refactor: deprecate redundant FileHandler cache methods

paulbalandan · paulbalandan · commit 84569d6a4acc · 2025-04-11T02:07:54.000+08:00
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -63,6 +63,8 @@ public function __construct(Cache $config)
 
         $this->mode   = $config->file['mode'] ?? 0640;
         $this->prefix = $config->prefix;
+
+        helper('filesystem');
     }
 
     /**
@@ -96,7 +98,7 @@ public function save(string $key, $value, int $ttl = 60)
             'data' => $value,
         ];
 
-        if ($this->writeFile($this->path . $key, serialize($contents))) {
+        if (write_file($this->path . $key, serialize($contents))) {
             try {
                 chmod($this->path . $key, $this->mode);
 
@@ -176,15 +178,15 @@ public function decrement(string $key, int $offset = 1)
      */
     public function clean()
     {
-        return $this->deleteFiles($this->path, false, true);
+        return delete_files($this->path, false, true);
     }
 
     /**
      * {@inheritDoc}
      */
     public function getCacheInfo()
     {
-        return $this->getDirFileInfo($this->path);
+        return get_dir_file_info($this->path);
     }
 
     /**
@@ -251,6 +253,8 @@ protected function getItem(string $filename)
     /**
      * Writes a file to disk, or returns false if not successful.
      *
+     * @deprecated 4.6.1 Use `write_file()` instead.
+     *
      * @param string $path
      * @param string $data
      * @param string $mode
@@ -259,22 +263,7 @@ protected function getItem(string $filename)
      */
     protected function writeFile($path, $data, $mode = 'wb')
     {
-        if (($fp = @fopen($path, $mode)) === false) {
-            return false;
-        }
-
-        flock($fp, LOCK_EX);
-
-        for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {
-            if (($result = fwrite($fp, substr($data, $written))) === false) {
-                break;
-            }
-        }
-
-        flock($fp, LOCK_UN);
-        fclose($fp);
-
-        return is_int($result);
+        return write_file($path, $data, $mode);
     }
 
     /**
@@ -283,33 +272,17 @@ protected function writeFile($path, $data, $mode = 'wb')
      * If the second parameter is set to TRUE, any directories contained
      * within the supplied base directory will be nuked as well.
      *
+     * @deprecated 4.6.1 Use `delete_files()` instead.
+     *
      * @param string $path   File path
      * @param bool   $delDir Whether to delete any directories found in the path
      * @param bool   $htdocs Whether to skip deleting .htaccess and index page files
-     * @param int    $_level Current directory depth level (default: 0; internal use only)
+     * @param int    $_level Current directory depth level (default: 0; internal use only; unused)
      */
     protected function deleteFiles(string $path, bool $delDir = false, bool $htdocs = false, int $_level = 0): bool
     {
-        // Trim the trailing slash
-        $path = rtrim($path, '/\\');
-
-        if (! $currentDir = @opendir($path)) {
-            return false;
-        }
-
-        while (false !== ($filename = @readdir($currentDir))) {
-            if ($filename !== '.' && $filename !== '..') {
-                if (is_dir($path . DIRECTORY_SEPARATOR . $filename) && $filename[0] !== '.') {
-                    $this->deleteFiles($path . DIRECTORY_SEPARATOR . $filename, $delDir, $htdocs, $_level + 1);
-                } elseif (! $htdocs || preg_match('/^(\.htaccess|index\.(html|htm|php)|web\.config)$/i', $filename) !== 1) {
-                    @unlink($path . DIRECTORY_SEPARATOR . $filename);
-                }
-            }
-        }
-
-        closedir($currentDir);
-
-        return ($delDir && $_level > 0) ? @rmdir($path) : true;
+        // $hidden is set to default false as original implementation skips hidden files
+        return delete_files($path, $delDir, $htdocs);
     }
 
     /**
@@ -318,6 +291,8 @@ protected function deleteFiles(string $path, bool $delDir = false, bool $htdocs
      *
      * Any sub-folders contained within the specified path are read as well.
      *
+     * @deprecated 4.6.1 Use `get_dir_file_info()` instead.
+     *
      * @param string $sourceDir    Path to source
      * @param bool   $topLevelOnly Look only at the top level directory specified?
      * @param bool   $_recursion   Internal variable to determine recursion status - do not use in calls
@@ -326,29 +301,12 @@ protected function deleteFiles(string $path, bool $delDir = false, bool $htdocs
      */
     protected function getDirFileInfo(string $sourceDir, bool $topLevelOnly = true, bool $_recursion = false)
     {
-        static $_filedata = [];
-        $relativePath     = $sourceDir;
-
-        if ($fp = @opendir($sourceDir)) {
-            // reset the array and make sure $sourceDir has a trailing slash on the initial call
-            if ($_recursion === false) {
-                $_filedata = [];
-                $sourceDir = rtrim(realpath($sourceDir) ?: $sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-            }
-
-            // Used to be foreach (scandir($sourceDir, 1) as $file), but scandir() is simply not as fast
-            while (false !== ($file = readdir($fp))) {
-                if (is_dir($sourceDir . $file) && $file[0] !== '.' && $topLevelOnly === false) {
-                    $this->getDirFileInfo($sourceDir . $file . DIRECTORY_SEPARATOR, $topLevelOnly, true);
-                } elseif (! is_dir($sourceDir . $file) && $file[0] !== '.') {
-                    $_filedata[$file]                  = $this->getFileInfo($sourceDir . $file);
-                    $_filedata[$file]['relative_path'] = $relativePath;
-                }
-            }
+        $fp = @opendir($sourceDir);
 
+        if ($fp !== false) {
             closedir($fp);
 
-            return $_filedata;
+            return get_dir_file_info($sourceDir, $topLevelOnly, $_recursion);
         }
 
         return false;
@@ -360,59 +318,15 @@ protected function getDirFileInfo(string $sourceDir, bool $topLevelOnly = true,
      * Options are: name, server_path, size, date, readable, writable, executable, fileperms
      * Returns FALSE if the file cannot be found.
      *
+     * @deprecated 4.6.1 Use `get_file_info()` instead.
+     *
      * @param string       $file           Path to file
      * @param array|string $returnedValues Array or comma separated string of information returned
      *
      * @return array|false
      */
     protected function getFileInfo(string $file, $returnedValues = ['name', 'server_path', 'size', 'date'])
     {
-        if (! is_file($file)) {
-            return false;
-        }
-
-        if (is_string($returnedValues)) {
-            $returnedValues = explode(',', $returnedValues);
-        }
-
-        $fileInfo = [];
-
-        foreach ($returnedValues as $key) {
-            switch ($key) {
-                case 'name':
-                    $fileInfo['name'] = basename($file);
-                    break;
-
-                case 'server_path':
-                    $fileInfo['server_path'] = $file;
-                    break;
-
-                case 'size':
-                    $fileInfo['size'] = filesize($file);
-                    break;
-
-                case 'date':
-                    $fileInfo['date'] = filemtime($file);
-                    break;
-
-                case 'readable':
-                    $fileInfo['readable'] = is_readable($file);
-                    break;
-
-                case 'writable':
-                    $fileInfo['writable'] = is_writable($file);
-                    break;
-
-                case 'executable':
-                    $fileInfo['executable'] = is_executable($file);
-                    break;
-
-                case 'fileperms':
-                    $fileInfo['fileperms'] = fileperms($file);
-                    break;
-            }
-        }
-
-        return $fileInfo;
+        return get_file_info($file, $returnedValues) ?? false;
     }
 }
diff --git a/system/Helpers/filesystem_helper.php b/system/Helpers/filesystem_helper.php
@@ -123,8 +123,12 @@ function write_file(string $path, string $data, string $mode = 'wb'): bool
 
             flock($fp, LOCK_EX);
 
-            for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {
-                if (($result = fwrite($fp, substr($data, $written))) === false) {
+            $result = 0;
+
+            for ($written = 0, $length = strlen($data); $written < $length; $written += $result) {
+                $result = fwrite($fp, substr($data, $written));
+
+                if ($result === false) {
                     break;
                 }
             }
diff --git a/user_guide_src/source/changelogs/v4.6.1.rst b/user_guide_src/source/changelogs/v4.6.1.rst
@@ -26,6 +26,11 @@ Changes
 Deprecations
 ************
 
+- **Cache:** The ``FileHandler::writeFile()`` method is deprecated. Use ``write_file()`` instead.
+- **Cache:** The ``FileHandler::deleteFiles()`` method is deprecated. Use ``delete_files()`` instead.
+- **Cache:** The ``FileHandler::getDirFileInfo()`` method is deprecated. Use ``get_dir_file_info()`` instead.
+- **Cache:** The ``FileHandler::getFileInfo()`` method is deprecated. Use ``get_file_info()`` instead.
+
 **********
 Bugs Fixed
 **********
diff --git a/utils/phpstan-baseline/loader.neon b/utils/phpstan-baseline/loader.neon
@@ -1,4 +1,4 @@
-# total 3760 errors
+# total 3757 errors
 includes:
     - argument.type.neon
     - assign.propertyType.neon
diff --git a/utils/phpstan-baseline/ternary.shortNotAllowed.neon b/utils/phpstan-baseline/ternary.shortNotAllowed.neon
@@ -1,4 +1,4 @@
-# total 37 errors
+# total 36 errors
 
 parameters:
     ignoreErrors:
@@ -7,11 +7,6 @@ parameters:
             count: 2
             path: ../../system/CLI/CLI.php
 
-        -
-            message: '#^Short ternary operator is not allowed\. Use null coalesce operator if applicable or consider using long ternary\.$#'
-            count: 1
-            path: ../../system/Cache/Handlers/FileHandler.php
-
         -
             message: '#^Short ternary operator is not allowed\. Use null coalesce operator if applicable or consider using long ternary\.$#'
             count: 1
diff --git a/utils/phpstan-baseline/variable.undefined.neon b/utils/phpstan-baseline/variable.undefined.neon
@@ -1,17 +1,7 @@
-# total 21 errors
+# total 19 errors
 
 parameters:
     ignoreErrors:
-        -
-            message: '#^Variable \$result might not be defined\.$#'
-            count: 1
-            path: ../../system/Cache/Handlers/FileHandler.php
-
-        -
-            message: '#^Variable \$result might not be defined\.$#'
-            count: 1
-            path: ../../system/Helpers/filesystem_helper.php
-
         -
             message: '#^Variable \$written might not be defined\.$#'
             count: 1

Original file line number	Diff line number	Diff line change
`@@ -123,8 +123,12 @@ function write_file(string $path, string $data, string $mode = 'wb'): bool`
`123`	`123`
`124`	`124`	`flock($fp, LOCK_EX);`
`125`	`125`
`126`		`- for ($result = $written = 0, $length = strlen($data); $written < $length; $written += $result) {`
`127`		`- if (($result = fwrite($fp, substr($data, $written))) === false) {`
	`126`	`+ $result = 0;`
	`127`	`+`
	`128`	`+ for ($written = 0, $length = strlen($data); $written < $length; $written += $result) {`
	`129`	`+ $result = fwrite($fp, substr($data, $written));`
	`130`	`+`
	`131`	`+ if ($result === false) {`
`128`	`132`	`break;`
`129`	`133`	`}`
`130`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# total 3760 errors`
	`1`	`+# total 3757 errors`
`2`	`2`	`includes:`
`3`	`3`	`- argument.type.neon`
`4`	`4`	`- assign.propertyType.neon`