File size: 12,450 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Xml;
namespace System.Management.Automation
{
/// <summary>
/// Class ProviderHelpInfo keeps track of help information to be returned by
/// command help provider.
/// </summary>
internal sealed class ProviderHelpInfo : HelpInfo
{
/// <summary>
/// Constructor for HelpProvider.
/// </summary>
private ProviderHelpInfo(XmlNode xmlNode)
{
MamlNode mamlNode = new MamlNode(xmlNode);
_fullHelpObject = mamlNode.PSObject;
this.Errors = mamlNode.Errors;
_fullHelpObject.TypeNames.Clear();
_fullHelpObject.TypeNames.Add("ProviderHelpInfo");
_fullHelpObject.TypeNames.Add("HelpInfo");
}
#region Basic Help Properties / Methods
/// <summary>
/// Name of the provider for which this provider help info is for.
/// </summary>
/// <value>Name of the provider</value>
internal override string Name
{
get
{
if (_fullHelpObject == null)
return string.Empty;
if (_fullHelpObject.Properties["Name"] == null)
return string.Empty;
if (_fullHelpObject.Properties["Name"].Value == null)
return string.Empty;
string name = _fullHelpObject.Properties["Name"].Value.ToString();
if (name == null)
return string.Empty;
return name.Trim();
}
}
/// <summary>
/// Synopsis in the provider help info.
/// </summary>
/// <value>Synopsis in the provider help info</value>
internal override string Synopsis
{
get
{
if (_fullHelpObject == null)
return string.Empty;
if (_fullHelpObject.Properties["Synopsis"] == null)
return string.Empty;
if (_fullHelpObject.Properties["Synopsis"].Value == null)
return string.Empty;
string synopsis = _fullHelpObject.Properties["Synopsis"].Value.ToString();
if (synopsis == null)
return string.Empty;
return synopsis.Trim();
}
}
/// <summary>
/// Detailed description in the provider help info.
/// </summary>
/// <value>Detailed description in the provider help info</value>
internal string DetailedDescription
{
get
{
if (this.FullHelp == null)
return string.Empty;
if (this.FullHelp.Properties["DetailedDescription"] == null ||
this.FullHelp.Properties["DetailedDescription"].Value == null)
{
return string.Empty;
}
IList descriptionItems = FullHelp.Properties["DetailedDescription"].Value as IList;
if (descriptionItems == null || descriptionItems.Count == 0)
{
return string.Empty;
}
// I think every provider description should at least have 400 characters...
// so starting with this assumption..I did an average of all the help content
// available at the time of writing this code and came up with this number.
Text.StringBuilder result = new Text.StringBuilder(400);
foreach (object descriptionItem in descriptionItems)
{
PSObject descriptionObject = PSObject.AsPSObject(descriptionItem);
if ((descriptionObject == null) ||
(descriptionObject.Properties["Text"] == null) ||
(descriptionObject.Properties["Text"].Value == null))
{
continue;
}
string text = descriptionObject.Properties["Text"].Value.ToString();
result.Append(text);
result.Append(Environment.NewLine);
}
return result.ToString().Trim();
}
}
/// <summary>
/// Help category for this provider help info, which is constantly HelpCategory.Provider.
/// </summary>
/// <value>Help category for this provider help info</value>
internal override HelpCategory HelpCategory
{
get
{
return HelpCategory.Provider;
}
}
private readonly PSObject _fullHelpObject;
/// <summary>
/// Full help object for this provider help info.
/// </summary>
/// <value>Full help object for this provider help info</value>
internal override PSObject FullHelp
{
get
{
return _fullHelpObject;
}
}
/// <summary>
/// Returns true if help content in help info matches the
/// pattern contained in <paramref name="pattern"/>.
/// The underlying code will usually run pattern.IsMatch() on
/// content it wants to search.
/// Provider help info looks for pattern in Synopsis and
/// DetailedDescription.
/// </summary>
/// <param name="pattern"></param>
/// <returns></returns>
internal override bool MatchPatternInContent(WildcardPattern pattern)
{
Diagnostics.Assert(pattern != null, "pattern cannot be null");
string synopsis = Synopsis;
string detailedDescription = DetailedDescription;
synopsis ??= string.Empty;
detailedDescription ??= string.Empty;
return pattern.IsMatch(synopsis) || pattern.IsMatch(detailedDescription);
}
#endregion
#if V2
#region Cmdlet Help and Dynamic Parameter Help
private Hashtable _cmdletHelps;
/// <summary>
/// Return the provider-specific cmdlet help based on input cmdletName.
/// </summary>
/// <param name="cmdletName">CmdletName on which to get provider-specific help.</param>
/// <returns>An mshObject that contains provider-specific commandlet help.</returns>
internal PSObject GetCmdletHelp(string cmdletName)
{
if (string.IsNullOrEmpty(cmdletName))
return null;
LoadCmdletHelps();
if (_cmdletHelps == null)
return null;
return (PSObject)_cmdletHelps[cmdletName];
}
/// <summary>
/// Load provider-specific commandlet helps from xmlNode stored in _fullHelpObject.
/// Result will be stored in a hashtable.
/// </summary>
private void LoadCmdletHelps()
{
if (_cmdletHelps != null)
return;
if (_fullHelpObject == null)
return;
_cmdletHelps = new Hashtable();
if (_fullHelpObject.Properties["Cmdlets"] == null)
return;
PSObject cmdlets = (PSObject)_fullHelpObject.Properties["Cmdlets"].Value;
if (cmdlets == null)
return;
if (cmdlets.Properties["Cmdlet"] == null ||
cmdlets.Properties["Cmdlet"].Value == null)
return;
if (cmdlets.Properties["Cmdlet"].Value.GetType().Equals(typeof(PSObject[])))
{
PSObject[] cmdletHelpItems = (PSObject[])cmdlets.Properties["Cmdlet"].Value;
for (int i = 0; i < cmdletHelpItems.Length; i++)
{
if (cmdletHelpItems[i].Properties["Name"] == null
|| cmdletHelpItems[i].Properties["Name"].Value == null)
return;
string name = ((PSObject)cmdletHelpItems[i].Properties["Name"].Value).ToString();
_cmdletHelps[name] = cmdletHelpItems[i];
}
}
else if (cmdlets.Properties["Cmdlet"].Value.GetType().Equals(typeof(PSObject[])))
{
PSObject cmdletHelpItem = (PSObject)cmdlets.Properties["Cmdlet"].Value;
string name = ((PSObject)cmdletHelpItem.Properties["Name"].Value).ToString();
_cmdletHelps[name] = cmdletHelpItem;
}
}
private Hashtable _dynamicParameterHelps;
/// <summary>
/// Return the provider-specific dynamic parameter help based on input parameter name.
/// </summary>
/// <param name="parameters">An array of parameters to retrieve help.</param>
/// <returns>An array of mshObject that contains the parameter help.</returns>
internal PSObject[] GetDynamicParameterHelp(string[] parameters)
{
if (parameters == null || parameters.Length == 0)
return null;
LoadDynamicParameterHelps();
if (_dynamicParameterHelps == null)
return null;
ArrayList result = new ArrayList();
for (int i = 0; i < parameters.Length; i++)
{
PSObject entry = (PSObject)_dynamicParameterHelps[parameters[i].ToLower()];
if (entry != null)
result.Add(entry);
}
return (PSObject[])result.ToArray(typeof(PSObject));
}
/// <summary>
/// Load provider-specific dynamic parameter helps from xmlNode stored in _fullHelpObject.
/// Result will be stored in a hashtable.
/// </summary>
private void LoadDynamicParameterHelps()
{
if (_dynamicParameterHelps != null)
return;
if (_fullHelpObject == null)
return;
_dynamicParameterHelps = new Hashtable();
if (_fullHelpObject.Properties["DynamicParameters"] == null)
return;
PSObject dynamicParameters = (PSObject)_fullHelpObject.Properties["DynamicParameters"].Value;
if (dynamicParameters == null)
return;
if (dynamicParameters.Properties["DynamicParameter"] == null
|| dynamicParameters.Properties["DynamicParameter"].Value == null)
return;
if (dynamicParameters.Properties["DynamicParameter"].Value.GetType().Equals(typeof(PSObject[])))
{
PSObject[] dynamicParameterHelpItems = (PSObject[])dynamicParameters.Properties["DynamicParameter"].Value;
for (int i = 0; i < dynamicParameterHelpItems.Length; i++)
{
if (dynamicParameterHelpItems[i].Properties["Name"] == null
|| dynamicParameterHelpItems[i].Properties["Name"].Value == null)
return;
string name = ((PSObject)dynamicParameterHelpItems[i].Properties["Name"].Value).ToString();
_dynamicParameterHelps[name] = dynamicParameterHelpItems[i];
}
}
else if (dynamicParameters.Properties["DynamicParameter"].Value.GetType().Equals(typeof(PSObject[])))
{
PSObject dynamicParameterHelpItem = (PSObject)dynamicParameters.Properties["DynamicParameter"].Value;
string name = ((PSObject)dynamicParameterHelpItem.Properties["Name"].Value).ToString();
_dynamicParameterHelps[name] = dynamicParameterHelpItem;
}
}
#endregion
#endif
#region Load Help
/// <summary>
/// Create providerHelpInfo from an xmlNode.
/// </summary>
/// <param name="xmlNode">Xml node that contains the provider help info.</param>
/// <returns>The providerHelpInfo object created.</returns>
internal static ProviderHelpInfo Load(XmlNode xmlNode)
{
ProviderHelpInfo providerHelpInfo = new ProviderHelpInfo(xmlNode);
if (string.IsNullOrEmpty(providerHelpInfo.Name))
return null;
providerHelpInfo.AddCommonHelpProperties();
return providerHelpInfo;
}
#endregion
}
}
|