// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation.Host;
using System.Management.Automation.Internal;
using System.Management.Automation.Language;
using System.Management.Automation.Remoting;
using System.Management.Automation.Remoting.Internal;
using System.Management.Automation.Runspaces;
using System.Management.Automation.Tracing;
using System.Runtime.Serialization;
using System.Text;
using System.Threading;
using Microsoft.PowerShell.Commands;
using Dbg = System.Management.Automation.Diagnostics;
// Stops compiler from warning about unknown warnings
#pragma warning disable 1634, 1691
namespace System.Management.Automation
{
///
/// Enumeration for job status values. Indicates the status
/// of the result object.
///
public enum JobState
{
///
/// Execution of command in job not started.
///
NotStarted = 0,
///
/// Execution of command in progress.
///
Running = 1,
///
/// Execution of command completed in all
/// computernames/runspaces.
///
Completed = 2,
///
/// An error was encountered when trying to executed
/// command in one or more computernames/runspaces.
///
Failed = 3,
///
/// Command execution is cancelled (stopped) in one or more
/// computernames/runspaces.
///
Stopped = 4,
///
/// Command execution is blocked (on user input host calls etc)
///
Blocked = 5,
///
/// The job has been suspended.
///
Suspended = 6,
///
/// The job is a remote job and has been disconnected from the server.
///
Disconnected = 7,
///
/// Suspend is in progress.
///
Suspending = 8,
///
/// Stop is in progress.
///
Stopping = 9,
///
/// Script execution is halted in a debugger stop.
///
AtBreakpoint = 10
}
///
/// Defines exception which is thrown when state of the PSJob is different
/// from the expected state.
///
public class InvalidJobStateException : SystemException
{
///
/// Creates a new instance of InvalidPSJobStateException class.
///
public InvalidJobStateException()
: base
(
PSRemotingErrorInvariants.FormatResourceString
(
RemotingErrorIdStrings.InvalidJobStateGeneral
)
)
{
}
///
/// Creates a new instance of InvalidPSJobStateException class.
///
///
/// Creates a new instance of InvalidPSJobStateException class.
///
///
/// Creates a new instance of InvalidJobStateException class.
///
///
/// Initializes a new instance of the InvalidPSJobStateException and defines value of
/// CurrentState.
///
///
/// Initializes a new instance of the InvalidPSJobStateException
/// class with serialized data.
///
///
/// Gets CurrentState of the Job.
///
public JobState CurrentState
{
get
{
return _currState;
}
}
///
/// State of job when exception was thrown.
///
[NonSerialized]
private readonly JobState _currState = 0;
}
///
/// Type which has information about JobState and Exception
/// ,if any, associated with JobState.
///
public sealed class JobStateInfo
{
#region constructors
///
/// Constructor for state changes not resulting from an error.
///
///
/// Constructor for state changes with an optional error.
///
///
/// Copy constructor to support cloning.
///
///
/// ArgumentNullException when
internal JobStateInfo(JobStateInfo jobStateInfo)
{
State = jobStateInfo.State;
Reason = jobStateInfo.Reason;
}
#endregion constructors
#region public_properties
///
/// The state of the job.
///
///
/// This value indicates the state of the job .
///
public JobState State { get; }
///
/// The reason for the state change, if caused by an error.
///
///
/// The value of this property is non-null if the state
/// changed due to an error. Otherwise, the value of this
/// property is null.
///
public Exception Reason { get; }
#endregion public_properties
///
/// Override for ToString()
///
///
/// Clones this object.
///
/// Cloned object.
internal JobStateInfo Clone()
{
return new JobStateInfo(this);
}
#region private_fields
#endregion private_fields
}
///
/// Event arguments passed to JobStateEvent handlers
///
public sealed class JobStateEventArgs : EventArgs
{
#region constructors
///
/// Constructor of JobStateEventArgs.
///
///
/// Constructor of JobStateEventArgs.
///
///
/// Info about the current state of the job.
///
public JobStateInfo JobStateInfo { get; }
///
/// Info about the previous state of the job.
///
public JobStateInfo PreviousJobStateInfo { get; }
#endregion public_properties
}
///
/// Object that must be created by PowerShell to allow reuse of an ID for a job.
/// Also allows setting of the Instance Id so that jobs may be recreated.
///
public sealed class JobIdentifier
{
internal JobIdentifier(int id, Guid instanceId)
{
if (id <= 0)
PSTraceSource.NewArgumentException(nameof(id), RemotingErrorIdStrings.JobSessionIdLessThanOne, id);
Id = id;
InstanceId = instanceId;
}
internal int Id { get; }
internal Guid InstanceId { get; private set; }
}
///
/// Interface to expose a job debugger.
///
#nullable enable
public interface IJobDebugger
{
///
/// Job Debugger.
///
Debugger? Debugger
{
get;
}
///
/// True if job is running asynchronously.
///
bool IsAsync
{
get;
set;
}
}
#nullable restore
///
/// Represents a command running in background. A job object can internally
/// contain many child job objects.
///
public abstract class Job : IDisposable
{
#region Constructor
///
/// Default constructor.
///
protected Job()
{
Id = System.Threading.Interlocked.Increment(ref s_jobIdSeed);
}
///
/// Creates an instance of this class.
///
///
/// Creates an instance of this class.
///
///
/// Creates an instance of this class.
///
/// childJobs)
: this(command, name)
{
_childJobs = childJobs;
}
///
/// Creates an instance of this class.
///
/// The JobIdentifier is a token that must be issued by PowerShell to allow
/// reuse of the Id. This is the only way to set either Id or instance Id.
protected Job(string command, string name, JobIdentifier token)
{
if (token == null)
throw PSTraceSource.NewArgumentNullException(nameof(token), RemotingErrorIdStrings.JobIdentifierNull);
if (token.Id > s_jobIdSeed)
{
throw PSTraceSource.NewArgumentException(nameof(token), RemotingErrorIdStrings.JobIdNotYetAssigned, token.Id);
}
Command = command;
Id = token.Id;
InstanceId = token.InstanceId;
if (!string.IsNullOrEmpty(name))
{
_name = name;
}
else
{
_name = AutoGenerateJobName();
}
}
///
/// Creates an instance of this class.
///
/// The InstanceId may need to be set to maintain job identity across
/// instances of the process.
protected Job(string command, string name, Guid instanceId)
: this(command, name)
{
InstanceId = instanceId;
}
internal static string GetCommandTextFromInvocationInfo(InvocationInfo invocationInfo)
{
if (invocationInfo == null)
{
return null;
}
IScriptExtent scriptExtent = invocationInfo.ScriptPosition;
if ((scriptExtent != null) && (scriptExtent.StartScriptPosition != null) && !string.IsNullOrWhiteSpace(scriptExtent.StartScriptPosition.Line))
{
Dbg.Assert(scriptExtent.StartScriptPosition.ColumnNumber > 0, "Column numbers start at 1");
Dbg.Assert(scriptExtent.StartScriptPosition.ColumnNumber <= scriptExtent.StartScriptPosition.Line.Length, "Column numbers are not greater than the length of a line");
return scriptExtent.StartScriptPosition.Line.AsSpan(scriptExtent.StartScriptPosition.ColumnNumber - 1).Trim().ToString();
}
return invocationInfo.InvocationName;
}
#endregion Constructor
#region Private Members
private ManualResetEvent _finished = new ManualResetEvent(false);
private string _name;
private IList _childJobs;
internal readonly object syncObject = new object(); // object used for synchronization
// ISSUE: Should Result be public property
private PSDataCollection _results = new PSDataCollection();
private bool _resultsOwner = true;
private PSDataCollection _error = new PSDataCollection();
private bool _errorOwner = true;
private PSDataCollection _progress = new PSDataCollection();
private bool _progressOwner = true;
private PSDataCollection _verbose = new PSDataCollection();
private bool _verboseOwner = true;
private PSDataCollection _warning = new PSDataCollection();
private bool _warningOwner = true;
private PSDataCollection _debug = new PSDataCollection();
private bool _debugOwner = true;
private PSDataCollection _information = new PSDataCollection();
private bool _informationOwner = true;
private PSDataCollection _output = new PSDataCollection();
private bool _outputOwner = true;
///
/// Static variable which is incremented to generate id.
///
private static int s_jobIdSeed = 0;
private string _jobTypeName = string.Empty;
#endregion Private Members
#region Job Properties
///
/// Command Invoked by this Job.
///
public string Command { get; }
///
/// Status of the command execution.
///
public JobStateInfo JobStateInfo { get; private set; } = new JobStateInfo(JobState.NotStarted);
///
/// Wait Handle which is signaled when job is finished.
/// This is set when state of the job is set to Completed,
/// Stopped or Failed.
///
public WaitHandle Finished
{
get
{
lock (this.syncObject)
{
if (_finished != null)
{
return _finished;
}
else
{
// Damage control mode:
// Somebody is trying to get Finished handle for an already disposed Job instance.
// Return an already triggered handle (disposed job is finished by definition).
// The newly created handle will not be disposed in a deterministic manner
// and in some circumstances can be mistaken for a handle leak.
return new ManualResetEvent(true);
}
}
}
}
///
/// Unique identifier for this job.
///
public Guid InstanceId { get; } = Guid.NewGuid();
///
/// Short identifier for this result which will be
/// recycled and used within a process.
///
public int Id { get; }
///
/// Name for identifying this job object.
///
public string Name
{
get
{
return _name;
}
set
{
AssertNotDisposed();
_name = value;
}
}
///
/// List of child jobs contained within this job.
///
public IList ChildJobs
{
get
{
if (_childJobs == null)
{
lock (syncObject)
{
_childJobs ??= new List();
}
}
return _childJobs;
}
}
///
/// Success status of the command execution.
///
public abstract string StatusMessage { get; }
///
/// Indicates that more data is available in this
/// result object for reading.
///
public abstract bool HasMoreData { get; }
///
/// Time job was started.
///
public DateTime? PSBeginTime { get; protected set; } = null;
///
/// Time job stopped.
///
public DateTime? PSEndTime { get; protected set; } = null;
///
/// Job type name.
///
public string PSJobTypeName
{
get
{
return _jobTypeName;
}
protected internal set
{
_jobTypeName = value ?? this.GetType().ToString();
}
}
#region results
///
/// Result objects from this job. If this object is not a
/// leaf node (with no children), then this will
/// aggregate the results from all child jobs.
///
internal PSDataCollection Results
{
get
{
return _results;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Results");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_resultsOwner = false;
_results = value;
}
}
}
///
/// Indicates if a particular Job type uses the
/// internal results collection.
///
internal bool UsesResultsCollection { get; set; }
///
/// Suppresses forwarding of job output into a cmdlet (like Receive-Job).
/// This flag modifies functionality of
internal bool SuppressOutputForwarding { get; set; }
internal virtual void WriteObject(object outputObject)
{
PSObject pso = (outputObject == null) ? null : PSObject.AsPSObject(outputObject);
this.Output.Add(pso);
if (!SuppressOutputForwarding)
{
this.Results.Add(new PSStreamObject(PSStreamObjectType.Output, pso));
}
}
///
/// Allows propagating of terminating exceptions from remote "throw" statement
/// (normally / by default all remote errors are transformed into non-terminating errors.
///
internal bool PropagateThrows { get; set; }
private void WriteError(Cmdlet cmdlet, ErrorRecord errorRecord)
{
if (this.PropagateThrows)
{
Exception e = GetExceptionFromErrorRecord(errorRecord);
if (e != null)
throw e;
}
errorRecord.PreserveInvocationInfoOnce = true;
cmdlet.WriteError(errorRecord);
}
private static Exception GetExceptionFromErrorRecord(ErrorRecord errorRecord)
{
if (errorRecord.Exception is not RuntimeException runtimeException)
return null;
if (runtimeException is not RemoteException remoteException)
return null;
PSPropertyInfo wasThrownFromThrow =
remoteException.SerializedRemoteException.Properties["WasThrownFromThrowStatement"];
if (wasThrownFromThrow == null || !((bool)wasThrownFromThrow.Value))
return null;
runtimeException.WasThrownFromThrowStatement = true;
return runtimeException;
}
internal virtual void WriteError(ErrorRecord errorRecord)
{
Error.Add(errorRecord);
if (PropagateThrows)
{
Exception exception = GetExceptionFromErrorRecord(errorRecord);
if (exception != null)
{
Results.Add(new PSStreamObject(PSStreamObjectType.Exception, exception));
return;
}
}
Results.Add(new PSStreamObject(PSStreamObjectType.Error, errorRecord));
}
internal void WriteError(ErrorRecord errorRecord, out Exception exceptionThrownOnCmdletThread)
{
this.Error.Add(errorRecord);
this.InvokeCmdletMethodAndWaitForResults(
(Cmdlet cmdlet) =>
{
this.WriteError(cmdlet, errorRecord);
return null;
},
out exceptionThrownOnCmdletThread);
}
internal virtual void WriteWarning(string message)
{
this.Warning.Add(new WarningRecord(message));
this.Results.Add(new PSStreamObject(PSStreamObjectType.Warning, message));
}
internal virtual void WriteVerbose(string message)
{
this.Verbose.Add(new VerboseRecord(message));
this.Results.Add(new PSStreamObject(PSStreamObjectType.Verbose, message));
}
internal virtual void WriteDebug(string message)
{
this.Debug.Add(new DebugRecord(message));
this.Results.Add(new PSStreamObject(PSStreamObjectType.Debug, message));
}
internal virtual void WriteProgress(ProgressRecord progressRecord)
{
if ((progressRecord.ParentActivityId == (-1)) && (_parentActivityId != null))
{
progressRecord = new ProgressRecord(progressRecord) { ParentActivityId = _parentActivityId.Value };
}
Progress.Add(progressRecord);
Results.Add(new PSStreamObject(PSStreamObjectType.Progress, progressRecord));
}
internal virtual void WriteInformation(InformationRecord informationRecord)
{
Information.Add(informationRecord);
Results.Add(new PSStreamObject(PSStreamObjectType.Information, informationRecord));
}
private Lazy _parentActivityId;
internal void SetParentActivityIdGetter(Func parentActivityIdGetter)
{
Dbg.Assert(parentActivityIdGetter != null, "Caller should verify parentActivityIdGetter != null");
_parentActivityId = new Lazy(parentActivityIdGetter);
}
internal bool ShouldContinue(string query, string caption)
{
Exception exceptionThrownOnCmdletThread;
return this.ShouldContinue(query, caption, out exceptionThrownOnCmdletThread);
}
internal bool ShouldContinue(string query, string caption, out Exception exceptionThrownOnCmdletThread)
{
bool methodResult = InvokeCmdletMethodAndWaitForResults(
cmdlet => cmdlet.ShouldContinue(query, caption),
out exceptionThrownOnCmdletThread);
return methodResult;
}
internal virtual void NonblockingShouldProcess(
string verboseDescription,
string verboseWarning,
string caption)
{
InvokeCmdletMethodAndIgnoreResults(
(Cmdlet cmdlet) =>
{
ShouldProcessReason throwAwayProcessReason;
cmdlet.ShouldProcess(
verboseDescription,
verboseWarning,
caption,
out throwAwayProcessReason);
});
}
internal virtual bool ShouldProcess(
string verboseDescription,
string verboseWarning,
string caption,
out ShouldProcessReason shouldProcessReason,
out Exception exceptionThrownOnCmdletThread)
{
ShouldProcessReason closureSafeShouldProcessReason = ShouldProcessReason.None;
bool methodResult = InvokeCmdletMethodAndWaitForResults(
cmdlet => cmdlet.ShouldProcess(
verboseDescription,
verboseWarning,
caption,
out closureSafeShouldProcessReason),
out exceptionThrownOnCmdletThread);
shouldProcessReason = closureSafeShouldProcessReason;
return methodResult;
}
private void InvokeCmdletMethodAndIgnoreResults(Action invokeCmdletMethod)
{
object resultsLock = new object();
CmdletMethodInvoker methodInvoker = new CmdletMethodInvoker
{
Action = (Cmdlet cmdlet) => { invokeCmdletMethod(cmdlet); return null; },
Finished = null,
SyncObject = resultsLock
};
Results.Add(new PSStreamObject(PSStreamObjectType.BlockingError, methodInvoker));
}
private T InvokeCmdletMethodAndWaitForResults(Func invokeCmdletMethodAndReturnResult, out Exception exceptionThrownOnCmdletThread)
{
Dbg.Assert(invokeCmdletMethodAndReturnResult != null, "Caller should verify invokeCmdletMethodAndReturnResult != null");
T methodResult = default(T);
Exception closureSafeExceptionThrownOnCmdletThread = null;
object resultsLock = new object();
using (var gotResultEvent = new ManualResetEventSlim(false))
{
EventHandler stateChangedEventHandler =
(object sender, JobStateEventArgs eventArgs) =>
{
if (IsFinishedState(eventArgs.JobStateInfo.State) || eventArgs.JobStateInfo.State == JobState.Stopping)
{
lock (resultsLock)
{
closureSafeExceptionThrownOnCmdletThread = new OperationCanceledException();
}
gotResultEvent.Set();
}
};
this.StateChanged += stateChangedEventHandler;
Interlocked.MemoryBarrier();
try
{
stateChangedEventHandler(null, new JobStateEventArgs(this.JobStateInfo));
if (!gotResultEvent.IsSet)
{
this.SetJobState(JobState.Blocked);
// addition to results column happens here
CmdletMethodInvoker methodInvoker = new CmdletMethodInvoker
{
Action = invokeCmdletMethodAndReturnResult,
Finished = gotResultEvent,
SyncObject = resultsLock
};
PSStreamObjectType objectType = PSStreamObjectType.ShouldMethod;
if (typeof(T) == typeof(object))
objectType = PSStreamObjectType.BlockingError;
Results.Add(new PSStreamObject(objectType, methodInvoker));
gotResultEvent.Wait();
this.SetJobState(JobState.Running);
lock (resultsLock)
{
if (closureSafeExceptionThrownOnCmdletThread == null) // stateChangedEventHandler didn't set the results? = ok to clobber results?
{
closureSafeExceptionThrownOnCmdletThread = methodInvoker.ExceptionThrownOnCmdletThread;
methodResult = methodInvoker.MethodResult;
}
}
}
}
finally
{
this.StateChanged -= stateChangedEventHandler;
}
}
lock (resultsLock)
{
exceptionThrownOnCmdletThread = closureSafeExceptionThrownOnCmdletThread;
return methodResult;
}
}
internal virtual void ForwardAvailableResultsToCmdlet(Cmdlet cmdlet)
{
foreach (PSStreamObject obj in Results.ReadAll())
{
obj.WriteStreamObject(cmdlet);
}
}
internal virtual void ForwardAllResultsToCmdlet(Cmdlet cmdlet)
{
foreach (PSStreamObject obj in this.Results)
{
obj.WriteStreamObject(cmdlet);
}
}
///
/// This method is introduce for delaying the loading of streams
/// for a particular job.
///
protected virtual void DoLoadJobStreams()
{
}
///
/// Unloads job streams information. Enables jobs to
/// clear stream information from memory.
///
protected virtual void DoUnloadJobStreams()
{
}
///
/// Load the required job streams.
///
public void LoadJobStreams()
{
if (_jobStreamsLoaded)
{
return;
}
lock (syncObject)
{
if (_jobStreamsLoaded)
{
return;
}
_jobStreamsLoaded = true;
}
try
{
DoLoadJobStreams();
}
catch (Exception e)
{
// third party call-out for platform API
// Therefore it is fine to eat the exception
// here
using (PowerShellTraceSource tracer = PowerShellTraceSourceFactory.GetTraceSource())
{
tracer.TraceException(e);
}
}
}
private bool _jobStreamsLoaded;
///
/// Unload the required job streams.
///
public void UnloadJobStreams()
{
if (!_jobStreamsLoaded) return;
lock (syncObject)
{
if (!_jobStreamsLoaded) return;
_jobStreamsLoaded = false;
}
try
{
DoUnloadJobStreams();
}
catch (Exception e)
{
// third party call-out for platform API
// Therefore it is fine to eat the exception
// here
using (PowerShellTraceSource tracer = PowerShellTraceSourceFactory.GetTraceSource())
{
tracer.TraceException(e);
}
}
}
///
/// Gets or sets the output buffer. Output of job is written
/// into this buffer.
///
///
/// Cannot set to a null value.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Output
{
get
{
LoadJobStreams(); // for delayed loading
return _output;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Output");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_outputOwner = false;
_output = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Gets or sets the error buffer. Errors of job are written
/// into this buffer.
///
///
/// Cannot set to a null value.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Error
{
get
{
LoadJobStreams(); // for delayed loading
return _error;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Error");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_errorOwner = false;
_error = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Gets or sets the progress buffer. Progress of job is written
/// into this buffer.
///
///
/// Cannot set to a null value.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Progress
{
get
{
LoadJobStreams(); // for delayed loading
return _progress;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Progress");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_progressOwner = false;
_progress = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Gets or sets the verbose buffer. Verbose output of job is written to
/// this stream.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Verbose
{
get
{
LoadJobStreams(); // for delayed loading
return _verbose;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Verbose");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_verboseOwner = false;
_verbose = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Gets or sets the debug buffer. Debug output of Job is written
/// to this buffer.
///
/// Cannot set to a null value.
///
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Debug
{
get
{
LoadJobStreams(); // for delayed loading
return _debug;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Debug");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_debugOwner = false;
_debug = value;
}
}
}
///
/// Gets or sets the warning buffer. Warnings of job are written to
/// this buffer.
///
///
/// Cannot set to a null value.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Warning
{
get
{
LoadJobStreams(); // for delayed loading
return _warning;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Warning");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_warningOwner = false;
_warning = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Gets or sets the information buffer. Information records of job are written to
/// this buffer.
///
///
/// Cannot set to a null value.
///
///
/// Object is disposed.
///
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public PSDataCollection Information
{
get
{
LoadJobStreams(); // for delayed loading
return _information;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException("Information");
}
lock (syncObject)
{
AssertChangesAreAccepted();
_informationOwner = false;
_information = value;
_jobStreamsLoaded = true;
}
}
}
///
/// Indicates a location where this job is running.
///
public abstract string Location { get; }
#endregion results
#region Connect/Disconnect
///
/// Returns boolean indicating whether the underlying
/// transport for the job (or child jobs) supports
/// connect/disconnect semantics.
///
internal virtual bool CanDisconnect
{
get { return false; }
}
///
/// Returns runspaces associated with the Job, including
/// child jobs.
///
/// IEnumerable of RemoteRunspaces.
internal virtual IEnumerable GetRunspaces()
{
return null;
}
#endregion
#endregion Job Properties
#region Job State and State Change Event
///
/// Event raised when state of the job changes.
///
[SuppressMessage("Microsoft.Design", "CA1051:DoNotDeclareVisibleInstanceFields")]
public event EventHandler StateChanged;
///
/// Sets Job State.
///
///
/// Sets Job State.
///
///
/// Stop this job object. If job contains child job, this should
/// stop child job objects also.
///
public abstract void StopJob();
#endregion Job Public Methods
#region Private/Internal Methods
///
/// Returns the items in results collection
/// after clearing up all the internal
/// structures.
///
/// Collection of stream objects.
internal Collection ReadAll()
{
Output.Clear();
Error.Clear();
Debug.Clear();
Warning.Clear();
Verbose.Clear();
Progress.Clear();
return Results.ReadAll();
}
///
/// Helper function to check if job is finished.
///
///
/// Checks if the current instance can accept changes like
/// changing one of the properties like Output, Error etc.
/// If changes are not allowed, throws an exception.
///
///
/// Powershell instance cannot be changed in its
/// current state.
///
///
/// Object is disposed.
///
private void AssertChangesAreAccepted()
{
AssertNotDisposed();
lock (syncObject)
{
if (JobStateInfo.State == JobState.Running)
{
throw new InvalidJobStateException(JobState.Running);
}
}
}
///
/// Automatically generate a job name if the user
/// does not supply one.
///
/// Auto generated job name.
/// Since the user can script/program against the
/// job name, the auto generated name will not be
/// localizable
protected string AutoGenerateJobName()
{
return "Job" + Id.ToString(System.Globalization.NumberFormatInfo.InvariantInfo);
}
///
/// Checks if the current powershell instance is disposed.
/// If disposed, throws ObjectDisposedException.
///
///
/// Object is disposed.
///
internal void AssertNotDisposed()
{
if (_isDisposed)
{
throw PSTraceSource.NewObjectDisposedException("PSJob");
}
}
///
/// A helper method to close all the streams.
///
internal void CloseAllStreams()
{
// The Complete() method includes raising public notification events that third parties can
// handle and potentially throw exceptions on the notification thread. We don't want to
// propagate those exceptions because it prevents this thread from completing its processing.
if (_resultsOwner) { try { _results.Complete(); } catch (Exception e) { TraceException(e); } }
if (_outputOwner) { try { _output.Complete(); } catch (Exception e) { TraceException(e); } }
if (_errorOwner) { try { _error.Complete(); } catch (Exception e) { TraceException(e); } }
if (_progressOwner) { try { _progress.Complete(); } catch (Exception e) { TraceException(e); } }
if (_verboseOwner) { try { _verbose.Complete(); } catch (Exception e) { TraceException(e); } }
if (_warningOwner) { try { _warning.Complete(); } catch (Exception e) { TraceException(e); } }
if (_debugOwner) { try { _debug.Complete(); } catch (Exception e) { TraceException(e); } }
if (_informationOwner) { try { _information.Complete(); } catch (Exception e) { TraceException(e); } }
}
private static void TraceException(Exception e)
{
using (PowerShellTraceSource tracer = PowerShellTraceSourceFactory.GetTraceSource())
{
tracer.TraceException(e);
}
}
///
/// Gets the job for the specified location.
///
/// Collection of jobs.
internal List GetJobsForLocation(string location)
{
List returnJobList = new List();
foreach (Job job in ChildJobs)
{
if (string.Equals(job.Location, location, StringComparison.OrdinalIgnoreCase))
{
returnJobList.Add(job);
}
}
return returnJobList;
}
#endregion Private/Internal Methods
#region IDisposable Members
///
/// Dispose all managed resources. This will suppress finalizer on the object from getting called by
/// calling System.GC.SuppressFinalize(this).
///
public void Dispose()
{
Dispose(true);
// To prevent derived types with finalizers from having to re-implement System.IDisposable to call it,
// unsealed types without finalizers should still call SuppressFinalize.
System.GC.SuppressFinalize(this);
}
///
/// Release all the resources.
///
/// OutputProcessingStateChanged;
private bool _processingOutput;
///
/// MonitorOutputProcessing.
///
internal bool MonitorOutputProcessing
{
get;
set;
}
internal void SetMonitorOutputProcessing(IOutputProcessingState outputProcessingState)
{
if (outputProcessingState != null)
{
outputProcessingState.OutputProcessingStateChanged += HandleOutputProcessingStateChanged;
}
}
internal void RemoveMonitorOutputProcessing(IOutputProcessingState outputProcessingState)
{
if (outputProcessingState != null)
{
outputProcessingState.OutputProcessingStateChanged -= HandleOutputProcessingStateChanged;
}
}
private void HandleOutputProcessingStateChanged(object sender, OutputProcessingStateEventArgs e)
{
_processingOutput = e.ProcessingOutput;
OutputProcessingStateChanged.SafeInvoke(this, e);
}
#endregion
}
///
/// Top level job object for remoting. This contains multiple child job
/// objects. Each child job object invokes command on one remote machine.
///
///
/// Not removing the prefix "PS" as this signifies powershell specific remoting job
///
internal class PSRemotingJob : Job
{
#region Internal Constructors
///
/// Internal constructor for initializing PSRemotingJob using
/// computer names.
///
/// computerNameHelpers, string remoteCommand, string name)
: this(computerNames, computerNameHelpers, remoteCommand, 0, name)
{ }
///
/// Internal constructor for initializing job using
/// PSSession objects.
///
/// runspaceHelpers, string remoteCommand, string name)
: this(remoteRunspaceInfos, runspaceHelpers, remoteCommand, 0, name)
{ }
///
/// Internal constructor for initializing PSRemotingJob using
/// computer names.
///
/// computerNameHelpers, string remoteCommand,
int throttleLimit, string name)
: base(remoteCommand, name)
{
// Create child jobs for each object in the list
foreach (ExecutionCmdletHelperComputerName helper in computerNameHelpers)
{
// Create Child Job and Register for its StateChanged Event
PSRemotingChildJob childJob = new PSRemotingChildJob(remoteCommand,
helper, _throttleManager);
childJob.StateChanged += HandleChildJobStateChanged;
childJob.JobUnblocked += HandleJobUnblocked;
// Add this job to list of childjobs
ChildJobs.Add(childJob);
}
CommonInit(throttleLimit, computerNameHelpers);
}
///
/// Internal constructor for initializing job using
/// PSSession objects.
///
/// runspaceHelpers, string remoteCommand,
int throttleLimit, string name)
: base(remoteCommand, name)
{
// Create child jobs for each object in the list
for (int i = 0; i < remoteRunspaceInfos.Length; i++)
{
ExecutionCmdletHelperRunspace helper = (ExecutionCmdletHelperRunspace)runspaceHelpers[i];
// Create Child Job object and Register for its state changed event
PSRemotingChildJob job = new PSRemotingChildJob(remoteCommand,
helper, _throttleManager);
job.StateChanged += HandleChildJobStateChanged;
job.JobUnblocked += HandleJobUnblocked;
// Add the child job to list of child jobs
ChildJobs.Add(job);
}
CommonInit(throttleLimit, runspaceHelpers);
}
///
/// Creates a job object and child jobs for each disconnected pipeline/runspace
/// provided in the list of ExecutionCmdletHelperRunspace items. The runspace
/// object must have a remote running command that can be connected to.
/// Use Connect() method to transition to the connected state.
///
/// helpers,
int throttleLimit, string name, bool aggregateResults)
: base(string.Empty, name)
{
// All pipeline objects must be in "disconnected" state and associated to running
// remote commands. Once the jobs are connected they can be stopped using the
// ExecutionCmdletHelperRunspace object and ThrottleManager.
foreach (ExecutionCmdletHelper helper in helpers)
{
PSRemotingChildJob job = new PSRemotingChildJob(helper, _throttleManager, aggregateResults);
job.StateChanged += HandleChildJobStateChanged;
job.JobUnblocked += HandleJobUnblocked;
ChildJobs.Add(job);
}
// Since no results are produced by any streams. We should
// close all the streams.
base.CloseAllStreams();
// Set status to "disconnected".
SetJobState(JobState.Disconnected);
// Submit the disconnected operation helpers to the throttle manager
_throttleManager.ThrottleLimit = throttleLimit;
_throttleManager.SubmitOperations(helpers);
_throttleManager.EndSubmitOperations();
}
///
/// Default constructor.
///
protected PSRemotingJob() { }
///
/// Initialization common to both constructors.
///
private void CommonInit(int throttleLimit, List helpers)
{
// Since no results are produced by any streams. We should
// close all the streams
base.CloseAllStreams();
// set status to "in progress"
SetJobState(JobState.Running);
// submit operations to the throttle manager
_throttleManager.ThrottleLimit = throttleLimit;
_throttleManager.SubmitOperations(helpers);
_throttleManager.EndSubmitOperations();
}
#endregion Internal Constructors
#region internal methods
///
/// Get entity result for the specified computer.
///
/// Entity result.
internal List GetJobsForComputer(string computerName)
{
List returnJobList = new List();
foreach (Job j in ChildJobs)
{
if (j is not PSRemotingChildJob child) continue;
if (string.Equals(child.Runspace.ConnectionInfo.ComputerName, computerName,
StringComparison.OrdinalIgnoreCase))
{
returnJobList.Add(child);
}
}
return returnJobList;
}
///
/// Get entity result for the specified runspace.
///
/// Entity result.
internal List GetJobsForRunspace(PSSession runspace)
{
List returnJobList = new List();
foreach (Job j in ChildJobs)
{
if (j is not PSRemotingChildJob child) continue;
if (child.Runspace.InstanceId.Equals(runspace.InstanceId))
{
returnJobList.Add(child);
}
}
return returnJobList;
}
///
/// Get entity result for the specified helper object.
///
/// Entity result.
internal List GetJobsForOperation(IThrottleOperation operation)
{
List returnJobList = new List();
ExecutionCmdletHelper helper = operation as ExecutionCmdletHelper;
foreach (Job j in ChildJobs)
{
if (j is not PSRemotingChildJob child) continue;
if (child.Helper.Equals(helper))
{
returnJobList.Add(child);
}
}
return returnJobList;
}
#endregion internal methods
#region Connection Support
///
/// Connect all child jobs if they are in a disconnected state.
///
internal void ConnectJobs()
{
// Create connect operation objects for each child job object to connect.
List connectJobOperations = new List();
foreach (PSRemotingChildJob childJob in ChildJobs)
{
if (childJob.JobStateInfo.State == JobState.Disconnected)
{
connectJobOperations.Add(new ConnectJobOperation(childJob));
}
}
if (connectJobOperations.Count == 0)
{
return;
}
// Submit the connect job operation.
// Return only after the connect operation completes.
SubmitAndWaitForConnect(connectJobOperations);
}
///
/// Connect a single child job associated with the provided runspace.
///
/// connectJobOperations = new List();
PSRemotingChildJob childJob = FindDisconnectedChildJob(runspaceInstanceId);
if (childJob != null)
{
connectJobOperations.Add(new ConnectJobOperation(childJob));
}
if (connectJobOperations.Count == 0)
{
return;
}
// Submit the connect job operation.
// Return only after the connect operation completes.
SubmitAndWaitForConnect(connectJobOperations);
}
private static void SubmitAndWaitForConnect(List connectJobOperations)
{
using (ThrottleManager connectThrottleManager = new ThrottleManager())
{
using (ManualResetEvent connectResult = new ManualResetEvent(false))
{
EventHandler throttleCompleteEventHandler =
(object sender, EventArgs eventArgs) => connectResult.Set();
connectThrottleManager.ThrottleComplete += throttleCompleteEventHandler;
try
{
connectThrottleManager.ThrottleLimit = 0;
connectThrottleManager.SubmitOperations(connectJobOperations);
connectThrottleManager.EndSubmitOperations();
connectResult.WaitOne();
}
finally
{
connectThrottleManager.ThrottleComplete -= throttleCompleteEventHandler;
}
}
}
}
///
/// Simple throttle operation class for connecting jobs.
///
private sealed class ConnectJobOperation : IThrottleOperation
{
private readonly PSRemotingChildJob _psRemoteChildJob;
internal ConnectJobOperation(PSRemotingChildJob job)
{
_psRemoteChildJob = job;
_psRemoteChildJob.StateChanged += ChildJobStateChangedHandler;
}
internal override void StartOperation()
{
bool startedSuccessfully = true;
try
{
_psRemoteChildJob.ConnectAsync();
}
catch (InvalidJobStateException e)
{
startedSuccessfully = false;
string msg = StringUtil.Format(RemotingErrorIdStrings.JobConnectFailed, _psRemoteChildJob.Name);
Exception reason = new RuntimeException(msg, e);
ErrorRecord errorRecord = new ErrorRecord(reason, "PSJobConnectFailed", ErrorCategory.InvalidOperation, _psRemoteChildJob);
_psRemoteChildJob.WriteError(errorRecord);
}
if (!startedSuccessfully)
{
RemoveEventCallback();
SendStartComplete();
}
}
internal override void StopOperation()
{
RemoveEventCallback();
// Cannot stop a connect attempt.
OperationStateEventArgs operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.OperationState = OperationState.StopComplete;
OperationComplete.SafeInvoke(this, operationStateEventArgs);
}
internal override event EventHandler OperationComplete;
private void ChildJobStateChangedHandler(object sender, JobStateEventArgs eArgs)
{
if (eArgs.JobStateInfo.State == JobState.Disconnected)
{
return;
}
RemoveEventCallback();
SendStartComplete();
}
private void SendStartComplete()
{
OperationStateEventArgs operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.OperationState = OperationState.StartComplete;
OperationComplete.SafeInvoke(this, operationStateEventArgs);
}
private void RemoveEventCallback()
{
_psRemoteChildJob.StateChanged -= ChildJobStateChangedHandler;
}
}
///
/// Finds the disconnected child job associated with this runspace and returns
/// the PowerShell object that is remotely executing the command.
///
/// Associated PowerShell object.
internal PowerShell GetAssociatedPowerShellObject(Guid runspaceInstanceId)
{
PowerShell ps = null;
PSRemotingChildJob childJob = FindDisconnectedChildJob(runspaceInstanceId);
if (childJob != null)
{
ps = childJob.GetPowerShell();
}
return ps;
}
///
/// Helper method to find a disconnected child job associated with
/// a given runspace.
///
/// PSRemotingChildJob object.
private PSRemotingChildJob FindDisconnectedChildJob(Guid runspaceInstanceId)
{
PSRemotingChildJob rtnJob = null;
foreach (PSRemotingChildJob childJob in this.ChildJobs)
{
if ((childJob.Runspace.InstanceId.Equals(runspaceInstanceId)) &&
(childJob.JobStateInfo.State == JobState.Disconnected))
{
rtnJob = childJob;
break;
}
}
return rtnJob;
}
///
/// Internal method to stop a job without first connecting it if it is in
/// a disconnected state. This supports Receive-PSSession where it abandons
/// a currently running/disconnected job when user selects -OutTarget Host.
///
internal void InternalStopJob()
{
if (_isDisposed || _stopIsCalled || IsFinishedState(JobStateInfo.State))
{
return;
}
lock (_syncObject)
{
if (_isDisposed || _stopIsCalled || IsFinishedState(JobStateInfo.State))
{
return;
}
_stopIsCalled = true;
}
_throttleManager.StopAllOperations();
Finished.WaitOne();
}
#endregion
private bool _moreData = true;
///
/// Indicates if more data is available.
///
///
/// This has more data if any of the child jobs have more data.
///
public override bool HasMoreData
{
get
{
// moreData is initially set to true, and it
// will remain so until the async result
// object has completed execution.
if (_moreData && IsFinishedState(JobStateInfo.State))
{
bool atleastOneChildHasMoreData = false;
for (int i = 0; i < ChildJobs.Count; i++)
{
if (ChildJobs[i].HasMoreData)
{
atleastOneChildHasMoreData = true;
break;
}
}
_moreData = atleastOneChildHasMoreData;
}
return _moreData;
}
}
private bool _stopIsCalled = false;
///
/// Stop Job.
///
public override void StopJob()
{
// If the job is in a disconnected state then try to connect it
// so that it can be stopped on the server.
if (JobStateInfo.State == JobState.Disconnected)
{
bool ConnectSuccessful;
try
{
ConnectJobs();
ConnectSuccessful = true;
}
catch (InvalidRunspaceStateException)
{
ConnectSuccessful = false;
}
catch (PSRemotingTransportException)
{
ConnectSuccessful = false;
}
catch (PSInvalidOperationException)
{
ConnectSuccessful = false;
}
if (!ConnectSuccessful && this.Error.IsOpen)
{
string msg = StringUtil.Format(RemotingErrorIdStrings.StopJobNotConnected, this.Name);
Exception reason = new RuntimeException(msg);
ErrorRecord errorRecord = new ErrorRecord(reason, "StopJobCannotConnectToServer",
ErrorCategory.InvalidOperation, this);
WriteError(errorRecord);
return;
}
}
InternalStopJob();
}
private string _statusMessage;
///
/// Message indicating status of the job.
///
public override string StatusMessage
{
get
{
return _statusMessage;
}
}
///
/// Used by Invoke-Command cmdlet to show/hide computername property value.
/// Format and Output has capability to understand RemoteObjects and this property lets
/// Format and Output decide whether to show/hide computername.
/// Default is true.
///
internal bool HideComputerName
{
get
{
return _hideComputerName;
}
set
{
_hideComputerName = value;
foreach (Job job in this.ChildJobs)
{
PSRemotingChildJob rJob = job as PSRemotingChildJob;
if (rJob != null)
{
rJob.HideComputerName = value;
}
}
}
}
private bool _hideComputerName = true;
// ISSUE: Implement StatusMessage
///
/// Checks the status of remote command execution.
///
[SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
private void SetStatusMessage()
{
_statusMessage = "test";
// bool localErrors = false; // if local errors are present
// bool setFinished = false; // if finished needs to be set
// statusMessage = "OK";
// lock (syncObject)
// {
// if (finishedCount == ChildJobs.Count)
// {
// // ISSUE: Change this code to look in to child jobs for exception
// if (errors.Count > 0)
// {
// statusMessage = "LocalErrors";
// localErrors = true;
// }
// // check for status of remote command
// for (int i = 0; i < ChildJobs.Count; i++)
// {
// PSRemotingChildJob childJob = ChildJobs[i] as PSRemotingChildJob;
// if (childJob == null) continue;
// if (childJob.ContainsErrors)
// {
// if (localErrors)
// {
// statusMessage = "LocalAndRemoteErrors";
// }
// else
// {
// statusMessage = "RemoteErrors";
// }
// break;
// }
// }
// setFinished = true;
// }
// }
}
#region finish logic
// This variable is set to true if at least one child job failed.
private bool _atleastOneChildJobFailed = false;
// count of number of child jobs which have finished
private int _finishedChildJobsCount = 0;
// count of number of child jobs which are blocked
private int _blockedChildJobsCount = 0;
// count of child jobs that are in disconnected state.
private int _disconnectedChildJobsCount = 0;
// count of child jobs that are in Debug halted state.
private int _debugChildJobsCount = 0;
///
/// Handles the StateChanged event from each of the child job objects.
///
///
/// Updates the parent job state based on state of all child jobs.
///
///
/// Release all the resources.
///
///
/// Computers on which this job is running.
///
public override string Location
{
get
{
return ConstructLocation();
}
}
///
/// Returns boolean indicating whether the underlying
/// transport for the job (or child jobs) supports
/// connect/disconnect semantics.
///
internal override bool CanDisconnect
{
get
{
// If one child job can disconnect then all of them can since
// all child jobs use the same remote runspace transport.
return (ChildJobs.Count > 0) && ChildJobs[0].CanDisconnect;
}
}
///
/// Returns runspaces associated with the Job, including
/// child jobs.
///
/// IEnumerable of RemoteRunspaces.
internal override IEnumerable GetRunspaces()
{
List runspaces = new List();
foreach (PSRemotingChildJob job in ChildJobs)
{
runspaces.Add(job.Runspace as RemoteRunspace);
}
return runspaces;
}
///
/// Handles JobUnblocked event from a child job and decrements
/// count of blocked child jobs. When count reaches 0, sets the
/// state of the parent job to running.
///
///
/// Simple throttle operation class for PSRemoting jobs created in the
/// disconnected state.
///
internal class DisconnectedJobOperation : ExecutionCmdletHelper
{
internal DisconnectedJobOperation(Pipeline pipeline)
{
this.pipeline = pipeline;
this.pipeline.StateChanged += HandlePipelineStateChanged;
}
internal override void StartOperation()
{
// This is a no-op since disconnected jobs (pipelines) have
// already been started.
}
internal override void StopOperation()
{
if (pipeline.PipelineStateInfo.State == PipelineState.Running ||
pipeline.PipelineStateInfo.State == PipelineState.Disconnected ||
pipeline.PipelineStateInfo.State == PipelineState.NotStarted)
{
// If the pipeline state has reached Complete/Failed/Stopped
// by the time control reaches here, then this operation
// becomes a no-op. However, an OperationComplete would have
// already been raised from the handler.
pipeline.StopAsync();
}
else
{
// Will have to raise OperationComplete from here,
// else ThrottleManager will have
SendStopComplete();
}
}
internal override event EventHandler OperationComplete;
private void HandlePipelineStateChanged(object sender, PipelineStateEventArgs stateEventArgs)
{
PipelineStateInfo stateInfo = stateEventArgs.PipelineStateInfo;
switch (stateInfo.State)
{
case PipelineState.Running:
case PipelineState.NotStarted:
case PipelineState.Stopping:
case PipelineState.Disconnected:
return;
}
SendStopComplete(stateEventArgs);
}
private void SendStopComplete(EventArgs eventArgs = null)
{
OperationStateEventArgs operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.BaseEvent = eventArgs;
operationStateEventArgs.OperationState = OperationState.StopComplete;
OperationComplete.SafeInvoke(this, operationStateEventArgs);
}
}
#endregion
///
/// Class for RemotingChildJob object. This job object invokes command
/// on one remote machine.
///
///
/// TODO: I am not sure whether to change this internal to just RemotingChildJob.
///
///
/// Not removing the prefix "PS" as this signifies powershell specific remoting job
///
internal class PSRemotingChildJob : Job, IJobDebugger
{
#region Internal Constructor
///
/// Creates an instance of PSRemotingChildJob.
///
///
/// Constructs a disconnected child job that is able to connect to a remote
/// runspace/command on a server. The ExecutionCmdletHelperRunspace must
/// contain a remote pipeline object in a disconnected state. In addition
/// the pipeline runspace must be associated with a valid running remote
/// command that can be connected to.
///
///
/// Default constructor.
///
protected PSRemotingChildJob()
{
}
#endregion Internal Constructor
#region Internal Methods
///
/// Connects the remote pipeline that this job represents.
///
internal void ConnectAsync()
{
if (JobStateInfo.State != JobState.Disconnected)
{
throw new InvalidJobStateException(JobStateInfo.State);
}
_remotePipeline.ConnectAsync();
}
#endregion
#region stop
// bool isStopCalled = false;
///
/// Stops the job.
///
public override void StopJob()
{
if (_isDisposed || _stopIsCalled || IsFinishedState(JobStateInfo.State))
{
return;
}
lock (SyncObject)
{
if (_isDisposed || _stopIsCalled || IsFinishedState(JobStateInfo.State))
{
return;
}
_stopIsCalled = true;
}
_throttleManager.StopOperation(Helper);
// if IgnoreStop is set, then StopOperation will
// return immediately, but StopJob should only
// return when job is complete. Waiting on the
// wait handle will ensure that its blocked
// until the job reaches a terminal state
Finished.WaitOne();
}
#endregion stop
#region Properties
///
/// Status Message associated with the Job.
///
public override string StatusMessage
{
get
{
// ISSUE implement this.
return string.Empty;
}
}
///
/// Indicates if there is more data available in
/// this Job.
///
public override bool HasMoreData
{
get
{
return (Results.IsOpen || Results.Count > 0);
}
}
///
/// Returns the computer on which this command is
/// running.
///
public override string Location
{
get
{
return (Runspace != null) ? Runspace.ConnectionInfo.ComputerName : string.Empty;
}
}
///
///
public Runspace Runspace { get; }
///
/// Helper associated with this entity.
///
internal ExecutionCmdletHelper Helper { get; } = null;
///
/// Used by Invoke-Command cmdlet to show/hide computername property value.
/// Format and Output has capability to understand RemoteObjects and this property lets
/// Format and Output decide whether to show/hide computername.
/// Default is true.
///
internal bool HideComputerName
{
get
{
return _hideComputerName;
}
set
{
_hideComputerName = value;
foreach (Job job in this.ChildJobs)
{
PSRemotingChildJob rJob = job as PSRemotingChildJob;
if (rJob != null)
{
rJob.HideComputerName = value;
}
}
}
}
private bool _hideComputerName = true;
///
/// Property that indicates this disconnected child job was
/// previously in the Blocked state.
///
internal bool DisconnectedAndBlocked { get; private set; } = false;
///
/// Returns boolean indicating whether the underlying
/// transport for the job (or child jobs) supports
/// connect/disconnect semantics.
///
internal override bool CanDisconnect
{
get
{
RemoteRunspace remoteRS = Runspace as RemoteRunspace;
return remoteRS != null && remoteRS.CanDisconnect;
}
}
#endregion Properties
#region IJobDebugger
///
/// Job Debugger.
///
public Debugger Debugger
{
get
{
if (_jobDebugger == null)
{
lock (this.SyncObject)
{
if ((_jobDebugger == null) &&
(Runspace.Debugger != null))
{
_jobDebugger = new RemotingJobDebugger(Runspace.Debugger, Runspace, this.Name);
}
}
}
return _jobDebugger;
}
}
///
/// True if job is synchronous and can be debugged.
///
public bool IsAsync
{
get { return _isAsync; }
set { _isAsync = true; }
}
#endregion
#region Private Methods
///
/// Handler which will handle output ready events of the
/// pipeline. The output objects are queued on to the
/// internal stream.
///
/// reader =
sender as PSDataCollectionPipelineReader;
Collection output = reader.NonBlockingRead();
foreach (PSObject dataObject in output)
{
// attach origin information only if it doesn't exist
// in case of a second-hop scenario, the origin information
// will already be added at the second hop machine
if (dataObject != null)
{
// if the server has already added some properties, which we do not
// want to trust, we simply replace them with the server's
// identity we know of
if (dataObject.Properties[RemotingConstants.ComputerNameNoteProperty] != null)
{
dataObject.Properties.Remove(RemotingConstants.ComputerNameNoteProperty);
}
if (dataObject.Properties[RemotingConstants.RunspaceIdNoteProperty] != null)
{
dataObject.Properties.Remove(RemotingConstants.RunspaceIdNoteProperty);
}
dataObject.Properties.Add(new PSNoteProperty(RemotingConstants.ComputerNameNoteProperty, reader.ComputerName));
dataObject.Properties.Add(new PSNoteProperty(RemotingConstants.RunspaceIdNoteProperty, reader.RunspaceId));
// PSShowComputerName is present for all the objects (from remoting)..this is to allow PSComputerName to be selected.
// Ex: Invoke-Command localhost,blah { gps } | select PSComputerName should work.
if (dataObject.Properties[RemotingConstants.ShowComputerNameNoteProperty] == null)
{
PSNoteProperty showComputerNameNP = new PSNoteProperty(RemotingConstants.ShowComputerNameNoteProperty, !_hideComputerName);
dataObject.Properties.Add(showComputerNameNP);
}
}
this.WriteObject(dataObject);
}
}
///
/// Handler which will handle error ready events of the
/// pipeline. The error records are queued on to the
/// internal stream.
///
/// reader =
sender as PSDataCollectionPipelineReader;
Collection error = reader.NonBlockingRead();
foreach (object errorData in error)
{
ErrorRecord er = errorData as ErrorRecord;
if (er != null)
{
OriginInfo originInfo = new OriginInfo(reader.ComputerName, reader.RunspaceId);
RemotingErrorRecord errorRecord =
new RemotingErrorRecord(er, originInfo);
errorRecord.PreserveInvocationInfoOnce = true;
// ISSUE: Add an Assert for ErrorRecord.
// Add to the PSRemotingChild jobs streams
this.WriteError(errorRecord);
}
}
}
///
/// When the client remote session reports a URI redirection, this method will report the
/// message to the user as a Warning using Host method calls.
///
/// eventArgs)
{
string message = StringUtil.Format(RemotingErrorIdStrings.URIRedirectWarningToHost, eventArgs.Data.OriginalString);
this.WriteWarning(message);
}
///
/// Handle method executor stream events.
///
/// hostCallMethodExecutors =
hostCallsStream.NonBlockingRead(hostCallsStream.Count);
lock (SyncObject)
{
foreach (ClientMethodExecutor hostCallMethodExecutor in hostCallMethodExecutors)
{
Results.Add(new PSStreamObject(PSStreamObjectType.MethodExecutor, hostCallMethodExecutor));
// if the call id of the underlying remote host call is not ServerDispatchTable.VoidCallId
// then the call is waiting on user input. Change state to Blocked
if (hostCallMethodExecutor.RemoteHostCall.CallId != ServerDispatchTable.VoidCallId)
{
SetJobState(JobState.Blocked, null);
}
}
}
}
}
///
/// Handle changes in pipeline states.
///
///
/// Handle a throttle complete event.
///
///
/// Handle the operation complete event.
///
///
/// This method marks the completion state for Job. Also if job failed, it processes the
/// reason of failure.
///
protected virtual void DoFinish()
{
if (_doFinishCalled)
return;
lock (SyncObject)
{
if (_doFinishCalled)
return;
_doFinishCalled = true;
}
DeterminedAndSetJobState(Helper);
DoCleanupOnFinished();
}
///
/// This is the pretty formated error record associated with the reason of failure.
///
private ErrorRecord _failureErrorRecord;
///
/// This is the pretty formated error record associated with the reason of failure.
/// This is set if Job state is Failed and Reason has a exception.
///
internal ErrorRecord FailureErrorRecord
{
get
{
return _failureErrorRecord;
}
}
///
/// Process the exceptions to decide reason for job failure.
///
///
/// Release all the resources.
///
///
/// Cleanup after state changes to finished.
///
protected virtual void DoCleanupOnFinished()
{
bool doCleanup = false;
if (!_cleanupDone)
{
lock (SyncObject)
{
if (!_cleanupDone)
{
_cleanupDone = true;
doCleanup = true;
}
}
}
if (!doCleanup) return;
StopAggregateResultsFromHelper(Helper);
Runspace.AvailabilityChanged -= HandleRunspaceAvailabilityChanged;
IThrottleOperation operation = Helper as IThrottleOperation;
operation.OperationComplete -= HandleOperationComplete;
UnregisterThrottleComplete(_throttleManager);
_throttleManager = null;
}
///
/// Aggregates results from the pipeline associated
/// with the specified helper.
///
///
/// If the pipeline is not null, returns the pipeline's PowerShell
/// If it is null, then returns the PowerShell with the specified
/// instance Id.
///
/// PowerShell instance.
private PowerShell GetPipelinePowerShell(RemotePipeline pipeline, Guid instanceId)
{
if (pipeline != null)
{
return pipeline.PowerShell;
}
return GetPowerShell(instanceId);
}
///
/// When a debug message is raised in the underlying PowerShell
/// add it to the jobs debug stream.
///
///
/// When a verbose message is raised in the underlying PowerShell
/// add it to the jobs verbose stream.
///
///
/// When a warning message is raised in the underlying PowerShell
/// add it to the jobs warning stream.
///
///
/// When a progress message is raised in the underlying PowerShell
/// add it to the jobs progress tream.
///
///
/// When a Information message is raised in the underlying PowerShell
/// add it to the jobs Information stream.
///
///
/// Stops collecting results from the pipeline associated with
/// the specified helper.
///
///
/// Removes aggregate callbacks from pipeline so that a new job object can
/// be created and can add its own callbacks.
/// This is to support Invoke-Command auto-disconnect where a new PSRemoting
/// job must be created to pass back to user for connection.
///
///
/// Register for throttle complete from the specified
/// throttlemanager.
///
///
/// Unregister for throttle complete from the specified
/// throttle manager.
///
///
/// Determine the current state of the job based on the underlying
/// pipeline state and set the state accordingly.
///
///
/// Set the state of the current job from blocked to
/// running and raise an event indicating to this
/// parent job that this job is unblocked.
///
internal void UnblockJob()
{
Dbg.Assert(JobStateInfo.State == JobState.Blocked,
"Current state of job must be blocked before it can be unblocked");
SetJobState(JobState.Running, null);
Dbg.Assert(JobUnblocked != null, "Parent job must register for JobUnblocked event from all child jobs");
JobUnblocked.SafeInvoke(this, EventArgs.Empty);
}
///
/// Returns the PowerShell for the specified instance id.
///
/// Powershell instance.
internal virtual PowerShell GetPowerShell(Guid instanceId)
{
// this should be called only in the derived implementation
throw PSTraceSource.NewInvalidOperationException();
}
///
/// Returns the PowerShell object associated with this remote child job.
///
/// PowerShell object.
internal PowerShell GetPowerShell()
{
PowerShell ps = null;
if (_remotePipeline != null)
{
ps = _remotePipeline.PowerShell;
}
return ps;
}
///
/// Monitor runspace availability and if it goes to RemoteDebug then set
/// job state to Debug. Set back to Running when availability goes back to
/// Busy (indicating the script/command is running again).
///
///
/// Event raised by this job to indicate to its parent that
/// its now unblocked by the user.
///
internal event EventHandler JobUnblocked;
#endregion Private Methods
#region Private Members
// helper associated with this job object
private readonly RemotePipeline _remotePipeline = null;
// object used for synchronization
protected object SyncObject = new object();
private ThrottleManager _throttleManager;
private bool _stopIsCalled = false;
private volatile Debugger _jobDebugger;
private bool _isAsync = true;
private RunspaceAvailability _prevRunspaceAvailability = RunspaceAvailability.None;
#endregion Private Members
}
///
/// This is a debugger wrapper class used to allow debugging of
/// remoting jobs that implement the IJobDebugger interface.
///
internal sealed class RemotingJobDebugger : Debugger
{
#region Members
private readonly Debugger _wrappedDebugger;
private readonly Runspace _runspace;
private readonly string _jobName;
#endregion
#region Constructor
private RemotingJobDebugger() { }
///
/// Constructor.
///
///
/// Evaluates provided command either as a debugger specific command
/// or a PowerShell command.
///
/// DebuggerCommandResults.
public override DebuggerCommandResults ProcessCommand(PSCommand command, PSDataCollection output)
{
// Special handling for the prompt command.
if (command.Commands[0].CommandText.Trim().Equals("prompt", StringComparison.OrdinalIgnoreCase))
{
return HandlePromptCommand(output);
}
return _wrappedDebugger.ProcessCommand(command, output);
}
///
/// Adds the provided set of breakpoints to the debugger.
///
/// breakpoints, int? runspaceId) =>
_wrappedDebugger.SetBreakpoints(breakpoints, runspaceId);
///
/// Get a breakpoint by id, primarily for Enable/Disable/Remove-PSBreakpoint cmdlets.
///
/// A breakpoint with the specified id.
public override Breakpoint GetBreakpoint(int id, int? runspaceId) =>
_wrappedDebugger.GetBreakpoint(id, runspaceId);
///
/// Returns breakpoints on a runspace.
///
/// A list of breakpoints in a runspace.
public override List GetBreakpoints(int? runspaceId) =>
_wrappedDebugger.GetBreakpoints(runspaceId);
///
/// Sets a command breakpoint in the debugger.
///
/// The command breakpoint that was set.
public override CommandBreakpoint SetCommandBreakpoint(string command, ScriptBlock action, string path, int? runspaceId) =>
_wrappedDebugger.SetCommandBreakpoint(command, action, path, runspaceId);
///
/// Sets a line breakpoint in the debugger.
///
/// The line breakpoint that was set.
public override LineBreakpoint SetLineBreakpoint(string path, int line, int column, ScriptBlock action, int? runspaceId) =>
_wrappedDebugger.SetLineBreakpoint(path, line, column, action, runspaceId);
///
/// Sets a variable breakpoint in the debugger.
///
/// The variable breakpoint that was set.
public override VariableBreakpoint SetVariableBreakpoint(string variableName, VariableAccessMode accessMode, ScriptBlock action, string path, int? runspaceId) =>
_wrappedDebugger.SetVariableBreakpoint(variableName, accessMode, action, path, runspaceId);
///
/// Removes a breakpoint from the debugger.
///
/// True if the breakpoint was removed from the debugger; false otherwise.
public override bool RemoveBreakpoint(Breakpoint breakpoint, int? runspaceId) =>
_wrappedDebugger.RemoveBreakpoint(breakpoint, runspaceId);
///
/// Enables a breakpoint in the debugger.
///
/// The updated breakpoint if it was found; null if the breakpoint was not found in the debugger.
public override Breakpoint EnableBreakpoint(Breakpoint breakpoint, int? runspaceId) =>
_wrappedDebugger.EnableBreakpoint(breakpoint, runspaceId);
///
/// Disables a breakpoint in the debugger.
///
/// The updated breakpoint if it was found; null if the breakpoint was not found in the debugger.
public override Breakpoint DisableBreakpoint(Breakpoint breakpoint, int? runspaceId) =>
_wrappedDebugger.DisableBreakpoint(breakpoint, runspaceId);
///
/// Sets the debugger resume action.
///
///
/// Stops a running command.
///
public override void StopProcessCommand()
{
_wrappedDebugger.StopProcessCommand();
}
///
/// Returns current debugger stop event arguments if debugger is in
/// debug stop state. Otherwise returns null.
///
/// DebuggerStopEventArgs.
public override DebuggerStopEventArgs GetDebuggerStopArgs()
{
return _wrappedDebugger.GetDebuggerStopArgs();
}
///
/// Sets the parent debugger, breakpoints, and other debugging context information.
///
/// breakPoints,
DebuggerResumeAction? startAction,
PSHost host,
PathInfo path)
{
// For now always enable step mode debugging.
SetDebuggerStepMode(true);
}
///
/// Sets the debugger mode.
///
public override void SetDebugMode(DebugModes mode)
{
_wrappedDebugger.SetDebugMode(mode);
base.SetDebugMode(mode);
}
///
/// Returns IEnumerable of CallStackFrame objects.
///
/// GetCallStack()
{
return _wrappedDebugger.GetCallStack();
}
///
/// Sets debugger stepping mode.
///
///
/// CheckStateAndRaiseStopEvent.
///
internal void CheckStateAndRaiseStopEvent()
{
RemoteDebugger remoteDebugger = _wrappedDebugger as RemoteDebugger;
remoteDebugger?.CheckStateAndRaiseStopEvent();
}
///
/// True when debugger is stopped at a breakpoint.
///
public override bool InBreakpoint
{
get { return _wrappedDebugger.InBreakpoint; }
}
#endregion
#region Private methods
private void HandleDebuggerStop(object sender, DebuggerStopEventArgs e)
{
Pipeline remoteRunningCmd = null;
try
{
// For remote debugging drain/block output channel.
remoteRunningCmd = DrainAndBlockRemoteOutput();
this.RaiseDebuggerStopEvent(e);
}
finally
{
RestoreRemoteOutput(remoteRunningCmd);
}
}
private Pipeline DrainAndBlockRemoteOutput()
{
// We only do this for remote runspaces.
if (_runspace is not RemoteRunspace) { return null; }
Pipeline runningCmd = _runspace.GetCurrentlyRunningPipeline();
if (runningCmd != null)
{
runningCmd.DrainIncomingData();
runningCmd.SuspendIncomingData();
return runningCmd;
}
return null;
}
private static void RestoreRemoteOutput(Pipeline runningCmd) => runningCmd?.ResumeIncomingData();
private void HandleBreakpointUpdated(object sender, BreakpointUpdatedEventArgs e)
{
this.RaiseBreakpointUpdatedEvent(e);
}
private DebuggerCommandResults HandlePromptCommand(PSDataCollection output)
{
// Nested debugged runspace prompt should look like:
// [DBG]: [JobName]: PS C:\>>
string promptScript = "'[DBG]: '" + " + " + "'[" + CodeGeneration.EscapeSingleQuotedStringContent(_jobName) + "]: '" + " + " + @"""PS $($executionContext.SessionState.Path.CurrentLocation)>> """;
PSCommand promptCommand = new PSCommand();
promptCommand.AddScript(promptScript);
_wrappedDebugger.ProcessCommand(promptCommand, output);
return new DebuggerCommandResults(null, true);
}
#endregion
}
///
/// This job is used for running as a job the results from multiple
/// pipelines. This is used in synchronous Invoke-Expression execution.
///
///
/// TODO: I am not sure whether to change this internal to just InvokeExpressionSyncJob.
///
///
/// Not removing the prefix "PS" as this signifies powershell specific remoting job
///
internal class PSInvokeExpressionSyncJob : PSRemotingChildJob
{
#region Private Members
private readonly List _helpers = new List();
private readonly ThrottleManager _throttleManager;
private readonly Dictionary _powershells = new Dictionary();
private int _pipelineFinishedCount;
private int _pipelineDisconnectedCount;
#endregion Private Members
#region Constructors
///
/// Construct an invoke-expression sync job.
///
/// operations, ThrottleManager throttleManager)
{
UsesResultsCollection = true;
Results.AddRef();
_throttleManager = throttleManager;
RegisterThrottleComplete(_throttleManager);
foreach (IThrottleOperation operation in operations)
{
ExecutionCmdletHelper helper = operation as ExecutionCmdletHelper;
RemoteRunspace remoteRS = helper.Pipeline.Runspace as RemoteRunspace;
if (remoteRS != null)
{
remoteRS.StateChanged += HandleRunspaceStateChanged;
if (remoteRS.RunspaceStateInfo.State == RunspaceState.BeforeOpen)
{
remoteRS.URIRedirectionReported += HandleURIDirectionReported;
}
}
_helpers.Add(helper);
AggregateResultsFromHelper(helper);
Dbg.Assert(helper.Pipeline is RemotePipeline, "Only remote pipeline can be used in InvokeExpressionSyncJob");
RemotePipeline pipeline = helper.Pipeline as RemotePipeline;
_powershells.Add(pipeline.PowerShell.InstanceId, pipeline.PowerShell);
}
}
#endregion Constructors
#region Protected Methods
private bool _cleanupDone = false;
///
/// Clean up once job is finished.
///
protected override void DoCleanupOnFinished()
{
bool doCleanup = false;
if (!_cleanupDone)
{
lock (SyncObject)
{
if (!_cleanupDone)
{
_cleanupDone = true;
doCleanup = true;
}
}
}
if (!doCleanup) return;
foreach (ExecutionCmdletHelper helper in _helpers)
{
// cleanup remote runspace related handlers
RemoteRunspace remoteRS = helper.PipelineRunspace as RemoteRunspace;
if (remoteRS != null)
{
remoteRS.StateChanged -= HandleRunspaceStateChanged;
remoteRS.URIRedirectionReported -= HandleURIDirectionReported;
}
StopAggregateResultsFromHelper(helper);
}
UnregisterThrottleComplete(_throttleManager);
// throttleManager = null;
Results.DecrementRef();
}
///
/// Release all resources.
///
///
/// Handles operation complete from the operations. Adds an error record
/// to results whenever an error is encountered.
///
///
/// Handle changes in pipeline states.
///
///
/// Checks for a condition where all pipelines are either finished
/// or disconnected and at least one pipeline is disconnected.
/// In this case the Job state is set to Disconnected.
///
private void CheckForAndSetDisconnectedState(PipelineState pipelineState)
{
bool setJobStateToDisconnected;
lock (SyncObject)
{
if (IsTerminalState())
{
return;
}
switch (pipelineState)
{
case PipelineState.Completed:
case PipelineState.Failed:
case PipelineState.Stopped:
_pipelineFinishedCount += 1;
break;
case PipelineState.Disconnected:
_pipelineDisconnectedCount += 1;
break;
}
setJobStateToDisconnected = ((_pipelineFinishedCount + _pipelineDisconnectedCount) == _helpers.Count &&
_pipelineDisconnectedCount > 0);
}
if (setJobStateToDisconnected)
{
// Job cannot finish with pipelines in disconnected state.
// Set Job state to Disconnected.
SetJobState(JobState.Disconnected);
}
}
///
/// Used to stop all operations.
///
public override void StopJob()
{
_throttleManager.StopAllOperations();
}
private bool _doFinishCalled = false;
///
/// This method marks the completion state for Job. Also if job failed, it processes the
/// reason of failure.
///
protected override void DoFinish()
{
if (_doFinishCalled)
return;
lock (SyncObject)
{
if (_doFinishCalled)
return;
_doFinishCalled = true;
}
foreach (ExecutionCmdletHelper helper in _helpers)
{
DeterminedAndSetJobState(helper);
}
if (_helpers.Count == 0 && this.JobStateInfo.State == JobState.NotStarted)
{
SetJobState(JobState.Completed);
}
DoCleanupOnFinished();
}
///
/// Returns the PowerShell instance for the specified id.
///
/// PowerShell instance.
internal override PowerShell GetPowerShell(Guid instanceId)
{
PowerShell powershell = null;
_powershells.TryGetValue(instanceId, out powershell);
return powershell;
}
#endregion Protected Methods
#region Event Handlers
///
/// Used to unregister URI Redirection handler.
///
///
/// Submits the operations created in the constructor for invocation.
///
internal void StartOperations(List operations)
{
// submit operations to the throttle manager
_throttleManager.SubmitOperations(operations);
_throttleManager.EndSubmitOperations();
}
///
/// Determines if the job is in a terminal state.
///
/// True, if job in terminal state
/// false otherwise.
internal bool IsTerminalState()
{
return (IsFinishedState(this.JobStateInfo.State) ||
this.JobStateInfo.State == JobState.Disconnected);
}
///
/// Returns a collection of all powershells for this job.
///
/// Collection of PowerShell objects.
internal Collection GetPowerShells()
{
Collection powershellsToReturn = new Collection();
foreach (PowerShell ps in _powershells.Values)
{
powershellsToReturn.Add(ps);
}
return powershellsToReturn;
}
///
/// Returns a disconnected remoting job object that contains all
/// remote pipelines/runspaces that are in the Disconnected state.
///
/// disconnectedJobHelpers = new List();
foreach (var helper in _helpers)
{
if (helper.Pipeline.PipelineStateInfo.State == PipelineState.Disconnected)
{
// Remove data callbacks from the old helper.
RemoveAggreateCallbacksFromHelper(helper);
// Create new helper used to create the new Disconnected PSRemoting job.
disconnectedJobHelpers.Add(new DisconnectedJobOperation(helper.Pipeline));
}
}
if (disconnectedJobHelpers.Count == 0)
{
return null;
}
return new PSRemotingJob(disconnectedJobHelpers, 0, Name, true);
}
#endregion Internal Methods
}
#region OutputProcessingState class
internal class OutputProcessingStateEventArgs : EventArgs
{
internal bool ProcessingOutput { get; }
internal OutputProcessingStateEventArgs(bool processingOutput)
{
ProcessingOutput = processingOutput;
}
}
#nullable enable
internal interface IOutputProcessingState
{
event EventHandler? OutputProcessingStateChanged;
}
#endregion
}