PHP

SFTP Upload Large File in Parts

See more SFTP Examples

Demonstrates how to split a large file into N parts and then upload each part separately. This technique can be used to potentially avoid limits a SFTP server might impose on upload file size. Chilkat2 PHP

<?php

use Chilkat2\BinData;
use Chilkat2\FileAccess;
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();

    // Open a remote file for writing on the SSH server.
    // If the file already exists, it is overwritten.
    // (Specify "createNew" instead of "createTruncate" to
    // prevent overwriting existing files.)
    $handle = $sftp->OpenFile('big.zip', 'writeOnly', 'createTruncate');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// We're going to upload the local file "qa_data/zips/big.zip" (a relative local path from our current working directory)
// to the SFTP server.
$localFilePath = 'qa_data/zips/big.zip';

// Rather than uploading in one shot, we'll read the local file in chunks
// and upload a chunk at a time.
$fac = new FileAccess();

try {
    $fac->OpenForRead($localFilePath);
} catch (\Chilkat2\Exception $e) {
    $sftp->CloseHandle($handle);
    echo $e->getMessage(), "\n";
    exit;
}

// If we were to split the local file into 128K chunks, how many chunks (blocks) would
// we have, including the last partial block?
$blockSize = 131072;
$numBlocks = $fac->GetNumBlocks($blockSize);
echo 'Number of blocks = ', $numBlocks, "\n";

$bd = new BinData();
$i = 0;
while ($i < $numBlocks) {
    // Read the Nth block, which gets appended to the bd.  (which means
    // we must clear the contents of bd before the next iteration)
    try {
        $fac->ReadBlockBd($i, $blockSize, $bd);
    } catch (\Chilkat2\Exception $e) {
        $sftp->CloseHandle($handle);
        echo $e->getMessage(), "\n";
        exit;
    }

    // Upload this block to the open remote file.
    try {
        $sftp->WriteFileBd($handle, $bd);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    // Clear the contents for the next iteration.
    $bd->Clear();

    $i = $i + 1;
}

// Close the local file.
$fac->FileClose();

// -----------------------------------------------------------------------------
// This is important.  You must close the handle on the server.
// 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 remote file handle on the server.
try {
    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Success.\n";