MDL-54708 message: add backend APIs for notifications popover
[moodle.git] / message / lib.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  * Library functions for messaging
19  *
20  * @package   core_message
21  * @copyright 2008 Luis Rodrigues
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->libdir.'/eventslib.php');
27 define ('MESSAGE_SHORTLENGTH', 300);
29 define ('MESSAGE_DISCUSSION_WIDTH',600);
30 define ('MESSAGE_DISCUSSION_HEIGHT',500);
32 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
34 define('MESSAGE_HISTORY_SHORT',0);
35 define('MESSAGE_HISTORY_ALL',1);
37 define('MESSAGE_VIEW_UNREAD_MESSAGES','unread');
38 define('MESSAGE_VIEW_RECENT_CONVERSATIONS','recentconversations');
39 define('MESSAGE_VIEW_RECENT_NOTIFICATIONS','recentnotifications');
40 define('MESSAGE_VIEW_CONTACTS','contacts');
41 define('MESSAGE_VIEW_BLOCKED','blockedusers');
42 define('MESSAGE_VIEW_COURSE','course_');
43 define('MESSAGE_VIEW_SEARCH','search');
45 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
47 define('MESSAGE_CONTACTS_PER_PAGE',10);
48 define('MESSAGE_MAX_COURSE_NAME_LENGTH', 30);
50 define('MESSAGE_UNREAD','unread');
51 define('MESSAGE_READ','read');
52 define('MESSAGE_TYPE_NOTIFICATION','notification');
53 define('MESSAGE_TYPE_MESSAGE','message');
56 /**
57  * Define contants for messaging default settings population. For unambiguity of
58  * plugin developer intentions we use 4-bit value (LSB numbering):
59  * bit 0 - whether to send message when user is loggedin (MESSAGE_DEFAULT_LOGGEDIN)
60  * bit 1 - whether to send message when user is loggedoff (MESSAGE_DEFAULT_LOGGEDOFF)
61  * bit 2..3 - messaging permission (MESSAGE_DISALLOWED|MESSAGE_PERMITTED|MESSAGE_FORCED)
62  *
63  * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
64  */
66 define('MESSAGE_DEFAULT_LOGGEDIN', 0x01); // 0001
67 define('MESSAGE_DEFAULT_LOGGEDOFF', 0x02); // 0010
69 define('MESSAGE_DISALLOWED', 0x04); // 0100
70 define('MESSAGE_PERMITTED', 0x08); // 1000
71 define('MESSAGE_FORCED', 0x0c); // 1100
73 define('MESSAGE_PERMITTED_MASK', 0x0c); // 1100
75 /**
76  * Set default value for default outputs permitted setting
77  */
78 define('MESSAGE_DEFAULT_PERMITTED', 'permitted');
80 /**
81  * Retrieve users blocked by $user1
82  *
83  * @param object $user1 the user whose messages are being viewed
84  * @param object $user2 the user $user1 is talking to. If they are being blocked
85  *                      they will have a variable called 'isblocked' added to their user object
86  * @return array the users blocked by $user1
87  */
88 function message_get_blocked_users($user1=null, $user2=null) {
89     global $DB, $USER;
91     if (empty($user1)) {
92         $user1 = $USER;
93     }
95     if (!empty($user2)) {
96         $user2->isblocked = false;
97     }
99     $blockedusers = array();
101     $userfields = user_picture::fields('u', array('lastaccess'));
102     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
103                           FROM {message_contacts} mc
104                           JOIN {user} u ON u.id = mc.contactid
105                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
106                          WHERE u.deleted = 0 AND mc.userid = :user1id2 AND mc.blocked = 1
107                       GROUP BY $userfields
108                       ORDER BY u.firstname ASC";
109     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
111     foreach($rs as $rd) {
112         $blockedusers[] = $rd;
114         if (!empty($user2) && $user2->id == $rd->id) {
115             $user2->isblocked = true;
116         }
117     }
118     $rs->close();
120     return $blockedusers;
123 /**
124  * Retrieve $user1's contacts (online, offline and strangers)
125  *
126  * @param object $user1 the user whose messages are being viewed
127  * @param object $user2 the user $user1 is talking to. If they are a contact
128  *                      they will have a variable called 'iscontact' added to their user object
129  * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
130  */
131 function message_get_contacts($user1=null, $user2=null) {
132     global $DB, $CFG, $USER;
134     if (empty($user1)) {
135         $user1 = $USER;
136     }
138     if (!empty($user2)) {
139         $user2->iscontact = false;
140     }
142     $timetoshowusers = 300; //Seconds default
143     if (isset($CFG->block_online_users_timetosee)) {
144         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
145     }
147     // time which a user is counting as being active since
148     $timefrom = time()-$timetoshowusers;
150     // people in our contactlist who are online
151     $onlinecontacts  = array();
152     // people in our contactlist who are offline
153     $offlinecontacts = array();
154     // people who are not in our contactlist but have sent us a message
155     $strangers       = array();
157     $userfields = user_picture::fields('u', array('lastaccess'));
159     // get all in our contactlist who are not blocked in our contact list
160     // and count messages we have waiting from each of them
161     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
162                      FROM {message_contacts} mc
163                      JOIN {user} u ON u.id = mc.contactid
164                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
165                     WHERE u.deleted = 0 AND mc.userid = ? AND mc.blocked = 0
166                  GROUP BY $userfields
167                  ORDER BY u.firstname ASC";
169     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
170     foreach ($rs as $rd) {
171         if ($rd->lastaccess >= $timefrom) {
172             // they have been active recently, so are counted online
173             $onlinecontacts[] = $rd;
175         } else {
176             $offlinecontacts[] = $rd;
177         }
179         if (!empty($user2) && $user2->id == $rd->id) {
180             $user2->iscontact = true;
181         }
182     }
183     $rs->close();
185     // get messages from anyone who isn't in our contact list and count the number
186     // of messages we have from each of them
187     $strangersql = "SELECT $userfields, count(m.id) as messagecount
188                       FROM {message} m
189                       JOIN {user} u  ON u.id = m.useridfrom
190                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
191                      WHERE u.deleted = 0 AND mc.id IS NULL AND m.useridto = ?
192                   GROUP BY $userfields
193                   ORDER BY u.firstname ASC";
195     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
196     // Add user id as array index, so supportuser and noreply user don't get duplicated (if they are real users).
197     foreach ($rs as $rd) {
198         $strangers[$rd->id] = $rd;
199     }
200     $rs->close();
202     // Add noreply user and support user to the list, if they don't exist.
203     $supportuser = core_user::get_support_user();
204     if (!isset($strangers[$supportuser->id])) {
205         $supportuser->messagecount = message_count_unread_messages($USER, $supportuser);
206         if ($supportuser->messagecount > 0) {
207             $strangers[$supportuser->id] = $supportuser;
208         }
209     }
211     $noreplyuser = core_user::get_noreply_user();
212     if (!isset($strangers[$noreplyuser->id])) {
213         $noreplyuser->messagecount = message_count_unread_messages($USER, $noreplyuser);
214         if ($noreplyuser->messagecount > 0) {
215             $strangers[$noreplyuser->id] = $noreplyuser;
216         }
217     }
218     return array($onlinecontacts, $offlinecontacts, $strangers);
221 /**
222  * Load the course contexts for all of the users courses
223  *
224  * @param array $courses array of course objects. The courses the user is enrolled in.
225  * @return array of course contexts
226  */
227 function message_get_course_contexts($courses) {
228     $coursecontexts = array();
230     foreach($courses as $course) {
231         $coursecontexts[$course->id] = context_course::instance($course->id);
232     }
234     return $coursecontexts;
237 /**
238  * strip off action parameters like 'removecontact'
239  *
240  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
241  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
242  */
243 function message_remove_url_params($moodleurl) {
244     $newurl = new moodle_url($moodleurl);
245     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
246     return $newurl->out();
249 /**
250  * Count the number of messages with a field having a specified value.
251  * if $field is empty then return count of the whole array
252  * if $field is non-existent then return 0
253  *
254  * @param array $messagearray array of message objects
255  * @param string $field the field to inspect on the message objects
256  * @param string $value the value to test the field against
257  */
258 function message_count_messages($messagearray, $field='', $value='') {
259     if (!is_array($messagearray)) return 0;
260     if ($field == '' or empty($messagearray)) return count($messagearray);
262     $count = 0;
263     foreach ($messagearray as $message) {
264         $count += ($message->$field == $value) ? 1 : 0;
265     }
266     return $count;
269 /**
270  * Returns the count of unread messages for user. Either from a specific user or from all users.
271  *
272  * @param object $user1 the first user. Defaults to $USER
273  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
274  * @return int the count of $user1's unread messages
275  */
276 function message_count_unread_messages($user1=null, $user2=null) {
277     global $USER, $DB;
279     if (empty($user1)) {
280         $user1 = $USER;
281     }
283     if (!empty($user2)) {
284         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
285             array($user1->id, $user2->id), "COUNT('id')");
286     } else {
287         return $DB->count_records_select('message', "useridto = ?",
288             array($user1->id), "COUNT('id')");
289     }
292 /**
293  * Count the number of users blocked by $user1
294  *
295  * @param object $user1 user object
296  * @return int the number of blocked users
297  */
298 function message_count_blocked_users($user1=null) {
299     global $USER, $DB;
301     if (empty($user1)) {
302         $user1 = $USER;
303     }
305     $sql = "SELECT count(mc.id)
306             FROM {message_contacts} mc
307             WHERE mc.userid = :userid AND mc.blocked = 1";
308     $params = array('userid' => $user1->id);
310     return $DB->count_records_sql($sql, $params);
313 /**
314  * Get the users recent conversations meaning all the people they've recently
315  * sent or received a message from plus the most recent message sent to or received from each other user
316  *
317  * @param object|int $user the current user
318  * @param int $limitfrom can be used for paging
319  * @param int $limitto can be used for paging
320  * @return array
321  */
322 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
323     global $DB;
325     if (is_numeric($user)) {
326         $userid = $user;
327         $user = new stdClass();
328         $user->id = $userid;
329     }
331     $userfields = user_picture::fields('otheruser', array('lastaccess'));
333     // This query retrieves the most recent message received from or sent to
334     // seach other user.
335     //
336     // If two messages have the same timecreated, we take the one with the
337     // larger id.
338     //
339     // There is a separate query for read and unread messages as they are stored
340     // in different tables. They were originally retrieved in one query but it
341     // was so large that it was difficult to be confident in its correctness.
342     $uniquefield = $DB->sql_concat('message.useridfrom', "'-'", 'message.useridto');
343     $sql = "SELECT $uniquefield, $userfields,
344                    message.id as mid, message.notification, message.smallmessage, message.fullmessage,
345                    message.fullmessagehtml, message.fullmessageformat, message.timecreated,
346                    contact.id as contactlistid, contact.blocked
347               FROM {message_read} message
348               JOIN (
349                         SELECT MAX(id) AS messageid,
350                                matchedmessage.useridto,
351                                matchedmessage.useridfrom
352                          FROM {message_read} matchedmessage
353                    INNER JOIN (
354                                SELECT MAX(recentmessages.timecreated) timecreated,
355                                       recentmessages.useridfrom,
356                                       recentmessages.useridto
357                                  FROM {message_read} recentmessages
358                                 WHERE (
359                                       (recentmessages.useridfrom = :userid1 AND recentmessages.timeuserfromdeleted = 0) OR
360                                       (recentmessages.useridto = :userid2   AND recentmessages.timeusertodeleted = 0)
361                                       )
362                              GROUP BY recentmessages.useridfrom, recentmessages.useridto
363                               ) recent ON matchedmessage.useridto     = recent.useridto
364                            AND matchedmessage.useridfrom   = recent.useridfrom
365                            AND matchedmessage.timecreated  = recent.timecreated
366                            WHERE (
367                                  (matchedmessage.useridfrom = :userid6 AND matchedmessage.timeuserfromdeleted = 0) OR
368                                  (matchedmessage.useridto = :userid7   AND matchedmessage.timeusertodeleted = 0)
369                                  )
370                       GROUP BY matchedmessage.useridto, matchedmessage.useridfrom
371                    ) messagesubset ON messagesubset.messageid = message.id
372               JOIN {user} otheruser ON (message.useridfrom = :userid4 AND message.useridto = otheruser.id)
373                 OR (message.useridto   = :userid5 AND message.useridfrom   = otheruser.id)
374          LEFT JOIN {message_contacts} contact ON contact.userid  = :userid3 AND contact.contactid = otheruser.id
375              WHERE otheruser.deleted = 0 AND message.notification = 0
376           ORDER BY message.timecreated DESC";
377     $params = array(
378             'userid1' => $user->id,
379             'userid2' => $user->id,
380             'userid3' => $user->id,
381             'userid4' => $user->id,
382             'userid5' => $user->id,
383             'userid6' => $user->id,
384             'userid7' => $user->id
385         );
386     $read = $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
388     // We want to get the messages that have not been read. These are stored in the 'message' table. It is the
389     // exact same query as the one above, except for the table we are querying. So, simply replace references to
390     // the 'message_read' table with the 'message' table.
391     $sql = str_replace('{message_read}', '{message}', $sql);
392     $unread = $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
394     // Union the 2 result sets together looking for the message with the most
395     // recent timecreated for each other user.
396     // $conversation->id (the array key) is the other user's ID.
397     $conversations = array();
398     $conversation_arrays = array($unread, $read);
399     foreach ($conversation_arrays as $conversation_array) {
400         foreach ($conversation_array as $conversation) {
401             if (!isset($conversations[$conversation->id])) {
402                 $conversations[$conversation->id] = $conversation;
403             } else {
404                 $current = $conversations[$conversation->id];
405                 if ($current->timecreated < $conversation->timecreated) {
406                     $conversations[$conversation->id] = $conversation;
407                 } else if ($current->timecreated == $conversation->timecreated) {
408                     if ($current->mid < $conversation->mid) {
409                         $conversations[$conversation->id] = $conversation;
410                     }
411                 }
412             }
413         }
414     }
416     // Sort the conversations by $conversation->timecreated, newest to oldest
417     // There may be multiple conversations with the same timecreated
418     // The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
419     $result = core_collator::asort_objects_by_property($conversations, 'timecreated', core_collator::SORT_NUMERIC);
420     $conversations = array_reverse($conversations);
422     return $conversations;
425 /**
426  * Get the users recent event notifications
427  *
428  * @param object $user the current user
429  * @param int $limitfrom can be used for paging
430  * @param int $limitto can be used for paging
431  * @return array
432  */
433 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
434     global $DB;
436     $userfields = user_picture::fields('u', array('lastaccess'));
437     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.notification, mr.smallmessage, mr.fullmessage, mr.fullmessagehtml, mr.fullmessageformat, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
438               FROM {message_read} mr
439                    JOIN {user} u ON u.id=mr.useridfrom
440              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
441              ORDER BY mr.timecreated DESC";
442     $params = array('userid1' => $user->id, 'notification' => 1);
444     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
445     return $notifications;
448 /**
449  * Try to guess how to convert the message to html.
450  *
451  * @access private
452  *
453  * @param stdClass $message
454  * @param bool $forcetexttohtml
455  * @return string html fragment
456  */
457 function message_format_message_text($message, $forcetexttohtml = false) {
458     // Note: this is a very nasty hack that tries to work around the weird messaging rules and design.
460     $options = new stdClass();
461     $options->para = false;
462     $options->blanktarget = true;
464     $format = $message->fullmessageformat;
466     if (strval($message->smallmessage) !== '') {
467         if ($message->notification == 1) {
468             if (strval($message->fullmessagehtml) !== '' or strval($message->fullmessage) !== '') {
469                 $format = FORMAT_PLAIN;
470             }
471         }
472         $messagetext = $message->smallmessage;
474     } else if ($message->fullmessageformat == FORMAT_HTML) {
475         if (strval($message->fullmessagehtml) !== '') {
476             $messagetext = $message->fullmessagehtml;
477         } else {
478             $messagetext = $message->fullmessage;
479             $format = FORMAT_MOODLE;
480         }
482     } else {
483         if (strval($message->fullmessage) !== '') {
484             $messagetext = $message->fullmessage;
485         } else {
486             $messagetext = $message->fullmessagehtml;
487             $format = FORMAT_HTML;
488         }
489     }
491     if ($forcetexttohtml) {
492         // This is a crazy hack, why not set proper format when creating the notifications?
493         if ($format === FORMAT_PLAIN) {
494             $format = FORMAT_MOODLE;
495         }
496     }
497     return format_text($messagetext, $format, $options);
500 /**
501  * Add the selected user as a contact for the current user
502  *
503  * @param int $contactid the ID of the user to add as a contact
504  * @param int $blocked 1 if you wish to block the contact
505  * @param int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
506  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
507  *                  Otherwise returns the result of update_record() or insert_record()
508  */
509 function message_add_contact($contactid, $blocked = 0, $userid = 0) {
510     global $USER, $DB;
512     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
513         return false;
514     }
516     if (empty($userid)) {
517         $userid = $USER->id;
518     }
520     // Check if a record already exists as we may be changing blocking status.
521     if (($contact = $DB->get_record('message_contacts', array('userid' => $userid, 'contactid' => $contactid))) !== false) {
522         // Check if blocking status has been changed.
523         if ($contact->blocked != $blocked) {
524             $contact->blocked = $blocked;
525             $DB->update_record('message_contacts', $contact);
527             if ($blocked == 1) {
528                 // Trigger event for blocking a contact.
529                 $event = \core\event\message_contact_blocked::create(array(
530                     'objectid' => $contact->id,
531                     'userid' => $contact->userid,
532                     'relateduserid' => $contact->contactid,
533                     'context'  => context_user::instance($contact->userid)
534                 ));
535                 $event->add_record_snapshot('message_contacts', $contact);
536                 $event->trigger();
537             } else {
538                 // Trigger event for unblocking a contact.
539                 $event = \core\event\message_contact_unblocked::create(array(
540                     'objectid' => $contact->id,
541                     'userid' => $contact->userid,
542                     'relateduserid' => $contact->contactid,
543                     'context'  => context_user::instance($contact->userid)
544                 ));
545                 $event->add_record_snapshot('message_contacts', $contact);
546                 $event->trigger();
547             }
549             return true;
550         } else {
551             // No change to blocking status.
552             return true;
553         }
555     } else {
556         // New contact record.
557         $contact = new stdClass();
558         $contact->userid = $userid;
559         $contact->contactid = $contactid;
560         $contact->blocked = $blocked;
561         $contact->id = $DB->insert_record('message_contacts', $contact);
563         $eventparams = array(
564             'objectid' => $contact->id,
565             'userid' => $contact->userid,
566             'relateduserid' => $contact->contactid,
567             'context'  => context_user::instance($contact->userid)
568         );
570         if ($blocked) {
571             $event = \core\event\message_contact_blocked::create($eventparams);
572         } else {
573             $event = \core\event\message_contact_added::create($eventparams);
574         }
575         // Trigger event.
576         $event->trigger();
578         return true;
579     }
582 /**
583  * remove a contact
584  *
585  * @param int $contactid the user ID of the contact to remove
586  * @param int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
587  * @return bool returns the result of delete_records()
588  */
589 function message_remove_contact($contactid, $userid = 0) {
590     global $USER, $DB;
592     if (empty($userid)) {
593         $userid = $USER->id;
594     }
596     if ($contact = $DB->get_record('message_contacts', array('userid' => $userid, 'contactid' => $contactid))) {
597         $DB->delete_records('message_contacts', array('id' => $contact->id));
599         // Trigger event for removing a contact.
600         $event = \core\event\message_contact_removed::create(array(
601             'objectid' => $contact->id,
602             'userid' => $contact->userid,
603             'relateduserid' => $contact->contactid,
604             'context'  => context_user::instance($contact->userid)
605         ));
606         $event->add_record_snapshot('message_contacts', $contact);
607         $event->trigger();
609         return true;
610     }
612     return false;
615 /**
616  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
617  *
618  * @param int $contactid the user ID of the contact to unblock
619  * @param int $userid the user ID of the user we want to unblock the contact for, defaults to current user
620  *  if not specified.
621  * @return bool returns the result of delete_records()
622  */
623 function message_unblock_contact($contactid, $userid = 0) {
624     return message_add_contact($contactid, 0, $userid);
627 /**
628  * Block a user.
629  *
630  * @param int $contactid the user ID of the user to block
631  * @param int $userid the user ID of the user we want to unblock the contact for, defaults to current user
632  *  if not specified.
633  * @return bool
634  */
635 function message_block_contact($contactid, $userid = 0) {
636     return message_add_contact($contactid, 1, $userid);
639 /**
640  * Checks if a user can delete a message.
641  *
642  * @param stdClass $message the message to delete
643  * @param string $userid the user id of who we want to delete the message for (this may be done by the admin
644  *  but will still seem as if it was by the user)
645  * @return bool Returns true if a user can delete the message, false otherwise.
646  */
647 function message_can_delete_message($message, $userid) {
648     global $USER;
650     if ($message->useridfrom == $userid) {
651         $userdeleting = 'useridfrom';
652     } else if ($message->useridto == $userid) {
653         $userdeleting = 'useridto';
654     } else {
655         return false;
656     }
658     $systemcontext = context_system::instance();
660     // Let's check if the user is allowed to delete this message.
661     if (has_capability('moodle/site:deleteanymessage', $systemcontext) ||
662         ((has_capability('moodle/site:deleteownmessage', $systemcontext) &&
663             $USER->id == $message->$userdeleting))) {
664         return true;
665     }
667     return false;
670 /**
671  * Deletes a message.
672  *
673  * This function does not verify any permissions.
674  *
675  * @param stdClass $message the message to delete
676  * @param string $userid the user id of who we want to delete the message for (this may be done by the admin
677  *  but will still seem as if it was by the user)
678  * @return bool
679  */
680 function message_delete_message($message, $userid) {
681     global $DB;
683     // The column we want to alter.
684     if ($message->useridfrom == $userid) {
685         $coltimedeleted = 'timeuserfromdeleted';
686     } else if ($message->useridto == $userid) {
687         $coltimedeleted = 'timeusertodeleted';
688     } else {
689         return false;
690     }
692     // Don't update it if it's already been deleted.
693     if ($message->$coltimedeleted > 0) {
694         return false;
695     }
697     // Get the table we want to update.
698     if (isset($message->timeread)) {
699         $messagetable = 'message_read';
700     } else {
701         $messagetable = 'message';
702     }
704     // Mark the message as deleted.
705     $updatemessage = new stdClass();
706     $updatemessage->id = $message->id;
707     $updatemessage->$coltimedeleted = time();
708     $success = $DB->update_record($messagetable, $updatemessage);
710     if ($success) {
711         // Trigger event for deleting a message.
712         \core\event\message_deleted::create_from_ids($message->useridfrom, $message->useridto,
713             $userid, $messagetable, $message->id)->trigger();
714     }
716     return $success;
719 /**
720  * Load a user's contact record
721  *
722  * @param int $contactid the user ID of the user whose contact record you want
723  * @return array message contacts
724  */
725 function message_get_contact($contactid) {
726     global $USER, $DB;
727     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
730 /**
731  * Print a message contact link
732  *
733  * @param int $userid the ID of the user to apply to action to
734  * @param string $linktype can be add, remove, block or unblock
735  * @param bool $return if true return the link as a string. If false echo the link.
736  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
737  * @param bool $text include text next to the icons?
738  * @param bool $icon include a graphical icon?
739  * @return string  if $return is true otherwise bool
740  */
741 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
742     global $OUTPUT, $PAGE;
744     //hold onto the strings as we're probably creating a bunch of links
745     static $str;
747     if (empty($script)) {
748         //strip off previous action params like 'removecontact'
749         $script = message_remove_url_params($PAGE->url);
750     }
752     if (empty($str->blockcontact)) {
753        $str = new stdClass();
754        $str->blockcontact   =  get_string('blockcontact', 'message');
755        $str->unblockcontact =  get_string('unblockcontact', 'message');
756        $str->removecontact  =  get_string('removecontact', 'message');
757        $str->addcontact     =  get_string('addcontact', 'message');
758     }
760     $command = $linktype.'contact';
761     $string  = $str->{$command};
763     $safealttext = s($string);
765     $safestring = '';
766     if (!empty($text)) {
767         $safestring = $safealttext;
768     }
770     $img = '';
771     if ($icon) {
772         $iconpath = null;
773         switch ($linktype) {
774             case 'block':
775                 $iconpath = 't/block';
776                 break;
777             case 'unblock':
778                 $iconpath = 't/unblock';
779                 break;
780             case 'remove':
781                 $iconpath = 't/removecontact';
782                 break;
783             case 'add':
784             default:
785                 $iconpath = 't/addcontact';
786         }
788         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
789     }
791     $output = '<span class="'.$linktype.'contact">'.
792               '<a href="'.$script.'&amp;'.$command.'='.$userid.
793               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
794               $img.
795               $safestring.'</a></span>';
797     if ($return) {
798         return $output;
799     } else {
800         echo $output;
801         return true;
802     }
805 /**
806  * echo or return a link to take the user to the full message history between themselves and another user
807  *
808  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
809  * @param int $userid2 the ID of the other user
810  * @param bool $return true to return the link as a string. False to echo the link.
811  * @param string $keywords any keywords to highlight in the message history
812  * @param string $position anchor name to jump to within the message history
813  * @param string $linktext optionally specify the link text
814  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
815  */
816 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
817     global $OUTPUT, $PAGE;
818     static $strmessagehistory;
820     if (empty($strmessagehistory)) {
821         $strmessagehistory = get_string('messagehistory', 'message');
822     }
824     if ($position) {
825         $position = "#$position";
826     }
827     if ($keywords) {
828         $keywords = "&search=".urlencode($keywords);
829     }
831     if ($linktext == 'icon') {  // Icon only
832         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
833     } else if ($linktext == 'both') {  // Icon and standard name
834         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="" />';
835         $fulllink .= '&nbsp;'.$strmessagehistory;
836     } else if ($linktext) {    // Custom name
837         $fulllink = $linktext;
838     } else {                   // Standard name only
839         $fulllink = $strmessagehistory;
840     }
842     $popupoptions = array(
843             'height' => 500,
844             'width' => 500,
845             'menubar' => false,
846             'location' => false,
847             'status' => true,
848             'scrollbars' => true,
849             'resizable' => true);
851     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
852     if ($PAGE->url && $PAGE->url->get_param('viewing')) {
853         $link->param('viewing', $PAGE->url->get_param('viewing'));
854     }
855     $action = null;
856     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
858     $str = '<span class="history">'.$str.'</span>';
860     if ($return) {
861         return $str;
862     } else {
863         echo $str;
864         return true;
865     }
869 /**
870  * Search through course users.
871  *
872  * If $courseids contains the site course then this function searches
873  * through all undeleted and confirmed users.
874  *
875  * @param int|array $courseids Course ID or array of course IDs.
876  * @param string $searchtext the text to search for.
877  * @param string $sort the column name to order by.
878  * @param string|array $exceptions comma separated list or array of user IDs to exclude.
879  * @return array An array of {@link $USER} records.
880  */
881 function message_search_users($courseids, $searchtext, $sort='', $exceptions='') {
882     global $CFG, $USER, $DB;
884     // Basic validation to ensure that the parameter $courseids is not an empty array or an empty value.
885     if (!$courseids) {
886         $courseids = array(SITEID);
887     }
889     // Allow an integer to be passed.
890     if (!is_array($courseids)) {
891         $courseids = array($courseids);
892     }
894     $fullname = $DB->sql_fullname();
895     $ufields = user_picture::fields('u');
897     if (!empty($sort)) {
898         $order = ' ORDER BY '. $sort;
899     } else {
900         $order = '';
901     }
903     $params = array(
904         'userid' => $USER->id,
905         'query' => "%$searchtext%"
906     );
908     if (empty($exceptions)) {
909         $exceptions = array();
910     } else if (!empty($exceptions) && is_string($exceptions)) {
911         $exceptions = explode(',', $exceptions);
912     }
914     // Ignore self and guest account.
915     $exceptions[] = $USER->id;
916     $exceptions[] = $CFG->siteguest;
918     // Exclude exceptions from the search result.
919     list($except, $params_except) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'param', false);
920     $except = ' AND u.id ' . $except;
921     $params = array_merge($params_except, $params);
923     if (in_array(SITEID, $courseids)) {
924         // Search on site level.
925         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
926                                        FROM {user} u
927                                        LEFT JOIN {message_contacts} mc
928                                             ON mc.contactid = u.id AND mc.userid = :userid
929                                       WHERE u.deleted = '0' AND u.confirmed = '1'
930                                             AND (".$DB->sql_like($fullname, ':query', false).")
931                                             $except
932                                      $order", $params);
933     } else {
934         // Search in courses.
936         // Getting the context IDs or each course.
937         $contextids = array();
938         foreach ($courseids as $courseid) {
939             $context = context_course::instance($courseid);
940             $contextids = array_merge($contextids, $context->get_parent_context_ids(true));
941         }
942         list($contextwhere, $contextparams) = $DB->get_in_or_equal(array_unique($contextids), SQL_PARAMS_NAMED, 'context');
943         $params = array_merge($params, $contextparams);
945         // Everyone who has a role assignment in this course or higher.
946         // TODO: add enabled enrolment join here (skodak)
947         $users = $DB->get_records_sql("SELECT DISTINCT $ufields, mc.id as contactlistid, mc.blocked
948                                          FROM {user} u
949                                          JOIN {role_assignments} ra ON ra.userid = u.id
950                                          LEFT JOIN {message_contacts} mc
951                                               ON mc.contactid = u.id AND mc.userid = :userid
952                                         WHERE u.deleted = '0' AND u.confirmed = '1'
953                                               AND (".$DB->sql_like($fullname, ':query', false).")
954                                               AND ra.contextid $contextwhere
955                                               $except
956                                        $order", $params);
958         return $users;
959     }
962 /**
963  * Search a user's messages
964  *
965  * Returns a list of posts found using an array of search terms
966  * eg   word  +word -word
967  *
968  * @param array $searchterms an array of search terms (strings)
969  * @param bool $fromme include messages from the user?
970  * @param bool $tome include messages to the user?
971  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
972  * @param int $userid the user ID of the current user
973  * @return mixed An array of messages or false if no matching messages were found
974  */
975 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
976     global $CFG, $USER, $DB;
978     // If user is searching all messages check they are allowed to before doing anything else.
979     if ($courseid == SITEID && !has_capability('moodle/site:readallmessages', context_system::instance())) {
980         print_error('accessdenied','admin');
981     }
983     // If no userid sent then assume current user.
984     if ($userid == 0) $userid = $USER->id;
986     // Some differences in SQL syntax.
987     if ($DB->sql_regex_supported()) {
988         $REGEXP    = $DB->sql_regex(true);
989         $NOTREGEXP = $DB->sql_regex(false);
990     }
992     $searchcond = array();
993     $params = array();
994     $i = 0;
996     // Preprocess search terms to check whether we have at least 1 eligible search term.
997     // If we do we can drop words around it like 'a'.
998     $dropshortwords = false;
999     foreach ($searchterms as $searchterm) {
1000         if (strlen($searchterm) >= 2) {
1001             $dropshortwords = true;
1002         }
1003     }
1005     foreach ($searchterms as $searchterm) {
1006         $i++;
1008         $NOT = false; // Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle.
1010         if ($dropshortwords && strlen($searchterm) < 2) {
1011             continue;
1012         }
1013         // Under Oracle and MSSQL, trim the + and - operators and perform simpler LIKE search.
1014         if (!$DB->sql_regex_supported()) {
1015             if (substr($searchterm, 0, 1) == '-') {
1016                 $NOT = true;
1017             }
1018             $searchterm = trim($searchterm, '+-');
1019         }
1021         if (substr($searchterm,0,1) == "+") {
1022             $searchterm = substr($searchterm,1);
1023             $searchterm = preg_quote($searchterm, '|');
1024             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1025             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1027         } else if (substr($searchterm,0,1) == "-") {
1028             $searchterm = substr($searchterm,1);
1029             $searchterm = preg_quote($searchterm, '|');
1030             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1031             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1033         } else {
1034             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1035             $params['ss'.$i] = "%$searchterm%";
1036         }
1037     }
1039     if (empty($searchcond)) {
1040         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1041         $params['ss1'] = "%";
1042     } else {
1043         $searchcond = implode(" AND ", $searchcond);
1044     }
1046     // There are several possibilities
1047     // 1. courseid = SITEID : The admin is searching messages by all users
1048     // 2. courseid = ??     : A teacher is searching messages by users in
1049     //                        one of their courses - currently disabled
1050     // 3. courseid = none   : User is searching their own messages;
1051     //    a.  Messages from user
1052     //    b.  Messages to user
1053     //    c.  Messages to and from user
1055     if ($fromme && $tome) {
1056         $searchcond .= " AND ((useridto = :useridto AND timeusertodeleted = 0) OR
1057             (useridfrom = :useridfrom AND timeuserfromdeleted = 0))";
1058         $params['useridto'] = $userid;
1059         $params['useridfrom'] = $userid;
1060     } else if ($fromme) {
1061         $searchcond .= " AND (useridfrom = :useridfrom AND timeuserfromdeleted = 0)";
1062         $params['useridfrom'] = $userid;
1063     } else if ($tome) {
1064         $searchcond .= " AND (useridto = :useridto AND timeusertodeleted = 0)";
1065         $params['useridto'] = $userid;
1066     }
1067     if ($courseid == SITEID) { // Admin is searching all messages.
1068         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1069                                             FROM {message_read} m
1070                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1071         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1072                                             FROM {message} m
1073                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1075     } else if ($courseid !== 'none') {
1076         // This has not been implemented due to security concerns.
1077         $m_read   = array();
1078         $m_unread = array();
1080     } else {
1082         if ($fromme and $tome) {
1083             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1084             $params['userid1'] = $userid;
1085             $params['userid2'] = $userid;
1087         } else if ($fromme) {
1088             $searchcond .= " AND m.useridfrom=:userid";
1089             $params['userid'] = $userid;
1091         } else if ($tome) {
1092             $searchcond .= " AND m.useridto=:userid";
1093             $params['userid'] = $userid;
1094         }
1096         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1097                                             FROM {message_read} m
1098                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1099         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1100                                             FROM {message} m
1101                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1103     }
1105     /// The keys may be duplicated in $m_read and $m_unread so we can't
1106     /// do a simple concatenation
1107     $messages = array();
1108     foreach ($m_read as $m) {
1109         $messages[] = $m;
1110     }
1111     foreach ($m_unread as $m) {
1112         $messages[] = $m;
1113     }
1115     return (empty($messages)) ? false : $messages;
1118 /**
1119  * Given a message object that we already know has a long message
1120  * this function truncates the message nicely to the first
1121  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1122  *
1123  * @param string $message the message
1124  * @param int $minlength the minimum length to trim the message to
1125  * @return string the shortened message
1126  */
1127 function message_shorten_message($message, $minlength = 0) {
1128     $i = 0;
1129     $tag = false;
1130     $length = strlen($message);
1131     $count = 0;
1132     $stopzone = false;
1133     $truncate = 0;
1134     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1137     for ($i=0; $i<$length; $i++) {
1138         $char = $message[$i];
1140         switch ($char) {
1141             case "<":
1142                 $tag = true;
1143                 break;
1144             case ">":
1145                 $tag = false;
1146                 break;
1147             default:
1148                 if (!$tag) {
1149                     if ($stopzone) {
1150                         if ($char == '.' or $char == ' ') {
1151                             $truncate = $i+1;
1152                             break 2;
1153                         }
1154                     }
1155                     $count++;
1156                 }
1157                 break;
1158         }
1159         if (!$stopzone) {
1160             if ($count > $minlength) {
1161                 $stopzone = true;
1162             }
1163         }
1164     }
1166     if (!$truncate) {
1167         $truncate = $i;
1168     }
1170     return substr($message, 0, $truncate);
1174 /**
1175  * Given a string and an array of keywords, this function looks
1176  * for the first keyword in the string, and then chops out a
1177  * small section from the text that shows that word in context.
1178  *
1179  * @param string $message the text to search
1180  * @param array $keywords array of keywords to find
1181  */
1182 function message_get_fragment($message, $keywords) {
1184     $fullsize = 160;
1185     $halfsize = (int)($fullsize/2);
1187     $message = strip_tags($message);
1189     foreach ($keywords as $keyword) {  // Just get the first one
1190         if ($keyword !== '') {
1191             break;
1192         }
1193     }
1194     if (empty($keyword)) {   // None found, so just return start of message
1195         return message_shorten_message($message, 30);
1196     }
1198     $leadin = $leadout = '';
1200 /// Find the start of the fragment
1201     $start = 0;
1202     $length = strlen($message);
1204     $pos = strpos($message, $keyword);
1205     if ($pos > $halfsize) {
1206         $start = $pos - $halfsize;
1207         $leadin = '...';
1208     }
1209 /// Find the end of the fragment
1210     $end = $start + $fullsize;
1211     if ($end > $length) {
1212         $end = $length;
1213     } else {
1214         $leadout = '...';
1215     }
1217 /// Pull out the fragment and format it
1219     $fragment = substr($message, $start, $end - $start);
1220     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1221     return $fragment;
1224 /**
1225  * Retrieve the messages between two users
1226  *
1227  * @param object $user1 the current user
1228  * @param object $user2 the other user
1229  * @param int $limitnum the maximum number of messages to retrieve
1230  * @param bool $viewingnewmessages are we currently viewing new messages?
1231  */
1232 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1233     global $DB, $CFG;
1235     $messages = array();
1237     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1238     //desc to get the last $limitnum messages then flip the order in php
1239     $sort = 'asc';
1240     if ($limitnum>0) {
1241         $sort = 'desc';
1242     }
1244     $notificationswhere = null;
1245     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1246     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1247         $notificationswhere = 'AND notification=0';
1248     }
1250     //prevent notifications of your own actions appearing in your own message history
1251     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1253     $sql = "((useridto = ? AND useridfrom = ? AND timeusertodeleted = 0) OR
1254         (useridto = ? AND useridfrom = ? AND timeuserfromdeleted = 0))";
1255     if ($messages_read = $DB->get_records_select('message_read', $sql . $notificationswhere . $ownnotificationwhere,
1256                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1257                                                     "timecreated $sort", '*', 0, $limitnum)) {
1258         foreach ($messages_read as $message) {
1259             $messages[] = $message;
1260         }
1261     }
1262     if ($messages_new = $DB->get_records_select('message', $sql . $ownnotificationwhere,
1263                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1264                                                     "timecreated $sort", '*', 0, $limitnum)) {
1265         foreach ($messages_new as $message) {
1266             $messages[] = $message;
1267         }
1268     }
1270     $result = core_collator::asort_objects_by_property($messages, 'timecreated', core_collator::SORT_NUMERIC);
1272     //if we only want the last $limitnum messages
1273     $messagecount = count($messages);
1274     if ($limitnum > 0 && $messagecount > $limitnum) {
1275         $messages = array_slice($messages, $messagecount - $limitnum, $limitnum, true);
1276     }
1278     return $messages;
1281 /**
1282  * Format a message for display in the message history
1283  *
1284  * @param object $message the message object
1285  * @param string $format optional date format
1286  * @param string $keywords keywords to highlight
1287  * @param string $class CSS class to apply to the div around the message
1288  * @return string the formatted message
1289  */
1290 function message_format_message($message, $format='', $keywords='', $class='other') {
1292     static $dateformat;
1294     //if we haven't previously set the date format or they've supplied a new one
1295     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1296         if ($format) {
1297             $dateformat = $format;
1298         } else {
1299             $dateformat = get_string('strftimedatetimeshort');
1300         }
1301     }
1302     $time = userdate($message->timecreated, $dateformat);
1304     $messagetext = message_format_message_text($message, false);
1306     if ($keywords) {
1307         $messagetext = highlight($keywords, $messagetext);
1308     }
1310     $messagetext .= message_format_contexturl($message);
1312     $messagetext = clean_text($messagetext, FORMAT_HTML);
1314     return <<<TEMPLATE
1315 <div class='message $class'>
1316     <a name="m{$message->id}"></a>
1317     <span class="message-meta"><span class="time">$time</span></span>: <span class="text">$messagetext</span>
1318 </div>
1319 TEMPLATE;
1322 /**
1323  * Format a the context url and context url name of a message for display
1324  *
1325  * @param object $message the message object
1326  * @return string the formatted string
1327  */
1328 function message_format_contexturl($message) {
1329     $s = null;
1331     if (!empty($message->contexturl)) {
1332         $displaytext = null;
1333         if (!empty($message->contexturlname)) {
1334             $displaytext= $message->contexturlname;
1335         } else {
1336             $displaytext= $message->contexturl;
1337         }
1338         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
1339             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1340         $s .= html_writer::end_tag('div');
1341     }
1343     return $s;
1346 /**
1347  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
1348  *
1349  * @param object $userfrom the message sender
1350  * @param object $userto the message recipient
1351  * @param string $message the message
1352  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
1353  * @return int|false the ID of the new message or false
1354  */
1355 function message_post_message($userfrom, $userto, $message, $format) {
1356     global $SITE, $CFG, $USER;
1358     $eventdata = new stdClass();
1359     $eventdata->component        = 'moodle';
1360     $eventdata->name             = 'instantmessage';
1361     $eventdata->userfrom         = $userfrom;
1362     $eventdata->userto           = $userto;
1364     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1365     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1367     if ($format == FORMAT_HTML) {
1368         $eventdata->fullmessagehtml  = $message;
1369         //some message processors may revert to sending plain text even if html is supplied
1370         //so we keep both plain and html versions if we're intending to send html
1371         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1372     } else {
1373         $eventdata->fullmessage      = $message;
1374         $eventdata->fullmessagehtml  = '';
1375     }
1377     $eventdata->fullmessageformat = $format;
1378     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
1380     $s = new stdClass();
1381     $s->sitename = format_string($SITE->shortname, true, array('context' => context_course::instance(SITEID)));
1382     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1384     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1385     if (!empty($eventdata->fullmessage)) {
1386         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1387     }
1388     if (!empty($eventdata->fullmessagehtml)) {
1389         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1390     }
1392     $eventdata->timecreated     = time();
1393     $eventdata->notification    = 0;
1394     return message_send($eventdata);
1397 /**
1398  * Constructs the add/remove contact link to display next to other users
1399  *
1400  * @param bool $incontactlist is the user a contact
1401  * @param bool $isblocked is the user blocked
1402  * @param stdClass $contact contact object
1403  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1404  * @param bool $text include text next to the icons?
1405  * @param bool $icon include a graphical icon?
1406  * @return string
1407  */
1408 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1409     $strcontact = '';
1411     if($incontactlist){
1412         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1413     } else if ($isblocked) {
1414         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1415     } else{
1416         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1417     }
1419     return $strcontact;
1422 /**
1423  * Constructs the block contact link to display next to other users
1424  *
1425  * @param bool $incontactlist is the user a contact?
1426  * @param bool $isblocked is the user blocked?
1427  * @param stdClass $contact contact object
1428  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1429  * @param bool $text include text next to the icons?
1430  * @param bool $icon include a graphical icon?
1431  * @return string
1432  */
1433 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1434     $strblock   = '';
1436     //commented out to allow the user to block a contact without having to remove them first
1437     /*if ($incontactlist) {
1438         //$strblock = '';
1439     } else*/
1440     if ($isblocked) {
1441         $strblock   = message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1442     } else{
1443         $strblock   = message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1444     }
1446     return $strblock;
1449 /**
1450  * Moves messages from a particular user from the message table (unread messages) to message_read
1451  * This is typically only used when a user is deleted
1452  *
1453  * @param object $userid User id
1454  * @return boolean success
1455  */
1456 function message_move_userfrom_unread2read($userid) {
1457     global $DB;
1459     // move all unread messages from message table to message_read
1460     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1461         foreach ($messages as $message) {
1462             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1463         }
1464     }
1465     return true;
1468 /**
1469  * marks ALL messages being sent from $fromuserid to $touserid as read
1470  *
1471  * @param int $touserid the id of the message recipient
1472  * @param int $fromuserid the id of the message sender
1473  * @return void
1474  */
1475 function message_mark_messages_read($touserid, $fromuserid) {
1476     return message_mark_all_read_for_user($touserid, $fromuserid);
1479 /**
1480  * marks ALL messages being sent from $fromuserid to $touserid as read. Can
1481  * be filtered by type.
1482  *
1483  * @param int $touserid the id of the message recipient
1484  * @param int $fromuserid the id of the message sender
1485  * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1486  * @return void
1487  */
1488 function message_mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1489     global $DB;
1491     $params = array();
1492     $where = '';
1494     if (!empty($touserid)) {
1495         $params['useridto'] = $touserid;
1496     }
1498     if (!empty($fromuserid)) {
1499         $params['useridfrom'] = $fromuserid;
1500     }
1502     if (!empty($type)) {
1503         if (strtolower($type) == MESSAGE_TYPE_NOTIFICATION) {
1504             $params['notification'] = 1;
1505         } else if (strtolower($type) == MESSAGE_TYPE_MESSAGE) {
1506             $params['notification'] = 0;
1507         }
1508     }
1510     $sql = sprintf('SELECT m.* FROM {message} m WHERE m.%s = ?', implode('= ? AND m.', array_keys($params)));
1511     $messages = $DB->get_recordset_sql($sql, array_values($params));
1513     foreach ($messages as $message) {
1514         message_mark_message_read($message, time());
1515     }
1517     $messages->close();
1520 /**
1521  * Mark a single message as read
1522  *
1523  * @param stdClass $message An object with an object property ie $message->id which is an id in the message table
1524  * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1525  * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1526  * @return int the ID of the message in the message_read table
1527  */
1528 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1529     global $DB;
1531     $message->timeread = $timeread;
1533     $messageid = $message->id;
1534     unset($message->id);//unset because it will get a new id on insert into message_read
1536     //If any processors have pending actions abort them
1537     if (!$messageworkingempty) {
1538         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1539     }
1540     $messagereadid = $DB->insert_record('message_read', $message);
1542     $DB->delete_records('message', array('id' => $messageid));
1544     // Get the context for the user who received the message.
1545     $context = context_user::instance($message->useridto, IGNORE_MISSING);
1546     // If the user no longer exists the context value will be false, in this case use the system context.
1547     if ($context === false) {
1548         $context = context_system::instance();
1549     }
1551     // Trigger event for reading a message.
1552     $event = \core\event\message_viewed::create(array(
1553         'objectid' => $messagereadid,
1554         'userid' => $message->useridto, // Using the user who read the message as they are the ones performing the action.
1555         'context' => $context,
1556         'relateduserid' => $message->useridfrom,
1557         'other' => array(
1558             'messageid' => $messageid
1559         )
1560     ));
1561     $event->trigger();
1563     return $messagereadid;
1566 /**
1567  * Get all message processors, validate corresponding plugin existance and
1568  * system configuration
1569  *
1570  * @param bool $ready only return ready-to-use processors
1571  * @param bool $reset Reset list of message processors (used in unit tests)
1572  * @param bool $resetonly Just reset, then exit
1573  * @return mixed $processors array of objects containing information on message processors
1574  */
1575 function get_message_processors($ready = false, $reset = false, $resetonly = false) {
1576     global $DB, $CFG;
1578     static $processors;
1579     if ($reset) {
1580         $processors = array();
1582         if ($resetonly) {
1583             return $processors;
1584         }
1585     }
1587     if (empty($processors)) {
1588         // Get all processors, ensure the name column is the first so it will be the array key
1589         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
1590         foreach ($processors as &$processor){
1591             $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1592             if (is_readable($processorfile)) {
1593                 include_once($processorfile);
1594                 $processclass = 'message_output_' . $processor->name;
1595                 if (class_exists($processclass)) {
1596                     $pclass = new $processclass();
1597                     $processor->object = $pclass;
1598                     $processor->configured = 0;
1599                     if ($pclass->is_system_configured()) {
1600                         $processor->configured = 1;
1601                     }
1602                     $processor->hassettings = 0;
1603                     if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1604                         $processor->hassettings = 1;
1605                     }
1606                     $processor->available = 1;
1607                 } else {
1608                     print_error('errorcallingprocessor', 'message');
1609                 }
1610             } else {
1611                 $processor->available = 0;
1612             }
1613         }
1614     }
1615     if ($ready) {
1616         // Filter out enabled and system_configured processors
1617         $readyprocessors = $processors;
1618         foreach ($readyprocessors as $readyprocessor) {
1619             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
1620                 unset($readyprocessors[$readyprocessor->name]);
1621             }
1622         }
1623         return $readyprocessors;
1624     }
1626     return $processors;
1629 /**
1630  * Get all message providers, validate their plugin existance and
1631  * system configuration
1632  *
1633  * @return mixed $processors array of objects containing information on message processors
1634  */
1635 function get_message_providers() {
1636     global $CFG, $DB;
1638     $pluginman = core_plugin_manager::instance();
1640     $providers = $DB->get_records('message_providers', null, 'name');
1642     // Remove all the providers whose plugins are disabled or don't exist
1643     foreach ($providers as $providerid => $provider) {
1644         $plugin = $pluginman->get_plugin_info($provider->component);
1645         if ($plugin) {
1646             if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
1647                 unset($providers[$providerid]);   // Plugins does not exist
1648                 continue;
1649             }
1650             if ($plugin->is_enabled() === false) {
1651                 unset($providers[$providerid]);   // Plugin disabled
1652                 continue;
1653             }
1654         }
1655     }
1656     return $providers;
1659 /**
1660  * Get an instance of the message_output class for one of the output plugins.
1661  * @param string $type the message output type. E.g. 'email' or 'jabber'.
1662  * @return message_output message_output the requested class.
1663  */
1664 function get_message_processor($type) {
1665     global $CFG;
1667     // Note, we cannot use the get_message_processors function here, becaues this
1668     // code is called during install after installing each messaging plugin, and
1669     // get_message_processors caches the list of installed plugins.
1671     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
1672     if (!is_readable($processorfile)) {
1673         throw new coding_exception('Unknown message processor type ' . $type);
1674     }
1676     include_once($processorfile);
1678     $processclass = 'message_output_' . $type;
1679     if (!class_exists($processclass)) {
1680         throw new coding_exception('Message processor ' . $type .
1681                 ' does not define the right class');
1682     }
1684     return new $processclass();
1687 /**
1688  * Get messaging outputs default (site) preferences
1689  *
1690  * @return object $processors object containing information on message processors
1691  */
1692 function get_message_output_default_preferences() {
1693     return get_config('message');
1696 /**
1697  * Translate message default settings from binary value to the array of string
1698  * representing the settings to be stored. Also validate the provided value and
1699  * use default if it is malformed.
1700  *
1701  * @param  int    $plugindefault Default setting suggested by plugin
1702  * @param  string $processorname The name of processor
1703  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
1704  */
1705 function translate_message_default_setting($plugindefault, $processorname) {
1706     // Preset translation arrays
1707     $permittedvalues = array(
1708         0x04 => 'disallowed',
1709         0x08 => 'permitted',
1710         0x0c => 'forced',
1711     );
1713     $loggedinstatusvalues = array(
1714         0x00 => null, // use null if loggedin/loggedoff is not defined
1715         0x01 => 'loggedin',
1716         0x02 => 'loggedoff',
1717     );
1719     // define the default setting
1720     $processor = get_message_processor($processorname);
1721     $default = $processor->get_default_messaging_settings();
1723     // Validate the value. It should not exceed the maximum size
1724     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
1725         debugging(get_string('errortranslatingdefault', 'message'));
1726         $plugindefault = $default;
1727     }
1728     // Use plugin default setting of 'permitted' is 0
1729     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
1730         $plugindefault = $default;
1731     }
1733     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
1734     $loggedin = $loggedoff = null;
1736     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
1737         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
1738         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
1739     }
1741     return array($permitted, $loggedin, $loggedoff);
1744 /**
1745  * Return a list of page types
1746  * @param string $pagetype current page type
1747  * @param stdClass $parentcontext Block's parent context
1748  * @param stdClass $currentcontext Current context of block
1749  */
1750 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
1751     return array('messages-*'=>get_string('page-message-x', 'message'));
1754 /**
1755  * Get messages sent or/and received by the specified users.
1756  * Please note that this function return deleted messages too.
1757  *
1758  * @param  int      $useridto       the user id who received the message
1759  * @param  int      $useridfrom     the user id who sent the message. -10 or -20 for no-reply or support user
1760  * @param  int      $notifications  1 for retrieving notifications, 0 for messages, -1 for both
1761  * @param  bool     $read           true for retrieving read messages, false for unread
1762  * @param  string   $sort           the column name to order by including optionally direction
1763  * @param  int      $limitfrom      limit from
1764  * @param  int      $limitnum       limit num
1765  * @return external_description
1766  * @since  2.8
1767  */
1768 function message_get_messages($useridto, $useridfrom = 0, $notifications = -1, $read = true,
1769                                 $sort = 'mr.timecreated DESC', $limitfrom = 0, $limitnum = 0) {
1770     global $DB;
1772     $messagetable = $read ? '{message_read}' : '{message}';
1773     $params = array('deleted' => 0);
1775     // Empty useridto means that we are going to retrieve messages send by the useridfrom to any user.
1776     if (empty($useridto)) {
1777         $userfields = get_all_user_name_fields(true, 'u', '', 'userto');
1778         $joinsql = "JOIN {user} u ON u.id = mr.useridto";
1779         $usersql = "mr.useridfrom = :useridfrom AND u.deleted = :deleted";
1780         $params['useridfrom'] = $useridfrom;
1781     } else {
1782         $userfields = get_all_user_name_fields(true, 'u', '', 'userfrom');
1783         // Left join because useridfrom may be -10 or -20 (no-reply and support users).
1784         $joinsql = "LEFT JOIN {user} u ON u.id = mr.useridfrom";
1785         $usersql = "mr.useridto = :useridto AND (u.deleted IS NULL OR u.deleted = :deleted)";
1786         $params['useridto'] = $useridto;
1787         if (!empty($useridfrom)) {
1788             $usersql .= " AND mr.useridfrom = :useridfrom";
1789             $params['useridfrom'] = $useridfrom;
1790         }
1791     }
1793     // Now, if retrieve notifications, conversations or both.
1794     $typesql = "";
1795     if ($notifications !== -1) {
1796         $typesql = "AND mr.notification = :notification";
1797         $params['notification'] = ($notifications) ? 1 : 0;
1798     }
1800     $sql = "SELECT mr.*, $userfields
1801               FROM $messagetable mr
1802                    $joinsql
1803              WHERE $usersql
1804                    $typesql
1805              ORDER BY $sort";
1807     $messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
1808     return $messages;
1811 /**
1812  * Get notifications to and from the specified users.
1813  *
1814  * @param  int      $useridto       the user id who received the notification
1815  * @param  int      $useridfrom     the user id who sent the notification. -10 or -20 for no-reply or support user
1816  * @param  bool     $status         MESSAGE_READ for retrieving read notifications, MESSAGE_UNREAD for unread, empty for both
1817  * @param  string   $sort           the column name to order by including optionally direction
1818  * @param  bool     $embeduserto    embed the to user details in the notification response
1819  * @param  bool     $embeduserfrom  embed the from user details in the notification response
1820  * @param  int      $limit          limit the number of result returned
1821  * @param  int      $offset         offset the result set by this amount
1822  * @return array                    array of notification records
1823  * @since  3.1
1824  */
1825 function message_get_notifications($useridto = 0, $useridfrom = 0, $status = '',
1826     $embeduserto = false, $embeduserfrom = false, $sort = 'DESC', $limit = 0, $offset = 0) {
1827     global $DB;
1829     if (!empty($status) && $status != MESSAGE_READ && $status != MESSAGE_UNREAD) {
1830         throw new moodle_exception(sprintf('invalid parameter: status: must be "%s" or "%s"',
1831             MESSAGE_READ, MESSAGE_UNREAD));
1832     }
1834     $sort = strtoupper($sort);
1835     if ($sort != 'DESC' && $sort != 'ASC') {
1836         throw new moodle_exception('invalid parameter: sort: must be "DESC" or "ASC"');
1837     }
1839     $params = array();
1841     $buildtablesql = function($table, $prefix, $additionalfields) use ($useridto, $useridfrom, $embeduserto, $embeduserfrom) {
1842         $params = array();
1843         $fields = "concat('$prefix', $prefix.id) as uniqueid, $prefix.id, $prefix.useridfrom, $prefix.useridto,
1844             $prefix.subject, $prefix.fullmessage, $prefix.fullmessageformat,
1845             $prefix.fullmessagehtml, $prefix.smallmessage, $prefix.notification, $prefix.contexturl,
1846             $prefix.contexturlname, $prefix.timecreated, $prefix.timeuserfromdeleted, $prefix.timeusertodeleted,
1847             $prefix.component, $prefix.eventtype, $additionalfields";
1848         $where = '';
1849         $joinsql = '';
1851         if (empty($useridto)) {
1852             $where .= " AND $prefix.useridfrom = :{$prefix}useridfrom";
1853             $params["{$prefix}useridfrom"] = $useridfrom;
1854         } else {
1855             $where .= " AND $prefix.useridto = :{$prefix}useridto";
1856             $params["{$prefix}useridto"] = $useridto;
1858             if (!empty($useridfrom)) {
1859                 $where .= " AND $prefix.useridfrom = :{$prefix}useridfrom";
1860                 $params["{$prefix}useridfrom"] = $useridfrom;
1861             }
1862         }
1864         if ($embeduserto) {
1865             $embedprefix = "{$prefix}ut";
1866             $fields .= ", " . get_all_user_name_fields(true, $embedprefix, '', 'userto');
1867             $joinsql .= " LEFT JOIN {user} $embedprefix ON $embedprefix.id = $prefix.useridto";
1868         }
1870         if ($embeduserfrom) {
1871             $embedprefix = "{$prefix}uf";
1872             $fields .= ", " . get_all_user_name_fields(true, $embedprefix, '', 'userfrom');
1873             $joinsql .= " LEFT JOIN {user} $embedprefix ON $embedprefix.id = $prefix.useridfrom";
1874         }
1876         return array(sprintf("SELECT %s FROM %s %s %s WHERE %s.notification = 1 %s", $fields, $table, $prefix, $joinsql, $prefix, $where), $params);
1877     };
1879     $sql = '';
1880     switch ($status) {
1881         case MESSAGE_READ:
1882             list($sql, $readparams) = $buildtablesql('{message_read}', 'r', 'r.timeread');
1883             $params = array_merge($params, $readparams);
1884             break;
1885         case MESSAGE_UNREAD:
1886             list($sql, $unreadparams) = $buildtablesql('{message}', 'u', '0 as timeread');
1887             $params = array_merge($params, $unreadparams);
1888             break;
1889         default:
1890             list($readsql, $readparams) = $buildtablesql('{message_read}', 'r', 'r.timeread');
1891             list($unreadsql, $unreadparams) = $buildtablesql('{message}', 'u', '0 as timeread');
1892             $sql = sprintf("SELECT * FROM (%s UNION %s) f", $readsql, $unreadsql);
1893             $params = array_merge($params, $readparams, $unreadparams);
1894     }
1896     $sql .= " ORDER BY timecreated $sort, timeread $sort, id $sort";
1898     return array_values($DB->get_records_sql($sql, $params, $offset, $limit));
1901 /**
1902  * Count the unread notifications for a user.
1903  *
1904  * @param  int      $useridto       the user id who received the notification
1905  * @param  int      $useridfrom     the user id who sent the notification. -10 or -20 for no-reply or support user
1906  * @return int                      count of the unread notifications
1907  * @since  3.1
1908  */
1909 function message_count_unread_notifications($useridto = 0, $useridfrom = 0) {
1910     global $USER, $DB;
1912     if (empty($useridto)) {
1913         $useridto = $USER->id;
1914     }
1916     if (!empty($useridfrom)) {
1917         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ? AND notification = 1",
1918             array($useridto, $useridfrom), "COUNT('id')");
1919     } else {
1920         return $DB->count_records_select('message', "useridto = ? AND notification = 1",
1921             array($useridto), "COUNT('id')");
1922     }
1925 /**
1926  * Requires the JS libraries to send a message using a dialog.
1927  *
1928  * @return void
1929  */
1930 function message_messenger_requirejs() {
1931     global $PAGE;
1933     static $done = false;
1934     if ($done) {
1935         return;
1936     }
1938     $PAGE->requires->yui_module(
1939         array('moodle-core_message-messenger'),
1940         'Y.M.core_message.messenger.init',
1941         array(array())
1942     );
1943     $PAGE->requires->strings_for_js(array(
1944         'errorwhilesendingmessage',
1945         'messagesent',
1946         'messagetosend',
1947         'sendingmessage',
1948         'sendmessage',
1949         'viewconversation',
1950     ), 'core_message');
1951     $PAGE->requires->strings_for_js(array(
1952         'userisblockingyou',
1953         'userisblockingyounoncontact'
1954     ), 'message');
1955     $PAGE->requires->string_for_js('error', 'core');
1957     $done = true;
1960 /**
1961  * Requires the JS libraries for the toggle contact button.
1962  *
1963  * @return void
1964  */
1965 function message_togglecontact_requirejs() {
1966     global $PAGE;
1968     static $done = false;
1969     if ($done) {
1970         return;
1971     }
1973     $PAGE->requires->js_call_amd('message/toggle_contact_button', 'enhance', array('#toggle-contact-button'));
1974     $done = true;
1977 /**
1978  * Returns the attributes to place on a link to open the 'Send message' dialog.
1979  *
1980  * @param object $user User object.
1981  * @return void
1982  */
1983 function message_messenger_sendmessage_link_params($user) {
1984     $params = array(
1985         'data-trigger' => 'core_message-messenger::sendmessage',
1986         'data-fullname' => fullname($user),
1987         'data-userid' => $user->id,
1988         'role' => 'button'
1989     );
1991     if (message_is_user_non_contact_blocked($user)) {
1992         $params['data-blocked-string'] = 'userisblockingyounoncontact';
1993     } else if (message_is_user_blocked($user)) {
1994         $params['data-blocked-string'] = 'userisblockingyou';
1995     }
1997     return $params;
2000 /**
2001  * Returns the attributes to place on a contact button.
2002  *
2003  * @param object $user User object.
2004  * @param bool $iscontact
2005  * @return void
2006  */
2007 function message_togglecontact_link_params($user, $iscontact = false) {
2008     $params = array(
2009         'data-userid' => $user->id,
2010         'data-is-contact' => $iscontact,
2011         'id' => 'toggle-contact-button',
2012         'role' => 'button',
2013         'class' => 'ajax-contact-button',
2014     );
2016     return $params;
2019 /**
2020  * Determines if a user is permitted to send another user a private message.
2021  * If no sender is provided then it defaults to the logged in user.
2022  *
2023  * @param object $recipient User object.
2024  * @param object $sender User object.
2025  * @return bool true if user is permitted, false otherwise.
2026  */
2027 function message_can_post_message($recipient, $sender = null) {
2028     global $USER, $DB;
2030     if (is_null($sender)) {
2031         // The message is from the logged in user, unless otherwise specified.
2032         $sender = $USER;
2033     }
2035     if (!has_capability('moodle/site:sendmessage', context_system::instance(), $sender)) {
2036         return false;
2037     }
2039     // The recipient blocks messages from non-contacts and the
2040     // sender isn't a contact.
2041     if (message_is_user_non_contact_blocked($recipient, $sender)) {
2042         return false;
2043     }
2045     // The recipient has specifically blocked this sender.
2046     if (message_is_user_blocked($recipient, $sender)) {
2047         return false;
2048     }
2050     return true;
2053 /**
2054  * Checks if the recipient is allowing messages from users that aren't a
2055  * contact. If not then it checks to make sure the sender is in the
2056  * recipient's contacts.
2057  *
2058  * @param object $recipient User object.
2059  * @param object $sender User object.
2060  * @return bool true if $sender is blocked, false otherwise.
2061  */
2062 function message_is_user_non_contact_blocked($recipient, $sender = null) {
2063     global $USER, $DB;
2065     if (is_null($sender)) {
2066         // The message is from the logged in user, unless otherwise specified.
2067         $sender = $USER;
2068     }
2070     $blockednoncontacts = get_user_preferences('message_blocknoncontacts', '', $recipient->id);
2071     if (!empty($blockednoncontacts)) {
2072         // Confirm the sender is a contact of the recipient.
2073         $exists = $DB->record_exists('message_contacts', array('userid' => $recipient->id, 'contactid' => $sender->id));
2074         if ($exists) {
2075             // All good, the recipient is a contact of the sender.
2076             return false;
2077         } else {
2078             // Oh no, the recipient is not a contact. Looks like we can't send the message.
2079             return true;
2080         }
2081     }
2083     return false;
2086 /**
2087  * Checks if the recipient has specifically blocked the sending user.
2088  *
2089  * Note: This function will always return false if the sender has the
2090  * readallmessages capability at the system context level.
2091  *
2092  * @param object $recipient User object.
2093  * @param object $sender User object.
2094  * @return bool true if $sender is blocked, false otherwise.
2095  */
2096 function message_is_user_blocked($recipient, $sender = null) {
2097     global $USER, $DB;
2099     if (is_null($sender)) {
2100         // The message is from the logged in user, unless otherwise specified.
2101         $sender = $USER;
2102     }
2104     $systemcontext = context_system::instance();
2105     if (has_capability('moodle/site:readallmessages', $systemcontext, $sender)) {
2106         return false;
2107     }
2109     if ($contact = $DB->get_record('message_contacts', array('userid' => $recipient->id, 'contactid' => $sender->id))) {
2110         if ($contact->blocked) {
2111             return true;
2112         }
2113     }
2115     return false;