Completed
Pull Request — master (#293)
by
unknown
09:20
created

BucketManager   F

Complexity

Total Complexity 116

Size/Duplication

Total Lines 1096
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 5

Test Coverage

Coverage 73.18%

Importance

Changes 0
Metric Value
dl 0
loc 1096
ccs 131
cts 179
cp 0.7318
rs 1.216
c 0
b 0
f 0
wmc 116
lcom 2
cbo 5

64 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 2
A buckets() 0 8 2
A listbuckets() 0 10 1
A deleteBucket() 0 5 1
A domains() 0 4 1
A bucketInfo() 0 6 1
A bucketInfos() 0 6 1
A listFiles() 0 15 1
A createBucket() 0 5 1
A listFilesv2() 0 25 2
B bucketLifecycleRule() 0 27 6
B updateBucketLifecycleRule() 0 27 6
A getBucketLifecycleRules() 0 6 1
A deleteBucketLifecycleRule() 0 13 3
C putBucketEvent() 0 43 10
C updateBucketEvent() 0 39 9
A getBucketEvents() 0 6 1
A deleteBucketEvent() 0 13 3
A putCorsRules() 0 7 1
A getCorsRules() 0 6 1
A putBucktSourceConfig() 0 7 1
A getBucktSourceConfig() 0 7 1
A putBucketAccessStyleMode() 0 6 1
A putBucketAccessMode() 0 6 1
A putReferAntiLeech() 0 6 1
A putBucketMaxAge() 0 6 1
A putBucketQuota() 0 6 1
A getBucketQuota() 0 6 1
A stat() 0 5 1
A delete() 0 6 1
A rename() 0 4 1
A copy() 0 11 2
A move() 0 11 2
A changeMime() 0 8 1
A changeType() 0 7 1
A changeStatus() 0 7 1
A fetch() 0 13 1
A prefetch() 0 12 1
A batch() 0 5 1
A deleteAfterDays() 0 7 1
A getRsfHost() 0 8 2
A getRsHost() 0 8 2
A getApiHost() 0 8 2
A getUcHost() 0 8 2
A rsPost() 0 5 1
A apiPost() 0 5 1
A ucPost() 0 5 1
A ucGet() 0 5 1
A apiGet() 0 5 1
A rsGet() 0 5 1
A get() 0 9 2
A post() 0 10 3
A ucPostV2() 0 5 1
A postV2() 0 11 3
A buildBatchCopy() 0 4 1
A buildBatchRename() 0 4 1
A buildBatchMove() 0 4 1
A buildBatchDelete() 0 4 1
A buildBatchStat() 0 4 1
A buildBatchDeleteAfterDays() 0 8 2
A buildBatchChangeMime() 0 8 2
A buildBatchChangeType() 0 8 2
A oneKeyBatch() 0 8 2
A twoKeyBatch() 0 17 4

How to fix   Complexity   

Complex Class

Complex classes like BucketManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use BucketManager, and based on these observations, apply Extract Interface, too.

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
     * 列举空间,返回bucket列表
46
     * region 指定区域,global 指定全局空间。
47
     * 在指定了 region 参数时,
48
     * 如果指定 global 为 true,那么忽略 region 参数指定的区域,返回所有区域的全局空间。
49
     * 如果没有指定 global 为 true,那么返回指定区域中非全局空间。
50
     * 在没有指定 region 参数时(包括指定为空""),
51
     * 如果指定 global 为 true,那么返回所有区域的全局空间。
52
     * 如果没有指定 global 为 true,那么返回指定区域中所有的空间,包括全局空间。
53
     * 在指定了line为 true 时,只返回 Line 空间;否则,只返回非 Line 空间。
54
     * share 参数用于指定共享空间。
55
     */
56
57
    public function listbuckets(
58
        $region = null,
59
        $global = 'false',
60
        $line = 'false',
61
        $shared = 'false'
0 ignored issues
show
Unused Code introduced by
The parameter $shared is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
62
    ) {
63
        $path = '/v3/buckets?region=' . $region . '&global=' . $global . '&line=' . $line . '&shared=' . $share;
0 ignored issues
show
Bug introduced by
The variable $share does not exist. Did you mean $shared?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
64
        $info = $this->ucPost($path);
65
        return $info;
66
    }
67
68
    /**
69
     * 创建空间
70
     *
71
     * @param $name     创建的空间名
72
     * @param $region    创建的区域,默认华东
73
     *
74
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
75
     */
76
    public function createBucket($name, $region = 'z0')
77
    {
78
        $path = '/mkbucketv2/'.$name.'/region/' . $region;
79 3
        return $this->rsPost($path, null);
80
    }
81 3
82 3
    /**
83 3
     * 删除空间
84 3
     *
85 3
     * @param $name     删除的空间名
86 3
     *
87 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
88
     */
89
    public function deleteBucket($name)
90
    {
91
        $path = '/drop/'.$name;
92
        return $this->rsPost($path, null);
93
    }
94
95
    /**
96
     * 获取指定空间绑定的所有的域名
97
     *
98
     * @return string[] 包含所有空间域名
99
     */
100
    public function domains($bucket)
101
    {
102
        return $this->apiGet('/v6/domain/list?tbl=' . $bucket);
103
    }
104
105
    /**
106
     * 获取指定空间的相关信息
107 6
     *
108
     * @return string[] 包含空间信息
109 6
     */
110 6
    public function bucketInfo($bucket)
111
    {
112
        $path = '/v2/bucketInfo?bucket=' . $bucket;
113
        $info = $this->ucPost($path);
114
        return $info;
115
    }
116
117
    /**
118
     * 获取指定zone的空间信息列表
119
     * 在Region 未指定且Global 不为 true 时(包含未指定的情况,下同),返回用户的所有空间。
120
     * 在指定了 region 参数且 global 不为 true 时,只列举非全局空间。
121
     * 在指定了global为 true 时,返回所有全局空间,忽略region 参数
122 15
     * shared 不指定shared参数或指定shared为rw或false时,返回包含具有读写权限空间,
123
     * 指定shared为rd或true时,返回包含具有读权限空间。
124 15
     * fs:如果为 true,会返回每个空间当前的文件数和存储量(实时数据)。
125 15
     * @return string[] 包含空间信息
126 15
     */
127
    public function bucketInfos($region = null, $global = 'false', $shared = 'false', $fs = 'false')
128
    {
129
        $path = '/v2/bucketInfos?region=' . $region . '&global=' . $global . '&shared=' . $shared . '&fs=' . $fs;
130
        $info = $this->ucPost($path);
131
        return $info;
132
    }
133
134
    /**
135
     * 获取空间绑定的域名列表
136
     * @return string[] 包含空间绑定的所有域名
137
     */
138
139 3
    /**
140
     * 列取空间的文件列表
141 3
     *
142
     * @param $bucket     空间名
143
     * @param $prefix     列举前缀
144
     * @param $marker     列举标识符
145
     * @param $limit      单次列举个数限制
146
     * @param $delimiter  指定目录分隔符
147
     *
148
     * @return array    包含文件信息的数组,类似:[
149
*                                              {
150
*                                                 "hash" => "<Hash string>",
151
*                                                  "key" => "<Key string>",
152
*                                                  "fsize" => "<file size>",
153
*                                                  "putTime" => "<file modify time>"
154
*                                              },
155 15
*                                              ...
156
*                                            ]
157 15
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
158 15
     */
159 15
    public function listFiles(
160 15
        $bucket,
161 3
        $prefix = null,
162 3
        $marker = null,
163 15
        $limit = 1000,
164 15
        $delimiter = null
165
    ) {
166
        $query = array('bucket' => $bucket);
167
        \Qiniu\setWithoutEmpty($query, 'prefix', $prefix);
168
        \Qiniu\setWithoutEmpty($query, 'marker', $marker);
169
        \Qiniu\setWithoutEmpty($query, 'limit', $limit);
170
        \Qiniu\setWithoutEmpty($query, 'delimiter', $delimiter);
171
        $url = $this->getRsfHost() . '/list?' . http_build_query($query);
172
        return $this->get($url);
173
    }
174
175
    /**
176
     * 列取空间的文件列表
177
     *
178 3
     * @param $bucket     空间名
179
     * @param $prefix     列举前缀
180 3
     * @param $marker     列举标识符
181 3
     * @param $limit      单次列举个数限制
182 3
     * @param $delimiter  指定目录分隔符
183 3
     * @param $skipconfirm  是否跳过已删除条目的确认机制
184
     *
185
     * @return array    包含文件信息的数组,类似:[
186 3
*                                              {
187 3
*                                                 "hash" => "<Hash string>",
188
*                                                  "key" => "<Key string>",
189
*                                                  "fsize" => "<file size>",
190
*                                                  "putTime" => "<file modify time>"
191
*                                              },
192
*                                              ...
193
*                                            ]
194
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
195
     */
196
    public function listFilesv2(
197
        $bucket,
198
        $prefix = null,
199
        $marker = null,
200 3
        $limit = 1000,
201
        $delimiter = null,
202 3
        $skipconfirm = true
203 3
    ) {
204 3
        $query = array('bucket' => $bucket);
205 3
        \Qiniu\setWithoutEmpty($query, 'prefix', $prefix);
206 3
        \Qiniu\setWithoutEmpty($query, 'marker', $marker);
207
        \Qiniu\setWithoutEmpty($query, 'limit', $limit);
208
        \Qiniu\setWithoutEmpty($query, 'delimiter', $delimiter);
209
        \Qiniu\setWithoutEmpty($query, 'skipconfirm', $skipconfirm);
210
        $path = '/v2/list?' . http_build_query($query);
211
        $url = $this->getRsfHost() . $path;
212
        $headers = $this->auth->authorization($url, null, 'application/x-www-form-urlencoded');
213
        $ret = Client::post($url, null, $headers);
214
        if (!$ret->ok()) {
215
            return array(null, new Error($url, $ret));
216
        }
217
        $r = explode("\n", $ret->body);
218
        $pop = array_pop($r);
0 ignored issues
show
Unused Code introduced by
$pop is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
219
        return array($r, null);
220
    }
221
222
    /**
223
     * 设置Referer防盗链
224
     *
225
     * @param $bucket     空间名
226
     * @param $mode     0: 表示关闭Referer(使用此选项将会忽略以下参数并将恢复默认值);
227
     * 1: 表示设置Referer白名单; 2:表示设置Referer黑名单
228
     * @param $norefer     0: 表示不允许空 Refer 访问; 1: 表示允许空 Refer 访问
229
     * @param $pattern      规则字符串, 当前允许格式分为三种: 一种为空主机头域名,
230
     * 比如 foo.com; 一种是泛域名,比如 *.bar.com; 一种是完全通配符,
231
     * 即一个 *; 多个规则之间用;隔开, 比如: foo.com;*.bar.com;sub.foo.com;*.sub.bar.com
232
     * @param $source_enabled  源站是否支持,默认为0只给CDN配置, 设置为1表示开启源站防盗链
233
     *
234
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
235
     */
236
    // public function referAntiLeech(){
237
238
    // }
239
240
    /**
241
     * 增加bucket生命规则
242
     *
243
     * @param $bucket     空间名
244
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为
245
     * 字母、数字、下划线
246
     * @param $prefix     同一个 bucket 里面前缀不能重复
247
     * @param $delete_after_days      指定上传文件多少天后删除,指定为0表示不删除,
248
     * 大于0表示多少天后删除,需大于 to_line_after_days
249
     * @param $to_line_after_days  指定文件上传多少天后转低频存储。指定为0表示
250
     * 不转低频存储,小于0表示上传的文件立即变低频存储
251
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
252
     */
253
    public function bucketLifecycleRule(
254
        $bucket,
255
        $name,
256
        $prefix,
257
        $delete_after_days,
258
        $to_line_after_days
259
    ) {
260
        $path = '/rules/add';
261
        if ($bucket) {
262
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
263
        }
264
        if ($name) {
265
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
266
        }
267
        if ($prefix) {
268 3
            $params['prefix'] = $prefix;
269
        }
270
        if ($delete_after_days) {
271 3
            $params['delete_after_days'] = $delete_after_days;
272 3
        }
273 3
        if ($to_line_after_days) {
274
            $params['to_line_after_days'] = $to_line_after_days;
275 3
        }
276 3
        $data = http_build_query($params);
277
        $info = $this->ucPost($path, $data);
278 3
        return $info;
279 3
    }
280
281
    /**
282
     * 更新bucket生命规则
283
     *
284
     * @param $bucket     空间名
285
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、
286
     * 数字、下划线
287
     * @param $prefix     同一个 bucket 里面前缀不能重复
288
     * @param $delete_after_days      指定上传文件多少天后删除,指定为0表示不删除,
289
     * 大于0表示多少天后删除,需大于 to_line_after_days
290
     * @param $to_line_after_days  指定文件上传多少天后转低频存储。指定为0表示不
291 3
     * 转低频存储,小于0表示上传的文件立即变低频存储
292
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
293 3
     */
294 3
    public function updateBucketLifecycleRule(
295
        $bucket,
296 3
        $name,
297 3
        $prefix,
298
        $delete_after_days,
299 3
        $to_line_after_days
300 3
    ) {
301 3
        $path = '/rules/update';
302
        if ($bucket) {
303
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
304
        }
305
        if ($name) {
306
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
307
        }
308
        if ($prefix) {
309
            $params['prefix'] = $prefix;
310
        }
311
        if ($delete_after_days) {
312
            $params['delete_after_days'] = $delete_after_days;
313
        }
314
        if ($to_line_after_days) {
315
            $params['to_line_after_days'] = $to_line_after_days;
316
        }
317
        $data = http_build_query($params);
318
        $info = $this->ucPost($path, $data);
319
        return $info;
320 12
    }
321
322 12
    /**
323 12
     * 获取bucket生命规则
324
     *
325
     * @param $bucket     空间名
326
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
327
     */
328
    public function getBucketLifecycleRules($bucket)
329
    {
330
        $path = '/rules/get?bucket=' . $bucket;
331
        $info = $this->ucGet($path);
332
        return $info;
333
    }
334
335
    /**
336 3
     * 删除bucket生命规则
337
     *
338 3
     * @param $bucket     空间名
339 3
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,
340 3
     * 只能为字母、数字、下划线()
341 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
342
     */
343
    public function deleteBucketLifecycleRule($bucket, $name)
344 3
    {
345
        $path = '/rules/delete';
346 3
        if ($bucket) {
347 3
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
348
        }
349
        if ($name) {
350 3
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
351
        }
352
        $data = http_build_query($params);
353 33
        $info = $this->ucPost($path, $data);
354
        return $info;
355 33
    }
356 33
357
    /**
358
     * 增加bucket事件通知规则
359 33
     *
360
     * @param $bucket     空间名
361
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,
362
     * 只能为字母、数字、下划线()
363
     * @param $prefix     同一个 bucket 里面前缀不能重复
364
     * @param $suffix      可选,文件配置的后缀
365
     * @param $event  事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append,
366
     * disable,enable,deleteMarkerCreate
367
     * @param $callbackURL 通知URL,可以指定多个,失败依次重试
368
     * @param $access_key 可选,设置的话会对通知请求用对应的ak、sk进行签名
369
     * @param $host 可选,通知请求的host
370
     *
371 27
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
372
     */
373 27
    public function putBucketEvent(
374 27
        $bucket,
375
        $name,
376
        $prefix,
377
        $suffix,
378
        $event,
379
        $callbackURL,
380
        $access_key = null,
381
        $host = null
382
    ) {
383 9
        $path = '/events/add';
384
        if ($bucket) {
385 9
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
386 9
        }
387
        if ($name) {
388
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
389 12
        }
390
        if ($prefix) {
391 12
            $params['prefix'] = $prefix;
392 12
        }
393 12
        if ($suffix) {
394 8
            $params['suffix'] = $suffix;
395
        }
396 8
        if ($callbackURL) {
397
            $params['callbackURL'] = $callbackURL;
398
        }
399 33
        if ($access_key) {
400
            $params['access_key'] = $access_key;
401 33
        }
402 33
        if ($host) {
403 33
            $params['host'] = $host;
404 9
        }
405
        $data = http_build_query($params);
406 30
        if ($event) {
407 30
            $eventpath = "";
408
            foreach ($event as $key => $value) {
409
                $eventpath .= "&event=$value";
410 3
            }
411
            $data .= $eventpath;
412 3
        }
413
        $info = $this->ucPost($path, $data);
414
        return $info;
415
    }
416 3
417
    /**
418 3
     * 更新bucket事件通知规则
419
     *
420
     * @param $bucket     空间名
421
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,
422 6
     * 只能为字母、数字、下划线()
423
     * @param $prefix     同一个 bucket 里面前缀不能重复
424 6
     * @param $suffix      可选,文件配置的后缀
425
     * @param $event  事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append,disable,
426
     * enable,deleteMarkerCreate
427
     * @param $callbackURL 通知URL,可以指定多个,失败依次重试
428 3
     * @param $access_key 可选,设置的话会对通知请求用对应的ak、sk进行签名
429
     * @param $host 可选,通知请求的host
430 3
     *
431
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
432
     */
433
    public function updateBucketEvent(
434 3
        $bucket,
435
        $name,
436 3
        $prefix,
437
        $suffix,
438
        $event,
439
        $callbackURL,
440
        $access_key = null,
441
        $host = null
442
    ) {
443
        $path = '/events/update';
444
        if ($bucket) {
445
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
446
        }
447
        if ($name) {
448
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
449
        }
450
        if ($prefix) {
451
            $params['prefix'] = $prefix;
452
        }
453
        if ($suffix) {
454
            $params['suffix'] = $suffix;
455
        }
456
        if ($event) {
457
            $params['event'] = $event;
458
        }
459
        if ($callbackURL) {
460
            $params['callbackURL'] = $callbackURL;
461
        }
462
        if ($access_key) {
463
            $params['access_key'] = $access_key;
464
        }
465
        if ($host) {
466 6
            $params['host'] = $host;
467
        }
468 6
        $data = http_build_query($params);
469 6
        $info = $this->ucPost($path, $data);
470 6
        return $info;
471 6
    }
472 6
473
    /**
474
     * 获取bucket事件通知规则
475 9
     *
476
     * @param $bucket     空间名
477 9
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
478
     */
479
    public function getBucketEvents($bucket)
480 9
    {
481 9
        $path = '/events/get?bucket=' . $bucket;
482 9
        $info = $this->ucGet($path);
483 9
        return $info;
484 9
    }
485 9
486 9
    /**
487 9
     * 删除bucket事件通知规则
488 9
     *
489 9
     * @param $bucket     空间名
490 9
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,
491
     * 只能为字母、数字、下划线
492
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
493
     */
494
    public function deleteBucketEvent($bucket, $name)
495
    {
496
        $path = '/events/delete';
497
        if ($bucket) {
498
            $params['bucket'] = $bucket;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$params was never initialized. Although not strictly required by PHP, it is generally a good practice to add $params = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
499
        }
500
        if ($name) {
501
            $params['name'] = $name;
0 ignored issues
show
Bug introduced by
The variable $params does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
502
        }
503
        $data = http_build_query($params);
504
        $info = $this->ucPost($path, $data);
505
        return $info;
506
    }
507
508
    /**
509
     * 设置bucket的跨域信息,最多允许设置10条跨域规则。
510
     * 对于同一个域名如果设置了多条规则,那么按顺序使用第一条匹配的规则去生成返回值。
511
     * 对于简单跨域请求,只匹配 Origin;
512
     * 对于预检请求, 需要匹配 Origin、AllowedMethod、AllowedHeader;
513
     * allowed_orgin: 允许的域名。必填;支持通配符*;*表示全部匹配;只有第一个*生效;
514
     * 需要设置"Scheme";大小写敏感。例如
515
     * 规则:http://*.abc.*.com 请求:"http://test.abc.test.com" 结果:不通过
516
     * 规则:"http://abc.com" 请求:"https://abc.com"/"abc.com" 结果:不通过
517
     * 规则:"abc.com" 请求:"http://abc.com" 结果:不通过
518
     * allowed_method: 允许的方法。必填;不支持通配符;大小写不敏感;
519
     * allowed_header: 允许的header。选填;支持通配符*,
520
     * 但只能是单独的*,表示允许全部header,其他*不生效;
521
     * 空则不允许任何header;大小写不敏感;
522
     * exposed_header: 暴露的header。选填;不支持通配符;
523
     * X-Log, X-Reqid是默认会暴露的两个header;
524
     * 其他的header如果没有设置,则不会暴露;大小写不敏感;
525
     * max_age: 结果可以缓存的时间。选填;空则不缓存;
526
     * allowed_credentials:该配置不支持设置,默认为true。
527
     * 备注:如果没有设置任何corsRules,那么默认允许所有的跨域请求
528
     */
529
    public function putCorsRules($bucket, $params)
530
    {
531
        $path = '/corsRules/set/' . $bucket;
532
        $data = json_encode($params);
533
        $info = $this->ucPost($path, $data);
534
        return $info;
535
    }
536
537
    /**
538
     * 获取bucket的跨域信息
539
     * $bucket 空间名
540
     */
541
    public function getCorsRules($bucket)
542
    {
543
        $path = '/corsRules/get/' . $bucket;
544
        $info = $this->ucGet($path);
545
        return $info;
546
    }
547
548
    /**
549
     * 设置回源规则
550
     * 使用该API设置源站优先级高于/image设置的源站,即IO优先读取source接口设置的源站配置,
551
     * 如果存在会忽略/image设置的源站
552
     * Bucket 空间名
553
     * Host(可选)回源Host
554
     * RetryCodes(可选),镜像回源时源站返回Code可以重试,最多指定3个,当前只支持4xx错误码重试
555
     * SourceQiniuAK,SourceQiniuSK(可选)如果存在将在回源时对URL进行签名,客户源站可以验证
556
     * 以保证请求来自Qiniu服务器
557
     * Expires(可选) 签名过期时间,如果不设置默认为1小时
558
     * Addr 回源地址,不可重复。
559
     * Weight 权重,范围限制1-100,不填默认为1,回源时会根据所有源的权重值进行源站选择,
560
     * 主备源会分开计算.
561
     * Backup 是否备用回源,回源优先尝试主源
562
     */
563
    public function putBucktSourceConfig($params)
564
    {
565
        $path = '/mirrorConfig/set';
566
        $data = json_encode($params);
567
        $info = $this->ucPostV2($path, $data);
568
        return $info;
569
    }
570
571
    /**
572
     * 获取空间回源配置
573
     */
574
    public function getBucktSourceConfig($params)
575
    {
576
        $path = '/mirrorConfig/get';
577
        $data = json_encode($params);
578
        $info = $this->ucPostV2($path, $data);
579
        return $info;
580
    }
581
582
    /**
583
     * 开关原图保护
584
     * mode 为1表示开启原图保护,0表示关闭
585
     */
586
    public function putBucketAccessStyleMode($bucket, $mode)
587
    {
588
        $path = '/accessMode/' . $bucket . '/mode/' . $mode;
589
        $info = $this->ucPost($path, null);
590
        return $info;
591
    }
592
593
    /**
594
     * 设置私有属性
595
     * private为0表示公开,为1表示私有
596
     */
597
    public function putBucketAccessMode($bucket, $private)
598
    {
599
        $path = '/bucket/' . $bucket . '/private/' . $private;
600
        $info = $this->ucPost($path, null);
601
        return $info;
602
    }
603
604
    /**
605
     * 设置referer防盗链
606
     * bucket=<BucketName>: bucket 名
607
     * mode=<AntiLeechMode>:
608
     * 0: 表示关闭Referer(使用此选项将会忽略以下参数并将恢复默认值);
609
     * 1: 表示设置Referer白名单; 2: 表示设置Referer黑名单
610
     * norefer=<NoRefer>: 0: 表示不允许空 Refer 访问;
611
     * 1: 表示允许空 Refer 访问
612
     * pattern=<Pattern>: 规则字符串, 当前允许格式分为三种:
613
     * 一种为空主机头域名, 比如 foo.com;
614
     * 一种是泛域名, 比如 *.bar.com; 一种是完全通配符, 即一个 *;
615
     * 多个规则之间用;隔开, 比如: foo.com;*.bar.com;sub.foo.com;*.sub.bar.com
616
     * 空主机头域名可以是多级域名,比如 foo.bar.com。
617
     * 多个域名之间不允许夹带空白字符。
618
     * source_enabled=:1
619
     */
620
    public function putReferAntiLeech($bucket, $mode, $norefer, $pattern, $enabled = 1)
621
    {
622
        $path = "/referAntiLeech?bucket=$bucket&mode=$mode&norefer=$norefer&pattern=$pattern&source_enabled=$enabled";
623
        $info = $this->ucPost($path, null);
624
        return $info;
625
    }
626
627
    /**
628
     * 设置Bucket的maxAge
629
     * maxAge为0或者负数表示为默认值(31536000)
630
     */
631
    public function putBucketMaxAge($bucket, $maxAge)
632
    {
633
        $path = '/maxAge?bucket=' . $bucket . '&maxAge=' . $maxAge;
634
        $info = $this->ucPost($path, null);
635
        return $info;
636
    }
637
638
    /**
639
     * 设置配额
640
     * <bucket>: 空间名称,不支持授权空间
641
     * <size>: 空间存储量配额,参数传入0或不传表示不更改当前配置,传入-1表示取消限额,
642
     * 新创建的空间默认没有限额。
643
     * <count>: 空间文件数配额,参数含义同<size>
644
     */
645
    public function putBucketQuota($bucket, $size, $count)
646
    {
647
        $path = '/setbucketquota/' . $bucket . '/size/' . $size . '/count/' . $count;
648
        $info = $this->apiPost($path, null);
649
        return $info;
650
    }
651
652
    /**
653
     * 获取配额
654
     * bucket 空间名称
655
     */
656
    public function getBucketQuota($bucket)
657
    {
658
        $path = '/getbucketquota/' . $bucket;
659
        $info = $this->apiPost($path, null);
660
        return $info;
661
    }
662
663
    /**
664
     * 获取资源的元信息,但不返回文件内容
665
     *
666
     * @param $bucket     待获取信息资源所在的空间
667
     * @param $key        待获取资源的文件名
668
     *
669
     * @return array    包含文件信息的数组,类似:
670
*                                              [
671
*                                                  "hash" => "<Hash string>",
672
*                                                  "key" => "<Key string>",
673
*                                                  "fsize" => <file size>,
674
*                                                  "putTime" => "<file modify time>"
675
*                                                  "fileType" => <file type>
676
*                                              ]
677
     *
678
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/stat.html
679
     */
680
    public function stat($bucket, $key)
681
    {
682
        $path = '/stat/' . \Qiniu\entry($bucket, $key);
683
        return $this->rsGet($path);
684
    }
685
686
    /**
687
     * 删除指定资源
688
     *
689
     * @param $bucket     待删除资源所在的空间
690
     * @param $key        待删除资源的文件名
691
     *
692
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
693
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
694
     */
695
    public function delete($bucket, $key)
696
    {
697
        $path = '/delete/' . \Qiniu\entry($bucket, $key);
698
        list(, $error) = $this->rsPost($path);
699
        return $error;
700
    }
701
702
703
    /**
704
     * 给资源进行重命名,本质为move操作。
705
     *
706
     * @param $bucket     待操作资源所在空间
707
     * @param $oldname    待操作资源文件名
708
     * @param $newname    目标资源文件名
709
     *
710
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
711
     */
712
    public function rename($bucket, $oldname, $newname)
713
    {
714
        return $this->move($bucket, $oldname, $bucket, $newname);
715
    }
716
717
    /**
718
     * 对资源进行复制。
719
     *
720
     * @param $from_bucket     待操作资源所在空间
721
     * @param $from_key        待操作资源文件名
722
     * @param $to_bucket       目标资源空间名
723
     * @param $to_key          目标资源文件名
724
     *
725
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
726
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
727
     */
728
    public function copy($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
729
    {
730
        $from = \Qiniu\entry($from_bucket, $from_key);
731
        $to = \Qiniu\entry($to_bucket, $to_key);
732
        $path = '/copy/' . $from . '/' . $to;
733
        if ($force === true) {
734
            $path .= '/force/true';
735
        }
736
        list(, $error) = $this->rsPost($path);
737
        return $error;
738
    }
739
740
    /**
741
     * 将资源从一个空间到另一个空间
742
     *
743
     * @param $from_bucket     待操作资源所在空间
744
     * @param $from_key        待操作资源文件名
745
     * @param $to_bucket       目标资源空间名
746
     * @param $to_key          目标资源文件名
747
     *
748
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
749
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
750
     */
751
    public function move($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
752
    {
753
        $from = \Qiniu\entry($from_bucket, $from_key);
754
        $to = \Qiniu\entry($to_bucket, $to_key);
755
        $path = '/move/' . $from . '/' . $to;
756
        if ($force) {
757
            $path .= '/force/true';
758
        }
759
        list(, $error) = $this->rsPost($path);
760
        return $error;
761
    }
762
763
    /**
764
     * 主动修改指定资源的文件元信息
765
     *
766
     * @param $bucket     待操作资源所在空间
767
     * @param $key        待操作资源文件名
768
     * @param $mime       待操作文件目标mimeType
769
     *
770
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
771
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
772
     */
773
    public function changeMime($bucket, $key, $mime)
774
    {
775
        $resource = \Qiniu\entry($bucket, $key);
776
        $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
777
        $path = '/chgm/' . $resource . '/mime/' . $encode_mime;
778
        list(, $error) = $this->rsPost($path);
779
        return $error;
780
    }
781
782
783
    /**
784
     * 修改指定资源的存储类型
785
     *
786
     * @param $bucket     待操作资源所在空间
787
     * @param $key        待操作资源文件名
788
     * @param $fileType       待操作文件目标文件类型
789
     *
790
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
791
     * @link  https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
792
     */
793
    public function changeType($bucket, $key, $fileType)
794
    {
795
        $resource = \Qiniu\entry($bucket, $key);
796
        $path = '/chtype/' . $resource . '/type/' . $fileType;
797
        list(, $error) = $this->rsPost($path);
798
        return $error;
799
    }
800
801
    /**
802
     * 修改文件的存储状态,即禁用状态和启用状态间的的互相转换
803
     *
804
     * @param $bucket     待操作资源所在空间
805
     * @param $key        待操作资源文件名
806
     * @param $status       待操作文件目标文件类型
807
     *
808
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
809
     * @link  https://developer.qiniu.com/kodo/api/4173/modify-the-file-status
810
     */
811
    public function changeStatus($bucket, $key, $status)
812
    {
813
        $resource = \Qiniu\entry($bucket, $key);
814
        $path = '/chstatus/' . $resource . '/status/' . $status;
815
        list(, $error) = $this->rsPost($path);
816
        return $error;
817
    }
818
819
    /**
820
     * 从指定URL抓取资源,并将该资源存储到指定空间中
821
     *
822
     * @param $url        指定的URL
823
     * @param $bucket     目标资源空间
824
     * @param $key        目标资源文件名
825
     *
826
     * @return array    包含已拉取的文件信息。
827
     *                         成功时:  [
828
     *                                          [
829
     *                                              "hash" => "<Hash string>",
830
     *                                              "key" => "<Key string>"
831
     *                                          ],
832
     *                                          null
833
     *                                  ]
834
     *
835
     *                         失败时:  [
836
     *                                          null,
837
     *                                         Qiniu/Http/Error
838
     *                                  ]
839
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
840
     */
841
    public function fetch($url, $bucket, $key = null)
842
    {
843
844
        $resource = \Qiniu\base64_urlSafeEncode($url);
845
        $to = \Qiniu\entry($bucket, $key);
846
        $path = '/fetch/' . $resource . '/to/' . $to;
847
848
        $ak = $this->auth->getAccessKey();
849
        $ioHost = $this->config->getIovipHost($ak, $bucket);
850
851
        $url = $ioHost . $path;
852
        return $this->post($url, null);
853
    }
854
855
    /**
856
     * 从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源
857
     *
858
     * @param $bucket     待获取资源所在的空间
859
     * @param $key        代获取资源文件名
860
     *
861
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
862
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
863
     */
864
    public function prefetch($bucket, $key)
865
    {
866
        $resource = \Qiniu\entry($bucket, $key);
867
        $path = '/prefetch/' . $resource;
868
869
        $ak = $this->auth->getAccessKey();
870
        $ioHost = $this->config->getIovipHost($ak, $bucket);
871
872
        $url = $ioHost . $path;
873
        list(, $error) = $this->post($url, null);
874
        return $error;
875
    }
876
877
    /**
878
     * 在单次请求中进行多个资源管理操作
879
     *
880
     * @param $operations     资源管理操作数组
881
     *
882
     * @return array 每个资源的处理情况,结果类似:
883
     *              [
884
     *                   { "code" => <HttpCode int>, "data" => <Data> },
885
     *                   { "code" => <HttpCode int> },
886
     *                   { "code" => <HttpCode int> },
887
     *                   { "code" => <HttpCode int> },
888
     *                   { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } },
889
     *                   ...
890
     *               ]
891
     * @link http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
892
     */
893
    public function batch($operations)
894
    {
895
        $params = 'op=' . implode('&op=', $operations);
896
        return $this->rsPost('/batch', $params);
897
    }
898
899
    /**
900
     * 设置文件的生命周期
901
     *
902
     * @param $bucket 设置文件生命周期文件所在的空间
903
     * @param $key    设置文件生命周期文件的文件名
904
     * @param $days   设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期
905
     *
906
     * @return Mixed
907
     * @link https://developer.qiniu.com/kodo/api/update-file-lifecycle
908
     */
909
    public function deleteAfterDays($bucket, $key, $days)
910
    {
911
        $entry = \Qiniu\entry($bucket, $key);
912
        $path = "/deleteAfterDays/$entry/$days";
913
        list(, $error) = $this->rsPost($path);
914
        return $error;
915
    }
916
917
    private function getRsfHost()
918
    {
919
        $scheme = "http://";
920
        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...
921
            $scheme = "https://";
922
        }
923
        return $scheme . Config::RSF_HOST;
924
    }
925
926
    private function getRsHost()
927
    {
928
        $scheme = "http://";
929
        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...
930
            $scheme = "https://";
931
        }
932
        return $scheme . Config::RS_HOST;
933
    }
934
935
    private function getApiHost()
936
    {
937
        $scheme = "http://";
938
        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...
939
            $scheme = "https://";
940
        }
941
        return $scheme . Config::API_HOST;
942
    }
