Malin
3248cbb029
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
809 lines
50 KiB
PHP
809 lines
50 KiB
PHP
<?php
|
|
|
|
namespace DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3;
|
|
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Api\ApiProvider;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Api\DocModel;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Api\Service;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\AwsClient;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\CacheInterface;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\ClientResolver;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Command;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\CommandInterface;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Configuration\ConfigurationResolver;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Exception\AwsException;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\HandlerList;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Identity\S3\S3ExpressIdentityProvider;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\InputValidationMiddleware;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Middleware;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\ResultInterface;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\Retry\QuotaManager;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\RetryMiddleware;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\RetryMiddlewareV2;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\Parser\GetBucketLocationResultMutator;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\Parser\S3Parser;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\Parser\ValidateResponseChecksumResultMutator;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\RegionalEndpoint\ConfigurationProvider;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\UseArnRegion\Configuration;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\UseArnRegion\ConfigurationInterface;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Aws\S3\UseArnRegion\ConfigurationProvider as UseArnRegionConfigurationProvider;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\GuzzleHttp\Exception\RequestException;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\GuzzleHttp\Promise\PromiseInterface;
|
|
use DeliciousBrains\WP_Offload_Media\Aws3\Psr\Http\Message\RequestInterface;
|
|
/**
|
|
* Client used to interact with **Amazon Simple Storage Service (Amazon S3)**.
|
|
*
|
|
* @method \Aws\Result abortMultipartUpload(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise abortMultipartUploadAsync(array $args = [])
|
|
* @method \Aws\Result completeMultipartUpload(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise completeMultipartUploadAsync(array $args = [])
|
|
* @method \Aws\Result copyObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise copyObjectAsync(array $args = [])
|
|
* @method \Aws\Result createBucket(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise createBucketAsync(array $args = [])
|
|
* @method \Aws\Result createMultipartUpload(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise createMultipartUploadAsync(array $args = [])
|
|
* @method \Aws\Result createSession(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise createSessionAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucket(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketAnalyticsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketAnalyticsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketCors(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketCorsAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketEncryption(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketEncryptionAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketIntelligentTieringConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketIntelligentTieringConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketInventoryConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketInventoryConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketLifecycle(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketLifecycleAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketMetricsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketMetricsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketOwnershipControls(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketOwnershipControlsAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketPolicy(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketReplication(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketReplicationAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array $args = [])
|
|
* @method \Aws\Result deleteBucketWebsite(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteBucketWebsiteAsync(array $args = [])
|
|
* @method \Aws\Result deleteObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
|
|
* @method \Aws\Result deleteObjectTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteObjectTaggingAsync(array $args = [])
|
|
* @method \Aws\Result deleteObjects(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deleteObjectsAsync(array $args = [])
|
|
* @method \Aws\Result deletePublicAccessBlock(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise deletePublicAccessBlockAsync(array $args = [])
|
|
* @method \Aws\Result getBucketAccelerateConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketAccelerateConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketAcl(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketAclAsync(array $args = [])
|
|
* @method \Aws\Result getBucketAnalyticsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketAnalyticsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketCors(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketCorsAsync(array $args = [])
|
|
* @method \Aws\Result getBucketEncryption(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketEncryptionAsync(array $args = [])
|
|
* @method \Aws\Result getBucketIntelligentTieringConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketIntelligentTieringConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketInventoryConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketInventoryConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketLifecycle(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleAsync(array $args = [])
|
|
* @method \Aws\Result getBucketLifecycleConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketLocation(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketLocationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketLogging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketLoggingAsync(array $args = [])
|
|
* @method \Aws\Result getBucketMetricsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketMetricsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketNotification(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketNotificationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketNotificationConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketNotificationConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketOwnershipControls(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketOwnershipControlsAsync(array $args = [])
|
|
* @method \Aws\Result getBucketPolicy(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketPolicyAsync(array $args = [])
|
|
* @method \Aws\Result getBucketPolicyStatus(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketPolicyStatusAsync(array $args = [])
|
|
* @method \Aws\Result getBucketReplication(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketReplicationAsync(array $args = [])
|
|
* @method \Aws\Result getBucketRequestPayment(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketRequestPaymentAsync(array $args = [])
|
|
* @method \Aws\Result getBucketTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketTaggingAsync(array $args = [])
|
|
* @method \Aws\Result getBucketVersioning(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketVersioningAsync(array $args = [])
|
|
* @method \Aws\Result getBucketWebsite(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getBucketWebsiteAsync(array $args = [])
|
|
* @method \Aws\Result getObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectAsync(array $args = [])
|
|
* @method \Aws\Result getObjectAcl(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectAclAsync(array $args = [])
|
|
* @method \Aws\Result getObjectAttributes(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectAttributesAsync(array $args = [])
|
|
* @method \Aws\Result getObjectLegalHold(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectLegalHoldAsync(array $args = [])
|
|
* @method \Aws\Result getObjectLockConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectLockConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result getObjectRetention(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectRetentionAsync(array $args = [])
|
|
* @method \Aws\Result getObjectTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectTaggingAsync(array $args = [])
|
|
* @method \Aws\Result getObjectTorrent(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getObjectTorrentAsync(array $args = [])
|
|
* @method \Aws\Result getPublicAccessBlock(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise getPublicAccessBlockAsync(array $args = [])
|
|
* @method \Aws\Result headBucket(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise headBucketAsync(array $args = [])
|
|
* @method \Aws\Result headObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise headObjectAsync(array $args = [])
|
|
* @method \Aws\Result listBucketAnalyticsConfigurations(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listBucketAnalyticsConfigurationsAsync(array $args = [])
|
|
* @method \Aws\Result listBucketIntelligentTieringConfigurations(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listBucketIntelligentTieringConfigurationsAsync(array $args = [])
|
|
* @method \Aws\Result listBucketInventoryConfigurations(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listBucketInventoryConfigurationsAsync(array $args = [])
|
|
* @method \Aws\Result listBucketMetricsConfigurations(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listBucketMetricsConfigurationsAsync(array $args = [])
|
|
* @method \Aws\Result listBuckets(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listBucketsAsync(array $args = [])
|
|
* @method \Aws\Result listDirectoryBuckets(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listDirectoryBucketsAsync(array $args = [])
|
|
* @method \Aws\Result listMultipartUploads(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listMultipartUploadsAsync(array $args = [])
|
|
* @method \Aws\Result listObjectVersions(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listObjectVersionsAsync(array $args = [])
|
|
* @method \Aws\Result listObjects(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listObjectsAsync(array $args = [])
|
|
* @method \Aws\Result listObjectsV2(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listObjectsV2Async(array $args = [])
|
|
* @method \Aws\Result listParts(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise listPartsAsync(array $args = [])
|
|
* @method \Aws\Result putBucketAccelerateConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketAccelerateConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketAcl(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketAclAsync(array $args = [])
|
|
* @method \Aws\Result putBucketAnalyticsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketAnalyticsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketCors(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketCorsAsync(array $args = [])
|
|
* @method \Aws\Result putBucketEncryption(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketEncryptionAsync(array $args = [])
|
|
* @method \Aws\Result putBucketIntelligentTieringConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketIntelligentTieringConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketInventoryConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketInventoryConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketLifecycle(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleAsync(array $args = [])
|
|
* @method \Aws\Result putBucketLifecycleConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketLogging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketLoggingAsync(array $args = [])
|
|
* @method \Aws\Result putBucketMetricsConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketMetricsConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketNotification(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketNotificationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketNotificationConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketNotificationConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketOwnershipControls(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketOwnershipControlsAsync(array $args = [])
|
|
* @method \Aws\Result putBucketPolicy(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketPolicyAsync(array $args = [])
|
|
* @method \Aws\Result putBucketReplication(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketReplicationAsync(array $args = [])
|
|
* @method \Aws\Result putBucketRequestPayment(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketRequestPaymentAsync(array $args = [])
|
|
* @method \Aws\Result putBucketTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketTaggingAsync(array $args = [])
|
|
* @method \Aws\Result putBucketVersioning(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketVersioningAsync(array $args = [])
|
|
* @method \Aws\Result putBucketWebsite(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putBucketWebsiteAsync(array $args = [])
|
|
* @method \Aws\Result putObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectAsync(array $args = [])
|
|
* @method \Aws\Result putObjectAcl(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectAclAsync(array $args = [])
|
|
* @method \Aws\Result putObjectLegalHold(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectLegalHoldAsync(array $args = [])
|
|
* @method \Aws\Result putObjectLockConfiguration(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectLockConfigurationAsync(array $args = [])
|
|
* @method \Aws\Result putObjectRetention(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectRetentionAsync(array $args = [])
|
|
* @method \Aws\Result putObjectTagging(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putObjectTaggingAsync(array $args = [])
|
|
* @method \Aws\Result putPublicAccessBlock(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise putPublicAccessBlockAsync(array $args = [])
|
|
* @method \Aws\Result restoreObject(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise restoreObjectAsync(array $args = [])
|
|
* @method \Aws\Result selectObjectContent(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise selectObjectContentAsync(array $args = [])
|
|
* @method \Aws\Result uploadPart(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise uploadPartAsync(array $args = [])
|
|
* @method \Aws\Result uploadPartCopy(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise uploadPartCopyAsync(array $args = [])
|
|
* @method \Aws\Result writeGetObjectResponse(array $args = [])
|
|
* @method \GuzzleHttp\Promise\Promise writeGetObjectResponseAsync(array $args = [])
|
|
*/
|
|
class S3Client extends AwsClient implements S3ClientInterface
|
|
{
|
|
use S3ClientTrait;
|
|
/** @var array */
|
|
private static $mandatoryAttributes = ['Bucket', 'Key'];
|
|
public static function getArguments()
|
|
{
|
|
$args = parent::getArguments();
|
|
$args['retries']['fn'] = [__CLASS__, '_applyRetryConfig'];
|
|
$args['api_provider']['fn'] = [__CLASS__, '_applyApiProvider'];
|
|
return $args + ['bucket_endpoint' => ['type' => 'config', 'valid' => ['bool'], 'doc' => 'Set to true to send requests to a hardcoded ' . 'bucket endpoint rather than create an endpoint as a ' . 'result of injecting the bucket into the URL. This ' . 'option is useful for interacting with CNAME endpoints.'], 'use_arn_region' => ['type' => 'config', 'valid' => ['bool', Configuration::class, CacheInterface::class, 'callable'], 'doc' => 'Set to true to allow passed in ARNs to override' . ' client region. Accepts...', 'fn' => [__CLASS__, '_apply_use_arn_region'], 'default' => [UseArnRegionConfigurationProvider::class, 'defaultProvider']], 'use_accelerate_endpoint' => ['type' => 'config', 'valid' => ['bool'], 'doc' => 'Set to true to send requests to an S3 Accelerate' . ' endpoint by default. Can be enabled or disabled on' . ' individual operations by setting' . ' \'@use_accelerate_endpoint\' to true or false. Note:' . ' you must enable S3 Accelerate on a bucket before it can' . ' be accessed via an Accelerate endpoint.', 'default' => \false], 'use_path_style_endpoint' => ['type' => 'config', 'valid' => ['bool'], 'doc' => 'Set to true to send requests to an S3 path style' . ' endpoint by default.' . ' Can be enabled or disabled on individual operations by setting' . ' \'@use_path_style_endpoint\' to true or false.', 'default' => \false], 'disable_multiregion_access_points' => ['type' => 'config', 'valid' => ['bool'], 'doc' => 'Set to true to disable the usage of' . ' multi region access points. These are enabled by default.' . ' Can be enabled or disabled on individual operations by setting' . ' \'@disable_multiregion_access_points\' to true or false.', 'default' => \false], 'disable_express_session_auth' => ['type' => 'config', 'valid' => ['bool'], 'doc' => 'Set to true to disable the usage of' . ' s3 express session authentication. This is enabled by default.', 'default' => [__CLASS__, '_default_disable_express_session_auth']], 's3_express_identity_provider' => ['type' => 'config', 'valid' => ['bool', 'callable'], 'doc' => 'Specifies the provider used to generate identities to sign s3 express requests. ' . 'Set to `false` to disable s3 express auth, or a callable provider used to create s3 express ' . 'identities or return null.', 'default' => [__CLASS__, '_default_s3_express_identity_provider']]];
|
|
}
|
|
/**
|
|
* {@inheritdoc}
|
|
*
|
|
* In addition to the options available to
|
|
* {@see Aws\AwsClient::__construct}, S3Client accepts the following
|
|
* options:
|
|
*
|
|
* - bucket_endpoint: (bool) Set to true to send requests to a
|
|
* hardcoded bucket endpoint rather than create an endpoint as a result
|
|
* of injecting the bucket into the URL. This option is useful for
|
|
* interacting with CNAME endpoints. Note: if you are using version 2.243.0
|
|
* and above and do not expect the bucket name to appear in the host, you will
|
|
* also need to set `use_path_style_endpoint` to `true`.
|
|
* - calculate_md5: (bool) Set to false to disable calculating an MD5
|
|
* for all Amazon S3 signed uploads.
|
|
* - s3_us_east_1_regional_endpoint:
|
|
* (Aws\S3\RegionalEndpoint\ConfigurationInterface|Aws\CacheInterface\|callable|string|array)
|
|
* Specifies whether to use regional or legacy endpoints for the us-east-1
|
|
* region. Provide an Aws\S3\RegionalEndpoint\ConfigurationInterface object, an
|
|
* instance of Aws\CacheInterface, a callable configuration provider used
|
|
* to create endpoint configuration, a string value of `legacy` or
|
|
* `regional`, or an associative array with the following keys:
|
|
* endpoint_types: (string) Set to `legacy` or `regional`, defaults to
|
|
* `legacy`
|
|
* - use_accelerate_endpoint: (bool) Set to true to send requests to an S3
|
|
* Accelerate endpoint by default. Can be enabled or disabled on
|
|
* individual operations by setting '@use_accelerate_endpoint' to true or
|
|
* false. Note: you must enable S3 Accelerate on a bucket before it can be
|
|
* accessed via an Accelerate endpoint.
|
|
* - use_arn_region: (Aws\S3\UseArnRegion\ConfigurationInterface,
|
|
* Aws\CacheInterface, bool, callable) Set to true to enable the client
|
|
* to use the region from a supplied ARN argument instead of the client's
|
|
* region. Provide an instance of Aws\S3\UseArnRegion\ConfigurationInterface,
|
|
* an instance of Aws\CacheInterface, a callable that provides a promise for
|
|
* a Configuration object, or a boolean value. Defaults to false (i.e.
|
|
* the SDK will not follow the ARN region if it conflicts with the client
|
|
* region and instead throw an error).
|
|
* - use_dual_stack_endpoint: (bool) Set to true to send requests to an S3
|
|
* Dual Stack endpoint by default, which enables IPv6 Protocol.
|
|
* Can be enabled or disabled on individual operations by setting
|
|
* '@use_dual_stack_endpoint\' to true or false. Note:
|
|
* you cannot use it together with an accelerate endpoint.
|
|
* - use_path_style_endpoint: (bool) Set to true to send requests to an S3
|
|
* path style endpoint by default.
|
|
* Can be enabled or disabled on individual operations by setting
|
|
* '@use_path_style_endpoint\' to true or false. Note:
|
|
* you cannot use it together with an accelerate endpoint.
|
|
* - disable_multiregion_access_points: (bool) Set to true to disable
|
|
* sending multi region requests. They are enabled by default.
|
|
* Can be enabled or disabled on individual operations by setting
|
|
* '@disable_multiregion_access_points\' to true or false. Note:
|
|
* you cannot use it together with an accelerate or dualstack endpoint.
|
|
*
|
|
* @param array $args
|
|
*/
|
|
public function __construct(array $args)
|
|
{
|
|
if (!isset($args['s3_us_east_1_regional_endpoint']) || $args['s3_us_east_1_regional_endpoint'] instanceof CacheInterface) {
|
|
$args['s3_us_east_1_regional_endpoint'] = ConfigurationProvider::defaultProvider($args);
|
|
}
|
|
$this->addBuiltIns($args);
|
|
parent::__construct($args);
|
|
$stack = $this->getHandlerList();
|
|
$stack->appendInit(SSECMiddleware::wrap($this->getEndpoint()->getScheme()), 's3.ssec');
|
|
$stack->appendBuild(ApplyChecksumMiddleware::wrap($this->getApi()), 's3.checksum');
|
|
$stack->appendBuild(Middleware::contentType(['PutObject', 'UploadPart']), 's3.content_type');
|
|
if ($this->getConfig('bucket_endpoint')) {
|
|
$stack->appendBuild(BucketEndpointMiddleware::wrap(), 's3.bucket_endpoint');
|
|
} elseif (!$this->isUseEndpointV2()) {
|
|
$stack->appendBuild(S3EndpointMiddleware::wrap($this->getRegion(), $this->getConfig('endpoint_provider'), ['accelerate' => $this->getConfig('use_accelerate_endpoint'), 'path_style' => $this->getConfig('use_path_style_endpoint'), 'use_fips_endpoint' => $this->getConfig('use_fips_endpoint'), 'dual_stack' => $this->getConfig('use_dual_stack_endpoint')->isUseDualStackEndpoint()]), 's3.endpoint_middleware');
|
|
}
|
|
$stack->appendBuild(BucketEndpointArnMiddleware::wrap($this->getApi(), $this->getRegion(), ['use_arn_region' => $this->getConfig('use_arn_region'), 'accelerate' => $this->getConfig('use_accelerate_endpoint'), 'path_style' => $this->getConfig('use_path_style_endpoint'), 'dual_stack' => $this->getConfig('use_dual_stack_endpoint')->isUseDualStackEndpoint(), 'use_fips_endpoint' => $this->getConfig('use_fips_endpoint'), 'disable_multiregion_access_points' => $this->getConfig('disable_multiregion_access_points'), 'endpoint' => $args['endpoint'] ?? null], $this->isUseEndpointV2()), 's3.bucket_endpoint_arn');
|
|
if ($this->getConfig('disable_express_session_auth')) {
|
|
$stack->prependSign($this->getDisableExpressSessionAuthMiddleware(), 's3.disable_express_session_auth');
|
|
}
|
|
$stack->appendValidate(InputValidationMiddleware::wrap($this->getApi(), self::$mandatoryAttributes), 'input_validation_middleware');
|
|
$stack->appendSign(ExpiresParsingMiddleware::wrap(), 's3.expires_parsing');
|
|
$stack->appendSign(PutObjectUrlMiddleware::wrap(), 's3.put_object_url');
|
|
$stack->appendSign(PermanentRedirectMiddleware::wrap(), 's3.permanent_redirect');
|
|
$stack->appendInit(Middleware::sourceFile($this->getApi()), 's3.source_file');
|
|
$stack->appendInit($this->getSaveAsParameter(), 's3.save_as');
|
|
$stack->appendInit($this->getLocationConstraintMiddleware(), 's3.location');
|
|
$stack->appendInit($this->getEncodingTypeMiddleware(), 's3.auto_encode');
|
|
$stack->appendInit($this->getHeadObjectMiddleware(), 's3.head_object');
|
|
$this->processModel($this->isUseEndpointV2());
|
|
if ($this->isUseEndpointV2()) {
|
|
$stack->after('builder', 's3.check_empty_path_with_query', $this->getEmptyPathWithQuery());
|
|
}
|
|
}
|
|
/**
|
|
* Determine if a string is a valid name for a DNS compatible Amazon S3
|
|
* bucket.
|
|
*
|
|
* DNS compatible bucket names can be used as a subdomain in a URL (e.g.,
|
|
* "<bucket>.s3.amazonaws.com").
|
|
*
|
|
* @param string $bucket Bucket name to check.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function isBucketDnsCompatible($bucket)
|
|
{
|
|
if (!\is_string($bucket)) {
|
|
return \false;
|
|
}
|
|
$bucketLen = \strlen($bucket);
|
|
return $bucketLen >= 3 && $bucketLen <= 63 && !\filter_var($bucket, \FILTER_VALIDATE_IP) && \preg_match('/^[a-z0-9]([a-z0-9\\-\\.]*[a-z0-9])?$/', $bucket);
|
|
}
|
|
public static function _apply_use_arn_region($value, array &$args, HandlerList $list)
|
|
{
|
|
if ($value instanceof CacheInterface) {
|
|
$value = UseArnRegionConfigurationProvider::defaultProvider($args);
|
|
}
|
|
if (\is_callable($value)) {
|
|
$value = $value();
|
|
}
|
|
if ($value instanceof PromiseInterface) {
|
|
$value = $value->wait();
|
|
}
|
|
if ($value instanceof ConfigurationInterface) {
|
|
$args['use_arn_region'] = $value;
|
|
} else {
|
|
// The Configuration class itself will validate other inputs
|
|
$args['use_arn_region'] = new Configuration($value);
|
|
}
|
|
}
|
|
public function createPresignedRequest(CommandInterface $command, $expires, array $options = [])
|
|
{
|
|
$command = clone $command;
|
|
$command->getHandlerList()->remove('signer');
|
|
$request = \DeliciousBrains\WP_Offload_Media\Aws3\Aws\serialize($command);
|
|
$signing_name = $command['@context']['signing_service'] ?? $this->getSigningName($request->getUri()->getHost());
|
|
$signature_version = $this->getSignatureVersionFromCommand($command);
|
|
/** @var \Aws\Signature\SignatureInterface $signer */
|
|
$signer = \call_user_func($this->getSignatureProvider(), $signature_version, $signing_name, $this->getConfig('signing_region'));
|
|
if ($signature_version == 'v4-s3express') {
|
|
$provider = $this->getConfig('s3_express_identity_provider');
|
|
$credentials = $provider($command)->wait();
|
|
} else {
|
|
$credentials = $this->getCredentials()->wait();
|
|
}
|
|
return $signer->presign($request, $credentials, $expires, $options);
|
|
}
|
|
/**
|
|
* Returns the URL to an object identified by its bucket and key.
|
|
*
|
|
* The URL returned by this method is not signed nor does it ensure that the
|
|
* bucket and key given to the method exist. If you need a signed URL, then
|
|
* use the {@see \Aws\S3\S3Client::createPresignedRequest} method and get
|
|
* the URI of the signed request.
|
|
*
|
|
* @param string $bucket The name of the bucket where the object is located
|
|
* @param string $key The key of the object
|
|
*
|
|
* @return string The URL to the object
|
|
*/
|
|
public function getObjectUrl($bucket, $key)
|
|
{
|
|
$command = $this->getCommand('GetObject', ['Bucket' => $bucket, 'Key' => $key]);
|
|
return (string) \DeliciousBrains\WP_Offload_Media\Aws3\Aws\serialize($command)->getUri();
|
|
}
|
|
/**
|
|
* Raw URL encode a key and allow for '/' characters
|
|
*
|
|
* @param string $key Key to encode
|
|
*
|
|
* @return string Returns the encoded key
|
|
*/
|
|
public static function encodeKey($key)
|
|
{
|
|
return \str_replace('%2F', '/', \rawurlencode($key));
|
|
}
|
|
/**
|
|
* Provides a middleware that removes the need to specify LocationConstraint on CreateBucket.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getLocationConstraintMiddleware()
|
|
{
|
|
$region = $this->getRegion();
|
|
return static function (callable $handler) use($region) {
|
|
return function (Command $command, $request = null) use($handler, $region) {
|
|
if ($command->getName() === 'CreateBucket') {
|
|
$locationConstraint = $command['CreateBucketConfiguration']['LocationConstraint'] ?? null;
|
|
if ($locationConstraint === 'us-east-1') {
|
|
unset($command['CreateBucketConfiguration']);
|
|
} elseif ('us-east-1' !== $region && empty($locationConstraint)) {
|
|
$command['CreateBucketConfiguration'] = ['LocationConstraint' => $region];
|
|
}
|
|
}
|
|
return $handler($command, $request);
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Provides a middleware that supports the `SaveAs` parameter.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getSaveAsParameter()
|
|
{
|
|
return static function (callable $handler) {
|
|
return function (Command $command, $request = null) use($handler) {
|
|
if ($command->getName() === 'GetObject' && isset($command['SaveAs'])) {
|
|
$command['@http']['sink'] = $command['SaveAs'];
|
|
unset($command['SaveAs']);
|
|
}
|
|
return $handler($command, $request);
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Provides a middleware that disables content decoding on HeadObject
|
|
* commands.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getHeadObjectMiddleware()
|
|
{
|
|
return static function (callable $handler) {
|
|
return function (CommandInterface $command, RequestInterface $request = null) use($handler) {
|
|
if ($command->getName() === 'HeadObject' && !isset($command['@http']['decode_content'])) {
|
|
$command['@http']['decode_content'] = \false;
|
|
}
|
|
return $handler($command, $request);
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Provides a middleware that autopopulates the EncodingType parameter on
|
|
* ListObjects commands.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getEncodingTypeMiddleware()
|
|
{
|
|
return static function (callable $handler) {
|
|
return function (Command $command, $request = null) use($handler) {
|
|
$autoSet = \false;
|
|
if ($command->getName() === 'ListObjects' && empty($command['EncodingType'])) {
|
|
$command['EncodingType'] = 'url';
|
|
$autoSet = \true;
|
|
}
|
|
return $handler($command, $request)->then(function (ResultInterface $result) use($autoSet) {
|
|
if ($result['EncodingType'] === 'url' && $autoSet) {
|
|
static $topLevel = ['Delimiter', 'Marker', 'NextMarker', 'Prefix'];
|
|
static $nested = [['Contents', 'Key'], ['CommonPrefixes', 'Prefix']];
|
|
foreach ($topLevel as $key) {
|
|
if (isset($result[$key])) {
|
|
$result[$key] = \urldecode($result[$key]);
|
|
}
|
|
}
|
|
foreach ($nested as $steps) {
|
|
if (isset($result[$steps[0]])) {
|
|
foreach ($result[$steps[0]] as $key => $part) {
|
|
if (isset($part[$steps[1]])) {
|
|
$result[$steps[0]][$key][$steps[1]] = \urldecode($part[$steps[1]]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $result;
|
|
});
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Provides a middleware that checks for an empty path and a
|
|
* non-empty query string.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getEmptyPathWithQuery()
|
|
{
|
|
return static function (callable $handler) {
|
|
return function (Command $command, RequestInterface $request) use($handler) {
|
|
$uri = $request->getUri();
|
|
if (empty($uri->getPath()) && !empty($uri->getQuery())) {
|
|
$uri = $uri->withPath('/');
|
|
$request = $request->withUri($uri);
|
|
}
|
|
return $handler($command, $request);
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Provides a middleware that disables express session auth when
|
|
* customers opt out of it.
|
|
*
|
|
* @return \Closure
|
|
*/
|
|
private function getDisableExpressSessionAuthMiddleware()
|
|
{
|
|
return function (callable $handler) {
|
|
return function (CommandInterface $command, RequestInterface $request = null) use($handler) {
|
|
if (!empty($command['@context']['signature_version']) && $command['@context']['signature_version'] === 'v4-s3express') {
|
|
$command['@context']['signature_version'] = 's3v4';
|
|
}
|
|
return $handler($command, $request);
|
|
};
|
|
};
|
|
}
|
|
/**
|
|
* Special handling for when the service name is s3-object-lambda.
|
|
* So, if the host contains s3-object-lambda, then the service name
|
|
* returned is s3-object-lambda, otherwise the default signing service is returned.
|
|
* @param string $host The host to validate if is a s3-object-lambda URL.
|
|
* @return string returns the signing service name to be used
|
|
*/
|
|
private function getSigningName($host)
|
|
{
|
|
if (\strpos($host, 's3-object-lambda')) {
|
|
return 's3-object-lambda';
|
|
}
|
|
return $this->getConfig('signing_name');
|
|
}
|
|
public static function _default_disable_express_session_auth(array &$args)
|
|
{
|
|
return ConfigurationResolver::resolve('s3_disable_express_session_auth', \false, 'bool', $args);
|
|
}
|
|
public static function _default_s3_express_identity_provider(array $args)
|
|
{
|
|
if ($args['config']['disable_express_session_auth']) {
|
|
return \false;
|
|
}
|
|
return new S3ExpressIdentityProvider($args['region']);
|
|
}
|
|
/**
|
|
* If EndpointProviderV2 is used, removes `Bucket` from request URIs.
|
|
* This is now handled by the endpoint ruleset.
|
|
*
|
|
* Additionally adds a synthetic shape `ExpiresString` and modifies
|
|
* `Expires` type to ensure it remains set to `timestamp`.
|
|
*
|
|
* @param array $args
|
|
* @return void
|
|
*
|
|
* @internal
|
|
*/
|
|
private function processModel(bool $isUseEndpointV2) : void
|
|
{
|
|
$definition = $this->getApi()->getDefinition();
|
|
if ($isUseEndpointV2) {
|
|
foreach ($definition['operations'] as &$operation) {
|
|
if (isset($operation['http']['requestUri'])) {
|
|
$requestUri = $operation['http']['requestUri'];
|
|
if ($requestUri === "/{Bucket}") {
|
|
$requestUri = \str_replace('/{Bucket}', '/', $requestUri);
|
|
} else {
|
|
$requestUri = \str_replace('/{Bucket}', '', $requestUri);
|
|
}
|
|
$operation['http']['requestUri'] = $requestUri;
|
|
}
|
|
}
|
|
}
|
|
foreach ($definition['shapes'] as $key => &$value) {
|
|
$suffix = 'Output';
|
|
if (\substr($key, -\strlen($suffix)) === $suffix) {
|
|
if (isset($value['members']['Expires'])) {
|
|
$value['members']['Expires']['deprecated'] = \true;
|
|
$value['members']['ExpiresString'] = ['shape' => 'ExpiresString', 'location' => 'header', 'locationName' => 'Expires'];
|
|
}
|
|
}
|
|
}
|
|
$definition['shapes']['ExpiresString']['type'] = 'string';
|
|
$definition['shapes']['Expires']['type'] = 'timestamp';
|
|
$this->getApi()->setDefinition($definition);
|
|
}
|
|
/**
|
|
* Adds service-specific client built-in values
|
|
*
|
|
* @return void
|
|
*/
|
|
private function addBuiltIns($args)
|
|
{
|
|
if (isset($args['region']) && $args['region'] !== 'us-east-1') {
|
|
return \false;
|
|
}
|
|
if (!isset($args['region']) && ConfigurationResolver::resolve('region', '', 'string') !== 'us-east-1') {
|
|
return \false;
|
|
}
|
|
$key = 'AWS::S3::UseGlobalEndpoint';
|
|
$result = $args['s3_us_east_1_regional_endpoint'] instanceof \Closure ? $args['s3_us_east_1_regional_endpoint']()->wait() : $args['s3_us_east_1_regional_endpoint'];
|
|
if (\is_string($result)) {
|
|
if ($result === 'regional') {
|
|
$value = \false;
|
|
} else {
|
|
if ($result === 'legacy') {
|
|
$value = \true;
|
|
} else {
|
|
return;
|
|
}
|
|
}
|
|
} else {
|
|
if ($result->isFallback() || $result->getEndpointsType() === 'legacy') {
|
|
$value = \true;
|
|
} else {
|
|
$value = \false;
|
|
}
|
|
}
|
|
$this->clientBuiltIns[$key] = $value;
|
|
}
|
|
/** @internal */
|
|
public static function _applyRetryConfig($value, $args, HandlerList $list)
|
|
{
|
|
if ($value) {
|
|
$config = \DeliciousBrains\WP_Offload_Media\Aws3\Aws\Retry\ConfigurationProvider::unwrap($value);
|
|
if ($config->getMode() === 'legacy') {
|
|
$maxRetries = $config->getMaxAttempts() - 1;
|
|
$decider = RetryMiddleware::createDefaultDecider($maxRetries);
|
|
$decider = function ($retries, $command, $request, $result, $error) use($decider, $maxRetries) {
|
|
$maxRetries = $command['@retries'] ?? $maxRetries;
|
|
if ($decider($retries, $command, $request, $result, $error)) {
|
|
return \true;
|
|
}
|
|
if ($error instanceof AwsException && $retries < $maxRetries) {
|
|
if ($error->getResponse() && $error->getResponse()->getStatusCode() >= 400) {
|
|
return \strpos($error->getResponse()->getBody(), 'Your socket connection to the server') !== \false;
|
|
}
|
|
if ($error->getPrevious() instanceof RequestException) {
|
|
// All commands except CompleteMultipartUpload are
|
|
// idempotent and may be retried without worry if a
|
|
// networking error has occurred.
|
|
return $command->getName() !== 'CompleteMultipartUpload';
|
|
}
|
|
}
|
|
return \false;
|
|
};
|
|
$delay = [RetryMiddleware::class, 'exponentialDelay'];
|
|
$list->appendSign(Middleware::retry($decider, $delay), 'retry');
|
|
} else {
|
|
$defaultDecider = RetryMiddlewareV2::createDefaultDecider(new QuotaManager(), $config->getMaxAttempts());
|
|
$list->appendSign(RetryMiddlewareV2::wrap($config, ['collect_stats' => $args['stats']['retries'], 'decider' => function ($attempts, CommandInterface $cmd, $result) use($defaultDecider, $config) {
|
|
$isRetryable = $defaultDecider($attempts, $cmd, $result);
|
|
if (!$isRetryable && $result instanceof AwsException && $attempts < $config->getMaxAttempts()) {
|
|
if (!empty($result->getResponse()) && $result->getResponse()->getStatusCode() >= 400) {
|
|
return \strpos($result->getResponse()->getBody(), 'Your socket connection to the server') !== \false;
|
|
}
|
|
if ($result->getPrevious() instanceof RequestException && $cmd->getName() !== 'CompleteMultipartUpload') {
|
|
$isRetryable = \true;
|
|
}
|
|
}
|
|
return $isRetryable;
|
|
}]), 'retry');
|
|
}
|
|
}
|
|
}
|
|
/** @internal */
|
|
public static function _applyApiProvider($value, array &$args, HandlerList $list)
|
|
{
|
|
ClientResolver::_apply_api_provider($value, $args);
|
|
$s3Parser = new S3Parser($args['parser'], $args['error_parser'], $args['api'], $args['exception_class']);
|
|
$s3Parser->addS3ResultMutator('get-bucket-location', new GetBucketLocationResultMutator());
|
|
$s3Parser->addS3ResultMutator('validate-response-checksum', new ValidateResponseChecksumResultMutator($args['api']));
|
|
$args['parser'] = $s3Parser;
|
|
}
|
|
/**
|
|
* @internal
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public static function applyDocFilters(array $api, array $docs)
|
|
{
|
|
$b64 = '<div class="alert alert-info">This value will be base64 encoded on your behalf.</div>';
|
|
$opt = '<div class="alert alert-info">This value will be computed for you it is not supplied.</div>';
|
|
// Add a note on the CopyObject docs
|
|
$s3ExceptionRetryMessage = "<p>Additional info on response behavior: if there is" . " an internal error in S3 after the request was successfully recieved," . " a 200 response will be returned with an <code>S3Exception</code> embedded" . " in it; this will still be caught and retried by" . " <code>RetryMiddleware.</code></p>";
|
|
$docs['operations']['CopyObject'] .= $s3ExceptionRetryMessage;
|
|
$docs['operations']['CompleteMultipartUpload'] .= $s3ExceptionRetryMessage;
|
|
$docs['operations']['UploadPartCopy'] .= $s3ExceptionRetryMessage;
|
|
$docs['operations']['UploadPart'] .= $s3ExceptionRetryMessage;
|
|
// Add note about stream ownership in the putObject call
|
|
$guzzleStreamMessage = "<p>Additional info on behavior of the stream" . " parameters: Psr7 takes ownership of streams and will automatically close" . " streams when this method is called with a stream as the <code>Body</code>" . " parameter. To prevent this, set the <code>Body</code> using" . " <code>GuzzleHttp\\Psr7\\stream_for</code> method with a is an instance of" . " <code>Psr\\Http\\Message\\StreamInterface</code>, and it will be returned" . " unmodified. This will allow you to keep the stream in scope. </p>";
|
|
$docs['operations']['PutObject'] .= $guzzleStreamMessage;
|
|
// Add the SourceFile parameter.
|
|
$docs['shapes']['SourceFile']['base'] = 'The path to a file on disk to use instead of the Body parameter.';
|
|
$api['shapes']['SourceFile'] = ['type' => 'string'];
|
|
$api['shapes']['PutObjectRequest']['members']['SourceFile'] = ['shape' => 'SourceFile'];
|
|
$api['shapes']['UploadPartRequest']['members']['SourceFile'] = ['shape' => 'SourceFile'];
|
|
// Add the ContentSHA256 parameter.
|
|
$docs['shapes']['ContentSHA256']['base'] = 'A SHA256 hash of the body content of the request.';
|
|
$api['shapes']['ContentSHA256'] = ['type' => 'string'];
|
|
$api['shapes']['PutObjectRequest']['members']['ContentSHA256'] = ['shape' => 'ContentSHA256'];
|
|
$api['shapes']['UploadPartRequest']['members']['ContentSHA256'] = ['shape' => 'ContentSHA256'];
|
|
$docs['shapes']['ContentSHA256']['append'] = $opt;
|
|
// Add the AddContentMD5 parameter.
|
|
$docs['shapes']['AddContentMD5']['base'] = 'Set to true to calculate the ContentMD5 for the upload.';
|
|
$api['shapes']['AddContentMD5'] = ['type' => 'boolean'];
|
|
$api['shapes']['PutObjectRequest']['members']['AddContentMD5'] = ['shape' => 'AddContentMD5'];
|
|
$api['shapes']['UploadPartRequest']['members']['AddContentMD5'] = ['shape' => 'AddContentMD5'];
|
|
// Add the SaveAs parameter.
|
|
$docs['shapes']['SaveAs']['base'] = 'The path to a file on disk to save the object data.';
|
|
$api['shapes']['SaveAs'] = ['type' => 'string'];
|
|
$api['shapes']['GetObjectRequest']['members']['SaveAs'] = ['shape' => 'SaveAs'];
|
|
// Several SSECustomerKey documentation updates.
|
|
$docs['shapes']['SSECustomerKey']['append'] = $b64;
|
|
$docs['shapes']['CopySourceSSECustomerKey']['append'] = $b64;
|
|
$docs['shapes']['SSECustomerKeyMd5']['append'] = $opt;
|
|
// Add the ObjectURL to various output shapes and documentation.
|
|
$docs['shapes']['ObjectURL']['base'] = 'The URI of the created object.';
|
|
$api['shapes']['ObjectURL'] = ['type' => 'string'];
|
|
$api['shapes']['PutObjectOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
|
|
$api['shapes']['CopyObjectOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
|
|
$api['shapes']['CompleteMultipartUploadOutput']['members']['ObjectURL'] = ['shape' => 'ObjectURL'];
|
|
// Fix references to Location Constraint.
|
|
unset($api['shapes']['CreateBucketRequest']['payload']);
|
|
$api['shapes']['BucketLocationConstraint']['enum'] = ["ap-northeast-1", "ap-southeast-2", "ap-southeast-1", "cn-north-1", "eu-central-1", "eu-west-1", "us-east-1", "us-west-1", "us-west-2", "sa-east-1"];
|
|
// Add a note that the ContentMD5 is automatically computed, except for with PutObject and UploadPart
|
|
$docs['shapes']['ContentMD5']['append'] = '<div class="alert alert-info">The value will be computed on ' . 'your behalf.</div>';
|
|
$docs['shapes']['ContentMD5']['excludeAppend'] = ['PutObjectRequest', 'UploadPartRequest'];
|
|
//Add a note to ContentMD5 for PutObject and UploadPart that specifies the value is required
|
|
// When uploading to a bucket with object lock enabled and that it is not computed automatically
|
|
$objectLock = '<div class="alert alert-info">This value is required if uploading to a bucket ' . 'which has Object Lock enabled. It will not be calculated for you automatically. If you wish to have ' . 'the value calculated for you, use the `AddContentMD5` parameter.</div>';
|
|
$docs['shapes']['ContentMD5']['appendOnly'] = ['message' => $objectLock, 'shapes' => ['PutObjectRequest', 'UploadPartRequest']];
|
|
// Add `ExpiresString` shape to output structures which contain `Expires`
|
|
// Deprecate existing `Expires` shapes in output structures
|
|
// Add/Update documentation for both `ExpiresString` and `Expires`
|
|
// Ensure `Expires` type remains timestamp
|
|
foreach ($api['shapes'] as $key => &$value) {
|
|
$suffix = 'Output';
|
|
if (\substr($key, -\strlen($suffix)) === $suffix) {
|
|
if (isset($value['members']['Expires'])) {
|
|
$value['members']['Expires']['deprecated'] = \true;
|
|
$value['members']['ExpiresString'] = ['shape' => 'ExpiresString', 'location' => 'header', 'locationName' => 'Expires'];
|
|
$docs['shapes']['Expires']['refs'][$key . '$Expires'] .= '<p>This output shape has been deprecated. Please refer to <code>ExpiresString</code> instead.</p>.';
|
|
}
|
|
}
|
|
}
|
|
$api['shapes']['ExpiresString']['type'] = 'string';
|
|
$docs['shapes']['ExpiresString']['base'] = 'The unparsed string value of the <code>Expires</code> output member.';
|
|
$api['shapes']['Expires']['type'] = 'timestamp';
|
|
return [new Service($api, ApiProvider::defaultProvider()), new DocModel($docs)];
|
|
}
|
|
/**
|
|
* @internal
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public static function addDocExamples($examples)
|
|
{
|
|
$getObjectExample = ['input' => ['Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint', 'Key' => 'my-key'], 'output' => ['Body' => 'class GuzzleHttp\\Psr7\\Stream#208 (7) {...}', 'ContentLength' => '11', 'ContentType' => 'application/octet-stream'], 'comments' => ['input' => '', 'output' => 'Simplified example output'], 'description' => 'The following example retrieves an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.', 'id' => '', 'title' => 'To get an object via an S3 access point ARN'];
|
|
if (isset($examples['GetObject'])) {
|
|
$examples['GetObject'][] = $getObjectExample;
|
|
} else {
|
|
$examples['GetObject'] = [$getObjectExample];
|
|
}
|
|
$putObjectExample = ['input' => ['Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint', 'Key' => 'my-key', 'Body' => 'my-body'], 'output' => ['ObjectURL' => 'https://my-bucket.s3.us-east-1.amazonaws.com/my-key'], 'comments' => ['input' => '', 'output' => 'Simplified example output'], 'description' => 'The following example uploads an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.', 'id' => '', 'title' => 'To upload an object via an S3 access point ARN'];
|
|
if (isset($examples['PutObject'])) {
|
|
$examples['PutObject'][] = $putObjectExample;
|
|
} else {
|
|
$examples['PutObject'] = [$putObjectExample];
|
|
}
|
|
return $examples;
|
|
}
|
|
/**
|
|
* @param CommandInterface $command
|
|
* @return array|mixed|null
|
|
*/
|
|
private function getSignatureVersionFromCommand(CommandInterface $command)
|
|
{
|
|
return $command['@context']['signature_version'] ?? $this->getConfig('signature_version');
|
|
}
|
|
}
|