Lua

Synchronize Local Directory Tree

See more FTP Examples

Downloads files from the FTP server to a local directory tree. Synchronization modes include:

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.
mode=99: Do not download files, but instead delete remote files that do not exist locally. Lua

local chilkat = require("chilkat")

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

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.username = "login"
ftp.password = "password"

ftp.keep_session_log = true

-- Connect and login to the FTP server.
local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

-- Set the current remote directory to the root of
-- the tree to be downloaded.
success = ftp:change_remote_dir("/subDir1")
if not success then
    print(ftp.last_error_text)
    return
end

-- Recursively download all non-existant and newer files.
local mode = 2
success = ftp:sync_local_tree("c:/temp/subDir1", mode)
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:disconnect()

-- Display the session log.
print(ftp.session_log)