(PureBasic) SFTP Upload - Synchronize Directory Tree

See more SFTP Examples

Demonstrates how to upload files to synchronize a local directory tree with a remote directory tree. The SyncTreeUpload method recursively descends a local directory tree and uploads files based on existence, last-mod date/time and/or size differences.

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

    ; Synchronize (by uploading) the local directory tree rooted at "qa_data/sftpUploadTree"
    ; with the remote directory tree rooted at "syncUploadTest"
    ; 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.

    remoteDir.s = "syncUploadTest"
    localDir.s = "qa_data/sftpUploadTree"

    ; Possible modes that can be passed to the SyncTreeUpload method are:
    ; mode=0: Upload all files
    ; mode=1: Upload all files that do not exist on the server.
    ; mode=2: Upload newer or non-existant files.
    ; mode=3: Upload only newer files. If a file does not already exist on the server, it is not uploaded.
    ; mode=4: transfer missing files or files with size differences.
    ; mode=5: same as mode 4, but also newer files.

    ; This example will use mode 5 to upload missing, newer, or files with size differences.
    mode.i = 5
    ; This example turns on recursion to synchronize the entire tree. 
    ; Recursion can be turned off to synchronize the files of a single directory.
    recursive.i = 1
    success = CkSFtp::ckSyncTreeUpload(sftp,localDir,remoteDir,mode,recursive)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "Success."


    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure