PSComputerManagementZp

0.0.2

Private/Base/PlatformTools.ps1

function Test-Platform{
<#
.DESCRIPTION
    Test if the current platform is compatible with the arg `Name`.
    Currently, it only support Windows, Linux and Wsl2.
    If $Verbose is given, it will show the result.
.EXAMPLE
    Test-Platform -Name 'Windows' -Verbose
    Test-Platform -Name 'Wsl2' -Verbose
    Test-Platform -Name 'Linux' -Verbose
.OUTPUTS
    $true if compatible, otherwise $false.
#>
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param(
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string]$Name,
        [switch]$Throw
    )
    # if ($IsWindows){
    # Write-Verbose "Windows"
    # return 'Windows'
    # } elseif ($IsLinux -and (Test-IsWSL2)){
    # Write-Verbose "Wsl2"
    # return 'Wsl2'
    # } elseif ($IsLinux -and(!(Test-IsWSL2))){
    # Write-Verbose "Linux"
    # return 'Linux'
    # } else {
    # Write-Warning "The current platform, $($PSVersionTable.Platform), has not been supported yet."
    # return $null
    # }
    # see https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-7.3&viewFallbackFrom=powershell-6#islinux
    # for more information about $IsWindows and $IsLinux
    if ($IsWindows){
        if ($Name.ToLower() -eq "windows"){
            $info = "The current platform, $($PSVersionTable.Platform), is compatible with ${Name}."
            $output = $true
        } else {
            $info = "The platform, $($PSVersionTable.Platform), is not compatible with ${Name}."
            $output = $false
        }
    } elseif ($IsLinux -and (Test-IsWSL2)){
        if ($Name.ToLower() -eq "wsl2"){
            $info = "The current platform, $($PSVersionTable.Platform), is compatible with ${Name}."
            $output = $true
        } else {
            $info =  "The platform, $($PSVersionTable.Platform), is not compatible with ${Name}."
            $output = $false
        }
    } elseif ($IsLinux -and(!(Test-IsWSL2))){
        if ($Name.ToLower() -eq "linux"){
            $info = "The current platform, $($PSVersionTable.Platform), is compatible with ${Name}."
            $output = $true
        } else {
            $info = "The platform, $($PSVersionTable.Platform), is not compatible with ${Name}."
            $output = $false
        }
    } else {
        $info = "The current platform, $($PSVersionTable.Platform), has not been supported yet."
        $output = $null
    }

    if ($output -eq $true){
        Write-Verbose $info
    }elseif ($null -eq $output) {
        Write-Warning $info
    }else {
        <# Action when all if and elseif conditions are false #>
        if($Throw){
            throw $info
        }else{
            Write-Verbose $info
        }
    }
    if(!$Throw){
        return $output
    }
}


function Test-IsWSL2{
    $output = bash -c "cat /proc/version 2>&1"
    return $output.Contains("WSL2")
}

function Test-AdminPermission {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param()
    $current_user = [Security.Principal.WindowsIdentity]::GetCurrent()
    $principal = New-Object Security.Principal.WindowsPrincipal($current_user)

    if ($principal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
        return $true
    }else{
        return $false
    }
}
function Assert-AdminPermission {
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param()
    if (Test-AdminPermission){
        Write-Verbose "Current process is in AdminPermission."
    }else{
        Write-Verbose "Current process is not in AdminPermission."
        throw [System.UnauthorizedAccessException]::new("You must run in administrator privilege.")
    }
}
function Assert-AdminRobocopyAvailable{
    [CmdletBinding()]
    [OutputType([bool])]
    param()
    try {
        Robocopy > $null
    }
    catch {
        Write-Verbose "Exception: $PSItem"
        throw "The robocopy command is not available, please install it first."
    }
    Test-Platform -Name 'Windows' -Throw
    Assert-AdminPermission
}

function Assert-IsWindows{
    [CmdletBinding()]
    [OutputType([bool])]
    param()
    Test-Platform -Name 'Windows' -Throw
} 
function Assert-IsWindowsAndAdmin{
    [CmdletBinding()]
    [OutputType([bool])]
    param()
    Test-Platform -Name 'Windows' -Throw
    Assert-AdminPermission
}