(Perl) SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$sftp = chilkat::CkSFtp->new();

# Set some timeouts, in milliseconds:
$sftp->put_ConnectTimeoutMs(5000);
$sftp->put_IdleTimeoutMs(15000);

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
$hostname = "sftp.example.com";
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp->AuthenticatePw("myLogin","myPassword");
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Open a file on the server:

$handle = $sftp->openFile("hamlet.xml","readOnly","openExisting");
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# Get the total size of this file (in bytes)
$bFollowLinks = 0;
$bIsHandle = 1;

# bFollowLinks is ignored because we are passing a handle
# and not a remote filename.
# There are alternative methods for handling file sizes
# greater than 32-bit.  (See the reference documentation.)
$numBytes = $sftp->GetFileSize32($handle,$bFollowLinks,$bIsHandle);
if ($numBytes < 0) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

# The charset indicates the character encoding of the text
# file on the SSH server.   Setting the charset correctly
# allows the Chilkat SFTP component to correctly interpret
# the bytes that represent the characters.

$charset = "ansi";

$fileContents = $sftp->readFileText($handle,$numBytes,$charset);
if ($sftp->get_LastMethodSuccess() != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}
else {
    print "Received file:" . "\r\n";
    print $fileContents . "\r\n";
}

# Close the file.
$success = $sftp->CloseHandle($handle);
if ($success != 1) {
    print $sftp->lastErrorText() . "\r\n";
    exit;
}

print "Success." . "\r\n";