add filePathCompatible option for php5.x

huiguangjun · huiguangjun · commit 93bb6f565044 · 2024-02-01T16:47:25.000+08:00
diff --git a/src/OSS/OssClient.php b/src/OSS/OssClient.php
@@ -206,6 +206,21 @@ private function __initNewClient($config = array())
             }
         }
 
+        //filePathCompatible
+        $this->filePathCompatible = false;
+        if (version_compare(phpversion(), '7.0.0', '<')) {
+            if (OssUtil::isWin()) {
+                $this->filePathCompatible = true;
+            }
+        }
+        if (isset($config['filePathCompatible'])) {
+            if ($config['filePathCompatible'] === true) {
+                $this->filePathCompatible = true;
+            } else if ($config['filePathCompatible'] === false) {
+                $this->filePathCompatible = false;
+            }
+        }
+
         self::checkEnv();
     }
 
@@ -1867,7 +1882,7 @@ public function uploadFile($bucket, $object, $file, $options = NULL)
     {
         $this->precheckCommon($bucket, $object, $options);
         OssUtil::throwOssExceptionWithMessageIfEmpty($file, "file path is invalid");
-        $file = OssUtil::encodePath($file);
+        $file = $this->encodeFilePath($file);
         if (!file_exists($file)) {
             throw new OssException($file . " file does not exist");
         }
@@ -1985,7 +2000,7 @@ public function appendFile($bucket, $object, $file, $position, $options = NULL)
         $this->precheckCommon($bucket, $object, $options);
 
         OssUtil::throwOssExceptionWithMessageIfEmpty($file, "file path is invalid");
-        $file = OssUtil::encodePath($file);
+        $file = $this->encodeFilePath($file);
         if (!file_exists($file)) {
             throw new OssException($file . " file does not exist");
         }
@@ -2651,7 +2666,7 @@ public function multiuploadFile($bucket, $object, $file, $options = null)
         if (empty($file)) {
             throw new OssException("parameter invalid, file is empty");
         }
-        $uploadFile = OssUtil::encodePath($file);
+        $uploadFile = $this->encodeFilePath($file);
         if (!isset($options[self::OSS_CONTENT_TYPE])) {
             $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object, $uploadFile);
         }
