Assembly/Assembly.ps1

#region Copyright & License

# Copyright © 2012 - 2021 François Chabot
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#endregion

Set-StrictMode -Version Latest

function Get-AssemblyName {
    [CmdletBinding()]
    [OutputType([PSObject[]])]
    param(
        [Parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ } )]
        [PSObject[]]
        $Path,

        [Parameter(Mandatory = $false)]
        [switch]
        $Name,

        [Parameter(Mandatory = $false)]
        [switch]
        $FullName
    )
    process {
        $Path | ForEach-Object -Process { $_ } | ForEach-Object -Process {
            $assemblyName = [System.Reflection.AssemblyName]::GetAssemblyName($_)
            if ($Name) {
                $assemblyName.Name
            } elseif ($FullName) {
                $assemblyName.FullName
            } else {
                $assemblyName
            }
        }
    }
}

function Install-GacAssembly {
    [CmdletBinding()]
    [OutputType([void])]
    param(
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ } )]
        [string]
        $Path,

        [Parameter(Mandatory = $false)]
        [ValidateNotNullOrEmpty()]
        [string]
        $InstallReference
    )
    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    $arguments = @{  }
    $name = Get-AssemblyName -Path $Path
    $pathFileVersion = Get-Item -Path $Path | Select-Object -ExpandProperty VersionInfo | Select-Object -ExpandProperty FileVersion
    if (Test-GacAssembly -AssemblyName $name) {
        $gacFileVersion = Gac\Get-GacAssemblyFile -AssemblyName $name | Select-Object -ExpandProperty VersionInfo | Select-Object -ExpandProperty FileVersion
        if ($pathFileVersion -ge $gacFileVersion) {
            Write-Verbose -Message "Installing same or newer version of the assembly file in GAC [$pathFileVersion >= $gacFileVersion]."
            $arguments.LiteralPath = $Path
        } else {
            Write-Verbose -Message "Installing same version of the assembly file in GAC though an older version was given [$pathFileVersion < $gacFileVersion]."
            $arguments.LiteralPath = Gac\Get-GacAssemblyFile -AssemblyName $name | Select-Object -ExpandProperty FullName
        }
    } else {
        Write-Verbose -Message "Installing new assembly file in GAC [$pathFileVersion]."
        $arguments.LiteralPath = $Path
    }
    if (-not [string]::IsNullOrEmpty($InstallReference)) { $arguments.InstallReference = New-GacAssemblyInstallReference -InstallReference $InstallReference }
    Gac\Add-GacAssembly @arguments -Force -Verbose:($VerbosePreference -eq 'Continue')
}

function New-GacAssemblyInstallReference {
    [CmdletBinding()]
    [OutputType([PowerShellGac.InstallReference])]
    param(
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $InstallReference
    )
    Gac\New-GacAssemblyInstallReference -Type Opaque `
        -Identifier $InstallReference `
        -Description 'Installed by BizTalk.Deployment PowerShell Module.'
}

function Test-GacAssembly {
    [CmdletBinding()]
    [OutputType([bool])]
    param(
        [Parameter(Mandatory = $true, ParameterSetName = 'name')]
        [ValidateNotNullOrEmpty()]
        [System.Reflection.AssemblyName]
        $AssemblyName,

        [Parameter(Mandatory = $true, ParameterSetName = 'path')]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ } )]
        [string]
        $Path
    )
    if ($PSCmdlet.ParameterSetName -eq 'path') { $AssemblyName = Get-AssemblyName -Path $Path }
    [bool](Gac\Get-GacAssembly -AssemblyName $AssemblyName)
}

function Test-GacAssemblyInstallReference {
    [CmdletBinding()]
    [OutputType([bool])]
    param(
        [Parameter(Mandatory = $true, ParameterSetName = 'name')]
        [ValidateNotNullOrEmpty()]
        [System.Reflection.AssemblyName]
        $AssemblyName,

        [Parameter(Mandatory = $true, ParameterSetName = 'path')]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ } )]
        [string]
        $Path,

        [Parameter(Mandatory = $false, ParameterSetName = 'name')]
        [Parameter(Mandatory = $false, ParameterSetName = 'path')]
        [ValidateNotNull()]
        [PowerShellGac.InstallReference]
        $InstallReference
    )
    if ($PSCmdlet.ParameterSetName -eq 'path') { $AssemblyName = Get-AssemblyName -Path $Path }
    Gac\Get-GacAssemblyInstallReference -AssemblyName $AssemblyName |
        <# let it thru any pending InstallReference if none was given to filter on, or only the one equal to the given one otherwise, see https://stackoverflow.com/a/47577074/1789441 #>
        Where-Object { ($null -eq $InstallReference) -or -not(Compare-Object -ReferenceObject $_ -DifferenceObject $InstallReference -Property $InstallReference.PSObject.Properties.Name) } |
        Test-Any
}

