update qcloud sdk to 5.9.29

jordanqin · jordanqin · commit 15f3848669ff · 2024-05-27T11:23:48.000+08:00
diff --git a/QCloudCosXml/cos-android-base/build.gradle b/QCloudCosXml/cos-android-base/build.gradle
@@ -6,8 +6,8 @@ android {
         minSdkVersion 15
         targetSdkVersion 28
 
-        versionCode 50926
-        versionName '5.9.26'
+        versionCode 50927
+        versionName '5.9.27'
 
         testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
 
diff --git a/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/BaseCosXml.java b/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/BaseCosXml.java
@@ -28,6 +28,7 @@
 import com.tencent.cos.xml.model.CosXmlRequest;
 import com.tencent.cos.xml.model.object.BasePutObjectRequest;
 import com.tencent.cos.xml.model.object.BasePutObjectResult;
+import com.tencent.cos.xml.model.object.GetObjectBytesRequest;
 import com.tencent.cos.xml.model.object.GetObjectRequest;
 import com.tencent.cos.xml.model.object.GetObjectResult;
 import com.tencent.cos.xml.model.object.UploadPartRequest;
@@ -113,6 +114,22 @@ public interface BaseCosXml {
      */
     byte[] getObject(String bucketName, String objectName) throws CosXmlClientException, CosXmlServiceException;
 
+    /**
+     * <p>
+     * 下载 COS 对象到字节数组的同步方法<br>
+     * 和{@link #getObject(GetObjectRequest)}类似，只是返回结果形式不同
+     * </p>
+     * <p>
+     * 注意：请不要通过本接口下载大文件，否则容易造成内存溢出。
+     * </p>
+     *
+     * @param request 获取 COS 对象的请求 {@link GetObjectBytesRequest}
+     * @return 对象的字节数据
+     * @throws CosXmlClientException 客户端异常
+     * @throws CosXmlServiceException 服务端异常
+     */
+    byte[] getObject(GetObjectBytesRequest request) throws CosXmlClientException, CosXmlServiceException;
+
     /**
      * <p>
      * 基础简单上传的同步方法.&nbsp;
diff --git a/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/CosXmlBaseService.java b/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/CosXmlBaseService.java
@@ -657,6 +657,18 @@ public byte[] getObject(String bucketName, String objectName) throws CosXmlClien
         return getObjectBytesResult != null ? getObjectBytesResult.data : new byte[0];
     }
 
+    /**
+     * <p>
+     * 将 COS 对象下载为字节数组
+     * <p>
+     * 详细介绍，请查看:{@link BaseCosXml#getObject(GetObjectBytesRequest)}
+     */
+    @Override
+    public byte[] getObject(GetObjectBytesRequest request) throws CosXmlClientException, CosXmlServiceException {
+        GetObjectBytesResult getObjectBytesResult = execute(request, new GetObjectBytesResult());
+        return getObjectBytesResult != null ? getObjectBytesResult.data : new byte[0];
+    }
+
     /**
      * <p>
      * 基础简单上传的同步方法.&nbsp;
diff --git a/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/model/object/GetObjectBytesRequest.java b/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/model/object/GetObjectBytesRequest.java
@@ -22,20 +22,34 @@
 
 package com.tencent.cos.xml.model.object;
 
+import android.util.Log;
+
 import com.tencent.cos.xml.BaseCosXml;
+import com.tencent.cos.xml.common.ClientErrorCode;
 import com.tencent.cos.xml.common.RequestMethod;
 import com.tencent.cos.xml.exception.CosXmlClientException;
 import com.tencent.qcloud.core.http.RequestBodySerializer;
 
 import org.xmlpull.v1.XmlPullParserException;
 
+import java.io.File;
 import java.io.IOException;
 
 /**
  * 下载 COS 对象到字节数组的请求.
  * @see BaseCosXml#getObject(String, String)
  */
 final public class GetObjectBytesRequest extends ObjectRequest {
+    private boolean objectKeySimplifyCheck = true;
+
+    /**
+     * 设置是否校验cosPath归并后是否符合规范，默认为true
+     * @param objectKeySimplifyCheck 是否校验cosPath归并后是否符合规范
+     */
+    public void setObjectKeySimplifyCheck(boolean objectKeySimplifyCheck) {
+        this.objectKeySimplifyCheck = objectKeySimplifyCheck;
+    }
+
     public GetObjectBytesRequest(String bucket, String cosPath) {
         super(bucket, cosPath);
     }
@@ -49,4 +63,20 @@ public String getMethod() {
     protected RequestBodySerializer xmlBuilder() throws XmlPullParserException, IOException {
         return null;
     }
+
+    @Override
+    public void checkParameters() throws CosXmlClientException {
+        super.checkParameters();
+
+        if(objectKeySimplifyCheck) {
+            String normalizedPath = cosPath;
+            try {
+                File file = new File("/" + cosPath);
+                normalizedPath = file.getCanonicalPath();
+            } catch (IOException e) {e.printStackTrace();}
+            if ("/".equals(normalizedPath)) {
+                throw new CosXmlClientException(ClientErrorCode.INVALID_ARGUMENT.getCode(), "The key in the getobject is illegal");
+            }
+        }
+    }
 }
diff --git a/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/model/object/GetObjectRequest.java b/QCloudCosXml/cos-android-base/src/main/java/com/tencent/cos/xml/model/object/GetObjectRequest.java
@@ -26,8 +26,10 @@
 
 import com.tencent.cos.xml.BaseCosXml;
 import com.tencent.cos.xml.common.COSRequestHeaderKey;
+import com.tencent.cos.xml.common.ClientErrorCode;
 import com.tencent.cos.xml.common.Range;
 import com.tencent.cos.xml.common.RequestMethod;
+import com.tencent.cos.xml.exception.CosXmlClientException;
 import com.tencent.cos.xml.listener.CosXmlProgressListener;
 import com.tencent.cos.xml.listener.CosXmlResultListener;
 import com.tencent.qcloud.core.http.RequestBodySerializer;
@@ -61,6 +63,8 @@ public class GetObjectRequest extends ObjectRequest implements TransferRequest {
 
     private Uri fileContentUri;
 
+    private boolean objectKeySimplifyCheck = true;
+
     /**
      * GetObjectRequest 构造函数
      * @param bucket 存储桶名称(cos v5 的 bucket格式为：xxx-appid, 如 bucket-1250000000)
@@ -317,6 +321,18 @@ public String getSaveFileName() {
         return saveFileName;
     }
 
+    /**
+     * 设置是否校验cosPath归并后是否符合规范，默认为true
+     * @param objectKeySimplifyCheck 是否校验cosPath归并后是否符合规范
+     */
+    public void setObjectKeySimplifyCheck(boolean objectKeySimplifyCheck) {
+        this.objectKeySimplifyCheck = objectKeySimplifyCheck;
+    }
+
+    public boolean isObjectKeySimplifyCheck() {
+        return objectKeySimplifyCheck;
+    }
+
     public String getDownloadPath(){
         String path  = null;
         if(savePath != null){
@@ -389,4 +405,20 @@ protected RequestBodySerializer xmlBuilder() throws XmlPullParserException, IOEx
     public void setTrafficLimit(long limit) {
         addHeader("x-cos-traffic-limit", String.valueOf(limit));
     }
+
+    @Override
+    public void checkParameters() throws CosXmlClientException {
+        super.checkParameters();
+
+        if(objectKeySimplifyCheck) {
+            String normalizedPath = cosPath;
+            try {
+                File file = new File("/" + cosPath);
+                normalizedPath = file.getCanonicalPath();
+            } catch (IOException e) {e.printStackTrace();}
+            if ("/".equals(normalizedPath)) {
+                throw new CosXmlClientException(ClientErrorCode.INVALID_ARGUMENT.getCode(), "The key in the getobject is illegal");
+            }
+        }
+    }
 }
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/core/TestConst.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/core/TestConst.java
@@ -19,6 +19,7 @@ public class TestConst {
     public static final String PERSIST_BUCKET_REGION = BuildConfig.PERSIST_BUCKET_REGION;
     public static final String PERSIST_BUCKET = BuildConfig.PERSIST_BUCKET;
     public static final String PERSIST_BUCKET_CDN_SIGN = BuildConfig.PERSIST_BUCKET_CDN_SIGN;
+    public static final String PERSIST_BUCKET_ROOT_FILE_PATH = "do_not_remove";
     public static final String PERSIST_BUCKET_PIC_PATH = "do_not_remove/image.png";
     public static final String PERSIST_BUCKET_PIC_6M_PATH = "do_not_remove/6m.jpg";
     public static final String PERSIST_BUCKET_QR_PATH = "do_not_remove/qr.png";
@@ -103,5 +104,5 @@ public class TestConst {
     public static final String CALLBACK_SECRET_ID = BuildConfig.CALLBACK_SECRET_ID;
     public static final String CALLBACK_SECRET_KEY = BuildConfig.CALLBACK_SECRET_KEY;
     public static final String CALLBACK_PERSIST_BUCKET_REGION = "ap-shanghai";
-    public static final String CALLBACK_PERSIST_BUCKET = "test-callback-1251668577";
+    public static final String CALLBACK_PERSIST_BUCKET = "test-callback-1252246555";
 }
diff --git a/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/transfer/DownloadTest.java b/QCloudCosXml/cos-android/src/androidTest/java/com/tencent/cos/xml/transfer/DownloadTest.java
@@ -40,6 +40,7 @@
 import com.tencent.cos.xml.listener.CosXmlResultListener;
 import com.tencent.cos.xml.model.CosXmlRequest;
 import com.tencent.cos.xml.model.CosXmlResult;
+import com.tencent.cos.xml.model.object.GetObjectBytesRequest;
 import com.tencent.cos.xml.model.object.GetObjectRequest;
 import com.tencent.qcloud.core.http.HttpTaskMetrics;
 import com.tencent.qcloud.core.logger.QCloudLogger;
@@ -476,4 +477,195 @@ public void onFail(CosXmlRequest request, @Nullable CosXmlClientException client
         }
         Assert.assertTrue(true);
     }
+
+    @Test public void testDownloadPath() {
+        testDownloadBtPath("/", true, true);
+        testDownloadBtPath("///////", true, true);
+        testDownloadBtPath("/abc/../", true, true);
+        testDownloadBtPath("/./", true, true);
+        testDownloadBtPath("///abc/.//def//../../", true, true);
+        testDownloadBtPath("/././///abc/.//def//../../", true, true);
+        testDownloadBtPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, true);
+        testDownloadBtPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        testDownloadBtPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        testDownloadBtPath("do_not_remove/", false, true);
+        testDownloadBtPath("/do_not_remove/", false, true);
+
+        testDownloadBtPath("/", true, false);
+        testDownloadBtPath("///////", true, false);
+        testDownloadBtPath("/abc/../", true, false);
+        testDownloadBtPath("/./", true, false);
+        testDownloadBtPath("///abc/.//def//../../", true, false);
+        testDownloadBtPath("/././///abc/.//def//../../", true, false);
+        testDownloadBtPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, false);
+        testDownloadBtPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        testDownloadBtPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        testDownloadBtPath("do_not_remove/", false, false);
+        testDownloadBtPath("/do_not_remove/", false, false);
+
+        // 为了覆盖getCanonicalPath()的IOException
+        testDownloadBtPath("\u0000", true, true);
+
+        Assert.assertTrue(true);
+    }
+
+    private void testDownloadBtPath(String cosPath, boolean isFail, boolean isObjectKeySimplifyCheck){
+        try {
+            TransferManager transferManager = ServiceFactory.INSTANCE.newDefaultTransferManager();
+
+            GetObjectRequest getObjectRequest = new GetObjectRequest(TestConst.PERSIST_BUCKET,
+                    cosPath,
+                    TestUtils.localParentPath(), "test");
+            getObjectRequest.setObjectKeySimplifyCheck(isObjectKeySimplifyCheck);
+
+            COSXMLDownloadTask downloadTask = transferManager.download(TestUtils.getContext(),
+                    getObjectRequest);
+            final TestLocker testLocker = new TestLocker();
+            downloadTask.setCosXmlResultListener(new CosXmlResultListener() {
+                @Override
+                public void onSuccess(CosXmlRequest request, CosXmlResult result) {
+                    testLocker.release();
+                }
+
+                @Override
+                public void onFail(CosXmlRequest request, CosXmlClientException clientException, CosXmlServiceException serviceException) {
+                    String error = TestUtils.getCosExceptionMessage(clientException, serviceException);
+                    TestUtils.printError(error);
+                    if(serviceException != null){
+                        // 如果开启校验且应该校验失败 就不应该走到服务端，其他情况不关注后端错误
+                        if(isObjectKeySimplifyCheck && isFail){
+                            Assert.fail(error);
+                        }
+                    }
+                    if(clientException != null){
+                        if(isFail) {
+                            if (!"The key in the getobject is illegal".equals(clientException.getMessage())) {
+                                Assert.fail(clientException.getMessage());
+                            } else {
+                                if(!isObjectKeySimplifyCheck){
+                                    Assert.fail(clientException.getMessage());
+                                }
+                            }
+                        } else {
+                            Assert.fail(clientException.getMessage());
+                        }
+                    }
+                    testLocker.release();
+                }
+            });
+            testLocker.lock();
+        } catch (Exception e){
+            e.printStackTrace();
+        }
+    }
+
+    @Test public void testGetObjectPath() {
+        getObjectByPath("/", true, true);
+        getObjectByPath("///////", true, true);
+        getObjectByPath("/abc/../", true, true);
+        getObjectByPath("/./", true, true);
+        getObjectByPath("///abc/.//def//../../", true, true);
+        getObjectByPath("/././///abc/.//def//../../", true, true);
+        getObjectByPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, true);
+        getObjectByPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        getObjectByPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        getObjectByPath("do_not_remove/", false, true);
+        getObjectByPath("/do_not_remove/", false, true);
+
+        getObjectByPath("/", true, false);
+        getObjectByPath("///////", true, false);
+        getObjectByPath("/abc/../", true, false);
+        getObjectByPath("/./", true, false);
+        getObjectByPath("///abc/.//def//../../", true, false);
+        getObjectByPath("/././///abc/.//def//../../", true, false);
+        getObjectByPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, false);
+        getObjectByPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        getObjectByPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        getObjectByPath("do_not_remove/", false, false);
+        getObjectByPath("/do_not_remove/", false, false);
+
+        Assert.assertTrue(true);
+    }
+    private void getObjectByPath(String cosPath, boolean isFail, boolean isObjectKeySimplifyCheck) {
+        CosXmlSimpleService cosXmlSimpleService = ServiceFactory.INSTANCE.newDefaultService();
+        GetObjectRequest getObjectRequest = new GetObjectRequest(TestConst.PERSIST_BUCKET,
+                cosPath,
+                TestUtils.localParentPath(), "test");
+        getObjectRequest.setObjectKeySimplifyCheck(isObjectKeySimplifyCheck);
+        try {
+            cosXmlSimpleService.getObject(getObjectRequest);
+        } catch (CosXmlClientException e) {
+            TestUtils.printError(e.getMessage());
+            if(isFail) {
+                if (!"The key in the getobject is illegal".equals(e.getMessage())) {
+                    Assert.fail(e.getMessage());
+                } else {
+                    if(!isObjectKeySimplifyCheck){
+                        Assert.fail(e.getMessage());
+                    }
+                }
+            } else {
+                Assert.fail(e.getMessage());
+            }
+        } catch (CosXmlServiceException e) {
+            // 如果开启校验且应该校验失败 就不应该走到服务端，其他情况不关注后端错误
+            if(isObjectKeySimplifyCheck && isFail){
+                Assert.fail(e.getMessage());
+            }
+        }
+    }
+
+    @Test public void testGetObjectBytesPath() {
+        getObjectBytesByPath("/", true, true);
+        getObjectBytesByPath("///////", true, true);
+        getObjectBytesByPath("/abc/../", true, true);
+        getObjectBytesByPath("/./", true, true);
+        getObjectBytesByPath("///abc/.//def//../../", true, true);
+        getObjectBytesByPath("/././///abc/.//def//../../", true, true);
+        getObjectBytesByPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, true);
+        getObjectBytesByPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        getObjectBytesByPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, true);
+        getObjectBytesByPath("do_not_remove/", false, true);
+        getObjectBytesByPath("/do_not_remove/", false, true);
+
+        getObjectBytesByPath("/", true, false);
+        getObjectBytesByPath("///////", true, false);
+        getObjectBytesByPath("/abc/../", true, false);
+        getObjectBytesByPath("/./", true, false);
+        getObjectBytesByPath("///abc/.//def//../../", true, false);
+        getObjectBytesByPath("/././///abc/.//def//../../", true, false);
+        getObjectBytesByPath(TestConst.PERSIST_BUCKET_ROOT_FILE_PATH, false, false);
+        getObjectBytesByPath(TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        getObjectBytesByPath("/"+TestConst.PERSIST_BUCKET_PIC_PATH, false, false);
+        getObjectBytesByPath("do_not_remove/", false, false);
+        getObjectBytesByPath("/do_not_remove/", false, false);
+
+        Assert.assertTrue(true);
+    }
+    private void getObjectBytesByPath(String cosPath, boolean isFail, boolean isObjectKeySimplifyCheck) {
+        CosXmlSimpleService cosXmlSimpleService = ServiceFactory.INSTANCE.newDefaultService();
+        GetObjectBytesRequest getObjectBytesRequest = new GetObjectBytesRequest(TestConst.PERSIST_BUCKET, cosPath);
+        getObjectBytesRequest.setObjectKeySimplifyCheck(isObjectKeySimplifyCheck);
+        try {
+            cosXmlSimpleService.getObject(getObjectBytesRequest);
+        } catch (CosXmlClientException e) {
+            TestUtils.printError(e.getMessage());
+            if(isFail) {
+                if (!"The key in the getobject is illegal".equals(e.getMessage())) {
+                    Assert.fail(e.getMessage());
+                } else {
+                    if(!isObjectKeySimplifyCheck){
+                        Assert.fail(e.getMessage());
+                    }
+                }
+            } else {
+                Assert.fail(e.getMessage());
+            }
+        } catch (CosXmlServiceException e) {
+            // 如果开启校验且应该校验失败 就不应该走到服务端，其他情况不关注后端错误
+            if(isObjectKeySimplifyCheck && isFail){
+                Assert.fail(e.getMessage());
+            }
+        }
+    }
 }
diff --git a/QCloudCosXml/cos-android/src/main/java/com/tencent/cos/xml/transfer/COSXMLDownloadTask.java b/QCloudCosXml/cos-android/src/main/java/com/tencent/cos/xml/transfer/COSXMLDownloadTask.java
diff --git a/QCloudCosXml/settings.gradle b/QCloudCosXml/settings.gradle
diff --git a/QCloudCosXml/version.gradle b/QCloudCosXml/version.gradle
