|
@@ -0,0 +1,492 @@
|
|
|
+<?php
|
|
|
+namespace Qiniu\Storage;
|
|
|
+
|
|
|
+use Qiniu\Auth;
|
|
|
+use Qiniu\Config;
|
|
|
+use Qiniu\Zone;
|
|
|
+use Qiniu\Http\Client;
|
|
|
+use Qiniu\Http\Error;
|
|
|
+
|
|
|
+/**
|
|
|
+ * 主要涉及了空间资源管理及批量操作接口的实现,具体的接口规格可以参考
|
|
|
+ *
|
|
|
+ * @link https://developer.qiniu.com/kodo/api/1274/rs
|
|
|
+ */
|
|
|
+final class BucketManager
|
|
|
+{
|
|
|
+ private $auth;
|
|
|
+ private $config;
|
|
|
+
|
|
|
+ public function __construct(Auth $auth, Config $config = null)
|
|
|
+ {
|
|
|
+ $this->auth = $auth;
|
|
|
+ if ($config == null) {
|
|
|
+ $this->config = new Config();
|
|
|
+ } else {
|
|
|
+ $this->config = $config;
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 获取指定账号下所有的空间名。
|
|
|
+ *
|
|
|
+ * @return string[] 包含所有空间名
|
|
|
+ */
|
|
|
+ public function buckets($shared = true)
|
|
|
+ {
|
|
|
+ $includeShared = "false";
|
|
|
+ if ($shared === true) {
|
|
|
+ $includeShared = "true";
|
|
|
+ }
|
|
|
+ return $this->rsGet('/buckets?shared=' . $includeShared);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 获取指定空间绑定的所有的域名
|
|
|
+ *
|
|
|
+ * @return string[] 包含所有空间域名
|
|
|
+ */
|
|
|
+ public function domains($bucket)
|
|
|
+ {
|
|
|
+ return $this->apiGet('/v6/domain/list?tbl=' . $bucket);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 获取空间绑定的域名列表
|
|
|
+ * @return string[] 包含空间绑定的所有域名
|
|
|
+ */
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 列取空间的文件列表
|
|
|
+ *
|
|
|
+ * @param $bucket 空间名
|
|
|
+ * @param $prefix 列举前缀
|
|
|
+ * @param $marker 列举标识符
|
|
|
+ * @param $limit 单次列举个数限制
|
|
|
+ * @param $delimiter 指定目录分隔符
|
|
|
+ *
|
|
|
+ * @return array 包含文件信息的数组,类似:[
|
|
|
+ * {
|
|
|
+ * "hash" => "<Hash string>",
|
|
|
+ * "key" => "<Key string>",
|
|
|
+ * "fsize" => "<file size>",
|
|
|
+ * "putTime" => "<file modify time>"
|
|
|
+ * },
|
|
|
+ * ...
|
|
|
+ * ]
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/list.html
|
|
|
+ */
|
|
|
+ public function listFiles($bucket, $prefix = null, $marker = null, $limit = 1000, $delimiter = null)
|
|
|
+ {
|
|
|
+ $query = array('bucket' => $bucket);
|
|
|
+ \Qiniu\setWithoutEmpty($query, 'prefix', $prefix);
|
|
|
+ \Qiniu\setWithoutEmpty($query, 'marker', $marker);
|
|
|
+ \Qiniu\setWithoutEmpty($query, 'limit', $limit);
|
|
|
+ \Qiniu\setWithoutEmpty($query, 'delimiter', $delimiter);
|
|
|
+ $url = $this->getRsfHost() . '/list?' . http_build_query($query);
|
|
|
+ return $this->get($url);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 获取资源的元信息,但不返回文件内容
|
|
|
+ *
|
|
|
+ * @param $bucket 待获取信息资源所在的空间
|
|
|
+ * @param $key 待获取资源的文件名
|
|
|
+ *
|
|
|
+ * @return array 包含文件信息的数组,类似:
|
|
|
+ * [
|
|
|
+ * "hash" => "<Hash string>",
|
|
|
+ * "key" => "<Key string>",
|
|
|
+ * "fsize" => <file size>,
|
|
|
+ * "putTime" => "<file modify time>"
|
|
|
+ * "fileType" => <file type>
|
|
|
+ * ]
|
|
|
+ *
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/stat.html
|
|
|
+ */
|
|
|
+ public function stat($bucket, $key)
|
|
|
+ {
|
|
|
+ $path = '/stat/' . \Qiniu\entry($bucket, $key);
|
|
|
+ return $this->rsGet($path);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 删除指定资源
|
|
|
+ *
|
|
|
+ * @param $bucket 待删除资源所在的空间
|
|
|
+ * @param $key 待删除资源的文件名
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/delete.html
|
|
|
+ */
|
|
|
+ public function delete($bucket, $key)
|
|
|
+ {
|
|
|
+ $path = '/delete/' . \Qiniu\entry($bucket, $key);
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 给资源进行重命名,本质为move操作。
|
|
|
+ *
|
|
|
+ * @param $bucket 待操作资源所在空间
|
|
|
+ * @param $oldname 待操作资源文件名
|
|
|
+ * @param $newname 目标资源文件名
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ */
|
|
|
+ public function rename($bucket, $oldname, $newname)
|
|
|
+ {
|
|
|
+ return $this->move($bucket, $oldname, $bucket, $newname);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 给资源进行重命名,本质为move操作。
|
|
|
+ *
|
|
|
+ * @param $from_bucket 待操作资源所在空间
|
|
|
+ * @param $from_key 待操作资源文件名
|
|
|
+ * @param $to_bucket 目标资源空间名
|
|
|
+ * @param $to_key 目标资源文件名
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/copy.html
|
|
|
+ */
|
|
|
+ public function copy($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
|
|
|
+ {
|
|
|
+ $from = \Qiniu\entry($from_bucket, $from_key);
|
|
|
+ $to = \Qiniu\entry($to_bucket, $to_key);
|
|
|
+ $path = '/copy/' . $from . '/' . $to;
|
|
|
+ if ($force === true) {
|
|
|
+ $path .= '/force/true';
|
|
|
+ }
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 将资源从一个空间到另一个空间
|
|
|
+ *
|
|
|
+ * @param $from_bucket 待操作资源所在空间
|
|
|
+ * @param $from_key 待操作资源文件名
|
|
|
+ * @param $to_bucket 目标资源空间名
|
|
|
+ * @param $to_key 目标资源文件名
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/move.html
|
|
|
+ */
|
|
|
+ public function move($from_bucket, $from_key, $to_bucket, $to_key, $force = false)
|
|
|
+ {
|
|
|
+ $from = \Qiniu\entry($from_bucket, $from_key);
|
|
|
+ $to = \Qiniu\entry($to_bucket, $to_key);
|
|
|
+ $path = '/move/' . $from . '/' . $to;
|
|
|
+ if ($force) {
|
|
|
+ $path .= '/force/true';
|
|
|
+ }
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 主动修改指定资源的文件类型
|
|
|
+ *
|
|
|
+ * @param $bucket 待操作资源所在空间
|
|
|
+ * @param $key 待操作资源文件名
|
|
|
+ * @param $mime 待操作文件目标mimeType
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/chgm.html
|
|
|
+ */
|
|
|
+ public function changeMime($bucket, $key, $mime)
|
|
|
+ {
|
|
|
+ $resource = \Qiniu\entry($bucket, $key);
|
|
|
+ $encode_mime = \Qiniu\base64_urlSafeEncode($mime);
|
|
|
+ $path = '/chgm/' . $resource . '/mime/' . $encode_mime;
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 修改指定资源的存储类型
|
|
|
+ *
|
|
|
+ * @param $bucket 待操作资源所在空间
|
|
|
+ * @param $key 待操作资源文件名
|
|
|
+ * @param $fileType 待操作文件目标文件类型
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link https://developer.qiniu.com/kodo/api/3710/modify-the-file-type
|
|
|
+ */
|
|
|
+ public function changeType($bucket, $key, $fileType)
|
|
|
+ {
|
|
|
+ $resource = \Qiniu\entry($bucket, $key);
|
|
|
+ $path = '/chtype/' . $resource . '/type/' . $fileType;
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 修改文件的存储状态,即禁用状态和启用状态间的的互相转换
|
|
|
+ *
|
|
|
+ * @param $bucket 待操作资源所在空间
|
|
|
+ * @param $key 待操作资源文件名
|
|
|
+ * @param $status 待操作文件目标文件类型
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link https://developer.qiniu.com/kodo/api/4173/modify-the-file-status
|
|
|
+ */
|
|
|
+ public function changeStatus($bucket, $key, $status)
|
|
|
+ {
|
|
|
+ $resource = \Qiniu\entry($bucket, $key);
|
|
|
+ $path = '/chstatus/' . $resource . '/status/' . $status;
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 从指定URL抓取资源,并将该资源存储到指定空间中
|
|
|
+ *
|
|
|
+ * @param $url 指定的URL
|
|
|
+ * @param $bucket 目标资源空间
|
|
|
+ * @param $key 目标资源文件名
|
|
|
+ *
|
|
|
+ * @return array 包含已拉取的文件信息。
|
|
|
+ * 成功时: [
|
|
|
+ * [
|
|
|
+ * "hash" => "<Hash string>",
|
|
|
+ * "key" => "<Key string>"
|
|
|
+ * ],
|
|
|
+ * null
|
|
|
+ * ]
|
|
|
+ *
|
|
|
+ * 失败时: [
|
|
|
+ * null,
|
|
|
+ * Qiniu/Http/Error
|
|
|
+ * ]
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/fetch.html
|
|
|
+ */
|
|
|
+ public function fetch($url, $bucket, $key = null)
|
|
|
+ {
|
|
|
+
|
|
|
+ $resource = \Qiniu\base64_urlSafeEncode($url);
|
|
|
+ $to = \Qiniu\entry($bucket, $key);
|
|
|
+ $path = '/fetch/' . $resource . '/to/' . $to;
|
|
|
+
|
|
|
+ $ak = $this->auth->getAccessKey();
|
|
|
+ $ioHost = $this->config->getIovipHost($ak, $bucket);
|
|
|
+
|
|
|
+ $url = $ioHost . $path;
|
|
|
+ return $this->post($url, null);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 从镜像源站抓取资源到空间中,如果空间中已经存在,则覆盖该资源
|
|
|
+ *
|
|
|
+ * @param $bucket 待获取资源所在的空间
|
|
|
+ * @param $key 代获取资源文件名
|
|
|
+ *
|
|
|
+ * @return mixed 成功返回NULL,失败返回对象Qiniu\Http\Error
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/prefetch.html
|
|
|
+ */
|
|
|
+ public function prefetch($bucket, $key)
|
|
|
+ {
|
|
|
+ $resource = \Qiniu\entry($bucket, $key);
|
|
|
+ $path = '/prefetch/' . $resource;
|
|
|
+
|
|
|
+ $ak = $this->auth->getAccessKey();
|
|
|
+ $ioHost = $this->config->getIovipHost($ak, $bucket);
|
|
|
+
|
|
|
+ $url = $ioHost . $path;
|
|
|
+ list(, $error) = $this->post($url, null);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 在单次请求中进行多个资源管理操作
|
|
|
+ *
|
|
|
+ * @param $operations 资源管理操作数组
|
|
|
+ *
|
|
|
+ * @return array 每个资源的处理情况,结果类似:
|
|
|
+ * [
|
|
|
+ * { "code" => <HttpCode int>, "data" => <Data> },
|
|
|
+ * { "code" => <HttpCode int> },
|
|
|
+ * { "code" => <HttpCode int> },
|
|
|
+ * { "code" => <HttpCode int> },
|
|
|
+ * { "code" => <HttpCode int>, "data" => { "error": "<ErrorMessage string>" } },
|
|
|
+ * ...
|
|
|
+ * ]
|
|
|
+ * @link http://developer.qiniu.com/docs/v6/api/reference/rs/batch.html
|
|
|
+ */
|
|
|
+ public function batch($operations)
|
|
|
+ {
|
|
|
+ $params = 'op=' . implode('&op=', $operations);
|
|
|
+ return $this->rsPost('/batch', $params);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * 设置文件的生命周期
|
|
|
+ *
|
|
|
+ * @param $bucket 设置文件生命周期文件所在的空间
|
|
|
+ * @param $key 设置文件生命周期文件的文件名
|
|
|
+ * @param $days 设置该文件多少天后删除,当$days设置为0时表示取消该文件的生命周期
|
|
|
+ *
|
|
|
+ * @return Mixed
|
|
|
+ * @link https://developer.qiniu.com/kodo/api/update-file-lifecycle
|
|
|
+ */
|
|
|
+ public function deleteAfterDays($bucket, $key, $days)
|
|
|
+ {
|
|
|
+ $entry = \Qiniu\entry($bucket, $key);
|
|
|
+ $path = "/deleteAfterDays/$entry/$days";
|
|
|
+ list(, $error) = $this->rsPost($path);
|
|
|
+ return $error;
|
|
|
+ }
|
|
|
+
|
|
|
+ private function getRsfHost()
|
|
|
+ {
|
|
|
+ $scheme = "http://";
|
|
|
+ if ($this->config->useHTTPS == true) {
|
|
|
+ $scheme = "https://";
|
|
|
+ }
|
|
|
+ return $scheme . Config::RSF_HOST;
|
|
|
+ }
|
|
|
+
|
|
|
+ private function getRsHost()
|
|
|
+ {
|
|
|
+ $scheme = "http://";
|
|
|
+ if ($this->config->useHTTPS == true) {
|
|
|
+ $scheme = "https://";
|
|
|
+ }
|
|
|
+ return $scheme . Config::RS_HOST;
|
|
|
+ }
|
|
|
+
|
|
|
+ private function getApiHost()
|
|
|
+ {
|
|
|
+ $scheme = "http://";
|
|
|
+ if ($this->config->useHTTPS == true) {
|
|
|
+ $scheme = "https://";
|
|
|
+ }
|
|
|
+ return $scheme . Config::API_HOST;
|
|
|
+ }
|
|
|
+
|
|
|
+ private function rsPost($path, $body = null)
|
|
|
+ {
|
|
|
+ $url = $this->getRsHost() . $path;
|
|
|
+ return $this->post($url, $body);
|
|
|
+ }
|
|
|
+
|
|
|
+ private function apiGet($path)
|
|
|
+ {
|
|
|
+ $url = $this->getApiHost() . $path;
|
|
|
+ return $this->get($url);
|
|
|
+ }
|
|
|
+
|
|
|
+ private function rsGet($path)
|
|
|
+ {
|
|
|
+ $url = $this->getRsHost() . $path;
|
|
|
+ return $this->get($url);
|
|
|
+ }
|
|
|
+
|
|
|
+ private function get($url)
|
|
|
+ {
|
|
|
+ $headers = $this->auth->authorization($url);
|
|
|
+ $ret = Client::get($url, $headers);
|
|
|
+ if (!$ret->ok()) {
|
|
|
+ return array(null, new Error($url, $ret));
|
|
|
+ }
|
|
|
+ return array($ret->json(), null);
|
|
|
+ }
|
|
|
+
|
|
|
+ private function post($url, $body)
|
|
|
+ {
|
|
|
+ $headers = $this->auth->authorization($url, $body, 'application/x-www-form-urlencoded');
|
|
|
+ $ret = Client::post($url, $body, $headers);
|
|
|
+ if (!$ret->ok()) {
|
|
|
+ return array(null, new Error($url, $ret));
|
|
|
+ }
|
|
|
+ $r = ($ret->body === null) ? array() : $ret->json();
|
|
|
+ return array($r, null);
|
|
|
+ }
|
|
|
+
|
|
|
+ public static function buildBatchCopy($source_bucket, $key_pairs, $target_bucket, $force)
|
|
|
+ {
|
|
|
+ return self::twoKeyBatch('/copy', $source_bucket, $key_pairs, $target_bucket, $force);
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ public static function buildBatchRename($bucket, $key_pairs, $force)
|
|
|
+ {
|
|
|
+ return self::buildBatchMove($bucket, $key_pairs, $bucket, $force);
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ public static function buildBatchMove($source_bucket, $key_pairs, $target_bucket, $force)
|
|
|
+ {
|
|
|
+ return self::twoKeyBatch('/move', $source_bucket, $key_pairs, $target_bucket, $force);
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ public static function buildBatchDelete($bucket, $keys)
|
|
|
+ {
|
|
|
+ return self::oneKeyBatch('/delete', $bucket, $keys);
|
|
|
+ }
|
|
|
+
|
|
|
+
|
|
|
+ public static function buildBatchStat($bucket, $keys)
|
|
|
+ {
|
|
|
+ return self::oneKeyBatch('/stat', $bucket, $keys);
|
|
|
+ }
|
|
|
+
|
|
|
+ public static function buildBatchDeleteAfterDays($bucket, $key_day_pairs)
|
|
|
+ {
|
|
|
+ $data = array();
|
|
|
+ foreach ($key_day_pairs as $key => $day) {
|
|
|
+ array_push($data, '/deleteAfterDays/' . \Qiniu\entry($bucket, $key) . '/' . $day);
|
|
|
+ }
|
|
|
+ return $data;
|
|
|
+ }
|
|
|
+
|
|
|
+ public static function buildBatchChangeMime($bucket, $key_mime_pairs)
|
|
|
+ {
|
|
|
+ $data = array();
|
|
|
+ foreach ($key_mime_pairs as $key => $mime) {
|
|
|
+ array_push($data, '/chgm/' . \Qiniu\entry($bucket, $key) . '/mime/' . base64_encode($mime));
|
|
|
+ }
|
|
|
+ return $data;
|
|
|
+ }
|
|
|
+
|
|
|
+ public static function buildBatchChangeType($bucket, $key_type_pairs)
|
|
|
+ {
|
|
|
+ $data = array();
|
|
|
+ foreach ($key_type_pairs as $key => $type) {
|
|
|
+ array_push($data, '/chtype/' . \Qiniu\entry($bucket, $key) . '/type/' . $type);
|
|
|
+ }
|
|
|
+ return $data;
|
|
|
+ }
|
|
|
+
|
|
|
+ private static function oneKeyBatch($operation, $bucket, $keys)
|
|
|
+ {
|
|
|
+ $data = array();
|
|
|
+ foreach ($keys as $key) {
|
|
|
+ array_push($data, $operation . '/' . \Qiniu\entry($bucket, $key));
|
|
|
+ }
|
|
|
+ return $data;
|
|
|
+ }
|
|
|
+
|
|
|
+ private static function twoKeyBatch($operation, $source_bucket, $key_pairs, $target_bucket, $force)
|
|
|
+ {
|
|
|
+ if ($target_bucket === null) {
|
|
|
+ $target_bucket = $source_bucket;
|
|
|
+ }
|
|
|
+ $data = array();
|
|
|
+ $forceOp = "false";
|
|
|
+ if ($force) {
|
|
|
+ $forceOp = "true";
|
|
|
+ }
|
|
|
+ foreach ($key_pairs as $from_key => $to_key) {
|
|
|
+ $from = \Qiniu\entry($source_bucket, $from_key);
|
|
|
+ $to = \Qiniu\entry($target_bucket, $to_key);
|
|
|
+ array_push($data, $operation . '/' . $from . '/' . $to . "/force/" . $forceOp);
|
|
|
+ }
|
|
|
+ return $data;
|
|
|
+ }
|
|
|
+}
|