Version 1.2 - 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

If the Toast script is deployed in the SYSTEM context, the script source is copied to a new folder in the users %TEMP% Directory.

The folder is given a unique GUID name.

A scheduled task is created for the current logged on user and is unique for the each time the Toast Script is deployed. Each scheduled task is named using the User SID and the unique Task GUID.

If the script is deployed to the current logged on user, a scheduled task is not created and the script is run as normal
This commit is contained in:
Ben Whitmore 2021-01-09 14:24:35 +00:00
parent f7fa13de2e
commit 8abfe35abd

View file

@ -5,6 +5,20 @@ Created by: Ben Whitmore
Filename: Toast_Notify.ps1 Filename: Toast_Notify.ps1
=========================================================================== ===========================================================================
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 .SYNOPSIS
The purpose of the script is to create simple Toast Notifications in Windows 10 The purpose of the script is to create simple Toast Notifications in Windows 10
@ -23,6 +37,9 @@ Specify the name of the XML file to read. The XML file must exist in the same di
.PARAMETER XMLOtherSource .PARAMETER XMLOtherSource
Specify the location of the Custom XML file used for the Toast when it is not in the same directory as the Toast_Notify.ps1 script Specify the location of the Custom XML file used for the Toast when it is not in the same directory as the Toast_Notify.ps1 script
.PARAMETER Snooze
Add a snooze option to the Toast
.EXAMPLE .EXAMPLE
Toast_Notify.ps1 -XMLOtherSource "\\fileserverhome\xml\CustomMessage.xml" Toast_Notify.ps1 -XMLOtherSource "\\fileserverhome\xml\CustomMessage.xml"
@ -30,7 +47,7 @@ Toast_Notify.ps1 -XMLOtherSource "\\fileserverhome\xml\CustomMessage.xml"
Toast_Notify.ps1 -XMLSciptDirSource "PhoneSystemProblems.xml" Toast_Notify.ps1 -XMLSciptDirSource "PhoneSystemProblems.xml"
.EXAMPLE .EXAMPLE
Toast_Notify.ps1 Toast_Notify.ps1 -Snooze
#> #>
Param Param
@ -38,10 +55,15 @@ Param
[Parameter(Mandatory = $False)] [Parameter(Mandatory = $False)]
[Switch]$Snooze, [Switch]$Snooze,
[String]$XMLScriptDirSource = "CustomMessage.xml", [String]$XMLScriptDirSource = "CustomMessage.xml",
[String]$XMLOtherSource [String]$XMLOtherSource,
[String]$ToastGUID
) )
#Set Unique GUID for Toast if it is not passed to the script. This should only happen from the Scheduled Task
If (!($ToastGUID)){
$ToastGUID = ([guid]::NewGuid()).ToString().ToUpper()
}
#Current Directory #Current Directory
$ScriptPath = $MyInvocation.MyCommand.Path $ScriptPath = $MyInvocation.MyCommand.Path
$CurrentDir = Split-Path $ScriptPath $CurrentDir = Split-Path $ScriptPath
@ -54,24 +76,89 @@ else {
$XMLPath = $XMLOtherSource $XMLPath = $XMLOtherSource
} }
#Test if XML exists #Get Logged On User to prepare Scheduled Task
if (!(Test-Path -Path $XMLPath)) { $LoggedOnUserName = (Get-CimInstance -Namespace "root\cimv2" -ClassName Win32_ComputerSystem).Username
throw "$XMLPath is invalid." $LoggedOnUserSID = (Get-CimInstance -Namespace "root\cimv2" -ClassName Win32_UserAccount | Where-Object { $_.Caption -eq $LoggedOnUserName }).SID
#Get list of User Profiles
$ProfilePath = Get-CimInstance -Namespace "root\cimv2" -ClassName "Win32_UserProfile"
# Get Profile Path for LoggedOnUser
Foreach ($Profile in $ProfilePath) {
Try {
If ($LoggedOnUserSID -eq $Profile.SID) {
#Set Toast Path to UserProfile Temp Directory
$LoggedOnUserToastPath = (Join-Path $Profile.LocalPath "AppData\Local\Temp\$($ToastGuid)")
}
}
Catch {
Write-Warning $_.Exception.Message
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)")
}
} }
#Check XML is valid #Create TEMP folder to stage Toast Notification Content in %TEMP% Folder
$XMLToast = New-Object System.Xml.XmlDocument Try {
try { New-Item $LoggedOnUserToastPath -ItemType Directory -ErrorAction Continue | Out-Null
Try {
$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
}
}
Catch {
Write-Warning $_.Exception.Message
}
#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") {
#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')
$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 -UserId $LoggedOnUserName -LogonType ServiceAccount
$Task_Settings = New-ScheduledTaskSettingsSet -Compatibility V1 -DeleteExpiredTaskAfter (New-TimeSpan -Seconds 600)
$New_Task = New-ScheduledTask -Description "Toast_Notififcation_$($LoggedOnUserSID)_$($ToastGuid) Task for user notification" -Action $Task_Action -Principal $Task_Principal -Trigger $Task_Trigger -Settings $Task_Settings
Register-ScheduledTask -TaskName "Toast_Notififcation_$($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) {
#Test if XML exists
if (!(Test-Path -Path $XMLPath)) {
throw "$XMLPath is invalid."
}
#Check XML is valid
$XMLToast = New-Object System.Xml.XmlDocument
try {
$XMLToast.Load((Get-ChildItem -Path $XMLPath).FullName) $XMLToast.Load((Get-ChildItem -Path $XMLPath).FullName)
$XMLValid = $True $XMLValid = $True
} }
catch [System.Xml.XmlException] { catch [System.Xml.XmlException] {
Write-Verbose "$XMLPath : $($_.toString())" Write-Verbose "$XMLPath : $($_.toString())"
$XMLValid = $False $XMLValid = $False
} }
#Continue if XML is valid #Continue if XML is valid
If ($XMLValid -eq $True) { If ($XMLValid -eq $True) {
#Read XML Nodes #Read XML Nodes
[XML]$Toast = Get-Content $XMLPath [XML]$Toast = Get-Content $XMLPath
@ -208,4 +295,5 @@ If ($XMLValid -eq $True) {
#Prepare and Create Toast #Prepare and Create Toast
$ToastMessage = [Windows.UI.Notifications.ToastNotification]::New($ToastXML) $ToastMessage = [Windows.UI.Notifications.ToastNotification]::New($ToastXML)
[Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($LauncherID).Show($ToastMessage) [Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($LauncherID).Show($ToastMessage)
}
} }