Completed
Pull Request — master (#277)
by
unknown
12:33
created

BucketManager::pulpVideo()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 12
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 0
Metric Value
cc 2
eloc 9
nc 2
nop 4
dl 0
loc 12
rs 9.4285
c 0
b 0
f 0
ccs 0
cts 10
cp 0
crap 6
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 $reqBody     待操作资源所在空间
194
     * @param $from_key        待操作资源文件名
195
     * @param $to_bucket       目标资源空间名
196
     * @param $to_key          目标资源文件名
197
     *
198
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
199
     * @link  https://developer.qiniu.com/dora/manual/4258/video-pulp
200
     */
201
    public function pulpVideo($reqBody, $ops, $vid, $params = null)
202
    {
203
        $path = '/v1/video/' . $vid;
204
        $req = array();
205
        $req['data'] = $reqBody;
206
        $req['ops'] = $ops;
207
        if (isset($params)) {
208
            $req['params'] = $params;
209
        }
210
        $body = json_encode($req);
211
        return $this->arPost($path, $body);
212
    }
213
214
    /**
215
     * 主动修改指定资源的文件类型
216
     *
217
     * @param $bucket     待操作资源所在空间
218
     * @param $key        待操作资源文件名
219
     * @param $mime       待操作文件目标mimeType
220
     *
221
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
222
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
223
     */
224 3
    public function changeMime($bucket, $key, $mime)
225
    {
226 3
        $resource = \Qiniu\entry($bucket, $key);
227 3
        $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
228 3
        $path = '/chgm/' . $resource . '/mime/' . $encode_mime;
229 3
        list(, $error) = $this->rsPost($path);
230 3
        return $error;
231
    }
232
233
234
    /**
235
     * 修改指定资源的存储类型
236
     *
237
     * @param $bucket     待操作资源所在空间
238
     * @param $key        待操作资源文件名
239
     * @param $fileType       待操作文件目标文件类型
240
     *
241
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
242
     * @link  https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
243
     */
244
    public function changeType($bucket, $key, $fileType)
245
    {
246
        $resource = \Qiniu\entry($bucket, $key);
247
        $path = '/chtype/' . $resource . '/type/' . $fileType;
248
        list(, $error) = $this->rsPost($path);
249
        return $error;
250
    }
251
252
    /**
253
     * 修改文件的存储状态,即禁用状态和启用状态间的的互相转换
254
     *
255
     * @param $bucket     待操作资源所在空间
256
     * @param $key        待操作资源文件名
257
     * @param $status       待操作文件目标文件类型
258
     *
259
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
260
     * @link  https://developer.qiniu.com/kodo/api/4173/modify-the-file-status
261
     */
262
    public function changeStatus($bucket, $key, $status)
263
    {
264
        $resource = \Qiniu\entry($bucket, $key);
265
        $path = '/chstatus/' . $resource . '/status/' . $status;
266
        list(, $error) = $this->rsPost($path);
267
        return $error;
268
    }
269
270
    /**
271
     * 从指定URL抓取资源,并将该资源存储到指定空间中
272
     *
273
     * @param $url        指定的URL
274
     * @param $bucket     目标资源空间
275
     * @param $key        目标资源文件名
276
     *
277
     * @return array    包含已拉取的文件信息。
278
     *                         成功时:  [
279
     *                                          [
280
     *                                              "hash" => "<Hash string>",
281
     *                                              "key" => "<Key string>"
282
     *                                          ],
283
     *                                          null
284
     *                                  ]
285
     *
286
     *                         失败时:  [
287
     *                                          null,
288
     *                                         Qiniu/Http/Error
289
     *                                  ]
290
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
291
     */
292 3
    public function fetch($url, $bucket, $key = null)
293
    {
294
295 3
        $resource = \Qiniu\base64_urlSafeEncode($url);
296 3
        $to = \Qiniu\entry($bucket, $key);
297 3
        $path = '/fetch/' . $resource . '/to/' . $to;
298
299 3
        $ak = $this->auth->getAccessKey();
300 3
        $ioHost = $this->config->getIovipHost($ak, $bucket);
301
302
        $url = $ioHost . $path;
303
        return $this->post($url, null);
304
    }
305
306
    /**
307
     * 从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源
308
     *
309
     * @param $bucket     待获取资源所在的空间
310
     * @param $key        代获取资源文件名
311
     *
312
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
313
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
314
     */
315 3
    public function prefetch($bucket, $key)
316
    {
317 3
        $resource = \Qiniu\entry($bucket, $key);
318 3
        $path = '/prefetch/' . $resource;
319
320 3
        $ak = $this->auth->getAccessKey();
321 3
        $ioHost = $this->config->getIovipHost($ak, $bucket);
322
323
        $url = $ioHost . $path;
324
        list(, $error) = $this->post($url, null);
325
        return $error;
326
    }
327
328
    /**
329
     * 在单次请求中进行多个资源管理操作
330
     *
331
     * @param $operations     资源管理操作数组
332
     *
333
     * @return array 每个资源的处理情况,结果类似:
334
     *              [
335
     *                   { "code" => <HttpCode int>, "data" => <Data> },
336
     *                   { "code" => <HttpCode int> },
337
     *                   { "code" => <HttpCode int> },
338
     *                   { "code" => <HttpCode int> },
339
     *                   { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } },
340
     *                   ...
341
     *               ]
342
     * @link http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
343
     */
344 12
    public function batch($operations)
345
    {
346 12
        $params = 'op=' . implode('&op=', $operations);
347 12
        return $this->rsPost('/batch', $params);
348
    }
349
350
    /**
351
     * 设置文件的生命周期
352
     *
353
     * @param $bucket 设置文件生命周期文件所在的空间
354
     * @param $key    设置文件生命周期文件的文件名
355
     * @param $days   设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期
356
     *
357
     * @return Mixed
358
     * @link https://developer.qiniu.com/kodo/api/update-file-lifecycle
359
     */
360 3
    public function deleteAfterDays($bucket, $key, $days)
361
    {
362 3
        $entry = \Qiniu\entry($bucket, $key);
363 3
        $path = "/deleteAfterDays/$entry/$days";
364 3
        list(, $error) = $this->rsPost($path);
365 3
        return $error;
366
    }
367
368 3
    private function getRsfHost()
369
    {
370 3
        $scheme = "http://";
371 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...
372
            $scheme = "https://";
373
        }
374 3
        return $scheme . Config::RSF_HOST;
375
    }
