xref: /webtrees/app/Http/Middleware/UseTheme.php (revision 24931b29a0237a5f5f1b8620af661ea530451af0) 
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\Module\ModuleThemeInterface;
23use Fisharebest\Webtrees\Module\WebtreesTheme;
24use Fisharebest\Webtrees\Registry;
25use Fisharebest\Webtrees\Services\ModuleService;
26use Fisharebest\Webtrees\Session;
27use Fisharebest\Webtrees\Site;
28use Generator;
29use Psr\Http\Message\ResponseInterface;
30use Psr\Http\Message\ServerRequestInterface;
31use Psr\Http\Server\MiddlewareInterface;
32use Psr\Http\Server\RequestHandlerInterface;
33
34/**
35 * Middleware to select a theme.
36 */
37class UseTheme implements MiddlewareInterface
38{
39    private ModuleService $module_service;
40
41    /**
42     * @param ModuleService $module_service
43     */
44    public function __construct(ModuleService $module_service)
45    {
46        $this->module_service = $module_service;
47    }
48
49    /**
50     * @param ServerRequestInterface  $request
51     * @param RequestHandlerInterface $handler
52     *
53     * @return ResponseInterface
54     */
55    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
56    {
57        foreach ($this->themes() as $theme) {
58            if ($theme instanceof ModuleThemeInterface) {
59                Registry::container()->set(ModuleThemeInterface::class, $theme);
60                $request = $request->withAttribute('theme', $theme);
61                Session::put('theme', $theme->name());
62                break;
63            }
64        }
65
66        return $handler->handle($request);
67    }
68
69    /**
70     * The theme can be chosen in various ways.
71     *
72     * @return Generator<ModuleThemeInterface|null>
73     */
74    private function themes(): Generator
75    {
76        $themes = $this->module_service->findByInterface(ModuleThemeInterface::class);
77
78        // Last theme used
79        yield $themes
80            ->first(static fn (ModuleThemeInterface $module): bool => $module->name() === Session::get('theme'));
81
82        // Default for site
83        yield $themes
84            ->first(static fn (ModuleThemeInterface $module): bool => $module->name() === Site::getPreference('THEME_DIR'));
85
86        // Default for application
87        yield new WebtreesTheme();
88    }
89}
90