. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Contracts\UserInterface; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\Http\RequestHandlers\UserPage; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Tree; use Illuminate\Database\Capsule\Manager as DB; use Illuminate\Support\Str; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use stdClass; use function assert; /** * Class UserFavoritesModule */ class UserFavoritesModule extends AbstractModule implements ModuleBlockInterface { use ModuleBlockTrait; /** * How should this module be identified in the control panel, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('Favorites'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “Favorites” module */ return I18N::translate('Display and manage a user’s favorite pages.'); } /** * Generate the HTML content of this block. * * @param Tree $tree * @param int $block_id * @param string $context * @param string[] $config * * @return string */ public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string { $content = view('modules/favorites/favorites', [ 'block_id' => $block_id, 'can_edit' => true, 'favorites' => $this->getFavorites($tree, Auth::user()), 'module_name' => $this->name(), 'tree' => $tree, ]); if ($context !== self::CONTEXT_EMBED) { return view('modules/block-template', [ 'block' => Str::kebab($this->name()), 'id' => $block_id, 'config_url' => '', 'title' => $this->title(), 'content' => $content, ]); } return $content; } /** * Should this block load asynchronously using AJAX? * Simple blocks are faster in-line, more complex ones can be loaded later. * * @return bool */ public function loadAjax(): bool { return false; } /** * Can this block be shown on the user’s home page? * * @return bool */ public function isUserBlock(): bool { return true; } /** * Can this block be shown on the tree’s home page? * * @return bool */ public function isTreeBlock(): bool { return false; } /** * Get the favorites for a user * * @param Tree $tree * @param UserInterface $user * * @return array */ public function getFavorites(Tree $tree, UserInterface $user): array { return DB::table('favorite') ->where('gedcom_id', '=', $tree->id()) ->where('user_id', '=', $user->id()) ->get() ->map(static function (stdClass $row) use ($tree): stdClass { if ($row->xref !== null) { $row->record = Registry::gedcomRecordFactory()->make($row->xref, $tree); if ($row->record instanceof GedcomRecord && !$row->record->canShowName()) { $row->record = null; $row->note = null; } } else { $row->record = null; } return $row; }) ->all(); } /** * @param ServerRequestInterface $request * * @return ResponseInterface */ public function postAddFavoriteAction(ServerRequestInterface $request): ResponseInterface { $tree = $request->getAttribute('tree'); assert($tree instanceof Tree); $user = $request->getAttribute('user'); $params = (array) $request->getParsedBody(); $note = $params['note']; $title = $params['title']; $url = $params['url']; $type = $params['type']; $xref = $params[$type . '-xref'] ?? ''; $record = $this->getRecordForType($type, $xref, $tree); if (Auth::check()) { if ($type === 'url' && $url !== '') { $this->addUrlFavorite($tree, $user, $url, $title ?: $url, $note); } if ($record instanceof GedcomRecord && $record->canShow()) { $this->addRecordFavorite($tree, $user, $record, $note); } } $url = route(UserPage::class, ['tree' => $tree->name()]); return redirect($url); } /** * @param ServerRequestInterface $request * * @return ResponseInterface */ public function postDeleteFavoriteAction(ServerRequestInterface $request): ResponseInterface { $tree = $request->getAttribute('tree'); assert($tree instanceof Tree); $user = $request->getAttribute('user'); $favorite_id = $request->getQueryParams()['favorite_id']; if (Auth::check()) { DB::table('favorite') ->where('favorite_id', '=', $favorite_id) ->where('user_id', '=', $user->id()) ->delete(); } $url = route(UserPage::class, ['tree' => $tree->name()]); return redirect($url); } /** * @param Tree $tree * @param UserInterface $user * @param string $url * @param string $title * @param string $note * * @return void */ private function addUrlFavorite(Tree $tree, UserInterface $user, string $url, string $title, string $note): void { DB::table('favorite')->updateOrInsert([ 'gedcom_id' => $tree->id(), 'user_id' => $user->id(), 'url' => $url, ], [ 'favorite_type' => 'URL', 'note' => $note, 'title' => $title, ]); } /** * @param Tree $tree * @param UserInterface $user * @param GedcomRecord $record * @param string $note * * @return void */ private function addRecordFavorite(Tree $tree, UserInterface $user, GedcomRecord $record, string $note): void { DB::table('favorite')->updateOrInsert([ 'gedcom_id' => $tree->id(), 'user_id' => $user->id(), 'xref' => $record->xref(), ], [ 'favorite_type' => $record->tag(), 'note' => $note, ]); } /** * @param string $type * @param string $xref * @param Tree $tree * * @return GedcomRecord|null */ private function getRecordForType(string $type, string $xref, Tree $tree): ?GedcomRecord { switch ($type) { case 'indi': return Registry::individualFactory()->make($xref, $tree); case 'fam': return Registry::familyFactory()->make($xref, $tree); case 'sour': return Registry::sourceFactory()->make($xref, $tree); case 'repo': return Registry::repositoryFactory()->make($xref, $tree); case 'obje': return Registry::mediaFactory()->make($xref, $tree); default: return null; } } }