943
944
    private function getUcHost()
945
    {
946
        $scheme = "http://";
947
        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...
948
            $scheme = "https://";
949
        }
950
        return $scheme . Config::UC_HOST;
951
    }
952
953
    private function rsPost($path, $body = null)
954
    {
955
        $url = $this->getRsHost() . $path;
956
        return $this->post($url, $body);
957
    }
958
959
    private function apiPost($path, $body = null)
960
    {
961
        $url = $this->getApiHost() . $path;
962
        return $this->post($url, $body);
963
    }
964
965
    private function ucPost($path, $body = null)
966
    {
967
        $url = $this->getUcHost() . $path;
968
        return $this->post($url, $body);
969
    }
970
971
    private function ucGet($path)
972
    {
973
        $url = $this->getUcHost() . $path;
974
        return $this->get($url);
975
    }
976
977
    private function apiGet($path)
978
    {
979
        $url = $this->getApiHost() . $path;
980
        return $this->get($url);
981
    }
982
983
    private function rsGet($path)
984
    {
985
        $url = $this->getRsHost() . $path;
986
        return $this->get($url);
987
    }
988
989
    private function get($url)
990
    {
991
        $headers = $this->auth->authorization($url);
992
        $ret = Client::get($url, $headers);
993
        if (!$ret->ok()) {
994
            return array(null, new Error($url, $ret));
995
        }
996
        return array($ret->json(), null);
997
    }
