1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* 又拍云 PHP-SDK |
4
|
|
|
*/ |
5
|
|
|
namespace Upyun; |
6
|
|
|
|
7
|
|
|
use Upyun\Api\Rest; |
8
|
|
|
|
9
|
|
|
use GuzzleHttp\Client; |
10
|
|
|
use GuzzleHttp\Psr7; |
11
|
|
|
use GuzzleHttp; |
12
|
|
|
|
13
|
|
|
/** |
14
|
|
|
* Class Upyun |
15
|
|
|
* |
16
|
|
|
* 又拍云云存储、云处理接口 |
17
|
|
|
* |
18
|
|
|
* Upyun 类实现了又拍云云存储和云处理的所有接口,通过该类可以实现文件上传、下载;图片视频等多媒体资源云处理。 |
19
|
|
|
* 本文档中,提到的"服务"是指又拍云文件加速回又拍云源类型的服务(即原先的存储类空间)。 |
20
|
|
|
* |
21
|
|
|
* @package Upyun |
22
|
|
|
*/ |
23
|
|
|
class Upyun { |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* @var Config: 服务配置 |
27
|
|
|
*/ |
28
|
|
|
protected $config; |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Upyun constructor. |
32
|
|
|
* |
33
|
|
|
* @param Config $config 服务配置 |
34
|
|
|
*/ |
35
|
|
|
public function __construct(Config $config) { |
36
|
|
|
$this->setConfig($config); |
37
|
|
|
} |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* 更新服务配置 |
41
|
|
|
* |
42
|
|
|
* 当需要操作的新的服务时,使用该方法传入新的服务配置即可 |
43
|
|
|
* |
44
|
|
|
* @param Config $config 服务配置 |
45
|
|
|
* |
46
|
|
|
* @return $this |
47
|
|
|
*/ |
48
|
|
|
public function setConfig(Config $config) { |
49
|
|
|
$this->config = $config; |
50
|
|
|
return $this; |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* 上传一个文件到又拍云存储 |
55
|
|
|
* |
56
|
|
|
* 上传的文件格式支持文件流或者字符串方式上传。除简单的文件上传外,针对多媒体资源(图片、音视频),还可以设置同步/异步预处理多媒体资源,例如:图片的裁剪缩放,音视频的转码截图等等众多又拍云强大的云处理功能 |
57
|
|
|
* |
58
|
|
|
* @param string $path 被上传的文件在又拍云存储服务中保存的路径 |
59
|
|
|
* @param string|resource $content 被上传的文件内容(字符串),或者打开该文件获得的文件句柄(文件流)。当上传本地大文件时,推荐使用文件流的方式上传 |
60
|
|
|
* @param array $params 上传文件时,附加的自定义参数。支持 Content-MD5 Content-Type Content-Secret 等,详见 [上传参数](http://docs.upyun |
61
|
|
|
* .com/api/rest_api/#_2),例如: |
62
|
|
|
* - 设置文件[保护秘钥](http://docs.upyun.com/api/rest_api/#Content-Secret) `write($path, $content, array('Content-Secret' => 'my-secret'))`; |
63
|
|
|
* - 添加[文件元信息](http://docs.upyun.com/api/rest_api/#metadata) `write($path, $content, array('X-Upyun-Meta-Foo' => |
64
|
|
|
* 'bar'))` |
65
|
|
|
* - [图片同步预处理](http://docs.upyun.com/cloud/image/#_5) `write($path, $content, array('x-gmkerl-thumb' => '/format/png'))` |
66
|
|
|
* @param bool $withAsyncProcess 默认为 `false`,当上传图片或者音视频资源时,可以设置该参数为 `true`,开启图片音视频的[异步处理功能](http://docs.upyun.com/api/form_api/#_6) ,例如: |
67
|
|
|
*``` |
68
|
|
|
* // 以下参数会将新上传的图片,再异步生成另一份 png 格式的图片,原图不受影响 |
69
|
|
|
* write($path, $content, array( |
70
|
|
|
* 'apps' => array( |
71
|
|
|
* array( |
72
|
|
|
* 'name' => 'thumb', //异步图片处理任务 |
73
|
|
|
* 'x-gmkerl-thumb' => '/format/png', // 格式化图片为 png 格式 |
74
|
|
|
* 'save_as': '/iamge/png/new.png', // 处理成功后的图片保存路径 |
75
|
|
|
* 'notify_url': 'http://your.notify.url' // 异步任务完成后的回调地址 |
76
|
|
|
* ) |
77
|
|
|
* ) |
78
|
|
|
* ), true); |
79
|
|
|
*``` |
80
|
|
|
* |
81
|
|
|
* |
82
|
|
|
* |
83
|
|
|
* @return array|bool 若文件是图片则返回图片基本信息,如:`array('x-upyun-width' => 123, 'x-upyun-height' => 50, 'x-upyun-frames' |
84
|
|
|
* => 1, 'x-upyun-file-type' => 'JPEG')`,否则返回空数组。当使用异步预处理功能时,返回结果为布尔值,成功为 `true`。 |
85
|
|
|
* |
86
|
|
|
* @throws \Exception 上传失败时,抛出异常 |
87
|
|
|
*/ |
88
|
|
|
public function write($path, $content, $params = array(), $withAsyncProcess = false) { |
89
|
|
|
if(!$content) { |
|
|
|
|
90
|
|
|
throw new \Exception('write content can not be empty.'); |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
$upload = new Uploader($this->config); |
94
|
|
|
$response = $upload->upload($path, $content, $params, $withAsyncProcess); |
95
|
|
|
if ($withAsyncProcess) { |
96
|
|
|
return $response; |
97
|
|
|
} |
98
|
|
|
return Util::getHeaderParams($response->getHeaders()); |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* 读取云存储文件/目录内容 |
103
|
|
|
* |
104
|
|
|
* @param string $path 又拍云存储中的文件或者目录路径 |
105
|
|
|
* @param resource $saveHandler 文件内容写入本地文件流。例如 `$saveHandler = fopen('/local/file', 'w') |
106
|
|
|
* `。当设置该参数时,将以文件流的方式,直接将又拍云中的文件写入本地的文件流,或其他可以写入的流 |
107
|
|
|
* @param array $params 可选参数,读取目录内容时,需要设置三个参数: `X-List-Iter` 分页开始位置(第一页不需要设置),`X-List-Limit` 获取的文件数量(默认 100,最大 |
108
|
|
|
* 10000),`X-List-Order` 结果以时间正序或者倒序 |
109
|
|
|
* |
110
|
|
|
* @return mixed $return 当读取文件且没有设置 `$saveHandler` 参数时,返回一个字符串类型,表示文件内容;设置了 `$saveHandler` 参数时,返回布尔值 |
111
|
|
|
* `true`。当读取目录时,返回一个数组,表示目录下的文件列表。目录下文件内容过多时,需要通过判断返回数组中的 `is_end` 属性,进行分页读取内容 |
112
|
|
|
* |
113
|
|
|
* @throws \Exception |
114
|
|
|
*/ |
115
|
|
|
public function read($path, $saveHandler = NULL, $params = array()) { |
|
|
|
|
116
|
|
|
$req = new Rest($this->config); |
117
|
|
|
$response = $req->request('GET', $path) |
118
|
|
|
->withHeaders($params) |
119
|
|
|
->send(); |
120
|
|
|
|
121
|
|
|
|
122
|
|
|
$params = Util::getHeaderParams($response->getHeaders()); |
123
|
|
|
|
124
|
|
|
|
125
|
|
|
if(! isset($params['x-upyun-list-iter'])) { |
|
|
|
|
126
|
|
|
if(is_resource($saveHandler)) { |
|
|
|
|
127
|
|
|
Psr7\copy_to_stream($response->getBody(), Psr7\stream_for($saveHandler)); |
128
|
|
|
return true; |
129
|
|
|
} else { |
130
|
|
|
return $response->getBody()->getContents(); |
131
|
|
|
} |
132
|
|
|
} else { |
133
|
|
|
$files = Util::parseDir($response->getBody()); |
134
|
|
|
return array('files' => $files, 'is_end' => $params['x-upyun-list-iter'] === 'g2gCZAAEbmV4dGQAA2VvZg', 'iter' => $params['x-upyun-list-iter']); |
135
|
|
|
} |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* 判断文件是否存在于又拍云存储 |
140
|
|
|
* |
141
|
|
|
* 注意: 对刚删除的文件, 立即调用该方法可能会返回 true, 因为服务端执行删除操作后可能会有很短暂的延迟. |
142
|
|
|
* |
143
|
|
|
* @param string $path 云存储的文件路径 |
144
|
|
|
* |
145
|
|
|
* @return bool 存在时返回 `true`,否则返回 `false` |
146
|
|
|
* @throws \Exception |
147
|
|
|
*/ |
148
|
|
|
public function has($path) { |
149
|
|
|
$req = new Rest($this->config); |
150
|
|
|
try { |
151
|
|
|
$req->request('HEAD', $path) |
152
|
|
|
->send(); |
153
|
|
|
} catch(GuzzleHttp\Exception\BadResponseException $e) { |
|
|
|
|
154
|
|
|
$statusCode = $e->getResponse()->getStatusCode(); |
155
|
|
|
if($statusCode === 404) { |
|
|
|
|
156
|
|
|
return false; |
157
|
|
|
} else { |
158
|
|
|
throw $e; |
159
|
|
|
} |
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
return true; |
163
|
|
|
} |
164
|
|
|
|
165
|
|
|
/** |
166
|
|
|
* 获取云存储文件/目录的基本信息 |
167
|
|
|
* |
168
|
|
|
* @param string $path 云存储的文件路径 |
169
|
|
|
* |
170
|
|
|
* @return array 返回一个数组,包含以下 key |
171
|
|
|
* - `x-upyun-file-type` 当 $path 是目录时,值为 *folder*,当 $path 是文件时,值为 *file*, |
172
|
|
|
* - `x-upyun-file-size` 文件大小 |
173
|
|
|
* - `x-upyun-file-date` 文件的创建时间 |
174
|
|
|
*/ |
175
|
|
|
public function info($path) { |
176
|
|
|
$req = new Rest($this->config); |
177
|
|
|
$response = $req->request('HEAD', $path) |
178
|
|
|
->send(); |
179
|
|
|
return Util::getHeaderParams($response->getHeaders()); |
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
/** |
183
|
|
|
* 删除文件或者目录 |
184
|
|
|
* |
185
|
|
|
* @param string $path 文件或目录在又拍云存储的路径 |
186
|
|
|
* @param bool $async 是否异步删除,默认为 false,表示同步删除。当需要批量删除大量文件时,必须选择异步删除 |
187
|
|
|
* |
188
|
|
|
* @return bool 删除成功返回 true,否则 false |
189
|
|
|
* @throws \Exception 删除不存在的文件将会抛出异常 |
190
|
|
|
*/ |
191
|
|
|
public function delete($path, $async = false) { |
192
|
|
|
$req = new Rest($this->config); |
193
|
|
|
$req->request('DELETE', $path); |
194
|
|
|
if($async) { |
|
|
|
|
195
|
|
|
$req->withHeader('x-upyun-async', 'true'); |
196
|
|
|
} |
197
|
|
|
$res = $req->send(); |
198
|
|
|
return $res->getStatusCode() === 200; |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
/** |
202
|
|
|
* 创建目录 |
203
|
|
|
* |
204
|
|
|
* @param string $path 需要在又拍云存储创建的目录路径 |
205
|
|
|
* |
206
|
|
|
* @return bool 创建成功返回 true,否则返回 false |
207
|
|
|
* @throws \Exception |
208
|
|
|
*/ |
209
|
|
View Code Duplication |
public function createDir($path) { |
|
|
|
|
210
|
|
|
$path = rtrim($path, '/') . '/'; |
211
|
|
|
$req = new Rest($this->config); |
212
|
|
|
$res = $req->request('POST', $path) |
213
|
|
|
->withHeader('folder', 'true') |
214
|
|
|
->send(); |
215
|
|
|
return $res->getStatusCode() === 200; |
216
|
|
|
} |
217
|
|
|
|
218
|
|
|
/** |
219
|
|
|
* 删除文件或者目录 |
220
|
|
|
* |
221
|
|
|
* @param string $path 需要被删除的云存储文件或目录路径 |
222
|
|
|
* |
223
|
|
|
* @return bool 成功返回 true,否则 false |
224
|
|
|
* @throws \Exception |
225
|
|
|
*/ |
226
|
|
|
public function deleteDir($path) { |
227
|
|
|
return $this->delete($path); |
228
|
|
|
} |
229
|
|
|
|
230
|
|
|
/** |
231
|
|
|
* 获取目录下存储使用量 |
232
|
|
|
* |
233
|
|
|
* @param string $path 云存储目录路径,默认为根目录,表示整个云存储服务使用的空间大小 |
234
|
|
|
* @return string 存储使用量,单位字节 |
235
|
|
|
* @throws \Exception |
236
|
|
|
*/ |
237
|
|
View Code Duplication |
public function usage($path = '/') { |
|
|
|
|
238
|
|
|
|
239
|
|
|
$path = rtrim($path, '/') . '/'; |
240
|
|
|
$req = new Rest($this->config); |
241
|
|
|
$response = $req->request('GET', $path . '?usage') |
242
|
|
|
->withHeader('folder', 'true') |
243
|
|
|
->send(); |
244
|
|
|
|
245
|
|
|
return $response->getBody()->getContents(); |
246
|
|
|
} |
247
|
|
|
|
248
|
|
|
/** |
249
|
|
|
* 刷新缓存 |
250
|
|
|
* |
251
|
|
|
* @param array|string $urls 需要刷新的文件 url 列表 |
252
|
|
|
* |
253
|
|
|
* @return array 刷新失败的 url 列表,若全部刷新成功则为空数组 |
254
|
|
|
*/ |
255
|
|
|
public function purge($urls) { |
256
|
|
|
$urlString = $urls; |
257
|
|
|
if(is_array($urls)) { |
|
|
|
|
258
|
|
|
$urlString = implode("\n", $urls); |
259
|
|
|
} |
260
|
|
|
|
261
|
|
|
$client = new Client([ |
262
|
|
|
'timeout' => $this->config->timeout |
263
|
|
|
]); |
264
|
|
|
$response = $client->request('POST', Config::ED_PURGE, [ |
265
|
|
|
'headers' => Signature::getPurgeSignHeader($this->config, $urlString), |
266
|
|
|
'form_params' => ['purge' => $urlString] |
267
|
|
|
]); |
268
|
|
|
$result = json_decode($response->getBody()->getContents(), true); |
269
|
|
|
return $result['invalid_domain_of_url']; |
270
|
|
|
} |
271
|
|
|
|
272
|
|
|
/** |
273
|
|
|
* 异步云处理 |
274
|
|
|
* |
275
|
|
|
* 该方法是基于[又拍云云处理](http://docs.upyun.com/cloud/) 服务实现,可以实现音视频的转码、切片、剪辑;文件的压缩解压缩;文件拉取功能 |
276
|
|
|
* 所有需要调用该方法处理的资源,必须已经上传到云存储服务,未上传到云存储的文件,同时需要云处理功能,请使用 `write` 方法。 |
277
|
|
|
* 例如视频转码: |
278
|
|
|
* ``` |
279
|
|
|
* process($source, array( |
280
|
|
|
* array( |
281
|
|
|
* 'type' => 'video', // video 表示视频任务, audio 表示音频任务 |
282
|
|
|
* 'avopts' => '/s/240p(4:3)/as/1/r/30', // 处理参数,`s` 表示输出的分辨率,`r` 表示视频帧率,`as` 表示是否自动调整分辨率 |
283
|
|
|
* 'save_as' => '/video/240/new.mp4', // 新视频在又拍云存储的保存路径 |
284
|
|
|
* ), |
285
|
|
|
* ... // 同时还可以添加其他任务 |
286
|
|
|
* )) |
287
|
|
|
* ``` |
288
|
|
|
* 注意,被处理的资源需要已经上传到又拍云云存储 |
289
|
|
|
* |
290
|
|
|
* @param string $source 需要预处理的图片、音视频资源在又拍云存储的路径 |
291
|
|
|
* @param array $tasks 需要处理的任务 |
292
|
|
|
* |
293
|
|
|
* @return array 任务 ID,提交了多少任务,便会返回多少任务 ID,与提交任务的顺序保持一致。可以通过任务 ID 查询处理进度。格式如下: |
294
|
|
|
* ``` |
295
|
|
|
* array( |
296
|
|
|
* '35f0148d414a688a275bf915ba7cebb2', |
297
|
|
|
* '98adbaa52b2f63d6d7f327a0ff223348', |
298
|
|
|
* ) |
299
|
|
|
* ``` |
300
|
|
|
*/ |
301
|
|
|
public function process($source, $tasks) { |
302
|
|
|
$video = new Api\Pretreat($this->config); |
303
|
|
|
return $video->process($source, $tasks); |
304
|
|
|
} |
305
|
|
|
|
306
|
|
|
/** |
307
|
|
|
* 音视频预处理任务进度查询 |
308
|
|
|
* |
309
|
|
|
* 根据 `process` 方法返回的任务 ID,通过该访问查询处理进度 |
310
|
|
|
* |
311
|
|
|
* @param array $taskIds 任务 ID |
312
|
|
|
* |
313
|
|
|
* @return bool|array 查询失败返回布尔值 `false`,否则返回每个任务的百分比进度信息,格式如下: |
314
|
|
|
* ``` |
315
|
|
|
* array( |
316
|
|
|
* '35f0148d414a688a275bf915ba7cebb2' => 100, // 100 表示任务完成 |
317
|
|
|
* 'c3103189fa906a5354d29bd807e8dc51' => 35, |
318
|
|
|
* '98adbaa52b2f63d6d7f327a0ff223348' => null, // null 表示任务未开始,或异常 |
319
|
|
|
* ) |
320
|
|
|
* ``` |
321
|
|
|
*/ |
322
|
|
|
public function queryProcessStatus($taskIds) { |
323
|
|
|
$video = new Api\Pretreat($this->config); |
324
|
|
|
return $video->query($taskIds, '/status'); |
325
|
|
|
} |
326
|
|
|
|
327
|
|
|
/** |
328
|
|
|
* 音视频预处理任务结果查询 |
329
|
|
|
* |
330
|
|
|
* 根据 `process` 方法返回的任务 ID,通过该访问查询处理结果,会包含每个任务详细信息 |
331
|
|
|
* @param array $taskIds 任务 ID |
332
|
|
|
* |
333
|
|
|
* @return bool|mixed 查询失败返回 `false`,否则返回每个任务的处理结果,格式如下: |
334
|
|
|
* ``` |
335
|
|
|
* array( |
336
|
|
|
* '9d9c32b63a1034834e77672c6f51f661' => array( |
337
|
|
|
* 'path' => array('/v2.mp4'), |
338
|
|
|
* 'signature' => '4042c1f07f546d28', |
339
|
|
|
* 'status_code' => 200, |
340
|
|
|
* 'bucket_name' => 'your_storage_bucket', |
341
|
|
|
* 'description' => 'OK', |
342
|
|
|
* 'task_id' => '9d9c32b63a1034834e77672c6f51f661', |
343
|
|
|
* 'timestamp' => 1472010684 |
344
|
|
|
* ) |
345
|
|
|
* ) |
346
|
|
|
* ``` |
347
|
|
|
*/ |
348
|
|
|
public function queryProcessResult($taskIds) { |
349
|
|
|
$video = new Api\Pretreat($this->config); |
350
|
|
|
return $video->query($taskIds, '/result'); |
351
|
|
|
} |
352
|
|
|
} |