File size: 4,009 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.ObjectModel;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation
{
/// <summary>
/// Class MamlCommandHelpInfo keeps track of help information to be returned by
/// command help provider.
/// </summary>
internal class RemoteHelpInfo : BaseCommandHelpInfo
{
private readonly PSObject _deserializedRemoteHelp;
internal RemoteHelpInfo(
ExecutionContext context,
RemoteRunspace remoteRunspace,
string localCommandName,
string remoteHelpTopic,
string remoteHelpCategory,
HelpCategory localHelpCategory) : base(localHelpCategory)
{
Dbg.Assert(remoteRunspace != null, "Caller should verify arguments");
using (PowerShell powerShell = PowerShell.Create())
{
powerShell.AddCommand("Get-Help");
powerShell.AddParameter("Name", remoteHelpTopic);
if (!string.IsNullOrEmpty(remoteHelpCategory))
{
powerShell.AddParameter("Category", remoteHelpCategory);
}
powerShell.Runspace = remoteRunspace;
Collection<PSObject> helpResults;
using (new PowerShellStopper(context, powerShell))
{
helpResults = powerShell.Invoke();
}
if ((helpResults == null) || (helpResults.Count == 0))
{
throw new Microsoft.PowerShell.Commands.HelpNotFoundException(remoteHelpTopic);
}
Dbg.Assert(helpResults.Count == 1, "Remote help should return exactly one result");
_deserializedRemoteHelp = helpResults[0];
_deserializedRemoteHelp.Methods.Remove("ToString");
// Win8: bug9457: Remote proxy command's name can be changed locally using -Prefix
// parameter of the Import-PSSession cmdlet. To give better user experience for
// get-help (on par with get-command), it was decided to use the local command name
// for the help content.
PSPropertyInfo nameInfo = _deserializedRemoteHelp.Properties["Name"];
if (nameInfo != null)
{
nameInfo.Value = localCommandName;
}
PSObject commandDetails = this.Details;
if (commandDetails != null)
{
nameInfo = commandDetails.Properties["Name"];
if (nameInfo != null)
{
nameInfo.Value = localCommandName;
}
else
{
commandDetails.InstanceMembers.Add(new PSNoteProperty("Name", localCommandName));
}
}
}
}
internal override PSObject FullHelp
{
get
{
return _deserializedRemoteHelp;
}
}
private string GetHelpProperty(string propertyName)
{
PSPropertyInfo property = _deserializedRemoteHelp.Properties[propertyName];
if (property == null)
{
return null;
}
return property.Value as string;
}
internal override string Component
{
get
{
return this.GetHelpProperty("Component");
}
}
internal override string Functionality
{
get
{
return this.GetHelpProperty("Functionality");
}
}
internal override string Role
{
get
{
return this.GetHelpProperty("Role");
}
}
}
}
|