vendor/symfony/cache/Adapter/ArrayAdapter.php line 76

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Cache\Adapter;
  11. use Psr\Cache\CacheItemInterface;
  12. use Psr\Log\LoggerAwareInterface;
  13. use Psr\Log\LoggerAwareTrait;
  14. use Symfony\Component\Cache\CacheItem;
  15. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  16. use Symfony\Component\Cache\ResettableInterface;
  17. use Symfony\Contracts\Cache\CacheInterface;
  18. /**
  19.  * An in-memory cache storage.
  20.  *
  21.  * Acts as a least-recently-used (LRU) storage when configured with a maximum number of items.
  22.  *
  23.  * @author Nicolas Grekas <p@tchwork.com>
  24.  */
  25. class ArrayAdapter implements AdapterInterfaceCacheInterfaceLoggerAwareInterfaceResettableInterface
  26. {
  27.     use LoggerAwareTrait;
  28.     private $storeSerialized;
  29.     private $values = [];
  30.     private $expiries = [];
  31.     private $defaultLifetime;
  32.     private $maxLifetime;
  33.     private $maxItems;
  34.     private static $createCacheItem;
  35.     /**
  36.      * @param bool $storeSerialized Disabling serialization can lead to cache corruptions when storing mutable values but increases performance otherwise
  37.      */
  38.     public function __construct(int $defaultLifetime 0bool $storeSerialized truefloat $maxLifetime 0int $maxItems 0)
  39.     {
  40.         if ($maxLifetime) {
  41.             throw new InvalidArgumentException(sprintf('Argument $maxLifetime must be positive, %F passed.'$maxLifetime));
  42.         }
  43.         if ($maxItems) {
  44.             throw new InvalidArgumentException(sprintf('Argument $maxItems must be a positive integer, %d passed.'$maxItems));
  45.         }
  46.         $this->defaultLifetime $defaultLifetime;
  47.         $this->storeSerialized $storeSerialized;
  48.         $this->maxLifetime $maxLifetime;
  49.         $this->maxItems $maxItems;
  50.         self::$createCacheItem ?? self::$createCacheItem \Closure::bind(
  51.             static function ($key$value$isHit) {
  52.                 $item = new CacheItem();
  53.                 $item->key $key;
  54.                 $item->value $value;
  55.                 $item->isHit $isHit;
  56.                 return $item;
  57.             },
  58.             null,
  59.             CacheItem::class
  60.         );
  61.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function get(string $key, callable $callback, ?float $beta null, ?array &$metadata null)
  66.     {
  67.         $item $this->getItem($key);
  68.         $metadata $item->getMetadata();
  69.         // ArrayAdapter works in memory, we don't care about stampede protection
  70.         if (\INF === $beta || !$item->isHit()) {
  71.             $save true;
  72.             $item->set($callback($item$save));
  73.             if ($save) {
  74.                 $this->save($item);
  75.             }
  76.         }
  77.         return $item->get();
  78.     }
  79.     /**
  80.      * {@inheritdoc}
  81.      */
  82.     public function delete(string $key): bool
  83.     {
  84.         return $this->deleteItem($key);
  85.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      *
  89.      * @return bool
  90.      */
  91.     public function hasItem($key)
  92.     {
  93.         if (\is_string($key) && isset($this->expiries[$key]) && $this->expiries[$key] > microtime(true)) {
  94.             if ($this->maxItems) {
  95.                 // Move the item last in the storage
  96.                 $value $this->values[$key];
  97.                 unset($this->values[$key]);
  98.                 $this->values[$key] = $value;
  99.             }
  100.             return true;
  101.         }
  102.         \assert('' !== CacheItem::validateKey($key));
  103.         return isset($this->expiries[$key]) && !$this->deleteItem($key);
  104.     }
  105.     /**
  106.      * {@inheritdoc}
  107.      */
  108.     public function getItem($key)
  109.     {
  110.         if (!$isHit $this->hasItem($key)) {
  111.             $value null;
  112.             if (!$this->maxItems) {
  113.                 // Track misses in non-LRU mode only
  114.                 $this->values[$key] = null;
  115.             }
  116.         } else {
  117.             $value $this->storeSerialized $this->unfreeze($key$isHit) : $this->values[$key];
  118.         }
  119.         return (self::$createCacheItem)($key$value$isHit);
  120.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function getItems(array $keys = [])
  125.     {
  126.         \assert(self::validateKeys($keys));
  127.         return $this->generateItems($keysmicrotime(true), self::$createCacheItem);
  128.     }
  129.     /**
  130.      * {@inheritdoc}
  131.      *
  132.      * @return bool
  133.      */
  134.     public function deleteItem($key)
  135.     {
  136.         \assert('' !== CacheItem::validateKey($key));
  137.         unset($this->values[$key], $this->expiries[$key]);
  138.         return true;
  139.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      *
  143.      * @return bool
  144.      */
  145.     public function deleteItems(array $keys)
  146.     {
  147.         foreach ($keys as $key) {
  148.             $this->deleteItem($key);
  149.         }
  150.         return true;
  151.     }
  152.     /**
  153.      * {@inheritdoc}
  154.      *
  155.      * @return bool
  156.      */
  157.     public function save(CacheItemInterface $item)
  158.     {
  159.         if (!$item instanceof CacheItem) {
  160.             return false;
  161.         }
  162.         $item = (array) $item;
  163.         $key $item["\0*\0key"];
  164.         $value $item["\0*\0value"];
  165.         $expiry $item["\0*\0expiry"];
  166.         $now microtime(true);
  167.         if (null !== $expiry) {
  168.             if (!$expiry) {
  169.                 $expiry \PHP_INT_MAX;
  170.             } elseif ($expiry <= $now) {
  171.                 $this->deleteItem($key);
  172.                 return true;
  173.             }
  174.         }
  175.         if ($this->storeSerialized && null === $value $this->freeze($value$key)) {
  176.             return false;
  177.         }
  178.         if (null === $expiry && $this->defaultLifetime) {
  179.             $expiry $this->defaultLifetime;
  180.             $expiry $now + ($expiry > ($this->maxLifetime ?: $expiry) ? $this->maxLifetime $expiry);
  181.         } elseif ($this->maxLifetime && (null === $expiry || $expiry $now $this->maxLifetime)) {
  182.             $expiry $now $this->maxLifetime;
  183.         }
  184.         if ($this->maxItems) {
  185.             unset($this->values[$key]);
  186.             // Iterate items and vacuum expired ones while we are at it
  187.             foreach ($this->values as $k => $v) {
  188.                 if ($this->expiries[$k] > $now && \count($this->values) < $this->maxItems) {
  189.                     break;
  190.                 }
  191.                 unset($this->values[$k], $this->expiries[$k]);
  192.             }
  193.         }
  194.         $this->values[$key] = $value;
  195.         $this->expiries[$key] = $expiry ?? \PHP_INT_MAX;
  196.         return true;
  197.     }
  198.     /**
  199.      * {@inheritdoc}
  200.      *
  201.      * @return bool
  202.      */
  203.     public function saveDeferred(CacheItemInterface $item)
  204.     {
  205.         return $this->save($item);
  206.     }
  207.     /**
  208.      * {@inheritdoc}
  209.      *
  210.      * @return bool
  211.      */
  212.     public function commit()
  213.     {
  214.         return true;
  215.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      *
  219.      * @return bool
  220.      */
  221.     public function clear(string $prefix '')
  222.     {
  223.         if ('' !== $prefix) {
  224.             $now microtime(true);
  225.             foreach ($this->values as $key => $value) {
  226.                 if (!isset($this->expiries[$key]) || $this->expiries[$key] <= $now || === strpos($key$prefix)) {
  227.                     unset($this->values[$key], $this->expiries[$key]);
  228.                 }
  229.             }
  230.             if ($this->values) {
  231.                 return true;
  232.             }
  233.         }
  234.         $this->values $this->expiries = [];
  235.         return true;
  236.     }
  237.     /**
  238.      * Returns all cached values, with cache miss as null.
  239.      *
  240.      * @return array
  241.      */
  242.     public function getValues()
  243.     {
  244.         if (!$this->storeSerialized) {
  245.             return $this->values;
  246.         }
  247.         $values $this->values;
  248.         foreach ($values as $k => $v) {
  249.             if (null === $v || 'N;' === $v) {
  250.                 continue;
  251.             }
  252.             if (!\is_string($v) || !isset($v[2]) || ':' !== $v[1]) {
  253.                 $values[$k] = serialize($v);
  254.             }
  255.         }
  256.         return $values;
  257.     }
  258.     /**
  259.      * {@inheritdoc}
  260.      */
  261.     public function reset()
  262.     {
  263.         $this->clear();
  264.     }
  265.     private function generateItems(array $keysfloat $now\Closure $f): \Generator
  266.     {
  267.         foreach ($keys as $i => $key) {
  268.             if (!$isHit = isset($this->expiries[$key]) && ($this->expiries[$key] > $now || !$this->deleteItem($key))) {
  269.                 $value null;
  270.                 if (!$this->maxItems) {
  271.                     // Track misses in non-LRU mode only
  272.                     $this->values[$key] = null;
  273.                 }
  274.             } else {
  275.                 if ($this->maxItems) {
  276.                     // Move the item last in the storage
  277.                     $value $this->values[$key];
  278.                     unset($this->values[$key]);
  279.                     $this->values[$key] = $value;
  280.                 }
  281.                 $value $this->storeSerialized $this->unfreeze($key$isHit) : $this->values[$key];
  282.             }
  283.             unset($keys[$i]);
  284.             yield $key => $f($key$value$isHit);
  285.         }
  286.         foreach ($keys as $key) {
  287.             yield $key => $f($keynullfalse);
  288.         }
  289.     }
  290.     private function freeze($valuestring $key)
  291.     {
  292.         if (null === $value) {
  293.             return 'N;';
  294.         }
  295.         if (\is_string($value)) {
  296.             // Serialize strings if they could be confused with serialized objects or arrays
  297.             if ('N;' === $value || (isset($value[2]) && ':' === $value[1])) {
  298.                 return serialize($value);
  299.             }
  300.         } elseif (!\is_scalar($value)) {
  301.             try {
  302.                 $serialized serialize($value);
  303.             } catch (\Exception $e) {
  304.                 unset($this->values[$key]);
  305.                 $type get_debug_type($value);
  306.                 $message sprintf('Failed to save key "{key}" of type %s: %s'$type$e->getMessage());
  307.                 CacheItem::log($this->logger$message, ['key' => $key'exception' => $e'cache-adapter' => get_debug_type($this)]);
  308.                 return;
  309.             }
  310.             // Keep value serialized if it contains any objects or any internal references
  311.             if ('C' === $serialized[0] || 'O' === $serialized[0] || preg_match('/;[OCRr]:[1-9]/'$serialized)) {
  312.                 return $serialized;
  313.             }
  314.         }
  315.         return $value;
  316.     }
  317.     private function unfreeze(string $keybool &$isHit)
  318.     {
  319.         if ('N;' === $value $this->values[$key]) {
  320.             return null;
  321.         }
  322.         if (\is_string($value) && isset($value[2]) && ':' === $value[1]) {
  323.             try {
  324.                 $value unserialize($value);
  325.             } catch (\Exception $e) {
  326.                 CacheItem::log($this->logger'Failed to unserialize key "{key}": '.$e->getMessage(), ['key' => $key'exception' => $e'cache-adapter' => get_debug_type($this)]);
  327.                 $value false;
  328.             }
  329.             if (false === $value) {
  330.                 $value null;
  331.                 $isHit false;
  332.                 if (!$this->maxItems) {
  333.                     $this->values[$key] = null;
  334.                 }
  335.             }
  336.         }
  337.         return $value;
  338.     }
  339.     private function validateKeys(array $keys): bool
  340.     {
  341.         foreach ($keys as $key) {
  342.             if (!\is_string($key) || !isset($this->expiries[$key])) {
  343.                 CacheItem::validateKey($key);
  344.             }
  345.         }
  346.         return true;
  347.     }
  348. }