DataFlex

Synchronize an SFTP Directory Tree to Local

Demonstrates the Chilkat SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a local directory. The arguments are the remote root, the local root, the sync mode, and whether to recurse into subdirectories.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

Background: The mirror-image of SyncTreeUpload, used to pull a remote tree down — fetching logs, backing up a server directory, or refreshing a local copy of published content. The same mode numbers apply, now judged from the download direction: only-missing, only-newer-on-server, differing-size, and so on. Missing local directories are created as needed, and GetSyncedFiles reports both the files and the directories that resulted.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    Integer iPort
    String sPassword
    Integer iMode
    Boolean iRecurse
    String sTemp1

    Move False To iSuccess

    //  Demonstrates the SFtp.SyncTreeDownload method, which synchronizes a remote directory tree to a
    //  local directory.  The 1st argument is the remote root, the 2nd is the local root, the 3rd is
    //  the sync mode, and the 4th selects recursion into subdirectories.

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    //  Connect, authenticate, and initialize the SFTP subsystem.
    Move 22 To iPort
    Get ComConnect Of hoSftp "sftp.example.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    Move "mySshPassword" To sPassword

    Get ComAuthenticatePw Of hoSftp "mySshLogin" sPassword To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  Sync mode 5 downloads files that are missing locally or differ in size, plus files that are
    //  newer on the server.  Other modes:
    //    0 = all files
    //    1 = files not existing locally
    //    2 = files newer remotely or missing locally
    //    3 = only files newer remotely (do not download missing)
    //    4 = files missing locally or differing in size
    //    5 = mode 4 plus files newer remotely
    Move 5 To iMode
    Move True To iRecurse
    Get ComSyncTreeDownload Of hoSftp "/var/www/html" "qa_output/website" iMode iRecurse To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Directory tree downloaded."

    Send ComDisconnect To hoSftp


End_Procedure