Merge branch 'dev-baserproject#2773' into dev-baserproject#2773-BcPlugin

nghiem-mb · Oct 16, 2023 · a21a386 · a21a386
2 parents 13c25df + 94062ae
commit a21a386
Show file tree

Hide file tree

Showing 7 changed files with 205 additions and 10 deletions.
diff --git a/plugins/baser-core/src/TestSuite/BcTestCase.php b/plugins/baser-core/src/TestSuite/BcTestCase.php
@@ -17,6 +17,7 @@
 use BaserCore\Service\BcDatabaseService;
 use BaserCore\Utility\BcApiUtil;
 use BaserCore\Utility\BcContainerTrait;
+use BaserCore\Utility\BcFolder;
 use BaserCore\Utility\BcUtil;
 use BcBlog\ServiceProvider\BcBlogServiceProvider;
 use BcContentLink\ServiceProvider\BcContentLinkServiceProvider;
@@ -32,7 +33,6 @@
 use Cake\Datasource\ConnectionManager;
 use Cake\Event\EventListenerInterface;
 use Cake\Event\EventManager;
-use Cake\Filesystem\Folder;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
 use Cake\ORM\TableRegistry;
@@ -46,6 +46,7 @@
 use BaserCore\Annotation\Checked;
 use Cake\Utility\Inflector;
 use CakephpTestSuiteLight\Fixture\TruncateDirtyTables;
+use Couchbase\LookupGetSpec;
 use ReflectionClass;
 use BaserCore\Utility\BcContainer;
 use BaserCore\ServiceProvider\BcServiceProvider;
@@ -424,9 +425,10 @@ public function resetEvent()
      */
     public static function tearDownAfterClass(): void
     {
-        $folder = new Folder();
-        $folder->chmod(LOGS, 0777);
-        $folder->chmod(TMP, 0777);
+        $folder = new BcFolder(LOGS);
+        $folder->chmod( 0777);
+        $folder = new BcFolder(TMP);
+        $folder->chmod(0777);
     }
 
     /**

diff --git a/plugins/baser-core/src/Utility/BcFileUploader.php b/plugins/baser-core/src/Utility/BcFileUploader.php
@@ -12,7 +12,6 @@
 namespace BaserCore\Utility;
 
 use ArrayObject;
-use Cake\Filesystem\File;
 use Cake\Http\Session;
 use Cake\ORM\Entity;
 use Cake\ORM\Table;

diff --git a/plugins/baser-core/src/Utility/BcFolder.php b/plugins/baser-core/src/Utility/BcFolder.php
@@ -14,6 +14,10 @@
 use BaserCore\Annotation\UnitTest;
 use BaserCore\Annotation\NoTodo;
 use BaserCore\Annotation\Checked;
+use Exception;
+use FilesystemIterator;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
 
 /**
  * Class BcFolder
@@ -27,6 +31,21 @@ class BcFolder
      */
     private string $path;
 
