Public/Get-PatLibraryPath.ps1
|
function Get-PatLibraryPath { <# .SYNOPSIS Retrieves library section paths from a Plex server. .DESCRIPTION Gets the configured filesystem paths for Plex library sections. Returns paths for all sections, a specific section by ID, or a specific section by name. .PARAMETER ServerUri The base URI of the Plex server (e.g., http://plex.example.com:32400) If not specified, uses the default stored server. .PARAMETER SectionId The ID of the library section. If omitted, returns paths for all sections. .PARAMETER SectionName The friendly name of the library section (e.g., "Movies", "TV Shows") .EXAMPLE Get-PatLibraryPath Retrieves all configured paths for all library sections from the default stored server. .EXAMPLE Get-PatLibraryPath -ServerUri "http://plex.example.com:32400" -SectionId 1 Retrieves all configured paths for library section 1. .EXAMPLE Get-PatLibraryPath -SectionId 2 Retrieves all configured paths for library section 2 from the default stored server. .EXAMPLE Get-PatLibraryPath -SectionName "Movies" Retrieves all configured paths for the "Movies" library section. .OUTPUTS PSCustomObject #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSReviewUnusedParameter', 'commandName', Justification = 'Standard ArgumentCompleter parameter, not always used' )] [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSReviewUnusedParameter', 'parameterName', Justification = 'Standard ArgumentCompleter parameter, not always used' )] [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSReviewUnusedParameter', 'commandAst', Justification = 'Standard ArgumentCompleter parameter, not always used' )] [CmdletBinding(DefaultParameterSetName = 'All')] param ( [Parameter(Mandatory = $false, ParameterSetName = 'ByName')] [ValidateNotNullOrEmpty()] [ArgumentCompleter({ param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) # Strip leading quotes for matching (case-insensitive) $quoteChar = '' $strippedWord = $wordToComplete if ($wordToComplete -match "^([`"'])(.*)$") { $quoteChar = $Matches[1] $strippedWord = $Matches[2] } # Use provided ServerUri if available, otherwise use default server if ($fakeBoundParameters.ContainsKey('ServerUri')) { try { $sections = Get-PatLibrary -ServerUri $fakeBoundParameters['ServerUri'] -ErrorAction 'SilentlyContinue' foreach ($sectionTitle in $sections.Directory.title) { if ($sectionTitle -ilike "$strippedWord*") { if ($quoteChar) { $completionText = "$quoteChar$sectionTitle$quoteChar" } elseif ($sectionTitle -match '\s') { $completionText = "'$sectionTitle'" } else { $completionText = $sectionTitle } [System.Management.Automation.CompletionResult]::new($completionText, $sectionTitle, 'ParameterValue', $sectionTitle) } } } catch { # Silently fail if server is unavailable } } else { # Fall back to default server - don't pass ServerUri so Get-PatLibrary retrieves server object with token try { $sections = Get-PatLibrary -ErrorAction 'SilentlyContinue' foreach ($sectionTitle in $sections.Directory.title) { if ($sectionTitle -ilike "$strippedWord*") { if ($quoteChar) { $completionText = "$quoteChar$sectionTitle$quoteChar" } elseif ($sectionTitle -match '\s') { $completionText = "'$sectionTitle'" } else { $completionText = $sectionTitle } [System.Management.Automation.CompletionResult]::new($completionText, $sectionTitle, 'ParameterValue', $sectionTitle) } } } catch { # Silently fail if default server retrieval fails } } })] [string] $SectionName, [Parameter(Mandatory = $false, ParameterSetName = 'ById')] [ValidateRange(1, [int]::MaxValue)] [ArgumentCompleter({ param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) # Strip leading quotes for matching $strippedWord = $wordToComplete -replace "^[`"']", '' # Use provided ServerUri if available, otherwise use default server if ($fakeBoundParameters.ContainsKey('ServerUri')) { try { $sections = Get-PatLibrary -ServerUri $fakeBoundParameters['ServerUri'] -ErrorAction 'SilentlyContinue' $sections.Directory | ForEach-Object { $sectionId = ($_.key -replace '.*/(\d+)$', '$1') if ($sectionId -ilike "$strippedWord*") { [System.Management.Automation.CompletionResult]::new($sectionId, "$sectionId - $($_.title)", 'ParameterValue', "$($_.title) (ID: $sectionId)") } } } catch { # Silently fail if server is unavailable } } else { # Fall back to default server - don't pass ServerUri so Get-PatLibrary retrieves server object with token try { $sections = Get-PatLibrary -ErrorAction 'SilentlyContinue' $sections.Directory | ForEach-Object { $sectionId = ($_.key -replace '.*/(\d+)$', '$1') if ($sectionId -ilike "$strippedWord*") { [System.Management.Automation.CompletionResult]::new($sectionId, "$sectionId - $($_.title)", 'ParameterValue', "$($_.title) (ID: $sectionId)") } } } catch { # Silently fail if default server retrieval fails } } })] [int] $SectionId, [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [ValidateScript({ if ($_ -notmatch '^https?://[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)*(:[0-9]{1,5})?$') { throw "ServerUri must be a valid HTTP or HTTPS URL (e.g., http://plex.local:32400)" } $true })] [string] $ServerUri ) # Use default server if ServerUri not specified $effectiveUri = $ServerUri $usingDefaultServer = $false if (-not $ServerUri) { try { $server = Get-PatStoredServer -Default -ErrorAction 'Stop' if (-not $server) { throw "No default server configured. Use Add-PatServer with -Default or specify -ServerUri." } $effectiveUri = $server.uri $usingDefaultServer = $true } catch { throw "Failed to get default server: $($_.Exception.Message)" } } try { # Get all sections first # If using default server, don't pass ServerUri so Get-PatLibrary can retrieve server object with token if ($usingDefaultServer) { $allSections = Get-PatLibrary -ErrorAction 'Stop' } else { $allSections = Get-PatLibrary -ServerUri $effectiveUri -ErrorAction 'Stop' } # If SectionName is provided, filter to that section if ($SectionName) { $matchingSection = $allSections.Directory | Where-Object { $_.title -eq $SectionName } if (-not $matchingSection) { throw "Library section '$SectionName' not found" } # Return Location objects enriched with section context if ($matchingSection.Location) { foreach ($location in $matchingSection.Location) { [PSCustomObject]@{ id = $location.id path = $location.path section = $matchingSection.title sectionId = ($matchingSection.key -replace '.*/(\d+)$', '$1') sectionType = $matchingSection.type } } } else { Write-Verbose "No paths configured for section '$SectionName'" } } elseif ($SectionId) { # Filter to specific section by ID $matchingSection = $allSections.Directory | Where-Object { ($_.key -replace '.*/(\d+)$', '$1') -eq $SectionId.ToString() } if (-not $matchingSection) { throw "Library section with ID $SectionId not found" } # Return Location objects enriched with section context if ($matchingSection.Location) { foreach ($location in $matchingSection.Location) { [PSCustomObject]@{ id = $location.id path = $location.path section = $matchingSection.title sectionId = ($matchingSection.key -replace '.*/(\d+)$', '$1') sectionType = $matchingSection.type } } } else { Write-Verbose "No paths configured for section $SectionId" } } else { # Return all locations from all sections with context if ($allSections.Directory) { foreach ($section in $allSections.Directory) { if ($section.Location) { $sectionId = ($section.key -replace '.*/(\d+)$', '$1') foreach ($location in $section.Location) { [PSCustomObject]@{ id = $location.id path = $location.path section = $section.title sectionId = $sectionId sectionType = $section.type } } } } } else { Write-Verbose "No library sections found" } } } catch { $errorMsg = if ($SectionName) { "Failed to retrieve library paths for section '$SectionName': $($_.Exception.Message)" } elseif ($SectionId) { "Failed to retrieve library paths for section $SectionId : $($_.Exception.Message)" } else { "Failed to retrieve library paths: $($_.Exception.Message)" } throw $errorMsg } } |