-
Notifications
You must be signed in to change notification settings - Fork 7.1k
/
Command.cs
885 lines (772 loc) · 36 KB
/
Command.cs
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
/********************************************************************++
Copyright (c) Microsoft Corporation. All rights reserved.
--********************************************************************/
using System.Collections.Generic;
using System.Collections.ObjectModel;
using Dbg = System.Management.Automation.Diagnostics;
using System.Management.Automation.Internal;
using Microsoft.Management.Infrastructure;
namespace System.Management.Automation.Runspaces
{
/// <summary>
/// Defines a Command object which can be added to <see cref="Pipeline"/> object
/// for invocation.
/// </summary>
public sealed class Command
{
#region constructors
/// <summary>
/// Initializes a new instance of Command class using specified command parameter.
/// </summary>
/// <param name="command">Name of the command or script contents </param>
/// <exception cref="ArgumentNullException">command is null</exception>
public Command(string command)
: this(command, false, null)
{
}
/// <summary>
/// Initializes a new instance of Command class using specified command parameter.
/// </summary>
/// <param name="command">The command name or script contents</param>
/// <param name="isScript">True if this command represents a script, otherwise; false.</param>
/// <exception cref="ArgumentNullException">command is null</exception>
public Command(string command, bool isScript)
: this(command, isScript, null)
{
}
/// <summary>
/// Constructor
/// </summary>
/// <param name="command">The command name or script contents</param>
/// <param name="isScript">True if this command represents a script, otherwise; false.</param>
/// <param name="useLocalScope">if true local scope is used to run the script command</param>
/// <exception cref="ArgumentNullException">command is null</exception>
public Command(string command, bool isScript, bool useLocalScope)
{
IsEndOfStatement = false;
if (command == null)
{
throw PSTraceSource.NewArgumentNullException("command");
}
CommandText = command;
IsScript = isScript;
_useLocalScope = useLocalScope;
}
internal Command(string command, bool isScript, bool? useLocalScope)
{
IsEndOfStatement = false;
if (command == null)
{
throw PSTraceSource.NewArgumentNullException("command");
}
CommandText = command;
IsScript = isScript;
_useLocalScope = useLocalScope;
}
internal Command(string command, bool isScript, bool? useLocalScope, bool mergeUnclaimedPreviousErrorResults)
: this(command, isScript, useLocalScope)
{
if (mergeUnclaimedPreviousErrorResults)
{
_mergeUnclaimedPreviousCommandResults = PipelineResultTypes.Error | PipelineResultTypes.Output;
}
}
internal Command(CommandInfo commandInfo)
: this(commandInfo, false)
{
}
internal Command(CommandInfo commandInfo, bool isScript)
{
IsEndOfStatement = false;
CommandInfo = commandInfo;
CommandText = CommandInfo.Name;
IsScript = isScript;
}
/// <summary>
/// Copy constructor for clone operations
/// </summary>
/// <param name="command">The source <see cref="Command"/> instance.</param>
internal Command(Command command)
{
IsScript = command.IsScript;
_useLocalScope = command._useLocalScope;
CommandText = command.CommandText;
MergeInstructions = command.MergeInstructions;
MergeMyResult = command.MergeMyResult;
MergeToResult = command.MergeToResult;
_mergeUnclaimedPreviousCommandResults = command._mergeUnclaimedPreviousCommandResults;
IsEndOfStatement = command.IsEndOfStatement;
foreach (CommandParameter param in command.Parameters)
{
Parameters.Add(new CommandParameter(param.Name, param.Value));
}
}
#endregion constructors
#region Properties
/// <summary>
/// Gets the set of parameters for this command.
/// </summary>
/// <remarks>
/// This property is used to add positional or named parameters to the command.
/// </remarks>
public CommandParameterCollection Parameters { get; } = new CommandParameterCollection();
/// <summary>
/// Access the command string.
/// </summary>
/// <value>The command name, if <see cref="Command.IsScript"/> is false; otherwise; the script contents</value>
public string CommandText { get; } = string.Empty;
/// <summary>
/// Access the commandInfo.
/// </summary>
/// <value>The command info object</value>
internal CommandInfo CommandInfo { get; }
/// <summary>
/// Access the value indicating if this <see cref="Command"/> represents a script.
/// </summary>
public bool IsScript { get; }
/// <summary>
/// Access the value indicating if LocalScope is to be used for running
/// this script command.
/// </summary>
/// <value>True if this command is a script and localScope is
/// used for executing the script</value>
/// <remarks>This value is always false for non-script commands</remarks>
public bool UseLocalScope
{
get { return _useLocalScope ?? false; }
}
/// <summary>
/// Gets or sets the command origin for this command. A command origin
/// of 'Runspace' (the default) applies Runspace restrictions to this command.
/// A command origin of 'Internal' does not apply runspace restrictions.
/// </summary>
public CommandOrigin CommandOrigin { get; set; } = CommandOrigin.Runspace;
/// <summary>
/// Access the actual value indicating if LocalScope is to be used for running
/// this script command. Needed for serialization in remoting.
/// </summary>
internal bool? UseLocalScopeNullable
{
get { return _useLocalScope; }
}
/// <summary>
/// Checks if the current command marks the end of a statement (see PowerShell.AddStatement())
/// </summary>
public bool IsEndOfStatement { get; internal set; }
#endregion Properties
#region Methods
/// <summary>
/// Creates a new <see cref="Command"/> that is a copy of the current instance.
/// </summary>
/// <returns>A new <see cref="Command"/> that is a copy of this instance.</returns>
internal Command Clone()
{
return new Command(this);
}
/// <summary>
/// for diagnostic purposes
/// </summary>
/// <returns></returns>
public override string ToString()
{
return CommandText;
}
#endregion Methods
#region Merge
private PipelineResultTypes _mergeUnclaimedPreviousCommandResults =
PipelineResultTypes.None;
/// <summary>
/// Sets this command as the mergepoint for previous unclaimed
/// commands' results
/// </summary>
/// <value></value>
/// <remarks>
/// Currently only supported operation is to merge
/// Output and Error.
/// </remarks>
/// <exception cref="NotSupportedException">
/// Currently only supported operation is to merge Output and Error.
/// Attempt to set the property to something other than
/// PipelineResultTypes.Error | PipelineResultTypes.Output results
/// in this exception.
/// </exception>
public PipelineResultTypes MergeUnclaimedPreviousCommandResults
{
get
{
return _mergeUnclaimedPreviousCommandResults;
}
set
{
if (value == PipelineResultTypes.None)
{
_mergeUnclaimedPreviousCommandResults = value;
return;
}
if (value != (PipelineResultTypes.Error | PipelineResultTypes.Output))
{
throw PSTraceSource.NewNotSupportedException();
}
_mergeUnclaimedPreviousCommandResults = value;
}
}
//
// These properties are kept for backwards compatibility for V2
// over the wire, which allows merging only for Error stream.
//
internal PipelineResultTypes MergeMyResult { get; private set; } = PipelineResultTypes.None;
internal PipelineResultTypes MergeToResult { get; private set; } = PipelineResultTypes.None;
//
// For V3 we allow merging from all streams except Output.
//
internal enum MergeType
{
Error = 0,
Warning = 1,
Verbose = 2,
Debug = 3,
Information = 4
}
internal const int MaxMergeType = (int)(MergeType.Information + 1);
/// <summary>
/// Internal accessor for _mergeInstructions. It is used by serialization
/// code
/// </summary>
internal PipelineResultTypes[] MergeInstructions { get; set; } = new PipelineResultTypes[MaxMergeType];
/// <summary>
/// Merges this commands results
/// </summary>
///
/// <param name="myResult">
/// Pipeline stream to be redirected.
/// </param>
///
/// <param name="toResult">
/// Pipeline stream in to which myResult is merged
/// </param>
///
/// <exception cref="ArgumentException">
/// myResult parameter is not PipelineResultTypes.Error or
/// toResult parameter is not PipelineResultTypes.Output
/// </exception>
/// <remarks>
/// Currently only operation supported is to merge error of command to output of
/// command.
/// </remarks>
public void MergeMyResults(PipelineResultTypes myResult, PipelineResultTypes toResult)
{
if (myResult == PipelineResultTypes.None && toResult == PipelineResultTypes.None)
{
// For V2 backwards compatibility.
MergeMyResult = myResult;
MergeToResult = toResult;
for (int i = 0; i < MaxMergeType; ++i)
{
MergeInstructions[i] = PipelineResultTypes.None;
}
return;
}
// Validate parameters.
if (myResult == PipelineResultTypes.None || myResult == PipelineResultTypes.Output)
{
throw PSTraceSource.NewArgumentException("myResult", RunspaceStrings.InvalidMyResultError);
}
if (myResult == PipelineResultTypes.Error && toResult != PipelineResultTypes.Output)
{
throw PSTraceSource.NewArgumentException("toResult", RunspaceStrings.InvalidValueToResultError);
}
if (toResult != PipelineResultTypes.Output && toResult != PipelineResultTypes.Null)
{
throw PSTraceSource.NewArgumentException("toResult", RunspaceStrings.InvalidValueToResult);
}
// For V2 backwards compatibility.
if (myResult == PipelineResultTypes.Error)
{
MergeMyResult = myResult;
MergeToResult = toResult;
}
// Set internal merge instructions.
if (myResult == PipelineResultTypes.Error || myResult == PipelineResultTypes.All)
{
MergeInstructions[(int)MergeType.Error] = toResult;
}
if (myResult == PipelineResultTypes.Warning || myResult == PipelineResultTypes.All)
{
MergeInstructions[(int)MergeType.Warning] = toResult;
}
if (myResult == PipelineResultTypes.Verbose || myResult == PipelineResultTypes.All)
{
MergeInstructions[(int)MergeType.Verbose] = toResult;
}
if (myResult == PipelineResultTypes.Debug || myResult == PipelineResultTypes.All)
{
MergeInstructions[(int)MergeType.Debug] = toResult;
}
if (myResult == PipelineResultTypes.Information || myResult == PipelineResultTypes.All)
{
MergeInstructions[(int)MergeType.Information] = toResult;
}
}
/// <summary>
/// Set the merge settings on commandProcessor
/// </summary>
/// <param name="commandProcessor"></param>
private
void
SetMergeSettingsOnCommandProcessor(CommandProcessorBase commandProcessor)
{
Dbg.Assert(commandProcessor != null, "caller should validate the parameter");
MshCommandRuntime mcr = commandProcessor.Command.commandRuntime as MshCommandRuntime;
if (_mergeUnclaimedPreviousCommandResults != PipelineResultTypes.None)
{
//Currently only merging previous unclaimed error and output is supported.
if (mcr != null)
{
mcr.MergeUnclaimedPreviousErrorResults = true;
}
}
// Error merge.
if (MergeInstructions[(int)MergeType.Error] == PipelineResultTypes.Output)
{
//Currently only merging error with output is supported.
mcr.ErrorMergeTo = MshCommandRuntime.MergeDataStream.Output;
}
// Warning merge.
PipelineResultTypes toType = MergeInstructions[(int)MergeType.Warning];
if (toType != PipelineResultTypes.None)
{
mcr.WarningOutputPipe = GetRedirectionPipe(toType, mcr);
}
// Verbose merge.
toType = MergeInstructions[(int)MergeType.Verbose];
if (toType != PipelineResultTypes.None)
{
mcr.VerboseOutputPipe = GetRedirectionPipe(toType, mcr);
}
// Debug merge.
toType = MergeInstructions[(int)MergeType.Debug];
if (toType != PipelineResultTypes.None)
{
mcr.DebugOutputPipe = GetRedirectionPipe(toType, mcr);
}
// Information merge.
toType = MergeInstructions[(int)MergeType.Information];
if (toType != PipelineResultTypes.None)
{
mcr.InformationOutputPipe = GetRedirectionPipe(toType, mcr);
}
}
private Pipe GetRedirectionPipe(
PipelineResultTypes toType,
MshCommandRuntime mcr)
{
if (toType == PipelineResultTypes.Output)
{
return mcr.OutputPipe;
}
Pipe pipe = new Pipe();
pipe.NullPipe = true;
return pipe;
}
#endregion Merge
/// <summary>
/// Create a CommandProcessorBase for this Command
/// </summary>
/// <param name="executionContext"></param>
/// <param name="addToHistory"></param>
/// <param name="origin"></param>
/// <returns></returns>
internal
CommandProcessorBase
CreateCommandProcessor
(
ExecutionContext executionContext,
bool addToHistory,
CommandOrigin origin
)
{
Dbg.Assert(executionContext != null, "Caller should verify the parameters");
CommandProcessorBase commandProcessorBase;
if (IsScript)
{
if ((executionContext.LanguageMode == PSLanguageMode.NoLanguage) &&
(origin == Automation.CommandOrigin.Runspace))
{
throw InterpreterError.NewInterpreterException(CommandText, typeof(ParseException),
null, "ScriptsNotAllowed", ParserStrings.ScriptsNotAllowed);
}
ScriptBlock scriptBlock = executionContext.Engine.ParseScriptBlock(CommandText, addToHistory);
if (origin == Automation.CommandOrigin.Internal)
{
scriptBlock.LanguageMode = PSLanguageMode.FullLanguage;
}
// If running in restricted language mode, verify that the parse tree represents on legitimate
// constructions...
switch (scriptBlock.LanguageMode)
{
case PSLanguageMode.RestrictedLanguage:
scriptBlock.CheckRestrictedLanguage(null, null, false);
break;
case PSLanguageMode.FullLanguage:
// Interactive script commands are permitted in this mode.
break;
case PSLanguageMode.ConstrainedLanguage:
// Constrained Language is checked at runtime.
break;
default:
// This should never happen...
Diagnostics.Assert(false, "Invalid language mode was set when building a ScriptCommandProcessor");
throw new InvalidOperationException("Invalid language mode was set when building a ScriptCommandProcessor");
}
if (scriptBlock.UsesCmdletBinding)
{
FunctionInfo functionInfo = new FunctionInfo("", scriptBlock, executionContext);
commandProcessorBase = new CommandProcessor(functionInfo, executionContext,
_useLocalScope ?? false, fromScriptFile: false, sessionState: executionContext.EngineSessionState);
}
else
{
commandProcessorBase = new DlrScriptCommandProcessor(scriptBlock,
executionContext, _useLocalScope ?? false,
origin,
executionContext.EngineSessionState);
}
}
else
{
// RestrictedLanguage / NoLanguage do not support dot-sourcing when CommandOrigin is Runspace
if ((_useLocalScope.HasValue) && (!_useLocalScope.Value))
{
switch (executionContext.LanguageMode)
{
case PSLanguageMode.RestrictedLanguage:
case PSLanguageMode.NoLanguage:
string message = StringUtil.Format(RunspaceStrings.UseLocalScopeNotAllowed,
"UseLocalScope",
PSLanguageMode.RestrictedLanguage.ToString(),
PSLanguageMode.NoLanguage.ToString());
throw new RuntimeException(message);
case PSLanguageMode.FullLanguage:
// Interactive script commands are permitted in this mode...
break;
}
}
commandProcessorBase = executionContext.CommandDiscovery.LookupCommandProcessor(CommandText, origin, _useLocalScope);
}
CommandParameterCollection parameters = Parameters;
if (parameters != null)
{
bool isNativeCommand = commandProcessorBase is NativeCommandProcessor;
foreach (CommandParameter publicParameter in parameters)
{
CommandParameterInternal internalParameter = CommandParameter.ToCommandParameterInternal(publicParameter, isNativeCommand);
commandProcessorBase.AddParameter(internalParameter);
}
}
string helpTarget;
HelpCategory helpCategory;
if (commandProcessorBase.IsHelpRequested(out helpTarget, out helpCategory))
{
commandProcessorBase = CommandProcessorBase.CreateGetHelpCommandProcessor(
executionContext,
helpTarget,
helpCategory);
}
//Set the merge settings
SetMergeSettingsOnCommandProcessor(commandProcessorBase);
return commandProcessorBase;
}
#region Private fields
/// <summary>
/// This is used for script commands (i.e. _isScript is true). If
/// _useLocalScope is true, script is run in LocalScope. If
/// null, it was unspecified and a suitable default is used (true
/// for non-script, false for script). Note that the public
/// property is bool, not bool? (from V1), so it should probably
/// be deprecated, at least for internal use.
/// </summary>
private bool? _useLocalScope;
#endregion Private fields
#region Serialization / deserialization for remoting
/// <summary>
/// Creates a Command object from a PSObject property bag.
/// PSObject has to be in the format returned by ToPSObjectForRemoting method.
/// </summary>
/// <param name="commandAsPSObject">PSObject to rehydrate</param>
/// <returns>
/// Command rehydrated from a PSObject property bag
/// </returns>
/// <exception cref="ArgumentNullException">
/// Thrown if the PSObject is null.
/// </exception>
/// <exception cref="System.Management.Automation.Remoting.PSRemotingDataStructureException">
/// Thrown when the PSObject is not in the expected format
/// </exception>
internal static Command FromPSObjectForRemoting(PSObject commandAsPSObject)
{
if (commandAsPSObject == null)
{
throw PSTraceSource.NewArgumentNullException("commandAsPSObject");
}
string commandText = RemotingDecoder.GetPropertyValue<string>(commandAsPSObject, RemoteDataNameStrings.CommandText);
bool isScript = RemotingDecoder.GetPropertyValue<bool>(commandAsPSObject, RemoteDataNameStrings.IsScript);
bool? useLocalScopeNullable = RemotingDecoder.GetPropertyValue<bool?>(commandAsPSObject, RemoteDataNameStrings.UseLocalScopeNullable);
Command command = new Command(commandText, isScript, useLocalScopeNullable);
// For V2 backwards compatibility.
PipelineResultTypes mergeMyResult = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeMyResult);
PipelineResultTypes mergeToResult = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeToResult);
command.MergeMyResults(mergeMyResult, mergeToResult);
command.MergeUnclaimedPreviousCommandResults = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeUnclaimedPreviousCommandResults);
// V3 merge instructions will not be returned by V2 server and this is expected.
if (commandAsPSObject.Properties[RemoteDataNameStrings.MergeError] != null)
{
command.MergeInstructions[(int)MergeType.Error] = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeError);
}
if (commandAsPSObject.Properties[RemoteDataNameStrings.MergeWarning] != null)
{
command.MergeInstructions[(int)MergeType.Warning] = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeWarning);
}
if (commandAsPSObject.Properties[RemoteDataNameStrings.MergeVerbose] != null)
{
command.MergeInstructions[(int)MergeType.Verbose] = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeVerbose);
}
if (commandAsPSObject.Properties[RemoteDataNameStrings.MergeDebug] != null)
{
command.MergeInstructions[(int)MergeType.Debug] = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeDebug);
}
if (commandAsPSObject.Properties[RemoteDataNameStrings.MergeInformation] != null)
{
command.MergeInstructions[(int)MergeType.Information] = RemotingDecoder.GetPropertyValue<PipelineResultTypes>(commandAsPSObject, RemoteDataNameStrings.MergeInformation);
}
foreach (PSObject parameterAsPSObject in RemotingDecoder.EnumerateListProperty<PSObject>(commandAsPSObject, RemoteDataNameStrings.Parameters))
{
command.Parameters.Add(CommandParameter.FromPSObjectForRemoting(parameterAsPSObject));
}
return command;
}
/// <summary>
/// Returns this object as a PSObject property bag
/// that can be used in a remoting protocol data object.
/// </summary>
/// <param name="psRPVersion">PowerShell remoting protocol version</param>
/// <returns>This object as a PSObject property bag</returns>
internal PSObject ToPSObjectForRemoting(Version psRPVersion)
{
PSObject commandAsPSObject = RemotingEncoder.CreateEmptyPSObject();
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.CommandText, this.CommandText));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.IsScript, this.IsScript));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.UseLocalScopeNullable, this.UseLocalScopeNullable));
// For V2 backwards compatibility.
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeMyResult, this.MergeMyResult));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeToResult, this.MergeToResult));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeUnclaimedPreviousCommandResults, this.MergeUnclaimedPreviousCommandResults));
if (psRPVersion != null &&
psRPVersion >= RemotingConstants.ProtocolVersionWin10RTM)
{
// V5 merge instructions
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeError, MergeInstructions[(int)MergeType.Error]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeWarning, MergeInstructions[(int)MergeType.Warning]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeVerbose, MergeInstructions[(int)MergeType.Verbose]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeDebug, MergeInstructions[(int)MergeType.Debug]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeInformation, MergeInstructions[(int)MergeType.Information]));
}
else if (psRPVersion != null &&
psRPVersion >= RemotingConstants.ProtocolVersionWin8RTM)
{
// V3 merge instructions.
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeError, MergeInstructions[(int)MergeType.Error]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeWarning, MergeInstructions[(int)MergeType.Warning]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeVerbose, MergeInstructions[(int)MergeType.Verbose]));
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.MergeDebug, MergeInstructions[(int)MergeType.Debug]));
// If they've explicitly redirected the Information stream, generate an error. Don't
// generate an error if they've done "*", as that makes any new stream a breaking change.
if ((MergeInstructions[(int)MergeType.Information] == PipelineResultTypes.Output) &&
(MergeInstructions.Length != MaxMergeType))
{
throw new RuntimeException(
StringUtil.Format(RunspaceStrings.InformationRedirectionNotSupported));
}
}
else
{
// If they've explicitly redirected an unsupported stream, generate an error. Don't
// generate an error if they've done "*", as that makes any new stream a breaking change.
if (MergeInstructions.Length != MaxMergeType)
{
if (MergeInstructions[(int)MergeType.Warning] == PipelineResultTypes.Output)
{
throw new RuntimeException(
StringUtil.Format(RunspaceStrings.WarningRedirectionNotSupported));
}
if (MergeInstructions[(int)MergeType.Verbose] == PipelineResultTypes.Output)
{
throw new RuntimeException(
StringUtil.Format(RunspaceStrings.VerboseRedirectionNotSupported));
}
if (MergeInstructions[(int)MergeType.Debug] == PipelineResultTypes.Output)
{
throw new RuntimeException(
StringUtil.Format(RunspaceStrings.DebugRedirectionNotSupported));
}
if (MergeInstructions[(int)MergeType.Information] == PipelineResultTypes.Output)
{
throw new RuntimeException(
StringUtil.Format(RunspaceStrings.InformationRedirectionNotSupported));
}
}
}
List<PSObject> parametersAsListOfPSObjects = new List<PSObject>(this.Parameters.Count);
foreach (CommandParameter parameter in this.Parameters)
{
parametersAsListOfPSObjects.Add(parameter.ToPSObjectForRemoting());
}
commandAsPSObject.Properties.Add(new PSNoteProperty(RemoteDataNameStrings.Parameters, parametersAsListOfPSObjects));
return commandAsPSObject;
}
#endregion
#region Win Blue Extensions
#if !CORECLR // PSMI Not Supported On CSS
internal CimInstance ToCimInstance()
{
CimInstance c = InternalMISerializer.CreateCimInstance("PS_Command");
CimProperty commandTextProperty = InternalMISerializer.CreateCimProperty("CommandText",
this.CommandText,
Microsoft.Management.Infrastructure.CimType.String);
c.CimInstanceProperties.Add(commandTextProperty);
CimProperty isScriptProperty = InternalMISerializer.CreateCimProperty("IsScript",
this.IsScript,
Microsoft.Management.Infrastructure.CimType.Boolean);
c.CimInstanceProperties.Add(isScriptProperty);
if (this.Parameters != null && this.Parameters.Count > 0)
{
List<CimInstance> parameterInstances = new List<CimInstance>();
foreach (var p in this.Parameters)
{
parameterInstances.Add(p.ToCimInstance());
}
if (parameterInstances.Count > 0)
{
CimProperty parametersProperty = InternalMISerializer.CreateCimProperty("Parameters",
parameterInstances.ToArray(),
Microsoft.Management.Infrastructure.CimType.ReferenceArray);
c.CimInstanceProperties.Add(parametersProperty);
}
}
return c;
}
#endif
#endregion Win Blue Extensions
}
/// <summary>
/// Enum defining the types of streams coming out of a pipeline
/// </summary>
[Flags]
public enum PipelineResultTypes
{
/// <summary>
/// Default streaming behavior
/// </summary>
None,
/// <summary>
/// Success output
/// </summary>
Output,
/// <summary>
/// Error output
/// </summary>
Error,
/// <summary>
/// Warning information stream
/// </summary>
Warning,
/// <summary>
/// Verbose information stream
/// </summary>
Verbose,
/// <summary>
/// Debug information stream
/// </summary>
Debug,
/// <summary>
/// Information information stream
/// </summary>
Information,
/// <summary>
/// All streams
/// </summary>
All,
/// <summary>
/// Redirect to nothing.
/// </summary>
Null
}
/// <summary>
/// Defines a collection of Commands. This collection is used by <see cref="Pipeline"/> to define
/// elements of pipeline.
/// </summary>
public sealed class CommandCollection : Collection<Command>
{
/// <summary>
/// Make the default constructor internal
/// </summary>
internal CommandCollection()
{
}
/// <summary>
/// Adds a new command for given string
/// </summary>
/// <exception cref="System.ArgumentNullException">
/// command is null.
/// </exception>
public void Add(string command)
{
if (String.Equals(command, "out-default", StringComparison.OrdinalIgnoreCase))
{
this.Add(command, true);
}
else
{
this.Add(new Command(command));
}
}
internal void Add(string command, bool mergeUnclaimedPreviousCommandError)
{
this.Add(new Command(command, false, false, mergeUnclaimedPreviousCommandError));
}
/// <summary>
/// Adds a new script command
/// </summary>
/// <param name="scriptContents">script contents</param>
/// <exception cref="System.ArgumentNullException">
/// scriptContents is null.
/// </exception>
public void AddScript(string scriptContents)
{
this.Add(new Command(scriptContents, true));
}
/// <summary>
/// Adds a new scrip command for given script
/// </summary>
/// <param name="scriptContents">script contents</param>
/// <param name="useLocalScope">if true local scope is used to run the script command</param>
/// <exception cref="System.ArgumentNullException">
/// scriptContents is null.
/// </exception>
public void AddScript(string scriptContents, bool useLocalScope)
{
this.Add(new Command(scriptContents, true, useLocalScope));
}
/// <summary>
/// Gets the string representation of the command collection to be used for history.
/// </summary>
/// <returns>
/// string representing the command(s)
/// </returns>
internal string GetCommandStringForHistory()
{
Diagnostics.Assert(this.Count != 0, "this is called when there is at least one element in the collection");
Command firstCommand = this[0];
return firstCommand.CommandText;
}
}
}