+    public int $mode = 0755;
+    /**
+     * Holds messages from last method.
+     *
+     * @var array
+     */
+    protected array $_messages = [];
+
+    /**
+     * Holds errors from last method.
+     *
+     * @var array
+     */
+    protected array $_errors = [];
+
     /**
      * Constructor
      * @param string $path
@@ -195,4 +214,145 @@ public function move($source, $dest): bool
         return $this->copy($source, $dest) && $this->delete();
     }
 
+    /**
+     * ディレクトリ構造のモードを再帰的に変更します。これにはファイルのモードも変更することが含まれます。
+     * @checked
+     * @noTodo
+     * @unitTest
+     */
+    public function chmod(?int $mode = null, bool $recursive = true, array $exceptions = []): bool
+    {
+        $path = $this->path;
+        if (!$mode) {
+            $mode = $this->mode;
+        }
+
+        if ($recursive === false && is_dir($path)) {
+            // phpcs:disable
+            if (@chmod($path, intval($mode, 8))) {
+                // phpcs:enable
+                $this->_messages[] = sprintf('%s changed to %s', $path, $mode);
+
+                return true;
+            }
+
+            $this->_errors[] = sprintf('%s NOT changed to %s', $path, $mode);
+
+            return false;
+        }
+
+        if (is_dir($path)) {
+            $paths = $this->tree($path);
+
+            foreach ($paths as $type) {
+                foreach ($type as $fullpath) {
+                    $check = explode(DIRECTORY_SEPARATOR, $fullpath);
+                    $count = count($check);
+
+                    if (in_array($check[$count - 1], $exceptions, true)) {
+                        continue;
+                    }
+
+                    // phpcs:disable
+                    if (@chmod($fullpath, intval($mode, 8))) {
+                        // phpcs:enable
+                        $this->_messages[] = sprintf('%s changed to %s', $fullpath, $mode);
+                    } else {
+                        $this->_errors[] = sprintf('%s NOT changed to %s', $fullpath, $mode);
+                    }
+                }
+            }
+
+            if (empty($this->_errors)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * 各ディレクトリ内のネストされたディレクトリとファイルの配列を返す
+     * @checked
+     * @noTodo
+     * @unitTest
+     */
+    public function tree(?string $path = null, $exceptions = false, ?string $type = null): array
+    {
+        if (!$path) {
+            $path = $this->path;
+        }
+        $files = [];
+        $directories = [$path];
+
+        if (is_array($exceptions)) {
+            $exceptions = array_flip($exceptions);
+        }
+        $skipHidden = false;
+        if ($exceptions === true) {
+            $skipHidden = true;
+        } elseif (isset($exceptions['.'])) {
+            $skipHidden = true;
+            unset($exceptions['.']);
+        }
+
+        try {
+            $directory = new RecursiveDirectoryIterator(
+                $path,
+                FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_SELF
+            );
+            $iterator = new RecursiveIteratorIterator($directory, RecursiveIteratorIterator::SELF_FIRST);
+        } catch (Exception $e) {
+            unset($directory, $iterator);
+
+            if ($type === null) {
+                return [[], []];
+            }
+
+            return [];
+        }
+
+        /**
+         * @var string $itemPath
+         * @var RecursiveDirectoryIterator $fsIterator
+         */
+        foreach ($iterator as $itemPath => $fsIterator) {
+            if ($skipHidden) {
+                $subPathName = $fsIterator->getSubPathname();
+                if ($subPathName[0] === '.' || str_contains($subPathName, DIRECTORY_SEPARATOR . '.')) {
+                    unset($fsIterator);
+                    continue;
+                }
+            }
+            /** @var \FilesystemIterator $item */
+            $item = $fsIterator->current();
+            if (!empty($exceptions) && isset($exceptions[$item->getFilename()])) {
+                unset($fsIterator, $item);
+                continue;
+            }
+
+            if ($item->isFile()) {
+                $files[] = $itemPath;
+            } elseif ($item->isDir() && !$item->isDot()) {
+                $directories[] = $itemPath;
+            }
+
+            // inner iterators need to be unset too in order for locks on parents to be released
+            unset($fsIterator, $item);
+        }
+
+        // unsetting iterators helps to release possible locks in certain environments,
+        // which could otherwise make `rmdir()` fail
+        unset($directory, $iterator);
+
+        if ($type === null) {
+            return [$directories, $files];
+        }
+        if ($type === 'dir') {
+            return $directories;
+        }
+
+        return $files;
+    }
+
 }
diff --git a/plugins/baser-core/tests/TestCase/Database/Schema/BcSchemaTest.php b/plugins/baser-core/tests/TestCase/Database/Schema/BcSchemaTest.php
@@ -13,7 +13,7 @@
 
 use BaserCore\Database\Schema\BcSchema;
 use BaserCore\TestSuite\BcTestCase;
-use Cake\Filesystem\File;
+use BaserCore\Utility\BcFile;
 
 /**
  * Class BcSchemaTest
@@ -47,7 +47,8 @@ public function setUp(): void
         $path = TMP . 'schema' . DS;
         $schemaName = 'UserActionsSchema';
         $schemaFilePath = $path . $schemaName . '.php';
-        $this->schemaFile = new File($schemaFilePath, true);
+        $this->schemaFile = new BcFile($schemaFilePath);
+        $this->schemaFile->create();
         $table = 'user_actions';
         // スキーマファイルを生成
         $this->schemaFile->write("<?php

diff --git a/plugins/baser-core/tests/TestCase/TestSuite/BcTestCaseTest.php b/plugins/baser-core/tests/TestCase/TestSuite/BcTestCaseTest.php
@@ -13,6 +13,7 @@
 
 use BaserCore\Database\Schema\BcSchema;
 use BaserCore\Utility\BcContainer;
+use BaserCore\Utility\BcFile;
 use BaserCore\View\Helper\BcFormHelper;
 use Cake\Event\Event;
 use Cake\Event\EventManager;
@@ -27,7 +28,6 @@
 use BaserCore\Annotation\NoTodo;
 use BaserCore\Annotation\Checked;
 use BaserCore\Annotation\UnitTest;
-use Cake\Filesystem\File;
 
 /**
  * BaserCore\TestSuite\BcTestCase
@@ -286,7 +286,7 @@ public function testGetPrivateProperty()
     {
         $className = 'DummyClass';
         $filePath = TMP . $className . '.php';
-        $file = new File($filePath, true);
+        $file = new BcFile($filePath);
         // DummyClassファイルを作成する
         $file->write("<?php
 class $className

diff --git a/plugins/baser-core/tests/TestCase/Utility/BcFolderTest.php b/plugins/baser-core/tests/TestCase/Utility/BcFolderTest.php
@@ -94,4 +94,38 @@ public function testDelete()
         $this->assertFalse(is_dir($parent));
 	}
 
+    /**
+     * test chmod
+     */
+    public function test_chmod()
+    {
+        $path = TMP_TESTS . 'test' . DS . 'chmod';
+        $folder = new BcFolder($path);
+        $folder->create();
+        $folder->chmod(0777);
+        $this->assertEquals('0777', substr(sprintf('%o', fileperms($path)), -4));
+        $folder->chmod(0775);
+        $this->assertEquals('0775', substr(sprintf('%o', fileperms($path)), -4));
+        $folder->delete();
+    }
+
+    /**
+     * test tree
+     */
+    public function test_tree()
+    {
+        $path = TMP_TESTS . 'test' . DS . 'tree';
+        $folder = new BcFolder($path);
+        $folder->create();
+        $result = $folder->tree();
+        $this->assertEquals($path, $result[0][0]);
+        (new BcFile($path. DS . 'test.txt'))->create();
+        $result = $folder->tree();
+        $this->assertEquals($path, $result[0][0]);
+        $this->assertEquals($path. DS . 'test.txt', $result[1][0]);
+        $folder->delete();
+    }
+
+
+
 }
diff --git a/plugins/baser-core/tests/TestCase/Utility/BcUpdateLogTest.php b/plugins/baser-core/tests/TestCase/Utility/BcUpdateLogTest.php
@@ -12,7 +12,6 @@
 namespace BaserCore\Test\TestCase\Utility;
 
 use BaserCore\Utility\BcUpdateLog;
-use Cake\Filesystem\File;
 
 /**
  * BcUpdateLogTest