Private/Routes.ps1
|
function Get-PodeRoute { param ( [Parameter(Mandatory=$true)] [ValidateSet('DELETE', 'GET', 'HEAD', 'MERGE', 'OPTIONS', 'PATCH', 'POST', 'PUT', 'TRACE', 'STATIC', '*')] [string] $Method, [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [string] $Route, [Parameter()] [string] $Protocol, [Parameter()] [string] $Endpoint, [switch] $CheckWildMethod ) # first, if supplied, check the wildcard method if ($CheckWildMethod -and $PodeContext.Server.Routes['*'].Count -ne 0) { $found = Get-PodeRoute -Method '*' -Route $Route -Protocol $Protocol -Endpoint $Endpoint if ($null -ne $found) { return $found } } # is this a static route? $isStatic = ($Method -ieq 'static') # first ensure we have the method $_method = $PodeContext.Server.Routes[$Method] if ($null -eq $_method) { return $null } # if we have a perfect match for the route, return it if the protocol is right $found = Get-PodeRouteByUrl -Routes $_method[$Route] -Protocol $Protocol -Endpoint $Endpoint if (!$isStatic -and $null -ne $found) { return @{ Logic = $found.Logic Middleware = $found.Middleware Protocol = $found.Protocol Endpoint = $found.Endpoint ContentType = $found.ContentType ErrorType = $found.ErrorType Parameters = $null Arguments = $found.Arguments } } # otherwise, attempt to match on regex parameters else { $valid = @(foreach ($key in $_method.Keys) { if ($Route -imatch "^$($key)$") { $key } })[0] if ($null -eq $valid) { return $null } $found = Get-PodeRouteByUrl -Routes $_method[$valid] -Protocol $Protocol -Endpoint $Endpoint if ($null -eq $found) { return $null } $Route -imatch "$($valid)$" | Out-Null if ($isStatic) { return @{ Path = $found.Path Defaults = $found.Defaults Protocol = $found.Protocol Endpoint = $found.Endpoint Download = $found.Download File = $Matches['file'] } } else { return @{ Logic = $found.Logic Middleware = $found.Middleware Protocol = $found.Protocol Endpoint = $found.Endpoint ContentType = $found.ContentType ErrorType = $found.ErrorType Parameters = $Matches Arguments = $found.Arguments } } } } function Get-PodeStaticRoutePath { param ( [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [string] $Route, [Parameter()] [string] $Protocol, [Parameter()] [string] $Endpoint ) # attempt to get a static route for the path $found = Get-PodeRoute -Method 'static' -Route $Route -Protocol $Protocol -Endpoint $Endpoint $path = $null $download = $false # if we have a defined static route, use that if ($null -ne $found) { # is the found route set as download only? if ($found.Download) { $download = $true $path = (Join-Path $found.Path (Protect-PodeValue -Value $found.File -Default ([string]::Empty))) } # if there's no file, we need to check defaults elseif (!(Test-PodePathIsFile $found.File) -and (Get-PodeCount @($found.Defaults)) -gt 0) { $found.File = (Protect-PodeValue -Value $found.File -Default ([string]::Empty)) if ((Get-PodeCount @($found.Defaults)) -eq 1) { $found.File = Join-PodePaths @($found.File, @($found.Defaults)[0]) } else { foreach ($def in $found.Defaults) { if (Test-PodePath (Join-Path $found.Path $def) -NoStatus) { $found.File = Join-PodePaths @($found.File, $def) break } } } } $path = (Join-Path $found.Path $found.File) } # else, use the public static directory (but only if path is a file, and a public dir is present) elseif ((Test-PodePathIsFile $Route) -and ![string]::IsNullOrWhiteSpace($PodeContext.Server.InbuiltDrives['public'])) { $path = (Join-Path $PodeContext.Server.InbuiltDrives['public'] $Route) } # return the route details return @{ Path = $path; Download = $download; } } function Get-PodeRouteByUrl { param ( [Parameter()] [object[]] $Routes, [Parameter()] [string] $Protocol, [Parameter()] [string] $Endpoint ) # get the value routes $rs = @(foreach ($route in $Routes) { if ( (($route.Protocol -ieq $Protocol) -or [string]::IsNullOrWhiteSpace($route.Protocol)) -and ([string]::IsNullOrWhiteSpace($route.Endpoint) -or ($Endpoint -ilike $route.Endpoint)) ) { $route } }) if ($null -eq $rs[0]) { return $null } return @($rs | Sort-Object -Property { $_.Protocol }, { $_.Endpoint } -Descending)[0] } function Update-PodeRoutePlaceholders { param ( [Parameter(Mandatory=$true)] [string] $Path ) # replace placeholder parameters with regex $placeholder = '\:(?<tag>[\w]+)' if ($Path -imatch $placeholder) { $Path = [regex]::Escape($Path) } while ($Path -imatch $placeholder) { $Path = ($Path -ireplace $Matches[0], "(?<$($Matches['tag'])>[^\/]+?)") } return $Path } function Update-PodeRouteSlashes { param ( [Parameter(Mandatory=$true)] [string] $Path, [switch] $Static ) # ensure route starts with a '/' if (!$Path.StartsWith('/')) { $Path = "/$($Path)" } if ($Static) { # ensure the static route ends with '/{0,1}.*' $Path = $Path.TrimEnd('/*') $Path = "$($Path)[/]{0,1}(?<file>*)" } # replace * with .* $Path = ($Path -ireplace '\*', '.*') return $Path } function Split-PodeRouteQuery { param ( [Parameter(Mandatory=$true)] [string] $Path ) return ($Path -isplit "\?")[0] } function ConvertTo-PodeRouteRegex { param ( [Parameter()] [string] $Path ) $Path = Protect-PodeValue -Value $Path -Default '/' $Path = Split-PodeRouteQuery -Path $Path $Path = Protect-PodeValue -Value $Path -Default '/' $Path = Update-PodeRouteSlashes -Path $Path $Path = Update-PodeRoutePlaceholders -Path $Path return $Path } function Get-PodeStaticRouteDefaults { if (!(Test-IsEmpty $PodeContext.Server.Web.Static.Defaults)) { return @($PodeContext.Server.Web.Static.Defaults) } return @( 'index.html', 'index.htm', 'default.html', 'default.htm' ) } function Test-PodeRouteAndError { param ( [Parameter(Mandatory=$true)] [string] $Method, [Parameter(Mandatory=$true)] [string] $Path, [Parameter()] [string] $Protocol, [Parameter()] [string] $Endpoint ) $found = @($PodeContext.Server.Routes[$Method][$Path]) if (($found | Where-Object { $_.Protocol -ieq $Protocol -and $_.Endpoint -ieq $Endpoint } | Measure-Object).Count -eq 0) { return } $_url = $Protocol if (![string]::IsNullOrEmpty($_url) -and ![string]::IsNullOrWhiteSpace($Endpoint)) { $_url = "$($_url)://$($Endpoint)" } elseif (![string]::IsNullOrWhiteSpace($Endpoint)) { $_url = $Endpoint } if ([string]::IsNullOrEmpty($_url)) { throw "[$($Method)] $($Path): Already defined" } else { throw "[$($Method)] $($Path): Already defined for $($_url)" } } function Get-PodeEndpointByName { param ( [Parameter()] [string] $EndpointName, [switch] $ThrowError ) # if an EndpointName was supplied, find it and use it if ([string]::IsNullOrWhiteSpace($EndpointName)) { return $null } # ensure it exists $found = ($PodeContext.Server.Endpoints | Where-Object { $_.Name -ieq $EndpointName } | Select-Object -First 1) if ($null -eq $found) { if ($ThrowError) { throw "Endpoint with name '$($EndpointName)' does not exist" } return $null } return $found } function Convert-PodeFunctionVerbToHttpMethod { param ( [Parameter()] [string] $Verb ) # if empty, just return default $DefaultMethod = 'POST' if ([string]::IsNullOrWhiteSpace($Verb)) { return $DefaultMethod } # GET method if (@('Find', 'Format', 'Get', 'Join', 'Search', 'Select', 'Split', 'Measure', 'Ping', 'Test', 'Trace') -icontains $Verb) { return 'GET' } # PUT method if (@('Set') -icontains $Verb) { return 'PUT' } # PATCH method if (@('Rename', 'Edit', 'Update') -icontains $Verb) { return 'PATCH' } # DELETE method if (@('Clear', 'Close', 'Exit', 'Hide', 'Remove', 'Undo', 'Dismount', 'Unpublish', 'Disable', 'Uninstall', 'Unregister') -icontains $Verb) { return 'DELETE' } # default method is POST return $DefaultMethod } |