Windows-powershell / PowerShell-master /src /Microsoft.PowerShell.Commands.Management /commands /management /WMIHelper.cs
| // Copyright (c) Microsoft Corporation. | |
| // Licensed under the MIT License. | |
| using System; | |
| using System.Collections; | |
| using System.Collections.ObjectModel; | |
| using System.ComponentModel; | |
| using System.Diagnostics.CodeAnalysis; | |
| using System.Globalization; | |
| using System.Management; | |
| using System.Management.Automation; | |
| using System.Management.Automation.Internal; | |
| using System.Management.Automation.Provider; | |
| using System.Management.Automation.Remoting; | |
| using System.Runtime.InteropServices; | |
| using System.Security.AccessControl; | |
| using System.Text; | |
| using System.Threading; | |
| using Microsoft.PowerShell.Commands.Internal; | |
| using Dbg = System.Management.Automation; | |
| namespace Microsoft.PowerShell.Commands | |
| { | |
| /// <summary> | |
| /// Base class for all WMI helper classes. This is an abstract class | |
| /// and the helpers need to derive from this. | |
| /// </summary> | |
| internal abstract class AsyncCmdletHelper : IThrottleOperation | |
| { | |
| /// <summary> | |
| /// Exception raised internally when any method of this class | |
| /// is executed. | |
| /// </summary> | |
| internal Exception InternalException | |
| { | |
| get | |
| { | |
| return internalException; | |
| } | |
| } | |
| protected Exception internalException = null; | |
| } | |
| /// <summary> | |
| /// This class is responsible for creating WMI connection for getting objects and notifications | |
| /// from WMI asynchronously. This spawns a new thread to connect to WMI on remote machine. | |
| /// This allows the main thread to return faster and not blocked on network hops. | |
| /// </summary> | |
| internal class WmiAsyncCmdletHelper : AsyncCmdletHelper | |
| { | |
| /// <summary> | |
| /// Internal Constructor. | |
| /// </summary> | |
| /// <param name="childJob">Job associated with this operation.</param> | |
| /// <param name="wmiObject">Object associated with this operation.</param> | |
| /// <param name="computerName">Computer on which the operation is invoked.</param> | |
| /// <param name="results">Sink to get wmi objects.</param> | |
| internal WmiAsyncCmdletHelper(PSWmiChildJob childJob, Cmdlet wmiObject, string computerName, ManagementOperationObserver results) | |
| { | |
| _wmiObject = wmiObject; | |
| _computerName = computerName; | |
| _results = results; | |
| this.State = WmiState.NotStarted; | |
| _job = childJob; | |
| } | |
| /// <summary> | |
| /// Internal Constructor. This variant takes a count parameter that determines how many times | |
| /// the WMI command is executed. | |
| /// </summary> | |
| /// <param name="childJob">Job associated with this operation.</param> | |
| /// <param name="wmiObject">Object associated with this operation.</param> | |
| /// <param name="computerName">Computer on which the operation is invoked.</param> | |
| /// <param name="results">Sink to return wmi objects.</param> | |
| /// <param name="count">Number of times the WMI command is executed.</param> | |
| internal WmiAsyncCmdletHelper(PSWmiChildJob childJob, Cmdlet wmiObject, string computerName, ManagementOperationObserver results, int count) | |
| : this(childJob, wmiObject, computerName, results) | |
| { | |
| _cmdCount = count; | |
| } | |
| private string _computerName; | |
| internal event EventHandler<WmiJobStateEventArgs> WmiOperationState; | |
| internal event EventHandler<EventArgs> ShutdownComplete; | |
| private ManagementOperationObserver _results; | |
| private int _cmdCount = 1; | |
| private PSWmiChildJob _job; | |
| /// <summary> | |
| /// Current operation state. | |
| /// </summary> | |
| internal WmiState State | |
| { | |
| get { return _state; } | |
| set { _state = value; } | |
| } | |
| private WmiState _state; | |
| /// <summary> | |
| /// Cancel WMI connection. | |
| /// </summary> | |
| internal override void StopOperation() | |
| { | |
| _results.Cancel(); | |
| _state = WmiState.Stopped; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| /// <summary> | |
| /// Uses this.filter, this.wmiClass and this.property to retrieve the filter. | |
| /// </summary> | |
| private string GetWmiQueryString() | |
| { | |
| GetWmiObjectCommand getObject = (GetWmiObjectCommand)_wmiObject; | |
| StringBuilder returnValue = new StringBuilder("select "); | |
| returnValue.Append(string.Join(", ", getObject.Property)); | |
| returnValue.Append(" from "); | |
| returnValue.Append(getObject.Class); | |
| if (!string.IsNullOrEmpty(getObject.Filter)) | |
| { | |
| returnValue.Append(" where "); | |
| returnValue.Append(getObject.Filter); | |
| } | |
| return returnValue.ToString(); | |
| } | |
| /// <summary> | |
| /// Do WMI connection by creating another thread based on type of request and return immediately. | |
| /// </summary> | |
| internal override void StartOperation() | |
| { | |
| Thread thread; | |
| if (_wmiObject.GetType() == typeof(GetWmiObjectCommand)) | |
| { | |
| thread = new Thread(new ThreadStart(ConnectGetWMI)); | |
| } | |
| else if (_wmiObject.GetType() == typeof(RemoveWmiObject)) | |
| { | |
| thread = new Thread(new ThreadStart(ConnectRemoveWmi)); | |
| } | |
| else if (_wmiObject is InvokeWmiMethod) | |
| { | |
| thread = new Thread(new ThreadStart(ConnectInvokeWmi)); | |
| } | |
| else if (_wmiObject is SetWmiInstance) | |
| { | |
| thread = new Thread(new ThreadStart(ConnectSetWmi)); | |
| } | |
| else | |
| { | |
| InvalidOperationException exception = new InvalidOperationException("This operation is not supported for this cmdlet."); | |
| internalException = exception; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| thread.IsBackground = true; | |
| thread.SetApartmentState(ApartmentState.STA); | |
| thread.Start(); | |
| } | |
| /// <summary> | |
| /// </summary> | |
| internal override event EventHandler<OperationStateEventArgs> OperationComplete; | |
| private Cmdlet _wmiObject; | |
| /// <summary> | |
| /// Raise operation completion event. | |
| /// </summary> | |
| internal void RaiseOperationCompleteEvent(EventArgs baseEventArgs, OperationState state) | |
| { | |
| OperationStateEventArgs operationStateEventArgs = new OperationStateEventArgs(); | |
| operationStateEventArgs.OperationState = state; | |
| OperationComplete.SafeInvoke(this, operationStateEventArgs); | |
| } | |
| /// <summary> | |
| /// Raise WMI state changed event | |
| /// </summary> | |
| internal void RaiseWmiOperationState(EventArgs baseEventArgs, WmiState state) | |
| { | |
| WmiJobStateEventArgs wmiJobStateEventArgs = new WmiJobStateEventArgs(); | |
| wmiJobStateEventArgs.WmiState = state; | |
| WmiOperationState.SafeInvoke(this, wmiJobStateEventArgs); | |
| } | |
| /// <summary> | |
| /// Do the actual connection to remote machine for Set-WMIInstance cmdlet and raise operation complete event. | |
| /// </summary> | |
| private void ConnectSetWmi() | |
| { | |
| SetWmiInstance setObject = (SetWmiInstance)_wmiObject; | |
| _state = WmiState.Running; | |
| RaiseWmiOperationState(null, WmiState.Running); | |
| if (setObject.InputObject != null) | |
| { | |
| ManagementObject mObj = null; | |
| try | |
| { | |
| PutOptions pOptions = new PutOptions(); | |
| // Extra check | |
| if (setObject.InputObject.GetType() == typeof(ManagementClass)) | |
| { | |
| // Check if Flag specified is CreateOnly or not | |
| if (setObject.flagSpecified && setObject.PutType != PutType.CreateOnly) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("CreateOnlyFlagNotSpecifiedWithClassPath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| mObj = ((ManagementClass)setObject.InputObject).CreateInstance(); | |
| setObject.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| // Check if Flag specified is Updateonly or UpdateOrCreateOnly or not | |
| if (setObject.flagSpecified) | |
| { | |
| if (!(setObject.PutType == PutType.UpdateOnly || setObject.PutType == PutType.UpdateOrCreate)) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("NonUpdateFlagSpecifiedWithInstancePath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| } | |
| else | |
| { | |
| setObject.PutType = PutType.UpdateOrCreate; | |
| } | |
| mObj = (ManagementObject)setObject.InputObject.Clone(); | |
| } | |
| if (setObject.Arguments != null) | |
| { | |
| IDictionaryEnumerator en = setObject.Arguments.GetEnumerator(); | |
| while (en.MoveNext()) | |
| { | |
| mObj[en.Key as string] = en.Value; | |
| } | |
| } | |
| pOptions.Type = setObject.PutType; | |
| if (mObj != null) | |
| { | |
| mObj.Put(_results, pOptions); | |
| } | |
| else | |
| { | |
| InvalidOperationException exp = new InvalidOperationException(); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| else | |
| { | |
| ManagementPath mPath = null; | |
| // If Class is specified only CreateOnly flag is supported | |
| if (setObject.Class != null) | |
| { | |
| if (setObject.flagSpecified && setObject.PutType != PutType.CreateOnly) | |
| { | |
| InvalidOperationException exp = new InvalidOperationException("CreateOnlyFlagNotSpecifiedWithClassPath"); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| setObject.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| mPath = new ManagementPath(setObject.Path); | |
| if (string.IsNullOrEmpty(mPath.NamespacePath)) | |
| { | |
| mPath.NamespacePath = setObject.Namespace; | |
| } | |
| else if (setObject.namespaceSpecified) | |
| { | |
| InvalidOperationException exp = new InvalidOperationException("NamespaceSpecifiedWithPath"); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| if (mPath.Server != "." && setObject.serverNameSpecified) | |
| { | |
| InvalidOperationException exp = new InvalidOperationException("ComputerNameSpecifiedWithPath"); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| if (mPath.IsClass) | |
| { | |
| if (setObject.flagSpecified && setObject.PutType != PutType.CreateOnly) | |
| { | |
| InvalidOperationException exp = new InvalidOperationException("CreateOnlyFlagNotSpecifiedWithClassPath"); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| setObject.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| if (setObject.flagSpecified) | |
| { | |
| if (!(setObject.PutType == PutType.UpdateOnly || setObject.PutType == PutType.UpdateOrCreate)) | |
| { | |
| InvalidOperationException exp = new InvalidOperationException("NonUpdateFlagSpecifiedWithInstancePath"); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| } | |
| else | |
| { | |
| setObject.PutType = PutType.UpdateOrCreate; | |
| } | |
| } | |
| } | |
| // If server name is specified loop through it. | |
| if (mPath != null) | |
| { | |
| if (!(mPath.Server == "." && setObject.serverNameSpecified)) | |
| { | |
| _computerName = mPath.Server; | |
| } | |
| } | |
| ConnectionOptions options = setObject.GetConnectionOption(); | |
| ManagementObject mObject = null; | |
| try | |
| { | |
| if (setObject.Path != null) | |
| { | |
| mPath.Server = _computerName; | |
| ManagementScope mScope = new ManagementScope(mPath, options); | |
| if (mPath.IsClass) | |
| { | |
| ManagementClass mClass = new ManagementClass(mPath); | |
| mClass.Scope = mScope; | |
| mObject = mClass.CreateInstance(); | |
| } | |
| else | |
| { | |
| // This can throw if path does not exist caller should catch it. | |
| ManagementObject mInstance = new ManagementObject(mPath); | |
| mInstance.Scope = mScope; | |
| try | |
| { | |
| mInstance.Get(); | |
| } | |
| catch (ManagementException e) | |
| { | |
| if (e.ErrorCode != ManagementStatus.NotFound) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| int namespaceIndex = setObject.Path.IndexOf(':'); | |
| if (namespaceIndex == -1) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| int classIndex = (setObject.Path.Substring(namespaceIndex)).IndexOf('.'); | |
| if (classIndex == -1) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| // Get class object and create instance. | |
| string newPath = setObject.Path.Substring(0, classIndex + namespaceIndex); | |
| ManagementPath classPath = new ManagementPath(newPath); | |
| ManagementClass mClass = new ManagementClass(classPath); | |
| mClass.Scope = mScope; | |
| mInstance = mClass.CreateInstance(); | |
| } | |
| mObject = mInstance; | |
| } | |
| } | |
| else | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, setObject.Namespace), options); | |
| ManagementClass mClass = new ManagementClass(setObject.Class); | |
| mClass.Scope = scope; | |
| mObject = mClass.CreateInstance(); | |
| } | |
| if (setObject.Arguments != null) | |
| { | |
| IDictionaryEnumerator en = setObject.Arguments.GetEnumerator(); | |
| while (en.MoveNext()) | |
| { | |
| mObject[en.Key as string] = en.Value; | |
| } | |
| } | |
| PutOptions pOptions = new PutOptions(); | |
| pOptions.Type = setObject.PutType; | |
| if (mObject != null) | |
| { | |
| mObject.Put(_results, pOptions); | |
| } | |
| else | |
| { | |
| InvalidOperationException exp = new InvalidOperationException(); | |
| internalException = exp; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// Do the actual connection to remote machine for Invoke-WMIMethod cmdlet and raise operation complete event. | |
| /// </summary> | |
| private void ConnectInvokeWmi() | |
| { | |
| InvokeWmiMethod invokeObject = (InvokeWmiMethod)_wmiObject; | |
| _state = WmiState.Running; | |
| RaiseWmiOperationState(null, WmiState.Running); | |
| if (invokeObject.InputObject != null) | |
| { | |
| ManagementBaseObject inputParameters = null; | |
| try | |
| { | |
| inputParameters = invokeObject.InputObject.GetMethodParameters(invokeObject.Name); | |
| if (invokeObject.ArgumentList != null) | |
| { | |
| int inParamCount = invokeObject.ArgumentList.Length; | |
| foreach (PropertyData property in inputParameters.Properties) | |
| { | |
| if (inParamCount == 0) | |
| break; | |
| property.Value = invokeObject.ArgumentList[invokeObject.ArgumentList.Length - inParamCount]; | |
| inParamCount--; | |
| } | |
| } | |
| invokeObject.InputObject.InvokeMethod(_results, invokeObject.Name, inputParameters, null); | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| return; | |
| } | |
| else | |
| { | |
| ConnectionOptions options = invokeObject.GetConnectionOption(); | |
| ManagementPath mPath = null; | |
| ManagementObject mObject = null; | |
| if (invokeObject.Path != null) | |
| { | |
| mPath = new ManagementPath(invokeObject.Path); | |
| if (string.IsNullOrEmpty(mPath.NamespacePath)) | |
| { | |
| mPath.NamespacePath = invokeObject.Namespace; | |
| } | |
| else if (invokeObject.namespaceSpecified) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("NamespaceSpecifiedWithPath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| if (mPath.Server != "." && invokeObject.serverNameSpecified) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("ComputerNameSpecifiedWithPath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| // If server name is specified loop through it. | |
| if (!(mPath.Server == "." && invokeObject.serverNameSpecified)) | |
| { | |
| _computerName = mPath.Server; | |
| } | |
| } | |
| bool isLocal = false, needToEnablePrivilege = false; | |
| PlatformInvokes.TOKEN_PRIVILEGE currentPrivilegeState = new PlatformInvokes.TOKEN_PRIVILEGE(); | |
| try | |
| { | |
| needToEnablePrivilege = NeedToEnablePrivilege(_computerName, invokeObject.Name, ref isLocal); | |
| if (needToEnablePrivilege) | |
| { | |
| if (!(isLocal && PlatformInvokes.EnableTokenPrivilege(ComputerWMIHelper.SE_SHUTDOWN_NAME, ref currentPrivilegeState)) && | |
| !(!isLocal && PlatformInvokes.EnableTokenPrivilege(ComputerWMIHelper.SE_REMOTE_SHUTDOWN_NAME, ref currentPrivilegeState))) | |
| { | |
| string message = | |
| StringUtil.Format(ComputerResources.PrivilegeNotEnabled, _computerName, | |
| isLocal ? ComputerWMIHelper.SE_SHUTDOWN_NAME : ComputerWMIHelper.SE_REMOTE_SHUTDOWN_NAME); | |
| InvalidOperationException e = new InvalidOperationException(message); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| } | |
| if (invokeObject.Path != null) | |
| { | |
| mPath.Server = _computerName; | |
| if (mPath.IsClass) | |
| { | |
| ManagementClass mClass = new ManagementClass(mPath); | |
| mObject = mClass; | |
| } | |
| else | |
| { | |
| ManagementObject mInstance = new ManagementObject(mPath); | |
| mObject = mInstance; | |
| } | |
| ManagementScope mScope = new ManagementScope(mPath, options); | |
| mObject.Scope = mScope; | |
| } | |
| else | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, invokeObject.Namespace), options); | |
| ManagementClass mClass = new ManagementClass(invokeObject.Class); | |
| mObject = mClass; | |
| mObject.Scope = scope; | |
| } | |
| ManagementBaseObject inputParameters = mObject.GetMethodParameters(invokeObject.Name); | |
| if (invokeObject.ArgumentList != null) | |
| { | |
| int inParamCount = invokeObject.ArgumentList.Length; | |
| foreach (PropertyData property in inputParameters.Properties) | |
| { | |
| if (inParamCount == 0) | |
| break; | |
| property.Value = invokeObject.ArgumentList[invokeObject.ArgumentList.Length - inParamCount]; | |
| inParamCount--; | |
| } | |
| } | |
| if (needToEnablePrivilege) | |
| { | |
| ManagementBaseObject result = mObject.InvokeMethod(invokeObject.Name, inputParameters, null); | |
| Dbg.Diagnostics.Assert(result != null, "result cannot be null if the Join method is invoked"); | |
| int returnCode = Convert.ToInt32(result["ReturnValue"], CultureInfo.CurrentCulture); | |
| if (returnCode != 0) | |
| { | |
| var e = new Win32Exception(returnCode); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| else | |
| { | |
| ShutdownComplete.SafeInvoke(this, null); | |
| } | |
| } | |
| else | |
| { | |
| mObject.InvokeMethod(_results, invokeObject.Name, inputParameters, null); | |
| } | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| finally | |
| { | |
| // Restore the previous privilege state if something unexpected happened | |
| if (needToEnablePrivilege) | |
| { | |
| PlatformInvokes.RestoreTokenPrivilege( | |
| isLocal ? ComputerWMIHelper.SE_SHUTDOWN_NAME : ComputerWMIHelper.SE_REMOTE_SHUTDOWN_NAME, ref currentPrivilegeState); | |
| } | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// Check if we need to enable the shutdown privilege. | |
| /// </summary> | |
| /// <param name="computer"></param> | |
| /// <param name="methodName"></param> | |
| /// <param name="isLocal"></param> | |
| /// <returns></returns> | |
| private bool NeedToEnablePrivilege(string computer, string methodName, ref bool isLocal) | |
| { | |
| bool result = false; | |
| if (methodName.Equals("Win32Shutdown", StringComparison.OrdinalIgnoreCase)) | |
| { | |
| result = true; | |
| // CLR 4.0 Port note - use https://msdn.microsoft.com/library/system.net.networkinformation.ipglobalproperties.hostname(v=vs.110).aspx | |
| string localName = System.Net.Dns.GetHostName(); | |
| // And for this, use PsUtils.GetHostname() | |
| string localFullName = System.Net.Dns.GetHostEntry(string.Empty).HostName; | |
| if (computer.Equals(".") || computer.Equals("localhost", StringComparison.OrdinalIgnoreCase) || | |
| computer.Equals(localName, StringComparison.OrdinalIgnoreCase) || | |
| computer.Equals(localFullName, StringComparison.OrdinalIgnoreCase)) | |
| { | |
| isLocal = true; | |
| } | |
| } | |
| return result; | |
| } | |
| /// <summary> | |
| /// Do the actual connection to remote machine for Remove-WMIObject cmdlet and raise operation complete event. | |
| /// </summary> | |
| private void ConnectRemoveWmi() | |
| { | |
| RemoveWmiObject removeObject = (RemoveWmiObject)_wmiObject; | |
| _state = WmiState.Running; | |
| RaiseWmiOperationState(null, WmiState.Running); | |
| if (removeObject.InputObject != null) | |
| { | |
| try | |
| { | |
| removeObject.InputObject.Delete(_results); | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| return; | |
| } | |
| else | |
| { | |
| ConnectionOptions options = removeObject.GetConnectionOption(); | |
| ManagementPath mPath = null; | |
| ManagementObject mObject = null; | |
| if (removeObject.Path != null) | |
| { | |
| mPath = new ManagementPath(removeObject.Path); | |
| if (string.IsNullOrEmpty(mPath.NamespacePath)) | |
| { | |
| mPath.NamespacePath = removeObject.Namespace; | |
| } | |
| else if (removeObject.namespaceSpecified) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("NamespaceSpecifiedWithPath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| if (mPath.Server != "." && removeObject.serverNameSpecified) | |
| { | |
| InvalidOperationException e = new InvalidOperationException("ComputerNameSpecifiedWithPath"); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| if (!(mPath.Server == "." && removeObject.serverNameSpecified)) | |
| { | |
| _computerName = mPath.Server; | |
| } | |
| } | |
| try | |
| { | |
| if (removeObject.Path != null) | |
| { | |
| mPath.Server = _computerName; | |
| if (mPath.IsClass) | |
| { | |
| ManagementClass mClass = new ManagementClass(mPath); | |
| mObject = mClass; | |
| } | |
| else | |
| { | |
| ManagementObject mInstance = new ManagementObject(mPath); | |
| mObject = mInstance; | |
| } | |
| ManagementScope mScope = new ManagementScope(mPath, options); | |
| mObject.Scope = mScope; | |
| } | |
| else | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, removeObject.Namespace), options); | |
| ManagementClass mClass = new ManagementClass(removeObject.Class); | |
| mObject = mClass; | |
| mObject.Scope = scope; | |
| } | |
| mObject.Delete(_results); | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// Do the actual connection to remote machine for Get-WMIObject cmdlet and raise operation complete event. | |
| /// </summary> | |
| private void ConnectGetWMI() | |
| { | |
| GetWmiObjectCommand getObject = (GetWmiObjectCommand)_wmiObject; | |
| _state = WmiState.Running; | |
| RaiseWmiOperationState(null, WmiState.Running); | |
| ConnectionOptions options = getObject.GetConnectionOption(); | |
| if (getObject.List.IsPresent) | |
| { | |
| if (!getObject.ValidateClassFormat()) | |
| { | |
| ArgumentException e = new ArgumentException( | |
| string.Format( | |
| Thread.CurrentThread.CurrentCulture, | |
| "Class", getObject.Class)); | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| try | |
| { | |
| if (getObject.Recurse.IsPresent) | |
| { | |
| ArrayList namespaceArray = new ArrayList(); | |
| ArrayList sinkArray = new ArrayList(); | |
| ArrayList connectArray = new ArrayList(); // Optimization for remote namespace | |
| int currentNamespaceCount = 0; | |
| namespaceArray.Add(getObject.Namespace); | |
| bool topNamespace = true; | |
| while (currentNamespaceCount < namespaceArray.Count) | |
| { | |
| string connectNamespace = (string)namespaceArray[currentNamespaceCount]; | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, connectNamespace), options); | |
| scope.Connect(); | |
| ManagementClass namespaceClass = new ManagementClass(scope, new ManagementPath("__Namespace"), new ObjectGetOptions()); | |
| foreach (ManagementBaseObject obj in namespaceClass.GetInstances()) | |
| { | |
| if (!getObject.IsLocalizedNamespace((string)obj["Name"])) | |
| { | |
| namespaceArray.Add(connectNamespace + "\\" + obj["Name"]); | |
| } | |
| } | |
| if (topNamespace) | |
| { | |
| topNamespace = false; | |
| sinkArray.Add(_results); | |
| } | |
| else | |
| { | |
| sinkArray.Add(_job.GetNewSink()); | |
| } | |
| connectArray.Add(scope); | |
| currentNamespaceCount++; | |
| } | |
| if ((sinkArray.Count != namespaceArray.Count) || (connectArray.Count != namespaceArray.Count)) // not expected throw exception | |
| { | |
| internalException = new InvalidOperationException(); | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| return; | |
| } | |
| currentNamespaceCount = 0; | |
| while (currentNamespaceCount < namespaceArray.Count) | |
| { | |
| string connectNamespace = (string)namespaceArray[currentNamespaceCount]; | |
| ManagementObjectSearcher searcher = getObject.GetObjectList((ManagementScope)connectArray[currentNamespaceCount]); | |
| if (searcher == null) | |
| { | |
| currentNamespaceCount++; | |
| continue; | |
| } | |
| if (topNamespace) | |
| { | |
| topNamespace = false; | |
| searcher.Get(_results); | |
| } | |
| else | |
| { | |
| searcher.Get((ManagementOperationObserver)sinkArray[currentNamespaceCount]); | |
| } | |
| currentNamespaceCount++; | |
| } | |
| } | |
| else | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, getObject.Namespace), options); | |
| scope.Connect(); | |
| ManagementObjectSearcher searcher = getObject.GetObjectList(scope); | |
| if (searcher == null) | |
| throw new ManagementException(); | |
| searcher.Get(_results); | |
| } | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| return; | |
| } | |
| string queryString = string.IsNullOrEmpty(getObject.Query) ? GetWmiQueryString() : getObject.Query; | |
| ObjectQuery query = new ObjectQuery(queryString.ToString()); | |
| try | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(_computerName, getObject.Namespace), options); | |
| EnumerationOptions enumOptions = new EnumerationOptions(); | |
| enumOptions.UseAmendedQualifiers = getObject.Amended; | |
| enumOptions.DirectRead = getObject.DirectRead; | |
| ManagementObjectSearcher searcher = new ManagementObjectSearcher(scope, query, enumOptions); | |
| // Execute the WMI command for each count value. | |
| for (int i = 0; i < _cmdCount; ++i) | |
| { | |
| searcher.Get(_results); | |
| } | |
| } | |
| catch (ManagementException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.Runtime.InteropServices.COMException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| catch (System.UnauthorizedAccessException e) | |
| { | |
| internalException = e; | |
| _state = WmiState.Failed; | |
| RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// Event which will be triggered when WMI state is changed. | |
| /// Currently it is to notify Jobs that state has changed to running. | |
| /// Other states are notified via OperationComplete. | |
| /// </summary> | |
| internal sealed class WmiJobStateEventArgs : EventArgs | |
| { | |
| /// <summary> | |
| /// WMI state | |
| /// </summary> | |
| internal WmiState WmiState { get; set; } | |
| } | |
| /// <summary> | |
| /// Enumerated type defining the state of the WMI operation. | |
| /// </summary> | |
| public enum WmiState | |
| { | |
| /// <summary> | |
| /// The operation has not been started. | |
| /// </summary> | |
| NotStarted = 0, | |
| /// <summary> | |
| /// The operation is executing. | |
| /// </summary> | |
| Running = 1, | |
| /// <summary> | |
| /// The operation is stoping execution. | |
| /// </summary> | |
| Stopping = 2, | |
| /// <summary> | |
| /// The operation is completed due to a stop request. | |
| /// </summary> | |
| Stopped = 3, | |
| /// <summary> | |
| /// The operation has completed. | |
| /// </summary> | |
| Completed = 4, | |
| /// <summary> | |
| /// The operation completed abnormally due to an error. | |
| /// </summary> | |
| Failed = 5, | |
| } | |
| internal static class WMIHelper | |
| { | |
| internal static string GetScopeString(string computer, string namespaceParameter) | |
| { | |
| StringBuilder returnValue = new StringBuilder("\\\\"); | |
| returnValue.Append(computer); | |
| returnValue.Append('\\'); | |
| returnValue.Append(namespaceParameter); | |
| return returnValue.ToString(); | |
| } | |
| } | |
| /// <summary> | |
| /// A class to set WMI connection options. | |
| /// </summary> | |
| public class WmiBaseCmdlet : Cmdlet | |
| { | |
| /// <summary> | |
| /// Perform Async operation. | |
| /// </summary> | |
| [] | |
| public SwitchParameter AsJob { get; set; } = false; | |
| /// <summary> | |
| /// The Impersonation level to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public ImpersonationLevel Impersonation { get; set; } = ImpersonationLevel.Impersonate; | |
| /// <summary> | |
| /// The Authentication level to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public AuthenticationLevel Authentication { get; set; } = AuthenticationLevel.PacketPrivacy; | |
| /// <summary> | |
| /// The Locale to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public string Locale { get; set; } = null; | |
| /// <summary> | |
| /// If all Privileges are enabled. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public SwitchParameter EnableAllPrivileges { get; set; } | |
| /// <summary> | |
| /// The Authority to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public string Authority { get; set; } = null; | |
| /// <summary> | |
| /// The credential to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public PSCredential Credential { get; set; } | |
| /// <summary> | |
| /// The credential to use. | |
| /// </summary> | |
| [] | |
| public Int32 ThrottleLimit { get; set; } = s_DEFAULT_THROTTLE_LIMIT; | |
| /// <summary> | |
| /// The ComputerName in which to query. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public string[] ComputerName | |
| { | |
| get { return _computerName; } | |
| set { _computerName = value; serverNameSpecified = true; } | |
| } | |
| /// <summary> | |
| /// The WMI namespace to use. | |
| /// </summary> | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| [] | |
| public string Namespace | |
| { | |
| get { return _nameSpace; } | |
| set { _nameSpace = value; namespaceSpecified = true; } | |
| } | |
| /// <summary> | |
| /// The computer to query. | |
| /// </summary> | |
| private string[] _computerName = new string[] { "localhost" }; | |
| /// <summary> | |
| /// WMI namespace. | |
| /// </summary> | |
| private string _nameSpace = "root\\cimv2"; | |
| /// <summary> | |
| /// Specify if namespace was specified or not. | |
| /// </summary> | |
| internal bool namespaceSpecified = false; | |
| /// <summary> | |
| /// Specify if server name was specified or not. | |
| /// </summary> | |
| internal bool serverNameSpecified = false; | |
| private static int s_DEFAULT_THROTTLE_LIMIT = 32; // maximum number of items to be processed at a time | |
| /// <summary> | |
| /// Get connection options. | |
| /// </summary> | |
| internal ConnectionOptions GetConnectionOption() | |
| { | |
| ConnectionOptions options; | |
| options = new ConnectionOptions(); | |
| options.Authentication = this.Authentication; | |
| options.Locale = this.Locale; | |
| options.Authority = this.Authority; | |
| options.EnablePrivileges = this.EnableAllPrivileges; | |
| options.Impersonation = this.Impersonation; | |
| if (this.Credential != null) | |
| { | |
| if (!(this.Credential.UserName == null && this.Credential.Password == null)) // Empty credential, use implicit credential | |
| { | |
| options.Username = this.Credential.UserName; | |
| options.SecurePassword = this.Credential.Password; | |
| } | |
| } | |
| return options; | |
| } | |
| /// <summary> | |
| /// Set wmi instance helper. | |
| /// </summary> | |
| internal ManagementObject SetWmiInstanceGetObject(ManagementPath mPath, string serverName) | |
| { | |
| ConnectionOptions options = GetConnectionOption(); | |
| ManagementObject mObject = null; | |
| var setObject = this as SetWmiInstance; | |
| if (setObject != null) | |
| { | |
| if (setObject.Path != null) | |
| { | |
| mPath.Server = serverName; | |
| ManagementScope mScope = new ManagementScope(mPath, options); | |
| if (mPath.IsClass) | |
| { | |
| ManagementClass mClass = new ManagementClass(mPath); | |
| mClass.Scope = mScope; | |
| mObject = mClass.CreateInstance(); | |
| } | |
| else | |
| { | |
| // This can throw if path does not exist caller should catch it. | |
| ManagementObject mInstance = new ManagementObject(mPath); | |
| mInstance.Scope = mScope; | |
| try | |
| { | |
| mInstance.Get(); | |
| } | |
| catch (ManagementException e) | |
| { | |
| if (e.ErrorCode != ManagementStatus.NotFound) | |
| { | |
| throw; | |
| } | |
| int namespaceIndex = setObject.Path.IndexOf(':'); | |
| if (namespaceIndex == -1) | |
| { | |
| throw; | |
| } | |
| int classIndex = (setObject.Path.Substring(namespaceIndex)).IndexOf('.'); | |
| if (classIndex == -1) | |
| { | |
| throw; | |
| } | |
| // Get class object and create instance. | |
| string newPath = setObject.Path.Substring(0, classIndex + namespaceIndex); | |
| ManagementPath classPath = new ManagementPath(newPath); | |
| ManagementClass mClass = new ManagementClass(classPath); | |
| mClass.Scope = mScope; | |
| mInstance = mClass.CreateInstance(); | |
| } | |
| mObject = mInstance; | |
| } | |
| } | |
| else | |
| { | |
| ManagementScope scope = new ManagementScope(WMIHelper.GetScopeString(serverName, setObject.Namespace), options); | |
| ManagementClass mClass = new ManagementClass(setObject.Class); | |
| mClass.Scope = scope; | |
| mObject = mClass.CreateInstance(); | |
| } | |
| if (setObject.Arguments != null) | |
| { | |
| IDictionaryEnumerator en = setObject.Arguments.GetEnumerator(); | |
| while (en.MoveNext()) | |
| { | |
| mObject[en.Key as string] = en.Value; | |
| } | |
| } | |
| } | |
| return mObject; | |
| } | |
| /// <summary> | |
| /// Set wmi instance helper for building management path. | |
| /// </summary> | |
| internal ManagementPath SetWmiInstanceBuildManagementPath() | |
| { | |
| ManagementPath mPath = null; | |
| var wmiInstance = this as SetWmiInstance; | |
| if (wmiInstance != null) | |
| { | |
| // If Class is specified only CreateOnly flag is supported | |
| if (wmiInstance.Class != null) | |
| { | |
| if (wmiInstance.flagSpecified && wmiInstance.PutType != PutType.CreateOnly) | |
| { | |
| // Throw Terminating error | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "CreateOnlyFlagNotSpecifiedWithClassPath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.PutType)); | |
| } | |
| wmiInstance.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| mPath = new ManagementPath(wmiInstance.Path); | |
| if (string.IsNullOrEmpty(mPath.NamespacePath)) | |
| { | |
| mPath.NamespacePath = wmiInstance.Namespace; | |
| } | |
| else if (wmiInstance.namespaceSpecified) | |
| { | |
| // ThrowTerminatingError | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "NamespaceSpecifiedWithPath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.Namespace)); | |
| } | |
| if (mPath.Server != "." && wmiInstance.serverNameSpecified) | |
| { | |
| // ThrowTerminatingError | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "ComputerNameSpecifiedWithPath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.ComputerName)); | |
| } | |
| if (mPath.IsClass) | |
| { | |
| if (wmiInstance.flagSpecified && wmiInstance.PutType != PutType.CreateOnly) | |
| { | |
| // Throw Terminating error | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "CreateOnlyFlagNotSpecifiedWithClassPath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.PutType)); | |
| } | |
| wmiInstance.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| if (wmiInstance.flagSpecified) | |
| { | |
| if (!(wmiInstance.PutType == PutType.UpdateOnly || wmiInstance.PutType == PutType.UpdateOrCreate)) | |
| { | |
| // Throw terminating error | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "NonUpdateFlagSpecifiedWithInstancePath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.PutType)); | |
| } | |
| } | |
| else | |
| { | |
| wmiInstance.PutType = PutType.UpdateOrCreate; | |
| } | |
| } | |
| } | |
| } | |
| return mPath; | |
| } | |
| /// <summary> | |
| /// Set wmi instance helper for pipeline input. | |
| /// </summary> | |
| internal ManagementObject SetWmiInstanceGetPipelineObject() | |
| { | |
| // Should only be called from Set-WMIInstance cmdlet | |
| ManagementObject mObj = null; | |
| var wmiInstance = this as SetWmiInstance; | |
| if (wmiInstance != null) | |
| { | |
| // Extra check | |
| if (wmiInstance.InputObject != null) | |
| { | |
| if (wmiInstance.InputObject.GetType() == typeof(ManagementClass)) | |
| { | |
| // Check if Flag specified is CreateOnly or not | |
| if (wmiInstance.flagSpecified && wmiInstance.PutType != PutType.CreateOnly) | |
| { | |
| // Throw terminating error | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "CreateOnlyFlagNotSpecifiedWithClassPath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.PutType)); | |
| } | |
| mObj = ((ManagementClass)wmiInstance.InputObject).CreateInstance(); | |
| wmiInstance.PutType = PutType.CreateOnly; | |
| } | |
| else | |
| { | |
| // Check if Flag specified is Updateonly or UpdateOrCreateOnly or not | |
| if (wmiInstance.flagSpecified) | |
| { | |
| if (!(wmiInstance.PutType == PutType.UpdateOnly || wmiInstance.PutType == PutType.UpdateOrCreate)) | |
| { | |
| // Throw terminating error | |
| ThrowTerminatingError(new ErrorRecord( | |
| new InvalidOperationException(), | |
| "NonUpdateFlagSpecifiedWithInstancePath", | |
| ErrorCategory.InvalidOperation, | |
| wmiInstance.PutType)); | |
| } | |
| } | |
| else | |
| { | |
| wmiInstance.PutType = PutType.UpdateOrCreate; | |
| } | |
| mObj = (ManagementObject)wmiInstance.InputObject.Clone(); | |
| } | |
| if (wmiInstance.Arguments != null) | |
| { | |
| IDictionaryEnumerator en = wmiInstance.Arguments.GetEnumerator(); | |
| while (en.MoveNext()) | |
| { | |
| mObj[en.Key as string] = en.Value; | |
| } | |
| } | |
| } | |
| } | |
| return mObj; | |
| } | |
| /// <summary> | |
| /// Start this cmdlet as a WMI job... | |
| /// </summary> | |
| internal void RunAsJob(string cmdletName) | |
| { | |
| PSWmiJob wmiJob = new PSWmiJob(this, ComputerName, this.ThrottleLimit, Job.GetCommandTextFromInvocationInfo(this.MyInvocation)); | |
| if (_context != null) | |
| { | |
| ((System.Management.Automation.Runspaces.LocalRunspace)_context.CurrentRunspace).JobRepository.Add(wmiJob); | |
| } | |
| WriteObject(wmiJob); | |
| } | |
| // Get the PowerShell execution context if it's available at cmdlet creation time... | |
| private System.Management.Automation.ExecutionContext _context = System.Management.Automation.Runspaces.LocalPipeline.GetExecutionContextFromTLS(); | |
| } | |
| /// <summary> | |
| /// A class to perform async operations for WMI cmdlets. | |
| /// </summary> | |
| internal class PSWmiJob : Job | |
| { | |
| /// <summary> | |
| ///Internal constructor for initializing WMI jobs. | |
| /// </summary> | |
| internal PSWmiJob(Cmdlet cmds, string[] computerName, int throttleLimt, string command) | |
| : base(command, null) | |
| { | |
| PSJobTypeName = WMIJobType; | |
| _throttleManager.ThrottleLimit = throttleLimt; | |
| for (int i = 0; i < computerName.Length; i++) | |
| { | |
| PSWmiChildJob job = new PSWmiChildJob(cmds, computerName[i], _throttleManager); | |
| job.StateChanged += new EventHandler<JobStateEventArgs>(HandleChildJobStateChanged); | |
| job.JobUnblocked += new EventHandler(HandleJobUnblocked); | |
| ChildJobs.Add(job); | |
| } | |
| CommonInit(throttleLimt); | |
| } | |
| /// <summary> | |
| /// Internal constructor for initializing WMI jobs, where WMI command is executed a variable | |
| /// number of times. | |
| /// </summary> | |
| internal PSWmiJob(Cmdlet cmds, string[] computerName, int throttleLimit, string command, int count) | |
| : base(command, null) | |
| { | |
| PSJobTypeName = WMIJobType; | |
| _throttleManager.ThrottleLimit = throttleLimit; | |
| for (int i = 0; i < computerName.Length; ++i) | |
| { | |
| PSWmiChildJob childJob = new PSWmiChildJob(cmds, computerName[i], _throttleManager, count); | |
| childJob.StateChanged += new EventHandler<JobStateEventArgs>(HandleChildJobStateChanged); | |
| childJob.JobUnblocked += new EventHandler(HandleJobUnblocked); | |
| ChildJobs.Add(childJob); | |
| } | |
| CommonInit(throttleLimit); | |
| } | |
| // Set to true when at least one chil job failed | |
| private bool _atleastOneChildJobFailed = false; | |
| // Count the number of childs which have finished | |
| private int _finishedChildJobsCount = 0; | |
| // Count of number of child jobs which are blocked | |
| private int _blockedChildJobsCount = 0; | |
| // WMI Job type name. | |
| private const string WMIJobType = "WmiJob"; | |
| /// <summary> | |
| /// Handles the StateChanged event from each of the child job objects. | |
| /// </summary> | |
| /// <param name="sender"></param> | |
| /// <param name="e"></param> | |
| private void HandleChildJobStateChanged(object sender, JobStateEventArgs e) | |
| { | |
| if (e.JobStateInfo.State == JobState.Blocked) | |
| { | |
| // increment count of blocked child jobs | |
| lock (_syncObject) | |
| { | |
| _blockedChildJobsCount++; | |
| } | |
| // if any of the child job is blocked, we set state to blocked | |
| SetJobState(JobState.Blocked, null); | |
| return; | |
| } | |
| // Ignore state changes which are not resulting in state change to finished. | |
| if ((!IsFinishedState(e.JobStateInfo.State)) || (e.JobStateInfo.State == JobState.NotStarted)) | |
| { | |
| return; | |
| } | |
| if (e.JobStateInfo.State == JobState.Failed) | |
| { | |
| // If any of the child job failed, we set status to failed | |
| _atleastOneChildJobFailed = true; | |
| } | |
| bool allChildJobsFinished = false; | |
| lock (_syncObject) | |
| { | |
| _finishedChildJobsCount++; | |
| // We are done | |
| if (_finishedChildJobsCount == ChildJobs.Count) | |
| { | |
| allChildJobsFinished = true; | |
| } | |
| } | |
| if (allChildJobsFinished) | |
| { | |
| // if any child job failed, set status to failed | |
| // If stop was called set, status to stopped | |
| // else completed | |
| if (_atleastOneChildJobFailed) | |
| { | |
| SetJobState(JobState.Failed); | |
| } | |
| else if (_stopIsCalled == true) | |
| { | |
| SetJobState(JobState.Stopped); | |
| } | |
| else | |
| { | |
| SetJobState(JobState.Completed); | |
| } | |
| } | |
| } | |
| private bool _stopIsCalled = false; | |
| private string _statusMessage; | |
| /// <summary> | |
| /// Message indicating status of the job. | |
| /// </summary> | |
| public override string StatusMessage | |
| { | |
| get | |
| { | |
| return _statusMessage; | |
| } | |
| } | |
| // ISSUE: Implement StatusMessage | |
| /// <summary> | |
| /// Checks the status of remote command execution. | |
| /// </summary> | |
| [] | |
| private void SetStatusMessage() | |
| { | |
| _statusMessage = "test"; | |
| } | |
| private bool _moreData = false; | |
| /// <summary> | |
| /// Indicates if more data is available. | |
| /// </summary> | |
| /// <remarks> | |
| /// This has more data if any of the child jobs have more data. | |
| /// </remarks> | |
| public override bool HasMoreData | |
| { | |
| get | |
| { | |
| // moreData is set to false and will be set to true | |
| // if at least one child is has more data. | |
| // if ( (!moreData)) | |
| // { | |
| bool atleastOneChildHasMoreData = false; | |
| for (int i = 0; i < ChildJobs.Count; i++) | |
| { | |
| if (ChildJobs[i].HasMoreData) | |
| { | |
| atleastOneChildHasMoreData = true; | |
| break; | |
| } | |
| } | |
| _moreData = atleastOneChildHasMoreData; | |
| // } | |
| return _moreData; | |
| } | |
| } | |
| /// <summary> | |
| /// Computers on which this job is running. | |
| /// </summary> | |
| public override string Location | |
| { | |
| get | |
| { | |
| return ConstructLocation(); | |
| } | |
| } | |
| private string ConstructLocation() | |
| { | |
| StringBuilder location = new StringBuilder(); | |
| foreach (PSWmiChildJob job in ChildJobs) | |
| { | |
| location.Append(job.Location); | |
| location.Append(','); | |
| } | |
| location.Remove(location.Length - 1, 1); | |
| return location.ToString(); | |
| } | |
| /// <summary> | |
| /// Stop Job. | |
| /// </summary> | |
| public override void StopJob() | |
| { | |
| // AssertNotDisposed(); | |
| if (!IsFinishedState(JobStateInfo.State)) | |
| { | |
| _stopIsCalled = true; | |
| _throttleManager.StopAllOperations(); | |
| Finished.WaitOne(); | |
| } | |
| } | |
| /// <summary> | |
| /// Release all the resources. | |
| /// </summary> | |
| /// <param name="disposing"> | |
| /// if true, release all the managed objects. | |
| /// </param> | |
| protected override void Dispose(bool disposing) | |
| { | |
| if (disposing) | |
| { | |
| if (!_isDisposed) | |
| { | |
| _isDisposed = true; | |
| try | |
| { | |
| if (!IsFinishedState(JobStateInfo.State)) | |
| { | |
| StopJob(); | |
| } | |
| _throttleManager.Dispose(); | |
| foreach (Job job in ChildJobs) | |
| { | |
| job.Dispose(); | |
| } | |
| } | |
| finally | |
| { | |
| base.Dispose(disposing); | |
| } | |
| } | |
| } | |
| } | |
| private bool _isDisposed = false; | |
| /// <summary> | |
| /// Initialization common to both constructors. | |
| /// </summary> | |
| private void CommonInit(int throttleLimit) | |
| { | |
| // 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.EndSubmitOperations(); | |
| } | |
| /// <summary> | |
| /// 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. | |
| /// </summary> | |
| /// <param name="sender">Sender of this event, unused.</param> | |
| /// <param name="eventArgs">event arguments, should be empty in this | |
| /// case</param> | |
| private void HandleJobUnblocked(object sender, EventArgs eventArgs) | |
| { | |
| bool unblockjob = false; | |
| lock (_syncObject) | |
| { | |
| _blockedChildJobsCount--; | |
| if (_blockedChildJobsCount == 0) | |
| { | |
| unblockjob = true; | |
| } | |
| } | |
| if (unblockjob) | |
| { | |
| SetJobState(JobState.Running, null); | |
| } | |
| } | |
| private ThrottleManager _throttleManager = new ThrottleManager(); | |
| private object _syncObject = new object(); // sync object | |
| } | |
| /// <summary> | |
| /// Class for WmiChildJob object. This job object Execute wmi cmdlet. | |
| /// </summary> | |
| internal class PSWmiChildJob : Job | |
| { | |
| /// <summary> | |
| /// Internal constructor for initializing WMI jobs. | |
| /// </summary> | |
| internal PSWmiChildJob(Cmdlet cmds, string computerName, ThrottleManager throttleManager) | |
| : base(null, null) | |
| { | |
| UsesResultsCollection = true; | |
| Location = computerName; | |
| _throttleManager = throttleManager; | |
| _wmiSinkArray = new ArrayList(); | |
| ManagementOperationObserver wmiSink = new ManagementOperationObserver(); | |
| _wmiSinkArray.Add(wmiSink); | |
| _sinkCompleted++; | |
| wmiSink.ObjectReady += new ObjectReadyEventHandler(this.NewObject); | |
| wmiSink.Completed += new CompletedEventHandler(this.JobDone); | |
| _helper = new WmiAsyncCmdletHelper(this, cmds, computerName, wmiSink); | |
| _helper.WmiOperationState += new EventHandler<WmiJobStateEventArgs>(HandleWMIState); | |
| _helper.ShutdownComplete += new EventHandler<EventArgs>(JobDoneForWin32Shutdown); | |
| SetJobState(JobState.NotStarted); | |
| IThrottleOperation operation = _helper; | |
| operation.OperationComplete += new EventHandler<OperationStateEventArgs>(HandleOperationComplete); | |
| throttleManager.ThrottleComplete += new EventHandler<EventArgs>(HandleThrottleComplete); | |
| throttleManager.AddOperation(operation); | |
| } | |
| /// <summary> | |
| /// Internal constructor for initializing WMI jobs, where WMI command is executed a variable | |
| /// number of times. | |
| /// </summary> | |
| internal PSWmiChildJob(Cmdlet cmds, string computerName, ThrottleManager throttleManager, int count) | |
| : base(null, null) | |
| { | |
| UsesResultsCollection = true; | |
| Location = computerName; | |
| _throttleManager = throttleManager; | |
| _wmiSinkArray = new ArrayList(); | |
| ManagementOperationObserver wmiSink = new ManagementOperationObserver(); | |
| _wmiSinkArray.Add(wmiSink); | |
| _sinkCompleted += count; | |
| wmiSink.ObjectReady += new ObjectReadyEventHandler(this.NewObject); | |
| wmiSink.Completed += new CompletedEventHandler(this.JobDone); | |
| _helper = new WmiAsyncCmdletHelper(this, cmds, computerName, wmiSink, count); | |
| _helper.WmiOperationState += new EventHandler<WmiJobStateEventArgs>(HandleWMIState); | |
| _helper.ShutdownComplete += new EventHandler<EventArgs>(JobDoneForWin32Shutdown); | |
| SetJobState(JobState.NotStarted); | |
| IThrottleOperation operation = _helper; | |
| operation.OperationComplete += new EventHandler<OperationStateEventArgs>(HandleOperationComplete); | |
| throttleManager.ThrottleComplete += new EventHandler<EventArgs>(HandleThrottleComplete); | |
| throttleManager.AddOperation(operation); | |
| } | |
| private WmiAsyncCmdletHelper _helper; | |
| // bool _bFinished; | |
| private ThrottleManager _throttleManager; | |
| private object _syncObject = new object(); // sync object | |
| private int _sinkCompleted; | |
| private bool _bJobFailed; | |
| private bool _bAtLeastOneObject; | |
| private ArrayList _wmiSinkArray; | |
| /// <summary> | |
| /// Event raised by this job to indicate to its parent that | |
| /// its now unblocked by the user. | |
| /// </summary> | |
| internal event EventHandler JobUnblocked; | |
| /// <summary> | |
| /// 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. | |
| /// </summary> | |
| [] | |
| internal void UnblockJob() | |
| { | |
| SetJobState(JobState.Running, null); | |
| JobUnblocked.SafeInvoke(this, EventArgs.Empty); | |
| } | |
| internal ManagementOperationObserver GetNewSink() | |
| { | |
| ManagementOperationObserver wmiSink = new ManagementOperationObserver(); | |
| _wmiSinkArray.Add(wmiSink); | |
| lock (_syncObject) | |
| { | |
| _sinkCompleted++; | |
| } | |
| wmiSink.ObjectReady += new ObjectReadyEventHandler(this.NewObject); | |
| wmiSink.Completed += new CompletedEventHandler(this.JobDone); | |
| return wmiSink; | |
| } | |
| /// <summary> | |
| /// It receives Management objects. | |
| /// </summary> | |
| private void NewObject(object sender, ObjectReadyEventArgs obj) | |
| { | |
| if (!_bAtLeastOneObject) | |
| { | |
| _bAtLeastOneObject = true; | |
| } | |
| this.WriteObject(obj.NewObject); | |
| } | |
| /// <summary> | |
| /// It is called when WMI job is done. | |
| /// </summary> | |
| private void JobDone(object sender, CompletedEventArgs obj) | |
| { | |
| lock (_syncObject) | |
| { | |
| _sinkCompleted--; | |
| } | |
| if (obj.Status != ManagementStatus.NoError) | |
| { | |
| _bJobFailed = true; | |
| } | |
| if (_sinkCompleted == 0) | |
| { | |
| // Notify throttle manager and change the state to complete | |
| // Two cases where _bFinished should be set to false. | |
| // 1) Invalid class or some other condition so that after making a connection WMI is throwing an error | |
| // 2) We could not get any instance for the class. | |
| /*if(bAtLeastOneObject ) | |
| _bFinished = true;*/ | |
| _helper.RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| if (!_bJobFailed) | |
| { | |
| _helper.State = WmiState.Completed; | |
| SetJobState(JobState.Completed); | |
| } | |
| else | |
| { | |
| _helper.State = WmiState.Failed; | |
| SetJobState(JobState.Failed); | |
| } | |
| } | |
| } | |
| /// <summary> | |
| /// It is called when the call to Win32shutdown is successfully completed. | |
| /// </summary> | |
| private void JobDoneForWin32Shutdown(object sender, EventArgs arg) | |
| { | |
| lock (_syncObject) | |
| { | |
| _sinkCompleted--; | |
| } | |
| if (_sinkCompleted == 0) | |
| { | |
| _helper.RaiseOperationCompleteEvent(null, OperationState.StopComplete); | |
| _helper.State = WmiState.Completed; | |
| SetJobState(JobState.Completed); | |
| } | |
| } | |
| /// <summary> | |
| /// Message indicating status of the job. | |
| /// </summary> | |
| public override string StatusMessage { get; } = "test"; | |
| /// <summary> | |
| /// Indicates if there is more data available in | |
| /// this Job. | |
| /// </summary> | |
| public override bool HasMoreData | |
| { | |
| get | |
| { | |
| return (Results.IsOpen || Results.Count > 0); | |
| } | |
| } | |
| /// <summary> | |
| /// Returns the computer on which this command is | |
| /// running. | |
| /// </summary> | |
| public override string Location { get; } | |
| /// <summary> | |
| /// Stops the job. | |
| /// </summary> | |
| public override void StopJob() | |
| { | |
| AssertNotDisposed(); | |
| _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(); | |
| } | |
| /// <summary> | |
| /// Release all the resources. | |
| /// </summary> | |
| /// <param name="disposing"> | |
| /// if true, release all the managed objects. | |
| /// </param> | |
| protected override void Dispose(bool disposing) | |
| { | |
| if (disposing) | |
| { | |
| if (!_isDisposed) | |
| { | |
| _isDisposed = true; | |
| base.Dispose(disposing); | |
| } | |
| } | |
| } | |
| private bool _isDisposed; | |
| /// <summary> | |
| /// Handles operation complete event. | |
| /// </summary> | |
| private void HandleOperationComplete(object sender, OperationStateEventArgs stateEventArgs) | |
| { | |
| WmiAsyncCmdletHelper helper = (WmiAsyncCmdletHelper)sender; | |
| if (helper.State == WmiState.NotStarted) | |
| { | |
| // This is a case WMI operation was not started. | |
| SetJobState(JobState.Stopped, helper.InternalException); | |
| } | |
| else if (helper.State == WmiState.Running) | |
| { | |
| SetJobState(JobState.Running, helper.InternalException); | |
| } | |
| else if (helper.State == WmiState.Completed) | |
| { | |
| SetJobState(JobState.Completed, helper.InternalException); | |
| } | |
| else if (helper.State == WmiState.Failed) | |
| { | |
| SetJobState(JobState.Failed, helper.InternalException); | |
| } | |
| else | |
| { | |
| SetJobState(JobState.Stopped, helper.InternalException); | |
| } | |
| } | |
| /// <summary> | |
| /// Handles WMI state changed. | |
| /// </summary> | |
| private void HandleWMIState(object sender, WmiJobStateEventArgs stateEventArgs) | |
| { | |
| if (stateEventArgs.WmiState == WmiState.Running) | |
| { | |
| SetJobState(JobState.Running, _helper.InternalException); | |
| } | |
| else if (stateEventArgs.WmiState == WmiState.NotStarted) | |
| { | |
| SetJobState(JobState.NotStarted, _helper.InternalException); | |
| } | |
| else if (stateEventArgs.WmiState == WmiState.Completed) | |
| { | |
| SetJobState(JobState.Completed); | |
| } | |
| else if (stateEventArgs.WmiState == WmiState.Failed) | |
| { | |
| SetJobState(JobState.Failed, _helper.InternalException); | |
| } | |
| else | |
| { | |
| SetJobState(JobState.Stopped, _helper.InternalException); | |
| } | |
| } | |
| /// <summary> | |
| /// Handle a throttle complete event. | |
| /// </summary> | |
| /// <param name="sender">Sender of this event.</param> | |
| /// <param name="eventArgs">Not used in this method.</param> | |
| private void HandleThrottleComplete(object sender, EventArgs eventArgs) | |
| { | |
| if (_helper.State == WmiState.NotStarted) | |
| { | |
| // This is a case WMI operation was not started. | |
| SetJobState(JobState.Stopped, _helper.InternalException); | |
| } | |
| else if (_helper.State == WmiState.Running) | |
| { | |
| SetJobState(JobState.Running, _helper.InternalException); | |
| } | |
| else if (_helper.State == WmiState.Completed) | |
| { | |
| SetJobState(JobState.Completed, _helper.InternalException); | |
| } | |
| else if (_helper.State == WmiState.Failed) | |
| { | |
| SetJobState(JobState.Failed, _helper.InternalException); | |
| } | |
| else | |
| { | |
| SetJobState(JobState.Stopped, _helper.InternalException); | |
| } | |
| // Do Nothing | |
| } | |
| } | |
| } | |