vendor/symfony/config/ResourceCheckerConfigCache.php line 57

  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.     public function getPath(): string
  44.     {
  45.         return $this->file;
  46.     }
  48.     /**
  49.      * Checks if the cache is still fresh.
  50.      *
  51.      * This implementation will make a decision solely based on the ResourceCheckers
  52.      * passed in the constructor.
  53.      *
  54.      * The first ResourceChecker that supports a given resource is considered authoritative.
  55.      * Resources with no matching ResourceChecker will silently be ignored and considered fresh.
  56.      */
  57.     public function isFresh(): bool
  58.     {
  59.         if (!is_file($this->file)) {
  60.             return false;
  61.         }
  63.         if ($this->resourceCheckers instanceof \Traversable && !$this->resourceCheckers instanceof \Countable) {
  64.             $this->resourceCheckers = iterator_to_array($this->resourceCheckers);
  65.         }
  67.         if (!\count($this->resourceCheckers)) {
  68.             return true; // shortcut - if we don't have any checkers we don't need to bother with the meta file at all
  69.         }
  71.         $metadata = $this->getMetaFile();
  73.         if (!is_file($metadata)) {
  74.             return false;
  75.         }
  77.         $meta = $this->safelyUnserialize($metadata);
  79.         if (false === $meta) {
  80.             return false;
  81.         }
  83.         $time = filemtime($this->file);
  85.         foreach ($meta as $resource) {
  86.             foreach ($this->resourceCheckers as $checker) {
  87.                 if (!$checker->supports($resource)) {
  88.                     continue; // next checker
  89.                 }
  90.                 if ($checker->isFresh($resource, $time)) {
  91.                     break; // no need to further check this resource
  92.                 }
  94.                 return false; // cache is stale
  95.             }
  96.             // no suitable checker found, ignore this resource
  97.         }
  99.         return true;
  100.     }
  102.     /**
  103.      * Writes cache.
  104.      *
  105.      * @param string              $content  The content to write in the cache
  106.      * @param ResourceInterface[] $metadata An array of metadata
  107.      *
  108.      * @throws \RuntimeException When cache file can't be written
  109.      */
  110.     public function write(string $content, array $metadata = null)
  111.     {
  112.         $mode = 0666;
  113.         $umask = umask();
  114.         $filesystem = new Filesystem();
  115.         $filesystem->dumpFile($this->file, $content);
  116.         try {
  117.             $filesystem->chmod($this->file, $mode, $umask);
  118.         } catch (IOException) {
  119.             // discard chmod failure (some filesystem may not support it)
  120.         }
  122.         if (null !== $metadata) {
  123.             $filesystem->dumpFile($this->getMetaFile(), serialize($metadata));
  124.             try {
  125.                 $filesystem->chmod($this->getMetaFile(), $mode, $umask);
  126.             } catch (IOException) {
  127.                 // discard chmod failure (some filesystem may not support it)
  128.             }
  129.         }
  131.         if (\function_exists('opcache_invalidate') && filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOL)) {
  132.             @opcache_invalidate($this->file, true);
  133.         }
  134.     }
  136.     /**
  137.      * Gets the meta file path.
  138.      */
  139.     private function getMetaFile(): string
  140.     {
  141.         return $this->file.'.meta';
  142.     }
  144.     private function safelyUnserialize(string $file)
  145.     {
  146.         $meta = false;
  147.         $content = file_get_contents($file);
  148.         $signalingException = new \UnexpectedValueException();
  149.         $prevUnserializeHandler = ini_set('unserialize_callback_func', self::class.'::handleUnserializeCallback');
  150.         $prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) use (&$prevErrorHandler, $signalingException) {
  151.             if (__FILE__ === $file) {
  152.                 throw $signalingException;
  153.             }
  155.             return $prevErrorHandler ? $prevErrorHandler($type, $msg, $file, $line, $context) : false;
  156.         });
  158.         try {
  159.             $meta = unserialize($content);
  160.         } catch (\Throwable $e) {
  161.             if ($e !== $signalingException) {
  162.                 throw $e;
  163.             }
  164.         } finally {
  165.             restore_error_handler();
  166.             ini_set('unserialize_callback_func', $prevUnserializeHandler);
  167.         }
  169.         return $meta;
  170.     }
  172.     /**
  173.      * @internal
  174.      */
  175.     public static function handleUnserializeCallback(string $class)
  176.     {
  177.         trigger_error('Class not found: '.$class);
  178.     }
  179. }