Completed
Pull Request — master (#293)
by
unknown
02:57
created

BucketManager   F

Complexity

Total Complexity 111

Size/Duplication

Total Lines 971
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 5

Test Coverage

Coverage 73.18%

Importance

Changes 0
Metric Value
dl 0
loc 971
rs 1.629
c 0
b 0
f 0
ccs 131
cts 179
cp 0.7318
wmc 111
lcom 2
cbo 5

61 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 9 2
A buckets() 0 8 2
A listbuckets() 0 6 1
A creatBucket() 0 5 1
A deleteBucket() 0 5 1
A domains() 0 4 1
A bucketInfo() 0 6 1
A bucketInfos() 0 6 1
A listFiles() 0 10 1
B bucketLifecycleRule() 0 22 6
B updateBucketLifecycleRule() 0 22 6
A getBucketLifecycleRules() 0 6 1
A deleteBucketLifecycleRule() 0 13 3
C putBucketEvent() 0 39 9
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 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($region = null, $global = 'false', $line = 'false', $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...
58
    {
59
        $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...
60
        $info = $this->ucPost($path);
61
        return $info;
62
    }
63
64
    /**
65
     * 创建空间
66
     *
67
     * @param $name     创建的空间名
68
     * @param $region    创建的区域,默认华东
69
     *
70
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
71
     */
72
    public function creatBucket($name, $region = 'z0')
73
    {
74
        $path = '/mkbucketv2/'.$name.'/region/' . $region;
75
        return $this->rsPost($path, null);
76
    }
77
78
    /**
79 3
     * 删除空间
80
     *
81 3
     * @param $name     删除的空间名
82 3
     *
83 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
84 3
     */
85 3
    public function deleteBucket($name)
86 3
    {
87 3
        $path = '/drop/'.$name;
88
        return $this->rsPost($path, null);
89
    }
90
91
    /**
92
     * 获取指定空间绑定的所有的域名
93
     *
94
     * @return string[] 包含所有空间域名
95
     */
96
    public function domains($bucket)
97
    {
98
        return $this->apiGet('/v6/domain/list?tbl=' . $bucket);
99
    }
100
101
    /**
102
     * 获取指定空间的相关信息
103
     *
104
     * @return string[] 包含空间信息
105
     */
106
    public function bucketInfo($bucket)
107 6
    {
108
        $path = '/v2/bucketInfo?bucket=' . $bucket;
109 6
        $info = $this->ucPost($path);
110 6
        return $info;
111
    }
112
113
    /**
114
     * 获取指定zone的空间信息列表
115
     * 在Region 未指定且Global 不为 true 时(包含未指定的情况,下同),返回用户的所有空间。
116
     * 在指定了 region 参数且 global 不为 true 时,只列举非全局空间。
117
     * 在指定了global为 true 时,返回所有全局空间,忽略region 参数
118
     * shared 不指定shared参数或指定shared为rw或false时,返回包含具有读写权限空间,指定shared为rd或true时,返回包含具有读权限空间。
119
     * fs:如果为 true,会返回每个空间当前的文件数和存储量(实时数据)。
120
     *
121
     * @return string[] 包含空间信息
122 15
     */
123
    public function bucketInfos($region = null, $global = 'false', $shared = 'false', $fs = 'false')
124 15
    {
125 15
        $path = '/v2/bucketInfos?region=' . $region . '&global=' . $global . '&shared=' . $shared . '&fs=' . $fs;
126 15
        $info = $this->ucPost($path);
127
        return $info;
128
    }
129
130
    /**
131
     * 获取空间绑定的域名列表
132
     * @return string[] 包含空间绑定的所有域名
133
     */
134
135
    /**
136
     * 列取空间的文件列表
137
     *
138
     * @param $bucket     空间名
139 3
     * @param $prefix     列举前缀
140
     * @param $marker     列举标识符
141 3
     * @param $limit      单次列举个数限制
142
     * @param $delimiter  指定目录分隔符
143
     *
144
     * @return array    包含文件信息的数组,类似:[
145
     *                                              {
146
     *                                                 "hash" => "<Hash string>",
147
     *                                                  "key" => "<Key string>",
148
     *                                                  "fsize" => "<file size>",
149
     *                                                  "putTime" => "<file modify time>"
150
     *                                              },
151
     *                                              ...
152
     *                                            ]
153
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
154
     */
155 15
    public function listFiles($bucket, $prefix = null, $marker = null, $limit = 1000, $delimiter = null)
156
    {
157 15
        $query = array('bucket' => $bucket);
158 15
        \Qiniu\setWithoutEmpty($query, 'prefix', $prefix);
159 15
        \Qiniu\setWithoutEmpty($query, 'marker', $marker);
160 15
        \Qiniu\setWithoutEmpty($query, 'limit', $limit);
161 3
        \Qiniu\setWithoutEmpty($query, 'delimiter', $delimiter);
162 3
        $url = $this->getRsfHost() . '/list?' . http_build_query($query);
163 15
        return $this->get($url);
164 15
    }
165
166
    /**
167
     * 设置Referer防盗链
168
     *
169
     * @param $bucket     空间名
170
     * @param $mode     0: 表示关闭Referer(使用此选项将会忽略以下参数并将恢复默认值); 1: 表示设置Referer白名单; 2: 表示设置Referer黑名单
171
     * @param $norefer     0: 表示不允许空 Refer 访问; 1: 表示允许空 Refer 访问
172
     * @param $pattern      规则字符串, 当前允许格式分为三种: 一种为空主机头域名, 比如 foo.com; 一种是泛域名, 比如 *.bar.com; 一种是完全通配符,
173
     *          即一个 *; 多个规则之间用;隔开, 比如: foo.com;*.bar.com;sub.foo.com;*.sub.bar.com
174
     * @param $source_enabled  源站是否支持,默认为0只给CDN配置, 设置为1表示开启源站防盗链
175
     *
176
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
177
     */
178 3
    // public function referAntiLeech(){
179
180 3
    // }
181 3
182 3
    /**
183 3
     * 增加bucket生命规则
184
     *
185
     * @param $bucket     空间名
186 3
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
187 3
     * @param $prefix     同一个 bucket 里面前缀不能重复
188
     * @param $delete_after_days      指定上传文件多少天后删除,指定为0表示不删除,大于0表示多少天后删除,需大于 to_line_after_days
189
     * @param $to_line_after_days  指定文件上传多少天后转低频存储。指定为0表示不转低频存储,小于0表示上传的文件立即变低频存储
190
     *
191
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
192
     */
193
    public function bucketLifecycleRule($bucket, $name, $prefix, $delete_after_days, $to_line_after_days)
194
    {
195
        $path = '/rules/add';
196
        if ($bucket) {
197
            $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...
198
        }
199
        if ($name) {
200 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...
201
        }
202 3
        if ($prefix) {
203 3
            $params['prefix'] = $prefix;
204 3
        }
205 3
        if ($delete_after_days) {
206 3
            $params['delete_after_days'] = $delete_after_days;
207
        }
208
        if ($to_line_after_days) {
209
            $params['to_line_after_days'] = $to_line_after_days;
210
        }
211
        $data = http_build_query($params);
212
        $info = $this->ucPost($path, $data);
213
        return $info;
214
    }
215
216
    /**
217
     * 更新bucket生命规则
218
     *
219
     * @param $bucket     空间名
220
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
221
     * @param $prefix     同一个 bucket 里面前缀不能重复
222
     * @param $delete_after_days      指定上传文件多少天后删除,指定为0表示不删除,大于0表示多少天后删除,需大于 to_line_after_days
223
     * @param $to_line_after_days  指定文件上传多少天后转低频存储。指定为0表示不转低频存储,小于0表示上传的文件立即变低频存储
224
     *
225
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
226
     */
227
    public function updateBucketLifecycleRule($bucket, $name, $prefix, $delete_after_days, $to_line_after_days)
228
    {
229
        $path = '/rules/update';
230
        if ($bucket) {
231
            $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...
232
        }
233
        if ($name) {
234
            $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...
235
        }
236
        if ($prefix) {
237
            $params['prefix'] = $prefix;
238
        }
239
        if ($delete_after_days) {
240
            $params['delete_after_days'] = $delete_after_days;
241
        }
242
        if ($to_line_after_days) {
243
            $params['to_line_after_days'] = $to_line_after_days;
244
        }
245
        $data = http_build_query($params);
246
        $info = $this->ucPost($path, $data);
247
        return $info;
248
    }
249
250
    /**
251
     * 获取bucket生命规则
252
     *
253
     * @param $bucket     空间名
254
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
255
     */
256
    public function getBucketLifecycleRules($bucket)
257
    {
258
        $path = '/rules/get?bucket=' . $bucket;
259
        $info = $this->ucGet($path);
260
        return $info;
261
    }
262
263
    /**
264
     * 删除bucket生命规则
265
     *
266
     * @param $bucket     空间名
267
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
268 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
269
     */
270
    public function deleteBucketLifecycleRule($bucket, $name)
271 3
    {
272 3
        $path = '/rules/delete';
273 3
        if ($bucket) {
274
            $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...
275 3
        }
276 3
        if ($name) {
277
            $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...
278 3
        }
279 3
        $data = http_build_query($params);
280
        $info = $this->ucPost($path, $data);
281
        return $info;
282
    }
283
284
    /**
285
     * 增加bucket事件通知规则
286
     *
287
     * @param $bucket     空间名
288
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
289
     * @param $prefix     同一个 bucket 里面前缀不能重复
290
     * @param $suffix      可选,文件配置的后缀
291 3
     * @param $event  事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append,disable,enable,deleteMarkerCreate
292
     * @param $callbackURL 通知URL,可以指定多个,失败依次重试
293 3
     * @param $access_key 可选,设置的话会对通知请求用对应的ak、sk进行签名
294 3
     * @param $host 可选,通知请求的host
295
     *
296 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
297 3
     */
298
    public function putBucketEvent(
299 3
        $bucket,
300 3
        $name,
301 3
        $prefix,
302
        $suffix,
303
        $event,
304
        $callbackURL,
305
        $access_key = null,
306
        $host = null
307
    ) {
308
        $path = '/events/add';
309
        if ($bucket) {
310
            $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...
311
        }
312
        if ($name) {
313
            $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...
314
        }
315
        if ($prefix) {
316
            $params['prefix'] = $prefix;
317
        }
318
        if ($suffix) {
319
            $params['suffix'] = $suffix;
320 12
        }
321
        if ($event) {
322 12
            $params['event'] = $event;
323 12
        }
324
        if ($callbackURL) {
325
            $params['callbackURL'] = $callbackURL;
326
        }
327
        if ($access_key) {
328
            $params['access_key'] = $access_key;
329
        }
330
        if ($host) {
331
            $params['host'] = $host;
332
        }
333
        $data = http_build_query($params);
334
        $info = $this->ucPost($path, $data);
335
        return $info;
336 3
    }
337
338 3
    /**
339 3
     * 更新bucket事件通知规则
340 3
     *
341 3
     * @param $bucket     空间名
342
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
343
     * @param $prefix     同一个 bucket 里面前缀不能重复
344 3
     * @param $suffix      可选,文件配置的后缀
345
     * @param $event  事件类型,可以指定多个,包括 put,mkfile,delete,copy,move,append,disable,enable,deleteMarkerCreate
346 3
     * @param $callbackURL 通知URL,可以指定多个,失败依次重试
347 3
     * @param $access_key 可选,设置的话会对通知请求用对应的ak、sk进行签名
348
     * @param $host 可选,通知请求的host
349
     *
350 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
351
     */
352
    public function updateBucketEvent(
353 33
        $bucket,
354
        $name,
355 33
        $prefix,
356 33
        $suffix,
357
        $event,
358
        $callbackURL,
359 33
        $access_key = null,
360
        $host = null
361
    ) {
362
        $path = '/events/update';
363
        if ($bucket) {
364
            $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...
365
        }
366
        if ($name) {
367
            $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...
368
        }
369
        if ($prefix) {
370
            $params['prefix'] = $prefix;
371 27
        }
372
        if ($suffix) {
373 27
            $params['suffix'] = $suffix;
374 27
        }
375
        if ($event) {
376
            $params['event'] = $event;
377
        }
378
        if ($callbackURL) {
379
            $params['callbackURL'] = $callbackURL;
380
        }
381
        if ($access_key) {
382
            $params['access_key'] = $access_key;
383 9
        }
384
        if ($host) {
385 9
            $params['host'] = $host;
386 9
        }
387
        $data = http_build_query($params);
388
        $info = $this->ucPost($path, $data);
389 12
        return $info;
390
    }
391 12
392 12
    /**
393 12
     * 获取bucket事件通知规则
394 8
     *
395
     * @param $bucket     空间名
396 8
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
397
     */
398
    public function getBucketEvents($bucket)
399 33
    {
400
        $path = '/events/get?bucket=' . $bucket;
401 33
        $info = $this->ucGet($path);
402 33
        return $info;
403 33
    }
404 9
405
    /**
406 30
     * 删除bucket事件通知规则
407 30
     *
408
     * @param $bucket     空间名
409
     * @param $name     规则名称 bucket 内唯一,长度小于50,不能为空,只能为字母、数字、下划线
410 3
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
411
     */
412 3
    public function deleteBucketEvent($bucket, $name)
413
    {
414
        $path = '/events/delete';
415
        if ($bucket) {
416 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...
417
        }
418 3
        if ($name) {
419
            $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...
420
        }
421
        $data = http_build_query($params);
422 6
        $info = $this->ucPost($path, $data);
423
        return $info;
424 6
    }
425
426
    /**
427
     * 设置bucket的跨域信息,最多允许设置10条跨域规则。
428 3
     * 对于同一个域名如果设置了多条规则,那么按顺序使用第一条匹配的规则去生成返回值。
429
     * 对于简单跨域请求,只匹配 Origin;
430 3
     * 对于预检请求, 需要匹配 Origin、AllowedMethod、AllowedHeader;
431
     * allowed_orgin: 允许的域名。必填;支持通配符*;*表示全部匹配;只有第一个*生效;需要设置"Scheme";大小写敏感。例如
432
     * 规则:http://*.abc.*.com 请求:"http://test.abc.test.com" 结果:不通过
433
     * 规则:"http://abc.com" 请求:"https://abc.com"/"abc.com" 结果:不通过
434 3
     * 规则:"abc.com" 请求:"http://abc.com" 结果:不通过
435
     * allowed_method: 允许的方法。必填;不支持通配符;大小写不敏感;
436 3
     * allowed_header: 允许的header。选填;支持通配符*,但只能是单独的*,表示允许全部header,其他*不生效;空则不允许任何header;大小写不敏感;
437
     * exposed_header: 暴露的header。选填;不支持通配符;X-Log, X-Reqid是默认会暴露的两个header;其他的header如果没有设置,则不会暴露;大小写不敏感;
438
     * max_age: 结果可以缓存的时间。选填;空则不缓存;
439
     * allowed_credentials:该配置不支持设置,默认为true。
440
     * 备注:如果没有设置任何corsRules,那么默认允许所有的跨域请求
441
     */
442
    public function putCorsRules($bucket, $params)
443
    {
444
        $path = '/corsRules/set/' . $bucket;
445
        $data = json_encode($params);
446
        $info = $this->ucPost($path, $data);
447
        return $info;
448
    }
449
450
    /**
451
     * 获取bucket的跨域信息
452
     * $bucket 空间名
453
     */
454
    public function getCorsRules($bucket)
455
    {
456
        $path = '/corsRules/get/' . $bucket;
457
        $info = $this->ucGet($path);
458
        return $info;
459
    }
460
461
    /**
462
     * 设置回源规则
463
     * 使用该API设置源站优先级高于/image设置的源站,即IO优先读取source接口设置的源站配置,如果存在会忽略/image设置的源站
464
     * Bucket 空间名
465
     * Host(可选)回源Host
466 6
     * RetryCodes(可选),镜像回源时源站返回Code可以重试,最多指定3个,当前只支持4xx错误码重试
467
     * SourceQiniuAK,SourceQiniuSK(可选)如果存在将在回源时对URL进行签名,客户源站可以验证以保证请求来自Qiniu服务器
468 6
     * Expires(可选) 签名过期时间,如果不设置默认为1小时
469 6
     * Addr 回源地址,不可重复。
470 6
     * Weight 权重,范围限制1-100,不填默认为1,回源时会根据所有源的权重值进行源站选择,主备源会分开计算.
471 6
     * Backup 是否备用回源,回源优先尝试主源
472 6
     */
473
    public function putBucktSourceConfig($params)
474
    {
475 9
        $path = '/mirrorConfig/set';
476
        $data = json_encode($params);
477 9
        $info = $this->ucPostV2($path, $data);
478
        return $info;
479
    }
480 9
481 9
    /**
482 9
     * 获取空间回源配置
483 9
     */
484 9
    public function getBucktSourceConfig($params)
485 9
    {
486 9
        $path = '/mirrorConfig/get';
487 9
        $data = json_encode($params);
488 9
        $info = $this->ucPostV2($path, $data);
489 9
        return $info;
490 9
    }
491
492
    /**
493
     * 开关原图保护
494
     * mode 为1表示开启原图保护,0表示关闭
495
     */
496
    public function putBucketAccessStyleMode($bucket, $mode)
497
    {
498
        $path = '/accessMode/' . $bucket . '/mode/' . $mode;
499
        $info = $this->ucPost($path, null);
500
        return $info;
501
    }
502
503
    /**
504
     * 设置Bucket的maxAge
505
     * maxAge为0或者负数表示为默认值(31536000)
506
     */
507
    public function putBucketMaxAge($bucket, $maxAge)
508
    {
509
        $path = '/maxAge?bucket=' . $bucket . '&maxAge=' . $maxAge;
510
        $info = $this->ucPost($path, null);
511
        return $info;
512
    }
513
514
    /**
515
     * 设置配额
516
     * <bucket>: 空间名称,不支持授权空间
517
     * <size>: 空间存储量配额,参数传入0或不传表示不更改当前配置,传入-1表示取消限额,新创建的空间默认没有限额。
518
     * <count>: 空间文件数配额,参数含义同<size>
519
     */
520
    public function putBucketQuota($bucket, $size, $count)
521
    {
522
        $path = '/setbucketquota/' . $bucket . '/size/' . $size . '/count/' . $count;
523
        $info = $this->apiPost($path, null);
524
        return $info;
525
    }
526
527
    /**
528
     * 获取配额
529
     * bucket 空间名称
530
     */
531
    public function getBucketQuota($bucket)
532
    {
533
        $path = '/getbucketquota/' . $bucket;
534
        $info = $this->apiPost($path, null);
535
        return $info;
536
    }
537
538
    /**
539
     * 获取资源的元信息,但不返回文件内容
540
     *
541
     * @param $bucket     待获取信息资源所在的空间
542
     * @param $key        待获取资源的文件名
543
     *
544
     * @return array    包含文件信息的数组,类似:
545
     *                                              [
546
     *                                                  "hash" => "<Hash string>",
547
     *                                                  "key" => "<Key string>",
548
     *                                                  "fsize" => <file size>,
549
     *                                                  "putTime" => "<file modify time>"
550
     *                                                  "fileType" => <file type>
551
     *                                              ]
552
     *
553
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/stat.html
554
     */
555
    public function stat($bucket, $key)
556
    {
557
        $path = '/stat/' . \Qiniu\entry($bucket, $key);
558
        return $this->rsGet($path);
559
    }
560
561
    /**
562
     * 删除指定资源
563
     *
564
     * @param $bucket     待删除资源所在的空间
565
     * @param $key        待删除资源的文件名
566
     *
567
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
568
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
569
     */
570
    public function delete($bucket, $key)
571
    {
572
        $path = '/delete/' . \Qiniu\entry($bucket, $key);
573
        list(, $error) = $this->rsPost($path);
574
        return $error;
575
    }
576
577
578
    /**
579
     * 给资源进行重命名,本质为move操作。
580
     *
581
     * @param $bucket     待操作资源所在空间
582
     * @param $oldname    待操作资源文件名
583
     * @param $newname    目标资源文件名
584
     *
585
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
586
     */
587
    public function rename($bucket, $oldname, $newname)
588
    {
589
        return $this->move($bucket, $oldname, $bucket, $newname);
590
    }
591
592
    /**
593
     * 对资源进行复制。
594
     *
595
     * @param $from_bucket     待操作资源所在空间
596
     * @param $from_key        待操作资源文件名
597
     * @param $to_bucket       目标资源空间名
598
     * @param $to_key          目标资源文件名
599
     *
600
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
601
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
602
     */
603
    public function copy($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
604
    {
605
        $from = \Qiniu\entry($from_bucket, $from_key);
606
        $to = \Qiniu\entry($to_bucket, $to_key);
607
        $path = '/copy/' . $from . '/' . $to;
608
        if ($force === true) {
609
            $path .= '/force/true';
610
        }
611
        list(, $error) = $this->rsPost($path);
612
        return $error;
613
    }
614
615
    /**
616
     * 将资源从一个空间到另一个空间
617
     *
618
     * @param $from_bucket     待操作资源所在空间
619
     * @param $from_key        待操作资源文件名
620
     * @param $to_bucket       目标资源空间名
621
     * @param $to_key          目标资源文件名
622
     *
623
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
624
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
625
     */
626
    public function move($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
627
    {
628
        $from = \Qiniu\entry($from_bucket, $from_key);
629
        $to = \Qiniu\entry($to_bucket, $to_key);
630
        $path = '/move/' . $from . '/' . $to;
631
        if ($force) {
632
            $path .= '/force/true';
633
        }
634
        list(, $error) = $this->rsPost($path);
635
        return $error;
636
    }
637
638
    /**
639
     * 主动修改指定资源的文件元信息
640
     *
641
     * @param $bucket     待操作资源所在空间
642
     * @param $key        待操作资源文件名
643
     * @param $mime       待操作文件目标mimeType
644
     *
645
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
646
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
647
     */
648
    public function changeMime($bucket, $key, $mime)
649
    {
650
        $resource = \Qiniu\entry($bucket, $key);
651
        $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
652
        $path = '/chgm/' . $resource . '/mime/' . $encode_mime;
653
        list(, $error) = $this->rsPost($path);
654
        return $error;
655
    }
656
657
658
    /**
659
     * 修改指定资源的存储类型
660
     *
661
     * @param $bucket     待操作资源所在空间
662
     * @param $key        待操作资源文件名
663
     * @param $fileType       待操作文件目标文件类型
664
     *
665
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
666
     * @link  https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
667
     */
668
    public function changeType($bucket, $key, $fileType)
669
    {
670
        $resource = \Qiniu\entry($bucket, $key);
671
        $path = '/chtype/' . $resource . '/type/' . $fileType;
672
        list(, $error) = $this->rsPost($path);
673
        return $error;
674
    }
675
676
    /**
677
     * 修改文件的存储状态,即禁用状态和启用状态间的的互相转换
678
     *
679
     * @param $bucket     待操作资源所在空间
680
     * @param $key        待操作资源文件名
681
     * @param $status       待操作文件目标文件类型
682
     *
683
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
684
     * @link  https://developer.qiniu.com/kodo/api/4173/modify-the-file-status
685
     */
686
    public function changeStatus($bucket, $key, $status)
687
    {
688
        $resource = \Qiniu\entry($bucket, $key);
689
        $path = '/chstatus/' . $resource . '/status/' . $status;
690
        list(, $error) = $this->rsPost($path);
691
        return $error;
692
    }
693
694
    /**
695
     * 从指定URL抓取资源,并将该资源存储到指定空间中
696
     *
697
     * @param $url        指定的URL
698
     * @param $bucket     目标资源空间
699
     * @param $key        目标资源文件名
700
     *
701
     * @return array    包含已拉取的文件信息。
702
     *                         成功时:  [
703
     *                                          [
704
     *                                              "hash" => "<Hash string>",
705
     *                                              "key" => "<Key string>"
706
     *                                          ],
707
     *                                          null
708
     *                                  ]
709
     *
710
     *                         失败时:  [
711
     *                                          null,
712
     *                                         Qiniu/Http/Error
713
     *                                  ]
714
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
715
     */
716
    public function fetch($url, $bucket, $key = null)
717
    {
718
719
        $resource = \Qiniu\base64_urlSafeEncode($url);
720
        $to = \Qiniu\entry($bucket, $key);
721
        $path = '/fetch/' . $resource . '/to/' . $to;
722
723
        $ak = $this->auth->getAccessKey();
724
        $ioHost = $this->config->getIovipHost($ak, $bucket);
725
726
        $url = $ioHost . $path;
727
        return $this->post($url, null);
728
    }
729
730
    /**
731
     * 从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源
732
     *
733
     * @param $bucket     待获取资源所在的空间
734
     * @param $key        代获取资源文件名
735
     *
736
     * @return mixed      成功返回NULL,失败返回对象Qiniu\Http\Error
737
     * @link  http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
738
     */
739
    public function prefetch($bucket, $key)
740
    {
741
        $resource = \Qiniu\entry($bucket, $key);
742
        $path = '/prefetch/' . $resource;
743
744
        $ak = $this->auth->getAccessKey();
745
        $ioHost = $this->config->getIovipHost($ak, $bucket);
746
747
        $url = $ioHost . $path;
748
        list(, $error) = $this->post($url, null);
749
        return $error;
750
    }
751
752
    /**
753
     * 在单次请求中进行多个资源管理操作
754
     *
755
     * @param $operations     资源管理操作数组
756
     *
757
     * @return array 每个资源的处理情况,结果类似:
758
     *              [
759
     *                   { "code" => <HttpCode int>, "data" => <Data> },
760
     *                   { "code" => <HttpCode int> },
761
     *                   { "code" => <HttpCode int> },
762
     *                   { "code" => <HttpCode int> },
763
     *                   { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } },
764
     *                   ...
765
     *               ]
766
     * @link http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
767
     */
768
    public function batch($operations)
769
    {
770
        $params = 'op=' . implode('&op=', $operations);
771
        return $this->rsPost('/batch', $params);
772
    }
773
774
    /**
775
     * 设置文件的生命周期
776
     *
777
     * @param $bucket 设置文件生命周期文件所在的空间
778
     * @param $key    设置文件生命周期文件的文件名
779
     * @param $days   设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期
780
     *
781
     * @return Mixed
782
     * @link https://developer.qiniu.com/kodo/api/update-file-lifecycle
783
     */
784
    public function deleteAfterDays($bucket, $key, $days)
785
    {
786
        $entry = \Qiniu\entry($bucket, $key);
787
        $path = "/deleteAfterDays/$entry/$days";
788
        list(, $error) = $this->rsPost($path);
789
        return $error;
790
    }
791
792
    private function getRsfHost()
793
    {
794
        $scheme = "http://";
795
        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...
796
            $scheme = "https://";
797
        }
798
        return $scheme . Config::RSF_HOST;
799
    }
800
801
    private function getRsHost()
802
    {
803
        $scheme = "http://";
804
        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...
805
            $scheme = "https://";
806
        }
807
        return $scheme . Config::RS_HOST;
808
    }
809
810
    private function getApiHost()
811
    {
812
        $scheme = "http://";
813
        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...
814
            $scheme = "https://";
815
        }
816
        return $scheme . Config::API_HOST;
817
    }
818
819
    private function getUcHost()
820
    {
821
        $scheme = "http://";
822
        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...
823
            $scheme = "https://";
824
        }
825
        return $scheme . Config::UC_HOST;
826
    }
827
828
    private function rsPost($path, $body = null)
829
    {
830
        $url = $this->getRsHost() . $path;
831
        return $this->post($url, $body);
832
    }
833
834
    private function apiPost($path, $body = null)
835
    {
836
        $url = $this->getApiHost() . $path;
837
        return $this->post($url, $body);
838
    }
839
840
    private function ucPost($path, $body = null)
841
    {
842
        $url = $this->getUcHost() . $path;
843
        return $this->post($url, $body);
844
    }
845
846
    private function ucGet($path)
847
    {
848
        $url = $this->getUcHost() . $path;
849
        return $this->get($url);
850
    }
851
852
    private function apiGet($path)
853
    {
854
        $url = $this->getApiHost() . $path;
855
        return $this->get($url);
856
    }
857
858
    private function rsGet($path)
859
    {
860
        $url = $this->getRsHost() . $path;
861
        return $this->get($url);
862
    }
863
864
    private function get($url)
865
    {
866
        $headers = $this->auth->authorization($url);
867
        $ret = Client::get($url, $headers);
868
        if (!$ret->ok()) {
869
            return array(null, new Error($url, $ret));
870
        }
871
        return array($ret->json(), null);
872
    }
873
874
    private function post($url, $body)
875
    {
876
        $headers = $this->auth->authorization($url, $body, 'application/x-www-form-urlencoded');
877
        $ret = Client::post($url, $body, $headers);
878
        if (!$ret->ok()) {
879
            return array(null, new Error($url, $ret));
880
        }
881
        $r = ($ret->body === null) ? array() : $ret->json();
882
        return array($r, null);
883
    }
884
885
    private function ucPostV2($path, $body)
886
    {
887
        $url = $this->getUcHost() . $path;
888
        return $this->postV2($url, $body);
889
    }
890
891
    private function postV2($url, $body)
892
    {
893
        $headers = $this->auth->authorizationV2($url, 'POST', $body, 'application/json');
894
        $headers["Content-Type"] = 'application/json';
895
        $ret = Client::post($url, $body, $headers);
896
        if (!$ret->ok()) {
897
            return array(null, new Error($url, $ret));
898
        }
899
        $r = ($ret->body === null) ? array() : $ret->json();
900
        return array($r, null);
901
    }
902
903
    public static function buildBatchCopy($source_bucket, $key_pairs, $target_bucket, $force)
904
    {
905
        return self::twoKeyBatch('/copy', $source_bucket, $key_pairs, $target_bucket, $force);
906
    }
907
908
909
    public static function buildBatchRename($bucket, $key_pairs, $force)
910
    {
911
        return self::buildBatchMove($bucket, $key_pairs, $bucket, $force);
912
    }
913
914
915
    public static function buildBatchMove($source_bucket, $key_pairs, $target_bucket, $force)
916
    {
917
        return self::twoKeyBatch('/move', $source_bucket, $key_pairs, $target_bucket, $force);
918
    }
