d5792239e13a944ee91d14bac674e1f50bd57af8
[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 use core_favourites\local\entity\favourite;
29 defined('MOODLE_INTERNAL') || die();
31 require_once($CFG->dirroot . '/lib/messagelib.php');
33 /**
34  * Class used to return information to display for the message area.
35  *
36  * @copyright  2016 Mark Nelson <markn@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class api {
41     /**
42      * The action for reading a message.
43      */
44     const MESSAGE_ACTION_READ = 1;
46     /**
47      * The action for deleting a message.
48      */
49     const MESSAGE_ACTION_DELETED = 2;
51     /**
52      * The privacy setting for being messaged by anyone within courses user is member of.
53      */
54     const MESSAGE_PRIVACY_COURSEMEMBER = 0;
56     /**
57      * The privacy setting for being messaged only by contacts.
58      */
59     const MESSAGE_PRIVACY_ONLYCONTACTS = 1;
61     /**
62      * The privacy setting for being messaged by anyone on the site.
63      */
64     const MESSAGE_PRIVACY_SITE = 2;
66     /**
67      * An individual conversation.
68      */
69     const MESSAGE_CONVERSATION_TYPE_INDIVIDUAL = 1;
71     /**
72      * A group conversation.
73      */
74     const MESSAGE_CONVERSATION_TYPE_GROUP = 2;
76     /**
77      * The state for an enabled conversation area.
78      */
79     const MESSAGE_CONVERSATION_ENABLED = 1;
81     /**
82      * The state for a disabled conversation area.
83      */
84     const MESSAGE_CONVERSATION_DISABLED = 0;
86     /**
87      * Handles searching for messages in the message area.
88      *
89      * @param int $userid The user id doing the searching
90      * @param string $search The string the user is searching
91      * @param int $limitfrom
92      * @param int $limitnum
93      * @return array
94      */
95     public static function search_messages($userid, $search, $limitfrom = 0, $limitnum = 0) {
96         global $DB;
98         // Get the user fields we want.
99         $ufields = \user_picture::fields('u', array('lastaccess'), 'userfrom_id', 'userfrom_');
100         $ufields2 = \user_picture::fields('u2', array('lastaccess'), 'userto_id', 'userto_');
102         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto, m.subject, m.fullmessage, m.fullmessagehtml, m.fullmessageformat,
103                        m.smallmessage, m.conversationid, m.timecreated, 0 as isread, $ufields, mub.id as userfrom_blocked,
104                        $ufields2, mub2.id as userto_blocked
105                   FROM {messages} m
106             INNER JOIN {user} u
107                     ON u.id = m.useridfrom
108             INNER JOIN {message_conversations} mc
109                     ON mc.id = m.conversationid
110             INNER JOIN {message_conversation_members} mcm
111                     ON mcm.conversationid = m.conversationid
112             INNER JOIN {user} u2
113                     ON u2.id = mcm.userid
114              LEFT JOIN {message_users_blocked} mub
115                     ON (mub.blockeduserid = u.id AND mub.userid = ?)
116              LEFT JOIN {message_users_blocked} mub2
117                     ON (mub2.blockeduserid = u2.id AND mub2.userid = ?)
118              LEFT JOIN {message_user_actions} mua
119                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
120                  WHERE (m.useridfrom = ? OR mcm.userid = ?)
121                    AND m.useridfrom != mcm.userid
122                    AND u.deleted = 0
123                    AND u2.deleted = 0
124                    AND mua.id is NULL
125                    AND " . $DB->sql_like('smallmessage', '?', false) . "
126               ORDER BY timecreated DESC";
128         $params = array($userid, $userid, $userid, self::MESSAGE_ACTION_DELETED, $userid, $userid, '%' . $search . '%');
130         // Convert the messages into searchable contacts with their last message being the message that was searched.
131         $conversations = array();
132         if ($messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
133             foreach ($messages as $message) {
134                 $prefix = 'userfrom_';
135                 if ($userid == $message->useridfrom) {
136                     $prefix = 'userto_';
137                     // If it from the user, then mark it as read, even if it wasn't by the receiver.
138                     $message->isread = true;
139                 }
140                 $blockedcol = $prefix . 'blocked';
141                 $message->blocked = $message->$blockedcol ? 1 : 0;
143                 $message->messageid = $message->id;
144                 $conversations[] = helper::create_contact($message, $prefix);
145             }
146         }
148         return $conversations;
149     }
151     /**
152      * Handles searching for user in a particular course in the message area.
153      *
154      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
155      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
156      * But we are deprecating data_for_messagearea_search_users_in_course external function.
157      * Followup: MDL-63915
158      *
159      * @param int $userid The user id doing the searching
160      * @param int $courseid The id of the course we are searching in
161      * @param string $search The string the user is searching
162      * @param int $limitfrom
163      * @param int $limitnum
164      * @return array
165      */
166     public static function search_users_in_course($userid, $courseid, $search, $limitfrom = 0, $limitnum = 0) {
167         global $DB;
169         // Get all the users in the course.
170         list($esql, $params) = get_enrolled_sql(\context_course::instance($courseid), '', 0, true);
171         $sql = "SELECT u.*, mub.id as isblocked
172                   FROM {user} u
173                   JOIN ($esql) je
174                     ON je.id = u.id
175              LEFT JOIN {message_users_blocked} mub
176                     ON (mub.blockeduserid = u.id AND mub.userid = :userid)
177                  WHERE u.deleted = 0";
178         // Add more conditions.
179         $fullname = $DB->sql_fullname();
180         $sql .= " AND u.id != :userid2
181                   AND " . $DB->sql_like($fullname, ':search', false) . "
182              ORDER BY " . $DB->sql_fullname();
183         $params = array_merge(array('userid' => $userid, 'userid2' => $userid, 'search' => '%' . $search . '%'), $params);
185         // Convert all the user records into contacts.
186         $contacts = array();
187         if ($users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
188             foreach ($users as $user) {
189                 $user->blocked = $user->isblocked ? 1 : 0;
190                 $contacts[] = helper::create_contact($user);
191             }
192         }
194         return $contacts;
195     }
197     /**
198      * Handles searching for user in the message area.
199      *
200      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
201      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
202      * But we are deprecating data_for_messagearea_search_users external function.
203      * Followup: MDL-63915
204      *
205      * @param int $userid The user id doing the searching
206      * @param string $search The string the user is searching
207      * @param int $limitnum
208      * @return array
209      */
210     public static function search_users($userid, $search, $limitnum = 0) {
211         global $CFG, $DB;
213         // Used to search for contacts.
214         $fullname = $DB->sql_fullname();
215         $ufields = \user_picture::fields('u', array('lastaccess'));
217         // Users not to include.
218         $excludeusers = array($userid, $CFG->siteguest);
219         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
221         // Ok, let's search for contacts first.
222         $contacts = array();
223         $sql = "SELECT $ufields, mub.id as isuserblocked
224                   FROM {user} u
225                   JOIN {message_contacts} mc
226                     ON u.id = mc.contactid
227              LEFT JOIN {message_users_blocked} mub
228                     ON (mub.userid = :userid2 AND mub.blockeduserid = u.id)
229                  WHERE mc.userid = :userid
230                    AND u.deleted = 0
231                    AND u.confirmed = 1
232                    AND " . $DB->sql_like($fullname, ':search', false) . "
233                    AND u.id $exclude
234               ORDER BY " . $DB->sql_fullname();
235         if ($users = $DB->get_records_sql($sql, array('userid' => $userid, 'userid2' => $userid,
236                 'search' => '%' . $search . '%') + $excludeparams, 0, $limitnum)) {
237             foreach ($users as $user) {
238                 $user->blocked = $user->isuserblocked ? 1 : 0;
239                 $contacts[] = helper::create_contact($user);
240             }
241         }
243         // Now, let's get the courses.
244         // Make sure to limit searches to enrolled courses.
245         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
246         $courses = array();
247         // Really we want the user to be able to view the participants if they have the capability
248         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
249         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
250         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
251         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
252                 array('moodle/course:viewparticipants'))) {
253             foreach ($arrcourses as $course) {
254                 if (isset($enrolledcourses[$course->id])) {
255                     $data = new \stdClass();
256                     $data->id = $course->id;
257                     $data->shortname = $course->shortname;
258                     $data->fullname = $course->fullname;
259                     $courses[] = $data;
260                 }
261             }
262         }
264         // Let's get those non-contacts. Toast them gears boi.
265         // Note - you can only block contacts, so these users will not be blocked, so no need to get that
266         // extra detail from the database.
267         $noncontacts = array();
268         $sql = "SELECT $ufields
269                   FROM {user} u
270                  WHERE u.deleted = 0
271                    AND u.confirmed = 1
272                    AND " . $DB->sql_like($fullname, ':search', false) . "
273                    AND u.id $exclude
274                    AND u.id NOT IN (SELECT contactid
275                                       FROM {message_contacts}
276                                      WHERE userid = :userid)
277               ORDER BY " . $DB->sql_fullname();
278         if ($users = $DB->get_records_sql($sql,  array('userid' => $userid, 'search' => '%' . $search . '%') + $excludeparams,
279                 0, $limitnum)) {
280             foreach ($users as $user) {
281                 $noncontacts[] = helper::create_contact($user);
282             }
283         }
285         return array($contacts, $courses, $noncontacts);
286     }
288     /**
289      * Handles searching for user.
290      *
291      * @param int $userid The user id doing the searching
292      * @param string $search The string the user is searching
293      * @param int $limitfrom
294      * @param int $limitnum
295      * @return array
296      */
297     public static function message_search_users(int $userid, string $search, int $limitfrom = 0, int $limitnum = 20) : array {
298         global $CFG, $DB;
300         // Check if messaging is enabled.
301         if (empty($CFG->messaging)) {
302             throw new \moodle_exception('disabled', 'message');
303         }
305         // Used to search for contacts.
306         $fullname = $DB->sql_fullname();
308         // Users not to include.
309         $excludeusers = array($userid, $CFG->siteguest);
310         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
312         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid);
314         // Ok, let's search for contacts first.
315         $sql = "SELECT u.id
316                   FROM {user} u
317                   JOIN {message_contacts} mc
318                     ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
319                  WHERE u.deleted = 0
320                    AND u.confirmed = 1
321                    AND " . $DB->sql_like($fullname, ':search', false) . "
322                    AND u.id $exclude
323               ORDER BY " . $DB->sql_fullname();
324         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
326         $orderedcontacts = array();
327         if (!empty($foundusers)) {
328             $contacts = helper::get_member_info($userid, array_keys($foundusers));
329             // The get_member_info returns an associative array, so is not ordered in the same way.
330             // We need to reorder it again based on query's result.
331             foreach ($foundusers as $key => $value) {
332                 $contact = $contacts[$key];
333                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
334                 $orderedcontacts[] = $contact;
335             }
336         }
338         // Let's get those non-contacts.
339         // If site wide messaging is enabled, we just fetch any matched users which are non-contacts.
340         if ($CFG->messagingallusers) {
341             $sql = "SELECT u.id
342                   FROM {user} u
343                  WHERE u.deleted = 0
344                    AND u.confirmed = 1
345                    AND " . $DB->sql_like($fullname, ':search', false) . "
346                    AND u.id $exclude
347                    AND NOT EXISTS (SELECT mc.id
348                                      FROM {message_contacts} mc
349                                     WHERE (mc.userid = u.id AND mc.contactid = :userid1)
350                                        OR (mc.userid = :userid2 AND mc.contactid = u.id))
351               ORDER BY " . $DB->sql_fullname();
353             $foundusers = $DB->get_records_sql($sql, $params + $excludeparams, $limitfrom, $limitnum);
354         } else {
355             require_once($CFG->dirroot . '/user/lib.php');
356             // If site-wide messaging is disabled, then we should only be able to search for users who we are allowed to see.
357             // Because we can't achieve all the required visibility checks in SQL, we'll iterate through the non-contact records
358             // and stop once we have enough matching the 'visible' criteria.
359             // TODO: MDL-63983 - Improve the performance of non-contact searches when site-wide messaging is disabled (default).
361             // Use a local generator to achieve this iteration.
362             $getnoncontactusers = function ($limitfrom = 0, $limitnum = 0) use($fullname, $exclude, $params, $excludeparams) {
363                 global $DB;
364                 $sql = "SELECT u.*
365                       FROM {user} u
366                      WHERE u.deleted = 0
367                        AND u.confirmed = 1
368                        AND " . $DB->sql_like($fullname, ':search', false) . "
369                        AND u.id $exclude
370                        AND NOT EXISTS (SELECT mc.id
371                                          FROM {message_contacts} mc
372                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
373                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
374                   ORDER BY " . $DB->sql_fullname();
375                 while ($records = $DB->get_records_sql($sql, $params + $excludeparams, $limitfrom, $limitnum)) {
376                     yield $records;
377                     $limitfrom += $limitnum;
378                 }
379             };
381             // Fetch in batches of $limitnum * 2 to improve the chances of matching a user without going back to the DB.
382             // The generator cannot function without a sensible limiter, so set one if this is not set.
383             $batchlimit = ($limitnum == 0) ? 20 : $limitnum;
385             // We need to make the offset param work with the generator.
386             // Basically, if we want to get say 10 records starting at the 40th record, we need to see 50 records and return only
387             // those after the 40th record. We can never pass the method's offset param to the generator as we need to manage the
388             // position within those valid records ourselves.
389             // See MDL-63983 dealing with performance improvements to this area of code.
390             $noofvalidseenrecords = 0;
391             $returnedusers = [];
392             foreach ($getnoncontactusers(0, $batchlimit) as $users) {
393                 foreach ($users as $id => $user) {
394                     $userdetails = \user_get_user_details_courses($user);
396                     // Return the user only if the searched field is returned.
397                     // Otherwise it means that the $USER was not allowed to search the returned user.
398                     if (!empty($userdetails) and !empty($userdetails['fullname'])) {
399                         // We know we've matched, but only save the record if it's within the offset area we need.
400                         if ($limitfrom == 0) {
401                             // No offset specified, so just save.
402                             $returnedusers[$id] = $user;
403                         } else {
404                             // There is an offset in play.
405                             // If we've passed enough records already (> offset value), then we can save this one.
406                             if ($noofvalidseenrecords >= $limitfrom) {
407                                 $returnedusers[$id] = $user;
408                             }
409                         }
410                         if (count($returnedusers) == $limitnum) {
411                             break 2;
412                         }
413                         $noofvalidseenrecords++;
414                     }
415                 }
416             }
417             $foundusers = $returnedusers;
418         }
420         $orderednoncontacts = array();
421         if (!empty($foundusers)) {
422             $noncontacts = helper::get_member_info($userid, array_keys($foundusers));
423             // The get_member_info returns an associative array, so is not ordered in the same way.
424             // We need to reorder it again based on query's result.
425             foreach ($foundusers as $key => $value) {
426                 $contact = $noncontacts[$key];
427                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
428                 $orderednoncontacts[] = $contact;
429             }
430         }
432         return array($orderedcontacts, $orderednoncontacts);
433     }
435     /**
436      * Gets extra fields, like image url and subname for any conversations linked to components.
437      *
438      * The subname is like a subtitle for the conversation, to compliment it's name.
439      * The imageurl is the location of the image for the conversation, as might be seen on a listing of conversations for a user.
440      *
441      * @param array $conversations a list of conversations records.
442      * @return array the array of subnames, index by conversation id.
443      * @throws \coding_exception
444      * @throws \dml_exception
445      */
446     protected static function get_linked_conversation_extra_fields(array $conversations) : array {
447         global $DB;
449         $linkedconversations = [];
450         foreach ($conversations as $conversation) {
451             if (!is_null($conversation->component) && !is_null($conversation->itemtype)) {
452                 $linkedconversations[$conversation->component][$conversation->itemtype][$conversation->id]
453                     = $conversation->itemid;
454             }
455         }
456         if (empty($linkedconversations)) {
457             return [];
458         }
460         // TODO: MDL-63814: Working out the subname for linked conversations should be done in a generic way.
461         // Get the itemid, but only for course group linked conversation for now.
462         $extrafields = [];
463         if (!empty($linkeditems = $linkedconversations['core_group']['groups'])) { // Format: [conversationid => itemid].
464             // Get the name of the course to which the group belongs.
465             list ($groupidsql, $groupidparams) = $DB->get_in_or_equal(array_values($linkeditems), SQL_PARAMS_NAMED, 'groupid');
466             $sql = "SELECT g.*, c.shortname as courseshortname
467                       FROM {groups} g
468                       JOIN {course} c
469                         ON g.courseid = c.id
470                      WHERE g.id $groupidsql";
471             $courseinfo = $DB->get_records_sql($sql, $groupidparams);
472             foreach ($linkeditems as $convid => $groupid) {
473                 if (array_key_exists($groupid, $courseinfo)) {
474                     $group = $courseinfo[$groupid];
475                     // Subname.
476                     $extrafields[$convid]['subname'] = format_string($courseinfo[$groupid]->courseshortname);
478                     // Imageurl.
479                     $extrafields[$convid]['imageurl'] = '';
480                     if ($url = get_group_picture_url($group, $group->courseid, true)) {
481                         $extrafields[$convid]['imageurl'] = $url->out(false);
482                     }
483                 }
484             }
485         }
486         return $extrafields;
487     }
490     /**
491      * Returns the contacts and their conversation to display in the contacts area.
492      *
493      * ** WARNING **
494      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
495      * to retrieve too much information in a single call will cause performance problems.
496      * ** WARNING **
497      *
498      * This function has specifically been altered to break each of the data sets it
499      * requires into separate database calls. This is to avoid the performance problems
500      * observed when attempting to join large data sets (e.g. the message tables and
501      * the user table).
502      *
503      * While it is possible to gather the data in a single query, and it may even be
504      * more efficient with a correctly tuned database, we have opted to trade off some of
505      * the benefits of a single query in order to ensure this function will work on
506      * most databases with default tunings and with large data sets.
507      *
508      * @param int $userid The user id
509      * @param int $limitfrom
510      * @param int $limitnum
511      * @param int $type the type of the conversation, if you wish to filter to a certain type (see api constants).
512      * @param bool $favourites whether to include NO favourites (false) or ONLY favourites (true), or null to ignore this setting.
513      * @return array the array of conversations
514      * @throws \moodle_exception
515      */
516     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20, int $type = null,
517             bool $favourites = null) {
518         global $DB;
520         if (!is_null($type) && !in_array($type, [self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
521                 self::MESSAGE_CONVERSATION_TYPE_GROUP])) {
522             throw new \moodle_exception("Invalid value ($type) for type param, please see api constants.");
523         }
525         // We need to know which conversations are favourites, so we can either:
526         // 1) Include the 'isfavourite' attribute on conversations (when $favourite = null and we're including all conversations)
527         // 2) Restrict the results to ONLY those conversations which are favourites (when $favourite = true)
528         // 3) Restrict the results to ONLY those conversations which are NOT favourites (when $favourite = false).
529         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
530         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
531         $favouriteconversationids = array_column($favouriteconversations, 'itemid');
532         if ($favourites && empty($favouriteconversationids)) {
533             return []; // If we are aiming to return ONLY favourites, and we have none, there's nothing more to do.
534         }
536         // CONVERSATIONS AND MOST RECENT MESSAGE.
537         // Include those conversations with messages first (ordered by most recent message, desc), then add any conversations which
538         // don't have messages, such as newly created group conversations.
539         // Because we're sorting by message 'timecreated', those conversations without messages could be at either the start or the
540         // end of the results (behaviour for sorting of nulls differs between DB vendors), so we use the case to presort these.
542         // If we need to return ONLY favourites, or NO favourites, generate the SQL snippet.
543         $favouritesql = "";
544         $favouriteparams = [];
545         if (null !== $favourites && !empty($favouriteconversationids)) {
546             list ($insql, $favouriteparams) =
547                     $DB->get_in_or_equal($favouriteconversationids, SQL_PARAMS_NAMED, 'favouriteids', $favourites);
548             $favouritesql = " AND mc.id {$insql} ";
549         }
551         // If we need to restrict type, generate the SQL snippet.
552         $typesql = !is_null($type) ? " AND mc.type = :convtype " : "";
554         $sql = "SELECT m.id as messageid, mc.id as id, mc.name as conversationname, mc.type as conversationtype, m.useridfrom,
555                        m.smallmessage, m.fullmessage, m.fullmessageformat, m.fullmessagehtml, m.timecreated, mc.component,
556                        mc.itemtype, mc.itemid
557                   FROM {message_conversations} mc
558             INNER JOIN {message_conversation_members} mcm
559                     ON (mcm.conversationid = mc.id AND mcm.userid = :userid3)
560             LEFT JOIN (
561                           SELECT m.conversationid, MAX(m.id) AS messageid
562                             FROM {messages} m
563                       INNER JOIN (
564                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
565                                         FROM {messages} m
566                                   INNER JOIN {message_conversation_members} mcm
567                                           ON mcm.conversationid = m.conversationid
568                                    LEFT JOIN {message_user_actions} mua
569                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
570                                        WHERE mua.id is NULL
571                                          AND mcm.userid = :userid2
572                                     GROUP BY m.conversationid
573                                  ) maxmessage
574                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
575                          GROUP BY m.conversationid
576                        ) lastmessage
577                     ON lastmessage.conversationid = mc.id
578             LEFT JOIN {messages} m
579                    ON m.id = lastmessage.messageid
580                 WHERE mc.id IS NOT NULL
581                   AND mc.enabled = 1 $typesql $favouritesql
582               ORDER BY (CASE WHEN m.timecreated IS NULL THEN 0 ELSE 1 END) DESC, m.timecreated DESC, id DESC";
584         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
585             'userid2' => $userid, 'userid3' => $userid, 'convtype' => $type]);
586         $conversationset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
588         $conversations = [];
589         $members = [];
590         $individualmembers = [];
591         $groupmembers = [];
592         foreach ($conversationset as $conversation) {
593             $conversations[$conversation->id] = $conversation;
594             $members[$conversation->id] = [];
595         }
596         $conversationset->close();
598         // If there are no conversations found, then return early.
599         if (empty($conversations)) {
600             return [];
601         }
603         // COMPONENT-LINKED CONVERSATION FIELDS.
604         // Conversations linked to components may have extra information, such as:
605         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
606         // - imageurl: A URL to the image for the linked conversation.
607         // For now, this is ONLY course groups.
608         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
610         // MEMBERS.
611         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
612         // message or not.
613         //
614         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
615         // we want the details of the other member in the conversation (i.e. not the current user).
616         //
617         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
618         // This can be the current user or another group member, but for groups without messages, this will be empty.
619         //
620         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
621         // query to get the 'other' user as we already have that information.
623         // Work out which members we have already, and which ones we might need to fetch.
624         // If all the last messages were from another user, then we don't need to fetch anything further.
625         foreach ($conversations as $conversation) {
626             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
627                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
628                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
629                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
630                 } else {
631                     $individualconversations[] = $conversation->id;
632                 }
633             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
634                 // If we have a recent message, the sender is our member.
635                 if (!is_null($conversation->useridfrom)) {
636                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
637                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
638                 }
639             }
640         }
641         // If we need to fetch any member information for any of the individual conversations.
642         // This is the case if any of the individual conversations have a recent message sent by the current user.
643         if (!empty($individualconversations)) {
644             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
645             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
646                         FROM {message_conversation_members} mcm
647                        WHERE mcm.conversationid $icidinsql
648                        AND mcm.userid != :userid
649                        ORDER BY mcm.id";
650             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
651             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
653             foreach ($conversationmembers as $mid => $member) {
654                 $members[$member->conversationid][$member->userid] = $member->userid;
655                 $individualmembers[$member->userid] = $member->userid;
656             }
657         }
659         // We could fail early here if we're sure that:
660         // a) we have no otherusers for all the conversations (users may have been deleted)
661         // b) we're sure that all conversations are individual (1:1).
663         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
664         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
665         // tables because on large sites these tables are massive which results in extremely slow
666         // performance (typically due to join buffer exhaustion).
667         if (!empty($individualmembers) || !empty($groupmembers)) {
668             // Now, we want to remove any duplicates from the group members array. For individual members we will
669             // be doing a more extensive call as we want their contact requests as well as privacy information,
670             // which is not necessary for group conversations.
671             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
673             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
674             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
676             // Don't use array_merge, as we lose array keys.
677             $memberinfo = $individualmemberinfo + $groupmemberinfo;
679             // Update the members array with the member information.
680             $deletedmembers = [];
681             foreach ($members as $convid => $memberarr) {
682                 foreach ($memberarr as $key => $memberid) {
683                     if (array_key_exists($memberid, $memberinfo)) {
684                         // If the user is deleted, remember that.
685                         if ($memberinfo[$memberid]->isdeleted) {
686                             $deletedmembers[$convid][] = $memberid;
687                         }
689                         $members[$convid][$key] = clone $memberinfo[$memberid];
691                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
692                             // Remove data we don't need for group.
693                             $members[$convid][$key]->requirescontact = null;
694                             $members[$convid][$key]->canmessage = null;
695                             $members[$convid][$key]->contactrequests = [];
696                         }
697                     }
698                 }
699             }
700         }
702         // MEMBER COUNT.
703         $cids = array_column($conversations, 'id');
704         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
705         $membercountsql = "SELECT conversationid, count(id) AS membercount
706                              FROM {message_conversation_members} mcm
707                             WHERE mcm.conversationid $cidinsql
708                          GROUP BY mcm.conversationid";
709         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
711         // UNREAD MESSAGE COUNT.
712         // Finally, let's get the unread messages count for this user so that we can add it
713         // to the conversation. Remember we need to ignore the messages the user sent.
714         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
715                               FROM {messages} m
716                         INNER JOIN {message_conversations} mc
717                                 ON mc.id = m.conversationid
718                         INNER JOIN {message_conversation_members} mcm
719                                 ON m.conversationid = mcm.conversationid
720                          LEFT JOIN {message_user_actions} mua
721                                 ON (mua.messageid = m.id AND mua.userid = ? AND
722                                    (mua.action = ? OR mua.action = ?))
723                              WHERE mcm.userid = ?
724                                AND m.useridfrom != ?
725                                AND mua.id is NULL
726                           GROUP BY m.conversationid';
727         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
728             $userid, $userid]);
730         // Now, create the final return structure.
731         $arrconversations = [];
732         foreach ($conversations as $conversation) {
733             // Do not include any individual conversations which do not contain a recent message for the user.
734             // This happens if the user has deleted all messages.
735             // Group conversations with deleted users or no messages are always returned.
736             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
737                     && (empty($conversation->messageid))) {
738                 continue;
739             }
741             $conv = new \stdClass();
742             $conv->id = $conversation->id;
743             $conv->name = $conversation->conversationname;
744             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
745             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
746             $conv->type = $conversation->conversationtype;
747             $conv->membercount = $membercounts[$conv->id]->membercount;
748             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
749             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
750             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
751             $conv->members = $members[$conv->id];
753             // Add the most recent message information.
754             $conv->messages = [];
755             if ($conversation->smallmessage) {
756                 $msg = new \stdClass();
757                 $msg->id = $conversation->messageid;
758                 $msg->text = message_format_message_text($conversation);
759                 $msg->useridfrom = $conversation->useridfrom;
760                 $msg->timecreated = $conversation->timecreated;
761                 $conv->messages[] = $msg;
762             }
764             $arrconversations[] = $conv;
765         }
766         return $arrconversations;
767     }
769     /**
770      * Returns all conversations between two users
771      *
772      * @param int $userid1 One of the user's id
773      * @param int $userid2 The other user's id
774      * @param int $limitfrom
775      * @param int $limitnum
776      * @return array
777      * @throws \dml_exception
778      */
779     public static function get_conversations_between_users(int $userid1, int $userid2,
780                                                            int $limitfrom = 0, int $limitnum = 20) : array {
782         global $DB;
784         if ($userid1 == $userid2) {
785             return array();
786         }
788         // Get all conversation where both user1 and user2 are members.
789         // TODO: Add subname value. Waiting for definite table structure.
790         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
791                   FROM {message_conversations} mc
792             INNER JOIN {message_conversation_members} mcm1
793                     ON mc.id = mcm1.conversationid
794             INNER JOIN {message_conversation_members} mcm2
795                     ON mc.id = mcm2.conversationid
796                  WHERE mcm1.userid = :userid1
797                    AND mcm2.userid = :userid2
798                    AND mc.enabled != 0
799               ORDER BY mc.timecreated DESC";
801         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
802     }
804     /**
805      * Return a conversation.
806      *
807      * @param int $userid The user id to get the conversation for
808      * @param int $conversationid The id of the conversation to fetch
809      * @param bool $includecontactrequests Should contact requests be included between members
810      * @param bool $includeprivacyinfo Should privacy info be included between members
811      * @param int $memberlimit Limit number of members to load
812      * @param int $memberoffset Offset members by this amount
813      * @param int $messagelimit Limit number of messages to load
814      * @param int $messageoffset Offset the messages
815      * @param bool $newestmessagesfirst Order messages by newest first
816      * @return \stdClass
817      */
818     public static function get_conversation(
819         int $userid,
820         int $conversationid,
821         bool $includecontactrequests = false,
822         bool $includeprivacyinfo = false,
823         int $memberlimit = 0,
824         int $memberoffset = 0,
825         int $messagelimit = 0,
826         int $messageoffset = 0,
827         bool $newestmessagesfirst = true
828     ) {
829         global $USER, $DB;
831         $systemcontext = \context_system::instance();
832         $canreadallmessages = has_capability('moodle/site:readallmessages', $systemcontext);
833         if (($USER->id != $userid) && !$canreadallmessages) {
834             throw new \moodle_exception('You do not have permission to perform this action.');
835         }
837         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
838         if (!$conversation) {
839             return null;
840         }
842         $isconversationmember = $DB->record_exists(
843             'message_conversation_members',
844             [
845                 'conversationid' => $conversationid,
846                 'userid' => $userid
847             ]
848         );
850         if (!$isconversationmember && !$canreadallmessages) {
851             throw new \moodle_exception('You do not have permission to view this conversation.');
852         }
854         $members = self::get_conversation_members(
855             $userid,
856             $conversationid,
857             $includecontactrequests,
858             $includeprivacyinfo,
859             $memberoffset,
860             $memberlimit
861         );
862         // Strip out the requesting user to match what get_conversations does.
863         $members = array_filter($members, function($member) use ($userid) {
864             return $member->id != $userid;
865         });
867         $messages = self::get_conversation_messages(
868             $userid,
869             $conversationid,
870             $messageoffset,
871             $messagelimit,
872             $newestmessagesfirst ? 'timecreated DESC' : 'timecreated ASC'
873         );
875         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
876         $isfavourite = $service->favourite_exists('core_message', 'message_conversations', $conversationid, $systemcontext);
878         $convextrafields = self::get_linked_conversation_extra_fields([$conversation]);
879         $subname = isset($convextrafields[$conversationid]) ? $convextrafields[$conversationid]['subname'] : null;
880         $imageurl = isset($convextrafields[$conversationid]) ? $convextrafields[$conversationid]['imageurl'] : null;
882         $unreadcountssql = 'SELECT count(m.id)
883                               FROM {messages} m
884                         INNER JOIN {message_conversations} mc
885                                 ON mc.id = m.conversationid
886                          LEFT JOIN {message_user_actions} mua
887                                 ON (mua.messageid = m.id AND mua.userid = ? AND
888                                    (mua.action = ? OR mua.action = ?))
889                              WHERE m.conversationid = ?
890                                AND m.useridfrom != ?
891                                AND mua.id is NULL';
892         $unreadcount = $DB->count_records_sql(
893             $unreadcountssql,
894             [
895                 $userid,
896                 self::MESSAGE_ACTION_READ,
897                 self::MESSAGE_ACTION_DELETED,
898                 $conversationid,
899                 $userid
900             ]
901         );
903         $membercount = $DB->count_records('message_conversation_members', ['conversationid' => $conversationid]);
905         return (object) [
906             'id' => $conversation->id,
907             'name' => $conversation->name,
908             'subname' => $subname,
909             'imageurl' => $imageurl,
910             'type' => $conversation->type,
911             'membercount' => $membercount,
912             'isfavourite' => $isfavourite,
913             'isread' => empty($unreadcount),
914             'unreadcount' => $unreadcount,
915             'members' => $members,
916             'messages' => $messages['messages']
917         ];
918     }
920     /**
921      * Mark a conversation as a favourite for the given user.
922      *
923      * @param int $conversationid the id of the conversation to mark as a favourite.
924      * @param int $userid the id of the user to whom the favourite belongs.
925      * @return favourite the favourite object.
926      * @throws \moodle_exception if the user or conversation don't exist.
927      */
928     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
929         global $DB;
931         if (!self::is_user_in_conversation($userid, $conversationid)) {
932             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
933         }
934         // Get the context for this conversation.
935         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
936         $userctx = \context_user::instance($userid);
937         if (empty($conversation->contextid)) {
938             // When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
939             $conversationctx = $userctx;
940         } else {
941             // If the contextid is defined, the favourite will be added there.
942             $conversationctx = \context::instance_by_id($conversation->contextid);
943         }
945         $ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
947         if ($favourite = $ufservice->get_favourite('core_message', 'message_conversations', $conversationid, $conversationctx)) {
948             return $favourite;
949         } else {
950             return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
951         }
952     }
954     /**
955      * Unset a conversation as a favourite for the given user.
956      *
957      * @param int $conversationid the id of the conversation to unset as a favourite.
958      * @param int $userid the id to whom the favourite belongs.
959      * @throws \moodle_exception if the favourite does not exist for the user.
960      */
961     public static function unset_favourite_conversation(int $conversationid, int $userid) {
962         global $DB;
964         // Get the context for this conversation.
965         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
966         $userctx = \context_user::instance($userid);
967         if (empty($conversation->contextid)) {
968             // When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
969             $conversationctx = $userctx;
970         } else {
971             // If the contextid is defined, the favourite will be added there.
972             $conversationctx = \context::instance_by_id($conversation->contextid);
973         }
975         $ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
976         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
977     }
979     /**
980      * Returns the contacts to display in the contacts area.
981      *
982      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
983      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
984      * Followup: MDL-63915
985      *
986      * @param int $userid The user id
987      * @param int $limitfrom
988      * @param int $limitnum
989      * @return array
990      */
991     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
992         global $DB;
994         $contactids = [];
995         $sql = "SELECT mc.*
996                   FROM {message_contacts} mc
997                  WHERE mc.userid = ? OR mc.contactid = ?
998               ORDER BY timecreated DESC";
999         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
1000             foreach ($contacts as $contact) {
1001                 if ($userid == $contact->userid) {
1002                     $contactids[] = $contact->contactid;
1003                 } else {
1004                     $contactids[] = $contact->userid;
1005                 }
1006             }
1007         }
1009         if (!empty($contactids)) {
1010             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
1012             $sql = "SELECT u.*, mub.id as isblocked
1013                       FROM {user} u
1014                  LEFT JOIN {message_users_blocked} mub
1015                         ON u.id = mub.blockeduserid
1016                      WHERE u.id $insql";
1017             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
1018                 $arrcontacts = [];
1019                 foreach ($contacts as $contact) {
1020                     $contact->blocked = $contact->isblocked ? 1 : 0;
1021                     $arrcontacts[] = helper::create_contact($contact);
1022                 }
1024                 return $arrcontacts;
1025             }
1026         }
1028         return [];
1029     }
1031     /**
1032      * Get the contacts for a given user.
1033      *
1034      * @param int $userid
1035      * @param int $limitfrom
1036      * @param int $limitnum
1037      * @return array An array of contacts
1038      */
1039     public static function get_user_contacts(int $userid, int $limitfrom = 0, int $limitnum = 0) {
1040         global $DB;
1042         $sql = "SELECT *
1043                   FROM {message_contacts} mc
1044                  WHERE mc.userid = ? OR mc.contactid = ?
1045               ORDER BY timecreated DESC, id ASC";
1046         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
1047             $userids = [];
1048             foreach ($contacts as $contact) {
1049                 if ($contact->userid == $userid) {
1050                     $userids[] = $contact->contactid;
1051                 } else {
1052                     $userids[] = $contact->userid;
1053                 }
1054             }
1055             return helper::get_member_info($userid, $userids);
1056         }
1058         return [];
1059     }
1061     /**
1062      * Returns the contacts count.
1063      *
1064      * @param int $userid The user id
1065      * @return array
1066      */
1067     public static function count_contacts(int $userid) : int {
1068         global $DB;
1070         $sql = "SELECT COUNT(id)
1071                   FROM {message_contacts}
1072                  WHERE userid = ? OR contactid = ?";
1073         return $DB->count_records_sql($sql, [$userid, $userid]);
1074     }
1076     /**
1077      * Returns the an array of the users the given user is in a conversation
1078      * with who are a contact and the number of unread messages.
1079      *
1080      * @param int $userid The user id
1081      * @param int $limitfrom
1082      * @param int $limitnum
1083      * @return array
1084      */
1085     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
1086         global $DB;
1088         $userfields = \user_picture::fields('u', array('lastaccess'));
1089         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
1090                               FROM {message_contacts} mc
1091                         INNER JOIN {user} u
1092                                 ON (u.id = mc.contactid OR u.id = mc.userid)
1093                          LEFT JOIN {messages} m
1094                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
1095                          LEFT JOIN {message_conversation_members} mcm
1096                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
1097                          LEFT JOIN {message_user_actions} mua
1098                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1099                          LEFT JOIN {message_users_blocked} mub
1100                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
1101                              WHERE mua.id is NULL
1102                                AND mub.id is NULL
1103                                AND (mc.userid = ? OR mc.contactid = ?)
1104                                AND u.id != ?
1105                                AND u.deleted = 0
1106                           GROUP BY $userfields";
1108         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
1109             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
1110     }
1112     /**
1113      * Returns the an array of the users the given user is in a conversation
1114      * with who are not a contact and the number of unread messages.
1115      *
1116      * @param int $userid The user id
1117      * @param int $limitfrom
1118      * @param int $limitnum
1119      * @return array
1120      */
1121     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
1122         global $DB;
1124         $userfields = \user_picture::fields('u', array('lastaccess'));
1125         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
1126                               FROM {user} u
1127                         INNER JOIN {messages} m
1128                                 ON m.useridfrom = u.id
1129                         INNER JOIN {message_conversation_members} mcm
1130                                 ON mcm.conversationid = m.conversationid
1131                          LEFT JOIN {message_user_actions} mua
1132                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1133                          LEFT JOIN {message_contacts} mc
1134                                 ON (mc.userid = ? AND mc.contactid = u.id)
1135                          LEFT JOIN {message_users_blocked} mub
1136                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
1137                              WHERE mcm.userid = ?
1138                                AND mcm.userid != m.useridfrom
1139                                AND mua.id is NULL
1140                                AND mub.id is NULL
1141                                AND mc.id is NULL
1142                                AND u.deleted = 0
1143                           GROUP BY $userfields";
1145         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
1146             $limitfrom, $limitnum);
1147     }
1149     /**
1150      * Returns the messages to display in the message area.
1151      *
1152      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1153      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1154      * Followup: MDL-63915
1155      *
1156      * @param int $userid the current user
1157      * @param int $otheruserid the other user
1158      * @param int $limitfrom
1159      * @param int $limitnum
1160      * @param string $sort
1161      * @param int $timefrom the time from the message being sent
1162      * @param int $timeto the time up until the message being sent
1163      * @return array
1164      */
1165     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
1166             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
1168         if (!empty($timefrom)) {
1169             // Get the conversation between userid and otheruserid.
1170             $userids = [$userid, $otheruserid];
1171             if (!$conversationid = self::get_conversation_between_users($userids)) {
1172                 // This method was always used for individual conversations.
1173                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1174                 $conversationid = $conversation->id;
1175             }
1177             // Check the cache to see if we even need to do a DB query.
1178             $cache = \cache::make('core', 'message_time_last_message_between_users');
1179             $key = helper::get_last_message_time_created_cache_key($conversationid);
1180             $lastcreated = $cache->get($key);
1182             // The last known message time is earlier than the one being requested so we can
1183             // just return an empty result set rather than having to query the DB.
1184             if ($lastcreated && $lastcreated < $timefrom) {
1185                 return [];
1186             }
1187         }
1189         $arrmessages = array();
1190         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
1191                                              $sort, $timefrom, $timeto)) {
1192             $arrmessages = helper::create_messages($userid, $messages);
1193         }
1195         return $arrmessages;
1196     }
1198     /**
1199      * Returns the messages for the defined conversation.
1200      *
1201      * @param  int $userid The current user.
1202      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
1203      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
1204      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
1205      * @param  string $sort The column name to order by including optionally direction.
1206      * @param  int $timefrom The time from the message being sent.
1207      * @param  int $timeto The time up until the message being sent.
1208      * @return array of messages
1209      */
1210     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
1211         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
1213         if (!empty($timefrom)) {
1214             // Check the cache to see if we even need to do a DB query.
1215             $cache = \cache::make('core', 'message_time_last_message_between_users');
1216             $key = helper::get_last_message_time_created_cache_key($convid);
1217             $lastcreated = $cache->get($key);
1219             // The last known message time is earlier than the one being requested so we can
1220             // just return an empty result set rather than having to query the DB.
1221             if ($lastcreated && $lastcreated < $timefrom) {
1222                 return [];
1223             }
1224         }
1226         $messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto);
1227         return helper::format_conversation_messages($userid, $convid, $messages);
1228     }
1230     /**
1231      * Returns the most recent message between two users.
1232      *
1233      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1234      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1235      * Followup: MDL-63915
1236      *
1237      * @param int $userid the current user
1238      * @param int $otheruserid the other user
1239      * @return \stdClass|null
1240      */
1241     public static function get_most_recent_message($userid, $otheruserid) {
1242         // We want two messages here so we get an accurate 'blocktime' value.
1243         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1244             // Swap the order so we now have them in historical order.
1245             $messages = array_reverse($messages);
1246             $arrmessages = helper::create_messages($userid, $messages);
1247             return array_pop($arrmessages);
1248         }
1250         return null;
1251     }
1253     /**
1254      * Returns the most recent message in a conversation.
1255      *
1256      * @param int $convid The conversation identifier.
1257      * @param int $currentuserid The current user identifier.
1258      * @return \stdClass|null The most recent message.
1259      */
1260     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1261         global $USER;
1263         if (empty($currentuserid)) {
1264             $currentuserid = $USER->id;
1265         }
1267         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1268             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1269             return array_pop($convmessages['messages']);
1270         }
1272         return null;
1273     }
1275     /**
1276      * Returns the profile information for a contact for a user.
1277      *
1278      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1279      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1280      * Followup: MDL-63915
1281      *
1282      * @param int $userid The user id
1283      * @param int $otheruserid The id of the user whose profile we want to view.
1284      * @return \stdClass
1285      */
1286     public static function get_profile($userid, $otheruserid) {
1287         global $CFG, $PAGE;
1289         require_once($CFG->dirroot . '/user/lib.php');
1291         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1293         // Create the data we are going to pass to the renderable.
1294         $data = new \stdClass();
1295         $data->userid = $otheruserid;
1296         $data->fullname = fullname($user);
1297         $data->city = '';
1298         $data->country = '';
1299         $data->email = '';
1300         $data->isonline = null;
1301         // Get the user picture data - messaging has always shown these to the user.
1302         $userpicture = new \user_picture($user);
1303         $userpicture->size = 1; // Size f1.
1304         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1305         $userpicture->size = 0; // Size f2.
1306         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1308         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1309         if ($userfields) {
1310             if (isset($userfields['city'])) {
1311                 $data->city = $userfields['city'];
1312             }
1313             if (isset($userfields['country'])) {
1314                 $data->country = $userfields['country'];
1315             }
1316             if (isset($userfields['email'])) {
1317                 $data->email = $userfields['email'];
1318             }
1319             if (isset($userfields['lastaccess'])) {
1320                 $data->isonline = helper::is_online($userfields['lastaccess']);
1321             }
1322         }
1324         $data->isblocked = self::is_blocked($userid, $otheruserid);
1325         $data->iscontact = self::is_contact($userid, $otheruserid);
1327         return $data;
1328     }
1330     /**
1331      * Checks if a user can delete messages they have either received or sent.
1332      *
1333      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1334      *  but will still seem as if it was by the user)
1335      * @param int $conversationid The id of the conversation
1336      * @return bool Returns true if a user can delete the conversation, false otherwise.
1337      */
1338     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1339         global $USER;
1341         if (is_null($conversationid)) {
1342             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1343                 DEBUG_DEVELOPER);
1344             return false;
1345         }
1347         $systemcontext = \context_system::instance();
1349         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1350             return true;
1351         }
1353         if (!self::is_user_in_conversation($userid, $conversationid)) {
1354             return false;
1355         }
1357         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1358                 $USER->id == $userid) {
1359             return true;
1360         }
1362         return false;
1363     }
1365     /**
1366      * Deletes a conversation.
1367      *
1368      * This function does not verify any permissions.
1369      *
1370      * @deprecated since 3.6
1371      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1372      *  but will still seem as if it was by the user)
1373      * @param int $otheruserid The id of the other user in the conversation
1374      * @return bool
1375      */
1376     public static function delete_conversation($userid, $otheruserid) {
1377         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1378             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1380         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1382         // If there is no conversation, there is nothing to do.
1383         if (!$conversationid) {
1384             return true;
1385         }
1387         self::delete_conversation_by_id($userid, $conversationid);
1389         return true;
1390     }
1392     /**
1393      * Deletes a conversation for a specified user.
1394      *
1395      * This function does not verify any permissions.
1396      *
1397      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1398      *  but will still seem as if it was by the user)
1399      * @param int $conversationid The id of the other user in the conversation
1400      */
1401     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1402         global $DB, $USER;
1404         // Get all messages belonging to this conversation that have not already been deleted by this user.
1405         $sql = "SELECT m.*
1406                  FROM {messages} m
1407            INNER JOIN {message_conversations} mc
1408                    ON m.conversationid = mc.id
1409             LEFT JOIN {message_user_actions} mua
1410                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1411                 WHERE mua.id is NULL
1412                   AND mc.id = ?
1413              ORDER BY m.timecreated ASC";
1414         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1416         // Ok, mark these as deleted.
1417         foreach ($messages as $message) {
1418             $mua = new \stdClass();
1419             $mua->userid = $userid;
1420             $mua->messageid = $message->id;
1421             $mua->action = self::MESSAGE_ACTION_DELETED;
1422             $mua->timecreated = time();
1423             $mua->id = $DB->insert_record('message_user_actions', $mua);
1425             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1426                 $message->id, $mua->id)->trigger();
1427         }
1428     }
1430     /**
1431      * Returns the count of unread conversations (collection of messages from a single user) for
1432      * the given user.
1433      *
1434      * @param \stdClass $user the user who's conversations should be counted
1435      * @return int the count of the user's unread conversations
1436      */
1437     public static function count_unread_conversations($user = null) {
1438         global $USER, $DB;
1440         if (empty($user)) {
1441             $user = $USER;
1442         }
1444         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1445                   FROM {messages} m
1446             INNER JOIN {message_conversations} mc
1447                     ON m.conversationid = mc.id
1448             INNER JOIN {message_conversation_members} mcm
1449                     ON mc.id = mcm.conversationid
1450              LEFT JOIN {message_user_actions} mua
1451                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1452                  WHERE mcm.userid = ?
1453                    AND mcm.userid != m.useridfrom
1454                    AND mua.id is NULL";
1456         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1457     }
1459     /**
1460      * Checks if a user can mark all messages as read.
1461      *
1462      * @param int $userid The user id of who we want to mark the messages for
1463      * @param int $conversationid The id of the conversation
1464      * @return bool true if user is permitted, false otherwise
1465      * @since 3.6
1466      */
1467     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1468         global $USER;
1470         $systemcontext = \context_system::instance();
1472         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1473             return true;
1474         }
1476         if (!self::is_user_in_conversation($userid, $conversationid)) {
1477             return false;
1478         }
1480         if ($USER->id == $userid) {
1481             return true;
1482         }
1484         return false;
1485     }
1487     /**
1488      * Returns the count of conversations (collection of messages from a single user) for
1489      * the given user.
1490      *
1491      * @param int $userid The user whose conversations should be counted.
1492      * @return array the array of conversations counts, indexed by type.
1493      */
1494     public static function get_conversation_counts(int $userid) : array {
1495         global $DB;
1497         // Some restrictions we need to be aware of:
1498         // - Individual conversations containing soft-deleted user must be counted.
1499         // - Individual conversations containing only deleted messages must NOT be counted.
1500         // - Group conversations with 0 messages must be counted.
1501         // - Linked conversations which are disabled (enabled = 0) must NOT be counted.
1502         // - Any type of conversation can be included in the favourites count, however, the type counts and the favourites count
1503         // are mutually exclusive; any conversations which are counted in favourites cannot be counted elsewhere.
1505         // First, ask the favourites service to give us the join SQL for favourited conversations,
1506         // so we can include favourite information in the query.
1507         $usercontext = \context_user::instance($userid);
1508         $favservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
1509         list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_message', 'message_conversations', 'fav', 'mc.id');
1511         $sql = "SELECT mc.type, fav.itemtype, COUNT(DISTINCT mc.id) as count
1512                   FROM {message_conversations} mc
1513             INNER JOIN {message_conversation_members} mcm
1514                     ON mcm.conversationid = mc.id
1515              LEFT JOIN (
1516                               SELECT m.conversationid as convid, MAX(m.timecreated) as maxtime
1517                                 FROM {messages} m
1518                           INNER JOIN {message_conversation_members} mcm
1519                                   ON mcm.conversationid = m.conversationid
1520                            LEFT JOIN {message_user_actions} mua
1521                                   ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
1522                                WHERE mua.id is NULL
1523                                  AND mcm.userid = :userid2
1524                             GROUP BY m.conversationid
1525                        ) maxvisibleconvmessage
1526                     ON maxvisibleconvmessage.convid = mc.id
1527                $favsql
1528                  WHERE mcm.userid = :userid3
1529                    AND mc.enabled = :enabled
1530                    AND ((mc.type = :individualtype AND maxvisibleconvmessage.convid IS NOT NULL) OR (mc.type = :grouptype))
1531               GROUP BY mc.type, fav.itemtype
1532               ORDER BY mc.type ASC";
1534         $params = [
1535             'userid' => $userid,
1536             'userid2' => $userid,
1537             'userid3' => $userid,
1538             'userid4' => $userid,
1539             'action' => self::MESSAGE_ACTION_DELETED,
1540             'enabled' => self::MESSAGE_CONVERSATION_ENABLED,
1541             'individualtype' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1542             'grouptype' => self::MESSAGE_CONVERSATION_TYPE_GROUP,
1543         ] + $favparams;
1545         // Assemble the return array.
1546         $counts = [
1547             'favourites' => 0,
1548             'types' => [
1549                 self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL => 0,
1550                 self::MESSAGE_CONVERSATION_TYPE_GROUP => 0
1551             ]
1552         ];
1554         $countsrs = $DB->get_recordset_sql($sql, $params);
1555         foreach ($countsrs as $key => $val) {
1556             if (!empty($val->itemtype)) {
1557                 $counts['favourites'] += $val->count;
1558                 continue;
1559             }
1560             $counts['types'][$val->type] = $val->count;
1561         }
1562         $countsrs->close();
1564         return $counts;
1565     }
1567     /**
1568      * Marks all messages being sent to a user in a particular conversation.
1569      *
1570      * If $conversationdid is null then it marks all messages as read sent to $userid.
1571      *
1572      * @param int $userid
1573      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1574      */
1575     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1576         global $DB;
1578         $messagesql = "SELECT m.*
1579                          FROM {messages} m
1580                    INNER JOIN {message_conversations} mc
1581                            ON mc.id = m.conversationid
1582                    INNER JOIN {message_conversation_members} mcm
1583                            ON mcm.conversationid = mc.id
1584                     LEFT JOIN {message_user_actions} mua
1585                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1586                         WHERE mua.id is NULL
1587                           AND mcm.userid = ?
1588                           AND m.useridfrom != ?";
1589         $messageparams = [];
1590         $messageparams[] = $userid;
1591         $messageparams[] = self::MESSAGE_ACTION_READ;
1592         $messageparams[] = $userid;
1593         $messageparams[] = $userid;
1594         if (!is_null($conversationid)) {
1595             $messagesql .= " AND mc.id = ?";
1596             $messageparams[] = $conversationid;
1597         }
1599         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1600         foreach ($messages as $message) {
1601             self::mark_message_as_read($userid, $message);
1602         }
1603         $messages->close();
1604     }
1606     /**
1607      * Marks all notifications being sent from one user to another user as read.
1608      *
1609      * If the from user is null then it marks all notifications as read sent to the to user.
1610      *
1611      * @param int $touserid the id of the message recipient
1612      * @param int|null $fromuserid the id of the message sender, null if all messages
1613      * @return void
1614      */
1615     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1616         global $DB;
1618         $notificationsql = "SELECT n.*
1619                               FROM {notifications} n
1620                              WHERE useridto = ?
1621                                AND timeread is NULL";
1622         $notificationsparams = [$touserid];
1623         if (!empty($fromuserid)) {
1624             $notificationsql .= " AND useridfrom = ?";
1625             $notificationsparams[] = $fromuserid;
1626         }
1628         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1629         foreach ($notifications as $notification) {
1630             self::mark_notification_as_read($notification);
1631         }
1632         $notifications->close();
1633     }
1635     /**
1636      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1637      *
1638      * Can be filtered by type.
1639      *
1640      * @deprecated since 3.5
1641      * @param int $touserid the id of the message recipient
1642      * @param int $fromuserid the id of the message sender
1643      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1644      * @return void
1645      */
1646     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1647         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1648             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1649             DEBUG_DEVELOPER);
1651         $type = strtolower($type);
1653         $conversationid = null;
1654         $ignoremessages = false;
1655         if (!empty($fromuserid)) {
1656             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1657             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1658                 $ignoremessages = true;
1659             }
1660         }
1662         if (!empty($type)) {
1663             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1664                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1665             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1666                 if (!$ignoremessages) {
1667                     self::mark_all_messages_as_read($touserid, $conversationid);
1668                 }
1669             }
1670         } else { // We want both.
1671             self::mark_all_notifications_as_read($touserid, $fromuserid);
1672             if (!$ignoremessages) {
1673                 self::mark_all_messages_as_read($touserid, $conversationid);
1674             }
1675         }
1676     }
1678     /**
1679      * Returns message preferences.
1680      *
1681      * @param array $processors
1682      * @param array $providers
1683      * @param \stdClass $user
1684      * @return \stdClass
1685      * @since 3.2
1686      */
1687     public static function get_all_message_preferences($processors, $providers, $user) {
1688         $preferences = helper::get_providers_preferences($providers, $user->id);
1689         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1691         // For every processors put its options on the form (need to get function from processor's lib.php).
1692         foreach ($processors as $processor) {
1693             $processor->object->load_data($preferences, $user->id);
1694         }
1696         // Load general messaging preferences.
1697         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1698         $preferences->mailformat = $user->mailformat;
1699         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1701         return $preferences;
1702     }
1704     /**
1705      * Count the number of users blocked by a user.
1706      *
1707      * @param \stdClass $user The user object
1708      * @return int the number of blocked users
1709      */
1710     public static function count_blocked_users($user = null) {
1711         global $USER, $DB;
1713         if (empty($user)) {
1714             $user = $USER;
1715         }
1717         $sql = "SELECT count(mub.id)
1718                   FROM {message_users_blocked} mub
1719                  WHERE mub.userid = :userid";
1720         return $DB->count_records_sql($sql, array('userid' => $user->id));
1721     }
1723     /**
1724      * Determines if a user is permitted to send another user a private message.
1725      * If no sender is provided then it defaults to the logged in user.
1726      *
1727      * @param \stdClass $recipient The user object.
1728      * @param \stdClass|null $sender The user object.
1729      * @return bool true if user is permitted, false otherwise.
1730      */
1731     public static function can_post_message($recipient, $sender = null) {
1732         global $USER;
1734         if (is_null($sender)) {
1735             // The message is from the logged in user, unless otherwise specified.
1736             $sender = $USER;
1737         }
1739         $systemcontext = \context_system::instance();
1740         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1741             return false;
1742         }
1744         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1745             return true;
1746         }
1748         // Check if the recipient can be messaged by the sender.
1749         return (self::can_contact_user($recipient->id, $sender->id));
1750     }
1752     /**
1753      * Determines if a user is permitted to send a message to a given conversation.
1754      * If no sender is provided then it defaults to the logged in user.
1755      *
1756      * @param int $userid the id of the user on which the checks will be applied.
1757      * @param int $conversationid the id of the conversation we wish to check.
1758      * @return bool true if the user can send a message to the conversation, false otherwise.
1759      * @throws \moodle_exception
1760      */
1761     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1762         global $DB;
1764         $systemcontext = \context_system::instance();
1765         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1766             return false;
1767         }
1769         if (!self::is_user_in_conversation($userid, $conversationid)) {
1770             return false;
1771         }
1773         // User can post messages and is in the conversation, but we need to check the conversation type to
1774         // know whether or not to check the user privacy settings via can_contact_user().
1775         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1776         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1777             return true;
1778         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1779             // Get the other user in the conversation.
1780             $members = self::get_conversation_members($userid, $conversationid);
1781             $otheruser = array_filter($members, function($member) use($userid) {
1782                 return $member->id != $userid;
1783             });
1784             $otheruser = reset($otheruser);
1786             return self::can_contact_user($otheruser->id, $userid);
1787         } else {
1788             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1789         }
1790     }
1792     /**
1793      * Send a message from a user to a conversation.
1794      *
1795      * This method will create the basic eventdata and delegate to message creation to message_send.
1796      * The message_send() method is responsible for event data that is specific to each recipient.
1797      *
1798      * @param int $userid the sender id.
1799      * @param int $conversationid the conversation id.
1800      * @param string $message the message to send.
1801      * @param int $format the format of the message to send.
1802      * @return \stdClass the message created.
1803      * @throws \coding_exception
1804      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1805      */
1806     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1807                                                         int $format) : \stdClass {
1808         global $DB;
1810         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1811             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1812         }
1814         $eventdata = new \core\message\message();
1815         $eventdata->courseid         = 1;
1816         $eventdata->component        = 'moodle';
1817         $eventdata->name             = 'instantmessage';
1818         $eventdata->userfrom         = $userid;
1819         $eventdata->convid           = $conversationid;
1821         if ($format == FORMAT_HTML) {
1822             $eventdata->fullmessagehtml  = $message;
1823             // Some message processors may revert to sending plain text even if html is supplied,
1824             // so we keep both plain and html versions if we're intending to send html.
1825             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1826         } else {
1827             $eventdata->fullmessage      = $message;
1828             $eventdata->fullmessagehtml  = '';
1829         }
1831         $eventdata->fullmessageformat = $format;
1832         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1834         $eventdata->timecreated     = time();
1835         $eventdata->notification    = 0;
1836         $messageid = message_send($eventdata);
1838         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1839         $message = (object) [
1840             'id' => $messagerecord->id,
1841             'useridfrom' => $messagerecord->useridfrom,
1842             'text' => $messagerecord->fullmessage,
1843             'timecreated' => $messagerecord->timecreated
1844         ];
1845         return $message;
1846     }
1848     /**
1849      * Get the messaging preference for a user.
1850      * If the user has not any messaging privacy preference:
1851      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1852      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1853      *
1854      * @param  int    $userid The user identifier.
1855      * @return int    The default messaging preference.
1856      */
1857     public static function get_user_privacy_messaging_preference(int $userid) : int {
1858         global $CFG, $USER;
1860         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1861         // otherwise, the default value will be "My contacts and anyone in my courses".
1862         if (empty($CFG->messagingallusers)) {
1863             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1864         } else {
1865             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1866         }
1867         if ($userid == $USER->id) {
1868             $user = $USER;
1869         } else {
1870             $user = $userid;
1871         }
1872         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $user);
1874         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1875         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1876         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1877             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1878         }
1880         return $privacypreference;
1881     }
1883     /**
1884      * Checks if the recipient is allowing messages from users that aren't a
1885      * contact. If not then it checks to make sure the sender is in the
1886      * recipient's contacts.
1887      *
1888      * @deprecated since 3.6
1889      * @param \stdClass $recipient The user object.
1890      * @param \stdClass|null $sender The user object.
1891      * @return bool true if $sender is blocked, false otherwise.
1892      */
1893     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1894         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1896         global $USER, $CFG;
1898         if (is_null($sender)) {
1899             // The message is from the logged in user, unless otherwise specified.
1900             $sender = $USER;
1901         }
1903         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1904         switch ($privacypreference) {
1905             case self::MESSAGE_PRIVACY_SITE:
1906                 if (!empty($CFG->messagingallusers)) {
1907                     // Users can be messaged without being contacts or members of the same course.
1908                     break;
1909                 }
1910                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1911                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1912             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1913                 // Confirm the sender and the recipient are both members of the same course.
1914                 if (enrol_sharing_course($recipient, $sender)) {
1915                     // All good, the recipient and the sender are members of the same course.
1916                     return false;
1917                 }
1918             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1919                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1920                 return !self::is_contact($sender->id, $recipient->id);
1921         }
1923         return false;
1924     }
1926     /**
1927      * Checks if the recipient has specifically blocked the sending user.
1928      *
1929      * Note: This function will always return false if the sender has the
1930      * readallmessages capability at the system context level.
1931      *
1932      * @deprecated since 3.6
1933      * @param int $recipientid User ID of the recipient.
1934      * @param int $senderid User ID of the sender.
1935      * @return bool true if $sender is blocked, false otherwise.
1936      */
1937     public static function is_user_blocked($recipientid, $senderid = null) {
1938         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1939             DEBUG_DEVELOPER);
1941         global $USER;
1943         if (is_null($senderid)) {
1944             // The message is from the logged in user, unless otherwise specified.
1945             $senderid = $USER->id;
1946         }
1948         $systemcontext = \context_system::instance();
1949         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1950             return false;
1951         }
1953         if (self::is_blocked($recipientid, $senderid)) {
1954             return true;
1955         }
1957         return false;
1958     }
1960     /**
1961      * Get specified message processor, validate corresponding plugin existence and
1962      * system configuration.
1963      *
1964      * @param string $name  Name of the processor.
1965      * @param bool $ready only return ready-to-use processors.
1966      * @return mixed $processor if processor present else empty array.
1967      * @since Moodle 3.2
1968      */
1969     public static function get_message_processor($name, $ready = false) {
1970         global $DB, $CFG;
1972         $processor = $DB->get_record('message_processors', array('name' => $name));
1973         if (empty($processor)) {
1974             // Processor not found, return.
1975             return array();
1976         }
1978         $processor = self::get_processed_processor_object($processor);
1979         if ($ready) {
1980             if ($processor->enabled && $processor->configured) {
1981                 return $processor;
1982             } else {
1983                 return array();
1984             }
1985         } else {
1986             return $processor;
1987         }
1988     }
1990     /**
1991      * Returns weather a given processor is enabled or not.
1992      * Note:- This doesn't check if the processor is configured or not.
1993      *
1994      * @param string $name Name of the processor
1995      * @return bool
1996      */
1997     public static function is_processor_enabled($name) {
1999         $cache = \cache::make('core', 'message_processors_enabled');
2000         $status = $cache->get($name);
2002         if ($status === false) {
2003             $processor = self::get_message_processor($name);
2004             if (!empty($processor)) {
2005                 $cache->set($name, $processor->enabled);
2006                 return $processor->enabled;
2007             } else {
2008                 return false;
2009             }
2010         }
2012         return $status;
2013     }
2015     /**
2016      * Set status of a processor.
2017      *
2018      * @param \stdClass $processor processor record.
2019      * @param 0|1 $enabled 0 or 1 to set the processor status.
2020      * @return bool
2021      * @since Moodle 3.2
2022      */
2023     public static function update_processor_status($processor, $enabled) {
2024         global $DB;
2025         $cache = \cache::make('core', 'message_processors_enabled');
2026         $cache->delete($processor->name);
2027         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
2028     }
2030     /**
2031      * Given a processor object, loads information about it's settings and configurations.
2032      * This is not a public api, instead use @see \core_message\api::get_message_processor()
2033      * or @see \get_message_processors()
2034      *
2035      * @param \stdClass $processor processor object
2036      * @return \stdClass processed processor object
2037      * @since Moodle 3.2
2038      */
2039     public static function get_processed_processor_object(\stdClass $processor) {
2040         global $CFG;
2042         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2043         if (is_readable($processorfile)) {
2044             include_once($processorfile);
2045             $processclass = 'message_output_' . $processor->name;
2046             if (class_exists($processclass)) {
2047                 $pclass = new $processclass();
2048                 $processor->object = $pclass;
2049                 $processor->configured = 0;
2050                 if ($pclass->is_system_configured()) {
2051                     $processor->configured = 1;
2052                 }
2053                 $processor->hassettings = 0;
2054                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2055                     $processor->hassettings = 1;
2056                 }
2057                 $processor->available = 1;
2058             } else {
2059                 print_error('errorcallingprocessor', 'message');
2060             }
2061         } else {
2062             $processor->available = 0;
2063         }
2064         return $processor;
2065     }
2067     /**
2068      * Retrieve users blocked by $user1
2069      *
2070      * @param int $userid The user id of the user whos blocked users we are returning
2071      * @return array the users blocked
2072      */
2073     public static function get_blocked_users($userid) {
2074         global $DB;
2076         $userfields = \user_picture::fields('u', array('lastaccess'));
2077         $blockeduserssql = "SELECT $userfields
2078                               FROM {message_users_blocked} mub
2079                         INNER JOIN {user} u
2080                                 ON u.id = mub.blockeduserid
2081                              WHERE u.deleted = 0
2082                                AND mub.userid = ?
2083                           GROUP BY $userfields
2084                           ORDER BY u.firstname ASC";
2085         return $DB->get_records_sql($blockeduserssql, [$userid]);
2086     }
2088     /**
2089      * Mark a single message as read.
2090      *
2091      * @param int $userid The user id who marked the message as read
2092      * @param \stdClass $message The message
2093      * @param int|null $timeread The time the message was marked as read, if null will default to time()
2094      */
2095     public static function mark_message_as_read($userid, $message, $timeread = null) {
2096         global $DB;
2098         if (is_null($timeread)) {
2099             $timeread = time();
2100         }
2102         $mua = new \stdClass();
2103         $mua->userid = $userid;
2104         $mua->messageid = $message->id;
2105         $mua->action = self::MESSAGE_ACTION_READ;
2106         $mua->timecreated = $timeread;
2107         $mua->id = $DB->insert_record('message_user_actions', $mua);
2109         // Get the context for the user who received the message.
2110         $context = \context_user::instance($userid, IGNORE_MISSING);
2111         // If the user no longer exists the context value will be false, in this case use the system context.
2112         if ($context === false) {
2113             $context = \context_system::instance();
2114         }
2116         // Trigger event for reading a message.
2117         $event = \core\event\message_viewed::create(array(
2118             'objectid' => $mua->id,
2119             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
2120             'context' => $context,
2121             'relateduserid' => $message->useridfrom,
2122             'other' => array(
2123                 'messageid' => $message->id
2124             )
2125         ));
2126         $event->trigger();
2127     }
2129     /**
2130      * Mark a single notification as read.
2131      *
2132      * @param \stdClass $notification The notification
2133      * @param int|null $timeread The time the message was marked as read, if null will default to time()
2134      */
2135     public static function mark_notification_as_read($notification, $timeread = null) {
2136         global $DB;
2138         if (is_null($timeread)) {
2139             $timeread = time();
2140         }
2142         if (is_null($notification->timeread)) {
2143             $updatenotification = new \stdClass();
2144             $updatenotification->id = $notification->id;
2145             $updatenotification->timeread = $timeread;
2147             $DB->update_record('notifications', $updatenotification);
2149             // Trigger event for reading a notification.
2150             \core\event\notification_viewed::create_from_ids(
2151                 $notification->useridfrom,
2152                 $notification->useridto,
2153                 $notification->id
2154             )->trigger();
2155         }
2156     }
2158     /**
2159      * Checks if a user can delete a message.
2160      *
2161      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
2162      *  but will still seem as if it was by the user)
2163      * @param int $messageid The message id
2164      * @return bool Returns true if a user can delete the message, false otherwise.
2165      */
2166     public static function can_delete_message($userid, $messageid) {
2167         global $DB, $USER;
2169         $systemcontext = \context_system::instance();
2171         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
2173         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
2174             return true;
2175         }
2177         if (!self::is_user_in_conversation($userid, $conversationid)) {
2178             return false;
2179         }
2181         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
2182                 $USER->id == $userid) {
2183             return true;
2184         }
2186         return false;
2187     }
2189     /**
2190      * Deletes a message.
2191      *
2192      * This function does not verify any permissions.
2193      *
2194      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
2195      *  but will still seem as if it was by the user)
2196      * @param int $messageid The message id
2197      * @return bool
2198      */
2199     public static function delete_message($userid, $messageid) {
2200         global $DB, $USER;
2202         if (!$DB->record_exists('messages', ['id' => $messageid])) {
2203             return false;
2204         }
2206         // Check if the user has already deleted this message.
2207         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
2208                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
2209             $mua = new \stdClass();
2210             $mua->userid = $userid;
2211             $mua->messageid = $messageid;
2212             $mua->action = self::MESSAGE_ACTION_DELETED;
2213             $mua->timecreated = time();
2214             $mua->id = $DB->insert_record('message_user_actions', $mua);
2216             // Trigger event for deleting a message.
2217             \core\event\message_deleted::create_from_ids($userid, $USER->id,
2218                 $messageid, $mua->id)->trigger();
2220             return true;
2221         }
2223         return false;
2224     }
2226     /**
2227      * Returns the conversation between two users.
2228      *
2229      * @param array $userids
2230      * @return int|bool The id of the conversation, false if not found
2231      */
2232     public static function get_conversation_between_users(array $userids) {
2233         global $DB;
2235         $conversations = self::get_individual_conversations_between_users([$userids]);
2236         $conversation = $conversations[0];
2238         if ($conversation) {
2239             return $conversation->id;
2240         }
2242         return false;
2243     }
2245     /**
2246      * Returns the conversations between sets of users.
2247      *
2248      * The returned array of results will be in the same order as the requested
2249      * arguments, null will be returned if there is no conversation for that user
2250      * pair.
2251      *
2252      * For example:
2253      * If we have 6 users with ids 1, 2, 3, 4, 5, 6 where only 2 conversations
2254      * exist. One between 1 and 2 and another between 5 and 6.
2255      *
2256      * Then if we call:
2257      * $conversations = get_individual_conversations_between_users([[1,2], [3,4], [5,6]]);
2258      *
2259      * The conversations array will look like:
2260      * [<conv_record>, null, <conv_record>];
2261      *
2262      * Where null is returned for the pairing of [3, 4] since no record exists.
2263      *
2264      * @param array $useridsets An array of arrays where the inner array is the set of user ids
2265      * @return stdClass[] Array of conversation records
2266      */
2267     public static function get_individual_conversations_between_users(array $useridsets) : array {
2268         global $DB;
2270         if (empty($useridsets)) {
2271             return [];
2272         }
2274         $hashes = array_map(function($userids) {
2275             return  helper::get_conversation_hash($userids);
2276         }, $useridsets);
2278         list($inorequalsql, $params) = $DB->get_in_or_equal($hashes);
2279         array_unshift($params, self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL);
2280         $where = "type = ? AND convhash ${inorequalsql}";
2281         $conversations = array_fill(0, count($hashes), null);
2282         $records = $DB->get_records_select('message_conversations', $where, $params);
2284         foreach (array_values($records) as $record) {
2285             $index = array_search($record->convhash, $hashes);
2286             if ($index !== false) {
2287                 $conversations[$index] = $record;
2288             }
2289         }
2291         return $conversations;
2292     }
2294     /**
2295      * Creates a conversation between two users.
2296      *
2297      * @deprecated since 3.6
2298      * @param array $userids
2299      * @return int The id of the conversation
2300      */
2301     public static function create_conversation_between_users(array $userids) {
2302         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
2303             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
2305         // This method was always used for individual conversations.
2306         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
2308         return $conversation->id;
2309     }
2311     /**
2312      * Creates a conversation with selected users and messages.
2313      *
2314      * @param int $type The type of conversation
2315      * @param int[] $userids The array of users to add to the conversation
2316      * @param string|null $name The name of the conversation
2317      * @param int $enabled Determines if the conversation is created enabled or disabled
2318      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
2319      * @param string|null $itemtype Defines the type of the component
2320      * @param int|null $itemid The id of the component
2321      * @param int|null $contextid The id of the context
2322      * @return \stdClass
2323      */
2324     public static function create_conversation(int $type, array $userids, string $name = null,
2325             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
2326             string $itemtype = null, int $itemid = null, int $contextid = null) {
2328         global $DB;
2330         $validtypes = [
2331             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
2332             self::MESSAGE_CONVERSATION_TYPE_GROUP
2333         ];
2335         if (!in_array($type, $validtypes)) {
2336             throw new \moodle_exception('An invalid conversation type was specified.');
2337         }
2339         // Sanity check.
2340         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2341             if (count($userids) > 2) {
2342                 throw new \moodle_exception('An individual conversation can not have more than two users.');
2343             }
2344         }
2346         $conversation = new \stdClass();
2347         $conversation->type = $type;
2348         $conversation->name = $name;
2349         $conversation->convhash = null;
2350         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2351             $conversation->convhash = helper::get_conversation_hash($userids);
2352         }
2353         $conversation->component = $component;
2354         $conversation->itemtype = $itemtype;
2355         $conversation->itemid = $itemid;
2356         $conversation->contextid = $contextid;
2357         $conversation->enabled = $enabled;
2358         $conversation->timecreated = time();
2359         $conversation->timemodified = $conversation->timecreated;
2360         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2362         // Add users to this conversation.
2363         $arrmembers = [];
2364         foreach ($userids as $userid) {
2365             $member = new \stdClass();
2366             $member->conversationid = $conversation->id;
2367             $member->userid = $userid;
2368             $member->timecreated = time();
2369             $member->id = $DB->insert_record('message_conversation_members', $member);
2371             $arrmembers[] = $member;
2372         }
2374         $conversation->members = $arrmembers;
2376         return $conversation;
2377     }
2379     /**
2380      * Checks if a user can create a group conversation.
2381      *
2382      * @param int $userid The id of the user attempting to create the conversation
2383      * @param \context $context The context they are creating the conversation from, most likely course context
2384      * @return bool
2385      */
2386     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2387         global $CFG;
2389         // If we can't message at all, then we can't create a conversation.
2390         if (empty($CFG->messaging)) {
2391             return false;
2392         }
2394         // We need to check they have the capability to create the conversation.
2395         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2396     }
2398     /**
2399      * Checks if a user can create a contact request.
2400      *
2401      * @param int $userid The id of the user who is creating the contact request
2402      * @param int $requesteduserid The id of the user being requested
2403      * @return bool
2404      */
2405     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2406         global $CFG;
2408         // If we can't message at all, then we can't create a contact.
2409         if (empty($CFG->messaging)) {
2410             return false;
2411         }
2413         // If we can message anyone on the site then we can create a contact.
2414         if ($CFG->messagingallusers) {
2415             return true;
2416         }
2418         // We need to check if they are in the same course.
2419         return enrol_sharing_course($userid, $requesteduserid);
2420     }
2422     /**
2423      * Handles creating a contact request.
2424      *
2425      * @param int $userid The id of the user who is creating the contact request
2426      * @param int $requesteduserid The id of the user being requested
2427      * @return \stdClass the request
2428      */
2429     public static function create_contact_request(int $userid, int $requesteduserid) : \stdClass {
2430         global $DB;
2432         $request = new \stdClass();
2433         $request->userid = $userid;
2434         $request->requesteduserid = $requesteduserid;
2435         $request->timecreated = time();
2437         $request->id = $DB->insert_record('message_contact_requests', $request);
2439         return $request;
2440     }
2443     /**
2444      * Handles confirming a contact request.
2445      *
2446      * @param int $userid The id of the user who created the contact request
2447      * @param int $requesteduserid The id of the user confirming the request
2448      */
2449     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2450         global $DB;
2452         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2453                 'requesteduserid' => $requesteduserid])) {
2454             self::add_contact($userid, $requesteduserid);
2456             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2457         }
2458     }
2460     /**
2461      * Handles declining a contact request.
2462      *
2463      * @param int $userid The id of the user who created the contact request
2464      * @param int $requesteduserid The id of the user declining the request
2465      */
2466     public static function decline_contact_request(int $userid, int $requesteduserid) {
2467         global $DB;
2469         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2470                 'requesteduserid' => $requesteduserid])) {
2471             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2472         }
2473     }
2475     /**
2476      * Handles returning the contact requests for a user.
2477      *
2478      * This also includes the user data necessary to display information
2479      * about the user.
2480      *
2481      * It will not include blocked users.
2482      *
2483      * @param int $userid
2484      * @param int $limitfrom
2485      * @param int $limitnum
2486      * @return array The list of contact requests
2487      */
2488     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2489         global $DB;
2491         $sql = "SELECT mcr.userid
2492                   FROM {message_contact_requests} mcr
2493              LEFT JOIN {message_users_blocked} mub
2494                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2495                  WHERE mcr.requesteduserid = ?
2496                    AND mub.id is NULL
2497               ORDER BY mcr.timecreated ASC";
2498         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2499             $userids = array_keys($contactrequests);
2500             return helper::get_member_info($userid, $userids);
2501         }
2503         return [];
2504     }
2506     /**
2507      * Returns the number of contact requests the user has received.
2508      *
2509      * @param int $userid The ID of the user we want to return the number of received contact requests for
2510      * @return int The count
2511      */
2512     public static function get_received_contact_requests_count(int $userid) : int {
2513         global $DB;
2514         return $DB->count_records('message_contact_requests', ['requesteduserid' => $userid]);
2515     }
2517     /**
2518      * Handles adding a contact.
2519      *
2520      * @param int $userid The id of the user who requested to be a contact
2521      * @param int $contactid The id of the contact
2522      */
2523     public static function add_contact(int $userid, int $contactid) {
2524         global $DB;
2526         $messagecontact = new \stdClass();
2527         $messagecontact->userid = $userid;
2528         $messagecontact->contactid = $contactid;
2529         $messagecontact->timecreated = time();
2530         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2532         $eventparams = [
2533             'objectid' => $messagecontact->id,
2534             'userid' => $userid,
2535             'relateduserid' => $contactid,
2536             'context' => \context_user::instance($userid)
2537         ];
2538         $event = \core\event\message_contact_added::create($eventparams);
2539         $event->add_record_snapshot('message_contacts', $messagecontact);
2540         $event->trigger();
2541     }
2543     /**
2544      * Handles removing a contact.
2545      *
2546      * @param int $userid The id of the user who is removing a user as a contact
2547      * @param int $contactid The id of the user to be removed as a contact
2548      */
2549     public static function remove_contact(int $userid, int $contactid) {
2550         global $DB;
2552         if ($contact = self::get_contact($userid, $contactid)) {
2553             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2555             $event = \core\event\message_contact_removed::create(array(
2556                 'objectid' => $contact->id,
2557                 'userid' => $userid,
2558                 'relateduserid' => $contactid,
2559                 'context' => \context_user::instance($userid)
2560             ));
2561             $event->add_record_snapshot('message_contacts', $contact);
2562             $event->trigger();
2563         }
2564     }
2566     /**
2567      * Handles blocking a user.
2568      *
2569      * @param int $userid The id of the user who is blocking
2570      * @param int $usertoblockid The id of the user being blocked
2571      */
2572     public static function block_user(int $userid, int $usertoblockid) {
2573         global $DB;
2575         $blocked = new \stdClass();
2576         $blocked->userid = $userid;
2577         $blocked->blockeduserid = $usertoblockid;
2578         $blocked->timecreated = time();
2579         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2581         // Trigger event for blocking a contact.
2582         $event = \core\event\message_user_blocked::create(array(
2583             'objectid' => $blocked->id,
2584             'userid' => $userid,
2585             'relateduserid' => $usertoblockid,
2586             'context' => \context_user::instance($userid)
2587         ));
2588         $event->add_record_snapshot('message_users_blocked', $blocked);
2589         $event->trigger();
2590     }
2592     /**
2593      * Handles unblocking a user.
2594      *
2595      * @param int $userid The id of the user who is unblocking
2596      * @param int $usertounblockid The id of the user being unblocked
2597      */
2598     public static function unblock_user(int $userid, int $usertounblockid) {
2599         global $DB;
2601         if ($blockeduser = $DB->get_record('message_users_blocked',
2602                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2603             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2605             // Trigger event for unblocking a contact.
2606             $event = \core\event\message_user_unblocked::create(array(
2607                 'objectid' => $blockeduser->id,
2608                 'userid' => $userid,
2609                 'relateduserid' => $usertounblockid,
2610                 'context' => \context_user::instance($userid)
2611             ));
2612             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2613             $event->trigger();
2614         }
2615     }
2617     /**
2618      * Checks if users are already contacts.
2619      *
2620      * @param int $userid The id of one of the users
2621      * @param int $contactid The id of the other user
2622      * @return bool Returns true if they are a contact, false otherwise
2623      */
2624     public static function is_contact(int $userid, int $contactid) : bool {
2625         global $DB;
2627         $sql = "SELECT id
2628                   FROM {message_contacts} mc
2629                  WHERE (mc.userid = ? AND mc.contactid = ?)
2630                     OR (mc.userid = ? AND mc.contactid = ?)";
2631         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2632     }
2634     /**
2635      * Returns the row in the database table message_contacts that represents the contact between two people.
2636      *
2637      * @param int $userid The id of one of the users
2638      * @param int $contactid The id of the other user
2639      * @return mixed A fieldset object containing the record, false otherwise
2640      */
2641     public static function get_contact(int $userid, int $contactid) {
2642         global $DB;
2644         $sql = "SELECT mc.*
2645                   FROM {message_contacts} mc
2646                  WHERE (mc.userid = ? AND mc.contactid = ?)
2647                     OR (mc.userid = ? AND mc.contactid = ?)";
2648         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2649     }
2651     /**
2652      * Checks if a user is already blocked.
2653      *
2654      * @param int $userid
2655      * @param int $blockeduserid
2656      * @return bool Returns true if they are a blocked, false otherwise
2657      */
2658     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2659         global $DB;
2661         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2662     }
2664     /**
2665      * Get contact requests between users.
2666      *
2667      * @param int $userid The id of the user who is creating the contact request
2668      * @param int $requesteduserid The id of the user being requested
2669      * @return \stdClass[]
2670      */
2671     public static function get_contact_requests_between_users(int $userid, int $requesteduserid) : array {
2672         global $DB;
2674         $sql = "SELECT *
2675                   FROM {message_contact_requests} mcr
2676                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2677                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2678         return $DB->get_records_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2679     }
2681     /**
2682      * Checks if a contact request already exists between users.
2683      *
2684      * @param int $userid The id of the user who is creating the contact request
2685      * @param int $requesteduserid The id of the user being requested
2686      * @return bool Returns true if a contact request exists, false otherwise
2687      */
2688     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2689         global $DB;
2691         $sql = "SELECT id
2692                   FROM {message_contact_requests} mcr
2693                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2694                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2695         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2696     }
2698     /**
2699      * Checks if a user is already in a conversation.
2700      *
2701      * @param int $userid The id of the user we want to check if they are in a group
2702      * @param int $conversationid The id of the conversation
2703      * @return bool Returns true if a contact request exists, false otherwise
2704      */
2705     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2706         global $DB;
2708         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2709             'userid' => $userid]);
2710     }
2712     /**
2713      * Checks if the sender can message the recipient.
2714      *
2715      * @param int $recipientid
2716      * @param int $senderid
2717      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2718      */
2719     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2720         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2721             // The sender has the ability to contact any user across the entire site.
2722             return true;
2723         }
2725         // The initial value of $cancontact is null to indicate that a value has not been determined.
2726         $cancontact = null;
2728         if (self::is_blocked($recipientid, $senderid)) {
2729             // The recipient has specifically blocked this sender.
2730             $cancontact = false;
2731         }
2733         $sharedcourses = null;
2734         if (null === $cancontact) {
2735             // There are three user preference options:
2736             // - Site: Allow anyone not explicitly blocked to contact me;
2737             // - Course members: Allow anyone I am in a course with to contact me; and
2738             // - Contacts: Only allow my contacts to contact me.
2739             //
2740             // The Site option is only possible when the messagingallusers site setting is also enabled.
2742             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2743             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2744                 // The user preference is to allow any user to contact them.
2745                 // No need to check anything else.
2746                 $cancontact = true;
2747             } else {
2748                 // This user only allows their own contacts, and possibly course peers, to contact them.
2749                 // If the users are contacts then we can avoid the more expensive shared courses check.
2750                 $cancontact = self::is_contact($senderid, $recipientid);
2752                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2753                     // The users are not contacts and the user allows course member messaging.
2754                     // Check whether these two users share any course together.
2755                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2756                     $cancontact = (!empty($sharedcourses));
2757                 }
2758             }
2759         }
2761         if (false === $cancontact) {
2762             // At the moment the users cannot contact one another.
2763             // Check whether the messageanyuser capability applies in any of the shared courses.
2764             // This is intended to allow teachers to message students regardless of message settings.
2766             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2767             if (null === $sharedcourses) {
2768                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2769             }
2771             foreach ($sharedcourses as $course) {
2772                 // Note: enrol_get_shared_courses will preload any shared context.
2773                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2774                     $cancontact = true;
2775                     break;
2776                 }
2777             }
2778         }
2780         return $cancontact;
2781     }
2783     /**
2784      * Add some new members to an existing conversation.
2785      *
2786      * @param array $userids User ids array to add as members.
2787      * @param int $convid The conversation id. Must exists.
2788      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2789      * @throws \dml_exception If there is a database error
2790      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2791      */
2792     public static function add_members_to_conversation(array $userids, int $convid) {
2793         global $DB;
2795         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2797         // We can only add members to a group conversation.
2798         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2799             throw new \moodle_exception('You can not add members to a non-group conversation.');
2800         }
2802         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2803         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2804         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2806         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2807         $memberuserids = array_values($DB->get_records_menu(
2808             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2809         );
2811         // Work with existing new members.
2812         $members = array();
2813         $newuserids = array_diff($existingusers, $memberuserids);
2814         foreach ($newuserids as $userid) {
2815             $member = new \stdClass();
2816             $member->conversationid = $convid;
2817             $member->userid = $userid;
2818             $member->timecreated = time();
2819             $members[] = $member;
2820         }
2822         $DB->insert_records('message_conversation_members', $members);
2823     }
2825     /**
2826      * Remove some members from an existing conversation.
2827      *
2828      * @param array $userids The user ids to remove from conversation members.
2829      * @param int $convid The conversation id. Must exists.
2830      * @throws \dml_exception
2831      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2832      */
2833     public static function remove_members_from_conversation(array $userids, int $convid) {
2834         global $DB;
2836         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2838         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2839             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2840         }
2842         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2843         $params['convid'] = $convid;
2845         $DB->delete_records_select('message_conversation_members',
2846             "conversationid = :convid AND userid $useridcondition", $params);
2847     }
2849     /**
2850      * Count conversation members.
2851      *
2852      * @param int $convid The conversation id.
2853      * @return int Number of conversation members.
2854      * @throws \dml_exception
2855      */
2856     public static function count_conversation_members(int $convid) : int {
2857         global $DB;
2859         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2860     }
2862     /**
2863      * Checks whether or not a conversation area is enabled.
2864      *
2865      * @param string $component Defines the Moodle component which the area was added to.
2866      * @param string $itemtype Defines the type of the component.
2867      * @param int $itemid The id of the component.
2868      * @param int $contextid The id of the context.
2869      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2870      */
2871     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2872         global $DB;
2874         return $DB->record_exists('message_conversations',
2875             [
2876                 'itemid' => $itemid,
2877                 'contextid' => $contextid,
2878                 'component' => $component,
2879                 'itemtype' => $itemtype,
2880                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2881             ]
2882         );
2883     }
2885     /**
2886      * Get conversation by area.
2887      *
2888      * @param string $component Defines the Moodle component which the area was added to.
2889      * @param string $itemtype Defines the type of the component.
2890      * @param int $itemid The id of the component.
2891      * @param int $contextid The id of the context.
2892      * @return \stdClass
2893      */
2894     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2895         global $DB;
2897         return $DB->get_record('message_conversations',
2898             [
2899                 'itemid' => $itemid,
2900                 'contextid' => $contextid,
2901                 'component' => $component,
2902                 'itemtype'  => $itemtype
2903             ]
2904         );
2905     }
2907     /**
2908      * Enable a conversation.
2909      *
2910      * @param int $conversationid The id of the conversation.
2911      * @return void
2912      */
2913     public static function enable_conversation(int $conversationid) {
2914         global $DB;
2916         $conversation = new \stdClass();
2917         $conversation->id = $conversationid;
2918         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2919         $conversation->timemodified = time();
2920         $DB->update_record('message_conversations', $conversation);
2921     }
2923     /**
2924      * Disable a conversation.
2925      *
2926      * @param int $conversationid The id of the conversation.
2927      * @return void
2928      */
2929     public static function disable_conversation(int $conversationid) {
2930         global $DB;
2932         $conversation = new \stdClass();
2933         $conversation->id = $conversationid;
2934         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2935         $conversation->timemodified = time();
2936         $DB->update_record('message_conversations', $conversation);
2937     }
2939     /**
2940      * Update the name of a conversation.
2941      *
2942      * @param int $conversationid The id of a conversation.
2943      * @param string $name The main name of the area
2944      * @return void
2945      */
2946     public static function update_conversation_name(int $conversationid, string $name) {
2947         global $DB;
2949         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2950             if ($name <> $conversation->name) {
2951                 $conversation->name = $name;
2952                 $conversation->timemodified = time();
2953                 $DB->update_record('message_conversations', $conversation);
2954             }
2955         }
2956     }
2958     /**
2959      * Returns a list of conversation members.
2960      *
2961      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2962      * @param int $conversationid The id of the conversation
2963      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2964      * @param bool $includeprivacyinfo Do we want to include privacy requests with this data?
2965      * @param int $limitfrom
2966      * @param int $limitnum
2967      * @return array
2968      */
2969     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2970                                                     bool $includeprivacyinfo = false, int $limitfrom = 0,
2971                                                     int $limitnum = 0) : array {
2972         global $DB;
2974         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2975                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2976             $userids = array_keys($members);
2977             $members = helper::get_member_info($userid, $userids, $includecontactrequests, $includeprivacyinfo);
2979             return $members;
2980         }
2982         return [];
2983     }
2985     /**
2986      * Get the unread counts for all conversations for the user, sorted by type, and including favourites.
2987      *
2988      * @param int $userid the id of the user whose conversations we'll check.
2989      * @return array the unread counts for each conversation, indexed by type.
2990      */
2991     public static function get_unread_conversation_counts(int $userid) : array {
2992         global $DB;
2994         // Get all conversations the user is in, and check unread.
2995         $unreadcountssql = 'SELECT conv.id, conv.type, indcounts.unreadcount
2996                               FROM {message_conversations} conv
2997                         INNER JOIN (
2998                                       SELECT m.conversationid, count(m.id) as unreadcount
2999                                         FROM {messages} m
3000                                   INNER JOIN {message_conversations} mc
3001                                           ON mc.id = m.conversationid
3002                                   INNER JOIN {message_conversation_members} mcm
3003                                           ON m.conversationid = mcm.conversationid
3004                                    LEFT JOIN {message_user_actions} mua
3005                                           ON (mua.messageid = m.id AND mua.userid = ? AND
3006                                              (mua.action = ? OR mua.action = ?))
3007                                        WHERE mcm.userid = ?
3008                                          AND m.useridfrom != ?
3009                                          AND mua.id is NULL
3010                                     GROUP BY m.conversationid
3011                                    ) indcounts
3012                                 ON indcounts.conversationid = conv.id
3013                              WHERE conv.enabled = 1';
3015         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
3016             $userid, $userid]);
3018         // Get favourites, so we can track these separately.
3019         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
3020         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
3021         $favouriteconvids = array_flip(array_column($favouriteconversations, 'itemid'));
3023         // Assemble the return array.
3024         $counts = ['favourites' => 0, 'types' => [
3025             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL => 0,
3026             self::MESSAGE_CONVERSATION_TYPE_GROUP => 0
3027         ]];
3028         foreach ($unreadcounts as $convid => $info) {
3029             if (isset($favouriteconvids[$convid])) {
3030                 $counts['favourites']++;
3031                 continue;
3032             }
3033             $counts['types'][$info->type]++;
3034         }
3036         return $counts;
3037     }