xref: /webtrees/app/Module/RecentChangesModule.php (revision b295534922aa0d15bf8b3821f74784a5ff810d62) 
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\Filter;
21use Fisharebest\Webtrees\GedcomRecord;
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Individual;
24use Fisharebest\Webtrees\Tree;
25
26/**
27 * Class RecentChangesModule
28 */
29class RecentChangesModule extends AbstractModule implements ModuleBlockInterface {
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		return /* I18N: Name of a module */ I18N::translate('Recent changes');
41	}
42
43	/** {@inheritdoc} */
44	public function getDescription() {
45		return /* I18N: Description of the “Recent changes” module */ I18N::translate('A list of records that have been updated recently.');
46	}
47
48	/** {@inheritdoc} */
49	public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string {
50		global $ctype;
51
52		$days      = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
53		$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
54		$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
55		$show_user = (bool) $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
56
57		extract($cfg, EXTR_OVERWRITE);
58
59		$records = $this->getRecentChanges($tree, $days);
60
61		switch ($sortStyle) {
62			case 'name':
63				uasort($records, ['self', 'sortByNameAndChangeDate']);
64				break;
65			case 'date_asc':
66				uasort($records, ['self', 'sortByChangeDateAndName']);
67				$records = array_reverse($records);
68				break;
69			case 'date_desc':
70				uasort($records, ['self', 'sortByChangeDateAndName']);
71		}
72
73		if (empty($records)) {
74			$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));
75		} elseif ($infoStyle === 'list') {
76			$content = view('modules/recent_changes/changes-list', [
77				'records'   => $records,
78				'show_user' => $show_user,
79			]);
80		} else {
81			$content = view('modules/recent_changes/changes-table', [
82				'records'   => $records,
83				'show_user' => $show_user,
84			]);
85		}
86
87		if ($template) {
88			if ($ctype === 'gedcom' && Auth::isManager($tree)) {
89				$config_url = route('tree-page-block-edit', ['block_id' => $block_id, 'ged' => $tree->getName()]);
90			} elseif ($ctype === 'user' && Auth::check()) {
91				$config_url = route('user-page-block-edit', ['block_id' => $block_id, 'ged' => $tree->getName()]);
92			} else {
93				$config_url = '';
94			}
95
96			return view('modules/block-template', [
97				'block'      => str_replace('_', '-', $this->getName()),
98				'id'         => $block_id,
99				'config_url' => $config_url,
100				'title'      => I18N::plural('Changes in the last %s day', 'Changes in the last %s days', $days, I18N::number($days)),
101				'content'    => $content,
102			]);
103		} else {
104			return $content;
105		}
106	}
107
108	/** {@inheritdoc} */
109	public function loadAjax(): bool {
110		return true;
111	}
112
113	/** {@inheritdoc} */
114	public function isUserBlock(): bool {
115		return true;
116	}
117
118	/** {@inheritdoc} */
119	public function isGedcomBlock(): bool {
120		return true;
121	}
122
123	/** {@inheritdoc} */
124	public function configureBlock(Tree $tree, int $block_id) {
125		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
126			$this->setBlockSetting($block_id, 'days', Filter::postInteger('days', 1, self::MAX_DAYS));
127			$this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table'));
128			$this->setBlockSetting($block_id, 'sortStyle', Filter::post('sortStyle', 'name|date_asc|date_desc'));
129			$this->setBlockSetting($block_id, 'show_user', Filter::postBool('show_user'));
130
131			return;
132		}
133
134		$days      = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
135		$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
136		$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
137		$show_user = $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
138
139		$info_styles = [
140			'list'  => /* I18N: An option in a list-box */ I18N::translate('list'),
141			'table' => /* I18N: An option in a list-box */ I18N::translate('table'),
142		];
143
144		$sort_styles = [
145			'name'      => /* I18N: An option in a list-box */ I18N::translate('sort by name'),
146			'date_asc'  => /* I18N: An option in a list-box */ I18N::translate('sort by date, oldest first'),
147			'date_desc' => /* I18N: An option in a list-box */ I18N::translate('sort by date, newest first'),
148		];
149
150		echo view('modules/recent_changes/config', [
151			'days'        => $days,
152			'infoStyle'   => $infoStyle,
153			'info_styles' => $info_styles,
154			'max_days'    => self::MAX_DAYS,
155			'sortStyle'   => $sortStyle,
156			'sort_styles' => $sort_styles,
157			'show_user'   => $show_user,
158		]);
159	}
160
161	/**
162	 * Find records that have changed since a given julian day
163	 *
164	 * @param Tree $tree Changes for which tree
165	 * @param int  $days Number of days
166	 *
167	 * @return GedcomRecord[] List of records with changes
168	 */
169	private function getRecentChanges(Tree $tree, $days) {
170		$sql =
171			"SELECT xref FROM `##change`" .
172			" WHERE new_gedcom != '' AND change_time > DATE_SUB(NOW(), INTERVAL :days DAY) AND gedcom_id = :tree_id" .
173			" GROUP BY xref" .
174			" ORDER BY MAX(change_id) DESC";
175
176		$vars = [
177			'days'    => $days,
178			'tree_id' => $tree->getTreeId(),
179		];
180
181		$xrefs = Database::prepare($sql)->execute($vars)->fetchOneColumn();
182
183		$records = [];
184		foreach ($xrefs as $xref) {
185			$record = GedcomRecord::getInstance($xref, $tree);
186			if ($record && $record->canShow()) {
187				$records[] = $record;
188			}
189		}
190
191		return $records;
192	}
193
194	/**
195	 * Sort the records by (1) last change date and (2) name
196	 *
197	 * @param GedcomRecord $a
198	 * @param GedcomRecord $b
199	 *
200	 * @return int
201	 */
202	private static function sortByChangeDateAndName(GedcomRecord $a, GedcomRecord $b) {
203		return $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true) ?: GedcomRecord::compare($a, $b);
204	}
205
206	/**
207	 * Sort the records by (1) name and (2) last change date
208	 *
209	 * @param GedcomRecord $a
210	 * @param GedcomRecord $b
211	 *
212	 * @return int
213	 */
214	private static function sortByNameAndChangeDate(GedcomRecord $a, GedcomRecord $b) {
215		return GedcomRecord::compare($a, $b) ?: $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true);
216	}
217}
218