1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Tree;
/**
* Class RecentChangesModule
*/
class RecentChangesModule extends AbstractModule implements ModuleBlockInterface {
const DEFAULT_BLOCK = '1';
const DEFAULT_DAYS = 7;
const DEFAULT_HIDE_EMPTY = '0';
const DEFAULT_SHOW_USER = '1';
const DEFAULT_SORT_STYLE = 'date_desc';
const DEFAULT_INFO_STYLE = 'table';
const MAX_DAYS = 90;
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('Recent changes');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “Recent changes” module */ I18N::translate('A list of records that have been updated recently.');
}
/** {@inheritdoc} */
public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string {
global $ctype;
$days = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
$show_user = (bool) $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
extract($cfg, EXTR_OVERWRITE);
$records = $this->getRecentChanges($tree, $days);
switch ($sortStyle) {
case 'name':
uasort($records, ['self', 'sortByNameAndChangeDate']);
break;
case 'date_asc':
uasort($records, ['self', 'sortByChangeDateAndName']);
$records = array_reverse($records);
break;
case 'date_desc':
uasort($records, ['self', 'sortByChangeDateAndName']);
}
if (empty($records)) {
$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));
} elseif ($infoStyle === 'list') {
$content = view('modules/recent_changes/changes-list', [
'records' => $records,
'show_user' => $show_user,
]);
} else {
$content = view('modules/recent_changes/changes-table', [
'records' => $records,
'show_user' => $show_user,
]);
}
if ($template) {
if ($ctype === 'gedcom' && Auth::isManager($tree)) {
$config_url = route('tree-page-block-edit', ['block_id' => $block_id, 'ged' => $tree->getName()]);
} elseif ($ctype === 'user' && Auth::check()) {
$config_url = route('user-page-block-edit', ['block_id' => $block_id, 'ged' => $tree->getName()]);
} else {
$config_url = '';
}
return view('modules/block-template', [
'block' => str_replace('_', '-', $this->getName()),
'id' => $block_id,
'config_url' => $config_url,
'title' => I18N::plural('Changes in the last %s day', 'Changes in the last %s days', $days, I18N::number($days)),
'content' => $content,
]);
} else {
return $content;
}
}
/** {@inheritdoc} */
public function loadAjax(): bool {
return true;
}
/** {@inheritdoc} */
public function isUserBlock(): bool {
return true;
}
/** {@inheritdoc} */
public function isGedcomBlock(): bool {
return true;
}
/** {@inheritdoc} */
public function configureBlock(Tree $tree, int $block_id) {
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$this->setBlockSetting($block_id, 'days', Filter::postInteger('days', 1, self::MAX_DAYS));
$this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table'));
$this->setBlockSetting($block_id, 'sortStyle', Filter::post('sortStyle', 'name|date_asc|date_desc'));
$this->setBlockSetting($block_id, 'show_user', Filter::postBool('show_user'));
return;
}
$days = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
$show_user = $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
$info_styles = [
'list' => /* I18N: An option in a list-box */ I18N::translate('list'),
'table' => /* I18N: An option in a list-box */ I18N::translate('table'),
];
$sort_styles = [
'name' => /* I18N: An option in a list-box */ I18N::translate('sort by name'),
'date_asc' => /* I18N: An option in a list-box */ I18N::translate('sort by date, oldest first'),
'date_desc' => /* I18N: An option in a list-box */ I18N::translate('sort by date, newest first'),
];
echo view('modules/recent_changes/config', [
'days' => $days,
'infoStyle' => $infoStyle,
'info_styles' => $info_styles,
'max_days' => self::MAX_DAYS,
'sortStyle' => $sortStyle,
'sort_styles' => $sort_styles,
'show_user' => $show_user,
]);
}
/**
* Find records that have changed since a given julian day
*
* @param Tree $tree Changes for which tree
* @param int $days Number of days
*
* @return GedcomRecord[] List of records with changes
*/
private function getRecentChanges(Tree $tree, $days) {
$sql =
"SELECT xref FROM `##change`" .
" WHERE new_gedcom != '' AND change_time > DATE_SUB(NOW(), INTERVAL :days DAY) AND gedcom_id = :tree_id" .
" GROUP BY xref" .
" ORDER BY MAX(change_id) DESC";
$vars = [
'days' => $days,
'tree_id' => $tree->getTreeId(),
];
$xrefs = Database::prepare($sql)->execute($vars)->fetchOneColumn();
$records = [];
foreach ($xrefs as $xref) {
$record = GedcomRecord::getInstance($xref, $tree);
if ($record && $record->canShow()) {
$records[] = $record;
}
}
return $records;
}
/**
* Sort the records by (1) last change date and (2) name
*
* @param GedcomRecord $a
* @param GedcomRecord $b
*
* @return int
*/
private static function sortByChangeDateAndName(GedcomRecord $a, GedcomRecord $b) {
return $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true) ?: GedcomRecord::compare($a, $b);
}
/**
* Sort the records by (1) name and (2) last change date
*
* @param GedcomRecord $a
* @param GedcomRecord $b
*
* @return int
*/
private static function sortByNameAndChangeDate(GedcomRecord $a, GedcomRecord $b) {
return GedcomRecord::compare($a, $b) ?: $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true);
}
}
|