function Uninstall-GacAssembly {
    [CmdletBinding()]
    [OutputType([void])]
    param(
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ } )]
        [string]
        $Path,

        [Parameter(Mandatory = $false)]
        [ValidateNotNullOrEmpty()]
        [string]
        $InstallReference
    )
    Resolve-ActionPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
    $arguments = @{ AssemblyName = Get-AssemblyName -Path $Path }
    if (Test-GacAssembly @arguments) {
        if ([string]::IsNullOrEmpty($InstallReference)) {
            if (Test-GacAssemblyInstallReference @arguments) {
                Write-Verbose -Message 'The assembly cannot be uninstalled from GAC because it has pending InstallReferences and none was given.'
            } else {
                Write-Verbose -Message 'Uninstalling assembly without pending InstallReferences from GAC.'
                Gac\Remove-GacAssembly @arguments -Verbose:($VerbosePreference -eq 'Continue')
            }
        } else {
            $arguments.InstallReference = New-GacAssemblyInstallReference -InstallReference $InstallReference
            if (Test-GacAssemblyInstallReference @arguments) {
                # Twisted logic and ErrorAction due to https://github.com/LTruijens/powershell-gac/issues/2
                Write-Verbose -Message "Uninstalling assembly from GAC or removing pending InstallReference '$InstallReference'."
                Gac\Remove-GacAssembly @arguments -Verbose:($VerbosePreference -eq 'Continue') -ErrorAction SilentlyContinue
                # ensure assembly has been removed from gac and if not try again without silencing any error in a last paranoiac attempt
                if (Test-GacAssemblyInstallReference @arguments) {
                    Write-Warning -Message "Failed to uninstall assembly from GAC or to remove pending InstallReference '$InstallReference'. Trying again..."
                    Gac\Remove-GacAssembly @arguments -Verbose:($VerbosePreference -eq 'Continue')
                }
            } else {
                Write-Verbose -Message 'The assembly cannot be uninstalled from GAC because the given InstallReference is not pending.'
            }
        }
    } else {
        Write-Verbose -Message 'The assembly is not installed in the GAC.'
    }
}

