xstefen/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil.git synced 2025-01-15 09:20:36 -06:00
Code Issues Packages Projects Releases Wiki Activity

Rename File/Function, Refactor Choco Install, Add Status Indicator

Browse Source
This commit is contained in:
Marterich 2024-08-23 14:16:49 +02:00
parent 5b3cd16ac0
commit 12a07a7d9c
6 changed files with 270 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/dev/tweaks/Essential-Tweaks/Powershell7.md
View File

@ -69,7 +69,7 @@ function Invoke-WPFTweakPS7{
Write-Host "Powershell 7 is already installed." Write-Host "Powershell 7 is already installed."
} else { } else {
Write-Host "Installing Powershell 7..." Write-Host "Installing Powershell 7..."
Invoke-WinUtilWingetProgram -Action Install -Programs @("Microsoft.PowerShell") Install-WinUtilProgramWinget -Action Install -Programs @("Microsoft.PowerShell")
} }
$targetTerminalName = "PowerShell" $targetTerminalName = "PowerShell"
} }
@ -105,10 +105,10 @@ function Invoke-WPFTweakPS7{
} }
``` ```
## Function: Invoke-WinUtilWingetProgram ## Function: Install-WinUtilProgramWinget
```powershell ```powershell
Function Invoke-WinUtilWingetProgram { Function Install-WinUtilProgramWinget {
<# <#
.SYNOPSIS .SYNOPSIS
Runs the designated action on the provided programs using Winget Runs the designated action on the provided programs using Winget

320
functions/private/Install-WinUtilProgramChoco.ps1
View File

@ -1,112 +1,258 @@
function Install-WinUtilProgramChoco { function Install-WinUtilProgramChoco {
<# <#
.SYNOPSIS .SYNOPSIS
Manages the provided programs using Chocolatey Manages the installation or uninstallation of a list of Chocolatey packages.
.PARAMETER ProgramsToInstall .PARAMETER Programs
A list of programs to manage A string array containing the programs to be installed or uninstalled.
.PARAMETER manage .PARAMETER Action
The action to perform on the programs, can be either 'Installing' or 'Uninstalling' Specifies the action to perform: "Install" or "Uninstall". The default value is "Install".
.NOTES .DESCRIPTION
The triple quotes are required any time you need a " in a normal script block. This function processes a list of programs to be managed using Chocolatey. Depending on the specified action, it either installs or uninstalls each program in the list, updating the taskbar progress accordingly. After all operations are completed, temporary output files are cleaned up.
.EXAMPLE
Install-WinUtilProgramChoco -Programs @("7zip","chrome") -Action "Uninstall"
#> #>
param( param(
[Parameter(Mandatory, Position = 0)] [Parameter(Mandatory, Position = 0)]
[PsCustomObject]$ProgramsToInstall, [string[]]$Programs,
[Parameter(Position = 1)] [Parameter(Position = 1)]
[String]$manage = "Installing" [String]$Action = "Install"
) )
$x = 0 function Initialize-OutputFile {
$count = $ProgramsToInstall.Count <#
.SYNOPSIS
# This check isn't really necessary, as there's a couple of checks before this Private Function gets called, but just to make sure ;) Initializes an output file by removing any existing file and creating a new, empty file at the specified path.
if ($count -le 0) {
throw "Private Function 'Install-WinUtilProgramChoco' expected Parameter 'ProgramsToInstall' to be of size 1 or greater, instead got $count,`nPlease double check your code and re-compile WinUtil." .PARAMETER filePath
The full path to the file to be initialized.
.DESCRIPTION
This function ensures that the specified file is reset by removing any existing file at the provided path and then creating a new, empty file. It is useful when preparing a log or output file for subsequent operations.
.EXAMPLE
Initialize-OutputFile -filePath "C:\temp\output.txt"
#>
param ($filePath)
Remove-Item -Path $filePath -Force -ErrorAction SilentlyContinue
New-Item -ItemType File -Path $filePath | Out-Null
} }
function Run-ChocoCommand {
Write-Host "===========================================" <#
Write-Host "-- Configuring Chocolatey pacakages ---" .SYNOPSIS
Write-Host "===========================================" Executes a Chocolatey command with the specified arguments and returns the exit code.
Foreach ($Program in $ProgramsToInstall) {
.PARAMETER arguments
if ($manage -eq "Installing") { The arguments to be passed to the Chocolatey command.
write-host "Starting install of $($Program.choco) with Chocolatey."
try { .DESCRIPTION
$tryUpgrade = $false This function runs a specified Chocolatey command by passing the provided arguments to the `choco` executable. It waits for the process to complete and then returns the exit code, allowing the caller to determine success or failure based on the exit code.
$installOutputFilePath = "$env:TEMP\Install-WinUtilProgramChoco.install-command.output.txt"
New-Item -ItemType File -Path $installOutputFilePath .RETURNS
$chocoInstallStatus = $(Start-Process -FilePath "choco" -ArgumentList "install $($Program.choco) -y --log-file $($installOutputFilePath)" -Wait -PassThru).ExitCode [int]
if (($chocoInstallStatus -eq 0) -AND (Test-Path -Path $installOutputFilePath)) { The exit code of the Chocolatey command.
$keywordsFound = Get-Content -Path $installOutputFilePath | Where-Object { $_ -match "reinstall" -OR $_ -match "already installed" }
if ($keywordsFound) { .EXAMPLE
$tryUpgrade = $true $exitCode = Run-ChocoCommand -arguments "install 7zip -y"
} #>
}
if ($tryUpgrade) { param ($arguments)
$chocoUpdateStatus = $(Start-Process -FilePath "choco" -ArgumentList "upgrade $($Program.choco) -y" -Wait -PassThru).ExitCode return (Start-Process -FilePath "choco" -ArgumentList $arguments -Wait -PassThru).ExitCode
if ($chocoUpdateStatus -eq 0) { }
Write-Host "$($Program.choco) was updated successfully using Chocolatey."
} function Check-UpgradeNeeded {
else{ <#
Write-Host "Failed upgdate of $($Program.choco) using Chocolatey." .SYNOPSIS
} Checks if an upgrade is needed for a Chocolatey package based on the content of a log file.
}
if (($chocoInstallStatus -eq 0) -AND ($tryUpgrade -eq $false)) { .PARAMETER filePath
Write-Host "$($Program.choco) installed successfully using Chocolatey." The path to the log file that contains the output of a Chocolatey install command.
$X++
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Normal" -value ($x / $count) }) .DESCRIPTION
continue This function reads the specified log file and checks for keywords that indicate whether an upgrade is needed. It returns a boolean value indicating whether the terms "reinstall" or "already installed" are present, which suggests that the package might need an upgrade.
}
elseif (($chocoInstallStatus -ne 0) -AND ($tryUpgrade -eq $false)) { .RETURNS
Write-Host "Failed to install $($Program.choco) using Chocolatey" [bool]
$X++ True if the log file indicates that an upgrade is needed; otherwise, false.
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Error" -value ($x / $count) })
} .EXAMPLE
} $isUpgradeNeeded = Check-UpgradeNeeded -filePath "C:\temp\install-output.txt"
catch { #>
Write-Host "Failed to install $($Program.choco) due to an error: $_"
$X++ param ($filePath)
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Error" -value ($x / $count) }) return Get-Content -Path $filePath | Select-String -Pattern "reinstall|already installed" -Quiet
} }
}
function Update-TaskbarProgress {
if ($manage -eq "Uninstalling") { <#
Write-Host "Searching for Metapackages of of $($Program.choco) (.install or .portable)" .SYNOPSIS
$chocoPackages = ((choco list | Select-String -Pattern "$($Program.choco)(\.install|\.portable) {0,1}").Matches.Value) -join " " Updates the taskbar progress based on the current installation progress.
Write-Host "Starting uninstall of $chocoPackages with Chocolatey."
try { .PARAMETER currentIndex
$uninstallOutputFilePath = "$env:TEMP\Install-WinUtilProgramChoco.uninstall-command.output.txt" The current index of the program being installed or uninstalled.
New-Item -ItemType File -Path $uninstallOutputFilePath
$chocoUninstallStatus = $(Start-Process -FilePath "choco" -ArgumentList "uninstall $chocoPackages -y" -Wait -PassThru).ExitCode .PARAMETER totalPrograms
if ($chocoUninstallStatus -eq 0) { The total number of programs to be installed or uninstalled.
Write-Host "$($Program.choco) uninstalled successfully using Chocolatey."
$x++ .DESCRIPTION
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Normal" -value ($x / $count) }) This function calculates the progress of the installation or uninstallation process and updates the taskbar accordingly. The taskbar is set to "Normal" if all programs have been processed, otherwise, it is set to "Error" as a placeholder.
continue
.EXAMPLE
Update-TaskbarProgress -currentIndex 3 -totalPrograms 10
#>
param (
[int]$currentIndex,
[int]$totalPrograms
)
$progressState = if ($currentIndex -eq $totalPrograms) { "Normal" } else { "Error" }
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state $progressState -value ($currentIndex / $totalPrograms) })
}
function Install-ChocoPackage {
<#
.SYNOPSIS
Installs a Chocolatey package and optionally upgrades it if needed.
.PARAMETER Program
A string containing the name of the Chocolatey package to be installed.
.PARAMETER currentIndex
The current index of the program in the list of programs to be managed.
.PARAMETER totalPrograms
The total number of programs to be installed.
.DESCRIPTION
This function installs a Chocolatey package by running the `choco install` command. If the installation output indicates that an upgrade might be needed, the function will attempt to upgrade the package. The taskbar progress is updated after each package is processed.
.EXAMPLE
Install-ChocoPackage -Program $Program -currentIndex 0 -totalPrograms 5
#>
param (
[string]$Program,
[int]$currentIndex,
[int]$totalPrograms
)
$installOutputFile = "$env:TEMP\Install-WinUtilProgramChoco.install-command.output.txt"
Initialize-OutputFile $installOutputFile
Write-Host "Starting installation of $Program with Chocolatey."
try {
$installStatusCode = Run-ChocoCommand "install $Program -y --log-file $installOutputFile"
if ($installStatusCode -eq 0) {
if (Check-UpgradeNeeded $installOutputFile) {
$upgradeStatusCode = Run-ChocoCommand "upgrade $Program -y"
Write-Host "$Program was" $(if ($upgradeStatusCode -eq 0) { "upgraded successfully." } else { "not upgraded." })
} }
else { else {
Write-Host "Failed to uninstall $($Program.choco) using Chocolatey, Chocolatey output:`n`n$(Get-Content -Path $uninstallOutputFilePath)." Write-Host "$Program installed successfully."
$x++
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Error" -value ($x / $count) })
} }
} }
catch { else {
Write-Host "Failed to uninstall $($Program.choco) due to an error: $_" Write-Host "Failed to install $Program."
$x++
$sync.form.Dispatcher.Invoke([action] { Set-WinUtilTaskbaritem -state "Error" -value ($x / $count) })
} }
} }
catch {
Write-Host "Failed to install $Program due to an error: $_"
}
finally {
Update-TaskbarProgress $currentIndex $totalPrograms
}
}
function Uninstall-ChocoPackage {
<#
.SYNOPSIS
Uninstalls a Chocolatey package and any related metapackages.
.PARAMETER Program
A string containing the name of the Chocolatey package to be uninstalled.
.PARAMETER currentIndex
The current index of the program in the list of programs to be managed.
.PARAMETER totalPrograms
The total number of programs to be uninstalled.
.DESCRIPTION
This function uninstalls a Chocolatey package and any related metapackages (e.g., .install or .portable variants). It updates the taskbar progress after processing each package.
.EXAMPLE
Uninstall-ChocoPackage -Program $Program -currentIndex 0 -totalPrograms 5
#>
param (
[string]$Program,
[int]$currentIndex,
[int]$totalPrograms
)
$uninstallOutputFile = "$env:TEMP\Install-WinUtilProgramChoco.uninstall-command.output.txt"
Initialize-OutputFile $uninstallOutputFile
Write-Host "Searching for metapackages of $Program (.install or .portable)"
$chocoPackages = ((choco list | Select-String -Pattern "$Program(\.install|\.portable)?").Matches.Value) -join " "
if ($chocoPackages) {
Write-Host "Starting uninstallation of $chocoPackages with Chocolatey."
try {
$uninstallStatusCode = Run-ChocoCommand "uninstall $chocoPackages -y"
Write-Host "$Program" $(if ($uninstallStatusCode -eq 0) { "uninstalled successfully." } else { "failed to uninstall." })
}
catch {
Write-Host "Failed to uninstall $Program due to an error: $_"
}
finally {
Update-TaskbarProgress $currentIndex $totalPrograms
}
}
else {
Write-Host "$Program is not installed."
}
} }
# Cleanup leftovers files $totalPrograms = $Programs.Count
if (Test-Path -Path $installOutputFilePath) { Remove-Item -Path $installOutputFilePath } if ($totalPrograms -le 0) {
if (Test-Path -Path $uninstallOutputFilePath) { Remove-Item -Path $uninstallOutputFilePath } throw "Parameter 'Programs' must have at least one item."
}
return; Write-Host "==========================================="
Write-Host "-- Configuring Chocolatey packages ---"
Write-Host "==========================================="
for ($currentIndex = 0; $currentIndex -lt $totalPrograms; $currentIndex++) {
$Program = $Programs[$currentIndex]
Set-WinUtilProgressBar -label "$Action $($Program)" -percent ($currentIndex / $totalPrograms * 100)
$sync.form.Dispatcher.Invoke([action]{ Set-WinUtilTaskbaritem -value ($currentIndex / $totalPrograms)})
switch ($Action) {
"Install" {
Install-ChocoPackage -Program $Program -currentIndex $currentIndex -totalPrograms $totalPrograms
}
"Uninstall" {
Uninstall-ChocoPackage -Program $Program -currentIndex $currentIndex -totalPrograms $totalPrograms
}
default {
throw "Invalid action parameter value: '$Action'."
}
}
}
Set-WinUtilProgressBar -label "$($Action)ation done" -percent 100
# Cleanup Output Files
$outputFiles = @("$env:TEMP\Install-WinUtilProgramChoco.install-command.output.txt", "$env:TEMP\Install-WinUtilProgramChoco.uninstall-command.output.txt")
foreach ($filePath in $outputFiles) {
Remove-Item -Path $filePath -Force -ErrorAction SilentlyContinue
}
} }

