File size: 8,614 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation.Host;
using System.Management.Automation.Internal;
using System.Management.Automation.Remoting.Client;
using System.Management.Automation.Runspaces.Internal;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation.Remoting
{
/// <summary>
/// Executes methods on the client.
/// </summary>
internal sealed class ClientMethodExecutor
{
/// <summary>
/// Transport manager.
/// </summary>
private readonly BaseClientTransportManager _transportManager;
/// <summary>
/// Client host.
/// </summary>
private readonly PSHost _clientHost;
/// <summary>
/// Client runspace pool id.
/// </summary>
private readonly Guid _clientRunspacePoolId;
/// <summary>
/// Client power shell id.
/// </summary>
private readonly Guid _clientPowerShellId;
/// <summary>
/// Remote host call.
/// </summary>
private readonly RemoteHostCall _remoteHostCall;
/// <summary>
/// Remote host call.
/// </summary>
internal RemoteHostCall RemoteHostCall
{
get
{
return _remoteHostCall;
}
}
/// <summary>
/// Constructor for ClientMethodExecutor.
/// </summary>
private ClientMethodExecutor(BaseClientTransportManager transportManager, PSHost clientHost, Guid clientRunspacePoolId, Guid clientPowerShellId, RemoteHostCall remoteHostCall)
{
Dbg.Assert(transportManager != null, "Expected transportManager != null");
Dbg.Assert(remoteHostCall != null, "Expected remoteHostCall != null");
_transportManager = transportManager;
_remoteHostCall = remoteHostCall;
_clientHost = clientHost;
_clientRunspacePoolId = clientRunspacePoolId;
_clientPowerShellId = clientPowerShellId;
}
/// <summary>
/// Create a new ClientMethodExecutor object and then dispatch it.
/// </summary>
internal static void Dispatch(
BaseClientTransportManager transportManager,
PSHost clientHost,
PSDataCollectionStream<ErrorRecord> errorStream,
ObjectStream methodExecutorStream,
bool isMethodExecutorStreamEnabled,
RemoteRunspacePoolInternal runspacePool,
Guid clientPowerShellId,
RemoteHostCall remoteHostCall)
{
ClientMethodExecutor methodExecutor =
new ClientMethodExecutor(transportManager, clientHost, runspacePool.InstanceId,
clientPowerShellId, remoteHostCall);
// If the powershell id is not specified, this message is for the runspace pool, execute
// it immediately and return
if (clientPowerShellId == Guid.Empty)
{
methodExecutor.Execute(errorStream);
return;
}
// Check client host to see if SetShouldExit should be allowed
bool hostAllowSetShouldExit = false;
if (clientHost != null)
{
PSObject hostPrivateData = clientHost.PrivateData as PSObject;
if (hostPrivateData != null)
{
PSNoteProperty allowSetShouldExit = hostPrivateData.Properties["AllowSetShouldExitFromRemote"] as PSNoteProperty;
hostAllowSetShouldExit = allowSetShouldExit != null && allowSetShouldExit.Value is bool && (bool)allowSetShouldExit.Value;
}
}
// Should we kill remote runspace? Check if "SetShouldExit" and if we are in the
// cmdlet case. In the API case (when we are invoked from an API not a cmdlet) we
// should not interpret "SetShouldExit" but should pass it on to the host. The
// variable IsMethodExecutorStreamEnabled is only true in the cmdlet case. In the
// API case it is false.
if (remoteHostCall.IsSetShouldExit && isMethodExecutorStreamEnabled && !hostAllowSetShouldExit)
{
runspacePool.Close();
return;
}
// Cmdlet case: queue up the executor in the pipeline stream.
if (isMethodExecutorStreamEnabled)
{
Dbg.Assert(methodExecutorStream != null, "method executor stream can't be null when enabled");
methodExecutorStream.Write(methodExecutor);
}
// API case: execute it immediately.
else
{
methodExecutor.Execute(errorStream);
}
}
/// <summary>
/// Is runspace pushed.
/// </summary>
private static bool IsRunspacePushed(PSHost host)
{
if (host is not IHostSupportsInteractiveSession host2)
{
return false;
}
// IsRunspacePushed can throw (not implemented exception)
try
{
return host2.IsRunspacePushed;
}
catch (PSNotImplementedException) { }
return false;
}
/// <summary>
/// Execute.
/// </summary>
internal void Execute(PSDataCollectionStream<ErrorRecord> errorStream)
{
Action<ErrorRecord> writeErrorAction = null;
// If error-stream is null or we are in pushed-runspace - then write error directly to console.
if (errorStream == null || IsRunspacePushed(_clientHost))
{
writeErrorAction = (ErrorRecord errorRecord) =>
{
try
{
_clientHost.UI?.WriteErrorLine(errorRecord.ToString());
}
catch (Exception)
{
// Catch-all OK, 3rd party callout.
}
};
}
// Otherwise write it to error-stream.
else
{
writeErrorAction = (ErrorRecord errorRecord) => errorStream.Write(errorRecord);
}
this.Execute(writeErrorAction);
}
/// <summary>
/// Execute.
/// </summary>
internal void Execute(Cmdlet cmdlet)
{
this.Execute(cmdlet.WriteError);
}
/// <summary>
/// Execute.
/// </summary>
internal void Execute(Action<ErrorRecord> writeErrorAction)
{
if (_remoteHostCall.IsVoidMethod)
{
ExecuteVoid(writeErrorAction);
}
else
{
RemotingDataType remotingDataType =
_clientPowerShellId == Guid.Empty ? RemotingDataType.RemoteRunspaceHostResponseData : RemotingDataType.RemotePowerShellHostResponseData;
RemoteHostResponse remoteHostResponse = _remoteHostCall.ExecuteNonVoidMethod(_clientHost);
RemoteDataObject<PSObject> dataToBeSent = RemoteDataObject<PSObject>.CreateFrom(
RemotingDestination.Server, remotingDataType, _clientRunspacePoolId,
_clientPowerShellId, remoteHostResponse.Encode());
_transportManager.DataToBeSentCollection.Add<PSObject>(dataToBeSent, DataPriorityType.PromptResponse);
}
}
/// <summary>
/// Execute void.
/// </summary>
internal void ExecuteVoid(Action<ErrorRecord> writeErrorAction)
{
try
{
_remoteHostCall.ExecuteVoidMethod(_clientHost);
}
catch (Exception exception)
{
// Catch-all OK, 3rd party callout.
// Extract inner exception.
if (exception.InnerException != null)
{
exception = exception.InnerException;
}
// Create an error record and write it to the stream.
ErrorRecord errorRecord = new ErrorRecord(
exception,
nameof(PSRemotingErrorId.RemoteHostCallFailed),
ErrorCategory.InvalidArgument,
_remoteHostCall.MethodName);
writeErrorAction(errorRecord);
}
}
}
}
|