vendor/predis/predis/src/Command/Processor/KeyPrefixProcessor.php line 195

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Predis package.
  5.  *
  6.  * (c) Daniele Alessandri <suppakilla@gmail.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 Predis\Command\Processor;
  14. use Predis\Command\CommandInterface;
  15. use Predis\Command\PrefixableCommandInterface;
  17. /**
  18.  * Command processor capable of prefixing keys stored in the arguments of Redis
  19.  * commands supported.
  20.  *
  21.  * @author Daniele Alessandri <suppakilla@gmail.com>
  22.  */
  23. class KeyPrefixProcessor implements ProcessorInterface
  24. {
  25.     private $prefix;
  26.     private $commands;
  28.     /**
  29.      * @param string $prefix Prefix for the keys.
  30.      */
  31.     public function __construct($prefix)
  32.     {
  33.         $this->prefix = $prefix;
  34.         $this->commands = array(
  35.             /* ---------------- Redis 1.2 ---------------- */
  36.             'EXISTS' => 'static::all',
  37.             'DEL' => 'static::all',
  38.             'TYPE' => 'static::first',
  39.             'KEYS' => 'static::first',
  40.             'RENAME' => 'static::all',
  41.             'RENAMENX' => 'static::all',
  42.             'EXPIRE' => 'static::first',
  43.             'EXPIREAT' => 'static::first',
  44.             'TTL' => 'static::first',
  45.             'MOVE' => 'static::first',
  46.             'SORT' => 'static::sort',
  47.             'DUMP' => 'static::first',
  48.             'RESTORE' => 'static::first',
  49.             'SET' => 'static::first',
  50.             'SETNX' => 'static::first',
  51.             'MSET' => 'static::interleaved',
  52.             'MSETNX' => 'static::interleaved',
  53.             'GET' => 'static::first',
  54.             'MGET' => 'static::all',
  55.             'GETSET' => 'static::first',
  56.             'INCR' => 'static::first',
  57.             'INCRBY' => 'static::first',
  58.             'DECR' => 'static::first',
  59.             'DECRBY' => 'static::first',
  60.             'RPUSH' => 'static::first',
  61.             'LPUSH' => 'static::first',
  62.             'LLEN' => 'static::first',
  63.             'LRANGE' => 'static::first',
  64.             'LTRIM' => 'static::first',
  65.             'LINDEX' => 'static::first',
  66.             'LSET' => 'static::first',
  67.             'LREM' => 'static::first',
  68.             'LPOP' => 'static::first',
  69.             'RPOP' => 'static::first',
  70.             'RPOPLPUSH' => 'static::all',
  71.             'SADD' => 'static::first',
  72.             'SREM' => 'static::first',
  73.             'SPOP' => 'static::first',
  74.             'SMOVE' => 'static::skipLast',
  75.             'SCARD' => 'static::first',
  76.             'SISMEMBER' => 'static::first',
  77.             'SINTER' => 'static::all',
  78.             'SINTERSTORE' => 'static::all',
  79.             'SUNION' => 'static::all',
  80.             'SUNIONSTORE' => 'static::all',
  81.             'SDIFF' => 'static::all',
  82.             'SDIFFSTORE' => 'static::all',
  83.             'SMEMBERS' => 'static::first',
  84.             'SRANDMEMBER' => 'static::first',
  85.             'ZADD' => 'static::first',
  86.             'ZINCRBY' => 'static::first',
  87.             'ZREM' => 'static::first',
  88.             'ZRANGE' => 'static::first',
  89.             'ZREVRANGE' => 'static::first',
  90.             'ZRANGEBYSCORE' => 'static::first',
  91.             'ZCARD' => 'static::first',
  92.             'ZSCORE' => 'static::first',
  93.             'ZREMRANGEBYSCORE' => 'static::first',
  94.             /* ---------------- Redis 2.0 ---------------- */
  95.             'SETEX' => 'static::first',
  96.             'APPEND' => 'static::first',
  97.             'SUBSTR' => 'static::first',
  98.             'BLPOP' => 'static::skipLast',
  99.             'BRPOP' => 'static::skipLast',
  100.             'ZUNIONSTORE' => 'static::zsetStore',
  101.             'ZINTERSTORE' => 'static::zsetStore',
  102.             'ZCOUNT' => 'static::first',
  103.             'ZRANK' => 'static::first',
  104.             'ZREVRANK' => 'static::first',
  105.             'ZREMRANGEBYRANK' => 'static::first',
  106.             'HSET' => 'static::first',
  107.             'HSETNX' => 'static::first',
  108.             'HMSET' => 'static::first',
  109.             'HINCRBY' => 'static::first',
  110.             'HGET' => 'static::first',
  111.             'HMGET' => 'static::first',
  112.             'HDEL' => 'static::first',
  113.             'HEXISTS' => 'static::first',
  114.             'HLEN' => 'static::first',
  115.             'HKEYS' => 'static::first',
  116.             'HVALS' => 'static::first',
  117.             'HGETALL' => 'static::first',
  118.             'SUBSCRIBE' => 'static::all',
  119.             'UNSUBSCRIBE' => 'static::all',
  120.             'PSUBSCRIBE' => 'static::all',
  121.             'PUNSUBSCRIBE' => 'static::all',
  122.             'PUBLISH' => 'static::first',
  123.             /* ---------------- Redis 2.2 ---------------- */
  124.             'PERSIST' => 'static::first',
  125.             'STRLEN' => 'static::first',
  126.             'SETRANGE' => 'static::first',
  127.             'GETRANGE' => 'static::first',
  128.             'SETBIT' => 'static::first',
  129.             'GETBIT' => 'static::first',
  130.             'RPUSHX' => 'static::first',
  131.             'LPUSHX' => 'static::first',
  132.             'LINSERT' => 'static::first',
  133.             'BRPOPLPUSH' => 'static::skipLast',
  134.             'ZREVRANGEBYSCORE' => 'static::first',
  135.             'WATCH' => 'static::all',
  136.             /* ---------------- Redis 2.6 ---------------- */
  137.             'PTTL' => 'static::first',
  138.             'PEXPIRE' => 'static::first',
  139.             'PEXPIREAT' => 'static::first',
  140.             'PSETEX' => 'static::first',
  141.             'INCRBYFLOAT' => 'static::first',
  142.             'BITOP' => 'static::skipFirst',
  143.             'BITCOUNT' => 'static::first',
  144.             'HINCRBYFLOAT' => 'static::first',
  145.             'EVAL' => 'static::evalKeys',
  146.             'EVALSHA' => 'static::evalKeys',
  147.             'MIGRATE' => 'static::migrate',
  148.             /* ---------------- Redis 2.8 ---------------- */
  149.             'SSCAN' => 'static::first',
  150.             'ZSCAN' => 'static::first',
  151.             'HSCAN' => 'static::first',
  152.             'PFADD' => 'static::first',
  153.             'PFCOUNT' => 'static::all',
  154.             'PFMERGE' => 'static::all',
  155.             'ZLEXCOUNT' => 'static::first',
  156.             'ZRANGEBYLEX' => 'static::first',
  157.             'ZREMRANGEBYLEX' => 'static::first',
  158.             'ZREVRANGEBYLEX' => 'static::first',
  159.             'BITPOS' => 'static::first',
  160.             /* ---------------- Redis 3.2 ---------------- */
  161.             'HSTRLEN' => 'static::first',
  162.             'BITFIELD' => 'static::first',
  163.             'GEOADD' => 'static::first',
  164.             'GEOHASH' => 'static::first',
  165.             'GEOPOS' => 'static::first',
  166.             'GEODIST' => 'static::first',
  167.             'GEORADIUS' => 'static::georadius',
  168.             'GEORADIUSBYMEMBER' => 'static::georadius',
  169.         );
  170.     }
  172.     /**
  173.      * Sets a prefix that is applied to all the keys.
  174.      *
  175.      * @param string $prefix Prefix for the keys.
  176.      */
  177.     public function setPrefix($prefix)
  178.     {
  179.         $this->prefix = $prefix;
  180.     }
  182.     /**
  183.      * Gets the current prefix.
  184.      *
  185.      * @return string
  186.      */
  187.     public function getPrefix()
  188.     {
  189.         return $this->prefix;
  190.     }
  192.     /**
  193.      * {@inheritdoc}
  194.      */
  195.     public function process(CommandInterface $command)
  196.     {
  197.         if ($command instanceof PrefixableCommandInterface) {
  198.             $command->prefixKeys($this->prefix);
  199.         } elseif (isset($this->commands[$commandID = strtoupper($command->getId())])) {
  200.             call_user_func($this->commands[$commandID], $command, $this->prefix);
  201.         }
  202.     }
  204.     /**
  205.      * Sets an handler for the specified command ID.
  206.      *
  207.      * The callback signature must have 2 parameters of the following types:
  208.      *
  209.      *   - Predis\Command\CommandInterface (command instance)
  210.      *   - String (prefix)
  211.      *
  212.      * When the callback argument is omitted or NULL, the previously
  213.      * associated handler for the specified command ID is removed.
  214.      *
  215.      * @param string $commandID The ID of the command to be handled.
  216.      * @param mixed  $callback  A valid callable object or NULL.
  217.      *
  218.      * @throws \InvalidArgumentException
  219.      */
  220.     public function setCommandHandler($commandID, $callback = null)
  221.     {
  222.         $commandID = strtoupper($commandID);
  224.         if (!isset($callback)) {
  225.             unset($this->commands[$commandID]);
  227.             return;
  228.         }
  230.         if (!is_callable($callback)) {
  231.             throw new \InvalidArgumentException(
  232.                 'Callback must be a valid callable object or NULL'
  233.             );
  234.         }
  236.         $this->commands[$commandID] = $callback;
  237.     }
  239.     /**
  240.      * {@inheritdoc}
  241.      */
  242.     public function __toString()
  243.     {
  244.         return $this->getPrefix();
  245.     }
  247.     /**
  248.      * Applies the specified prefix only the first argument.
  249.      *
  250.      * @param CommandInterface $command Command instance.
  251.      * @param string           $prefix  Prefix string.
  252.      */
  253.     public static function first(CommandInterface $command, $prefix)
  254.     {
  255.         if ($arguments = $command->getArguments()) {
  256.             $arguments[0] = "$prefix{$arguments[0]}";
  257.             $command->setRawArguments($arguments);
  258.         }
  259.     }
  261.     /**
  262.      * Applies the specified prefix to all the arguments.
  263.      *
  264.      * @param CommandInterface $command Command instance.
  265.      * @param string           $prefix  Prefix string.
  266.      */
  267.     public static function all(CommandInterface $command, $prefix)
  268.     {
  269.         if ($arguments = $command->getArguments()) {
  270.             foreach ($arguments as &$key) {
  271.                 $key = "$prefix$key";
  272.             }
  274.             $command->setRawArguments($arguments);
  275.         }
  276.     }
  278.     /**
  279.      * Applies the specified prefix only to even arguments in the list.
  280.      *
  281.      * @param CommandInterface $command Command instance.
  282.      * @param string           $prefix  Prefix string.
  283.      */
  284.     public static function interleaved(CommandInterface $command, $prefix)
  285.     {
  286.         if ($arguments = $command->getArguments()) {
  287.             $length = count($arguments);
  289.             for ($i = 0; $i < $length; $i += 2) {
  290.                 $arguments[$i] = "$prefix{$arguments[$i]}";
  291.             }
  293.             $command->setRawArguments($arguments);
  294.         }
  295.     }
  297.     /**
  298.      * Applies the specified prefix to all the arguments but the first one.
  299.      *
  300.      * @param CommandInterface $command Command instance.
  301.      * @param string           $prefix  Prefix string.
  302.      */
  303.     public static function skipFirst(CommandInterface $command, $prefix)
  304.     {
  305.         if ($arguments = $command->getArguments()) {
  306.             $length = count($arguments);
  308.             for ($i = 1; $i < $length; ++$i) {
  309.                 $arguments[$i] = "$prefix{$arguments[$i]}";
  310.             }
  312.             $command->setRawArguments($arguments);
  313.         }
  314.     }
  316.     /**
  317.      * Applies the specified prefix to all the arguments but the last one.
  318.      *
  319.      * @param CommandInterface $command Command instance.
  320.      * @param string           $prefix  Prefix string.
  321.      */
  322.     public static function skipLast(CommandInterface $command, $prefix)
  323.     {
  324.         if ($arguments = $command->getArguments()) {
  325.             $length = count($arguments);
  327.             for ($i = 0; $i < $length - 1; ++$i) {
  328.                 $arguments[$i] = "$prefix{$arguments[$i]}";
  329.             }
  331.             $command->setRawArguments($arguments);
  332.         }
  333.     }
  335.     /**
  336.      * Applies the specified prefix to the keys of a SORT command.
  337.      *
  338.      * @param CommandInterface $command Command instance.
  339.      * @param string           $prefix  Prefix string.
  340.      */
  341.     public static function sort(CommandInterface $command, $prefix)
  342.     {
  343.         if ($arguments = $command->getArguments()) {
  344.             $arguments[0] = "$prefix{$arguments[0]}";
  346.             if (($count = count($arguments)) > 1) {
  347.                 for ($i = 1; $i < $count; ++$i) {
  348.                     switch (strtoupper($arguments[$i])) {
  349.                         case 'BY':
  350.                         case 'STORE':
  351.                             $arguments[$i] = "$prefix{$arguments[++$i]}";
  352.                             break;
  354.                         case 'GET':
  355.                             $value = $arguments[++$i];
  356.                             if ($value !== '#') {
  357.                                 $arguments[$i] = "$prefix$value";
  358.                             }
  359.                             break;
  361.                         case 'LIMIT';
  362.                             $i += 2;
  363.                             break;
  364.                     }
  365.                 }
  366.             }
  368.             $command->setRawArguments($arguments);
  369.         }
  370.     }
  372.     /**
  373.      * Applies the specified prefix to the keys of an EVAL-based command.
  374.      *
  375.      * @param CommandInterface $command Command instance.
  376.      * @param string           $prefix  Prefix string.
  377.      */
  378.     public static function evalKeys(CommandInterface $command, $prefix)
  379.     {
  380.         if ($arguments = $command->getArguments()) {
  381.             for ($i = 2; $i < $arguments[1] + 2; ++$i) {
  382.                 $arguments[$i] = "$prefix{$arguments[$i]}";
  383.             }
  385.             $command->setRawArguments($arguments);
  386.         }
  387.     }
  389.     /**
  390.      * Applies the specified prefix to the keys of Z[INTERSECTION|UNION]STORE.
  391.      *
  392.      * @param CommandInterface $command Command instance.
  393.      * @param string           $prefix  Prefix string.
  394.      */
  395.     public static function zsetStore(CommandInterface $command, $prefix)
  396.     {
  397.         if ($arguments = $command->getArguments()) {
  398.             $arguments[0] = "$prefix{$arguments[0]}";
  399.             $length = ((int) $arguments[1]) + 2;
  401.             for ($i = 2; $i < $length; ++$i) {
  402.                 $arguments[$i] = "$prefix{$arguments[$i]}";
  403.             }
  405.             $command->setRawArguments($arguments);
  406.         }
  407.     }
  409.     /**
  410.      * Applies the specified prefix to the key of a MIGRATE command.
  411.      *
  412.      * @param CommandInterface $command Command instance.
  413.      * @param string           $prefix  Prefix string.
  414.      */
  415.     public static function migrate(CommandInterface $command, $prefix)
  416.     {
  417.         if ($arguments = $command->getArguments()) {
  418.             $arguments[2] = "$prefix{$arguments[2]}";
  419.             $command->setRawArguments($arguments);
  420.         }
  421.     }
  423.     /**
  424.      * Applies the specified prefix to the key of a GEORADIUS command.
  425.      *
  426.      * @param CommandInterface $command Command instance.
  427.      * @param string           $prefix  Prefix string.
  428.      */
  429.     public static function georadius(CommandInterface $command, $prefix)
  430.     {
  431.         if ($arguments = $command->getArguments()) {
  432.             $arguments[0] = "$prefix{$arguments[0]}";
  433.             $startIndex = $command->getId() === 'GEORADIUS' ? 5 : 4;
  435.             if (($count = count($arguments)) > $startIndex) {
  436.                 for ($i = $startIndex; $i < $count; ++$i) {
  437.                     switch (strtoupper($arguments[$i])) {
  438.                         case 'STORE':
  439.                         case 'STOREDIST':
  440.                             $arguments[$i] = "$prefix{$arguments[++$i]}";
  441.                             break;
  443.                     }
  444.                 }
  445.             }
  447.             $command->setRawArguments($arguments);
  448.         }
  449.     }
  450. }