ChainAdapter.php 8.6 KB

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