private List <CmdletInfo> GetCmdlets()
{
List <CmdletInfo> cmdlets = new List <CmdletInfo>();
var types = _assembly.GetTypes().Where(t => t.BaseType != null && (t.BaseType.Name.StartsWith("SPO") || t.BaseType.Name.StartsWith("PnP") || t.BaseType.Name == "PSCmdlet" || (t.BaseType.BaseType != null && (t.BaseType.BaseType.Name.StartsWith("PnP") || t.BaseType.BaseType.Name == "PSCmdlet")))).OrderBy(t => t.Name).ToArray();
foreach (var type in types)
{
var cmdletInfo = new Model.CmdletInfo();
cmdletInfo.CmdletType = type;
var attributes = type.GetCustomAttributes();
foreach (var attribute in attributes)
{
var cmdletAttribute = attribute as CmdletAttribute;
if (cmdletAttribute != null)
{
#if !NETCOREAPP3_0
var a = cmdletAttribute;
cmdletInfo.Verb = a.VerbName;
cmdletInfo.Noun = a.NounName;
#else
var customAttributesData = type.GetCustomAttributesData();
var customAttributeData = customAttributesData.FirstOrDefault(c => c.AttributeType == typeof(CmdletAttribute));
if (customAttributeData != null)
{
cmdletInfo.Verb = customAttributeData.ConstructorArguments[0].Value.ToString();
cmdletInfo.Noun = customAttributeData.ConstructorArguments[1].Value.ToString();
}
#endif
}
var aliasAttribute = attribute as AliasAttribute;
if (aliasAttribute != null)
{
#if !NETCOREAPP3_0
foreach (var name in aliasAttribute.AliasNames)
{
cmdletInfo.Aliases.Add(name);
}
#else
var customAttributeData = type.GetCustomAttributesData().FirstOrDefault(c => c.AttributeType == typeof(AliasAttribute));
if (customAttributeData != null)
{
foreach (var name in customAttributeData.ConstructorArguments)
{
cmdletInfo.Aliases.Add(name.Value as string);
}
}
#endif
}
var helpAttribute = attribute as CmdletHelpAttribute;
if (helpAttribute != null)
{
var a = helpAttribute;
cmdletInfo.Description = a.Description;
cmdletInfo.Copyright = a.Copyright;
cmdletInfo.Version = a.Version;
cmdletInfo.DetailedDescription = a.DetailedDescription;
cmdletInfo.Category = ToEnumString(a.Category);
cmdletInfo.OutputType = a.OutputType;
cmdletInfo.OutputTypeLink = a.OutputTypeLink;
cmdletInfo.OutputTypeDescription = a.OutputTypeDescription;
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.All))
{
cmdletInfo.Platform = "All";
}
else
{
List <string> platforms = new List <string>();
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.OnPremises))
{
platforms.Add("SharePoint On-Premises");
}
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.Online))
{
platforms.Add("SharePoint Online");
}
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.SP2013))
{
platforms.Add("SharePoint 2013");
}
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.SP2016))
{
platforms.Add("SharePoint 2016");
}
if (a.SupportedPlatform.HasFlag(CmdletSupportedPlatform.SP2019))
{
platforms.Add("SharePoint 2019");
}
cmdletInfo.Platform = string.Join(", ", platforms);
}
}
var exampleAttribute = attribute as CmdletExampleAttribute;
if (exampleAttribute != null)
{
cmdletInfo.Examples.Add(exampleAttribute);
}
var linkAttribute = attribute as CmdletRelatedLinkAttribute;
if (linkAttribute != null)
{
cmdletInfo.RelatedLinks.Add(linkAttribute);
}
var additionalParameter = attribute as CmdletAdditionalParameter;
if (additionalParameter != null)
{
cmdletInfo.AdditionalParameters.Add(additionalParameter);
}
var apiPermissionAttribute = attribute as CmdletApiPermissionBase;
if (apiPermissionAttribute != null)
{
cmdletInfo.ApiPermissions.Add(apiPermissionAttribute);
}
}
if (!string.IsNullOrEmpty(cmdletInfo.Verb) && !string.IsNullOrEmpty(cmdletInfo.Noun))
{
cmdletInfo.Syntaxes = GetCmdletSyntaxes(cmdletInfo);
cmdletInfo.Parameters = GetCmdletParameters(cmdletInfo);
cmdlets.Add(cmdletInfo);
}
}
return(cmdlets);
}
private List <CmdletParameterInfo> GetCmdletParameters(Model.CmdletInfo cmdletInfo)
{
List <CmdletParameterInfo> parameters = new List <CmdletParameterInfo>();
var fields = GetFields(cmdletInfo.CmdletType);
foreach (var field in fields)
{
MemberInfo fieldInfo = field;
var obsolete = fieldInfo.GetCustomAttributes <ObsoleteAttribute>().Any();
if (!obsolete)
{
var aliases = field.GetCustomAttributes <AliasAttribute>(true);
var parameterAttributes = field.GetCustomAttributes <ParameterAttribute>(true);
var pnpParameterAttributes = field.GetCustomAttributes <PnPParameterAttribute>(true);
foreach (var parameterAttribute in parameterAttributes)
{
var description = parameterAttribute.HelpMessage;
if (string.IsNullOrEmpty(description))
{
// Maybe a generic one? Find the one with only a helpmessage set
var helpParameterAttribute = parameterAttributes.FirstOrDefault(p => !string.IsNullOrEmpty(p.HelpMessage));
if (helpParameterAttribute != null)
{
description = helpParameterAttribute.HelpMessage;
}
}
var typeString = field.FieldType.Name;
if (field.FieldType.IsGenericType)
{
typeString = field.FieldType.GenericTypeArguments[0].Name;
}
var fieldAttribute = field.FieldType.GetCustomAttributes <CmdletPipelineAttribute>(false).FirstOrDefault();
if (fieldAttribute != null)
{
if (fieldAttribute.Type != null)
{
typeString = string.Format(fieldAttribute.Description, fieldAttribute.Type.Name);
}
else
{
typeString = fieldAttribute.Description;
}
}
var order = 0;
if (pnpParameterAttributes != null && pnpParameterAttributes.Any())
{
order = pnpParameterAttributes.First().Order;
}
var cmdletParameterInfo = new CmdletParameterInfo()
{
Description = description,
Type = typeString,
Name = field.Name,
Required = parameterAttribute.Mandatory,
Position = parameterAttribute.Position,
ValueFromPipeline = parameterAttribute.ValueFromPipeline,
ParameterSetName = parameterAttribute.ParameterSetName,
Order = order
};
if (aliases != null && aliases.Any())
{
#if !NETCOREAPP3_0
foreach (var aliasAttribute in aliases)
{
cmdletParameterInfo.Aliases.AddRange(aliasAttribute.AliasNames);
}
#else
var customAttributesData = fieldInfo.GetCustomAttributesData();
foreach (var aliasAttribute in customAttributesData.Where(c => c.AttributeType == typeof(AliasAttribute)))
{
cmdletParameterInfo.Aliases.AddRange(aliasAttribute.ConstructorArguments.Select(a => a.ToString()));
}
#endif
}
parameters.Add(cmdletParameterInfo);
}
}
}
foreach (var additionalParameter in cmdletInfo.AdditionalParameters)
{
var typeString = additionalParameter.ParameterType.Name;
var fieldAttribute = additionalParameter.ParameterType.GetCustomAttributes <CmdletPipelineAttribute>(false).FirstOrDefault();
if (fieldAttribute != null)
{
if (fieldAttribute.Type != null)
{
typeString = string.Format(fieldAttribute.Description, fieldAttribute.Type.Name);
}
else
{
typeString = fieldAttribute.Description;
}
}
parameters.Add(new CmdletParameterInfo()
{
Description = additionalParameter.HelpMessage,
Type = typeString,
Name = additionalParameter.ParameterName,
Required = additionalParameter.Mandatory,
Position = additionalParameter.Position,
ParameterSetName = additionalParameter.ParameterSetName
});
}
return(parameters);
}
private List <CmdletSyntax> GetCmdletSyntaxes(Model.CmdletInfo cmdletInfo)
{
List <CmdletSyntax> syntaxes = new List <CmdletSyntax>();
var fields = GetFields(cmdletInfo.CmdletType);
foreach (var field in fields)
{
MemberInfo fieldInfo = field;
var obsolete = fieldInfo.GetCustomAttributes <ObsoleteAttribute>().Any();
if (!obsolete)
{
var parameterAttributes = fieldInfo.GetCustomAttributes <ParameterAttribute>(true).Where(a => a.ParameterSetName != ParameterAttribute.AllParameterSets);
var pnpAttributes = field.GetCustomAttributes <PnPParameterAttribute>(true);
foreach (var parameterAttribute in parameterAttributes)
{
var cmdletSyntax = syntaxes.FirstOrDefault(c => c.ParameterSetName == parameterAttribute.ParameterSetName);
if (cmdletSyntax == null)
{
cmdletSyntax = new CmdletSyntax();
cmdletSyntax.ParameterSetName = parameterAttribute.ParameterSetName;
syntaxes.Add(cmdletSyntax);
}
var typeString = field.FieldType.Name;
if (field.FieldType.IsGenericType)
{
typeString = field.FieldType.GenericTypeArguments[0].Name;
}
var fieldAttribute = field.FieldType.GetCustomAttributes <CmdletPipelineAttribute>(false).FirstOrDefault();
if (fieldAttribute != null)
{
if (fieldAttribute.Type != null)
{
typeString = string.Format(fieldAttribute.Description, fieldAttribute.Type.Name);
}
else
{
typeString = fieldAttribute.Description;
}
}
var order = 0;
if (pnpAttributes != null && pnpAttributes.Any())
{
order = pnpAttributes.First().Order;
}
cmdletSyntax.Parameters.Add(new CmdletParameterInfo()
{
Name = field.Name,
Description = parameterAttribute.HelpMessage,
Position = parameterAttribute.Position,
Required = parameterAttribute.Mandatory,
Type = typeString,
Order = order
});
}
}
}
foreach (var additionalParameter in cmdletInfo.AdditionalParameters.Where(a => a.ParameterSetName != ParameterAttribute.AllParameterSets))
{
var cmdletSyntax = syntaxes.FirstOrDefault(c => c.ParameterSetName == additionalParameter.ParameterSetName);
if (cmdletSyntax == null)
{
cmdletSyntax = new CmdletSyntax();
cmdletSyntax.ParameterSetName = additionalParameter.ParameterSetName;
syntaxes.Add(cmdletSyntax);
}
var typeString = additionalParameter.ParameterType.Name;
if (additionalParameter.ParameterType.IsGenericType)
{
typeString = additionalParameter.ParameterType.GenericTypeArguments[0].Name;
}
var fieldAttribute = additionalParameter.ParameterType.GetCustomAttributes <CmdletPipelineAttribute>(false).FirstOrDefault();
if (fieldAttribute != null)
{
if (fieldAttribute.Type != null)
{
typeString = string.Format(fieldAttribute.Description, fieldAttribute.Type.Name);
}
else
{
typeString = fieldAttribute.Description;
}
}
cmdletSyntax.Parameters.Add(new CmdletParameterInfo()
{
Name = additionalParameter.ParameterName,
Description = additionalParameter.HelpMessage,
Position = additionalParameter.Position,
Required = additionalParameter.Mandatory,
Type = typeString,
Order = additionalParameter.Order
});
}
// AllParameterSets
foreach (var field in fields)
{
var obsolete = field.GetCustomAttributes <ObsoleteAttribute>().Any();
if (!obsolete)
{
var parameterAttributes = field.GetCustomAttributes <ParameterAttribute>(true).Where(a => a.ParameterSetName == ParameterAttribute.AllParameterSets);
var pnpAttributes = field.GetCustomAttributes <PnPParameterAttribute>(true);
foreach (var parameterAttribute in parameterAttributes)
{
if (!syntaxes.Any())
{
syntaxes.Add(new CmdletSyntax {
ParameterSetName = ParameterAttribute.AllParameterSets
});
}
foreach (var syntax in syntaxes)
{
var typeString = field.FieldType.Name;
if (field.FieldType.IsGenericType)
{
typeString = field.FieldType.GenericTypeArguments[0].Name;
}
var fieldAttribute = field.FieldType.GetCustomAttributes <CmdletPipelineAttribute>(false).FirstOrDefault();
if (fieldAttribute != null)
{
if (fieldAttribute.Type != null)
{
typeString = string.Format(fieldAttribute.Description, fieldAttribute.Type.Name);
}
else
{
typeString = fieldAttribute.Description;
}
}
var order = 0;
if (pnpAttributes != null && pnpAttributes.Any())
{
order = pnpAttributes.First().Order;
}
syntax.Parameters.Add(new CmdletParameterInfo()
{
Name = field.Name,
Description = parameterAttribute.HelpMessage,
Position = parameterAttribute.Position,
Required = parameterAttribute.Mandatory,
Type = typeString,
Order = order
});
}
}
}
}
return(syntaxes);
}
