Objective-C

SCP Sync Tree Upload

See more SCP Examples

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

#import <CkoSsh.h>
#import <NSString.h>
#import <CkoScp.h>

BOOL success = NO;

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

CkoSsh *ssh = [[CkoSsh alloc] init];

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

// Connect to an SSH server:
success = [ssh Connect: hostname port: [NSNumber numberWithInt: port]];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = [NSNumber numberWithInt:5000];

// Authenticate using login/password:
success = [ssh AuthenticatePw: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
CkoScp *scp = [[CkoScp alloc] init];

success = [scp UseSsh: ssh];
if (success != YES) {
    NSLog(@"%@",scp.LastErrorText);
    return;
}

// The remoteRoot is relative to the HOME directory of the SSH user account.
NSString *remoteRoot = @"workspace/projectB";
NSString *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:
BOOL bRecurse = YES;
int mode = 2;
success = [scp SyncTreeUpload: localRoot remoteBaseDir: remoteRoot mode: [NSNumber numberWithInt: mode] bRecurse: bRecurse];
if (success != YES) {
    NSLog(@"%@",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.
NSLog(@"%@",@"Files uploaded: ");
NSLog(@"%@",scp.SyncedFiles);

NSLog(@"%@",@"----");
NSLog(@"%@",@"SCP sync upload success.");

// Disconnect
[ssh Disconnect];