Lua

SCP Sync Tree Upload

See more SCP Examples

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

local chilkat = require("chilkat")

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

local ssh = chilkat.Ssh.new()

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

-- Connect to an SSH server:
local success = ssh:connect(hostname, port)
if not success then
    print(ssh.last_error_text)
    return
end

-- Wait a max of 5 seconds when reading responses..
ssh.idle_timeout_ms = 5000

-- Authenticate using login/password:
success = ssh:authenticate_pw("myLogin", "myPassword")
if not success then
    print(ssh.last_error_text)
    return
end

-- Once the SSH object is connected and authenticated, we use it
-- in our SCP object.
local scp = chilkat.Scp.new()

success = scp:use_ssh(ssh)
if not success then
    print(scp.last_error_text)
    return
end

-- The remoteRoot is relative to the HOME directory of the SSH user account.
local remoteRoot = "workspace/projectB"
local 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.sync_must_not_match = "*.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.sync_must_match = "*.cpp; *.h"

-- Do the recursive sync to upload newer or non-existant files:
local bRecurse = true
local mode = 2
success = scp:sync_tree_upload(localRoot, remoteRoot, mode, bRecurse)
if not success then
    print(scp.last_error_text)
    return
end

-- 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.
print("Files uploaded: ")
print(scp.synced_files)

print("----")
print("SCP sync upload success.")

-- Disconnect
ssh:disconnect()