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 */ 16namespace Fisharebest\Webtrees\Module; 17 18use Fisharebest\Webtrees\Auth; 19use Fisharebest\Webtrees\Database; 20use Fisharebest\Webtrees\GedcomRecord; 21use Fisharebest\Webtrees\I18N; 22use Fisharebest\Webtrees\Tree; 23use Symfony\Component\HttpFoundation\Request; 24 25/** 26 * Class RecentChangesModule 27 */ 28class RecentChangesModule extends AbstractModule implements ModuleBlockInterface 29{ 30 const DEFAULT_BLOCK = '1'; 31 const DEFAULT_DAYS = 7; 32 const DEFAULT_HIDE_EMPTY = '0'; 33 const DEFAULT_SHOW_USER = '1'; 34 const DEFAULT_SORT_STYLE = 'date_desc'; 35 const DEFAULT_INFO_STYLE = 'table'; 36 const MAX_DAYS = 90; 37 38 /** {@inheritdoc} */ 39 public function getTitle() 40 { 41 /* I18N: Name of a module */ 42 return I18N::translate('Recent changes'); 43 } 44 45 /** {@inheritdoc} */ 46 public function getDescription() 47 { 48 /* I18N: Description of the “Recent changes” module */ 49 return I18N::translate('A list of records that have been updated recently.'); 50 } 51 52 /** {@inheritdoc} */ 53 public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string 54 { 55 global $ctype; 56 57 $days = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS); 58 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE); 59 $sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE); 60 $show_user = (bool)$this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER); 61 62 extract($cfg, EXTR_OVERWRITE); 63 64 $records = $this->getRecentChanges($tree, $days); 65 66 switch ($sortStyle) { 67 case 'name': 68 uasort($records, [ 69 'self', 70 'sortByNameAndChangeDate', 71 ]); 72 break; 73 case 'date_asc': 74 uasort($records, [ 75 'self', 76 'sortByChangeDateAndName', 77 ]); 78 $records = array_reverse($records); 79 break; 80 case 'date_desc': 81 uasort($records, [ 82 'self', 83 'sortByChangeDateAndName', 84 ]); 85 } 86 87 if (empty($records)) { 88 $content = I18N::plural('There have been no changes within the last %s day.', 'There have been no changes within the last %s days.', $days, I18N::number($days)); 89 } elseif ($infoStyle === 'list') { 90 $content = view('modules/recent_changes/changes-list', [ 91 'records' => $records, 92 'show_user' => $show_user, 93 ]); 94 } else { 95 $content = view('modules/recent_changes/changes-table', [ 96 'records' => $records, 97 'show_user' => $show_user, 98 ]); 99 } 100 101 if ($template) { 102 if ($ctype === 'gedcom' && Auth::isManager($tree)) { 103 $config_url = route('tree-page-block-edit', [ 104 'block_id' => $block_id, 105 'ged' => $tree->getName(), 106 ]); 107 } elseif ($ctype === 'user' && Auth::check()) { 108 $config_url = route('user-page-block-edit', [ 109 'block_id' => $block_id, 110 'ged' => $tree->getName(), 111 ]); 112 } else { 113 $config_url = ''; 114 } 115 116 return view('modules/block-template', [ 117 'block' => str_replace('_', '-', $this->getName()), 118 'id' => $block_id, 119 'config_url' => $config_url, 120 'title' => I18N::plural('Changes in the last %s day', 'Changes in the last %s days', $days, I18N::number($days)), 121 'content' => $content, 122 ]); 123 } else { 124 return $content; 125 } 126 } 127 128 /** {@inheritdoc} */ 129 public function loadAjax(): bool 130 { 131 return true; 132 } 133 134 /** {@inheritdoc} */ 135 public function isUserBlock(): bool 136 { 137 return true; 138 } 139 140 /** {@inheritdoc} */ 141 public function isGedcomBlock(): bool 142 { 143 return true; 144 } 145 146 /** 147 * Update the configuration for a block. 148 * 149 * @param Request $request 150 * @param int $block_id 151 * 152 * @return void 153 */ 154 public function saveBlockConfiguration(Request $request, int $block_id) 155 { 156 $this->setBlockSetting($block_id, 'days', $request->get('days', self::DEFAULT_DAYS)); 157 $this->setBlockSetting($block_id, 'infoStyle', $request->get('infoStyle', self::DEFAULT_INFO_STYLE)); 158 $this->setBlockSetting($block_id, 'sortStyle', $request->get('sortStyle', self::DEFAULT_SORT_STYLE)); 159 $this->setBlockSetting($block_id, 'show_user', $request->get('show_user', self::DEFAULT_SHOW_USER)); 160 } 161 162 /** 163 * An HTML form to edit block settings 164 * 165 * @param Tree $tree 166 * @param int $block_id 167 * 168 * @return void 169 */ 170 public function editBlockConfiguration(Tree $tree, int $block_id) 171 { 172 $days = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS); 173 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE); 174 $sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE); 175 $show_user = $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER); 176 177 $info_styles = [ 178 /* I18N: An option in a list-box */ 179 'list' => I18N::translate('list'), 180 /* I18N: An option in a list-box */ 181 'table' => I18N::translate('table'), 182 ]; 183 184 $sort_styles = [ 185 /* I18N: An option in a list-box */ 186 'name' => I18N::translate('sort by name'), 187 /* I18N: An option in a list-box */ 188 'date_asc' => I18N::translate('sort by date, oldest first'), 189 /* I18N: An option in a list-box */ 190 'date_desc' => I18N::translate('sort by date, newest first'), 191 ]; 192 193 echo view('modules/recent_changes/config', [ 194 'days' => $days, 195 'infoStyle' => $infoStyle, 196 'info_styles' => $info_styles, 197 'max_days' => self::MAX_DAYS, 198 'sortStyle' => $sortStyle, 199 'sort_styles' => $sort_styles, 200 'show_user' => $show_user, 201 ]); 202 } 203 204 /** 205 * Find records that have changed since a given julian day 206 * 207 * @param Tree $tree Changes for which tree 208 * @param int $days Number of days 209 * 210 * @return GedcomRecord[] List of records with changes 211 */ 212 private function getRecentChanges(Tree $tree, $days) 213 { 214 $sql = 215 "SELECT xref FROM `##change`" . 216 " WHERE new_gedcom != '' AND change_time > DATE_SUB(NOW(), INTERVAL :days DAY) AND gedcom_id = :tree_id" . 217 " GROUP BY xref" . 218 " ORDER BY MAX(change_id) DESC"; 219 220 $vars = [ 221 'days' => $days, 222 'tree_id' => $tree->getTreeId(), 223 ]; 224 225 $xrefs = Database::prepare($sql)->execute($vars)->fetchOneColumn(); 226 227 $records = []; 228 foreach ($xrefs as $xref) { 229 $record = GedcomRecord::getInstance($xref, $tree); 230 if ($record && $record->canShow()) { 231 $records[] = $record; 232 } 233 } 234 235 return $records; 236 } 237 238 /** 239 * Sort the records by (1) last change date and (2) name 240 * 241 * @param GedcomRecord $a 242 * @param GedcomRecord $b 243 * 244 * @return int 245 */ 246 private static function sortByChangeDateAndName(GedcomRecord $a, GedcomRecord $b) 247 { 248 return $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true) ?: GedcomRecord::compare($a, $b); 249 } 250 251 /** 252 * Sort the records by (1) name and (2) last change date 253 * 254 * @param GedcomRecord $a 255 * @param GedcomRecord $b 256 * 257 * @return int 258 */ 259 private static function sortByNameAndChangeDate(GedcomRecord $a, GedcomRecord $b) 260 { 261 return GedcomRecord::compare($a, $b) ?: $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true); 262 } 263} 264