<# =========================================================================== Created on: 22/07/2020 11:04 Created by: Ben Whitmore Filename: Toast_Notify.ps1 =========================================================================== Version 1.2.28 - 28/01/2021 -For AzureAD Joined computers we now try and grab a name to display in the Toast by getting the owner of the process Explorer.exe -Better error handling when Get-xx fails Version 1.2.26 - 26/01/2021 -Changed the Scheduled Task to run as -GroupId "S-1-5-32-545" (USERS). When Toast_Notify.ps1 is deployed as SYSTEM, the scheduled task will be created to run in the context of the Group "Users". This means the Toast will pop for the logged on user even if the username was unobtainable (During testing AzureAD Joined Computers did not populate (Win32_ComputerSystem).Username). The Toast will also be staged in the $ENV:Windir "Temp\$($ToastGuid)" folder if the logged on user information could not be found. Thanks @CodyMathis123 for the inspiration via https://github.com/CodyMathis123/CM-Ramblings/blob/master/New-PostTeamsMachineWideInstallScheduledTask.ps1 Version 1.2.14 - 14/01/21 -Fixed logic to return logged on DisplayName - Thanks @MMelkersen -Changed the way we retrieve the SID for the current user variable $LoggedOnUserSID -Added Event Title, Description and Source Path to the Scheduled Task that is created to pop the User Toast -Fixed an issue where Snooze was not being passed from the Scheduled Task -Fixed an issue with XMLSource full path not being returned correctly from Scheduled Task Version 1.2.10 - 10/01/21 -Removed XMLOtherSource Parameter -Cleaned up XML formatting which removed unnecessary duplication when the Snooze parameter was passed. Action ChildNodes are now appended to ToastTemplate XML. Version 1.2 - 09/01/21 -Added logic so if the script is deployed as SYSTEM it will create a scheduled task to run the script for the current logged on user. -Special Thanks to: - -Inspiration for creating a Scheduled Task for Toasts @PaulWetter https://wetterssource.com/ondemandtoast -Inspiration for running Toasts in User Context @syst_and_deploy http://www.systanddeploy.com/2020/11/display-simple-toast-notification-for.html -Inspiration for creating scheduled tasks for the logged on user @ccmexec via Community Hub in ConfigMgr https://github.com/Microsoft/configmgr-hub/commit/e4abdc0d3105afe026211805f13cf533c8de53c4 Version 1.1 - 30/12/20 -Added Snooze Switch option Version 1.0 - 22/07/20 -Release .SYNOPSIS The purpose of the script is to create simple Toast Notifications in Windows 10 .DESCRIPTION Toast_Notify.ps1 will read an XML file so Toast Notifications can be changed "on the fly" without having to repackage an application. The CustomMessage.xml file can be hosted on a fileshare. To create a custom XML, copy CustomMessage.xml and edit the text you want to disaply in the toast notification. The following files should be present in the Script Directory Toast_Notify.ps1 BadgeImage.jpg HeroImage.jpg CustomMessage.xml .PARAMETER XMLSource Specify the name of the XML file to read. The XML file must exist in the same directory as Toast_Notify.ps1. If no parameter is passed, it is assumed the XML file is called CustomMessage.xml. .PARAMETER Snooze Add a snooze option to the Toast .EXAMPLE Toast_Notify.ps1 -XMLSource "PhoneSystemProblems.xml" .EXAMPLE Toast_Notify.ps1 -Snooze #> Param ( [Parameter(Mandatory = $False)] [Switch]$Snooze, [String]$XMLSource = "CustomMessage.xml", [String]$ToastGUID ) #Set Unique GUID for the Toast If (!($ToastGUID)) { $ToastGUID = ([guid]::NewGuid()).ToString().ToUpper() } #Current Directory $ScriptPath = $MyInvocation.MyCommand.Path $CurrentDir = Split-Path $ScriptPath #Get Logged On User to prepare Scheduled Task $LoggedOnUserName = (Get-CimInstance -Namespace "root\cimv2" -ClassName Win32_ComputerSystem).Username Try { $LoggedOnUserSID = ([System.Security.Principal.NTAccount]($LoggedOnUserName)).Translate([System.Security.Principal.SecurityIdentifier]).Value } Catch { Write-Warning "Could not get User SID because Username could not be obtained from Win32_ComputerSystem" } # Get Profile Path for LoggedOnUser Try { #Set Toast Path to UserProfile Temp Directory $LocalUserPath = (Get-CimInstance -Namespace "root\cimv2" -ClassName "Win32_UserProfile" | Where-Object { $_.SID -eq $LoggedOnUserSID }).LocalPath If ($LocalUserPath){ $LoggedOnUserToastPath = (Join-Path $LocalUserPath "AppData\Local\Temp\$($ToastGuid)") } } Catch { Write-Warning "Error resolving Logged on User SID to a valid Profile Path" #Set Toast Path to C:\Windows\Temp if user profile path cannot be resolved $LoggedOnUserToastPath = (Join-Path $ENV:Windir "Temp\$($ToastGuid)") } #Test if XML exists if (!(Test-Path (Join-Path $CurrentDir $XMLSource))) { throw "$XMLSource is invalid." } #Check XML is valid $XMLToast = New-Object System.Xml.XmlDocument try { $XMLToast.Load((Get-ChildItem -Path (Join-Path $CurrentDir $XMLSource)).FullName) $XMLValid = $True } catch [System.Xml.XmlException] { Write-Verbose "$XMLSource : $($_.toString())" $XMLValid = $False } #Continue if XML is valid If ($XMLValid -eq $True) { #Create Toast Variables $ToastTitle = $XMLToast.ToastContent.ToastTitle $Signature = $XMLToast.ToastContent.Signature $EventTitle = $XMLToast.ToastContent.EventTitle $EventText = $XMLToast.ToastContent.EventText $ButtonTitle = $XMLToast.ToastContent.ButtonTitle $ButtonAction = $XMLToast.ToastContent.ButtonAction $SnoozeTitle = $XMLToast.ToastContent.SnoozeTitle #ToastDuration: Short = 7s, Long = 25s $ToastDuration = "long" #Images $BadgeImage = "file:///$CurrentDir/badgeimage.jpg" $HeroImage = "file:///$CurrentDir/heroimage.jpg" #Set COM App ID > To bring a URL on button press to focus use a browser for the appid e.g. MSEdge #$LauncherID = "Microsoft.SoftwareCenter.DesktopToasts" #$LauncherID = "{1AC14E77-02E7-4E5D-B744-2EB1AE5198B7}\WindowsPowerShell\v1.0\powershell.exe" $Launcherid = "MSEdge" #Dont Create a Scheduled Task if the script is running in the context of the logged on user, only if SYSTEM fired the script i.e. Deployment from Intune/ConfigMgr If (([System.Security.Principal.WindowsIdentity]::GetCurrent()).Name -eq "NT AUTHORITY\SYSTEM") { #Prepare to stage Toast Notification Content in %TEMP% Folder Try { #Create TEMP folder to stage Toast Notification Content in %TEMP% Folder New-Item $LoggedOnUserToastPath -ItemType Directory -Force -ErrorAction Continue | Out-Null $ToastFiles = Get-ChildItem $CurrentDir -Recurse #Copy Toast Files to Toat TEMP folder ForEach ($ToastFile in $ToastFiles) { Copy-Item (Join-Path $CurrentDir $ToastFile) -Destination $LoggedOnUserToastPath -ErrorAction Continue } } Catch { Write-Warning $_.Exception.Message } #Set new Toast script to run from TEMP path $New_ToastPath = Join-Path $LoggedOnUserToastPath "Toast_Notify.ps1" #Created Scheduled Task to run as Logged on User $Task_TimeToRun = (Get-Date).AddSeconds(30).ToString('s') $Task_Expiry = (Get-Date).AddSeconds(120).ToString('s') If ($Snooze) { $Task_Action = New-ScheduledTaskAction -Execute "C:\WINDOWS\system32\WindowsPowerShell\v1.0\PowerShell.exe" -Argument "-NoProfile -WindowStyle Hidden -File ""$New_ToastPath"" -ToastGUID ""$ToastGUID"" -Snooze" } else { $Task_Action = New-ScheduledTaskAction -Execute "C:\WINDOWS\system32\WindowsPowerShell\v1.0\PowerShell.exe" -Argument "-NoProfile -WindowStyle Hidden -File ""$New_ToastPath"" -ToastGUID ""$ToastGUID""" } $Task_Trigger = New-ScheduledTaskTrigger -Once -At $Task_TimeToRun $Task_Trigger.EndBoundary = $Task_Expiry $Task_Principal = New-ScheduledTaskPrincipal -GroupId "S-1-5-32-545" -RunLevel Limited $Task_Settings = New-ScheduledTaskSettingsSet -Compatibility V1 -DeleteExpiredTaskAfter (New-TimeSpan -Seconds 600) $New_Task = New-ScheduledTask -Description "Toast_Notification_$($LoggedOnUserSID)_$($ToastGuid) Task for user notification. Title: $($EventTitle) :: Event:$($EventText) :: Source Path: $($LoggedOnUserToastPath) " -Action $Task_Action -Principal $Task_Principal -Trigger $Task_Trigger -Settings $Task_Settings Register-ScheduledTask -TaskName "Toast_Notification_$($LoggedOnUserSID)_$($ToastGuid)" -InputObject $New_Task } #Run the toast of the script is running in the context of the Logged On User If (([System.Security.Principal.WindowsIdentity]::GetCurrent()).Name -eq $LoggedOnUserName) { #Get logged on user DisplayName Try { If (Get-Itemproperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Authentication\LogonUI" -Name "LastLoggedOnDisplayName" -ErrorAction SilentlyContinue) { $User = Get-Itemproperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Authentication\LogonUI" -Name "LastLoggedOnDisplayName" | Select-Object -ExpandProperty LastLoggedOnDisplayName If ($Null -eq $User) { $Firstname = $Null } else { $DisplayName = $User.Split(" ") $Firstname = $DisplayName[0] } } else { Try { $User = (Get-WmiObject -Namespace "root\cimv2" -ClassName Win32_Process | Where-Object {$_.Name -eq 'explorer.exe'}).GetOwner().User $User = (Get-Culture).textinfo.totitlecase($User) } Catch { Write-Warning "Could not get from owner of the process Explorer.exe or from Win32_ComputerSystem" } If ($User){ $Firstname = $User } else { $Firstname = $Null } } } Catch { Write-Warning "Warning: Registry value for LastLoggedOnDisplayName could not be found." $Firstname = $Null } #Get Hour of Day and set Custom Hello $Hour = (Get-Date).Hour If ($Hour -lt 12) { $CustomHello = "Good Morning $($Firstname)" } ElseIf ($Hour -gt 16) { $CustomHello = "Good Evening $($Firstname)" } Else { $CustomHello = "Good Afternoon $($Firstname)" } #Load Assemblies [Windows.UI.Notifications.ToastNotificationManager, Windows.UI.Notifications, ContentType = WindowsRuntime] | Out-Null [Windows.Data.Xml.Dom.XmlDocument, Windows.Data.Xml.Dom.XmlDocument, ContentType = WindowsRuntime] | Out-Null #Build XML ToastTemplate [xml]$ToastTemplate = @" $CustomHello $ToastTitle $Signature $EventTitle $EventText "@ #Build XML ActionTemplateSnooze (Used when $Snooze is passed as a parameter) [xml]$ActionTemplateSnooze = @" "@ #Build XML ActionTemplate (Used when $Snooze is not passed as a parameter) [xml]$ActionTemplate = @" "@ #If the Snooze parameter was passed, add additional XML elements to Toast If ($Snooze) { #Define default and snooze actions to be added $ToastTemplate $Action_Node = $ActionTemplateSnooze.toast.actions } else { #Define default actions to be added $ToastTemplate $Action_Node = $ActionTemplate.toast.actions } #Append actions to $ToastTemplate [void]$ToastTemplate.toast.AppendChild($ToastTemplate.ImportNode($Action_Node, $true)) #Prepare XML $ToastXml = [Windows.Data.Xml.Dom.XmlDocument]::New() $ToastXml.LoadXml($ToastTemplate.OuterXml) #Prepare and Create Toast $ToastMessage = [Windows.UI.Notifications.ToastNotification]::New($ToastXML) [Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($LauncherID).Show($ToastMessage) } }