xref: /webtrees/app/Module/RecentChangesModule.php (revision 20ac4041ff6d2c96733f4df91b821d1c039e0259) 
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\Tree;
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     * An HTML form to edit block settings
148     *
149     * @param Tree $tree
150     * @param int  $block_id
151     *
152     * @return void
153     */
154   public function configureBlock(Tree $tree, int $block_id)
155    {
156        if ($_SERVER['REQUEST_METHOD'] === 'POST') {
157            $this->setBlockSetting($block_id, 'days', Filter::postInteger('days', 1, self::MAX_DAYS));
158            $this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table'));
159            $this->setBlockSetting($block_id, 'sortStyle', Filter::post('sortStyle', 'name|date_asc|date_desc'));
160            $this->setBlockSetting($block_id, 'show_user', Filter::postBool('show_user'));
161
162            return;
163        }
164
165        $days      = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
166        $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_INFO_STYLE);
167        $sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT_STYLE);
168        $show_user = $this->getBlockSetting($block_id, 'show_user', self::DEFAULT_SHOW_USER);
169
170        $info_styles = [
171            /* I18N: An option in a list-box */
172            'list'  => I18N::translate('list'),
173            /* I18N: An option in a list-box */
174            'table' => I18N::translate('table'),
175        ];
176
177        $sort_styles = [
178            /* I18N: An option in a list-box */
179            'name'      => I18N::translate('sort by name'),
180            /* I18N: An option in a list-box */
181            'date_asc'  => I18N::translate('sort by date, oldest first'),
182            /* I18N: An option in a list-box */
183            'date_desc' => I18N::translate('sort by date, newest first'),
184        ];
185
186        echo view('modules/recent_changes/config', [
187            'days'        => $days,
188            'infoStyle'   => $infoStyle,
189            'info_styles' => $info_styles,
190            'max_days'    => self::MAX_DAYS,
191            'sortStyle'   => $sortStyle,
192            'sort_styles' => $sort_styles,
193            'show_user'   => $show_user,
194        ]);
195    }
196
197    /**
198     * Find records that have changed since a given julian day
199     *
200     * @param Tree $tree Changes for which tree
201     * @param int  $days Number of days
202     *
203     * @return GedcomRecord[] List of records with changes
204     */
205    private function getRecentChanges(Tree $tree, $days)
206    {
207        $sql =
208            "SELECT xref FROM `##change`" .
209            " WHERE new_gedcom != '' AND change_time > DATE_SUB(NOW(), INTERVAL :days DAY) AND gedcom_id = :tree_id" .
210            " GROUP BY xref" .
211            " ORDER BY MAX(change_id) DESC";
212
213        $vars = [
214            'days'    => $days,
215            'tree_id' => $tree->getTreeId(),
216        ];
217
218        $xrefs = Database::prepare($sql)->execute($vars)->fetchOneColumn();
219
220        $records = [];
221        foreach ($xrefs as $xref) {
222            $record = GedcomRecord::getInstance($xref, $tree);
223            if ($record && $record->canShow()) {
224                $records[] = $record;
225            }
226        }
227
228        return $records;
229    }
230
231    /**
232     * Sort the records by (1) last change date and (2) name
233     *
234     * @param GedcomRecord $a
235     * @param GedcomRecord $b
236     *
237     * @return int
238     */
239    private static function sortByChangeDateAndName(GedcomRecord $a, GedcomRecord $b)
240    {
241        return $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true) ?: GedcomRecord::compare($a, $b);
242    }
243
244    /**
245     * Sort the records by (1) name and (2) last change date
246     *
247     * @param GedcomRecord $a
248     * @param GedcomRecord $b
249     *
250     * @return int
251     */
252    private static function sortByNameAndChangeDate(GedcomRecord $a, GedcomRecord $b)
253    {
254        return GedcomRecord::compare($a, $b) ?: $b->lastChangeTimestamp(true) - $a->lastChangeTimestamp(true);
255    }
256}
257