AbstractAdapter.php 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  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\Log\LoggerAwareInterface;
  12. use Psr\Log\LoggerInterface;
  13. use Psr\Log\NullLogger;
  14. use Symfony\Component\Cache\CacheItem;
  15. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  16. use Symfony\Component\Cache\ResettableInterface;
  17. use Symfony\Component\Cache\Traits\AbstractAdapterTrait;
  18. use Symfony\Component\Cache\Traits\ContractsTrait;
  19. use Symfony\Contracts\Cache\CacheInterface;
  20. /**
  21. * @author Nicolas Grekas <p@tchwork.com>
  22. */
  23. abstract class AbstractAdapter implements AdapterInterface, CacheInterface, LoggerAwareInterface, ResettableInterface
  24. {
  25. /**
  26. * @internal
  27. */
  28. protected const NS_SEPARATOR = ':';
  29. use AbstractAdapterTrait;
  30. use ContractsTrait;
  31. private static $apcuSupported;
  32. private static $phpFilesSupported;
  33. protected function __construct(string $namespace = '', int $defaultLifetime = 0)
  34. {
  35. $this->namespace = '' === $namespace ? '' : CacheItem::validateKey($namespace).static::NS_SEPARATOR;
  36. if (null !== $this->maxIdLength && \strlen($namespace) > $this->maxIdLength - 24) {
  37. throw new InvalidArgumentException(sprintf('Namespace must be %d chars max, %d given ("%s").', $this->maxIdLength - 24, \strlen($namespace), $namespace));
  38. }
  39. $this->createCacheItem = \Closure::bind(
  40. static function ($key, $value, $isHit) use ($defaultLifetime) {
  41. $item = new CacheItem();
  42. $item->key = $key;
  43. $item->value = $v = $value;
  44. $item->isHit = $isHit;
  45. $item->defaultLifetime = $defaultLifetime;
  46. // Detect wrapped values that encode for their expiry and creation duration
  47. // For compactness, these values are packed in the key of an array using
  48. // magic numbers in the form 9D-..-..-..-..-00-..-..-..-5F
  49. if (\is_array($v) && 1 === \count($v) && 10 === \strlen($k = key($v)) && "\x9D" === $k[0] && "\0" === $k[5] && "\x5F" === $k[9]) {
  50. $item->value = $v[$k];
  51. $v = unpack('Ve/Nc', substr($k, 1, -1));
  52. $item->metadata[CacheItem::METADATA_EXPIRY] = $v['e'] + CacheItem::METADATA_EXPIRY_OFFSET;
  53. $item->metadata[CacheItem::METADATA_CTIME] = $v['c'];
  54. }
  55. return $item;
  56. },
  57. null,
  58. CacheItem::class
  59. );
  60. $getId = \Closure::fromCallable([$this, 'getId']);
  61. $this->mergeByLifetime = \Closure::bind(
  62. static function ($deferred, $namespace, &$expiredIds) use ($getId) {
  63. $byLifetime = [];
  64. $now = microtime(true);
  65. $expiredIds = [];
  66. foreach ($deferred as $key => $item) {
  67. $key = (string) $key;
  68. if (null === $item->expiry) {
  69. $ttl = 0 < $item->defaultLifetime ? $item->defaultLifetime : 0;
  70. } elseif (0 >= $ttl = (int) (0.1 + $item->expiry - $now)) {
  71. $expiredIds[] = $getId($key);
  72. continue;
  73. }
  74. if (isset(($metadata = $item->newMetadata)[CacheItem::METADATA_TAGS])) {
  75. unset($metadata[CacheItem::METADATA_TAGS]);
  76. }
  77. // For compactness, expiry and creation duration are packed in the key of an array, using magic numbers as separators
  78. $byLifetime[$ttl][$getId($key)] = $metadata ? ["\x9D".pack('VN', (int) (0.1 + $metadata[self::METADATA_EXPIRY] - self::METADATA_EXPIRY_OFFSET), $metadata[self::METADATA_CTIME])."\x5F" => $item->value] : $item->value;
  79. }
  80. return $byLifetime;
  81. },
  82. null,
  83. CacheItem::class
  84. );
  85. }
  86. /**
  87. * Returns the best possible adapter that your runtime supports.
  88. *
  89. * Using ApcuAdapter makes system caches compatible with read-only filesystems.
  90. *
  91. * @param string $namespace
  92. * @param int $defaultLifetime
  93. * @param string $version
  94. * @param string $directory
  95. *
  96. * @return AdapterInterface
  97. */
  98. public static function createSystemCache($namespace, $defaultLifetime, $version, $directory, LoggerInterface $logger = null)
  99. {
  100. $opcache = new PhpFilesAdapter($namespace, $defaultLifetime, $directory, true);
  101. if (null !== $logger) {
  102. $opcache->setLogger($logger);
  103. }
  104. if (!self::$apcuSupported = self::$apcuSupported ?? ApcuAdapter::isSupported()) {
  105. return $opcache;
  106. }
  107. $apcu = new ApcuAdapter($namespace, (int) $defaultLifetime / 5, $version);
  108. if ('cli' === \PHP_SAPI && !filter_var(ini_get('apc.enable_cli'), FILTER_VALIDATE_BOOLEAN)) {
  109. $apcu->setLogger(new NullLogger());
  110. } elseif (null !== $logger) {
  111. $apcu->setLogger($logger);
  112. }
  113. return new ChainAdapter([$apcu, $opcache]);
  114. }
  115. public static function createConnection($dsn, array $options = [])
  116. {
  117. if (!\is_string($dsn)) {
  118. throw new InvalidArgumentException(sprintf('The "%s()" method expect argument #1 to be string, "%s" given.', __METHOD__, \gettype($dsn)));
  119. }
  120. if (0 === strpos($dsn, 'redis:') || 0 === strpos($dsn, 'rediss:')) {
  121. return RedisAdapter::createConnection($dsn, $options);
  122. }
  123. if (0 === strpos($dsn, 'memcached:')) {
  124. return MemcachedAdapter::createConnection($dsn, $options);
  125. }
  126. throw new InvalidArgumentException(sprintf('Unsupported DSN: "%s".', $dsn));
  127. }
  128. /**
  129. * {@inheritdoc}
  130. *
  131. * @return bool
  132. */
  133. public function commit()
  134. {
  135. $ok = true;
  136. $byLifetime = $this->mergeByLifetime;
  137. $byLifetime = $byLifetime($this->deferred, $this->namespace, $expiredIds);
  138. $retry = $this->deferred = [];
  139. if ($expiredIds) {
  140. $this->doDelete($expiredIds);
  141. }
  142. foreach ($byLifetime as $lifetime => $values) {
  143. try {
  144. $e = $this->doSave($values, $lifetime);
  145. } catch (\Exception $e) {
  146. }
  147. if (true === $e || [] === $e) {
  148. continue;
  149. }
  150. if (\is_array($e) || 1 === \count($values)) {
  151. foreach (\is_array($e) ? $e : array_keys($values) as $id) {
  152. $ok = false;
  153. $v = $values[$id];
  154. $type = \is_object($v) ? \get_class($v) : \gettype($v);
  155. $message = sprintf('Failed to save key "{key}" of type %s%s', $type, $e instanceof \Exception ? ': '.$e->getMessage() : '.');
  156. CacheItem::log($this->logger, $message, ['key' => substr($id, \strlen($this->namespace)), 'exception' => $e instanceof \Exception ? $e : null]);
  157. }
  158. } else {
  159. foreach ($values as $id => $v) {
  160. $retry[$lifetime][] = $id;
  161. }
  162. }
  163. }
  164. // When bulk-save failed, retry each item individually
  165. foreach ($retry as $lifetime => $ids) {
  166. foreach ($ids as $id) {
  167. try {
  168. $v = $byLifetime[$lifetime][$id];
  169. $e = $this->doSave([$id => $v], $lifetime);
  170. } catch (\Exception $e) {
  171. }
  172. if (true === $e || [] === $e) {
  173. continue;
  174. }
  175. $ok = false;
  176. $type = \is_object($v) ? \get_class($v) : \gettype($v);
  177. $message = sprintf('Failed to save key "{key}" of type %s%s', $type, $e instanceof \Exception ? ': '.$e->getMessage() : '.');
  178. CacheItem::log($this->logger, $message, ['key' => substr($id, \strlen($this->namespace)), 'exception' => $e instanceof \Exception ? $e : null]);
  179. }
  180. }
  181. return $ok;
  182. }
  183. }