ChainAdapter.php 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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\Cache\CacheItemPoolInterface;
  13. use Symfony\Component\Cache\CacheItem;
  14. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  15. use Symfony\Component\Cache\PruneableInterface;
  16. use Symfony\Component\Cache\ResettableInterface;
  17. use Symfony\Component\Cache\Traits\ContractsTrait;
  18. use Symfony\Contracts\Cache\CacheInterface;
  19. use Symfony\Contracts\Service\ResetInterface;
  20. /**
  21. * Chains several adapters together.
  22. *
  23. * Cached items are fetched from the first adapter having them in its data store.
  24. * They are saved and deleted in all adapters at once.
  25. *
  26. * @author Kévin Dunglas <dunglas@gmail.com>
  27. */
  28. class ChainAdapter implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface
  29. {
  30. use ContractsTrait;
  31. private array $adapters = [];
  32. private int $adapterCount;
  33. private int $defaultLifetime;
  34. private static \Closure $syncItem;
  35. /**
  36. * @param CacheItemPoolInterface[] $adapters The ordered list of adapters used to fetch cached items
  37. * @param int $defaultLifetime The default lifetime of items propagated from lower adapters to upper ones
  38. */
  39. public function __construct(array $adapters, int $defaultLifetime = 0)
  40. {
  41. if (!$adapters) {
  42. throw new InvalidArgumentException('At least one adapter must be specified.');
  43. }
  44. foreach ($adapters as $adapter) {
  45. if (!$adapter instanceof CacheItemPoolInterface) {
  46. throw new InvalidArgumentException(sprintf('The class "%s" does not implement the "%s" interface.', get_debug_type($adapter), CacheItemPoolInterface::class));
  47. }
  48. if (\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) && $adapter instanceof ApcuAdapter && !filter_var(\ini_get('apc.enable_cli'), \FILTER_VALIDATE_BOOLEAN)) {
  49. continue; // skip putting APCu in the chain when the backend is disabled
  50. }
  51. if ($adapter instanceof AdapterInterface) {
  52. $this->adapters[] = $adapter;
  53. } else {
  54. $this->adapters[] = new ProxyAdapter($adapter);
  55. }
  56. }
  57. $this->adapterCount = \count($this->adapters);
  58. $this->defaultLifetime = $defaultLifetime;
  59. self::$syncItem ?? self::$syncItem = \Closure::bind(
  60. static function ($sourceItem, $item, $defaultLifetime, $sourceMetadata = null) {
  61. $sourceItem->isTaggable = false;
  62. $sourceMetadata = $sourceMetadata ?? $sourceItem->metadata;
  63. unset($sourceMetadata[CacheItem::METADATA_TAGS]);
  64. $item->value = $sourceItem->value;
  65. $item->isHit = $sourceItem->isHit;
  66. $item->metadata = $item->newMetadata = $sourceItem->metadata = $sourceMetadata;
  67. if (isset($item->metadata[CacheItem::METADATA_EXPIRY])) {
  68. $item->expiresAt(\DateTime::createFromFormat('U.u', sprintf('%.6F', $item->metadata[CacheItem::METADATA_EXPIRY])));
  69. } elseif (0 < $defaultLifetime) {
  70. $item->expiresAfter($defaultLifetime);
  71. }
  72. return $item;
  73. },
  74. null,
  75. CacheItem::class
  76. );
  77. }
  78. /**
  79. * {@inheritdoc}
  80. */
  81. public function get(string $key, callable $callback, float $beta = null, array &$metadata = null): mixed
  82. {
  83. $doSave = true;
  84. $callback = static function (CacheItem $item, bool &$save) use ($callback, &$doSave) {
  85. $value = $callback($item, $save);
  86. $doSave = $save;
  87. return $value;
  88. };
  89. $lastItem = null;
  90. $i = 0;
  91. $wrap = function (CacheItem $item = null, bool &$save = true) use ($key, $callback, $beta, &$wrap, &$i, &$doSave, &$lastItem, &$metadata) {
  92. $adapter = $this->adapters[$i];
  93. if (isset($this->adapters[++$i])) {
  94. $callback = $wrap;
  95. $beta = \INF === $beta ? \INF : 0;
  96. }
  97. if ($adapter instanceof CacheInterface) {
  98. $value = $adapter->get($key, $callback, $beta, $metadata);
  99. } else {
  100. $value = $this->doGet($adapter, $key, $callback, $beta, $metadata);
  101. }
  102. if (null !== $item) {
  103. (self::$syncItem)($lastItem = $lastItem ?? $item, $item, $this->defaultLifetime, $metadata);
  104. }
  105. $save = $doSave;
  106. return $value;
  107. };
  108. return $wrap();
  109. }
  110. /**
  111. * {@inheritdoc}
  112. */
  113. public function getItem(mixed $key): CacheItem
  114. {
  115. $syncItem = self::$syncItem;
  116. $misses = [];
  117. foreach ($this->adapters as $i => $adapter) {
  118. $item = $adapter->getItem($key);
  119. if ($item->isHit()) {
  120. while (0 <= --$i) {
  121. $this->adapters[$i]->save($syncItem($item, $misses[$i], $this->defaultLifetime));
  122. }
  123. return $item;
  124. }
  125. $misses[$i] = $item;
  126. }
  127. return $item;
  128. }
  129. /**
  130. * {@inheritdoc}
  131. */
  132. public function getItems(array $keys = []): iterable
  133. {
  134. return $this->generateItems($this->adapters[0]->getItems($keys), 0);
  135. }
  136. private function generateItems(iterable $items, int $adapterIndex): \Generator
  137. {
  138. $missing = [];
  139. $misses = [];
  140. $nextAdapterIndex = $adapterIndex + 1;
  141. $nextAdapter = $this->adapters[$nextAdapterIndex] ?? null;
  142. foreach ($items as $k => $item) {
  143. if (!$nextAdapter || $item->isHit()) {
  144. yield $k => $item;
  145. } else {
  146. $missing[] = $k;
  147. $misses[$k] = $item;
  148. }
  149. }
  150. if ($missing) {
  151. $syncItem = self::$syncItem;
  152. $adapter = $this->adapters[$adapterIndex];
  153. $items = $this->generateItems($nextAdapter->getItems($missing), $nextAdapterIndex);
  154. foreach ($items as $k => $item) {
  155. if ($item->isHit()) {
  156. $adapter->save($syncItem($item, $misses[$k], $this->defaultLifetime));
  157. }
  158. yield $k => $item;
  159. }
  160. }
  161. }
  162. /**
  163. * {@inheritdoc}
  164. */
  165. public function hasItem(mixed $key): bool
  166. {
  167. foreach ($this->adapters as $adapter) {
  168. if ($adapter->hasItem($key)) {
  169. return true;
  170. }
  171. }
  172. return false;
  173. }
  174. /**
  175. * {@inheritdoc}
  176. */
  177. public function clear(string $prefix = ''): bool
  178. {
  179. $cleared = true;
  180. $i = $this->adapterCount;
  181. while ($i--) {
  182. if ($this->adapters[$i] instanceof AdapterInterface) {
  183. $cleared = $this->adapters[$i]->clear($prefix) && $cleared;
  184. } else {
  185. $cleared = $this->adapters[$i]->clear() && $cleared;
  186. }
  187. }
  188. return $cleared;
  189. }
  190. /**
  191. * {@inheritdoc}
  192. */
  193. public function deleteItem(mixed $key): bool
  194. {
  195. $deleted = true;
  196. $i = $this->adapterCount;
  197. while ($i--) {
  198. $deleted = $this->adapters[$i]->deleteItem($key) && $deleted;
  199. }
  200. return $deleted;
  201. }
  202. /**
  203. * {@inheritdoc}
  204. */
  205. public function deleteItems(array $keys): bool
  206. {
  207. $deleted = true;
  208. $i = $this->adapterCount;
  209. while ($i--) {
  210. $deleted = $this->adapters[$i]->deleteItems($keys) && $deleted;
  211. }
  212. return $deleted;
  213. }
  214. /**
  215. * {@inheritdoc}
  216. */
  217. public function save(CacheItemInterface $item): bool
  218. {
  219. $saved = true;
  220. $i = $this->adapterCount;
  221. while ($i--) {
  222. $saved = $this->adapters[$i]->save($item) && $saved;
  223. }
  224. return $saved;
  225. }
  226. /**
  227. * {@inheritdoc}
  228. */
  229. public function saveDeferred(CacheItemInterface $item): bool
  230. {
  231. $saved = true;
  232. $i = $this->adapterCount;
  233. while ($i--) {
  234. $saved = $this->adapters[$i]->saveDeferred($item) && $saved;
  235. }
  236. return $saved;
  237. }
  238. /**
  239. * {@inheritdoc}
  240. */
  241. public function commit(): bool
  242. {
  243. $committed = true;
  244. $i = $this->adapterCount;
  245. while ($i--) {
  246. $committed = $this->adapters[$i]->commit() && $committed;
  247. }
  248. return $committed;
  249. }
  250. /**
  251. * {@inheritdoc}
  252. */
  253. public function prune(): bool
  254. {
  255. $pruned = true;
  256. foreach ($this->adapters as $adapter) {
  257. if ($adapter instanceof PruneableInterface) {
  258. $pruned = $adapter->prune() && $pruned;
  259. }
  260. }
  261. return $pruned;
  262. }
  263. /**
  264. * {@inheritdoc}
  265. */
  266. public function reset()
  267. {
  268. foreach ($this->adapters as $adapter) {
  269. if ($adapter instanceof ResetInterface) {
  270. $adapter->reset();
  271. }
  272. }
  273. }
  274. }