998
999
    private function post($url, $body)
1000
    {
1001
        $headers = $this->auth->authorization($url, $body, 'application/x-www-form-urlencoded');
1002
        $ret = Client::post($url, $body, $headers);
1003
        if (!$ret->ok()) {
1004
            return array(null, new Error($url, $ret));
1005
        }
1006
        $r = ($ret->body === null) ? array() : $ret->json();
1007
        return array($r, null);
1008
    }
1009
1010
    private function ucPostV2($path, $body)
1011
    {
1012
        $url = $this->getUcHost() . $path;
1013
        return $this->postV2($url, $body);
1014
    }
1015
1016
    private function postV2($url, $body)
1017
    {
1018
        $headers = $this->auth->authorizationV2($url, 'POST', $body, 'application/json');
1019
        $headers["Content-Type"] = 'application/json';
1020
        $ret = Client::post($url, $body, $headers);
1021
        if (!$ret->ok()) {
1022
            return array(null, new Error($url, $ret));
1023
        }
1024
        $r = ($ret->body === null) ? array() : $ret->json();
1025
        return array($r, null);
1026
    }
1027
1028
    public static function buildBatchCopy($source_bucket, $key_pairs, $target_bucket, $force)
1029
    {
1030
        return self::twoKeyBatch('/copy', $source_bucket, $key_pairs, $target_bucket, $force);
1031
    }
