Lua Requires Chilkat v9.5.0.76+

FTP Sync Download Tree w/ Must-Match Directory Constraints

See more FTP Examples

Demonstrates how synchronize a directory tree in the download direction, but only entering directories matching a set of wildcard filenames. 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.something.com"
ftp.username = "my_login"
ftp.password = "my_password"

-- 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

-- Possible synchronization modes are:
-- 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.

-- Imagine our remote directory tree has these files and directories:

--     accentedLatin1.txt
--     accentedUtf8.txt
--     alice.key
--     anter_cert.pem
--     chiliPepper.gif
--     helloWorld.pdf
--     abc/chiliPepper.gif
--     abc/ghk/
--     data/chiliPepper.gif
--     data/xyz/dkimHtmlBody.txt
--     data/xyz/dkimVerifyTest.eml
--     data/xyz/emailForCreateDsn.eml
--     text/frenchUtf8.txt
--     text/helloWorld.txt
--     text/PolishEmailBody.txt
--     text/something/

-- Only enter remote directories named either "data" or matching "x*"
ftp.sync_must_match_dir = "data; x*"
local mode = 0
success = ftp:sync_local_tree("c:/temp/subDir1", mode)
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:disconnect()

-- Show the files downloaded.
local st = chilkat.StringTable.new()
ftp:get_synced_files(st)

local numFiles = st.count
local i = 0
local remoteFilename = ""
while i < numFiles do
    print(st:string_at(i))
    i = i + 1
end

-- Output showing the files downloaded:

-- accentedLatin1.txt
-- accentedUtf8.txt
-- alice.key
-- anter_cert.pem
-- chiliPepper.gif
-- helloWorld.pdf
-- data/chiliPepper.gif
-- data/xyz/dkimHtmlBody.txt
-- data/xyz/dkimVerifyTest.eml
-- data/xyz/emailForCreateDsn.eml