Ansible
PS DSC
Downloads:
207
Downloads of v 1.1.0:
138
Last Update:
29 Sep 2023
Package Maintainer(s):
Software Author(s):
- Bill Curran
Tags:
bcurran3 unofficial choco toast notifications hook
(unofficial) Choco Toast Notifications (Hook)
- 1
- 2
- 3
1.1.0 | Updated: 29 Sep 2023
Downloads:
207
Downloads of v 1.1.0:
138
Maintainer(s):
Software Author(s):
- Bill Curran
(unofficial) Choco Toast Notifications (Hook) 1.1.0
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install (unofficial) Choco Toast Notifications (Hook), run the following command from the command line or from PowerShell:
>
To upgrade (unofficial) Choco Toast Notifications (Hook), run the following command from the command line or from PowerShell:
>
To uninstall (unofficial) Choco Toast Notifications (Hook), run the following command from the command line or from PowerShell:
>
Deployment Method:
NOTE
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download choco-toast-notifications.hook --internalize --source=https://community.chocolatey.org/api/v2/ -
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'" - Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade choco-toast-notifications.hook -y --source="'INTERNAL REPO URL'" [other options]See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade choco-toast-notifications.hook -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install choco-toast-notifications.hook
win_chocolatey:
name: choco-toast-notifications.hook
version: '1.1.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'choco-toast-notifications.hook' do
action :install
source 'INTERNAL REPO URL'
version '1.1.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller choco-toast-notifications.hook
{
Name = "choco-toast-notifications.hook"
Version = "1.1.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'choco-toast-notifications.hook':
ensure => '1.1.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
Package Approved
This package was approved by moderator Windos on 07 Oct 2023.
Description
choco://choco-toast-notifications.hook
To use choco:// protocol URLs, install (unofficial) choco:// Protocol support
Choco Toast Notifications Hook is a Chocolatey hook that displays a toast notification after installing, uninstalling, or upgrading a package.
Sound vaguely familiar? This hook supersedes, replaces, and expands upon my Chocolatey Toast Notifications Extension. Chocolatey Toast Notifications Hook is even better than the extension as it works with ALL packages no matter if they have a program installer or not. Chocolatey Toast Notifications Hook also determines the difference between installs and upgrades and reports such. It's pretty and Chocotastic!
PURPOSE:
- Chocogeeky fun!
FEATURES:
- Choco Toast Notifications Hook will display a toast notification with the package name, program name, version, status message (installed, uninstalled, or upgraded), and a link to the package page on the chocolatey.org website after a package is installed, uninstalled, or upgraded.
WHAT IT WON'T DO:
- Choco Toast Notifications Hook will NOT work on anything other than Windows 10 and 11, this is a limitation of the BurntToast PowerShell module and its use of the UWP Community Toolkit.
If you like this little hook, please consider donating: https://www.paypal.me/bcurran3donations or become a patron at https://www.patreon.com/bcurran3
Files
hook\post-install-all.ps1
$ErrorActionPreference = 'Continue'
# choco-toast-notifications.hook v1.1.0 (2023-09-29) Copyleft 2023 by Bill Curran AKA BCURRAN3
# LICENSE: GNU GPL v3 - https://www.gnu.org/licenses/gpl.html
# Suggestions? Problems? Open a GitHub issue at https://github.com/bcurran3/ChocolateyPackages/issues
# Create icon if it doesn't exist
if (!(Test-Path "$env:PUBLIC\Pictures\choco.ico")){
[System.Reflection.Assembly]::LoadWithPartialName('System.Drawing') | Out-Null
[System.Drawing.Icon]::ExtractAssociatedIcon("$env:ChocolateyInstall\choco.exe").ToBitmap().Save("$env:PUBLIC\Pictures\choco.ico")
}
# Check if upgrading or installing
if (Test-Path $env:ChocolateyInstall\lib-bkp\$env:chocolateyPackageName) {$chocolateyAction="UPGRADED"} else {$chocolateyAction="INSTALLED"}
# Check if WinRM is running (required to send Toast systemwide)
$WinRMStatus=(Get-Service 'WinRM').Status
# Send Toast systemwide if admin
if (Test-ProcessAdminRights) {
# Start WinRM if not Running
if ((Get-Service WinRM).Status -eq 'Stopped') {Start-Service 'WinRM' -ErrorAction SilentlyContinue}
# Show Toast notification
if ((Get-Service WinRM).Status -eq 'Running') {
Invoke-Command -ComputerName $(hostname) -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
} else {
Write-Host "** Can't send global choco-toast-notifications because WinRM service is not running." -Foreground Yellow
Invoke-Command -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
}
# Stop WinRM if it was previously in Stopped state
if ($WinRMStatus -eq 'Stopped') {Stop-Service 'WinRM' -ErrorAction SilentlyContinue}
} else {
# Show Toast notification to running user if non-admin
Invoke-Command -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
}
hook\post-uninstall-all.ps1
$ErrorActionPreference = 'Continue'
# choco-toast-notifications.hook v1.1.0 (2023-09-29) Copyleft 2023 by Bill Curran AKA BCURRAN3
# LICENSE: GNU GPL v3 - https://www.gnu.org/licenses/gpl.html
# Suggestions? Problems? Open a GitHub issue at https://github.com/bcurran3/ChocolateyPackages/issues
$chocolateyAction="UNINSTALLED"
# Create icon if it doesn't exist
if (!(Test-Path "$env:PUBLIC\Pictures\choco.ico")){
[System.Reflection.Assembly]::LoadWithPartialName('System.Drawing') | Out-Null
[System.Drawing.Icon]::ExtractAssociatedIcon("$env:ChocolateyInstall\choco.exe").ToBitmap().Save("$env:PUBLIC\Pictures\choco.ico")
}
# Check if WinRM is running (required to send Toast systemwide)
$WinRMStatus=(Get-Service 'WinRM').Status
# Send Toast systemwide if admin
if (Test-ProcessAdminRights) {
# Start WinRM if not Running
if ((Get-Service WinRM).Status -eq 'Stopped') {Start-Service 'WinRM' -ErrorAction SilentlyContinue}
# Show Toast notification
if ((Get-Service WinRM).Status -eq 'Running') {
Invoke-Command -ComputerName $(hostname) -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
} else {
Write-Host "** Can't send global choco-toast-notifications because WinRM service is not running." -Foreground Yellow
Invoke-Command -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
}
# Stop WinRM if it was previously in Stopped state
if ($WinRMStatus -eq 'Stopped') {Stop-Service 'WinRM' -ErrorAction SilentlyContinue}
} else {
# Show Toast notification to running user if non-admin
Invoke-Command -ArgumentList $env:chocolateyPackageName,$env:chocolateyPackageTitle,$env:chocolateyPackageVersion,$chocolateyAction -ScriptBlock {param([string]$chocolateyPackageName, [string]$chocolateyPackageTitle, [string]$chocolateyPackageVersion, [string]$chocolateyAction) Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; New-BurntToastNotification -Text "Chocolatey ($chocolateyPackageName)", "$chocolateyPackageTitle v$chocolateyPackageVersion `n$chocolateyAction." -Button (New-BTButton -Content 'Package Webpage' -Arguments "https://community.chocolatey.org/packages/$chocolateyPackageName") -AppLogo "$env:PUBLIC\Pictures\choco.ico"}
}
Virus Scan Results
Log in or click on link to see number of positives.
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Version History
| Add to Builder | Version | Downloads | Last Updated | Status |
|---|---|---|---|---|
| (unofficial) Choco Toast Notifications (Hook) 1.1.0 | 138 | Friday, September 29, 2023 | Approved | |
| (unofficial) Choco Toast Notifications (Hook) 1.0.0 | 69 | Tuesday, August 22, 2023 | Approved |
Copyright
Copyleft Bill Curran
Release Notes
CHANGELOG:
- 1.1.0 - Minor aestetics change - installed/uninstalled/upgraded moved to seperate line, should now always bypass Powershell Execution Policy, now sends toast to running user if it fails to send systemwide
- 1.0.0 - initial release
ROADMAP:
- No future development planned, only maintenance as needed. (BurntToast v1.0 will require an update.)
Dependencies
-
- burnttoast-psmodule (≥ 0.6.2 && ≤ 1.0.0)
- chocolatey (≥ 1.2.0)
Discussion for the (unofficial) Choco Toast Notifications (Hook) Package
Ground Rules:
- This discussion is only about (unofficial) Choco Toast Notifications (Hook) and the (unofficial) Choco Toast Notifications (Hook) package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or (unofficial) Choco Toast Notifications (Hook), or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.