376
377 33
    private function getRsHost()
378
    {
379 33
        $scheme = "http://";
380 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...
381
            $scheme = "https://";
382
        }
383 33
        return $scheme . Config::RS_HOST;
384
    }
385
386
    private function getArHost()
387
    {
388
        $scheme = "http://";
389
        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...
390
            $scheme = "https://";
391
        }
392
        return $scheme . Config::ARGUS_HOST;
393
    }
394
395
    private function getApiHost()
396
    {
397
        $scheme = "http://";
398
        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...
399
            $scheme = "https://";
400
        }
401
        return $scheme . Config::API_HOST;
402
    }
403
404 27
    private function rsPost($path, $body = null)
405
    {
406 27
        $url = $this->getRsHost() . $path;
407 27
        return $this->post($url, $body);
408
    }
409
410
    private function apiGet($path)
411
    {
412
        $url = $this->getApiHost() . $path;
413
        return $this->get($url);
414
    }
415
416 6
    private function rsGet($path)
417
    {
418 6
        $url = $this->getRsHost() . $path;
419 6
        return $this->get($url);
420
    }
421
422
    private function arPost($path, $body = null)
423
    {
424
        $url = $this->getArHost() . $path;
425
        return $this->pluPost($url, 'POST', $body);
426
    }
427
428 9
    private function get($url)
429
    {
430 9
        $headers = $this->auth->authorization($url);
431 9
        $ret = Client::get($url, $headers);
432 9
        if (!$ret->ok()) {
433 9
            return array(null, new Error($url, $ret));
434
        }
435
        return array($ret->json(), null);
436
    }
437
438 27
    private function post($url, $body)
