Sync branch with 2.x (#1169)

* Added support for new arguments for BITPOS, BITCOUNT commands (#1045) * Added support for new arguments for EXPIRE, EXPIREAT commands (#1046) * Extended core support by implementing SORT_RO command (#1044) * Added support for SORT_RO command * Codestyle fixes * Added command description --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * fix deprecated call * Added support for container commands (#1049) * Added support for container commands FUNCTION LOAD, FUNCTION DELETE and FCALL * Changed ContainerInterface and AbstractContainer * Re-implement logic of abstract methods --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Added stream commands to KeyPrefixProcessor (#1051) Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> * Fix return type of ReplicationInterface::getSlaves (#1111) * Codestyle fixes * Changed return annotation --------- Co-authored-by: Vladyslav Vildanov <vladyslavvildanov@Vladyslav-Vildanov-MacBook-Pro.local> Co-authored-by: Till Krüss <till@kruss.io> Co-authored-by: Stephan <glaubinix@users.noreply.github.com>
predis · Feb 21, 2023 · bc5f07d · bc5f07d
1 parent 02fadf8
commit bc5f07d
Show file tree

Hide file tree

Showing 53 changed files with 2,126 additions and 22 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -17,6 +17,8 @@
 use IteratorAggregate;
 use Predis\Command\CommandInterface;
 use Predis\Command\RawCommand;
+use Predis\Command\Redis\Container\ContainerFactory;
+use Predis\Command\Redis\Container\ContainerInterface;
 use Predis\Command\ScriptCommand;
 use Predis\Configuration\Options;
 use Predis\Configuration\OptionsInterface;
@@ -31,6 +33,7 @@
 use Predis\Response\ServerException;
 use Predis\Transaction\MultiExec as MultiExecTransaction;
 use ReturnTypeWillChange;
+use RuntimeException;
 use Traversable;
 
 /**
@@ -310,6 +313,34 @@ public function createCommand($commandID, $arguments = [])
         return $this->commands->create($commandID, $arguments);
     }
 
+    /**
+     * @param $name
+     * @return ContainerInterface
+     */
+    public function __get($name)
+    {
+        return ContainerFactory::create($this, $name);
+    }
+
+    /**
+     * @param $name
+     * @param $value
+     * @return mixed
+     */
+    public function __set($name, $value)
+    {
+        throw new RuntimeException('Not allowed');
+    }
+
+    /**
+     * @param $name
+     * @return mixed
+     */
+    public function __isset($name)
+    {
+        throw new RuntimeException('Not allowed');
+    }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/ClientContextInterface.php b/src/ClientContextInterface.php
@@ -14,8 +14,10 @@
 
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
+use Predis\Command\Argument\Server\LimitOffsetCount;
 use Predis\Command\Argument\Server\To;
 use Predis\Command\CommandInterface;
+use Predis\Command\Redis\Container\FunctionContainer;
 
 /**
  * Interface defining a client-side context such as a pipeline or transaction.
@@ -24,8 +26,8 @@
  * @method $this del(array|string $keys)
  * @method $this dump($key)
  * @method $this exists($key)
- * @method $this expire($key, $seconds)
- * @method $this expireat($key, $timestamp)
+ * @method $this expire($key, $seconds, string $expireOption = '')
+ * @method $this expireat($key, $timestamp, string $expireOption = '')
  * @method $this expiretime(string $key)
  * @method $this keys($pattern)
  * @method $this move($key, $db)
@@ -39,9 +41,11 @@
  * @method $this renamenx($key, $target)
  * @method $this scan($cursor, array $options = null)
  * @method $this sort($key, array $options = null)
+ * @method $this sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
  * @method $this ttl($key)
  * @method $this type($key)
  * @method $this append($key, $value)
+ * @method $this bitcount($key, $start = null, $end = null, string $index = 'byte')
  * @method $this bfadd(string $key, $item)
  * @method $this bfexists(string $key, $item)
  * @method $this bfinfo(string $key, string $modifier = '')
@@ -51,10 +55,9 @@
  * @method $this bfmexists(string $key, ...$item)
  * @method $this bfreserve(string $key, float $errorRate, int $capacity, int $expansion = -1, bool $nonScaling = false)
  * @method $this bfscandump(string $key, int $iterator)
- * @method $this bitcount($key, $start = null, $end = null)
  * @method $this bitop($operation, $destkey, $key)
  * @method $this bitfield($key, $subcommand, ...$subcommandArg)
- * @method $this bitpos($key, $bit, $start = null, $end = null)
+ * @method $this bitpos($key, $bit, $start = null, $end = null, string $index = 'byte')
  * @method $this blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
  * @method $this bzpopmax(array $keys, int $timeout)
  * @method $this bzpopmin(array $keys, int $timeout)
@@ -80,6 +83,7 @@
  * @method $this decr($key)
  * @method $this decrby($key, $decrement)
  * @method $this failover(?To $to = null, bool $abort = false, int $timeout = -1)
+ * @method $this fcall(string $function, array $keys, ...$args)
  * @method $this get($key)
  * @method $this getbit($key, $offset)
  * @method $this getex(string $key, $modifier = '', $value = false)
@@ -265,6 +269,9 @@
  * @method $this georadiusbymember($key, $member, $radius, $unit, array $options = null)
  * @method $this geosearch(string $key, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $withCoord = false, bool $withDist = false, bool $withHash = false)
  * @method $this geosearchstore(string $destination, string $source, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $storeDist = false)
+ *
+ * Container commands
+ * @property FunctionContainer $function
  */
 interface ClientContextInterface
 {

diff --git a/src/ClientInterface.php b/src/ClientInterface.php
@@ -14,9 +14,11 @@
 
 use Predis\Command\Argument\Geospatial\ByInterface;
 use Predis\Command\Argument\Geospatial\FromInterface;
+use Predis\Command\Argument\Server\LimitOffsetCount;
 use Predis\Command\Argument\Server\To;
 use Predis\Command\CommandInterface;
 use Predis\Command\FactoryInterface;
+use Predis\Command\Redis\Container\FunctionContainer;
 use Predis\Configuration\OptionsInterface;
 use Predis\Connection\ConnectionInterface;
 use Predis\Response\Status;
@@ -33,8 +35,8 @@
  * @method int               del(string[]|string $keyOrKeys, string ...$keys = null)
  * @method string|null       dump(string $key)
  * @method int               exists(string $key)
- * @method int               expire(string $key, int $seconds)
- * @method int               expireat(string $key, int $timestamp)
+ * @method int               expire(string $key, int $seconds, string $expireOption = '')
+ * @method int               expireat(string $key, int $timestamp, string $expireOption = '')
  * @method int               expiretime(string $key)
  * @method array             keys(string $pattern)
  * @method int               move(string $key, int $db)
@@ -48,9 +50,11 @@
  * @method int               renamenx(string $key, string $target)
  * @method array             scan($cursor, array $options = null)
  * @method array             sort(string $key, array $options = null)
+ * @method array             sort_ro(string $key, ?string $byPattern = null, ?LimitOffsetCount $limit = null, array $getPatterns = [], ?string $sorting = null, bool $alpha = false)
  * @method int               ttl(string $key)
  * @method mixed             type(string $key)
  * @method int               append(string $key, $value)
+ * @method int               bitcount(string $key, $start = null, $end = null, string $index = 'byte')
  * @method int               bfadd(string $key, $item)
  * @method int               bfexists(string $key, $item)
  * @method array             bfinfo(string $key, string $modifier = '')
@@ -60,10 +64,9 @@
  * @method array             bfmexists(string $key, ...$item)
  * @method Status            bfreserve(string $key, float $errorRate, int $capacity, int $expansion = -1, bool $nonScaling = false)
  * @method array             bfscandump(string $key, int $iterator)
- * @method int               bitcount(string $key, $start = null, $end = null)
  * @method int               bitop($operation, $destkey, $key)
  * @method array|null        bitfield(string $key, $subcommand, ...$subcommandArg)
- * @method int               bitpos(string $key, $bit, $start = null, $end = null)
+ * @method int               bitpos(string $key, $bit, $start = null, $end = null, string $index = 'byte')
  * @method array             blmpop(int $timeout, array $keys, string $modifier = 'left', int $count = 1)
  * @method array             bzpopmax(array $keys, int $timeout)
  * @method array             bzpopmin(array $keys, int $timeout)
@@ -89,6 +92,7 @@
  * @method int               decr(string $key)
  * @method int               decrby(string $key, int $decrement)
  * @method Status            failover(?To $to = null, bool $abort = false, int $timeout = -1)
+ * @method mixed             fcall(string $function, array $keys, ...$args)
  * @method string|null       get(string $key)
  * @method int               getbit(string $key, $offset)
  * @method int|null          getex(string $key, $modifier = '', $value = false)
@@ -283,6 +287,9 @@
  * @method array             georadiusbymember(string $key, $member, $radius, $unit, array $options = null)
  * @method array             geosearch(string $key, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $withCoord = false, bool $withDist = false, bool $withHash = false)
  * @method int               geosearchstore(string $destination, string $source, FromInterface $from, ByInterface $by, ?string $sorting = null, int $count = -1, bool $any = false, bool $storeDist = false)
+ *
+ * Container commands
+ * @property FunctionContainer $function
  */
 interface ClientInterface
 {

diff --git a/src/Command/Argument/Server/LimitInterface.php b/src/Command/Argument/Server/LimitInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Argument\Server;
+
+use Predis\Command\Argument\ArrayableArgument;
+
+interface LimitInterface extends ArrayableArgument
+{
+}
diff --git a/src/Command/Argument/Server/LimitOffsetCount.php b/src/Command/Argument/Server/LimitOffsetCount.php
@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Argument\Server;
+
+class LimitOffsetCount implements LimitInterface
+{
+    private const KEYWORD = 'LIMIT';
+
+    /**
+     * @var int
+     */
+    private $offset;
+
+    /**
+     * @var int
+     */
+    private $count;
+
+    public function __construct(int $offset, int $count)
+    {
+        $this->offset = $offset;
+        $this->count = $count;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [self::KEYWORD, $this->offset, $this->count];
+    }
+}
diff --git a/src/Command/Command.php b/src/Command/Command.php
@@ -120,7 +120,7 @@ public static function normalizeVariadic(array $arguments)
     public function filterArguments(): void
     {
         $this->arguments = array_filter($this->arguments, static function ($argument) {
-            return $argument !== false;
+            return $argument !== false && $argument !== null;
         });
     }
 }
diff --git a/src/Command/Processor/KeyPrefixProcessor.php b/src/Command/Processor/KeyPrefixProcessor.php
@@ -178,6 +178,12 @@ public function __construct($prefix)
             'GEODIST' => $prefixFirst,
             'GEORADIUS' => $prefixGeoradius,
             'GEORADIUSBYMEMBER' => $prefixGeoradius,
+            /* ---------------- Redis 5.0 ---------------- */
+            'XADD' => $prefixFirst,
+            'XRANGE' => $prefixFirst,
+            'XDEL' => $prefixFirst,
+            'XLEN' => $prefixFirst,
+            'XACK' => $prefixFirst,
         ];
     }
 

diff --git a/src/Command/Redis/BITCOUNT.php b/src/Command/Redis/BITCOUNT.php
@@ -13,12 +13,17 @@
 namespace Predis\Command\Redis;
 
 use Predis\Command\Command as RedisCommand;
+use Predis\Command\Traits\BitByte;
 
 /**
  * @see http://redis.io/commands/bitcount
+ *
+ * Count the number of set bits (population counting) in a string.
  */
 class BITCOUNT extends RedisCommand
 {
+    use BitByte;
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Command/Redis/BITPOS.php b/src/Command/Redis/BITPOS.php
@@ -13,12 +13,17 @@
 namespace Predis\Command\Redis;
 
 use Predis\Command\Command as RedisCommand;
+use Predis\Command\Traits\BitByte;
 
 /**
  * @see http://redis.io/commands/bitpos
+ *
+ * Return the position of the first bit set to 1 or 0 in a string.
  */
 class BITPOS extends RedisCommand
 {
+    use BitByte;
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Command/Redis/Container/AbstractContainer.php b/src/Command/Redis/Container/AbstractContainer.php
@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Container;
+
+use Predis\ClientInterface;
+
+abstract class AbstractContainer implements ContainerInterface
+{
+    /**
+     * @var ClientInterface
+     */
+    protected $client;
+
+    public function __construct(ClientInterface $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function __call($subcommandID, $arguments)
+    {
+        array_unshift($arguments, strtoupper($subcommandID));
+
+        return $this->client->executeCommand(
+            $this->client->createCommand($this->getContainerCommandId(), $arguments)
+        );
+    }
+
+    abstract public function getContainerCommandId(): string;
+}
diff --git a/src/Command/Redis/Container/ContainerFactory.php b/src/Command/Redis/Container/ContainerFactory.php
@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Predis package.
+ *
+ * (c) 2009-2020 Daniele Alessandri
+ * (c) 2021-2023 Till Krüss
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Predis\Command\Redis\Container;
+
+use Predis\ClientInterface;
+use UnexpectedValueException;
+
+class ContainerFactory
+{
+    private const CONTAINER_NAMESPACE = "Predis\Command\Redis\Container";
+
+    /**
+     * Mappings for class names that corresponds to PHP reserved words.
+     *
+     * @var array
+     */
+    private static $specialMappings = [
+        'FUNCTION' => FunctionContainer::class,
+    ];
+
+    /**
+     * Creates container command.
+     *
+     * @param  ClientInterface    $client
+     * @param  string             $containerCommandID
+     * @return ContainerInterface
+     */
+    public static function create(ClientInterface $client, string $containerCommandID): ContainerInterface
+    {
+        $containerCommandID = strtoupper($containerCommandID);
+
+        if (class_exists($containerClass = self::CONTAINER_NAMESPACE . '\\' . $containerCommandID)) {
+            return new $containerClass($client);
+        }
+
+        if (array_key_exists($containerCommandID, self::$specialMappings)) {
+            $containerClass = self::$specialMappings[$containerCommandID];
+
+            return new $containerClass($client);
+        }
+
+        throw new UnexpectedValueException('Given command is not supported.');
+    }
+}