Streaming SFTP Download

Demonstrates how to download a file chunk by chunk from an SSH server.

Download Chilkat 32-bit SSH / SFTP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

<?php

//  Important: It is helpful to send the contents of the
//  sftp.LastErrorText property when requesting support.

$sftp = new COM("Chilkat.SFtp");

//  Any string automatically begins a fully-functional 30-day trial.
$success = $sftp->UnlockComponent('Anything for 30-day trial');
if ($success != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

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

//  Connect to the SSH server.
//  The standard SSH port = 22
//  The hostname may be a hostname or IP address.

$hostname = 'www.my-ssh-server.com';
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != true) {
    print $sftp->lastErrorText() . "\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 != true) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

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

//  Open a file on the server:

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

$bEof = false;
$chunkSize = 10000;

while ($bEof == false) {

    $pData = $sftp->ReadFileBytes($handle,$chunkSize);
    if ($sftp->LastReadFailed($handle) == true) {
        print $sftp->lastErrorText() . "\n";
        break;
    }
    else {

        //  Do whatever  you wish with the data received...
        //  It is possible that if the EOF is reached, 0 bytes will be returned.

    }

    $bEof = $sftp->Eof($handle);
}

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

print 'Success.' . "\n";
?>