(PureBasic) SFTP Sync Download Tree w/ Must-Match Filename Constraints

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

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSFtp.pb"

Procedure ChilkatExample()

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

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

    success.i = CkSFtp::ckConnect(sftp,"my-ssh-server.com",22)
    If success = 1
        success = CkSFtp::ckAuthenticatePw(sftp,"mySshLogin","mySshPassword")
    EndIf

    If success = 1
        success = CkSFtp::ckInitializeSftp(sftp)
    EndIf

    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        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.
    CkSFtp::setCkSyncCreateAllLocalDirs(sftp, 0)

    CkSFtp::setCkSyncMustMatch(sftp, "*.eml; *.gif")

    remoteDir.s = "syncDownloadTest/someDir"
    localDir.s = "qa_output"
    mode.i = 0
    recursive.i = 1
    success = CkSFtp::ckSyncTreeDownload(sftp,remoteDir,localDir,mode,recursive)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; The following files were downloaded:

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

    Debug "Success."


    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure