Files
WPS3Media/vendor/Aws3/Aws/S3/ObjectCopier.php
Malin 3248cbb029 feat: add S3-compatible storage provider (MinIO, Ceph, R2, etc.)
Adds a new 'S3-Compatible Storage' provider that works with any
S3-API-compatible object storage service, including MinIO, Ceph,
Cloudflare R2, Backblaze B2, and others.

Changes:
- New provider class: classes/providers/storage/s3-compatible-provider.php
  - Provider key: s3compatible
  - Reads user-configured endpoint URL from settings
  - Uses path-style URL access (required by most S3-compatible services)
  - Supports credentials via AS3CF_S3COMPAT_ACCESS_KEY_ID /
    AS3CF_S3COMPAT_SECRET_ACCESS_KEY wp-config.php constants
  - Disables AWS-specific features (Block Public Access, Object Ownership)
- New provider SVG icons (s3compatible.svg, -link.svg, -round.svg)
- Registered provider in main plugin class with endpoint setting support
- Updated StorageProviderSubPage to show endpoint URL input for S3-compatible
- Built pro settings bundle with rollup (Svelte 4.2.19)
- Added package.json and updated rollup.config.mjs for pro-only builds
2026-03-03 12:30:18 +01:00

120 lines
5.6 KiB
PHP

<?php
namespace DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3;
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Arn\ArnParser;
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Arn\S3\AccessPointArn;
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Exception\MultipartUploadException;
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Result;
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\Exception\S3Exception;
use DeliciousBrains\WP_Offload_Media\Aws3\GuzzleHttp\Promise\Coroutine;
use DeliciousBrains\WP_Offload_Media\Aws3\GuzzleHttp\Promise\PromiseInterface;
use DeliciousBrains\WP_Offload_Media\Aws3\GuzzleHttp\Promise\PromisorInterface;
use InvalidArgumentException;
/**
* Copies objects from one S3 location to another, utilizing a multipart copy
* when appropriate.
*/
class ObjectCopier implements PromisorInterface
{
const DEFAULT_MULTIPART_THRESHOLD = MultipartUploader::PART_MAX_SIZE;
private $client;
private $source;
private $destination;
private $acl;
private $options;
private static $defaults = ['before_lookup' => null, 'before_upload' => null, 'concurrency' => 5, 'mup_threshold' => self::DEFAULT_MULTIPART_THRESHOLD, 'params' => [], 'part_size' => null, 'version_id' => null];
/**
* @param S3ClientInterface $client The S3 Client used to execute
* the copy command(s).
* @param array $source The object to copy, specified as
* an array with a 'Bucket' and
* 'Key' keys. Provide a
* 'VersionID' key to copy a
* specified version of an object.
* @param array $destination The bucket and key to which to
* copy the $source, specified as
* an array with a 'Bucket' and
* 'Key' keys.
* @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 commands.
*
* @throws InvalidArgumentException
*/
public function __construct(S3ClientInterface $client, array $source, array $destination, $acl = 'private', array $options = [])
{
$this->validateLocation($source);
$this->validateLocation($destination);
$this->client = $client;
$this->source = $source;
$this->destination = $destination;
$this->acl = $acl;
$this->options = $options + self::$defaults;
}
/**
* Perform the configured copy asynchronously. Returns a promise that is
* fulfilled with the result of the CompleteMultipartUpload or CopyObject
* operation or rejected with an exception.
*
* @return Coroutine
*/
public function promise() : PromiseInterface
{
return Coroutine::of(function () {
$headObjectCommand = $this->client->getCommand('HeadObject', $this->options['params'] + $this->source);
if (\is_callable($this->options['before_lookup'])) {
$this->options['before_lookup']($headObjectCommand);
}
$objectStats = (yield $this->client->executeAsync($headObjectCommand));
if ($objectStats['ContentLength'] > $this->options['mup_threshold']) {
$mup = new MultipartCopy($this->client, $this->getSourcePath(), ['source_metadata' => $objectStats, 'acl' => $this->acl] + $this->destination + $this->options);
(yield $mup->promise());
} else {
$defaults = ['ACL' => $this->acl, 'MetadataDirective' => 'COPY', 'CopySource' => $this->getSourcePath()];
$params = \array_diff_key($this->options, self::$defaults) + $this->destination + $defaults + $this->options['params'];
(yield $this->client->executeAsync($this->client->getCommand('CopyObject', $params)));
}
});
}
/**
* Perform the configured copy synchronously. Returns the result of the
* CompleteMultipartUpload or CopyObject operation.
*
* @return Result
*
* @throws S3Exception
* @throws MultipartUploadException
*/
public function copy()
{
return $this->promise()->wait();
}
private function validateLocation(array $location)
{
if (empty($location['Bucket']) || empty($location['Key'])) {
throw new \InvalidArgumentException('Locations provided to an' . ' Aws\\S3\\ObjectCopier must have a non-empty Bucket and Key');
}
}
private function getSourcePath()
{
$path = "/{$this->source['Bucket']}/";
if (ArnParser::isArn($this->source['Bucket'])) {
try {
new AccessPointArn($this->source['Bucket']);
$path = "{$this->source['Bucket']}/object/";
} catch (\Exception $e) {
throw new \InvalidArgumentException('Provided ARN was a not a valid S3 access point ARN (' . $e->getMessage() . ')', 0, $e);
}
}
$sourcePath = $path . \rawurlencode($this->source['Key']);
if (isset($this->source['VersionId'])) {
$sourcePath .= "?versionId={$this->source['VersionId']}";
}
return $sourcePath;
}
}