1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2018 webtrees development team 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation, either version 3 of the License, or 8 * (at your option) any later version. 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * You should have received a copy of the GNU General Public License 14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 15 */ 16declare(strict_types=1); 17 18namespace Fisharebest\Webtrees\Module; 19 20use Fisharebest\Webtrees\Auth; 21use Fisharebest\Webtrees\Database; 22use Fisharebest\Webtrees\GedcomRecord; 23use Fisharebest\Webtrees\I18N; 24use Fisharebest\Webtrees\Tree; 25use Fisharebest\Webtrees\User; 26use stdClass; 27use Symfony\Component\HttpFoundation\RedirectResponse; 28use Symfony\Component\HttpFoundation\Request; 29 30/** 31 * Class UserFavoritesModule 32 */ 33class UserFavoritesModule extends AbstractModule implements ModuleBlockInterface 34{ 35 /** 36 * How should this module be labelled on tabs, menus, etc.? 37 * 38 * @return string 39 */ 40 public function getTitle(): string 41 { 42 /* I18N: Name of a module */ 43 return I18N::translate('Favorites'); 44 } 45 46 /** 47 * A sentence describing what this module does. 48 * 49 * @return string 50 */ 51 public function getDescription(): string 52 { 53 /* I18N: Description of the “Favorites” module */ 54 return I18N::translate('Display and manage a user’s favorite pages.'); 55 } 56 57 /** 58 * Generate the HTML content of this block. 59 * 60 * @param Tree $tree 61 * @param int $block_id 62 * @param bool $template 63 * @param string[] $cfg 64 * 65 * @return string 66 */ 67 public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string 68 { 69 $content = view('modules/user_favorites/favorites', [ 70 'block_id' => $block_id, 71 'favorites' => $this->getFavorites($tree, Auth::user()), 72 'tree' => $tree, 73 ]); 74 75 if ($template) { 76 return view('modules/block-template', [ 77 'block' => str_replace('_', '-', $this->getName()), 78 'id' => $block_id, 79 'config_url' => '', 80 'title' => $this->getTitle(), 81 'content' => $content, 82 ]); 83 } 84 85 return $content; 86 } 87 88 /** 89 * Should this block load asynchronously using AJAX? 90 * 91 * Simple blocks are faster in-line, more comples ones 92 * can be loaded later. 93 * 94 * @return bool 95 */ 96 public function loadAjax(): bool 97 { 98 return false; 99 } 100 101 /** 102 * Can this block be shown on the user’s home page? 103 * 104 * @return bool 105 */ 106 public function isUserBlock(): bool 107 { 108 return true; 109 } 110 111 /** 112 * Can this block be shown on the tree’s home page? 113 * 114 * @return bool 115 */ 116 public function isGedcomBlock(): bool 117 { 118 return false; 119 } 120 121 /** 122 * Update the configuration for a block. 123 * 124 * @param Request $request 125 * @param int $block_id 126 * 127 * @return void 128 */ 129 public function saveBlockConfiguration(Request $request, int $block_id) 130 { 131 } 132 133 /** 134 * An HTML form to edit block settings 135 * 136 * @param Tree $tree 137 * @param int $block_id 138 * 139 * @return void 140 */ 141 public function editBlockConfiguration(Tree $tree, int $block_id) 142 { 143 } 144 145 /** 146 * Get the favorites for a user 147 * 148 * @param Tree $tree 149 * @param User $user 150 * 151 * @return stdClass[] 152 */ 153 public function getFavorites(Tree $tree, User $user): array 154 { 155 $favorites = Database::prepare( 156 "SELECT favorite_id, user_id, gedcom_id, xref, favorite_type, title, note, url" . 157 " FROM `##favorite` WHERE gedcom_id = :tree_id AND user_id = :user_id" 158 )->execute([ 159 'tree_id' => $tree->id(), 160 'user_id' => $user->getUserId(), 161 ])->fetchAll(); 162 163 foreach ($favorites as $favorite) { 164 if ($favorite->xref !== null) { 165 $favorite->record = GedcomRecord::getInstance($favorite->xref, $tree); 166 } else { 167 $favorite->record = null; 168 } 169 } 170 171 return $favorites; 172 } 173 174 /** 175 * @param Request $request 176 * @param Tree $tree 177 * @param User $user 178 * 179 * @return RedirectResponse 180 */ 181 public function postAddFavoriteAction(Request $request, Tree $tree, User $user): RedirectResponse 182 { 183 $note = $request->get('note', ''); 184 $title = $request->get('title', ''); 185 $url = $request->get('url', ''); 186 $xref = $request->get('xref', ''); 187 188 $record = GedcomRecord::getInstance($xref, $tree); 189 190 if (Auth::check()) { 191 if ($url !== '') { 192 $this->addUrlFavorite($tree, $user, $url, $title ?: $url, $note); 193 } else { 194 $this->addRecordFavorite($tree, $user, $record, $note); 195 } 196 } 197 198 $url = route('user-page', ['ged' => $tree->name()]); 199 200 return new RedirectResponse($url); 201 } 202 203 /** 204 * @param Request $request 205 * @param Tree $tree 206 * @param User $user 207 * 208 * @return RedirectResponse 209 */ 210 public function postDeleteFavoriteAction(Request $request, Tree $tree, User $user): RedirectResponse 211 { 212 $favorite_id = (int) $request->get('favorite_id'); 213 214 if (Auth::check()) { 215 Database::prepare( 216 "DELETE FROM `##favorite` WHERE favorite_id = :favorite_id AND user_id = :user_id" 217 )->execute([ 218 'favorite_id' => $favorite_id, 219 'user_id' => $user->getUserId(), 220 ]); 221 } 222 223 $url = route('user-page', ['ged' => $tree->name()]); 224 225 return new RedirectResponse($url); 226 } 227 228 /** 229 * @param Tree $tree 230 * @param User $user 231 * @param string $url 232 * @param string $title 233 * @param string $note 234 * 235 * @return void 236 */ 237 private function addUrlFavorite(Tree $tree, User $user, string $url, string $title, string $note) 238 { 239 $favorite = Database::prepare( 240 "SELECT * FROM `##favorite` WHERE gedcom_id = :gedcom_id AND user_id = :user_id AND url = :url" 241 )->execute([ 242 'gedcom_id' => $tree->id(), 243 'user_id' => $user->getUserId(), 244 'url' => $url, 245 ])->fetchOneRow(); 246 247 if ($favorite === null) { 248 Database::prepare( 249 "INSERT INTO `##favorite` (gedcom_id, favorite_type, user_id, url, note, title) VALUES (:gedcom_id, 'URL', :user_id, :url, :note, :title)" 250 )->execute([ 251 'gedcom_id' => $tree->id(), 252 'user_id' => $user->getUserId(), 253 'url' => $url, 254 'note' => $note, 255 'title' => $title, 256 ]); 257 } else { 258 Database::prepare( 259 "UPDATE `##favorite` SET note = :note, title = :title WHERE favorite_id = :favorite_id" 260 )->execute([ 261 'note' => $note, 262 'title' => $title, 263 'favorite_id' => $favorite->favorite_id, 264 ]); 265 } 266 } 267 268 /** 269 * @param Tree $tree 270 * @param User $user 271 * @param GedcomRecord $record 272 * @param string $note 273 * 274 * @return void 275 */ 276 private function addRecordFavorite(Tree $tree, User $user, GedcomRecord $record, string $note) 277 { 278 $favorite = Database::prepare( 279 "SELECT * FROM `##favorite` WHERE gedcom_id = :gedcom_id AND user_id = :user_id AND xref = :xref" 280 )->execute([ 281 'gedcom_id' => $tree->id(), 282 'user_id' => $user->getUserId(), 283 'xref' => $record->xref(), 284 ])->fetchOneRow(); 285 286 if ($favorite === null) { 287 Database::prepare( 288 "INSERT INTO `##favorite` (gedcom_id, user_id, favorite_type, xref, note) VALUES (:gedcom_id, :user_id, :favorite_type, :xref, :note)" 289 )->execute([ 290 'gedcom_id' => $tree->id(), 291 'user_id' => $user->getUserId(), 292 'favorite_type' => $record::RECORD_TYPE, 293 'xref' => $record->xref(), 294 'note' => $note, 295 ]); 296 } else { 297 Database::prepare( 298 "UPDATE `##favorite` SET note = :note WHERE favorite_id = :favorite_id" 299 )->execute([ 300 'note' => $note, 301 'favorite_id' => $favorite->favorite_id, 302 ]); 303 } 304 } 305} 306