Notices: This section not yet converted to new layout. Download stats are rolling back out.

Chocolatey Misc Helpers Extension

0.0.3.1

Package test results are passing.

This package was approved by moderator gep13 on 1/14/2019.


choco://chocolatey-misc-helpers.extension
To use choco:// protocol URLs, install (unofficial) choco:// Protocol support


chocolatey-misc-helpers.extension provides helper functions to be used in Chocolatey install/uninstall scripts by package creators/maintainers.

These didn't fit into the concept scope of my other extensions so I started this miscellaneous collection and will add to it as "needed."

HELPERS:

  • Start-CheckandStop - Checks for and stops a process if running. Creates variables to easily restart the process after a package upgrade. Useful for installers that fail if the program is running, i.e. KeePass, uTorrent, etc. or for stopping programs that automatically run after install, i.e. Skype, SuMo, Ellp, etc. as well as for programs that will stop running during an upgrade and then not return to a running state post upgrade, i.e. Plex Media Server, etc. Screenshot
  • Start-CheckandThrow - Checks if a process is running and aborts installation/upgrade if so. Screenshot
  • Start-WaitandStop - Starts a background process to stop a (foreground) process - quits after 5 minutes or after the process gets stopped. Useful to stop additional pop-up programs during installation. Screenshot
  • Start-WaitandStopActual - (do not directly use) Called by Start-WaitandStop to make Start-WaitandStop simple to use.
  • Test-Dependency - Provides a way to verify a dependency is installed. Does NOT check version. Returns True/False. Screenshot
  • Read comments in the scripts for help implementing.

USAGE:

  • Start-CheckandStop "ProcessName"
  • Start-CheckandThrow "ProcessName"
  • Start-WaitandStop "ProcessName"
  • Test-Dependency "DependencyPackageName"

Click here to Patreon-ize the package maintainer.


To install Chocolatey Misc Helpers Extension, run the following command from the command line or from PowerShell:

C:\> choco install chocolatey-misc-helpers.extension

To upgrade Chocolatey Misc Helpers Extension, run the following command from the command line or from PowerShell:

C:\> choco upgrade chocolatey-misc-helpers.extension

Files

