CachePoolPass.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  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\DependencyInjection;
  11. use Symfony\Component\Cache\Adapter\AbstractAdapter;
  12. use Symfony\Component\Cache\Adapter\ArrayAdapter;
  13. use Symfony\Component\Cache\Adapter\ChainAdapter;
  14. use Symfony\Component\Cache\Adapter\NullAdapter;
  15. use Symfony\Component\Cache\Adapter\ParameterNormalizer;
  16. use Symfony\Component\Cache\Messenger\EarlyExpirationDispatcher;
  17. use Symfony\Component\DependencyInjection\ChildDefinition;
  18. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  19. use Symfony\Component\DependencyInjection\ContainerBuilder;
  20. use Symfony\Component\DependencyInjection\Definition;
  21. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  22. use Symfony\Component\DependencyInjection\Reference;
  23. /**
  24. * @author Nicolas Grekas <p@tchwork.com>
  25. */
  26. class CachePoolPass implements CompilerPassInterface
  27. {
  28. /**
  29. * {@inheritdoc}
  30. */
  31. public function process(ContainerBuilder $container)
  32. {
  33. if ($container->hasParameter('cache.prefix.seed')) {
  34. $seed = $container->getParameterBag()->resolveValue($container->getParameter('cache.prefix.seed'));
  35. } else {
  36. $seed = '_'.$container->getParameter('kernel.project_dir');
  37. $seed .= '.'.$container->getParameter('kernel.container_class');
  38. }
  39. $needsMessageHandler = false;
  40. $allPools = [];
  41. $clearers = [];
  42. $attributes = [
  43. 'provider',
  44. 'name',
  45. 'namespace',
  46. 'default_lifetime',
  47. 'early_expiration_message_bus',
  48. 'reset',
  49. ];
  50. foreach ($container->findTaggedServiceIds('cache.pool') as $id => $tags) {
  51. $adapter = $pool = $container->getDefinition($id);
  52. if ($pool->isAbstract()) {
  53. continue;
  54. }
  55. $class = $adapter->getClass();
  56. while ($adapter instanceof ChildDefinition) {
  57. $adapter = $container->findDefinition($adapter->getParent());
  58. $class = $class ?: $adapter->getClass();
  59. if ($t = $adapter->getTag('cache.pool')) {
  60. $tags[0] += $t[0];
  61. }
  62. }
  63. $name = $tags[0]['name'] ?? $id;
  64. if (!isset($tags[0]['namespace'])) {
  65. $namespaceSeed = $seed;
  66. if (null !== $class) {
  67. $namespaceSeed .= '.'.$class;
  68. }
  69. $tags[0]['namespace'] = $this->getNamespace($namespaceSeed, $name);
  70. }
  71. if (isset($tags[0]['clearer'])) {
  72. $clearer = $tags[0]['clearer'];
  73. while ($container->hasAlias($clearer)) {
  74. $clearer = (string) $container->getAlias($clearer);
  75. }
  76. } else {
  77. $clearer = null;
  78. }
  79. unset($tags[0]['clearer'], $tags[0]['name']);
  80. if (isset($tags[0]['provider'])) {
  81. $tags[0]['provider'] = new Reference(static::getServiceProvider($container, $tags[0]['provider']));
  82. }
  83. if (ChainAdapter::class === $class) {
  84. $adapters = [];
  85. foreach ($adapter->getArgument(0) as $provider => $adapter) {
  86. if ($adapter instanceof ChildDefinition) {
  87. $chainedPool = $adapter;
  88. } else {
  89. $chainedPool = $adapter = new ChildDefinition($adapter);
  90. }
  91. $chainedTags = [\is_int($provider) ? [] : ['provider' => $provider]];
  92. $chainedClass = '';
  93. while ($adapter instanceof ChildDefinition) {
  94. $adapter = $container->findDefinition($adapter->getParent());
  95. $chainedClass = $chainedClass ?: $adapter->getClass();
  96. if ($t = $adapter->getTag('cache.pool')) {
  97. $chainedTags[0] += $t[0];
  98. }
  99. }
  100. if (ChainAdapter::class === $chainedClass) {
  101. throw new InvalidArgumentException(sprintf('Invalid service "%s": chain of adapters cannot reference another chain, found "%s".', $id, $chainedPool->getParent()));
  102. }
  103. $i = 0;
  104. if (isset($chainedTags[0]['provider'])) {
  105. $chainedPool->replaceArgument($i++, new Reference(static::getServiceProvider($container, $chainedTags[0]['provider'])));
  106. }
  107. if (isset($tags[0]['namespace']) && !\in_array($adapter->getClass(), [ArrayAdapter::class, NullAdapter::class], true)) {
  108. $chainedPool->replaceArgument($i++, $tags[0]['namespace']);
  109. }
  110. if (isset($tags[0]['default_lifetime'])) {
  111. $chainedPool->replaceArgument($i++, $tags[0]['default_lifetime']);
  112. }
  113. $adapters[] = $chainedPool;
  114. }
  115. $pool->replaceArgument(0, $adapters);
  116. unset($tags[0]['provider'], $tags[0]['namespace']);
  117. $i = 1;
  118. } else {
  119. $i = 0;
  120. }
  121. foreach ($attributes as $attr) {
  122. if (!isset($tags[0][$attr])) {
  123. // no-op
  124. } elseif ('reset' === $attr) {
  125. if ($tags[0][$attr]) {
  126. $pool->addTag('kernel.reset', ['method' => $tags[0][$attr]]);
  127. }
  128. } elseif ('early_expiration_message_bus' === $attr) {
  129. $needsMessageHandler = true;
  130. $pool->addMethodCall('setCallbackWrapper', [(new Definition(EarlyExpirationDispatcher::class))
  131. ->addArgument(new Reference($tags[0]['early_expiration_message_bus']))
  132. ->addArgument(new Reference('reverse_container'))
  133. ->addArgument((new Definition('callable'))
  134. ->setFactory([new Reference($id), 'setCallbackWrapper'])
  135. ->addArgument(null)
  136. ),
  137. ]);
  138. $pool->addTag('container.reversible');
  139. } elseif ('namespace' !== $attr || !\in_array($class, [ArrayAdapter::class, NullAdapter::class], true)) {
  140. $argument = $tags[0][$attr];
  141. if ('default_lifetime' === $attr && !is_numeric($argument)) {
  142. $argument = (new Definition('int', [$argument]))
  143. ->setFactory([ParameterNormalizer::class, 'normalizeDuration']);
  144. }
  145. $pool->replaceArgument($i++, $argument);
  146. }
  147. unset($tags[0][$attr]);
  148. }
  149. if (!empty($tags[0])) {
  150. throw new InvalidArgumentException(sprintf('Invalid "cache.pool" tag for service "%s": accepted attributes are "clearer", "provider", "name", "namespace", "default_lifetime", "early_expiration_message_bus" and "reset", found "%s".', $id, implode('", "', array_keys($tags[0]))));
  151. }
  152. if (null !== $clearer) {
  153. $clearers[$clearer][$name] = new Reference($id, $container::IGNORE_ON_UNINITIALIZED_REFERENCE);
  154. }
  155. $allPools[$name] = new Reference($id, $container::IGNORE_ON_UNINITIALIZED_REFERENCE);
  156. }
  157. if (!$needsMessageHandler) {
  158. $container->removeDefinition('cache.early_expiration_handler');
  159. }
  160. $notAliasedCacheClearerId = $aliasedCacheClearerId = 'cache.global_clearer';
  161. while ($container->hasAlias('cache.global_clearer')) {
  162. $aliasedCacheClearerId = (string) $container->getAlias('cache.global_clearer');
  163. }
  164. if ($container->hasDefinition($aliasedCacheClearerId)) {
  165. $clearers[$notAliasedCacheClearerId] = $allPools;
  166. }
  167. foreach ($clearers as $id => $pools) {
  168. $clearer = $container->getDefinition($id);
  169. if ($clearer instanceof ChildDefinition) {
  170. $clearer->replaceArgument(0, $pools);
  171. } else {
  172. $clearer->setArgument(0, $pools);
  173. }
  174. $clearer->addTag('cache.pool.clearer');
  175. if ('cache.system_clearer' === $id) {
  176. $clearer->addTag('kernel.cache_clearer');
  177. }
  178. }
  179. $allPoolsKeys = array_keys($allPools);
  180. if ($container->hasDefinition('console.command.cache_pool_list')) {
  181. $container->getDefinition('console.command.cache_pool_list')->replaceArgument(0, $allPoolsKeys);
  182. }
  183. if ($container->hasDefinition('console.command.cache_pool_clear')) {
  184. $container->getDefinition('console.command.cache_pool_clear')->addArgument($allPoolsKeys);
  185. }
  186. if ($container->hasDefinition('console.command.cache_pool_delete')) {
  187. $container->getDefinition('console.command.cache_pool_delete')->addArgument($allPoolsKeys);
  188. }
  189. }
  190. private function getNamespace(string $seed, string $id)
  191. {
  192. return substr(str_replace('/', '-', base64_encode(hash('sha256', $id.$seed, true))), 0, 10);
  193. }
  194. /**
  195. * @internal
  196. */
  197. public static function getServiceProvider(ContainerBuilder $container, string $name)
  198. {
  199. $container->resolveEnvPlaceholders($name, null, $usedEnvs);
  200. if ($usedEnvs || preg_match('#^[a-z]++:#', $name)) {
  201. $dsn = $name;
  202. if (!$container->hasDefinition($name = '.cache_connection.'.ContainerBuilder::hash($dsn))) {
  203. $definition = new Definition(AbstractAdapter::class);
  204. $definition->setPublic(false);
  205. $definition->setFactory([AbstractAdapter::class, 'createConnection']);
  206. $definition->setArguments([$dsn, ['lazy' => true]]);
  207. $container->setDefinition($name, $definition);
  208. }
  209. }
  210. return $name;
  211. }
  212. }