xref: /webtrees/app/SessionDatabaseHandler.php (revision dfc849d226fb4bd64f14664478a941ef05c27b61)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees;

use Illuminate\Database\Capsule\Manager as DB;
use Psr\Http\Message\ServerRequestInterface;
use SessionHandlerInterface;
use stdClass;

/**
 * Session handling - stores sessions in the database.
 */
class SessionDatabaseHandler implements SessionHandlerInterface
{
    /** @var ServerRequestInterface */
    private $request;

    /** @var stdClass|null The row from the session table */
    private $row;

    public function __construct(ServerRequestInterface $request)
    {
        $this->request = $request;
    }

    /**
     * @param string $save_path
     * @param string $name
     *
     * @return bool
     */
    public function open($save_path, $name): bool
    {
        return true;
    }

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

    /**
     * @param string $id
     *
     * @return string
     */
    public function read($id): string
    {
        $this->row = DB::table('session')
            ->where('session_id', '=', $id)
            ->first();


        return $this->row->session_data ?? '';
    }

    /**
     * @param string $id
     * @param string $data
     *
     * @return bool
     */
    public function write($id, $data): bool
    {
        if ($this->row === null) {
            DB::table('session')->insert([
                'session_id' => $id,
                'session_time' => Carbon::now(),
                'user_id'      => (int) Auth::id(),
                'ip_address'   => $this->request->getAttribute('client-ip'),
                'session_data' => $data,
            ]);
        } else {
            $updates = [];

            // The user ID can change if we masquerade as another user.
            if ((int) $this->row->user_id !== (int) Auth::id()) {
                $updates['user_id'] = (int) Auth::id();
            }

            if ($this->row->ip_address !== $this->request->getAttribute('client-ip')) {
                $updates['ip_address'] = $this->request->getAttribute('client-ip');
            }

            if ($this->row->session_data !== $data) {
                $updates['session_data'] = $data;
            }

            if (Carbon::now()->subMinute()->gt($this->row->session_time)) {
                $updates['session_time'] = Carbon::now();
            }

            if ($updates !== []) {
                DB::table('session')
                    ->where('session_id', '=', $id)
                    ->update($updates);
            }
        }

        return true;
    }

    /**
     * @param string $id
     *
     * @return bool
     */
    public function destroy($id): bool
    {
        DB::table('session')
            ->where('session_id', '=', $id)
            ->delete();

        return true;
    }

    /**
     * @param int $maxlifetime
     *
     * @return bool
     */
    public function gc($maxlifetime): bool
    {
        DB::table('session')
            ->where('session_time', '<', Carbon::now()->subSeconds($maxlifetime))
            ->delete();

        return true;
    }
}