getiplayer (Install) 3.26

choco upgrade getiplayer -y --source="'STEP 3 URL'" [other options]

choco upgrade getiplayer -y --source="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

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

Exit $exitCode

- name: Ensure getiplayer installed
  win_chocolatey:
    name: getiplayer
    state: present
    version: 3.26
    source: STEP 3 URL

chocolatey_package 'getiplayer' do
  action    :install
  version  '3.26'
  source   'STEP 3 URL'
end

Chocolatey::Ensure-Package
(
    Name: getiplayer,
    Version: 3.26,
    Source: STEP 3 URL
);

cChocoPackageInstaller getiplayer
{
   Name     = 'getiplayer'
   Ensure   = 'Present'
   Version  = '3.26'
   Source   = 'STEP 3 URL'
}

package { 'getiplayer':
  provider => 'chocolatey',
  ensure   => '3.26',
  source   => 'STEP 3 URL',
}

salt '*' chocolatey.install getiplayer version="3.26" source="STEP 3 URL"

# Update get_iplayer to new version

import subprocess
import os
from shutil import copyfile
import requests

def replaceInTag(text, tag_name, new_inner):
    start_tag, end_tag = '<' + tag_name + '>', '</' + tag_name + '>'
    start_pos, end_pos = text.find(start_tag), nuspec.find(end_tag)

    text = text[:start_pos] + start_tag + new_inner + text[end_pos:]
    return text

# folders
user_dir = os.environ['USERPROFILE']
app_name = 'get_iplayer'
choco_name = 'getiplayer'
get_iplayer_folder = os.path.join(user_dir, 'GitHub', app_name)
wiki_folder = get_iplayer_folder + '_wiki'
choco_folder = os.path.join(user_dir, 'Documents', 'Scripts', choco_name)

# update GitHub + wiki folders (I think 'fetch' is correct)
assert subprocess.call('git fetch', cwd=get_iplayer_folder) == 0
assert subprocess.call('git fetch', cwd=wiki_folder) == 0

nuspec_filename = os.path.join(choco_folder, choco_name + '.nuspec')
nuspec = open(nuspec_filename, encoding='utf-8').read()

authors = open(os.path.join(get_iplayer_folder, 'CONTRIBUTORS')).read().replace('\n', ', ')[:-2]
nuspec = replaceInTag(nuspec, 'authors', authors)

release_notes = open(os.path.join(wiki_folder, 'releasenotes.md')).read().splitlines()

# find first link - should point to the newest version
for line in release_notes:
    start_pos, mid_pos, end_pos = line.find('['), line.find(']('), line.find(')')
    if -1 in (start_pos, mid_pos, end_pos):
        continue
    link_name = line[start_pos+1:mid_pos]
    link_dest = line[mid_pos+2:end_pos]
    if link_name.startswith(app_name):
        version = link_name.split(' ')[1]
        break

print(app_name + ' version ' + version)
nuspec = replaceInTag(nuspec, 'version', version)

# get info from readme
readme = open(os.path.join(get_iplayer_folder, 'README.md')).read().splitlines()

# get first two sections (title and 'Features')
description = ''
sections = 0
for line in readme:
    if line.startswith('## '):
        sections += 1
        if sections > 2:
            break
    description += line.replace('<', '`').replace('>', '`') + '\n'

nuspec = replaceInTag(nuspec, 'description', description)

release_notes_file, link_name = link_dest.split('#')
release_notes = open(os.path.join(wiki_folder, release_notes_file + '.md'), encoding='utf-8').read().splitlines()

new_release_notes = ''
in_section = False
for line in release_notes:
    if line.startswith('<a name="' + link_name + '"/>'):
        in_section = True
        continue
    if in_section:
        if line.startswith('<a name="'):  # next section
            break
        new_release_notes += line.replace('<', '`').replace('>', '`') + '\n'  # < and > need to be escaped

print(new_release_notes)
nuspec = replaceInTag(nuspec, 'releaseNotes', new_release_notes)
copyfile(nuspec_filename, nuspec_filename + '.bak')
open(nuspec_filename, 'w', encoding='utf-8').write(nuspec)

# get binary info
json = requests.get("https://api.github.com/repos/get-iplayer/get_iplayer_win32/releases/latest").content
release = eval(json.replace(b'false', b'False').replace(b'null', b'None').replace(b'true', b'True'))

for asset in release['assets']:
    name = asset['name']
    url = asset['browser_download_url']
    if name.endswith('.exe'):
        exe_url = url
    elif name.endswith('.sha1'):
        sha1 = requests.get(url).content.decode('utf-8').split(' ')[0]
    elif name.endswith('.sha256'):
        sha256 = requests.get(url).content.decode('utf-8').split(' ')[0]

# update the exe URL and checksums in the install file
install_file = os.path.join(choco_folder, 'tools', 'chocolateyinstall.ps1')
install = open(install_file, encoding='utf-8').read().splitlines()
new_install = ''
for line in install:
    pos = line.find("'")
    if line.startswith('$url'):
        line = line[:pos] + "'" + exe_url + "'"
    elif 'checksum ' in line:
        line = line[:pos] + "'" + sha1 + "'"
    elif 'checksum64' in line:
        line = line[:pos] + "'" + sha256 + "'"
    new_install += line + '\n'

