xref: /webtrees/app/Http/Middleware/UseTheme.php (revision fcfa147e10aaa6c7ff580c29bd6e5b88666befc1)
1b5979037SGreg Roach<?php
23976b470SGreg Roach
3b5979037SGreg Roach/**
4b5979037SGreg Roach * webtrees: online genealogy
5b5979037SGreg Roach * Copyright (C) 2019 webtrees development team
6b5979037SGreg Roach * This program is free software: you can redistribute it and/or modify
7b5979037SGreg Roach * it under the terms of the GNU General Public License as published by
8b5979037SGreg Roach * the Free Software Foundation, either version 3 of the License, or
9b5979037SGreg Roach * (at your option) any later version.
10b5979037SGreg Roach * This program is distributed in the hope that it will be useful,
11b5979037SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12b5979037SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13b5979037SGreg Roach * GNU General Public License for more details.
14b5979037SGreg Roach * You should have received a copy of the GNU General Public License
15b5979037SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
16b5979037SGreg Roach */
17*fcfa147eSGreg Roach
18b5979037SGreg Roachdeclare(strict_types=1);
19b5979037SGreg Roach
20b5979037SGreg Roachnamespace Fisharebest\Webtrees\Http\Middleware;
21b5979037SGreg Roach
22b5979037SGreg Roachuse Fisharebest\Webtrees\Module\ModuleThemeInterface;
23b5979037SGreg Roachuse Fisharebest\Webtrees\Module\WebtreesTheme;
24b5979037SGreg Roachuse Fisharebest\Webtrees\Services\ModuleService;
25b5979037SGreg Roachuse Fisharebest\Webtrees\Session;
26b5979037SGreg Roachuse Fisharebest\Webtrees\Site;
27b5979037SGreg Roachuse Fisharebest\Webtrees\Tree;
28b5979037SGreg Roachuse Generator;
296ccdf4f0SGreg Roachuse Psr\Http\Message\ResponseInterface;
306ccdf4f0SGreg Roachuse Psr\Http\Message\ServerRequestInterface;
316ccdf4f0SGreg Roachuse Psr\Http\Server\MiddlewareInterface;
326ccdf4f0SGreg Roachuse Psr\Http\Server\RequestHandlerInterface;
33b5979037SGreg Roach
34b5979037SGreg Roach/**
35b5979037SGreg Roach * Middleware to set a global theme.
36b5979037SGreg Roach */
37b5979037SGreg Roachclass UseTheme implements MiddlewareInterface
38b5979037SGreg Roach{
39b5979037SGreg Roach    /** @var ModuleService */
40b5979037SGreg Roach    private $module_service;
41b5979037SGreg Roach
42b5979037SGreg Roach    /**
43b5979037SGreg Roach     * UseTheme constructor.
44b5979037SGreg Roach     *
45b5979037SGreg Roach     * @param ModuleService $module_service
46b5979037SGreg Roach     */
4717b3ba76SGreg Roach    public function __construct(ModuleService $module_service)
48b5979037SGreg Roach    {
49b5979037SGreg Roach        $this->module_service = $module_service;
50b5979037SGreg Roach    }
51b5979037SGreg Roach
52b5979037SGreg Roach    /**
536ccdf4f0SGreg Roach     * @param ServerRequestInterface  $request
546ccdf4f0SGreg Roach     * @param RequestHandlerInterface $handler
55b5979037SGreg Roach     *
566ccdf4f0SGreg Roach     * @return ResponseInterface
57b5979037SGreg Roach     */
586ccdf4f0SGreg Roach    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
59b5979037SGreg Roach    {
60f1d4b4a2SGreg Roach        foreach ($this->themes($request) as $theme) {
61b5979037SGreg Roach            if ($theme instanceof ModuleThemeInterface) {
62b5979037SGreg Roach                // Bind this theme into the container
63b5979037SGreg Roach                app()->instance(ModuleThemeInterface::class, $theme);
64b5979037SGreg Roach
65b5979037SGreg Roach                // Remember this setting
66a0801ffbSGreg Roach                Session::put('theme', $theme->name());
67b5979037SGreg Roach
68b5979037SGreg Roach                break;
69b5979037SGreg Roach            }
70b5979037SGreg Roach        }
71b5979037SGreg Roach
726ccdf4f0SGreg Roach        return $handler->handle($request);
73b5979037SGreg Roach    }
74b5979037SGreg Roach
75b5979037SGreg Roach    /**
76b5979037SGreg Roach     * The theme can be chosen in various ways.
77b5979037SGreg Roach     *
78f1d4b4a2SGreg Roach     * @param ServerRequestInterface $request
79f1d4b4a2SGreg Roach     *
80b5979037SGreg Roach     * @return Generator
81b5979037SGreg Roach     */
82f1d4b4a2SGreg Roach    private function themes(ServerRequestInterface $request): Generator
83b5979037SGreg Roach    {
84b5979037SGreg Roach        $themes = $this->module_service->findByInterface(ModuleThemeInterface::class);
85b5979037SGreg Roach
86b5979037SGreg Roach        // Last theme used
87a0801ffbSGreg Roach        yield $themes->get(Session::get('theme', ''));
88b5979037SGreg Roach
89b5979037SGreg Roach        // Default for tree
90f1d4b4a2SGreg Roach        $tree = $request->getAttribute('tree');
9117b3ba76SGreg Roach
9217b3ba76SGreg Roach        if ($tree instanceof Tree) {
9317b3ba76SGreg Roach            yield $themes->get($tree->getPreference('THEME_DIR'));
94b5979037SGreg Roach        }
95b5979037SGreg Roach
96b5979037SGreg Roach        // Default for site
97b5979037SGreg Roach        yield $themes->get(Site::getPreference('THEME_DIR'));
98b5979037SGreg Roach
99b5979037SGreg Roach        // Default for application
100cab242e7SGreg Roach        yield app(WebtreesTheme::class);
101b5979037SGreg Roach    }
102b5979037SGreg Roach}
103