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