Lua

FTP Non-Recursive Sync Directory (Download)

See more FTP Examples

Download files from the server that have filenames matchhing a pattern, and don't yet exist in a local directory. 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 = "myUsername"
ftp.password = "myPassword"
ftp.port = 21
ftp.auth_tls = true

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

-- Change to the remote directory where the files are located.
-- This step is only necessary if the files are not in the root directory
-- of the FTP account.
success = ftp:change_remote_dir("qa")
if not success then
    print(ftp.last_error_text)
    return
end

-- Indicate that we only want to download files with filenames ending in ".txt"
ftp.sync_must_match = "*.txt"

-- Modes for synchronization are as follows:
-- 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.
local mode = 1

-- Download all files matching "*.txt" from the current remote ftp directory.
-- The files are downloaded into c:/temp/qa_output
success = ftp:sync_local_dir("c:/temp/qa_output", mode)
if not success then
    print(ftp.last_error_text)
    return
end

-- Perhaps we wish to delete the files we just downloaded from the server..
local st = chilkat.StringTable.new()
ftp:get_synced_files(st)

local numFiles = st.count
local i = 0
local remoteFilename = ""
while i < numFiles do
    remoteFilename = st:string_at(i)
    print("Deleting " .. remoteFilename .. " from the FTP server")
    success = ftp:delete_remote_file(remoteFilename)
    if not success then
        print(ftp.last_error_text)
        return
    end

    i = i + 1
end

success = ftp:disconnect()