316 lines
12 KiB
PowerShell
316 lines
12 KiB
PowerShell
|
<#
|
||
|
|
|
||
|
|
.SYNOPSIS
|
||
|
|
PSAppDeployToolkit - This script performs the installation or uninstallation of an application(s).
|
||
|
|
|
||
|
|
.DESCRIPTION
|
||
|
|
- The script is provided as a template to perform an install, uninstall, or repair of an application(s).
|
||
|
|
- The script either performs an "Install", "Uninstall", or "Repair" deployment type.
|
||
|
|
- The install deployment type is broken down into 3 main sections/phases: Pre-Install, Install, and Post-Install.
|
||
|
|
|
||
|
|
The script imports the PSAppDeployToolkit module which contains the logic and functions required to install or uninstall an application.
|
||
|
|
|
||
|
|
PSAppDeployToolkit is licensed under the GNU LGPLv3 License - (C) 2024 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
|
||
|
|
|
||
|
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the
|
||
|
|
Free Software Foundation, either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but
|
||
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||
|
|
for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
.PARAMETER DeploymentType
|
||
|
|
The type of deployment to perform. Default is: Install.
|
||
|
|
|
||
|
|
.PARAMETER DeployMode
|
||
|
|
Specifies whether the installation should be run in Interactive, Silent, or NonInteractive mode. Default is: Interactive. Options: Interactive = Shows dialogs, Silent = No dialogs, NonInteractive = Very silent, i.e. no blocking apps. NonInteractive mode is automatically set if it is detected that the process is not user interactive.
|
||
|
|
|
||
|
|
.PARAMETER AllowRebootPassThru
|
||
|
|
Allows the 3010 return code (requires restart) to be passed back to the parent process (e.g. SCCM) if detected from an installation. If 3010 is passed back to SCCM, a reboot prompt will be triggered.
|
||
|
|
|
||
|
|
.PARAMETER TerminalServerMode
|
||
|
|
Changes to "user install mode" and back to "user execute mode" for installing/uninstalling applications for Remote Desktop Session Hosts/Citrix servers.
|
||
|
|
|
||
|
|
.PARAMETER DisableLogging
|
||
|
|
Disables logging to file for the script. Default is: $false.
|
||
|
|
|
||
|
|
.EXAMPLE
|
||
|
|
powershell.exe -File Invoke-AppDeployToolkit.ps1 -DeployMode Silent
|
||
|
|
|
||
|
|
.EXAMPLE
|
||
|
|
powershell.exe -File Invoke-AppDeployToolkit.ps1 -AllowRebootPassThru
|
||
|
|
|
||
|
|
.EXAMPLE
|
||
|
|
powershell.exe -File Invoke-AppDeployToolkit.ps1 -DeploymentType Uninstall
|
||
|
|
|
||
|
|
.EXAMPLE
|
||
|
|
Invoke-AppDeployToolkit.exe -DeploymentType "Install" -DeployMode "Silent"
|
||
|
|
|
||
|
|
.INPUTS
|
||
|
|
None. You cannot pipe objects to this script.
|
||
|
|
|
||
|
|
.OUTPUTS
|
||
|
|
None. This script does not generate any output.
|
||
|
|
|
||
|
|
.NOTES
|
||
|
|
Toolkit Exit Code Ranges:
|
||
|
|
- 60000 - 68999: Reserved for built-in exit codes in Invoke-AppDeployToolkit.ps1, and Invoke-AppDeployToolkit.exe
|
||
|
|
- 69000 - 69999: Recommended for user customized exit codes in Invoke-AppDeployToolkit.ps1
|
||
|
|
- 70000 - 79999: Recommended for user customized exit codes in PSAppDeployToolkit.Extensions module.
|
||
|
|
|
||
|
|
.LINK
|
||
|
|
https://psappdeploytoolkit.com
|
||
|
|
|
||
|
|
#>
|
||
|
|
|
||
|
|
[CmdletBinding()]
|
||
|
|
param
|
||
|
|
(
|
||
|
|
[Parameter(Mandatory = $false)]
|
||
|
|
[ValidateSet('Install', 'Uninstall', 'Repair')]
|
||
|
|
[System.String]$DeploymentType = 'Install',
|
||
|
|
|
||
|
|
[Parameter(Mandatory = $false)]
|
||
|
|
[ValidateSet('Interactive', 'Silent', 'NonInteractive')]
|
||
|
|
[System.String]$DeployMode = 'Silent',
|
||
|
|
|
||
|
|
[Parameter(Mandatory = $false)]
|
||
|
|
[System.Management.Automation.SwitchParameter]$AllowRebootPassThru = $false,
|
||
|
|
|
||
|
|
[Parameter(Mandatory = $false)]
|
||
|
|
[System.Management.Automation.SwitchParameter]$TerminalServerMode = $false,
|
||
|
|
|
||
|
|
[Parameter(Mandatory = $false)]
|
||
|
|
[System.Management.Automation.SwitchParameter]$DisableLogging
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Variables
|
||
|
|
##================================================
|
||
|
|
|
||
|
|
$adtSession = @{
|
||
|
|
# App variables.
|
||
|
|
AppVendor = 'IS Research Informatics'
|
||
|
|
AppName = 'BPC STARS'
|
||
|
|
AppVersion = 'Firefox ESR Version'
|
||
|
|
AppArch = 'x86'
|
||
|
|
AppLang = 'EN'
|
||
|
|
AppRevision = '01'
|
||
|
|
AppSuccessExitCodes = @(0)
|
||
|
|
AppRebootExitCodes = @(1641, 3010)
|
||
|
|
AppScriptVersion = '1.0.0'
|
||
|
|
AppScriptDate = '02/11/2025'
|
||
|
|
AppScriptAuthor = 'jxp066admin'
|
||
|
|
|
||
|
|
# Install Titles (Only set here to override defaults set by the toolkit).
|
||
|
|
InstallName = ''
|
||
|
|
InstallTitle = ''
|
||
|
|
|
||
|
|
# Script variables.
|
||
|
|
DeployAppScriptFriendlyName = $MyInvocation.MyCommand.Name
|
||
|
|
DeployAppScriptVersion = '4.0.4'
|
||
|
|
DeployAppScriptParameters = $PSBoundParameters
|
||
|
|
}
|
||
|
|
|
||
|
|
function Install-ADTDeployment
|
||
|
|
{
|
||
|
|
##================================================
|
||
|
|
## MARK: Pre-Install
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
# This section will eventually be used to clean up the old install of the Firefox Portable version. But for testing they want to be able to have both.
|
||
|
|
|
||
|
|
<#
|
||
|
|
|
||
|
|
# Define the shortcut names
|
||
|
|
$shortcutNames = @("STARS PROD.lnk", "STARS Training.lnk")
|
||
|
|
|
||
|
|
# Define the path to the public desktop
|
||
|
|
$publicDesktopPath = [System.IO.Path]::Combine($env:PUBLIC, "Desktop")
|
||
|
|
|
||
|
|
# Initialize an array to store the results
|
||
|
|
$results = @()
|
||
|
|
|
||
|
|
# Get all user profile directories from C:\Users
|
||
|
|
$userProfilePaths = Get-ChildItem -Path "C:\Users" -Directory | ForEach-Object {
|
||
|
|
[System.IO.Path]::Combine($_.FullName, "Desktop")
|
||
|
|
}
|
||
|
|
|
||
|
|
# Add the public desktop path to the list of paths to search
|
||
|
|
$pathsToSearch = $userProfilePaths + $publicDesktopPath
|
||
|
|
|
||
|
|
# Search for and remove the shortcuts
|
||
|
|
foreach ($path in $pathsToSearch) {
|
||
|
|
$allFound = $true
|
||
|
|
foreach ($shortcut in $shortcutNames) {
|
||
|
|
$shortcutPath = [System.IO.Path]::Combine($path, $shortcut)
|
||
|
|
if (Test-Path -Path $shortcutPath) {
|
||
|
|
try {
|
||
|
|
Remove-Item -Path $shortcutPath -Force
|
||
|
|
$results += "Removed: '$shortcut' from '$path'"
|
||
|
|
|
||
|
|
} catch {
|
||
|
|
$results += "Failed to remove: '$shortcut' from '$path'. Error: $_"
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$allFound = $false
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ($allFound) {
|
||
|
|
$results += "Both shortcuts were originally found in '$path'"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
# Output the results
|
||
|
|
if ($results.Count -eq 0) {
|
||
|
|
Write-Output "No shortcuts found or removed."
|
||
|
|
} else {
|
||
|
|
$results | ForEach-Object { Write-Output $_ }
|
||
|
|
}
|
||
|
|
|
||
|
|
# Define the path to check for FireFoxPortable
|
||
|
|
$starsPath = "C:\Program Files (x86)\STARS"
|
||
|
|
$fireFoxPortablePath = [System.IO.Path]::Combine($starsPath, "FireFoxPortable")
|
||
|
|
|
||
|
|
# Check for the existence of FireFoxPortable and delete the STARS directory if found
|
||
|
|
if (Test-Path -Path $fireFoxPortablePath) {
|
||
|
|
try {
|
||
|
|
Remove-Item -Path $starsPath -Recurse -Force
|
||
|
|
Write-Output "Deleted directory: '$starsPath'"
|
||
|
|
} catch {
|
||
|
|
Write-Output "Failed to delete directory: '$starsPath'. Error: $_"
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
Write-Output "FireFoxPortable not found in '$starsPath'. No deletion performed."
|
||
|
|
}
|
||
|
|
#>
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Install
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = $adtSession.DeploymentType
|
||
|
|
|
||
|
|
Write-ADTLogEntry "Removing the Public Desktop Shortcuts for the New STARS application."
|
||
|
|
Copy-ADTFile "$($adtSession.DirFiles)\*" -Destination 'C:\Users\Public\Desktop'
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Post-Install
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
## Master Wrapper detection
|
||
|
|
Set-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\IS Research Informatics_BPC STARS_Firefox ESR Version"
|
||
|
|
}
|
||
|
|
|
||
|
|
function Uninstall-ADTDeployment
|
||
|
|
{
|
||
|
|
##================================================
|
||
|
|
## MARK: Pre-Uninstall
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Uninstall
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = $adtSession.DeploymentType
|
||
|
|
|
||
|
|
Write-ADTLogEntry "Removing the Public Desktop Shortcuts for the New STARS application."
|
||
|
|
Remove-ADTFile -Path "C:\Users\Public\Desktop\STARS PROD New.lnk"
|
||
|
|
Remove-ADTFile -Path "C:\Users\Public\Desktop\STARS Training New.lnk"
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Post-Uninstallation
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
## Master Wrapper detection
|
||
|
|
Remove-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\IS Research Informatics_BPC STARS_Firefox ESR Version"
|
||
|
|
}
|
||
|
|
|
||
|
|
function Repair-ADTDeployment
|
||
|
|
{
|
||
|
|
##================================================
|
||
|
|
## MARK: Pre-Repair
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Pre-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Repair
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = $adtSession.DeploymentType
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Post-Repair
|
||
|
|
##================================================
|
||
|
|
$adtSession.InstallPhase = "Post-$($adtSession.DeploymentType)"
|
||
|
|
|
||
|
|
## Master Wrapper detection
|
||
|
|
Set-ADTRegistryKey -Key "HKLM\SOFTWARE\InstalledApps\IS Research Informatics_BPC STARS_Firefox ESR Version"
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Initialization
|
||
|
|
##================================================
|
||
|
|
|
||
|
|
# Set strict error handling across entire operation.
|
||
|
|
$ErrorActionPreference = [System.Management.Automation.ActionPreference]::Stop
|
||
|
|
$ProgressPreference = [System.Management.Automation.ActionPreference]::SilentlyContinue
|
||
|
|
Set-StrictMode -Version 1
|
||
|
|
|
||
|
|
# Import the module and instantiate a new session.
|
||
|
|
try
|
||
|
|
{
|
||
|
|
$moduleName = if ([System.IO.File]::Exists("$PSScriptRoot\PSAppDeployToolkit\PSAppDeployToolkit.psd1"))
|
||
|
|
{
|
||
|
|
Get-ChildItem -LiteralPath $PSScriptRoot\PSAppDeployToolkit -Recurse -File | Unblock-File -ErrorAction Ignore
|
||
|
|
"$PSScriptRoot\PSAppDeployToolkit\PSAppDeployToolkit.psd1"
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
'PSAppDeployToolkit'
|
||
|
|
}
|
||
|
|
Import-Module -FullyQualifiedName @{ ModuleName = $moduleName; Guid = '8c3c366b-8606-4576-9f2d-4051144f7ca2'; ModuleVersion = '4.0.4' } -Force
|
||
|
|
try
|
||
|
|
{
|
||
|
|
$adtSession = Open-ADTSession -SessionState $ExecutionContext.SessionState @adtSession @PSBoundParameters -PassThru
|
||
|
|
}
|
||
|
|
catch
|
||
|
|
{
|
||
|
|
Remove-Module -Name PSAppDeployToolkit* -Force
|
||
|
|
throw
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch
|
||
|
|
{
|
||
|
|
$Host.UI.WriteErrorLine((Out-String -InputObject $_ -Width ([System.Int32]::MaxValue)))
|
||
|
|
exit 60008
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
##================================================
|
||
|
|
## MARK: Invocation
|
||
|
|
##================================================
|
||
|
|
|
||
|
|
try
|
||
|
|
{
|
||
|
|
Get-Item -Path $PSScriptRoot\PSAppDeployToolkit.* | & {
|
||
|
|
process
|
||
|
|
{
|
||
|
|
Get-ChildItem -LiteralPath $_.FullName -Recurse -File | Unblock-File -ErrorAction Ignore
|
||
|
|
Import-Module -Name $_.FullName -Force
|
||
|
|
}
|
||
|
|
}
|
||
|
|
& "$($adtSession.DeploymentType)-ADTDeployment"
|
||
|
|
Close-ADTSession
|
||
|
|
}
|
||
|
|
catch
|
||
|
|
{
|
||
|
|
Write-ADTLogEntry -Message ($mainErrorMessage = Resolve-ADTErrorRecord -ErrorRecord $_) -Severity 3
|
||
|
|
Show-ADTDialogBox -Text $mainErrorMessage -Icon Stop | Out-Null
|
||
|
|
Close-ADTSession -ExitCode 60001
|
||
|
|
}
|
||
|
|
finally
|
||
|
|
{
|
||
|
|
Remove-Module -Name PSAppDeployToolkit* -Force
|
||
|
|
}
|