-
Notifications
You must be signed in to change notification settings - Fork 3
/
Set-WinGetSetting.ps1
302 lines (274 loc) · 11.5 KB
/
Set-WinGetSetting.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
function Set-WinGetSetting {
[CmdletBinding()]
Param (
[Parameter(
HelpMessage = 'Number of minutes before source update'
)]
[ValidateRange(0, 43200)]
[Int]
$AutoUpdateIntervalInMinutes,
[Parameter(
HelpMessage = 'Progress bar display style'
)]
[ValidateSet('accent', 'rainbow', 'retro')]
[String]
$ProgressBar,
[Parameter(
HelpMessage = 'Preferred logging level'
)]
[ValidateSet('verbose', 'info', 'warning', 'error', 'critical')]
[String]
$LoggingLevel,
[Parameter(
HelpMessage = 'The scope of a package install'
)]
[ValidateSet('user', 'machine')]
[String]
$PreferredScope,
[Parameter(
HelpMessage = 'The locales of a package install'
)]
[ValidatePattern('^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$')]
[ValidateCount(1, 10)]
[ValidateLength(1, 20)]
[String[]]
$PreferredLocale,
[Parameter(
HelpMessage = 'The architecture(s) to use for a package install'
)]
[ValidateSet('neutral', 'x64', 'x86', 'arm64', 'arm')]
[ValidateCount(1, 4)]
[String[]]
$PreferredArchitectures,
[Parameter(
HelpMessage = 'The scope of a package install'
)]
[ValidateSet('user', 'machine')]
[String]
$RequiredScope,
[Parameter(
HelpMessage = 'The locales of a package install'
)]
[ValidatePattern('^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$')]
[ValidateCount(1, 10)]
[ValidateLength(1, 20)]
[String[]]
$RequiredLocale,
[Parameter(
HelpMessage = 'The architecture(s) to use for a package install'
)]
[ValidateSet('neutral', 'x64', 'x86', 'arm64', 'arm')]
[ValidateCount(1, 4)]
[String[]]
$RequiredArchitectures,
[Parameter(
HelpMessage = 'Controls whether blocking warning messages shown to the user during an install or upgrade are ignored'
)]
[Bool]
$IgnoreWarnings,
[Parameter(
HelpMessage = 'Controls whether installation notes are shown after a successful install'
)]
[Bool]
$DisableInstallNotes,
[Parameter(
HelpMessage = 'The default root directory where packages are installed to under User scope. Applies to the portable installer type.'
)]
[String]
$PortablePackageUserRoot,
[Parameter(
HelpMessage = 'The default root directory where packages are installed to under Machine scope. Applies to the portable installer type.'
)]
[String]
$PortablePackageMachineRoot,
[Parameter(
HelpMessage = 'Default install location to use for packages that require it when not specified'
)]
[String]
[ValidateLength(1, 32767)]
$DefaultInstallRoot,
[Parameter(
HelpMessage = 'Controls whether the default behavior for uninstall removes all files and directories relevant to this package. Only applies to the portable installerType.'
)]
[Bool]
$PurgePortablePackage,
[Parameter(
HelpMessage = 'Controls whether telemetry events are written'
)]
[Bool]
$DisableTelemetry,
[Parameter(
HelpMessage = 'Control which download code is used for packages'
)]
[ValidateSet('default', 'wininet', 'do')]
[String]
$Downloader,
[Parameter(
HelpMessage = 'Number of seconds to wait without progress before fallback'
)]
[ValidateRange(1, 600)]
[Int]
$DoProgressTimeoutInSeconds,
[Parameter(
HelpMessage = 'Controls whether interactive prompts are shown by the Windows Package Manager client'
)]
[Bool]
$DisableInteractive,
[Parameter(
HelpMessage = 'Reference implementation for an experimental command'
)]
[Bool]
$ExperimentalCMD,
[Parameter(
HelpMessage = 'Reference implementation for an experimental argument'
)]
[Bool]
$ExperimentalARG,
[Parameter(
HelpMessage = 'Support for package dependencies'
)]
[Bool]
$Dependencies,
[Parameter(
HelpMessage = 'Enable use of MSI APIs rather than msiexec for MSI installs'
)]
[Bool]
$DirectMSI,
[Parameter(
HelpMessage = 'Enable support for installing zip packages.'
)]
[Bool]
$zipInstall,
[Parameter(
HelpMessage = 'Enable installing packages from local manifest files. Required running with Admin rights'
)]
[Bool]
$LocalManifestFiles,
[Parameter(
HelpMessage = 'Passthru a psobject of the settings.json'
)]
[Switch]
$Passthru
)
Begin {
[String[]]$WinGetArgs = $null
[String[]]$JSPath = $null
[String[]]$NoteMembers = $null
[String]$ParamArgString = $null
[String]$Name = $null
[Int]$PathCount = 0
[Bool]$UpdateJSON = $false
[String[]]$IgnoreParams = @('Passthru')
$Mapping = @{}
$Mapping['AutoUpdateIntervalInMinutes'] = @('autoUpdateIntervalInMinutes', 'source')
$Mapping['ProgressBar'] = @('progressBar', 'visual')
$Mapping['LoggingLevel'] = @('level', 'logging')
$Mapping['PreferredScope'] = @('scope', 'installBehavior/preferences')
$Mapping['PreferredLocale'] = @('locale', 'installBehavior/preferences')
$Mapping['PreferredArchitectures'] = @('architectures', 'installBehavior/preferences')
$Mapping['RequiredScope'] = @('scope', 'installBehavior/requirements')
$Mapping['RequiredLocale'] = @('locale', 'installBehavior/requirements')
$Mapping['RequiredArchitectures'] = @('architectures', 'installBehavior/requirements')
$Mapping['IgnoreWarnings'] = @('ignoreWarnings', 'installBehavior')
$Mapping['DisableInstallNotes'] = @('disableInstallNotes', 'installBehavior')
$Mapping['PortablePackageUserRoot'] = @('portablePackageUserRoot', 'installBehavior')
$Mapping['PortablePackageMachineRoot'] = @('portablePackageMachineRoot', 'installBehavior')
$Mapping['DefaultInstallRoot'] = @('defaultInstallRoot', 'installBehavior')
$Mapping['PurgePortablePackage'] = @('purgePortablePackage', 'uninstallBehavior')
$Mapping['DisableTelemetry'] = @('disable', 'telemetry')
$Mapping['Downloader'] = @('downloader', 'network')
$Mapping['DoProgressTimeoutInSeconds'] = @('doProgressTimeoutInSeconds', 'network')
$Mapping['DisableInteractive'] = @('disable', 'interactivity')
$Mapping['ExperimentalCMD'] = @('experimentalCMD', 'experimentalFeatures')
$Mapping['ExperimentalARG'] = @('experimentalARG', 'experimentalFeatures')
$Mapping['Dependencies'] = @('dependencies', 'experimentalFeatures')
$Mapping['DirectMSI'] = @('directMSI', 'experimentalFeatures')
$Mapping['ZipInstall'] = @('zipInstall', 'experimentalFeatures')
[String]$SettingsPath = "$($env:LOCALAPPDATA)\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json"
# Default value for settings.json
[String]$JSON = '{"$schema":"https://aka.ms/winget-settings.schema.json"}'
# The default settings.json is invalid, and causes 5.1 ConvertFrom-Json to choke, so check/fix if needed.
# https://github.com/microsoft/winget-cli/blob/master/src/AppInstallerCommonCore/UserSettings.cpp
if (Test-Path -LiteralPath $SettingsPath) {
try {
[String]$TryJSON = @(Get-Content -LiteralPath $SettingsPath | ForEach-Object { $_.Trim() } | Where-Object { (!([String]::IsNullOrWhiteSpace($_) -or $_ -like '//*')) }) -join ''
$TryJSON = $TryJSON -replace ',}$', '}'
$null = $TryJSON | ConvertFrom-Json
$JSON = $TryJSON
}
catch {
Write-Error "Unable to read settings from '$($SettingsPath)'"
return
}
}
$Settings = $JSON | ConvertFrom-Json
}
Process {
foreach ($BParam in $PSBoundParameters.GetEnumerator()) {
if ($Mapping.ContainsKey($BParam.Key)) {
$UpdateJSON = $true
$Map = $Mapping[$BParam.Key]
$Name = $Map[0]
$Value = $BParam.Value
$JSPath = @($Map[1] -split '/')
$PathCount = 1
$SettingsWork = $Settings
foreach ($Folder in $JSPath) {
$NoteMembers = @($SettingsWork | Get-Member | Where-Object { $_.MemberType -eq 'NoteProperty' } | Select-Object -ExpandProperty 'Name')
if ($NoteMembers -contains $Folder) {
$SettingsWork = $SettingsWork."$Folder"
}
else {
$null = $SettingsWork | Add-Member -MemberType NoteProperty -Name $Folder -Value ([pscustomobject]@{})
$SettingsWork = $SettingsWork."$Folder"
}
}
$NoteMembers = @($SettingsWork | Get-Member | Where-Object { $_.MemberType -eq 'NoteProperty' } | Select-Object -ExpandProperty 'Name')
if ($NoteMembers -contains $Name) {
$SettingsWork."$Name" = $Value
}
else {
$null = $SettingsWork | Add-Member -MemberType NoteProperty -Name $Name -Value $Value
}
}
else {
if ($BParam.Key -eq 'LocalManifestFiles') {
# This setting is stored in a binary value in the appx local reg, for reasons, here:
# C:\Users\atamido\AppData\Local\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\Settings
if ($LocalManifestFiles) {
$ParamArgString = '--Enable'
}
else {
$ParamArgString = '--Disable'
}
$WinGetArgs = "Settings", $ParamArgString, 'LocalManifestFiles', '--verbose-logs'
try {
#& "WinGet" $WingetArgs
$Process = Start-Process -FilePath 'winget.exe' -ArgumentList $WinGetArgs -NoNewWindow -PassThru -Wait
if ($Process.ExitCode -ne 0) {
Write-Error "Error calling 'winget $($WingetArgs -join ' ')' which returned exit code $($Process.ExitCode)"
return
}
}
catch {
Write-Error "Error calling 'winget $($WingetArgs -join ' ')'"
return
}
}
elseif ($IgnoreParams -contains $BParam.Key) {
}
else {
Write-Warning "Did not apply setting '$($BParam.Key)' with value '$($BParam.Value)'"
}
}
}
}
End {
if ($UpdateJSON) {
$Settings | ConvertTo-Json -Depth 10 | Out-File -LiteralPath $SettingsPath -Force -Encoding utf8
}
if ($Passthru) {
return $Settings
}
}
}