Perl

Get a Remote File's Size as a String

Demonstrates the Chilkat SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a decimal string. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: Returning the size as a string sidesteps integer-width limits entirely, so it is the safe choice for files of any size — multi-gigabyte archives, disk images, database dumps. It is also convenient in programming languages that lack a native 64-bit integer type. When you need to do arithmetic on the value, parse the string; when you only need to display or log it, the string is ready to use.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the SFtp.GetFileSizeStr method, which returns a remote file's size in bytes as a
# decimal string.  The 1st argument is the remote path (or handle), the 2nd selects whether
# symbolic links are followed, and the 3rd indicates whether the 1st argument is a handle.

my $sftp = Chilkat2::SFtp->new;

# Connect, authenticate, and initialize the SFTP subsystem.
my $port = 22;
my $success = $sftp->Connect('sftp.example.com', $port);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# 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.
my $password = 'mySshPassword';

$success = $sftp->AuthenticatePw('mySshLogin', $password);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

$success = $sftp->InitializeSftp();
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
# The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
# open handle.
my $bFollowLinks = 1;
my $bIsHandle = 0;

# A string return avoids the 32-bit overflow that GetFileSize32 would have for very large files.
my $fileSize = $sftp->GetFileSizeStr('subdir/hugefile.dat', $bFollowLinks, $bIsHandle);
if (!$sftp->LastMethodSuccess) {
    print $sftp->LastErrorText, "\n";
    exit;
}

print 'File size: ', $fileSize, " bytes\n";

$sftp->Disconnect();