Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oFtp
LOCAL oSbPlan
LOCAL cPlan

nSuccess := 0

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

oFtp := CreateObject("Chilkat.Ftp2")

oFtp:Hostname := "ftp.example.com"
oFtp: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.
oFtp:Password := "myPassword"

nSuccess := oFtp:Connect()
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

nSuccess := oFtp:ChangeRemoteDir("public_html")
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    RETURN
ENDIF

//  Load a plan that was previously created with CreatePlan.
oSbPlan := CreateObject("Chilkat.StringBuilder")
nSuccess := oSbPlan:LoadFile("qa_output/upload_plan.txt", "utf-8")
IF (nSuccess == 0)
    ? oSbPlan:LastErrorText
    oFtp:destroy()
    oSbPlan:destroy()
    RETURN
ENDIF

cPlan := oSbPlan:GetAsString()

//  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.
nSuccess := oFtp:PutPlan(cPlan, "qa_output/upload_done.log")
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    oSbPlan:destroy()
    RETURN
ENDIF

? "Upload plan executed."

nSuccess := oFtp:Disconnect()
IF (nSuccess == 0)
    ? oFtp:LastErrorText
    oFtp:destroy()
    oSbPlan:destroy()
    RETURN
ENDIF

oFtp:destroy()
oSbPlan:destroy()