File size: 17,487 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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation.Runspaces;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation
{
/// <summary>
/// Defines a PowerShell command / script object which can be used with
/// <see cref="PowerShell"/> object.
/// </summary>
public sealed class PSCommand
{
#region Private Fields
private PowerShell _owner;
private CommandCollection _commands;
private Command _currentCommand;
#endregion
#region Constructor
/// <summary>
/// Creates an empty PSCommand; a command or script must be added to this PSCommand before it can be executed.
/// </summary>
public PSCommand()
{
Initialize(null, false, null);
}
/// <summary>
/// Internal copy constructor.
/// </summary>
/// <param name="commandToClone"></param>
internal PSCommand(PSCommand commandToClone)
{
_commands = new CommandCollection();
foreach (Command command in commandToClone.Commands)
{
Command clone = command.Clone();
// Attach the cloned Command to this instance.
_commands.Add(clone);
_currentCommand = clone;
}
}
/// <summary>
/// Creates a PSCommand from the specified command.
/// </summary>
/// <param name="command">Command object to use.</param>
internal PSCommand(Command command)
{
_currentCommand = command;
_commands = new CommandCollection();
_commands.Add(_currentCommand);
}
#endregion
#region Command / Parameter Construction
/// <summary>
/// Add a command to construct a command pipeline.
/// For example, to construct a command string "get-process | sort-object",
/// <code>
/// PSCommand command = new PSCommand("get-process").AddCommand("sort-object");
/// </code>
/// </summary>
/// <param name="command">
/// A string representing the command.
/// </param>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
/// <returns>
/// A PSCommand instance with <paramref name="command"/> added.
/// </returns>
/// <remarks>
/// This method is not thread safe.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// cmdlet is null.
/// </exception>
public PSCommand AddCommand(string command)
{
if (command == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(command));
}
_owner?.AssertChangesAreAccepted();
_currentCommand = new Command(command, false);
_commands.Add(_currentCommand);
return this;
}
/// <summary>
/// Add a cmdlet to construct a command pipeline.
/// For example, to construct a command string "get-process | sort-object",
/// <code>
/// PSCommand command = new PSCommand("get-process").AddCommand("sort-object");
/// </code>
/// </summary>
/// <param name="cmdlet">
/// A string representing cmdlet.
/// </param>
/// <param name="useLocalScope">
/// if true local scope is used to run the script command.
/// </param>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
/// <returns>
/// A PSCommand instance with <paramref name="cmdlet"/> added.
/// </returns>
/// <remarks>
/// This method is not thread safe.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// cmdlet is null.
/// </exception>
public PSCommand AddCommand(string cmdlet, bool useLocalScope)
{
if (cmdlet == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(cmdlet));
}
_owner?.AssertChangesAreAccepted();
_currentCommand = new Command(cmdlet, false, useLocalScope);
_commands.Add(_currentCommand);
return this;
}
/// <summary>
/// Add a piece of script to construct a command pipeline.
/// For example, to construct a command string "get-process | foreach { $_.Name }"
/// <code>
/// PSCommand command = new PSCommand("get-process")
/// .AddScript("foreach { $_.Name }", true);
/// </code>
/// </summary>
/// <param name="script">
/// A string representing the script.
/// </param>
/// <returns>
/// A PSCommand instance with <paramref name="script"/> added.
/// </returns>
/// <remarks>
/// This method is not thread-safe.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// command is null.
/// </exception>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
public PSCommand AddScript(string script)
{
if (script == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(script));
}
_owner?.AssertChangesAreAccepted();
_currentCommand = new Command(script, true);
_commands.Add(_currentCommand);
return this;
}
/// <summary>
/// Add a piece of script to construct a command pipeline.
/// For example, to construct a command string "get-process | foreach { $_.Name }"
/// <code>
/// PSCommand command = new PSCommand("get-process")
/// .AddScript("foreach { $_.Name }", true);
/// </code>
/// </summary>
/// <param name="script">
/// A string representing the script.
/// </param>
/// <param name="useLocalScope">
/// if true local scope is used to run the script command.
/// </param>
/// <returns>
/// A PSCommand instance with <paramref name="script"/> added.
/// </returns>
/// <remarks>
/// This method is not thread-safe.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// command is null.
/// </exception>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
public PSCommand AddScript(string script, bool useLocalScope)
{
if (script == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(script));
}
_owner?.AssertChangesAreAccepted();
_currentCommand = new Command(script, true, useLocalScope);
_commands.Add(_currentCommand);
return this;
}
/// <summary>
/// Add a <see cref="Command"/> element to the current command
/// pipeline.
/// </summary>
/// <param name="command">
/// Command to add.
/// </param>
/// <returns>
/// A PSCommand instance with <paramref name="command"/> added.
/// </returns>
/// <remarks>
/// This method is not thread-safe.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// command is null.
/// </exception>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
public PSCommand AddCommand(Command command)
{
if (command == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(command));
}
_owner?.AssertChangesAreAccepted();
_currentCommand = command;
_commands.Add(_currentCommand);
return this;
}
/// <summary>
/// Add a parameter to the last added command.
/// For example, to construct a command string "get-process | select-object -property name"
/// <code>
/// PSCommand command = new PSCommand("get-process")
/// .AddCommand("select-object")
/// .AddParameter("property", "name");
/// </code>
/// </summary>
/// <param name="parameterName">
/// Name of the parameter.
/// </param>
/// <param name="value">
/// Value for the parameter.
/// </param>
/// <returns>
/// A PSCommand instance with <paramref name="parameterName"/> added
/// to the parameter list of the last command.
/// </returns>
/// <remarks>
/// This method is not thread safe.
/// </remarks>
/// <exception cref="ArgumentException">
/// Name is non null and name length is zero after trimming whitespace.
/// </exception>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
public PSCommand AddParameter(string parameterName, object value)
{
if (_currentCommand == null)
{
throw PSTraceSource.NewInvalidOperationException(PSCommandStrings.ParameterRequiresCommand,
new object[] { "PSCommand" });
}
_owner?.AssertChangesAreAccepted();
_currentCommand.Parameters.Add(parameterName, value);
return this;
}
/// <summary>
/// Adds a switch parameter to the last added command.
/// For example, to construct a command string "get-process | sort-object -descending"
/// <code>
/// PSCommand command = new PSCommand("get-process")
/// .AddCommand("sort-object")
/// .AddParameter("descending");
/// </code>
/// </summary>
/// <param name="parameterName">
/// Name of the parameter.
/// </param>
/// <returns>
/// A PSCommand instance with <paramref name="parameterName"/> added
/// to the parameter list of the last command.
/// </returns>
/// <remarks>
/// This method is not thread safe.
/// </remarks>
/// <exception cref="ArgumentException">
/// Name is non null and name length is zero after trimming whitespace.
/// </exception>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
public PSCommand AddParameter(string parameterName)
{
if (_currentCommand == null)
{
throw PSTraceSource.NewInvalidOperationException(PSCommandStrings.ParameterRequiresCommand,
new object[] { "PSCommand" });
}
_owner?.AssertChangesAreAccepted();
_currentCommand.Parameters.Add(parameterName, true);
return this;
}
/// <summary>
/// Adds a <see cref="CommandParameter"/> instance to the last added command.
/// </summary>
internal PSCommand AddParameter(CommandParameter parameter)
{
if (_currentCommand == null)
{
throw PSTraceSource.NewInvalidOperationException(PSCommandStrings.ParameterRequiresCommand,
new object[] { "PSCommand" });
}
_owner?.AssertChangesAreAccepted();
_currentCommand.Parameters.Add(parameter);
return this;
}
/// <summary>
/// Adds an argument to the last added command.
/// For example, to construct a command string "get-process | select-object name"
/// <code>
/// PSCommand command = new PSCommand("get-process")
/// .AddCommand("select-object")
/// .AddArgument("name");
/// </code>
/// This will add the value "name" to the positional parameter list of "select-object"
/// cmdlet. When the command is invoked, this value will get bound to positional parameter 0
/// of the "select-object" cmdlet which is "Property".
/// </summary>
/// <param name="value">
/// Value for the parameter.
/// </param>
/// <returns>
/// A PSCommand instance parameter value <paramref name="value"/> added
/// to the parameter list of the last command.
/// </returns>
/// <exception cref="InvalidPowerShellStateException">
/// Powershell instance cannot be changed in its
/// current state.
/// </exception>
/// <remarks>
/// This method is not thread safe.
/// </remarks>
public PSCommand AddArgument(object value)
{
if (_currentCommand == null)
{
throw PSTraceSource.NewInvalidOperationException(PSCommandStrings.ParameterRequiresCommand,
new object[] { "PSCommand" });
}
_owner?.AssertChangesAreAccepted();
_currentCommand.Parameters.Add(null, value);
return this;
}
/// <summary>
/// Adds an additional statement for execution
///
/// For example,
/// <code>
/// Runspace rs = RunspaceFactory.CreateRunspace();
/// PowerShell ps = PowerShell.Create();
///
/// ps.Runspace = rs;
/// ps.AddCommand("Get-Process").AddArgument("idle");
/// ps.AddStatement().AddCommand("Get-Service").AddArgument("audiosrv");
/// ps.Invoke();
/// </code>
/// </summary>
/// <returns>
/// A PowerShell instance with the items in <paramref name="parameters"/> added
/// to the parameter list of the last command.
/// </returns>
public PSCommand AddStatement()
{
if (_commands.Count == 0)
{
return this;
}
_commands[_commands.Count - 1].IsEndOfStatement = true;
return this;
}
#endregion
#region Properties and Methods
/// <summary>
/// Gets the collection of commands from this PSCommand
/// instance.
/// </summary>
public CommandCollection Commands
{
get
{
return _commands;
}
}
/// <summary>
/// The PowerShell instance this PSCommand is associated to, or null if it is an standalone command.
/// </summary>
internal PowerShell Owner
{
get
{
return _owner;
}
set
{
_owner = value;
}
}
/// <summary>
/// Clears the command(s).
/// </summary>
public void Clear()
{
_commands.Clear();
_currentCommand = null;
}
/// <summary>
/// Creates a shallow copy of the current PSCommand.
/// </summary>
/// <returns>
/// A shallow copy of the current PSCommand
/// </returns>
public PSCommand Clone()
{
return new PSCommand(this);
}
#endregion
#region Private Methods
/// <summary>
/// Initializes the instance. Called from the constructor.
/// </summary>
/// <param name="command">
/// Command to initialize the instance with.
/// </param>
/// <param name="isScript">
/// true if the <paramref name="command"/> is script,
/// false otherwise.
/// </param>
/// <param name="useLocalScope">
/// if true local scope is used to run the script command.
/// </param>
/// <remarks>
/// Caller should check the input.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// command is null
/// </exception>
private void Initialize(string command, bool isScript, bool? useLocalScope)
{
_commands = new CommandCollection();
if (command != null)
{
_currentCommand = new Command(command, isScript, useLocalScope);
_commands.Add(_currentCommand);
}
}
#endregion
}
}
|