Merge branch 'MDL-63716-master' of git://github.com/damyon/moodle
[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.timecreated, 0 as isread, $ufields, mub.id as userfrom_blocked, $ufields2,
104                        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         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid, 'userid3' => $userid);
223         // Ok, let's search for contacts first.
224         $contacts = array();
225         $sql = "SELECT $ufields, mub.id as isuserblocked
226                 FROM {user} u
227                 JOIN {message_contacts} mc
228                   ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
229            LEFT JOIN {message_users_blocked} mub
230                   ON (mub.userid = :userid3 AND mub.blockeduserid = u.id)
231                WHERE u.deleted = 0
232                  AND u.confirmed = 1
233                  AND " . $DB->sql_like($fullname, ':search', false) . "
234                  AND u.id $exclude
235             ORDER BY " . $DB->sql_fullname();
237         if ($users = $DB->get_records_sql($sql, $params + $excludeparams, 0, $limitnum)) {
238             foreach ($users as $user) {
239                 $user->blocked = $user->isuserblocked ? 1 : 0;
240                 $contacts[] = helper::create_contact($user);
241             }
242         }
244         // Now, let's get the courses.
245         // Make sure to limit searches to enrolled courses.
246         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
247         $courses = array();
248         // Really we want the user to be able to view the participants if they have the capability
249         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
250         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
251         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
252         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
253                 array('moodle/course:viewparticipants'))) {
254             foreach ($arrcourses as $course) {
255                 if (isset($enrolledcourses[$course->id])) {
256                     $data = new \stdClass();
257                     $data->id = $course->id;
258                     $data->shortname = $course->shortname;
259                     $data->fullname = $course->fullname;
260                     $courses[] = $data;
261                 }
262             }
263         }
265         // Let's get those non-contacts.
266         $noncontacts = array();
267         if ($CFG->messagingallusers) {
268             // In case $CFG->messagingallusers is enabled, search for all users site-wide but are not user's contact.
269             $sql = "SELECT $ufields
270                       FROM {user} u
271                  LEFT JOIN {message_users_blocked} mub
272                         ON (mub.userid = :userid1 AND mub.blockeduserid = u.id)
273                      WHERE u.deleted = 0
274                        AND u.confirmed = 1
275                        AND " . $DB->sql_like($fullname, ':search', false) . "
276                        AND u.id $exclude
277                        AND NOT EXISTS (SELECT mc.id
278                                          FROM {message_contacts} mc
279                                         WHERE (mc.userid = u.id AND mc.contactid = :userid2)
280                                            OR (mc.userid = :userid3 AND mc.contactid = u.id))
281                   ORDER BY " . $DB->sql_fullname();
282         } else {
283             // In case $CFG->messagingallusers is disabled, search for users you have a conversation with.
284             // Messaging setting could change, so could exist an old conversation with users you cannot message anymore.
285             $sql = "SELECT $ufields, mub.id as isuserblocked
286                       FROM {user} u
287                  LEFT JOIN {message_users_blocked} mub
288                         ON (mub.userid = :userid1 AND mub.blockeduserid = u.id)
289                 INNER JOIN {message_conversation_members} cm
290                         ON u.id = cm.userid
291                 INNER JOIN {message_conversation_members} cm2
292                         ON cm.conversationid = cm2.conversationid AND cm2.userid = :userid
293                      WHERE u.deleted = 0
294                        AND u.confirmed = 1
295                        AND " . $DB->sql_like($fullname, ':search', false) . "
296                        AND u.id $exclude
297                        AND NOT EXISTS (SELECT mc.id
298                                          FROM {message_contacts} mc
299                                         WHERE (mc.userid = u.id AND mc.contactid = :userid2)
300                                            OR (mc.userid = :userid3 AND mc.contactid = u.id))
301                   ORDER BY " . $DB->sql_fullname();
302             $params['userid'] = $userid;
303         }
304         if ($users = $DB->get_records_sql($sql,  $params + $excludeparams, 0, $limitnum)) {
305             foreach ($users as $user) {
306                 $noncontacts[] = helper::create_contact($user);
307             }
308         }
310         return array($contacts, $courses, $noncontacts);
311     }
313     /**
314      * Handles searching for user.
315      *
316      * @param int $userid The user id doing the searching
317      * @param string $search The string the user is searching
318      * @param int $limitfrom
319      * @param int $limitnum
320      * @return array
321      */
322     public static function message_search_users(int $userid, string $search, int $limitfrom = 0, int $limitnum = 1000) : array {
323         global $CFG, $DB;
325         // Used to search for contacts.
326         $fullname = $DB->sql_fullname();
328         // Users not to include.
329         $excludeusers = array($userid, $CFG->siteguest);
330         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
332         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid);
334         // Ok, let's search for contacts first.
335         $sql = "SELECT u.id
336                   FROM {user} u
337                   JOIN {message_contacts} mc
338                     ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
339                  WHERE u.deleted = 0
340                    AND u.confirmed = 1
341                    AND " . $DB->sql_like($fullname, ':search', false) . "
342                    AND u.id $exclude
343               ORDER BY " . $DB->sql_fullname();
344         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
346         $orderedcontacs = array();
347         if (!empty($foundusers)) {
348             $contacts = helper::get_member_info($userid, array_keys($foundusers));
349             // The get_member_info returns an associative array, so is not ordered in the same way.
350             // We need to reorder it again based on query's result.
351             foreach ($foundusers as $key => $value) {
352                 $contact = $contacts[$key];
353                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
354                 $orderedcontacs[] = $contact;
355             }
356         }
358         // Let's get those non-contacts.
359         if ($CFG->messagingallusers) {
360             // In case $CFG->messagingallusers is enabled, search for all users site-wide but are not user's contact.
361             $sql = "SELECT u.id
362                       FROM {user} u
363                      WHERE u.deleted = 0
364                        AND u.confirmed = 1
365                        AND " . $DB->sql_like($fullname, ':search', false) . "
366                        AND u.id $exclude
367                        AND NOT EXISTS (SELECT mc.id
368                                          FROM {message_contacts} mc
369                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
370                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
371                   ORDER BY " . $DB->sql_fullname();
372         } else {
373             // In case $CFG->messagingallusers is disabled, search for users you have a conversation with.
374             // Messaging setting could change, so could exist an old conversation with users you cannot message anymore.
375             $sql = "SELECT u.id
376                       FROM {user} u
377                 INNER JOIN {message_conversation_members} cm
378                         ON u.id = cm.userid
379                 INNER JOIN {message_conversation_members} cm2
380                         ON cm.conversationid = cm2.conversationid AND cm2.userid = :userid
381                      WHERE u.deleted = 0
382                        AND u.confirmed = 1
383                        AND " . $DB->sql_like($fullname, ':search', false) . "
384                        AND u.id $exclude
385                        AND NOT EXISTS (SELECT mc.id
386                                          FROM {message_contacts} mc
387                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
388                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
389                   ORDER BY " . $DB->sql_fullname();
390             $params['userid'] = $userid;
391         }
392         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
394         $orderednoncontacs = array();
395         if (!empty($foundusers)) {
396             $noncontacts = helper::get_member_info($userid, array_keys($foundusers));
397             // The get_member_info returns an associative array, so is not ordered in the same way.
398             // We need to reorder it again based on query's result.
399             foreach ($foundusers as $key => $value) {
400                 $contact = $noncontacts[$key];
401                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
402                 $orderednoncontacs[] = $contact;
403             }
404         }
406         return array($orderedcontacs, $orderednoncontacs);
407     }
409     /**
410      * Gets extra fields, like image url and subname for any conversations linked to components.
411      *
412      * The subname is like a subtitle for the conversation, to compliment it's name.
413      * The imageurl is the location of the image for the conversation, as might be seen on a listing of conversations for a user.
414      *
415      * @param array $conversations a list of conversations records.
416      * @return array the array of subnames, index by conversation id.
417      * @throws \coding_exception
418      * @throws \dml_exception
419      */
420     protected static function get_linked_conversation_extra_fields(array $conversations) : array {
421         global $DB;
423         $linkedconversations = [];
424         foreach ($conversations as $conversation) {
425             if (!is_null($conversation->component) && !is_null($conversation->itemtype)) {
426                 $linkedconversations[$conversation->component][$conversation->itemtype][$conversation->id]
427                     = $conversation->itemid;
428             }
429         }
430         if (empty($linkedconversations)) {
431             return [];
432         }
434         // TODO: MDL-63814: Working out the subname for linked conversations should be done in a generic way.
435         // Get the itemid, but only for course group linked conversation for now.
436         $extrafields = [];
437         if (!empty($linkeditems = $linkedconversations['core_group']['groups'])) { // Format: [conversationid => itemid].
438             // Get the name of the course to which the group belongs.
439             list ($groupidsql, $groupidparams) = $DB->get_in_or_equal(array_values($linkeditems), SQL_PARAMS_NAMED, 'groupid');
440             $sql = "SELECT g.*, c.shortname as courseshortname
441                       FROM {groups} g
442                       JOIN {course} c
443                         ON g.courseid = c.id
444                      WHERE g.id $groupidsql";
445             $courseinfo = $DB->get_records_sql($sql, $groupidparams);
446             foreach ($linkeditems as $convid => $groupid) {
447                 if (array_key_exists($groupid, $courseinfo)) {
448                     $group = $courseinfo[$groupid];
449                     // Subname.
450                     $extrafields[$convid]['subname'] = format_string($courseinfo[$groupid]->courseshortname);
452                     // Imageurl.
453                     $extrafields[$convid]['imageurl'] = '';
454                     if ($url = get_group_picture_url($group, $group->courseid, true)) {
455                         $extrafields[$convid]['imageurl'] = $url->out(false);
456                     }
457                 }
458             }
459         }
460         return $extrafields;
461     }
464     /**
465      * Returns the contacts and their conversation to display in the contacts area.
466      *
467      * ** WARNING **
468      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
469      * to retrieve too much information in a single call will cause performance problems.
470      * ** WARNING **
471      *
472      * This function has specifically been altered to break each of the data sets it
473      * requires into separate database calls. This is to avoid the performance problems
474      * observed when attempting to join large data sets (e.g. the message tables and
475      * the user table).
476      *
477      * While it is possible to gather the data in a single query, and it may even be
478      * more efficient with a correctly tuned database, we have opted to trade off some of
479      * the benefits of a single query in order to ensure this function will work on
480      * most databases with default tunings and with large data sets.
481      *
482      * @param int $userid The user id
483      * @param int $limitfrom
484      * @param int $limitnum
485      * @param int $type the type of the conversation, if you wish to filter to a certain type (see api constants).
486      * @param bool $favourites whether to include NO favourites (false) or ONLY favourites (true), or null to ignore this setting.
487      * @return array the array of conversations
488      * @throws \moodle_exception
489      */
490     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20, int $type = null,
491             bool $favourites = null) {
492         global $DB;
494         if (!is_null($type) && !in_array($type, [self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
495                 self::MESSAGE_CONVERSATION_TYPE_GROUP])) {
496             throw new \moodle_exception("Invalid value ($type) for type param, please see api constants.");
497         }
499         // We need to know which conversations are favourites, so we can either:
500         // 1) Include the 'isfavourite' attribute on conversations (when $favourite = null and we're including all conversations)
501         // 2) Restrict the results to ONLY those conversations which are favourites (when $favourite = true)
502         // 3) Restrict the results to ONLY those conversations which are NOT favourites (when $favourite = false).
503         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
504         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
505         $favouriteconversationids = array_column($favouriteconversations, 'itemid');
506         if ($favourites && empty($favouriteconversationids)) {
507             return []; // If we are aiming to return ONLY favourites, and we have none, there's nothing more to do.
508         }
510         // CONVERSATIONS AND MOST RECENT MESSAGE.
511         // Include those conversations with messages first (ordered by most recent message, desc), then add any conversations which
512         // don't have messages, such as newly created group conversations.
513         // Because we're sorting by message 'timecreated', those conversations without messages could be at either the start or the
514         // end of the results (behaviour for sorting of nulls differs between DB vendors), so we use the case to presort these.
516         // If we need to return ONLY favourites, or NO favourites, generate the SQL snippet.
517         $favouritesql = "";
518         $favouriteparams = [];
519         if (null !== $favourites && !empty($favouriteconversationids)) {
520             list ($insql, $favouriteparams) =
521                     $DB->get_in_or_equal($favouriteconversationids, SQL_PARAMS_NAMED, 'favouriteids', $favourites);
522             $favouritesql = " AND mc.id {$insql} ";
523         }
525         // If we need to restrict type, generate the SQL snippet.
526         $typesql = !is_null($type) ? " AND mc.type = :convtype " : "";
528         $sql = "SELECT m.id as messageid, mc.id as id, mc.name as conversationname, mc.type as conversationtype, m.useridfrom,
529                        m.smallmessage, m.fullmessage, m.fullmessageformat, m.fullmessagehtml, m.timecreated, mc.component,
530                        mc.itemtype, mc.itemid
531                   FROM {message_conversations} mc
532             INNER JOIN {message_conversation_members} mcm
533                     ON (mcm.conversationid = mc.id AND mcm.userid = :userid3)
534             LEFT JOIN (
535                           SELECT m.conversationid, MAX(m.id) AS messageid
536                             FROM {messages} m
537                       INNER JOIN (
538                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
539                                         FROM {messages} m
540                                   INNER JOIN {message_conversation_members} mcm
541                                           ON mcm.conversationid = m.conversationid
542                                    LEFT JOIN {message_user_actions} mua
543                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
544                                        WHERE mua.id is NULL
545                                          AND mcm.userid = :userid2
546                                     GROUP BY m.conversationid
547                                  ) maxmessage
548                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
549                          GROUP BY m.conversationid
550                        ) lastmessage
551                     ON lastmessage.conversationid = mc.id
552             LEFT JOIN {messages} m
553                    ON m.id = lastmessage.messageid
554                 WHERE mc.id IS NOT NULL $typesql $favouritesql
555               ORDER BY (CASE WHEN m.timecreated IS NULL THEN 0 ELSE 1 END) DESC, m.timecreated DESC, id DESC";
557         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
558             'userid2' => $userid, 'userid3' => $userid, 'convtype' => $type]);
559         $conversationset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
561         $conversations = [];
562         $members = [];
563         $individualmembers = [];
564         $groupmembers = [];
565         foreach ($conversationset as $conversation) {
566             $conversations[$conversation->id] = $conversation;
567             $members[$conversation->id] = [];
568         }
569         $conversationset->close();
571         // If there are no conversations found, then return early.
572         if (empty($conversations)) {
573             return [];
574         }
576         // COMPONENT-LINKED CONVERSATION FIELDS.
577         // Conversations linked to components may have extra information, such as:
578         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
579         // - imageurl: A URL to the image for the linked conversation.
580         // For now, this is ONLY course groups.
581         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
583         // MEMBERS.
584         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
585         // message or not.
586         //
587         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
588         // we want the details of the other member in the conversation (i.e. not the current user).
589         //
590         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
591         // This can be the current user or another group member, but for groups without messages, this will be empty.
592         //
593         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
594         // query to get the 'other' user as we already have that information.
596         // Work out which members we have already, and which ones we might need to fetch.
597         // If all the last messages were from another user, then we don't need to fetch anything further.
598         foreach ($conversations as $conversation) {
599             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
600                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
601                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
602                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
603                 } else {
604                     $individualconversations[] = $conversation->id;
605                 }
606             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
607                 // If we have a recent message, the sender is our member.
608                 if (!is_null($conversation->useridfrom)) {
609                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
610                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
611                 }
612             }
613         }
614         // If we need to fetch any member information for any of the individual conversations.
615         // This is the case if any of the individual conversations have a recent message sent by the current user.
616         if (!empty($individualconversations)) {
617             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
618             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
619                         FROM {message_conversation_members} mcm
620                        WHERE mcm.conversationid $icidinsql
621                        AND mcm.userid != :userid
622                        ORDER BY mcm.id";
623             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
624             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
626             foreach ($conversationmembers as $mid => $member) {
627                 $members[$member->conversationid][$member->userid] = $member->userid;
628                 $individualmembers[$member->userid] = $member->userid;
629             }
630         }
632         // We could fail early here if we're sure that:
633         // a) we have no otherusers for all the conversations (users may have been deleted)
634         // b) we're sure that all conversations are individual (1:1).
636         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
637         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
638         // tables because on large sites these tables are massive which results in extremely slow
639         // performance (typically due to join buffer exhaustion).
640         if (!empty($individualmembers) || !empty($groupmembers)) {
641             // Now, we want to remove any duplicates from the group members array. For individual members we will
642             // be doing a more extensive call as we want their contact requests as well as privacy information,
643             // which is not necessary for group conversations.
644             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
646             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
647             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
649             // Don't use array_merge, as we lose array keys.
650             $memberinfo = $individualmemberinfo + $groupmemberinfo;
652             // Update the members array with the member information.
653             $deletedmembers = [];
654             foreach ($members as $convid => $memberarr) {
655                 foreach ($memberarr as $key => $memberid) {
656                     if (array_key_exists($memberid, $memberinfo)) {
657                         // If the user is deleted, remember that.
658                         if ($memberinfo[$memberid]->isdeleted) {
659                             $deletedmembers[$convid][] = $memberid;
660                         }
662                         $members[$convid][$key] = clone $memberinfo[$memberid];
664                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
665                             // Remove data we don't need for group.
666                             $members[$convid][$key]->requirescontact = null;
667                             $members[$convid][$key]->canmessage = null;
668                             $members[$convid][$key]->contactrequests = [];
669                         }
670                     }
671                 }
672             }
673         }
675         // MEMBER COUNT.
676         $cids = array_column($conversations, 'id');
677         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
678         $membercountsql = "SELECT conversationid, count(id) AS membercount
679                              FROM {message_conversation_members} mcm
680                             WHERE mcm.conversationid $cidinsql
681                          GROUP BY mcm.conversationid";
682         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
684         // UNREAD MESSAGE COUNT.
685         // Finally, let's get the unread messages count for this user so that we can add it
686         // to the conversation. Remember we need to ignore the messages the user sent.
687         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
688                               FROM {messages} m
689                         INNER JOIN {message_conversations} mc
690                                 ON mc.id = m.conversationid
691                         INNER JOIN {message_conversation_members} mcm
692                                 ON m.conversationid = mcm.conversationid
693                          LEFT JOIN {message_user_actions} mua
694                                 ON (mua.messageid = m.id AND mua.userid = ? AND
695                                    (mua.action = ? OR mua.action = ?))
696                              WHERE mcm.userid = ?
697                                AND m.useridfrom != ?
698                                AND mua.id is NULL
699                           GROUP BY m.conversationid';
700         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
701             $userid, $userid]);
703         // Now, create the final return structure.
704         $arrconversations = [];
705         foreach ($conversations as $conversation) {
706             // Do not include any individual conversation which:
707             // a) Contains a deleted member or
708             // b) Does not contain a recent message for the user (this happens if the user has deleted all messages).
709             // Group conversations with deleted users or no messages are always returned.
710             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
711                     && (isset($deletedmembers[$conversation->id]) || empty($conversation->messageid))) {
712                 continue;
713             }
715             $conv = new \stdClass();
716             $conv->id = $conversation->id;
717             $conv->name = $conversation->conversationname;
718             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
719             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
720             $conv->type = $conversation->conversationtype;
721             $conv->membercount = $membercounts[$conv->id]->membercount;
722             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
723             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
724             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
725             $conv->members = $members[$conv->id];
727             // Add the most recent message information.
728             $conv->messages = [];
729             if ($conversation->smallmessage) {
730                 $msg = new \stdClass();
731                 $msg->id = $conversation->messageid;
732                 $msg->text = message_format_message_text($conversation);
733                 $msg->useridfrom = $conversation->useridfrom;
734                 $msg->timecreated = $conversation->timecreated;
735                 $conv->messages[] = $msg;
736             }
738             $arrconversations[] = $conv;
739         }
740         return $arrconversations;
741     }
743     /**
744      * Returns all conversations between two users
745      *
746      * @param int $userid1 One of the user's id
747      * @param int $userid2 The other user's id
748      * @param int $limitfrom
749      * @param int $limitnum
750      * @return array
751      * @throws \dml_exception
752      */
753     public static function get_conversations_between_users(int $userid1, int $userid2,
754                                                            int $limitfrom = 0, int $limitnum = 20) : array {
756         global $DB;
758         if ($userid1 == $userid2) {
759             return array();
760         }
762         // Get all conversation where both user1 and user2 are members.
763         // TODO: Add subname value. Waiting for definite table structure.
764         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
765                   FROM {message_conversations} mc
766             INNER JOIN {message_conversation_members} mcm1
767                     ON mc.id = mcm1.conversationid
768             INNER JOIN {message_conversation_members} mcm2
769                     ON mc.id = mcm2.conversationid
770                  WHERE mcm1.userid = :userid1
771                    AND mcm2.userid = :userid2
772                    AND mc.enabled != 0
773               ORDER BY mc.timecreated DESC";
775         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
776     }
778     /**
779      * Mark a conversation as a favourite for the given user.
780      *
781      * @param int $conversationid the id of the conversation to mark as a favourite.
782      * @param int $userid the id of the user to whom the favourite belongs.
783      * @return favourite the favourite object.
784      * @throws \moodle_exception if the user or conversation don't exist.
785      */
786     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
787         if (!self::is_user_in_conversation($userid, $conversationid)) {
788             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
789         }
790         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
791         return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
792     }
794     /**
795      * Unset a conversation as a favourite for the given user.
796      *
797      * @param int $conversationid the id of the conversation to unset as a favourite.
798      * @param int $userid the id to whom the favourite belongs.
799      * @throws \moodle_exception if the favourite does not exist for the user.
800      */
801     public static function unset_favourite_conversation(int $conversationid, int $userid) {
802         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
803         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
804     }
806     /**
807      * Returns the contacts to display in the contacts area.
808      *
809      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
810      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
811      * Followup: MDL-63915
812      *
813      * @param int $userid The user id
814      * @param int $limitfrom
815      * @param int $limitnum
816      * @return array
817      */
818     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
819         global $DB;
821         $contactids = [];
822         $sql = "SELECT mc.*
823                   FROM {message_contacts} mc
824                  WHERE mc.userid = ? OR mc.contactid = ?
825               ORDER BY timecreated DESC";
826         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
827             foreach ($contacts as $contact) {
828                 if ($userid == $contact->userid) {
829                     $contactids[] = $contact->contactid;
830                 } else {
831                     $contactids[] = $contact->userid;
832                 }
833             }
834         }
836         if (!empty($contactids)) {
837             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
839             $sql = "SELECT u.*, mub.id as isblocked
840                       FROM {user} u
841                  LEFT JOIN {message_users_blocked} mub
842                         ON u.id = mub.blockeduserid
843                      WHERE u.id $insql";
844             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
845                 $arrcontacts = [];
846                 foreach ($contacts as $contact) {
847                     $contact->blocked = $contact->isblocked ? 1 : 0;
848                     $arrcontacts[] = helper::create_contact($contact);
849                 }
851                 return $arrcontacts;
852             }
853         }
855         return [];
856     }
858     /**
859      * Returns the an array of the users the given user is in a conversation
860      * with who are a contact and the number of unread messages.
861      *
862      * @param int $userid The user id
863      * @param int $limitfrom
864      * @param int $limitnum
865      * @return array
866      */
867     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
868         global $DB;
870         $userfields = \user_picture::fields('u', array('lastaccess'));
871         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
872                               FROM {message_contacts} mc
873                         INNER JOIN {user} u
874                                 ON (u.id = mc.contactid OR u.id = mc.userid)
875                          LEFT JOIN {messages} m
876                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
877                          LEFT JOIN {message_conversation_members} mcm
878                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
879                          LEFT JOIN {message_user_actions} mua
880                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
881                          LEFT JOIN {message_users_blocked} mub
882                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
883                              WHERE mua.id is NULL
884                                AND mub.id is NULL
885                                AND (mc.userid = ? OR mc.contactid = ?)
886                                AND u.id != ?
887                                AND u.deleted = 0
888                           GROUP BY $userfields";
890         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
891             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
892     }
894     /**
895      * Returns the an array of the users the given user is in a conversation
896      * with who are not a contact and the number of unread messages.
897      *
898      * @param int $userid The user id
899      * @param int $limitfrom
900      * @param int $limitnum
901      * @return array
902      */
903     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
904         global $DB;
906         $userfields = \user_picture::fields('u', array('lastaccess'));
907         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
908                               FROM {user} u
909                         INNER JOIN {messages} m
910                                 ON m.useridfrom = u.id
911                         INNER JOIN {message_conversation_members} mcm
912                                 ON mcm.conversationid = m.conversationid
913                          LEFT JOIN {message_user_actions} mua
914                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
915                          LEFT JOIN {message_contacts} mc
916                                 ON (mc.userid = ? AND mc.contactid = u.id)
917                          LEFT JOIN {message_users_blocked} mub
918                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
919                              WHERE mcm.userid = ?
920                                AND mcm.userid != m.useridfrom
921                                AND mua.id is NULL
922                                AND mub.id is NULL
923                                AND mc.id is NULL
924                                AND u.deleted = 0
925                           GROUP BY $userfields";
927         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
928             $limitfrom, $limitnum);
929     }
931     /**
932      * Returns the messages to display in the message area.
933      *
934      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
935      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
936      * Followup: MDL-63915
937      *
938      * @param int $userid the current user
939      * @param int $otheruserid the other user
940      * @param int $limitfrom
941      * @param int $limitnum
942      * @param string $sort
943      * @param int $timefrom the time from the message being sent
944      * @param int $timeto the time up until the message being sent
945      * @return array
946      */
947     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
948             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
950         if (!empty($timefrom)) {
951             // Get the conversation between userid and otheruserid.
952             $userids = [$userid, $otheruserid];
953             if (!$conversationid = self::get_conversation_between_users($userids)) {
954                 // This method was always used for individual conversations.
955                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
956                 $conversationid = $conversation->id;
957             }
959             // Check the cache to see if we even need to do a DB query.
960             $cache = \cache::make('core', 'message_time_last_message_between_users');
961             $key = helper::get_last_message_time_created_cache_key($conversationid);
962             $lastcreated = $cache->get($key);
964             // The last known message time is earlier than the one being requested so we can
965             // just return an empty result set rather than having to query the DB.
966             if ($lastcreated && $lastcreated < $timefrom) {
967                 return [];
968             }
969         }
971         $arrmessages = array();
972         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
973                                              $sort, $timefrom, $timeto)) {
974             $arrmessages = helper::create_messages($userid, $messages);
975         }
977         return $arrmessages;
978     }
980     /**
981      * Returns the messages for the defined conversation.
982      *
983      * @param  int $userid The current user.
984      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
985      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
986      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
987      * @param  string $sort The column name to order by including optionally direction.
988      * @param  int $timefrom The time from the message being sent.
989      * @param  int $timeto The time up until the message being sent.
990      * @return array of messages
991      */
992     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
993         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
995         if (!empty($timefrom)) {
996             // Check the cache to see if we even need to do a DB query.
997             $cache = \cache::make('core', 'message_time_last_message_between_users');
998             $key = helper::get_last_message_time_created_cache_key($convid);
999             $lastcreated = $cache->get($key);
1001             // The last known message time is earlier than the one being requested so we can
1002             // just return an empty result set rather than having to query the DB.
1003             if ($lastcreated && $lastcreated < $timefrom) {
1004                 return [];
1005             }
1006         }
1008         $arrmessages = array();
1009         if ($messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto)) {
1010             $arrmessages = helper::format_conversation_messages($userid, $convid, $messages);
1011         }
1013         return $arrmessages;
1014     }
1016     /**
1017      * Returns the most recent message between two users.
1018      *
1019      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1020      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1021      * Followup: MDL-63915
1022      *
1023      * @param int $userid the current user
1024      * @param int $otheruserid the other user
1025      * @return \stdClass|null
1026      */
1027     public static function get_most_recent_message($userid, $otheruserid) {
1028         // We want two messages here so we get an accurate 'blocktime' value.
1029         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1030             // Swap the order so we now have them in historical order.
1031             $messages = array_reverse($messages);
1032             $arrmessages = helper::create_messages($userid, $messages);
1033             return array_pop($arrmessages);
1034         }
1036         return null;
1037     }
1039     /**
1040      * Returns the most recent message in a conversation.
1041      *
1042      * @param int $convid The conversation identifier.
1043      * @param int $currentuserid The current user identifier.
1044      * @return \stdClass|null The most recent message.
1045      */
1046     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1047         global $USER;
1049         if (empty($currentuserid)) {
1050             $currentuserid = $USER->id;
1051         }
1053         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1054             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1055             return array_pop($convmessages['messages']);
1056         }
1058         return null;
1059     }
1061     /**
1062      * Returns the profile information for a contact for a user.
1063      *
1064      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1065      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1066      * Followup: MDL-63915
1067      *
1068      * @param int $userid The user id
1069      * @param int $otheruserid The id of the user whose profile we want to view.
1070      * @return \stdClass
1071      */
1072     public static function get_profile($userid, $otheruserid) {
1073         global $CFG, $PAGE;
1075         require_once($CFG->dirroot . '/user/lib.php');
1077         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1079         // Create the data we are going to pass to the renderable.
1080         $data = new \stdClass();
1081         $data->userid = $otheruserid;
1082         $data->fullname = fullname($user);
1083         $data->city = '';
1084         $data->country = '';
1085         $data->email = '';
1086         $data->isonline = null;
1087         // Get the user picture data - messaging has always shown these to the user.
1088         $userpicture = new \user_picture($user);
1089         $userpicture->size = 1; // Size f1.
1090         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1091         $userpicture->size = 0; // Size f2.
1092         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1094         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1095         if ($userfields) {
1096             if (isset($userfields['city'])) {
1097                 $data->city = $userfields['city'];
1098             }
1099             if (isset($userfields['country'])) {
1100                 $data->country = $userfields['country'];
1101             }
1102             if (isset($userfields['email'])) {
1103                 $data->email = $userfields['email'];
1104             }
1105             if (isset($userfields['lastaccess'])) {
1106                 $data->isonline = helper::is_online($userfields['lastaccess']);
1107             }
1108         }
1110         $data->isblocked = self::is_blocked($userid, $otheruserid);
1111         $data->iscontact = self::is_contact($userid, $otheruserid);
1113         return $data;
1114     }
1116     /**
1117      * Checks if a user can delete messages they have either received or sent.
1118      *
1119      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1120      *  but will still seem as if it was by the user)
1121      * @param int $conversationid The id of the conversation
1122      * @return bool Returns true if a user can delete the conversation, false otherwise.
1123      */
1124     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1125         global $USER;
1127         if (is_null($conversationid)) {
1128             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1129                 DEBUG_DEVELOPER);
1130             return false;
1131         }
1133         $systemcontext = \context_system::instance();
1135         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1136             return true;
1137         }
1139         if (!self::is_user_in_conversation($userid, $conversationid)) {
1140             return false;
1141         }
1143         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1144                 $USER->id == $userid) {
1145             return true;
1146         }
1148         return false;
1149     }
1151     /**
1152      * Deletes a conversation.
1153      *
1154      * This function does not verify any permissions.
1155      *
1156      * @deprecated since 3.6
1157      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1158      *  but will still seem as if it was by the user)
1159      * @param int $otheruserid The id of the other user in the conversation
1160      * @return bool
1161      */
1162     public static function delete_conversation($userid, $otheruserid) {
1163         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1164             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1166         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1168         // If there is no conversation, there is nothing to do.
1169         if (!$conversationid) {
1170             return true;
1171         }
1173         self::delete_conversation_by_id($userid, $conversationid);
1175         return true;
1176     }
1178     /**
1179      * Deletes a conversation for a specified user.
1180      *
1181      * This function does not verify any permissions.
1182      *
1183      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1184      *  but will still seem as if it was by the user)
1185      * @param int $conversationid The id of the other user in the conversation
1186      */
1187     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1188         global $DB, $USER;
1190         // Get all messages belonging to this conversation that have not already been deleted by this user.
1191         $sql = "SELECT m.*
1192                  FROM {messages} m
1193            INNER JOIN {message_conversations} mc
1194                    ON m.conversationid = mc.id
1195             LEFT JOIN {message_user_actions} mua
1196                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1197                 WHERE mua.id is NULL
1198                   AND mc.id = ?
1199              ORDER BY m.timecreated ASC";
1200         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1202         // Ok, mark these as deleted.
1203         foreach ($messages as $message) {
1204             $mua = new \stdClass();
1205             $mua->userid = $userid;
1206             $mua->messageid = $message->id;
1207             $mua->action = self::MESSAGE_ACTION_DELETED;
1208             $mua->timecreated = time();
1209             $mua->id = $DB->insert_record('message_user_actions', $mua);
1211             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1212                 $message->id, $mua->id)->trigger();
1213         }
1214     }
1216     /**
1217      * Returns the count of unread conversations (collection of messages from a single user) for
1218      * the given user.
1219      *
1220      * @param \stdClass $user the user who's conversations should be counted
1221      * @return int the count of the user's unread conversations
1222      */
1223     public static function count_unread_conversations($user = null) {
1224         global $USER, $DB;
1226         if (empty($user)) {
1227             $user = $USER;
1228         }
1230         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1231                   FROM {messages} m
1232             INNER JOIN {message_conversations} mc
1233                     ON m.conversationid = mc.id
1234             INNER JOIN {message_conversation_members} mcm
1235                     ON mc.id = mcm.conversationid
1236              LEFT JOIN {message_user_actions} mua
1237                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1238                  WHERE mcm.userid = ?
1239                    AND mcm.userid != m.useridfrom
1240                    AND mua.id is NULL";
1242         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1243     }
1245     /**
1246      * Checks if a user can mark all messages as read.
1247      *
1248      * @param int $userid The user id of who we want to mark the messages for
1249      * @param int $conversationid The id of the conversation
1250      * @return bool true if user is permitted, false otherwise
1251      * @since 3.6
1252      */
1253     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1254         global $USER;
1256         $systemcontext = \context_system::instance();
1258         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1259             return true;
1260         }
1262         if (!self::is_user_in_conversation($userid, $conversationid)) {
1263             return false;
1264         }
1266         if ($USER->id == $userid) {
1267             return true;
1268         }
1270         return false;
1271     }
1273     /**
1274      * Marks all messages being sent to a user in a particular conversation.
1275      *
1276      * If $conversationdid is null then it marks all messages as read sent to $userid.
1277      *
1278      * @param int $userid
1279      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1280      */
1281     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1282         global $DB;
1284         $messagesql = "SELECT m.*
1285                          FROM {messages} m
1286                    INNER JOIN {message_conversations} mc
1287                            ON mc.id = m.conversationid
1288                    INNER JOIN {message_conversation_members} mcm
1289                            ON mcm.conversationid = mc.id
1290                     LEFT JOIN {message_user_actions} mua
1291                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1292                         WHERE mua.id is NULL
1293                           AND mcm.userid = ?
1294                           AND m.useridfrom != ?";
1295         $messageparams = [];
1296         $messageparams[] = $userid;
1297         $messageparams[] = self::MESSAGE_ACTION_READ;
1298         $messageparams[] = $userid;
1299         $messageparams[] = $userid;
1300         if (!is_null($conversationid)) {
1301             $messagesql .= " AND mc.id = ?";
1302             $messageparams[] = $conversationid;
1303         }
1305         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1306         foreach ($messages as $message) {
1307             self::mark_message_as_read($userid, $message);
1308         }
1309         $messages->close();
1310     }
1312     /**
1313      * Marks all notifications being sent from one user to another user as read.
1314      *
1315      * If the from user is null then it marks all notifications as read sent to the to user.
1316      *
1317      * @param int $touserid the id of the message recipient
1318      * @param int|null $fromuserid the id of the message sender, null if all messages
1319      * @return void
1320      */
1321     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1322         global $DB;
1324         $notificationsql = "SELECT n.*
1325                               FROM {notifications} n
1326                              WHERE useridto = ?
1327                                AND timeread is NULL";
1328         $notificationsparams = [$touserid];
1329         if (!empty($fromuserid)) {
1330             $notificationsql .= " AND useridfrom = ?";
1331             $notificationsparams[] = $fromuserid;
1332         }
1334         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1335         foreach ($notifications as $notification) {
1336             self::mark_notification_as_read($notification);
1337         }
1338         $notifications->close();
1339     }
1341     /**
1342      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1343      *
1344      * Can be filtered by type.
1345      *
1346      * @deprecated since 3.5
1347      * @param int $touserid the id of the message recipient
1348      * @param int $fromuserid the id of the message sender
1349      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1350      * @return void
1351      */
1352     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1353         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1354             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1355             DEBUG_DEVELOPER);
1357         $type = strtolower($type);
1359         $conversationid = null;
1360         $ignoremessages = false;
1361         if (!empty($fromuserid)) {
1362             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1363             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1364                 $ignoremessages = true;
1365             }
1366         }
1368         if (!empty($type)) {
1369             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1370                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1371             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1372                 if (!$ignoremessages) {
1373                     self::mark_all_messages_as_read($touserid, $conversationid);
1374                 }
1375             }
1376         } else { // We want both.
1377             self::mark_all_notifications_as_read($touserid, $fromuserid);
1378             if (!$ignoremessages) {
1379                 self::mark_all_messages_as_read($touserid, $conversationid);
1380             }
1381         }
1382     }
1384     /**
1385      * Returns message preferences.
1386      *
1387      * @param array $processors
1388      * @param array $providers
1389      * @param \stdClass $user
1390      * @return \stdClass
1391      * @since 3.2
1392      */
1393     public static function get_all_message_preferences($processors, $providers, $user) {
1394         $preferences = helper::get_providers_preferences($providers, $user->id);
1395         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1397         // For every processors put its options on the form (need to get function from processor's lib.php).
1398         foreach ($processors as $processor) {
1399             $processor->object->load_data($preferences, $user->id);
1400         }
1402         // Load general messaging preferences.
1403         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1404         $preferences->mailformat = $user->mailformat;
1405         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1407         return $preferences;
1408     }
1410     /**
1411      * Count the number of users blocked by a user.
1412      *
1413      * @param \stdClass $user The user object
1414      * @return int the number of blocked users
1415      */
1416     public static function count_blocked_users($user = null) {
1417         global $USER, $DB;
1419         if (empty($user)) {
1420             $user = $USER;
1421         }
1423         $sql = "SELECT count(mub.id)
1424                   FROM {message_users_blocked} mub
1425                  WHERE mub.userid = :userid";
1426         return $DB->count_records_sql($sql, array('userid' => $user->id));
1427     }
1429     /**
1430      * Determines if a user is permitted to send another user a private message.
1431      * If no sender is provided then it defaults to the logged in user.
1432      *
1433      * @param \stdClass $recipient The user object.
1434      * @param \stdClass|null $sender The user object.
1435      * @return bool true if user is permitted, false otherwise.
1436      */
1437     public static function can_post_message($recipient, $sender = null) {
1438         global $USER;
1440         if (is_null($sender)) {
1441             // The message is from the logged in user, unless otherwise specified.
1442             $sender = $USER;
1443         }
1445         $systemcontext = \context_system::instance();
1446         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1447             return false;
1448         }
1450         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1451             return true;
1452         }
1454         // Check if the recipient can be messaged by the sender.
1455         return (self::can_contact_user($recipient->id, $sender->id));
1456     }
1458     /**
1459      * Determines if a user is permitted to send a message to a given conversation.
1460      * If no sender is provided then it defaults to the logged in user.
1461      *
1462      * @param int $userid the id of the user on which the checks will be applied.
1463      * @param int $conversationid the id of the conversation we wish to check.
1464      * @return bool true if the user can send a message to the conversation, false otherwise.
1465      * @throws \moodle_exception
1466      */
1467     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1468         global $DB;
1470         $systemcontext = \context_system::instance();
1471         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1472             return false;
1473         }
1475         if (!self::is_user_in_conversation($userid, $conversationid)) {
1476             return false;
1477         }
1479         // User can post messages and is in the conversation, but we need to check the conversation type to
1480         // know whether or not to check the user privacy settings via can_contact_user().
1481         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1482         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1483             return true;
1484         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1485             // Get the other user in the conversation.
1486             $members = self::get_conversation_members($userid, $conversationid);
1487             $otheruser = array_filter($members, function($member) use($userid) {
1488                 return $member->id != $userid;
1489             });
1490             $otheruser = reset($otheruser);
1492             return self::can_contact_user($otheruser->id, $userid);
1493         } else {
1494             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1495         }
1496     }
1498     /**
1499      * Send a message from a user to a conversation.
1500      *
1501      * This method will create the basic eventdata and delegate to message creation to message_send.
1502      * The message_send() method is responsible for event data that is specific to each recipient.
1503      *
1504      * @param int $userid the sender id.
1505      * @param int $conversationid the conversation id.
1506      * @param string $message the message to send.
1507      * @param int $format the format of the message to send.
1508      * @return \stdClass the message created.
1509      * @throws \coding_exception
1510      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1511      */
1512     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1513                                                         int $format) : \stdClass {
1514         global $DB;
1516         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1517             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1518         }
1520         $eventdata = new \core\message\message();
1521         $eventdata->courseid         = 1;
1522         $eventdata->component        = 'moodle';
1523         $eventdata->name             = 'instantmessage';
1524         $eventdata->userfrom         = $userid;
1525         $eventdata->convid           = $conversationid;
1527         if ($format == FORMAT_HTML) {
1528             $eventdata->fullmessagehtml  = $message;
1529             // Some message processors may revert to sending plain text even if html is supplied,
1530             // so we keep both plain and html versions if we're intending to send html.
1531             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1532         } else {
1533             $eventdata->fullmessage      = $message;
1534             $eventdata->fullmessagehtml  = '';
1535         }
1537         $eventdata->fullmessageformat = $format;
1538         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1540         $eventdata->timecreated     = time();
1541         $eventdata->notification    = 0;
1542         $messageid = message_send($eventdata);
1544         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1545         $message = (object) [
1546             'id' => $messagerecord->id,
1547             'useridfrom' => $messagerecord->useridfrom,
1548             'text' => $messagerecord->fullmessage,
1549             'timecreated' => $messagerecord->timecreated
1550         ];
1551         return $message;
1552     }
1554     /**
1555      * Get the messaging preference for a user.
1556      * If the user has not any messaging privacy preference:
1557      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1558      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1559      *
1560      * @param  int    $userid The user identifier.
1561      * @return int    The default messaging preference.
1562      */
1563     public static function get_user_privacy_messaging_preference(int $userid) : int {
1564         global $CFG;
1566         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1567         // otherwise, the default value will be "My contacts and anyone in my courses".
1568         if (empty($CFG->messagingallusers)) {
1569             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1570         } else {
1571             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1572         }
1573         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
1575         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1576         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1577         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1578             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1579         }
1581         return $privacypreference;
1582     }
1584     /**
1585      * Checks if the recipient is allowing messages from users that aren't a
1586      * contact. If not then it checks to make sure the sender is in the
1587      * recipient's contacts.
1588      *
1589      * @deprecated since 3.6
1590      * @param \stdClass $recipient The user object.
1591      * @param \stdClass|null $sender The user object.
1592      * @return bool true if $sender is blocked, false otherwise.
1593      */
1594     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1595         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1597         global $USER, $CFG;
1599         if (is_null($sender)) {
1600             // The message is from the logged in user, unless otherwise specified.
1601             $sender = $USER;
1602         }
1604         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1605         switch ($privacypreference) {
1606             case self::MESSAGE_PRIVACY_SITE:
1607                 if (!empty($CFG->messagingallusers)) {
1608                     // Users can be messaged without being contacts or members of the same course.
1609                     break;
1610                 }
1611                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1612                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1613             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1614                 // Confirm the sender and the recipient are both members of the same course.
1615                 if (enrol_sharing_course($recipient, $sender)) {
1616                     // All good, the recipient and the sender are members of the same course.
1617                     return false;
1618                 }
1619             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1620                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1621                 return !self::is_contact($sender->id, $recipient->id);
1622         }
1624         return false;
1625     }
1627     /**
1628      * Checks if the recipient has specifically blocked the sending user.
1629      *
1630      * Note: This function will always return false if the sender has the
1631      * readallmessages capability at the system context level.
1632      *
1633      * @deprecated since 3.6
1634      * @param int $recipientid User ID of the recipient.
1635      * @param int $senderid User ID of the sender.
1636      * @return bool true if $sender is blocked, false otherwise.
1637      */
1638     public static function is_user_blocked($recipientid, $senderid = null) {
1639         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1640             DEBUG_DEVELOPER);
1642         global $USER;
1644         if (is_null($senderid)) {
1645             // The message is from the logged in user, unless otherwise specified.
1646             $senderid = $USER->id;
1647         }
1649         $systemcontext = \context_system::instance();
1650         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1651             return false;
1652         }
1654         if (self::is_blocked($recipientid, $senderid)) {
1655             return true;
1656         }
1658         return false;
1659     }
1661     /**
1662      * Get specified message processor, validate corresponding plugin existence and
1663      * system configuration.
1664      *
1665      * @param string $name  Name of the processor.
1666      * @param bool $ready only return ready-to-use processors.
1667      * @return mixed $processor if processor present else empty array.
1668      * @since Moodle 3.2
1669      */
1670     public static function get_message_processor($name, $ready = false) {
1671         global $DB, $CFG;
1673         $processor = $DB->get_record('message_processors', array('name' => $name));
1674         if (empty($processor)) {
1675             // Processor not found, return.
1676             return array();
1677         }
1679         $processor = self::get_processed_processor_object($processor);
1680         if ($ready) {
1681             if ($processor->enabled && $processor->configured) {
1682                 return $processor;
1683             } else {
1684                 return array();
1685             }
1686         } else {
1687             return $processor;
1688         }
1689     }
1691     /**
1692      * Returns weather a given processor is enabled or not.
1693      * Note:- This doesn't check if the processor is configured or not.
1694      *
1695      * @param string $name Name of the processor
1696      * @return bool
1697      */
1698     public static function is_processor_enabled($name) {
1700         $cache = \cache::make('core', 'message_processors_enabled');
1701         $status = $cache->get($name);
1703         if ($status === false) {
1704             $processor = self::get_message_processor($name);
1705             if (!empty($processor)) {
1706                 $cache->set($name, $processor->enabled);
1707                 return $processor->enabled;
1708             } else {
1709                 return false;
1710             }
1711         }
1713         return $status;
1714     }
1716     /**
1717      * Set status of a processor.
1718      *
1719      * @param \stdClass $processor processor record.
1720      * @param 0|1 $enabled 0 or 1 to set the processor status.
1721      * @return bool
1722      * @since Moodle 3.2
1723      */
1724     public static function update_processor_status($processor, $enabled) {
1725         global $DB;
1726         $cache = \cache::make('core', 'message_processors_enabled');
1727         $cache->delete($processor->name);
1728         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1729     }
1731     /**
1732      * Given a processor object, loads information about it's settings and configurations.
1733      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1734      * or @see \get_message_processors()
1735      *
1736      * @param \stdClass $processor processor object
1737      * @return \stdClass processed processor object
1738      * @since Moodle 3.2
1739      */
1740     public static function get_processed_processor_object(\stdClass $processor) {
1741         global $CFG;
1743         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1744         if (is_readable($processorfile)) {
1745             include_once($processorfile);
1746             $processclass = 'message_output_' . $processor->name;
1747             if (class_exists($processclass)) {
1748                 $pclass = new $processclass();
1749                 $processor->object = $pclass;
1750                 $processor->configured = 0;
1751                 if ($pclass->is_system_configured()) {
1752                     $processor->configured = 1;
1753                 }
1754                 $processor->hassettings = 0;
1755                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1756                     $processor->hassettings = 1;
1757                 }
1758                 $processor->available = 1;
1759             } else {
1760                 print_error('errorcallingprocessor', 'message');
1761             }
1762         } else {
1763             $processor->available = 0;
1764         }
1765         return $processor;
1766     }
1768     /**
1769      * Retrieve users blocked by $user1
1770      *
1771      * @param int $userid The user id of the user whos blocked users we are returning
1772      * @return array the users blocked
1773      */
1774     public static function get_blocked_users($userid) {
1775         global $DB;
1777         $userfields = \user_picture::fields('u', array('lastaccess'));
1778         $blockeduserssql = "SELECT $userfields
1779                               FROM {message_users_blocked} mub
1780                         INNER JOIN {user} u
1781                                 ON u.id = mub.blockeduserid
1782                              WHERE u.deleted = 0
1783                                AND mub.userid = ?
1784                           GROUP BY $userfields
1785                           ORDER BY u.firstname ASC";
1786         return $DB->get_records_sql($blockeduserssql, [$userid]);
1787     }
1789     /**
1790      * Mark a single message as read.
1791      *
1792      * @param int $userid The user id who marked the message as read
1793      * @param \stdClass $message The message
1794      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1795      */
1796     public static function mark_message_as_read($userid, $message, $timeread = null) {
1797         global $DB;
1799         if (is_null($timeread)) {
1800             $timeread = time();
1801         }
1803         $mua = new \stdClass();
1804         $mua->userid = $userid;
1805         $mua->messageid = $message->id;
1806         $mua->action = self::MESSAGE_ACTION_READ;
1807         $mua->timecreated = $timeread;
1808         $mua->id = $DB->insert_record('message_user_actions', $mua);
1810         // Get the context for the user who received the message.
1811         $context = \context_user::instance($userid, IGNORE_MISSING);
1812         // If the user no longer exists the context value will be false, in this case use the system context.
1813         if ($context === false) {
1814             $context = \context_system::instance();
1815         }
1817         // Trigger event for reading a message.
1818         $event = \core\event\message_viewed::create(array(
1819             'objectid' => $mua->id,
1820             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1821             'context' => $context,
1822             'relateduserid' => $message->useridfrom,
1823             'other' => array(
1824                 'messageid' => $message->id
1825             )
1826         ));
1827         $event->trigger();
1828     }
1830     /**
1831      * Mark a single notification as read.
1832      *
1833      * @param \stdClass $notification The notification
1834      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1835      */
1836     public static function mark_notification_as_read($notification, $timeread = null) {
1837         global $DB;
1839         if (is_null($timeread)) {
1840             $timeread = time();
1841         }
1843         if (is_null($notification->timeread)) {
1844             $updatenotification = new \stdClass();
1845             $updatenotification->id = $notification->id;
1846             $updatenotification->timeread = $timeread;
1848             $DB->update_record('notifications', $updatenotification);
1850             // Trigger event for reading a notification.
1851             \core\event\notification_viewed::create_from_ids(
1852                 $notification->useridfrom,
1853                 $notification->useridto,
1854                 $notification->id
1855             )->trigger();
1856         }
1857     }
1859     /**
1860      * Checks if a user can delete a message.
1861      *
1862      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1863      *  but will still seem as if it was by the user)
1864      * @param int $messageid The message id
1865      * @return bool Returns true if a user can delete the message, false otherwise.
1866      */
1867     public static function can_delete_message($userid, $messageid) {
1868         global $DB, $USER;
1870         $systemcontext = \context_system::instance();
1872         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
1874         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1875             return true;
1876         }
1878         if (!self::is_user_in_conversation($userid, $conversationid)) {
1879             return false;
1880         }
1882         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1883                 $USER->id == $userid) {
1884             return true;
1885         }
1887         return false;
1888     }
1890     /**
1891      * Deletes a message.
1892      *
1893      * This function does not verify any permissions.
1894      *
1895      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1896      *  but will still seem as if it was by the user)
1897      * @param int $messageid The message id
1898      * @return bool
1899      */
1900     public static function delete_message($userid, $messageid) {
1901         global $DB, $USER;
1903         if (!$DB->record_exists('messages', ['id' => $messageid])) {
1904             return false;
1905         }
1907         // Check if the user has already deleted this message.
1908         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
1909                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
1910             $mua = new \stdClass();
1911             $mua->userid = $userid;
1912             $mua->messageid = $messageid;
1913             $mua->action = self::MESSAGE_ACTION_DELETED;
1914             $mua->timecreated = time();
1915             $mua->id = $DB->insert_record('message_user_actions', $mua);
1917             // Trigger event for deleting a message.
1918             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1919                 $messageid, $mua->id)->trigger();
1921             return true;
1922         }
1924         return false;
1925     }
1927     /**
1928      * Returns the conversation between two users.
1929      *
1930      * @param array $userids
1931      * @return int|bool The id of the conversation, false if not found
1932      */
1933     public static function get_conversation_between_users(array $userids) {
1934         global $DB;
1936         $hash = helper::get_conversation_hash($userids);
1938         $params = [
1939             'type' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1940             'convhash' => $hash
1941         ];
1942         if ($conversation = $DB->get_record('message_conversations', $params)) {
1943             return $conversation->id;
1944         }
1946         return false;
1947     }
1949     /**
1950      * Creates a conversation between two users.
1951      *
1952      * @deprecated since 3.6
1953      * @param array $userids
1954      * @return int The id of the conversation
1955      */
1956     public static function create_conversation_between_users(array $userids) {
1957         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
1958             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
1960         // This method was always used for individual conversations.
1961         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1963         return $conversation->id;
1964     }
1966     /**
1967      * Creates a conversation with selected users and messages.
1968      *
1969      * @param int $type The type of conversation
1970      * @param int[] $userids The array of users to add to the conversation
1971      * @param string|null $name The name of the conversation
1972      * @param int $enabled Determines if the conversation is created enabled or disabled
1973      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
1974      * @param string|null $itemtype Defines the type of the component
1975      * @param int|null $itemid The id of the component
1976      * @param int|null $contextid The id of the context
1977      * @return \stdClass
1978      */
1979     public static function create_conversation(int $type, array $userids, string $name = null,
1980             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
1981             string $itemtype = null, int $itemid = null, int $contextid = null) {
1983         global $DB;
1985         $validtypes = [
1986             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1987             self::MESSAGE_CONVERSATION_TYPE_GROUP
1988         ];
1990         if (!in_array($type, $validtypes)) {
1991             throw new \moodle_exception('An invalid conversation type was specified.');
1992         }
1994         // Sanity check.
1995         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1996             if (count($userids) > 2) {
1997                 throw new \moodle_exception('An individual conversation can not have more than two users.');
1998             }
1999         }
2001         $conversation = new \stdClass();
2002         $conversation->type = $type;
2003         $conversation->name = $name;
2004         $conversation->convhash = null;
2005         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2006             $conversation->convhash = helper::get_conversation_hash($userids);
2007         }
2008         $conversation->component = $component;
2009         $conversation->itemtype = $itemtype;
2010         $conversation->itemid = $itemid;
2011         $conversation->contextid = $contextid;
2012         $conversation->enabled = $enabled;
2013         $conversation->timecreated = time();
2014         $conversation->timemodified = $conversation->timecreated;
2015         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2017         // Add users to this conversation.
2018         $arrmembers = [];
2019         foreach ($userids as $userid) {
2020             $member = new \stdClass();
2021             $member->conversationid = $conversation->id;
2022             $member->userid = $userid;
2023             $member->timecreated = time();
2024             $member->id = $DB->insert_record('message_conversation_members', $member);
2026             $arrmembers[] = $member;
2027         }
2029         $conversation->members = $arrmembers;
2031         return $conversation;
2032     }
2034     /**
2035      * Checks if a user can create a group conversation.
2036      *
2037      * @param int $userid The id of the user attempting to create the conversation
2038      * @param \context $context The context they are creating the conversation from, most likely course context
2039      * @return bool
2040      */
2041     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2042         global $CFG;
2044         // If we can't message at all, then we can't create a conversation.
2045         if (empty($CFG->messaging)) {
2046             return false;
2047         }
2049         // We need to check they have the capability to create the conversation.
2050         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2051     }
2053     /**
2054      * Checks if a user can create a contact request.
2055      *
2056      * @param int $userid The id of the user who is creating the contact request
2057      * @param int $requesteduserid The id of the user being requested
2058      * @return bool
2059      */
2060     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2061         global $CFG;
2063         // If we can't message at all, then we can't create a contact.
2064         if (empty($CFG->messaging)) {
2065             return false;
2066         }
2068         // If we can message anyone on the site then we can create a contact.
2069         if ($CFG->messagingallusers) {
2070             return true;
2071         }
2073         // We need to check if they are in the same course.
2074         return enrol_sharing_course($userid, $requesteduserid);
2075     }
2077     /**
2078      * Handles creating a contact request.
2079      *
2080      * @param int $userid The id of the user who is creating the contact request
2081      * @param int $requesteduserid The id of the user being requested
2082      */
2083     public static function create_contact_request(int $userid, int $requesteduserid) {
2084         global $DB;
2086         $request = new \stdClass();
2087         $request->userid = $userid;
2088         $request->requesteduserid = $requesteduserid;
2089         $request->timecreated = time();
2091         $DB->insert_record('message_contact_requests', $request);
2093         // Send a notification.
2094         $userfrom = \core_user::get_user($userid);
2095         $userfromfullname = fullname($userfrom);
2096         $userto = \core_user::get_user($requesteduserid);
2097         $url = new \moodle_url('/message/pendingcontactrequests.php');
2099         $subject = get_string('messagecontactrequestsnotificationsubject', 'core_message', $userfromfullname);
2100         $fullmessage = get_string('messagecontactrequestsnotification', 'core_message', $userfromfullname);
2102         $message = new \core\message\message();
2103         $message->courseid = SITEID;
2104         $message->component = 'moodle';
2105         $message->name = 'messagecontactrequests';
2106         $message->notification = 1;
2107         $message->userfrom = $userfrom;
2108         $message->userto = $userto;
2109         $message->subject = $subject;
2110         $message->fullmessage = text_to_html($fullmessage);
2111         $message->fullmessageformat = FORMAT_HTML;
2112         $message->fullmessagehtml = $fullmessage;
2113         $message->smallmessage = '';
2114         $message->contexturl = $url->out(false);
2116         message_send($message);
2117     }
2120     /**
2121      * Handles confirming a contact request.
2122      *
2123      * @param int $userid The id of the user who created the contact request
2124      * @param int $requesteduserid The id of the user confirming the request
2125      */
2126     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2127         global $DB;
2129         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2130                 'requesteduserid' => $requesteduserid])) {
2131             self::add_contact($userid, $requesteduserid);
2133             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2134         }
2135     }
2137     /**
2138      * Handles declining a contact request.
2139      *
2140      * @param int $userid The id of the user who created the contact request
2141      * @param int $requesteduserid The id of the user declining the request
2142      */
2143     public static function decline_contact_request(int $userid, int $requesteduserid) {
2144         global $DB;
2146         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2147                 'requesteduserid' => $requesteduserid])) {
2148             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2149         }
2150     }
2152     /**
2153      * Handles returning the contact requests for a user.
2154      *
2155      * This also includes the user data necessary to display information
2156      * about the user.
2157      *
2158      * It will not include blocked users.
2159      *
2160      * @param int $userid
2161      * @param int $limitfrom
2162      * @param int $limitnum
2163      * @return array The list of contact requests
2164      */
2165     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2166         global $DB;
2168         $sql = "SELECT mcr.userid
2169                   FROM {message_contact_requests} mcr
2170              LEFT JOIN {message_users_blocked} mub
2171                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2172                  WHERE mcr.requesteduserid = ?
2173                    AND mub.id is NULL
2174               ORDER BY mcr.timecreated ASC";
2175         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2176             $userids = array_keys($contactrequests);
2177             return helper::get_member_info($userid, $userids);
2178         }
2180         return [];
2181     }
2183     /**
2184      * Handles adding a contact.
2185      *
2186      * @param int $userid The id of the user who requested to be a contact
2187      * @param int $contactid The id of the contact
2188      */
2189     public static function add_contact(int $userid, int $contactid) {
2190         global $DB;
2192         $messagecontact = new \stdClass();
2193         $messagecontact->userid = $userid;
2194         $messagecontact->contactid = $contactid;
2195         $messagecontact->timecreated = time();
2196         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2198         $eventparams = [
2199             'objectid' => $messagecontact->id,
2200             'userid' => $userid,
2201             'relateduserid' => $contactid,
2202             'context' => \context_user::instance($userid)
2203         ];
2204         $event = \core\event\message_contact_added::create($eventparams);
2205         $event->add_record_snapshot('message_contacts', $messagecontact);
2206         $event->trigger();
2207     }
2209     /**
2210      * Handles removing a contact.
2211      *
2212      * @param int $userid The id of the user who is removing a user as a contact
2213      * @param int $contactid The id of the user to be removed as a contact
2214      */
2215     public static function remove_contact(int $userid, int $contactid) {
2216         global $DB;
2218         if ($contact = self::get_contact($userid, $contactid)) {
2219             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2221             $event = \core\event\message_contact_removed::create(array(
2222                 'objectid' => $contact->id,
2223                 'userid' => $userid,
2224                 'relateduserid' => $contactid,
2225                 'context' => \context_user::instance($userid)
2226             ));
2227             $event->add_record_snapshot('message_contacts', $contact);
2228             $event->trigger();
2229         }
2230     }
2232     /**
2233      * Handles blocking a user.
2234      *
2235      * @param int $userid The id of the user who is blocking
2236      * @param int $usertoblockid The id of the user being blocked
2237      */
2238     public static function block_user(int $userid, int $usertoblockid) {
2239         global $DB;
2241         $blocked = new \stdClass();
2242         $blocked->userid = $userid;
2243         $blocked->blockeduserid = $usertoblockid;
2244         $blocked->timecreated = time();
2245         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2247         // Trigger event for blocking a contact.
2248         $event = \core\event\message_user_blocked::create(array(
2249             'objectid' => $blocked->id,
2250             'userid' => $userid,
2251             'relateduserid' => $usertoblockid,
2252             'context' => \context_user::instance($userid)
2253         ));
2254         $event->add_record_snapshot('message_users_blocked', $blocked);
2255         $event->trigger();
2256     }
2258     /**
2259      * Handles unblocking a user.
2260      *
2261      * @param int $userid The id of the user who is unblocking
2262      * @param int $usertounblockid The id of the user being unblocked
2263      */
2264     public static function unblock_user(int $userid, int $usertounblockid) {
2265         global $DB;
2267         if ($blockeduser = $DB->get_record('message_users_blocked',
2268                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2269             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2271             // Trigger event for unblocking a contact.
2272             $event = \core\event\message_user_unblocked::create(array(
2273                 'objectid' => $blockeduser->id,
2274                 'userid' => $userid,
2275                 'relateduserid' => $usertounblockid,
2276                 'context' => \context_user::instance($userid)
2277             ));
2278             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2279             $event->trigger();
2280         }
2281     }
2283     /**
2284      * Checks if users are already contacts.
2285      *
2286      * @param int $userid The id of one of the users
2287      * @param int $contactid The id of the other user
2288      * @return bool Returns true if they are a contact, false otherwise
2289      */
2290     public static function is_contact(int $userid, int $contactid) : bool {
2291         global $DB;
2293         $sql = "SELECT id
2294                   FROM {message_contacts} mc
2295                  WHERE (mc.userid = ? AND mc.contactid = ?)
2296                     OR (mc.userid = ? AND mc.contactid = ?)";
2297         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2298     }
2300     /**
2301      * Returns the row in the database table message_contacts that represents the contact between two people.
2302      *
2303      * @param int $userid The id of one of the users
2304      * @param int $contactid The id of the other user
2305      * @return mixed A fieldset object containing the record, false otherwise
2306      */
2307     public static function get_contact(int $userid, int $contactid) {
2308         global $DB;
2310         $sql = "SELECT mc.*
2311                   FROM {message_contacts} mc
2312                  WHERE (mc.userid = ? AND mc.contactid = ?)
2313                     OR (mc.userid = ? AND mc.contactid = ?)";
2314         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2315     }
2317     /**
2318      * Checks if a user is already blocked.
2319      *
2320      * @param int $userid
2321      * @param int $blockeduserid
2322      * @return bool Returns true if they are a blocked, false otherwise
2323      */
2324     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2325         global $DB;
2327         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2328     }
2330     /**
2331      * Checks if a contact request already exists between users.
2332      *
2333      * @param int $userid The id of the user who is creating the contact request
2334      * @param int $requesteduserid The id of the user being requested
2335      * @return bool Returns true if a contact request exists, false otherwise
2336      */
2337     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2338         global $DB;
2340         $sql = "SELECT id
2341                   FROM {message_contact_requests} mcr
2342                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2343                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2344         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2345     }
2347     /**
2348      * Checks if a user is already in a conversation.
2349      *
2350      * @param int $userid The id of the user we want to check if they are in a group
2351      * @param int $conversationid The id of the conversation
2352      * @return bool Returns true if a contact request exists, false otherwise
2353      */
2354     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2355         global $DB;
2357         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2358             'userid' => $userid]);
2359     }
2361     /**
2362      * Checks if the sender can message the recipient.
2363      *
2364      * @param int $recipientid
2365      * @param int $senderid
2366      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2367      */
2368     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2369         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2370             // The sender has the ability to contact any user across the entire site.
2371             return true;
2372         }
2374         // The initial value of $cancontact is null to indicate that a value has not been determined.
2375         $cancontact = null;
2377         if (self::is_blocked($recipientid, $senderid)) {
2378             // The recipient has specifically blocked this sender.
2379             $cancontact = false;
2380         }
2382         $sharedcourses = null;
2383         if (null === $cancontact) {
2384             // There are three user preference options:
2385             // - Site: Allow anyone not explicitly blocked to contact me;
2386             // - Course members: Allow anyone I am in a course with to contact me; and
2387             // - Contacts: Only allow my contacts to contact me.
2388             //
2389             // The Site option is only possible when the messagingallusers site setting is also enabled.
2391             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2392             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2393                 // The user preference is to allow any user to contact them.
2394                 // No need to check anything else.
2395                 $cancontact = true;
2396             } else {
2397                 // This user only allows their own contacts, and possibly course peers, to contact them.
2398                 // If the users are contacts then we can avoid the more expensive shared courses check.
2399                 $cancontact = self::is_contact($senderid, $recipientid);
2401                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2402                     // The users are not contacts and the user allows course member messaging.
2403                     // Check whether these two users share any course together.
2404                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2405                     $cancontact = (!empty($sharedcourses));
2406                 }
2407             }
2408         }
2410         if (false === $cancontact) {
2411             // At the moment the users cannot contact one another.
2412             // Check whether the messageanyuser capability applies in any of the shared courses.
2413             // This is intended to allow teachers to message students regardless of message settings.
2415             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2416             if (null === $sharedcourses) {
2417                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2418             }
2420             foreach ($sharedcourses as $course) {
2421                 // Note: enrol_get_shared_courses will preload any shared context.
2422                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2423                     $cancontact = true;
2424                     break;
2425                 }
2426             }
2427         }
2429         return $cancontact;
2430     }
2432     /**
2433      * Add some new members to an existing conversation.
2434      *
2435      * @param array $userids User ids array to add as members.
2436      * @param int $convid The conversation id. Must exists.
2437      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2438      * @throws \dml_exception If there is a database error
2439      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2440      */
2441     public static function add_members_to_conversation(array $userids, int $convid) {
2442         global $DB;
2444         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2446         // We can only add members to a group conversation.
2447         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2448             throw new \moodle_exception('You can not add members to a non-group conversation.');
2449         }
2451         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2452         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2453         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2455         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2456         $memberuserids = array_values($DB->get_records_menu(
2457             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2458         );
2460         // Work with existing new members.
2461         $members = array();
2462         $newuserids = array_diff($existingusers, $memberuserids);
2463         foreach ($newuserids as $userid) {
2464             $member = new \stdClass();
2465             $member->conversationid = $convid;
2466             $member->userid = $userid;
2467             $member->timecreated = time();
2468             $members[] = $member;
2469         }
2471         $DB->insert_records('message_conversation_members', $members);
2472     }
2474     /**
2475      * Remove some members from an existing conversation.
2476      *
2477      * @param array $userids The user ids to remove from conversation members.
2478      * @param int $convid The conversation id. Must exists.
2479      * @throws \dml_exception
2480      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2481      */
2482     public static function remove_members_from_conversation(array $userids, int $convid) {
2483         global $DB;
2485         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2487         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2488             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2489         }
2491         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2492         $params['convid'] = $convid;
2494         $DB->delete_records_select('message_conversation_members',
2495             "conversationid = :convid AND userid $useridcondition", $params);
2496     }
2498     /**
2499      * Count conversation members.
2500      *
2501      * @param int $convid The conversation id.
2502      * @return int Number of conversation members.
2503      * @throws \dml_exception
2504      */
2505     public static function count_conversation_members(int $convid) : int {
2506         global $DB;
2508         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2509     }
2511     /**
2512      * Checks whether or not a conversation area is enabled.
2513      *
2514      * @param string $component Defines the Moodle component which the area was added to.
2515      * @param string $itemtype Defines the type of the component.
2516      * @param int $itemid The id of the component.
2517      * @param int $contextid The id of the context.
2518      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2519      */
2520     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2521         global $DB;
2523         return $DB->record_exists('message_conversations',
2524             [
2525                 'itemid' => $itemid,
2526                 'contextid' => $contextid,
2527                 'component' => $component,
2528                 'itemtype' => $itemtype,
2529                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2530             ]
2531         );
2532     }
2534     /**
2535      * Get conversation by area.
2536      *
2537      * @param string $component Defines the Moodle component which the area was added to.
2538      * @param string $itemtype Defines the type of the component.
2539      * @param int $itemid The id of the component.
2540      * @param int $contextid The id of the context.
2541      * @return \stdClass
2542      */
2543     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2544         global $DB;
2546         return $DB->get_record('message_conversations',
2547             [
2548                 'itemid' => $itemid,
2549                 'contextid' => $contextid,
2550                 'component' => $component,
2551                 'itemtype'  => $itemtype
2552             ]
2553         );
2554     }
2556     /**
2557      * Enable a conversation.
2558      *
2559      * @param int $conversationid The id of the conversation.
2560      * @return void
2561      */
2562     public static function enable_conversation(int $conversationid) {
2563         global $DB;
2565         $conversation = new \stdClass();
2566         $conversation->id = $conversationid;
2567         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2568         $conversation->timemodified = time();
2569         $DB->update_record('message_conversations', $conversation);
2570     }
2572     /**
2573      * Disable a conversation.
2574      *
2575      * @param int $conversationid The id of the conversation.
2576      * @return void
2577      */
2578     public static function disable_conversation(int $conversationid) {
2579         global $DB;
2581         $conversation = new \stdClass();
2582         $conversation->id = $conversationid;
2583         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2584         $conversation->timemodified = time();
2585         $DB->update_record('message_conversations', $conversation);
2586     }
2588     /**
2589      * Update the name of a conversation.
2590      *
2591      * @param int $conversationid The id of a conversation.
2592      * @param string $name The main name of the area
2593      * @return void
2594      */
2595     public static function update_conversation_name(int $conversationid, string $name) {
2596         global $DB;
2598         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2599             if ($name <> $conversation->name) {
2600                 $conversation->name = $name;
2601                 $conversation->timemodified = time();
2602                 $DB->update_record('message_conversations', $conversation);
2603             }
2604         }
2605     }
2607     /**
2608      * Returns a list of conversation members.
2609      *
2610      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2611      * @param int $conversationid The id of the conversation
2612      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2613      * @param int $limitfrom
2614      * @param int $limitnum
2615      * @return array
2616      */
2617     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2618                                                     int $limitfrom = 0, int $limitnum = 0) : array {
2619         global $DB;
2621         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2622                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2623             $userids = array_keys($members);
2624             $members = helper::get_member_info($userid, $userids, $includecontactrequests);
2626             return $members;
2627         }
2629         return [];
2630     }