. */ namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Database; use Fisharebest\Webtrees\Filter; use Fisharebest\Webtrees\Functions\FunctionsEdit; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\GedcomTag; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Individual; use Fisharebest\Webtrees\Theme; use Fisharebest\Webtrees\Tree; use Rhumsaa\Uuid\Uuid; /** * 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($block_id, $template = true, $cfg = []) { global $ctype, $WT_TREE; $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); $block = $this->getBlockSetting($block_id, 'block', self::DEFAULT_BLOCK); $hide_empty = $this->getBlockSetting($block_id, 'hide_empty', self::DEFAULT_HIDE_EMPTY); foreach (['days', 'infoStyle', 'sortStyle', 'hide_empty', 'show_user', 'block'] as $name) { if (array_key_exists($name, $cfg)) { $$name = $cfg[$name]; } } $records = $this->getRecentChanges($WT_TREE, WT_CLIENT_JD - $days); if (empty($records) && $hide_empty) { return ''; } // Print block header $id = $this->getName() . $block_id; $class = $this->getName() . '_block'; if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) { $title = ''; } else { $title = ''; } $title .= /* I18N: title for list of recent changes */ I18N::plural('Changes in the last %s day', 'Changes in the last %s days', $days, I18N::number($days)); $content = ''; // Print block content if (count($records) == 0) { $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)); } else { switch ($infoStyle) { case 'list': $content .= $this->changesList($records, $sortStyle, $show_user); break; case 'table': $content .= $this->changesTable($records, $sortStyle, $show_user); break; } } if ($template) { if ($block === '1') { $class .= ' small_inner_block'; } return Theme::theme()->formatBlock($id, $title, $class, $content); } else { return $content; } } /** {@inheritdoc} */ public function loadAjax() { return true; } /** {@inheritdoc} */ public function isUserBlock() { return true; } /** {@inheritdoc} */ public function isGedcomBlock() { return true; } /** {@inheritdoc} */ public function configureBlock($block_id) { if (Filter::postBool('save') && Filter::checkCsrf()) { $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')); $this->setBlockSetting($block_id, 'hide_empty', Filter::postBool('hide_empty')); $this->setBlockSetting($block_id, 'block', Filter::postBool('block')); } $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); $block = $this->getBlockSetting($block_id, 'block', self::DEFAULT_BLOCK); $hide_empty = $this->getBlockSetting($block_id, 'hide_empty', self::DEFAULT_HIDE_EMPTY); echo ''; echo I18N::translate('Number of days to show'); echo ''; echo ''; echo ' ', I18N::plural('maximum %s day', 'maximum %s days', I18N::number(self::MAX_DAYS), I18N::number(self::MAX_DAYS)), ''; echo ''; echo ''; echo I18N::translate('Presentation style'); echo ''; echo FunctionsEdit::selectEditControl('infoStyle', ['list' => I18N::translate('list'), 'table' => I18N::translate('table')], null, $infoStyle, ''); echo ''; echo ''; echo I18N::translate('Sort order'); echo ''; echo FunctionsEdit::selectEditControl('sortStyle', [ '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'), ], null, $sortStyle, ''); echo ''; echo ''; echo /* I18N: label for a yes/no option */ I18N::translate('Show the user who made the change'); echo ''; echo FunctionsEdit::editFieldYesNo('show_user', $show_user); echo ''; echo ''; echo /* I18N: label for a yes/no option */ I18N::translate('Add a scrollbar when block contents grow'); echo ''; echo FunctionsEdit::editFieldYesNo('block', $block); echo ''; echo ''; echo I18N::translate('Should this block be hidden when it is empty'); echo ''; echo FunctionsEdit::editFieldYesNo('hide_empty', $hide_empty); echo ''; echo ''; echo '', I18N::translate('If you hide an empty block, you will not be able to change its configuration until it becomes visible by no longer being empty.'), ''; echo ''; } /** * Find records that have changed since a given julian day * * @param Tree $tree Changes for which tree * @param int $jd Julian day * * @return GedcomRecord[] List of records with changes */ private function getRecentChanges(Tree $tree, $jd) { $sql = "SELECT d_gid FROM `##dates`" . " WHERE d_fact='CHAN' AND d_julianday1 >= :jd AND d_file = :tree_id"; $vars = [ 'jd' => $jd, 'tree_id' => $tree->getTreeId(), ]; $xrefs = Database::prepare($sql)->execute($vars)->fetchOneColumn(); $records = []; foreach ($xrefs as $xref) { $record = GedcomRecord::getInstance($xref, $tree); if ($record->canShow()) { $records[] = $record; } } return $records; } /** * Format a table of events * * @param GedcomRecord[] $records * @param string $sort * @param bool $show_user * * @return string */ private function changesList(array $records, $sort, $show_user) { switch ($sort) { 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']); } $html = ''; foreach ($records as $record) { $html .= '' . $record->getFullName() . ''; $html .= '
'; if ($record instanceof Individual) { if ($record->getAddName()) { $html .= '' . $record->getAddName() . ''; } } // The timestamp may be missing or private. $timestamp = $record->lastChangeTimestamp(); if ($timestamp !== '') { if ($show_user) { $html .= /* I18N: [a record was] Changed on by */ I18N::translate('Changed on %1$s by %2$s', $timestamp, Filter::escapeHtml($record->lastChangeUser())); } else { $html .= /* I18N: [a record was] Changed on */ I18N::translate('Changed on %1$s', $timestamp); } } $html .= '
'; } return $html; } /** * Format a table of events * * @param GedcomRecord[] $records * @param string $sort * @param bool $show_user * * @return string */ private function changesTable($records, $sort, $show_user) { global $controller; $table_id = 'table-chan-' . Uuid::uuid4(); // lists requires a unique ID in case there are multiple lists per page switch ($sort) { case 'name': default: $aaSorting = "[1,'asc'], [2,'desc']"; break; case 'date_asc': $aaSorting = "[2,'asc'], [1,'asc']"; break; case 'date_desc': $aaSorting = "[2,'desc'], [1,'asc']"; break; } $html = ''; $controller ->addExternalJavascript(WT_JQUERY_DATATABLES_JS_URL) ->addInlineJavascript(' jQuery("#' . $table_id . '").dataTable({ dom: \'t\', paging: false, autoWidth:false, lengthChange: false, filter: false, ' . I18N::datatablesI18N() . ', jQueryUI: true, sorting: [' . $aaSorting . '], columns: [ { sortable: false, class: "center" }, null, null, { visible: ' . ($show_user ? 'true' : 'false') . ' } ] }); '); $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; foreach ($records as $record) { $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; } $html .= '
' . I18N::translate('Record') . '' . GedcomTag::getLabel('CHAN') . '' . GedcomTag::getLabel('_WT_USER') . '
'; switch ($record::RECORD_TYPE) { case 'INDI': $html .= $record->getSexImage('small'); break; case 'FAM': $html .= ''; break; case 'OBJE': $html .= ''; break; case 'NOTE': $html .= ''; break; case 'SOUR': $html .= ''; break; case 'REPO': $html .= ''; break; } $html .= ''; $html .= '' . $record->getFullName() . ''; $addname = $record->getAddName(); if ($addname) { $html .= ''; } $html .= '' . $record->lastChangeTimestamp() . '' . Filter::escapeHtml($record->lastChangeUser()) . '
'; return $html; } /** * 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); } }