Tcl

Download File (Stream to Local Filesystem)

See more Google Drive Examples

This example demonstrates how to download the content of a file from Google Drive. The file is streamed to the local filesystem. Tcl

load ./chilkat.dll

set success 0

set success 1

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

# This example uses a previously obtained access token having permission for the 
# Google Drive scope.

set gAuth [new_CkAuthGoogle]

CkAuthGoogle_put_AccessToken $gAuth "GOOGLE_DRIVE_ACCESS_TOKEN"

set rest [new_CkRest]

# Connect using TLS.
# A single REST object, once connected, can be used for many Google Drive 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
set success [CkRest_Connect $rest "www.googleapis.com" 443 1 $bAutoReconnect]

# Provide the authentication credentials (i.e. the access token)
CkRest_SetAuthGoogle $rest $gAuth

# ------------------------------------------------------------------------------
# To download a file, we must know the file ID.
# In a previous example (see Build Local Metadata Cache
# we built a local cache to make it easy to lookup file IDs given a file path.
# Let's say we want to download "testFolder/abc/123/penguins.jpg".
# First we lookup the fileId in the cache.  With the fileId, we can download the file.
set gdCache [new_CkCache]

CkCache_put_Level $gdCache 0
CkCache_AddRoot $gdCache "C:/ckCache/googleDrive"

set fileId [CkCache_fetchText $gdCache "testFolder/abc/123/penguins.jpg"]
if {[CkCache_get_LastMethodSuccess $gdCache] != 1} then {
    puts "Filepath not found in cache."
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkCache $gdCache
    exit
}

# We need to send a GET request like this:
# GET https://www.googleapis.com/drive/v3/files/fileId?alt=media
# The fileId is part of the path.
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/drive/v3/files/"
CkStringBuilder_Append $sbPath $fileId
CkRest_AddQueryParam $rest "alt" "media"

# Create a stream object with a SinkFile set to the path where the downloaded file will go.
set fileStream [new_CkStream]

CkStream_put_SinkFile $fileStream "qa_output/penguins.jpg"
# Indicate that the response body should stream directly to fileStream,
# but only if the response status is 200.  
CkRest_SetResponseBodyStream $rest 200 1 $fileStream

# Download the file, streaming the content to the SinkFile.
set jsonResponse [CkRest_fullRequestNoBody $rest "GET" [CkStringBuilder_getAsString $sbPath]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkCache $gdCache
    delete_CkStringBuilder $sbPath
    delete_CkStream $fileStream
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    delete_CkAuthGoogle $gAuth
    delete_CkRest $rest
    delete_CkCache $gdCache
    delete_CkStringBuilder $sbPath
    delete_CkStream $fileStream
    exit
}

puts "File downloaded."

delete_CkAuthGoogle $gAuth
delete_CkRest $rest
delete_CkCache $gdCache
delete_CkStringBuilder $sbPath
delete_CkStream $fileStream