Redis.php

<?php

declare(strict_types=1);

namespace Rancoud\Session;

use Predis\Client as Predis;

class Redis implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
{
    protected Predis $redis;

    protected int $lifetime = 1440;

    protected int $lengthSessionID = 127;

    public function setNewRedis(array|string $configuration): void
    {
        $this->redis = new Predis($configuration);
    }

    public function setCurrentRedis(Predis $redis): void
    {
        $this->redis = $redis;
    }

    public function setLifetime(int $lifetime): void
    {
        $this->lifetime = $lifetime;
    }

    /** @throws SessionException */
    public function setLengthSessionID(int $length): void
    {
        if ($length < 32) {
            throw new SessionException('could not set length session ID below 32');
        }

        $this->lengthSessionID = $length;
    }

    public function getLengthSessionID(): int
    {
        return $this->lengthSessionID;
    }

    public function open(string $path, string $name): bool
    {
        return true;
    }

    public function close(): bool
    {
        return true;
    }

    public function read(string $id): string
    {
        return (string) $this->redis->get($id);
    }

    public function write(string $id, string $data): bool
    {
        $this->redis->set($id, $data);
        $this->redis->expireat($id, \time() + $this->lifetime);

        return true;
    }

    public function destroy(string $id): bool
    {
        $this->redis->del([$id]);

        return true;
    }

    #[\ReturnTypeWillChange]
    public function gc(int $max_lifetime): bool
    {
        return true;
    }

    /** Checks format and id exists, if not session_id will be regenerate. */
    public function validateId(string $id): bool
    {
        if (\preg_match('/^[a-zA-Z0-9-]{' . $this->lengthSessionID . '}+$/', $id) !== 1) {
            return false;
        }

        $exist = $this->redis->exists($id);

        return $exist === 1;
    }

    /** Updates the timestamp of a session when its data didn't change. */
    public function updateTimestamp(string $id, string $data): bool
    {
        return $this->write($id, $data);
    }

    /**
     * @throws SessionException
     *
     * @noinspection PhpMethodNamingConventionInspection
     */
    public function create_sid(): string
    {
        $string = '';
        $characters = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-';

        try {
            $countCharacters = 62;
            for ($i = 0; $i < $this->lengthSessionID; ++$i) {
                $string .= $characters[\random_int(0, $countCharacters)];
            }
            // @codeCoverageIgnoreStart
        } catch (\Exception $e) {
            /* If an appropriate source of randomness cannot be found, an Exception will be thrown.
             * The list of randomness: https://www.php.net/manual/en/function.random-int.php
             */
            throw new SessionException('could not create sid: ' . $e->getMessage(), $e->getCode(), $e->getPrevious());
            // @codeCoverageIgnoreEnd
        }

        $exist = $this->redis->exists($string);
        if ($exist !== 0) {
            // @codeCoverageIgnoreStart
            // Could not reach this statement without mocking the function
            return $this->create_sid();
            // @codeCoverageIgnoreEnd
        }

        return $string;
    }
}