(PureBasic) SCP Upload Contents of String to Remote File

Demonstrates how to upload the contents of a string variable using the SCP protocol (Secure Copy Protocol over SSH). The text is uploaded to a file in specific remote directory. If the file did not already exist, it is created. If it already existed, it is overwritten.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSsh.pb"
IncludeFile "CkScp.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ssh.i = CkSsh::ckCreate()
    If ssh.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to an SSH server:
    hostname.s
    port.i

    ; Hostname may be an IP address or hostname:
    hostname = "www.some-ssh-server.com"
    port = 22

    success.i = CkSsh::ckConnect(ssh,hostname,port)
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Wait a max of 5 seconds when reading responses..
    CkSsh::setCkIdleTimeoutMs(ssh, 5000)

    ; Authenticate using login/password:
    success = CkSsh::ckAuthenticatePw(ssh,"myLogin","myPassword")
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Once the SSH object is connected and authenticated, we use it
    ; as the underlying transport in our SCP object.
    scp.i = CkScp::ckCreate()
    If scp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkScp::ckUseSsh(scp,ssh)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    content.s = "This string will be the contents of the remote file."
    remotePath.s = "uploads/text/testUtf8.txt"

    ; The utf-8 byte representation of the string will be uploaded.
    ; See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charsets.
    charset.s = "utf-8"

    ; This uploads to the "uploads/text" directory relative to the HOME
    ; directory of the SSH user account.  
    ; Note: The remote target directory must already exist on the SSH server.
    success = CkScp::ckUploadString(scp,remotePath,content,charset)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    remotePath = "uploads/text/testUtf8_withBOM.txt"

    ; To include the utf-8 preamble (also known as the BOM),
    ; prefix the charset name with "bom:".  Any charset that can 
    ; optionally include a BOM can be specified in this way.
    charset = "bom:utf-8"

    ; Uploads to a remote file that contains text in the 
    ; utf-8 representation, including the BOM at the start of the file.
    success = CkScp::ckUploadString(scp,remotePath,content,charset)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    Debug "SCP upload string success."

    ; Disconnect
    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)
    CkScp::ckDispose(scp)


    ProcedureReturn
EndProcedure