PureBasic

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.

PureBasic

IncludeFile "CkFtp2.pb"
IncludeFile "CkStringTable.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    CkFtp2::setCkHostname(ftp, "ftp.something.com")
    CkFtp2::setCkUsername(ftp, "my_login")
    CkFtp2::setCkPassword(ftp, "my_password")

    ; Connect and login to the FTP server.
    success = CkFtp2::ckConnect(ftp)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ; Set the current remote directory to the root of
    ; the tree to be downloaded.
    success = CkFtp2::ckChangeRemoteDir(ftp,"/subDir1")
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ; 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::setCkSyncCreateAllLocalDirs(ftp, 0)

    CkFtp2::setCkSyncMustMatch(ftp, "*.eml; *.gif")
    mode.i = 0
    success = CkFtp2::ckSyncLocalTree(ftp,"c:/temp/subDir1",mode)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckDisconnect(ftp)

    ; Show the files downloaded.
    st.i = CkStringTable::ckCreate()
    If st.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFtp2::ckGetSyncedFiles(ftp,st)

    numFiles.i = CkStringTable::ckCount(st)
    i.i = 0
    remoteFilename.s
    While i < numFiles
        Debug CkStringTable::ckStringAt(st,i)
        i = i + 1
    Wend

    ; Output showing the files downloaded:

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


    CkFtp2::ckDispose(ftp)
    CkStringTable::ckDispose(st)


    ProcedureReturn
EndProcedure