Completed
Pull Request — master (#288)
by Bai
13:51
created

BucketManager::copy()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 2.0438

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 5
dl 0
loc 11
ccs 7
cts 9
cp 0.7778
crap 2.0438
rs 9.9
c 0
b 0
f 0
1
<?php
2
namespace Qiniu\Storage;
3
4
use Qiniu\Auth;
5
use Qiniu\Config;
6
use Qiniu\Zone;
7
use Qiniu\Http\Client;
8
use Qiniu\Http\Error;
9
10
/**
11
 * 主要涉及了空间资源管理及批量操作接口的实现,具体的接口规格可以参考
12
 *
13
 * @link https://developer.qiniu.com/kodo/api/1274/rs
14
 */
15
final class BucketManager
16
{
17
    private $auth;
18
    private $config;
19
20 42
    public function __construct(Auth $auth, Config $config = null)
21
    {
22 42
        $this->auth = $auth;
23 42
        if ($config == null) {
24 42
            $this->config = new Config();
25 42
        } else {
26
            $this->config = $config;
27
        }
28 42
    }
29
30
    /**
31
     * 获取指定账号下所有的空间名。
32
     *
33
     * @return string[] 包含所有空间名
34
     */
35 3
    public function buckets($shared = true)
36
    {
37 3
        $includeShared = "false";
38 3
        if ($shared === true) {
39 3
            $includeShared = "true";
40 3
        }
41 3
        return $this->rsGet('/buckets?shared=' . $includeShared);
42
    }
43
44
    /**
45
     * 获取指定空间绑定的所有的域名
46
     *
47
     * @return string[] 包含所有空间域名
48
     */
49
    public function domains($bucket)
50
    {
51
        return $this->apiGet('/v6/domain/list?tbl=' . $bucket);
52
    }
53
54
    /**
55
     * 获取空间绑定的域名列表
56
     * @return string[] 包含空间绑定的所有域名
57
     */
58
59
    /**
60
     * 列取空间的文件列表
61
     *
62
     * @param $bucket     空间名
63
     * @param $prefix     列举前缀
64
     * @param $marker     列举标识符
65
     * @param $limit      单次列举个数限制
66
     * @param $delimiter  指定目录分隔符
67
     *
68
     * @return array    包含文件信息的数组,类似:[
69
     *                                              {
70
     *                                                 "hash" => "<Hash string>",
71
     *                                                  "key" => "<Key string>",
72
     *                                                  "fsize" => "<file size>",
73
     *                                                  "putTime" => "<file modify time>"
74
     *                                              },
75
     *                                              ...
76
     *                                            ]
77
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
78
     */
79 3
    public function listFiles($bucket, $prefix = null, $marker = null, $limit = 1000, $delimiter = null)
80
    {
81 3
        $query = array('bucket' => $bucket);
82 3
        \Qiniu\setWithoutEmpty($query, 'prefix', $prefix);
83 3
        \Qiniu\setWithoutEmpty($query, 'marker', $marker);
84 3
        \Qiniu\setWithoutEmpty($query, 'limit', $limit);
85 3
        \Qiniu\setWithoutEmpty($query, 'delimiter', $delimiter);
86 3
        $url = $this->getRsfHost() . '/list?' . http_build_query($query);
87 3
        return $this->get($url);
88
    }
89
90
    /**
91
     * 获取资源的元信息,但不返回文件内容
92
     *
93
     * @param $bucket     待获取信息资源所在的空间
94
     * @param $key        待获取资源的文件名
95
     *
96
     * @return array    包含文件信息的数组,类似:
97
     *                                              [
98
     *                                                  "hash" => "<Hash string>",
99
     *                                                  "key" => "<Key string>",
100
     *                                                  "fsize" => <file size>,
101
     *                                                  "putTime" => "<file modify time>"
102
     *                                                  "fileType" => <file type>
103
     *                                              ]
104
     *
105
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/stat.html
106
     */
107 3
    public function stat($bucket, $key)
108
    {
109 3
        $path = '/stat/' . \Qiniu\entry($bucket, $key);
110 3
        return $this->rsGet($path);
111
    }
112
113
    /**
114
     * 删除指定资源
115
     *
116
     * @param $bucket     待删除资源所在的空间
117
     * @param $key        待删除资源的文件名
118
     *
119
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
120
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
121
     */
122 6
    public function delete($bucket, $key)
123
    {
124 6
        $path = '/delete/' . \Qiniu\entry($bucket, $key);
125 6
        list(, $error) = $this->rsPost($path);
126 6
        return $error;
127
    }
128
129
130
    /**
131
     * 给资源进行重命名,本质为move操作。
132
     *
133
     * @param $bucket     待操作资源所在空间
134
     * @param $oldname    待操作资源文件名
135
     * @param $newname    目标资源文件名
136
     *
137
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
138
     */
139 3
    public function rename($bucket, $oldname, $newname)
140
    {
141 3
        return $this->move($bucket, $oldname, $bucket, $newname);
142
    }
143
144
    /**
145
     * 给资源进行重命名,本质为move操作。
146
     *
147
     * @param $from_bucket     待操作资源所在空间
148
     * @param $from_key        待操作资源文件名
149
     * @param $to_bucket       目标资源空间名
150
     * @param $to_key          目标资源文件名
151
     *
152
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
153
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
154
     */
155 12
    public function copy($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
156
    {
157 12
        $from = \Qiniu\entry($from_bucket, $from_key);
158 12
        $to = \Qiniu\entry($to_bucket, $to_key);
159 12
        $path = '/copy/' . $from . '/' . $to;
160 12
        if ($force === true) {
161
            $path .= '/force/true';
162
        }
163 12
        list(, $error) = $this->rsPost($path);
164 12
        return $error;
165
    }
166
167
    /**
168
     * 将资源从一个空间到另一个空间
169
     *
170
     * @param $from_bucket     待操作资源所在空间
171
     * @param $from_key        待操作资源文件名
172
     * @param $to_bucket       目标资源空间名
173
     * @param $to_key          目标资源文件名
174
     *
175
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
176
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
177
     */
178 3
    public function move($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
179
    {
180 3
        $from = \Qiniu\entry($from_bucket, $from_key);
181 3
        $to = \Qiniu\entry($to_bucket, $to_key);
182 3
        $path = '/move/' . $from . '/' . $to;
183 3
        if ($force) {
184
            $path .= '/force/true';
185
        }
186 3
        list(, $error) = $this->rsPost($path);
187 3
        return $error;
188
    }
189
190
    /**
191
     * 主动修改指定资源的文件类型
192
     *
193
     * @param $bucket     待操作资源所在空间
194
     * @param $key        待操作资源文件名
195
     * @param $mime       待操作文件目标mimeType
196
     *
197
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
198
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
199
     */
200 3
    public function changeMime($bucket, $key, $mime)
201
    {
202 3
        $resource = \Qiniu\entry($bucket, $key);
203 3
        $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
204 3
        $path = '/chgm/' . $resource . '/mime/' . $encode_mime;
205 3
        list(, $error) = $this->rsPost($path);
206 3
        return $error;
207
    }
208
209
210
    /**
211
     * 修改指定资源的存储类型
212
     *
213
     * @param $bucket     待操作资源所在空间
214
     * @param $key        待操作资源文件名
215
     * @param $fileType       待操作文件目标文件类型
216
     *
217
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
218
     * @link  https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
219
     */
220
    public function changeType($bucket, $key, $fileType)
221
    {
222
        $resource = \Qiniu\entry($bucket, $key);
223
        $path = '/chtype/' . $resource . '/type/' . $fileType;
224
        list(, $error) = $this->rsPost($path);
225
        return $error;
226
    }
227
228
    /**
229
     * 修改文件的存储状态,即禁用状态和启用状态间的的互相转换
230
     *
231
     * @param $bucket     待操作资源所在空间
232
     * @param $key        待操作资源文件名
233
     * @param $status       待操作文件目标文件类型
234
     *
235
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
236
     * @link  https://developer.qiniu.com/kodo/api/4173/modify-the-file-status
237
     */
238
    public function changeStatus($bucket, $key, $status)
239
    {
240
        $resource = \Qiniu\entry($bucket, $key);
241
        $path = '/chstatus/' . $resource . '/status/' . $status;
242
        list(, $error) = $this->rsPost($path);
243
        return $error;
244
    }
245
246
    /**
247
     * 从指定URL抓取资源,并将该资源存储到指定空间中
248
     *
249
     * @param $url        指定的URL
250
     * @param $bucket     目标资源空间
251
     * @param $key        目标资源文件名
252
     *
253
     * @return array    包含已拉取的文件信息。
254
     *                         成功时:  [
255
     *                                          [
256
     *                                              "hash" => "<Hash string>",
257
     *                                              "key" => "<Key string>"
258
     *                                          ],
259
     *                                          null
260
     *                                  ]
261
     *
262
     *                         失败时:  [
263
     *                                          null,
264
     *                                         Qiniu/Http/Error
265
     *                                  ]
266
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
267
     */
268 3
    public function fetch($url, $bucket, $key = null)
269
    {
270
271 3
        $resource = \Qiniu\base64_urlSafeEncode($url);
272 3
        $to = \Qiniu\entry($bucket, $key);
273 3
        $path = '/fetch/' . $resource . '/to/' . $to;
274
275 3
        $ak = $this->auth->getAccessKey();
276 3
        $ioHost = $this->config->getIovipHost($ak, $bucket);
277
278
        $url = $ioHost . $path;
279
        return $this->post($url, null);
280
    }
281
282
    /**
283
     * 从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源
284
     *
285
     * @param $bucket     待获取资源所在的空间
286
     * @param $key        代获取资源文件名
287
     *
288
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
289
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
290
     */
291 3
    public function prefetch($bucket, $key)
292
    {
293 3
        $resource = \Qiniu\entry($bucket, $key);
294 3
        $path = '/prefetch/' . $resource;
295
296 3
        $ak = $this->auth->getAccessKey();
297 3
        $ioHost = $this->config->getIovipHost($ak, $bucket);
298
299
        $url = $ioHost . $path;
300
        list(, $error) = $this->post($url, null);
301
        return $error;
302
    }
303
304
    /**
305
     * 在单次请求中进行多个资源管理操作
306
     *
307
     * @param $operations     资源管理操作数组
308
     *
309
     * @return array 每个资源的处理情况,结果类似:
310
     *              [
311
     *                   { "code" => <HttpCode int>, "data" => <Data> },
312
     *                   { "code" => <HttpCode int> },
313
     *                   { "code" => <HttpCode int> },
314
     *                   { "code" => <HttpCode int> },
315
     *                   { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } },
316
     *                   ...
317
     *               ]
318
     * @link http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
319
     */
320 12
    public function batch($operations)
321
    {
322 12
        $params = 'op=' . implode('&op=', $operations);
323 12
        return $this->rsPost('/batch', $params);
324
    }
325
326
    /**
327
     * 设置文件的生命周期
328
     *
329
     * @param $bucket 设置文件生命周期文件所在的空间
330
     * @param $key    设置文件生命周期文件的文件名
331
     * @param $days   设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期
332
     *
333
     * @return Mixed
334
     * @link https://developer.qiniu.com/kodo/api/update-file-lifecycle
335
     */
336 3
    public function deleteAfterDays($bucket, $key, $days)
337
    {
338 3
        $entry = \Qiniu\entry($bucket, $key);
339 3
        $path = "/deleteAfterDays/$entry/$days";
340 3
        list(, $error) = $this->rsPost($path);
341 3
        return $error;
342
    }
343
344 3
    private function getRsfHost()
345
    {
346 3
        $scheme = "http://";
347 3
        if ($this->config->useHTTPS == true) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
348
            $scheme = "https://";
349
        }
350 3
        return $scheme . Config::RSF_HOST;
351
    }
352
353 33
    private function getRsHost()
354
    {
355 33
        $scheme = "http://";
356 33
        if ($this->config->useHTTPS == true) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
357
            $scheme = "https://";
358
        }
359 33
        return $scheme . Config::RS_HOST;
360
    }
361
362
    private function getApiHost()
363
    {
364
        $scheme = "http://";
365
        if ($this->config->useHTTPS == true) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
366
            $scheme = "https://";
367
        }
368
        return $scheme . Config::API_HOST;
369
    }
370
371 27
    private function rsPost($path, $body = null)
372
    {
373 27
        $url = $this->getRsHost() . $path;
374 27
        return $this->post($url, $body);
375
    }
376
377
    private function apiGet($path)
378
    {
379
        $url = $this->getApiHost() . $path;
380
        return $this->get($url);
381
    }
382
383 6
    private function rsGet($path)
384
    {
385 6
        $url = $this->getRsHost() . $path;
386 6
        return $this->get($url);
387
    }
388
389 9
    private function get($url)
390
    {
391 9
        $headers = $this->auth->authorization($url);
392 9
        $ret = Client::get($url, $headers);
393 9
        if (!$ret->ok()) {
394 9
            return array(null, new Error($url, $ret));
395
        }
396
        return array($ret->json(), null);
397
    }
398
399 27
    private function post($url, $body)
400
    {
401 27
        $headers = $this->auth->authorization($url, $body, 'application/x-www-form-urlencoded');
402 27
        $ret = Client::post($url, $body, $headers);
403 27
        if (!$ret->ok()) {
404 27
            return array(null, new Error($url, $ret));
405
        }
406
        $r = ($ret->body === null) ? array() : $ret->json();
407
        return array($r, null);
408
    }
409
410 3
    public static function buildBatchCopy($source_bucket, $key_pairs, $target_bucket, $force)
411
    {
412 3
        return self::twoKeyBatch('/copy', $source_bucket, $key_pairs, $target_bucket, $force);
413
    }
414
415
416 3
    public static function buildBatchRename($bucket, $key_pairs, $force)
417
    {
418 3
        return self::buildBatchMove($bucket, $key_pairs, $bucket, $force);
419
    }
420
421
422 6
    public static function buildBatchMove($source_bucket, $key_pairs, $target_bucket, $force)
423
    {
424 6
        return self::twoKeyBatch('/move', $source_bucket, $key_pairs, $target_bucket, $force);
425
    }
426
427
428
    public static function buildBatchDelete($bucket, $keys)
429
    {
430
        return self::oneKeyBatch('/delete', $bucket, $keys);
431
    }
432
433
434 3
    public static function buildBatchStat($bucket, $keys)
435
    {
436 3
        return self::oneKeyBatch('/stat', $bucket, $keys);
437
    }
438
439
    public static function buildBatchDeleteAfterDays($bucket, $key_day_pairs)
440
    {
441
        $data = array();
442
        foreach ($key_day_pairs as $key => $day) {
443
            array_push($data, '/deleteAfterDays/' . \Qiniu\entry($bucket, $key) . '/' . $day);
444
        }
445
        return $data;
446
    }
447
448
    public static function buildBatchChangeMime($bucket, $key_mime_pairs)
449
    {
450
        $data = array();
451
        foreach ($key_mime_pairs as $key => $mime) {
452
            array_push($data, '/chgm/' . \Qiniu\entry($bucket, $key) . '/mime/' . base64_encode($mime));
453
        }
454
        return $data;
455
    }
456
457
    public static function buildBatchChangeType($bucket, $key_type_pairs)
458
    {
459
        $data = array();
460
        foreach ($key_type_pairs as $key => $type) {
461
            array_push($data, '/chtype/' . \Qiniu\entry($bucket, $key) . '/type/' . $type);
462
        }
463
        return $data;
464
    }
465
466 3
    private static function oneKeyBatch($operation, $bucket, $keys)
467
    {
468 3
        $data = array();
469 3
        foreach ($keys as $key) {
470 3
            array_push($data, $operation . '/' . \Qiniu\entry($bucket, $key));
471 3
        }
472 3
        return $data;
473
    }
474
475 9
    private static function twoKeyBatch($operation, $source_bucket, $key_pairs, $target_bucket, $force)
476
    {
477 9
        if ($target_bucket === null) {
478
            $target_bucket = $source_bucket;
479
        }
480 9
        $data = array();
481 9
        $forceOp = "false";
482 9
        if ($force) {
483 9
            $forceOp = "true";
484 9
        }
485 9
        foreach ($key_pairs as $from_key => $to_key) {
486 9
            $from = \Qiniu\entry($source_bucket, $from_key);
487 9
            $to = \Qiniu\entry($target_bucket, $to_key);
488 9
            array_push($data, $operation . '/' . $from . '/' . $to . "/force/" . $forceOp);
489 9
        }
490 9
        return $data;
491
    }
492
}
493