vendor/symfony/cache/Traits/FilesystemCommonTrait.php line 120

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Cache\Traits;
  14. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  16. /**
  17.  * @author Nicolas Grekas <p@tchwork.com>
  18.  *
  19.  * @internal
  20.  */
  21. trait FilesystemCommonTrait
  22. {
  23.     private string $directory;
  24.     private string $tmpSuffix;
  26.     private function init(string $namespace, ?string $directory)
  27.     {
  28.         if (!isset($directory[0])) {
  29.             $directory = sys_get_temp_dir().\DIRECTORY_SEPARATOR.'symfony-cache';
  30.         } else {
  31.             $directory = realpath($directory) ?: $directory;
  32.         }
  33.         if (isset($namespace[0])) {
  34.             if (preg_match('#[^-+_.A-Za-z0-9]#', $namespace, $match)) {
  35.                 throw new InvalidArgumentException(sprintf('Namespace contains "%s" but only characters in [-+_.A-Za-z0-9] are allowed.', $match[0]));
  36.             }
  37.             $directory .= \DIRECTORY_SEPARATOR.$namespace;
  38.         } else {
  39.             $directory .= \DIRECTORY_SEPARATOR.'@';
  40.         }
  41.         if (!is_dir($directory)) {
  42.             @mkdir($directory, 0777, true);
  43.         }
  44.         $directory .= \DIRECTORY_SEPARATOR;
  45.         // On Windows the whole path is limited to 258 chars
  46.         if ('\\' === \DIRECTORY_SEPARATOR && \strlen($directory) > 234) {
  47.             throw new InvalidArgumentException(sprintf('Cache directory too long (%s).', $directory));
  48.         }
  50.         $this->directory = $directory;
  51.     }
  53.     protected function doClear(string $namespace): bool
  54.     {
  55.         $ok = true;
  57.         foreach ($this->scanHashDir($this->directory) as $file) {
  58.             if ('' !== $namespace && !str_starts_with($this->getFileKey($file), $namespace)) {
  59.                 continue;
  60.             }
  62.             $ok = ($this->doUnlink($file) || !file_exists($file)) && $ok;
  63.         }
  65.         return $ok;
  66.     }
  68.     protected function doDelete(array $ids): bool
  69.     {
  70.         $ok = true;
  72.         foreach ($ids as $id) {
  73.             $file = $this->getFile($id);
  74.             $ok = (!is_file($file) || $this->doUnlink($file) || !file_exists($file)) && $ok;
  75.         }
  77.         return $ok;
  78.     }
  80.     protected function doUnlink(string $file)
  81.     {
  82.         return @unlink($file);
  83.     }
  85.     private function write(string $file, string $data, int $expiresAt = null)
  86.     {
  87.         set_error_handler(__CLASS__.'::throwError');
  88.         try {
  89.             $tmp = $this->directory.$this->tmpSuffix ??= str_replace('/', '-', base64_encode(random_bytes(6)));
  90.             try {
  91.                 $h = fopen($tmp, 'x');
  92.             } catch (\ErrorException $e) {
  93.                 if (!str_contains($e->getMessage(), 'File exists')) {
  94.                     throw $e;
  95.                 }
  97.                 $tmp = $this->directory.$this->tmpSuffix = str_replace('/', '-', base64_encode(random_bytes(6)));
  98.                 $h = fopen($tmp, 'x');
  99.             }
  100.             fwrite($h, $data);
  101.             fclose($h);
  103.             if (null !== $expiresAt) {
  104.                 touch($tmp, $expiresAt ?: time() + 31556952); // 1 year in seconds
  105.             }
  107.             return rename($tmp, $file);
  108.         } finally {
  109.             restore_error_handler();
  110.         }
  111.     }
  113.     private function getFile(string $id, bool $mkdir = false, string $directory = null)
  114.     {
  115.         // Use MD5 to favor speed over security, which is not an issue here
  116.         $hash = str_replace('/', '-', base64_encode(hash('md5', static::class.$id, true)));
  117.         $dir = ($directory ?? $this->directory).strtoupper($hash[0].\DIRECTORY_SEPARATOR.$hash[1].\DIRECTORY_SEPARATOR);
  119.         if ($mkdir && !is_dir($dir)) {
  120.             @mkdir($dir, 0777, true);
  121.         }
  123.         return $dir.substr($hash, 2, 20);
  124.     }
  126.     private function getFileKey(string $file): string
  127.     {
  128.         return '';
  129.     }
  131.     private function scanHashDir(string $directory): \Generator
  132.     {
  133.         if (!is_dir($directory)) {
  134.             return;
  135.         }
  137.         $chars = '+-ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
  139.         for ($i = 0; $i < 38; ++$i) {
  140.             if (!is_dir($directory.$chars[$i])) {
  141.                 continue;
  142.             }
  144.             for ($j = 0; $j < 38; ++$j) {
  145.                 if (!is_dir($dir = $directory.$chars[$i].\DIRECTORY_SEPARATOR.$chars[$j])) {
  146.                     continue;
  147.                 }
  149.                 foreach (@scandir($dir, \SCANDIR_SORT_NONE) ?: [] as $file) {
  150.                     if ('.' !== $file && '..' !== $file) {
  151.                         yield $dir.\DIRECTORY_SEPARATOR.$file;
  152.                     }
  153.                 }
  154.             }
  155.         }
  156.     }
  158.     /**
  159.      * @internal
  160.      */
  161.     public static function throwError(int $type, string $message, string $file, int $line)
  162.     {
  163.         throw new \ErrorException($message, 0, $type, $file, $line);
  164.     }
  166.     public function __sleep(): array
  167.     {
  168.         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
  169.     }
  171.     public function __wakeup()
  172.     {
  173.         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  174.     }
  176.     public function __destruct()
  177.     {
  178.         if (method_exists(parent::class, '__destruct')) {
  179.             parent::__destruct();
  180.         }
  181.         if (isset($this->tmpSuffix) && is_file($this->directory.$this->tmpSuffix)) {
  182.             unlink($this->directory.$this->tmpSuffix);
  183.         }
  184.     }
  185. }