Merge pull request #677 from Romanitho/restructure

[MSI Prerequisites] Folder structure + Default excluded app list to config folder + WAU Configurator without shortcut anymore
pull/681/head
Romain 2024-09-01 16:10:05 +02:00 committed by GitHub
commit 7cb8758fc8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
71 changed files with 55 additions and 357 deletions

View File

@ -68,7 +68,7 @@ jobs:
- name: Overwrite Version.txt file
uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
with:
path: Sources/WAU/Winget-AutoUpdate/Version.txt
path: Sources/Winget-AutoUpdate/Version.txt
write-mode: overwrite
contents: ${{ steps.versioning.outputs.version }}
@ -88,8 +88,8 @@ jobs:
echo "### Extract MSI ###"
7z x MicrosoftDeploymentToolkit_x64.msi
echo "### Copy ServiceUI.exe to 'Sources/WAU/Winget-AutoUpdate' folder ###"
mv Modena_File206 Sources/WAU/Winget-AutoUpdate/ServiceUI.exe -v
echo "### Copy ServiceUI.exe to 'Sources/Winget-AutoUpdate' folder ###"
mv Modena_File206 Sources/Winget-AutoUpdate/ServiceUI.exe -v
echo "### Go to Sources ###"
cd Sources

View File

@ -31,7 +31,7 @@ jobs:
lfs: "true"
- name: Auto Increment Semver Action
uses: MCKanpolat/auto-semver-action@5003b8d37f4b03d95f15303ea10242cbf7c13141 # 2
uses: MCKanpolat/auto-semver-action@5003b8d37f4b03d95f15303ea10242cbf7c13141 # 2
id: versioning
with:
releaseType: ${{ github.event.inputs.version }}
@ -39,14 +39,14 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
- name: Overwrite Version.txt file
uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
uses: DamianReeves/write-file-action@6929a9a6d1807689191dcc8bbe62b54d70a32b42 # v1.3
with:
path: Sources/WAU/Winget-AutoUpdate/Version.txt
path: Sources/Winget-AutoUpdate/Version.txt
write-mode: overwrite
contents: "${{ steps.versioning.outputs.version }}"
- name: Commit & Push
uses: actions-js/push@5a7cbd780d82c0c937b5977586e641b2fd94acc5 # v1.5
uses: actions-js/push@5a7cbd780d82c0c937b5977586e641b2fd94acc5 # v1.5
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: main
@ -61,8 +61,8 @@ jobs:
echo "### Extract MSI ###"
7z x MicrosoftDeploymentToolkit_x64.msi
echo "### Copy ServiceUI.exe to 'Sources/WAU/Winget-AutoUpdate' folder ###"
mv Modena_File206 Sources/WAU/Winget-AutoUpdate/ServiceUI.exe -v
echo "### Copy ServiceUI.exe to 'Sources/Winget-AutoUpdate' folder ###"
mv Modena_File206 Sources/Winget-AutoUpdate/ServiceUI.exe -v
echo "### Go to Sources ###"
cd Sources
@ -87,7 +87,7 @@ jobs:
echo "Install counter file." > WAU_InstallCounter
- name: Create release
uses: ncipollo/release-action@2c591bcc8ecdcd2db72b97d6147f871fcd833ba5 # v1.14.0
uses: ncipollo/release-action@2c591bcc8ecdcd2db72b97d6147f871fcd833ba5 # v1.14.0
with:
tag: "v${{ steps.versioning.outputs.version }}"
prerelease: ${{ github.event.inputs.pre-release }}

View File

@ -21,7 +21,7 @@ jobs:
- name: Perform a Pester test for the WAU installation
shell: powershell
run: |
$command = New-PesterContainer -Path Sources/WAU/Winget-AutoUpdate-Install.ps1 -Data @{ Silent = $true }
$command = New-PesterContainer -Path Sources/Winget-AutoUpdate-Install.ps1 -Data @{ Silent = $true }
Invoke-Pester -PassThru -Container $command -ErrorAction Continue
- name: Perform a Pester test for WAU run
shell: powershell

View File

@ -1,3 +1,10 @@
@@:: This prolog allows a PowerShell script to be embedded in a .CMD file.
@@:: Any non-PowerShell content must be preceeded by "@@"
@@setlocal
@@set POWERSHELL_BAT_ARGS=%*
@@if defined POWERSHELL_BAT_ARGS set POWERSHELL_BAT_ARGS=%POWERSHELL_BAT_ARGS:"=\"%
@@PowerShell -NoProfile -WindowStyle Hidden -ExecutionPolicy Bypass -Command Invoke-Expression $('$args=@(^&{$args} %POWERSHELL_BAT_ARGS%);'+[String]::Join([char]10,$((Get-Content '%~f0') -notmatch '^^@@'))) & goto :EOF
<#
.SYNOPSIS
Install and configure Winget-AutoUpdate

