Public/Show-ADTInstallationWelcome.ps1
|
#----------------------------------------------------------------------------- # # MARK: Show-ADTInstallationWelcome # #----------------------------------------------------------------------------- function Show-ADTInstallationWelcome { <# .SYNOPSIS Show a welcome dialog prompting the user with information about the installation and actions to be performed before the installation can begin. .DESCRIPTION The following prompts can be included in the welcome dialog: a) Close the specified running applications, or optionally close the applications without showing a prompt (using the -Silent switch). b) Defer the installation a certain number of times, for a certain number of days or until a deadline is reached. c) Countdown until applications are automatically closed. d) Prevent users from launching the specified applications while the installation is in progress. .PARAMETER CloseProcesses Name of the process to stop (do not include the .exe). Specify multiple processes separated by a comma. Specify custom descriptions like this: @{ Name = 'winword'; Description = 'Microsoft Office Word'},@{ Name = 'excel'; Description = 'Microsoft Office Excel'} .PARAMETER Silent Stop processes without prompting the user. .PARAMETER CloseProcessesCountdown Option to provide a countdown in seconds until the specified applications are automatically closed. This only takes effect if deferral is not allowed or has expired. .PARAMETER ForceCloseProcessesCountdown Option to provide a countdown in seconds until the specified applications are automatically closed regardless of whether deferral is allowed. .PARAMETER PromptToSave Specify whether to prompt to save working documents when the user chooses to close applications by selecting the "Close Programs" button. Option does not work in SYSTEM context unless toolkit launched with "psexec.exe -s -i" to run it as an interactive process under the SYSTEM account. .PARAMETER PersistPrompt Specify whether to make the Show-ADTInstallationWelcome prompt persist in the center of the screen every couple of seconds, specified in the AppDeployToolkitConfig.xml. The user will have no option but to respond to the prompt. This only takes effect if deferral is not allowed or has expired. .PARAMETER BlockExecution Option to prevent the user from launching processes/applications, specified in -CloseProcesses, during the installation. .PARAMETER AllowDefer Enables an optional defer button to allow the user to defer the installation. .PARAMETER AllowDeferCloseProcesses Enables an optional defer button to allow the user to defer the installation only if there are running applications that need to be closed. This parameter automatically enables -AllowDefer .PARAMETER DeferTimes Specify the number of times the installation can be deferred. .PARAMETER DeferDays Specify the number of days since first run that the installation can be deferred. This is converted to a deadline. .PARAMETER DeferDeadline Specify the deadline date until which the installation can be deferred. Specify the date in the local culture if the script is intended for that same culture. If the script is intended to run on EN-US machines, specify the date in the format: "08/25/2013" or "08-25-2013" or "08-25-2013 18:00:00" If the script is intended for multiple cultures, specify the date in the universal sortable date/time format: "2013-08-22 11:51:52Z" The deadline date will be displayed to the user in the format of their culture. .PARAMETER CheckDiskSpace Specify whether to check if there is enough disk space for the installation to proceed. If this parameter is specified without the RequiredDiskSpace parameter, the required disk space is calculated automatically based on the size of the script source and associated files. .PARAMETER RequiredDiskSpace Specify required disk space in MB, used in combination with CheckDiskSpace. .PARAMETER NoMinimizeWindows Specifies whether to minimize other windows when displaying prompt. Default: $false. .PARAMETER TopMost Specifies whether the windows is the topmost window. Default: $true. .PARAMETER ForceCountdown Specify a countdown to display before automatically proceeding with the installation when a deferral is enabled. .PARAMETER CustomText Specify whether to display a custom message specified in the XML file. Custom message must be populated for each language section in the XML. .INPUTS None You cannot pipe objects to this function. .OUTPUTS None This function does not return any output. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses iexplore, winword, excel Prompt the user to close Internet Explorer, Word and Excel. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses @{ Name = 'winword' }, @{ Name = 'excel' } -Silent Close Word and Excel without prompting the user. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses @{ Name = 'winword' }, @{ Name = 'excel' } -BlockExecution Close Word and Excel and prevent the user from launching the applications while the installation is in progress. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses @{ Name = 'winword'; Description = 'Microsoft Office Word' }, @{ Name = 'excel'; Description = 'Microsoft Office Excel' } -CloseProcessesCountdown 600 Prompt the user to close Word and Excel, with customized descriptions for the applications and automatically close the applications after 10 minutes. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses @{ Name = 'winword' }, @{ Name = 'msaccess' }, @{ Name = 'excel' } -PersistPrompt Prompt the user to close Word, MSAccess and Excel. By using the PersistPrompt switch, the dialog will return to the center of the screen every couple of seconds, specified in the AppDeployToolkitConfig.xml, so the user cannot ignore it by dragging it aside. .EXAMPLE Show-ADTInstallationWelcome -AllowDefer -DeferDeadline '25/08/2013' Allow the user to defer the installation until the deadline is reached. .EXAMPLE Show-ADTInstallationWelcome -CloseProcesses @{ Name = 'winword' }, @{ Name = 'excel' } -BlockExecution -AllowDefer -DeferTimes 10 -DeferDeadline '25/08/2013' -CloseProcessesCountdown 600 Close Word and Excel and prevent the user from launching the applications while the installation is in progress. Allow the user to defer the installation a maximum of 10 times or until the deadline is reached, whichever happens first. When deferral expires, prompt the user to close the applications and automatically close them after 10 minutes. .NOTES An active ADT session is NOT required to use this function. The process descriptions are retrieved via Get-Process, with a fall back on the process name if no description is available. Alternatively, you can specify the description yourself with a '=' symbol - see examples. The dialog box will timeout after the timeout specified in the XML configuration file (default 1 hour and 55 minutes) to prevent SCCM installations from timing out and returning a failure code to SCCM. When the dialog times out, the script will exit and return a 1618 code (SCCM fast retry code). Tags: psadt Website: https://psappdeploytoolkit.com Copyright: (C) 2024 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough). License: https://opensource.org/license/lgpl-3-0 .LINK https://psappdeploytoolkit.com #> [CmdletBinding(DefaultParameterSetName = 'None')] param ( [Parameter(Mandatory = $false, HelpMessage = 'Specify process names and an optional process description, e.g. @{ Name = "winword"; Description = "Microsoft Word"}')] [ValidateNotNullOrEmpty()] [PSADT.Types.ProcessObject[]]$CloseProcesses, [Parameter(Mandatory = $false, HelpMessage = 'Specify whether to prompt user or force close the applications.')] [System.Management.Automation.SwitchParameter]$Silent, [Parameter(Mandatory = $false, HelpMessage = 'Specify a countdown to display before automatically closing applications where deferral is not allowed or has expired.')] [ValidateNotNullOrEmpty()] [System.Double]$CloseProcessesCountdown, [Parameter(Mandatory = $false, HelpMessage = 'Specify a countdown to display before automatically closing applications whether or not deferral is allowed.')] [ValidateNotNullOrEmpty()] [System.UInt32]$ForceCloseProcessesCountdown, [Parameter(Mandatory = $false, HelpMessage = 'Specify whether to prompt to save working documents when the user chooses to close applications by selecting the "Close Programs" button.')] [System.Management.Automation.SwitchParameter]$PromptToSave, [Parameter(Mandatory = $false, HelpMessage = ' Specify whether to make the prompt persist in the center of the screen every couple of seconds, specified in the AppDeployToolkitConfig.xml.')] [System.Management.Automation.SwitchParameter]$PersistPrompt, [Parameter(Mandatory = $false, HelpMessage = ' Specify whether to block execution of the processes during installation.')] [System.Management.Automation.SwitchParameter]$BlockExecution, [Parameter(Mandatory = $false, HelpMessage = ' Specify whether to enable the optional defer button on the dialog box.')] [System.Management.Automation.SwitchParameter]$AllowDefer, [Parameter(Mandatory = $false, HelpMessage = ' Specify whether to enable the optional defer button on the dialog box only if an app needs to be closed.')] [System.Management.Automation.SwitchParameter]$AllowDeferCloseProcesses, [Parameter(Mandatory = $false, HelpMessage = 'Specify the number of times the deferral is allowed.')] [ValidateNotNullOrEmpty()] [System.Int32]$DeferTimes, [Parameter(Mandatory = $false, HelpMessage = 'Specify the number of days since first run that the deferral is allowed.')] [ValidateNotNullOrEmpty()] [System.UInt32]$DeferDays, [Parameter(Mandatory = $false, HelpMessage = 'Specify the deadline (in format dd/mm/yyyy) for which deferral will expire as an option.')] [ValidateNotNullOrEmpty()] [System.String]$DeferDeadline, [Parameter(Mandatory = $true, HelpMessage = 'Specify whether to check if there is enough disk space for the installation to proceed. If this parameter is specified without the RequiredDiskSpace parameter, the required disk space is calculated automatically based on the size of the script source and associated files.', ParameterSetName = 'CheckDiskSpace')] [System.Management.Automation.SwitchParameter]$CheckDiskSpace, [Parameter(Mandatory = $false, HelpMessage = 'Specify required disk space in MB, used in combination with $CheckDiskSpace.', ParameterSetName = 'CheckDiskSpace')] [ValidateNotNullOrEmpty()] [System.UInt32]$RequiredDiskSpace, [Parameter(Mandatory = $false, HelpMessage = 'Specify whether to minimize other windows when displaying prompt.')] [System.Management.Automation.SwitchParameter]$NoMinimizeWindows, [Parameter(Mandatory = $false, HelpMessage = 'Specifies whether the window is the topmost window.')] [System.Management.Automation.SwitchParameter]$NotTopMost, [Parameter(Mandatory = $false, HelpMessage = 'Specify a countdown to display before automatically proceeding with the installation when a deferral is enabled.')] [ValidateNotNullOrEmpty()] [System.UInt32]$ForceCountdown, [Parameter(Mandatory = $false, HelpMessage = 'Specify whether to display a custom message specified in the XML file. Custom message must be populated for each language section in the XML.')] [System.Management.Automation.SwitchParameter]$CustomText ) dynamicparam { # Initialize variables. $adtSession = Initialize-ADTModuleIfUnitialized -Cmdlet $PSCmdlet $adtStrings = Get-ADTStringTable $adtConfig = Get-ADTConfig # Define parameter dictionary for returning at the end. $paramDictionary = [System.Management.Automation.RuntimeDefinedParameterDictionary]::new() # Add in parameters we need as mandatory when there's no active ADTSession. $paramDictionary.Add('Title', [System.Management.Automation.RuntimeDefinedParameter]::new( 'Title', [System.String], $( [System.Management.Automation.ParameterAttribute]@{ Mandatory = !$adtSession; HelpMessage = "Title of the prompt. Default: the application installation name." } [System.Management.Automation.ValidateNotNullOrEmptyAttribute]::new() ) )) $paramDictionary.Add('Subtitle', [System.Management.Automation.RuntimeDefinedParameter]::new( 'Subtitle', [System.String], $( [System.Management.Automation.ParameterAttribute]@{ Mandatory = !$adtSession -and ($adtConfig.UI.DialogStyle -eq 'Fluent'); HelpMessage = "Subtitle of the prompt. Default: the application deployment type." } [System.Management.Automation.ValidateNotNullOrEmptyAttribute]::new() ) )) $paramDictionary.Add('DeploymentType', [System.Management.Automation.RuntimeDefinedParameter]::new( 'DeploymentType', [System.String], $( [System.Management.Automation.ParameterAttribute]@{ Mandatory = !$adtSession -and ($adtConfig.UI.DialogStyle -eq 'Classic'); HelpMessage = "The deployment type. Default: the session's DeploymentType value." } [System.Management.Automation.ValidateSetAttribute]::new($adtStrings.DeploymentType.Keys) ) )) # Return the populated dictionary. return $paramDictionary } begin { # Initialize function. Initialize-ADTFunction -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState $adtEnv = Get-ADTEnvironment # Set up defaults if not specified. if (!$PSBoundParameters.ContainsKey('Title')) { $PSBoundParameters.Add('Title', $adtSession.InstallTitle) } if (!$PSBoundParameters.ContainsKey('Subtitle')) { $PSBoundParameters.Add('Subtitle', [System.String]::Format($adtStrings.WelcomePrompt.Fluent.Subtitle, $adtSession.DeploymentType)) } if (!$PSBoundParameters.ContainsKey('DeploymentType')) { $PSBoundParameters.Add('DeploymentType', $adtSession.DeploymentType) } # Instantiate new object to hold all data needed within this call. $welcomeState = [PSADT.Types.WelcomeState]::new() $deferDeadlineUniversal = $null $promptResult = $null } process { try { try { # If running in NonInteractive mode, force the processes to close silently. if ($adtSession -and $adtSession.IsNonInteractive()) { $Silent = $true } # If using Zero-Config MSI Deployment, append any executables found in the MSI to the CloseProcesses list if ($adtSession -and ($msiExecutables = $adtSession.GetDefaultMsiExecutablesList())) { $CloseProcesses = $(if ($CloseProcesses) { $CloseProcesses }; $msiExecutables) } # Check disk space requirements if specified if ($adtSession -and $CheckDiskSpace) { Write-ADTLogEntry -Message 'Evaluating disk space requirements.' if (!$RequiredDiskSpace) { try { # Determine the size of the Files folder $fso = New-Object -ComObject Scripting.FileSystemObject $RequiredDiskSpace = [System.Math]::Round($fso.GetFolder($adtSession.ScriptDirectory).Size / 1MB) } catch { Write-ADTLogEntry -Message "Failed to calculate disk space requirement from source files.`n$(Resolve-ADTErrorRecord -ErrorRecord $_)" -Severity 3 } finally { $null = try { [System.Runtime.InteropServices.Marshal]::ReleaseComObject($fso) } catch { $null } } } if (($freeDiskSpace = Get-ADTFreeDiskSpace) -lt $RequiredDiskSpace) { Write-ADTLogEntry -Message "Failed to meet minimum disk space requirement. Space Required [$RequiredDiskSpace MB], Space Available [$freeDiskSpace MB]." -Severity 3 if (!$Silent) { Show-ADTInstallationPrompt -Message ((Get-ADTStringTable).DiskSpace.Message -f $PSBoundParameters.Title, $RequiredDiskSpace, $freeDiskSpace) -ButtonRightText OK -Icon Error } Close-ADTSession -ExitCode $adtConfig.UI.DefaultExitCode } Write-ADTLogEntry -Message 'Successfully passed minimum disk space requirement check.' } # Check Deferral history and calculate remaining deferrals. if ($AllowDefer -or $AllowDeferCloseProcesses) { # Set $AllowDefer to true if $AllowDeferCloseProcesses is true. $AllowDefer = $true # Get the deferral history from the registry. $deferHistory = if ($adtSession) { Get-ADTDeferHistory } $deferHistoryTimes = $deferHistory | Select-Object -ExpandProperty DeferTimesRemaining -ErrorAction Ignore $deferHistoryDeadline = $deferHistory | Select-Object -ExpandProperty DeferDeadline -ErrorAction Ignore # Reset switches. $checkDeferDays = $DeferDays -ne 0 $checkDeferDeadline = !!$DeferDeadline if ($DeferTimes -ne 0) { $DeferTimes = if ($deferHistoryTimes -ge 0) { Write-ADTLogEntry -Message "Defer history shows [$($deferHistory.DeferTimesRemaining)] deferrals remaining." $deferHistory.DeferTimesRemaining - 1 } else { Write-ADTLogEntry -Message "The user has [$DeferTimes] deferrals remaining." $DeferTimes - 1 } if ($DeferTimes -lt 0) { Write-ADTLogEntry -Message 'Deferral has expired.' $AllowDefer = $false } } if ($checkDeferDays -and $AllowDefer) { $deferDeadlineUniversal = if ($deferHistoryDeadline) { Write-ADTLogEntry -Message "Defer history shows a deadline date of [$deferHistoryDeadline]." Get-ADTUniversalDate -DateTime $deferHistoryDeadline } else { Get-ADTUniversalDate -DateTime ([System.DateTime]::Now.AddDays($DeferDays).ToString([System.Globalization.DateTimeFormatInfo]::CurrentInfo.UniversalSortableDateTimePattern)) } Write-ADTLogEntry -Message "The user has until [$deferDeadlineUniversal] before deferral expires." if ((Get-ADTUniversalDate) -gt $deferDeadlineUniversal) { Write-ADTLogEntry -Message 'Deferral has expired.' $AllowDefer = $false } } if ($checkDeferDeadline -and $AllowDefer) { # Validate date. try { $deferDeadlineUniversal = Get-ADTUniversalDate -DateTime $DeferDeadline Write-ADTLogEntry -Message "The user has until [$deferDeadlineUniversal] remaining." if ((Get-ADTUniversalDate) -gt $deferDeadlineUniversal) { Write-ADTLogEntry -Message 'Deferral has expired.' $AllowDefer = $false } } catch { Invoke-ADTFunctionErrorHandler -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState -ErrorRecord $_ -LogMessage "Date is not in the correct format for the current culture. Type the date in the current locale format, such as 20/08/2014 (Europe) or 08/20/2014 (United States). If the script is intended for multiple cultures, specify the date in the universal sortable date/time format, e.g. '2013-08-22 11:51:52Z'." } } } if (($DeferTimes -lt 0) -and !$deferDeadlineUniversal) { $AllowDefer = $false } # Prompt the user to close running applications and optionally defer if enabled. if (!$Silent -and (!$adtSession -or !$adtSession.IsSilent())) { # Keep the same variable for countdown to simplify the code. if ($ForceCloseProcessesCountdown -gt 0) { $CloseProcessesCountdown = $ForceCloseProcessesCountdown } elseif ($ForceCountdown -gt 0) { $CloseProcessesCountdown = $ForceCountdown } $welcomeState.CloseProcessesCountdown = $CloseProcessesCountdown while (($runningProcesses = Get-ADTRunningProcesses -ProcessObjects $CloseProcesses) -or (($promptResult -ne 'Defer') -and ($promptResult -ne 'Close'))) { # Get all unique running process descriptions. $welcomeState.RunningProcessDescriptions = $runningProcesses | Select-Object -ExpandProperty ProcessDescription | Sort-Object -Unique # Define parameters for welcome prompt. $promptParams = @{ WelcomeState = $welcomeState Title = $PSBoundParameters.Title Subtitle = $PSBoundParameters.Subtitle DeploymentType = $PSBoundParameters.DeploymentType CloseProcessesCountdown = $welcomeState.CloseProcessesCountdown ForceCloseProcessesCountdown = !!$ForceCloseProcessesCountdown ForceCountdown = !!$ForceCountdown PersistPrompt = $PersistPrompt NoMinimizeWindows = $NoMinimizeWindows CustomText = $CustomText NotTopMost = $NotTopMost } if ($CloseProcesses) { $promptParams.Add('ProcessObjects', $CloseProcesses) } # Check if we need to prompt the user to defer, to defer and close apps, or not to prompt them at all if ($AllowDefer) { # If there is deferral and closing apps is allowed but there are no apps to be closed, break the while loop. if ($AllowDeferCloseProcesses -and !$welcomeState.RunningProcessDescriptions) { break } elseif (($promptResult -ne 'Close') -or ($welcomeState.RunningProcessDescriptions -and ($promptResult -ne 'Continue'))) { # Otherwise, as long as the user has not selected to close the apps or the processes are still running and the user has not selected to continue, prompt user to close running processes with deferral. $deferParams = @{ AllowDefer = $true; DeferTimes = $DeferTimes }; if ($deferDeadlineUniversal) { $deferParams.Add('DeferDeadline', $deferDeadlineUniversal) } $promptResult = & $Script:CommandTable."Show-ADTWelcomePrompt$($adtConfig.UI.DialogStyle)" @promptParams @deferParams } } elseif ($welcomeState.RunningProcessDescriptions -or !!$forceCountdown) { # If there is no deferral and processes are running, prompt the user to close running processes with no deferral option. $promptResult = & $Script:CommandTable."Show-ADTWelcomePrompt$($adtConfig.UI.DialogStyle)" @promptParams } else { # If there is no deferral and no processes running, break the while loop. break } # Process the form results. if ($promptResult -eq 'Continue') { # If the user has clicked OK, wait a few seconds for the process to terminate before evaluating the running processes again. Write-ADTLogEntry -Message 'The user selected to continue...' if (!$runningProcesses) { # Break the while loop if there are no processes to close and the user has clicked OK to continue. break } [System.Threading.Thread]::Sleep(2000) } elseif ($promptResult -eq 'Close') { # Force the applications to close. Write-ADTLogEntry -Message 'The user selected to force the application(s) to close...' if ($PromptToSave -and $adtEnv.SessionZero -and !$adtEnv.IsProcessUserInteractive) { Write-ADTLogEntry -Message 'Specified [-PromptToSave] option will not be available, because current process is running in session zero and is not interactive.' -Severity 2 } # Update the process list right before closing, in case it changed. $AllOpenWindows = Get-ADTWindowTitle -GetAllWindowTitles -InformationAction SilentlyContinue $PromptToSaveTimeout = [System.TimeSpan]::FromSeconds($adtConfig.UI.PromptToSaveTimeout) $PromptToSaveStopWatch = [System.Diagnostics.StopWatch]::new() foreach ($runningProcess in ($runningProcesses = Get-ADTRunningProcesses -ProcessObject $CloseProcesses -InformationAction SilentlyContinue)) { # If the PromptToSave parameter was specified and the process has a window open, then prompt the user to save work if there is work to be saved when closing window. if ($PromptToSave -and !($adtEnv.SessionZero -and !$adtEnv.IsProcessUserInteractive) -and ($AllOpenWindowsForRunningProcess = $AllOpenWindows | & { process { if ($_.ParentProcess -eq $runningProcess.ProcessName) { return $_ } } } | Select-Object -First 1) -and ($runningProcess.MainWindowHandle -ne [IntPtr]::Zero)) { foreach ($OpenWindow in $AllOpenWindowsForRunningProcess) { try { Write-ADTLogEntry -Message "Stopping process [$($runningProcess.ProcessName)] with window title [$($OpenWindow.WindowTitle)] and prompt to save if there is work to be saved (timeout in [$($adtConfig.UI.PromptToSaveTimeout)] seconds)..." $null = [PSADT.GUI.UiAutomation]::BringWindowToFront($OpenWindow.WindowHandle) if (!$runningProcess.CloseMainWindow()) { Write-ADTLogEntry -Message "Failed to call the CloseMainWindow() method on process [$($runningProcess.ProcessName)] with window title [$($OpenWindow.WindowTitle)] because the main window may be disabled due to a modal dialog being shown." -Severity 3 } else { $PromptToSaveStopWatch.Reset() $PromptToSaveStopWatch.Start() do { if (!($IsWindowOpen = $AllOpenWindows | & { process { if ($_.WindowHandle -eq $OpenWindow.WindowHandle) { return $_ } } } | Select-Object -First 1)) { break } [System.Threading.Thread]::Sleep(3000) } while (($IsWindowOpen) -and ($PromptToSaveStopWatch.Elapsed -lt $PromptToSaveTimeout)) if ($IsWindowOpen) { Write-ADTLogEntry -Message "Exceeded the [$($adtConfig.UI.PromptToSaveTimeout)] seconds timeout value for the user to save work associated with process [$($runningProcess.ProcessName)] with window title [$($OpenWindow.WindowTitle)]." -Severity 2 } else { Write-ADTLogEntry -Message "Window [$($OpenWindow.WindowTitle)] for process [$($runningProcess.ProcessName)] was successfully closed." } } } catch { Write-ADTLogEntry -Message "Failed to close window [$($OpenWindow.WindowTitle)] for process [$($runningProcess.ProcessName)].`n$(Resolve-ADTErrorRecord -ErrorRecord $_)" -Severity 3 } finally { $runningProcess.Refresh() } } } else { Write-ADTLogEntry -Message "Stopping process $($runningProcess.ProcessName)..." Stop-Process -Name $runningProcess.ProcessName -Force -ErrorAction Ignore } } if ($runningProcesses = Get-ADTRunningProcesses -ProcessObjects $CloseProcesses -InformationAction SilentlyContinue) { # Apps are still running, give them 2s to close. If they are still running, the Welcome Window will be displayed again. Write-ADTLogEntry -Message 'Sleeping for 2 seconds because the processes are still not closed...' [System.Threading.Thread]::Sleep(2000) } } elseif ($promptResult -eq 'Timeout') { # Stop the script (if not actioned before the timeout value). Write-ADTLogEntry -Message 'Installation not actioned before the timeout value.' $BlockExecution = $false if ($adtSession -and (($DeferTimes -ge 0) -or $deferDeadlineUniversal)) { Set-ADTDeferHistory -DeferTimesRemaining $DeferTimes -DeferDeadline $deferDeadlineUniversal } # Dispose the welcome prompt timer here because if we dispose it within the Show-ADTWelcomePrompt function we risk resetting the timer and missing the specified timeout period. if ($welcomeState.WelcomeTimer) { $welcomeState.WelcomeTimer.Dispose() $welcomeState.WelcomeTimer = $null } # Restore minimized windows. if (!$NoMinimizeWindows) { $null = $adtEnv.ShellApp.UndoMinimizeAll() } if ($adtSession) { Close-ADTSession -ExitCode $adtConfig.UI.DefaultExitCode } } elseif ($promptResult -eq 'Defer') { # Stop the script (user chose to defer) Write-ADTLogEntry -Message 'Installation deferred by the user.' $BlockExecution = $false Set-ADTDeferHistory -DeferTimesRemaining $DeferTimes -DeferDeadline $deferDeadlineUniversal # Restore minimized windows. if (!$NoMinimizeWindows) { $null = $adtEnv.ShellApp.UndoMinimizeAll() } if ($adtSession) { Close-ADTSession -ExitCode $adtConfig.UI.DeferExitCode } } } } # Force the processes to close silently, without prompting the user. if (($Silent -or ($adtSession -and $adtSession.IsSilent())) -and ($runningProcesses = Get-ADTRunningProcesses -ProcessObjects $CloseProcesses -InformationAction SilentlyContinue)) { Write-ADTLogEntry -Message "Force closing application(s) [$(($runningProcesses.ProcessDescription | Sort-Object -Unique) -join ',')] without prompting user." $runningProcesses | Stop-Process -Force -ErrorAction Ignore [System.Threading.Thread]::Sleep(2000) } # If block execution switch is true, call the function to block execution of these processes. if ($BlockExecution -and $CloseProcesses) { Write-ADTLogEntry -Message '[-BlockExecution] parameter specified.' Block-ADTAppExecution -ProcessName $CloseProcesses.Name } } catch { Write-Error -ErrorRecord $_ } } catch { Invoke-ADTFunctionErrorHandler -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState -ErrorRecord $_ } } end { Complete-ADTFunction -Cmdlet $PSCmdlet } } |