Tcl

SFTP Synchronize Directory Tree - Download

See more SFTP Examples

Demonstrates how to download files to synchronize a local directory tree with a remote directory tree. The SyncTreeDownload method recursively descends the remote directory tree and downloads files based on existence, last-mod date/time and/or size differences. Tcl

load ./chilkat.dll

set success 0

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

set sftp [new_CkSFtp]

set success [CkSFtp_Connect $sftp "my-ssh-server.com" 22]
if {$success == 1} then {
    set success [CkSFtp_AuthenticatePw $sftp "mySshLogin" "mySshPassword"]
}

if {$success == 1} then {
    set success [CkSFtp_InitializeSftp $sftp]
}

if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
# with the local directory tree rooted at "qa_output"
# Both directories are relative paths.  The remote directory
# is relative to the HOME directory of the SSH user account.
# The local directory is relative to the current working directory of the process.
# It is also possible to use absolute paths.

set remoteDir "syncDownloadTest/xml"
set localDir "qa_output"

# Possible modes that can be passed to the SyncTreeDownload method are:
# mode=0: Download all files
# mode=1: Download all files that do not exist on the local filesystem.
# mode=2: Download newer or non-existant files.
# mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
# mode=5: Download only missing files or files with size differences.
# mode=6: Same as mode 5, but also download newer files.
# mode=99: Do not download files, but instead delete remote files that do not exist locally.

# This example will use mode 6 to download missing, newer, or files with size differences.
set mode 6
# This example will turn on recursion to synchronize the entire tree. 
# Recursion can be turned off to synchronize the files of a single directory.
set recursive 1
set success [CkSFtp_SyncTreeDownload $sftp $remoteDir $localDir $mode $recursive]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "Success."

delete_CkSFtp $sftp