919
920
921
    public static function buildBatchDelete($bucket, $keys)
922
    {
923
        return self::oneKeyBatch('/delete', $bucket, $keys);
924
    }
925
926
927
    public static function buildBatchStat($bucket, $keys)
928
    {
929
        return self::oneKeyBatch('/stat', $bucket, $keys);
930
    }
931
932
    public static function buildBatchDeleteAfterDays($bucket, $key_day_pairs)
933
    {
934
        $data = array();
935
        foreach ($key_day_pairs as $key => $day) {
936
            array_push($data, '/deleteAfterDays/' . \Qiniu\entry($bucket, $key) . '/' . $day);
937
        }
938
        return $data;
939
    }
940
941
    public static function buildBatchChangeMime($bucket, $key_mime_pairs)
942
    {
943
        $data = array();
944
        foreach ($key_mime_pairs as $key => $mime) {
945
            array_push($data, '/chgm/' . \Qiniu\entry($bucket, $key) . '/mime/' . base64_encode($mime));
946
        }
947
        return $data;
948
    }
949
950
    public static function buildBatchChangeType($bucket, $key_type_pairs)
951
    {
952
        $data = array();
953
        foreach ($key_type_pairs as $key => $type) {
954
            array_push($data, '/chtype/' . \Qiniu\entry($bucket, $key) . '/type/' . $type);
955
        }
956
        return $data;
957
    }
958
959
    private static function oneKeyBatch($operation, $bucket, $keys)
960
    {
961
        $data = array();
962
        foreach ($keys as $key) {
963
            array_push($data, $operation . '/' . \Qiniu\entry($bucket, $key));
964
        }
965
        return $data;
966
    }
967
968
    private static function twoKeyBatch($operation, $source_bucket, $key_pairs, $target_bucket, $force)
969
    {
970
        if ($target_bucket === null) {
971
            $target_bucket = $source_bucket;
972
        }
973
        $data = array();
974
        $forceOp = "false";
975
        if ($force) {
976
            $forceOp = "true";
977
        }
978
        foreach ($key_pairs as $from_key => $to_key) {
979
            $from = \Qiniu\entry($source_bucket, $from_key);
980
            $to = \Qiniu\entry($target_bucket, $to_key);
981
            array_push($data, $operation . '/' . $from . '/' . $to . "/force/" . $forceOp);
982
        }
983
        return $data;
984
    }
985
}
986