MDL-63214 message: Add privacy preferences to filter who can message
[moodle.git] / message / classes / api.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  * Contains class used to return information to display for the message area.
19  *
20  * @package    core_message
21  * @copyright  2016 Mark Nelson <markn@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_message;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/lib/messagelib.php');
31 /**
32  * Class used to return information to display for the message area.
33  *
34  * @copyright  2016 Mark Nelson <markn@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class api {
39     /**
40      * The action for reading a message.
41      */
42     const MESSAGE_ACTION_READ = 1;
44     /**
45      * The action for deleting a message.
46      */
47     const MESSAGE_ACTION_DELETED = 2;
49     /**
50      * The privacy setting for being messaged by anyone within courses user is member of.
51      */
52     const MESSAGE_PRIVACY_COURSEMEMBER = 0;
54     /**
55      * The privacy setting for being messaged only by contacts.
56      */
57     const MESSAGE_PRIVACY_ONLYCONTACTS = 1;
59     /**
60      * The privacy setting for being messaged by anyone on the site.
61      */
62     const MESSAGE_PRIVACY_SITE = 2;
64     /**
65      * Handles searching for messages in the message area.
66      *
67      * @param int $userid The user id doing the searching
68      * @param string $search The string the user is searching
69      * @param int $limitfrom
70      * @param int $limitnum
71      * @return array
72      */
73     public static function search_messages($userid, $search, $limitfrom = 0, $limitnum = 0) {
74         global $DB;
76         // Get the user fields we want.
77         $ufields = \user_picture::fields('u', array('lastaccess'), 'userfrom_id', 'userfrom_');
78         $ufields2 = \user_picture::fields('u2', array('lastaccess'), 'userto_id', 'userto_');
80         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto, m.subject, m.fullmessage, m.fullmessagehtml, m.fullmessageformat,
81                        m.smallmessage, m.timecreated, 0 as isread, $ufields, mub.id as userfrom_blocked, $ufields2,
82                        mub2.id as userto_blocked
83                   FROM {messages} m
84             INNER JOIN {user} u
85                     ON u.id = m.useridfrom
86             INNER JOIN {message_conversations} mc
87                     ON mc.id = m.conversationid
88             INNER JOIN {message_conversation_members} mcm
89                     ON mcm.conversationid = m.conversationid
90             INNER JOIN {user} u2
91                     ON u2.id = mcm.userid
92              LEFT JOIN {message_users_blocked} mub
93                     ON (mub.blockeduserid = u.id AND mub.userid = ?)
94              LEFT JOIN {message_users_blocked} mub2
95                     ON (mub2.blockeduserid = u2.id AND mub2.userid = ?)
96              LEFT JOIN {message_user_actions} mua
97                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
98                  WHERE (m.useridfrom = ? OR mcm.userid = ?)
99                    AND m.useridfrom != mcm.userid
100                    AND u.deleted = 0
101                    AND u2.deleted = 0
102                    AND mua.id is NULL
103                    AND " . $DB->sql_like('smallmessage', '?', false) . "
104               ORDER BY timecreated DESC";
106         $params = array($userid, $userid, $userid, self::MESSAGE_ACTION_DELETED, $userid, $userid, '%' . $search . '%');
108         // Convert the messages into searchable contacts with their last message being the message that was searched.
109         $conversations = array();
110         if ($messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
111             foreach ($messages as $message) {
112                 $prefix = 'userfrom_';
113                 if ($userid == $message->useridfrom) {
114                     $prefix = 'userto_';
115                     // If it from the user, then mark it as read, even if it wasn't by the receiver.
116                     $message->isread = true;
117                 }
118                 $blockedcol = $prefix . 'blocked';
119                 $message->blocked = $message->$blockedcol ? 1 : 0;
121                 $message->messageid = $message->id;
122                 $conversations[] = helper::create_contact($message, $prefix);
123             }
124         }
126         return $conversations;
127     }
129     /**
130      * Handles searching for user in a particular course in the message area.
131      *
132      * @param int $userid The user id doing the searching
133      * @param int $courseid The id of the course we are searching in
134      * @param string $search The string the user is searching
135      * @param int $limitfrom
136      * @param int $limitnum
137      * @return array
138      */
139     public static function search_users_in_course($userid, $courseid, $search, $limitfrom = 0, $limitnum = 0) {
140         global $DB;
142         // Get all the users in the course.
143         list($esql, $params) = get_enrolled_sql(\context_course::instance($courseid), '', 0, true);
144         $sql = "SELECT u.*, mub.id as isblocked
145                   FROM {user} u
146                   JOIN ($esql) je
147                     ON je.id = u.id
148              LEFT JOIN {message_users_blocked} mub
149                     ON (mub.blockeduserid = u.id AND mub.userid = :userid)
150                  WHERE u.deleted = 0";
151         // Add more conditions.
152         $fullname = $DB->sql_fullname();
153         $sql .= " AND u.id != :userid2
154                   AND " . $DB->sql_like($fullname, ':search', false) . "
155              ORDER BY " . $DB->sql_fullname();
156         $params = array_merge(array('userid' => $userid, 'userid2' => $userid, 'search' => '%' . $search . '%'), $params);
158         // Convert all the user records into contacts.
159         $contacts = array();
160         if ($users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
161             foreach ($users as $user) {
162                 $user->blocked = $user->isblocked ? 1 : 0;
163                 $contacts[] = helper::create_contact($user);
164             }
165         }
167         return $contacts;
168     }
170     /**
171      * Handles searching for user in the message area.
172      *
173      * @param int $userid The user id doing the searching
174      * @param string $search The string the user is searching
175      * @param int $limitnum
176      * @return array
177      */
178     public static function search_users($userid, $search, $limitnum = 0) {
179         global $CFG, $DB;
181         // Used to search for contacts.
182         $fullname = $DB->sql_fullname();
183         $ufields = \user_picture::fields('u', array('lastaccess'));
185         // Users not to include.
186         $excludeusers = array($userid, $CFG->siteguest);
187         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
189         // Ok, let's search for contacts first.
190         $contacts = array();
191         $sql = "SELECT $ufields, mub.id as isuserblocked
192                   FROM {user} u
193                   JOIN {message_contacts} mc
194                     ON u.id = mc.contactid
195              LEFT JOIN {message_users_blocked} mub
196                     ON (mub.userid = :userid2 AND mub.blockeduserid = u.id)
197                  WHERE mc.userid = :userid
198                    AND u.deleted = 0
199                    AND u.confirmed = 1
200                    AND " . $DB->sql_like($fullname, ':search', false) . "
201                    AND u.id $exclude
202               ORDER BY " . $DB->sql_fullname();
203         if ($users = $DB->get_records_sql($sql, array('userid' => $userid, 'userid2' => $userid,
204                 'search' => '%' . $search . '%') + $excludeparams, 0, $limitnum)) {
205             foreach ($users as $user) {
206                 $user->blocked = $user->isuserblocked ? 1 : 0;
207                 $contacts[] = helper::create_contact($user);
208             }
209         }
211         // Now, let's get the courses.
212         // Make sure to limit searches to enrolled courses.
213         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
214         $courses = array();
215         // Really we want the user to be able to view the participants if they have the capability
216         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
217         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
218         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
219         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
220                 array('moodle/course:viewparticipants'))) {
221             foreach ($arrcourses as $course) {
222                 if (isset($enrolledcourses[$course->id])) {
223                     $data = new \stdClass();
224                     $data->id = $course->id;
225                     $data->shortname = $course->shortname;
226                     $data->fullname = $course->fullname;
227                     $courses[] = $data;
228                 }
229             }
230         }
232         // Let's get those non-contacts. Toast them gears boi.
233         // Note - you can only block contacts, so these users will not be blocked, so no need to get that
234         // extra detail from the database.
235         $noncontacts = array();
236         $sql = "SELECT $ufields
237                   FROM {user} u
238                  WHERE u.deleted = 0
239                    AND u.confirmed = 1
240                    AND " . $DB->sql_like($fullname, ':search', false) . "
241                    AND u.id $exclude
242                    AND u.id NOT IN (SELECT contactid
243                                       FROM {message_contacts}
244                                      WHERE userid = :userid)
245               ORDER BY " . $DB->sql_fullname();
246         if ($users = $DB->get_records_sql($sql,  array('userid' => $userid, 'search' => '%' . $search . '%') + $excludeparams,
247                 0, $limitnum)) {
248             foreach ($users as $user) {
249                 $noncontacts[] = helper::create_contact($user);
250             }
251         }
253         return array($contacts, $courses, $noncontacts);
254     }
256     /**
257      * Returns the contacts and their conversation to display in the contacts area.
258      *
259      * ** WARNING **
260      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
261      * to retrieve too much information in a single call will cause performance problems.
262      * ** WARNING **
263      *
264      * This function has specifically been altered to break each of the data sets it
265      * requires into separate database calls. This is to avoid the performance problems
266      * observed when attempting to join large data sets (e.g. the message tables and
267      * the user table).
268      *
269      * While it is possible to gather the data in a single query, and it may even be
270      * more efficient with a correctly tuned database, we have opted to trade off some of
271      * the benefits of a single query in order to ensure this function will work on
272      * most databases with default tunings and with large data sets.
273      *
274      * @param int $userid The user id
275      * @param int $limitfrom
276      * @param int $limitnum
277      * @return array
278      */
279     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20) {
280         global $DB;
282         // Get the last message from each conversation that the user belongs to.
283         $sql = "SELECT m.id, m.conversationid, m.useridfrom, mcm2.userid as useridto, m.smallmessage, m.timecreated
284                   FROM {messages} m
285             INNER JOIN (
286                           SELECT MAX(m.id) AS messageid
287                             FROM {messages} m
288                       INNER JOIN (
289                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
290                                         FROM {messages} m
291                                   INNER JOIN {message_conversation_members} mcm
292                                           ON mcm.conversationid = m.conversationid
293                                    LEFT JOIN {message_user_actions} mua
294                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
295                                        WHERE mua.id is NULL
296                                          AND mcm.userid = :userid2
297                                     GROUP BY m.conversationid
298                                  ) maxmessage
299                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
300                          GROUP BY m.conversationid
301                        ) lastmessage
302                     ON lastmessage.messageid = m.id
303             INNER JOIN {message_conversation_members} mcm
304                     ON mcm.conversationid = m.conversationid
305             INNER JOIN {message_conversation_members} mcm2
306                     ON mcm2.conversationid = m.conversationid
307                  WHERE mcm.userid = m.useridfrom
308                    AND mcm.id != mcm2.id
309               ORDER BY m.timecreated DESC";
310         $messageset = $DB->get_recordset_sql($sql, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
311             'userid2' => $userid], $limitfrom, $limitnum);
313         $messages = [];
314         foreach ($messageset as $message) {
315             $messages[$message->id] = $message;
316         }
317         $messageset->close();
319         // If there are no messages return early.
320         if (empty($messages)) {
321             return [];
322         }
324         // We need to pull out the list of other users that are part of each of these conversations. This
325         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
326         // tables because on large sites these tables are massive which results in extremely slow
327         // performance (typically due to join buffer exhaustion).
328         $otheruserids = array_map(function($message) use ($userid) {
329             return ($message->useridfrom == $userid) ? $message->useridto : $message->useridfrom;
330         }, array_values($messages));
332         // Ok, let's get the other members in the conversations.
333         list($useridsql, $usersparams) = $DB->get_in_or_equal($otheruserids);
334         $userfields = \user_picture::fields('u', array('lastaccess'));
335         $userssql = "SELECT $userfields
336                        FROM {user} u
337                       WHERE id $useridsql
338                         AND deleted = 0";
339         $otherusers = $DB->get_records_sql($userssql, $usersparams);
341         // If there are no other users (user may have been deleted), then do not continue.
342         if (empty($otherusers)) {
343             return [];
344         }
346         $contactssql = "SELECT contactid
347                           FROM {message_contacts}
348                          WHERE userid = ?
349                            AND contactid $useridsql";
350         $contacts = $DB->get_records_sql($contactssql, array_merge([$userid], $usersparams));
352         // Finally, let's get the unread messages count for this user so that we can add them
353         // to the conversation. Remember we need to ignore the messages the user sent.
354         $unreadcountssql = 'SELECT m.useridfrom, count(m.id) as count
355                               FROM {messages} m
356                         INNER JOIN {message_conversations} mc
357                                 ON mc.id = m.conversationid
358                         INNER JOIN {message_conversation_members} mcm
359                                 ON m.conversationid = mcm.conversationid
360                          LEFT JOIN {message_user_actions} mua
361                                 ON (mua.messageid = m.id AND mua.userid = ? AND
362                                    (mua.action = ? OR mua.action = ?))
363                              WHERE mcm.userid = ?
364                                AND m.useridfrom != ?
365                                AND mua.id is NULL
366                           GROUP BY useridfrom';
367         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
368             $userid, $userid]);
370         // Get rid of the table prefix.
371         $userfields = str_replace('u.', '', $userfields);
372         $userproperties = explode(',', $userfields);
373         $arrconversations = array();
374         foreach ($messages as $message) {
375             $conversation = new \stdClass();
376             $otheruserid = ($message->useridfrom == $userid) ? $message->useridto : $message->useridfrom;
377             $otheruser = isset($otherusers[$otheruserid]) ? $otherusers[$otheruserid] : null;
378             $contact = isset($contacts[$otheruserid]) ? $contacts[$otheruserid] : null;
380             // It's possible the other user was deleted, so, skip.
381             if (is_null($otheruser)) {
382                 continue;
383             }
385             // Add the other user's information to the conversation, if we have one.
386             foreach ($userproperties as $prop) {
387                 $conversation->$prop = ($otheruser) ? $otheruser->$prop : null;
388             }
390             // Add the contact's information, if we have one.
391             $conversation->blocked = ($contact) ? $contact->blocked : null;
393             // Add the message information.
394             $conversation->messageid = $message->id;
395             $conversation->smallmessage = $message->smallmessage;
396             $conversation->useridfrom = $message->useridfrom;
398             // Only consider it unread if $user has unread messages.
399             if (isset($unreadcounts[$otheruserid])) {
400                 $conversation->isread = false;
401                 $conversation->unreadcount = $unreadcounts[$otheruserid]->count;
402             } else {
403                 $conversation->isread = true;
404             }
406             $arrconversations[$otheruserid] = helper::create_contact($conversation);
407         }
409         return $arrconversations;
410     }
412     /**
413      * Returns the contacts to display in the contacts area.
414      *
415      * @param int $userid The user id
416      * @param int $limitfrom
417      * @param int $limitnum
418      * @return array
419      */
420     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
421         global $DB;
423         $contactids = [];
424         $sql = "SELECT mc.*
425                   FROM {message_contacts} mc
426                  WHERE mc.userid = ? OR mc.contactid = ?
427               ORDER BY timecreated DESC";
428         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
429             foreach ($contacts as $contact) {
430                 if ($userid == $contact->userid) {
431                     $contactids[] = $contact->contactid;
432                 } else {
433                     $contactids[] = $contact->userid;
434                 }
435             }
436         }
438         if (!empty($contactids)) {
439             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
441             $sql = "SELECT u.*, mub.id as isblocked
442                       FROM {user} u
443                  LEFT JOIN {message_users_blocked} mub
444                         ON u.id = mub.blockeduserid
445                      WHERE u.id $insql";
446             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
447                 $arrcontacts = [];
448                 foreach ($contacts as $contact) {
449                     $contact->blocked = $contact->isblocked ? 1 : 0;
450                     $arrcontacts[] = helper::create_contact($contact);
451                 }
453                 return $arrcontacts;
454             }
455         }
457         return [];
458     }
460     /**
461      * Returns the an array of the users the given user is in a conversation
462      * with who are a contact and the number of unread messages.
463      *
464      * @param int $userid The user id
465      * @param int $limitfrom
466      * @param int $limitnum
467      * @return array
468      */
469     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
470         global $DB;
472         $userfields = \user_picture::fields('u', array('lastaccess'));
473         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
474                               FROM {message_contacts} mc
475                         INNER JOIN {user} u
476                                 ON (u.id = mc.contactid OR u.id = mc.userid)
477                          LEFT JOIN {messages} m
478                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
479                          LEFT JOIN {message_conversation_members} mcm
480                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
481                          LEFT JOIN {message_user_actions} mua
482                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
483                          LEFT JOIN {message_users_blocked} mub
484                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
485                              WHERE mua.id is NULL
486                                AND mub.id is NULL
487                                AND (mc.userid = ? OR mc.contactid = ?)
488                                AND u.id != ?
489                                AND u.deleted = 0
490                           GROUP BY $userfields";
492         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
493             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
494     }
496     /**
497      * Returns the an array of the users the given user is in a conversation
498      * with who are not a contact and the number of unread messages.
499      *
500      * @param int $userid The user id
501      * @param int $limitfrom
502      * @param int $limitnum
503      * @return array
504      */
505     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
506         global $DB;
508         $userfields = \user_picture::fields('u', array('lastaccess'));
509         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
510                               FROM {user} u
511                         INNER JOIN {messages} m
512                                 ON m.useridfrom = u.id
513                         INNER JOIN {message_conversation_members} mcm
514                                 ON mcm.conversationid = m.conversationid
515                          LEFT JOIN {message_user_actions} mua
516                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
517                          LEFT JOIN {message_contacts} mc
518                                 ON (mc.userid = ? AND mc.contactid = u.id)
519                          LEFT JOIN {message_users_blocked} mub
520                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
521                              WHERE mcm.userid = ?
522                                AND mcm.userid != m.useridfrom
523                                AND mua.id is NULL
524                                AND mub.id is NULL
525                                AND mc.id is NULL
526                                AND u.deleted = 0
527                           GROUP BY $userfields";
529         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
530             $limitfrom, $limitnum);
531     }
533     /**
534      * Returns the messages to display in the message area.
535      *
536      * @param int $userid the current user
537      * @param int $otheruserid the other user
538      * @param int $limitfrom
539      * @param int $limitnum
540      * @param string $sort
541      * @param int $timefrom the time from the message being sent
542      * @param int $timeto the time up until the message being sent
543      * @return array
544      */
545     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
546         $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
548         if (!empty($timefrom)) {
549             // Check the cache to see if we even need to do a DB query.
550             $cache = \cache::make('core', 'message_time_last_message_between_users');
551             $key = helper::get_last_message_time_created_cache_key($otheruserid, $userid);
552             $lastcreated = $cache->get($key);
554             // The last known message time is earlier than the one being requested so we can
555             // just return an empty result set rather than having to query the DB.
556             if ($lastcreated && $lastcreated < $timefrom) {
557                 return [];
558             }
559         }
561         $arrmessages = array();
562         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
563                                              $sort, $timefrom, $timeto)) {
565             $arrmessages = helper::create_messages($userid, $messages);
566         }
568         return $arrmessages;
569     }
571     /**
572      * Returns the most recent message between two users.
573      *
574      * @param int $userid the current user
575      * @param int $otheruserid the other user
576      * @return \stdClass|null
577      */
578     public static function get_most_recent_message($userid, $otheruserid) {
579         // We want two messages here so we get an accurate 'blocktime' value.
580         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
581             // Swap the order so we now have them in historical order.
582             $messages = array_reverse($messages);
583             $arrmessages = helper::create_messages($userid, $messages);
584             return array_pop($arrmessages);
585         }
587         return null;
588     }
590     /**
591      * Returns the profile information for a contact for a user.
592      *
593      * @param int $userid The user id
594      * @param int $otheruserid The id of the user whose profile we want to view.
595      * @return \stdClass
596      */
597     public static function get_profile($userid, $otheruserid) {
598         global $CFG, $PAGE;
600         require_once($CFG->dirroot . '/user/lib.php');
602         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
604         // Create the data we are going to pass to the renderable.
605         $data = new \stdClass();
606         $data->userid = $otheruserid;
607         $data->fullname = fullname($user);
608         $data->city = '';
609         $data->country = '';
610         $data->email = '';
611         $data->isonline = null;
612         // Get the user picture data - messaging has always shown these to the user.
613         $userpicture = new \user_picture($user);
614         $userpicture->size = 1; // Size f1.
615         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
616         $userpicture->size = 0; // Size f2.
617         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
619         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
620         if ($userfields) {
621             if (isset($userfields['city'])) {
622                 $data->city = $userfields['city'];
623             }
624             if (isset($userfields['country'])) {
625                 $data->country = $userfields['country'];
626             }
627             if (isset($userfields['email'])) {
628                 $data->email = $userfields['email'];
629             }
630             if (isset($userfields['lastaccess'])) {
631                 $data->isonline = helper::is_online($userfields['lastaccess']);
632             }
633         }
635         $data->isblocked = self::is_blocked($userid, $otheruserid);
636         $data->iscontact = self::is_contact($userid, $otheruserid);
638         return $data;
639     }
641     /**
642      * Checks if a user can delete messages they have either received or sent.
643      *
644      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
645      *  but will still seem as if it was by the user)
646      * @return bool Returns true if a user can delete the conversation, false otherwise.
647      */
648     public static function can_delete_conversation($userid) {
649         global $USER;
651         $systemcontext = \context_system::instance();
653         // Let's check if the user is allowed to delete this conversation.
654         if (has_capability('moodle/site:deleteanymessage', $systemcontext) ||
655             ((has_capability('moodle/site:deleteownmessage', $systemcontext) &&
656                 $USER->id == $userid))) {
657             return true;
658         }
660         return false;
661     }
663     /**
664      * Deletes a conversation.
665      *
666      * This function does not verify any permissions.
667      *
668      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
669      *  but will still seem as if it was by the user)
670      * @param int $otheruserid The id of the other user in the conversation
671      * @return bool
672      */
673     public static function delete_conversation($userid, $otheruserid) {
674         global $DB, $USER;
676         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
678         // If there is no conversation, there is nothing to do.
679         if (!$conversationid) {
680             return true;
681         }
683         // Get all messages belonging to this conversation that have not already been deleted by this user.
684         $sql = "SELECT m.*
685                  FROM {messages} m
686            INNER JOIN {message_conversations} mc
687                    ON m.conversationid = mc.id
688             LEFT JOIN {message_user_actions} mua
689                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
690                 WHERE mua.id is NULL
691                   AND mc.id = ?
692              ORDER BY m.timecreated ASC";
693         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
695         // Ok, mark these as deleted.
696         foreach ($messages as $message) {
697             $mua = new \stdClass();
698             $mua->userid = $userid;
699             $mua->messageid = $message->id;
700             $mua->action = self::MESSAGE_ACTION_DELETED;
701             $mua->timecreated = time();
702             $mua->id = $DB->insert_record('message_user_actions', $mua);
704             if ($message->useridfrom == $userid) {
705                 $useridto = $otheruserid;
706             } else {
707                 $useridto = $userid;
708             }
709             \core\event\message_deleted::create_from_ids($message->useridfrom, $useridto,
710                 $USER->id, $message->id, $mua->id)->trigger();
711         }
713         return true;
714     }
716     /**
717      * Returns the count of unread conversations (collection of messages from a single user) for
718      * the given user.
719      *
720      * @param \stdClass $user the user who's conversations should be counted
721      * @return int the count of the user's unread conversations
722      */
723     public static function count_unread_conversations($user = null) {
724         global $USER, $DB;
726         if (empty($user)) {
727             $user = $USER;
728         }
730         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
731                   FROM {messages} m
732             INNER JOIN {message_conversations} mc
733                     ON m.conversationid = mc.id
734             INNER JOIN {message_conversation_members} mcm
735                     ON mc.id = mcm.conversationid
736              LEFT JOIN {message_user_actions} mua
737                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
738                  WHERE mcm.userid = ?
739                    AND mcm.userid != m.useridfrom
740                    AND mua.id is NULL";
742         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
743     }
745     /**
746      * Marks all messages being sent to a user in a particular conversation.
747      *
748      * If $conversationdid is null then it marks all messages as read sent to $userid.
749      *
750      * @param int $userid
751      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
752      */
753     public static function mark_all_messages_as_read($userid, $conversationid = null) {
754         global $DB;
756         $messagesql = "SELECT m.*
757                          FROM {messages} m
758                    INNER JOIN {message_conversations} mc
759                            ON mc.id = m.conversationid
760                    INNER JOIN {message_conversation_members} mcm
761                            ON mcm.conversationid = mc.id
762                     LEFT JOIN {message_user_actions} mua
763                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
764                         WHERE mua.id is NULL
765                           AND mcm.userid = ?
766                           AND m.useridfrom != ?";
767         $messageparams = [];
768         $messageparams[] = $userid;
769         $messageparams[] = self::MESSAGE_ACTION_READ;
770         $messageparams[] = $userid;
771         $messageparams[] = $userid;
772         if (!is_null($conversationid)) {
773             $messagesql .= " AND mc.id = ?";
774             $messageparams[] = $conversationid;
775         }
777         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
778         foreach ($messages as $message) {
779             self::mark_message_as_read($userid, $message);
780         }
781         $messages->close();
782     }
784     /**
785      * Marks all notifications being sent from one user to another user as read.
786      *
787      * If the from user is null then it marks all notifications as read sent to the to user.
788      *
789      * @param int $touserid the id of the message recipient
790      * @param int|null $fromuserid the id of the message sender, null if all messages
791      * @return void
792      */
793     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
794         global $DB;
796         $notificationsql = "SELECT n.*
797                               FROM {notifications} n
798                              WHERE useridto = ?
799                                AND timeread is NULL";
800         $notificationsparams = [$touserid];
801         if (!empty($fromuserid)) {
802             $notificationsql .= " AND useridfrom = ?";
803             $notificationsparams[] = $fromuserid;
804         }
806         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
807         foreach ($notifications as $notification) {
808             self::mark_notification_as_read($notification);
809         }
810         $notifications->close();
811     }
813     /**
814      * Marks ALL messages being sent from $fromuserid to $touserid as read.
815      *
816      * Can be filtered by type.
817      *
818      * @deprecated since 3.5
819      * @param int $touserid the id of the message recipient
820      * @param int $fromuserid the id of the message sender
821      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
822      * @return void
823      */
824     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
825         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
826             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
827             DEBUG_DEVELOPER);
829         $type = strtolower($type);
831         $conversationid = null;
832         $ignoremessages = false;
833         if (!empty($fromuserid)) {
834             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
835             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
836                 $ignoremessages = true;
837             }
838         }
840         if (!empty($type)) {
841             if ($type == MESSAGE_TYPE_NOTIFICATION) {
842                 self::mark_all_notifications_as_read($touserid, $fromuserid);
843             } else if ($type == MESSAGE_TYPE_MESSAGE) {
844                 if (!$ignoremessages) {
845                     self::mark_all_messages_as_read($touserid, $conversationid);
846                 }
847             }
848         } else { // We want both.
849             self::mark_all_notifications_as_read($touserid, $fromuserid);
850             if (!$ignoremessages) {
851                 self::mark_all_messages_as_read($touserid, $conversationid);
852             }
853         }
854     }
856     /**
857      * Returns message preferences.
858      *
859      * @param array $processors
860      * @param array $providers
861      * @param \stdClass $user
862      * @return \stdClass
863      * @since 3.2
864      */
865     public static function get_all_message_preferences($processors, $providers, $user) {
866         $preferences = helper::get_providers_preferences($providers, $user->id);
867         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
869         // For every processors put its options on the form (need to get function from processor's lib.php).
870         foreach ($processors as $processor) {
871             $processor->object->load_data($preferences, $user->id);
872         }
874         // Load general messaging preferences.
875         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
876         $preferences->mailformat = $user->mailformat;
877         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
879         return $preferences;
880     }
882     /**
883      * Count the number of users blocked by a user.
884      *
885      * @param \stdClass $user The user object
886      * @return int the number of blocked users
887      */
888     public static function count_blocked_users($user = null) {
889         global $USER, $DB;
891         if (empty($user)) {
892             $user = $USER;
893         }
895         $sql = "SELECT count(mub.id)
896                   FROM {message_users_blocked} mub
897                  WHERE mub.userid = :userid";
898         return $DB->count_records_sql($sql, array('userid' => $user->id));
899     }
901     /**
902      * Determines if a user is permitted to send another user a private message.
903      * If no sender is provided then it defaults to the logged in user.
904      *
905      * @param \stdClass $recipient The user object.
906      * @param \stdClass|null $sender The user object.
907      * @return bool true if user is permitted, false otherwise.
908      */
909     public static function can_post_message($recipient, $sender = null) {
910         global $USER;
912         if (is_null($sender)) {
913             // The message is from the logged in user, unless otherwise specified.
914             $sender = $USER;
915         }
917         if (!has_capability('moodle/site:sendmessage', \context_system::instance(), $sender)) {
918             return false;
919         }
921         // The recipient blocks messages from non-contacts and the
922         // sender isn't a contact.
923         if (self::is_user_non_contact_blocked($recipient, $sender)) {
924             return false;
925         }
927         $senderid = null;
928         if ($sender !== null && isset($sender->id)) {
929             $senderid = $sender->id;
930         }
932         $systemcontext = \context_system::instance();
933         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
934             return true;
935         }
937         // The recipient has specifically blocked this sender.
938         if (self::is_blocked($recipient->id, $senderid)) {
939             return false;
940         }
942         return true;
943     }
945     /**
946      * Get the messaging preference for a user.
947      * If the user has not any messaging privacy preference:
948      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
949      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
950      *
951      * @param  int    $userid The user identifier.
952      * @return int    The default messaging preference.
953      */
954     public static function get_user_privacy_messaging_preference(int $userid) : int {
955         global $CFG;
957         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
958         // otherwise, the default value will be "My contacts and anyone in my courses".
959         if (empty($CFG->messagingallusers)) {
960             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
961         } else {
962             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
963         }
964         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
966         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
967         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
968         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
969             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
970         }
972         return $privacypreference;
973     }
975     /**
976      * Checks if the recipient is allowing messages from users that aren't a
977      * contact. If not then it checks to make sure the sender is in the
978      * recipient's contacts.
979      *
980      * @param \stdClass $recipient The user object.
981      * @param \stdClass|null $sender The user object.
982      * @return bool true if $sender is blocked, false otherwise.
983      */
984     public static function is_user_non_contact_blocked($recipient, $sender = null) {
985         global $USER, $CFG;
987         if (is_null($sender)) {
988             // The message is from the logged in user, unless otherwise specified.
989             $sender = $USER;
990         }
992         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
993         switch ($privacypreference) {
994             case self::MESSAGE_PRIVACY_SITE:
995                 if (!empty($CFG->messagingallusers)) {
996                     // Users can be messaged without being contacts or members of the same course.
997                     break;
998                 }
999                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1000                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1001             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1002                 // Confirm the sender and the recipient are both members of the same course.
1003                 if (enrol_sharing_course($recipient, $sender)) {
1004                     // All good, the recipient and the sender are members of the same course.
1005                     return false;
1006                 }
1007             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1008                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1009                 return !self::is_contact($sender->id, $recipient->id);
1010         }
1012         return false;
1013     }
1015     /**
1016      * Checks if the recipient has specifically blocked the sending user.
1017      *
1018      * Note: This function will always return false if the sender has the
1019      * readallmessages capability at the system context level.
1020      *
1021      * @deprecated since 3.6
1022      * @param int $recipientid User ID of the recipient.
1023      * @param int $senderid User ID of the sender.
1024      * @return bool true if $sender is blocked, false otherwise.
1025      */
1026     public static function is_user_blocked($recipientid, $senderid = null) {
1027         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1028             DEBUG_DEVELOPER);
1030         global $USER;
1032         if (is_null($senderid)) {
1033             // The message is from the logged in user, unless otherwise specified.
1034             $senderid = $USER->id;
1035         }
1037         $systemcontext = \context_system::instance();
1038         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1039             return false;
1040         }
1042         if (self::is_blocked($recipientid, $senderid)) {
1043             return true;
1044         }
1046         return false;
1047     }
1049     /**
1050      * Get specified message processor, validate corresponding plugin existence and
1051      * system configuration.
1052      *
1053      * @param string $name  Name of the processor.
1054      * @param bool $ready only return ready-to-use processors.
1055      * @return mixed $processor if processor present else empty array.
1056      * @since Moodle 3.2
1057      */
1058     public static function get_message_processor($name, $ready = false) {
1059         global $DB, $CFG;
1061         $processor = $DB->get_record('message_processors', array('name' => $name));
1062         if (empty($processor)) {
1063             // Processor not found, return.
1064             return array();
1065         }
1067         $processor = self::get_processed_processor_object($processor);
1068         if ($ready) {
1069             if ($processor->enabled && $processor->configured) {
1070                 return $processor;
1071             } else {
1072                 return array();
1073             }
1074         } else {
1075             return $processor;
1076         }
1077     }
1079     /**
1080      * Returns weather a given processor is enabled or not.
1081      * Note:- This doesn't check if the processor is configured or not.
1082      *
1083      * @param string $name Name of the processor
1084      * @return bool
1085      */
1086     public static function is_processor_enabled($name) {
1088         $cache = \cache::make('core', 'message_processors_enabled');
1089         $status = $cache->get($name);
1091         if ($status === false) {
1092             $processor = self::get_message_processor($name);
1093             if (!empty($processor)) {
1094                 $cache->set($name, $processor->enabled);
1095                 return $processor->enabled;
1096             } else {
1097                 return false;
1098             }
1099         }
1101         return $status;
1102     }
1104     /**
1105      * Set status of a processor.
1106      *
1107      * @param \stdClass $processor processor record.
1108      * @param 0|1 $enabled 0 or 1 to set the processor status.
1109      * @return bool
1110      * @since Moodle 3.2
1111      */
1112     public static function update_processor_status($processor, $enabled) {
1113         global $DB;
1114         $cache = \cache::make('core', 'message_processors_enabled');
1115         $cache->delete($processor->name);
1116         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1117     }
1119     /**
1120      * Given a processor object, loads information about it's settings and configurations.
1121      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1122      * or @see \get_message_processors()
1123      *
1124      * @param \stdClass $processor processor object
1125      * @return \stdClass processed processor object
1126      * @since Moodle 3.2
1127      */
1128     public static function get_processed_processor_object(\stdClass $processor) {
1129         global $CFG;
1131         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1132         if (is_readable($processorfile)) {
1133             include_once($processorfile);
1134             $processclass = 'message_output_' . $processor->name;
1135             if (class_exists($processclass)) {
1136                 $pclass = new $processclass();
1137                 $processor->object = $pclass;
1138                 $processor->configured = 0;
1139                 if ($pclass->is_system_configured()) {
1140                     $processor->configured = 1;
1141                 }
1142                 $processor->hassettings = 0;
1143                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1144                     $processor->hassettings = 1;
1145                 }
1146                 $processor->available = 1;
1147             } else {
1148                 print_error('errorcallingprocessor', 'message');
1149             }
1150         } else {
1151             $processor->available = 0;
1152         }
1153         return $processor;
1154     }
1156     /**
1157      * Retrieve users blocked by $user1
1158      *
1159      * @param int $userid The user id of the user whos blocked users we are returning
1160      * @return array the users blocked
1161      */
1162     public static function get_blocked_users($userid) {
1163         global $DB;
1165         $userfields = \user_picture::fields('u', array('lastaccess'));
1166         $blockeduserssql = "SELECT $userfields
1167                               FROM {message_users_blocked} mub
1168                         INNER JOIN {user} u
1169                                 ON u.id = mub.blockeduserid
1170                              WHERE u.deleted = 0
1171                                AND mub.userid = ?
1172                           GROUP BY $userfields
1173                           ORDER BY u.firstname ASC";
1174         return $DB->get_records_sql($blockeduserssql, [$userid]);
1175     }
1177     /**
1178      * Mark a single message as read.
1179      *
1180      * @param int $userid The user id who marked the message as read
1181      * @param \stdClass $message The message
1182      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1183      */
1184     public static function mark_message_as_read($userid, $message, $timeread = null) {
1185         global $DB;
1187         if (is_null($timeread)) {
1188             $timeread = time();
1189         }
1191         $mua = new \stdClass();
1192         $mua->userid = $userid;
1193         $mua->messageid = $message->id;
1194         $mua->action = self::MESSAGE_ACTION_READ;
1195         $mua->timecreated = $timeread;
1196         $mua->id = $DB->insert_record('message_user_actions', $mua);
1198         // Get the context for the user who received the message.
1199         $context = \context_user::instance($userid, IGNORE_MISSING);
1200         // If the user no longer exists the context value will be false, in this case use the system context.
1201         if ($context === false) {
1202             $context = \context_system::instance();
1203         }
1205         // Trigger event for reading a message.
1206         $event = \core\event\message_viewed::create(array(
1207             'objectid' => $mua->id,
1208             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1209             'context' => $context,
1210             'relateduserid' => $message->useridfrom,
1211             'other' => array(
1212                 'messageid' => $message->id
1213             )
1214         ));
1215         $event->trigger();
1216     }
1218     /**
1219      * Mark a single notification as read.
1220      *
1221      * @param \stdClass $notification The notification
1222      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1223      */
1224     public static function mark_notification_as_read($notification, $timeread = null) {
1225         global $DB;
1227         if (is_null($timeread)) {
1228             $timeread = time();
1229         }
1231         if (is_null($notification->timeread)) {
1232             $updatenotification = new \stdClass();
1233             $updatenotification->id = $notification->id;
1234             $updatenotification->timeread = $timeread;
1236             $DB->update_record('notifications', $updatenotification);
1238             // Trigger event for reading a notification.
1239             \core\event\notification_viewed::create_from_ids(
1240                 $notification->useridfrom,
1241                 $notification->useridto,
1242                 $notification->id
1243             )->trigger();
1244         }
1245     }
1247     /**
1248      * Checks if a user can delete a message.
1249      *
1250      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1251      *  but will still seem as if it was by the user)
1252      * @param int $messageid The message id
1253      * @return bool Returns true if a user can delete the message, false otherwise.
1254      */
1255     public static function can_delete_message($userid, $messageid) {
1256         global $DB, $USER;
1258         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto
1259                   FROM {messages} m
1260             INNER JOIN {message_conversations} mc
1261                     ON m.conversationid = mc.id
1262             INNER JOIN {message_conversation_members} mcm
1263                     ON mcm.conversationid = mc.id
1264                  WHERE mcm.userid != m.useridfrom
1265                    AND m.id = ?";
1266         $message = $DB->get_record_sql($sql, [$messageid], MUST_EXIST);
1268         if ($message->useridfrom == $userid) {
1269             $userdeleting = 'useridfrom';
1270         } else if ($message->useridto == $userid) {
1271             $userdeleting = 'useridto';
1272         } else {
1273             return false;
1274         }
1276         $systemcontext = \context_system::instance();
1278         // Let's check if the user is allowed to delete this message.
1279         if (has_capability('moodle/site:deleteanymessage', $systemcontext) ||
1280             ((has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1281                 $USER->id == $message->$userdeleting))) {
1282             return true;
1283         }
1285         return false;
1286     }
1288     /**
1289      * Deletes a message.
1290      *
1291      * This function does not verify any permissions.
1292      *
1293      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1294      *  but will still seem as if it was by the user)
1295      * @param int $messageid The message id
1296      * @return bool
1297      */
1298     public static function delete_message($userid, $messageid) {
1299         global $DB;
1301         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto
1302                   FROM {messages} m
1303             INNER JOIN {message_conversations} mc
1304                     ON m.conversationid = mc.id
1305             INNER JOIN {message_conversation_members} mcm
1306                     ON mcm.conversationid = mc.id
1307                  WHERE mcm.userid != m.useridfrom
1308                    AND m.id = ?";
1309         $message = $DB->get_record_sql($sql, [$messageid], MUST_EXIST);
1311         // Check if the user has already deleted this message.
1312         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
1313                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
1314             $mua = new \stdClass();
1315             $mua->userid = $userid;
1316             $mua->messageid = $messageid;
1317             $mua->action = self::MESSAGE_ACTION_DELETED;
1318             $mua->timecreated = time();
1319             $mua->id = $DB->insert_record('message_user_actions', $mua);
1321             // Trigger event for deleting a message.
1322             \core\event\message_deleted::create_from_ids($message->useridfrom, $message->useridto,
1323                 $userid, $message->id, $mua->id)->trigger();
1325             return true;
1326         }
1328         return false;
1329     }
1331     /**
1332      * Returns the conversation between two users.
1333      *
1334      * @param array $userids
1335      * @return int|bool The id of the conversation, false if not found
1336      */
1337     public static function get_conversation_between_users(array $userids) {
1338         global $DB;
1340         $hash = helper::get_conversation_hash($userids);
1342         if ($conversation = $DB->get_record('message_conversations', ['convhash' => $hash])) {
1343             return $conversation->id;
1344         }
1346         return false;
1347     }
1349     /**
1350      * Creates a conversation between two users.
1351      *
1352      * @param array $userids
1353      * @return int The id of the conversation
1354      */
1355     public static function create_conversation_between_users(array $userids) {
1356         global $DB;
1358         $conversation = new \stdClass();
1359         $conversation->convhash = helper::get_conversation_hash($userids);
1360         $conversation->timecreated = time();
1361         $conversation->id = $DB->insert_record('message_conversations', $conversation);
1363         // Add members to this conversation.
1364         foreach ($userids as $userid) {
1365             $member = new \stdClass();
1366             $member->conversationid = $conversation->id;
1367             $member->userid = $userid;
1368             $member->timecreated = time();
1369             $DB->insert_record('message_conversation_members', $member);
1370         }
1372         return $conversation->id;
1373     }
1375     /**
1376      * Checks if a user can create a contact request.
1377      *
1378      * @param int $userid The id of the user who is creating the contact request
1379      * @param int $requesteduserid The id of the user being requested
1380      * @return bool
1381      */
1382     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
1383         global $CFG;
1385         // If we can't message at all, then we can't create a contact.
1386         if (empty($CFG->messaging)) {
1387             return false;
1388         }
1390         // If we can message anyone on the site then we can create a contact.
1391         if ($CFG->messagingallusers) {
1392             return true;
1393         }
1395         // We need to check if they are in the same course.
1396         return enrol_sharing_course($userid, $requesteduserid);
1397     }
1399     /**
1400      * Handles creating a contact request.
1401      *
1402      * @param int $userid The id of the user who is creating the contact request
1403      * @param int $requesteduserid The id of the user being requested
1404      */
1405     public static function create_contact_request(int $userid, int $requesteduserid) {
1406         global $DB;
1408         $request = new \stdClass();
1409         $request->userid = $userid;
1410         $request->requesteduserid = $requesteduserid;
1411         $request->timecreated = time();
1413         $DB->insert_record('message_contact_requests', $request);
1415         // Send a notification.
1416         $userfrom = \core_user::get_user($userid);
1417         $userfromfullname = fullname($userfrom);
1418         $userto = \core_user::get_user($requesteduserid);
1419         $url = new \moodle_url('/message/pendingcontactrequests.php');
1421         $subject = get_string('messagecontactrequestsnotificationsubject', 'core_message', $userfromfullname);
1422         $fullmessage = get_string('messagecontactrequestsnotification', 'core_message', $userfromfullname);
1424         $message = new \core\message\message();
1425         $message->courseid = SITEID;
1426         $message->component = 'moodle';
1427         $message->name = 'messagecontactrequests';
1428         $message->notification = 1;
1429         $message->userfrom = $userfrom;
1430         $message->userto = $userto;
1431         $message->subject = $subject;
1432         $message->fullmessage = text_to_html($fullmessage);
1433         $message->fullmessageformat = FORMAT_HTML;
1434         $message->fullmessagehtml = $fullmessage;
1435         $message->smallmessage = '';
1436         $message->contexturl = $url->out(false);
1438         message_send($message);
1439     }
1442     /**
1443      * Handles confirming a contact request.
1444      *
1445      * @param int $userid The id of the user who created the contact request
1446      * @param int $requesteduserid The id of the user confirming the request
1447      */
1448     public static function confirm_contact_request(int $userid, int $requesteduserid) {
1449         global $DB;
1451         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
1452                 'requesteduserid' => $requesteduserid])) {
1453             self::add_contact($userid, $requesteduserid);
1455             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
1456         }
1457     }
1459     /**
1460      * Handles declining a contact request.
1461      *
1462      * @param int $userid The id of the user who created the contact request
1463      * @param int $requesteduserid The id of the user declining the request
1464      */
1465     public static function decline_contact_request(int $userid, int $requesteduserid) {
1466         global $DB;
1468         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
1469                 'requesteduserid' => $requesteduserid])) {
1470             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
1471         }
1472     }
1474     /**
1475      * Handles returning the contact requests for a user.
1476      *
1477      * This also includes the user data necessary to display information
1478      * about the user.
1479      *
1480      * It will not include blocked users.
1481      *
1482      * @param int $userid
1483      * @return array The list of contact requests
1484      */
1485     public static function get_contact_requests(int $userid) : array {
1486         global $DB;
1488         // Used to search for contacts.
1489         $ufields = \user_picture::fields('u');
1491         $sql = "SELECT $ufields, mcr.id as contactrequestid
1492                   FROM {user} u
1493                   JOIN {message_contact_requests} mcr
1494                     ON u.id = mcr.userid
1495              LEFT JOIN {message_users_blocked} mub
1496                     ON (mub.userid = ? AND mub.blockeduserid = u.id)
1497                  WHERE mcr.requesteduserid = ?
1498                    AND u.deleted = 0
1499                    AND mub.id is NULL
1500               ORDER BY mcr.timecreated DESC";
1502         return $DB->get_records_sql($sql, [$userid, $userid]);
1503     }
1505     /**
1506      * Handles adding a contact.
1507      *
1508      * @param int $userid The id of the user who requested to be a contact
1509      * @param int $contactid The id of the contact
1510      */
1511     public static function add_contact(int $userid, int $contactid) {
1512         global $DB;
1514         $messagecontact = new \stdClass();
1515         $messagecontact->userid = $userid;
1516         $messagecontact->contactid = $contactid;
1517         $messagecontact->timecreated = time();
1518         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
1520         $eventparams = [
1521             'objectid' => $messagecontact->id,
1522             'userid' => $userid,
1523             'relateduserid' => $contactid,
1524             'context' => \context_user::instance($userid)
1525         ];
1526         $event = \core\event\message_contact_added::create($eventparams);
1527         $event->add_record_snapshot('message_contacts', $messagecontact);
1528         $event->trigger();
1529     }
1531     /**
1532      * Handles removing a contact.
1533      *
1534      * @param int $userid The id of the user who is removing a user as a contact
1535      * @param int $contactid The id of the user to be removed as a contact
1536      */
1537     public static function remove_contact(int $userid, int $contactid) {
1538         global $DB;
1540         if ($contact = self::get_contact($userid, $contactid)) {
1541             $DB->delete_records('message_contacts', ['id' => $contact->id]);
1543             $event = \core\event\message_contact_removed::create(array(
1544                 'objectid' => $contact->id,
1545                 'userid' => $userid,
1546                 'relateduserid' => $contactid,
1547                 'context' => \context_user::instance($userid)
1548             ));
1549             $event->add_record_snapshot('message_contacts', $contact);
1550             $event->trigger();
1551         }
1552     }
1554     /**
1555      * Handles blocking a user.
1556      *
1557      * @param int $userid The id of the user who is blocking
1558      * @param int $usertoblockid The id of the user being blocked
1559      */
1560     public static function block_user(int $userid, int $usertoblockid) {
1561         global $DB;
1563         $blocked = new \stdClass();
1564         $blocked->userid = $userid;
1565         $blocked->blockeduserid = $usertoblockid;
1566         $blocked->timecreated = time();
1567         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
1569         // Trigger event for blocking a contact.
1570         $event = \core\event\message_user_blocked::create(array(
1571             'objectid' => $blocked->id,
1572             'userid' => $userid,
1573             'relateduserid' => $usertoblockid,
1574             'context' => \context_user::instance($userid)
1575         ));
1576         $event->add_record_snapshot('message_users_blocked', $blocked);
1577         $event->trigger();
1578     }
1580     /**
1581      * Handles unblocking a user.
1582      *
1583      * @param int $userid The id of the user who is unblocking
1584      * @param int $usertounblockid The id of the user being unblocked
1585      */
1586     public static function unblock_user(int $userid, int $usertounblockid) {
1587         global $DB;
1589         if ($blockeduser = $DB->get_record('message_users_blocked',
1590                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
1591             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
1593             // Trigger event for unblocking a contact.
1594             $event = \core\event\message_user_unblocked::create(array(
1595                 'objectid' => $blockeduser->id,
1596                 'userid' => $userid,
1597                 'relateduserid' => $usertounblockid,
1598                 'context' => \context_user::instance($userid)
1599             ));
1600             $event->add_record_snapshot('message_users_blocked', $blockeduser);
1601             $event->trigger();
1602         }
1603     }
1605     /**
1606      * Checks if users are already contacts.
1607      *
1608      * @param int $userid The id of one of the users
1609      * @param int $contactid The id of the other user
1610      * @return bool Returns true if they are a contact, false otherwise
1611      */
1612     public static function is_contact(int $userid, int $contactid) : bool {
1613         global $DB;
1615         $sql = "SELECT id
1616                   FROM {message_contacts} mc
1617                  WHERE (mc.userid = ? AND mc.contactid = ?)
1618                     OR (mc.userid = ? AND mc.contactid = ?)";
1619         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
1620     }
1622     /**
1623      * Returns the row in the database table message_contacts that represents the contact between two people.
1624      *
1625      * @param int $userid The id of one of the users
1626      * @param int $contactid The id of the other user
1627      * @return mixed A fieldset object containing the record, false otherwise
1628      */
1629     public static function get_contact(int $userid, int $contactid) {
1630         global $DB;
1632         $sql = "SELECT mc.*
1633                   FROM {message_contacts} mc
1634                  WHERE (mc.userid = ? AND mc.contactid = ?)
1635                     OR (mc.userid = ? AND mc.contactid = ?)";
1636         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
1637     }
1639     /**
1640      * Checks if a user is already blocked.
1641      *
1642      * @param int $userid
1643      * @param int $blockeduserid
1644      * @return bool Returns true if they are a blocked, false otherwise
1645      */
1646     public static function is_blocked(int $userid, int $blockeduserid) : bool {
1647         global $DB;
1649         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
1650     }
1652     /**
1653      * Checks if a contact request already exists between users.
1654      *
1655      * @param int $userid The id of the user who is creating the contact request
1656      * @param int $requesteduserid The id of the user being requested
1657      * @return bool Returns true if a contact request exists, false otherwise
1658      */
1659     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
1660         global $DB;
1662         $sql = "SELECT id
1663                   FROM {message_contact_requests} mcr
1664                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
1665                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
1666         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
1667     }