Functions/GenXdev.Console.Spotify/Get-SpotifyApiToken.ps1

<##############################################################################
Part of PowerShell module : GenXdev.Console.Spotify
Original cmdlet filename : Get-SpotifyApiToken.ps1
Original author : René Vaessen / GenXdev
Version : 1.300.2025
################################################################################
Copyright (c) René Vaessen / GenXdev
 
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.
################################################################################>

###############################################################################
<#
.SYNOPSIS
Retrieves or generates a valid Spotify API authentication token.
 
.DESCRIPTION
This function manages Spotify API authentication by either retrieving a cached
token or obtaining a new one. It also ensures proper firewall access and
validates the token's functionality.
 
.EXAMPLE
$token = Get-SpotifyApiToken
#>

function Get-SpotifyApiToken {

    [CmdletBinding()]
    param()

    begin {

        # define firewall rule settings
        $ruleName = 'Allow Current PowerShell'
        $programPath = Microsoft.PowerShell.Management\Join-Path -Path $PSHOME -ChildPath 'pwsh.exe'
        $remoteAddress = '192.168.1.1'

        Microsoft.PowerShell.Utility\Write-Verbose "Checking firewall rule: $ruleName"
    }


    process {

        # verify if firewall rule exists
        $existingRule = NetSecurity\Get-NetFirewallRule `
            -DisplayName $ruleName `
            -ErrorAction SilentlyContinue

        # create firewall rule if it doesn't exist
        if ($null -eq $existingRule) {

            Microsoft.PowerShell.Utility\Write-Verbose 'Creating new firewall rule'
            NetSecurity\New-NetFirewallRule `
                -DisplayName $ruleName `
                -Direction Inbound `
                -Program $programPath `
                -Action Allow `
                -RemoteAddress $remoteAddress

            Microsoft.PowerShell.Utility\Write-Host "Firewall rule '$ruleName' created."
        }

        # path to cached authentication token
        $path = "$($Env:LOCALAPPDATA)\GenXdev.PowerShell\Spotify_Auth.json"

        # attempt to load existing token
        if ([IO.File]::Exists($path)) {

            Microsoft.PowerShell.Utility\Write-Verbose "Loading existing token from $path"
            $apiToken = [IO.File]::ReadAllText($path)
        }
        else {

            Microsoft.PowerShell.Utility\Write-Verbose 'No existing token found, connecting to Spotify'
            $apiToken = GenXdev.Console\Connect-SpotifyApiToken
            $null = GenXdev.Console\Set-SpotifyApiToken $apiToken
        }

        # validate token by attempting to list devices
        try {

            Microsoft.PowerShell.Utility\Write-Verbose 'Validating token by retrieving devices'
            $null = [GenXdev.Helpers.Spotify]::GetDevices($apiToken)
        }
        catch {

            Microsoft.PowerShell.Utility\Write-Verbose 'Token validation failed, obtaining new token'
            $apiToken = GenXdev.Console\Connect-SpotifyApiToken
            $null = GenXdev.Console\Set-SpotifyApiToken $apiToken
        }

        # return the valid token
        $apiToken
    }

    end {
    }
}