Downloads:

194,192

Downloads of v 1.1.0:

26,215

Last Update:

25 Jun 2016

Package Maintainer(s):

Software Author(s):

  • dtgm
  • ferventcoder

Tags:

chocolatey uninstall extension admin

Chocolatey Uninstall Extension

This is not the latest version of Chocolatey Uninstall Extension available.

  • 1
  • 2
  • 3

1.1.0 | Updated: 25 Jun 2016

Downloads:

194,192

Downloads of v 1.1.0:

26,215

Maintainer(s):

Software Author(s):

  • dtgm
  • ferventcoder

  • 1
  • 2
  • 3
Chocolatey Uninstall Extension 1.1.0

This is not the latest version of Chocolatey Uninstall Extension available.

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Failed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details

Deployment Method: Individual Install, Upgrade, & Uninstall

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

>

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

>

To uninstall Chocolatey Uninstall Extension, 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

  • 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

3. Copy Your Script

choco upgrade chocolatey-uninstall.extension -y --source="'INTERNAL REPO URL'" --version="'1.1.0'" [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 chocolatey-uninstall.extension -y --source="'INTERNAL REPO URL'" --version="'1.1.0'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install chocolatey-uninstall.extension
  win_chocolatey:
    name: chocolatey-uninstall.extension
    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 'chocolatey-uninstall.extension' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.1.0'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller chocolatey-uninstall.extension
{
    Name     = "chocolatey-uninstall.extension"
    Version  = "1.1.0"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'chocolatey-uninstall.extension':
  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.

This package was approved by moderator gep13 on 12 Jul 2016.

Description

This package provides helper functions installed as a Chocolatey extension. These functions may be used in Chocolatey install/uninstall scripts by declaring this package a dependency in your package's nuspec.

<dependencies>
  <dependency id="chocolatey-uninstall.extension" />
</dependencies>

Functions

Get-UninstallRegistryKey -- retrieve registry keys for use during uninstall of Chocolatey packages

  1. To use, add the following to chocolateyUninstall.ps1, setting $softwareName to the name as seen in Control Panel's "Programs and Features"

$softwareName = "Example Name"
[array]$key = Get-UninstallRegistryKey -SoftwareName $softwareName

  1. The found registry key's properties are accessible by dot notation. For example, $key.UninstallString

extensions\Get-UninstallRegistryKey.psm1
function Get-UninstallRegistryKey {
<#
.SYNOPSIS
Retrieve registry key(s) for system-installed applications from an 
exact or wildcard search.

.DESCRIPTION
This function will attempt to retrieve a matching registry key for an
already installed application, usually to be used with a 
chocolateyUninstall.ps1 automation script.

The function also prevents `Get-ItemProperty` from failing when 
handling wrongly encoded registry keys.

.PARAMETER SoftwareName
Part or all of the Display Name as you see it in Programs and Features.
It should be enough to be unique.

If the display name contains a version number, such as "Launchy (2.5)", 
it is recommended you use a fuzzy search `"Launchy (*)"` (the wildcard `*`)
so if Launchy auto-updates or is updated outside of chocolatey, the 
uninstall script will not fail.

Take care not to abuse fuzzy/glob pattern searches. Be conscientious of
programs that may have shared or common root words to prevent overmatching.
"SketchUp*" would match two keys with software names "SketchUp 2016" and 
"SketchUp Viewer" that are different programs released by the same company.

.INPUTS
System.String

.OUTPUTS
PSCustomObject

This function searches registry objects and returns PSCustomObject of the
matched key's properties.

Retrieve properties with dot notation, for example: $key.UninstallString

.NOTES
This helper reduces the number of lines one would have to write to 
retrieve registry keys to 1 line. It also prevents Get-ItemProperty from
failing when handling wrongly encoded registry keys.

Using this function in a package requires adding the extension as a
dependency. Add the following to the nuspec:

<dependencies>
  <dependency id="chocolatey-uninstall.extension" />
</dependencies>

.EXAMPLE
[array]$key = Get-UninstallRegistryKey -SoftwareName "VLC media player"
$key.UninstallString

Exact match: software name in Programs and Features is "VLC media player"

.EXAMPLE
[array]$key = Get-UninstallRegistryKey -SoftwareName "Gpg4win (*)"
$key.UninstallString

Version match: software name is "Gpg4Win (2.3.0)"

.EXAMPLE
[array]$key = Get-UninstallRegistryKey -SoftwareName "SketchUp [0-9]*"
$key.UninstallString

Version match: software name is "SketchUp 2016"
Note that the similar software name "SketchUp Viewer" would not be matched.

.LINK
Uninstall-ChocolateyPackage
#>
  [CmdletBinding()]
  param(
    [Parameter(Mandatory=$true, Position=0, ValueFromPipeline=$true)]
    [ValidateNotNullOrEmpty()]
    [string] $softwareName,
    [Parameter(ValueFromRemainingArguments = $true)][Object[]] $ignoredArguments
  )
  Write-Debug "Running 'Get-UninstallRegistryKey' for `'$env:ChocolateyPackageName`' with SoftwareName:`'$softwareName`'";

  $ErrorActionPreference = 'Stop'
  $local_key       = 'HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall\*'
  $machine_key     = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*'
  $machine_key6432 = 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*'

  Write-Verbose "Retrieving all uninstall registry keys"
  [array]$keys = Get-ChildItem -Path @($machine_key6432, $machine_key, $local_key) `
                               -ErrorAction SilentlyContinue
  Write-Debug "Registry uninstall keys on system: $($keys.Count)"

  Write-Debug "Error handling check: `'Get-ItemProperty`' fails if a registry key is encoded incorrectly."
  [int]$maxAttempts = $keys.Count
  for ([int]$attempt = 1; $attempt -le $maxAttempts; $attempt++) {
    [bool]$success = $FALSE
    
    try {
      [array]$foundKey = Get-ItemProperty -Path $keys.PsPath `
                                          -ErrorAction SilentlyContinue `
                         | Where-Object { $_.DisplayName -like $softwareName }
      $success = $TRUE
    } catch {
      Write-Debug "Found bad key."
      foreach ($key in $keys){ try{ Get-ItemProperty $key.PsPath > $null }catch{ $badKey = $key.PsPath }}
      Write-Verbose "Skipping bad key: $badKey"
      [array]$keys = $keys | Where-Object { $badKey -NotContains $_.PsPath }
    }
    
    if ($success) { break; }
    if ($attempt -eq 10) {
      Write-Warning "Found more than 10 bad registry keys. Run command again with `'--verbose --debug`' for more info."
      Write-Debug "Each key searched should correspond to an installed program. It is very unlikely to have more than a few programs with incorrectly encoded keys, if any at all. This may be indicative of one or more corrupted registry branches."
    }
  }
  
  Write-Debug "Found $($foundKey.Count) uninstall registry key(s) with SoftwareName:`'$softwareName`'";
  return $foundKey
}

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.

Add to Builder Version Downloads Last Updated Status
Chocolatey Uninstall Extension 1.1.0 26215 Saturday, June 25, 2016 Approved

1.1.0

Bug fixes
  • Not building array properly; fails if more than one bad key
  • Not reporting correct key
Improvements
  • Try to remove all bad keys found.
  • (reporting) add warning if more than 10 bad keys are found
  • (reporting) no registry keys matched SoftwareName

This package has no dependencies.

Discussion for the Chocolatey Uninstall Extension Package

Ground Rules:

  • This discussion is only about Chocolatey Uninstall Extension and the Chocolatey Uninstall 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 Uninstall 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