open(install_file, 'w', encoding='utf-8').write(new_install)

# package and push to server
assert subprocess.call('choco pack', cwd=choco_folder) == 0
assert subprocess.call('choco push', cwd=choco_folder) == 0

Open getiplayer.nuspec in Notepad++
Update
 version
 authors 
  replace \n with , in https://github.com/get-iplayer/get_iplayer/blob/master/CONTRIBUTORS
 description 
  just the first (Features) section of https://raw.githubusercontent.com/get-iplayer/get_iplayer/master/README.md
  replace < and > with [ and ]
 releaseNotes                                            XXX
  https://github.com/get-iplayer/get_iplayer/wiki/release320to329/_edit
  put links in for previous release notes
  replace angle brackets with &lt; and &gt; (doesn't work within `code tags`, so replace and remove the ` characters)

Go to https://github.com/get-iplayer/get_iplayer_win32/releases/latest to get URLs and checksums
Open tools/chocolateyinstall.ps1 in Notepad++
Update 
 $url
 checksum

Admin command prompt
c:
cd \Users\bjs54\Documents\Scripts\getiplayer
choco pack
del getiplayer.3.XX.nupkg  <-- previous version
choco push

Hopefully the 'push' command means the below is unnecessary:

https://chocolatey.org/packages/getiplayer/
Login
Upload C:\Documents\Scripts\getiplayer\getiplayer.3.XX.nupkg

Profit!!!!
## Summary
How do I create packages? See https://chocolatey.org/docs/create-packages

If you are submitting packages to the community feed (https://chocolatey.org)
always try to ensure you have read, understood and adhere to the create
packages wiki link above.

## Automatic Packaging Updates?
Consider making this package an automatic package, for the best 
maintainability over time. Read up at https://chocolatey.org/docs/automatic-packages

## Shim Generation
Any executables you include in the package or download (but don't call 
install against using the built-in functions) will be automatically shimmed.

This means those executables will automatically be included on the path.
Shim generation runs whether the package is self-contained or uses automation 
scripts. 

By default, these are considered console applications.

If the application is a GUI, you should create an empty file next to the exe 
named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'.
See https://chocolatey.org/docs/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui

If you want to ignore the executable, create an empty file next to the exe 
named 'name.exe.ignore' e.g. 'bob.exe' would need a file named 
'bob.exe.ignore'. 
See https://chocolatey.org/docs/create-packages#how-do-i-exclude-executables-from-getting-shims

## Self-Contained? 
If you have a self-contained package, you can remove the automation scripts 
entirely and just include the executables, they will automatically get shimmed, 
which puts them on the path. Ensure you have the legal right to distribute 
the application though. See https://chocolatey.org/docs/legal. 

You should read up on the Shim Generation section to familiarize yourself 
on what to do with GUI applications and/or ignoring shims.

## Automation Scripts
You have a powerful use of Chocolatey, as you are using PowerShell. So you
can do just about anything you need. Choco has some very handy built-in 
functions that you can use, these are sometimes called the helpers.

### Built-In Functions
https://chocolatey.org/docs/helpers-reference

A note about a couple:
* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://chocolatey.org/docs/helpers-get-tools-location
* Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://chocolatey.org/docs/helpers-install-bin-file
* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://chocolatey.org/docs/helpers-uninstall-bin-file

### Getting package specific information
Use the package parameters pattern - see https://chocolatey.org/docs/how-to-parse-package-parameters-argument

### Need to mount an ISO?
https://chocolatey.org/docs/how-to-mount-an-iso-in-chocolatey-package

### Environment Variables
Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):

 * TEMP = Overridden to the CacheLocation, but may be the same as the original TEMP folder
 * ChocolateyInstall = Top level folder where Chocolatey is installed
 * chocolateyPackageName = The name of the package, equivalent to the id in the nuspec (0.9.9+)
 * chocolateyPackageVersion = The version of the package, equivalent to the version in the nuspec (0.9.9+)
 * chocolateyPackageFolder = The top level location of the package folder

#### Advanced Environment Variables
The following are more advanced settings:

 * chocolateyPackageParameters = (0.9.8.22+)
 * CHOCOLATEY_VERSION = The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+)
    - Otherwise take a dependency on the specific version you need. 
 * chocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+)
    - Automatically handled in built in Choco functions. 
 * OS_PLATFORM = Like Windows, OSX, Linux. (0.9.9+)
 * OS_VERSION = The version of OS, like 6.1 something something for Windows. (0.9.9+)
 * OS_NAME = The reported name of the OS. (0.9.9+)
 * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+)

#### Experimental Environment Variables
The following are experimental or use not recommended:

 * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+)
 * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+)
    - it's based on git describe
 * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+)
 * chocolateyInstallOverride = Not for use in package automation scripts. (0.9.9+)
 * chocolateyInstallArguments = the installer arguments meant for the native installer. You should use chocolateyPackageParameters intead. (0.9.9+)

