xref: /webtrees/app/Http/Middleware/UseSession.php (revision 2978efea0c934a7f830579d20c3e8661e837b748) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\Middleware;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\Session;
25use Fisharebest\Webtrees\Webtrees;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28use Psr\Http\Server\MiddlewareInterface;
29use Psr\Http\Server\RequestHandlerInterface;
30
31use function session_destroy;
32use function session_status;
33use function time;
34
35use const PHP_SESSION_ACTIVE;
36
37/**
38 * Middleware to activate sessions.
39 */
40class UseSession implements MiddlewareInterface
41{
42    // To avoid read-write contention on the wt_user_setting table, don't update the last-active time on every request.
43    private const UPDATE_ACTIVITY_INTERVAL = 60;
44
45    /**
46     * @param ServerRequestInterface  $request
47     * @param RequestHandlerInterface $handler
48     *
49     * @return ResponseInterface
50     */
51    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
52    {
53        // Some sites (e.g. Wordpress/NinjaFirewall) use the PHP auto_prepend_file
54        // setting to run their own startup code - which may start a session.
55        if (session_status() === PHP_SESSION_ACTIVE) {
56            session_destroy();
57        }
58
59        // Sessions
60        Session::start($request);
61
62        $user = Auth::user();
63
64        // Update the last-login time.
65        if (Session::get('masquerade') === null) {
66            $last = (int) $user->getPreference(UserInterface::PREF_TIMESTAMP_ACTIVE);
67
68            if (time() - $last >= self::UPDATE_ACTIVITY_INTERVAL) {
69                $user->setPreference(UserInterface::PREF_TIMESTAMP_ACTIVE, (string) time());
70            }
71        }
72
73        // Allow request handlers, modules, etc. to have a dependency on the current user.
74        Webtrees::set(UserInterface::class, $user);
75
76        $request = $request->withAttribute('user', $user);
77
78        $response = $handler->handle($request);
79
80        Session::save();
81
82        return $response;
83    }
84}
85