File size: 15,468 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Management.Automation;
using System.Runtime.CompilerServices;
using System.Threading;
using Microsoft.Management.Infrastructure;
using Dbg = System.Management.Automation.Diagnostics;
namespace Microsoft.PowerShell.Cmdletization.Cim
{
/// <summary>
/// CIM-specific ObjectModelWrapper.
/// </summary>
public sealed class CimCmdletAdapter :
SessionBasedCmdletAdapter<CimInstance, CimSession>,
IDynamicParameters
{
#region Special method and parameter names
internal const string CreateInstance_MethodName = "cim:CreateInstance";
internal const string ModifyInstance_MethodName = "cim:ModifyInstance";
internal const string DeleteInstance_MethodName = "cim:DeleteInstance";
#endregion
#region Changing Session parameter to CimSession
/// <summary>
/// CimSession to operate on.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[Alias("Session")]
public CimSession[] CimSession
{
get
{
return base.Session;
}
set
{
base.Session = value;
}
}
/// <summary>
/// Maximum number of remote connections that can remain active at any given time.
/// </summary>
[Parameter]
public override int ThrottleLimit
{
get
{
if (_throttleLimitIsSetExplicitly)
{
return base.ThrottleLimit;
}
return this.CmdletDefinitionContext.DefaultThrottleLimit;
}
set
{
base.ThrottleLimit = value;
_throttleLimitIsSetExplicitly = true;
}
}
private bool _throttleLimitIsSetExplicitly;
#endregion
#region ObjectModelWrapper overrides
/// <summary>
/// Creates a query builder for CIM OM.
/// </summary>
/// <returns>Query builder for CIM OM.</returns>
public override QueryBuilder GetQueryBuilder()
{
return new CimQuery();
}
internal CimCmdletInvocationContext CmdletInvocationContext
{
get
{
return _cmdletInvocationContext ??= new CimCmdletInvocationContext(
this.CmdletDefinitionContext,
this.Cmdlet,
this.GetDynamicNamespace());
}
}
private CimCmdletInvocationContext _cmdletInvocationContext;
internal CimCmdletDefinitionContext CmdletDefinitionContext
{
get
{
_cmdletDefinitionContext ??= new CimCmdletDefinitionContext(
this.ClassName,
this.ClassVersion,
this.ModuleVersion,
this.Cmdlet.CommandInfo.CommandMetadata.SupportsShouldProcess,
this.PrivateData);
return _cmdletDefinitionContext;
}
}
private CimCmdletDefinitionContext _cmdletDefinitionContext;
internal InvocationInfo CmdletInvocationInfo
{
get { return this.CmdletInvocationContext.CmdletInvocationInfo; }
}
#endregion ObjectModelWrapper overrides
#region SessionBasedCmdletAdapter overrides
private static long s_jobNumber;
/// <summary>
/// Returns a new job name to use for the parent job that handles throttling of the child jobs that actually perform querying and method invocation.
/// </summary>
/// <returns>Job name.</returns>
protected override string GenerateParentJobName()
{
return "CimJob" + Interlocked.Increment(ref CimCmdletAdapter.s_jobNumber).ToString(CultureInfo.InvariantCulture);
}
/// <summary>
/// Returns default sessions to use when the user doesn't specify the -Session cmdlet parameter.
/// </summary>
/// <returns>Default sessions to use when the user doesn't specify the -Session cmdlet parameter.</returns>
protected override CimSession DefaultSession
{
get
{
return this.CmdletInvocationContext.GetDefaultCimSession();
}
}
private CimJobContext CreateJobContext(CimSession session, object targetObject)
{
return new CimJobContext(
this.CmdletInvocationContext,
session,
targetObject);
}
/// <summary>
/// Creates a <see cref="System.Management.Automation.Job"/> object that performs a query against the wrapped object model.
/// </summary>
/// <param name="session">Remote session to query.</param>
/// <param name="baseQuery">Query parameters.</param>
/// <returns><see cref="System.Management.Automation.Job"/> object that performs a query against the wrapped object model.</returns>
internal override StartableJob CreateQueryJob(CimSession session, QueryBuilder baseQuery)
{
if (baseQuery is not CimQuery query)
{
throw new ArgumentNullException(nameof(baseQuery));
}
TerminatingErrorTracker tracker = TerminatingErrorTracker.GetTracker(this.CmdletInvocationInfo, isStaticCmdlet: false);
if (tracker.IsSessionTerminated(session))
{
return null;
}
if (!IsSupportedSession(session, tracker))
{
return null;
}
CimJobContext jobContext = this.CreateJobContext(session, targetObject: null);
StartableJob queryJob = query.GetQueryJob(jobContext);
return queryJob;
}
/// <summary>
/// Creates a <see cref="System.Management.Automation.Job"/> object that invokes an instance method in the wrapped object model.
/// </summary>
/// <param name="session">Remote session to invoke the method in.</param>
/// <param name="objectInstance">The object on which to invoke the method.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
/// <param name="passThru"><see langword="true"/> if successful method invocations should emit downstream the <paramref name="objectInstance"/> being operated on.</param>
/// <returns></returns>
internal override StartableJob CreateInstanceMethodInvocationJob(CimSession session, CimInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru)
{
TerminatingErrorTracker tracker = TerminatingErrorTracker.GetTracker(this.CmdletInvocationInfo, isStaticCmdlet: false);
if (tracker.IsSessionTerminated(session))
{
return null;
}
if (!IsSupportedSession(session, tracker))
{
return null;
}
CimJobContext jobContext = this.CreateJobContext(session, objectInstance);
Dbg.Assert(objectInstance != null, "Caller should verify objectInstance != null");
StartableJob result;
if (methodInvocationInfo.MethodName.Equals(CimCmdletAdapter.DeleteInstance_MethodName, StringComparison.OrdinalIgnoreCase))
{
result = new DeleteInstanceJob(
jobContext,
passThru,
objectInstance,
methodInvocationInfo);
}
else if (methodInvocationInfo.MethodName.Equals(CimCmdletAdapter.ModifyInstance_MethodName, StringComparison.OrdinalIgnoreCase))
{
result = new ModifyInstanceJob(
jobContext,
passThru,
objectInstance,
methodInvocationInfo);
}
else
{
result = new InstanceMethodInvocationJob(
jobContext,
passThru,
objectInstance,
methodInvocationInfo);
}
return result;
}
private bool IsSupportedSession(CimSession cimSession, TerminatingErrorTracker terminatingErrorTracker)
{
bool confirmSwitchSpecified = this.CmdletInvocationInfo.BoundParameters.ContainsKey("Confirm");
bool whatIfSwitchSpecified = this.CmdletInvocationInfo.BoundParameters.ContainsKey("WhatIf");
if (confirmSwitchSpecified || whatIfSwitchSpecified)
{
if (cimSession.ComputerName != null && (!cimSession.ComputerName.Equals("localhost", StringComparison.OrdinalIgnoreCase)))
{
PSPropertyInfo protocolProperty = PSObject.AsPSObject(cimSession).Properties["Protocol"];
if ((protocolProperty != null) &&
(protocolProperty.Value != null) &&
(protocolProperty.Value.ToString().Equals("DCOM", StringComparison.OrdinalIgnoreCase)))
{
bool sessionWasAlreadyTerminated;
terminatingErrorTracker.MarkSessionAsTerminated(cimSession, out sessionWasAlreadyTerminated);
if (!sessionWasAlreadyTerminated)
{
string nameOfUnsupportedSwitch;
if (confirmSwitchSpecified)
{
nameOfUnsupportedSwitch = "-Confirm";
}
else
{
Dbg.Assert(whatIfSwitchSpecified, "Confirm and WhatIf are the only detected settings");
nameOfUnsupportedSwitch = "-WhatIf";
}
string errorMessage = string.Format(
CultureInfo.InvariantCulture,
CmdletizationResources.CimCmdletAdapter_RemoteDcomDoesntSupportExtendedSemantics,
cimSession.ComputerName,
nameOfUnsupportedSwitch);
Exception exception = new NotSupportedException(errorMessage);
ErrorRecord errorRecord = new(
exception,
"NoExtendedSemanticsSupportInRemoteDcomProtocol",
ErrorCategory.NotImplemented,
cimSession);
this.Cmdlet.WriteError(errorRecord);
}
}
}
}
return true;
}
/// <summary>
/// Creates a <see cref="System.Management.Automation.Job"/> object that invokes a static method
/// (of the class named by <see cref="Microsoft.PowerShell.Cmdletization.CmdletAdapter<TObjectInstance>.ClassName"/>)
/// in the wrapped object model.
/// </summary>
/// <param name="session">Remote session to invoke the method in.</param>
/// <param name="methodInvocationInfo">Method invocation details.</param>
internal override StartableJob CreateStaticMethodInvocationJob(CimSession session, MethodInvocationInfo methodInvocationInfo)
{
TerminatingErrorTracker tracker = TerminatingErrorTracker.GetTracker(this.CmdletInvocationInfo, isStaticCmdlet: true);
if (tracker.IsSessionTerminated(session))
{
return null;
}
if (!IsSupportedSession(session, tracker))
{
return null;
}
CimJobContext jobContext = this.CreateJobContext(session, targetObject: null);
StartableJob result;
if (methodInvocationInfo.MethodName.Equals(CimCmdletAdapter.CreateInstance_MethodName, StringComparison.OrdinalIgnoreCase))
{
result = new CreateInstanceJob(
jobContext,
methodInvocationInfo);
}
else
{
result = new StaticMethodInvocationJob(
jobContext,
methodInvocationInfo);
}
return result;
}
#endregion SessionBasedCmdletAdapter overrides
#region Session affinity management
private static readonly ConditionalWeakTable<CimInstance, CimSession> s_cimInstanceToSessionOfOrigin = new();
internal static void AssociateSessionOfOriginWithInstance(CimInstance cimInstance, CimSession sessionOfOrigin)
{
// GetValue adds value to the table, if the key is not present in the table
s_cimInstanceToSessionOfOrigin.GetValue(cimInstance, _ => sessionOfOrigin);
}
internal static CimSession GetSessionOfOriginFromCimInstance(CimInstance instance)
{
CimSession result = null;
if (instance != null)
{
s_cimInstanceToSessionOfOrigin.TryGetValue(instance, out result);
}
return result;
}
internal override CimSession GetSessionOfOriginFromInstance(CimInstance instance)
{
return GetSessionOfOriginFromCimInstance(instance);
}
#endregion
#region Handling of dynamic parameters
private RuntimeDefinedParameterDictionary _dynamicParameters;
private const string CimNamespaceParameter = "CimNamespace";
private string GetDynamicNamespace()
{
if (_dynamicParameters == null)
{
return null;
}
RuntimeDefinedParameter runtimeParameter;
if (!_dynamicParameters.TryGetValue(CimNamespaceParameter, out runtimeParameter))
{
return null;
}
return runtimeParameter.Value as string;
}
object IDynamicParameters.GetDynamicParameters()
{
if (_dynamicParameters == null)
{
_dynamicParameters = new RuntimeDefinedParameterDictionary();
if (this.CmdletDefinitionContext.ExposeCimNamespaceParameter)
{
Collection<Attribute> namespaceAttributes = new();
namespaceAttributes.Add(new ValidateNotNullOrEmptyAttribute());
namespaceAttributes.Add(new ParameterAttribute());
RuntimeDefinedParameter namespaceRuntimeParameter = new(
CimNamespaceParameter,
typeof(string),
namespaceAttributes);
_dynamicParameters.Add(CimNamespaceParameter, namespaceRuntimeParameter);
}
}
return _dynamicParameters;
}
#endregion
}
}
|