1032
1033
1034
    public static function buildBatchRename($bucket, $key_pairs, $force)
1035
    {
1036
        return self::buildBatchMove($bucket, $key_pairs, $bucket, $force);
1037
    }
1038
1039
1040
    public static function buildBatchMove($source_bucket, $key_pairs, $target_bucket, $force)
1041
    {
1042
        return self::twoKeyBatch('/move', $source_bucket, $key_pairs, $target_bucket, $force);
1043
    }
1044
1045
1046
    public static function buildBatchDelete($bucket, $keys)
1047
    {
1048
        return self::oneKeyBatch('/delete', $bucket, $keys);
1049
    }
1050
1051
1052
    public static function buildBatchStat($bucket, $keys)
1053
    {
1054
        return self::oneKeyBatch('/stat', $bucket, $keys);
1055
    }
1056
1057
    public static function buildBatchDeleteAfterDays($bucket, $key_day_pairs)
1058
    {
1059
        $data = array();
1060
        foreach ($key_day_pairs as $key => $day) {
1061
            array_push($data, '/deleteAfterDays/' . \Qiniu\entry($bucket, $key) . '/' . $day);
1062
        }
1063
        return $data;
1064
    }
1065
1066
    public static function buildBatchChangeMime($bucket, $key_mime_pairs)
