-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRemove-PlatformPackage.ps1
More file actions
3708 lines (3191 loc) · 144 KB
/
Copy pathRemove-PlatformPackage.ps1
File metadata and controls
3708 lines (3191 loc) · 144 KB
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
function Remove-PlatformPackage
{
<#
.SYNOPSIS
Removes installed packages with the native platform package manager.
.DESCRIPTION
Detects the supported package manager for the current platform, lists installed
packages, and opens an interactive console picker where packages can be selected
with Space before removal. In the picker, selecting a package controls
whether it will be removed when Enter is pressed. If no package is selected,
pressing Enter removes the current package. The purge/zap option is a separate
per-package toggle that requests deeper cleanup for selected packages on package
managers that support it.
Supported package managers:
- Windows: winget
- macOS: brew
- Debian/Ubuntu Linux: apt
- Alpine Linux: apk
Removal command output is streamed directly to the console so the operation can
be followed while it runs. Use -NonInteractive to return the discovered installed
package list without starting the interactive picker, or -All to remove every
matching package without prompting.
.PARAMETER IncludePackage
Optional package names or wildcard patterns to include. Matches package Name or Id.
.PARAMETER ExcludePackage
Optional package names or wildcard patterns to exclude. Matches package Name or Id.
.PARAMETER All
Removes all matching installed packages without opening the interactive picker.
To avoid accidental full-system package removal, -All requires -IncludePackage.
.PARAMETER Purge
Uses package-manager-specific purge or zap behavior for every package selected
for removal. This requests deeper cleanup than a normal removal when supported:
winget uses uninstall --purge for portable packages, apt uses purge,
apk uses del --purge, and Homebrew casks use uninstall --zap. It has no
effect for Homebrew formulae.
In the interactive picker, Space marks a package for removal and P toggles this
purge/zap behavior for the highlighted package. Pressing Enter removes the
selected packages, or the current package when nothing is selected, using
purge/zap only for packages where it was requested.
.PARAMETER NonInteractive
Returns the discovered installed package records without removing anything. The
previous -AsObject spelling is retained as an alias.
.PARAMETER FilterSource
Sets the initial source filter in the interactive picker. When specified, the picker
opens showing only packages from this source. Press S in the picker to cycle through
available sources. Only applicable when multiple package sources are present.
.PARAMETER NoSudo
On Linux package managers that normally require elevated privileges, do not
automatically prefix remove commands with sudo.
.EXAMPLE
PS > Remove-PlatformPackage
Lists installed packages and opens the interactive picker. Press Space to select
packages for removal, optionally press P to request purge/zap cleanup for a
selected package, then press Enter to remove the selected packages or the current
package when nothing is selected.
.EXAMPLE
PS > Remove-PlatformPackage -IncludePackage 'git*' -All
Removes every installed package whose name or id matches 'git*' without prompting.
.EXAMPLE
PS > Remove-PlatformPackage -IncludePackage 'node*' -ExcludePackage 'node@18'
Opens the picker for matching node packages except packages whose name or id
matches 'node@18'.
.EXAMPLE
PS > Remove-PlatformPackage -IncludePackage 'openssl' -Purge -All
Removes the matching package and requests package-manager-specific purge behavior
where supported.
.EXAMPLE
PS > Remove-PlatformPackage -IncludePackage 'visual-studio-code'
Opens the picker for matching packages. Selecting the Homebrew cask with Space
removes it normally; pressing P before Enter changes that selected package to use
brew uninstall --cask --zap instead.
.EXAMPLE
PS > Remove-PlatformPackage -NonInteractive | Format-Table
Lists installed packages for the detected package manager without removing anything.
.EXAMPLE
PS > Remove-PlatformPackage -IncludePackage 'git' -All -WhatIf
Shows the package removal that would run without invoking the package manager.
.OUTPUTS
System.Management.Automation.PSCustomObject
Returns package records when -NonInteractive is used. Otherwise returns a removal
summary object with package manager, selection counts, NotSelected,
selected-package skip/failure counts, and per-package results.
.NOTES
- winget is used on Windows.
- brew is used on macOS.
- apt is used on Debian/Ubuntu-style Linux distributions.
- apk is used on Alpine Linux.
- apt and apk remove operations are prefixed with sudo when needed and available.
- Query commands are parsed to build the picker; remove commands stream their
native output to the console.
Author: Jon LaBelle
License: MIT
Source: https://github.com/jonlabelle/pwsh-profile/blob/main/Functions/SystemAdministration/Remove-PlatformPackage.ps1
.LINK
https://github.com/jonlabelle/pwsh-profile/blob/main/Functions/SystemAdministration/Remove-PlatformPackage.ps1
#>
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidOverwritingBuiltInCmdlets', '', Justification = 'Function name requested by the profile owner.')]
[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]
[OutputType([PSCustomObject], [PSCustomObject[]], [Object[]])]
param(
[Parameter(Position = 0)]
[Alias('Name', 'PackageName', 'Include')]
[String[]]$IncludePackage = @(),
[Parameter()]
[Alias('Exclude')]
[String[]]$ExcludePackage = @(),
[Parameter()]
[Switch]$All,
[Parameter()]
[Switch]$Purge,
[Parameter()]
[Alias('AsObject')]
[Switch]$NonInteractive,
[Parameter()]
[String]$FilterSource = '',
[Parameter()]
[Switch]$NoSudo,
[Parameter(DontShow = $true)]
[ValidateSet('Auto', 'winget', 'brew', 'apt', 'apk')]
[String]$PackageManager = 'Auto',
[Parameter(DontShow = $true)]
[ScriptBlock]$CommandRunner,
[Parameter(DontShow = $true)]
[ScriptBlock]$KeyReader,
[Parameter(DontShow = $true)]
[ValidateRange(0, 500)]
[Int32]$PickerPageSize = 0,
[Parameter(DontShow = $true)]
[Switch]$ReturnToPlatformPackageManagerOnBackKey
)
begin
{
function Get-DependencyPathIfNeeded
{
param(
[Parameter(Mandatory)]
[String]$FunctionName,
[Parameter(Mandatory)]
[String]$RelativePath
)
if (-not (Get-Command -Name $FunctionName -ErrorAction SilentlyContinue))
{
Write-Verbose "$FunctionName is required - attempting to load it"
$dependencyPath = Join-Path -Path $PSScriptRoot -ChildPath $RelativePath
$dependencyPath = [System.IO.Path]::GetFullPath($dependencyPath)
if (Test-Path -Path $dependencyPath -PathType Leaf)
{
return $dependencyPath
}
throw "Required function '$FunctionName' could not be found. Expected location: $dependencyPath"
}
Write-Verbose "$FunctionName is already loaded"
return $null
}
$getPlatformPackagePath = Get-DependencyPathIfNeeded -FunctionName 'Get-PlatformPackage' -RelativePath 'Get-PlatformPackage.ps1'
if (-not [String]::IsNullOrWhiteSpace($getPlatformPackagePath))
{
try
{
. $getPlatformPackagePath
Write-Verbose "Loaded Get-PlatformPackage from: $getPlatformPackagePath"
}
catch
{
throw "Failed to load required dependency 'Get-PlatformPackage' from '$getPlatformPackagePath': $($_.Exception.Message)"
}
}
$getPlatformPackageDependencyPath = Get-DependencyPathIfNeeded -FunctionName 'Get-PlatformPackageDependency' -RelativePath 'Get-PlatformPackageDependency.ps1'
if (-not [String]::IsNullOrWhiteSpace($getPlatformPackageDependencyPath))
{
try
{
. $getPlatformPackageDependencyPath
Write-Verbose "Loaded Get-PlatformPackageDependency from: $getPlatformPackageDependencyPath"
}
catch
{
throw "Failed to load required dependency 'Get-PlatformPackageDependency' from '$getPlatformPackageDependencyPath': $($_.Exception.Message)"
}
}
function ConvertTo-PackageText
{
param(
[Parameter()]
[Object]$Value
)
if ($null -eq $Value)
{
return ''
}
$items = @($Value) |
Where-Object { $null -ne $_ -and -not [String]::IsNullOrWhiteSpace("$($_)") } |
ForEach-Object { "$($_)".Trim() }
return ($items -join ', ')
}
function Get-FirstPropertyValue
{
param(
[Parameter()]
[Object]$InputObject,
[Parameter(Mandatory)]
[String[]]$PropertyName
)
if ($null -eq $InputObject)
{
return $null
}
foreach ($name in $PropertyName)
{
$property = $InputObject.PSObject.Properties[$name]
if ($property)
{
$value = $property.Value
if ($null -ne $value -and -not [String]::IsNullOrWhiteSpace((ConvertTo-PackageText -Value $value)))
{
return $value
}
}
}
return $null
}
function Get-PackageRemoveArguments
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Manager,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$Name,
[Parameter()]
[String]$Id,
[Parameter()]
[String]$Type,
[Parameter()]
[String]$Source,
[Parameter()]
[Switch]$UsePurge
)
switch ($Manager.Name)
{
'winget'
{
$sourceArguments = if (-not [String]::IsNullOrWhiteSpace($Source))
{
@('--source', $Source)
}
else
{
@()
}
$arguments = if (-not [String]::IsNullOrWhiteSpace($Id))
{
@('uninstall', '--id', $Id, '--exact') + $sourceArguments + @('--accept-source-agreements')
}
else
{
@('uninstall', $Name) + $sourceArguments + @('--accept-source-agreements')
}
if ($UsePurge)
{
$arguments += '--purge'
}
return $arguments
}
'brew'
{
if ($Type -eq 'Cask')
{
if ($UsePurge)
{
return @('uninstall', '--cask', '--zap', $Name)
}
return @('uninstall', '--cask', $Name)
}
return @('uninstall', $Name)
}
'apt'
{
if ($UsePurge)
{
return @('purge', '-y', $Name)
}
return @('remove', '-y', $Name)
}
'apk'
{
if ($UsePurge)
{
return @('del', '--purge', $Name)
}
return @('del', $Name)
}
default
{
throw "Unsupported package manager '$($Manager.Name)'."
}
}
}
function Get-PackageRemoveObject
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Manager,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$Name,
[Parameter()]
[String]$Id,
[Parameter()]
[String]$Type,
[Parameter()]
[String]$InstalledVersion,
[Parameter()]
[String]$Source,
[Parameter()]
[String]$Publisher,
[Parameter()]
[String]$Description,
[Parameter()]
[String]$Notes
)
[PSCustomObject]@{
Name = $Name
Id = $Id
PackageManager = $Manager.Name
PackageManagerDisplayName = $Manager.DisplayName
Type = $Type
InstalledVersion = $InstalledVersion
Source = $Source
Publisher = if (-not [String]::IsNullOrWhiteSpace($Publisher)) { $Publisher } elseif ($Manager.Name -eq 'brew') { 'Homebrew' } elseif ($Manager.Name -eq 'apk') { 'Alpine' } elseif ($Manager.Name -eq 'apt' -and -not [String]::IsNullOrWhiteSpace($Source)) { $Source } elseif ($Manager.Name -eq 'apt') { 'APT' } elseif ($Manager.Name -eq 'winget' -and -not [String]::IsNullOrWhiteSpace($Source)) { $Source } else { '' }
Description = if (-not [String]::IsNullOrWhiteSpace($Description)) { $Description } else { $Notes }
Notes = $Notes
Command = $Manager.Command
RemoveArguments = @(Get-PackageRemoveArguments -Manager $Manager -Name $Name -Id $Id -Type $Type -Source $Source -UsePurge:$Purge.IsPresent)
}
}
function Test-ReverseDependencyPreviewSupported
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Manager
)
return $Manager.Name -in @('brew', 'apt', 'apk')
}
function Get-PackageIdentityKeys
{
param(
[Parameter()]
[Object]$Package
)
$keys = New-Object 'System.Collections.Generic.List[String]'
foreach ($value in @(
(ConvertTo-PackageText -Value (Get-FirstPropertyValue -InputObject $Package -PropertyName @('Name', 'Package', 'PackageName')))
(ConvertTo-PackageText -Value (Get-FirstPropertyValue -InputObject $Package -PropertyName @('Id', 'PackageIdentifier', 'Identifier')))
))
{
if ([String]::IsNullOrWhiteSpace($value))
{
continue
}
$key = $value.Trim().ToLowerInvariant()
if (-not $keys.Contains($key))
{
$keys.Add($key)
}
}
return @($keys)
}
function Add-PackageRequiredByMetadata
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Manager,
[Parameter()]
[PSCustomObject[]]$Packages = @()
)
if ($Packages.Count -eq 0 -or -not (Test-ReverseDependencyPreviewSupported -Manager $Manager))
{
return
}
$requiredByLookup = @{}
try
{
$dependencyRecords = @(Get-PlatformPackageDependency -Package $Packages -Direction RequiredBy -InstalledOnly -PackageManager $Manager.Name -CommandRunner $CommandRunner)
}
catch
{
Write-Verbose "Unable to check reverse dependencies before removal: $($_.Exception.Message)"
return
}
foreach ($record in @($dependencyRecords | Where-Object { $_.Direction -eq 'RequiredBy' }))
{
foreach ($key in @(Get-PackageIdentityKeys -Package $record))
{
if (-not $requiredByLookup.ContainsKey($key))
{
$requiredByLookup[$key] = New-Object 'System.Collections.Generic.List[Object]'
}
$requiredByLookup[$key].Add($record)
}
}
foreach ($package in $Packages)
{
$records = New-Object 'System.Collections.Generic.List[Object]'
foreach ($key in @(Get-PackageIdentityKeys -Package $package))
{
if ($requiredByLookup.ContainsKey($key))
{
foreach ($record in $requiredByLookup[$key])
{
$records.Add($record)
}
}
}
$relatedPackages = @(
$records |
Where-Object { -not [String]::IsNullOrWhiteSpace($_.RelatedPackage) } |
ForEach-Object { $_.RelatedPackage } |
Select-Object -Unique
)
$package | Add-Member -NotePropertyName 'RequiredByPackages' -NotePropertyValue @($relatedPackages) -Force
$package | Add-Member -NotePropertyName 'RequiredByCount' -NotePropertyValue $relatedPackages.Count -Force
}
}
function Format-PackageRequiredByPreview
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Package,
[Parameter()]
[ValidateRange(1, 20)]
[Int32]$Limit = 5
)
$requiredByPackages = @()
if ($Package.PSObject.Properties['RequiredByPackages'])
{
$requiredByPackages = @($Package.RequiredByPackages | Where-Object { -not [String]::IsNullOrWhiteSpace($_) })
}
if ($requiredByPackages.Count -eq 0)
{
return ''
}
$preview = (@($requiredByPackages | Select-Object -First $Limit) -join ', ')
if ($requiredByPackages.Count -gt $Limit)
{
$preview = "$preview, +$($requiredByPackages.Count - $Limit) more"
}
return "$($Package.Name) is required by $($requiredByPackages.Count) installed package(s): $preview"
}
function Write-PackageRequiredByWarnings
{
param(
[Parameter()]
[PSCustomObject[]]$Packages = @()
)
foreach ($package in $Packages)
{
$preview = Format-PackageRequiredByPreview -Package $package
if (-not [String]::IsNullOrWhiteSpace($preview))
{
Write-Warning "$preview. Removing it may break dependent packages."
}
}
}
function Get-PackageResultRequiredByProperties
{
param(
[Parameter()]
[PSCustomObject]$Package
)
$requiredByPackages = if ($Package -and $Package.PSObject.Properties['RequiredByPackages'])
{
@($Package.RequiredByPackages)
}
else
{
@()
}
[PSCustomObject]@{
RequiredByCount = $requiredByPackages.Count
RequiredByPackages = @($requiredByPackages)
}
}
function Test-PackageManagerCommandAvailable
{
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$Name
)
if ($CommandRunner)
{
return $true
}
return $null -ne (Get-Command -Name $Name -CommandType Application -ErrorAction SilentlyContinue |
Select-Object -First 1)
}
function Get-LinuxDistributionInfo
{
$info = @{
Id = ''
IdLike = ''
}
if (-not (Test-Path -Path '/etc/os-release' -PathType Leaf))
{
return [PSCustomObject]$info
}
foreach ($line in (Get-Content -Path '/etc/os-release' -ErrorAction SilentlyContinue))
{
if ($line -match '^(?<Name>ID|ID_LIKE)=(?<Value>.+)$')
{
$value = $Matches.Value.Trim().Trim('"')
if ($Matches.Name -eq 'ID')
{
$info.Id = $value
}
elseif ($Matches.Name -eq 'ID_LIKE')
{
$info.IdLike = $value
}
}
}
[PSCustomObject]$info
}
function Get-PackageManagerDefinition
{
param(
[Parameter(Mandatory)]
[ValidateSet('winget', 'brew', 'apt', 'apk')]
[String]$Name
)
switch ($Name)
{
'winget'
{
[PSCustomObject]@{
Name = 'winget'
DisplayName = 'Windows Package Manager'
Command = 'winget'
Platform = 'Windows'
NeedsSudo = $false
}
}
'brew'
{
[PSCustomObject]@{
Name = 'brew'
DisplayName = 'Homebrew'
Command = 'brew'
Platform = 'macOS'
NeedsSudo = $false
}
}
'apt'
{
[PSCustomObject]@{
Name = 'apt'
DisplayName = 'APT'
Command = 'apt'
Platform = 'Debian/Ubuntu Linux'
NeedsSudo = $true
}
}
'apk'
{
[PSCustomObject]@{
Name = 'apk'
DisplayName = 'Alpine Package Keeper'
Command = 'apk'
Platform = 'Alpine Linux'
NeedsSudo = $true
}
}
}
}
function Resolve-PackageManager
{
$requestedManager = $PackageManager.ToLowerInvariant()
if ($requestedManager -ne 'auto')
{
if (-not (Test-PackageManagerCommandAvailable -Name $requestedManager))
{
throw "Package manager '$requestedManager' is not installed or not available in PATH."
}
return Get-PackageManagerDefinition -Name $requestedManager
}
$isWindowsPlatform = if ($PSVersionTable.PSVersion.Major -lt 6) { $true } else { [Bool]$IsWindows }
$isMacOSPlatform = if ($PSVersionTable.PSVersion.Major -lt 6) { $false } else { [Bool]$IsMacOS }
$isLinuxPlatform = if ($PSVersionTable.PSVersion.Major -lt 6) { $false } else { [Bool]$IsLinux }
if ($isWindowsPlatform -and (Test-PackageManagerCommandAvailable -Name 'winget'))
{
return Get-PackageManagerDefinition -Name 'winget'
}
if ($isMacOSPlatform -and (Test-PackageManagerCommandAvailable -Name 'brew'))
{
return Get-PackageManagerDefinition -Name 'brew'
}
if ($isLinuxPlatform)
{
$distributionInfo = Get-LinuxDistributionInfo
$linuxFamily = "$($distributionInfo.Id) $($distributionInfo.IdLike)".Trim().ToLowerInvariant()
if ($linuxFamily -match '\balpine\b' -and (Test-PackageManagerCommandAvailable -Name 'apk'))
{
return Get-PackageManagerDefinition -Name 'apk'
}
if ($linuxFamily -match '\b(debian|ubuntu)\b' -and (Test-PackageManagerCommandAvailable -Name 'apt'))
{
return Get-PackageManagerDefinition -Name 'apt'
}
if (Test-PackageManagerCommandAvailable -Name 'apt')
{
return Get-PackageManagerDefinition -Name 'apt'
}
if (Test-PackageManagerCommandAvailable -Name 'apk')
{
return Get-PackageManagerDefinition -Name 'apk'
}
}
foreach ($fallbackManager in @('brew', 'winget', 'apt', 'apk'))
{
if (Test-PackageManagerCommandAvailable -Name $fallbackManager)
{
return Get-PackageManagerDefinition -Name $fallbackManager
}
}
throw 'No supported package manager was found. Install winget, brew, apt, or apk and try again.'
}
function Invoke-PackageManagerCommand
{
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$Command,
[Parameter()]
[String[]]$Arguments = @(),
[Parameter()]
[Switch]$StreamOutput,
[Parameter()]
[Switch]$PreserveConsoleOutput
)
if ($CommandRunner)
{
$runnerOutput = & $CommandRunner -Command $Command -Arguments $Arguments -StreamOutput:$StreamOutput.IsPresent
$runnerOutputItems = @($runnerOutput)
if ($runnerOutputItems.Count -eq 1)
{
$item = $runnerOutputItems[0]
if ($item -is [System.Collections.IDictionary] -and $item.Contains('ExitCode') -and $item.Contains('Output'))
{
$result = [PSCustomObject]@{
ExitCode = [Int32]$item['ExitCode']
Output = @($item['Output'])
}
if ($StreamOutput)
{
$result.Output | ForEach-Object { Write-Host "$_" }
}
return $result
}
if ($item -and $item.PSObject.Properties['ExitCode'] -and $item.PSObject.Properties['Output'])
{
$result = [PSCustomObject]@{
ExitCode = [Int32]$item.ExitCode
Output = @($item.Output)
}
if ($StreamOutput)
{
$result.Output | ForEach-Object { Write-Host "$_" }
}
return $result
}
}
if ($StreamOutput)
{
$runnerOutputItems | ForEach-Object { Write-Host "$_" }
}
return [PSCustomObject]@{
ExitCode = 0
Output = @($runnerOutputItems)
}
}
$output = @()
try
{
if ($StreamOutput)
{
if ($PreserveConsoleOutput)
{
$process = $null
try
{
$startInfo = [System.Diagnostics.ProcessStartInfo]::new()
$startInfo.FileName = $Command
$startInfo.UseShellExecute = $false
$startInfo.RedirectStandardOutput = $false
$startInfo.RedirectStandardError = $false
foreach ($argument in @($Arguments))
{
[void]$startInfo.ArgumentList.Add($argument)
}
$process = [System.Diagnostics.Process]::Start($startInfo)
if ($null -eq $process)
{
throw "Failed to start '$Command'."
}
$process.WaitForExit()
return [PSCustomObject]@{
ExitCode = [Int32]$process.ExitCode
Output = @()
}
}
finally
{
if ($null -ne $process)
{
$process.Dispose()
}
}
}
$capturedOutput = New-Object 'System.Collections.Generic.List[String]'
& $Command @Arguments 2>&1 | ForEach-Object {
$line = "$($_)"
[void]$capturedOutput.Add($line)
Write-Host $line
}
return [PSCustomObject]@{
ExitCode = if ($null -ne $LASTEXITCODE) { [Int32]$LASTEXITCODE } else { 0 }
Output = @($capturedOutput)
}
}
$output = @(& $Command @Arguments 2>&1)
return [PSCustomObject]@{
ExitCode = if ($null -ne $LASTEXITCODE) { [Int32]$LASTEXITCODE } else { 0 }
Output = @($output)
}
}
catch
{
if ($StreamOutput)
{
Write-Host "$($_.Exception.Message)"
}
return [PSCustomObject]@{
ExitCode = 1
Output = @($_.Exception.Message)
}
}
}
function Test-CurrentUserIsRoot
{
if ($CommandRunner)
{
return $false
}
$idCommand = Get-Command -Name 'id' -CommandType Application -ErrorAction SilentlyContinue |
Select-Object -First 1
if (-not $idCommand)
{
return $false
}
try
{
$effectiveUserIdOutput = & $idCommand.Source -u 2>$null
return "$($effectiveUserIdOutput | Select-Object -First 1)".Trim() -eq '0'
}
catch
{
return $false
}
}
function Resolve-PackageManagerInvocation
{
param(
[Parameter(Mandatory)]
[PSCustomObject]$Manager,
[Parameter()]
[String[]]$Arguments = @()
)
if ($CommandRunner)
{
return [PSCustomObject]@{
Command = $Manager.Command
Arguments = @($Arguments)
}
}
if ($Manager.NeedsSudo -and -not $NoSudo -and -not (Test-CurrentUserIsRoot))
{
if (Test-PackageManagerCommandAvailable -Name 'sudo')
{
return [PSCustomObject]@{
Command = 'sudo'
Arguments = @($Manager.Command) + @($Arguments)
}
}
Write-Warning "The '$($Manager.Command)' operation may require root privileges, but sudo was not found. Running without sudo."
}
[PSCustomObject]@{
Command = $Manager.Command
Arguments = @($Arguments)
}
}
function Get-PackageCommandFailureMessage
{
param(
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()]
[String]$Command,
[Parameter()]
[String[]]$Arguments = @(),
[Parameter(Mandatory)]
[Int32]$ExitCode,
[Parameter()]
[Object[]]$Output = @()
)
$message = ($Output | Where-Object { -not [String]::IsNullOrWhiteSpace("$($_)") }) -join ' '
if (-not [String]::IsNullOrWhiteSpace($message))
{
return $message
}
$commandText = "$Command $($Arguments -join ' ')".Trim()
return "$commandText failed with exit code $ExitCode. Command output was streamed directly to the console above."
}
function Get-PackageInformationalOutput
{
param(
[Parameter()]
[Object[]]$Output = @()
)
$lines = @(