xref: /webtrees/app/Http/RequestHandlers/TreePreferencesAction.php (revision 24f2a3af38709f9bf0a739b30264240d20ba34e8) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 Exception;
23use Fisharebest\Webtrees\FlashMessages;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Tree;
26use Illuminate\Database\Capsule\Manager as DB;
27use Psr\Http\Message\ResponseInterface;
28use Psr\Http\Message\ServerRequestInterface;
29use Psr\Http\Server\RequestHandlerInterface;
30
31use function array_unique;
32use function assert;
33use function e;
34use function implode;
35use function preg_replace;
36use function redirect;
37use function route;
38use function trim;
39
40/**
41 * Edit the tree preferences.
42 */
43class TreePreferencesAction implements RequestHandlerInterface
44{
45    /**
46     * @param ServerRequestInterface $request
47     *
48     * @return ResponseInterface
49     */
50    public function handle(ServerRequestInterface $request): ResponseInterface
51    {
52        $tree = $request->getAttribute('tree');
53        assert($tree instanceof Tree);
54
55        $params = (array) $request->getParsedBody();
56
57        $tree->setPreference('ADVANCED_NAME_FACTS', implode(',', $params['ADVANCED_NAME_FACTS'] ?? []));
58        $tree->setPreference('ADVANCED_PLAC_FACTS', implode(',', $params['ADVANCED_PLAC_FACTS'] ?? []));
59        // For backwards compatibility with webtrees 1.x we store the two calendar formats in one variable
60        // e.g. "gregorian_and_jewish"
61        $tree->setPreference('CALENDAR_FORMAT', implode('_and_', array_unique([
62            $params['CALENDAR_FORMAT0'] ?? 'none',
63            $params['CALENDAR_FORMAT1'] ?? 'none',
64        ])));
65        $tree->setPreference('CHART_BOX_TAGS', implode(',', $params['CHART_BOX_TAGS'] ?? []));
66        $tree->setPreference('CONTACT_USER_ID', $params['CONTACT_USER_ID'] ?? '');
67        $tree->setPreference('EXPAND_NOTES', $params['EXPAND_NOTES'] ?? '');
68        $tree->setPreference('EXPAND_SOURCES', $params['EXPAND_SOURCES'] ?? '');
69        $tree->setPreference('FAM_FACTS_ADD', implode(',', $params['FAM_FACTS_ADD'] ?? []));
70        $tree->setPreference('FAM_FACTS_QUICK', implode(',', $params['FAM_FACTS_QUICK'] ?? []));
71        $tree->setPreference('FAM_FACTS_UNIQUE', implode(',', $params['FAM_FACTS_UNIQUE'] ?? []));
72        $tree->setPreference('FULL_SOURCES', $params['FULL_SOURCES'] ?? '');
73        $tree->setPreference('FORMAT_TEXT', $params['FORMAT_TEXT'] ?? '');
74        $tree->setPreference('GENERATE_UIDS', $params['GENERATE_UIDS'] ?? '');
75        $tree->setPreference('HIDE_GEDCOM_ERRORS', $params['HIDE_GEDCOM_ERRORS'] ?? '');
76        $tree->setPreference('INDI_FACTS_ADD', implode(',', $params['INDI_FACTS_ADD'] ?? []));
77        $tree->setPreference('INDI_FACTS_QUICK', implode(',', $params['INDI_FACTS_QUICK'] ?? []));
78        $tree->setPreference('INDI_FACTS_UNIQUE', implode(',', $params['INDI_FACTS_UNIQUE'] ?? []));
79        $tree->setPreference('MEDIA_UPLOAD', $params['MEDIA_UPLOAD'] ?? '');
80        $tree->setPreference('META_DESCRIPTION', $params['META_DESCRIPTION'] ?? '');
81        $tree->setPreference('META_TITLE', $params['META_TITLE'] ?? '');
82        $tree->setPreference('NO_UPDATE_CHAN', $params['NO_UPDATE_CHAN'] ?? '');
83        $tree->setPreference('PEDIGREE_ROOT_ID', $params['PEDIGREE_ROOT_ID'] ?? '');
84        $tree->setPreference('PREFER_LEVEL2_SOURCES', $params['PREFER_LEVEL2_SOURCES'] ?? '');
85        $tree->setPreference('QUICK_REQUIRED_FACTS', implode(',', $params['QUICK_REQUIRED_FACTS'] ?? []));
86        $tree->setPreference('QUICK_REQUIRED_FAMFACTS', implode(',', $params['QUICK_REQUIRED_FAMFACTS'] ?? []));
87        $tree->setPreference('REPO_FACTS_ADD', implode(',', $params['REPO_FACTS_ADD'] ?? []));
88        $tree->setPreference('REPO_FACTS_QUICK', implode(',', $params['REPO_FACTS_QUICK'] ?? []));
89        $tree->setPreference('REPO_FACTS_UNIQUE', implode(',', $params['REPO_FACTS_UNIQUE'] ?? []));
90        $tree->setPreference('SHOW_COUNTER', $params['SHOW_COUNTER'] ?? '');
91        $tree->setPreference('SHOW_EST_LIST_DATES', $params['SHOW_EST_LIST_DATES'] ?? '');
92        $tree->setPreference('SHOW_FACT_ICONS', $params['SHOW_FACT_ICONS'] ?? '');
93        $tree->setPreference('SHOW_GEDCOM_RECORD', $params['SHOW_GEDCOM_RECORD'] ?? '');
94        $tree->setPreference('SHOW_HIGHLIGHT_IMAGES', $params['SHOW_HIGHLIGHT_IMAGES'] ?? '');
95        $tree->setPreference('SHOW_LAST_CHANGE', $params['SHOW_LAST_CHANGE'] ?? '');
96        $tree->setPreference('SHOW_MEDIA_DOWNLOAD', $params['SHOW_MEDIA_DOWNLOAD'] ?? '');
97        $tree->setPreference('SHOW_NO_WATERMARK', $params['SHOW_NO_WATERMARK'] ?? '');
98        $tree->setPreference('SHOW_PARENTS_AGE', $params['SHOW_PARENTS_AGE'] ?? '');
99        $tree->setPreference('SHOW_PEDIGREE_PLACES', $params['SHOW_PEDIGREE_PLACES'] ?? '');
100        $tree->setPreference('SHOW_PEDIGREE_PLACES_SUFFIX', $params['SHOW_PEDIGREE_PLACES_SUFFIX'] ?? '');
101        $tree->setPreference('SHOW_RELATIVES_EVENTS', implode(',', $params['SHOW_RELATIVES_EVENTS'] ?? []));
102        $tree->setPreference('SOUR_FACTS_ADD', implode(',', $params['SOUR_FACTS_ADD'] ?? []));
103        $tree->setPreference('SOUR_FACTS_QUICK', implode(',', $params['SOUR_FACTS_QUICK'] ?? []));
104        $tree->setPreference('SOUR_FACTS_UNIQUE', implode(',', $params['SOUR_FACTS_UNIQUE'] ?? []));
105        $tree->setPreference('SUBLIST_TRIGGER_I', $params['SUBLIST_TRIGGER_I'] ?? '200');
106        $tree->setPreference('SURNAME_LIST_STYLE', $params['SURNAME_LIST_STYLE'] ?? '');
107        $tree->setPreference('SURNAME_TRADITION', $params['SURNAME_TRADITION'] ?? '');
108        $tree->setPreference('USE_SILHOUETTE', $params['USE_SILHOUETTE'] ?? '');
109        $tree->setPreference('WEBMASTER_USER_ID', $params['WEBMASTER_USER_ID'] ?? '');
110        $tree->setPreference('title', $params['title'] ?? '');
111
112        // Only accept valid folders for MEDIA_DIRECTORY
113        $MEDIA_DIRECTORY = $params['MEDIA_DIRECTORY'] ?? '';
114        $MEDIA_DIRECTORY = preg_replace('/[:\/\\\\]+/', '/', $MEDIA_DIRECTORY);
115        $MEDIA_DIRECTORY = trim($MEDIA_DIRECTORY, '/') . '/';
116
117        $tree->setPreference('MEDIA_DIRECTORY', $MEDIA_DIRECTORY);
118
119        $gedcom = $params['gedcom'] ?? '';
120
121        if ($gedcom !== '' && $gedcom !== $tree->name()) {
122            try {
123                DB::table('gedcom')
124                    ->where('gedcom_id', '=', $tree->id())
125                    ->update(['gedcom_name' => $gedcom]);
126
127                DB::table('site_setting')
128                    ->where('setting_name', '=', 'DEFAULT_GEDCOM')
129                    ->where('setting_value', '=', $tree->name())
130                    ->update(['setting_value' => $gedcom]);
131            } catch (Exception $ex) {
132                // Probably a duplicate name.
133            }
134        }
135
136        FlashMessages::addMessage(I18N::translate('The preferences for the family tree “%s” have been updated.', e($tree->title())), 'success');
137
138        // Coming soon...
139        $all_trees = $params['all_trees'] ?? '';
140        $new_trees = $params['new_trees'] ?? '';
141
142        if ($all_trees === 'on') {
143            FlashMessages::addMessage(I18N::translate('The preferences for all family trees have been updated.'), 'success');
144        }
145
146        if ($new_trees === 'on') {
147            FlashMessages::addMessage(I18N::translate('The preferences for new family trees have been updated.'), 'success');
148        }
149
150        $url = route(ManageTrees::class, ['tree' => $gedcom]);
151
152        return redirect($url);
153    }
154}
155