390 lines
12 KiB
PHP
390 lines
12 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This file is part of the Symfony package.
|
||
|
|
*
|
||
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Symfony\Component\Cache\Adapter;
|
||
|
|
|
||
|
|
use Psr\Cache\CacheItemInterface;
|
||
|
|
use Psr\Cache\CacheItemPoolInterface;
|
||
|
|
use Symfony\Component\Cache\CacheItem;
|
||
|
|
use Symfony\Component\Cache\Exception\InvalidArgumentException;
|
||
|
|
use Symfony\Component\Cache\PruneableInterface;
|
||
|
|
use Symfony\Component\Cache\ResettableInterface;
|
||
|
|
use Symfony\Component\Cache\Traits\ContractsTrait;
|
||
|
|
use Symfony\Component\Cache\Traits\ProxyTrait;
|
||
|
|
use Symfony\Component\VarExporter\VarExporter;
|
||
|
|
use Symfony\Contracts\Cache\CacheInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Caches items at warm up time using a PHP array that is stored in shared memory by OPCache since PHP 7.0.
|
||
|
|
* Warmed up items are read-only and run-time discovered items are cached using a fallback adapter.
|
||
|
|
*
|
||
|
|
* @author Titouan Galopin <galopintitouan@gmail.com>
|
||
|
|
* @author Nicolas Grekas <p@tchwork.com>
|
||
|
|
*/
|
||
|
|
class PhpArrayAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
|
||
|
|
{
|
||
|
|
use ContractsTrait;
|
||
|
|
use ProxyTrait;
|
||
|
|
|
||
|
|
private array $keys;
|
||
|
|
private array $values;
|
||
|
|
|
||
|
|
private static \Closure $createCacheItem;
|
||
|
|
private static array $valuesCache = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $file The PHP file were values are cached
|
||
|
|
* @param AdapterInterface $fallbackPool A pool to fallback on when an item is not hit
|
||
|
|
*/
|
||
|
|
public function __construct(
|
||
|
|
private string $file,
|
||
|
|
AdapterInterface $fallbackPool,
|
||
|
|
) {
|
||
|
|
$this->pool = $fallbackPool;
|
||
|
|
self::$createCacheItem ??= \Closure::bind(
|
||
|
|
static function ($key, $value, $isHit) {
|
||
|
|
$item = new CacheItem();
|
||
|
|
$item->key = $key;
|
||
|
|
$item->value = $value;
|
||
|
|
$item->isHit = $isHit;
|
||
|
|
|
||
|
|
return $item;
|
||
|
|
},
|
||
|
|
null,
|
||
|
|
CacheItem::class
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This adapter takes advantage of how PHP stores arrays in its latest versions.
|
||
|
|
*
|
||
|
|
* @param string $file The PHP file were values are cached
|
||
|
|
* @param CacheItemPoolInterface $fallbackPool A pool to fallback on when an item is not hit
|
||
|
|
*/
|
||
|
|
public static function create(string $file, CacheItemPoolInterface $fallbackPool): CacheItemPoolInterface
|
||
|
|
{
|
||
|
|
if (!$fallbackPool instanceof AdapterInterface) {
|
||
|
|
$fallbackPool = new ProxyAdapter($fallbackPool);
|
||
|
|
}
|
||
|
|
|
||
|
|
return new static($file, $fallbackPool);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function get(string $key, callable $callback, ?float $beta = null, ?array &$metadata = null): mixed
|
||
|
|
{
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
if (!isset($this->keys[$key])) {
|
||
|
|
get_from_pool:
|
||
|
|
if ($this->pool instanceof CacheInterface) {
|
||
|
|
return $this->pool->get($key, $callback, $beta, $metadata);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->doGet($this->pool, $key, $callback, $beta, $metadata);
|
||
|
|
}
|
||
|
|
$value = $this->values[$this->keys[$key]];
|
||
|
|
|
||
|
|
if ('N;' === $value) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
try {
|
||
|
|
if ($value instanceof \Closure) {
|
||
|
|
return $value();
|
||
|
|
}
|
||
|
|
} catch (\Throwable) {
|
||
|
|
unset($this->keys[$key]);
|
||
|
|
goto get_from_pool;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getItem(mixed $key): CacheItem
|
||
|
|
{
|
||
|
|
if (!\is_string($key)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given.', get_debug_type($key)));
|
||
|
|
}
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
if (!isset($this->keys[$key])) {
|
||
|
|
return $this->pool->getItem($key);
|
||
|
|
}
|
||
|
|
|
||
|
|
$value = $this->values[$this->keys[$key]];
|
||
|
|
$isHit = true;
|
||
|
|
|
||
|
|
if ('N;' === $value) {
|
||
|
|
$value = null;
|
||
|
|
} elseif ($value instanceof \Closure) {
|
||
|
|
try {
|
||
|
|
$value = $value();
|
||
|
|
} catch (\Throwable) {
|
||
|
|
$value = null;
|
||
|
|
$isHit = false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return (self::$createCacheItem)($key, $value, $isHit);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getItems(array $keys = []): iterable
|
||
|
|
{
|
||
|
|
foreach ($keys as $key) {
|
||
|
|
if (!\is_string($key)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given.', get_debug_type($key)));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->generateItems($keys);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function hasItem(mixed $key): bool
|
||
|
|
{
|
||
|
|
if (!\is_string($key)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given.', get_debug_type($key)));
|
||
|
|
}
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
return isset($this->keys[$key]) || $this->pool->hasItem($key);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function deleteItem(mixed $key): bool
|
||
|
|
{
|
||
|
|
if (!\is_string($key)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given.', get_debug_type($key)));
|
||
|
|
}
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
return !isset($this->keys[$key]) && $this->pool->deleteItem($key);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function deleteItems(array $keys): bool
|
||
|
|
{
|
||
|
|
$deleted = true;
|
||
|
|
$fallbackKeys = [];
|
||
|
|
|
||
|
|
foreach ($keys as $key) {
|
||
|
|
if (!\is_string($key)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key must be string, "%s" given.', get_debug_type($key)));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($this->keys[$key])) {
|
||
|
|
$deleted = false;
|
||
|
|
} else {
|
||
|
|
$fallbackKeys[] = $key;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($fallbackKeys) {
|
||
|
|
$deleted = $this->pool->deleteItems($fallbackKeys) && $deleted;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $deleted;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function save(CacheItemInterface $item): bool
|
||
|
|
{
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
return !isset($this->keys[$item->getKey()]) && $this->pool->save($item);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function saveDeferred(CacheItemInterface $item): bool
|
||
|
|
{
|
||
|
|
if (!isset($this->values)) {
|
||
|
|
$this->initialize();
|
||
|
|
}
|
||
|
|
|
||
|
|
return !isset($this->keys[$item->getKey()]) && $this->pool->saveDeferred($item);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function commit(): bool
|
||
|
|
{
|
||
|
|
return $this->pool->commit();
|
||
|
|
}
|
||
|
|
|
||
|
|
public function clear(string $prefix = ''): bool
|
||
|
|
{
|
||
|
|
$this->keys = $this->values = [];
|
||
|
|
|
||
|
|
$cleared = @unlink($this->file) || !file_exists($this->file);
|
||
|
|
unset(self::$valuesCache[$this->file]);
|
||
|
|
|
||
|
|
if ($this->pool instanceof AdapterInterface) {
|
||
|
|
return $this->pool->clear($prefix) && $cleared;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->pool->clear() && $cleared;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Store an array of cached values.
|
||
|
|
*
|
||
|
|
* @param array $values The cached values
|
||
|
|
*
|
||
|
|
* @return string[] A list of classes to preload on PHP 7.4+
|
||
|
|
*/
|
||
|
|
public function warmUp(array $values): array
|
||
|
|
{
|
||
|
|
if (file_exists($this->file)) {
|
||
|
|
if (!is_file($this->file)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache path exists and is not a file: "%s".', $this->file));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!is_writable($this->file)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache file is not writable: "%s".', $this->file));
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$directory = \dirname($this->file);
|
||
|
|
|
||
|
|
if (!is_dir($directory) && !@mkdir($directory, 0777, true)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache directory does not exist and cannot be created: "%s".', $directory));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!is_writable($directory)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache directory is not writable: "%s".', $directory));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$preload = [];
|
||
|
|
$dumpedValues = '';
|
||
|
|
$dumpedMap = [];
|
||
|
|
$dump = <<<'EOF'
|
||
|
|
<?php
|
||
|
|
|
||
|
|
// This file has been auto-generated by the Symfony Cache Component.
|
||
|
|
|
||
|
|
return [[
|
||
|
|
|
||
|
|
|
||
|
|
EOF;
|
||
|
|
|
||
|
|
foreach ($values as $key => $value) {
|
||
|
|
CacheItem::validateKey(\is_int($key) ? (string) $key : $key);
|
||
|
|
$isStaticValue = true;
|
||
|
|
|
||
|
|
if (null === $value) {
|
||
|
|
$value = "'N;'";
|
||
|
|
} elseif (\is_object($value) || \is_array($value)) {
|
||
|
|
try {
|
||
|
|
$value = VarExporter::export($value, $isStaticValue, $preload);
|
||
|
|
} catch (\Exception $e) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key "%s" has non-serializable "%s" value.', $key, get_debug_type($value)), 0, $e);
|
||
|
|
}
|
||
|
|
} elseif (\is_string($value)) {
|
||
|
|
// Wrap "N;" in a closure to not confuse it with an encoded `null`
|
||
|
|
if ('N;' === $value) {
|
||
|
|
$isStaticValue = false;
|
||
|
|
}
|
||
|
|
$value = var_export($value, true);
|
||
|
|
} elseif (!\is_scalar($value)) {
|
||
|
|
throw new InvalidArgumentException(sprintf('Cache key "%s" has non-serializable "%s" value.', $key, get_debug_type($value)));
|
||
|
|
} else {
|
||
|
|
$value = var_export($value, true);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$isStaticValue) {
|
||
|
|
$value = str_replace("\n", "\n ", $value);
|
||
|
|
$value = "static function () {\n return {$value};\n}";
|
||
|
|
}
|
||
|
|
$hash = hash('xxh128', $value);
|
||
|
|
|
||
|
|
if (null === $id = $dumpedMap[$hash] ?? null) {
|
||
|
|
$id = $dumpedMap[$hash] = \count($dumpedMap);
|
||
|
|
$dumpedValues .= "{$id} => {$value},\n";
|
||
|
|
}
|
||
|
|
|
||
|
|
$dump .= var_export($key, true)." => {$id},\n";
|
||
|
|
}
|
||
|
|
|
||
|
|
$dump .= "\n], [\n\n{$dumpedValues}\n]];\n";
|
||
|
|
|
||
|
|
$tmpFile = uniqid($this->file, true);
|
||
|
|
|
||
|
|
file_put_contents($tmpFile, $dump);
|
||
|
|
@chmod($tmpFile, 0666 & ~umask());
|
||
|
|
unset($serialized, $value, $dump);
|
||
|
|
|
||
|
|
@rename($tmpFile, $this->file);
|
||
|
|
unset(self::$valuesCache[$this->file]);
|
||
|
|
|
||
|
|
$this->initialize();
|
||
|
|
|
||
|
|
return $preload;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Load the cache file.
|
||
|
|
*/
|
||
|
|
private function initialize(): void
|
||
|
|
{
|
||
|
|
if (isset(self::$valuesCache[$this->file])) {
|
||
|
|
$values = self::$valuesCache[$this->file];
|
||
|
|
} elseif (!is_file($this->file)) {
|
||
|
|
$this->keys = $this->values = [];
|
||
|
|
|
||
|
|
return;
|
||
|
|
} else {
|
||
|
|
$values = self::$valuesCache[$this->file] = (include $this->file) ?: [[], []];
|
||
|
|
}
|
||
|
|
|
||
|
|
if (2 !== \count($values) || !isset($values[0], $values[1])) {
|
||
|
|
$this->keys = $this->values = [];
|
||
|
|
} else {
|
||
|
|
[$this->keys, $this->values] = $values;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
private function generateItems(array $keys): \Generator
|
||
|
|
{
|
||
|
|
$f = self::$createCacheItem;
|
||
|
|
$fallbackKeys = [];
|
||
|
|
|
||
|
|
foreach ($keys as $key) {
|
||
|
|
if (isset($this->keys[$key])) {
|
||
|
|
$value = $this->values[$this->keys[$key]];
|
||
|
|
|
||
|
|
if ('N;' === $value) {
|
||
|
|
yield $key => $f($key, null, true);
|
||
|
|
} elseif ($value instanceof \Closure) {
|
||
|
|
try {
|
||
|
|
yield $key => $f($key, $value(), true);
|
||
|
|
} catch (\Throwable) {
|
||
|
|
yield $key => $f($key, null, false);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
yield $key => $f($key, $value, true);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$fallbackKeys[] = $key;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($fallbackKeys) {
|
||
|
|
yield from $this->pool->getItems($fallbackKeys);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|