xref: /webtrees/app/Module/UserMessagesModule.php (revision 13abd6f3a37322f885d85df150e105d27ad81f8d) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2016 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\Functions\FunctionsDate;
22use Fisharebest\Webtrees\Functions\FunctionsEdit;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Theme;
25use Fisharebest\Webtrees\User;
26
27/**
28 * Class UserMessagesModule
29 */
30class UserMessagesModule extends AbstractModule implements ModuleBlockInterface {
31	/** {@inheritdoc} */
32	public function getTitle() {
33		return /* I18N: Name of a module */ I18N::translate('Messages');
34	}
35
36	/** {@inheritdoc} */
37	public function getDescription() {
38		return /* I18N: Description of the “Messages” module */ I18N::translate('Communicate directly with other users, using private messages.');
39	}
40
41	/**
42	 * This is a general purpose hook, allowing modules to respond to routes
43	 * of the form module.php?mod=FOO&mod_action=BAR
44	 *
45	 * @param string $mod_action
46	 */
47	public function modAction($mod_action) {
48		switch ($mod_action) {
49		case 'delete':
50			$stmt = Database::prepare("DELETE FROM `##message` WHERE user_id = :user_id AND message_id = :message_id");
51
52			foreach (Filter::postArray('message_id') as $id) {
53				$stmt->execute([
54					'message_id' => $id,
55					'user_id'    => Auth::id(),
56				]);
57			}
58		}
59
60		$ged   = Filter::post('ged');
61		$ctype = Filter::post('ctype', 'user|gedcom', 'user');
62
63		header('Location: ' . WT_BASE_URL . 'index.php?ged=' . Filter::escapeUrl($ged) . '&ctype=' . $ctype);
64	}
65
66	/**
67	 * Generate the HTML content of this block.
68	 *
69	 * @param int      $block_id
70	 * @param bool     $template
71	 * @param string[] $cfg
72	 *
73	 * @return string
74	 */
75	public function getBlock($block_id, $template = true, $cfg = []) {
76		global $ctype, $WT_TREE;
77
78		$block = $this->getBlockSetting($block_id, 'block', '1');
79		foreach (['block'] as $name) {
80			if (array_key_exists($name, $cfg)) {
81				$$name = $cfg[$name];
82			}
83		}
84		$messages = Database::prepare("SELECT message_id, sender, subject, body, UNIX_TIMESTAMP(created) AS created FROM `##message` WHERE user_id=? ORDER BY message_id DESC")
85			->execute([Auth::id()])
86			->fetchAll();
87
88		$count = count($messages);
89		$id    = $this->getName() . $block_id;
90		$class = $this->getName() . '_block';
91		$title = I18N::plural('%s message', '%s messages', $count, I18N::number($count));
92		$users = array_filter(User::all(), function (User $user) {
93			return $user->getUserId() !== Auth::id() && $user->getPreference('verified_by_admin') && $user->getPreference('contactmethod') !== 'none';
94		});
95
96		$content = '<form id="messageform" name="messageform" method="post" action="module.php?mod=user_messages&mod_action=delete" onsubmit="return confirm(\'' . I18N::translate('Are you sure you want to delete this message? It cannot be retrieved later.') . '\');">';
97		$content .= '<input type="hidden" name="ged" value="' . $ctype . '">';
98		$content .= '<input type="hidden" name="ctype" value="' . $WT_TREE->getNameHtml() . '">';
99		if ($users) {
100			$content .= '<label for="touser">' . I18N::translate('Send a message') . '</label>';
101			$content .= '<select id="touser" name="touser">';
102			$content .= '<option value="">' . I18N::translate('&lt;select&gt;') . '</option>';
103			foreach ($users as $user) {
104				$content .= sprintf('<option value="%1$s">%2$s - %1$s</option>', Filter::escapeHtml($user->getUserName()), Filter::escapeHtml($user->getRealName()));
105			}
106			$content .= '</select>';
107			$content .= '<input type="button" value="' . I18N::translate('Send') . '" onclick="return message(document.messageform.touser.options[document.messageform.touser.selectedIndex].value, \'messaging2\', \'\');"><br><br>';
108		}
109		if ($messages) {
110			$content .= '<table class="list_table"><tr>';
111			$content .= '<th class="list_label">' . I18N::translate('Delete') . '<br><a href="#" onclick="jQuery(\'#' . $this->getName() . $block_id . ' :checkbox\').prop(\'checked\', true); return false;">' . I18N::translate('All') . '</a></th>';
112			$content .= '<th class="list_label">' . I18N::translate('Subject') . '</th>';
113			$content .= '<th class="list_label">' . I18N::translate('Date sent') . '</th>';
114			$content .= '<th class="list_label">' . I18N::translate('Email address') . '</th>';
115			$content .= '</tr>';
116			foreach ($messages as $message) {
117				$content .= '<tr>';
118				$content .= '<td class="list_value_wrap"><input type="checkbox" name="message_id[]" value="' . $message->message_id . '" id="cb_message' . $message->message_id . '"></td>';
119				$content .= '<td class="list_value_wrap"><a href="#" onclick="return expand_layer(\'message' . $message->message_id . '\');"><i id="message' . $message->message_id . '_img" class="icon-plus"></i> <b dir="auto">' . Filter::escapeHtml($message->subject) . '</b></a></td>';
120				$content .= '<td class="list_value_wrap">' . FunctionsDate::formatTimestamp($message->created + WT_TIMESTAMP_OFFSET) . '</td>';
121				$content .= '<td class="list_value_wrap">';
122				$user = User::findByIdentifier($message->sender);
123				if ($user) {
124					$content .= $user->getRealNameHtml();
125					$content .= '  - <span dir="auto">' . $user->getEmail() . '</span>';
126				} else {
127					$content .= '<a href="mailto:' . Filter::escapeHtml($message->sender) . '">' . Filter::escapeHtml($message->sender) . '</a>';
128				}
129				$content .= '</td>';
130				$content .= '</tr>';
131				$content .= '<tr><td class="list_value_wrap" colspan="4"><div id="message' . $message->message_id . '" style="display:none;">';
132				$content .= '<div dir="auto" style="white-space: pre-wrap;">' . Filter::expandUrls($message->body) . '</div><br>';
133				if (strpos($message->subject, /* I18N: When replying to an email, the subject becomes “RE: <subject>” */ I18N::translate('RE: ')) !== 0) {
134					$message->subject = I18N::translate('RE: ') . $message->subject;
135				}
136				if ($user) {
137					$content .= '<button type="button" onclick="reply(\'' . Filter::escapeJs($message->sender) . '\', \'' . Filter::escapeJs($message->subject) . '\'); return false;">' . I18N::translate('Reply') . '</button> ';
138				}
139				$content .= '<button type="button" onclick="if (confirm(\'' . I18N::translate('Are you sure you want to delete this message? It cannot be retrieved later.') . '\')) {jQuery(\'#messageform :checkbox\').prop(\'checked\', false); jQuery(\'#cb_message' . $message->message_id . '\').prop(\'checked\', true); document.messageform.submit();}">' . I18N::translate('Delete') . '</button></div></td></tr>';
140			}
141			$content .= '</table>';
142			$content .= '<p><button type="submit">' . I18N::translate('Delete selected messages') . '</button></p>';
143		}
144		$content .= '</form>';
145
146		if ($template) {
147			if ($block) {
148				$class .= ' small_inner_block';
149			}
150
151			return Theme::theme()->formatBlock($id, $title, $class, $content);
152		} else {
153			return $content;
154		}
155	}
156
157	/** {@inheritdoc} */
158	public function loadAjax() {
159		return false;
160	}
161
162	/** {@inheritdoc} */
163	public function isUserBlock() {
164		return true;
165	}
166
167	/** {@inheritdoc} */
168	public function isGedcomBlock() {
169		return false;
170	}
171
172	/**
173	 * An HTML form to edit block settings
174	 *
175	 * @param int $block_id
176	 */
177	public function configureBlock($block_id) {
178		if (Filter::postBool('save') && Filter::checkCsrf()) {
179			$this->setBlockSetting($block_id, 'block', Filter::postBool('block'));
180		}
181
182		$block = $this->getBlockSetting($block_id, 'block', '1');
183		echo '<tr><td class="descriptionbox wrap width33">';
184		echo /* I18N: label for a yes/no option */ I18N::translate('Add a scrollbar when block contents grow');
185		echo '</td><td class="optionbox">';
186		echo FunctionsEdit::editFieldYesNo('block', $block);
187		echo '</td></tr>';
188	}
189}
190