-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
@.ps1
573 lines (531 loc) · 21.8 KB
/
@.ps1
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
#region Splatter [ 0.5.5 ] : Simple Scripts to Supercharge Splatting (Install-Module Splatter, then Initialize-Splatter -Verb Get,Use,Find )
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseDeclaredVarsMoreThanAssignments", "", Justification="This Declares Variables for Other Scripts")]
param()
${?@}=${GetSplat}=${gSplat}={
<#
.Synopsis
Gets a splat
.Description
Gets a splat for a command
.Link
Find-Splat
.Link
Use-Splat
.Example
@{id=$pid} | Get-Splat
.Example
@{id=$Pid} | ?@ # ?@ is an alias for Get-Splat
.Example
@{id=$pid} | & ${?@} # Get-Splat as a script block
#>
[Alias('?@','gSplat')]
param(
# The command that is being splatted.
[Parameter(Mandatory=$true,Position=0)]
[PSObject[]]
$Command,
# The input object
[Parameter(Mandatory=$true,ValueFromPipeline=$true,Position=1)]
[Alias('InputObject')]
[PSObject]
$Splat,
# If set, will return regardless of if parameters map, are valid, and have enough mandatory parameters
[switch]
$Force
)
begin {
# Declare some caches:
if (-not ${script:_@p}) { ${script:_@p} = @{} } # * All Parameters
if (-not ${script:_@c}) { ${script:_@c} = @{} } # * All commands
if (-not ${script:_@mp}) { ${script:_@mp} = @{} } # * All Mandatory Parameters
if (-not ${script:_@pp}) { ${script:_@pp} = @{} } # * All Pipelined Parameters
$ValidateAttributes = {
param(
[Parameter(Mandatory)]$value,
[Parameter(Mandatory)]$attributes
)
foreach ($attr in $attributes) {
$_ = $this = $value
if ($attr -is [Management.Automation.ValidateScriptAttribute]) {
$result = . $attr.ScriptBlock
if ($result -ne $true) {
$attr
}
}
elseif ($attr -is [Management.Automation.ValidatePatternAttribute] -and
(-not [Regex]::new($attr.RegexPattern, $attr.Options, '00:00:05').IsMatch($value))
) { $attr }
elseif ($attr -is [Management.Automation.ValidateSetAttribute] -and
$attr.ValidValues -notcontains $value) { $attr }
elseif ($attr -is [Management.Automation.ValidateRangeAttribute] -and (
($value -gt $attr.MaxRange) -or ($value -lt $attr.MinRange)
)) {$attr}
}
}
}
process {
$ap,$ac,$amp = ${script:_@p},${script:_@c}, ${script:_@mp}
#region Turn dictionaries into PSObjects
if ($Splat -is [Collections.IDictionary]) {
$splat = [PSCustomObject]([Ordered]@{} + $Splat)
}
#endregion Turn dictionaries into PSObjects
$in = $Splat
foreach ($cmd in $Command) { # Walk over each command
$rc =
if ($ac.$cmd) { # use cache if available, otherwise:
$ac.$cmd
} elseif ($cmd -is [string]) { # *find it if it's a [string]
$fc = $ExecutionContext.SessionState.InvokeCommand.GetCommand($cmd,'Function,Cmdlet,ExternalScript,Alias')
$fc =
if ($fc -is [Management.Automation.AliasInfo]) {
$fc.ResolvedCommand
} else {
$fc
}
$ac.$cmd = $fc
$fc
} elseif ($cmd -is [ScriptBlock]) { # * Make a temporary command if it's a [ScriptBlock]
$hc = $cmd.GetHashCode()
$ExecutionContext.SessionState.PSVariable.Set("function:f$hc", $cmd)
$c = $ExecutionContext.SessionState.InvokeCommand.GetCommand("f$hc",'Function')
$ac.$cmd = $c
$c
} elseif ($cmd -is [Management.Automation.CommandInfo]) { # * Otherwise, use the command info
$ac.$cmd = $cmd
$cmd
}
if (-not $rc) {continue}
$cmd = $rc
$outSplat,$Invalid,$Unmapped,$paramMap,$Pipe,$NoPipe = foreach ($_ in 1..6){[ordered]@{}}
$params = [Collections.ArrayList]::new()
$props = @($in.psobject.properties)
$pc = $props.Count
if (-not ${script:_@pp}.$cmd) {
${script:_@pp}.$cmd = @(
foreach ($param in $cmd.Parameters.Values) {
foreach ($attr in $param.Attributes) {
if ($attr.ValueFromPipeline) {
$param
}
}
})
}
$cmdMd = $cmd -as [Management.Automation.CommandMetaData]
$problems = @(
foreach ($vfp in ${script:_@pp}.$cmd) {
if ($in -is $vfp.ParameterType -or
($vfp.ParameterType.IsArray -and $in -as $vfp.ParameterType)
) {
$v = $in
$badAttributes = & $ValidateAttributes $v $vfp.Attributes
if ($badAttributes) {
@{$vfp.Name=$badAttributes}
}
if (-not $badAttributes -or $Force) {
$null = $params.Add($vfp.Name)
$pipe[$vfp.Name] = $v
$outSplat[$vfp.Name] = $v
$paramMap[$vfp.Name] = $vfp.Name
$pipelineParameterSets =
@(foreach ($attr in $vfp.Attributes) {
if ($attr.ParameterSetName) { $attr.ParameterSetName}
})
}
}
}
:NextProperty foreach ($prop in $props) {
$cp=$cmd.Parameters
$pn = $prop.Name
$pv = $prop.Value
if (-not $cp) { continue }
$param = $cp.$pn
if (-not $param) {
$k = "${cmd}:$pn"
$param =
if ($ap[$k]) {
$ap[$k]
} else {
foreach ($p in $cp.Values) {
foreach ($a in $p.Aliases) {
$ap["${cmd}:$a"] = $p
}
if ($ap[$k]) { $ap[$k]; break }
}
}
}
if (-not $param) {
$pn
continue
}
$paramMap[$param.Name] = $pn
if ($params -contains $param) { continue }
$pt=$param.ParameterType
$paramSets =
@(foreach ($attr in $param.Attributes) {
if ($attr.ParameterSetName) { $attr.ParameterSetName }
})
if ($pipelineParameterSets) {
$ok = $false
foreach ($cmdPs in $paramSets) {
$ok = $ok -bor ($pipelineParameterSets -contains $cmdPs)
}
if (-not $ok -and -not $Force) { continue }
}
$v = $pv -as $pt
if (-not $v -and
($pt -eq [ScriptBlock] -or
$pt -eq [ScriptBlock[]])) {
$sb = try { foreach ($_ in $pv) { [ScriptBlock]::Create($_) }} catch {$null}
if ($sb) { $v = $sb }
}
if ($null -ne $v) {
$nv = try {
[PSVariable]::new("$pn", $v, 'Private',$param.Attributes)
} catch {
@{$pn=$_}
}
if ($nv -is [PSVariable] -or $Force) {
$null = $params.Add($param)
:CanItPipe do {
foreach ($attr in $param.Attributes) {
if ($attr.ValueFromPipeline -or $attr.ValueFromPipelineByPropertyName -and
((-not $pipelineParameterSets) -or ($pipelineParameterSets -contains $attr.ParameterSetName))
) {
$pipe[$prop.Name] = $v
break CanItPipe
}
}
$NoPipe[$prop.Name] = $v
} while ($false)
$outSplat[$prop.Name] = $v
}
if ($nv -isnot [PSVariable]) { $nv }
} else {
@{$pn = $param}
}
})
$Mandatory = @{}
foreach ($param in $cmdMd.Parameters.Values) {
foreach ($a in $param.Attributes) {
if (-not $a.Mandatory) { continue }
if ($a -isnot [Management.Automation.ParameterAttribute]) { continue }
if (-not $Mandatory[$a.ParameterSetName]) { $Mandatory[$a.ParameterSetName] = [Ordered]@{} }
$mp = ($paramMap.($param.Name))
$Mandatory[$a.ParameterSetName].($param.Name) =
if ($mp) {
if ($pipelineParameterName -contains $param.Name) {
$in
} else {
$outSplat.$mp
}
}
}
}
$amp.$cmd = $Mandatory
$mandatory = $amp.$cmd
$missingMandatory = @{}
foreach ($m in $Mandatory.GetEnumerator()) {
$missingMandatory[$m.Key] =
@(foreach ($_ in $m.value.GetEnumerator()) {
if ($null -eq $_.Value) { $_.Key }
})
}
$couldRun =
if (-not $Mandatory.Count) { $true }
elseif ($missingMandatory.'__AllParameterSets') {
$false
}
else {
foreach ($_ in $missingMandatory.GetEnumerator()) {
if (-not $_.Value) { $true;break }
}
}
if (-not $couldRun -and -not $Force) { continue }
foreach ($p in $problems) {
if ($p -is [Hashtable]) {
$Invalid += $p
} else { $Unmapped[$p] = $in.$p }
}
if ($Invalid.Count -eq 0) { $Invalid = $null }
if ($Unmapped.Count -eq 0) { $Unmapped = $null }
$realCmd =
if ($cmd -is [Management.Automation.FunctionInfo] -and
$cmd.Name.Contains($cmd.ScriptBlock.GetHashCode().ToString())) {
$cmd.ScriptBlock
} else { $cmd }
foreach($_ in ([Ordered]@{
Command = $realCmd
CouldRun = $couldRun
Invalid = $Invalid
Missing = $missingMandatory
PercentFit = $(if ($pc) {$outSplat.Count / $pc } else { 0})
Unmapped = $Unmapped
PipelineParameter = $Pipe
NonPipelineParameter = $NoPipe
}).GetEnumerator()) {
$outSplat.psobject.properties.Add([Management.Automation.PSNoteProperty]::new($_.Key,$_.Value))
}
$outSplat
}
}
}
${.@}=${UseSplat}={
<#
.Synopsis
Uses a splat.
.Description
Uses a splat to call a command.
If passed from Find-Splat,Get-Splat or Test-Splat, the command will be automatically detected.
If called as .@, this will run only provided commands
If called as *@, this will run any found commands
.Link
Get-Splat
.Link
Find-Splat
.Link
Test-Splat
.Example
@{id=$pid} | Use-Splat gps # When calling Use-Splat is globally imported
.Example
@{id=$pid} | & ${.@} gps # When calling Use-Splat is nested
.Example
@{LogName='System';InstanceId=43,44},
@{LogName='Application';InstanceId=10000,10005} |
.@ Get-EventLog # get a bunch of different log events
#>
[Alias('.@','uSplat')]
param(
# One or more commands
[Parameter(Position=0)]
[PSObject[]]
$Command,
# Any additional positional arguments that would be passed to the command
[Parameter(Position=1,ValueFromRemainingArguments)]
[PSObject[]]
$ArgumentList = @(),
# The splat
[Parameter(ValueFromPipeline=$true)]
[PSObject[]]
$Splat,
# If set, will run regardless of if parameters map, are valid, and have enough mandatory parameters.
[switch]
$Force,
# If set, will run the best fit out of multiple commands.
# The best fit is the command that will use the most of the input splat.
[Alias('BestFit','BestFitFunction', 'BF','BFF')]
[switch]
$Best,
# If set, will stream input into a single pipeline of each command.
# The non-pipeable parameters of the first input splat will be used to start the pipeline.
# By default, a command will be run once per input splat.
[Alias('Pipe')]
[switch]
$Stream)
begin {
$pipelines = @{}
}
process {
$WeTrustTheSplat = $false
if (-not $Command -and
$splat.Length -eq 1 -and
$splat[0] -is [Collections.IDictionary] -and
$Splat[0].psobject.Properties['Command']) {
$Command = $Splat[0].psobject.Properties['Command'].Value
$WeTrustTheSplat = $true
} elseif (-not $command -and $_ -is [PSObject] -and $_.Command -and $_.Splat) {
$WeTrustTheSplat = $true
$splat = $_.Splat
$command = $_.Command
}
if ($Best -and $command.Count) {
$command = $splat |
& ${?@} -Command $command |
Sort-Object PercentFit -Descending |
Select-Object -ExpandProperty Command -First 1
}
if (-not $Command) {
Write-Error -Message "No command found" -Category ObjectNotFound -ErrorId 'Use-Splat.CommandNotFound' ;return
}
#region UseTheSplat
foreach ($cmd in $Command) {
if ($WeTrustTheSplat) {
if ($cmd -is [Management.Automation.CommandInfo] -or $cmd -is [ScriptBlock]) {
foreach ($s in $splat) {
if ($argumentList) {
& $cmd @s @ArgumentList
} else {
& $cmd @s
}
}
}
} else {
$Splat |
& ${?@} $cmd -Force:$Force |
& { process {
$i = $_
$np = $i.NonPipelineParameter
$c = $_.psobject.properties['Command'].Value
if ($Stream) {
if (-not $pipelines[$c]) {
$stepScript = if ($argumentList) { {& $c @np @argumentList} } else { {& $c @np} }
$stepPipeline = $stepScript.GetSteppablePipeline()
$pipelines[$c] = $stepPipeline
$stepPipeline.Begin($true)
} else {
$stepPipeline = $pipelines[$c]
}
$stepPipeline.Process([PSCustomObject]$i.PipelineParameter)
return
}
if ($c -is [Management.Automation.CommandInfo] -or $c -is [ScriptBlock]) {
if ($ArgumentList) {
& $c @i @ArgumentList
} else {
& $c @i
}
}
}}
}
}
#endregion UseTheSplat
}
end {
if ($pipelines.Count) {
foreach ($v in $pipelines.Values) { $v.End() }
}
}
}
${??@}=${FindSplat}=${fSplat}={
<#
.Synopsis
Finds commands that can be splatted to given an input.
.Description
Finds the commands whose input parameters match an input object, and returns an [ordered] dictionary of parameters.
.Link
Get-Splat
.Link
Use-Splat
.Example
@{Id=$pid} | Find-Splat -Global
#>
[Alias('??@','fSplat')]
param(
# One or more commands.
# If not provided, commands from the current module will be searched.
# If there is no current module, all commands will be searched.
[Parameter(Position=0)]
[string[]]$Command,
# The splat
[Parameter(ValueFromPipeline=$true,Position=1)]
[Alias('InputObject')]
[PSObject]$Splat,
# If set, will look for all commands, even if Find-Splat is used within a module.
[Alias('G')][switch]$Global,
# If set, will look for commands within the current module.
# To make this work within your own module Install-Splat.
[Alias('L')][switch]$Local,
# If provided, will look for commands within any number of loaded modules.
[Alias('M')][string[]]$Module,
# If set, will return regardless of if parameters map, are valid, and have enough mandatory parameters
[switch]$Force)
begin {
$myModule = $MyInvocation.MyCommand.ScriptBlock.Module
$cmdTypes = 'Function,Cmdlet,ExternalScript,Alias'
$resolveAliases = { begin {
$n = 0
} process {
$n++
if ($t -is [int] -and $id) {
$p = $n* 100 / $t
Write-Progress "Resolving" "$_ " -PercentComplete $p -Id $id
}
if ($_.ResolvedCommand) { $_.ResolvedCommand }
else { $_ }
} end {
Write-Progress 'Resolving Aliases' 'Complete' -Id $id
} }
$filterCmds = { process {
foreach ($c in $Command) { if ($_ -like $c) { return $_ } }
} }
}
process {
if (-not $Splat) { return }
$id =[Random]::new().Next()
$commandList =
@(if (-not $Command) {
Write-Progress -Id $id -Activity 'Getting Commands' -Status ' '
if ($MyModule -and $Local) {
$myModule.ExportedCommands.Values | . $resolveAliases | Select-Object -Unique
} elseif ($module) {
foreach ($m in $Module) {
$rm = Get-Module $m
if (-not $rm) { continue }
$rm.ExportedCommands.Values | . $resolveAliases | Select-Object -Unique
}
} else {
$allcmds = @($ExecutionContext.SessionState.InvokeCommand.GetCommands('*',$cmdTypes, $true))
$t = $allcmds.Count
$allcmds |. $resolveAliases | Select-Object -Unique
}
} elseif ($module) {
foreach ($m in $Module) {
$rm = Get-Module $m
if (-not $rm) { continue }
$rm.ExportedCommands.Values |
. $resolveAliases | . $filterCmds |
Select-Object -Unique
}
} elseif ($Global) {
foreach ($c in $Command) {
$ExecutionContext.SessionState.InvokeCommand.GetCommands($c,$cmdTypes, $true)
}
} elseif ($MyModule -and $Local) {
$myModule.ExportedCommands.Values |
. $filterCmds | . $resolveAliases | Select-Object -Unique
} else {
foreach ($cmd in $Command) {
if ($cmd -is [string] -and $cmd.Contains('*')) {
$ExecutionContext.SessionState.InvokeCommand.GetCommands($cmd,$cmdTypes, $true)
} else {
$cmd
}
}
})
$psBoundParameters.Command = $commandList
if ($Splat -is [Collections.IDictionary]) {
$Splat =
if ($splat.GetType().Name -ne 'PSBoundParametersDictionary') {
[PSCustomObject]$Splat
} else {
[PSCustomObject]([Ordered]@{} + $Splat)
}
}
$c,$t= 0, $commandList.Count
foreach ($cmd in $commandList) {
if ($t -gt 1) {
$c++;$p=$c*100/$t
Write-Progress -Id $id -Activity 'Finding Splats' -Status "$cmd " -PercentComplete $p
}
$Splat |
& ${?@} $cmd -Force:$Force |
Select-Object -Property * -ExcludeProperty SyncRoot,IsSynchronized,IsReadOnly,IsFixedSize,Count |
& { process {
if ($_.PercentFit -eq 0) { return }
$_.pstypenames.clear()
$_.pstypenames.add('Find.Splat.Output')
$keys, $values = @($_.Keys), @($_.Values)
$resplat = [Ordered]@{}
for ($i=0;$i -lt $keys.count;$i++) {
$resplat[$keys[$i]] = $values[$i]
}
$_.psobject.properties.remove('Keys')
$_.psobject.properties.remove('Values')
$_.psobject.properties.Add([Management.Automation.PSNoteProperty]::new('Splat', $resplat))
$_
} }
}
Write-Progress -Id $id -Completed -Activity 'Finding Splats' -Status 'Complete!'
}
}
#endregion Splatter [ 0.5.5 ] : Simple Scripts to Supercharge Splatting (Install-Module Splatter, then Initialize-Splatter -Verb Get,Use,Find )