DataFlex

SCP Upload Contents of String to Remote File

See more SCP Examples

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

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vSsh
    Handle hoSsh
    String sHostname
    Integer iPort
    Handle hoScp
    String sContent
    String sRemotePath
    String sCharset
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatSsh)) To hoSsh
    If (Not(IsComObjectCreated(hoSsh))) Begin
        Send CreateComObject of hoSsh
    End

    // Connect to an SSH server:

    // Hostname may be an IP address or hostname:
    Move "www.some-ssh-server.com" To sHostname
    Move 22 To iPort

    Get ComConnect Of hoSsh sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Wait a max of 5 seconds when reading responses..
    Set ComIdleTimeoutMs Of hoSsh To 5000

    // Authenticate using login/password:
    Get ComAuthenticatePw Of hoSsh "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Once the SSH object is connected and authenticated, we use it
    // as the underlying transport in our SCP object.
    Get Create (RefClass(cComChilkatScp)) To hoScp
    If (Not(IsComObjectCreated(hoScp))) Begin
        Send CreateComObject of hoScp
    End

    Get pvComObject of hoSsh to vSsh
    Get ComUseSsh Of hoScp vSsh To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move "This string will be the contents of the remote file." To sContent
    Move "uploads/text/testUtf8.txt" To sRemotePath

    // 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.
    Move "utf-8" To sCharset

    // 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.
    Get ComUploadString Of hoScp sRemotePath sContent sCharset To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move "uploads/text/testUtf8_withBOM.txt" To sRemotePath

    // 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.
    Move "bom:utf-8" To sCharset

    // Uploads to a remote file that contains text in the 
    // utf-8 representation, including the BOM at the start of the file.
    Get ComUploadString Of hoScp sRemotePath sContent sCharset To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoScp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "SCP upload string success."

    // Disconnect
    Send ComDisconnect To hoSsh


End_Procedure