123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603 |
- <?php
- namespace Symfony\Component\Cache\Traits;
- use Predis\Command\Redis\UNLINK;
- use Predis\Connection\Aggregate\ClusterInterface;
- use Predis\Connection\Aggregate\RedisCluster;
- use Predis\Connection\Aggregate\ReplicationInterface;
- use Predis\Response\ErrorInterface;
- use Predis\Response\Status;
- use Symfony\Component\Cache\Exception\CacheException;
- use Symfony\Component\Cache\Exception\InvalidArgumentException;
- use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
- use Symfony\Component\Cache\Marshaller\MarshallerInterface;
- trait RedisTrait
- {
- private static $defaultConnectionOptions = [
- 'class' => null,
- 'persistent' => 0,
- 'persistent_id' => null,
- 'timeout' => 30,
- 'read_timeout' => 0,
- 'retry_interval' => 0,
- 'tcp_keepalive' => 0,
- 'lazy' => null,
- 'redis_cluster' => false,
- 'redis_sentinel' => null,
- 'dbindex' => 0,
- 'failover' => 'none',
- 'ssl' => null,
- ];
- private $redis;
- private $marshaller;
-
- private function init($redis, string $namespace, int $defaultLifetime, ?MarshallerInterface $marshaller)
- {
- parent::__construct($namespace, $defaultLifetime);
- if (preg_match('#[^-+_.A-Za-z0-9]#', $namespace, $match)) {
- throw new InvalidArgumentException(sprintf('RedisAdapter namespace contains "%s" but only characters in [-+_.A-Za-z0-9] are allowed.', $match[0]));
- }
- if (!$redis instanceof \Redis && !$redis instanceof \RedisArray && !$redis instanceof \RedisCluster && !$redis instanceof \Predis\ClientInterface && !$redis instanceof RedisProxy && !$redis instanceof RedisClusterProxy) {
- throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, get_debug_type($redis)));
- }
- if ($redis instanceof \Predis\ClientInterface && $redis->getOptions()->exceptions) {
- $options = clone $redis->getOptions();
- \Closure::bind(function () { $this->options['exceptions'] = false; }, $options, $options)();
- $redis = new $redis($redis->getConnection(), $options);
- }
- $this->redis = $redis;
- $this->marshaller = $marshaller ?? new DefaultMarshaller();
- }
-
- public static function createConnection(string $dsn, array $options = [])
- {
- if (str_starts_with($dsn, 'redis:')) {
- $scheme = 'redis';
- } elseif (str_starts_with($dsn, 'rediss:')) {
- $scheme = 'rediss';
- } else {
- throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s" does not start with "redis:" or "rediss".', $dsn));
- }
- if (!\extension_loaded('redis') && !class_exists(\Predis\Client::class)) {
- throw new CacheException(sprintf('Cannot find the "redis" extension nor the "predis/predis" package: "%s".', $dsn));
- }
- $params = preg_replace_callback('#^'.$scheme.':(//)?(?:(?:[^:@]*+:)?([^@]*+)@)?#', function ($m) use (&$auth) {
- if (isset($m[2])) {
- $auth = $m[2];
- if ('' === $auth) {
- $auth = null;
- }
- }
- return 'file:'.($m[1] ?? '');
- }, $dsn);
- if (false === $params = parse_url($params)) {
- throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
- }
- $query = $hosts = [];
- $tls = 'rediss' === $scheme;
- $tcpScheme = $tls ? 'tls' : 'tcp';
- if (isset($params['query'])) {
- parse_str($params['query'], $query);
- if (isset($query['host'])) {
- if (!\is_array($hosts = $query['host'])) {
- throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
- }
- foreach ($hosts as $host => $parameters) {
- if (\is_string($parameters)) {
- parse_str($parameters, $parameters);
- }
- if (false === $i = strrpos($host, ':')) {
- $hosts[$host] = ['scheme' => $tcpScheme, 'host' => $host, 'port' => 6379] + $parameters;
- } elseif ($port = (int) substr($host, 1 + $i)) {
- $hosts[$host] = ['scheme' => $tcpScheme, 'host' => substr($host, 0, $i), 'port' => $port] + $parameters;
- } else {
- $hosts[$host] = ['scheme' => 'unix', 'path' => substr($host, 0, $i)] + $parameters;
- }
- }
- $hosts = array_values($hosts);
- }
- }
- if (isset($params['host']) || isset($params['path'])) {
- if (!isset($params['dbindex']) && isset($params['path'])) {
- if (preg_match('#/(\d+)$#', $params['path'], $m)) {
- $params['dbindex'] = $m[1];
- $params['path'] = substr($params['path'], 0, -\strlen($m[0]));
- } elseif (isset($params['host'])) {
- throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s", the "dbindex" parameter must be a number.', $dsn));
- }
- }
- if (isset($params['host'])) {
- array_unshift($hosts, ['scheme' => $tcpScheme, 'host' => $params['host'], 'port' => $params['port'] ?? 6379]);
- } else {
- array_unshift($hosts, ['scheme' => 'unix', 'path' => $params['path']]);
- }
- }
- if (!$hosts) {
- throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
- }
- $params += $query + $options + self::$defaultConnectionOptions;
- if (isset($params['redis_sentinel']) && !class_exists(\Predis\Client::class) && !class_exists(\RedisSentinel::class)) {
- throw new CacheException(sprintf('Redis Sentinel support requires the "predis/predis" package or the "redis" extension v5.2 or higher: "%s".', $dsn));
- }
- if ($params['redis_cluster'] && isset($params['redis_sentinel'])) {
- throw new InvalidArgumentException(sprintf('Cannot use both "redis_cluster" and "redis_sentinel" at the same time: "%s".', $dsn));
- }
- if (null === $params['class'] && \extension_loaded('redis')) {
- $class = $params['redis_cluster'] ? \RedisCluster::class : (1 < \count($hosts) && !isset($params['redis_sentinel']) ? \RedisArray::class : \Redis::class);
- } else {
- $class = $params['class'] ?? \Predis\Client::class;
- if (isset($params['redis_sentinel']) && !is_a($class, \Predis\Client::class, true) && !class_exists(\RedisSentinel::class)) {
- throw new CacheException(sprintf('Cannot use Redis Sentinel: class "%s" does not extend "Predis\Client" and ext-redis >= 5.2 not found: "%s".', $class, $dsn));
- }
- }
- if (is_a($class, \Redis::class, true)) {
- $connect = $params['persistent'] || $params['persistent_id'] ? 'pconnect' : 'connect';
- $redis = new $class();
- $initializer = static function ($redis) use ($connect, $params, $dsn, $auth, $hosts, $tls) {
- $hostIndex = 0;
- do {
- $host = $hosts[$hostIndex]['host'] ?? $hosts[$hostIndex]['path'];
- $port = $hosts[$hostIndex]['port'] ?? 0;
- $address = false;
- if (isset($hosts[$hostIndex]['host']) && $tls) {
- $host = 'tls://'.$host;
- }
- if (!isset($params['redis_sentinel'])) {
- break;
- }
- $sentinel = new \RedisSentinel($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout']);
- if ($address = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {
- [$host, $port] = $address;
- }
- } while (++$hostIndex < \count($hosts) && !$address);
- if (isset($params['redis_sentinel']) && !$address) {
- throw new InvalidArgumentException(sprintf('Failed to retrieve master information from sentinel "%s" and dsn "%s".', $params['redis_sentinel'], $dsn));
- }
- try {
- @$redis->{$connect}($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout'], ...\defined('Redis::SCAN_PREFIX') ? [['stream' => $params['ssl'] ?? null]] : []);
- set_error_handler(function ($type, $msg) use (&$error) { $error = $msg; });
- try {
- $isConnected = $redis->isConnected();
- } finally {
- restore_error_handler();
- }
- if (!$isConnected) {
- $error = preg_match('/^Redis::p?connect\(\): (.*)/', $error, $error) ? sprintf(' (%s)', $error[1]) : '';
- throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$error.'.');
- }
- if ((null !== $auth && !$redis->auth($auth))
- || ($params['dbindex'] && !$redis->select($params['dbindex']))
- ) {
- $e = preg_replace('/^ERR /', '', $redis->getLastError());
- throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e.'.');
- }
- if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
- $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
- }
- } catch (\RedisException $e) {
- throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
- }
- return true;
- };
- if ($params['lazy']) {
- $redis = new RedisProxy($redis, $initializer);
- } else {
- $initializer($redis);
- }
- } elseif (is_a($class, \RedisArray::class, true)) {
- foreach ($hosts as $i => $host) {
- switch ($host['scheme']) {
- case 'tcp': $hosts[$i] = $host['host'].':'.$host['port']; break;
- case 'tls': $hosts[$i] = 'tls://'.$host['host'].':'.$host['port']; break;
- default: $hosts[$i] = $host['path'];
- }
- }
- $params['lazy_connect'] = $params['lazy'] ?? true;
- $params['connect_timeout'] = $params['timeout'];
- try {
- $redis = new $class($hosts, $params);
- } catch (\RedisClusterException $e) {
- throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
- }
- if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
- $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
- }
- } elseif (is_a($class, \RedisCluster::class, true)) {
- $initializer = static function () use ($class, $params, $dsn, $hosts) {
- foreach ($hosts as $i => $host) {
- switch ($host['scheme']) {
- case 'tcp': $hosts[$i] = $host['host'].':'.$host['port']; break;
- case 'tls': $hosts[$i] = 'tls://'.$host['host'].':'.$host['port']; break;
- default: $hosts[$i] = $host['path'];
- }
- }
- try {
- $redis = new $class(null, $hosts, $params['timeout'], $params['read_timeout'], (bool) $params['persistent'], $params['auth'] ?? '', ...\defined('Redis::SCAN_PREFIX') ? [$params['ssl'] ?? null] : []);
- } catch (\RedisClusterException $e) {
- throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
- }
- if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
- $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
- }
- switch ($params['failover']) {
- case 'error': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_ERROR); break;
- case 'distribute': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_DISTRIBUTE); break;
- case 'slaves': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_DISTRIBUTE_SLAVES); break;
- }
- return $redis;
- };
- $redis = $params['lazy'] ? new RedisClusterProxy($initializer) : $initializer();
- } elseif (is_a($class, \Predis\ClientInterface::class, true)) {
- if ($params['redis_cluster']) {
- $params['cluster'] = 'redis';
- } elseif (isset($params['redis_sentinel'])) {
- $params['replication'] = 'sentinel';
- $params['service'] = $params['redis_sentinel'];
- }
- $params += ['parameters' => []];
- $params['parameters'] += [
- 'persistent' => $params['persistent'],
- 'timeout' => $params['timeout'],
- 'read_write_timeout' => $params['read_timeout'],
- 'tcp_nodelay' => true,
- ];
- if ($params['dbindex']) {
- $params['parameters']['database'] = $params['dbindex'];
- }
- if (null !== $auth) {
- $params['parameters']['password'] = $auth;
- }
- if (1 === \count($hosts) && !($params['redis_cluster'] || $params['redis_sentinel'])) {
- $hosts = $hosts[0];
- } elseif (\in_array($params['failover'], ['slaves', 'distribute'], true) && !isset($params['replication'])) {
- $params['replication'] = true;
- $hosts[0] += ['alias' => 'master'];
- }
- $params['exceptions'] = false;
- $redis = new $class($hosts, array_diff_key($params, array_diff_key(self::$defaultConnectionOptions, ['ssl' => null])));
- if (isset($params['redis_sentinel'])) {
- $redis->getConnection()->setSentinelTimeout($params['timeout']);
- }
- } elseif (class_exists($class, false)) {
- throw new InvalidArgumentException(sprintf('"%s" is not a subclass of "Redis", "RedisArray", "RedisCluster" nor "Predis\ClientInterface".', $class));
- } else {
- throw new InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
- }
- return $redis;
- }
-
- protected function doFetch(array $ids)
- {
- if (!$ids) {
- return [];
- }
- $result = [];
- if ($this->redis instanceof \Predis\ClientInterface && $this->redis->getConnection() instanceof ClusterInterface) {
- $values = $this->pipeline(function () use ($ids) {
- foreach ($ids as $id) {
- yield 'get' => [$id];
- }
- });
- } else {
- $values = $this->redis->mget($ids);
- if (!\is_array($values) || \count($values) !== \count($ids)) {
- return [];
- }
- $values = array_combine($ids, $values);
- }
- foreach ($values as $id => $v) {
- if ($v) {
- $result[$id] = $this->marshaller->unmarshall($v);
- }
- }
- return $result;
- }
-
- protected function doHave(string $id)
- {
- return (bool) $this->redis->exists($id);
- }
-
- protected function doClear(string $namespace)
- {
- if ($this->redis instanceof \Predis\ClientInterface) {
- $prefix = $this->redis->getOptions()->prefix ? $this->redis->getOptions()->prefix->getPrefix() : '';
- $prefixLen = \strlen($prefix ?? '');
- }
- $cleared = true;
- $hosts = $this->getHosts();
- $host = reset($hosts);
- if ($host instanceof \Predis\Client && $host->getConnection() instanceof ReplicationInterface) {
-
- $hosts = [$host->getClientFor('master')];
- }
- foreach ($hosts as $host) {
- if (!isset($namespace[0])) {
- $cleared = $host->flushDb() && $cleared;
- continue;
- }
- $info = $host->info('Server');
- $info = !$info instanceof ErrorInterface ? $info['Server'] ?? $info : ['redis_version' => '2.0'];
- if (!$host instanceof \Predis\ClientInterface) {
- $prefix = \defined('Redis::SCAN_PREFIX') && (\Redis::SCAN_PREFIX & $host->getOption(\Redis::OPT_SCAN)) ? '' : $host->getOption(\Redis::OPT_PREFIX);
- $prefixLen = \strlen($host->getOption(\Redis::OPT_PREFIX) ?? '');
- }
- $pattern = $prefix.$namespace.'*';
- if (!version_compare($info['redis_version'], '2.8', '>=')) {
-
-
-
- $unlink = version_compare($info['redis_version'], '4.0', '>=') ? 'UNLINK' : 'DEL';
- $args = $this->redis instanceof \Predis\ClientInterface ? [0, $pattern] : [[$pattern], 0];
- $cleared = $host->eval("local keys=redis.call('KEYS',ARGV[1]) for i=1,#keys,5000 do redis.call('$unlink',unpack(keys,i,math.min(i+4999,#keys))) end return 1", $args[0], $args[1]) && $cleared;
- continue;
- }
- $cursor = null;
- do {
- $keys = $host instanceof \Predis\ClientInterface ? $host->scan($cursor, 'MATCH', $pattern, 'COUNT', 1000) : $host->scan($cursor, $pattern, 1000);
- if (isset($keys[1]) && \is_array($keys[1])) {
- $cursor = $keys[0];
- $keys = $keys[1];
- }
- if ($keys) {
- if ($prefixLen) {
- foreach ($keys as $i => $key) {
- $keys[$i] = substr($key, $prefixLen);
- }
- }
- $this->doDelete($keys);
- }
- } while ($cursor = (int) $cursor);
- }
- return $cleared;
- }
-
- protected function doDelete(array $ids)
- {
- if (!$ids) {
- return true;
- }
- if ($this->redis instanceof \Predis\ClientInterface && $this->redis->getConnection() instanceof ClusterInterface) {
- static $del;
- $del = $del ?? (class_exists(UNLINK::class) ? 'unlink' : 'del');
- $this->pipeline(function () use ($ids, $del) {
- foreach ($ids as $id) {
- yield $del => [$id];
- }
- })->rewind();
- } else {
- static $unlink = true;
- if ($unlink) {
- try {
- $unlink = false !== $this->redis->unlink($ids);
- } catch (\Throwable $e) {
- $unlink = false;
- }
- }
- if (!$unlink) {
- $this->redis->del($ids);
- }
- }
- return true;
- }
-
- protected function doSave(array $values, int $lifetime)
- {
- if (!$values = $this->marshaller->marshall($values, $failed)) {
- return $failed;
- }
- $results = $this->pipeline(function () use ($values, $lifetime) {
- foreach ($values as $id => $value) {
- if (0 >= $lifetime) {
- yield 'set' => [$id, $value];
- } else {
- yield 'setEx' => [$id, $lifetime, $value];
- }
- }
- });
- foreach ($results as $id => $result) {
- if (true !== $result && (!$result instanceof Status || Status::get('OK') !== $result)) {
- $failed[] = $id;
- }
- }
- return $failed;
- }
- private function pipeline(\Closure $generator, object $redis = null): \Generator
- {
- $ids = [];
- $redis = $redis ?? $this->redis;
- if ($redis instanceof RedisClusterProxy || $redis instanceof \RedisCluster || ($redis instanceof \Predis\ClientInterface && $redis->getConnection() instanceof RedisCluster)) {
-
-
-
- $results = [];
- foreach ($generator() as $command => $args) {
- $results[] = $redis->{$command}(...$args);
- $ids[] = 'eval' === $command ? ($redis instanceof \Predis\ClientInterface ? $args[2] : $args[1][0]) : $args[0];
- }
- } elseif ($redis instanceof \Predis\ClientInterface) {
- $results = $redis->pipeline(static function ($redis) use ($generator, &$ids) {
- foreach ($generator() as $command => $args) {
- $redis->{$command}(...$args);
- $ids[] = 'eval' === $command ? $args[2] : $args[0];
- }
- });
- } elseif ($redis instanceof \RedisArray) {
- $connections = $results = $ids = [];
- foreach ($generator() as $command => $args) {
- $id = 'eval' === $command ? $args[1][0] : $args[0];
- if (!isset($connections[$h = $redis->_target($id)])) {
- $connections[$h] = [$redis->_instance($h), -1];
- $connections[$h][0]->multi(\Redis::PIPELINE);
- }
- $connections[$h][0]->{$command}(...$args);
- $results[] = [$h, ++$connections[$h][1]];
- $ids[] = $id;
- }
- foreach ($connections as $h => $c) {
- $connections[$h] = $c[0]->exec();
- }
- foreach ($results as $k => [$h, $c]) {
- $results[$k] = $connections[$h][$c];
- }
- } else {
- $redis->multi(\Redis::PIPELINE);
- foreach ($generator() as $command => $args) {
- $redis->{$command}(...$args);
- $ids[] = 'eval' === $command ? $args[1][0] : $args[0];
- }
- $results = $redis->exec();
- }
- if (!$redis instanceof \Predis\ClientInterface && 'eval' === $command && $redis->getLastError()) {
- $e = new \RedisException($redis->getLastError());
- $results = array_map(function ($v) use ($e) { return false === $v ? $e : $v; }, $results);
- }
- foreach ($ids as $k => $id) {
- yield $id => $results[$k];
- }
- }
- private function getHosts(): array
- {
- $hosts = [$this->redis];
- if ($this->redis instanceof \Predis\ClientInterface) {
- $connection = $this->redis->getConnection();
- if ($connection instanceof ClusterInterface && $connection instanceof \Traversable) {
- $hosts = [];
- foreach ($connection as $c) {
- $hosts[] = new \Predis\Client($c);
- }
- }
- } elseif ($this->redis instanceof \RedisArray) {
- $hosts = [];
- foreach ($this->redis->_hosts() as $host) {
- $hosts[] = $this->redis->_instance($host);
- }
- } elseif ($this->redis instanceof RedisClusterProxy || $this->redis instanceof \RedisCluster) {
- $hosts = [];
- foreach ($this->redis->_masters() as $host) {
- $hosts[] = new RedisClusterNodeProxy($host, $this->redis);
- }
- }
- return $hosts;
- }
- }
|