weekly release 3.9dev
[moodle.git] / lib / classes / message / manager.php
CommitLineData
349f98ad
PS
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle 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//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * New messaging manager class.
19 *
20 * @package core_message
21 * @since Moodle 2.8
22 * @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 * @author Petr Skoda <petr.skoda@totaralms.com>
25 */
26
27namespace core\message;
28
29defined('MOODLE_INTERNAL') || die();
30
31/**
32 * Class used for various messaging related stuff.
33 *
34 * Note: Do NOT use directly in your code, it is intended to be used from core code only.
35 *
36 * @access private
37 *
38 * @package core_message
39 * @since Moodle 2.8
40 * @copyright 2014 Totara Learning Solutions Ltd {@link http://www.totaralms.com/}
41 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42 * @author Petr Skoda <petr.skoda@totaralms.com>
43 */
44class manager {
45 /** @var array buffer of pending messages */
46 protected static $buffer = array();
47
b30f4d6d
JD
48 /** @var array buffer of pending messages to conversations */
49 protected static $convmessagebuffer = array();
50
9581bc3c
JD
51 /**
52 * Used for calling processors, and generating event data when sending a message to a conversation.
53 *
54 * This is ONLY used for messages of type 'message' (notification=0), and is responsible for:
55 *
56 * 1. generation of per-user event data (to pass to processors)
57 * 2. generation of the processors for each recipient member of the conversation
58 * 3. calling said processors for each member, passing in the per-user (local) eventdata.
59 * 4. generation of an appropriate event for the message send, depending on the conversation type
60 * - messages to individual conversations generate a 'message_sent' event (as per legacy send_message())
61 * - messages to group conversations generate a 'group_message_sent' event.
62 *
63 * @param message $eventdata
64 * @param \stdClass $savemessage
65 * @return int
66 */
67 public static function send_message_to_conversation(message $eventdata, \stdClass $savemessage) : int {
68 global $DB, $CFG, $SITE;
69
70 if (empty($eventdata->convid)) {
71 throw new \moodle_exception("Message is not being sent to a conversation. Please check event data.");
72 }
73
74 // Fetch default (site) preferences.
75 $defaultpreferences = get_message_output_default_preferences();
76 $preferencebase = $eventdata->component.'_'.$eventdata->name;
77
78 // Because we're dealing with multiple recipients, we need to send a localised (per-user) version of the eventdata to each
79 // processor, because of things like the language-specific subject. We're going to modify this, for each recipient member.
80 // Any time we're modifying the event data here, we should be using the localised version.
81 // This localised version is based on the generic event data, but we should keep that object intact, so we clone it.
82 $localisedeventdata = clone $eventdata;
83
84 // Get user records for all members of the conversation.
ad5de40c
JD
85 // We must fetch distinct users, because it's possible for a user to message themselves via bulk user actions.
86 // In such cases, there will be 2 records referring to the same user.
5e600f7c 87 $sql = "SELECT u.*, mca.id as ismuted
ad5de40c 88 FROM {user} u
5e600f7c
MN
89 LEFT JOIN {message_conversation_actions} mca
90 ON mca.userid = u.id AND mca.conversationid = ? AND mca.action = ?
ad5de40c
JD
91 WHERE u.id IN (
92 SELECT mcm.userid FROM {message_conversation_members} mcm
5e600f7c 93 WHERE mcm.conversationid = ?
ad5de40c 94 )";
5e600f7c
MN
95 $members = $DB->get_records_sql($sql, [$eventdata->convid, \core_message\api::CONVERSATION_ACTION_MUTED,
96 $eventdata->convid]);
9581bc3c
JD
97 if (empty($members)) {
98 throw new \moodle_exception("Conversation has no members or does not exist.");
99 }
100
101 if (!is_object($localisedeventdata->userfrom)) {
102 $localisedeventdata->userfrom = $members[$localisedeventdata->userfrom];
103 }
104
105 // This should now hold only the other users (recipients).
106 unset($members[$localisedeventdata->userfrom->id]);
107 $otherusers = $members;
108
109 // Get conversation type and name. We'll use this to determine which message subject to generate, depending on type.
110 $conv = $DB->get_record('message_conversations', ['id' => $eventdata->convid], 'id, type, name');
111
734b198f
SA
112 // For now Self conversations are not processed because users are aware of the messages sent by themselves, so we
113 // can return early.
114 if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_SELF) {
115 return $savemessage->id;
116 }
ca754fc8 117 $localisedeventdata->conversationtype = $conv->type;
734b198f 118
9581bc3c
JD
119 // We treat individual conversations the same as any direct message with 'userfrom' and 'userto' specified.
120 // We know the other user, so set the 'userto' field so that the event code will get access to this field.
121 // If this was a legacy caller (eventdata->userto is set), then use that instead, as we want to use the fields specified
122 // in that object instead of using one fetched from the DB.
123 $legacymessage = false;
124 if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
125 if (isset($eventdata->userto)) {
126 $legacymessage = true;
127 } else {
128 $otheruser = reset($otherusers);
129 $eventdata->userto = $otheruser;
130 }
131 }
132
133 // Fetch enabled processors.
134 // If we are dealing with a message some processors may want to handle it regardless of user and site settings.
135 $processors = array_filter(get_message_processors(false), function($processor) {
136 if ($processor->object->force_process_messages()) {
137 return true;
138 }
139
140 return ($processor->enabled && $processor->configured);
141 });
142
143 // For each member of the conversation, other than the sender:
144 // 1. Set recipient specific event data (language specific, user prefs, etc)
145 // 2. Generate recipient specific processor list
146 // 3. Call send_message() to pass the message to processors and generate the relevant per-user events.
147 $eventprocmaps = []; // Init the event/processors buffer.
148 foreach ($otherusers as $recipient) {
149 // If this message was a legacy (1:1) message, then we use the userto.
150 if ($legacymessage) {
5e600f7c
MN
151 $ismuted = $recipient->ismuted;
152
9581bc3c 153 $recipient = $eventdata->userto;
5e600f7c 154 $recipient->ismuted = $ismuted;
9581bc3c
JD
155 }
156
157 $usertoisrealuser = (\core_user::is_real_user($recipient->id) != false);
158
159 // Using string manager directly so that strings in the message will be in the message recipients language rather than
160 // the sender's.
161 if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
162 $localisedeventdata->subject = get_string_manager()->get_string('unreadnewmessage', 'message',
163 fullname($localisedeventdata->userfrom), $recipient->lang);
164 } else if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP) {
165 $stringdata = (object) ['name' => fullname($localisedeventdata->userfrom), 'conversationname' => $conv->name];
166 $localisedeventdata->subject = get_string_manager()->get_string('unreadnewgroupconversationmessage', 'message',
167 $stringdata, $recipient->lang);
168 }
169
170 // Spoof the userto based on the current member id.
171 $localisedeventdata->userto = $recipient;
36fa0ec9
JL
172 // Check if the notification is including images that will need a user token to be displayed outside Moodle.
173 if (!empty($localisedeventdata->customdata)) {
174 $customdata = json_decode($localisedeventdata->customdata);
175 if (is_object($customdata) && !empty($customdata->notificationiconurl)) {
176 $customdata->tokenpluginfile = get_user_key('core_files', $localisedeventdata->userto->id);
177 $localisedeventdata->customdata = $customdata; // Message class will JSON encode again.
178 }
179 }
9581bc3c
JD
180
181 $s = new \stdClass();
182 $s->sitename = format_string($SITE->shortname, true, array('context' => \context_course::instance(SITEID)));
e84312f7 183 $s->url = $CFG->wwwroot.'/message/index.php?id='.$eventdata->userfrom->id;
9581bc3c
JD
184 $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $recipient->lang);
185
186 $localisedeventdata->fullmessage = $eventdata->fullmessage;
187 $localisedeventdata->fullmessagehtml = $eventdata->fullmessagehtml;
188 if (!empty($localisedeventdata->fullmessage)) {
189 $localisedeventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n"
190 . $emailtagline;
191 }
192 if (!empty($localisedeventdata->fullmessagehtml)) {
193 $localisedeventdata->fullmessagehtml .=
194 "<br><br>---------------------------------------------------------------------<br>" . $emailtagline;
195 }
196
197 // If recipient is internal user (noreply user), and emailstop is set then don't send any msg.
198 if (!$usertoisrealuser && !empty($recipient->emailstop)) {
199 debugging('Attempt to send msg to internal (noreply) user', DEBUG_NORMAL);
200 return false;
201 }
202
203 // Set the online state.
204 if (isset($CFG->block_online_users_timetosee)) {
205 $timetoshowusers = $CFG->block_online_users_timetosee * 60;
206 } else {
207 $timetoshowusers = 300;
208 }
209
210 // Work out if the user is logged in or not.
211 $userstate = 'loggedoff';
212 if (!empty($localisedeventdata->userto->lastaccess)
213 && (time() - $timetoshowusers) < $localisedeventdata->userto->lastaccess) {
214 $userstate = 'loggedin';
215 }
216
217 // Fill in the array of processors to be used based on default and user preferences.
5e600f7c 218 // Do not process muted conversations.
9581bc3c 219 $processorlist = [];
c210455a 220 if (!$recipient->ismuted) {
267b4f03
JD
221 foreach ($processors as $processor) {
222 // Skip adding processors for internal user, if processor doesn't support sending message to internal user.
223 if (!$usertoisrealuser && !$processor->object->can_send_to_any_users()) {
224 continue;
225 }
9581bc3c 226
267b4f03
JD
227 // First find out permissions.
228 $defaultpreference = $processor->name . '_provider_' . $preferencebase . '_permitted';
229 if (isset($defaultpreferences->{$defaultpreference})) {
230 $permitted = $defaultpreferences->{$defaultpreference};
231 } else {
232 // MDL-25114 They supplied an $eventdata->component $eventdata->name combination which doesn't
233 // exist in the message_provider table (thus there is no default settings for them).
234 $preferrormsg = "Could not load preference $defaultpreference. Make sure the component and name you supplied
9581bc3c 235 to message_send() are valid.";
267b4f03
JD
236 throw new coding_exception($preferrormsg);
237 }
9581bc3c 238
267b4f03
JD
239 // Find out if user has configured this output.
240 // Some processors cannot function without settings from the user.
241 $userisconfigured = $processor->object->is_user_configured($recipient);
9581bc3c 242
267b4f03
JD
243 // DEBUG: notify if we are forcing unconfigured output.
244 if ($permitted == 'forced' && !$userisconfigured) {
245 debugging('Attempt to force message delivery to user who has "' . $processor->name .
246 '" output unconfigured', DEBUG_NORMAL);
247 }
9581bc3c 248
267b4f03
JD
249 // Populate the list of processors we will be using.
250 if (!$eventdata->notification && $processor->object->force_process_messages()) {
251 $processorlist[] = $processor->name;
252 } else if ($permitted == 'forced' && $userisconfigured) {
253 // An admin is forcing users to use this message processor. Use this processor unconditionally.
254 $processorlist[] = $processor->name;
255 } else if ($permitted == 'permitted' && $userisconfigured && !$recipient->emailstop) {
256 // User has not disabled notifications.
257 // See if user set any notification preferences, otherwise use site default ones.
258 $userpreferencename = 'message_provider_' . $preferencebase . '_' . $userstate;
259 if ($userpreference = get_user_preferences($userpreferencename, null, $recipient)) {
260 if (in_array($processor->name, explode(',', $userpreference))) {
261 $processorlist[] = $processor->name;
262 }
263 } else if (isset($defaultpreferences->{$userpreferencename})) {
264 if (in_array($processor->name, explode(',', $defaultpreferences->{$userpreferencename}))) {
265 $processorlist[] = $processor->name;
266 }
9581bc3c
JD
267 }
268 }
269 }
270 }
b30f4d6d
JD
271 // Batch up the localised event data and processor list for all users into a local buffer.
272 $eventprocmaps[] = [clone($localisedeventdata), $processorlist];
9581bc3c 273 }
b30f4d6d
JD
274 // Then pass it off as one item of work, to be processed by send_conversation_message_to_processors(), which will
275 // handle all transaction buffering logic.
276 self::send_conversation_message_to_processors($eventprocmaps, $eventdata, $savemessage);
9581bc3c
JD
277
278 return $savemessage->id;
279 }
280
b30f4d6d
JD
281 /**
282 * Takes a list of localised event data, and tries to send them to their respective member's message processors.
283 *
284 * Input format:
285 * [CONVID => [$localisedeventdata, $savemessage, $processorlist], ].
286 *
287 * @param array $eventprocmaps the array of localised event data and processors for each member of the conversation.
288 * @param message $eventdata the original conversation message eventdata
289 * @param \stdClass $savemessage the saved message record.
290 * @throws \coding_exception
291 */
292 protected static function send_conversation_message_to_processors(array $eventprocmaps, message $eventdata,
293 \stdClass $savemessage) {
294 global $DB;
295
296 // We cannot communicate with external systems in DB transactions,
297 // buffer the messages if necessary.
298 if ($DB->is_transaction_started()) {
299 // Buffer this group conversation message and it's record.
300 self::$convmessagebuffer[] = [$eventprocmaps, $eventdata, $savemessage];
301 return;
302 }
303
304 // Send each localised version of the event data to each member's respective processors.
305 foreach ($eventprocmaps as $eventprocmap) {
306 $eventdata = $eventprocmap[0];
307 $processorlist = $eventprocmap[1];
308 self::call_processors($eventdata, $processorlist);
309 }
310
311 // Trigger event for sending a message or notification - we need to do this before marking as read!
312 self::trigger_message_events($eventdata, $savemessage);
313 }
314
349f98ad
PS
315 /**
316 * Do the message sending.
317 *
318 * NOTE: to be used from message_send() only.
319 *
cc350fd9 320 * @param \core\message\message $eventdata fully prepared event data for processors
349f98ad
PS
321 * @param \stdClass $savemessage the message saved in 'message' table
322 * @param array $processorlist list of processors for target user
883ce421 323 * @return int $messageid the id from 'messages' (false is not returned)
349f98ad 324 */
cc4952e9 325 public static function send_message(message $eventdata, \stdClass $savemessage, array $processorlist) {
349f98ad 326 global $CFG;
c6f45ef8 327
349f98ad
PS
328 require_once($CFG->dirroot.'/message/lib.php'); // This is most probably already included from messagelib.php file.
329
330 if (empty($processorlist)) {
376a79c2 331 // Trigger event for sending a message or notification - we need to do this before marking as read!
947d3289 332 self::trigger_message_events($eventdata, $savemessage);
349f98ad 333
883ce421 334 if ($eventdata->notification or empty($CFG->messaging)) {
349f98ad
PS
335 // If they have deselected all processors and its a notification mark it read. The user doesn't want to be bothered.
336 // The same goes if the messaging is completely disabled.
883ce421 337 if ($eventdata->notification) {
548936a6
MN
338 $savemessage->timeread = null;
339 \core_message\api::mark_notification_as_read($savemessage);
883ce421 340 } else {
548936a6 341 \core_message\api::mark_message_as_read($eventdata->userto->id, $savemessage);
883ce421 342 }
349f98ad
PS
343 }
344
883ce421 345 return $savemessage->id;
349f98ad
PS
346 }
347
348 // Let the manager do the sending or buffering when db transaction in progress.
349 return self::send_message_to_processors($eventdata, $savemessage, $processorlist);
350 }
351
352 /**
353 * Send message to message processors.
354 *
c6f45ef8 355 * @param \stdClass|\core\message\message $eventdata
349f98ad
PS
356 * @param \stdClass $savemessage
357 * @param array $processorlist
358 * @return int $messageid
359 */
c6f45ef8
AA
360 protected static function send_message_to_processors($eventdata, \stdClass $savemessage, array
361 $processorlist) {
349f98ad
PS
362 global $CFG, $DB;
363
364 // We cannot communicate with external systems in DB transactions,
365 // buffer the messages if necessary.
349f98ad
PS
366 if ($DB->is_transaction_started()) {
367 // We need to clone all objects so that devs may not modify it from outside later.
368 $eventdata = clone($eventdata);
369 $eventdata->userto = clone($eventdata->userto);
370 $eventdata->userfrom = clone($eventdata->userfrom);
371
372 // Conserve some memory the same was as $USER setup does.
373 unset($eventdata->userto->description);
374 unset($eventdata->userfrom->description);
375
376 self::$buffer[] = array($eventdata, $savemessage, $processorlist);
377 return $savemessage->id;
378 }
379
947d3289
JD
380 // Send the message to processors.
381 self::call_processors($eventdata, $processorlist);
349f98ad 382
376a79c2 383 // Trigger event for sending a message or notification - we need to do this before marking as read!
947d3289 384 self::trigger_message_events($eventdata, $savemessage);
349f98ad 385
0d657cc9
MN
386 if (empty($CFG->messaging)) {
387 // If they have deselected all processors and its a notification mark it read. The user doesn't want to be bothered.
388 // The same goes if the messaging is completely disabled.
883ce421 389 if ($eventdata->notification) {
548936a6
MN
390 $savemessage->timeread = null;
391 \core_message\api::mark_notification_as_read($savemessage);
883ce421 392 } else {
548936a6 393 \core_message\api::mark_message_as_read($eventdata->userto->id, $savemessage);
883ce421 394 }
349f98ad
PS
395 }
396
883ce421 397 return $savemessage->id;
349f98ad
PS
398 }
399
400 /**
401 * Notification from DML layer.
402 *
403 * Note: to be used from DML layer only.
404 */
405 public static function database_transaction_commited() {
b30f4d6d 406 if (!self::$buffer && !self::$convmessagebuffer) {
349f98ad
PS
407 return;
408 }
409 self::process_buffer();
410 }
411
412 /**
413 * Notification from DML layer.
414 *
415 * Note: to be used from DML layer only.
416 */
417 public static function database_transaction_rolledback() {
418 self::$buffer = array();
9581bc3c 419 self::$convmessagebuffer = array();
349f98ad
PS
420 }
421
422 /**
423 * Sent out any buffered messages if necessary.
424 */
425 protected static function process_buffer() {
b30f4d6d 426 // Reset the buffers first in case we get exception from processor.
349f98ad
PS
427 $messages = self::$buffer;
428 self::$buffer = array();
b30f4d6d
JD
429 $convmessages = self::$convmessagebuffer;
430 self::$convmessagebuffer = array();
349f98ad
PS
431
432 foreach ($messages as $message) {
433 list($eventdata, $savemessage, $processorlist) = $message;
434 self::send_message_to_processors($eventdata, $savemessage, $processorlist);
435 }
b30f4d6d
JD
436
437 foreach ($convmessages as $convmessage) {
438 list($eventprocmap, $eventdata, $savemessage) = $convmessage;
439 self::send_conversation_message_to_processors($eventprocmap, $eventdata, $savemessage);
440 }
349f98ad 441 }
947d3289
JD
442
443 /**
444 * Trigger an appropriate message creation event, based on the supplied $eventdata and $savemessage.
445 *
446 * @param message $eventdata the eventdata for the message.
447 * @param \stdClass $savemessage the message record.
448 * @throws \coding_exception
449 */
450 protected static function trigger_message_events(message $eventdata, \stdClass $savemessage) {
9581bc3c 451 global $DB;
947d3289
JD
452 if ($eventdata->notification) {
453 \core\event\notification_sent::create_from_ids(
454 $eventdata->userfrom->id,
455 $eventdata->userto->id,
456 $savemessage->id,
457 $eventdata->courseid
458 )->trigger();
459 } else { // Must be a message.
9581bc3c
JD
460 // If the message is a group conversation, then trigger the 'group_message_sent' event.
461 if ($eventdata->convid) {
462 $conv = $DB->get_record('message_conversations', ['id' => $eventdata->convid], 'id, type');
463 if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP) {
464 \core\event\group_message_sent::create_from_ids(
465 $eventdata->userfrom->id,
466 $eventdata->convid,
467 $savemessage->id,
468 $eventdata->courseid
469 )->trigger();
470 return;
471 }
472 // Individual type conversations fall through to the default 'message_sent' event.
473 }
947d3289
JD
474 \core\event\message_sent::create_from_ids(
475 $eventdata->userfrom->id,
476 $eventdata->userto->id,
477 $savemessage->id,
478 $eventdata->courseid
479 )->trigger();
480 }
481 }
482
483 /**
484 * For each processor, call it's send_message() method.
485 *
486 * @param message $eventdata the message object.
487 * @param array $processorlist the list of processors for a single user.
488 */
489 protected static function call_processors(message $eventdata, array $processorlist) {
5ba12283
JL
490 // Allow plugins to change the message/notification data before sending it.
491 $pluginsfunction = get_plugins_with_function('pre_processor_message_send');
492
947d3289
JD
493 foreach ($processorlist as $procname) {
494 // Let new messaging class add custom content based on the processor.
495 $proceventdata = ($eventdata instanceof message) ? $eventdata->get_eventobject_for_processor($procname) : $eventdata;
5ba12283
JL
496
497 if ($pluginsfunction) {
498 foreach ($pluginsfunction as $plugintype => $plugins) {
499 foreach ($plugins as $pluginfunction) {
500 $pluginfunction($procname, $proceventdata);
501 }
502 }
503 }
504
947d3289
JD
505 $stdproc = new \stdClass();
506 $stdproc->name = $procname;
507 $processor = \core_message\api::get_processed_processor_object($stdproc);
508 if (!$processor->object->send_message($proceventdata)) {
509 debugging('Error calling message processor ' . $procname);
510 }
511 }
512 }
349f98ad 513}