Moodle release 3.6rc1
[moodle.git] / lib / classes / message / manager.php
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/>.
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  */
27 namespace core\message;
29 defined('MOODLE_INTERNAL') || die();
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  */
44 class manager {
45     /** @var array buffer of pending messages */
46     protected static $buffer = array();
48     /** @var array buffer of pending messages to conversations */
49     protected static $convmessagebuffer = array();
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;
70         if (empty($eventdata->convid)) {
71             throw new \moodle_exception("Message is not being sent to a conversation. Please check event data.");
72         }
74         // Fetch default (site) preferences.
75         $defaultpreferences = get_message_output_default_preferences();
76         $preferencebase = $eventdata->component.'_'.$eventdata->name;
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;
84         // Get user records for all members of the conversation.
85         $sql = "SELECT u.*
86                   FROM {message_conversation_members} mcm
87                   JOIN {user} u
88                     ON (mcm.conversationid = :convid AND u.id = mcm.userid)
89               ORDER BY u.id desc";
90         $members = $DB->get_records_sql($sql, ['convid' => $eventdata->convid]);
91         if (empty($members)) {
92             throw new \moodle_exception("Conversation has no members or does not exist.");
93         }
95         if (!is_object($localisedeventdata->userfrom)) {
96             $localisedeventdata->userfrom = $members[$localisedeventdata->userfrom];
97         }
99         // This should now hold only the other users (recipients).
100         unset($members[$localisedeventdata->userfrom->id]);
101         $otherusers = $members;
103         // Get conversation type and name. We'll use this to determine which message subject to generate, depending on type.
104         $conv = $DB->get_record('message_conversations', ['id' => $eventdata->convid], 'id, type, name');
106         // We treat individual conversations the same as any direct message with 'userfrom' and 'userto' specified.
107         // We know the other user, so set the 'userto' field so that the event code will get access to this field.
108         // If this was a legacy caller (eventdata->userto is set), then use that instead, as we want to use the fields specified
109         // in that object instead of using one fetched from the DB.
110         $legacymessage = false;
111         if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
112             if (isset($eventdata->userto)) {
113                 $legacymessage = true;
114             } else {
115                 $otheruser = reset($otherusers);
116                 $eventdata->userto = $otheruser;
117             }
118         }
120         // Fetch enabled processors.
121         // If we are dealing with a message some processors may want to handle it regardless of user and site settings.
122         $processors = array_filter(get_message_processors(false), function($processor) {
123             if ($processor->object->force_process_messages()) {
124                 return true;
125             }
127             return ($processor->enabled && $processor->configured);
128         });
130         // For each member of the conversation, other than the sender:
131         // 1. Set recipient specific event data (language specific, user prefs, etc)
132         // 2. Generate recipient specific processor list
133         // 3. Call send_message() to pass the message to processors and generate the relevant per-user events.
134         $eventprocmaps = []; // Init the event/processors buffer.
135         foreach ($otherusers as $recipient) {
136             // If this message was a legacy (1:1) message, then we use the userto.
137             if ($legacymessage) {
138                 $recipient = $eventdata->userto;
139             }
141             $usertoisrealuser = (\core_user::is_real_user($recipient->id) != false);
143             // Using string manager directly so that strings in the message will be in the message recipients language rather than
144             // the sender's.
145             if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
146                 $localisedeventdata->subject = get_string_manager()->get_string('unreadnewmessage', 'message',
147                     fullname($localisedeventdata->userfrom), $recipient->lang);
148             } else if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP) {
149                 $stringdata = (object) ['name' => fullname($localisedeventdata->userfrom), 'conversationname' => $conv->name];
150                 $localisedeventdata->subject = get_string_manager()->get_string('unreadnewgroupconversationmessage', 'message',
151                     $stringdata, $recipient->lang);
152             }
154             // Spoof the userto based on the current member id.
155             $localisedeventdata->userto = $recipient;
157             $s = new \stdClass();
158             $s->sitename = format_string($SITE->shortname, true, array('context' => \context_course::instance(SITEID)));
159             // When the new interface lands, the URL may be reintroduced, but for now it isn't supported, so just hit the index.
160             $s->url = $CFG->wwwroot.'/message/index.php';
161             $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $recipient->lang);
163             $localisedeventdata->fullmessage = $eventdata->fullmessage;
164             $localisedeventdata->fullmessagehtml = $eventdata->fullmessagehtml;
165             if (!empty($localisedeventdata->fullmessage)) {
166                 $localisedeventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n"
167                     . $emailtagline;
168             }
169             if (!empty($localisedeventdata->fullmessagehtml)) {
170                 $localisedeventdata->fullmessagehtml .=
171                     "<br><br>---------------------------------------------------------------------<br>" . $emailtagline;
172             }
174             // If recipient is internal user (noreply user), and emailstop is set then don't send any msg.
175             if (!$usertoisrealuser && !empty($recipient->emailstop)) {
176                 debugging('Attempt to send msg to internal (noreply) user', DEBUG_NORMAL);
177                 return false;
178             }
180             // Set the online state.
181             if (isset($CFG->block_online_users_timetosee)) {
182                 $timetoshowusers = $CFG->block_online_users_timetosee * 60;
183             } else {
184                 $timetoshowusers = 300;
185             }
187             // Work out if the user is logged in or not.
188             $userstate = 'loggedoff';
189             if (!empty($localisedeventdata->userto->lastaccess)
190                     && (time() - $timetoshowusers) < $localisedeventdata->userto->lastaccess) {
191                 $userstate = 'loggedin';
192             }
194             // Fill in the array of processors to be used based on default and user preferences.
195             // This applies only to individual conversations. Messages to group conversations ignore processors.
196             $processorlist = [];
197             if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
198                 foreach ($processors as $processor) {
199                     // Skip adding processors for internal user, if processor doesn't support sending message to internal user.
200                     if (!$usertoisrealuser && !$processor->object->can_send_to_any_users()) {
201                         continue;
202                     }
204                     // First find out permissions.
205                     $defaultpreference = $processor->name . '_provider_' . $preferencebase . '_permitted';
206                     if (isset($defaultpreferences->{$defaultpreference})) {
207                         $permitted = $defaultpreferences->{$defaultpreference};
208                     } else {
209                         // MDL-25114 They supplied an $eventdata->component $eventdata->name combination which doesn't
210                         // exist in the message_provider table (thus there is no default settings for them).
211                         $preferrormsg = "Could not load preference $defaultpreference. Make sure the component and name you supplied
212                     to message_send() are valid.";
213                         throw new coding_exception($preferrormsg);
214                     }
216                     // Find out if user has configured this output.
217                     // Some processors cannot function without settings from the user.
218                     $userisconfigured = $processor->object->is_user_configured($recipient);
220                     // DEBUG: notify if we are forcing unconfigured output.
221                     if ($permitted == 'forced' && !$userisconfigured) {
222                         debugging('Attempt to force message delivery to user who has "' . $processor->name .
223                             '" output unconfigured', DEBUG_NORMAL);
224                     }
226                     // Populate the list of processors we will be using.
227                     if (!$eventdata->notification && $processor->object->force_process_messages()) {
228                         $processorlist[] = $processor->name;
229                     } else if ($permitted == 'forced' && $userisconfigured) {
230                         // An admin is forcing users to use this message processor. Use this processor unconditionally.
231                         $processorlist[] = $processor->name;
232                     } else if ($permitted == 'permitted' && $userisconfigured && !$recipient->emailstop) {
233                         // User has not disabled notifications.
234                         // See if user set any notification preferences, otherwise use site default ones.
235                         $userpreferencename = 'message_provider_' . $preferencebase . '_' . $userstate;
236                         if ($userpreference = get_user_preferences($userpreferencename, null, $recipient)) {
237                             if (in_array($processor->name, explode(',', $userpreference))) {
238                                 $processorlist[] = $processor->name;
239                             }
240                         } else if (isset($defaultpreferences->{$userpreferencename})) {
241                             if (in_array($processor->name, explode(',', $defaultpreferences->{$userpreferencename}))) {
242                                 $processorlist[] = $processor->name;
243                             }
244                         }
245                     }
246                 }
247             }
248             // Batch up the localised event data and processor list for all users into a local buffer.
249             $eventprocmaps[] = [clone($localisedeventdata), $processorlist];
250         }
251         // Then pass it off as one item of work, to be processed by send_conversation_message_to_processors(), which will
252         // handle all transaction buffering logic.
253         self::send_conversation_message_to_processors($eventprocmaps, $eventdata, $savemessage);
255         return $savemessage->id;
256     }
258     /**
259      * Takes a list of localised event data, and tries to send them to their respective member's message processors.
260      *
261      * Input format:
262      *  [CONVID => [$localisedeventdata, $savemessage, $processorlist], ].
263      *
264      * @param array $eventprocmaps the array of localised event data and processors for each member of the conversation.
265      * @param message $eventdata the original conversation message eventdata
266      * @param \stdClass $savemessage the saved message record.
267      * @throws \coding_exception
268      */
269     protected static function send_conversation_message_to_processors(array $eventprocmaps, message $eventdata,
270                                                                       \stdClass $savemessage) {
271         global $DB;
273         // We cannot communicate with external systems in DB transactions,
274         // buffer the messages if necessary.
275         if ($DB->is_transaction_started()) {
276             // Buffer this group conversation message and it's record.
277             self::$convmessagebuffer[] = [$eventprocmaps, $eventdata, $savemessage];
278             return;
279         }
281         // Send each localised version of the event data to each member's respective processors.
282         foreach ($eventprocmaps as $eventprocmap) {
283             $eventdata = $eventprocmap[0];
284             $processorlist = $eventprocmap[1];
285             self::call_processors($eventdata, $processorlist);
286         }
288         // Trigger event for sending a message or notification - we need to do this before marking as read!
289         self::trigger_message_events($eventdata, $savemessage);
290     }
292     /**
293      * Do the message sending.
294      *
295      * NOTE: to be used from message_send() only.
296      *
297      * @param \core\message\message $eventdata fully prepared event data for processors
298      * @param \stdClass $savemessage the message saved in 'message' table
299      * @param array $processorlist list of processors for target user
300      * @return int $messageid the id from 'messages' (false is not returned)
301      */
302     public static function send_message(message $eventdata, \stdClass $savemessage, array $processorlist) {
303         global $CFG;
305         require_once($CFG->dirroot.'/message/lib.php'); // This is most probably already included from messagelib.php file.
307         if (empty($processorlist)) {
308             // Trigger event for sending a message or notification - we need to do this before marking as read!
309             self::trigger_message_events($eventdata, $savemessage);
311             if ($eventdata->notification or empty($CFG->messaging)) {
312                 // If they have deselected all processors and its a notification mark it read. The user doesn't want to be bothered.
313                 // The same goes if the messaging is completely disabled.
314                 if ($eventdata->notification) {
315                     $savemessage->timeread = null;
316                     \core_message\api::mark_notification_as_read($savemessage);
317                 } else {
318                     \core_message\api::mark_message_as_read($eventdata->userto->id, $savemessage);
319                 }
320             }
322             return $savemessage->id;
323         }
325         // Let the manager do the sending or buffering when db transaction in progress.
326         return self::send_message_to_processors($eventdata, $savemessage, $processorlist);
327     }
329     /**
330      * Send message to message processors.
331      *
332      * @param \stdClass|\core\message\message $eventdata
333      * @param \stdClass $savemessage
334      * @param array $processorlist
335      * @return int $messageid
336      */
337     protected static function send_message_to_processors($eventdata, \stdClass $savemessage, array
338     $processorlist) {
339         global $CFG, $DB;
341         // We cannot communicate with external systems in DB transactions,
342         // buffer the messages if necessary.
343         if ($DB->is_transaction_started()) {
344             // We need to clone all objects so that devs may not modify it from outside later.
345             $eventdata = clone($eventdata);
346             $eventdata->userto = clone($eventdata->userto);
347             $eventdata->userfrom = clone($eventdata->userfrom);
349             // Conserve some memory the same was as $USER setup does.
350             unset($eventdata->userto->description);
351             unset($eventdata->userfrom->description);
353             self::$buffer[] = array($eventdata, $savemessage, $processorlist);
354             return $savemessage->id;
355         }
357         // Send the message to processors.
358         self::call_processors($eventdata, $processorlist);
360         // Trigger event for sending a message or notification - we need to do this before marking as read!
361         self::trigger_message_events($eventdata, $savemessage);
363         if (empty($CFG->messaging)) {
364             // If they have deselected all processors and its a notification mark it read. The user doesn't want to be bothered.
365             // The same goes if the messaging is completely disabled.
366             if ($eventdata->notification) {
367                 $savemessage->timeread = null;
368                 \core_message\api::mark_notification_as_read($savemessage);
369             } else {
370                 \core_message\api::mark_message_as_read($eventdata->userto->id, $savemessage);
371             }
372         }
374         return $savemessage->id;
375     }
377     /**
378      * Notification from DML layer.
379      *
380      * Note: to be used from DML layer only.
381      */
382     public static function database_transaction_commited() {
383         if (!self::$buffer && !self::$convmessagebuffer) {
384             return;
385         }
386         self::process_buffer();
387     }
389     /**
390      * Notification from DML layer.
391      *
392      * Note: to be used from DML layer only.
393      */
394     public static function database_transaction_rolledback() {
395         self::$buffer = array();
396         self::$convmessagebuffer = array();
397     }
399     /**
400      * Sent out any buffered messages if necessary.
401      */
402     protected static function process_buffer() {
403         // Reset the buffers first in case we get exception from processor.
404         $messages = self::$buffer;
405         self::$buffer = array();
406         $convmessages = self::$convmessagebuffer;
407         self::$convmessagebuffer = array();
409         foreach ($messages as $message) {
410             list($eventdata, $savemessage, $processorlist) = $message;
411             self::send_message_to_processors($eventdata, $savemessage, $processorlist);
412         }
414         foreach ($convmessages as $convmessage) {
415             list($eventprocmap, $eventdata, $savemessage) = $convmessage;
416             self::send_conversation_message_to_processors($eventprocmap, $eventdata, $savemessage);
417         }
418     }
420     /**
421      * Trigger an appropriate message creation event, based on the supplied $eventdata and $savemessage.
422      *
423      * @param message $eventdata the eventdata for the message.
424      * @param \stdClass $savemessage the message record.
425      * @throws \coding_exception
426      */
427     protected static function trigger_message_events(message $eventdata, \stdClass $savemessage) {
428         global $DB;
429         if ($eventdata->notification) {
430             \core\event\notification_sent::create_from_ids(
431                 $eventdata->userfrom->id,
432                 $eventdata->userto->id,
433                 $savemessage->id,
434                 $eventdata->courseid
435             )->trigger();
436         } else { // Must be a message.
437             // If the message is a group conversation, then trigger the 'group_message_sent' event.
438             if ($eventdata->convid) {
439                 $conv = $DB->get_record('message_conversations', ['id' => $eventdata->convid], 'id, type');
440                 if ($conv->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP) {
441                     \core\event\group_message_sent::create_from_ids(
442                         $eventdata->userfrom->id,
443                         $eventdata->convid,
444                         $savemessage->id,
445                         $eventdata->courseid
446                     )->trigger();
447                     return;
448                 }
449                 // Individual type conversations fall through to the default 'message_sent' event.
450             }
451             \core\event\message_sent::create_from_ids(
452                 $eventdata->userfrom->id,
453                 $eventdata->userto->id,
454                 $savemessage->id,
455                 $eventdata->courseid
456             )->trigger();
457         }
458     }
460     /**
461      * For each processor, call it's send_message() method.
462      *
463      * @param message $eventdata the message object.
464      * @param array $processorlist the list of processors for a single user.
465      */
466     protected static function call_processors(message $eventdata, array $processorlist) {
467         foreach ($processorlist as $procname) {
468             // Let new messaging class add custom content based on the processor.
469             $proceventdata = ($eventdata instanceof message) ? $eventdata->get_eventobject_for_processor($procname) : $eventdata;
470             $stdproc = new \stdClass();
471             $stdproc->name = $procname;
472             $processor = \core_message\api::get_processed_processor_object($stdproc);
473             if (!$processor->object->send_message($proceventdata)) {
474                 debugging('Error calling message processor ' . $procname);
475             }
476         }
477     }