(PureBasic) URL Encoding Charset in POST Query Params

Demonstrates how to control the URL encoding charset in POST query params.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; We have the string "MÆRSK".
    nameWin1252Encoded.s = "M%E6RSK"

    sb.i = CkStringBuilder::ckCreate()
    If sb.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkStringBuilder::ckDecodeAndAppend(sb,nameWin1252Encoded,"url","windows-1252")

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; We're setting the session log filename so we can see the exact request sent.
    CkHttp::setCkSessionLogFilename(http, "qa_output/sessionLog.txt")

    ; First demonstrate a simple application/x-www-form-urlencoded POST

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the Charset = "utf-8" to cause URL encoding to use utf-8.
    CkHttpRequest::setCkCharset(req, "utf-8")

    CkHttpRequest::ckAddParam(req,"name",CkStringBuilder::ckGetAsString(sb))

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpReq(http,"https://www.chilkatsoft.com/something",req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sb)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; This is the request that is sent:
    ; Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

    ; 	POST /something HTTP/1.1
    ; 	Host: www.chilkatsoft.com
    ; 	Content-Type: application/x-www-form-urlencoded
    ; 	Content-Length: 15
    ; 
    ; 	name=M%C3%A6RSK

    ; ---------------------------------------------------------------
    ; Switch to windows-1252

    CkHttpRequest::setCkCharset(req, "windows-1252")
    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")

    success = CkHttp::ckHttpReq(http,"https://www.chilkatsoft.com/something",req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sb)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; This is the request that is sent:
    ; Notice that windows-1252 is used in the query param (the letter 'Æ' is %E6)

    ; 	POST /something HTTP/1.1
    ; 	Host: www.chilkatsoft.com
    ; 	Content-Type: application/x-www-form-urlencoded
    ; 	Content-Length: 12
    ; 
    ; 	name=M%E6RSK

    ; ---------------------------------------------------------------
    ; Let's do the same with HttpSReq, switching back to utf-8

    CkHttpRequest::setCkPath(req, "/something")
    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkContentType(req, "application/x-www-form-urlencoded")

    CkHttpRequest::setCkCharset(req, "utf-8")
    success = CkHttp::ckHttpSReq(http,"www.chilkatsoft.com",443,1,req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sb)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; This is the request that is sent:
    ; Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

    ; 	POST /something HTTP/1.1
    ; 	Host: www.chilkatsoft.com
    ; 	Content-Type: application/x-www-form-urlencoded
    ; 	Content-Length: 15
    ; 
    ; 	name=M%C3%A6RSK

    ; ---------------------------------------------------------------
    ; Let's do a POST with XML body where the query params are in the HTTP request start line, 
    ; and the Content-Type is text/xml where the body of the request is XML.

    CkHttpRequest::setCkPath(req, "/something")
    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkContentType(req, "text/xml")
    success = CkHttpRequest::ckLoadBodyFromString(req,"<test>123</test>","utf-8")
    CkHttpRequest::setCkCharset(req, "utf-8")

    ; Remember... our request object still contains the query param added in the above call to AddParam.
    success = CkHttp::ckHttpSReq(http,"www.chilkatsoft.com",443,1,req,resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sb)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; This is the request that is sent:
    ; Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

    ; 	POST /something?name=M%C3%A6RSK HTTP/1.1
    ; 	Host: www.chilkatsoft.com
    ; 	Content-Type: text/xml
    ; 	Content-Length: 16
    ; 
    ; 	<test>123</test>


    CkStringBuilder::ckDispose(sb)
    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure