(Tcl) Box.com Streaming Upload File

Demonstrates how to upload a file to box.com, streaming the file directly from the filesystem.

Note: This example requires a fix that is included in Chilkat v9.5.0.70 and above.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

#   Provide a previously obtained OAuth2 access token.
set oauth2 [new_CkOAuth2]

CkOAuth2_put_AccessToken $oauth2 "BOX_ACCESS_TOKEN"
CkRest_SetAuthOAuth2 $rest $oauth2

# First, make the initial connection.
# A single REST object, once connected, can be used for many Box REST API calls.
# The auto-reconnect indicates that if the already-established HTTPS connection is closed,
# then it will be automatically re-established as needed.
set bAutoReconnect 1

# ----------------------------------------------------------------------
# IMPORTANT: Note that the domain is "upload.box.com", not "api.box.com"
# ----------------------------------------------------------------------
set success [CkRest_Connect $rest "upload.box.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkOAuth2 $oauth2
    exit
}

# The request body uses the "multipart/form-data" format to transmit two "parts". 
# The first part is called "attributes" and contains a JSON object with information about the file, including the name of the file 
# and the ID of the parent folder. The second part contains the contents of the file. 
# (Note that the name of the second "part" is ignored.)

CkRest_AddHeader $rest "Content-Type" "multipart/form-data"

# Provide the content for each part of the request...

# First the JSON attributes.  Use "0" for the root folder.
#   {"name":"hedgehogs.jpg", "parent":{"id":"0"}}
set jsonAttr [new_CkJsonObject]

CkJsonObject_UpdateString $jsonAttr "name" "hedgehogs.jpg"
CkJsonObject_UpdateString $jsonAttr "parent.id" "0"

CkRest_put_PartSelector $rest "1"
CkRest_AddHeader $rest "Content-Disposition" "form-data; name=\"attributes\"; "
CkRest_SetMultipartBodyString $rest [CkJsonObject_emit $jsonAttr]

# The upload will stream directly from a file.
CkRest_put_PartSelector $rest "2"
CkRest_AddHeader $rest "Content-Disposition" "form-data; name=\"file\"; filename=\"hedgehogs.jpg\""
# "application/octet-stream" can be safely used for any type file..
CkRest_AddHeader $rest "Content-Type" "application/octet-stream"

# IMPORTANT: This example requires Chilkat v9.5.0.70 or later, for a fix that was made in
# multipart/streaming uploads. 
set fileStream [new_CkStream]

CkStream_put_SourceFile $fileStream "qa_data/jpg/hedgehogs.jpg"
CkRest_SetMultipartBodyStream $rest $fileStream

# Restore the PartSelector to "0" (for safety, in case something else sends another request on this object)
CkRest_put_PartSelector $rest "0"

# Send the multipart/form-data request, which uploads the file by streaming directly from the filesystem.
set responseBody [CkRest_fullRequestMultipart $rest "POST" "/api/2.0/files/content"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkOAuth2 $oauth2
    delete_CkJsonObject $jsonAttr
    delete_CkStream $fileStream
    exit
}

# A 201 is received for a successful upload
if {[CkRest_get_ResponseStatusCode $rest] != 201} then {
    puts "Box.com upload failed."
    puts "Request header:"
    puts [CkRest_lastRequestHeader $rest]
    puts "---"
    puts "Response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response body:"
    puts "$responseBody"
    delete_CkRest $rest
    delete_CkOAuth2 $oauth2
    delete_CkJsonObject $jsonAttr
    delete_CkStream $fileStream
    exit
}

puts "File uploaded."

delete_CkRest $rest
delete_CkOAuth2 $oauth2
delete_CkJsonObject $jsonAttr
delete_CkStream $fileStream