Create an FTP Upload Plan

See more FTP Examples

Demonstrates the Chilkat Ftp2.CreatePlan method, which creates and returns a textual upload plan for a local directory. The only argument is the local directory. The object must be connected, because the plan records the current absolute remote directory together with the local source paths.

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: A plan is a saved, resumable description of an upload — the list of local files and their absolute remote destinations — computed once and executed later (or on another run) with PutPlan. Separating planning from execution suits large or unreliable transfers: the plan can be reviewed, stored, and re-run, and because it records absolute remote paths it stays correct even if the working directory later changes.

Chilkat Go Downloads

Download Chilkat for Go

    success := false

    //  Demonstrates the Ftp2.CreatePlan method, which creates and returns a textual upload plan for a
    //  local directory.  The only argument is the local directory.  The object must be connected,
    //  because the plan records the current absolute remote directory.

    ftp := chilkat.NewFtp2()

    ftp.SetHostname("ftp.example.com")
    ftp.SetUsername("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.SetPassword("myPassword")

    success = ftp.Connect()
    if success == false {
        fmt.Println(ftp.LastErrorText())
        ftp.DisposeFtp2()
        return
    }

    success = ftp.ChangeRemoteDir("public_html")
    if success == false {
        fmt.Println(ftp.LastErrorText())
        ftp.DisposeFtp2()
        return
    }

    //  The plan captures which local files to upload and the absolute remote destination.  Save it so
    //  the upload can be run (or resumed) later with PutPlan.
    plan := ftp.CreatePlan("qa_data/site")
    if ftp.LastMethodSuccess() == false {
        fmt.Println(ftp.LastErrorText())
        ftp.DisposeFtp2()
        return
    }

    //  Persist the plan text for later use.
    sbPlan := chilkat.NewStringBuilder()
    sbPlan.Append(*plan)
    success = sbPlan.WriteFile("qa_output/upload_plan.txt")
    if success == false {
        fmt.Println(sbPlan.LastErrorText())
        ftp.DisposeFtp2()
        sbPlan.DisposeStringBuilder()
        return
    }

    fmt.Println("Upload plan created.")

    success = ftp.Disconnect()
    if success == false {
        fmt.Println(ftp.LastErrorText())
        ftp.DisposeFtp2()
        sbPlan.DisposeStringBuilder()
        return
    }


    ftp.DisposeFtp2()
    sbPlan.DisposeStringBuilder()