Lua

Execute an FTP Upload Plan

Demonstrates the Chilkat Ftp2.PutPlan method, which executes a previously created upload plan. The first argument is the plan text and the second is the local path of a completion log that records each successful operation.

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 completion log is what makes plan execution resumable: each successful upload is recorded, so if a run is interrupted, re-executing the same plan skips the operations already logged and continues where it left off — invaluable for a large transfer over a flaky connection. The plan's stored absolute remote paths are used regardless of the current remote directory, so execution is independent of session state.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.PutPlan method, which executes a previously created upload plan.  The 1st
-- argument is the plan text and the 2nd is the local path of a completion log.

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

-- Load a plan that was previously created with CreatePlan.
local sbPlan = chilkat.StringBuilder.new()
success = sbPlan:load_file("qa_output/upload_plan.txt", "utf-8")
if not success then
    print(sbPlan.last_error_text)
    return
end

local plan = sbPlan:get_as_string()

-- Execute the plan.  Each successful operation is recorded in the completion log, which lets an
-- interrupted run be resumed without repeating completed uploads.  The plan uses its stored
-- absolute remote paths even if the current remote directory has changed.
success = ftp:put_plan(plan, "qa_output/upload_done.log")
if not success then
    print(ftp.last_error_text)
    return
end

print("Upload plan executed.")

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