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 FamilyTreeFavoritesModule 32 */ 33class FamilyTreeFavoritesModule 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 family tree’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/gedcom_favorites/favorites', [ 70 'block_id' => $block_id, 71 'favorites' => $this->getFavorites($tree), 72 'is_manager' => Auth::isManager($tree), 73 'tree' => $tree, 74 ]); 75 76 if ($template) { 77 return view('modules/block-template', [ 78 'block' => str_replace('_', '-', $this->getName()), 79 'id' => $block_id, 80 'config_url' => '', 81 'title' => $this->getTitle(), 82 'content' => $content, 83 ]); 84 } 85 86 return $content; 87 } 88 89 /** 90 * Should this block load asynchronously using AJAX? 91 * 92 * Simple blocks are faster in-line, more comples ones 93 * can be loaded later. 94 * 95 * @return bool 96 */ 97 public function loadAjax(): bool 98 { 99 return false; 100 } 101 102 /** 103 * Can this block be shown on the user’s home page? 104 * 105 * @return bool 106 */ 107 public function isUserBlock(): bool 108 { 109 return false; 110 } 111 112 /** 113 * Can this block be shown on the tree’s home page? 114 * 115 * @return bool 116 */ 117 public function isGedcomBlock(): bool 118 { 119 return true; 120 } 121 122 /** 123 * Update the configuration for a block. 124 * 125 * @param Request $request 126 * @param int $block_id 127 * 128 * @return void 129 */ 130 public function saveBlockConfiguration(Request $request, int $block_id) 131 { 132 } 133 134 /** 135 * An HTML form to edit block settings 136 * 137 * @param Tree $tree 138 * @param int $block_id 139 * 140 * @return void 141 */ 142 public function editBlockConfiguration(Tree $tree, int $block_id) 143 { 144 } 145 146 /** 147 * Get favorites for a family tree 148 * 149 * @param Tree $tree 150 * 151 * @return stdClass[] 152 */ 153 public function getFavorites(Tree $tree): 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 IS NULL" 158 )->execute([ 159 'tree_id' => $tree->id(), 160 ])->fetchAll(); 161 162 foreach ($favorites as $favorite) { 163 if ($favorite->xref !== null) { 164 $favorite->record = GedcomRecord::getInstance($favorite->xref, $tree); 165 } else { 166 $favorite->record = null; 167 } 168 } 169 170 return $favorites; 171 } 172 173 /** 174 * @param Request $request 175 * @param Tree $tree 176 * @param User $user 177 * 178 * @return RedirectResponse 179 */ 180 public function postAddFavoriteAction(Request $request, Tree $tree, User $user): RedirectResponse 181 { 182 $note = $request->get('note', ''); 183 $title = $request->get('title', ''); 184 $url = $request->get('url', ''); 185 $xref = $request->get('xref', ''); 186 187 $record = GedcomRecord::getInstance($xref, $tree); 188 189 if (Auth::isManager($tree, $user)) { 190 if ($url !== '') { 191 $this->addUrlFavorite($tree, $url, $title ?: $url, $note); 192 } else { 193 $this->addRecordFavorite($tree, $record, $note); 194 } 195 } 196 197 $url = route('tree-page', ['ged' => $tree->name()]); 198 199 return new RedirectResponse($url); 200 } 201 202 /** 203 * @param Request $request 204 * @param Tree $tree 205 * @param User $user 206 * 207 * @return RedirectResponse 208 */ 209 public function postDeleteFavoriteAction(Request $request, Tree $tree, User $user): RedirectResponse 210 { 211 $favorite_id = (int) $request->get('favorite_id'); 212 213 if (Auth::isManager($tree, $user)) { 214 Database::prepare( 215 "DELETE FROM `##favorite` WHERE favorite_id = :favorite_id AND gedcom_id = :tree_id" 216 )->execute([ 217 'favorite_id' => $favorite_id, 218 'tree_id' => $tree->id(), 219 ]); 220 } 221 222 $url = route('tree-page', ['ged' => $tree->name()]); 223 224 return new RedirectResponse($url); 225 } 226 227 /** 228 * @param Tree $tree 229 * @param string $url 230 * @param string $title 231 * @param string $note 232 * 233 * @return void 234 */ 235 private function addUrlFavorite(Tree $tree, string $url, string $title, string $note) 236 { 237 $favorite = Database::prepare( 238 "SELECT * FROM `##favorite` WHERE gedcom_id = :gedcom_id AND user_id IS NULL AND url = :url" 239 )->execute([ 240 'gedcom_id' => $tree->id(), 241 'url' => $url, 242 ])->fetchOneRow(); 243 244 if ($favorite === null) { 245 Database::prepare( 246 "INSERT INTO `##favorite` (gedcom_id, favorite_type, url, note, title) VALUES (:gedcom_id, 'URL', :url, :note, :title)" 247 )->execute([ 248 'gedcom_id' => $tree->id(), 249 'url' => $url, 250 'note' => $note, 251 'title' => $title, 252 ]); 253 } else { 254 Database::prepare( 255 "UPDATE `##favorite` SET note = :note, title = :title WHERE favorite_id = :favorite_id" 256 )->execute([ 257 'note' => $note, 258 'title' => $title, 259 'favorite_id' => $favorite->favorite_id, 260 ]); 261 } 262 } 263 264 /** 265 * @param Tree $tree 266 * @param GedcomRecord $record 267 * @param string $note 268 * 269 * @return void 270 */ 271 private function addRecordFavorite(Tree $tree, GedcomRecord $record, string $note) 272 { 273 $favorite = Database::prepare( 274 "SELECT * FROM `##favorite` WHERE gedcom_id = :gedcom_id AND user_id IS NULL AND xref = :xref" 275 )->execute([ 276 'gedcom_id' => $tree->id(), 277 'xref' => $record->xref(), 278 ])->fetchOneRow(); 279 280 if ($favorite === null) { 281 Database::prepare( 282 "INSERT INTO `##favorite` (gedcom_id, favorite_type, xref, note) VALUES (:gedcom_id, :favorite_type, :xref, :note)" 283 )->execute([ 284 'gedcom_id' => $tree->id(), 285 'favorite_type' => $record::RECORD_TYPE, 286 'xref' => $record->xref(), 287 'note' => $note, 288 ]); 289 } else { 290 Database::prepare( 291 "UPDATE `##favorite` SET note = :note WHERE favorite_id = :favorite_id" 292 )->execute([ 293 'note' => $note, 294 'favorite_id' => $favorite->favorite_id, 295 ]); 296 } 297 } 298} 299