# SIG # Begin signature block
# MIII0QYJKoZIhvcNAQcCoIIIwjCCCL4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUm9P8nYwxZwsU9vIuifIKXW61
# 9p6gggVMMIIFSDCCAzCgAwIBAgIJAJkr3mJdTBkUMA0GCSqGSIb3DQEBCwUAMEEx
# PzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQAYQB0
# AGUAbABlAHMAcwAuAGIAZTAeFw0yMTA2MjUxNDEyMjNaFw00MTA2MjAxNDEyMjNa
# MEExPzA9BgNVBAMeNgBpAGMAcgBhAGYAdABzAG8AZgB0AHcAYQByAGUAQABzAHQA
# YQB0AGUAbABlAHMAcwAuAGIAZTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC
# ggIBAOeqdUHBv7sxSeX3aj6yPKj7PAvs8izpVXjyEBl5aR8mQneVcXuF53AH7EW1
# 6E5p4+Az5pJPGUD5c3tXhiGMF7vgLhQjO6hlaVBRIqiIYHikNLwMNy6YBMc/QQYM
# rPhqHEFsZ53dkBIIj3M8e3kFcTFA09n25yDtTPDab4nd9yUhc9Qc8+nfpIzfYsoP
# 1pZ3nCzhw6hN2/44v1dkQrG3dRYwt+px65p6NPNZWEJpt4VCJjIFh+lBYJdxm9d4
# X/rAnlHIkbv7liOavWDzgHVabS3hdAWtcDmynm+7+FcZDFqPWNCl3e4SS7xe4s/R
# CKFKA0IsfKkSk9YJlLgeSQIEXUOOWXJAGaLqnRD8xWLZsc4Oi9GZg7XV1mv/S88c
# oztXnwtAN3OOlRKBh2QbomMgxeMO0GvsLE/cq5Q/YKAoz+KGr/7LcZq9jzQ8IPus
# ZvWLeDXmxPiwJjpZc1koLgfGIEX2NStQTT3QmacWr9thrWcKvI+4uBmI4exS9B4a
# R3nV91w5EY+2RoYsHqej9LWwNamO96+jMX9pxprTX+EkLUuMAikw/po8sBC9MUUn
# 5pMWmUv7DCtQOLGGBDDMMMkn4ZcjpCEEdPGHRKfqNnD27ssGtDjiNzfQrsm67toU
# bBwUF+gyJq/YckWquYJhA9ZOFWEADuIwGnsOzsoRvuQyY+p9AgMBAAGjQzBBMA4G
# A1UdDwEB/wQEAwIHgDAWBgNVHSUBAf8EDDAKBggrBgEFBQcDAzAXBgNVHREEEDAO
# ggxzdGF0ZWxlc3MuYmUwDQYJKoZIhvcNAQELBQADggIBACithYM3qckZRc9+Xbfu
# a6gWr3HwjrW+FHKgjfrcOm8ZnLVapb9xFqsqrRQqd3RXWQDINEGrtI2rSfrzyfoK
# UiTgldIfQNP1ZcGY229d++90t3hdo2mlt05hjYlbMENloJHpsEP0vQZmwOcEimCT
# ex1pymYM+P9pj3j8UD1PT1eIZot6or8fBRl63UybyDSrM7L4UOkkAOniKxWy5pW6
# 6duS8SR+SZpr3Bv44NyXPj0Nv+MIpLmsLrd7XPBFmnGxzY01ZO9vzi9KEhM2wT5i
# jPqHDNOvfPiADtAa+EyUBzdJiqy9heCz/TMZQgMWGwtfqJNxWZmsHcha2anW4Qt+
# mzrLO4GojWoVog9uVSAq+l0a+YQsd1u1kUmm4vgZCFyUA+lEp4LkI7ca2VBHkLPD
# w+u2DoDMRiqFPZjO7BCKjGc0jj9B/qGR3JVt+tqDdB621xXf2YGF2oFvxZQ/keGt
# 0ujfJ+JwN3nCulDAA4773q6KUnfykyrvAgITNbRJL6TngeRKtw9VIJBPxzqMzLpV
# 5ggXNituwLaD1CCBJ1oo9DZHpL9gplXp1wGrelJOTiJhh+pdNsPtRH7CrranWa5h
# LFLuigqin0eewQ5giJ1VaiBVEseOmiZog+27UpFIv40aDzgGL3YxB/Mu0ojwrQtp
# WLmqJCmWnR5qxOm0yK+zNWe0MYIC7zCCAusCAQEwTjBBMT8wPQYDVQQDHjYAaQBj
# AHIAYQBmAHQAcwBvAGYAdAB3AGEAcgBlAEAAcwB0AGEAdABlAGwAZQBzAHMALgBi
# AGUCCQCZK95iXUwZFDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAA
# oQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4w
# DAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUuX0y2jbHpUXtImKpBem4SjKC
# /PYwDQYJKoZIhvcNAQEBBQAEggIAjbbm+7XNBL3sg/cARLu/T7ZYheO3tHLm6K24
# YXLREbQ2O3iys7a94WOWgRN1egl9av151sgt1qowLadAey36Wtw5RJsIDlvPNyty
# CbKUeZbRAOVnf3G7vNcefRYUIutO0kNdO0tPxCi04o5+E37jU2oCx9y+2OHXXjs0
# gZRm0Wz19qqGLhA+Cr68nUA78EYwHsqc0bVjkxjSXEIPW6RvRFpGZ3F0xL8nCuZe
# bw2Uf6FFhx1QPlYKRWjaztHb/YLG5kolFC92yhBV5S1PRkF4+HmW3LyrBfzpNASH
# lVELe4s0Eh90DJUD3rIwyMJXNB+ito+XTM5PIIXdIoVq3MgkeRsyMfhyxBh49SCq
# Uh+3GGsqourYKosbaeg5tLUvVC0r2Rg9Lzdl4QoCtI9UQ4GdCGSQjK5w/0JryeOE
# Zpj8iv1OO6TKwhqvkDCHU6hN2/e9lOdJDbgUi1WlJhqXjl70/CYZ2YtWVwqZF+av
# V/ZEad2TpR0qf9hTcXhdqLFs9EPZOhKZaMt2AvKMBHWMoctAE4EF6va8MNWII8fW
# 71Wh7J1rq+Pdbkw1cahwIj4AdLkk1EABqCnblxetclXdfFaP2kCLl7esObmYeKza
# vi5fRmF072CLhv67g6oXy6d9ITHN0Vb5KLqZkaxLS++uyheNP98WI6MjsaPYajtC
# xk8BTFs=
# SIG # End signature block