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