Binary file not shown.

View File

@ -1,319 +0,0 @@
# Obtain UTC offset (think about moving it to the parent method)
$DateTime = New-Object -ComObject 'WbemScripting.SWbemDateTime';
$DateTime.SetVarDate($(Get-Date));
$UtcValue = $DateTime.Value;
$global:CMTraceLog_UtcOffset = $UtcValue.Substring(21, $UtcValue.Length - 21);
[System.Runtime.InteropServices.Marshal]::ReleaseComObject($DateTime) | Out-Null;
# Set context of process which writes a message
$global:CMTraceLog_Context = [System.Security.Principal.WindowsIdentity]::GetCurrent().Name;
# set string templates for formatting later
[string]$global:logline_part1_template_nonerror = "<![LOG[{0}: {1}]LOG]!>";
[string]$global:logline_part1_template_error = "<![LOG[{0}: {1}`r`r`nCommand: {2}`nScriptName: {3}`nLine Number: {4}`nColumn Number: {5}`nLine: {6}]LOG]!>";
[string]$global:logline_part2_template = "<time=`"{0}{1}`" date=`"{2}`" component=`"{3}`" context=`"{4}`" type=`"{5}`" thread=`"{6}`" file=`"{7}`">";
# (full help at the end of file)
enum CMTraceLogSeverity
{
Warning = 2
Error = 3
Verbose = 4
Debug = 5
Information = 6
}
Function Write-CMTraceLog
{
# Define and validate parameters
[CmdletBinding()]
Param(
#Path to the log file
[parameter(Mandatory=$False)]
[String]$Logfile = "$Script:WorkingDir\logs\updates.log",
#The information to log
[parameter(Mandatory=$True)]
$Message,
#The severity (Error, Warning, Verbose, Debug, Information)
[parameter(Mandatory=$True)]
[ValidateSet('Warning','Error','Verbose','Debug', 'Information', IgnoreCase=$True)]
[String]$Type,
#Write back to the console or just to the log file. By default it will write back to the host.
[parameter(Mandatory=$False)]
[switch]$WriteBackToHost = $False
)#Param
# Get the info about the calling script, function etc
$callinginfo = (Get-PSCallStack)[1];
# Set Source Information
$Source = (Get-PSCallStack)[1].Location;
# Set Component Information
$Component = (Get-Process -Id $PID).ProcessName;
# Set PID Information
$ProcessID = $PID;
# Set date/time of message
$dt = Get-Date;
[string]$time = [string]::Format("{0:HH:mm:ss.fff}", $dt);
[string]$date = [string]::Format("{0:MM-dd-yyyy}", $dt);
# Set the order
<#
switch($Type)
{
'Warning' {$Severity = 2;} #Warning
'Error' {$Severity = 3;} #Error
'Verbose' {$Severity = 4;} #Verbose
'Debug' {$Severity = 5;} #Debug
'Information' {$Severity = 6;} #Information
}
#>
$severity = [int]([CMTraceLogSeverity]::$Type);
#region set the 1st part of logged entry (templates for formatting)
if($Type -eq 'Error')
{
if($Message.exception.Message)
{
# cool! we have an exception, we can use it
}
else
{
# we do not have an exception, we need to prepare out own custom error to use later
[System.Exception]$Exception = $Message;
[String]$ErrorID = 'Custom Error';
[System.Management.Automation.ErrorCategory]$ErrorCategory = [Management.Automation.ErrorCategory]::WriteError;
$ErrorRecord = [System.Management.Automation.ErrorRecord]::new($Exception, $ErrorID, $ErrorCategory, $Message);
$Message = $ErrorRecord;
}
[string]$logline_part1 = [string]::Format(
$global:logline_part1_template_error,
$Type.ToUpper(),
$Message.exception.message,
$Message.InvocationInfo.MyCommand,
$Message.InvocationInfo.ScriptName,
$Message.InvocationInfo.ScriptLineNumber,
$Message.InvocationInfo.OffsetInLine,
$Message.InvocationInfo.Line
);
}
else
{
[string]$logline_part1 = [string]::Format($global:logline_part1_template_nonerror, $Type.ToUpper(), $message);
}
#endregion set the 1st part of logged entry (templates for formatting)
#region set the 2nd part of logged entry
[string]$logline_part2 = [string]::Format(
$global:logline_part2_template,
$time,
$global:CMTraceLog_UtcOffset,
$date,
$Component,
$global:CMTraceLog_Context,
$Severity,
$ProcessID,
$Source
);
#endregion set the 2nd part of logged entry
#region Switch statement to write out to the log and/or back to the host.
# Write the log entry in the CMTrace Format.
$logline = $logline_part1 + $logline_part2;
$logline | Out-File -Append -Encoding utf8 -FilePath $Logfile;
switch ($severity)
{
#region Warning
2{
#Write back to the host if $Writebacktohost is true.
if(($WriteBackToHost))
{
Switch($PSCmdlet.GetVariableValue('WarningPreference')){
'Continue' {$WarningPreference = 'Continue';Write-Warning -Message "$Message";$WarningPreference=''}
'Stop' {$WarningPreference = 'Stop';Write-Warning -Message "$Message";$WarningPreference=''}
'Inquire' {$WarningPreference ='Inquire';Write-Warning -Message "$Message";$WarningPreference=''}
'SilentlyContinue' {}
}
}
}
#endregion Warning
#region Error
3{
#This if statement is to catch the two different types of errors that may come through. A normal terminating exception will have all the information that is needed, if it's a user generated error by using Write-Error,
#then the else statement will setup all the information we would like to log.
#Write back to the host if $Writebacktohost is true.
if(($WriteBackToHost))
{
#Write back to Host
Switch($PSCmdlet.GetVariableValue('ErrorActionPreference'))
{
'Stop'{$ErrorActionPreference = 'Stop';$Host.Ui.WriteErrorLine("ERROR: $([String]$Message.Exception.Message)");Write-Error $Message -ErrorAction 'Stop';$ErrorActionPreference=''}
'Inquire'{$ErrorActionPreference = 'Inquire';$Host.Ui.WriteErrorLine("ERROR: $([String]$Message.Exception.Message)");Write-Error $Message -ErrorAction 'Inquire';$ErrorActionPreference=''}
'Continue'{$ErrorActionPreference = 'Continue';$Host.Ui.WriteErrorLine("ERROR: $([String]$Message.Exception.Message)");$ErrorActionPreference=''}
'Suspend'{$ErrorActionPreference = 'Suspend';$Host.Ui.WriteErrorLine("ERROR: $([String]$Message.Exception.Message)");Write-Error $Message -ErrorAction 'Suspend';$ErrorActionPreference=''}
'SilentlyContinue'{}
}
}
}
#endregion Error
#region Verbose
4{
#Write back to the host if $Writebacktohost is true.
if(($WriteBackToHost)){
Switch ($PSCmdlet.GetVariableValue('VerbosePreference')) {
'Continue' {$VerbosePreference = 'Continue'; Write-Verbose -Message "$Message";$VerbosePreference = ''}
'Inquire' {$VerbosePreference = 'Inquire'; Write-Verbose -Message "$Message";$VerbosePreference = ''}
'Stop' {$VerbosePreference = 'Stop'; Write-Verbose -Message "$Message";$VerbosePreference = ''}
}
}
}
#endregion Verbose
#region Debug
5{
#Write back to the host if $Writebacktohost is true.
if(($WriteBackToHost))
{
Switch ($PSCmdlet.GetVariableValue('DebugPreference')){
'Continue' {$DebugPreference = 'Continue'; Write-Debug -Message "$Message";$DebugPreference = ''}
'Inquire' {$DebugPreference = 'Inquire'; Write-Debug -Message "$Message";$DebugPreference = ''}
'Stop' {$DebugPreference = 'Stop'; Write-Debug -Message "$Message";$DebugPreference = ''}
}
}
}
#endregion Debug
#region Information
6{
#Write back to the host if $Writebacktohost is true.
if(($WriteBackToHost)){
Switch ($PSCmdlet.GetVariableValue('InformationPreference')){
'Continue' {$InformationPreference = [System.Management.Automation.ActionPreference]::Continue; Write-Information "INFORMATION: $Message" -InformationAction Continue ; $InformationPreference = ''}
'Inquire' {$InformationPreference = [System.Management.Automation.ActionPreference]::Inquire; Write-Information "INFORMATION: $Message" -InformationAction Inquire; $InformationPreference = ''}
'Stop' {$InformationPreference = [System.Management.Automation.ActionPreference]::Stop; Write-Information "INFORMATION: $Message" -InformationAction Stop; $InformationPreference = ''}
'Suspend' {$InformationPreference = [System.Management.Automation.ActionPreference]::Suspend; Write-Information "INFORMATION: $Message" -InformationAction Suspend; $InformationPreference = ''}
}
}
}
#endregion Information
}
#endregion Switch statement to write out to the log and/or back to the host.
}
<#
.SYNOPSIS
Write to a log file in a format that takes advantage of the CMTrace.exe log viewer that comes with SCCM.
Found @ https://wolffhaven.gitlab.io/wolffhaven_icarus_test/powershell/write-cmtracelog-dropping-logs-like-a-boss/
heavily modified for the purpose of WAU project
.DESCRIPTION
Output strings to a log file that is formatted for use with CMTRace.exe and also writes back to the host.
The severity of the logged line can be set as:
2-Error
3-Warning
4-Verbose
5-Debug
6-Information
Warnings will be highlighted in yellow. Errors are highlighted in red.
The tools to view the log:
SMS Trace - http://www.microsoft.com/en-us/download/details.aspx?id=18153
CM Trace - https://www.microsoft.com/en-us/download/details.aspx?id=50012 or the Installation directory on Configuration Manager 2012 Site Server - <Install Directory>\tools\
With current atomization of the code, the component parameter should be passed as one of parameters
[string]$component_name = (Get-PSCallStack)[0].FunctionName
If logger function is not called in the function, then we could designate a decriptive name for it.
.EXAMPLE
Try{
Get-Process -Name DoesnotExist -ea stop
}
Catch{
Write-CMTraceLog -Logfile "C:\output\logfile.log -Message $Error[0] -Type Error
}
This will write a line to the logfile.log file in c:\output\logfile.log. It will state the errordetails in the log file
and highlight the line in Red. It will also write back to the host in a friendlier red on black message than
the normal error record.
.EXAMPLE
$VerbosePreference = Continue
Write-CMTraceLog -Message "This is a verbose message." -Type Verbose
This example will write a verbose entry into the log file and also write back to the host. The Write-CMTraceLog will obey
the preference variables.
.EXAMPLE
Write-CMTraceLog -Message "This is an informational message" -Type Information -WritebacktoHost:$false
This example will write the informational message to the log but not back to the host.
.EXAMPLE
Function Test{
[cmdletbinding()]
Param()
Write-CMTraceLog -Message "This is a verbose message" -Type Verbose
}
Test -Verbose
This example shows how to use write-cmtracelog inside a function and then call the function with the -verbose switch.
The write-cmtracelog function will then print the verbose message.
.NOTES
##########
Change Log
##########
v1.6 - 2024-04-01 - reorganized com handling triggered by UTC Offset calculation, reduced the parallelism by moving err/non-err strings generation to the front
##########
v1.5 - 2015-03-12 - Found bug with Error writing back to host twice. Fixed.
##########
v1.4 - 2015-03-12 - Found bug with Warning writebackto host duplicating warning error message.
Fixed.
##########
v1.3 - 2015-02-23 - Commented out line 224 and 249 as it was causing a duplicaton of the message.
##########
v1.2 - Fixed inheritance of preference variables from child scopes finally!! Changed from using
using get-variable -scope 1 (which doesn't work when a script modules calls a function:
See this Microsoft Connect bug https://connect.microsoft.com/PowerShell/feedback/details/1606119.)
Anyway now now i use the $PSCmdlet.GetVariableValue('VerbosePreference') command and it works.
##########
v1.1 - Found a bug with the get-variable scope. Need to refer to 2 parent scopes for the writebacktohost to work.
- Changed all Get-Variable commands to use Scope 2, instead of Scope 1.
##########
v1.0 - Script Created
#>

View File

@ -1,10 +1,9 @@
Google.Chrome
Microsoft.Edge
Microsoft.EdgeWebView2Runtime
Google.Chrome*
Microsoft.Edge*
Microsoft.Office
Microsoft.OneDrive
Microsoft.Teams
Microsoft.Teams.Classic
Mozilla.Firefox*
TeamViewer.TeamViewer*
Microsoft.RemoteDesktopClient
Microsoft.Teams*
Mozilla.Firefox*
Opera.Opera*
TeamViewer.TeamViewer*

View File

@ -4,45 +4,54 @@ function Get-ExcludedApps {
$AppIDs = @()
#region blacklist in registry
#blacklist in registry
if ($GPOList) {
Write-ToLog "-> Excluded apps from GPO is activated"
if (Test-Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\BlackList") {
$ValueNames = (Get-Item -Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\BlackList").Property
foreach ($ValueName in $ValueNames) {
$AppIDs += (Get-ItemPropertyValue -Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\BlackList" -Name $ValueName).Trim()
}
Write-ToLog "-> Successsfully loaded excluded apps list."
}
}
#endregion blacklist in registry
#region blacklist pulled from URI
}
#blacklist pulled from URI
elseif ($URIList) {
$RegPath = "$WAU_GPORoot";
$RegValueName = 'WAU_URIList';
if (Test-Path -Path $RegPath) {
$RegKey = Get-Item -Path $RegPath;
$WAUURI = $RegKey.GetValue($RegValueName);
Write-ToLog "-> Excluded apps from URI is activated"
if ($null -ne $WAUURI) {
$resp = Invoke-WebRequest -Uri $WAUURI -UseDefaultCredentials;
if ($resp.BaseResponse.StatusCode -eq [System.Net.HttpStatusCode]::OK) {
$resp.Content.Split([System.Environment]::NewLine, [System.StringSplitOptions]::RemoveEmptyEntries) |
$resp.Content.Split([System.Environment]::NewLine, [System.StringSplitOptions]::RemoveEmptyEntries) |
ForEach-Object {
$AppIds += $_
}
Write-ToLog "-> Successsfully loaded excluded apps list."
}
}
}
}
#endregion blacklist pulled from URI
#blacklist pulled from local file
elseif (Test-Path "$WorkingDir\excluded_apps.txt") {
return (Get-Content -Path "$WorkingDir\excluded_apps.txt").Trim() | Where-Object { $_.length -gt 0 }
$AppIDs = (Get-Content -Path "$WorkingDir\excluded_apps.txt").Trim()
Write-ToLog "-> Successsfully loaded local excluded apps list."
}
#blacklist pulled from default file
elseif (Test-Path "$WorkingDir\config\default_excluded_apps.txt") {
$AppIDs = (Get-Content -Path "$WorkingDir\config\default_excluded_apps.txt").Trim()
Write-ToLog "-> Successsfully loaded default excluded apps list."
}

View File

@ -3,45 +3,47 @@
function Get-IncludedApps {
$AppIDs = @()
#region whitelist in registry
#whitelist in registry
if ($GPOList) {
Write-ToLog "-> Included apps from GPO is activated"
if (Test-Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\WhiteList") {
$ValueNames = (Get-Item -Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\WhiteList").Property
foreach ($ValueName in $ValueNames) {
$AppIDs += (Get-ItemPropertyValue -Path "HKLM:\SOFTWARE\Policies\Romanitho\Winget-AutoUpdate\WhiteList" -Name $ValueName).Trim()
}
Write-ToLog "-> Successsfully loaded included apps list."
}
}
#endregion whitelist in registry
#region whitelist pulled from URI
}
#whitelist pulled from URI
elseif ($URIList) {
$RegPath = "$WAU_GPORoot";
$RegValueName = 'WAU_URIList';
if (Test-Path -Path $RegPath) {
$RegKey = Get-Item -Path $RegPath;
$WAUURI = $RegKey.GetValue($RegValueName);
Write-ToLog "-> Included apps from URI is activated"
if ($null -ne $WAUURI) {
$resp = Invoke-WebRequest -Uri $WAUURI -UseDefaultCredentials;
if ($resp.BaseResponse.StatusCode -eq [System.Net.HttpStatusCode]::OK) {
$resp.Content.Split([System.Environment]::NewLine, [System.StringSplitOptions]::RemoveEmptyEntries) |
$resp.Content.Split([System.Environment]::NewLine, [System.StringSplitOptions]::RemoveEmptyEntries) |
ForEach-Object {
$AppIds += $_
}
Write-ToLog "-> Successsfully loaded included apps list."
}
}
}
}
#endregion whitelist pulled from URI
#whitelist pulled from local file
elseif (Test-Path "$WorkingDir\included_apps.txt") {
return (Get-Content -Path "$WorkingDir\included_apps.txt").Trim() | Where-Object { $_.length -gt 0 }
$AppIDs = (Get-Content -Path "$WorkingDir\included_apps.txt").Trim()
Write-ToLog "-> Successsfully loaded local included apps list."
}

View File

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

View File

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 4.1 KiB

View File

Before

Width:  |  Height:  |  Size: 3.1 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB