xref: /webtrees/app/Http/RequestHandlers/TreePreferencesPage.php (revision 52550490b7095dd69811f3ec21ed5a3ca1a8968d)
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\RequestHandlers;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\ElementInterface;
24use Fisharebest\Webtrees\Contracts\UserInterface;
25use Fisharebest\Webtrees\Date;
26use Fisharebest\Webtrees\Elements\UnknownElement;
27use Fisharebest\Webtrees\Http\ViewResponseTrait;
28use Fisharebest\Webtrees\I18N;
29use Fisharebest\Webtrees\Module\ModuleThemeInterface;
30use Fisharebest\Webtrees\Registry;
31use Fisharebest\Webtrees\Services\ModuleService;
32use Fisharebest\Webtrees\Services\TreeService;
33use Fisharebest\Webtrees\Services\UserService;
34use Fisharebest\Webtrees\Validator;
35use Illuminate\Support\Collection;
36use Psr\Http\Message\ResponseInterface;
37use Psr\Http\Message\ServerRequestInterface;
38use Psr\Http\Server\RequestHandlerInterface;
39
40use function e;
41use function explode;
42use function in_array;
43
44/**
45 * Edit the tree preferences.
46 */
47class TreePreferencesPage implements RequestHandlerInterface
48{
49    use ViewResponseTrait;
50
51    private ModuleService $module_service;
52
53    private TreeService $tree_service;
54
55    private UserService $user_service;
56
57    /**
58     * @param ModuleService $module_service
59     * @param TreeService   $tree_service
60     * @param UserService   $user_service
61     */
62    public function __construct(
63        ModuleService $module_service,
64        TreeService $tree_service,
65        UserService $user_service
66    ) {
67        $this->module_service = $module_service;
68        $this->tree_service   = $tree_service;
69        $this->user_service   = $user_service;
70    }
71
72    /**
73     * @param ServerRequestInterface $request
74     *
75     * @return ResponseInterface
76     */
77    public function handle(ServerRequestInterface $request): ResponseInterface
78    {
79        $this->layout = 'layouts/administration';
80
81        $tree        = Validator::attributes($request)->tree();
82        $data_folder = Registry::filesystem()->dataName();
83
84        $french_calendar_start    = new Date('22 SEP 1792');
85        $french_calendar_end      = new Date('31 DEC 1805');
86        $gregorian_calendar_start = new Date('15 OCT 1582');
87
88        $surname_list_styles = [
89            /* I18N: Layout option for lists of names */
90            'style1' => I18N::translate('list'),
91            /* I18N: Layout option for lists of names */
92            'style2' => I18N::translate('table'),
93            /* I18N: Layout option for lists of names */
94            'style3' => I18N::translate('tag cloud'),
95        ];
96
97        $page_layouts = [
98            /* I18N: page orientation */
99            0 => I18N::translate('Portrait'),
100            /* I18N: page orientation */
101            1 => I18N::translate('Landscape'),
102        ];
103
104        $formats = [
105            /* I18N: https://en.wikipedia.org/wiki/Plain_text */
106            ''         => I18N::translate('plain text'),
107            /* I18N: https://en.wikipedia.org/wiki/Markdown */
108            'markdown' => I18N::translate('markdown'),
109        ];
110
111        $source_types = [
112            0 => I18N::translate('none'),
113            1 => I18N::translate('facts'),
114            2 => I18N::translate('records'),
115        ];
116
117        $theme_options = $this->module_service
118            ->findByInterface(ModuleThemeInterface::class)
119            ->map($this->module_service->titleMapper())
120            ->prepend(I18N::translate('<default theme>'), '');
121
122        $privacy_options = [
123            Auth::PRIV_USER => I18N::translate('Show to members'),
124            Auth::PRIV_NONE => I18N::translate('Show to managers'),
125            Auth::PRIV_HIDE => I18N::translate('Hide from everyone'),
126        ];
127
128        // For historical reasons, we have two fields in one
129        $calendar_formats = explode('_and_', $tree->getPreference('CALENDAR_FORMAT') . '_and_');
130
131        // Split into separate fields
132        $relatives_events = explode(',', $tree->getPreference('SHOW_RELATIVES_EVENTS'));
133
134        $pedigree_individual = Registry::individualFactory()->make($tree->getPreference('PEDIGREE_ROOT_ID'), $tree);
135
136        $members = $this->user_service->all()->filter(static fn (UserInterface $user): bool => Auth::isMember($tree, $user));
137
138        $ignore_facts = ['CHAN', 'CHIL', 'FAMC', 'FAMS', 'HUSB', 'SUBM', 'WIFE', 'NAME', 'SEX'];
139
140        $all_family_facts = Collection::make(Registry::elementFactory()->make('FAM')->subtags())
141            ->filter(static fn (string $value, string $key): bool => !in_array($key, $ignore_facts, true))
142            ->mapWithKeys(static fn (string $value, string $key): array => [$key => 'FAM:' . $key])
143            ->map(static fn (string $tag): ElementInterface => Registry::elementFactory()->make($tag))
144            ->filter(static fn (ElementInterface $element): bool => !$element instanceof UnknownElement)
145            ->map(static fn (ElementInterface $element): string => $element->label())
146            ->sort(I18N::comparator());
147
148        $all_individual_facts = Collection::make(Registry::elementFactory()->make('INDI')->subtags())
149            ->filter(static fn (string $value, string $key): bool => !in_array($key, $ignore_facts, true))
150            ->mapWithKeys(static fn (string $value, string $key): array => [$key => 'INDI:' . $key])
151            ->map(static fn (string $tag): ElementInterface => Registry::elementFactory()->make($tag))
152            ->filter(static fn (ElementInterface $element): bool => !$element instanceof UnknownElement)
153            ->map(static fn (ElementInterface $element): string => $element->label())
154            ->sort(I18N::comparator());
155
156        $all_surname_traditions = Registry::surnameTraditionFactory()->list();
157
158        $tree_count = $this->tree_service->all()->count();
159
160        $title = I18N::translate('Preferences') . ' — ' . e($tree->title());
161
162        $base_url = Validator::attributes($request)->string('base_url');
163
164        return $this->viewResponse('admin/trees-preferences', [
165            'all_family_facts'         => $all_family_facts,
166            'all_individual_facts'     => $all_individual_facts,
167            'all_surname_traditions'   => $all_surname_traditions,
168            'base_url'                 => $base_url,
169            'calendar_formats'         => $calendar_formats,
170            'data_folder'              => $data_folder,
171            'formats'                  => $formats,
172            'french_calendar_end'      => $french_calendar_end,
173            'french_calendar_start'    => $french_calendar_start,
174            'gregorian_calendar_start' => $gregorian_calendar_start,
175            'members'                  => $members,
176            'page_layouts'             => $page_layouts,
177            'pedigree_individual'      => $pedigree_individual,
178            'privacy_options'          => $privacy_options,
179            'relatives_events'         => $relatives_events,
180            'source_types'             => $source_types,
181            'surname_list_styles'      => $surname_list_styles,
182            'theme_options'            => $theme_options,
183            'title'                    => $title,
184            'tree'                     => $tree,
185            'tree_count'               => $tree_count,
186        ]);
187    }
188}
189