phpOMS/DataStorage/Session/FileSessionHandler.php

<?php
/**
 * Karaka
 *
 * PHP Version 8.1
 *
 * @package   phpOMS\DataStorage\Session
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://karaka.app
 */
declare(strict_types=1);

namespace phpOMS\DataStorage\Session;

/**
 * File session handler.
 *
 * @package phpOMS\DataStorage\Session
 * @license OMS License 1.0
 * @link    https://karaka.app
 * @since   1.0.0
 *
 * @SuppressWarnings(PHPMD.Superglobals)
 */
final class FileSessionHandler implements \SessionHandlerInterface, \SessionIdInterface
{
    /**
     * File path for session
     *
     * @var string
     * @since 1.0.0
     */
    private string $savePath;

    /**
     * Constructor
     *
     * @param string $path Path of the session data
     *
     * @since 1.0.0
     */
    public function __construct(string $path)
    {
        $this->savePath = $path;

        if (\realpath($path) === false) {
            \mkdir($path, 0755, true);
        }
    }

    /**
     * Create a session id string
     *
     * @return string
     *
     * @since 1.0.0
     */
    public function create_sid() : string
    {
        return ($sid = \session_create_id('s-')) === false ? '' : $sid;
    }

    /**
     * Open the session storage
     *
     * @param string $savePath    Path of the session data
     * @param string $sessionName Name of the session
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function open(string $savePath, string $sessionName) : bool
    {
        $this->savePath = $savePath;

        return \is_dir($this->savePath);
    }

    /**
     * Close the session
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function close() : bool
    {
        return true;
    }

    /**
     * Read the session data
     *
     * @param string $id Session id
     *
     * @return false|string
     *
     * @since 1.0.0
     */
    public function read(string $id) : string|false
    {
        if (!\is_file($this->savePath . '/sess_' . $id)) {
            return '';
        }

        return \file_get_contents($this->savePath . '/sess_' . $id);
    }

    /**
     * Write session data
     *
     * @param string $id   Session id
     * @param string $data Session data
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function write(string $id, string $data) : bool
    {
        return \file_put_contents($this->savePath . '/sess_' . $id, $data) === false ? false : true;
    }

    /**
     * Destroy the session
     *
     * @param string $id Session id
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function destroy(string $id) : bool
    {
        $file = $this->savePath . '/sess_' . $id;
        if (\is_file($file)) {
            \unlink($file);
        }

        return true;
    }

    /**
     * Garbage collect session data
     *
     * @param int $maxlifetime Maximum session data life time
     *
     * @return int|false
     *
     * @since 1.0.0
     */
    public function gc(int $maxlifetime) : int|false
    {
        $files = \glob("{$this->savePath}/sess_*");

        if ($files === false) {
            return 0;
        }

        foreach ($files as $file) {
            if (\filemtime($file) + $maxlifetime < \time() && \is_file($file)) {
                \unlink($file);
            }
        }

        return 1;
    }
}