mirror of https://github.com/dahall/Vanara.git
Added Vanara.Management assembly with helpers for System.Management.
dahall
parent
c86ddbf315
commit
e82f8a7ef8
|
|
@ -0,0 +1,137 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Dynamic;
|
||||
using System.Linq;
|
||||
using System.Management;
|
||||
|
||||
namespace Vanara.Management
|
||||
{
|
||||
/// <summary>A dynamic object to handle WMI <see cref="ManagementBaseObject"/> references.</summary>
|
||||
/// <seealso cref="System.Dynamic.DynamicObject"/>
|
||||
/// <seealso cref="System.IDisposable"/>
|
||||
public class DynamicMgmtObject : DynamicObject, IDisposable
|
||||
{
|
||||
private readonly ManagementObject obj;
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="DynamicMgmtObject"/> class.</summary>
|
||||
/// <param name="obj">The object.</param>
|
||||
public DynamicMgmtObject(ManagementObject obj) => this.obj = obj ?? throw new ArgumentNullException();
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="DynamicMgmtObject"/> class.</summary>
|
||||
/// <param name="scope">The scope.</param>
|
||||
/// <param name="service">The service name.</param>
|
||||
public DynamicMgmtObject(ManagementScope scope, string service)
|
||||
{
|
||||
if (!scope.IsConnected)
|
||||
scope.Connect();
|
||||
|
||||
obj = scope.GetWMIService(service);
|
||||
if (obj is null) throw new ArgumentNullException();
|
||||
}
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="DynamicMgmtObject"/> class.</summary>
|
||||
/// <param name="wmiclass">The class.</param>
|
||||
public DynamicMgmtObject(ManagementClass wmiclass) => obj = wmiclass.CreateInstance();
|
||||
|
||||
/// <summary>Performs an implicit conversion from <see cref="ManagementObject"/> to <see cref="DynamicMgmtObject"/>.</summary>
|
||||
/// <param name="mbo">The <see cref="ManagementObject"/>.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static implicit operator DynamicMgmtObject(ManagementObject mbo) => new(mbo);
|
||||
|
||||
/// <inheritdoc/>
|
||||
public void Dispose() => ((IDisposable)obj).Dispose();
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override IEnumerable<string> GetDynamicMemberNames() => obj.Properties.Cast<PropertyData>().Select(d => d.Name);
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool TryConvert(ConvertBinder binder, out object result)
|
||||
{
|
||||
if (binder.Type == typeof(ManagementObject))
|
||||
{
|
||||
result = obj;
|
||||
return true;
|
||||
}
|
||||
return base.TryConvert(binder, out result);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool TryGetMember(GetMemberBinder binder, out object result)
|
||||
{
|
||||
try { result = obj.GetPropertyValue(binder.Name); return true; }
|
||||
catch (ManagementException)
|
||||
{
|
||||
result = binder.Name switch
|
||||
{
|
||||
"ClassPath" or "ManagementClassPath" => obj.ClassPath,
|
||||
"Path" or "ManagementPath" => obj.Path,
|
||||
"Scope" or "ManagementScope" => obj.Scope,
|
||||
_ => null
|
||||
};
|
||||
return result is not null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool TryInvokeMember(InvokeMemberBinder binder, object[] args, out object result)
|
||||
{
|
||||
if (args.Length == 1)
|
||||
{
|
||||
ManagementBaseObject input = null;
|
||||
if (args[0] is ManagementBaseObject mbo)
|
||||
{
|
||||
input = mbo;
|
||||
}
|
||||
else if (args[0] is IDictionary<string, object> eo)
|
||||
{
|
||||
input = obj.GetMethodParameters(binder.Name);
|
||||
foreach (KeyValuePair<string, object> kv in eo)
|
||||
input[kv.Key] = kv.Value;
|
||||
}
|
||||
else if (args[0] is (string Key, object Value)[] a)
|
||||
{
|
||||
input = obj.GetMethodParameters(binder.Name);
|
||||
foreach ((string Key, object Value) in a)
|
||||
input[Key] = Value;
|
||||
}
|
||||
if (input is not null)
|
||||
{
|
||||
result = (DynamicMgmtObject)obj.InvokeMethod(binder.Name, input, null);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
result = obj.InvokeMethod(binder.Name, args);
|
||||
return true;
|
||||
}
|
||||
catch (ManagementException) { }
|
||||
return base.TryInvokeMember(binder, args, out result);
|
||||
}
|
||||
|
||||
/// <inheritdoc/>
|
||||
public override bool TrySetMember(SetMemberBinder binder, object value)
|
||||
{
|
||||
try { obj.SetPropertyValue(binder.Name, value); return true; }
|
||||
catch (ManagementException)
|
||||
{
|
||||
switch (binder.Name)
|
||||
{
|
||||
case "Path":
|
||||
case "ManagementPath":
|
||||
obj.Path = value as ManagementPath;
|
||||
return true;
|
||||
|
||||
case "Scope":
|
||||
case "ManagementScope":
|
||||
obj.Scope = value as ManagementScope;
|
||||
return true;
|
||||
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,226 @@
|
|||
using System;
|
||||
using System.ComponentModel;
|
||||
using System.Linq;
|
||||
using System.Management;
|
||||
using System.Reflection;
|
||||
using System.Runtime.Serialization;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using System.Xml;
|
||||
|
||||
namespace Vanara.Management
|
||||
{
|
||||
/// <summary>Extension methods to work more easily with <see cref="System.Management"/>.</summary>
|
||||
public static class ManagementExtensions
|
||||
{
|
||||
internal enum JobState : ushort
|
||||
{
|
||||
New = 2,
|
||||
Starting = 3,
|
||||
Running = 4,
|
||||
Suspended = 5,
|
||||
ShuttingDown = 6,
|
||||
Completed = 7,
|
||||
Terminated = 8,
|
||||
Killed = 9,
|
||||
Exception = 10,
|
||||
Service = 11,
|
||||
QueryPending = 12,
|
||||
CompletedWithWarnings = 32768
|
||||
}
|
||||
|
||||
/// <summary>Calls a service method that returns a Job asynchronously.</summary>
|
||||
/// <param name="scope">The scope.</param>
|
||||
/// <param name="cancellationToken">The cancellation token.</param>
|
||||
/// <param name="progress">The progress.</param>
|
||||
/// <param name="service">The service.</param>
|
||||
/// <param name="method">The method.</param>
|
||||
/// <param name="values">The values.</param>
|
||||
/// <returns>The resulting <see cref="ManagementBaseObject"/>.</returns>
|
||||
public static async Task<ManagementBaseObject> CallJobMethodAsync(this ManagementScope scope, CancellationToken cancellationToken, IProgress<int> progress, string service, string method, params (string, object)[] values) =>
|
||||
await Task.Factory.StartNew(() =>
|
||||
{
|
||||
if (!scope.IsConnected)
|
||||
scope.Connect();
|
||||
|
||||
using ManagementObject imgMgmtSvc = scope.GetWMIService(service);
|
||||
using ManagementBaseObject inParams = imgMgmtSvc.GetMethodParameters(method);
|
||||
foreach ((string, object) kv in values)
|
||||
inParams[kv.Item1] = kv.Item2;
|
||||
|
||||
ManagementBaseObject outputParameters = imgMgmtSvc.InvokeMethod(method, inParams, null);
|
||||
|
||||
const int sleepDur = 500;
|
||||
|
||||
if (outputParameters.IsAsync())
|
||||
{
|
||||
// The method invoked an asynchronous operation. Get the Job object and wait for it to complete. Then we can check its result.
|
||||
using ManagementObject job = new((string)outputParameters["Job"]) { Scope = scope };
|
||||
|
||||
while (!job.GetProp<JobState>("JobState").IsJobComplete())
|
||||
{
|
||||
if (progress is not null)
|
||||
{
|
||||
try { progress.Report(job.GetProp<ushort>("PercentComplete")); }
|
||||
catch { }
|
||||
}
|
||||
|
||||
Task.Delay(sleepDur);
|
||||
|
||||
// ManagementObjects are offline objects. Call Get() on the object to have its current property state.
|
||||
job.Get();
|
||||
}
|
||||
|
||||
switch (job.GetProp<JobState>("JobState"))
|
||||
{
|
||||
case JobState.Terminated:
|
||||
case JobState.Killed:
|
||||
throw new ThreadInterruptedException();
|
||||
case JobState.Exception:
|
||||
ManagementBaseObject errOut = job.InvokeMethod("GetError", null, null);
|
||||
var xml = new XmlDocument();
|
||||
xml.LoadXml(errOut.GetProp<string>("Error"));
|
||||
var errMsg = xml.DocumentElement.SelectSingleNode(@"//PROPERTY[@NAME='Message']/VALUE")?.InnerText;
|
||||
throw new InvalidOperationException(errMsg);
|
||||
case JobState.Completed:
|
||||
case JobState.CompletedWithWarnings:
|
||||
outputParameters.SetPropertyValue("ReturnValue", 0);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
progress?.Report(100);
|
||||
return outputParameters;
|
||||
}, cancellationToken);
|
||||
|
||||
/// <summary>Gets the embedded instance string usable by WMI</summary>
|
||||
/// <typeparam name="T">The type of the instance.</typeparam>
|
||||
/// <param name="instance">The instance.</param>
|
||||
/// <param name="serverName">Name of the server.</param>
|
||||
/// <returns>Embedded instance string usable by WMI.</returns>
|
||||
/// <exception cref="System.InvalidOperationException">Generic type does not have a DataContract attribute.</exception>
|
||||
public static string GetInstanceText<T>(T instance, string serverName = ".")
|
||||
{
|
||||
DataContractAttribute attr = typeof(T).GetCustomAttributes<DataContractAttribute>(false).FirstOrDefault();
|
||||
if (attr is null)
|
||||
throw new InvalidOperationException("Generic type does not have a DataContract attribute.");
|
||||
var path = new ManagementPath() { Server = serverName, NamespacePath = attr.Namespace, ClassName = attr.Name };
|
||||
|
||||
using var settingsClass = new ManagementClass(path);
|
||||
using ManagementObject settingsInstance = settingsClass.CreateInstance();
|
||||
|
||||
foreach (PropertyInfo pi in typeof(T).GetProperties(BindingFlags.Instance | BindingFlags.Public))
|
||||
{
|
||||
DataMemberAttribute mattr = pi.GetCustomAttributes<DataMemberAttribute>(false).FirstOrDefault() ?? new DataMemberAttribute() { Name = pi.Name };
|
||||
var val = pi.PropertyType.IsEnum ? Convert.ChangeType(pi.GetValue(instance), pi.PropertyType.GetEnumUnderlyingType()) : pi.GetValue(instance);
|
||||
settingsInstance.SetPropertyValue(mattr.Name, val);
|
||||
}
|
||||
|
||||
return settingsInstance.GetText(TextFormat.WmiDtd20);
|
||||
}
|
||||
|
||||
/// <summary>Gets the specified property value of <paramref name="prop"/> from <paramref name="obj"/>.</summary>
|
||||
/// <typeparam name="T">The property type</typeparam>
|
||||
/// <param name="obj">The object.</param>
|
||||
/// <param name="prop">The property name.</param>
|
||||
/// <returns>The property value.</returns>
|
||||
public static T GetProp<T>(this ManagementBaseObject obj, string prop) => typeof(T).IsEnum ? (T)Enum.ToObject(typeof(T), obj[prop]) : (T)obj[prop];
|
||||
|
||||
/// <summary>Gets the result from a return value or throws the appropriate exception.</summary>
|
||||
/// <param name="output">The method output object.</param>
|
||||
/// <param name="throwAll">if set to <see langword="true"/> throws all exceptions including those for 4096 and 32768.</param>
|
||||
/// <returns><see langword="true"/> on success; otherwise <see langword="false"/>.</returns>
|
||||
public static bool GetResultOrThrow(this ManagementBaseObject output, bool throwAll = false) => output.GetProp<uint>("ReturnValue") switch
|
||||
{
|
||||
0 => true,
|
||||
4096 => throwAll ? throw new SynchronizationLockException() : false,
|
||||
32768 => throwAll ? throw new Exception() : false,
|
||||
32769 => throw new UnauthorizedAccessException(),
|
||||
32770 => throw new NotSupportedException(),
|
||||
32773 => throw new ArgumentException(),
|
||||
32779 => throw new System.IO.FileNotFoundException(),
|
||||
32778 => throw new OutOfMemoryException(),
|
||||
32772 => throw new TimeoutException(),
|
||||
//Status is unknown(32771)
|
||||
//System is in use(32774)
|
||||
//Invalid state for this operation(32775)
|
||||
//Incorrect data type(32776)
|
||||
//System is not available(32777)
|
||||
_ => throw new Exception(),
|
||||
};
|
||||
|
||||
/// <summary>Gets the specifid WMI service from a scope.</summary>
|
||||
/// <param name="scope">The scope.</param>
|
||||
/// <param name="path">The service path.</param>
|
||||
/// <returns>The service object.</returns>
|
||||
public static ManagementObject GetWMIService(this ManagementScope scope, string path)
|
||||
{
|
||||
using ManagementClass imageManagementServiceClass = new(path) { Scope = scope };
|
||||
return imageManagementServiceClass.GetInstances().Cast<ManagementObject>().FirstOrDefault();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Parses an embedded instance returned from the server and creates a new instance of <typeparamref name="T"/> with that information.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type to fill with information from <paramref name="embeddedInstance"/>.</typeparam>
|
||||
/// <param name="embeddedInstance">The embedded instance.</param>
|
||||
/// <returns>An instance of <typeparamref name="T"/> with the data contained in the embedded instance.</returns>
|
||||
/// <exception cref="FormatException">If there was a problem parsing the embedded instance.</exception>
|
||||
/// <exception cref="ArgumentNullException">If either param is null.</exception>
|
||||
public static T Parse<T>(string embeddedInstance) where T : class, new()
|
||||
{
|
||||
var doc = new XmlDocument();
|
||||
doc.LoadXml(embeddedInstance);
|
||||
|
||||
XmlNodeList nodelist = doc.SelectNodes(@"/INSTANCE/@CLASSNAME");
|
||||
var className = typeof(T).GetCustomAttributes<DataContractAttribute>(false).FirstOrDefault()?.Name ?? typeof(T).Name;
|
||||
if (nodelist.Count != 1 || nodelist[0].Value != className)
|
||||
{
|
||||
throw new FormatException();
|
||||
}
|
||||
|
||||
var output = new T();
|
||||
foreach (PropertyInfo pi in typeof(T).GetProperties(BindingFlags.Instance | BindingFlags.Public))
|
||||
{
|
||||
DataMemberAttribute attr = pi.GetCustomAttributes<DataMemberAttribute>(false).FirstOrDefault() ?? new DataMemberAttribute() { Name = pi.Name };
|
||||
|
||||
nodelist = doc.SelectNodes($@"//PROPERTY[@NAME = '{attr.Name}']/VALUE/child::text()");
|
||||
if (attr.IsRequired && nodelist.Count != 1)
|
||||
throw new FormatException();
|
||||
if (nodelist.Count == 0)
|
||||
continue;
|
||||
|
||||
if (pi.PropertyType.IsEnum)
|
||||
{
|
||||
TypeConverter cv = TypeDescriptor.GetConverter(pi.PropertyType.GetEnumUnderlyingType());
|
||||
var val = cv.ConvertFromInvariantString(nodelist[0].Value);
|
||||
if (!Enum.IsDefined(pi.PropertyType, val))
|
||||
throw new FormatException();
|
||||
pi.SetValue(output, Enum.ToObject(pi.PropertyType, val));
|
||||
}
|
||||
else
|
||||
{
|
||||
TypeConverter cv = TypeDescriptor.GetConverter(pi.PropertyType);
|
||||
var val = cv.ConvertFromInvariantString(nodelist[0].Value);
|
||||
pi.SetValue(output, val);
|
||||
}
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
/// <summary>Verifies whether a job is completed.</summary>
|
||||
/// <param name="jobStateObj">An object that represents the JobState of the job.</param>
|
||||
/// <returns>True if the job is completed, False otherwise.</returns>
|
||||
internal static bool IsJobComplete(this JobState jobStateObj) =>
|
||||
jobStateObj is JobState.Completed or JobState.CompletedWithWarnings or JobState.Terminated or JobState.Exception or JobState.Killed;
|
||||
|
||||
/// <summary>Verifies whether a job succeeded.</summary>
|
||||
/// <param name="jobStateObj">An object representing the JobState of the job.</param>
|
||||
/// <returns><c>true</c> if the job succeeded; otherwise, <c>false</c>.</returns>
|
||||
internal static bool IsJobSuccessful(this JobState jobStateObj) => jobStateObj is JobState.Completed or JobState.CompletedWithWarnings;
|
||||
|
||||
private static bool IsAsync(this ManagementBaseObject output) => output.GetProp<uint>("ReturnValue") == 4096;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<Description>Extensions and helper classes for System.Management.</Description>
|
||||
<AssemblyTitle>$(AssemblyName)</AssemblyTitle>
|
||||
<AssemblyName>Vanara.Management</AssemblyName>
|
||||
<PackageId>$(AssemblyName)</PackageId>
|
||||
<PackageTags>vanara;net-extensions;WMI</PackageTags>
|
||||
<PackageReleaseNotes />
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<!--<ProjectReference Include="..\..\Core\Vanara.Core.csproj" />-->
|
||||
</ItemGroup>
|
||||
<ItemGroup Condition=" '$(TargetFramework)' == 'net45' Or '$(TargetFramework)' == 'netstandard2.0' ">
|
||||
<PackageReference Include="System.ValueTuple" Version="4.3.0" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="System.Management" Version="5.0.0" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
Loading…
Reference in New Issue