Classes List

Symfony\Component\Lock\Store\RedisStore

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Lock\Store;

use Symfony\Component\Cache\Traits\RedisProxy;
use Symfony\Component\Lock\Exception\InvalidArgumentException;
use Symfony\Component\Lock\Exception\LockConflictedException;
use Symfony\Component\Lock\Exception\LockExpiredException;
use Symfony\Component\Lock\Key;
use Symfony\Component\Lock\StoreInterface;

/** * RedisStore is a StoreInterface implementation using Redis as store engine. * * @author Jérémy Derussé <jeremy@derusse.com> */
class RedisStore implements StoreInterface
{
    private $redis;
    private $initialTtl;

    /** * @param \Redis|\RedisArray|\RedisCluster|\Predis\Client $redisClient * @param float $initialTtl the expiration delay of locks in seconds */
    public function __construct($redisClient$initialTtl = 300.0)
    {
        if (!$redisClient instanceof \Redis && !$redisClient instanceof \RedisArray && !$redisClient instanceof \RedisCluster && !$redisClient instanceof \Predis\Client && !$redisClient instanceof RedisProxy) {
            throw new InvalidArgumentException(sprintf('%s() expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\Client, %s given'__METHOD__is_object($redisClient) ? get_class($redisClient) : gettype($redisClient)));
        }

        if ($initialTtl <= 0) {
            throw new InvalidArgumentException(sprintf('%s() expects a strictly positive TTL. Got %d.'__METHOD__$initialTtl));
        }

        $this->redis = $redisClient;
        $this->initialTtl = $initialTtl;
    }

    /** * {@inheritdoc} */
    public function save(Key $key)
    {
        $script = ' if redis.call("GET", KEYS[1]) == ARGV[1] then return redis.call("PEXPIRE", KEYS[1], ARGV[2]) else return redis.call("set", KEYS[1], ARGV[1], "NX", "PX", ARGV[2]) end ';

        $key->reduceLifetime($this->initialTtl);
        if (!$this->evaluate($script(string) $keyarray($this->getToken($key), (int) ceil($this->initialTtl * 1000)))) {
            throw new LockConflictedException();
        }

        if ($key->isExpired()) {
            throw new LockExpiredException(sprintf('Failed to store the "%s" lock.'$key));
        }
    }

    public function waitAndSave(Key $key)
    {
        throw new InvalidArgumentException(sprintf('The store "%s" does not supports blocking locks.'get_class($this)));
    }

    /** * {@inheritdoc} */
    public function putOffExpiration(Key $key$ttl)
    {
        $script = ' if redis.call("GET", KEYS[1]) == ARGV[1] then return redis.call("PEXPIRE", KEYS[1], ARGV[2]) else return 0 end ';

        $key->reduceLifetime($ttl);
        if (!$this->evaluate($script(string) $keyarray($this->getToken($key), (int) ceil($ttl * 1000)))) {
            throw new LockConflictedException();
        }

        if ($key->isExpired()) {
            throw new LockExpiredException(sprintf('Failed to put off the expiration of the "%s" lock within the specified time.'$key));
        }
    }

    /** * {@inheritdoc} */
    public function delete(Key $key)
    {
        $script = ' if redis.call("GET", KEYS[1]) == ARGV[1] then return redis.call("DEL", KEYS[1]) else return 0 end ';

        $this->evaluate($script(string) $keyarray($this->getToken($key)));
    }

    /** * {@inheritdoc} */
    public function exists(Key $key)
    {
        return $this->redis->get((string) $key=== $this->getToken($key);
    }

    /** * Evaluates a script in the corresponding redis client. * * @param string $script * @param string $resource * @param array $args * * @return mixed */
    private function evaluate($script$resourcearray $args)
    {
        if ($this->redis instanceof \Redis || $this->redis instanceof \RedisCluster || $this->redis instanceof RedisProxy) {
            return $this->redis->eval($scriptarray_merge(array($resource), $args), 1);
        }

        if ($this->redis instanceof \RedisArray) {
            return $this->redis->_instance($this->redis->_target($resource))->eval($scriptarray_merge(array($resource), $args), 1);
        }

        if ($this->redis instanceof \Predis\Client) {
            return call_user_func_array(array($this->redis'eval'), array_merge(array($script1$resource), $args));
        }

        throw new InvalidArgumentException(sprintf('%s() expects been initialized with a Redis, RedisArray, RedisCluster or Predis\Client, %s given'__METHOD__is_object($this->redis) ? get_class($this->redis) : gettype($this->redis)));
    }

    /** * Retrieves an unique token for the given key. * * @param Key $key * * @return string */
    private function getToken(Key $key)
    {
        if (!$key->hasState(__CLASS__)) {
            $token = base64_encode(random_bytes(32));
            $key->setState(__CLASS__$token);
        }

        return $key->getState(__CLASS__);
    }
}