776ca9248c24f01a6f526a217584ecff35359310
[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         $selfconversations = []; // Used to track legacy conversations with one's self (both conv members the same user).
590         $members = [];
591         $individualmembers = [];
592         $groupmembers = [];
593         foreach ($conversationset as $conversation) {
594             $conversations[$conversation->id] = $conversation;
595             $members[$conversation->id] = [];
596         }
597         $conversationset->close();
599         // If there are no conversations found, then return early.
600         if (empty($conversations)) {
601             return [];
602         }
604         // COMPONENT-LINKED CONVERSATION FIELDS.
605         // Conversations linked to components may have extra information, such as:
606         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
607         // - imageurl: A URL to the image for the linked conversation.
608         // For now, this is ONLY course groups.
609         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
611         // MEMBERS.
612         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
613         // message or not.
614         //
615         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
616         // we want the details of the other member in the conversation (i.e. not the current user).
617         // The only exception to the 'not the current user' rule is for 'self' conversations - a legacy construct in which a user
618         // can message themselves via user bulk actions. Subsequently, there are 2 records for the same user created in the members
619         // table.
620         //
621         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
622         // This can be the current user or another group member, but for groups without messages, this will be empty.
623         //
624         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
625         // query to get the 'other' user as we already have that information.
627         // Work out which members we have already, and which ones we might need to fetch.
628         // If all the last messages were from another user, then we don't need to fetch anything further.
629         foreach ($conversations as $conversation) {
630             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
631                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
632                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
633                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
634                 } else {
635                     $individualconversations[] = $conversation->id;
636                 }
637             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
638                 // If we have a recent message, the sender is our member.
639                 if (!is_null($conversation->useridfrom)) {
640                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
641                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
642                 }
643             }
644         }
645         // If we need to fetch any member information for any of the individual conversations.
646         // This is the case if any of the individual conversations have a recent message sent by the current user.
647         if (!empty($individualconversations)) {
648             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
649             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
650                         FROM {message_conversation_members} mcm
651                        WHERE mcm.conversationid $icidinsql
652                        AND mcm.userid != :userid
653                        ORDER BY mcm.id";
654             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
655             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
657             foreach ($conversationmembers as $mid => $member) {
658                 $members[$member->conversationid][$member->userid] = $member->userid;
659                 $individualmembers[$member->userid] = $member->userid;
660             }
662             // Self conversations: If any of the individual conversations which were missing members are still missing members,
663             // we know these must be 'self' conversations. This is a legacy scenario, created via user bulk actions.
664             // In such cases, the member returned should be the current user.
665             //
666             // NOTE: Currently, these conversations are not returned by this method, however,
667             // identifying them is important for future reference.
668             foreach ($individualconversations as $indconvid) {
669                 if (empty($members[$indconvid])) {
670                     // Keep track of the self conversation (for future use).
671                     $selfconversations[$indconvid] = $indconvid;
673                     // Set the member to the current user.
674                     $members[$indconvid][$userid] = $userid;
675                     $individualmembers[$userid] = $userid;
676                 }
677             }
678         }
680         // We could fail early here if we're sure that:
681         // a) we have no otherusers for all the conversations (users may have been deleted)
682         // b) we're sure that all conversations are individual (1:1).
684         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
685         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
686         // tables because on large sites these tables are massive which results in extremely slow
687         // performance (typically due to join buffer exhaustion).
688         if (!empty($individualmembers) || !empty($groupmembers)) {
689             // Now, we want to remove any duplicates from the group members array. For individual members we will
690             // be doing a more extensive call as we want their contact requests as well as privacy information,
691             // which is not necessary for group conversations.
692             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
694             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
695             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
697             // Don't use array_merge, as we lose array keys.
698             $memberinfo = $individualmemberinfo + $groupmemberinfo;
700             // Update the members array with the member information.
701             $deletedmembers = [];
702             foreach ($members as $convid => $memberarr) {
703                 foreach ($memberarr as $key => $memberid) {
704                     if (array_key_exists($memberid, $memberinfo)) {
705                         // If the user is deleted, remember that.
706                         if ($memberinfo[$memberid]->isdeleted) {
707                             $deletedmembers[$convid][] = $memberid;
708                         }
710                         $members[$convid][$key] = clone $memberinfo[$memberid];
712                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
713                             // Remove data we don't need for group.
714                             $members[$convid][$key]->requirescontact = null;
715                             $members[$convid][$key]->canmessage = null;
716                             $members[$convid][$key]->contactrequests = [];
717                         }
718                     }
719                 }
720             }
721         }
723         // MEMBER COUNT.
724         $cids = array_column($conversations, 'id');
725         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
726         $membercountsql = "SELECT conversationid, count(DISTINCT userid) AS membercount
727                              FROM {message_conversation_members} mcm
728                             WHERE mcm.conversationid $cidinsql
729                          GROUP BY mcm.conversationid";
730         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
732         // UNREAD MESSAGE COUNT.
733         // Finally, let's get the unread messages count for this user so that we can add it
734         // to the conversation. Remember we need to ignore the messages the user sent.
735         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
736                               FROM {messages} m
737                         INNER JOIN {message_conversations} mc
738                                 ON mc.id = m.conversationid
739                         INNER JOIN {message_conversation_members} mcm
740                                 ON m.conversationid = mcm.conversationid
741                          LEFT JOIN {message_user_actions} mua
742                                 ON (mua.messageid = m.id AND mua.userid = ? AND
743                                    (mua.action = ? OR mua.action = ?))
744                              WHERE mcm.userid = ?
745                                AND m.useridfrom != ?
746                                AND mua.id is NULL
747                           GROUP BY m.conversationid';
748         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
749             $userid, $userid]);
751         // Now, create the final return structure.
752         $arrconversations = [];
753         foreach ($conversations as $conversation) {
754             // Do not include any individual conversations which do not contain a recent message for the user.
755             // This happens if the user has deleted all messages.
756             // Group conversations with deleted users or no messages are always returned.
757             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
758                     && (empty($conversation->messageid))) {
759                 continue;
760             }
762             $conv = new \stdClass();
763             $conv->id = $conversation->id;
764             $conv->name = $conversation->conversationname;
765             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
766             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
767             $conv->type = $conversation->conversationtype;
768             $conv->membercount = $membercounts[$conv->id]->membercount;
769             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
770             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
771             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
772             $conv->members = $members[$conv->id];
774             // Add the most recent message information.
775             $conv->messages = [];
776             if ($conversation->smallmessage) {
777                 $msg = new \stdClass();
778                 $msg->id = $conversation->messageid;
779                 $msg->text = message_format_message_text($conversation);
780                 $msg->useridfrom = $conversation->useridfrom;
781                 $msg->timecreated = $conversation->timecreated;
782                 $conv->messages[] = $msg;
783             }
785             $arrconversations[] = $conv;
786         }
787         return $arrconversations;
788     }
790     /**
791      * Returns all conversations between two users
792      *
793      * @param int $userid1 One of the user's id
794      * @param int $userid2 The other user's id
795      * @param int $limitfrom
796      * @param int $limitnum
797      * @return array
798      * @throws \dml_exception
799      */
800     public static function get_conversations_between_users(int $userid1, int $userid2,
801                                                            int $limitfrom = 0, int $limitnum = 20) : array {
803         global $DB;
805         if ($userid1 == $userid2) {
806             return array();
807         }
809         // Get all conversation where both user1 and user2 are members.
810         // TODO: Add subname value. Waiting for definite table structure.
811         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
812                   FROM {message_conversations} mc
813             INNER JOIN {message_conversation_members} mcm1
814                     ON mc.id = mcm1.conversationid
815             INNER JOIN {message_conversation_members} mcm2
816                     ON mc.id = mcm2.conversationid
817                  WHERE mcm1.userid = :userid1
818                    AND mcm2.userid = :userid2
819                    AND mc.enabled != 0
820               ORDER BY mc.timecreated DESC";
822         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
823     }
825     /**
826      * Return a conversation.
827      *
828      * @param int $userid The user id to get the conversation for
829      * @param int $conversationid The id of the conversation to fetch
830      * @param bool $includecontactrequests Should contact requests be included between members
831      * @param bool $includeprivacyinfo Should privacy info be included between members
832      * @param int $memberlimit Limit number of members to load
833      * @param int $memberoffset Offset members by this amount
834      * @param int $messagelimit Limit number of messages to load
835      * @param int $messageoffset Offset the messages
836      * @param bool $newestmessagesfirst Order messages by newest first
837      * @return \stdClass
838      */
839     public static function get_conversation(
840         int $userid,
841         int $conversationid,
842         bool $includecontactrequests = false,
843         bool $includeprivacyinfo = false,
844         int $memberlimit = 0,
845         int $memberoffset = 0,
846         int $messagelimit = 0,
847         int $messageoffset = 0,
848         bool $newestmessagesfirst = true
849     ) {
850         global $USER, $DB;
852         $systemcontext = \context_system::instance();
853         $canreadallmessages = has_capability('moodle/site:readallmessages', $systemcontext);
854         if (($USER->id != $userid) && !$canreadallmessages) {
855             throw new \moodle_exception('You do not have permission to perform this action.');
856         }
858         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
859         if (!$conversation) {
860             return null;
861         }
863         $isconversationmember = $DB->record_exists(
864             'message_conversation_members',
865             [
866                 'conversationid' => $conversationid,
867                 'userid' => $userid
868             ]
869         );
871         if (!$isconversationmember && !$canreadallmessages) {
872             throw new \moodle_exception('You do not have permission to view this conversation.');
873         }
875         $members = self::get_conversation_members(
876             $userid,
877             $conversationid,
878             $includecontactrequests,
879             $includeprivacyinfo,
880             $memberoffset,
881             $memberlimit
882         );
883         // Strip out the requesting user to match what get_conversations does.
884         $members = array_filter($members, function($member) use ($userid) {
885             return $member->id != $userid;
886         });
888         $messages = self::get_conversation_messages(
889             $userid,
890             $conversationid,
891             $messageoffset,
892             $messagelimit,
893             $newestmessagesfirst ? 'timecreated DESC' : 'timecreated ASC'
894         );
896         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
897         $isfavourite = $service->favourite_exists('core_message', 'message_conversations', $conversationid, $systemcontext);
899         $convextrafields = self::get_linked_conversation_extra_fields([$conversation]);
900         $subname = isset($convextrafields[$conversationid]) ? $convextrafields[$conversationid]['subname'] : null;
901         $imageurl = isset($convextrafields[$conversationid]) ? $convextrafields[$conversationid]['imageurl'] : null;
903         $unreadcountssql = 'SELECT count(m.id)
904                               FROM {messages} m
905                         INNER JOIN {message_conversations} mc
906                                 ON mc.id = m.conversationid
907                          LEFT JOIN {message_user_actions} mua
908                                 ON (mua.messageid = m.id AND mua.userid = ? AND
909                                    (mua.action = ? OR mua.action = ?))
910                              WHERE m.conversationid = ?
911                                AND m.useridfrom != ?
912                                AND mua.id is NULL';
913         $unreadcount = $DB->count_records_sql(
914             $unreadcountssql,
915             [
916                 $userid,
917                 self::MESSAGE_ACTION_READ,
918                 self::MESSAGE_ACTION_DELETED,
919                 $conversationid,
920                 $userid
921             ]
922         );
924         $membercount = $DB->count_records('message_conversation_members', ['conversationid' => $conversationid]);
926         return (object) [
927             'id' => $conversation->id,
928             'name' => $conversation->name,
929             'subname' => $subname,
930             'imageurl' => $imageurl,
931             'type' => $conversation->type,
932             'membercount' => $membercount,
933             'isfavourite' => $isfavourite,
934             'isread' => empty($unreadcount),
935             'unreadcount' => $unreadcount,
936             'members' => $members,
937             'messages' => $messages['messages']
938         ];
939     }
941     /**
942      * Mark a conversation as a favourite for the given user.
943      *
944      * @param int $conversationid the id of the conversation to mark as a favourite.
945      * @param int $userid the id of the user to whom the favourite belongs.
946      * @return favourite the favourite object.
947      * @throws \moodle_exception if the user or conversation don't exist.
948      */
949     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
950         global $DB;
952         if (!self::is_user_in_conversation($userid, $conversationid)) {
953             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
954         }
955         // Get the context for this conversation.
956         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
957         $userctx = \context_user::instance($userid);
958         if (empty($conversation->contextid)) {
959             // When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
960             $conversationctx = $userctx;
961         } else {
962             // If the contextid is defined, the favourite will be added there.
963             $conversationctx = \context::instance_by_id($conversation->contextid);
964         }
966         $ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
968         if ($favourite = $ufservice->get_favourite('core_message', 'message_conversations', $conversationid, $conversationctx)) {
969             return $favourite;
970         } else {
971             return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
972         }
973     }
975     /**
976      * Unset a conversation as a favourite for the given user.
977      *
978      * @param int $conversationid the id of the conversation to unset as a favourite.
979      * @param int $userid the id to whom the favourite belongs.
980      * @throws \moodle_exception if the favourite does not exist for the user.
981      */
982     public static function unset_favourite_conversation(int $conversationid, int $userid) {
983         global $DB;
985         // Get the context for this conversation.
986         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
987         $userctx = \context_user::instance($userid);
988         if (empty($conversation->contextid)) {
989             // When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
990             $conversationctx = $userctx;
991         } else {
992             // If the contextid is defined, the favourite will be added there.
993             $conversationctx = \context::instance_by_id($conversation->contextid);
994         }
996         $ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
997         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
998     }
1000     /**
1001      * Returns the contacts to display in the contacts area.
1002      *
1003      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1004      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1005      * Followup: MDL-63915
1006      *
1007      * @param int $userid The user id
1008      * @param int $limitfrom
1009      * @param int $limitnum
1010      * @return array
1011      */
1012     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
1013         global $DB;
1015         $contactids = [];
1016         $sql = "SELECT mc.*
1017                   FROM {message_contacts} mc
1018                  WHERE mc.userid = ? OR mc.contactid = ?
1019               ORDER BY timecreated DESC";
1020         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
1021             foreach ($contacts as $contact) {
1022                 if ($userid == $contact->userid) {
1023                     $contactids[] = $contact->contactid;
1024                 } else {
1025                     $contactids[] = $contact->userid;
1026                 }
1027             }
1028         }
1030         if (!empty($contactids)) {
1031             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
1033             $sql = "SELECT u.*, mub.id as isblocked
1034                       FROM {user} u
1035                  LEFT JOIN {message_users_blocked} mub
1036                         ON u.id = mub.blockeduserid
1037                      WHERE u.id $insql";
1038             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
1039                 $arrcontacts = [];
1040                 foreach ($contacts as $contact) {
1041                     $contact->blocked = $contact->isblocked ? 1 : 0;
1042                     $arrcontacts[] = helper::create_contact($contact);
1043                 }
1045                 return $arrcontacts;
1046             }
1047         }
1049         return [];
1050     }
1052     /**
1053      * Get the contacts for a given user.
1054      *
1055      * @param int $userid
1056      * @param int $limitfrom
1057      * @param int $limitnum
1058      * @return array An array of contacts
1059      */
1060     public static function get_user_contacts(int $userid, int $limitfrom = 0, int $limitnum = 0) {
1061         global $DB;
1063         $sql = "SELECT *
1064                   FROM {message_contacts} mc
1065                  WHERE mc.userid = ? OR mc.contactid = ?
1066               ORDER BY timecreated DESC, id ASC";
1067         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
1068             $userids = [];
1069             foreach ($contacts as $contact) {
1070                 if ($contact->userid == $userid) {
1071                     $userids[] = $contact->contactid;
1072                 } else {
1073                     $userids[] = $contact->userid;
1074                 }
1075             }
1076             return helper::get_member_info($userid, $userids);
1077         }
1079         return [];
1080     }
1082     /**
1083      * Returns the contacts count.
1084      *
1085      * @param int $userid The user id
1086      * @return array
1087      */
1088     public static function count_contacts(int $userid) : int {
1089         global $DB;
1091         $sql = "SELECT COUNT(id)
1092                   FROM {message_contacts}
1093                  WHERE userid = ? OR contactid = ?";
1094         return $DB->count_records_sql($sql, [$userid, $userid]);
1095     }
1097     /**
1098      * Returns the an array of the users the given user is in a conversation
1099      * with who are a contact and the number of unread messages.
1100      *
1101      * @param int $userid The user id
1102      * @param int $limitfrom
1103      * @param int $limitnum
1104      * @return array
1105      */
1106     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
1107         global $DB;
1109         $userfields = \user_picture::fields('u', array('lastaccess'));
1110         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
1111                               FROM {message_contacts} mc
1112                         INNER JOIN {user} u
1113                                 ON (u.id = mc.contactid OR u.id = mc.userid)
1114                          LEFT JOIN {messages} m
1115                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
1116                          LEFT JOIN {message_conversation_members} mcm
1117                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
1118                          LEFT JOIN {message_user_actions} mua
1119                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1120                          LEFT JOIN {message_users_blocked} mub
1121                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
1122                              WHERE mua.id is NULL
1123                                AND mub.id is NULL
1124                                AND (mc.userid = ? OR mc.contactid = ?)
1125                                AND u.id != ?
1126                                AND u.deleted = 0
1127                           GROUP BY $userfields";
1129         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
1130             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
1131     }
1133     /**
1134      * Returns the an array of the users the given user is in a conversation
1135      * with who are not a contact and the number of unread messages.
1136      *
1137      * @param int $userid The user id
1138      * @param int $limitfrom
1139      * @param int $limitnum
1140      * @return array
1141      */
1142     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
1143         global $DB;
1145         $userfields = \user_picture::fields('u', array('lastaccess'));
1146         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
1147                               FROM {user} u
1148                         INNER JOIN {messages} m
1149                                 ON m.useridfrom = u.id
1150                         INNER JOIN {message_conversation_members} mcm
1151                                 ON mcm.conversationid = m.conversationid
1152                          LEFT JOIN {message_user_actions} mua
1153                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1154                          LEFT JOIN {message_contacts} mc
1155                                 ON (mc.userid = ? AND mc.contactid = u.id)
1156                          LEFT JOIN {message_users_blocked} mub
1157                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
1158                              WHERE mcm.userid = ?
1159                                AND mcm.userid != m.useridfrom
1160                                AND mua.id is NULL
1161                                AND mub.id is NULL
1162                                AND mc.id is NULL
1163                                AND u.deleted = 0
1164                           GROUP BY $userfields";
1166         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
1167             $limitfrom, $limitnum);
1168     }
1170     /**
1171      * Returns the messages to display in the message area.
1172      *
1173      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1174      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1175      * Followup: MDL-63915
1176      *
1177      * @param int $userid the current user
1178      * @param int $otheruserid the other user
1179      * @param int $limitfrom
1180      * @param int $limitnum
1181      * @param string $sort
1182      * @param int $timefrom the time from the message being sent
1183      * @param int $timeto the time up until the message being sent
1184      * @return array
1185      */
1186     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
1187             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
1189         if (!empty($timefrom)) {
1190             // Get the conversation between userid and otheruserid.
1191             $userids = [$userid, $otheruserid];
1192             if (!$conversationid = self::get_conversation_between_users($userids)) {
1193                 // This method was always used for individual conversations.
1194                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1195                 $conversationid = $conversation->id;
1196             }
1198             // Check the cache to see if we even need to do a DB query.
1199             $cache = \cache::make('core', 'message_time_last_message_between_users');
1200             $key = helper::get_last_message_time_created_cache_key($conversationid);
1201             $lastcreated = $cache->get($key);
1203             // The last known message time is earlier than the one being requested so we can
1204             // just return an empty result set rather than having to query the DB.
1205             if ($lastcreated && $lastcreated < $timefrom) {
1206                 return [];
1207             }
1208         }
1210         $arrmessages = array();
1211         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
1212                                              $sort, $timefrom, $timeto)) {
1213             $arrmessages = helper::create_messages($userid, $messages);
1214         }
1216         return $arrmessages;
1217     }
1219     /**
1220      * Returns the messages for the defined conversation.
1221      *
1222      * @param  int $userid The current user.
1223      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
1224      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
1225      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
1226      * @param  string $sort The column name to order by including optionally direction.
1227      * @param  int $timefrom The time from the message being sent.
1228      * @param  int $timeto The time up until the message being sent.
1229      * @return array of messages
1230      */
1231     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
1232         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
1234         if (!empty($timefrom)) {
1235             // Check the cache to see if we even need to do a DB query.
1236             $cache = \cache::make('core', 'message_time_last_message_between_users');
1237             $key = helper::get_last_message_time_created_cache_key($convid);
1238             $lastcreated = $cache->get($key);
1240             // The last known message time is earlier than the one being requested so we can
1241             // just return an empty result set rather than having to query the DB.
1242             if ($lastcreated && $lastcreated < $timefrom) {
1243                 return [];
1244             }
1245         }
1247         $messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto);
1248         return helper::format_conversation_messages($userid, $convid, $messages);
1249     }
1251     /**
1252      * Returns the most recent message between two users.
1253      *
1254      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1255      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1256      * Followup: MDL-63915
1257      *
1258      * @param int $userid the current user
1259      * @param int $otheruserid the other user
1260      * @return \stdClass|null
1261      */
1262     public static function get_most_recent_message($userid, $otheruserid) {
1263         // We want two messages here so we get an accurate 'blocktime' value.
1264         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1265             // Swap the order so we now have them in historical order.
1266             $messages = array_reverse($messages);
1267             $arrmessages = helper::create_messages($userid, $messages);
1268             return array_pop($arrmessages);
1269         }
1271         return null;
1272     }
1274     /**
1275      * Returns the most recent message in a conversation.
1276      *
1277      * @param int $convid The conversation identifier.
1278      * @param int $currentuserid The current user identifier.
1279      * @return \stdClass|null The most recent message.
1280      */
1281     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1282         global $USER;
1284         if (empty($currentuserid)) {
1285             $currentuserid = $USER->id;
1286         }
1288         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1289             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1290             return array_pop($convmessages['messages']);
1291         }
1293         return null;
1294     }
1296     /**
1297      * Returns the profile information for a contact for a user.
1298      *
1299      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1300      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1301      * Followup: MDL-63915
1302      *
1303      * @param int $userid The user id
1304      * @param int $otheruserid The id of the user whose profile we want to view.
1305      * @return \stdClass
1306      */
1307     public static function get_profile($userid, $otheruserid) {
1308         global $CFG, $PAGE;
1310         require_once($CFG->dirroot . '/user/lib.php');
1312         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1314         // Create the data we are going to pass to the renderable.
1315         $data = new \stdClass();
1316         $data->userid = $otheruserid;
1317         $data->fullname = fullname($user);
1318         $data->city = '';
1319         $data->country = '';
1320         $data->email = '';
1321         $data->isonline = null;
1322         // Get the user picture data - messaging has always shown these to the user.
1323         $userpicture = new \user_picture($user);
1324         $userpicture->size = 1; // Size f1.
1325         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1326         $userpicture->size = 0; // Size f2.
1327         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1329         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1330         if ($userfields) {
1331             if (isset($userfields['city'])) {
1332                 $data->city = $userfields['city'];
1333             }
1334             if (isset($userfields['country'])) {
1335                 $data->country = $userfields['country'];
1336             }
1337             if (isset($userfields['email'])) {
1338                 $data->email = $userfields['email'];
1339             }
1340             if (isset($userfields['lastaccess'])) {
1341                 $data->isonline = helper::is_online($userfields['lastaccess']);
1342             }
1343         }
1345         $data->isblocked = self::is_blocked($userid, $otheruserid);
1346         $data->iscontact = self::is_contact($userid, $otheruserid);
1348         return $data;
1349     }
1351     /**
1352      * Checks if a user can delete messages they have either received or sent.
1353      *
1354      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1355      *  but will still seem as if it was by the user)
1356      * @param int $conversationid The id of the conversation
1357      * @return bool Returns true if a user can delete the conversation, false otherwise.
1358      */
1359     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1360         global $USER;
1362         if (is_null($conversationid)) {
1363             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1364                 DEBUG_DEVELOPER);
1365             return false;
1366         }
1368         $systemcontext = \context_system::instance();
1370         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1371             return true;
1372         }
1374         if (!self::is_user_in_conversation($userid, $conversationid)) {
1375             return false;
1376         }
1378         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1379                 $USER->id == $userid) {
1380             return true;
1381         }
1383         return false;
1384     }
1386     /**
1387      * Deletes a conversation.
1388      *
1389      * This function does not verify any permissions.
1390      *
1391      * @deprecated since 3.6
1392      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1393      *  but will still seem as if it was by the user)
1394      * @param int $otheruserid The id of the other user in the conversation
1395      * @return bool
1396      */
1397     public static function delete_conversation($userid, $otheruserid) {
1398         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1399             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1401         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1403         // If there is no conversation, there is nothing to do.
1404         if (!$conversationid) {
1405             return true;
1406         }
1408         self::delete_conversation_by_id($userid, $conversationid);
1410         return true;
1411     }
1413     /**
1414      * Deletes a conversation for a specified user.
1415      *
1416      * This function does not verify any permissions.
1417      *
1418      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1419      *  but will still seem as if it was by the user)
1420      * @param int $conversationid The id of the other user in the conversation
1421      */
1422     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1423         global $DB, $USER;
1425         // Get all messages belonging to this conversation that have not already been deleted by this user.
1426         $sql = "SELECT m.*
1427                  FROM {messages} m
1428            INNER JOIN {message_conversations} mc
1429                    ON m.conversationid = mc.id
1430             LEFT JOIN {message_user_actions} mua
1431                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1432                 WHERE mua.id is NULL
1433                   AND mc.id = ?
1434              ORDER BY m.timecreated ASC";
1435         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1437         // Ok, mark these as deleted.
1438         foreach ($messages as $message) {
1439             $mua = new \stdClass();
1440             $mua->userid = $userid;
1441             $mua->messageid = $message->id;
1442             $mua->action = self::MESSAGE_ACTION_DELETED;
1443             $mua->timecreated = time();
1444             $mua->id = $DB->insert_record('message_user_actions', $mua);
1446             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1447                 $message->id, $mua->id)->trigger();
1448         }
1449     }
1451     /**
1452      * Returns the count of unread conversations (collection of messages from a single user) for
1453      * the given user.
1454      *
1455      * @param \stdClass $user the user who's conversations should be counted
1456      * @return int the count of the user's unread conversations
1457      */
1458     public static function count_unread_conversations($user = null) {
1459         global $USER, $DB;
1461         if (empty($user)) {
1462             $user = $USER;
1463         }
1465         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1466                   FROM {messages} m
1467             INNER JOIN {message_conversations} mc
1468                     ON m.conversationid = mc.id
1469             INNER JOIN {message_conversation_members} mcm
1470                     ON mc.id = mcm.conversationid
1471              LEFT JOIN {message_user_actions} mua
1472                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1473                  WHERE mcm.userid = ?
1474                    AND mcm.userid != m.useridfrom
1475                    AND mua.id is NULL";
1477         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1478     }
1480     /**
1481      * Checks if a user can mark all messages as read.
1482      *
1483      * @param int $userid The user id of who we want to mark the messages for
1484      * @param int $conversationid The id of the conversation
1485      * @return bool true if user is permitted, false otherwise
1486      * @since 3.6
1487      */
1488     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1489         global $USER;
1491         $systemcontext = \context_system::instance();
1493         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1494             return true;
1495         }
1497         if (!self::is_user_in_conversation($userid, $conversationid)) {
1498             return false;
1499         }
1501         if ($USER->id == $userid) {
1502             return true;
1503         }
1505         return false;
1506     }
1508     /**
1509      * Returns the count of conversations (collection of messages from a single user) for
1510      * the given user.
1511      *
1512      * @param int $userid The user whose conversations should be counted.
1513      * @return array the array of conversations counts, indexed by type.
1514      */
1515     public static function get_conversation_counts(int $userid) : array {
1516         global $DB;
1518         // Some restrictions we need to be aware of:
1519         // - Individual conversations containing soft-deleted user must be counted.
1520         // - Individual conversations containing only deleted messages must NOT be counted.
1521         // - Group conversations with 0 messages must be counted.
1522         // - Linked conversations which are disabled (enabled = 0) must NOT be counted.
1523         // - Any type of conversation can be included in the favourites count, however, the type counts and the favourites count
1524         // are mutually exclusive; any conversations which are counted in favourites cannot be counted elsewhere.
1526         // First, ask the favourites service to give us the join SQL for favourited conversations,
1527         // so we can include favourite information in the query.
1528         $usercontext = \context_user::instance($userid);
1529         $favservice = \core_favourites\service_factory::get_service_for_user_context($usercontext);
1530         list($favsql, $favparams) = $favservice->get_join_sql_by_type('core_message', 'message_conversations', 'fav', 'mc.id');
1532         $sql = "SELECT mc.type, fav.itemtype, COUNT(DISTINCT mc.id) as count
1533                   FROM {message_conversations} mc
1534             INNER JOIN {message_conversation_members} mcm
1535                     ON mcm.conversationid = mc.id
1536              LEFT JOIN (
1537                               SELECT m.conversationid as convid, MAX(m.timecreated) as maxtime
1538                                 FROM {messages} m
1539                           INNER JOIN {message_conversation_members} mcm
1540                                   ON mcm.conversationid = m.conversationid
1541                            LEFT JOIN {message_user_actions} mua
1542                                   ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
1543                                WHERE mua.id is NULL
1544                                  AND mcm.userid = :userid2
1545                             GROUP BY m.conversationid
1546                        ) maxvisibleconvmessage
1547                     ON maxvisibleconvmessage.convid = mc.id
1548                $favsql
1549                  WHERE mcm.userid = :userid3
1550                    AND mc.enabled = :enabled
1551                    AND ((mc.type = :individualtype AND maxvisibleconvmessage.convid IS NOT NULL) OR (mc.type = :grouptype))
1552               GROUP BY mc.type, fav.itemtype
1553               ORDER BY mc.type ASC";
1555         $params = [
1556             'userid' => $userid,
1557             'userid2' => $userid,
1558             'userid3' => $userid,
1559             'userid4' => $userid,
1560             'action' => self::MESSAGE_ACTION_DELETED,
1561             'enabled' => self::MESSAGE_CONVERSATION_ENABLED,
1562             'individualtype' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1563             'grouptype' => self::MESSAGE_CONVERSATION_TYPE_GROUP,
1564         ] + $favparams;
1566         // Assemble the return array.
1567         $counts = [
1568             'favourites' => 0,
1569             'types' => [
1570                 self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL => 0,
1571                 self::MESSAGE_CONVERSATION_TYPE_GROUP => 0
1572             ]
1573         ];
1575         $countsrs = $DB->get_recordset_sql($sql, $params);
1576         foreach ($countsrs as $key => $val) {
1577             if (!empty($val->itemtype)) {
1578                 $counts['favourites'] += $val->count;
1579                 continue;
1580             }
1581             $counts['types'][$val->type] = $val->count;
1582         }
1583         $countsrs->close();
1585         return $counts;
1586     }
1588     /**
1589      * Marks all messages being sent to a user in a particular conversation.
1590      *
1591      * If $conversationdid is null then it marks all messages as read sent to $userid.
1592      *
1593      * @param int $userid
1594      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1595      */
1596     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1597         global $DB;
1599         $messagesql = "SELECT m.*
1600                          FROM {messages} m
1601                    INNER JOIN {message_conversations} mc
1602                            ON mc.id = m.conversationid
1603                    INNER JOIN {message_conversation_members} mcm
1604                            ON mcm.conversationid = mc.id
1605                     LEFT JOIN {message_user_actions} mua
1606                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1607                         WHERE mua.id is NULL
1608                           AND mcm.userid = ?
1609                           AND m.useridfrom != ?";
1610         $messageparams = [];
1611         $messageparams[] = $userid;
1612         $messageparams[] = self::MESSAGE_ACTION_READ;
1613         $messageparams[] = $userid;
1614         $messageparams[] = $userid;
1615         if (!is_null($conversationid)) {
1616             $messagesql .= " AND mc.id = ?";
1617             $messageparams[] = $conversationid;
1618         }
1620         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1621         foreach ($messages as $message) {
1622             self::mark_message_as_read($userid, $message);
1623         }
1624         $messages->close();
1625     }
1627     /**
1628      * Marks all notifications being sent from one user to another user as read.
1629      *
1630      * If the from user is null then it marks all notifications as read sent to the to user.
1631      *
1632      * @param int $touserid the id of the message recipient
1633      * @param int|null $fromuserid the id of the message sender, null if all messages
1634      * @return void
1635      */
1636     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1637         global $DB;
1639         $notificationsql = "SELECT n.*
1640                               FROM {notifications} n
1641                              WHERE useridto = ?
1642                                AND timeread is NULL";
1643         $notificationsparams = [$touserid];
1644         if (!empty($fromuserid)) {
1645             $notificationsql .= " AND useridfrom = ?";
1646             $notificationsparams[] = $fromuserid;
1647         }
1649         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1650         foreach ($notifications as $notification) {
1651             self::mark_notification_as_read($notification);
1652         }
1653         $notifications->close();
1654     }
1656     /**
1657      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1658      *
1659      * Can be filtered by type.
1660      *
1661      * @deprecated since 3.5
1662      * @param int $touserid the id of the message recipient
1663      * @param int $fromuserid the id of the message sender
1664      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1665      * @return void
1666      */
1667     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1668         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1669             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1670             DEBUG_DEVELOPER);
1672         $type = strtolower($type);
1674         $conversationid = null;
1675         $ignoremessages = false;
1676         if (!empty($fromuserid)) {
1677             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1678             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1679                 $ignoremessages = true;
1680             }
1681         }
1683         if (!empty($type)) {
1684             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1685                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1686             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1687                 if (!$ignoremessages) {
1688                     self::mark_all_messages_as_read($touserid, $conversationid);
1689                 }
1690             }
1691         } else { // We want both.
1692             self::mark_all_notifications_as_read($touserid, $fromuserid);
1693             if (!$ignoremessages) {
1694                 self::mark_all_messages_as_read($touserid, $conversationid);
1695             }
1696         }
1697     }
1699     /**
1700      * Returns message preferences.
1701      *
1702      * @param array $processors
1703      * @param array $providers
1704      * @param \stdClass $user
1705      * @return \stdClass
1706      * @since 3.2
1707      */
1708     public static function get_all_message_preferences($processors, $providers, $user) {
1709         $preferences = helper::get_providers_preferences($providers, $user->id);
1710         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1712         // For every processors put its options on the form (need to get function from processor's lib.php).
1713         foreach ($processors as $processor) {
1714             $processor->object->load_data($preferences, $user->id);
1715         }
1717         // Load general messaging preferences.
1718         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1719         $preferences->mailformat = $user->mailformat;
1720         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1722         return $preferences;
1723     }
1725     /**
1726      * Count the number of users blocked by a user.
1727      *
1728      * @param \stdClass $user The user object
1729      * @return int the number of blocked users
1730      */
1731     public static function count_blocked_users($user = null) {
1732         global $USER, $DB;
1734         if (empty($user)) {
1735             $user = $USER;
1736         }
1738         $sql = "SELECT count(mub.id)
1739                   FROM {message_users_blocked} mub
1740                  WHERE mub.userid = :userid";
1741         return $DB->count_records_sql($sql, array('userid' => $user->id));
1742     }
1744     /**
1745      * Determines if a user is permitted to send another user a private message.
1746      * If no sender is provided then it defaults to the logged in user.
1747      *
1748      * @param \stdClass $recipient The user object.
1749      * @param \stdClass|null $sender The user object.
1750      * @return bool true if user is permitted, false otherwise.
1751      */
1752     public static function can_post_message($recipient, $sender = null) {
1753         global $USER;
1755         if (is_null($sender)) {
1756             // The message is from the logged in user, unless otherwise specified.
1757             $sender = $USER;
1758         }
1760         $systemcontext = \context_system::instance();
1761         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1762             return false;
1763         }
1765         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1766             return true;
1767         }
1769         // Check if the recipient can be messaged by the sender.
1770         return (self::can_contact_user($recipient->id, $sender->id));
1771     }
1773     /**
1774      * Determines if a user is permitted to send a message to a given conversation.
1775      * If no sender is provided then it defaults to the logged in user.
1776      *
1777      * @param int $userid the id of the user on which the checks will be applied.
1778      * @param int $conversationid the id of the conversation we wish to check.
1779      * @return bool true if the user can send a message to the conversation, false otherwise.
1780      * @throws \moodle_exception
1781      */
1782     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1783         global $DB;
1785         $systemcontext = \context_system::instance();
1786         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1787             return false;
1788         }
1790         if (!self::is_user_in_conversation($userid, $conversationid)) {
1791             return false;
1792         }
1794         // User can post messages and is in the conversation, but we need to check the conversation type to
1795         // know whether or not to check the user privacy settings via can_contact_user().
1796         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1797         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1798             return true;
1799         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1800             // Get the other user in the conversation.
1801             $members = self::get_conversation_members($userid, $conversationid);
1802             $otheruser = array_filter($members, function($member) use($userid) {
1803                 return $member->id != $userid;
1804             });
1805             $otheruser = reset($otheruser);
1807             return self::can_contact_user($otheruser->id, $userid);
1808         } else {
1809             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1810         }
1811     }
1813     /**
1814      * Send a message from a user to a conversation.
1815      *
1816      * This method will create the basic eventdata and delegate to message creation to message_send.
1817      * The message_send() method is responsible for event data that is specific to each recipient.
1818      *
1819      * @param int $userid the sender id.
1820      * @param int $conversationid the conversation id.
1821      * @param string $message the message to send.
1822      * @param int $format the format of the message to send.
1823      * @return \stdClass the message created.
1824      * @throws \coding_exception
1825      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1826      */
1827     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1828                                                         int $format) : \stdClass {
1829         global $DB;
1831         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1832             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1833         }
1835         $eventdata = new \core\message\message();
1836         $eventdata->courseid         = 1;
1837         $eventdata->component        = 'moodle';
1838         $eventdata->name             = 'instantmessage';
1839         $eventdata->userfrom         = $userid;
1840         $eventdata->convid           = $conversationid;
1842         if ($format == FORMAT_HTML) {
1843             $eventdata->fullmessagehtml  = $message;
1844             // Some message processors may revert to sending plain text even if html is supplied,
1845             // so we keep both plain and html versions if we're intending to send html.
1846             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1847         } else {
1848             $eventdata->fullmessage      = $message;
1849             $eventdata->fullmessagehtml  = '';
1850         }
1852         $eventdata->fullmessageformat = $format;
1853         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1855         $eventdata->timecreated     = time();
1856         $eventdata->notification    = 0;
1857         $messageid = message_send($eventdata);
1859         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1860         $message = (object) [
1861             'id' => $messagerecord->id,
1862             'useridfrom' => $messagerecord->useridfrom,
1863             'text' => $messagerecord->fullmessage,
1864             'timecreated' => $messagerecord->timecreated
1865         ];
1866         return $message;
1867     }
1869     /**
1870      * Get the messaging preference for a user.
1871      * If the user has not any messaging privacy preference:
1872      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1873      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1874      *
1875      * @param  int    $userid The user identifier.
1876      * @return int    The default messaging preference.
1877      */
1878     public static function get_user_privacy_messaging_preference(int $userid) : int {
1879         global $CFG, $USER;
1881         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1882         // otherwise, the default value will be "My contacts and anyone in my courses".
1883         if (empty($CFG->messagingallusers)) {
1884             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1885         } else {
1886             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1887         }
1888         if ($userid == $USER->id) {
1889             $user = $USER;
1890         } else {
1891             $user = $userid;
1892         }
1893         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $user);
1895         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1896         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1897         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1898             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1899         }
1901         return $privacypreference;
1902     }
1904     /**
1905      * Checks if the recipient is allowing messages from users that aren't a
1906      * contact. If not then it checks to make sure the sender is in the
1907      * recipient's contacts.
1908      *
1909      * @deprecated since 3.6
1910      * @param \stdClass $recipient The user object.
1911      * @param \stdClass|null $sender The user object.
1912      * @return bool true if $sender is blocked, false otherwise.
1913      */
1914     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1915         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1917         global $USER, $CFG;
1919         if (is_null($sender)) {
1920             // The message is from the logged in user, unless otherwise specified.
1921             $sender = $USER;
1922         }
1924         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1925         switch ($privacypreference) {
1926             case self::MESSAGE_PRIVACY_SITE:
1927                 if (!empty($CFG->messagingallusers)) {
1928                     // Users can be messaged without being contacts or members of the same course.
1929                     break;
1930                 }
1931                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1932                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1933             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1934                 // Confirm the sender and the recipient are both members of the same course.
1935                 if (enrol_sharing_course($recipient, $sender)) {
1936                     // All good, the recipient and the sender are members of the same course.
1937                     return false;
1938                 }
1939             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1940                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1941                 return !self::is_contact($sender->id, $recipient->id);
1942         }
1944         return false;
1945     }
1947     /**
1948      * Checks if the recipient has specifically blocked the sending user.
1949      *
1950      * Note: This function will always return false if the sender has the
1951      * readallmessages capability at the system context level.
1952      *
1953      * @deprecated since 3.6
1954      * @param int $recipientid User ID of the recipient.
1955      * @param int $senderid User ID of the sender.
1956      * @return bool true if $sender is blocked, false otherwise.
1957      */
1958     public static function is_user_blocked($recipientid, $senderid = null) {
1959         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1960             DEBUG_DEVELOPER);
1962         global $USER;
1964         if (is_null($senderid)) {
1965             // The message is from the logged in user, unless otherwise specified.
1966             $senderid = $USER->id;
1967         }
1969         $systemcontext = \context_system::instance();
1970         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1971             return false;
1972         }
1974         if (self::is_blocked($recipientid, $senderid)) {
1975             return true;
1976         }
1978         return false;
1979     }
1981     /**
1982      * Get specified message processor, validate corresponding plugin existence and
1983      * system configuration.
1984      *
1985      * @param string $name  Name of the processor.
1986      * @param bool $ready only return ready-to-use processors.
1987      * @return mixed $processor if processor present else empty array.
1988      * @since Moodle 3.2
1989      */
1990     public static function get_message_processor($name, $ready = false) {
1991         global $DB, $CFG;
1993         $processor = $DB->get_record('message_processors', array('name' => $name));
1994         if (empty($processor)) {
1995             // Processor not found, return.
1996             return array();
1997         }
1999         $processor = self::get_processed_processor_object($processor);
2000         if ($ready) {
2001             if ($processor->enabled && $processor->configured) {
2002                 return $processor;
2003             } else {
2004                 return array();
2005             }
2006         } else {
2007             return $processor;
2008         }
2009     }
2011     /**
2012      * Returns weather a given processor is enabled or not.
2013      * Note:- This doesn't check if the processor is configured or not.
2014      *
2015      * @param string $name Name of the processor
2016      * @return bool
2017      */
2018     public static function is_processor_enabled($name) {
2020         $cache = \cache::make('core', 'message_processors_enabled');
2021         $status = $cache->get($name);
2023         if ($status === false) {
2024             $processor = self::get_message_processor($name);
2025             if (!empty($processor)) {
2026                 $cache->set($name, $processor->enabled);
2027                 return $processor->enabled;
2028             } else {
2029                 return false;
2030             }
2031         }
2033         return $status;
2034     }
2036     /**
2037      * Set status of a processor.
2038      *
2039      * @param \stdClass $processor processor record.
2040      * @param 0|1 $enabled 0 or 1 to set the processor status.
2041      * @return bool
2042      * @since Moodle 3.2
2043      */
2044     public static function update_processor_status($processor, $enabled) {
2045         global $DB;
2046         $cache = \cache::make('core', 'message_processors_enabled');
2047         $cache->delete($processor->name);
2048         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
2049     }
2051     /**
2052      * Given a processor object, loads information about it's settings and configurations.
2053      * This is not a public api, instead use @see \core_message\api::get_message_processor()
2054      * or @see \get_message_processors()
2055      *
2056      * @param \stdClass $processor processor object
2057      * @return \stdClass processed processor object
2058      * @since Moodle 3.2
2059      */
2060     public static function get_processed_processor_object(\stdClass $processor) {
2061         global $CFG;
2063         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2064         if (is_readable($processorfile)) {
2065             include_once($processorfile);
2066             $processclass = 'message_output_' . $processor->name;
2067             if (class_exists($processclass)) {
2068                 $pclass = new $processclass();
2069                 $processor->object = $pclass;
2070                 $processor->configured = 0;
2071                 if ($pclass->is_system_configured()) {
2072                     $processor->configured = 1;
2073                 }
2074                 $processor->hassettings = 0;
2075                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2076                     $processor->hassettings = 1;
2077                 }
2078                 $processor->available = 1;
2079             } else {
2080                 print_error('errorcallingprocessor', 'message');
2081             }
2082         } else {
2083             $processor->available = 0;
2084         }
2085         return $processor;
2086     }
2088     /**
2089      * Retrieve users blocked by $user1
2090      *
2091      * @param int $userid The user id of the user whos blocked users we are returning
2092      * @return array the users blocked
2093      */
2094     public static function get_blocked_users($userid) {
2095         global $DB;
2097         $userfields = \user_picture::fields('u', array('lastaccess'));
2098         $blockeduserssql = "SELECT $userfields
2099                               FROM {message_users_blocked} mub
2100                         INNER JOIN {user} u
2101                                 ON u.id = mub.blockeduserid
2102                              WHERE u.deleted = 0
2103                                AND mub.userid = ?
2104                           GROUP BY $userfields
2105                           ORDER BY u.firstname ASC";
2106         return $DB->get_records_sql($blockeduserssql, [$userid]);
2107     }
2109     /**
2110      * Mark a single message as read.
2111      *
2112      * @param int $userid The user id who marked the message as read
2113      * @param \stdClass $message The message
2114      * @param int|null $timeread The time the message was marked as read, if null will default to time()
2115      */
2116     public static function mark_message_as_read($userid, $message, $timeread = null) {
2117         global $DB;
2119         if (is_null($timeread)) {
2120             $timeread = time();
2121         }
2123         $mua = new \stdClass();
2124         $mua->userid = $userid;
2125         $mua->messageid = $message->id;
2126         $mua->action = self::MESSAGE_ACTION_READ;
2127         $mua->timecreated = $timeread;
2128         $mua->id = $DB->insert_record('message_user_actions', $mua);
2130         // Get the context for the user who received the message.
2131         $context = \context_user::instance($userid, IGNORE_MISSING);
2132         // If the user no longer exists the context value will be false, in this case use the system context.
2133         if ($context === false) {
2134             $context = \context_system::instance();
2135         }
2137         // Trigger event for reading a message.
2138         $event = \core\event\message_viewed::create(array(
2139             'objectid' => $mua->id,
2140             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
2141             'context' => $context,
2142             'relateduserid' => $message->useridfrom,
2143             'other' => array(
2144                 'messageid' => $message->id
2145             )
2146         ));
2147         $event->trigger();
2148     }
2150     /**
2151      * Mark a single notification as read.
2152      *
2153      * @param \stdClass $notification The notification
2154      * @param int|null $timeread The time the message was marked as read, if null will default to time()
2155      */
2156     public static function mark_notification_as_read($notification, $timeread = null) {
2157         global $DB;
2159         if (is_null($timeread)) {
2160             $timeread = time();
2161         }
2163         if (is_null($notification->timeread)) {
2164             $updatenotification = new \stdClass();
2165             $updatenotification->id = $notification->id;
2166             $updatenotification->timeread = $timeread;
2168             $DB->update_record('notifications', $updatenotification);
2170             // Trigger event for reading a notification.
2171             \core\event\notification_viewed::create_from_ids(
2172                 $notification->useridfrom,
2173                 $notification->useridto,
2174                 $notification->id
2175             )->trigger();
2176         }
2177     }
2179     /**
2180      * Checks if a user can delete a message.
2181      *
2182      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
2183      *  but will still seem as if it was by the user)
2184      * @param int $messageid The message id
2185      * @return bool Returns true if a user can delete the message, false otherwise.
2186      */
2187     public static function can_delete_message($userid, $messageid) {
2188         global $DB, $USER;
2190         $systemcontext = \context_system::instance();
2192         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
2194         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
2195             return true;
2196         }
2198         if (!self::is_user_in_conversation($userid, $conversationid)) {
2199             return false;
2200         }
2202         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
2203                 $USER->id == $userid) {
2204             return true;
2205         }
2207         return false;
2208     }
2210     /**
2211      * Deletes a message.
2212      *
2213      * This function does not verify any permissions.
2214      *
2215      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
2216      *  but will still seem as if it was by the user)
2217      * @param int $messageid The message id
2218      * @return bool
2219      */
2220     public static function delete_message($userid, $messageid) {
2221         global $DB, $USER;
2223         if (!$DB->record_exists('messages', ['id' => $messageid])) {
2224             return false;
2225         }
2227         // Check if the user has already deleted this message.
2228         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
2229                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
2230             $mua = new \stdClass();
2231             $mua->userid = $userid;
2232             $mua->messageid = $messageid;
2233             $mua->action = self::MESSAGE_ACTION_DELETED;
2234             $mua->timecreated = time();
2235             $mua->id = $DB->insert_record('message_user_actions', $mua);
2237             // Trigger event for deleting a message.
2238             \core\event\message_deleted::create_from_ids($userid, $USER->id,
2239                 $messageid, $mua->id)->trigger();
2241             return true;
2242         }
2244         return false;
2245     }
2247     /**
2248      * Returns the conversation between two users.
2249      *
2250      * @param array $userids
2251      * @return int|bool The id of the conversation, false if not found
2252      */
2253     public static function get_conversation_between_users(array $userids) {
2254         global $DB;
2256         $conversations = self::get_individual_conversations_between_users([$userids]);
2257         $conversation = $conversations[0];
2259         if ($conversation) {
2260             return $conversation->id;
2261         }
2263         return false;
2264     }
2266     /**
2267      * Returns the conversations between sets of users.
2268      *
2269      * The returned array of results will be in the same order as the requested
2270      * arguments, null will be returned if there is no conversation for that user
2271      * pair.
2272      *
2273      * For example:
2274      * If we have 6 users with ids 1, 2, 3, 4, 5, 6 where only 2 conversations
2275      * exist. One between 1 and 2 and another between 5 and 6.
2276      *
2277      * Then if we call:
2278      * $conversations = get_individual_conversations_between_users([[1,2], [3,4], [5,6]]);
2279      *
2280      * The conversations array will look like:
2281      * [<conv_record>, null, <conv_record>];
2282      *
2283      * Where null is returned for the pairing of [3, 4] since no record exists.
2284      *
2285      * @param array $useridsets An array of arrays where the inner array is the set of user ids
2286      * @return stdClass[] Array of conversation records
2287      */
2288     public static function get_individual_conversations_between_users(array $useridsets) : array {
2289         global $DB;
2291         if (empty($useridsets)) {
2292             return [];
2293         }
2295         $hashes = array_map(function($userids) {
2296             return  helper::get_conversation_hash($userids);
2297         }, $useridsets);
2299         list($inorequalsql, $params) = $DB->get_in_or_equal($hashes);
2300         array_unshift($params, self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL);
2301         $where = "type = ? AND convhash ${inorequalsql}";
2302         $conversations = array_fill(0, count($hashes), null);
2303         $records = $DB->get_records_select('message_conversations', $where, $params);
2305         foreach (array_values($records) as $record) {
2306             $index = array_search($record->convhash, $hashes);
2307             if ($index !== false) {
2308                 $conversations[$index] = $record;
2309             }
2310         }
2312         return $conversations;
2313     }
2315     /**
2316      * Creates a conversation between two users.
2317      *
2318      * @deprecated since 3.6
2319      * @param array $userids
2320      * @return int The id of the conversation
2321      */
2322     public static function create_conversation_between_users(array $userids) {
2323         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
2324             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
2326         // This method was always used for individual conversations.
2327         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
2329         return $conversation->id;
2330     }
2332     /**
2333      * Creates a conversation with selected users and messages.
2334      *
2335      * @param int $type The type of conversation
2336      * @param int[] $userids The array of users to add to the conversation
2337      * @param string|null $name The name of the conversation
2338      * @param int $enabled Determines if the conversation is created enabled or disabled
2339      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
2340      * @param string|null $itemtype Defines the type of the component
2341      * @param int|null $itemid The id of the component
2342      * @param int|null $contextid The id of the context
2343      * @return \stdClass
2344      */
2345     public static function create_conversation(int $type, array $userids, string $name = null,
2346             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
2347             string $itemtype = null, int $itemid = null, int $contextid = null) {
2349         global $DB;
2351         $validtypes = [
2352             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
2353             self::MESSAGE_CONVERSATION_TYPE_GROUP
2354         ];
2356         if (!in_array($type, $validtypes)) {
2357             throw new \moodle_exception('An invalid conversation type was specified.');
2358         }
2360         // Sanity check.
2361         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2362             if (count($userids) > 2) {
2363                 throw new \moodle_exception('An individual conversation can not have more than two users.');
2364             }
2365         }
2367         $conversation = new \stdClass();
2368         $conversation->type = $type;
2369         $conversation->name = $name;
2370         $conversation->convhash = null;
2371         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2372             $conversation->convhash = helper::get_conversation_hash($userids);
2373         }
2374         $conversation->component = $component;
2375         $conversation->itemtype = $itemtype;
2376         $conversation->itemid = $itemid;
2377         $conversation->contextid = $contextid;
2378         $conversation->enabled = $enabled;
2379         $conversation->timecreated = time();
2380         $conversation->timemodified = $conversation->timecreated;
2381         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2383         // Add users to this conversation.
2384         $arrmembers = [];
2385         foreach ($userids as $userid) {
2386             $member = new \stdClass();
2387             $member->conversationid = $conversation->id;
2388             $member->userid = $userid;
2389             $member->timecreated = time();
2390             $member->id = $DB->insert_record('message_conversation_members', $member);
2392             $arrmembers[] = $member;
2393         }
2395         $conversation->members = $arrmembers;
2397         return $conversation;
2398     }
2400     /**
2401      * Checks if a user can create a group conversation.
2402      *
2403      * @param int $userid The id of the user attempting to create the conversation
2404      * @param \context $context The context they are creating the conversation from, most likely course context
2405      * @return bool
2406      */
2407     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2408         global $CFG;
2410         // If we can't message at all, then we can't create a conversation.
2411         if (empty($CFG->messaging)) {
2412             return false;
2413         }
2415         // We need to check they have the capability to create the conversation.
2416         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2417     }
2419     /**
2420      * Checks if a user can create a contact request.
2421      *
2422      * @param int $userid The id of the user who is creating the contact request
2423      * @param int $requesteduserid The id of the user being requested
2424      * @return bool
2425      */
2426     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2427         global $CFG;
2429         // If we can't message at all, then we can't create a contact.
2430         if (empty($CFG->messaging)) {
2431             return false;
2432         }
2434         // If we can message anyone on the site then we can create a contact.
2435         if ($CFG->messagingallusers) {
2436             return true;
2437         }
2439         // We need to check if they are in the same course.
2440         return enrol_sharing_course($userid, $requesteduserid);
2441     }
2443     /**
2444      * Handles creating a contact request.
2445      *
2446      * @param int $userid The id of the user who is creating the contact request
2447      * @param int $requesteduserid The id of the user being requested
2448      * @return \stdClass the request
2449      */
2450     public static function create_contact_request(int $userid, int $requesteduserid) : \stdClass {
2451         global $DB;
2453         $request = new \stdClass();
2454         $request->userid = $userid;
2455         $request->requesteduserid = $requesteduserid;
2456         $request->timecreated = time();
2458         $request->id = $DB->insert_record('message_contact_requests', $request);
2460         return $request;
2461     }
2464     /**
2465      * Handles confirming a contact request.
2466      *
2467      * @param int $userid The id of the user who created the contact request
2468      * @param int $requesteduserid The id of the user confirming the request
2469      */
2470     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2471         global $DB;
2473         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2474                 'requesteduserid' => $requesteduserid])) {
2475             self::add_contact($userid, $requesteduserid);
2477             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2478         }
2479     }
2481     /**
2482      * Handles declining a contact request.
2483      *
2484      * @param int $userid The id of the user who created the contact request
2485      * @param int $requesteduserid The id of the user declining the request
2486      */
2487     public static function decline_contact_request(int $userid, int $requesteduserid) {
2488         global $DB;
2490         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2491                 'requesteduserid' => $requesteduserid])) {
2492             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2493         }
2494     }
2496     /**
2497      * Handles returning the contact requests for a user.
2498      *
2499      * This also includes the user data necessary to display information
2500      * about the user.
2501      *
2502      * It will not include blocked users.
2503      *
2504      * @param int $userid
2505      * @param int $limitfrom
2506      * @param int $limitnum
2507      * @return array The list of contact requests
2508      */
2509     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2510         global $DB;
2512         $sql = "SELECT mcr.userid
2513                   FROM {message_contact_requests} mcr
2514              LEFT JOIN {message_users_blocked} mub
2515                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2516                  WHERE mcr.requesteduserid = ?
2517                    AND mub.id is NULL
2518               ORDER BY mcr.timecreated ASC";
2519         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2520             $userids = array_keys($contactrequests);
2521             return helper::get_member_info($userid, $userids);
2522         }
2524         return [];
2525     }
2527     /**
2528      * Returns the number of contact requests the user has received.
2529      *
2530      * @param int $userid The ID of the user we want to return the number of received contact requests for
2531      * @return int The count
2532      */
2533     public static function get_received_contact_requests_count(int $userid) : int {
2534         global $DB;
2535         return $DB->count_records('message_contact_requests', ['requesteduserid' => $userid]);
2536     }
2538     /**
2539      * Handles adding a contact.
2540      *
2541      * @param int $userid The id of the user who requested to be a contact
2542      * @param int $contactid The id of the contact
2543      */
2544     public static function add_contact(int $userid, int $contactid) {
2545         global $DB;
2547         $messagecontact = new \stdClass();
2548         $messagecontact->userid = $userid;
2549         $messagecontact->contactid = $contactid;
2550         $messagecontact->timecreated = time();
2551         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2553         $eventparams = [
2554             'objectid' => $messagecontact->id,
2555             'userid' => $userid,
2556             'relateduserid' => $contactid,
2557             'context' => \context_user::instance($userid)
2558         ];
2559         $event = \core\event\message_contact_added::create($eventparams);
2560         $event->add_record_snapshot('message_contacts', $messagecontact);
2561         $event->trigger();
2562     }
2564     /**
2565      * Handles removing a contact.
2566      *
2567      * @param int $userid The id of the user who is removing a user as a contact
2568      * @param int $contactid The id of the user to be removed as a contact
2569      */
2570     public static function remove_contact(int $userid, int $contactid) {
2571         global $DB;
2573         if ($contact = self::get_contact($userid, $contactid)) {
2574             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2576             $event = \core\event\message_contact_removed::create(array(
2577                 'objectid' => $contact->id,
2578                 'userid' => $userid,
2579                 'relateduserid' => $contactid,
2580                 'context' => \context_user::instance($userid)
2581             ));
2582             $event->add_record_snapshot('message_contacts', $contact);
2583             $event->trigger();
2584         }
2585     }
2587     /**
2588      * Handles blocking a user.
2589      *
2590      * @param int $userid The id of the user who is blocking
2591      * @param int $usertoblockid The id of the user being blocked
2592      */
2593     public static function block_user(int $userid, int $usertoblockid) {
2594         global $DB;
2596         $blocked = new \stdClass();
2597         $blocked->userid = $userid;
2598         $blocked->blockeduserid = $usertoblockid;
2599         $blocked->timecreated = time();
2600         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2602         // Trigger event for blocking a contact.
2603         $event = \core\event\message_user_blocked::create(array(
2604             'objectid' => $blocked->id,
2605             'userid' => $userid,
2606             'relateduserid' => $usertoblockid,
2607             'context' => \context_user::instance($userid)
2608         ));
2609         $event->add_record_snapshot('message_users_blocked', $blocked);
2610         $event->trigger();
2611     }
2613     /**
2614      * Handles unblocking a user.
2615      *
2616      * @param int $userid The id of the user who is unblocking
2617      * @param int $usertounblockid The id of the user being unblocked
2618      */
2619     public static function unblock_user(int $userid, int $usertounblockid) {
2620         global $DB;
2622         if ($blockeduser = $DB->get_record('message_users_blocked',
2623                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2624             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2626             // Trigger event for unblocking a contact.
2627             $event = \core\event\message_user_unblocked::create(array(
2628                 'objectid' => $blockeduser->id,
2629                 'userid' => $userid,
2630                 'relateduserid' => $usertounblockid,
2631                 'context' => \context_user::instance($userid)
2632             ));
2633             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2634             $event->trigger();
2635         }
2636     }
2638     /**
2639      * Checks if users are already contacts.
2640      *
2641      * @param int $userid The id of one of the users
2642      * @param int $contactid The id of the other user
2643      * @return bool Returns true if they are a contact, false otherwise
2644      */
2645     public static function is_contact(int $userid, int $contactid) : bool {
2646         global $DB;
2648         $sql = "SELECT id
2649                   FROM {message_contacts} mc
2650                  WHERE (mc.userid = ? AND mc.contactid = ?)
2651                     OR (mc.userid = ? AND mc.contactid = ?)";
2652         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2653     }
2655     /**
2656      * Returns the row in the database table message_contacts that represents the contact between two people.
2657      *
2658      * @param int $userid The id of one of the users
2659      * @param int $contactid The id of the other user
2660      * @return mixed A fieldset object containing the record, false otherwise
2661      */
2662     public static function get_contact(int $userid, int $contactid) {
2663         global $DB;
2665         $sql = "SELECT mc.*
2666                   FROM {message_contacts} mc
2667                  WHERE (mc.userid = ? AND mc.contactid = ?)
2668                     OR (mc.userid = ? AND mc.contactid = ?)";
2669         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2670     }
2672     /**
2673      * Checks if a user is already blocked.
2674      *
2675      * @param int $userid
2676      * @param int $blockeduserid
2677      * @return bool Returns true if they are a blocked, false otherwise
2678      */
2679     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2680         global $DB;
2682         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2683     }
2685     /**
2686      * Get contact requests between users.
2687      *
2688      * @param int $userid The id of the user who is creating the contact request
2689      * @param int $requesteduserid The id of the user being requested
2690      * @return \stdClass[]
2691      */
2692     public static function get_contact_requests_between_users(int $userid, int $requesteduserid) : array {
2693         global $DB;
2695         $sql = "SELECT *
2696                   FROM {message_contact_requests} mcr
2697                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2698                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2699         return $DB->get_records_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2700     }
2702     /**
2703      * Checks if a contact request already exists between users.
2704      *
2705      * @param int $userid The id of the user who is creating the contact request
2706      * @param int $requesteduserid The id of the user being requested
2707      * @return bool Returns true if a contact request exists, false otherwise
2708      */
2709     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2710         global $DB;
2712         $sql = "SELECT id
2713                   FROM {message_contact_requests} mcr
2714                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2715                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2716         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2717     }
2719     /**
2720      * Checks if a user is already in a conversation.
2721      *
2722      * @param int $userid The id of the user we want to check if they are in a group
2723      * @param int $conversationid The id of the conversation
2724      * @return bool Returns true if a contact request exists, false otherwise
2725      */
2726     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2727         global $DB;
2729         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2730             'userid' => $userid]);
2731     }
2733     /**
2734      * Checks if the sender can message the recipient.
2735      *
2736      * @param int $recipientid
2737      * @param int $senderid
2738      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2739      */
2740     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2741         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2742             // The sender has the ability to contact any user across the entire site.
2743             return true;
2744         }
2746         // The initial value of $cancontact is null to indicate that a value has not been determined.
2747         $cancontact = null;
2749         if (self::is_blocked($recipientid, $senderid)) {
2750             // The recipient has specifically blocked this sender.
2751             $cancontact = false;
2752         }
2754         $sharedcourses = null;
2755         if (null === $cancontact) {
2756             // There are three user preference options:
2757             // - Site: Allow anyone not explicitly blocked to contact me;
2758             // - Course members: Allow anyone I am in a course with to contact me; and
2759             // - Contacts: Only allow my contacts to contact me.
2760             //
2761             // The Site option is only possible when the messagingallusers site setting is also enabled.
2763             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2764             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2765                 // The user preference is to allow any user to contact them.
2766                 // No need to check anything else.
2767                 $cancontact = true;
2768             } else {
2769                 // This user only allows their own contacts, and possibly course peers, to contact them.
2770                 // If the users are contacts then we can avoid the more expensive shared courses check.
2771                 $cancontact = self::is_contact($senderid, $recipientid);
2773                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2774                     // The users are not contacts and the user allows course member messaging.
2775                     // Check whether these two users share any course together.
2776                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2777                     $cancontact = (!empty($sharedcourses));
2778                 }
2779             }
2780         }
2782         if (false === $cancontact) {
2783             // At the moment the users cannot contact one another.
2784             // Check whether the messageanyuser capability applies in any of the shared courses.
2785             // This is intended to allow teachers to message students regardless of message settings.
2787             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2788             if (null === $sharedcourses) {
2789                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2790             }
2792             foreach ($sharedcourses as $course) {
2793                 // Note: enrol_get_shared_courses will preload any shared context.
2794                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2795                     $cancontact = true;
2796                     break;
2797                 }
2798             }
2799         }
2801         return $cancontact;
2802     }
2804     /**
2805      * Add some new members to an existing conversation.
2806      *
2807      * @param array $userids User ids array to add as members.
2808      * @param int $convid The conversation id. Must exists.
2809      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2810      * @throws \dml_exception If there is a database error
2811      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2812      */
2813     public static function add_members_to_conversation(array $userids, int $convid) {
2814         global $DB;
2816         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2818         // We can only add members to a group conversation.
2819         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2820             throw new \moodle_exception('You can not add members to a non-group conversation.');
2821         }
2823         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2824         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2825         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2827         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2828         $memberuserids = array_values($DB->get_records_menu(
2829             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2830         );
2832         // Work with existing new members.
2833         $members = array();
2834         $newuserids = array_diff($existingusers, $memberuserids);
2835         foreach ($newuserids as $userid) {
2836             $member = new \stdClass();
2837             $member->conversationid = $convid;
2838             $member->userid = $userid;
2839             $member->timecreated = time();
2840             $members[] = $member;
2841         }
2843         $DB->insert_records('message_conversation_members', $members);
2844     }
2846     /**
2847      * Remove some members from an existing conversation.
2848      *
2849      * @param array $userids The user ids to remove from conversation members.
2850      * @param int $convid The conversation id. Must exists.
2851      * @throws \dml_exception
2852      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2853      */
2854     public static function remove_members_from_conversation(array $userids, int $convid) {
2855         global $DB;
2857         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2859         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2860             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2861         }
2863         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2864         $params['convid'] = $convid;
2866         $DB->delete_records_select('message_conversation_members',
2867             "conversationid = :convid AND userid $useridcondition", $params);
2868     }
2870     /**
2871      * Count conversation members.
2872      *
2873      * @param int $convid The conversation id.
2874      * @return int Number of conversation members.
2875      * @throws \dml_exception
2876      */
2877     public static function count_conversation_members(int $convid) : int {
2878         global $DB;
2880         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2881     }
2883     /**
2884      * Checks whether or not a conversation area is enabled.
2885      *
2886      * @param string $component Defines the Moodle component which the area was added to.
2887      * @param string $itemtype Defines the type of the component.
2888      * @param int $itemid The id of the component.
2889      * @param int $contextid The id of the context.
2890      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2891      */
2892     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2893         global $DB;
2895         return $DB->record_exists('message_conversations',
2896             [
2897                 'itemid' => $itemid,
2898                 'contextid' => $contextid,
2899                 'component' => $component,
2900                 'itemtype' => $itemtype,
2901                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2902             ]
2903         );
2904     }
2906     /**
2907      * Get conversation by area.
2908      *
2909      * @param string $component Defines the Moodle component which the area was added to.
2910      * @param string $itemtype Defines the type of the component.
2911      * @param int $itemid The id of the component.
2912      * @param int $contextid The id of the context.
2913      * @return \stdClass
2914      */
2915     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2916         global $DB;
2918         return $DB->get_record('message_conversations',
2919             [
2920                 'itemid' => $itemid,
2921                 'contextid' => $contextid,
2922                 'component' => $component,
2923                 'itemtype'  => $itemtype
2924             ]
2925         );
2926     }
2928     /**
2929      * Enable a conversation.
2930      *
2931      * @param int $conversationid The id of the conversation.
2932      * @return void
2933      */
2934     public static function enable_conversation(int $conversationid) {
2935         global $DB;
2937         $conversation = new \stdClass();
2938         $conversation->id = $conversationid;
2939         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2940         $conversation->timemodified = time();
2941         $DB->update_record('message_conversations', $conversation);
2942     }
2944     /**
2945      * Disable a conversation.
2946      *
2947      * @param int $conversationid The id of the conversation.
2948      * @return void
2949      */
2950     public static function disable_conversation(int $conversationid) {
2951         global $DB;
2953         $conversation = new \stdClass();
2954         $conversation->id = $conversationid;
2955         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2956         $conversation->timemodified = time();
2957         $DB->update_record('message_conversations', $conversation);
2958     }
2960     /**
2961      * Update the name of a conversation.
2962      *
2963      * @param int $conversationid The id of a conversation.
2964      * @param string $name The main name of the area
2965      * @return void
2966      */
2967     public static function update_conversation_name(int $conversationid, string $name) {
2968         global $DB;
2970         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2971             if ($name <> $conversation->name) {
2972                 $conversation->name = $name;
2973                 $conversation->timemodified = time();
2974                 $DB->update_record('message_conversations', $conversation);
2975             }
2976         }
2977     }
2979     /**
2980      * Returns a list of conversation members.
2981      *
2982      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2983      * @param int $conversationid The id of the conversation
2984      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2985      * @param bool $includeprivacyinfo Do we want to include privacy requests with this data?
2986      * @param int $limitfrom
2987      * @param int $limitnum
2988      * @return array
2989      */
2990     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2991                                                     bool $includeprivacyinfo = false, int $limitfrom = 0,
2992                                                     int $limitnum = 0) : array {
2993         global $DB;
2995         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2996                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2997             $userids = array_keys($members);
2998             $members = helper::get_member_info($userid, $userids, $includecontactrequests, $includeprivacyinfo);
3000             return $members;
3001         }
3003         return [];
3004     }
3006     /**
3007      * Get the unread counts for all conversations for the user, sorted by type, and including favourites.
3008      *
3009      * @param int $userid the id of the user whose conversations we'll check.
3010      * @return array the unread counts for each conversation, indexed by type.
3011      */
3012     public static function get_unread_conversation_counts(int $userid) : array {
3013         global $DB;
3015         // Get all conversations the user is in, and check unread.
3016         $unreadcountssql = 'SELECT conv.id, conv.type, indcounts.unreadcount
3017                               FROM {message_conversations} conv
3018                         INNER JOIN (
3019                                       SELECT m.conversationid, count(m.id) as unreadcount
3020                                         FROM {messages} m
3021                                   INNER JOIN {message_conversations} mc
3022                                           ON mc.id = m.conversationid
3023                                   INNER JOIN {message_conversation_members} mcm
3024                                           ON m.conversationid = mcm.conversationid
3025                                    LEFT JOIN {message_user_actions} mua
3026                                           ON (mua.messageid = m.id AND mua.userid = ? AND
3027                                              (mua.action = ? OR mua.action = ?))
3028                                        WHERE mcm.userid = ?
3029                                          AND m.useridfrom != ?
3030                                          AND mua.id is NULL
3031                                     GROUP BY m.conversationid
3032                                    ) indcounts
3033                                 ON indcounts.conversationid = conv.id
3034                              WHERE conv.enabled = 1';
3036         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
3037             $userid, $userid]);
3039         // Get favourites, so we can track these separately.
3040         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
3041         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
3042         $favouriteconvids = array_flip(array_column($favouriteconversations, 'itemid'));
3044         // Assemble the return array.
3045         $counts = ['favourites' => 0, 'types' => [
3046             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL => 0,
3047             self::MESSAGE_CONVERSATION_TYPE_GROUP => 0
3048         ]];
3049         foreach ($unreadcounts as $convid => $info) {
3050             if (isset($favouriteconvids[$convid])) {
3051                 $counts['favourites']++;
3052                 continue;
3053             }
3054             $counts['types'][$info->type]++;
3055         }
3057         return $counts;
3058     }