1067
    {
1068
        $data = array();
1069
        foreach ($key_mime_pairs as $key => $mime) {
1070
            array_push($data, '/chgm/' . \Qiniu\entry($bucket, $key) . '/mime/' . base64_encode($mime));
1071
        }
1072
        return $data;
1073
    }
1074
1075
    public static function buildBatchChangeType($bucket, $key_type_pairs)
1076
    {
1077
        $data = array();
1078
        foreach ($key_type_pairs as $key => $type) {
1079
            array_push($data, '/chtype/' . \Qiniu\entry($bucket, $key) . '/type/' . $type);
1080
        }
1081
        return $data;
1082
    }
1083
1084
    private static function oneKeyBatch($operation, $bucket, $keys)
1085
    {
1086
        $data = array();
1087
        foreach ($keys as $key) {
1088
            array_push($data, $operation . '/' . \Qiniu\entry($bucket, $key));
1089
        }
1090
        return $data;
1091
    }
1092
1093
    private static function twoKeyBatch($operation, $source_bucket, $key_pairs, $target_bucket, $force)
1094
    {
1095
        if ($target_bucket === null) {
1096
            $target_bucket = $source_bucket;
1097
        }
1098
        $data = array();
1099
        $forceOp = "false";
1100
        if ($force) {
1101
            $forceOp = "true";
1102
        }
1103
        foreach ($key_pairs as $from_key => $to_key) {
1104
            $from = \Qiniu\entry($source_bucket, $from_key);
1105
            $to = \Qiniu\entry($target_bucket, $to_key);
1106
            array_push($data, $operation . '/' . $from . '/' . $to . "/force/" . $forceOp);
1107
        }
1108
        return $data;
1109
    }
1110
}
1111