9.5/_database_session_backend_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Core\Session\Backend;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use Doctrine\DBAL\DBALException;

use ‪TYPO3\CMS\Core\Database\Connection;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Query\QueryBuilder;

use ‪TYPO3\CMS\Core\Session\Backend\Exception\SessionNotCreatedException;

use ‪TYPO3\CMS\Core\Session\Backend\Exception\SessionNotFoundException;

use ‪TYPO3\CMS\Core\Session\Backend\Exception\SessionNotUpdatedException;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪DatabaseSessionBackend implements ‪SessionBackendInterface, ‪HashableSessionBackendInterface

{

    protected ‪$configuration = [];


    protected ‪$hasAnonymousSessions = false;


    public function ‪initialize(string $identifier, array ‪$configuration)

    {

        $this->hasAnonymousSessions = (bool)(‪$configuration['has_anonymous'] ?? false);

        $this->configuration = ‪$configuration;

    }


    public function ‪validateConfiguration(): bool

    {

        if (empty($this->configuration['table'])) {

            throw new \InvalidArgumentException(

                'The session backend "' . static::class . '" needs a "table" configuration.',

                1442996707

            );

        }

        return true;

    }


    public function ‪hash(string $sessionId): string

    {

        // The sha1 hash ensures we have good length for the key.

        $key = sha1(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . 'core-session-backend');

        // @todo md5 is used as be_sessions.ses_id field only supports 32 characters in stable branches

        return hash_hmac('md5', $sessionId, $key);

    }


    public function get(string $sessionId): array

    {

        $query = $this->‪getQueryBuilder();


        $query->select('*')

            ->from($this->configuration['table'])

            ->where($query->expr()->eq('ses_id', $query->createNamedParameter($this->hash($sessionId), \PDO::PARAM_STR)));


        $result = $query->execute()->fetch();


        if (!is_array($result)) {

            // Check for a non-hashed-version, will be removed in TYPO3 v11

            $query = $this->‪getQueryBuilder();


            $result = $query->select('*')

                ->from($this->configuration['table'])

                ->where($query->expr()->eq('ses_id', $query->createNamedParameter($sessionId, \PDO::PARAM_STR)))

                ->execute()

                ->fetch();

            if (!is_array($result)) {

                throw new SessionNotFoundException(

                    'The session with identifier ' . $sessionId . ' was not found ',

                    1481885483

                );

            }

        }

        return $result;

    }


    public function remove(string $sessionId): bool

    {

        $query = $this->‪getQueryBuilder();

        $query->delete($this->configuration['table'])

            ->where(

                $query->expr()->orX(

                    $query->expr()->eq('ses_id', $query->createNamedParameter($this->hash($sessionId), \PDO::PARAM_STR)),

                    $query->expr()->eq('ses_id', $query->createNamedParameter($sessionId, \PDO::PARAM_STR))

                )

            );


        return (bool)$query->execute();

    }


    public function set(string $sessionId, array $sessionData): array

    {

        $sessionId = $this->‪hash($sessionId);

        $sessionData['ses_id'] = $sessionId;

        $sessionData['ses_tstamp'] = ‪$GLOBALS['EXEC_TIME'] ?? time();


        try {

            $this->‪getConnection()->‪insert(

                $this->configuration['table'],

                $sessionData,

                ['ses_data' => \PDO::PARAM_LOB]

            );

        } catch (DBALException $e) {

            throw new SessionNotCreatedException(

                'Session could not be written to database: ' . $e->getMessage(),

                1481895005,

                $e

            );

        }


        return $sessionData;

    }


    public function ‪update(string $sessionId, array $sessionData): array

    {

        $hashedSessionId = $this->‪hash($sessionId);

        $sessionData['ses_id'] = $hashedSessionId;

        $sessionData['ses_tstamp'] = ‪$GLOBALS['EXEC_TIME'] ?? time();


        try {

            // allow 0 records to be affected, happens when no columns where changed

            $this->‪getConnection()->‪update(

                $this->configuration['table'],

                $sessionData,

                ['ses_id' => $hashedSessionId],

                ['ses_data' => \PDO::PARAM_LOB]

            );

            // Migrate old session data as well to remove old entries and promote them to migrated entries

            $this->‪getConnection()->‪update(

                $this->configuration['table'],

                $sessionData,

                ['ses_id' => $sessionId],

                ['ses_data' => \PDO::PARAM_LOB]

            );

        } catch (DBALException $e) {

            throw new SessionNotUpdatedException(

                'Session with id ' . $sessionId . ' could not be updated: ' . $e->getMessage(),

                1481889220,

                $e

            );

        }

        return $sessionData;

    }


    public function ‪collectGarbage(int $maximumLifetime, int $maximumAnonymousLifetime = 0)

    {

        $query = $this->‪getQueryBuilder();


        $query->delete($this->configuration['table'])

            ->where($query->expr()->lt('ses_tstamp', (int)(‪$GLOBALS['EXEC_TIME'] - (int)$maximumLifetime)))

            ->andWhere($this->hasAnonymousSessions ? $query->expr()->eq('ses_anonymous', 0) : ' 1 = 1');

        $query->execute();


        if ($maximumAnonymousLifetime > 0 && $this->hasAnonymousSessions) {

            $query = $this->‪getQueryBuilder();

            $query->delete($this->configuration['table'])

                ->where($query->expr()->lt('ses_tstamp', (int)(‪$GLOBALS['EXEC_TIME'] - (int)$maximumAnonymousLifetime)))

                ->andWhere($query->expr()->eq('ses_anonymous', 1));

            $query->execute();

        }

    }


    public function ‪getAll(): array

    {

        $query = $this->‪getQueryBuilder();

        $query->select('*')->from($this->configuration['table']);

        return $query->execute()->fetchAll();

    }


    protected function ‪getQueryBuilder(): QueryBuilder

    {

        return $this->‪getConnection()->‪createQueryBuilder();

    }


    protected function ‪getConnection(): Connection

    {

        return GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->configuration['table']);

    }

}