2
functions/private/Invoke-WinUtilWingetProgram.ps1 → functions/private/Install-WinUtilProgramWinget.ps1
View File

@ -1,4 +1,4 @@
Function Invoke-WinUtilWingetProgram { Function Install-WinUtilProgramWinget {
<# <#
.SYNOPSIS .SYNOPSIS
Runs the designated action on the provided programs using Winget Runs the designated action on the provided programs using Winget

17
functions/public/Invoke-WPFInstall.ps1
View File

@ -29,23 +29,21 @@ function Invoke-WPFInstall {
} }
$packagesWinget, $packagesChoco = { $packagesWinget, $packagesChoco = {
$packagesWinget = [System.Collections.ArrayList]::new() $packagesWinget = [System.Collections.ArrayList]::new()
$packagesChoco = [System.Collections.Generic.List`1[System.Object]]::new() $packagesChoco = [System.Collections.ArrayList]::new()
foreach ($package in $PackagesToInstall) { foreach ($package in $PackagesToInstall) {
if ($ChocoPreference) { if ($ChocoPreference) {
Write-Host "Prefer Choco"
if ($package.choco -eq "na") { if ($package.choco -eq "na") {
$packagesWinget.add($package.winget) $packagesWinget.add($package.winget)
Write-Host "Queueing $($package.winget) for Winget install" Write-Host "Queueing $($package.winget) for Winget install"
} else { } else {
$null = $packagesChoco.add($package) $null = $packagesChoco.add($package.choco)
Write-Host "Queueing $($package) for Chocolatey install" Write-Host "Queueing $($package.choco) for Chocolatey install"
} }
} }
else { else {
Write-Host "Prefer Winget"
if ($package.winget -eq "na") { if ($package.winget -eq "na") {
$packagesChoco.add($package) $packagesChoco.add($package.choco)
Write-Host "Queueing $($package.choco) for Chocolatey install" Write-Host "Queueing $($package.choco) for Chocolatey install"
} else { } else {
$null = $packagesWinget.add($($package.winget)) $null = $packagesWinget.add($($package.winget))
@ -53,7 +51,6 @@ function Invoke-WPFInstall {
} }
} }
} }
return $packagesWinget, $packagesChoco return $packagesWinget, $packagesChoco
}.Invoke($PackagesToInstall) }.Invoke($PackagesToInstall)
@ -62,12 +59,12 @@ function Invoke-WPFInstall {
$errorPackages = @() $errorPackages = @()
if($packagesWinget.Count -gt 0) { if($packagesWinget.Count -gt 0) {
Install-WinUtilWinget Install-WinUtilWinget
$errorPackages += Invoke-WinUtilWingetProgram -Action Install -Programs $packagesWinget Install-WinUtilProgramWinget -Action Install -Programs $packagesWinget
$errorPackages| ForEach-Object {if($_.choco -ne "na") {$packagesChoco += $_}}
} }
if($packagesChoco.Count -gt 0) { if($packagesChoco.Count -gt 0) {
Install-WinUtilChoco Install-WinUtilChoco
Install-WinUtilProgramChoco -ProgramsToInstall $packagesChoco Install-WinUtilProgramChoco -Action Install -Programs $packagesChoco
} }
Write-Host "===========================================" Write-Host "==========================================="
Write-Host "-- Installs have finished ---" Write-Host "-- Installs have finished ---"

2
functions/public/Invoke-WPFTweakPS7.ps1
View File

@ -17,7 +17,7 @@ function Invoke-WPFTweakPS7{
Write-Host "Powershell 7 is already installed." Write-Host "Powershell 7 is already installed."
} else { } else {
Write-Host "Installing Powershell 7..." Write-Host "Installing Powershell 7..."
Invoke-WinUtilWingetProgram -Action Install -Programs @("Microsoft.PowerShell") Install-WinUtilProgramWinget -Action Install -Programs @("Microsoft.PowerShell")
} }
$targetTerminalName = "PowerShell" $targetTerminalName = "PowerShell"
} }

49
functions/public/Invoke-WPFUnInstall.ps1
View File

@ -38,40 +38,41 @@ function Invoke-WPFUnInstall {
$sync.form.Dispatcher.Invoke([action]{ Set-WinUtilTaskbaritem -state "Normal" -value 0.01 -overlay "logo" }) $sync.form.Dispatcher.Invoke([action]{ Set-WinUtilTaskbaritem -state "Normal" -value 0.01 -overlay "logo" })
} }
$packagesWinget, $packagesChoco = { $packagesWinget, $packagesChoco = {
$packagesWinget = [System.Collections.Generic.List`1[System.Object]]::new() $packagesWinget = [System.Collections.ArrayList]::new()
$packagesChoco = [System.Collections.Generic.List`1[System.Object]]::new() $packagesChoco = [System.Collections.ArrayList]::new()
foreach ($package in $PackagesToInstall) {
if ($ChocoPreference) { foreach ($package in $PackagesToInstall) {
if ($packagesChoco.choco -eq "na") { if ($ChocoPreference) {
$null = $packagesWinget.add($package.winget) if ($package.choco -eq "na") {
Write-Host "Queueing $($package.winget) for Winget Uninstall" $packagesWinget.add($package.winget)
} Write-Host "Queueing $($package.winget) for Winget uninstall"
else { } else {
$packagesChoco.add($package) $null = $packagesChoco.add($package.choco)
Write-Host "Queueing $($package.choco) for Chocolatey Uninstall" Write-Host "Queueing $($package.choco) for Chocolatey uninstall"
}
}
else {
if ($package.winget -eq "na") {
$packagesChoco.add($package)
Write-Host "Queueing $($package.choco) for Chocolatey Uninstall"
} else {
$null = $packagesWinget.add($($package.winget))
Write-Host "Queueing $($package.winget) for Winget Uninstall"
}
} }
} }
return $packagesWinget, $packagesChoco else {
if ($package.winget -eq "na") {
$packagesChoco.add($package.choco)
Write-Host "Queueing $($package.choco) for Chocolatey uninstall"
} else {
$null = $packagesWinget.add($($package.winget))
Write-Host "Queueing $($package.winget) for Winget uninstall"
}
}
}
return $packagesWinget, $packagesChoco
}.Invoke($PackagesToInstall) }.Invoke($PackagesToInstall)
try { try {
$sync.ProcessRunning = $true $sync.ProcessRunning = $true
# Install all selected programs in new window # Install all selected programs in new window
if($packagesWinget.Count -gt 0) { if($packagesWinget.Count -gt 0) {
Invoke-WinUtilWingetProgram -Action Uninstall -Programs $packagesWinget Install-WinUtilProgramWinget -Action Uninstall -Programs $packagesWinget
} }
if($packagesChoco.Count -gt 0) { if($packagesChoco.Count -gt 0) {
Install-WinUtilProgramChoco -ProgramsToInstall $packagesChoco -Manage "Uninstalling" Install-WinUtilProgramChoco -Action Uninstall -Programs $packagesChoco
} }
Write-Host "===========================================" Write-Host "==========================================="