PoshBot

0.11.7

Plugins/Builtin/Public/Update-Plugin.ps1


function Update-Plugin {
    <#
    .SYNOPSIS
        Updates an existing plugin to a newer version.
    .PARAMETER Name
        The name of the plugin to update.
    .PARAMETER Version
        The version to update to.
    .PARAMETER RemoveOldVersions
        Remove all previous versions of the plugin after update.
    .EXAMPLE
        !update-plugin --name myplugin

        Update the [myplugin] plugin to the latest available.
    .EXAMPLE
        !update-plugin --name myplugin --version 1.2.3

        Update the [myplugin] plugin to version [1.2.3].
    .EXAMPLE
        !update-plugin --name myplugin --removeoldversions

        Update the [myplugin] plugin and remove any old versions.
    #>
    [PoshBot.BotCommand(
        Aliases = ('up', 'updateplugin'),
        Permissions = 'manage-plugins'
    )]
    [cmdletbinding()]
    param(
        [parameter(Mandatory)]
        $Bot,

        [parameter(Mandatory, Position = 0)]
        [string[]]$Name,

        [parameter(Position = 1)]
        [ValidateScript({
            if ($_ -as [Version]) {
                $true
            } else {
                throw 'Version parameter must be a valid semantic version string (1.2.3)'
            }
        })]
        [string]$Version,

        [switch]$RemoveOldVersions
    )

    foreach ($item in $Name) {
        if ($item -eq 'Builtin') {
            New-PoshBotCardResponse -Type Warning -Text 'The builtin plugin cannot be updated as it is shipped with PoshBot' -Title 'Not gonna do it'
            continue
        }

        # Attempt to find the module in $env:PSModulePath or in the configurated repository
        $existingPlugin = $Bot.PluginManager.Plugins[$item]
        if (-not $existingPlugin) {
            New-PoshBotCardResponse -Type Warning -Text "Plugin [$item] is not installed. The plugin must be installed before you can update it."
            return
        } else {
            $existingPluginVersions = $existingPlugin.Keys | Sort-Object -Descending

            try {
                # Update to the latest available or to a specific version
                $params = @{
                    Name = $item
                    Force = $true
                    Confirm = $false
                }
                if ($PSBoundParameters.ContainsKey('Version')) {
                    $params.RequiredVersion = $Version
                }

                # Update module
                if ($PSBoundParameters.ContainsKey('Version')) {
                    # Only update the module if the desired version is not already on the system
                    if (-not (Get-Module -Name $item -ListAvailable | Where-Object {$_.Version -eq $Version})) {
                        Update-module @params
                    }
                    $newMod = Get-Module -Name $item -ListAvailable | Where-Object {$_.Version -eq $Version}
                } else {
                    Update-module @params
                    $newMod = @(Get-Module -Name $item -ListAvailable | Sort-Object -Property Version -Descending)[0]
                }

                # Install the module into PoshBot
                if ($existingPluginVersions -notcontains $newMod.Version) {
                    $Bot.PluginManager.InstallPlugin($newMod.Path, $true)

                    $resp = Get-Plugin -Bot $Bot -Name $item -Version $newMod.Version
                    if (-not ($resp | Get-Member -Name 'Title' -MemberType NoteProperty)) {
                        $resp | Add-Member -Name 'Title' -MemberType NoteProperty -Value $null
                    }
                    $resp.Title = "Plugin [$item] updated to version [$($newMod.Version)]"

                    # Remove any old versions
                    if ($RemoveOldVersions) {
                        $existingPlugin = $Bot.PluginManager.Plugins[$item]
                        $oldKeys = $existingPlugin.Keys | Where-Object {$_ -ne $newMod.Version}
                        $oldKeys | ForEach-Object {
                            $Bot.PluginManager.RemovePlugin($item, $_)
                        }
                    }

                    $resp
                }
            } catch {
                New-PoshBotCardResponse -Type Error -Text $_.Exception.Message -Title 'Rut row' -ThumbnailUrl $thumb.rutrow
            }
        }
    }
}