$ErrorActionPreference = 'Stop';

$packageName= 'getiplayer'
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$url        = 'https://github.com/get-iplayer/get_iplayer_win32/releases/download/3.26.0/get_iplayer-3.26.0-windows-x86-setup.exe'
$url64      = 'https://github.com/get-iplayer/get_iplayer_win32/releases/download/3.26.0/get_iplayer-3.26.0-windows-x64-setup.exe'

$packageArgs = @{
  packageName   = $packageName
  unzipLocation = $toolsDir
  fileType      = 'exe'
  url           = $url
  url64bit      = $url64

  softwareName  = 'getiplayer*'

  checksum      = '40938475dca461db8113908d2821e5b4e8b2ad653f9356d2ed7bb51d26529491'
  checksumType  = 'sha256'
  checksum64    = 'd0aaf1deda84a7dc15e558fa7e1b002140e4c9df3089becc5d08697f7e576fa2'
  checksumType64= 'sha256'

  silentArgs   = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-'
}

Install-ChocolateyPackage @packageArgs

$ErrorActionPreference = 'Stop';

$packageName = 'getiplayer'
$softwareName = 'get_iplayer*'
$installerType = 'EXE' 

$silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-'
$validExitCodes = @(0, 3010, 1605, 1614, 1641)
if ($installerType -ne 'MSI') {
  $silentArgs = '/S'
  $validExitCodes = @(0)
}

$uninstalled = $false
[array]$key = Get-UninstallRegistryKey -SoftwareName $softwareName

if ($key.Count -eq 1) {
  $key | % { 
    $file = "$($_.UninstallString)"

    if ($installerType -eq 'MSI') {
      $silentArgs = "$($_.PSChildName) $silentArgs"

      $file = ''
    }

    Uninstall-ChocolateyPackage -PackageName $packageName `
                                -FileType $installerType `
                                -SilentArgs "$silentArgs" `
                                -ValidExitCodes $validExitCodes `
                                -File "$file"
  }
} elseif ($key.Count -eq 0) {
  Write-Warning "$packageName has already been uninstalled by other means."
} elseif ($key.Count -gt 1) {
  Write-Warning "$key.Count matches found!"
  Write-Warning "To prevent accidental data loss, no programs will be uninstalled."
  Write-Warning "Please alert package maintainer the following keys were matched:"
  $key | % {Write-Warning "- $_.DisplayName"}
}

Version	Downloads	Last Updated	Status
getiplayer (Install) 3.26	211	Tuesday, June 30, 2020	Approved
getiplayer (Install) 3.25	376	Monday, February 3, 2020	Approved
getiplayer (Install) 3.24	124	Friday, January 10, 2020	Approved
getiplayer (Install) 3.23	149	Wednesday, December 4, 2019	Approved
getiplayer (Install) 3.22	254	Tuesday, August 20, 2019	Approved
getiplayer (Install) 3.21	188	Monday, July 15, 2019	Approved
getiplayer (Install) 3.20	273	Tuesday, February 26, 2019	Approved
getiplayer (Install) 3.18	199	Thursday, January 3, 2019	Approved
getiplayer (Install) 3.16	369	Friday, July 6, 2018	Approved
getiplayer (Install) 3.15	150	Thursday, July 5, 2018	Approved
getiplayer (Install) 3.14	266	Wednesday, May 9, 2018	Approved
getiplayer (Install) 3.13	279	Tuesday, March 27, 2018	Approved
getiplayer (Install) 3.12	331	Monday, January 15, 2018	Approved
getiplayer (Install) 3.10	242	Friday, January 12, 2018	Approved
getiplayer (Install) 3.09	336	Tuesday, January 2, 2018	Approved
getiplayer (Install) 3.07	299	Wednesday, November 29, 2017	Approved
getiplayer (Install) 3.06	297	Wednesday, November 1, 2017	Approved
getiplayer (Install) 3.05	310	Friday, October 13, 2017	Approved
getiplayer (Install) 3.04	230	Friday, October 13, 2017	Approved
getiplayer (Install) 3.03	302	Monday, October 2, 2017	Approved
getiplayer (Install) 3.02	332	Monday, August 21, 2017	Approved
getiplayer (Install) 3.01	369	Monday, May 8, 2017	Approved
getiplayer (Install) 3.00	277	Tuesday, May 2, 2017	Approved
getiplayer (Install) 2.99.20170410	311	Monday, April 10, 2017	Approved
getiplayer (Install) 2.99	353	Wednesday, February 22, 2017	Approved
getiplayer (Install) 2.97	303	Monday, October 31, 2016	Approved

7,246

211

30 Jun 2020

getiplayer (Install)

getiplayer (Install) 3.26

All Checks are Passing

1. Ensure you are set for organizational deployment

3. Enter your internal repository url

4. Choose your deployment method:

5. If applicable - Chocolatey configuration/installation

get_iplayer: BBC iPlayer/BBC Sounds Indexing Tool and PVR

Features

Changes in 3.26

Installation

More Information

Ground Rules: