xref: /webtrees/app/Module/UpcomingAnniversariesModule.php (revision 147e99aae08229316226c46b32d24d4f8bce04e0)

<?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\Filter;
use Fisharebest\Webtrees\Functions\FunctionsDb;
use Fisharebest\Webtrees\GedcomTag;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Tree;

/**
 * Class UpcomingAnniversariesModule
 */
class UpcomingAnniversariesModule extends AbstractModule implements ModuleBlockInterface {
	// Default values for new blocks.
	const DEFAULT_DAYS    = 7;
	const DEFAULT_FILTER  = '1';
	const DEFAULT_SORT    = 'alpha';
	const DEFAULT_STYLE   = 'table';

	// Can show this number of days into the future.
	const MIN_DAYS = 1;
	const MAX_DAYS = 30;

	// All standard GEDCOM 5.5.1 events except CENS, RESI and EVEN
	const ALL_EVENTS = [
		'ADOP',
		'ANUL',
		'BAPM',
		'BARM',
		'BASM',
		'BIRT',
		'BLES',
		'BURI',
		'CHR',
		'CHRA',
		'CONF',
		'CREM',
		'DEAT',
		'DIV',
		'DIVF',
		'EMIG',
		'ENGA',
		'FCOM',
		'GRAD',
		'IMMI',
		'MARB',
		'MARC',
		'MARL',
		'MARR',
		'MARS',
		'NATU',
		'ORDN',
		'PROB',
		'RETI',
		'WILL',
	];

	const DEFAULT_EVENTS = [
		'BIRT',
		'MARR',
		'DEAT',
	];

	/**
	 * How should this module be labelled on tabs, menus, etc.?
	 *
	 * @return string
	 */
	public function getTitle() {
		return /* I18N: Name of a module */ I18N::translate('Upcoming events');
	}

	/**
	 * A sentence describing what this module does.
	 *
	 * @return string
	 */
	public function getDescription() {
		return /* I18N: Description of the “Upcoming events” module */ I18N::translate('A list of the anniversaries that will occur in the near future.');
	}

	/**
	 * Generate the HTML content of this block.
	 *
	 * @param Tree     $tree
	 * @param int      $block_id
	 * @param bool     $template
	 * @param string[] $cfg
	 *
	 * @return string
	 */
	public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string {
		global $ctype;

		$default_events = implode(',', self::DEFAULT_EVENTS);

		$days      = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
		$filter    = (bool) $this->getBlockSetting($block_id, 'filter', self::DEFAULT_FILTER);
		$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_STYLE);
		$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT);
		$events    = $this->getBlockSetting($block_id, 'events', $default_events);

		extract($cfg, EXTR_OVERWRITE);

		$event_array = explode(',', $events);

		// If we are only showing living individuals, then we don't need to search for DEAT events.
		if ($filter) {
			$death_events = explode('|', WT_EVENTS_DEAT);
			$event_array = array_diff($event_array, $death_events);
		}

		$events_filter = implode('|', $event_array);

		$startjd = WT_CLIENT_JD + 1;
		$endjd   = WT_CLIENT_JD + (int) $days;

		$facts = FunctionsDb::getEventsList($startjd, $endjd, $events_filter, $filter, $sortStyle, $tree);

		if (empty($facts)) {
			if ($endjd == $startjd) {
				$content = view('modules/upcoming_events/empty', [
					'message' => I18N::translate('No events exist for tomorrow.')
				]);
			} else {
				$content = view('modules/upcoming_events/empty', [
					'message' => /* I18N: translation for %s==1 is unused; it is translated separately as “tomorrow” */ I18N::plural('No events exist for the next %s day.', 'No events exist for the next %s days.', $endjd - $startjd + 1, I18N::number($endjd - $startjd + 1))
				]);
			}
		} elseif ($infoStyle === 'list') {
			$content = view('modules/upcoming_events/list', [
				'facts'   => $facts,
			]);
		} else {
			$content = view('modules/upcoming_events/table', [
				'facts'   => $facts,
			]);
		}

		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'      => $this->getTitle(),
				'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;
	}

	/**
	 * An HTML form to edit block settings
	 *
	 * @param Tree $tree
	 * @param int  $block_id
	 *
	 * @return void
	 */
	public function configureBlock(Tree $tree, int $block_id) {
		if ($_SERVER['REQUEST_METHOD'] === 'POST') {
			$this->setBlockSetting($block_id, 'days', Filter::postInteger('days', self::MIN_DAYS, self::MAX_DAYS, self::DEFAULT_DAYS));
			$this->setBlockSetting($block_id, 'filter', Filter::postBool('filter'));
			$this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table', self::DEFAULT_STYLE));
			$this->setBlockSetting($block_id, 'sortStyle', Filter::post('sortStyle', 'alpha|anniv', self::DEFAULT_SORT));
			$this->setBlockSetting($block_id, 'events', implode(',', Filter::postArray('events')));

			return;
		}

		$default_events = implode(',', self::DEFAULT_EVENTS);

		$days      = $this->getBlockSetting($block_id, 'days', self::DEFAULT_DAYS);
		$filter    = $this->getBlockSetting($block_id, 'filter', self::DEFAULT_FILTER);
		$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_STYLE);
		$sortStyle = $this->getBlockSetting($block_id, 'sortStyle', self::DEFAULT_SORT);
		$events    = $this->getBlockSetting($block_id, 'events', $default_events);

		$event_array = explode(',', $events);

		$all_events = [];
		foreach (self::ALL_EVENTS as $event) {
			$all_events[$event] = GedcomTag::getLabel($event);
		}

		$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 = [
			'alpha' => /* I18N: An option in a list-box */ I18N::translate('sort by name'),
			'anniv' => /* I18N: An option in a list-box */ I18N::translate('sort by date'),
		];

		echo view('modules/upcoming_events/config', [
			'all_events'  => $all_events,
			'days'        => $days,
			'event_array' => $event_array,
			'filter'      => $filter,
			'infoStyle'   => $infoStyle,
			'info_styles' => $info_styles,
			'max_days'    => self::MAX_DAYS,
			'sortStyle'   => $sortStyle,
			'sort_styles' => $sort_styles,
		]);
	}
}