Tcl

FTP Sync Download Tree w/ Must-Match Constraints

See more FTP Examples

Demonstrates how synchronize a directory tree in the download direction, but only for files matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

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 ftp [new_CkFtp2]

CkFtp2_put_Hostname $ftp "ftp.something.com"
CkFtp2_put_Username $ftp "my_login"
CkFtp2_put_Password $ftp "my_password"

# Connect and login to the FTP server.
set success [CkFtp2_Connect $ftp]
if {$success != 1} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

# Set the current remote directory to the root of
# the tree to be downloaded.
set success [CkFtp2_ChangeRemoteDir $ftp "/subDir1"]
if {$success != 1} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

# Possible synchronization modes 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.

# This example will download all files, but only those files having filenames
# that match *.gif and *.eml

# Imagine our remote directory tree has these files and directories:

# 	accentedLatin1.txt
# 	accentedUtf8.txt
# 	alice.key
# 	anter_cert.pem
# 	chiliPepper.gif
# 	helloWorld.pdf
# 	abc/chiliPepper.gif
# 	abc/ghk/
# 	data/chiliPepper.gif
# 	data/xyz/dkimHtmlBody.txt
# 	data/xyz/dkimVerifyTest.eml
# 	data/xyz/emailForCreateDsn.eml
# 	text/frenchUtf8.txt
# 	text/helloWorld.txt
# 	text/PolishEmailBody.txt
# 	text/something/

# Indicate that we only want to create auto-create local directories (if needed)
# for the files that are actually downloaded.  If SyncCreateAllLocalDirs remains
# 1, then the corresponding local directory is created for each remote directory
# traversed regardless of whether files within are downloaded.
CkFtp2_put_SyncCreateAllLocalDirs $ftp 0

CkFtp2_put_SyncMustMatch $ftp "*.eml; *.gif"
set mode 0
set success [CkFtp2_SyncLocalTree $ftp "c:/temp/subDir1" $mode]
if {$success != 1} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

set success [CkFtp2_Disconnect $ftp]

# Show the files downloaded.
set st [new_CkStringTable]

CkFtp2_GetSyncedFiles $ftp $st

set numFiles [CkStringTable_get_Count $st]
set i 0

while {$i < $numFiles} {
    puts [CkStringTable_stringAt $st $i]
    set i [expr $i + 1]
}

# Output showing the files downloaded:

# chiliPepper.gif
# abc/chiliPepper.gif
# data/chiliPepper.gif
# data/xyz/dkimVerifyTest.eml
# data/xyz/emailForCreateDsn.eml

delete_CkFtp2 $ftp
delete_CkStringTable $st