vendor\symfony\config\ResourceCheckerConfigCache.php line 93

Open in your IDE?
  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\Config;
  14. use Symfony\Component\Config\Resource\ResourceInterface;
  15. use Symfony\Component\Filesystem\Exception\IOException;
  16. use Symfony\Component\Filesystem\Filesystem;
  18. /**
  19.  * ResourceCheckerConfigCache uses instances of ResourceCheckerInterface
  20.  * to check whether cached data is still fresh.
  21.  *
  22.  * @author Matthias Pigulla <mp@webfactory.de>
  23.  */
  24. class ResourceCheckerConfigCache implements ConfigCacheInterface
  25. {
  26.     private string $file;
  28.     /**
  29.      * @var iterable<mixed, ResourceCheckerInterface>
  30.      */
  31.     private iterable $resourceCheckers;
  33.     /**
  34.      * @param string                                    $file             The absolute cache path
  35.      * @param iterable<mixed, ResourceCheckerInterface> $resourceCheckers The ResourceCheckers to use for the freshness check
  36.      */
  37.     public function __construct(string $file, iterable $resourceCheckers = [])
  38.     {
  39.         $this->file = $file;
  40.         $this->resourceCheckers = $resourceCheckers;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function getPath(): string
  47.     {
  48.         return $this->file;
  49.     }
  51.     /**
  52.      * Checks if the cache is still fresh.
  53.      *
  54.      * This implementation will make a decision solely based on the ResourceCheckers
  55.      * passed in the constructor.
  56.      *
  57.      * The first ResourceChecker that supports a given resource is considered authoritative.
  58.      * Resources with no matching ResourceChecker will silently be ignored and considered fresh.
  59.      */
  60.     public function isFresh(): bool
  61.     {
  62.         if (!is_file($this->file)) {
  63.             return false;
  64.         }
  66.         if ($this->resourceCheckers instanceof \Traversable && !$this->resourceCheckers instanceof \Countable) {
  67.             $this->resourceCheckers = iterator_to_array($this->resourceCheckers);
  68.         }
  70.         if (!\count($this->resourceCheckers)) {
  71.             return true; // shortcut - if we don't have any checkers we don't need to bother with the meta file at all
  72.         }
  74.         $metadata = $this->getMetaFile();
  76.         if (!is_file($metadata)) {
  77.             return false;
  78.         }
  80.         $meta = $this->safelyUnserialize($metadata);
  82.         if (false === $meta) {
  83.             return false;
  84.         }
  86.         $time = filemtime($this->file);
  88.         foreach ($meta as $resource) {
  89.             foreach ($this->resourceCheckers as $checker) {
  90.                 if (!$checker->supports($resource)) {
  91.                     continue; // next checker
  92.                 }
  93.                 if ($checker->isFresh($resource, $time)) {
  94.                     break; // no need to further check this resource
  95.                 }
  97.                 return false; // cache is stale
  98.             }
  99.             // no suitable checker found, ignore this resource
  100.         }
  102.         return true;
  103.     }
  105.     /**
  106.      * Writes cache.
  107.      *
  108.      * @param string              $content  The content to write in the cache
  109.      * @param ResourceInterface[] $metadata An array of metadata
  110.      *
  111.      * @throws \RuntimeException When cache file can't be written
  112.      */
  113.     public function write(string $content, array $metadata = null)
  114.     {
  115.         $mode = 0666;
  116.         $umask = umask();
  117.         $filesystem = new Filesystem();
  118.         $filesystem->dumpFile($this->file, $content);
  119.         try {
  120.             $filesystem->chmod($this->file, $mode, $umask);
  121.         } catch (IOException) {
  122.             // discard chmod failure (some filesystem may not support it)
  123.         }
  125.         if (null !== $metadata) {
  126.             $filesystem->dumpFile($this->getMetaFile(), serialize($metadata));
  127.             try {
  128.                 $filesystem->chmod($this->getMetaFile(), $mode, $umask);
  129.             } catch (IOException) {
  130.                 // discard chmod failure (some filesystem may not support it)
  131.             }
  132.         }
  134.         if (\function_exists('opcache_invalidate') && filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOLEAN)) {
  135.             @opcache_invalidate($this->file, true);
  136.         }
  137.     }
  139.     /**
  140.      * Gets the meta file path.
  141.      */
  142.     private function getMetaFile(): string
  143.     {
  144.         return $this->file.'.meta';
  145.     }
  147.     private function safelyUnserialize(string $file)
  148.     {
  149.         $meta = false;
  150.         $content = file_get_contents($file);
  151.         $signalingException = new \UnexpectedValueException();
  152.         $prevUnserializeHandler = ini_set('unserialize_callback_func', self::class.'::handleUnserializeCallback');
  153.         $prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) use (&$prevErrorHandler, $signalingException) {
  154.             if (__FILE__ === $file) {
  155.                 throw $signalingException;
  156.             }
  158.             return $prevErrorHandler ? $prevErrorHandler($type, $msg, $file, $line, $context) : false;
  159.         });
  161.         try {
  162.             $meta = unserialize($content);
  163.         } catch (\Throwable $e) {
  164.             if ($e !== $signalingException) {
  165.                 throw $e;
  166.             }
  167.         } finally {
  168.             restore_error_handler();
  169.             ini_set('unserialize_callback_func', $prevUnserializeHandler);
  170.         }
  172.         return $meta;
  173.     }
  175.     /**
  176.      * @internal
  177.      */
  178.     public static function handleUnserializeCallback(string $class)
  179.     {
  180.         trigger_error('Class not found: '.$class);
  181.     }
  182. }