PHP

AWS S3 File Streaming Upload

See more Amazon S3 (new) Examples

Demonstrates how to do a streaming upload from a file to the AWS S3 storage service. The AWS authorization presents some difficulties when the REST request body is to be streamed from a file (or from some other source). The issue is that the SHA-256 hash of the file data must be calculated. There are only two possible ways to do this: (1) stream the file into memory in its entirety and calculate the SHA-256 hash prior to uploading, or (2) pre-calculate the SHA-256 in a streaming fashion, and then provide it to the AWS authentication object.

If the application does NOT pre-compute the SHA-256, then Chilkat (internally) is forced to stream into memory, calculate the SHA-256, and then upload from the in-memory copy of the file.

Chilkat2 PHP

<?php

use Chilkat2\AuthAws;
use Chilkat2\Crypt2;
use Chilkat2\Rest;
use Chilkat2\Stream;

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

// This first part is optional.  AWS authentication requires
// the SHA-256 hash of the request body (i.e. the contents of the file
// to be uploaded).  We can choose to pre-calculate the SHA-256 in a streaming fashion
// and then provide it to the authenticator object.  This way, if the file is
// extremely large, it never needs to completely reside in memory.
$crypt = new Crypt2();
$crypt->EncodingMode = 'hex';
$crypt->HashAlgorithm = 'sha-256';
$fileToUploadPath = 'qa_data/xml/hamlet.xml';
$hashStr = $crypt->HashFileENC($fileToUploadPath);

$rest = new Rest();

// Connect to the Amazon AWS REST server.
$bTls = true;
$port = 443;
$bAutoReconnect = true;
$rest->Connect('s3.amazonaws.com', $port, $bTls, $bAutoReconnect);

// ----------------------------------------------------------------------------
// Important: For buckets created in regions outside us-east-1,
// there are three important changes that need to be made.
// See Working with S3 Buckets in Non-us-east-1 Regions for the details.
// ----------------------------------------------------------------------------

// Provide AWS credentials for the REST call.
$authAws = new AuthAws();
$authAws->AccessKey = 'AWS_ACCESS_KEY';
$authAws->SecretKey = 'AWS_SECRET_KEY';
$authAws->ServiceName = 's3';
// Provide the pre-computed SHA-256 here:
$authAws->PrecomputedSha256 = $hashStr;

$rest->SetAuthAws($authAws);

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat100".
$rest->Host = 'chilkat100.s3.amazonaws.com';

$fileStream = new Stream();
$fileStream->SourceFile = $fileToUploadPath;

// Upload to the S3 Storage service.
// If the application provided the SHA-256 hash of the file contents (as shown above)
// then file is streamed and never has to completely reside in memory.
// If the application did NOT provide the SHA-256, then Chilkat will (internally)
// load the entire file into memory, calculate the SHA-256, and then upload.
try {
    $responseStr = $rest->FullRequestStream('PUT', '/hamlet.xml', $fileStream);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// When successful, the S3 Storage service will respond with a 200 response code,
// with an XML body.
if ($rest->ResponseStatusCode == 200) {
    echo $responseStr, "\n";
    echo "File uploaded.\n";
} else {
    // Examine the request/response to see what happened.
    echo 'response status code = ', $rest->ResponseStatusCode, "\n";
    echo 'response status text = ', $rest->ResponseStatusText, "\n";
    echo 'response header: ', $rest->ResponseHeader, "\n";
    echo 'response body: ', $responseStr, "\n";
    echo "---\n";
    echo 'LastRequestStartLine: ', $rest->LastRequestStartLine, "\n";
    echo 'LastRequestHeader: ', $rest->LastRequestHeader, "\n";
}