vendor/symfony/http-foundation/Session/Storage/Handler/RedisSessionHandler.php line 74

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\HttpFoundation\Session\Storage\Handler;
  14. use Predis\Response\ErrorInterface;
  15. use Symfony\Component\Cache\Traits\RedisClusterProxy;
  16. use Symfony\Component\Cache\Traits\RedisProxy;
  18. /**
  19.  * Redis based session storage handler based on the Redis class
  20.  * provided by the PHP redis extension.
  21.  *
  22.  * @author Dalibor Karlović <dalibor@flexolabs.io>
  23.  */
  24. class RedisSessionHandler extends AbstractSessionHandler
  25. {
  26.     private $redis;
  28.     /**
  29.      * @var string Key prefix for shared environments
  30.      */
  31.     private $prefix;
  33.     /**
  34.      * @var int Time to live in seconds
  35.      */
  36.     private $ttl;
  38.     /**
  39.      * List of available options:
  40.      *  * prefix: The prefix to use for the keys in order to avoid collision on the Redis server
  41.      *  * ttl: The time to live in seconds.
  42.      *
  43.      * @param \Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|RedisProxy|RedisClusterProxy $redis
  44.      *
  45.      * @throws \InvalidArgumentException When unsupported client or options are passed
  46.      */
  47.     public function __construct($redis, array $options = [])
  48.     {
  49.         if (
  50.             !$redis instanceof \Redis &&
  51.             !$redis instanceof \RedisArray &&
  52.             !$redis instanceof \RedisCluster &&
  53.             !$redis instanceof \Predis\ClientInterface &&
  54.             !$redis instanceof RedisProxy &&
  55.             !$redis instanceof RedisClusterProxy
  56.         ) {
  57.             throw new \InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, get_debug_type($redis)));
  58.         }
  60.         if ($diff = array_diff(array_keys($options), ['prefix', 'ttl'])) {
  61.             throw new \InvalidArgumentException(sprintf('The following options are not supported "%s".', implode(', ', $diff)));
  62.         }
  64.         $this->redis = $redis;
  65.         $this->prefix = $options['prefix'] ?? 'sf_s';
  66.         $this->ttl = $options['ttl'] ?? null;
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     protected function doRead(string $sessionId): string
  73.     {
  74.         return $this->redis->get($this->prefix.$sessionId) ?: '';
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     protected function doWrite(string $sessionId, string $data): bool
  81.     {
  82.         $result = $this->redis->setEx($this->prefix.$sessionId, (int) ($this->ttl ?? \ini_get('session.gc_maxlifetime')), $data);
  84.         return $result && !$result instanceof ErrorInterface;
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     protected function doDestroy(string $sessionId): bool
  91.     {
  92.         static $unlink = true;
  94.         if ($unlink) {
  95.             try {
  96.                 $unlink = false !== $this->redis->unlink($this->prefix.$sessionId);
  97.             } catch (\Throwable $e) {
  98.                 $unlink = false;
  99.             }
  100.         }
  102.         if (!$unlink) {
  103.             $this->redis->del($this->prefix.$sessionId);
  104.         }
  106.         return true;
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     #[\ReturnTypeWillChange]
  113.     public function close(): bool
  114.     {
  115.         return true;
  116.     }
  118.     /**
  119.      * {@inheritdoc}
  120.      *
  121.      * @return int|false
  122.      */
  123.     #[\ReturnTypeWillChange]
  124.     public function gc($maxlifetime)
  125.     {
  126.         return 0;
  127.     }
  129.     /**
  130.      * @return bool
  131.      */
  132.     #[\ReturnTypeWillChange]
  133.     public function updateTimestamp($sessionId, $data)
  134.     {
  135.         return (bool) $this->redis->expire($this->prefix.$sessionId, (int) ($this->ttl ?? \ini_get('session.gc_maxlifetime')));
  136.     }
  137. }