vendor/symfony/cache/Traits/RedisTrait.php line 171

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Cache\Traits;
  14. use Predis\Command\Redis\UNLINK;
  15. use Predis\Connection\Aggregate\ClusterInterface;
  16. use Predis\Connection\Aggregate\RedisCluster;
  17. use Predis\Connection\Aggregate\ReplicationInterface;
  18. use Predis\Response\ErrorInterface;
  19. use Predis\Response\Status;
  20. use Symfony\Component\Cache\Exception\CacheException;
  21. use Symfony\Component\Cache\Exception\InvalidArgumentException;
  22. use Symfony\Component\Cache\Marshaller\DefaultMarshaller;
  23. use Symfony\Component\Cache\Marshaller\MarshallerInterface;
  25. /**
  26.  * @author Aurimas Niekis <aurimas@niekis.lt>
  27.  * @author Nicolas Grekas <p@tchwork.com>
  28.  *
  29.  * @internal
  30.  */
  31. trait RedisTrait
  32. {
  33.     private static $defaultConnectionOptions = [
  34.         'class' => null,
  35.         'persistent' => 0,
  36.         'persistent_id' => null,
  37.         'timeout' => 30,
  38.         'read_timeout' => 0,
  39.         'retry_interval' => 0,
  40.         'tcp_keepalive' => 0,
  41.         'lazy' => null,
  42.         'redis_cluster' => false,
  43.         'redis_sentinel' => null,
  44.         'dbindex' => 0,
  45.         'failover' => 'none',
  46.         'ssl' => null, // see https://php.net/context.ssl
  47.     ];
  48.     private $redis;
  49.     private $marshaller;
  51.     /**
  52.      * @param \Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|RedisProxy|RedisClusterProxy $redis
  53.      */
  54.     private function init($redis, string $namespace, int $defaultLifetime, ?MarshallerInterface $marshaller)
  55.     {
  56.         parent::__construct($namespace, $defaultLifetime);
  58.         if (preg_match('#[^-+_.A-Za-z0-9]#', $namespace, $match)) {
  59.             throw new InvalidArgumentException(sprintf('RedisAdapter namespace contains "%s" but only characters in [-+_.A-Za-z0-9] are allowed.', $match[0]));
  60.         }
  62.         if (!$redis instanceof \Redis && !$redis instanceof \RedisArray && !$redis instanceof \RedisCluster && !$redis instanceof \Predis\ClientInterface && !$redis instanceof RedisProxy && !$redis instanceof RedisClusterProxy) {
  63.             throw new InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, get_debug_type($redis)));
  64.         }
  66.         if ($redis instanceof \Predis\ClientInterface && $redis->getOptions()->exceptions) {
  67.             $options = clone $redis->getOptions();
  68.             \Closure::bind(function () { $this->options['exceptions'] = false; }, $options, $options)();
  69.             $redis = new $redis($redis->getConnection(), $options);
  70.         }
  72.         $this->redis = $redis;
  73.         $this->marshaller = $marshaller ?? new DefaultMarshaller();
  74.     }
  76.     /**
  77.      * Creates a Redis connection using a DSN configuration.
  78.      *
  79.      * Example DSN:
  80.      *   - redis://localhost
  81.      *   - redis://example.com:1234
  82.      *   - redis://secret@example.com/13
  83.      *   - redis:///var/run/redis.sock
  84.      *   - redis://secret@/var/run/redis.sock/13
  85.      *
  86.      * @param array $options See self::$defaultConnectionOptions
  87.      *
  88.      * @return \Redis|\RedisArray|\RedisCluster|RedisClusterProxy|RedisProxy|\Predis\ClientInterface According to the "class" option
  89.      *
  90.      * @throws InvalidArgumentException when the DSN is invalid
  91.      */
  92.     public static function createConnection(string $dsn, array $options = [])
  93.     {
  94.         if (str_starts_with($dsn, 'redis:')) {
  95.             $scheme = 'redis';
  96.         } elseif (str_starts_with($dsn, 'rediss:')) {
  97.             $scheme = 'rediss';
  98.         } else {
  99.             throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s" does not start with "redis:" or "rediss".', $dsn));
  100.         }
  102.         if (!\extension_loaded('redis') && !class_exists(\Predis\Client::class)) {
  103.             throw new CacheException(sprintf('Cannot find the "redis" extension nor the "predis/predis" package: "%s".', $dsn));
  104.         }
  106.         $params = preg_replace_callback('#^'.$scheme.':(//)?(?:(?:[^:@]*+:)?([^@]*+)@)?#', function ($m) use (&$auth) {
  107.             if (isset($m[2])) {
  108.                 $auth = $m[2];
  110.                 if ('' === $auth) {
  111.                     $auth = null;
  112.                 }
  113.             }
  115.             return 'file:'.($m[1] ?? '');
  116.         }, $dsn);
  118.         if (false === $params = parse_url($params)) {
  119.             throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
  120.         }
  122.         $query = $hosts = [];
  124.         $tls = 'rediss' === $scheme;
  125.         $tcpScheme = $tls ? 'tls' : 'tcp';
  127.         if (isset($params['query'])) {
  128.             parse_str($params['query'], $query);
  130.             if (isset($query['host'])) {
  131.                 if (!\is_array($hosts = $query['host'])) {
  132.                     throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
  133.                 }
  134.                 foreach ($hosts as $host => $parameters) {
  135.                     if (\is_string($parameters)) {
  136.                         parse_str($parameters, $parameters);
  137.                     }
  138.                     if (false === $i = strrpos($host, ':')) {
  139.                         $hosts[$host] = ['scheme' => $tcpScheme, 'host' => $host, 'port' => 6379] + $parameters;
  140.                     } elseif ($port = (int) substr($host, 1 + $i)) {
  141.                         $hosts[$host] = ['scheme' => $tcpScheme, 'host' => substr($host, 0, $i), 'port' => $port] + $parameters;
  142.                     } else {
  143.                         $hosts[$host] = ['scheme' => 'unix', 'path' => substr($host, 0, $i)] + $parameters;
  144.                     }
  145.                 }
  146.                 $hosts = array_values($hosts);
  147.             }
  148.         }
  150.         if (isset($params['host']) || isset($params['path'])) {
  151.             if (!isset($params['dbindex']) && isset($params['path'])) {
  152.                 if (preg_match('#/(\d+)?$#', $params['path'], $m)) {
  153.                     $params['dbindex'] = $m[1] ?? '0';
  154.                     $params['path'] = substr($params['path'], 0, -\strlen($m[0]));
  155.                 } elseif (isset($params['host'])) {
  156.                     throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s", the "dbindex" parameter must be a number.', $dsn));
  157.                 }
  158.             }
  160.             if (isset($params['host'])) {
  161.                 array_unshift($hosts, ['scheme' => $tcpScheme, 'host' => $params['host'], 'port' => $params['port'] ?? 6379]);
  162.             } else {
  163.                 array_unshift($hosts, ['scheme' => 'unix', 'path' => $params['path']]);
  164.             }
  165.         }
  167.         if (!$hosts) {
  168.             throw new InvalidArgumentException(sprintf('Invalid Redis DSN: "%s".', $dsn));
  169.         }
  171.         $params += $query + $options + self::$defaultConnectionOptions;
  173.         if (isset($params['redis_sentinel']) && !class_exists(\Predis\Client::class) && !class_exists(\RedisSentinel::class)) {
  174.             throw new CacheException(sprintf('Redis Sentinel support requires the "predis/predis" package or the "redis" extension v5.2 or higher: "%s".', $dsn));
  175.         }
  177.         if (isset($params['lazy'])) {
  178.             $params['lazy'] = filter_var($params['lazy'], \FILTER_VALIDATE_BOOLEAN);
  179.         }
  180.         $params['redis_cluster'] = filter_var($params['redis_cluster'], \FILTER_VALIDATE_BOOLEAN);
  182.         if ($params['redis_cluster'] && isset($params['redis_sentinel'])) {
  183.             throw new InvalidArgumentException(sprintf('Cannot use both "redis_cluster" and "redis_sentinel" at the same time: "%s".', $dsn));
  184.         }
  186.         if (null === $params['class'] && \extension_loaded('redis')) {
  187.             $class = $params['redis_cluster'] ? \RedisCluster::class : (1 < \count($hosts) && !isset($params['redis_sentinel']) ? \RedisArray::class : \Redis::class);
  188.         } else {
  189.             $class = $params['class'] ?? \Predis\Client::class;
  191.             if (isset($params['redis_sentinel']) && !is_a($class, \Predis\Client::class, true) && !class_exists(\RedisSentinel::class)) {
  192.                 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));
  193.             }
  194.         }
  196.         if (is_a($class, \Redis::class, true)) {
  197.             $connect = $params['persistent'] || $params['persistent_id'] ? 'pconnect' : 'connect';
  198.             $redis = new $class();
  200.             $initializer = static function ($redis) use ($connect, $params, $dsn, $auth, $hosts, $tls) {
  201.                 $hostIndex = 0;
  202.                 do {
  203.                     $host = $hosts[$hostIndex]['host'] ?? $hosts[$hostIndex]['path'];
  204.                     $port = $hosts[$hostIndex]['port'] ?? 0;
  205.                     $address = false;
  207.                     if (isset($hosts[$hostIndex]['host']) && $tls) {
  208.                         $host = 'tls://'.$host;
  209.                     }
  211.                     if (!isset($params['redis_sentinel'])) {
  212.                         break;
  213.                     }
  214.                     $extra = [];
  215.                     if (\defined('Redis::OPT_NULL_MULTIBULK_AS_NULL') && isset($params['auth'])) {
  216.                         $extra = [$params['auth']];
  217.                     }
  218.                     $sentinel = new \RedisSentinel($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout'], ...$extra);
  220.                     if ($address = $sentinel->getMasterAddrByName($params['redis_sentinel'])) {
  221.                         [$host, $port] = $address;
  222.                     }
  223.                 } while (++$hostIndex < \count($hosts) && !$address);
  225.                 if (isset($params['redis_sentinel']) && !$address) {
  226.                     throw new InvalidArgumentException(sprintf('Failed to retrieve master information from sentinel "%s" and dsn "%s".', $params['redis_sentinel'], $dsn));
  227.                 }
  229.                 try {
  230.                     $extra = [
  231.                         'stream' => $params['ssl'] ?? null,
  232.                     ];
  233.                     if (isset($params['auth'])) {
  234.                         $extra['auth'] = $params['auth'];
  235.                     }
  236.                     @$redis->{$connect}($host, $port, $params['timeout'], (string) $params['persistent_id'], $params['retry_interval'], $params['read_timeout'], ...\defined('Redis::SCAN_PREFIX') ? [$extra] : []);
  238.                     set_error_handler(function ($type, $msg) use (&$error) { $error = $msg; });
  239.                     try {
  240.                         $isConnected = $redis->isConnected();
  241.                     } finally {
  242.                         restore_error_handler();
  243.                     }
  244.                     if (!$isConnected) {
  245.                         $error = preg_match('/^Redis::p?connect\(\): (.*)/', $error ?? '', $error) ? sprintf(' (%s)', $error[1]) : '';
  246.                         throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$error.'.');
  247.                     }
  249.                     if ((null !== $auth && !$redis->auth($auth))
  250.                         || ($params['dbindex'] && !$redis->select($params['dbindex']))
  251.                     ) {
  252.                         $e = preg_replace('/^ERR /', '', $redis->getLastError());
  253.                         throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e.'.');
  254.                     }
  256.                     if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
  257.                         $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
  258.                     }
  259.                 } catch (\RedisException $e) {
  260.                     throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
  261.                 }
  263.                 return true;
  264.             };
  266.             if ($params['lazy']) {
  267.                 $redis = new RedisProxy($redis, $initializer);
  268.             } else {
  269.                 $initializer($redis);
  270.             }
  271.         } elseif (is_a($class, \RedisArray::class, true)) {
  272.             foreach ($hosts as $i => $host) {
  273.                 switch ($host['scheme']) {
  274.                     case 'tcp': $hosts[$i] = $host['host'].':'.$host['port']; break;
  275.                     case 'tls': $hosts[$i] = 'tls://'.$host['host'].':'.$host['port']; break;
  276.                     default: $hosts[$i] = $host['path'];
  277.                 }
  278.             }
  279.             $params['lazy_connect'] = $params['lazy'] ?? true;
  280.             $params['connect_timeout'] = $params['timeout'];
  282.             try {
  283.                 $redis = new $class($hosts, $params);
  284.             } catch (\RedisClusterException $e) {
  285.                 throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
  286.             }
  288.             if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
  289.                 $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
  290.             }
  291.         } elseif (is_a($class, \RedisCluster::class, true)) {
  292.             $initializer = static function () use ($class, $params, $dsn, $hosts) {
  293.                 foreach ($hosts as $i => $host) {
  294.                     switch ($host['scheme']) {
  295.                         case 'tcp': $hosts[$i] = $host['host'].':'.$host['port']; break;
  296.                         case 'tls': $hosts[$i] = 'tls://'.$host['host'].':'.$host['port']; break;
  297.                         default: $hosts[$i] = $host['path'];
  298.                     }
  299.                 }
  301.                 try {
  302.                     $redis = new $class(null, $hosts, $params['timeout'], $params['read_timeout'], (bool) $params['persistent'], $params['auth'] ?? '', ...\defined('Redis::SCAN_PREFIX') ? [$params['ssl'] ?? null] : []);
  303.                 } catch (\RedisClusterException $e) {
  304.                     throw new InvalidArgumentException(sprintf('Redis connection "%s" failed: ', $dsn).$e->getMessage());
  305.                 }
  307.                 if (0 < $params['tcp_keepalive'] && \defined('Redis::OPT_TCP_KEEPALIVE')) {
  308.                     $redis->setOption(\Redis::OPT_TCP_KEEPALIVE, $params['tcp_keepalive']);
  309.                 }
  310.                 switch ($params['failover']) {
  311.                     case 'error': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_ERROR); break;
  312.                     case 'distribute': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_DISTRIBUTE); break;
  313.                     case 'slaves': $redis->setOption(\RedisCluster::OPT_SLAVE_FAILOVER, \RedisCluster::FAILOVER_DISTRIBUTE_SLAVES); break;
  314.                 }
  316.                 return $redis;
  317.             };
  319.             $redis = $params['lazy'] ? new RedisClusterProxy($initializer) : $initializer();
  320.         } elseif (is_a($class, \Predis\ClientInterface::class, true)) {
  321.             if ($params['redis_cluster']) {
  322.                 $params['cluster'] = 'redis';
  323.             } elseif (isset($params['redis_sentinel'])) {
  324.                 $params['replication'] = 'sentinel';
  325.                 $params['service'] = $params['redis_sentinel'];
  326.             }
  327.             $params += ['parameters' => []];
  328.             $params['parameters'] += [
  329.                 'persistent' => $params['persistent'],
  330.                 'timeout' => $params['timeout'],
  331.                 'read_write_timeout' => $params['read_timeout'],
  332.                 'tcp_nodelay' => true,
  333.             ];
  334.             if ($params['dbindex']) {
  335.                 $params['parameters']['database'] = $params['dbindex'];
  336.             }
  337.             if (null !== $auth) {
  338.                 $params['parameters']['password'] = $auth;
  339.             }
  341.             if (isset($params['ssl'])) {
  342.                 foreach ($hosts as $i => $host) {
  343.                     if (!isset($host['ssl'])) {
  344.                         $hosts[$i]['ssl'] = $params['ssl'];
  345.                     }
  346.                 }
  347.             }
  349.             if (1 === \count($hosts) && !($params['redis_cluster'] || $params['redis_sentinel'])) {
  350.                 $hosts = $hosts[0];
  351.             } elseif (\in_array($params['failover'], ['slaves', 'distribute'], true) && !isset($params['replication'])) {
  352.                 $params['replication'] = true;
  353.                 $hosts[0] += ['alias' => 'master'];
  354.             }
  355.             $params['exceptions'] = false;
  357.             $redis = new $class($hosts, array_diff_key($params, self::$defaultConnectionOptions));
  358.             if (isset($params['redis_sentinel'])) {
  359.                 $redis->getConnection()->setSentinelTimeout($params['timeout']);
  360.             }
  361.         } elseif (class_exists($class, false)) {
  362.             throw new InvalidArgumentException(sprintf('"%s" is not a subclass of "Redis", "RedisArray", "RedisCluster" nor "Predis\ClientInterface".', $class));
  363.         } else {
  364.             throw new InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
  365.         }
  367.         return $redis;
  368.     }
  370.     /**
  371.      * {@inheritdoc}
  372.      */
  373.     protected function doFetch(array $ids)
  374.     {
  375.         if (!$ids) {
  376.             return [];
  377.         }
  379.         $result = [];
  381.         if ($this->redis instanceof \Predis\ClientInterface && $this->redis->getConnection() instanceof ClusterInterface) {
  382.             $values = $this->pipeline(function () use ($ids) {
  383.                 foreach ($ids as $id) {
  384.                     yield 'get' => [$id];
  385.                 }
  386.             });
  387.         } else {
  388.             $values = $this->redis->mget($ids);
  390.             if (!\is_array($values) || \count($values) !== \count($ids)) {
  391.                 return [];
  392.             }
  394.             $values = array_combine($ids, $values);
  395.         }
  397.         foreach ($values as $id => $v) {
  398.             if ($v) {
  399.                 $result[$id] = $this->marshaller->unmarshall($v);
  400.             }
  401.         }
  403.         return $result;
  404.     }
  406.     /**
  407.      * {@inheritdoc}
  408.      */
  409.     protected function doHave(string $id)
  410.     {
  411.         return (bool) $this->redis->exists($id);
  412.     }
  414.     /**
  415.      * {@inheritdoc}
  416.      */
  417.     protected function doClear(string $namespace)
  418.     {
  419.         if ($this->redis instanceof \Predis\ClientInterface) {
  420.             $prefix = $this->redis->getOptions()->prefix ? $this->redis->getOptions()->prefix->getPrefix() : '';
  421.             $prefixLen = \strlen($prefix ?? '');
  422.         }
  424.         $cleared = true;
  425.         $hosts = $this->getHosts();
  426.         $host = reset($hosts);
  427.         if ($host instanceof \Predis\Client && $host->getConnection() instanceof ReplicationInterface) {
  428.             // Predis supports info command only on the master in replication environments
  429.             $hosts = [$host->getClientFor('master')];
  430.         }
  432.         foreach ($hosts as $host) {
  433.             if (!isset($namespace[0])) {
  434.                 $cleared = $host->flushDb() && $cleared;
  435.                 continue;
  436.             }
  438.             $info = $host->info('Server');
  439.             $info = !$info instanceof ErrorInterface ? $info['Server'] ?? $info : ['redis_version' => '2.0'];
  441.             if (!$host instanceof \Predis\ClientInterface) {
  442.                 $prefix = \defined('Redis::SCAN_PREFIX') && (\Redis::SCAN_PREFIX & $host->getOption(\Redis::OPT_SCAN)) ? '' : $host->getOption(\Redis::OPT_PREFIX);
  443.                 $prefixLen = \strlen($host->getOption(\Redis::OPT_PREFIX) ?? '');
  444.             }
  445.             $pattern = $prefix.$namespace.'*';
  447.             if (!version_compare($info['redis_version'], '2.8', '>=')) {
  448.                 // As documented in Redis documentation (http://redis.io/commands/keys) using KEYS
  449.                 // can hang your server when it is executed against large databases (millions of items).
  450.                 // Whenever you hit this scale, you should really consider upgrading to Redis 2.8 or above.
  451.                 $unlink = version_compare($info['redis_version'], '4.0', '>=') ? 'UNLINK' : 'DEL';
  452.                 $args = $this->redis instanceof \Predis\ClientInterface ? [0, $pattern] : [[$pattern], 0];
  453.                 $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;
  454.                 continue;
  455.             }
  457.             $cursor = null;
  458.             do {
  459.                 $keys = $host instanceof \Predis\ClientInterface ? $host->scan($cursor, 'MATCH', $pattern, 'COUNT', 1000) : $host->scan($cursor, $pattern, 1000);
  460.                 if (isset($keys[1]) && \is_array($keys[1])) {
  461.                     $cursor = $keys[0];
  462.                     $keys = $keys[1];
  463.                 }
  464.                 if ($keys) {
  465.                     if ($prefixLen) {
  466.                         foreach ($keys as $i => $key) {
  467.                             $keys[$i] = substr($key, $prefixLen);
  468.                         }
  469.                     }
  470.                     $this->doDelete($keys);
  471.                 }
  472.             } while ($cursor = (int) $cursor);
  473.         }
  475.         return $cleared;
  476.     }
  478.     /**
  479.      * {@inheritdoc}
  480.      */
  481.     protected function doDelete(array $ids)
  482.     {
  483.         if (!$ids) {
  484.             return true;
  485.         }
  487.         if ($this->redis instanceof \Predis\ClientInterface && $this->redis->getConnection() instanceof ClusterInterface) {
  488.             static $del;
  489.             $del = $del ?? (class_exists(UNLINK::class) ? 'unlink' : 'del');
  491.             $this->pipeline(function () use ($ids, $del) {
  492.                 foreach ($ids as $id) {
  493.                     yield $del => [$id];
  494.                 }
  495.             })->rewind();
  496.         } else {
  497.             static $unlink = true;
  499.             if ($unlink) {
  500.                 try {
  501.                     $unlink = false !== $this->redis->unlink($ids);
  502.                 } catch (\Throwable $e) {
  503.                     $unlink = false;
  504.                 }
  505.             }
  507.             if (!$unlink) {
  508.                 $this->redis->del($ids);
  509.             }
  510.         }
  512.         return true;
  513.     }
  515.     /**
  516.      * {@inheritdoc}
  517.      */
  518.     protected function doSave(array $values, int $lifetime)
  519.     {
  520.         if (!$values = $this->marshaller->marshall($values, $failed)) {
  521.             return $failed;
  522.         }
  524.         $results = $this->pipeline(function () use ($values, $lifetime) {
  525.             foreach ($values as $id => $value) {
  526.                 if (0 >= $lifetime) {
  527.                     yield 'set' => [$id, $value];
  528.                 } else {
  529.                     yield 'setEx' => [$id, $lifetime, $value];
  530.                 }
  531.             }
  532.         });
  534.         foreach ($results as $id => $result) {
  535.             if (true !== $result && (!$result instanceof Status || Status::get('OK') !== $result)) {
  536.                 $failed[] = $id;
  537.             }
  538.         }
  540.         return $failed;
  541.     }
  543.     private function pipeline(\Closure $generator, object $redis = null): \Generator
  544.     {
  545.         $ids = [];
  546.         $redis = $redis ?? $this->redis;
  548.         if ($redis instanceof RedisClusterProxy || $redis instanceof \RedisCluster || ($redis instanceof \Predis\ClientInterface && $redis->getConnection() instanceof RedisCluster)) {
  549.             // phpredis & predis don't support pipelining with RedisCluster
  550.             // see https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#pipelining
  551.             // see https://github.com/nrk/predis/issues/267#issuecomment-123781423
  552.             $results = [];
  553.             foreach ($generator() as $command => $args) {
  554.                 $results[] = $redis->{$command}(...$args);
  555.                 $ids[] = 'eval' === $command ? ($redis instanceof \Predis\ClientInterface ? $args[2] : $args[1][0]) : $args[0];
  556.             }
  557.         } elseif ($redis instanceof \Predis\ClientInterface) {
  558.             $results = $redis->pipeline(static function ($redis) use ($generator, &$ids) {
  559.                 foreach ($generator() as $command => $args) {
  560.                     $redis->{$command}(...$args);
  561.                     $ids[] = 'eval' === $command ? $args[2] : $args[0];
  562.                 }
  563.             });
  564.         } elseif ($redis instanceof \RedisArray) {
  565.             $connections = $results = $ids = [];
  566.             foreach ($generator() as $command => $args) {
  567.                 $id = 'eval' === $command ? $args[1][0] : $args[0];
  568.                 if (!isset($connections[$h = $redis->_target($id)])) {
  569.                     $connections[$h] = [$redis->_instance($h), -1];
  570.                     $connections[$h][0]->multi(\Redis::PIPELINE);
  571.                 }
  572.                 $connections[$h][0]->{$command}(...$args);
  573.                 $results[] = [$h, ++$connections[$h][1]];
  574.                 $ids[] = $id;
  575.             }
  576.             foreach ($connections as $h => $c) {
  577.                 $connections[$h] = $c[0]->exec();
  578.             }
  579.             foreach ($results as $k => [$h, $c]) {
  580.                 $results[$k] = $connections[$h][$c];
  581.             }
  582.         } else {
  583.             $redis->multi(\Redis::PIPELINE);
  584.             foreach ($generator() as $command => $args) {
  585.                 $redis->{$command}(...$args);
  586.                 $ids[] = 'eval' === $command ? $args[1][0] : $args[0];
  587.             }
  588.             $results = $redis->exec();
  589.         }
  591.         if (!$redis instanceof \Predis\ClientInterface && 'eval' === $command && $redis->getLastError()) {
  592.             $e = new \RedisException($redis->getLastError());
  593.             $results = array_map(function ($v) use ($e) { return false === $v ? $e : $v; }, (array) $results);
  594.         }
  596.         if (\is_bool($results)) {
  597.             return;
  598.         }
  600.         foreach ($ids as $k => $id) {
  601.             yield $id => $results[$k];
  602.         }
  603.     }
  605.     private function getHosts(): array
  606.     {
  607.         $hosts = [$this->redis];
  608.         if ($this->redis instanceof \Predis\ClientInterface) {
  609.             $connection = $this->redis->getConnection();
  610.             if ($connection instanceof ClusterInterface && $connection instanceof \Traversable) {
  611.                 $hosts = [];
  612.                 foreach ($connection as $c) {
  613.                     $hosts[] = new \Predis\Client($c);
  614.                 }
  615.             }
  616.         } elseif ($this->redis instanceof \RedisArray) {
  617.             $hosts = [];
  618.             foreach ($this->redis->_hosts() as $host) {
  619.                 $hosts[] = $this->redis->_instance($host);
  620.             }
  621.         } elseif ($this->redis instanceof RedisClusterProxy || $this->redis instanceof \RedisCluster) {
  622.             $hosts = [];
  623.             foreach ($this->redis->_masters() as $host) {
  624.                 $hosts[] = new RedisClusterNodeProxy($host, $this->redis);
  625.             }
  626.         }
  628.         return $hosts;
  629.     }
  630. }