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

This is not the latest version of Chocolatey Core Extensions available.

Chocolatey Core Extensions

1.3.1

Package test results are passing.

This package was approved as a trusted package on 7/20/2017.

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.

To install Chocolatey Core Extensions, run the following command from the command line or from PowerShell:

C:\> choco install chocolatey-core.extension --version 1.3.1

To upgrade Chocolatey Core Extensions, run the following command from the command line or from PowerShell:

C:\> choco upgrade chocolatey-core.extension --version 1.3.1

Files

Hide
  • extensions\chocolatey-core.psm1 Show
    # Export functions that start with capital letter, others are private
    # Include file names that start with capital letters, ignore others
    $ScriptRoot = Split-Path $MyInvocation.MyCommand.Definition
    
    $pre = ls Function:\*
    ls "$ScriptRoot\*.ps1" | ? { $_.Name -cmatch '^[A-Z]+' } | % { . $_  }
    $post = ls Function:\*
    $funcs = compare $pre $post | select -Expand InputObject | select -Expand Name
    $funcs | ? { $_ -cmatch '^[A-Z]+'} | % { Export-ModuleMember -Function $_ }
    
    #Export-ModuleMember -Alias *
    
  • extensions\Get-AppInstallLocation.ps1 Show
    . "$PSScriptRoot\Get-UninstallRegistryKey.ps1"
    <#
    .SYNOPSIS
        Get application install location
    
    .DESCRIPTION
        Function tries to find install location in multiple places. It returns $null if all fail. The following
        locations are tried:
          - local and machine (x32 & x64) various Uninstall keys
          - x32 & x64 Program Files up to the 2nd level of depth
          - native commands available via PATH
          - locale and machine registry key SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths
    
        Use Verbose parameter to see which of the above locations was used for the result, if any.
    
    .EXAMPLE
        PS> Get-AppInstallLocation choco
    
        Returns the install location of the application 'choco'.
    
    .OUTPUTS
        [String] or $null
    #>
    function Get-AppInstallLocation {
        [CmdletBinding()]
        param(
            # Regular expression pattern
            [ValidateNotNullOrEmpty()]
            [string] $AppNamePattern,
    
            # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
            [parameter(ValueFromRemainingArguments = $true)]
            [Object[]] $IgnoredArguments
        )
    
        function strip($path) { if ($path.EndsWith('\')) { return $path -replace '.$' } else { $path } }
    
        $ErrorActionPreference = "SilentlyContinue"
    
        Write-Verbose "Trying local and machine (x32 & x64) Uninstall keys"
        [array] $key = Get-UninstallRegistryKey $AppNamePattern
        if ($key.Count -eq 1) {
            Write-Verbose "Trying Uninstall key property 'InstallLocation'"
            $location = $key.InstallLocation
            if ($location -and (Test-Path $location))  { return strip $location }
    
            Write-Verbose "Trying Uninstall key property 'UninstallString'"
            $location = $key.UninstallString
            if ($location) { $location = $location.Replace('"', '') | Split-Path }
            if ($location -and (Test-Path $location))  { return strip $location }
    
            Write-Verbose "Trying Uninstall key property 'DisplayIcon'"
            $location = $key.DisplayIcon
            if ($location) { $location = Split-Path $location }
            if ($location -and (Test-Path $location))  { return strip $location }
        } else { Write-Verbose "Found $($key.Count) keys, aborting this method" }
    
        $dirs = $Env:ProgramFiles, "$Env:ProgramFiles\*\*"
        if (Get-ProcessorBits 64) { $dirs += ${ENV:ProgramFiles(x86)}, "${ENV:ProgramFiles(x86)}\*\*" }
        Write-Verbose "Trying Program Files with 2 levels depth: $dirs"
        $location = (ls $dirs | ? {$_.PsIsContainer}) -match $AppNamePattern | select -First 1 | % {$_.FullName}
        if ($location -and (Test-Path $location))  { return strip $location }
    
        Write-Verbose "Trying native commands on PATH"
        $location = (Get-Command -CommandType Application) -match $AppNamePattern | select -First 1 | % { Split-Path $_.Source }
        if ($location -and (Test-Path $location))  { return strip $location }
    
        $appPaths =  "\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths"
        Write-Verbose "Trying Registry: $appPaths"
        $location = (ls "HKCU:\$appPaths", "HKLM:\$appPaths") -match $AppNamePattern | select -First 1
        if ($location) { $location = Split-Path $location }
        if ($location -and (Test-Path $location))  { return strip $location }
    
        Write-Verbose "No location found"
    }
    
  • extensions\Get-AvailableDriveLetter.ps1 Show
    <#
    .SYNOPSIS
      Get a 'free' drive letter
    
    .DESCRIPTION
      Get a not yet in-use drive letter that can be used for mounting
    
    .EXAMPLE
      Get-AvailableDriveLetter
    
    .EXAMPLE
      Get-AvailableDriveLetter 'X'
      (do not return X, even if it'd be the next choice)
    
    .INPUTS
      specific drive letter(s) that will be excluded as potential candidates
    
    .OUTPUTS
      System.String (single drive-letter character)
    
    .LINK
      http://stackoverflow.com/questions/12488030/getting-a-free-drive-letter/29373301#29373301
    #>
    function Get-AvailableDriveLetter {
      param (
        [char[]]$ExcludedLetters,
    
        # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
        [parameter(ValueFromRemainingArguments = $true)]
        [Object[]] $IgnoredArguments
      )
    
      $Letter = [int][char]'C'
      $i = @()
    
      #getting all the used Drive letters reported by the Operating System
      $(Get-PSDrive -PSProvider filesystem) | %{$i += $_.name}
    
      #Adding the excluded letter
      $i+=$ExcludedLetters
    
      while($i -contains $([char]$Letter)){$Letter++}
    
      if ($Letter -gt [char]'Z') {
        throw "error: no drive letter available!"
      }
      Write-Verbose "available drive letter: '$([char]$Letter)'"
      Return $([char]$Letter)
    }
    
    
  • extensions\Get-EffectiveProxy.ps1 Show
    <#
    .SYNOPSIS
        Get the current proxy using several methods
    
    .DESCRIPTION
        Function tries to find the current proxy using several methods, in the given order:
            - $env:chocolateyProxyLocation variable
            - $env:http_proxy environment variable
            - IE proxy
            - Chocolatey config
            - Winhttp proxy
            - WebClient proxy
    
        Use Verbose parameter to see which of the above locations was used for the result, if any.
        The function currently doesn't handle the proxy username and password.
    
    .OUTPUTS
        [String] in the form of http://<proxy>:<port>
    #>
    function Get-EffectiveProxy(){
    
        # Try chocolatey proxy environment vars
        if ($env:chocolateyProxyLocation) {
            Write-Verbose "Using `$Env:chocolateyProxyLocation"
            return $env:chocolateyProxyLocation
        }
    
        # Try standard Linux variable
        if ($env:http_proxy) {
            Write-Verbose "Using `$Env:http_proxy"
            return $env:http_proxy
        }
        
        # Try to get IE proxy
        $key = "HKCU:\Software\Microsoft\Windows\CurrentVersion\Internet Settings"
        $r = Get-ItemProperty $key
        if ($r.ProxyEnable -and $r.ProxyServer) {
            Write-Verbose "Using IE proxy settings"
            return "http://" + $r.ProxyServer
        }
        
        # Try chocolatey config file
        [xml] $cfg = gc $env:ChocolateyInstall\config\chocolatey.config
        $p = $cfg.chocolatey.config | % { $_.add } | ? { $_.key -eq 'proxy' } | select -Expand value
        if ($p) {
            Write-Verbose "Using choco config proxy"
            return $p
        }
    
        # Try winhttp proxy
        (netsh.exe winhttp show proxy) -match 'Proxy Server\(s\)' | set proxy 
        $proxy = $proxy -split ' :' | select -Last 1
        $proxy = $proxy.Trim()
        if ($proxy) {
            Write-Verbose "Using winhttp proxy server"
            return "http://" + $proxy
        }
    
        # Try using WebClient
        $url = "http://chocolatey.org"
        $client = New-Object System.Net.WebClient
        if ($client.Proxy.IsBypassed($url)) { return $null }
    
        Write-Verbose "Using WebClient proxy"
        return "http://" + $client.Proxy.GetProxy($url).Authority
    }
    
  • extensions\Get-PackageCacheLocation.ps1 Show
    <#
    .SYNOPSIS
        Get temporary location for the package based on its name and version.
    
    .DESCRIPTION
        The function returns package cache directory within $Env:TEMP. It will not create the directory
        if it doesn't exist.
    
        This function is useful when you have to obtain the file using `Get-ChocolateyWebFile` in order
        to perform certain installation steps that other helpers can't do.
    
    .EXAMPLE
        Get-PackageCacheLocation
    
    .OUTPUTS
        [String]
    
    .LINKS
        Get-ChocolateyWebFile
    #>
    function Get-PackageCacheLocation {
        [CmdletBinding()]
        param (
            # Name of the package, by default $Env:ChocolateyPackageName
            [string] $Name    = $Env:ChocolateyPackageName,
            # Version of the package, by default $Env:ChocolateyPackageVersion
            [string] $Version = $Env:ChocolateyPackageVersion,
            # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
            [parameter(ValueFromRemainingArguments = $true)]
            [Object[]] $IgnoredArguments
        )
    
        if (!$Name) { Write-Warning 'Environment variable $Env:ChocolateyPackageName is not set' }
        $res = Join-Path $Env:TEMP $Name
    
        if (!$Version) { Write-Warning 'Environment variable $Env:ChocolateyPackageVersion is not set' }
        $res = Join-Path $res $Version
    
        $res
    }
    
  • extensions\Get-PackageParameters.ps1 Show
    <#
    .SYNOPSIS
        Parses parameters of the package
    
    .EXAMPLE
        Get-PackageParameters "/Shortcut /InstallDir:'c:\program files\xyz' /NoStartup" | set r
        if ($r.Shortcut) {... }
        Write-Host $r.InstallDir
    
    .OUTPUTS
        [HashTable]
    #>
    function Get-PackageParameters {
        [CmdletBinding()]
        param(
           [string] $Parameters = $Env:ChocolateyPackageParameters,
           # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
           [parameter(ValueFromRemainingArguments = $true)]
           [Object[]] $IgnoredArguments
        )
    
        $res = @{}
    
        $re = "\/([a-zA-Z0-9]+)(:[`"'].+?[`"']|[^ ]+)?"
        $results = $Parameters | Select-String $re -AllMatches | select -Expand Matches
        foreach ($m in $results) {
            if (!$m) { continue } # must because of posh 2.0 bug: https://github.com/chocolatey/chocolatey-coreteampackages/issues/465
    
            $a = $m.Value -split ':'
            $opt = $a[0].Substring(1); $val = $a[1..100] -join ':'
            if ($val -match '^(".+")|(''.+'')$') {$val = $val -replace '^.|.$'}
            $res[ $opt ] = if ($val) { $val } else { $true }
        }
        $res
    }
    
  • extensions\Get-UninstallRegistryKey.ps1 Show
    <#
    .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.
        The syntax follows the rules of the PowerShell `-like` operator, so the `*` character is interpreted
        as a wildcard, which matches any (zero or more) characters.
    
        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 conscious of programs that may have shared
        or common root words to prevent overmatching. For example, "SketchUp*" would match two keys with software
        names "SketchUp 2016" and "SketchUp Viewer" that are different programs released by the same company.
    
    .PARAMETER IgnoredArguments
        Allows splatting with arguments that do not apply and future expansion. Do not use directly.
    
    .INPUTS
        System.String
    
    .OUTPUTS
        PSCustomObject
    
    .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
    #>
    function Get-UninstallRegistryKey {
        [CmdletBinding()]
        param(
            [Parameter(Mandatory=$true, 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) -ea 0
        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++)
        {
            $success = $false
    
            $keyPaths = $keys | Select-Object -ExpandProperty PSPath
            try {
                [array]$foundKey = Get-ItemProperty -Path $keyPaths -ea 0 | ? { $_.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 | ? { $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
    }
    
  • extensions\Get-WebContent.ps1 Show
    <#
    .SYNOPSIS
      Download file with choco internals
    
    .DESCRIPTION
      This function will download a file from specified url and return it as a string.
      This command should be a replacement for ubiquitous WebClient in install scripts.
    
      The benefit of using this command instead of WebClient is that it correctly handles
      system or explicit proxy.
    
    .EXAMPLE
      PS C:\> $s = Get-WebContent "http://example.com"
      PS C:\> $s -match 'Example Domain'
      True
    
      First command downloads html content from http://example.com and stores it in $s.
      Now you can parse and match it as a string.
    
    .EXAMPLE
      PS C:\> $opts = @{ Headers = @{ Referer = 'http://google.com' } }
      PS C:\> $s = Get-WebContent -url "http://example.com" -options $opts
    
      You can set headers for http request this way.
    
    .INPUTS
      None
    
    .OUTPUTS
      System.String
    
    .NOTES
      This function can only return string content.
      If you want to download a binary content, please use Get-WebFile.
    
    .LINK
      Get-WebFile
    #>
    function Get-WebContent {
        [CmdletBinding()]
        param(
            # Url to download
            [string]$Url,
    
            # Additional options for http request.For now only Headers property supported.
            [hashtable]$Options,
    
            # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
            [parameter(ValueFromRemainingArguments = $true)]
            [Object[]] $IgnoredArguments
        )
    
        $filePath =  get_temp_filepath
        Get-WebFile -Url $Url -FileName $filePath -Options $Options 3>$null
    
        $fileContent = Get-Content $filePath -ReadCount 0 | Out-String
        Remove-Item $filePath
    
        $fileContent
    }
    
    function get_temp_filepath() {
        $tempDir = Get-PackageCacheLocation
        $fileName = [System.IO.Path]::GetRandomFileName()
        Join-Path $tempDir $fileName
    }
    
    
  • extensions\Register-Application.ps1 Show
    <#
    .SYNOPSIS
        Register application in the system
    
    .DESCRIPTION
        The function will register application in the system using App Paths registry key so that you
        can start it by typing its registred name in the Windows Start menu on using run dialog (Win + R).
    
        To make applications available in the shell, add to your profile Set-AppKeyAliases function.
    
    .EXAMPLE
        Register-Application 'c:\windows\notepad.exe'
    
        Register application using name derived from its file name.
    
    .EXAMPLE
        Register-Application 'c:\windows\notepad.exe' -Name ntp
    
        Register application using explicit name.
    
    .LINK
       Set-AppKeyAliases        - https://github.com/majkinetor/posh/blob/master/MM_Admin/Set-AppKeyAliases.ps1
       Application Registration - https://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx
    
    #>
    function Register-Application{
        [CmdletBinding()]
        param(
            # Full path of the executable to register.
            [Parameter(Mandatory=$true)]
            [string]$ExePath,
    
            # Optional name to register with. By default exe name will be used.
            [string]$Name,
    
            # Register application only for the current user. By default registration is for the machine.
            [switch]$User,
    
            # Allows splatting with arguments that do not apply and future expansion. Do not use directly.
            [parameter(ValueFromRemainingArguments = $true)]
            [Object[]] $IgnoredArguments
        )
    
        if (!(Test-Path $ExePath)) { throw "Path doesn't exist: $ExePath" }
        if (!$Name) { $Name = Split-Path $ExePath -Leaf } else { $Name = $Name + '.exe' }
    
        $appPathKey = "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\$Name"
        if ($User) { $appPathKey = "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\$Name" }
    
        If (!(Test-Path $AppPathKey)) { New-Item "$AppPathKey" | Out-Null }
        Set-ItemProperty -Path $AppPathKey -Name "(Default)" -Value $ExePath
    }
    

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.

Maintainer(s)

Software Author(s)

  • chocolatey

Copyright

© 2016 Chocolatey Core Team Package Contributors

Tags

Release Notes

https://github.com/chocolatey/chocolatey-coreteampackages/tree/master/extensions/chocolatey-core.extension/CHANGELOG.md

Version History

Version Downloads Last updated Status
Chocolatey Core Extensions 1.3.2 18290 Tuesday, October 10, 2017 approved
Chocolatey Core Extensions 1.3.1 1511207 Tuesday, May 23, 2017 approved
Chocolatey Core Extensions 1.3.0 325438 Friday, April 21, 2017 approved
Chocolatey Core Extensions 1.2.0 371721 Monday, March 20, 2017 approved
Chocolatey Core Extensions 1.1.0 220977 Thursday, February 23, 2017 approved
Chocolatey Core Extensions 1.0.7 198031 Monday, February 13, 2017 approved
Chocolatey Core Extensions 1.0.6 111226 Wednesday, February 1, 2017 approved
Chocolatey Core Extensions 1.0.5 79686 Tuesday, January 24, 2017 approved
Chocolatey Core Extensions 1.0.4 328639 Monday, December 12, 2016 approved
Show More

Discussion for the Chocolatey Core Extensions Package

Ground rules:

  • This discussion is only about Chocolatey Core Extensions and the Chocolatey Core Extensions 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 Core Extensions, 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