111 lines
5.2 KiB
PHP
111 lines
5.2 KiB
PHP
<?php
|
|
|
|
namespace UglyRobot\Infinite_Uploads\Aws\S3;
|
|
|
|
use UglyRobot\Infinite_Uploads\GuzzleHttp\Promise\PromisorInterface;
|
|
use UglyRobot\Infinite_Uploads\GuzzleHttp\Psr7;
|
|
use UglyRobot\Infinite_Uploads\Psr\Http\Message\StreamInterface;
|
|
/**
|
|
* Uploads an object to S3, using a PutObject command or a multipart upload as
|
|
* appropriate.
|
|
*/
|
|
class ObjectUploader implements \UglyRobot\Infinite_Uploads\GuzzleHttp\Promise\PromisorInterface
|
|
{
|
|
const DEFAULT_MULTIPART_THRESHOLD = 16777216;
|
|
private $client;
|
|
private $bucket;
|
|
private $key;
|
|
private $body;
|
|
private $acl;
|
|
private $options;
|
|
private static $defaults = ['before_upload' => null, 'concurrency' => 3, 'mup_threshold' => self::DEFAULT_MULTIPART_THRESHOLD, 'params' => [], 'part_size' => null];
|
|
/**
|
|
* @param S3ClientInterface $client The S3 Client used to execute
|
|
* the upload command(s).
|
|
* @param string $bucket Bucket to upload the object, or
|
|
* an S3 access point ARN.
|
|
* @param string $key Key of the object.
|
|
* @param mixed $body Object data to upload. Can be a
|
|
* StreamInterface, PHP stream
|
|
* resource, or a string of data to
|
|
* upload.
|
|
* @param string $acl ACL to apply to the copy
|
|
* (default: private).
|
|
* @param array $options Options used to configure the
|
|
* copy process. Options passed in
|
|
* through 'params' are added to
|
|
* the sub command(s).
|
|
*/
|
|
public function __construct(\UglyRobot\Infinite_Uploads\Aws\S3\S3ClientInterface $client, $bucket, $key, $body, $acl = 'private', array $options = [])
|
|
{
|
|
$this->client = $client;
|
|
$this->bucket = $bucket;
|
|
$this->key = $key;
|
|
$this->body = \UglyRobot\Infinite_Uploads\GuzzleHttp\Psr7\stream_for($body);
|
|
$this->acl = $acl;
|
|
$this->options = $options + self::$defaults;
|
|
}
|
|
public function promise()
|
|
{
|
|
/** @var int $mup_threshold */
|
|
$mup_threshold = $this->options['mup_threshold'];
|
|
if ($this->requiresMultipart($this->body, $mup_threshold)) {
|
|
// Perform a multipart upload.
|
|
return (new \UglyRobot\Infinite_Uploads\Aws\S3\MultipartUploader($this->client, $this->body, ['bucket' => $this->bucket, 'key' => $this->key, 'acl' => $this->acl] + $this->options))->promise();
|
|
}
|
|
// Perform a regular PutObject operation.
|
|
$command = $this->client->getCommand('PutObject', ['Bucket' => $this->bucket, 'Key' => $this->key, 'Body' => $this->body, 'ACL' => $this->acl] + $this->options['params']);
|
|
if (is_callable($this->options['before_upload'])) {
|
|
$this->options['before_upload']($command);
|
|
}
|
|
return $this->client->executeAsync($command);
|
|
}
|
|
public function upload()
|
|
{
|
|
return $this->promise()->wait();
|
|
}
|
|
/**
|
|
* Determines if the body should be uploaded using PutObject or the
|
|
* Multipart Upload System. It also modifies the passed-in $body as needed
|
|
* to support the upload.
|
|
*
|
|
* @param StreamInterface $body Stream representing the body.
|
|
* @param integer $threshold Minimum bytes before using Multipart.
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function requiresMultipart(\UglyRobot\Infinite_Uploads\Psr\Http\Message\StreamInterface &$body, $threshold)
|
|
{
|
|
// If body size known, compare to threshold to determine if Multipart.
|
|
if ($body->getSize() !== null) {
|
|
return $body->getSize() >= $threshold;
|
|
}
|
|
/**
|
|
* Handle the situation where the body size is unknown.
|
|
* Read up to 5MB into a buffer to determine how to upload the body.
|
|
* @var StreamInterface $buffer
|
|
*/
|
|
$buffer = \UglyRobot\Infinite_Uploads\GuzzleHttp\Psr7\stream_for();
|
|
\UglyRobot\Infinite_Uploads\GuzzleHttp\Psr7\copy_to_stream($body, $buffer, \UglyRobot\Infinite_Uploads\Aws\S3\MultipartUploader::PART_MIN_SIZE);
|
|
// If body < 5MB, use PutObject with the buffer.
|
|
if ($buffer->getSize() < \UglyRobot\Infinite_Uploads\Aws\S3\MultipartUploader::PART_MIN_SIZE) {
|
|
$buffer->seek(0);
|
|
$body = $buffer;
|
|
return false;
|
|
}
|
|
// If body >= 5 MB, then use multipart. [YES]
|
|
if ($body->isSeekable() && $body->getMetadata('uri') !== 'php://input') {
|
|
// If the body is seekable, just rewind the body.
|
|
$body->seek(0);
|
|
} else {
|
|
// If the body is non-seekable, stitch the rewind the buffer and
|
|
// the partially read body together into one stream. This avoids
|
|
// unnecessary disc usage and does not require seeking on the
|
|
// original stream.
|
|
$buffer->seek(0);
|
|
$body = new \UglyRobot\Infinite_Uploads\GuzzleHttp\Psr7\AppendStream([$buffer, $body]);
|
|
}
|
|
return true;
|
|
}
|
|
}
|