PureBasic Requires Chilkat v11.7.0+

Box: Upload a Large File in Parts and Commit the Session

See more Box Examples

Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Resolve documents by name, then perform the explicit chunked-upload session, part, and commit loop. Supports 20 MB through 2 GB using int. Saves recovery information and honors bounded commit Retry-After.

See the Box API guide for setup and the complete workflow.

PureBasic

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpCurl.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkFileAccess.pb"
IncludeFile "CkCrypt2.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkBinData.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
    ;  See Global Unlock Sample.
    ;  Guide: Box API Guide.

    success = 0

    ;  BEGIN ONE-TIME SETUP
    ;  This block is repeated so each published example can run on its own.
    ;  In an application, run the setup example once and pass the SAME curl object
    ;  to operation code below. Do not recreate it for every operation.
    ;  See Reusable Box HttpCurl Setup.
    curl.i = CkHttpCurl::ckCreate()
    If curl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpCurl::ckSetVar(curl,"access_token","BOX_ACCESS_TOKEN")
    CkHttpCurl::ckSetVar(curl,"parent_name","/")
    ;  Box's fixed root ID is an implementation detail; callers supply names.
    CkHttpCurl::ckSetVar(curl,"parent_id","0")
    setupCommand.i = CkStringBuilder::ckCreate()
    If setupCommand.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    setupReplacements.i

    ;  Register findParent; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"findParent",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register findFolder; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"findFolder",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register findFile; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"findFile",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register findDestination; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"findDestination",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register getFileDetails; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"getFileDetails",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register getEnterprise; registration sends no request.
    CkStringBuilder::ckSetString(setupCommand,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/users/me?fields=enterprise" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer ACCESS_TOKEN" + Chr(34))
    setupReplacements = CkStringBuilder::ckReplace(setupCommand,"ACCESS_TOKEN",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckAddFunction(curl,"getEnterprise",CkStringBuilder::ckGetAsString(setupCommand))
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
    ;  when extracting each output, using the current value at that time.
    success = CkHttpCurl::ckAddOutput2(curl,"findParent","entries","name","{{parent_name}}",1,"id","parent_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"findFolder","entries","name","{{folder_name}}",1,"id","folder_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"findFile","entries","name","{{file_name}}",1,"id","file_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput2(curl,"findDestination","entries","name","{{destination_name}}",1,"id","destination_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput(curl,"getFileDetails","file_version.id","file_version_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput(curl,"getFileDetails","sha1","file_sha1")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    success = CkHttpCurl::ckAddOutput(curl,"getEnterprise","enterprise.id","enterprise_id")
    If success <> 1
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        ProcedureReturn
    EndIf

    ;  END ONE-TIME SETUP
    ;  The name lookups below assume each listing fits in one page (1000 items).
    ;  Parent and destination names select root children; folder_name selects a child
    ;  of parent_name. "/" selects the root parent. These are not arbitrary paths.

    ;  BEGIN OPERATION -- keep the configured object when reusing it.
    ;  Inputs are names. Retain cached IDs when the selected names have not changed.
    parentName.s = "/"
    folderName.s = "documents"
    If (CkHttpCurl::ckGetVar(curl,"parent_name") <> parentName) OR ((parentName = "/") AND (CkHttpCurl::ckVarDefined(curl,"parent_id") = 0))
        CkHttpCurl::ckSetVar(curl,"parent_name",parentName)
        CkHttpCurl::ckClearVar(curl,"parent_id")
        CkHttpCurl::ckClearVar(curl,"folder_id")
        CkHttpCurl::ckClearVar(curl,"file_id")
        CkHttpCurl::ckClearVar(curl,"file_version_id")
        CkHttpCurl::ckClearVar(curl,"file_sha1")
        If parentName = "/"
            CkHttpCurl::ckSetVar(curl,"parent_id","0")
        EndIf

    EndIf

    If CkHttpCurl::ckGetVar(curl,"folder_name") <> folderName
        CkHttpCurl::ckSetVar(curl,"folder_name",folderName)
        CkHttpCurl::ckClearVar(curl,"folder_id")
        CkHttpCurl::ckClearVar(curl,"file_id")
        CkHttpCurl::ckClearVar(curl,"file_version_id")
        CkHttpCurl::ckClearVar(curl,"file_sha1")
    EndIf

    ;  Resolve the named destination first. HttpCurl does not expand variables
    ;  inside multipart -F attributes in the tested build, so this upload is two phases.
    CkHttpCurl::ckClearTargetOutput(curl,"*")
    authorizedCommand1.i = CkStringBuilder::ckCreate()
    If authorizedCommand1.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckSetString(authorizedCommand1,"curl -X GET " + Chr(34) + "https://api.box.com/2.0/folders/{{folder_id}}?fields=id" + Chr(34) + " -H " + Chr(34) + "Authorization: Bearer {{access_token}}" + Chr(34))
    headerReplacement1.i = CkStringBuilder::ckReplace(authorizedCommand1,"{{access_token}}",CkHttpCurl::ckGetVar(curl,"access_token"))
    success = CkHttpCurl::ckDoYourThing(curl,CkStringBuilder::ckGetAsString(authorizedCommand1))
    If (success <> 1) OR (CkHttpCurl::ckStatusCode(curl) <> 200)
        Debug "Box request failed. HTTP status: " + Str(CkHttpCurl::ckStatusCode(curl))
        Debug "Failure reason: " + Str(CkHttpCurl::ckFailReason(curl))
        Debug CkHttpCurl::ckResponseBodyStr(curl)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        ProcedureReturn
    EndIf

    ;  This example limits size to 2 GB so offsets fit all generated languages' integers.
    ;  The source must not change during hashing or upload. Create qa_output first.
    localPath.s = "qa_data/large-document.zip"
    file.i = CkFileAccess::ckCreate()
    If file.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  Check the decimal size before converting so an oversized file cannot overflow int.
    sizeString.s = CkFileAccess::ckFileSizeStr(file,localPath)
    If CkFileAccess::ckLastMethodSuccess(file) <> 1
        Debug CkFileAccess::ckLastErrorText(file)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        ProcedureReturn
    EndIf

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

    CkStringBuilder::ckSetString(sizeText,sizeString)
    sizeMatch.i = CkJsonObject::ckCreate()
    If sizeMatch.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    If CkStringBuilder::ckRegexMatch(sizeText,"^([0-9]{1,9}|1[0-9]{9}|2000000000)$",sizeMatch,100) <> 1
        Debug "Choose an input between 20 MB and 2 GB for this example."
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        ProcedureReturn
    EndIf

    fileSize.i = Val(sizeString)
    If fileSize < 20971520
        Debug "Choose an input between 20 MB and 2 GB for this example."
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        ProcedureReturn
    EndIf

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

    CkHttp::setCkAuthToken(http, CkHttpCurl::ckGetVar(curl,"access_token"))
    response.i = CkHttpResponse::ckCreate()
    If response.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckUpdateString(request,"folder_id",CkHttpCurl::ckGetVar(curl,"folder_id"))
    CkJsonObject::ckUpdateString(request,"file_name","large-document.zip")
    CkJsonObject::ckUpdateInt(request,"file_size",fileSize)
    success = CkHttp::ckHttpJson(http,"POST","https://upload.box.com/api/2.0/files/upload_sessions",request,"application/json",response)
    If success <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        ProcedureReturn
    EndIf

    If CkHttpResponse::ckStatusCode(response) <> 201
        Debug CkHttpResponse::ckBodyStr(response)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        ProcedureReturn
    EndIf

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

    success = CkJsonObject::ckLoad(session,CkHttpResponse::ckBodyStr(response))
    If success <> 1
        Debug CkJsonObject::ckLastErrorText(session)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckWriteFile(session,"qa_output/box_upload_session.json")
    If success <> 1
        Debug CkJsonObject::ckLastErrorText(session)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        ProcedureReturn
    EndIf

    partSize.i = CkJsonObject::ckIntOf(session,"part_size")
    uploadUrl.s = CkJsonObject::ckStringOf(session,"session_endpoints.upload_part")
    commitUrl.s = CkJsonObject::ckStringOf(session,"session_endpoints.commit")
    If (partSize <= 0) OR (uploadUrl = "") OR (commitUrl = "")
        Debug "Invalid session response."
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        ProcedureReturn
    EndIf

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

    CkCrypt2::setCkHashAlgorithm(hash, "sha1")
    CkCrypt2::setCkEncodingMode(hash, "base64")
    fileDigest.s = CkCrypt2::ckHashFileENC(hash,localPath)
    If CkCrypt2::ckLastMethodSuccess(hash) <> 1
        Debug CkCrypt2::ckLastErrorText(hash)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        CkCrypt2::ckDispose(hash)
        ProcedureReturn
    EndIf

    success = CkFileAccess::ckFileOpen(file,localPath,2147483648,1,3,0)
    If success <> 1
        Debug CkFileAccess::ckLastErrorText(file)
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        CkCrypt2::ckDispose(hash)
        ProcedureReturn
    EndIf

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

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

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

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

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

    offset.i = 0
    partIndex.i = 0
    partLength.i
    lastByte.i
    partDigest.s
    While offset < fileSize
        CkBinData::ckClear(chunk)
        success = CkFileAccess::ckFileReadBd(file,partSize,chunk)
        If success <> 1
            Debug CkFileAccess::ckLastErrorText(file)
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        partLength = CkBinData::ckNumBytes(chunk)
        If partLength <= 0
            Debug "Unexpected end of file."
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        lastByte = offset + (partLength - 1)
        CkStringBuilder::ckClear(range)
        CkStringBuilder::ckAppend(range,"bytes ")
        CkStringBuilder::ckAppendInt(range,offset)
        CkStringBuilder::ckAppend(range,"-")
        CkStringBuilder::ckAppendInt(range,lastByte)
        CkStringBuilder::ckAppend(range,"/")
        CkStringBuilder::ckAppendInt(range,fileSize)
        partDigest = CkCrypt2::ckHashBdENC(hash,chunk)
        If CkCrypt2::ckLastMethodSuccess(hash) <> 1
            Debug CkCrypt2::ckLastErrorText(hash)
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        CkStringBuilder::ckSetString(digestHeader,"sha=")
        CkStringBuilder::ckAppend(digestHeader,partDigest)
        CkHttp::ckSetRequestHeader(http,"Digest",CkStringBuilder::ckGetAsString(digestHeader))
        CkHttp::ckSetRequestHeader(http,"Content-Range",CkStringBuilder::ckGetAsString(range))
        success = CkHttp::ckHttpBd(http,"PUT",uploadUrl,chunk,"application/octet-stream",response)
        If (success <> 1) OR (CkHttpResponse::ckStatusCode(response) <> 200)
            Debug "Part failed. HTTP status: " + Str(CkHttpResponse::ckStatusCode(response))
            Debug CkHttpResponse::ckBodyStr(response)
            Debug "Inspect the saved session and server list_parts before retrying this part."
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        success = CkJsonObject::ckLoad(partResponse,CkHttpResponse::ckBodyStr(response))
        If success <> 1
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        CkJsonObject::setCkI(commit, partIndex)
        ;  Copy the server's acknowledged part fields into the commit manifest.
        CkJsonObject::ckUpdateString(commit,"parts[i].part_id",CkJsonObject::ckStringOf(partResponse,"part.part_id"))
        CkJsonObject::ckUpdateInt(commit,"parts[i].offset",CkJsonObject::ckIntOf(partResponse,"part.offset"))
        CkJsonObject::ckUpdateInt(commit,"parts[i].size",CkJsonObject::ckIntOf(partResponse,"part.size"))
        CkJsonObject::ckUpdateString(commit,"parts[i].sha1",CkJsonObject::ckStringOf(partResponse,"part.sha1"))
        success = CkJsonObject::ckWriteFile(commit,"qa_output/box_upload_parts.json")
        If success <> 1
            Debug CkJsonObject::ckLastErrorText(commit)
            CkFileAccess::ckFileClose(file)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            ProcedureReturn
        EndIf

        offset = offset + partLength
        partIndex = partIndex + 1
    Wend
    CkFileAccess::ckFileClose(file)
    CkHttp::ckRemoveRequestHeader(http,"Content-Range")
    CkStringBuilder::ckSetString(digestHeader,"sha=")
    CkStringBuilder::ckAppend(digestHeader,fileDigest)
    CkHttp::ckSetRequestHeader(http,"Digest",CkStringBuilder::ckGetAsString(digestHeader))
    attempts.i = 0
    waitSeconds.i
    retryHeader.i = CkStringBuilder::ckCreate()
    If retryHeader.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    completed.i = 0
    While (attempts < 10) AND (completed = 0)
        success = CkHttp::ckHttpJson(http,"POST",commitUrl,commit,"application/json",response)
        If success <> 1
            Debug "Commit failed: " + Str(CkHttpResponse::ckStatusCode(response))
            Debug CkHttpResponse::ckBodyStr(response)
            CkHttpCurl::ckDispose(curl)
            CkStringBuilder::ckDispose(setupCommand)
            CkStringBuilder::ckDispose(authorizedCommand1)
            CkFileAccess::ckDispose(file)
            CkStringBuilder::ckDispose(sizeText)
            CkJsonObject::ckDispose(sizeMatch)
            CkHttp::ckDispose(http)
            CkHttpResponse::ckDispose(response)
            CkJsonObject::ckDispose(request)
            CkJsonObject::ckDispose(session)
            CkCrypt2::ckDispose(hash)
            CkJsonObject::ckDispose(commit)
            CkJsonObject::ckDispose(partResponse)
            CkBinData::ckDispose(chunk)
            CkStringBuilder::ckDispose(range)
            CkStringBuilder::ckDispose(digestHeader)
            CkStringBuilder::ckDispose(retryHeader)
            CkJsonObject::ckDispose(retryMatch)
            ProcedureReturn
        EndIf

        If CkHttpResponse::ckStatusCode(response) = 201
            completed = 1
        Else
            If CkHttpResponse::ckStatusCode(response) <> 202
                Debug "Unexpected commit status: " + Str(CkHttpResponse::ckStatusCode(response))
                CkHttpCurl::ckDispose(curl)
                CkStringBuilder::ckDispose(setupCommand)
                CkStringBuilder::ckDispose(authorizedCommand1)
                CkFileAccess::ckDispose(file)
                CkStringBuilder::ckDispose(sizeText)
                CkJsonObject::ckDispose(sizeMatch)
                CkHttp::ckDispose(http)
                CkHttpResponse::ckDispose(response)
                CkJsonObject::ckDispose(request)
                CkJsonObject::ckDispose(session)
                CkCrypt2::ckDispose(hash)
                CkJsonObject::ckDispose(commit)
                CkJsonObject::ckDispose(partResponse)
                CkBinData::ckDispose(chunk)
                CkStringBuilder::ckDispose(range)
                CkStringBuilder::ckDispose(digestHeader)
                CkStringBuilder::ckDispose(retryHeader)
                CkJsonObject::ckDispose(retryMatch)
                ProcedureReturn
            EndIf

            ;  Box's asynchronous commit response supplies Retry-After in seconds.
            CkStringBuilder::ckSetString(retryHeader,CkHttpResponse::ckGetHeaderField(response,"Retry-After"))
            If CkStringBuilder::ckRegexMatch(retryHeader,"^[0-9]{1,2}$",retryMatch,100) <> 1
                Debug "Commit pending. Preserve the session and inspect Retry-After before resuming: " + CkStringBuilder::ckGetAsString(retryHeader)
                CkHttpCurl::ckDispose(curl)
                CkStringBuilder::ckDispose(setupCommand)
                CkStringBuilder::ckDispose(authorizedCommand1)
                CkFileAccess::ckDispose(file)
                CkStringBuilder::ckDispose(sizeText)
                CkJsonObject::ckDispose(sizeMatch)
                CkHttp::ckDispose(http)
                CkHttpResponse::ckDispose(response)
                CkJsonObject::ckDispose(request)
                CkJsonObject::ckDispose(session)
                CkCrypt2::ckDispose(hash)
                CkJsonObject::ckDispose(commit)
                CkJsonObject::ckDispose(partResponse)
                CkBinData::ckDispose(chunk)
                CkStringBuilder::ckDispose(range)
                CkStringBuilder::ckDispose(digestHeader)
                CkStringBuilder::ckDispose(retryHeader)
                CkJsonObject::ckDispose(retryMatch)
                ProcedureReturn
            EndIf

            waitSeconds = Val(CkStringBuilder::ckGetAsString(retryHeader))
            If (waitSeconds < 1) OR (waitSeconds > 60)
                Debug "Commit pending. Resume commit after Retry-After: " + CkHttpResponse::ckGetHeaderField(response,"Retry-After")
                CkHttpCurl::ckDispose(curl)
                CkStringBuilder::ckDispose(setupCommand)
                CkStringBuilder::ckDispose(authorizedCommand1)
                CkFileAccess::ckDispose(file)
                CkStringBuilder::ckDispose(sizeText)
                CkJsonObject::ckDispose(sizeMatch)
                CkHttp::ckDispose(http)
                CkHttpResponse::ckDispose(response)
                CkJsonObject::ckDispose(request)
                CkJsonObject::ckDispose(session)
                CkCrypt2::ckDispose(hash)
                CkJsonObject::ckDispose(commit)
                CkJsonObject::ckDispose(partResponse)
                CkBinData::ckDispose(chunk)
                CkStringBuilder::ckDispose(range)
                CkStringBuilder::ckDispose(digestHeader)
                CkStringBuilder::ckDispose(retryHeader)
                CkJsonObject::ckDispose(retryMatch)
                ProcedureReturn
            EndIf

            CkHttp::ckSleepMs(http,waitSeconds * 1000)
        EndIf

        attempts = attempts + 1
    Wend
    If completed = 0
        Debug "Commit still pending; retain session and part manifests to resume commit later."
        CkHttpCurl::ckDispose(curl)
        CkStringBuilder::ckDispose(setupCommand)
        CkStringBuilder::ckDispose(authorizedCommand1)
        CkFileAccess::ckDispose(file)
        CkStringBuilder::ckDispose(sizeText)
        CkJsonObject::ckDispose(sizeMatch)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(response)
        CkJsonObject::ckDispose(request)
        CkJsonObject::ckDispose(session)
        CkCrypt2::ckDispose(hash)
        CkJsonObject::ckDispose(commit)
        CkJsonObject::ckDispose(partResponse)
        CkBinData::ckDispose(chunk)
        CkStringBuilder::ckDispose(range)
        CkStringBuilder::ckDispose(digestHeader)
        CkStringBuilder::ckDispose(retryHeader)
        CkJsonObject::ckDispose(retryMatch)
        ProcedureReturn
    EndIf

    Debug "Upload committed: " + CkHttpResponse::ckBodyStr(response)


    CkHttpCurl::ckDispose(curl)
    CkStringBuilder::ckDispose(setupCommand)
    CkStringBuilder::ckDispose(authorizedCommand1)
    CkFileAccess::ckDispose(file)
    CkStringBuilder::ckDispose(sizeText)
    CkJsonObject::ckDispose(sizeMatch)
    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(response)
    CkJsonObject::ckDispose(request)
    CkJsonObject::ckDispose(session)
    CkCrypt2::ckDispose(hash)
    CkJsonObject::ckDispose(commit)
    CkJsonObject::ckDispose(partResponse)
    CkBinData::ckDispose(chunk)
    CkStringBuilder::ckDispose(range)
    CkStringBuilder::ckDispose(digestHeader)
    CkStringBuilder::ckDispose(retryHeader)
    CkJsonObject::ckDispose(retryMatch)


    ProcedureReturn
EndProcedure