@@ -2750,7 +2765,7 @@ public function uploadDir($bucket, $prefix, $localDirectory, $exclude = '.|..|.s
         if (!is_string($prefix)) throw new OssException("parameter error, prefix is not string");
         if (empty($localDirectory)) throw new OssException("parameter error, localDirectory is empty");
         $directory = $localDirectory;
-        $directory = OssUtil::encodePath($directory);
+        $directory = $this->encodeFilePath($directory);
         //If it's not the local directory, throw OSSException.
         if (!is_dir($directory)) {
             throw new OssException('parameter error: ' . $directory . ' is not a directory, please check it');
@@ -2768,7 +2783,9 @@ public function uploadDir($bucket, $prefix, $localDirectory, $exclude = '.|..|.s
                 self::OSS_PART_SIZE => self::OSS_MIN_PART_SIZE,
                 self::OSS_CHECK_MD5 => $checkMd5,
             );
-            $realObject = (!empty($prefix) ? $prefix . '/' : '') . $item['file'];
+            //mbstring to utf-8
+            $fileName = $this->decodeFilePath($item['file']);
+            $realObject = (!empty($prefix) ? $prefix . '/' : '') . $fileName;
 
             try {
                 $this->multiuploadFile($bucket, $realObject, $item['path'], $options);
@@ -3485,6 +3502,69 @@ private function getRegion()
         return $this->region;
     }
 
+    /**
+     * Encodes the file path from UTF-8 to GBK.
+     *
+     * @param $filepath
+     * @return string
+     */
+    private function encodeFilePath($filepath)
+    {
+        if ($this->filePathCompatible !== true) {
+            return $filepath;
+        }
+
+        if (empty($filepath)) {
+            return $filepath;
+        }
+
+        try {
+            $encoding = array('UTF-8','GB2312', 'GBK');
+            $encode = mb_detect_encoding($filepath, $encoding);
+            if ($encode !== 'UTF-8') {
+                return $filepath;
+            }
+            $tmp = iconv($encode, 'GBK', $filepath);
+            if ($tmp !== false) {
+                $filepath = $tmp;
+            }
+        } catch (\Exception $e) {
+            //IGNORE
+        }
+        return $filepath;
+    }
+
+     /**
+     * Decodes the file path from GBK  to UTF-8.
+     *
+     * @param $filepath
+     * @return string
+     */
+    private function decodeFilePath($filepath)
+    {
+        if ($this->filePathCompatible !== true) {
+            return $filepath;
+        }
+        if (empty($filepath)) {
+            return $filepath;
+        }
+
+        try {
+            $encoding = array('UTF-8','GB2312', 'GBK');
+            $encode = mb_detect_encoding($filepath, $encoding);
+            if ($encode === 'UTF-8' || $encode === false) {
+                return $filepath;
+            }
+            $tmp = iconv($encode, 'UTF-8', $filepath);
+            if ($tmp !== false) {
+                $filepath = $tmp;
+            }
+        } catch (\Exception $e) {
+            //IGNORE
+        }
+        return $filepath;
+    }
+
     /**
      * Check if all dependent extensions are installed correctly.
      * For now only "curl" is needed.
@@ -3702,4 +3782,6 @@ public function setConnectTimeout($connectTimeout)
     private $signer;
 
     private $checkObjectEncoding = false;
+
+    private $filePathCompatible;
 }
diff --git a/tests/OSS/Tests/OssClientObjectTest.php b/tests/OSS/Tests/OssClientObjectTest.php
@@ -3,6 +3,7 @@
 namespace OSS\Tests;
 
 use OSS\Core\OssException;
+use OSS\Core\OssUtil;
 use OSS\OssClient;
 
 require_once __DIR__ . DIRECTORY_SEPARATOR . 'TestOssClientBase.php';
@@ -817,6 +818,86 @@ public function testObjectKeyWithNonUTF8Name()
         }
     }
 
+    public function testEncodeFilePath()
+    {
+        if (!OssUtil::isWin()) {
+            $this->assertTrue(true);
+            return;
+        }
+
+        $fileFolder = __DIR__ . DIRECTORY_SEPARATOR . "中文目录";
+        $filePath1 = $fileFolder . DIRECTORY_SEPARATOR . "中文文件名1.txt";
+        $filePath2 = $fileFolder . DIRECTORY_SEPARATOR . "中文文件名2.txt";
+
+        $gbkfileFolder = iconv('UTF-8', 'GBK', $fileFolder);
+        $gbkfilePath1 = iconv('UTF-8', 'GBK', $filePath1);
+        $gbkfilePath2 = iconv('UTF-8', 'GBK', $filePath2);
+
+        $hexfilePath1 = bin2hex($filePath1);
+        $hexGbkfilePath2 = bin2hex($gbkfilePath2);
+
+        //$this->assertEquals("e4b8ade69687e69687e4bbb6e5908d312e747874", $hexfilePath1);
+        //$this->assertEquals("d6d0cec4cec4bcfec3fb322e747874", $hexGbkfilePath2);
+        try {
+            mkdir($fileFolder);
+        } catch (\Exception $e) {
+        }
+        OssUtil::generateFile($filePath1, 200 * 1024);
+        OssUtil::generateFile($filePath2, 202 * 1024);
+
+        try {
+            $content1 = file_get_contents($filePath1);
+            $content2 = file_get_contents($filePath2);
+
+            // upload file
+            $this->ossClient->uploadFile($this->bucket, '123', $filePath1);
+            $this->ossClient->uploadFile($this->bucket, '234', $gbkfilePath2);
+
+            $res = $this->ossClient->getObject($this->bucket, '123');
+            $this->assertEquals($content1, $res);
+
+            $res = $this->ossClient->getObject($this->bucket, '234');
+            $this->assertEquals($content2, $res);
+
+            // append file
+            $position = $this->ossClient->appendFile($this->bucket, 'append-file', $filePath1, 0);
+            $position = $this->ossClient->appendFile($this->bucket, 'append-file', $gbkfilePath2, $position);
+
+            $res = $this->ossClient->getObject($this->bucket, 'append-file');
+            $this->assertEquals($content1.$content2, $res);
+
+            // multi paet
+            $this->ossClient->multiuploadFile($this->bucket, 'multi-file-123', $filePath1, array(OssClient::OSS_PART_SIZE => 1));
+            $this->ossClient->multiuploadFile($this->bucket, 'multi-file-234', $gbkfilePath2, array(OssClient::OSS_PART_SIZE => 1));
+            $res = $this->ossClient->getObject($this->bucket, 'multi-file-123');
+            $this->assertEquals($content1, $res);
+
+            $res = $this->ossClient->getObject($this->bucket, 'multi-file-234');
+            $this->assertEquals($content2, $res);
+
+            // uploadDir
+            $this->ossClient->uploadDir($this->bucket, "dir", $fileFolder);
+            $options = array(
+                'delimiter' => '',
+                'prefix' => "dir",
+            );
+            $listObjectInfo = $this->ossClient->listObjects($this->bucket, $options);
+            $objectList = $listObjectInfo->getObjectList();
+            $this->assertEquals(2, count($objectList));
+            $this->assertEquals('dir/中文文件名1.txt', $objectList[0]->getKey());
+            $this->assertEquals('dir/中文文件名2.txt', $objectList[1]->getKey());
+
+        } catch (OssException $e) {
+            $this->assertFalse(true);
+        }
+
+        try {
+            unlink($filePath1);
+            unlink($filePath2);
+        } catch (\Exception $e) {
+        }
+    }
+
     protected function setUp(): void
     {
         parent::setUp();
