Merge pull request #381 from qiniu/features/support-deep-archive

support deep archive

Author: Mei-Zhao

examples/bucket_lifecycleRule.php

@@ -21,13 +21,17 @@
 $prefix = 'test'; // 规则策略中的前缀
 $delete_after_days = 80; // 用户新创建的文件将在该设定时间之后自动删除
 $to_line_after_days = 70; // 用户新创建的文件将在该设定的时间之后自动转为低频存储
+$to_archive_after_days = 72; // 用户新创建的文件将在该设定的时间之后自动转为归档存储
+$to_deep_archive_after_days = 74; // 用户新创建的文件将在该设定的时间之后自动转为深度归档存储
 
 list($ret, $err) = $bucketManager->bucketLifecycleRule(
     $bucket,
     $name,
     $prefix,
     $delete_after_days,
-    $to_line_after_days
+    $to_line_after_days,
+    $to_archive_after_days,
+    $to_deep_archive_after_days
 );
 if ($err != null) {
     var_dump($err);

examples/rs_batch_change_type.php

@@ -25,12 +25,17 @@
 
 $keyTypePairs = array();
 
-// type=0表示普通存储，type=1表示低频存储
+// key 是文件
+// value 是存储类型（fileType）
+// 0 表示普通存储
+// 1 表示低频存储
+// 2 表示归档存储
+// 3 表示深度归档存储
 foreach ($keys as $key) {
     $keyTypePairs[$key] = 1;
 }
 
-$ops = $bucketManager->buildBatchChangeType($bucket, $keyTypePairs);
+$ops = BucketManager::buildBatchChangeType($bucket, $keyTypePairs);
 list($ret, $err) = $bucketManager->batch($ops);
 if ($err != null) {
     var_dump($err);

examples/rs_batch_restore_ar.php

@@ -0,0 +1,41 @@
+<?php
+require_once __DIR__ . '/../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Config;
+use Qiniu\Storage\BucketManager;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+$bucket = getenv('QINIU_TEST_BUCKET');
+
+
+$auth = new Auth($accessKey, $secretKey);
+$config = new Config();
+$bucketManager = new BucketManager($auth, $config);
+
+// 批量解冻归档/深度归档文件，每次最多不能超过 1000 个
+
+$keys = array(
+    'archived_file.mp4',
+    'deep_archived_file.png',
+    'others.jpg'
+);
+
+$keyTypePairs = array();
+
+
+// key 是文件
+// value 是解冻时间（单位：天，范围 1~7）
+foreach ($keys as $key) {
+    $keyTypePairs[$key] = 1;
+}
+
+$ops = BucketManager::buildBatchRestoreAr($bucket, $keyTypePairs);
+list($ret, $err) = $bucketManager->batch($ops);
+if ($err != null) {
+    var_dump($err);
+} else {
+    var_dump($ret);
+}

examples/rs_change_type.php

@@ -21,7 +21,7 @@
 // 参考文档：https://developer.qiniu.com/kodo/api/3710/chtype
 
 $key = "qiniu.mp4";
-$fileType = 1; // 0 表示标准存储；1 表示低频存储；2 表示归档存储
+$fileType = 1; // 0 表示标准存储；1 表示低频存储；2 表示归档存储；3 表示深度归档存储
 
 list($ret, $err) = $bucketManager->changeType($bucket, $key, $fileType);
 if ($err != null) {

examples/rs_restore.php

@@ -0,0 +1,28 @@
+<?php
+require_once __DIR__ . '/../autoload.php';
+
+use Qiniu\Auth;
+use Qiniu\Config;
+use Qiniu\Storage\BucketManager;
+
+// 控制台获取密钥：https://portal.qiniu.com/user/key
+$accessKey = getenv('QINIU_ACCESS_KEY');
+$secretKey = getenv('QINIU_SECRET_KEY');
+$bucket = getenv('QINIU_TEST_BUCKET');
+
+$auth = new Auth($accessKey, $secretKey);
+
+$config = new Config();
+$bucketManager = new BucketManager($auth, $config);
+
+// 资源元信息查询
+// 参考文档：https://developer.qiniu.com/kodo/api/1308/stat
+
+$key = "my-php-logo.png";
+
+list($ret, $err) = $bucketManager->restoreAr($bucket, $key, 1);
+if ($err != null) {
+    var_dump($err);
+} else {
+    var_dump($ret);
+}

src/Qiniu/Storage/BucketManager.php

@@ -203,14 +203,20 @@ public function listFilesv2(
      * 大于0表示多少天后删除,需大于 to_line_after_days
      * @param int $to_line_after_days 指定文件上传多少天后转低频存储。指定为0表示
      * 不转低频存储，小于0表示上传的文件立即变低频存储
+     * @param int $to_archive_after_days 指定文件上传多少天后转归档存储。指定为0表示
+     * 不转归档存储，小于0表示上传的文件立即变归档存储
+     * @param int $to_deep_archive_after_days 指定文件上传多少天后转深度归档存储。指定为0表示
+     * 不转深度归档存储，小于0表示上传的文件立即变深度归档存储
      * @return array
      */
     public function bucketLifecycleRule(
         $bucket,
         $name,
         $prefix,
-        $delete_after_days,
-        $to_line_after_days
+        $delete_after_days = null,
+        $to_line_after_days = null,
+        $to_archive_after_days = null,
+        $to_deep_archive_after_days = null
     ) {
         $path = '/rules/add';
         $params = array();
@@ -229,6 +235,12 @@ public function bucketLifecycleRule(
         if ($to_line_after_days) {
             $params['to_line_after_days'] = $to_line_after_days;
         }
+        if ($to_archive_after_days) {
+            $params['to_archive_after_days'] = $to_archive_after_days;
+        }
+        if ($to_deep_archive_after_days) {
+            $params['to_deep_archive_after_days'] = $to_deep_archive_after_days;
+        }
         $data = http_build_query($params);
         $info = $this->ucPost($path, $data);
         return $info;
@@ -245,14 +257,20 @@ public function bucketLifecycleRule(
      * 大于0表示多少天后删除，需大于 to_line_after_days
      * @param int $to_line_after_days 指定文件上传多少天后转低频存储。指定为0表示不
      * 转低频存储，小于0表示上传的文件立即变低频存储
+     * @param int $to_archive_after_days 指定文件上传多少天后转归档存储。指定为0表示
+     * 不转归档存储，小于0表示上传的文件立即变归档存储
+     * @param int $to_deep_archive_after_days 指定文件上传多少天后转深度归档存储。指定为0表示
+     * 不转深度归档存储，小于0表示上传的文件立即变深度归档存储
      * @return array
      */
     public function updateBucketLifecycleRule(
         $bucket,
         $name,
         $prefix,
-        $delete_after_days,
-        $to_line_after_days
+        $delete_after_days = null,
+        $to_line_after_days = null,
+        $to_archive_after_days = null,
+        $to_deep_archive_after_days = null
     ) {
         $path = '/rules/update';
         $params = array();
@@ -271,6 +289,12 @@ public function updateBucketLifecycleRule(
         if ($to_line_after_days) {
             $params['to_line_after_days'] = $to_line_after_days;
         }
+        if ($to_archive_after_days) {
+            $params['to_archive_after_days'] = $to_archive_after_days;
+        }
+        if ($to_deep_archive_after_days) {
+            $params['to_deep_archive_after_days'] = $to_deep_archive_after_days;
+        }
         $data = http_build_query($params);
         return $this->ucPost($path, $data);
     }
@@ -675,7 +699,7 @@ public function changeMime($bucket, $key, $mime)
      *
      * @param string $bucket 待操作资源所在空间
      * @param string $key 待操作资源文件名
-     * @param int $fileType 0 表示标准存储；1 表示低频存储；2 表示归档存储
+     * @param int $fileType 0 表示标准存储；1 表示低频存储；2 表示归档存储；3 表示深度归档存储
      *
      * @return array
      * @link  https://developer.qiniu.com/kodo/api/3710/chtype
@@ -687,6 +711,23 @@ public function changeType($bucket, $key, $fileType)
         return $this->rsPost($path);
     }
 
+    /**
+     * 解冻指定资源的存储类型
+     *
+     * @param string $bucket 待操作资源所在空间
+     * @param string $key 待操作资源文件名
+     * @param int $freezeAfterDays 解冻有效时长，取值范围 1~7
+     *
+     * @return array
+     * @link  https://developer.qiniu.com/kodo/api/6380/restore-archive
+     */
+    public function restoreAr($bucket, $key, $freezeAfterDays)
+    {
+        $resource = \Qiniu\entry($bucket, $key);
+        $path = '/restoreAr/' . $resource . '/freezeAfterDays/' . $freezeAfterDays;
+        return $this->rsPost($path);
+    }
+
     /**
      * 修改文件的存储状态，即禁用状态和启用状态间的的互相转换
      *
@@ -1031,6 +1072,15 @@ public static function buildBatchChangeType($bucket, $key_type_pairs)
         return $data;
     }
 
+    public static function buildBatchRestoreAr($bucket, $key_restore_days_pairs)
+    {
+        $data = array();
+        foreach ($key_restore_days_pairs as $key => $restore_days) {
+            array_push($data, '/restoreAr/' . \Qiniu\entry($bucket, $key) . '/freezeAfterDays/' . $restore_days);
+        }
+        return $data;
+    }
+
     private static function oneKeyBatch($operation, $bucket, $keys)
     {
         $data = array();

src/Qiniu/Storage/UploadManager.php

@@ -65,21 +65,23 @@ public function put(
     /**
      * 上传文件到七牛
      *
-     * @param $upToken    上传凭证
-     * @param $key        上传文件名
-     * @param $filePath   上传文件的路径
-     * @param $params     自定义变量，规格参考
-     *                    http://developer.qiniu.com/docs/v6/api/overview/up/response/vars.html#xvar
-     * @param $mime       上传数据的mimeType
-     * @param $checkCrc   是否校验crc32
-     * @param $version    分片上传版本 目前支持v1/v2版本 默认v1
-     * @param $partSize   分片上传v2字段 默认大小为4MB 分片大小范围为1 MB - 1 GB
-     * @param $resumeRecordFile 断点续传文件路径 默认为null
-     * @return array    包含已上传文件的信息，类似：
+     * @param string $upToken 上传凭证
+     * @param string $key 上传文件名
+     * @param string $filePath 上传文件的路径
+     * @param array<string, mixed> $params 定义变量，规格参考
+     *                                     http://developer.qiniu.com/docs/v6/api/overview/up/response/vars.html#xvar
+     * @param boolean $mime 上传数据的mimeType
+     * @param string $checkCrc 是否校验crc32
+     * @param string $resumeRecordFile 断点续传文件路径 默认为null
+     * @param string $version 分片上传版本 目前支持v1/v2版本 默认v1
+     * @param int $partSize 分片上传v2字段 默认大小为4MB 分片大小范围为1 MB - 1 GB
+     *
+     * @return array<string, mixed> 包含已上传文件的信息，类似：
      *                                              [
      *                                                  "hash" => "<Hash string>",
      *                                                  "key" => "<Key string>"
      *                                              ]
+     * @throws \Exception
      */
     public function putFile(
         $upToken,