439
    {
440 27
        $headers = $this->auth->authorization($url, $body, 'application/x-www-form-urlencoded');
441 27
        $ret = Client::post($url, $body, $headers);
442 27
        if (!$ret->ok()) {
443 27
            return array(null, new Error($url, $ret));
444
        }
445
        $r = ($ret->body === null) ? array() : $ret->json();
446
        return array($r, null);
447
    }
448
449
    private function pluPost($url, $method, $body)
450
    {
451
        $headers = $this->auth->authorizationV2($url, $method, $body, 'application/json');
452
        $headers['Content-Type']='application/json';
453
        $ret = Client::post($url, $body, $headers);
454
        if (!$ret->ok()) {
455
            print($ret->statusCode);
456
            return array(null, new Error($url, $ret));
457
        }
458
        $r = ($ret->body === null) ? array() : $ret->json();
459
        return array($r, null);
460
    }
461
462 3
    public static function buildBatchCopy($source_bucket, $key_pairs, $target_bucket, $force)
463
    {
464 3
        return self::twoKeyBatch('/copy', $source_bucket, $key_pairs, $target_bucket, $force);
465
    }
466
467
468 3
    public static function buildBatchRename($bucket, $key_pairs, $force)
469
    {
470 3
        return self::buildBatchMove($bucket, $key_pairs, $bucket, $force);
471
    }
472
473
474 6
    public static function buildBatchMove($source_bucket, $key_pairs, $target_bucket, $force)
475
    {
476 6
        return self::twoKeyBatch('/move', $source_bucket, $key_pairs, $target_bucket, $force);
477
    }
478
479
480
    public static function buildBatchDelete($bucket, $keys)
481
    {
482
        return self::oneKeyBatch('/delete', $bucket, $keys);
483
    }
484
485
486 3
    public static function buildBatchStat($bucket, $keys)
487
    {
488 3
        return self::oneKeyBatch('/stat', $bucket, $keys);
489
    }
490
491
    public static function buildBatchDeleteAfterDays($bucket, $key_day_pairs)
492
    {
493
        $data = array();
494
        foreach ($key_day_pairs as $key => $day) {
495
            array_push($data, '/deleteAfterDays/' . \Qiniu\entry($bucket, $key) . '/' . $day);
496
        }
497
        return $data;
498
    }
499
500
    public static function buildBatchChangeMime($bucket, $key_mime_pairs)
501
    {
502
        $data = array();
503
        foreach ($key_mime_pairs as $key => $mime) {
504
            array_push($data, '/chgm/' . \Qiniu\entry($bucket, $key) . '/mime/' . base64_encode($mime));
505
        }
506
        return $data;
507
    }
508
509
    public static function buildBatchChangeType($bucket, $key_type_pairs)
510
    {
511
        $data = array();
512
        foreach ($key_type_pairs as $key => $type) {
513
            array_push($data, '/chtype/' . \Qiniu\entry($bucket, $key) . '/type/' . $type);
514
        }
515
        return $data;
516
    }
517
518 3
    private static function oneKeyBatch($operation, $bucket, $keys)
519
    {
520 3
        $data = array();
521 3
        foreach ($keys as $key) {
522 3
            array_push($data, $operation . '/' . \Qiniu\entry($bucket, $key));
523 3
        }
524 3
        return $data;
525
    }
526
527 9
    private static function twoKeyBatch($operation, $source_bucket, $key_pairs, $target_bucket, $force)
528
    {
529 9
        if ($target_bucket === null) {
530
            $target_bucket = $source_bucket;
531
        }
532 9
        $data = array();
533 9
        $forceOp = "false";
534 9
        if ($force) {
535 9
            $forceOp = "true";
536 9
        }
537 9
        foreach ($key_pairs as $from_key => $to_key) {
538 9
            $from = \Qiniu\entry($source_bucket, $from_key);
539 9
            $to = \Qiniu\entry($target_bucket, $to_key);
540 9
            array_push($data, $operation . '/' . $from . '/' . $to . "/force/" . $forceOp);
541 9
        }
542 9
        return $data;
543
    }
544
}
545