(Node.js) FTP Sync Download Tree w/ Must-Match Directory Constraints

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

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

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

    var ftp = new chilkat.Ftp2();

    ftp.Hostname = "ftp.something.com";
    ftp.Username = "my_login";
    ftp.Password = "my_password";

    // Connect and login to the FTP server.
    var success = ftp.Connect();
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    // Set the current remote directory to the root of
    // the tree to be downloaded.
    success = ftp.ChangeRemoteDir("/subDir1");
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    // 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.

    // 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/

    // Only enter remote directories named either "data" or matching "x*"
    ftp.SyncMustMatchDir = "data; x*";
    var mode = 0;
    success = ftp.SyncLocalTree("c:/temp/subDir1",mode);
    if (success !== true) {
        console.log(ftp.LastErrorText);
        return;
    }

    success = ftp.Disconnect();

    // Show the files downloaded.
    var st = new chilkat.StringTable();
    ftp.GetSyncedFiles(st);

    var numFiles = st.Count;
    var i = 0;
    var remoteFilename;
    while (i < numFiles) {
        console.log(st.StringAt(i));
        i = i+1;
    }

    // Output showing the files downloaded:

    // accentedLatin1.txt
    // accentedUtf8.txt
    // alice.key
    // anter_cert.pem
    // chiliPepper.gif
    // helloWorld.pdf
    // data/chiliPepper.gif
    // data/xyz/dkimHtmlBody.txt
    // data/xyz/dkimVerifyTest.eml
    // data/xyz/emailForCreateDsn.eml

}

chilkatExample();