Merge pull request #151 from VBA-tools/url-decode-cookies

Improve cookie decoding

Author: timhall

specs/Specs_WebResponse.bas

@@ -245,6 +245,20 @@ Public Function Specs() As SpecSuite
         .Expect(WebHelpers.FindInKeyValues(Cookies, "unsigned-cookie")).ToEqual "simple-cookie"
     End With
 
+    With Specs.It("should use RFC 6265 for decoding cookies")
+        Set Response = New WebResponse
+        ResponseHeaders = "Set-Cookie: a=plus+plus" & vbCrLf & _
+            "Set-Cookie: b=""quotes""" & vbCrLf & _
+            "Set-Cookie: c=semi-colon; Path=/"
+
+        Set Headers = Response.ExtractHeaders(ResponseHeaders)
+        Set Cookies = Response.ExtractCookies(Headers)
+
+        .Expect(WebHelpers.FindInKeyValues(Cookies, "a")).ToEqual "plus+plus"
+        .Expect(WebHelpers.FindInKeyValues(Cookies, "b")).ToEqual "quotes"
+        .Expect(WebHelpers.FindInKeyValues(Cookies, "c")).ToEqual "semi-colon"
+    End With
+    
     ' ============================================= '
     ' Errors
     ' ============================================= '

src/WebHelpers.bas

@@ -853,9 +853,11 @@ End Function
 '
 ' @method UrlDecode
 ' @param {String} Encoded Text to decode
+' @param {Boolean} [PlusAsSpace = True] Decode plus as space
+'   DEPRECATED: Default = True to align with existing behavior, will be changed to False in v5
 ' @return {String} Decoded string
 ''
-Public Function UrlDecode(Encoded As String) As String
+Public Function UrlDecode(Encoded As String, Optional PlusAsSpace As Boolean = True) As String
     Dim web_StringLen As Long
     web_StringLen = VBA.Len(Encoded)
 
@@ -867,7 +869,7 @@ Public Function UrlDecode(Encoded As String) As String
         For web_i = 1 To web_StringLen
             web_Temp = VBA.Mid$(Encoded, web_i, 1)
 
-            If web_Temp = "+" Then
+            If web_Temp = "+" And PlusAsSpace Then
                 web_Temp = " "
             ElseIf web_Temp = "%" And web_StringLen >= web_i + 2 Then
                 web_Temp = VBA.Mid$(Encoded, web_i + 1, 2)

src/WebResponse.cls

@@ -273,11 +273,17 @@ Public Function ExtractCookies(Headers As Collection) As Collection
                 web_Key = VBA.Mid$(web_Cookie, 1, VBA.InStr(1, web_Cookie, "=") - 1)
                 web_Value = VBA.Mid$(web_Cookie, VBA.InStr(1, web_Cookie, "=") + 1, VBA.Len(web_Cookie))
 
+                ' Ignore text after semi-colon
                 If VBA.InStr(1, web_Value, ";") > 0 Then
                     web_Value = VBA.Mid$(web_Value, 1, VBA.InStr(1, web_Value, ";") - 1)
                 End If
 
-                web_Cookies.Add WebHelpers.CreateKeyValue(web_Key, WebHelpers.UrlDecode(web_Value))
+                ' Ignore surrounding quotes
+                If VBA.Left$(web_Value, 1) = """" Then
+                    web_Value = VBA.Mid$(web_Value, 2, VBA.Len(web_Value) - 2)
+                End If
+                
+                web_Cookies.Add WebHelpers.CreateKeyValue(web_Key, WebHelpers.UrlDecode(web_Value, PlusAsSpace:=False))
             Else
                 WebHelpers.LogWarning _
                     "Unrecognized cookie format: " & web_Cookie, "WebResponse.ExtractCookies"