(extension) Added Uninstall Extension Package

chocolatey-community · May 18, 2016 · f7fe281 · f7fe281 · ferventcoder · May 18, 2016
1 parent f558e6f
commit f7fe281
Show file tree

Hide file tree

Showing 2 changed files with 118 additions and 0 deletions.
diff --git a/extensions/chocolatey-uninstall.extension/chocolatey-uninstall.extension.nuspec b/extensions/chocolatey-uninstall.extension/chocolatey-uninstall.extension.nuspec
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
+<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
+  <metadata>
+    <id>chocolatey-uninstall.extension</id>
+    <version>0.1.0</version>
+    <packageSourceUrl>https://github.com/chocolatey/chocolatey-coreteampackages</packageSourceUrl>
+    <owners>chocolatey</owners>
+    <title>chocolatey-uninstall.extension (Install)</title>
+    <authors>dtgm ferventcoder</authors>
+    <copyright>© 2016-Present Chocolatey Core Team Package Contributors</copyright>
+    <projectUrl>https://github.com/chocolatey/chocolatey-coreteampackages</projectUrl>
+    <licenseUrl>https://github.com/chocolatey/choco/blob/master/LICENSE</licenseUrl>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <projectSourceUrl>https://github.com/chocolatey/chocolatey-coreteampackages</projectSourceUrl>
+    <docsUrl>https://github.com/chocolatey/chocolatey-coreteampackages/wiki</docsUrl>
+    <mailingListUrl>https://groups.google.com/forum/#!forum/chocolatey</mailingListUrl>
+    <bugTrackerUrl>https://github.com/chocolatey/chocolatey-coreteampackages/issues</bugTrackerUrl>
+    <tags>uninstall extension admin</tags>
+    <summary>Helper Function for retrieving registry keys during uninstall of packages</summary>
+    <description>
+Provides a helper function to help with retrieving registry keys during uninstall of Chocolatey packages.
+    </description>
+    <releaseNotes>
+* 0.1.0 - Initial release of extension package
+    </releaseNotes>
+  </metadata>
+  <files>
+    <file src="extensions\**" target="extensions" />
+  </files>
+</package>
diff --git a/extensions/chocolatey-uninstall.extension/extensions/Get-UninstallRegistryKey.psm1 b/extensions/chocolatey-uninstall.extension/extensions/Get-UninstallRegistryKey.psm1
@@ -0,0 +1,87 @@
+function Get-UninstallRegistryKey {
+<#
+.SYNOPSIS
+  Retrieve registry uninstall key(s)
+
+.DESCRIPTION
+  This function will attempt to retrieve a matching registry key to be used
+  within a chocolateyUninstall.ps1 script.
+
+.PARAMETER SoftwareName
+  Part or all of the Display Name as you see it in Programs and Features.
+  It should be enough to be unique.
+
+.EXAMPLE
+  [array]$key = Get-UninstallRegistryKey -SoftwareName "Gpg4win (2.3.0)"
+  [array]$key = Get-UninstallRegistryKey -SoftwareName "Launchy 2.5"
+  [array]$key = Get-UninstallRegistryKey -SoftwareName "Mozilla Firefox*"
+  
+  $key.UninstallString
+  
+.INPUTS
+  Accepts [string]
+
+.OUTPUTS
+  This script 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 the nuspec:
+  
+  <dependencies>
+    <dependency id="chocolatey-uninstall.extension" />
+  </dependencies>
+
+.LINK
+  Uninstall-ChocolateyPackage
+#>
+  [CmdletBinding()]
+  param(
+    [Parameter(Mandatory=$True,
+    ValueFromPipeline=$True)]
+    [ValidateNotNullOrEmpty()]
+    [string] $softwareName
+  )
+  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 "Error handling check: Get-ItemProperty will fail if a registry key is written incorrectly."
+  Write-Debug "If such a key is found, loop to try to bypass all badKeys"
+  [int]$maxAttempts = 10
+  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: $($key.PsPath)"
+      [array]$keys = Get-ChildItem -Path @($machine_key6432, $machine_key, $local_key) `
+                                   -ErrorAction SilentlyContinue `
+                     | Where-Object {$badKey -NotContains $_.PsPath}
+    }
+
+    if ($success) {break;}
+  }
+
+  return $foundKey
+}