xref: /webtrees/app/Module/UserFavoritesModule.php (revision 202c018b592d5a516e4a465dc6dc515f3be37399) 
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\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\DB;
25use Fisharebest\Webtrees\GedcomRecord;
26use Fisharebest\Webtrees\Http\RequestHandlers\UserPage;
27use Fisharebest\Webtrees\I18N;
28use Fisharebest\Webtrees\Registry;
29use Fisharebest\Webtrees\Tree;
30use Fisharebest\Webtrees\Validator;
31use Illuminate\Support\Str;
32use Psr\Http\Message\ResponseInterface;
33use Psr\Http\Message\ServerRequestInterface;
34
35/**
36 * Class UserFavoritesModule
37 */
38class UserFavoritesModule extends AbstractModule implements ModuleBlockInterface
39{
40    use ModuleBlockTrait;
41
42    /**
43     * How should this module be identified in the control panel, etc.?
44     *
45     * @return string
46     */
47    public function title(): string
48    {
49        /* I18N: Name of a module */
50        return I18N::translate('Favorites');
51    }
52
53    /**
54     * A sentence describing what this module does.
55     *
56     * @return string
57     */
58    public function description(): string
59    {
60        /* I18N: Description of the “Favorites” module */
61        return I18N::translate('Display and manage a user’s favorite pages.');
62    }
63
64    /**
65     * Generate the HTML content of this block.
66     *
67     * @param Tree                 $tree
68     * @param int                  $block_id
69     * @param string               $context
70     * @param array<string,string> $config
71     *
72     * @return string
73     */
74    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
75    {
76        $content = view('modules/favorites/favorites', [
77            'block_id'    => $block_id,
78            'can_edit'    => true,
79            'favorites'   => $this->getFavorites($tree, Auth::user()),
80            'module_name' => $this->name(),
81            'tree'        => $tree,
82        ]);
83
84        if ($context !== self::CONTEXT_EMBED) {
85            return view('modules/block-template', [
86                'block'      => Str::kebab($this->name()),
87                'id'         => $block_id,
88                'config_url' => '',
89                'title'      => $this->title(),
90                'content'    => $content,
91            ]);
92        }
93
94        return $content;
95    }
96
97    /**
98     * Should this block load asynchronously using AJAX?
99     * Simple blocks are faster in-line, more complex ones can be loaded later.
100     *
101     * @return bool
102     */
103    public function loadAjax(): bool
104    {
105        return false;
106    }
107
108    /**
109     * Can this block be shown on the user’s home page?
110     *
111     * @return bool
112     */
113    public function isUserBlock(): bool
114    {
115        return true;
116    }
117
118    /**
119     * Can this block be shown on the tree’s home page?
120     *
121     * @return bool
122     */
123    public function isTreeBlock(): bool
124    {
125        return false;
126    }
127
128    /**
129     * Get the favorites for a user
130     *
131     * @param Tree          $tree
132     * @param UserInterface $user
133     *
134     * @return array<object>
135     */
136    public function getFavorites(Tree $tree, UserInterface $user): array
137    {
138        return DB::table('favorite')
139            ->where('gedcom_id', '=', $tree->id())
140            ->where('user_id', '=', $user->id())
141            ->get()
142            ->map(static function (object $row) use ($tree): object {
143                if ($row->xref !== null) {
144                    $row->record = Registry::gedcomRecordFactory()->make($row->xref, $tree);
145
146                    if ($row->record instanceof GedcomRecord && !$row->record->canShowName()) {
147                        $row->record = null;
148                        $row->note   = null;
149                    }
150                } else {
151                    $row->record = null;
152                }
153
154                return $row;
155            })
156            ->all();
157    }
158
159    /**
160     * @param ServerRequestInterface $request
161     *
162     * @return ResponseInterface
163     */
164    public function postAddFavoriteAction(ServerRequestInterface $request): ResponseInterface
165    {
166        $tree   = Validator::attributes($request)->tree();
167        $user   = Validator::attributes($request)->user();
168        $note   = Validator::parsedBody($request)->string('note');
169        $title  = Validator::parsedBody($request)->string('title');
170        $url    = Validator::parsedBody($request)->string('url');
171        $type   = Validator::parsedBody($request)->string('type');
172        $xref   = Validator::parsedBody($request)->string($type . '-xref', '');
173        $record = $this->getRecordForType($type, $xref, $tree);
174
175        if (Auth::check()) {
176            if ($type === 'url' && $url !== '') {
177                $this->addUrlFavorite($tree, $user, $url, $title ?: $url, $note);
178            }
179
180            if ($record instanceof GedcomRecord && $record->canShow()) {
181                $this->addRecordFavorite($tree, $user, $record, $note);
182            }
183        }
184
185        $url = route(UserPage::class, ['tree' => $tree->name()]);
186
187        return redirect($url);
188    }
189
190    /**
191     * @param ServerRequestInterface $request
192     *
193     * @return ResponseInterface
194     */
195    public function postDeleteFavoriteAction(ServerRequestInterface $request): ResponseInterface
196    {
197        $tree        = Validator::attributes($request)->tree();
198        $user        = Validator::attributes($request)->user();
199        $favorite_id = Validator::queryParams($request)->integer('favorite_id');
200
201        if (Auth::check()) {
202            DB::table('favorite')
203                ->where('favorite_id', '=', $favorite_id)
204                ->where('user_id', '=', $user->id())
205                ->delete();
206        }
207
208        $url = route(UserPage::class, ['tree' => $tree->name()]);
209
210        return redirect($url);
211    }
212
213    /**
214     * @param Tree          $tree
215     * @param UserInterface $user
216     * @param string        $url
217     * @param string        $title
218     * @param string        $note
219     *
220     * @return void
221     */
222    private function addUrlFavorite(Tree $tree, UserInterface $user, string $url, string $title, string $note): void
223    {
224        DB::table('favorite')->updateOrInsert([
225            'gedcom_id' => $tree->id(),
226            'user_id'   => $user->id(),
227            'url'       => $url,
228        ], [
229            'favorite_type' => 'URL',
230            'note'          => $note,
231            'title'         => $title,
232        ]);
233    }
234
235    /**
236     * @param Tree          $tree
237     * @param UserInterface $user
238     * @param GedcomRecord  $record
239     * @param string        $note
240     *
241     * @return void
242     */
243    private function addRecordFavorite(Tree $tree, UserInterface $user, GedcomRecord $record, string $note): void
244    {
245        DB::table('favorite')->updateOrInsert([
246            'gedcom_id' => $tree->id(),
247            'user_id'   => $user->id(),
248            'xref'      => $record->xref(),
249        ], [
250            'favorite_type' => $record->tag(),
251            'note'          => $note,
252        ]);
253    }
254
255    private function getRecordForType(string $type, string $xref, Tree $tree): GedcomRecord|null
256    {
257        switch ($type) {
258            case 'indi':
259                return Registry::individualFactory()->make($xref, $tree);
260
261            case 'fam':
262                return Registry::familyFactory()->make($xref, $tree);
263
264            case 'sour':
265                return Registry::sourceFactory()->make($xref, $tree);
266
267            case 'repo':
268                return Registry::repositoryFactory()->make($xref, $tree);
269
270            case 'obje':
271                return Registry::mediaFactory()->make($xref, $tree);
272
273            default:
274                return null;
275        }
276    }
277}
278