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