Update Resolve-URI.ps1

Add encoding for reserved characters and switch to only affect restricted characters depnding on the usage
Akaizoku · Jan 20, 2020 · 36170e8 · 36170e8
1 parent 38e8296
commit 36170e8
Showing 1 changed file with 65 additions and 3 deletions.
diff --git a/Public/Resolve-URI.ps1 b/Public/Resolve-URI.ps1
@@ -1,28 +1,90 @@
 function Resolve-URI {
+  <#
+    .SYNOPSIS
+    Resolve URI
+
+    .DESCRIPTION
+    Parse a unform resource identifier (URI) and resolve restricted and reserved characters
+
+    .PARAMETER URI
+    The URI parameter corresponds to the uniform resource identifier to resolve.
+
+    .INPUTS
+    System.String. You can pipe the uniform resource identifier to Resolve-URI.DESCRIPTION
+
+    .OUTPUTS
+    System.String. Resolve-URI returns the encoded uniform resource identifier.
+
+    File name:      Resolve-URI.ps1
+    Author:         Florian Carrier
+    Creation date:  12/12/2018
+    Last modified:  16/01/2020
+
+    .LINK
+    https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
+
+    .LINK
+    https://en.wikipedia.org/wiki/Percent-encoding
+  #>
   [CmdletBinding ()]
   Param (
     [Parameter (
       Position    = 1,
       Mandatory   = $true,
-      HelpMessage = "URI to resolve"
+      HelpMessage = "URI to resolve",
+      ValueFromPipeline               = $true,
+      ValueFromPipelineByPropertyName = $true
     )]
     [String]
-    $URI
+    $URI,
+    [Parameter (
+      HelpMessage = "Switch to limit parsing to restricted characters"
+    )]
+    [Switch]
+    $RestrictedOnly
   )
   Begin {
     # Get global preference variables
     Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState
     # List of restricted characters
     $RestrictedCharacters = [Ordered]@{
       "\" = '/'
+      "%" = '%25'
+    }
+    # List of reserved characters
+    $ReservedCharacters = [Ordered]@{
       " " = '%20'
+      "," = '%2C'
+      ";" = '%3B'
+      ":" = '%3A'
+      "!" = '%21'
+      "?" = '%3F'
+      "'" = '%27'
+      "(" = '%28'
+      ")" = '%29'
+      "[" = '%5B'
+      "]" = '%5D'
+      "@" = '%40'
+      "*" = '%2A'
+      "/" = '%2F'
+      "&" = '%26'
+      "#" = '%23'
+      "+" = '%2B'
+      "=" = '%3D'
+      "$" = '%24'
     }
   }
   Process {
-    # Encode URI
+    # Encode restricted characters
     foreach ($RestrictedCharacter in $RestrictedCharacters.GetEnumerator()) {
       $URI = $URI.Replace($RestrictedCharacter.Key, $RestrictedCharacter.Value)
     }
+    # Encode reserved characters
+    if (-Not $RestrictedOnly) {
+      foreach ($ReservedCharacter in $ReservedCharacters.GetEnumerator()) {
+        $URI = $URI.Replace($ReservedCharacter.Key, $ReservedCharacter.Value)
+      }
+    }
     # Return encoded URI
     return $URI
   }