xref: /webtrees/app/Module/ReviewChangesModule.php (revision 8857be8be4ae0e4a5b302164a217fc463c26b735) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2017 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\Bootstrap4;
20use Fisharebest\Webtrees\Database;
21use Fisharebest\Webtrees\Filter;
22use Fisharebest\Webtrees\FontAwesome;
23use Fisharebest\Webtrees\Functions\FunctionsDate;
24use Fisharebest\Webtrees\Functions\FunctionsEdit;
25use Fisharebest\Webtrees\GedcomRecord;
26use Fisharebest\Webtrees\I18N;
27use Fisharebest\Webtrees\Mail;
28use Fisharebest\Webtrees\Site;
29use Fisharebest\Webtrees\Theme;
30use Fisharebest\Webtrees\Tree;
31use Fisharebest\Webtrees\User;
32use Fisharebest\Webtrees\View;
33
34/**
35 * Class ReviewChangesModule
36 */
37class ReviewChangesModule extends AbstractModule implements ModuleBlockInterface {
38	/** {@inheritdoc} */
39	public function getTitle() {
40		return /* I18N: Name of a module */ I18N::translate('Pending changes');
41	}
42
43	/** {@inheritdoc} */
44	public function getDescription() {
45		return /* I18N: Description of the “Pending changes” module */ I18N::translate('A list of changes that need to be reviewed by a moderator, and email notifications.');
46	}
47
48	/**
49	 * Generate the HTML content of this block.
50	 *
51	 * @param int      $block_id
52	 * @param bool     $template
53	 * @param string[] $cfg
54	 *
55	 * @return string
56	 */
57	public function getBlock($block_id, $template = true, $cfg = []) {
58		global $ctype, $WT_TREE;
59
60		$sendmail = $this->getBlockSetting($block_id, 'sendmail', '1');
61		$days     = $this->getBlockSetting($block_id, 'days', '1');
62
63		foreach (['days', 'sendmail'] as $name) {
64			if (array_key_exists($name, $cfg)) {
65				$$name = $cfg[$name];
66			}
67		}
68
69		$changes = Database::prepare(
70			"SELECT 1" .
71			" FROM `##change`" .
72			" WHERE status='pending'" .
73			" LIMIT 1"
74		)->fetchOne();
75
76		if ($changes === '1' && $sendmail === '1') {
77			// There are pending changes - tell moderators/managers/administrators about them.
78			if (WT_TIMESTAMP - (int) Site::getPreference('LAST_CHANGE_EMAIL') > (60 * 60 * 24 * $days)) {
79				// Which users have pending changes?
80				foreach (User::all() as $user) {
81					if ($user->getPreference('contactmethod') !== 'none') {
82						foreach (Tree::getAll() as $tree) {
83							if ($tree->hasPendingEdit() && Auth::isManager($tree, $user)) {
84								I18N::init($user->getPreference('language'));
85
86								$sender = new User(
87									(object) [
88										'user_id'   => null,
89										'user_name' => '',
90										'real_name' => $WT_TREE->getTitle(),
91										'email'     => $WT_TREE->getPreference('WEBTREES_EMAIL'),
92									]
93								);
94
95								Mail::send(
96									$sender,
97									$user,
98									$sender,
99									I18N::translate('Pending changes'),
100									View::make('emails/pending-changes-text', ['tree' => $tree, 'user' => $user]),
101									View::make('emails/pending-changes-html', ['tree' => $tree, 'user' => $user])
102								);
103								I18N::init(WT_LOCALE);
104							}
105						}
106					}
107				}
108				Site::setPreference('LAST_CHANGE_EMAIL', WT_TIMESTAMP);
109			}
110		}
111		if (Auth::isEditor($WT_TREE) && $WT_TREE->hasPendingEdit()) {
112			$id    = $this->getName() . $block_id;
113			$class = $this->getName() . '_block';
114			if ($ctype === 'user' || Auth::isManager($WT_TREE)) {
115				$title = FontAwesome::linkIcon('preferences', I18N::translate('Preferences'), ['class' => 'btn btn-link', 'href' => 'block_edit.php?block_id=' . $block_id . '&ged=' . $WT_TREE->getNameHtml() . '&ctype=' . $ctype]) . ' ';
116			} else {
117				$title = '';
118			}
119			$title .= $this->getTitle();
120
121			$content = '';
122			if (Auth::isModerator($WT_TREE)) {
123				$content .= '<a href="edit_changes.php">' . I18N::translate('There are pending changes for you to moderate.') . '</a><br>';
124			}
125			if ($sendmail === '1') {
126				$content .= I18N::translate('Last email reminder was sent ') . FunctionsDate::formatTimestamp(Site::getPreference('LAST_CHANGE_EMAIL')) . '<br>';
127				$content .= I18N::translate('Next email reminder will be sent after ') . FunctionsDate::formatTimestamp(Site::getPreference('LAST_CHANGE_EMAIL') + (60 * 60 * 24 * $days)) . '<br><br>';
128			}
129			$content .= '<ul>';
130			$changes = Database::prepare(
131				"SELECT xref" .
132				" FROM  `##change`" .
133				" WHERE status='pending'" .
134				" AND   gedcom_id=?" .
135				" GROUP BY xref"
136			)->execute([$WT_TREE->getTreeId()])->fetchAll();
137			foreach ($changes as $change) {
138				$record = GedcomRecord::getInstance($change->xref, $WT_TREE);
139				if ($record->canShow()) {
140					$content .= '<li><a href="' . $record->getHtmlUrl() . '">' . $record->getFullName() . '</a></li>';
141				}
142			}
143			$content .= '</ul>';
144
145			if ($template) {
146				return Theme::theme()->formatBlock($id, $title, $class, $content);
147			} else {
148				return $content;
149			}
150		}
151
152		return '';
153	}
154
155	/** {@inheritdoc} */
156	public function loadAjax() {
157		return false;
158	}
159
160	/** {@inheritdoc} */
161	public function isUserBlock() {
162		return true;
163	}
164
165	/** {@inheritdoc} */
166	public function isGedcomBlock() {
167		return true;
168	}
169
170	/**
171	 * An HTML form to edit block settings
172	 *
173	 * @param int $block_id
174	 */
175	public function configureBlock($block_id) {
176		if (Filter::postBool('save') && Filter::checkCsrf()) {
177			$this->setBlockSetting($block_id, 'days', Filter::postInteger('num', 1, 180, 1));
178			$this->setBlockSetting($block_id, 'sendmail', Filter::postBool('sendmail'));
179		}
180
181		$sendmail = $this->getBlockSetting($block_id, 'sendmail', '1');
182		$days     = $this->getBlockSetting($block_id, 'days', '1');
183
184	?>
185	<p>
186		<?= I18N::translate('This block will show editors a list of records with pending changes that need to be reviewed by a moderator. It also generates daily emails to moderators whenever pending changes exist.') ?>
187	</p>
188
189	<fieldset class="form-group">
190		<div class="row">
191			<legend class="col-form-legend col-sm-3">
192				<?= /* I18N: Label for a configuration option */ I18N::translate('Send out reminder emails') ?>
193			</legend>
194			<div class="col-sm-9">
195				<?= Bootstrap4::radioButtons('sendmail', FunctionsEdit::optionsNoYes(), $sendmail, true) ?>
196			</div>
197		</div>
198	</fieldset>
199
200	<div class="form-group row">
201		<label class="col-sm-3 col-form-label" for="days">
202			<?= I18N::translate('Reminder email frequency (days)') ?>
203		</label>
204		<div class="col-sm-9">
205			<input class="form-control" type="text" name="days" id="days" value="<?= $days ?>">
206		</div>
207	</div>
208	<?php
209	}
210}
211