forked from PowerShell/PowerShell
/
Attributes.cs
2254 lines (2020 loc) · 87.1 KB
/
Attributes.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
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using System.Management.Automation.Internal;
using System.Management.Automation.Language;
using System.Runtime.CompilerServices;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
namespace System.Management.Automation.Internal
{
/// <summary>
/// Serves as the base class for Metadata attributes.
/// </summary>
/// <remarks>
/// PSSnapins may not create custom attributes derived directly from <see cref="CmdletMetadataAttribute"/>,
/// since it has no public constructor. Only the public subclasses <see cref="ValidateArgumentsAttribute"/>
/// and <see cref="ArgumentTransformationAttribute"/> are available.
/// </remarks>
/// <seealso cref="CmdletMetadataAttribute"/>
/// <seealso cref="ValidateArgumentsAttribute"/>
/// <seealso cref="ArgumentTransformationAttribute"/>
[AttributeUsage(AttributeTargets.All)]
public abstract class CmdletMetadataAttribute : Attribute
{
/// <summary>
/// Default constructor.
/// </summary>
internal CmdletMetadataAttribute()
{
}
}
/// <summary>
/// Serves as the base class for Metadata attributes that serve as guidance to the parser and parameter binder.
/// </summary>
/// <remarks>
/// PSSnapins may not create custom attributes derived from <see cref="ParsingBaseAttribute"/>, since it
/// has no public constructor. Only the sealed public subclasses <see cref="ParameterAttribute"/> and
/// <see cref="AliasAttribute"/> are available.
/// </remarks>
/// <seealso cref="ParsingBaseAttribute"/>
/// <seealso cref="ParameterAttribute"/>
/// <seealso cref="AliasAttribute"/>
[AttributeUsage(AttributeTargets.All)]
public abstract class ParsingBaseAttribute : CmdletMetadataAttribute
{
/// <summary>
/// Constructor with no parameters.
/// </summary>
internal ParsingBaseAttribute()
{
}
}
}
namespace System.Management.Automation
{
#region Base Metadata Classes
/// <summary>
/// Serves as the base class for Validate attributes that validate parameter arguments.
/// </summary>
/// <remarks>
/// Argument validation attributes can be attached to <see cref="Cmdlet"/> and
/// <see cref="Provider.CmdletProvider"/> parameters to ensure that the Cmdlet or CmdletProvider will
/// not be invoked with invalid values of the parameter. Existing validation attributes include
/// <see cref="ValidateCountAttribute"/>,
/// <see cref="ValidateNotNullAttribute"/>,
/// <see cref="ValidateNotNullOrEmptyAttribute"/>,
/// <see cref="ValidateArgumentsAttribute"/>,
/// <see cref="ValidateLengthAttribute"/>,
/// <see cref="ValidateRangeAttribute"/>,
/// <see cref="ValidatePatternAttribute"/>, and
/// <see cref="ValidateSetAttribute"/>.
/// PSSnapins wishing to create custom argument validation attributes should derive from
/// <see cref="ValidateArgumentsAttribute"/> and override the
/// <see cref="ValidateArgumentsAttribute.Validate"/> abstract method, after which they can apply the
/// attribute to their parameters.
/// <see cref="ValidateArgumentsAttribute"/> validates the argument as a whole. If the argument value may
/// be an enumerable, you can derive from <see cref="ValidateEnumeratedArgumentsAttribute"/>
/// which will take care of unrolling the enumerable and validate each element individually.
/// It is also recommended to override <see cref="System.Object.ToString"/> to return a readable string
/// similar to the attribute declaration, for example "[ValidateRangeAttribute(5,10)]".
/// If this attribute is applied to a string parameter, the string command argument will be validated.
/// If this attribute is applied to a string[] parameter, the string[] command argument will be validated.
/// </remarks>
/// <seealso cref="ValidateEnumeratedArgumentsAttribute"/>
/// <seealso cref="ValidateCountAttribute"/>
/// <seealso cref="ValidateNotNullAttribute"/>
/// <seealso cref="ValidateNotNullOrEmptyAttribute"/>
/// <seealso cref="ValidateArgumentsAttribute"/>
/// <seealso cref="ValidateLengthAttribute"/>
/// <seealso cref="ValidateRangeAttribute"/>
/// <seealso cref="ValidatePatternAttribute"/>
/// <seealso cref="ValidateSetAttribute"/>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public abstract class ValidateArgumentsAttribute : CmdletMetadataAttribute
{
/// <summary>
/// Verify that the value of <paramref name="arguments"/> is valid.
/// </summary>
/// <param name="arguments">Argument value to validate.</param>
/// <param name="engineIntrinsics">
/// The engine APIs for the context under which the prerequisite is being evaluated.
/// </param>
/// <exception cref="ValidationMetadataException">Should be thrown for any validation failure.</exception>
protected abstract void Validate(object arguments, EngineIntrinsics engineIntrinsics);
/// <summary>
/// Method that the command processor calls for data validate processing.
/// </summary>
/// <param name="o">Object to validate.</param>
/// <param name="engineIntrinsics">
/// The engine APIs for the context under which the prerequisite is being evaluated.
/// </param>
/// <returns>True if the validation succeeded.</returns>
/// <exception cref="ValidationMetadataException">
/// Whenever any exception occurs during data validation.
/// Additionally, all the system exceptions are wrapped in ValidationMetadataException.
/// </exception>
/// <exception cref="ArgumentException">For invalid arguments.</exception>
internal void InternalValidate(object o, EngineIntrinsics engineIntrinsics) => Validate(o, engineIntrinsics);
/// <summary>
/// Initializes a new instance of a class derived from <see cref="ValidateArgumentsAttribute"/>.
/// </summary>
protected ValidateArgumentsAttribute()
{
}
}
/// <summary>
/// A variant of <see cref="ValidateArgumentsAttribute"/> which unrolls enumeration values and validates
/// each element individually.
/// </summary>
/// <remarks>
/// <see cref="ValidateEnumeratedArgumentsAttribute"/> is like <see cref="ValidateArgumentsAttribute"/>,
/// except that if the argument value is enumerable, <see cref="ValidateEnumeratedArgumentsAttribute"/>
/// will unroll the enumeration and validate each item individually.
/// Existing enumerated validation attributes include
/// <see cref="ValidateLengthAttribute"/>,
/// <see cref="ValidateRangeAttribute"/>,
/// <see cref="ValidatePatternAttribute"/>, and
/// <see cref="ValidateSetAttribute"/>.
/// PSSnapins wishing to create custom enumerated argument validation attributes should derive from
/// <seealso cref="ValidateEnumeratedArgumentsAttribute"/> and override the
/// <seealso cref="ValidateEnumeratedArgumentsAttribute.ValidateElement"/>
/// abstract method, after which they can apply the attribute to their parameters.
/// It is also recommended to override <see cref="System.Object.ToString"/> to return a readable string
/// similar to the attribute declaration, for example "[ValidateRangeAttribute(5,10)]".
/// If this attribute is applied to a string parameter, the string command argument will be validated.
/// If this attribute is applied to a string[] parameter, each string command argument will be validated.
/// </remarks>
/// <seealso cref="ValidateArgumentsAttribute"/>
/// <seealso cref="ValidateLengthAttribute"/>
/// <seealso cref="ValidateRangeAttribute"/>
/// <seealso cref="ValidatePatternAttribute"/>
/// <seealso cref="ValidateSetAttribute"/>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public abstract class ValidateEnumeratedArgumentsAttribute : ValidateArgumentsAttribute
{
/// <summary>
/// Initializes a new instance of a class derived from <see cref="ValidateEnumeratedArgumentsAttribute"/>.
/// </summary>
protected ValidateEnumeratedArgumentsAttribute() : base()
{
}
/// <summary>
/// Abstract method to be overridden by subclasses, implementing the validation of each parameter argument.
/// </summary>
/// <remarks>
/// Validate that the value of <paramref name="element"/> is valid, and throw
/// <see cref="ValidationMetadataException"/> if it is invalid.
/// </remarks>
/// <param name="element">One of the parameter arguments.</param>
/// <exception cref="ValidationMetadataException">Should be thrown for any validation failure.</exception>
protected abstract void ValidateElement(object element);
/// <summary>
/// Calls ValidateElement in each element in the enumeration argument value.
/// </summary>
/// <param name="arguments">Object to validate.</param>
/// <param name="engineIntrinsics">
/// The engine APIs for the context under which the prerequisite is being evaluated.
/// </param>
/// <remarks>
/// PSSnapins should override <see cref="ValidateElement"/> instead.
/// </remarks>
/// <exception cref="ValidationMetadataException">Should be thrown for any validation failure.</exception>
protected sealed override void Validate(object arguments, EngineIntrinsics engineIntrinsics)
{
if (LanguagePrimitives.IsNull(arguments))
{
throw new ValidationMetadataException(
"ArgumentIsEmpty",
null,
Metadata.ValidateNotNullOrEmptyCollectionFailure);
}
var enumerator = _getEnumeratorSite.Target.Invoke(_getEnumeratorSite, arguments);
if (enumerator == null)
{
ValidateElement(arguments);
return;
}
// arguments is IEnumerator
while (enumerator.MoveNext())
{
ValidateElement(enumerator.Current);
}
enumerator.Reset();
}
private readonly CallSite<Func<CallSite, object, IEnumerator>> _getEnumeratorSite =
CallSite<Func<CallSite, object, IEnumerator>>.Create(PSEnumerableBinder.Get());
}
#endregion Base Metadata Classes
#region Misc Attributes
/// <summary>
/// To specify RunAs behavior for the class
/// /// </summary>
public enum DSCResourceRunAsCredential
{
/// <summary>Default is same as optional.</summary>
Default,
/// <summary>
/// PsDscRunAsCredential can not be used for this DSC Resource.
/// </summary>
NotSupported,
/// <summary>
/// PsDscRunAsCredential is mandatory for resource.
/// </summary>
Mandatory,
/// <summary>
/// PsDscRunAsCredential can or can not be specified.
/// </summary>
Optional = Default,
}
/// <summary>
/// Indicates the class defines a DSC resource.
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public class DscResourceAttribute : CmdletMetadataAttribute
{
/// <summary>
/// To specify RunAs Behavior for the resource.
/// </summary>
public DSCResourceRunAsCredential RunAsCredential { get; set; }
}
/// <summary>
/// When specified on a property or field of a DSC Resource, the property
/// can or must be specified in a configuration, unless it is marked
/// <see cref="DscPropertyAttribute.NotConfigurable"/>, in which case it is
/// returned by the Get() method of the resource.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public class DscPropertyAttribute : CmdletMetadataAttribute
{
/// <summary>
/// Indicates the property is a required key property for a DSC resource.
/// </summary>
public bool Key { get; set; }
/// <summary>
/// Indicates the property is a required property for a DSC resource.
/// </summary>
public bool Mandatory { get; set; }
/// <summary>
/// Indicates the property is not a parameter to the DSC resource, but the
/// property will contain a value after the Get() method of the resource is called.
/// </summary>
public bool NotConfigurable { get; set; }
}
/// <summary>
/// Indication the configuration is for local configuration manager, also known as meta configuration.
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public class DscLocalConfigurationManagerAttribute : CmdletMetadataAttribute
{
}
/// <summary>
/// Contains information about a cmdlet's metadata.
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public abstract class CmdletCommonMetadataAttribute : CmdletMetadataAttribute
{
/// <summary>
/// Gets or sets the cmdlet default parameter set.
/// </summary>
public string DefaultParameterSetName { get; set; }
/// <summary>
/// Gets or sets a Boolean value that indicates the Cmdlet supports ShouldProcess. By default
/// the value is false, meaning the cmdlet doesn't support ShouldProcess.
/// </summary>
public bool SupportsShouldProcess { get; set; } = false;
/// <summary>
/// Gets or sets a Boolean value that indicates the Cmdlet supports Paging. By default
/// the value is false, meaning the cmdlet doesn't support Paging.
/// </summary>
public bool SupportsPaging { get; set; } = false;
/// <summary>
/// Gets or sets a Boolean value that indicates the Cmdlet supports Transactions. By default
/// the value is false, meaning the cmdlet doesn't support Transactions.
/// </summary>
public bool SupportsTransactions
{
get
{
return _supportsTransactions;
}
set
{
#if !CORECLR
_supportsTransactions = value;
#else
// Disable 'SupportsTransactions' in CoreCLR
// No transaction supported on CSS due to the lack of System.Transactions namespace
_supportsTransactions = false;
#endif
}
}
private bool _supportsTransactions = false;
private ConfirmImpact _confirmImpact = ConfirmImpact.Medium;
/// <summary>
/// Gets or sets a ConfirmImpact value that indicates the "destructiveness" of the operation
/// and when it should be confirmed. This should only be used when SupportsShouldProcess is
/// specified.
/// </summary>
public ConfirmImpact ConfirmImpact
{
get => SupportsShouldProcess ? _confirmImpact : ConfirmImpact.None;
set => _confirmImpact = value;
}
/// <summary>
/// Gets or sets a HelpUri value that indicates the location of online help. This is used by
/// Get-Help to retrieve help content when -Online is specified.
/// </summary>
[SuppressMessage("Microsoft.Design", "CA1056:UriPropertiesShouldNotBeStrings")]
public string HelpUri { get; set; } = string.Empty;
/// <summary>
/// Gets or sets the RemotingBehavior value that declares how this cmdlet should interact
/// with ambient remoting.
/// </summary>
public RemotingCapability RemotingCapability { get; set; } = RemotingCapability.PowerShell;
}
/// <summary>
/// Identifies a class as a cmdlet and specifies the verb and noun identifying this cmdlet.
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public sealed class CmdletAttribute : CmdletCommonMetadataAttribute
{
/// <summary>
/// Gets the cmdlet noun.
/// </summary>
public string NounName { get; }
/// <summary>
/// Gets the cmdlet verb.
/// </summary>
public string VerbName { get; }
/// <summary>
/// Initializes a new instance of the CmdletAttribute class.
/// </summary>
/// <param name="verbName">Verb for the command.</param>
/// <param name="nounName">Noun for the command.</param>
/// <exception cref="ArgumentException">For invalid arguments.</exception>
public CmdletAttribute(string verbName, string nounName)
{
// NounName,VerbName have to be Non-Null strings
if (string.IsNullOrEmpty(nounName))
{
throw PSTraceSource.NewArgumentException(nameof(nounName));
}
if (string.IsNullOrEmpty(verbName))
{
throw PSTraceSource.NewArgumentException(nameof(verbName));
}
NounName = nounName;
VerbName = verbName;
}
}
/// <summary>
/// Identifies PowerShell script code as behaving like a cmdlet and hence uses cmdlet parameter binding
/// instead of script parameter binding.
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public class CmdletBindingAttribute : CmdletCommonMetadataAttribute
{
/// <summary>
/// When true, the script will auto-generate appropriate parameter metadata to support positional
/// parameters if the script hasn't already specified multiple parameter sets or specified positions
/// explicitly via the <see cref="ParameterAttribute"/>.
/// </summary>
public bool PositionalBinding { get; set; } = true;
}
/// <summary>
/// OutputTypeAttribute is used to specify the type of objects output by a cmdlet or script.
/// </summary>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
[SuppressMessage("Microsoft.Design", "CA1019:DefineAccessorsForAttributeArguments")]
public sealed class OutputTypeAttribute : CmdletMetadataAttribute
{
/// <summary>
/// Construct the attribute from a <see>System.Type</see>
/// </summary>
internal OutputTypeAttribute(Type type)
{
Type = new[] { new PSTypeName(type) };
}
/// <summary>
/// Construct the attribute from a type name.
/// </summary>
internal OutputTypeAttribute(string typeName)
{
Type = new[] { new PSTypeName(typeName) };
}
/// <summary>
/// Construct the attribute from an array of <see>System.Type</see>
/// </summary>
/// <param name="type">The types output by the cmdlet.</param>
public OutputTypeAttribute(params Type[] type)
{
if (type?.Length > 0)
{
Type = new PSTypeName[type.Length];
for (int i = 0; i < type.Length; i++)
{
Type[i] = new PSTypeName(type[i]);
}
}
else
{
Type = Array.Empty<PSTypeName>();
}
}
/// <summary>
/// Construct the attribute from an array of names of types.
/// </summary>
/// <param name="type">The types output by the cmdlet.</param>
public OutputTypeAttribute(params string[] type)
{
if (type?.Length > 0)
{
Type = new PSTypeName[type.Length];
for (int i = 0; i < type.Length; i++)
{
Type[i] = new PSTypeName(type[i]);
}
}
else
{
Type = Array.Empty<PSTypeName>();
}
}
/// <summary>
/// The types specified by the attribute.
/// </summary>
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
public PSTypeName[] Type { get; }
/// <summary>
/// Attributes implemented by a provider can use:
/// [OutputType(ProviderCmdlet='cmdlet', typeof(...))]
/// To specify the provider specific objects returned for a given cmdlet.
/// </summary>
public string ProviderCmdlet { get; set; }
/// <summary>
/// The list of parameter sets this OutputType specifies.
/// </summary>
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ParameterSetName
{
get => _parameterSetName ??= new[] { ParameterAttribute.AllParameterSets };
set => _parameterSetName = value;
}
private string[] _parameterSetName;
}
/// <summary>
/// This attribute is used on a dynamic assembly to mark it as one that is used to implement
/// a set of classes defined in a PowerShell script.
/// </summary>
[AttributeUsage(AttributeTargets.Assembly)]
public class DynamicClassImplementationAssemblyAttribute : Attribute
{
/// <summary>
/// The (possibly null) path to the file defining this class.
/// </summary>
public string ScriptFile { get; set; }
}
#endregion Misc Attributes
#region Parsing guidelines Attributes
/// <summary>
/// Declares an alternative name for a parameter, cmdlet, or function.
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false)]
public sealed class AliasAttribute : ParsingBaseAttribute
{
internal string[] aliasNames;
/// <summary>
/// Gets the alias names passed to the constructor.
/// </summary>
public IList<string> AliasNames { get => this.aliasNames; }
/// <summary>
/// Initializes a new instance of the AliasAttribute class.
/// </summary>
/// <param name="aliasNames">The name for this alias.</param>
/// <exception cref="ArgumentException">For invalid arguments.</exception>
public AliasAttribute(params string[] aliasNames)
{
if (aliasNames == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(aliasNames));
}
this.aliasNames = aliasNames;
}
}
/// <summary>
/// Identifies parameters to Cmdlets.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = true)]
public sealed class ParameterAttribute : ParsingBaseAttribute
{
/// <summary>
/// ParameterSetName referring to all ParameterSets.
/// </summary>
public const string AllParameterSets = "__AllParameterSets";
/// <summary>
/// Initializes a new instance of the ParameterAttribute class.
/// </summary>
public ParameterAttribute()
{
}
/// <summary>
/// Initializes a new instance that is associated with an experimental feature.
/// </summary>
public ParameterAttribute(string experimentName, ExperimentAction experimentAction)
{
ExperimentalAttribute.ValidateArguments(experimentName, experimentAction);
ExperimentName = experimentName;
ExperimentAction = experimentAction;
}
private string _parameterSetName = ParameterAttribute.AllParameterSets;
private string _helpMessage;
private string _helpMessageBaseName;
private string _helpMessageResourceId;
#region Experimental Feature Related Properties
/// <summary>
/// Gets the name of the experimental feature this attribute is associated with.
/// </summary>
public string ExperimentName { get; }
/// <summary>
/// Gets the action for the engine to take when the experimental feature is enabled.
/// </summary>
public ExperimentAction ExperimentAction { get; }
internal bool ToHide => EffectiveAction == ExperimentAction.Hide;
internal bool ToShow => EffectiveAction == ExperimentAction.Show;
/// <summary>
/// Gets the effective action to take at run time.
/// </summary>
private ExperimentAction EffectiveAction
{
get
{
if (_effectiveAction == ExperimentAction.None)
{
_effectiveAction = ExperimentalFeature.GetActionToTake(ExperimentName, ExperimentAction);
}
return _effectiveAction;
}
}
private ExperimentAction _effectiveAction = default(ExperimentAction);
#endregion
/// <summary>
/// Gets or sets the parameter position.
/// If not set, the parameter is named.
/// </summary>
public int Position { get; set; } = int.MinValue;
/// <summary>
/// Gets or sets the name of the parameter set this parameter belongs to.
/// When it is not specified, <see cref="ParameterAttribute.AllParameterSets"/> is assumed.
/// </summary>
public string ParameterSetName
{
get => _parameterSetName;
set => _parameterSetName = string.IsNullOrEmpty(value) ? ParameterAttribute.AllParameterSets : value;
}
/// <summary>
/// Gets or sets a flag specifying if this parameter is Mandatory.
/// When it is not specified, false is assumed and the parameter is considered optional.
/// </summary>
public bool Mandatory { get; set; } = false;
/// <summary>
/// Gets or sets a flag that specifies that this parameter can take values from the incoming pipeline
/// object.
/// When it is not specified, false is assumed.
/// </summary>
public bool ValueFromPipeline { get; set; }
/// <summary>
/// Gets or sets a flag that specifies that this parameter can take values from a property in the
/// incoming pipeline object with the same name as the parameter or an alias of the parameter.
/// When it is not specified, false is assumed.
/// </summary>
public bool ValueFromPipelineByPropertyName { get; set; }
/// <summary>
/// Gets or sets a flag that specifies that the remaining command line parameters should be
/// associated with this parameter in the form of an array.
/// When it is not specified, false is assumed.
/// </summary>
public bool ValueFromRemainingArguments { get; set; } = false;
/// <summary>
/// Gets or sets a short description for this parameter, suitable for presentation as a tool tip.
/// </summary>
/// <exception cref="ArgumentException">For a null or empty value when setting.</exception>
public string HelpMessage
{
get => _helpMessage;
set
{
if (string.IsNullOrEmpty(value))
{
throw PSTraceSource.NewArgumentException(nameof(HelpMessage));
}
_helpMessage = value;
}
}
/// <summary>
/// Gets or sets the base name of the resource for a help message.
/// When this field is specified, HelpMessageResourceId must also be specified.
/// </summary>
/// <exception cref="ArgumentException">For a null or empty value when setting.</exception>
public string HelpMessageBaseName
{
get => _helpMessageBaseName;
set
{
if (string.IsNullOrEmpty(value))
{
throw PSTraceSource.NewArgumentException(nameof(HelpMessageBaseName));
}
_helpMessageBaseName = value;
}
}
/// <summary>
/// Gets or sets the Id of the resource for a help message.
/// When this field is specified, HelpMessageBaseName must also be specified.
/// </summary>
/// <exception cref="ArgumentException">For a null or empty value when setting.</exception>
public string HelpMessageResourceId
{
get => _helpMessageResourceId;
set
{
if (string.IsNullOrEmpty(value))
{
throw PSTraceSource.NewArgumentException(nameof(HelpMessageResourceId));
}
_helpMessageResourceId = value;
}
}
/// <summary>
/// Indicates that this parameter should not be shown to the user in this like intellisense
/// This is primarily to be used in functions that are implementing the logic for dynamic keywords.
/// </summary>
public bool DontShow { get; set; }
}
/// <summary>
/// Specifies PSTypeName of a cmdlet or function parameter.
/// </summary>
/// <remarks>
/// This attribute is used to restrict the type name of the parameter, when the type goes beyond the .NET type system.
/// For example one could say: [PSTypeName("System.Management.ManagementObject#root\cimv2\Win32_Process")]
/// to only allow Win32_Process objects to be bound to the parameter.
/// </remarks>
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class PSTypeNameAttribute : Attribute
{
/// <summary>
/// </summary>
public string PSTypeName { get; }
/// <summary>
/// Creates a new PSTypeNameAttribute.
/// </summary>
/// <param name="psTypeName"></param>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")]
public PSTypeNameAttribute(string psTypeName)
{
if (string.IsNullOrEmpty(psTypeName))
{
throw PSTraceSource.NewArgumentException(nameof(psTypeName));
}
this.PSTypeName = psTypeName;
}
}
/// <summary>
/// Specifies that a parameter supports wildcards.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public sealed class SupportsWildcardsAttribute : ParsingBaseAttribute
{
}
/// <summary>
/// Specify a default value and/or help comment for a command parameter. This attribute
/// does not have any semantic meaning, it is simply an aid to tools to make it simpler
/// to know the true default value of a command parameter (which may or may not have
/// any correlation with, e.g., the backing store of the Parameter's property or field.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public sealed class PSDefaultValueAttribute : ParsingBaseAttribute
{
/// <summary>
/// Specify the default value of a command parameter. The PowerShell engine does not
/// use this value in any way, it exists for other tools that want to reflect on cmdlets.
/// </summary>
public object Value { get; set; }
/// <summary>
/// Specify the help string for the default value of a command parameter.
/// </summary>
public string Help { get; set; }
}
/// <summary>
/// Specify that the member is hidden for the purposes of cmdlets like Get-Member and that the
/// member is not displayed by default by Format-* cmdlets.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Method | AttributeTargets.Constructor | AttributeTargets.Event)]
public sealed class HiddenAttribute : ParsingBaseAttribute
{
}
#endregion Parsing guidelines Attributes
#region Data validate Attributes
/// <summary>
/// Validates that the length of each parameter argument's Length falls in the range specified by
/// <see cref="MinLength"/> and <see cref="MaxLength"/>.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public sealed class ValidateLengthAttribute : ValidateEnumeratedArgumentsAttribute
{
/// <summary>
/// Gets the attribute's minimum length.
/// </summary>
public int MinLength { get; }
/// <summary>
/// Gets the attribute's maximum length.
/// </summary>
public int MaxLength { get; }
/// <summary>
/// Validates that the length of each parameter argument's Length falls in the range specified
/// by <see cref="MinLength"/> and <see cref="MaxLength"/>.
/// </summary>
/// <param name="element">Object to validate.</param>
/// <exception cref="ValidationMetadataException">If <paramref name="element"/> is not a string
/// with length between minLength and maxLength</exception>
/// <exception cref="ArgumentException">For invalid arguments.</exception>
protected override void ValidateElement(object element)
{
if (!(element is string objectString))
{
throw new ValidationMetadataException(
"ValidateLengthNotString",
null,
Metadata.ValidateLengthNotString);
}
int len = objectString.Length;
if (len < MinLength)
{
throw new ValidationMetadataException(
"ValidateLengthMinLengthFailure",
null,
Metadata.ValidateLengthMinLengthFailure,
MinLength, len);
}
if (len > MaxLength)
{
throw new ValidationMetadataException(
"ValidateLengthMaxLengthFailure",
null,
Metadata.ValidateLengthMaxLengthFailure,
MaxLength, len);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="ValidateLengthAttribute"/> class.
/// </summary>
/// <param name="minLength">Minimum required length.</param>
/// <param name="maxLength">Maximum required length.</param>
/// <exception cref="ArgumentOutOfRangeException">For invalid arguments.</exception>
/// <exception cref="ValidationMetadataException">If maxLength is less than minLength.</exception>
public ValidateLengthAttribute(int minLength, int maxLength) : base()
{
if (minLength < 0)
{
throw PSTraceSource.NewArgumentOutOfRangeException(nameof(minLength), minLength);
}
if (maxLength <= 0)
{
throw PSTraceSource.NewArgumentOutOfRangeException(nameof(maxLength), maxLength);
}
if (maxLength < minLength)
{
throw new ValidationMetadataException(
"ValidateLengthMaxLengthSmallerThanMinLength",
null,
Metadata.ValidateLengthMaxLengthSmallerThanMinLength);
}
MinLength = minLength;
MaxLength = maxLength;
}
}
/// <summary>
/// Predefined range kind to use with ValidateRangeAttribute.
/// </summary>
public enum ValidateRangeKind
{
/// <summary>
/// Range is greater than 0.
/// </summary>
Positive,
/// <summary>
/// Range is greater than or equal to 0.
/// </summary>
NonNegative,
/// <summary>
/// Range is less than 0.
/// </summary>
Negative,
/// <summary>
/// Range is less than or equal to 0.
/// </summary>
NonPositive
}
/// <summary>
/// Validates that each parameter argument falls in the range specified by <see cref="MinRange"/>
/// and <see cref="MaxRange"/>.
/// </summary>
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public sealed class ValidateRangeAttribute : ValidateEnumeratedArgumentsAttribute
{
/// <summary>
/// Gets the attribute's minimum range.
/// </summary>
public object MinRange { get; }
private readonly IComparable _minComparable;
/// <summary>
/// Gets the attribute's maximum range.
/// </summary>
public object MaxRange { get; }
private readonly IComparable _maxComparable;
/// <summary>
/// The range values and the value to validate will all be converted to the promoted type.
/// If minRange and maxRange are the same type,
/// </summary>
private readonly Type _promotedType;
/// <summary>
/// Gets the name of the predefined range.
/// </summary>
internal ValidateRangeKind? RangeKind { get => _rangeKind; }
private readonly ValidateRangeKind? _rangeKind;
/// <summary>
/// Validates that each parameter argument falls in the range specified by <see cref="MinRange"/>
/// and <see cref="MaxRange"/>.
/// </summary>
/// <param name="element">Object to validate.</param>
/// <exception cref="ValidationMetadataException">
/// Thrown if the object to be validated does not implement <see cref="IComparable"/>,
/// if the element type is not the same as MinRange/MaxRange, or if the element is not between
/// MinRange and MaxRange.
/// </exception>
protected override void ValidateElement(object element)
{
if (element == null)
{
throw new ValidationMetadataException(
"ArgumentIsEmpty",
null,
Metadata.ValidateNotNullFailure);
}
var o = element as PSObject;
if (o != null)
{
element = o.BaseObject;
}
if (_rangeKind.HasValue)
{
ValidateRange(element, (ValidateRangeKind)_rangeKind);
}
else
{
ValidateRange(element);
}
}