You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
137 lines
3.6 KiB
137 lines
3.6 KiB
<?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\HttpFoundation\Session\Storage\Handler; |
|
|
|
use Predis\Response\ErrorInterface; |
|
use Symfony\Component\Cache\Traits\RedisClusterProxy; |
|
use Symfony\Component\Cache\Traits\RedisProxy; |
|
|
|
/** |
|
* Redis based session storage handler based on the Redis class |
|
* provided by the PHP redis extension. |
|
* |
|
* @author Dalibor Karlović <dalibor@flexolabs.io> |
|
*/ |
|
class RedisSessionHandler extends AbstractSessionHandler |
|
{ |
|
private $redis; |
|
|
|
/** |
|
* @var string Key prefix for shared environments |
|
*/ |
|
private $prefix; |
|
|
|
/** |
|
* @var int Time to live in seconds |
|
*/ |
|
private $ttl; |
|
|
|
/** |
|
* List of available options: |
|
* * prefix: The prefix to use for the keys in order to avoid collision on the Redis server |
|
* * ttl: The time to live in seconds. |
|
* |
|
* @param \Redis|\RedisArray|\RedisCluster|\Predis\ClientInterface|RedisProxy|RedisClusterProxy $redis |
|
* |
|
* @throws \InvalidArgumentException When unsupported client or options are passed |
|
*/ |
|
public function __construct($redis, array $options = []) |
|
{ |
|
if ( |
|
!$redis instanceof \Redis && |
|
!$redis instanceof \RedisArray && |
|
!$redis instanceof \RedisCluster && |
|
!$redis instanceof \Predis\ClientInterface && |
|
!$redis instanceof RedisProxy && |
|
!$redis instanceof RedisClusterProxy |
|
) { |
|
throw new \InvalidArgumentException(sprintf('"%s()" expects parameter 1 to be Redis, RedisArray, RedisCluster or Predis\ClientInterface, "%s" given.', __METHOD__, get_debug_type($redis))); |
|
} |
|
|
|
if ($diff = array_diff(array_keys($options), ['prefix', 'ttl'])) { |
|
throw new \InvalidArgumentException(sprintf('The following options are not supported "%s".', implode(', ', $diff))); |
|
} |
|
|
|
$this->redis = $redis; |
|
$this->prefix = $options['prefix'] ?? 'sf_s'; |
|
$this->ttl = $options['ttl'] ?? null; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function doRead(string $sessionId): string |
|
{ |
|
return $this->redis->get($this->prefix.$sessionId) ?: ''; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function doWrite(string $sessionId, string $data): bool |
|
{ |
|
$result = $this->redis->setEx($this->prefix.$sessionId, (int) ($this->ttl ?? \ini_get('session.gc_maxlifetime')), $data); |
|
|
|
return $result && !$result instanceof ErrorInterface; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
protected function doDestroy(string $sessionId): bool |
|
{ |
|
static $unlink = true; |
|
|
|
if ($unlink) { |
|
try { |
|
$unlink = false !== $this->redis->unlink($this->prefix.$sessionId); |
|
} catch (\Throwable $e) { |
|
$unlink = false; |
|
} |
|
} |
|
|
|
if (!$unlink) { |
|
$this->redis->del($this->prefix.$sessionId); |
|
} |
|
|
|
return true; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
#[\ReturnTypeWillChange] |
|
public function close(): bool |
|
{ |
|
return true; |
|
} |
|
|
|
/** |
|
* {@inheritdoc} |
|
* |
|
* @return int|false |
|
*/ |
|
#[\ReturnTypeWillChange] |
|
public function gc($maxlifetime) |
|
{ |
|
return 0; |
|
} |
|
|
|
/** |
|
* @return bool |
|
*/ |
|
#[\ReturnTypeWillChange] |
|
public function updateTimestamp($sessionId, $data) |
|
{ |
|
return (bool) $this->redis->expire($this->prefix.$sessionId, (int) ($this->ttl ?? \ini_get('session.gc_maxlifetime'))); |
|
} |
|
}
|
|
|