PHP

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Chilkat2 PHP

<?php

use Chilkat2\SFtp;

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

$sftp = new SFtp();

// Set some timeouts, in milliseconds:
$sftp->ConnectTimeoutMs = 5000;
$sftp->IdleTimeoutMs = 10000;

// 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;
try {
    $sftp->Connect($hostname, $port);

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    $sftp->AuthenticatePw('myLogin', 'myPassword');

    // After authenticating, the SFTP subsystem must be initialized:
    $sftp->InitializeSftp();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
// For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
$bFollowLinks = true;
$bIsHandle = false;
$fileSize = $sftp->GetFileSize32('someDir/someFile.dat', $bFollowLinks, $bIsHandle);
if ($fileSize < 0) {
    echo $sftp->LastErrorText, "\n";
    exit;
}

echo 'file size = ', $fileSize, "\n";

// If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
// You can convert the string to a 64-bit integer in your programming language.
try {
    $fileSizeStr = $sftp->GetFileSizeStr('someDir/someFile.dat', $bFollowLinks, $bIsHandle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo 'file size = ', $fileSizeStr, "\n";

// You can alternatively get the size with an open file handle.
try {
    $handle = $sftp->OpenFile('someDir/someFile.dat', 'readOnly', 'openExisting');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Get the size using the handle.
$bIsHandle = true;
$fileSize = $sftp->GetFileSize32('someDir/someFile.dat', $bFollowLinks, $bIsHandle);
if ($fileSize < 0) {
    echo $sftp->LastErrorText, "\n";
    exit;
}

echo 'file size = ', $fileSize, "\n";

// -----------------------------------------------------------------------------
// Don't forget to close the file handle.
// Otherwise open handles will accumulate on the server until eventually a limit
// is reached and the server will fail on a call to OpenFile.
// -----------------------------------------------------------------------------

// Close the file.
try {
    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}