1
|
|
|
<?php declare(strict_types=1); |
2
|
|
|
|
3
|
|
|
namespace OpenStack\ObjectStore\v1\Models; |
4
|
|
|
|
5
|
|
|
use GuzzleHttp\Promise\Promise; |
6
|
|
|
use GuzzleHttp\Psr7\LimitStream; |
7
|
|
|
use Psr\Http\Message\ResponseInterface; |
8
|
|
|
use OpenStack\Common\Error\BadResponseError; |
9
|
|
|
use OpenStack\Common\Resource\OperatorResource; |
10
|
|
|
use OpenStack\Common\Resource\Creatable; |
11
|
|
|
use OpenStack\Common\Resource\Deletable; |
12
|
|
|
use OpenStack\Common\Resource\HasMetadata; |
13
|
|
|
use OpenStack\Common\Resource\Listable; |
14
|
|
|
use OpenStack\Common\Resource\Retrievable; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* @property \OpenStack\ObjectStore\v1\Api $api |
18
|
|
|
*/ |
19
|
|
|
class Container extends OperatorResource implements Creatable, Deletable, Retrievable, Listable, HasMetadata |
20
|
|
|
{ |
21
|
|
|
use MetadataTrait; |
22
|
|
|
|
23
|
|
|
const METADATA_PREFIX = 'X-Container-Meta-'; |
24
|
|
|
|
25
|
|
|
/** @var int */ |
26
|
|
|
public $objectCount; |
27
|
|
|
|
28
|
|
|
/** @var int */ |
29
|
|
|
public $bytesUsed; |
30
|
|
|
|
31
|
|
|
/** @var string */ |
32
|
|
|
public $name; |
33
|
|
|
|
34
|
|
|
/** @var array */ |
35
|
|
|
public $metadata; |
36
|
|
|
|
37
|
|
|
protected $markerKey = 'name'; |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* {@inheritdoc} |
41
|
|
|
*/ |
42
|
5 |
|
public function populateFromResponse(ResponseInterface $response): self |
43
|
|
|
{ |
44
|
5 |
|
parent::populateFromResponse($response); |
45
|
|
|
|
46
|
5 |
|
$this->objectCount = $response->getHeaderLine('X-Container-Object-Count'); |
|
|
|
|
47
|
5 |
|
$this->bytesUsed = $response->getHeaderLine('X-Container-Bytes-Used'); |
|
|
|
|
48
|
5 |
|
$this->metadata = $this->parseMetadata($response); |
49
|
5 |
|
|
50
|
|
|
return $this; |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* Retrieves a collection of object resources in the form of a generator. |
55
|
|
|
* |
56
|
|
|
* @param array $options {@see \OpenStack\ObjectStore\v1\Api::getContainer} |
57
|
|
|
* @param callable|null $mapFn Allows a function to be mapped over each element. |
58
|
|
|
* |
59
|
1 |
|
* @return \Generator |
60
|
|
|
*/ |
61
|
1 |
|
public function listObjects(array $options = [], callable $mapFn = null): \Generator |
62
|
1 |
|
{ |
63
|
|
|
$options = array_merge($options, ['name' => $this->name, 'format' => 'json']); |
64
|
|
|
return $this->model(Object::class)->enumerate($this->api->getContainer(), $options, $mapFn); |
|
|
|
|
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
/** |
68
|
1 |
|
* {@inheritdoc} |
69
|
|
|
*/ |
70
|
1 |
|
public function retrieve() |
71
|
1 |
|
{ |
72
|
1 |
|
$response = $this->executeWithState($this->api->headContainer()); |
73
|
|
|
$this->populateFromResponse($response); |
74
|
|
|
} |
75
|
|
|
|
76
|
|
|
/** |
77
|
|
|
* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer} |
78
|
|
|
* |
79
|
3 |
|
* @return $this |
80
|
|
|
*/ |
81
|
3 |
|
public function create(array $data): Creatable |
82
|
|
|
{ |
83
|
3 |
|
$response = $this->execute($this->api->putContainer(), $data); |
84
|
3 |
|
|
85
|
|
|
$this->populateFromResponse($response); |
86
|
3 |
|
$this->name = $data['name']; |
87
|
|
|
|
88
|
|
|
return $this; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
1 |
|
* {@inheritdoc} |
93
|
|
|
*/ |
94
|
1 |
|
public function delete() |
95
|
1 |
|
{ |
96
|
|
|
$this->executeWithState($this->api->deleteContainer()); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
/** |
100
|
1 |
|
* {@inheritdoc} |
101
|
|
|
*/ |
102
|
1 |
|
public function mergeMetadata(array $metadata) |
103
|
1 |
|
{ |
104
|
|
|
$response = $this->execute($this->api->postContainer(), ['name' => $this->name, 'metadata' => $metadata]); |
105
|
|
|
$this->metadata = $this->parseMetadata($response); |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
1 |
|
* {@inheritdoc} |
110
|
|
|
*/ |
111
|
|
View Code Duplication |
public function resetMetadata(array $metadata) |
|
|
|
|
112
|
1 |
|
{ |
113
|
1 |
|
$options = [ |
114
|
1 |
|
'name' => $this->name, |
115
|
1 |
|
'removeMetadata' => [], |
116
|
|
|
'metadata' => $metadata, |
117
|
1 |
|
]; |
118
|
1 |
|
|
119
|
1 |
|
foreach ($this->getMetadata() as $key => $val) { |
120
|
1 |
|
if (!array_key_exists($key, $metadata)) { |
121
|
1 |
|
$options['removeMetadata'][$key] = 'True'; |
122
|
|
|
} |
123
|
1 |
|
} |
124
|
1 |
|
|
125
|
|
|
$response = $this->execute($this->api->postContainer(), $options); |
126
|
|
|
$this->metadata = $this->parseMetadata($response); |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
/** |
130
|
2 |
|
* {@inheritdoc} |
131
|
|
|
*/ |
132
|
2 |
|
public function getMetadata(): array |
133
|
2 |
|
{ |
134
|
|
|
$response = $this->executeWithState($this->api->headContainer()); |
135
|
|
|
return $this->parseMetadata($response); |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and |
140
|
|
|
* the name of this container. A HTTP call will not be executed by default - you need to call |
141
|
|
|
* {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that. |
142
|
|
|
* |
143
|
|
|
* @param string $name The name of the object |
144
|
|
|
* |
145
|
4 |
|
* @return Object |
146
|
|
|
*/ |
147
|
4 |
|
public function getObject($name): Object |
148
|
|
|
{ |
149
|
|
|
return $this->model(Object::class, ['containerName' => $this->name, 'name' => $name]); |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
/** |
153
|
|
|
* Identifies whether an object exists in this container. |
154
|
|
|
* |
155
|
|
|
* @param string $name The name of the object. |
156
|
|
|
* |
157
|
|
|
* @return bool TRUE if the object exists, FALSE if it does not. |
158
|
|
|
* |
159
|
|
|
* @throws BadResponseError For any other HTTP error which does not have a 404 Not Found status. |
160
|
3 |
|
* @throws \Exception For any other type of fatal error. |
161
|
|
|
*/ |
162
|
|
View Code Duplication |
public function objectExists(string $name): bool |
|
|
|
|
163
|
3 |
|
{ |
164
|
1 |
|
try { |
165
|
2 |
|
$this->getObject($name)->retrieve(); |
166
|
2 |
|
return true; |
167
|
1 |
|
} catch (BadResponseError $e) { |
168
|
|
|
if ($e->getResponse()->getStatusCode() === 404) { |
169
|
1 |
|
return false; |
170
|
|
|
} |
171
|
|
|
throw $e; |
172
|
|
|
} |
173
|
|
|
} |
174
|
|
|
|
175
|
|
|
/** |
176
|
|
|
* Creates a single object according to the values provided. |
177
|
|
|
* |
178
|
|
|
* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} |
179
|
|
|
* |
180
|
2 |
|
* @return Object |
181
|
|
|
*/ |
182
|
2 |
|
public function createObject(array $data): Object |
183
|
|
|
{ |
184
|
|
|
return $this->model(Object::class)->create($data + ['containerName' => $this->name]); |
|
|
|
|
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
/** |
188
|
|
|
* Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding |
189
|
|
|
* container. When this completes, a manifest file is uploaded which references the prefix of the segments, |
190
|
|
|
* allowing concatenation when a request is executed against the manifest. |
191
|
|
|
* |
192
|
|
|
* @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} |
193
|
|
|
* @param int $data['segmentSize'] The size in Bytes of each segment |
|
|
|
|
194
|
|
|
* @param string $data['segmentContainer'] The container to which each segment will be uploaded |
|
|
|
|
195
|
|
|
* @param string $data['segmentPrefix'] The prefix that will come before each segment. If omitted, a default |
|
|
|
|
196
|
|
|
* is used: name/timestamp/filesize |
197
|
|
|
* |
198
|
1 |
|
* @return Object |
199
|
|
|
*/ |
200
|
|
|
public function createLargeObject(array $data): Object |
201
|
1 |
|
{ |
202
|
|
|
/** @var \Psr\Http\Message\StreamInterface $stream */ |
203
|
1 |
|
$stream = $data['stream']; |
204
|
1 |
|
|
205
|
1 |
|
$segmentSize = isset($data['segmentSize']) ? $data['segmentSize'] : 1073741824; |
206
|
1 |
|
$segmentContainer = isset($data['segmentContainer']) ? $data['segmentContainer'] : $this->name . '_segments'; |
207
|
1 |
|
$segmentPrefix = isset($data['segmentPrefix']) |
208
|
|
|
? $data['segmentPrefix'] |
209
|
|
|
: sprintf("%s/%s/%d", $data['name'], microtime(true), $stream->getSize()); |
210
|
1 |
|
|
211
|
1 |
|
/** @var \OpenStack\ObjectStore\v1\Service $service */ |
212
|
1 |
|
$service = $this->getService(); |
213
|
1 |
|
if (!$service->containerExists($segmentContainer)) { |
214
|
|
|
$service->createContainer(['name' => $segmentContainer]); |
215
|
1 |
|
} |
216
|
1 |
|
|
217
|
|
|
$promises = []; |
218
|
1 |
|
$count = 0; |
219
|
1 |
|
|
220
|
1 |
|
while (!$stream->eof() && $count < round($stream->getSize() / $segmentSize)) { |
221
|
1 |
|
$promises[] = $this->model(Object::class)->createAsync([ |
|
|
|
|
222
|
1 |
|
'name' => sprintf("%s/%d", $segmentPrefix, ++$count), |
223
|
1 |
|
'stream' => new LimitStream($stream, $segmentSize, ($count - 1) * $segmentSize), |
224
|
1 |
|
'containerName' => $segmentContainer, |
225
|
|
|
]); |
226
|
|
|
} |
227
|
1 |
|
|
228
|
1 |
|
/** @var Promise $p */ |
229
|
|
|
$p = \GuzzleHttp\Promise\all($promises); |
230
|
1 |
|
$p->wait(); |
231
|
1 |
|
|
232
|
1 |
|
return $this->createObject([ |
233
|
1 |
|
'name' => $data['name'], |
234
|
|
|
'objectManifest' => sprintf("%s/%s", $segmentContainer, $segmentPrefix), |
235
|
|
|
]); |
236
|
|
|
} |
237
|
|
|
} |
238
|
|
|
|
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.