1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
<?php
namespace Aws\S3;
use Aws\Arn\ArnParser;
use Aws\Arn\S3\AccessPointArn;
use Aws\Exception\MultipartUploadException;
use Aws\Result;
use Aws\S3\Exception\S3Exception;
use GuzzleHttp\Promise\Coroutine;
use 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()
{
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()
{
if (ArnParser::isArn($this->source['Bucket'])) {
try {
new AccessPointArn($this->source['Bucket']);
} catch (\Exception $e) {
throw new \InvalidArgumentException(
'Provided ARN was a not a valid S3 access point ARN ('
. $e->getMessage() . ')',
0,
$e
);
}
}
$sourcePath = "/{$this->source['Bucket']}/" . rawurlencode($this->source['Key']);
if (isset($this->source['VersionId'])) {
$sourcePath .= "?versionId={$this->source['VersionId']}";
}
return $sourcePath;
}
}
|
