Lua

Sync a Local Tree Up with Preview and Traversal Control

Demonstrates the Chilkat Ftp2.SyncRemoteTree2 method, which uploads a local tree to the current remote directory with extra controls. The arguments are the local root, the upload mode, whether to descend into subdirectories, and whether to run preview-only. In preview mode the results are available via the SyncPreview property.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: The preview flag is what makes this valuable: run it first to see exactly which files would be uploaded — without transferring anything — then run it again for real once the plan looks right. That dry-run step is a strong safeguard before a large or destructive-looking sync. The descend flag lets you limit the operation to the top level, and the mode is the same set of upload rules as SyncRemoteTree.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.SyncRemoteTree2 method, which uploads a local tree to the current remote
-- directory with extra traversal and preview controls.  The 1st argument is the local root, the
-- 2nd is the upload mode, the 3rd selects whether to descend into subdirectories, and the 4th
-- selects preview-only (no actual transfers).

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.username = "myFtpLogin"

-- 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.
ftp.password = "myPassword"

local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:change_remote_dir("public_html")
if not success then
    print(ftp.last_error_text)
    return
end

--   0 = all selected files
--   1 = files missing on the server
--   2 = missing, or newer locally
--   3 = only files that exist remotely and are newer locally
--   4 = missing, or a different size
--   5 = missing, different size, or newer locally

local mode = 5

-- Descend into subdirectories.
local bDescend = true

-- Preview only: determine what WOULD be uploaded without transferring anything.  The results are
-- available via the SyncPreview property.
local bPreviewOnly = true

success = ftp:sync_remote_tree2("qa_data/site", mode, bDescend, bPreviewOnly)
if not success then
    print(ftp.last_error_text)
    return
end

-- SyncPreview lists the files that would be uploaded.
print(ftp.sync_preview)

success = ftp:disconnect()
if not success then
    print(ftp.last_error_text)
    return
end