Hide
  • extensions\Test-Dependency.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Tests to verify a dependency is installed and returns true/false. Does NOT check version. 
    # Designed for use with my OS dependency packages but can be used for anything to verify that SOME VERISION 
    # of the dependency is installed; i.e. Chocolatey v0.10.11 will continue trying to install a package even
    # if the dependency fails installation. Using Test-Dependency you can verify the dependency package DID get 
    # installed and abort if not. Example: Test-Dependency "dependency-windows10"
    # You would typically run this sometime before Install-ChocolateyPackage
    
    function Test-Dependency($dependency){
    if (Test-Path -Path $env:ChocolateyInstall\lib\$dependency){
        return $True
    	Write-Host "  ** Dependency $dependency found." -ForeGround Green
        } else {
    	  return $False
    	  Write-Host "  ** Dependency $dependency NOT found." -ForeGround Red
        }
    }
  • extensions\Show-PayPal.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Show-PayPal.ps1 - Displays a message and link to your PayPal account, i.e. www.paypal.me/account
    # If you define $global:packageMaintainer in your chocolateyinstall.ps1, 
    # i.e. $global:packageMaintainer = 'BCURRAN3' it will use that too.
    # Recommended to run this right before Install-ChocolateyPackage - that's when you MIGHT have a moment of the user's attention.
    # Oh yeah! You can donate to me at https://www.paypal.me/bcurran3donations :)
    
    function Show-PayPal($PayPalURL){
    # 08-24-2018
    # This function has been disallowed by the Chocolatey team. Donation requests can be on package pages but not in packages. :( Hey fellow maintainers, I tried!
    # Its existence is for backward compatibility, actual function NULLIFIED.
    Write-Host "  ** The Show-PayPal function has been retired. Please inform the package maintainer!" -ForeGround Red
    return
    
    Write-Host "-- While you're waiting for your package to install, consider donating to" -foreground cyan
    if ($packageMaintainer) {
        Write-Host "-- $packageMaintainer, the maintainer of this $env:packageName package, at $PayPalURL" -foreground cyan
       } else {
        Write-Host "-- the maintainer of this $env:packageName package at $PayPalURL" -foreground cyan
       }
    }
  • extensions\Show-Patreon.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Show-Patreon.ps1 - Displays a message and link to your Patreon account.
    # If you define $global:packageMaintainer in your chocolateyinstall.ps1, 
    # i.e. $global:packageMaintainer = 'BCURRAN3' it will use that too.
    # Recommended to run this right before Install-ChocolateyPackage - that's when you MIGHT have a moment of the user's attention.
    # Oh yeah! You can Patreon-ize me at https://www.patreon.com/bcurran3 :)
    
    function Show-Patreon($PatreonURL){
    # 08-24-2018
    # This function has been disallowed by the Chocolatey team. Donation requests can be on package pages but not in packages. :( Hey fellow maintainers, I tried!
    # Its existence is for backward compatibility, actual function NULLIFIED.
    Write-Host "  ** The Show-Patreon function has been retired. Please inform the package maintainer!" -ForeGround Red
    return
    
    Write-Host "-- While you're waiting for your package to install, consider becoming a patron of" -foreground cyan
    if ($packageMaintainer) {
        Write-Host "-- $packageMaintainer, the maintainer of this $env:packageName package, at $PatreonURL" -foreground cyan
       } else {
        Write-Host "-- the maintainer of this $env:packageName package at $PatreonURL" -foreground cyan
       }
    }
  • extensions\Enable-AutoPin.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Creates a .pin file in \programdata\chocolatey\.chocolatey\packagename.packageversion folder to AutoPin a package
    # Implementation should be via a user opt-in installation package parameter; i.e. AUTOPIN:YES
    # REF: https://github.com/chocolatey/choco/issues/1607
    # DISCLAIMER: Enable-AutoPin is implemented via an undocumented/non-public/unofficial "API." Tested with Chocolatey v0.10.11, should work with Chocolatey v0.9.9-v0.10.11. This will be deprecated when a future version of Chocolatey switches to using a database to store package options and thus this method will stop working. 
    
    function Enable-AutoPin{
    # 01-12-2019
    # This function has been retired. Real world testing has shown that even though the function works perfectly, it's a negated as choco.exe
    # deletes the .pin file after chocolateyinstall.ps1 finishes when the .pin file didn't exist previously. Even when the .pin file is set
    # to read only, choco.exe errors out trying to delete the .pin file and fails the package install.
    # -----> THWARTED! <-----
    # Its existence is for backward compatibility, actual function NULLIFIED.
    Write-Host "  ** The AutoPin function has been retired. It does not work. Please inform the package maintainer!" -ForeGround Red
    return
    if (Test-Path -Path $ENV:ChocolateyInstall\.chocolatey\$ENV:ChocolateyPackageName.$ENV:ChocolateyPackageVersion){
    	New-Item -Path "$ENV:ChocolateyInstall\.chocolatey\$ENV:ChocolateyPackageName.$ENV:ChocolateyPackageVersion\" -ItemType "file" -Name ".pin" -Value "This package has been AutoPinned." -Force
    	Out-File -FilePath "$ENV:ChocolateyInstall\.chocolatey\$ENV:ChocolateyPackageName.$ENV:ChocolateyPackageVersion\.pin" -InputObject "This package has been AutoPinned." -Force
    	Set-ItemProperty -Path "$ENV:ChocolateyInstall\.chocolatey\$ENV:ChocolateyPackageName.$ENV:ChocolateyPackageVersion\.pin" -Name IsReadOnly -Value $true
       }
    if (Test-Path -Path $ENV:ChocolateyInstall\.chocolatey\$ENV:ChocolateyPackageName.$ENV:ChocolateyPackageVersion\.pin){
        Write-Host "  ** $ENV:ChocolateyPackageName v$ENV:ChocolateyPackageVersion AutoPinned." -ForeGround Green
       } else {
         Write-Host "  ** Error creating AutoPin. Package NOT pinned." -ForeGround Red
       }
    }
    
  • extensions\chocolatey-misc-helpers.psm1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    
    $scriptRoot = Split-Path -Path $MyInvocation.MyCommand.Definition
    
    $publicFunctions = @(
        'Enable-AutoPin',
    	'Show-ToastMessage',
        'Show-Patreon',
    	'Show-PayPal',
        'Start-CheckandStop',
    	'Start-CheckandThrow',
    	'Start-WaitandStop',
    	'Start-WaitandStopActual',
        'Test-Dependency'
    )
     
    Get-ChildItem -Path "$scriptRoot\*.ps1" | ForEach-Object { . $_ }
    Export-ModuleMember -Function $publicFunctions
  • extensions\Start-WaitandStopActual.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Start-WaitandStopActual.ps1 - Stops process $ProcessName anywhere up to 5 minutes after being called.
    # This function is called by Start-WaitandStop.ps1 and should not be used directly.
    
    function Start-WaitandStopActual{
    $ProcessName = $ENV:ProcessName
    
    $LoopMePlease=1
    Do {
        Start-Sleep 5
        if((Get-Process "$ProcessName" -ea SilentlyContinue) -eq $Null){ 
          } else { 
            Write-Verbose "  ** Stopping $ProcessName process..."	  
            Stop-Process -ProcessName "$ProcessName" -Force
    		break
           }	
        $LoopMePlease++
       }
    Until ($LoopMePlease -gt 60)
    }
    
    
      
      
  • extensions\Start-WaitandStop.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Runs a background job to kill $ProcessName within 5 minutes
    # You would typically run this before Install-ChocolateyPackage
    
    function Start-WaitandStop($ProcessName){
    $ENV:ProcessName = $ProcessName
    
    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
    Start-Job -InitializationScript {Import-Module -Name "$ENV:ChocolateyInstall\extensions\chocolatey-misc-helpers\Start-WaitandStopActual.ps1"} -ScriptBlock {Start-WaitandStopActual} | Out-Null
    Start-Sleep 10
    Remove-Item ENV:\ProcessName
    }
    
  • extensions\Start-CheckandThrow.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Checks for and throws install if $ProcessName is running
    # Good for aborting installation of portable programs if they are running. Otherwise Chocolatey might think the package installed but you're still running the old version. This is an alternative to just stopping the process.
    
    function Start-CheckandThrow($ProcessName){
    
    if ((Get-Process "$ProcessName" -ea SilentlyContinue) -eq $Null){
        return
      } else { 
        Write-Warning "  ** Aborting install as $ProcessName is already running..."
    	Write-Warning "  ** Please quit the program and try the upgrade again."
    	throw
      }
    }
    
  • extensions\Start-CheckandStop.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Start-WaitandStop.ps1 - Checks for and stops $ProcessName if running.
    # $ProcessWasRunning can be checked later in scripts to re-run $ProcessName if it was running before stopped.
    # $ProcessFullPath is the full path and executable of the stopped process.
    # i.e. to re-run the process after an upgrade use: if ($ProcessWasRunning -eq "True") {&"$ProcessFullPath"}
    
    function Start-CheckandStop($ProcessName){
    $GLOBAL:ProcessWasRunning=$False
    
    if((Get-Process "$ProcessName" -ea SilentlyContinue) -eq $Null){ 
        Write-Host "  ** $ProcessName currently NOT running." -ForeGround Green
      }else{ 
        Write-Warning "  ** Stopping $ProcessName process..."
    	$GLOBAL:ProcessWasRunning = $True
    	$GLOBAL:ProcessFullPath = (Get-Process "$ProcessName").path
        Stop-Process -ProcessName "$ProcessName" -Force	
      }
    }
    
  • extensions\Show-ToastMessage.ps1 Show
    # chocolatey-misc-helpers.extension v0.0.3.1 (01-12-2019) by Bill Curran - public domain
    # Show-ToastMessage.ps1 - Sends a Windows toast message.
    # Uses BurntToast (https://github.com/Windos/BurntToast) if installed. NOTE: v0.5.0+ no longer works on Windows 8.
    # Otherwise uses the code I blatantly stole from https://gist.github.com/Windos/9aa6a684ac583e0d38a8fa68196bc2dc
    # Example of use: Show-ToastMessage "$packageName installed." "Version $env:packageVersion."
    # Not guaranteed to work on Windows versions other than Windows 10 and Server 2016. 
    # Should do nothing on other versions; i.e. tested on Windows Server 2012 R2 - no messages, no errors.
    
    function Show-ToastMessage($MessageLine1, $MessageLine2){
    # 08-31-2018
    # This function has been disallowed by the Chocolatey team as "pop ups" need to be 100% opt-in.
    # Its existence is for backward compatibility, actual function NULLIFIED.
    # I argued that by having BurntToast installed, users WANT the toast messages. The Chocolatey Team still disagreed. :(
    # 01-12-2019
    # This functionality has been replaced by https://chocolatey.org/packages/chocolatey-toast-notifications.extension which is much better!
    Write-Host "  ** The Show-ToastMessage function has been retired. Please inform the package maintainer!" -ForeGround Red
    return
    
    if (!(Test-Path "$ChocolateyInstall\extensions\chocolatey-misc-helpers\choco.ico")){
         [System.Reflection.Assembly]::LoadWithPartialName('System.Drawing')  | Out-Null
         [System.Drawing.Icon]::ExtractAssociatedIcon("$env:ChocolateyInstall\choco.exe").ToBitmap().Save("$env:ChocolateyInstall\extensions\chocolatey-misc-helpers\choco.ico")
    }
    
    if (Get-Module -ListAvailable -Name BurntToast -ErrorAction SilentlyContinue){
         New-BurntToastNotification -Text "Chocolatey ($env:packageName)", "$MessageLine1", "$MessageLine2" -AppLogo "$env:ChocolateyInstall\extensions\chocolatey-misc-helpers\choco.ico" -ErrorAction SilentlyContinue
       } else {
         $app = '{1AC14E77-02E7-4E5D-B744-2EB1AE5198B7}\WindowsPowerShell\v1.0\powershell.exe'
         [Windows.UI.Notifications.ToastNotificationManager, Windows.UI.Notifications, ContentType = WindowsRuntime] | Out-Null
         $Template = [Windows.UI.Notifications.ToastTemplateType]::ToastImageAndText01
         #Gets the Template XML so we can manipulate the values
         [xml]$ToastTemplate = ([Windows.UI.Notifications.ToastNotificationManager]::GetTemplateContent($Template).GetXml())
         [xml]$ToastTemplate = @"
    <toast launch="app-defined-string">
      <visual>
        <binding template="ToastGeneric">
          <text>Chocolatey ($env:packageName)</text>	
          <text>$MessageLine1</text>
          <text>$MessageLine2</text>
    	  <branding>logo</branding>
    	  <image placement="appLogoOverride" src="$env:ChocolateyInstall\extensions\chocolatey-misc-helpers\choco.ico"/>
        </binding>
      </visual>
    </toast>
    "@
         $ToastXml = New-Object -TypeName Windows.Data.Xml.Dom.XmlDocument
         $ToastXml.LoadXml($ToastTemplate.OuterXml)
         $notify = [Windows.UI.Notifications.ToastNotificationManager]::CreateToastNotifier($app) 
         $notify.Show($ToastXml)
        }
    }
    

Virus Scan Results

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.

Dependencies

This package has no dependencies.

Package Maintainer(s)

Software Author(s)

  • Bill Curran

Copyright

public domain

Tags

Release Notes

PACKAGE NOTES

Version History

Version Downloads Last updated Status
Chocolatey Misc Helpers Extension 0.0.3 11912 Tuesday, December 4, 2018 approved
Chocolatey Misc Helpers Extension 0.0.2 14078 Saturday, September 1, 2018 approved
Chocolatey Misc Helpers Extension 0.0.1 8376 Thursday, June 21, 2018 approved

Discussion for the Chocolatey Misc Helpers Extension Package

Ground rules:

  • This discussion is only about Chocolatey Misc Helpers Extension and the Chocolatey Misc Helpers Extension 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 Chocolatey Misc Helpers Extension, 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.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok