(JavaScript) SCP Sync Tree Upload

Synchronize local and remote directory trees by uploading newer or missing files to the remote server.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var ssh = new CkSsh();

// Hostname may be an IP address or hostname:
var hostname = "www.some-ssh-server.com";
var port = 22;

// Connect to an SSH server:
success = ssh.Connect(hostname,port);
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

// Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000;

// Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword");
if (success !== true) {
    console.log(ssh.LastErrorText);
    return;
}

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
var scp = new CkScp();

success = scp.UseSsh(ssh);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

// The remoteRoot is relative to the HOME directory of the SSH user account.
var remoteRoot = "workspace/projectB";
var localRoot = "c:/aaworkarea/scp/workspace/projectB";

// Upload synchronization modes:
// mode=0: Upload all files
// mode=1: Upload all files that do not exist on the FTP server.
// mode=2: Upload newer or non-existant files.
// mode=3: Upload only newer files.  If a file does not already exist on the FTP 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.

// Additional files and directores can be excluded by setting the SyncMustNotMatch property.
// The SyncMustNotMatch patterns apply only to the final filename or directory part of a path.
// If a directory matches, then it will not be traversed in a recursive traversal.
// 
scp.SyncMustNotMatch = "*.o;*.obj;*.log; temp";

// The SyncMustMatch property can be set to restrict the files uploaded to only those
// matching at least one pattern in a set.
scp.SyncMustMatch = "*.cpp; *.h";

// Do the recursive sync to upload newer or non-existant files:
var bRecurse = true;
var mode = 2;
success = scp.SyncTreeUpload(localRoot,remoteRoot,mode,bRecurse);
if (success !== true) {
    console.log(scp.LastErrorText);
    return;
}

// The files actually uploaded can be examined in the SyncedFiles property.
// It is a string property that contains the relative path, one per line, of each
// file uploaded.
console.log("Files uploaded: ");
console.log(scp.SyncedFiles);

console.log("----");
console.log("SCP sync upload success.");

// Disconnect
ssh.Disconnect();