MDL-64035 core_message: get_conversations() excludes disabled chats
[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
555                   AND mc.enabled = 1 $typesql $favouritesql
556               ORDER BY (CASE WHEN m.timecreated IS NULL THEN 0 ELSE 1 END) DESC, m.timecreated DESC, id DESC";
558         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
559             'userid2' => $userid, 'userid3' => $userid, 'convtype' => $type]);
560         $conversationset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
562         $conversations = [];
563         $members = [];
564         $individualmembers = [];
565         $groupmembers = [];
566         foreach ($conversationset as $conversation) {
567             $conversations[$conversation->id] = $conversation;
568             $members[$conversation->id] = [];
569         }
570         $conversationset->close();
572         // If there are no conversations found, then return early.
573         if (empty($conversations)) {
574             return [];
575         }
577         // COMPONENT-LINKED CONVERSATION FIELDS.
578         // Conversations linked to components may have extra information, such as:
579         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
580         // - imageurl: A URL to the image for the linked conversation.
581         // For now, this is ONLY course groups.
582         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
584         // MEMBERS.
585         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
586         // message or not.
587         //
588         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
589         // we want the details of the other member in the conversation (i.e. not the current user).
590         //
591         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
592         // This can be the current user or another group member, but for groups without messages, this will be empty.
593         //
594         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
595         // query to get the 'other' user as we already have that information.
597         // Work out which members we have already, and which ones we might need to fetch.
598         // If all the last messages were from another user, then we don't need to fetch anything further.
599         foreach ($conversations as $conversation) {
600             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
601                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
602                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
603                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
604                 } else {
605                     $individualconversations[] = $conversation->id;
606                 }
607             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
608                 // If we have a recent message, the sender is our member.
609                 if (!is_null($conversation->useridfrom)) {
610                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
611                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
612                 }
613             }
614         }
615         // If we need to fetch any member information for any of the individual conversations.
616         // This is the case if any of the individual conversations have a recent message sent by the current user.
617         if (!empty($individualconversations)) {
618             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
619             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
620                         FROM {message_conversation_members} mcm
621                        WHERE mcm.conversationid $icidinsql
622                        AND mcm.userid != :userid
623                        ORDER BY mcm.id";
624             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
625             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
627             foreach ($conversationmembers as $mid => $member) {
628                 $members[$member->conversationid][$member->userid] = $member->userid;
629                 $individualmembers[$member->userid] = $member->userid;
630             }
631         }
633         // We could fail early here if we're sure that:
634         // a) we have no otherusers for all the conversations (users may have been deleted)
635         // b) we're sure that all conversations are individual (1:1).
637         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
638         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
639         // tables because on large sites these tables are massive which results in extremely slow
640         // performance (typically due to join buffer exhaustion).
641         if (!empty($individualmembers) || !empty($groupmembers)) {
642             // Now, we want to remove any duplicates from the group members array. For individual members we will
643             // be doing a more extensive call as we want their contact requests as well as privacy information,
644             // which is not necessary for group conversations.
645             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
647             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
648             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
650             // Don't use array_merge, as we lose array keys.
651             $memberinfo = $individualmemberinfo + $groupmemberinfo;
653             // Update the members array with the member information.
654             $deletedmembers = [];
655             foreach ($members as $convid => $memberarr) {
656                 foreach ($memberarr as $key => $memberid) {
657                     if (array_key_exists($memberid, $memberinfo)) {
658                         // If the user is deleted, remember that.
659                         if ($memberinfo[$memberid]->isdeleted) {
660                             $deletedmembers[$convid][] = $memberid;
661                         }
663                         $members[$convid][$key] = clone $memberinfo[$memberid];
665                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
666                             // Remove data we don't need for group.
667                             $members[$convid][$key]->requirescontact = null;
668                             $members[$convid][$key]->canmessage = null;
669                             $members[$convid][$key]->contactrequests = [];
670                         }
671                     }
672                 }
673             }
674         }
676         // MEMBER COUNT.
677         $cids = array_column($conversations, 'id');
678         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
679         $membercountsql = "SELECT conversationid, count(id) AS membercount
680                              FROM {message_conversation_members} mcm
681                             WHERE mcm.conversationid $cidinsql
682                          GROUP BY mcm.conversationid";
683         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
685         // UNREAD MESSAGE COUNT.
686         // Finally, let's get the unread messages count for this user so that we can add it
687         // to the conversation. Remember we need to ignore the messages the user sent.
688         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
689                               FROM {messages} m
690                         INNER JOIN {message_conversations} mc
691                                 ON mc.id = m.conversationid
692                         INNER JOIN {message_conversation_members} mcm
693                                 ON m.conversationid = mcm.conversationid
694                          LEFT JOIN {message_user_actions} mua
695                                 ON (mua.messageid = m.id AND mua.userid = ? AND
696                                    (mua.action = ? OR mua.action = ?))
697                              WHERE mcm.userid = ?
698                                AND m.useridfrom != ?
699                                AND mua.id is NULL
700                           GROUP BY m.conversationid';
701         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
702             $userid, $userid]);
704         // Now, create the final return structure.
705         $arrconversations = [];
706         foreach ($conversations as $conversation) {
707             // Do not include any individual conversation which:
708             // a) Contains a deleted member or
709             // b) Does not contain a recent message for the user (this happens if the user has deleted all messages).
710             // Group conversations with deleted users or no messages are always returned.
711             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
712                     && (isset($deletedmembers[$conversation->id]) || empty($conversation->messageid))) {
713                 continue;
714             }
716             $conv = new \stdClass();
717             $conv->id = $conversation->id;
718             $conv->name = $conversation->conversationname;
719             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
720             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
721             $conv->type = $conversation->conversationtype;
722             $conv->membercount = $membercounts[$conv->id]->membercount;
723             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
724             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
725             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
726             $conv->members = $members[$conv->id];
728             // Add the most recent message information.
729             $conv->messages = [];
730             if ($conversation->smallmessage) {
731                 $msg = new \stdClass();
732                 $msg->id = $conversation->messageid;
733                 $msg->text = message_format_message_text($conversation);
734                 $msg->useridfrom = $conversation->useridfrom;
735                 $msg->timecreated = $conversation->timecreated;
736                 $conv->messages[] = $msg;
737             }
739             $arrconversations[] = $conv;
740         }
741         return $arrconversations;
742     }
744     /**
745      * Returns all conversations between two users
746      *
747      * @param int $userid1 One of the user's id
748      * @param int $userid2 The other user's id
749      * @param int $limitfrom
750      * @param int $limitnum
751      * @return array
752      * @throws \dml_exception
753      */
754     public static function get_conversations_between_users(int $userid1, int $userid2,
755                                                            int $limitfrom = 0, int $limitnum = 20) : array {
757         global $DB;
759         if ($userid1 == $userid2) {
760             return array();
761         }
763         // Get all conversation where both user1 and user2 are members.
764         // TODO: Add subname value. Waiting for definite table structure.
765         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
766                   FROM {message_conversations} mc
767             INNER JOIN {message_conversation_members} mcm1
768                     ON mc.id = mcm1.conversationid
769             INNER JOIN {message_conversation_members} mcm2
770                     ON mc.id = mcm2.conversationid
771                  WHERE mcm1.userid = :userid1
772                    AND mcm2.userid = :userid2
773                    AND mc.enabled != 0
774               ORDER BY mc.timecreated DESC";
776         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
777     }
779     /**
780      * Mark a conversation as a favourite for the given user.
781      *
782      * @param int $conversationid the id of the conversation to mark as a favourite.
783      * @param int $userid the id of the user to whom the favourite belongs.
784      * @return favourite the favourite object.
785      * @throws \moodle_exception if the user or conversation don't exist.
786      */
787     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
788         if (!self::is_user_in_conversation($userid, $conversationid)) {
789             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
790         }
791         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
792         return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
793     }
795     /**
796      * Unset a conversation as a favourite for the given user.
797      *
798      * @param int $conversationid the id of the conversation to unset as a favourite.
799      * @param int $userid the id to whom the favourite belongs.
800      * @throws \moodle_exception if the favourite does not exist for the user.
801      */
802     public static function unset_favourite_conversation(int $conversationid, int $userid) {
803         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
804         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
805     }
807     /**
808      * Returns the contacts to display in the contacts area.
809      *
810      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
811      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
812      * Followup: MDL-63915
813      *
814      * @param int $userid The user id
815      * @param int $limitfrom
816      * @param int $limitnum
817      * @return array
818      */
819     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
820         global $DB;
822         $contactids = [];
823         $sql = "SELECT mc.*
824                   FROM {message_contacts} mc
825                  WHERE mc.userid = ? OR mc.contactid = ?
826               ORDER BY timecreated DESC";
827         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
828             foreach ($contacts as $contact) {
829                 if ($userid == $contact->userid) {
830                     $contactids[] = $contact->contactid;
831                 } else {
832                     $contactids[] = $contact->userid;
833                 }
834             }
835         }
837         if (!empty($contactids)) {
838             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
840             $sql = "SELECT u.*, mub.id as isblocked
841                       FROM {user} u
842                  LEFT JOIN {message_users_blocked} mub
843                         ON u.id = mub.blockeduserid
844                      WHERE u.id $insql";
845             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
846                 $arrcontacts = [];
847                 foreach ($contacts as $contact) {
848                     $contact->blocked = $contact->isblocked ? 1 : 0;
849                     $arrcontacts[] = helper::create_contact($contact);
850                 }
852                 return $arrcontacts;
853             }
854         }
856         return [];
857     }
859     /**
860      * Returns the an array of the users the given user is in a conversation
861      * with who are a contact and the number of unread messages.
862      *
863      * @param int $userid The user id
864      * @param int $limitfrom
865      * @param int $limitnum
866      * @return array
867      */
868     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
869         global $DB;
871         $userfields = \user_picture::fields('u', array('lastaccess'));
872         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
873                               FROM {message_contacts} mc
874                         INNER JOIN {user} u
875                                 ON (u.id = mc.contactid OR u.id = mc.userid)
876                          LEFT JOIN {messages} m
877                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
878                          LEFT JOIN {message_conversation_members} mcm
879                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
880                          LEFT JOIN {message_user_actions} mua
881                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
882                          LEFT JOIN {message_users_blocked} mub
883                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
884                              WHERE mua.id is NULL
885                                AND mub.id is NULL
886                                AND (mc.userid = ? OR mc.contactid = ?)
887                                AND u.id != ?
888                                AND u.deleted = 0
889                           GROUP BY $userfields";
891         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
892             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
893     }
895     /**
896      * Returns the an array of the users the given user is in a conversation
897      * with who are not a contact and the number of unread messages.
898      *
899      * @param int $userid The user id
900      * @param int $limitfrom
901      * @param int $limitnum
902      * @return array
903      */
904     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
905         global $DB;
907         $userfields = \user_picture::fields('u', array('lastaccess'));
908         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
909                               FROM {user} u
910                         INNER JOIN {messages} m
911                                 ON m.useridfrom = u.id
912                         INNER JOIN {message_conversation_members} mcm
913                                 ON mcm.conversationid = m.conversationid
914                          LEFT JOIN {message_user_actions} mua
915                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
916                          LEFT JOIN {message_contacts} mc
917                                 ON (mc.userid = ? AND mc.contactid = u.id)
918                          LEFT JOIN {message_users_blocked} mub
919                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
920                              WHERE mcm.userid = ?
921                                AND mcm.userid != m.useridfrom
922                                AND mua.id is NULL
923                                AND mub.id is NULL
924                                AND mc.id is NULL
925                                AND u.deleted = 0
926                           GROUP BY $userfields";
928         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
929             $limitfrom, $limitnum);
930     }
932     /**
933      * Returns the messages to display in the message area.
934      *
935      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
936      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
937      * Followup: MDL-63915
938      *
939      * @param int $userid the current user
940      * @param int $otheruserid the other user
941      * @param int $limitfrom
942      * @param int $limitnum
943      * @param string $sort
944      * @param int $timefrom the time from the message being sent
945      * @param int $timeto the time up until the message being sent
946      * @return array
947      */
948     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
949             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
951         if (!empty($timefrom)) {
952             // Get the conversation between userid and otheruserid.
953             $userids = [$userid, $otheruserid];
954             if (!$conversationid = self::get_conversation_between_users($userids)) {
955                 // This method was always used for individual conversations.
956                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
957                 $conversationid = $conversation->id;
958             }
960             // Check the cache to see if we even need to do a DB query.
961             $cache = \cache::make('core', 'message_time_last_message_between_users');
962             $key = helper::get_last_message_time_created_cache_key($conversationid);
963             $lastcreated = $cache->get($key);
965             // The last known message time is earlier than the one being requested so we can
966             // just return an empty result set rather than having to query the DB.
967             if ($lastcreated && $lastcreated < $timefrom) {
968                 return [];
969             }
970         }
972         $arrmessages = array();
973         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
974                                              $sort, $timefrom, $timeto)) {
975             $arrmessages = helper::create_messages($userid, $messages);
976         }
978         return $arrmessages;
979     }
981     /**
982      * Returns the messages for the defined conversation.
983      *
984      * @param  int $userid The current user.
985      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
986      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
987      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
988      * @param  string $sort The column name to order by including optionally direction.
989      * @param  int $timefrom The time from the message being sent.
990      * @param  int $timeto The time up until the message being sent.
991      * @return array of messages
992      */
993     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
994         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
996         if (!empty($timefrom)) {
997             // Check the cache to see if we even need to do a DB query.
998             $cache = \cache::make('core', 'message_time_last_message_between_users');
999             $key = helper::get_last_message_time_created_cache_key($convid);
1000             $lastcreated = $cache->get($key);
1002             // The last known message time is earlier than the one being requested so we can
1003             // just return an empty result set rather than having to query the DB.
1004             if ($lastcreated && $lastcreated < $timefrom) {
1005                 return [];
1006             }
1007         }
1009         $arrmessages = array();
1010         if ($messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto)) {
1011             $arrmessages = helper::format_conversation_messages($userid, $convid, $messages);
1012         }
1014         return $arrmessages;
1015     }
1017     /**
1018      * Returns the most recent message between two users.
1019      *
1020      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1021      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1022      * Followup: MDL-63915
1023      *
1024      * @param int $userid the current user
1025      * @param int $otheruserid the other user
1026      * @return \stdClass|null
1027      */
1028     public static function get_most_recent_message($userid, $otheruserid) {
1029         // We want two messages here so we get an accurate 'blocktime' value.
1030         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1031             // Swap the order so we now have them in historical order.
1032             $messages = array_reverse($messages);
1033             $arrmessages = helper::create_messages($userid, $messages);
1034             return array_pop($arrmessages);
1035         }
1037         return null;
1038     }
1040     /**
1041      * Returns the most recent message in a conversation.
1042      *
1043      * @param int $convid The conversation identifier.
1044      * @param int $currentuserid The current user identifier.
1045      * @return \stdClass|null The most recent message.
1046      */
1047     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1048         global $USER;
1050         if (empty($currentuserid)) {
1051             $currentuserid = $USER->id;
1052         }
1054         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1055             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1056             return array_pop($convmessages['messages']);
1057         }
1059         return null;
1060     }
1062     /**
1063      * Returns the profile information for a contact for a user.
1064      *
1065      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1066      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1067      * Followup: MDL-63915
1068      *
1069      * @param int $userid The user id
1070      * @param int $otheruserid The id of the user whose profile we want to view.
1071      * @return \stdClass
1072      */
1073     public static function get_profile($userid, $otheruserid) {
1074         global $CFG, $PAGE;
1076         require_once($CFG->dirroot . '/user/lib.php');
1078         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1080         // Create the data we are going to pass to the renderable.
1081         $data = new \stdClass();
1082         $data->userid = $otheruserid;
1083         $data->fullname = fullname($user);
1084         $data->city = '';
1085         $data->country = '';
1086         $data->email = '';
1087         $data->isonline = null;
1088         // Get the user picture data - messaging has always shown these to the user.
1089         $userpicture = new \user_picture($user);
1090         $userpicture->size = 1; // Size f1.
1091         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1092         $userpicture->size = 0; // Size f2.
1093         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1095         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1096         if ($userfields) {
1097             if (isset($userfields['city'])) {
1098                 $data->city = $userfields['city'];
1099             }
1100             if (isset($userfields['country'])) {
1101                 $data->country = $userfields['country'];
1102             }
1103             if (isset($userfields['email'])) {
1104                 $data->email = $userfields['email'];
1105             }
1106             if (isset($userfields['lastaccess'])) {
1107                 $data->isonline = helper::is_online($userfields['lastaccess']);
1108             }
1109         }
1111         $data->isblocked = self::is_blocked($userid, $otheruserid);
1112         $data->iscontact = self::is_contact($userid, $otheruserid);
1114         return $data;
1115     }
1117     /**
1118      * Checks if a user can delete messages they have either received or sent.
1119      *
1120      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1121      *  but will still seem as if it was by the user)
1122      * @param int $conversationid The id of the conversation
1123      * @return bool Returns true if a user can delete the conversation, false otherwise.
1124      */
1125     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1126         global $USER;
1128         if (is_null($conversationid)) {
1129             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1130                 DEBUG_DEVELOPER);
1131             return false;
1132         }
1134         $systemcontext = \context_system::instance();
1136         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1137             return true;
1138         }
1140         if (!self::is_user_in_conversation($userid, $conversationid)) {
1141             return false;
1142         }
1144         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1145                 $USER->id == $userid) {
1146             return true;
1147         }
1149         return false;
1150     }
1152     /**
1153      * Deletes a conversation.
1154      *
1155      * This function does not verify any permissions.
1156      *
1157      * @deprecated since 3.6
1158      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1159      *  but will still seem as if it was by the user)
1160      * @param int $otheruserid The id of the other user in the conversation
1161      * @return bool
1162      */
1163     public static function delete_conversation($userid, $otheruserid) {
1164         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1165             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1167         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1169         // If there is no conversation, there is nothing to do.
1170         if (!$conversationid) {
1171             return true;
1172         }
1174         self::delete_conversation_by_id($userid, $conversationid);
1176         return true;
1177     }
1179     /**
1180      * Deletes a conversation for a specified user.
1181      *
1182      * This function does not verify any permissions.
1183      *
1184      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1185      *  but will still seem as if it was by the user)
1186      * @param int $conversationid The id of the other user in the conversation
1187      */
1188     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1189         global $DB, $USER;
1191         // Get all messages belonging to this conversation that have not already been deleted by this user.
1192         $sql = "SELECT m.*
1193                  FROM {messages} m
1194            INNER JOIN {message_conversations} mc
1195                    ON m.conversationid = mc.id
1196             LEFT JOIN {message_user_actions} mua
1197                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1198                 WHERE mua.id is NULL
1199                   AND mc.id = ?
1200              ORDER BY m.timecreated ASC";
1201         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1203         // Ok, mark these as deleted.
1204         foreach ($messages as $message) {
1205             $mua = new \stdClass();
1206             $mua->userid = $userid;
1207             $mua->messageid = $message->id;
1208             $mua->action = self::MESSAGE_ACTION_DELETED;
1209             $mua->timecreated = time();
1210             $mua->id = $DB->insert_record('message_user_actions', $mua);
1212             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1213                 $message->id, $mua->id)->trigger();
1214         }
1215     }
1217     /**
1218      * Returns the count of unread conversations (collection of messages from a single user) for
1219      * the given user.
1220      *
1221      * @param \stdClass $user the user who's conversations should be counted
1222      * @return int the count of the user's unread conversations
1223      */
1224     public static function count_unread_conversations($user = null) {
1225         global $USER, $DB;
1227         if (empty($user)) {
1228             $user = $USER;
1229         }
1231         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1232                   FROM {messages} m
1233             INNER JOIN {message_conversations} mc
1234                     ON m.conversationid = mc.id
1235             INNER JOIN {message_conversation_members} mcm
1236                     ON mc.id = mcm.conversationid
1237              LEFT JOIN {message_user_actions} mua
1238                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1239                  WHERE mcm.userid = ?
1240                    AND mcm.userid != m.useridfrom
1241                    AND mua.id is NULL";
1243         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1244     }
1246     /**
1247      * Checks if a user can mark all messages as read.
1248      *
1249      * @param int $userid The user id of who we want to mark the messages for
1250      * @param int $conversationid The id of the conversation
1251      * @return bool true if user is permitted, false otherwise
1252      * @since 3.6
1253      */
1254     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1255         global $USER;
1257         $systemcontext = \context_system::instance();
1259         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1260             return true;
1261         }
1263         if (!self::is_user_in_conversation($userid, $conversationid)) {
1264             return false;
1265         }
1267         if ($USER->id == $userid) {
1268             return true;
1269         }
1271         return false;
1272     }
1274     /**
1275      * Marks all messages being sent to a user in a particular conversation.
1276      *
1277      * If $conversationdid is null then it marks all messages as read sent to $userid.
1278      *
1279      * @param int $userid
1280      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1281      */
1282     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1283         global $DB;
1285         $messagesql = "SELECT m.*
1286                          FROM {messages} m
1287                    INNER JOIN {message_conversations} mc
1288                            ON mc.id = m.conversationid
1289                    INNER JOIN {message_conversation_members} mcm
1290                            ON mcm.conversationid = mc.id
1291                     LEFT JOIN {message_user_actions} mua
1292                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1293                         WHERE mua.id is NULL
1294                           AND mcm.userid = ?
1295                           AND m.useridfrom != ?";
1296         $messageparams = [];
1297         $messageparams[] = $userid;
1298         $messageparams[] = self::MESSAGE_ACTION_READ;
1299         $messageparams[] = $userid;
1300         $messageparams[] = $userid;
1301         if (!is_null($conversationid)) {
1302             $messagesql .= " AND mc.id = ?";
1303             $messageparams[] = $conversationid;
1304         }
1306         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1307         foreach ($messages as $message) {
1308             self::mark_message_as_read($userid, $message);
1309         }
1310         $messages->close();
1311     }
1313     /**
1314      * Marks all notifications being sent from one user to another user as read.
1315      *
1316      * If the from user is null then it marks all notifications as read sent to the to user.
1317      *
1318      * @param int $touserid the id of the message recipient
1319      * @param int|null $fromuserid the id of the message sender, null if all messages
1320      * @return void
1321      */
1322     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1323         global $DB;
1325         $notificationsql = "SELECT n.*
1326                               FROM {notifications} n
1327                              WHERE useridto = ?
1328                                AND timeread is NULL";
1329         $notificationsparams = [$touserid];
1330         if (!empty($fromuserid)) {
1331             $notificationsql .= " AND useridfrom = ?";
1332             $notificationsparams[] = $fromuserid;
1333         }
1335         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1336         foreach ($notifications as $notification) {
1337             self::mark_notification_as_read($notification);
1338         }
1339         $notifications->close();
1340     }
1342     /**
1343      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1344      *
1345      * Can be filtered by type.
1346      *
1347      * @deprecated since 3.5
1348      * @param int $touserid the id of the message recipient
1349      * @param int $fromuserid the id of the message sender
1350      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1351      * @return void
1352      */
1353     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1354         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1355             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1356             DEBUG_DEVELOPER);
1358         $type = strtolower($type);
1360         $conversationid = null;
1361         $ignoremessages = false;
1362         if (!empty($fromuserid)) {
1363             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1364             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1365                 $ignoremessages = true;
1366             }
1367         }
1369         if (!empty($type)) {
1370             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1371                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1372             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1373                 if (!$ignoremessages) {
1374                     self::mark_all_messages_as_read($touserid, $conversationid);
1375                 }
1376             }
1377         } else { // We want both.
1378             self::mark_all_notifications_as_read($touserid, $fromuserid);
1379             if (!$ignoremessages) {
1380                 self::mark_all_messages_as_read($touserid, $conversationid);
1381             }
1382         }
1383     }
1385     /**
1386      * Returns message preferences.
1387      *
1388      * @param array $processors
1389      * @param array $providers
1390      * @param \stdClass $user
1391      * @return \stdClass
1392      * @since 3.2
1393      */
1394     public static function get_all_message_preferences($processors, $providers, $user) {
1395         $preferences = helper::get_providers_preferences($providers, $user->id);
1396         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1398         // For every processors put its options on the form (need to get function from processor's lib.php).
1399         foreach ($processors as $processor) {
1400             $processor->object->load_data($preferences, $user->id);
1401         }
1403         // Load general messaging preferences.
1404         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1405         $preferences->mailformat = $user->mailformat;
1406         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1408         return $preferences;
1409     }
1411     /**
1412      * Count the number of users blocked by a user.
1413      *
1414      * @param \stdClass $user The user object
1415      * @return int the number of blocked users
1416      */
1417     public static function count_blocked_users($user = null) {
1418         global $USER, $DB;
1420         if (empty($user)) {
1421             $user = $USER;
1422         }
1424         $sql = "SELECT count(mub.id)
1425                   FROM {message_users_blocked} mub
1426                  WHERE mub.userid = :userid";
1427         return $DB->count_records_sql($sql, array('userid' => $user->id));
1428     }
1430     /**
1431      * Determines if a user is permitted to send another user a private message.
1432      * If no sender is provided then it defaults to the logged in user.
1433      *
1434      * @param \stdClass $recipient The user object.
1435      * @param \stdClass|null $sender The user object.
1436      * @return bool true if user is permitted, false otherwise.
1437      */
1438     public static function can_post_message($recipient, $sender = null) {
1439         global $USER;
1441         if (is_null($sender)) {
1442             // The message is from the logged in user, unless otherwise specified.
1443             $sender = $USER;
1444         }
1446         $systemcontext = \context_system::instance();
1447         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1448             return false;
1449         }
1451         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1452             return true;
1453         }
1455         // Check if the recipient can be messaged by the sender.
1456         return (self::can_contact_user($recipient->id, $sender->id));
1457     }
1459     /**
1460      * Determines if a user is permitted to send a message to a given conversation.
1461      * If no sender is provided then it defaults to the logged in user.
1462      *
1463      * @param int $userid the id of the user on which the checks will be applied.
1464      * @param int $conversationid the id of the conversation we wish to check.
1465      * @return bool true if the user can send a message to the conversation, false otherwise.
1466      * @throws \moodle_exception
1467      */
1468     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1469         global $DB;
1471         $systemcontext = \context_system::instance();
1472         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1473             return false;
1474         }
1476         if (!self::is_user_in_conversation($userid, $conversationid)) {
1477             return false;
1478         }
1480         // User can post messages and is in the conversation, but we need to check the conversation type to
1481         // know whether or not to check the user privacy settings via can_contact_user().
1482         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1483         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1484             return true;
1485         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1486             // Get the other user in the conversation.
1487             $members = self::get_conversation_members($userid, $conversationid);
1488             $otheruser = array_filter($members, function($member) use($userid) {
1489                 return $member->id != $userid;
1490             });
1491             $otheruser = reset($otheruser);
1493             return self::can_contact_user($otheruser->id, $userid);
1494         } else {
1495             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1496         }
1497     }
1499     /**
1500      * Send a message from a user to a conversation.
1501      *
1502      * This method will create the basic eventdata and delegate to message creation to message_send.
1503      * The message_send() method is responsible for event data that is specific to each recipient.
1504      *
1505      * @param int $userid the sender id.
1506      * @param int $conversationid the conversation id.
1507      * @param string $message the message to send.
1508      * @param int $format the format of the message to send.
1509      * @return \stdClass the message created.
1510      * @throws \coding_exception
1511      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1512      */
1513     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1514                                                         int $format) : \stdClass {
1515         global $DB;
1517         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1518             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1519         }
1521         $eventdata = new \core\message\message();
1522         $eventdata->courseid         = 1;
1523         $eventdata->component        = 'moodle';
1524         $eventdata->name             = 'instantmessage';
1525         $eventdata->userfrom         = $userid;
1526         $eventdata->convid           = $conversationid;
1528         if ($format == FORMAT_HTML) {
1529             $eventdata->fullmessagehtml  = $message;
1530             // Some message processors may revert to sending plain text even if html is supplied,
1531             // so we keep both plain and html versions if we're intending to send html.
1532             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1533         } else {
1534             $eventdata->fullmessage      = $message;
1535             $eventdata->fullmessagehtml  = '';
1536         }
1538         $eventdata->fullmessageformat = $format;
1539         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1541         $eventdata->timecreated     = time();
1542         $eventdata->notification    = 0;
1543         $messageid = message_send($eventdata);
1545         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1546         $message = (object) [
1547             'id' => $messagerecord->id,
1548             'useridfrom' => $messagerecord->useridfrom,
1549             'text' => $messagerecord->fullmessage,
1550             'timecreated' => $messagerecord->timecreated
1551         ];
1552         return $message;
1553     }
1555     /**
1556      * Get the messaging preference for a user.
1557      * If the user has not any messaging privacy preference:
1558      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1559      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1560      *
1561      * @param  int    $userid The user identifier.
1562      * @return int    The default messaging preference.
1563      */
1564     public static function get_user_privacy_messaging_preference(int $userid) : int {
1565         global $CFG;
1567         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1568         // otherwise, the default value will be "My contacts and anyone in my courses".
1569         if (empty($CFG->messagingallusers)) {
1570             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1571         } else {
1572             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1573         }
1574         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
1576         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1577         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1578         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1579             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1580         }
1582         return $privacypreference;
1583     }
1585     /**
1586      * Checks if the recipient is allowing messages from users that aren't a
1587      * contact. If not then it checks to make sure the sender is in the
1588      * recipient's contacts.
1589      *
1590      * @deprecated since 3.6
1591      * @param \stdClass $recipient The user object.
1592      * @param \stdClass|null $sender The user object.
1593      * @return bool true if $sender is blocked, false otherwise.
1594      */
1595     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1596         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1598         global $USER, $CFG;
1600         if (is_null($sender)) {
1601             // The message is from the logged in user, unless otherwise specified.
1602             $sender = $USER;
1603         }
1605         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1606         switch ($privacypreference) {
1607             case self::MESSAGE_PRIVACY_SITE:
1608                 if (!empty($CFG->messagingallusers)) {
1609                     // Users can be messaged without being contacts or members of the same course.
1610                     break;
1611                 }
1612                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1613                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1614             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1615                 // Confirm the sender and the recipient are both members of the same course.
1616                 if (enrol_sharing_course($recipient, $sender)) {
1617                     // All good, the recipient and the sender are members of the same course.
1618                     return false;
1619                 }
1620             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1621                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1622                 return !self::is_contact($sender->id, $recipient->id);
1623         }
1625         return false;
1626     }
1628     /**
1629      * Checks if the recipient has specifically blocked the sending user.
1630      *
1631      * Note: This function will always return false if the sender has the
1632      * readallmessages capability at the system context level.
1633      *
1634      * @deprecated since 3.6
1635      * @param int $recipientid User ID of the recipient.
1636      * @param int $senderid User ID of the sender.
1637      * @return bool true if $sender is blocked, false otherwise.
1638      */
1639     public static function is_user_blocked($recipientid, $senderid = null) {
1640         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1641             DEBUG_DEVELOPER);
1643         global $USER;
1645         if (is_null($senderid)) {
1646             // The message is from the logged in user, unless otherwise specified.
1647             $senderid = $USER->id;
1648         }
1650         $systemcontext = \context_system::instance();
1651         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1652             return false;
1653         }
1655         if (self::is_blocked($recipientid, $senderid)) {
1656             return true;
1657         }
1659         return false;
1660     }
1662     /**
1663      * Get specified message processor, validate corresponding plugin existence and
1664      * system configuration.
1665      *
1666      * @param string $name  Name of the processor.
1667      * @param bool $ready only return ready-to-use processors.
1668      * @return mixed $processor if processor present else empty array.
1669      * @since Moodle 3.2
1670      */
1671     public static function get_message_processor($name, $ready = false) {
1672         global $DB, $CFG;
1674         $processor = $DB->get_record('message_processors', array('name' => $name));
1675         if (empty($processor)) {
1676             // Processor not found, return.
1677             return array();
1678         }
1680         $processor = self::get_processed_processor_object($processor);
1681         if ($ready) {
1682             if ($processor->enabled && $processor->configured) {
1683                 return $processor;
1684             } else {
1685                 return array();
1686             }
1687         } else {
1688             return $processor;
1689         }
1690     }
1692     /**
1693      * Returns weather a given processor is enabled or not.
1694      * Note:- This doesn't check if the processor is configured or not.
1695      *
1696      * @param string $name Name of the processor
1697      * @return bool
1698      */
1699     public static function is_processor_enabled($name) {
1701         $cache = \cache::make('core', 'message_processors_enabled');
1702         $status = $cache->get($name);
1704         if ($status === false) {
1705             $processor = self::get_message_processor($name);
1706             if (!empty($processor)) {
1707                 $cache->set($name, $processor->enabled);
1708                 return $processor->enabled;
1709             } else {
1710                 return false;
1711             }
1712         }
1714         return $status;
1715     }
1717     /**
1718      * Set status of a processor.
1719      *
1720      * @param \stdClass $processor processor record.
1721      * @param 0|1 $enabled 0 or 1 to set the processor status.
1722      * @return bool
1723      * @since Moodle 3.2
1724      */
1725     public static function update_processor_status($processor, $enabled) {
1726         global $DB;
1727         $cache = \cache::make('core', 'message_processors_enabled');
1728         $cache->delete($processor->name);
1729         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1730     }
1732     /**
1733      * Given a processor object, loads information about it's settings and configurations.
1734      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1735      * or @see \get_message_processors()
1736      *
1737      * @param \stdClass $processor processor object
1738      * @return \stdClass processed processor object
1739      * @since Moodle 3.2
1740      */
1741     public static function get_processed_processor_object(\stdClass $processor) {
1742         global $CFG;
1744         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1745         if (is_readable($processorfile)) {
1746             include_once($processorfile);
1747             $processclass = 'message_output_' . $processor->name;
1748             if (class_exists($processclass)) {
1749                 $pclass = new $processclass();
1750                 $processor->object = $pclass;
1751                 $processor->configured = 0;
1752                 if ($pclass->is_system_configured()) {
1753                     $processor->configured = 1;
1754                 }
1755                 $processor->hassettings = 0;
1756                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1757                     $processor->hassettings = 1;
1758                 }
1759                 $processor->available = 1;
1760             } else {
1761                 print_error('errorcallingprocessor', 'message');
1762             }
1763         } else {
1764             $processor->available = 0;
1765         }
1766         return $processor;
1767     }
1769     /**
1770      * Retrieve users blocked by $user1
1771      *
1772      * @param int $userid The user id of the user whos blocked users we are returning
1773      * @return array the users blocked
1774      */
1775     public static function get_blocked_users($userid) {
1776         global $DB;
1778         $userfields = \user_picture::fields('u', array('lastaccess'));
1779         $blockeduserssql = "SELECT $userfields
1780                               FROM {message_users_blocked} mub
1781                         INNER JOIN {user} u
1782                                 ON u.id = mub.blockeduserid
1783                              WHERE u.deleted = 0
1784                                AND mub.userid = ?
1785                           GROUP BY $userfields
1786                           ORDER BY u.firstname ASC";
1787         return $DB->get_records_sql($blockeduserssql, [$userid]);
1788     }
1790     /**
1791      * Mark a single message as read.
1792      *
1793      * @param int $userid The user id who marked the message as read
1794      * @param \stdClass $message The message
1795      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1796      */
1797     public static function mark_message_as_read($userid, $message, $timeread = null) {
1798         global $DB;
1800         if (is_null($timeread)) {
1801             $timeread = time();
1802         }
1804         $mua = new \stdClass();
1805         $mua->userid = $userid;
1806         $mua->messageid = $message->id;
1807         $mua->action = self::MESSAGE_ACTION_READ;
1808         $mua->timecreated = $timeread;
1809         $mua->id = $DB->insert_record('message_user_actions', $mua);
1811         // Get the context for the user who received the message.
1812         $context = \context_user::instance($userid, IGNORE_MISSING);
1813         // If the user no longer exists the context value will be false, in this case use the system context.
1814         if ($context === false) {
1815             $context = \context_system::instance();
1816         }
1818         // Trigger event for reading a message.
1819         $event = \core\event\message_viewed::create(array(
1820             'objectid' => $mua->id,
1821             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1822             'context' => $context,
1823             'relateduserid' => $message->useridfrom,
1824             'other' => array(
1825                 'messageid' => $message->id
1826             )
1827         ));
1828         $event->trigger();
1829     }
1831     /**
1832      * Mark a single notification as read.
1833      *
1834      * @param \stdClass $notification The notification
1835      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1836      */
1837     public static function mark_notification_as_read($notification, $timeread = null) {
1838         global $DB;
1840         if (is_null($timeread)) {
1841             $timeread = time();
1842         }
1844         if (is_null($notification->timeread)) {
1845             $updatenotification = new \stdClass();
1846             $updatenotification->id = $notification->id;
1847             $updatenotification->timeread = $timeread;
1849             $DB->update_record('notifications', $updatenotification);
1851             // Trigger event for reading a notification.
1852             \core\event\notification_viewed::create_from_ids(
1853                 $notification->useridfrom,
1854                 $notification->useridto,
1855                 $notification->id
1856             )->trigger();
1857         }
1858     }
1860     /**
1861      * Checks if a user can delete a message.
1862      *
1863      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1864      *  but will still seem as if it was by the user)
1865      * @param int $messageid The message id
1866      * @return bool Returns true if a user can delete the message, false otherwise.
1867      */
1868     public static function can_delete_message($userid, $messageid) {
1869         global $DB, $USER;
1871         $systemcontext = \context_system::instance();
1873         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
1875         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1876             return true;
1877         }
1879         if (!self::is_user_in_conversation($userid, $conversationid)) {
1880             return false;
1881         }
1883         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1884                 $USER->id == $userid) {
1885             return true;
1886         }
1888         return false;
1889     }
1891     /**
1892      * Deletes a message.
1893      *
1894      * This function does not verify any permissions.
1895      *
1896      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1897      *  but will still seem as if it was by the user)
1898      * @param int $messageid The message id
1899      * @return bool
1900      */
1901     public static function delete_message($userid, $messageid) {
1902         global $DB, $USER;
1904         if (!$DB->record_exists('messages', ['id' => $messageid])) {
1905             return false;
1906         }
1908         // Check if the user has already deleted this message.
1909         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
1910                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
1911             $mua = new \stdClass();
1912             $mua->userid = $userid;
1913             $mua->messageid = $messageid;
1914             $mua->action = self::MESSAGE_ACTION_DELETED;
1915             $mua->timecreated = time();
1916             $mua->id = $DB->insert_record('message_user_actions', $mua);
1918             // Trigger event for deleting a message.
1919             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1920                 $messageid, $mua->id)->trigger();
1922             return true;
1923         }
1925         return false;
1926     }
1928     /**
1929      * Returns the conversation between two users.
1930      *
1931      * @param array $userids
1932      * @return int|bool The id of the conversation, false if not found
1933      */
1934     public static function get_conversation_between_users(array $userids) {
1935         global $DB;
1937         $hash = helper::get_conversation_hash($userids);
1939         $params = [
1940             'type' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1941             'convhash' => $hash
1942         ];
1943         if ($conversation = $DB->get_record('message_conversations', $params)) {
1944             return $conversation->id;
1945         }
1947         return false;
1948     }
1950     /**
1951      * Creates a conversation between two users.
1952      *
1953      * @deprecated since 3.6
1954      * @param array $userids
1955      * @return int The id of the conversation
1956      */
1957     public static function create_conversation_between_users(array $userids) {
1958         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
1959             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
1961         // This method was always used for individual conversations.
1962         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1964         return $conversation->id;
1965     }
1967     /**
1968      * Creates a conversation with selected users and messages.
1969      *
1970      * @param int $type The type of conversation
1971      * @param int[] $userids The array of users to add to the conversation
1972      * @param string|null $name The name of the conversation
1973      * @param int $enabled Determines if the conversation is created enabled or disabled
1974      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
1975      * @param string|null $itemtype Defines the type of the component
1976      * @param int|null $itemid The id of the component
1977      * @param int|null $contextid The id of the context
1978      * @return \stdClass
1979      */
1980     public static function create_conversation(int $type, array $userids, string $name = null,
1981             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
1982             string $itemtype = null, int $itemid = null, int $contextid = null) {
1984         global $DB;
1986         $validtypes = [
1987             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1988             self::MESSAGE_CONVERSATION_TYPE_GROUP
1989         ];
1991         if (!in_array($type, $validtypes)) {
1992             throw new \moodle_exception('An invalid conversation type was specified.');
1993         }
1995         // Sanity check.
1996         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1997             if (count($userids) > 2) {
1998                 throw new \moodle_exception('An individual conversation can not have more than two users.');
1999             }
2000         }
2002         $conversation = new \stdClass();
2003         $conversation->type = $type;
2004         $conversation->name = $name;
2005         $conversation->convhash = null;
2006         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2007             $conversation->convhash = helper::get_conversation_hash($userids);
2008         }
2009         $conversation->component = $component;
2010         $conversation->itemtype = $itemtype;
2011         $conversation->itemid = $itemid;
2012         $conversation->contextid = $contextid;
2013         $conversation->enabled = $enabled;
2014         $conversation->timecreated = time();
2015         $conversation->timemodified = $conversation->timecreated;
2016         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2018         // Add users to this conversation.
2019         $arrmembers = [];
2020         foreach ($userids as $userid) {
2021             $member = new \stdClass();
2022             $member->conversationid = $conversation->id;
2023             $member->userid = $userid;
2024             $member->timecreated = time();
2025             $member->id = $DB->insert_record('message_conversation_members', $member);
2027             $arrmembers[] = $member;
2028         }
2030         $conversation->members = $arrmembers;
2032         return $conversation;
2033     }
2035     /**
2036      * Checks if a user can create a group conversation.
2037      *
2038      * @param int $userid The id of the user attempting to create the conversation
2039      * @param \context $context The context they are creating the conversation from, most likely course context
2040      * @return bool
2041      */
2042     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2043         global $CFG;
2045         // If we can't message at all, then we can't create a conversation.
2046         if (empty($CFG->messaging)) {
2047             return false;
2048         }
2050         // We need to check they have the capability to create the conversation.
2051         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2052     }
2054     /**
2055      * Checks if a user can create a contact request.
2056      *
2057      * @param int $userid The id of the user who is creating the contact request
2058      * @param int $requesteduserid The id of the user being requested
2059      * @return bool
2060      */
2061     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2062         global $CFG;
2064         // If we can't message at all, then we can't create a contact.
2065         if (empty($CFG->messaging)) {
2066             return false;
2067         }
2069         // If we can message anyone on the site then we can create a contact.
2070         if ($CFG->messagingallusers) {
2071             return true;
2072         }
2074         // We need to check if they are in the same course.
2075         return enrol_sharing_course($userid, $requesteduserid);
2076     }
2078     /**
2079      * Handles creating a contact request.
2080      *
2081      * @param int $userid The id of the user who is creating the contact request
2082      * @param int $requesteduserid The id of the user being requested
2083      */
2084     public static function create_contact_request(int $userid, int $requesteduserid) {
2085         global $DB;
2087         $request = new \stdClass();
2088         $request->userid = $userid;
2089         $request->requesteduserid = $requesteduserid;
2090         $request->timecreated = time();
2092         $DB->insert_record('message_contact_requests', $request);
2094         // Send a notification.
2095         $userfrom = \core_user::get_user($userid);
2096         $userfromfullname = fullname($userfrom);
2097         $userto = \core_user::get_user($requesteduserid);
2098         $url = new \moodle_url('/message/pendingcontactrequests.php');
2100         $subject = get_string('messagecontactrequestsnotificationsubject', 'core_message', $userfromfullname);
2101         $fullmessage = get_string('messagecontactrequestsnotification', 'core_message', $userfromfullname);
2103         $message = new \core\message\message();
2104         $message->courseid = SITEID;
2105         $message->component = 'moodle';
2106         $message->name = 'messagecontactrequests';
2107         $message->notification = 1;
2108         $message->userfrom = $userfrom;
2109         $message->userto = $userto;
2110         $message->subject = $subject;
2111         $message->fullmessage = text_to_html($fullmessage);
2112         $message->fullmessageformat = FORMAT_HTML;
2113         $message->fullmessagehtml = $fullmessage;
2114         $message->smallmessage = '';
2115         $message->contexturl = $url->out(false);
2117         message_send($message);
2118     }
2121     /**
2122      * Handles confirming a contact request.
2123      *
2124      * @param int $userid The id of the user who created the contact request
2125      * @param int $requesteduserid The id of the user confirming the request
2126      */
2127     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2128         global $DB;
2130         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2131                 'requesteduserid' => $requesteduserid])) {
2132             self::add_contact($userid, $requesteduserid);
2134             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2135         }
2136     }
2138     /**
2139      * Handles declining a contact request.
2140      *
2141      * @param int $userid The id of the user who created the contact request
2142      * @param int $requesteduserid The id of the user declining the request
2143      */
2144     public static function decline_contact_request(int $userid, int $requesteduserid) {
2145         global $DB;
2147         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2148                 'requesteduserid' => $requesteduserid])) {
2149             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2150         }
2151     }
2153     /**
2154      * Handles returning the contact requests for a user.
2155      *
2156      * This also includes the user data necessary to display information
2157      * about the user.
2158      *
2159      * It will not include blocked users.
2160      *
2161      * @param int $userid
2162      * @param int $limitfrom
2163      * @param int $limitnum
2164      * @return array The list of contact requests
2165      */
2166     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2167         global $DB;
2169         $sql = "SELECT mcr.userid
2170                   FROM {message_contact_requests} mcr
2171              LEFT JOIN {message_users_blocked} mub
2172                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2173                  WHERE mcr.requesteduserid = ?
2174                    AND mub.id is NULL
2175               ORDER BY mcr.timecreated ASC";
2176         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2177             $userids = array_keys($contactrequests);
2178             return helper::get_member_info($userid, $userids);
2179         }
2181         return [];
2182     }
2184     /**
2185      * Handles adding a contact.
2186      *
2187      * @param int $userid The id of the user who requested to be a contact
2188      * @param int $contactid The id of the contact
2189      */
2190     public static function add_contact(int $userid, int $contactid) {
2191         global $DB;
2193         $messagecontact = new \stdClass();
2194         $messagecontact->userid = $userid;
2195         $messagecontact->contactid = $contactid;
2196         $messagecontact->timecreated = time();
2197         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2199         $eventparams = [
2200             'objectid' => $messagecontact->id,
2201             'userid' => $userid,
2202             'relateduserid' => $contactid,
2203             'context' => \context_user::instance($userid)
2204         ];
2205         $event = \core\event\message_contact_added::create($eventparams);
2206         $event->add_record_snapshot('message_contacts', $messagecontact);
2207         $event->trigger();
2208     }
2210     /**
2211      * Handles removing a contact.
2212      *
2213      * @param int $userid The id of the user who is removing a user as a contact
2214      * @param int $contactid The id of the user to be removed as a contact
2215      */
2216     public static function remove_contact(int $userid, int $contactid) {
2217         global $DB;
2219         if ($contact = self::get_contact($userid, $contactid)) {
2220             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2222             $event = \core\event\message_contact_removed::create(array(
2223                 'objectid' => $contact->id,
2224                 'userid' => $userid,
2225                 'relateduserid' => $contactid,
2226                 'context' => \context_user::instance($userid)
2227             ));
2228             $event->add_record_snapshot('message_contacts', $contact);
2229             $event->trigger();
2230         }
2231     }
2233     /**
2234      * Handles blocking a user.
2235      *
2236      * @param int $userid The id of the user who is blocking
2237      * @param int $usertoblockid The id of the user being blocked
2238      */
2239     public static function block_user(int $userid, int $usertoblockid) {
2240         global $DB;
2242         $blocked = new \stdClass();
2243         $blocked->userid = $userid;
2244         $blocked->blockeduserid = $usertoblockid;
2245         $blocked->timecreated = time();
2246         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2248         // Trigger event for blocking a contact.
2249         $event = \core\event\message_user_blocked::create(array(
2250             'objectid' => $blocked->id,
2251             'userid' => $userid,
2252             'relateduserid' => $usertoblockid,
2253             'context' => \context_user::instance($userid)
2254         ));
2255         $event->add_record_snapshot('message_users_blocked', $blocked);
2256         $event->trigger();
2257     }
2259     /**
2260      * Handles unblocking a user.
2261      *
2262      * @param int $userid The id of the user who is unblocking
2263      * @param int $usertounblockid The id of the user being unblocked
2264      */
2265     public static function unblock_user(int $userid, int $usertounblockid) {
2266         global $DB;
2268         if ($blockeduser = $DB->get_record('message_users_blocked',
2269                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2270             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2272             // Trigger event for unblocking a contact.
2273             $event = \core\event\message_user_unblocked::create(array(
2274                 'objectid' => $blockeduser->id,
2275                 'userid' => $userid,
2276                 'relateduserid' => $usertounblockid,
2277                 'context' => \context_user::instance($userid)
2278             ));
2279             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2280             $event->trigger();
2281         }
2282     }
2284     /**
2285      * Checks if users are already contacts.
2286      *
2287      * @param int $userid The id of one of the users
2288      * @param int $contactid The id of the other user
2289      * @return bool Returns true if they are a contact, false otherwise
2290      */
2291     public static function is_contact(int $userid, int $contactid) : bool {
2292         global $DB;
2294         $sql = "SELECT id
2295                   FROM {message_contacts} mc
2296                  WHERE (mc.userid = ? AND mc.contactid = ?)
2297                     OR (mc.userid = ? AND mc.contactid = ?)";
2298         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2299     }
2301     /**
2302      * Returns the row in the database table message_contacts that represents the contact between two people.
2303      *
2304      * @param int $userid The id of one of the users
2305      * @param int $contactid The id of the other user
2306      * @return mixed A fieldset object containing the record, false otherwise
2307      */
2308     public static function get_contact(int $userid, int $contactid) {
2309         global $DB;
2311         $sql = "SELECT mc.*
2312                   FROM {message_contacts} mc
2313                  WHERE (mc.userid = ? AND mc.contactid = ?)
2314                     OR (mc.userid = ? AND mc.contactid = ?)";
2315         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2316     }
2318     /**
2319      * Checks if a user is already blocked.
2320      *
2321      * @param int $userid
2322      * @param int $blockeduserid
2323      * @return bool Returns true if they are a blocked, false otherwise
2324      */
2325     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2326         global $DB;
2328         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2329     }
2331     /**
2332      * Checks if a contact request already exists between users.
2333      *
2334      * @param int $userid The id of the user who is creating the contact request
2335      * @param int $requesteduserid The id of the user being requested
2336      * @return bool Returns true if a contact request exists, false otherwise
2337      */
2338     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2339         global $DB;
2341         $sql = "SELECT id
2342                   FROM {message_contact_requests} mcr
2343                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2344                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2345         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2346     }
2348     /**
2349      * Checks if a user is already in a conversation.
2350      *
2351      * @param int $userid The id of the user we want to check if they are in a group
2352      * @param int $conversationid The id of the conversation
2353      * @return bool Returns true if a contact request exists, false otherwise
2354      */
2355     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2356         global $DB;
2358         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2359             'userid' => $userid]);
2360     }
2362     /**
2363      * Checks if the sender can message the recipient.
2364      *
2365      * @param int $recipientid
2366      * @param int $senderid
2367      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2368      */
2369     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2370         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2371             // The sender has the ability to contact any user across the entire site.
2372             return true;
2373         }
2375         // The initial value of $cancontact is null to indicate that a value has not been determined.
2376         $cancontact = null;
2378         if (self::is_blocked($recipientid, $senderid)) {
2379             // The recipient has specifically blocked this sender.
2380             $cancontact = false;
2381         }
2383         $sharedcourses = null;
2384         if (null === $cancontact) {
2385             // There are three user preference options:
2386             // - Site: Allow anyone not explicitly blocked to contact me;
2387             // - Course members: Allow anyone I am in a course with to contact me; and
2388             // - Contacts: Only allow my contacts to contact me.
2389             //
2390             // The Site option is only possible when the messagingallusers site setting is also enabled.
2392             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2393             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2394                 // The user preference is to allow any user to contact them.
2395                 // No need to check anything else.
2396                 $cancontact = true;
2397             } else {
2398                 // This user only allows their own contacts, and possibly course peers, to contact them.
2399                 // If the users are contacts then we can avoid the more expensive shared courses check.
2400                 $cancontact = self::is_contact($senderid, $recipientid);
2402                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2403                     // The users are not contacts and the user allows course member messaging.
2404                     // Check whether these two users share any course together.
2405                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2406                     $cancontact = (!empty($sharedcourses));
2407                 }
2408             }
2409         }
2411         if (false === $cancontact) {
2412             // At the moment the users cannot contact one another.
2413             // Check whether the messageanyuser capability applies in any of the shared courses.
2414             // This is intended to allow teachers to message students regardless of message settings.
2416             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2417             if (null === $sharedcourses) {
2418                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2419             }
2421             foreach ($sharedcourses as $course) {
2422                 // Note: enrol_get_shared_courses will preload any shared context.
2423                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2424                     $cancontact = true;
2425                     break;
2426                 }
2427             }
2428         }
2430         return $cancontact;
2431     }
2433     /**
2434      * Add some new members to an existing conversation.
2435      *
2436      * @param array $userids User ids array to add as members.
2437      * @param int $convid The conversation id. Must exists.
2438      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2439      * @throws \dml_exception If there is a database error
2440      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2441      */
2442     public static function add_members_to_conversation(array $userids, int $convid) {
2443         global $DB;
2445         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2447         // We can only add members to a group conversation.
2448         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2449             throw new \moodle_exception('You can not add members to a non-group conversation.');
2450         }
2452         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2453         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2454         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2456         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2457         $memberuserids = array_values($DB->get_records_menu(
2458             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2459         );
2461         // Work with existing new members.
2462         $members = array();
2463         $newuserids = array_diff($existingusers, $memberuserids);
2464         foreach ($newuserids as $userid) {
2465             $member = new \stdClass();
2466             $member->conversationid = $convid;
2467             $member->userid = $userid;
2468             $member->timecreated = time();
2469             $members[] = $member;
2470         }
2472         $DB->insert_records('message_conversation_members', $members);
2473     }
2475     /**
2476      * Remove some members from an existing conversation.
2477      *
2478      * @param array $userids The user ids to remove from conversation members.
2479      * @param int $convid The conversation id. Must exists.
2480      * @throws \dml_exception
2481      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2482      */
2483     public static function remove_members_from_conversation(array $userids, int $convid) {
2484         global $DB;
2486         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2488         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2489             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2490         }
2492         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2493         $params['convid'] = $convid;
2495         $DB->delete_records_select('message_conversation_members',
2496             "conversationid = :convid AND userid $useridcondition", $params);
2497     }
2499     /**
2500      * Count conversation members.
2501      *
2502      * @param int $convid The conversation id.
2503      * @return int Number of conversation members.
2504      * @throws \dml_exception
2505      */
2506     public static function count_conversation_members(int $convid) : int {
2507         global $DB;
2509         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2510     }
2512     /**
2513      * Checks whether or not a conversation area is enabled.
2514      *
2515      * @param string $component Defines the Moodle component which the area was added to.
2516      * @param string $itemtype Defines the type of the component.
2517      * @param int $itemid The id of the component.
2518      * @param int $contextid The id of the context.
2519      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2520      */
2521     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2522         global $DB;
2524         return $DB->record_exists('message_conversations',
2525             [
2526                 'itemid' => $itemid,
2527                 'contextid' => $contextid,
2528                 'component' => $component,
2529                 'itemtype' => $itemtype,
2530                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2531             ]
2532         );
2533     }
2535     /**
2536      * Get conversation by area.
2537      *
2538      * @param string $component Defines the Moodle component which the area was added to.
2539      * @param string $itemtype Defines the type of the component.
2540      * @param int $itemid The id of the component.
2541      * @param int $contextid The id of the context.
2542      * @return \stdClass
2543      */
2544     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2545         global $DB;
2547         return $DB->get_record('message_conversations',
2548             [
2549                 'itemid' => $itemid,
2550                 'contextid' => $contextid,
2551                 'component' => $component,
2552                 'itemtype'  => $itemtype
2553             ]
2554         );
2555     }
2557     /**
2558      * Enable a conversation.
2559      *
2560      * @param int $conversationid The id of the conversation.
2561      * @return void
2562      */
2563     public static function enable_conversation(int $conversationid) {
2564         global $DB;
2566         $conversation = new \stdClass();
2567         $conversation->id = $conversationid;
2568         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2569         $conversation->timemodified = time();
2570         $DB->update_record('message_conversations', $conversation);
2571     }
2573     /**
2574      * Disable a conversation.
2575      *
2576      * @param int $conversationid The id of the conversation.
2577      * @return void
2578      */
2579     public static function disable_conversation(int $conversationid) {
2580         global $DB;
2582         $conversation = new \stdClass();
2583         $conversation->id = $conversationid;
2584         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2585         $conversation->timemodified = time();
2586         $DB->update_record('message_conversations', $conversation);
2587     }
2589     /**
2590      * Update the name of a conversation.
2591      *
2592      * @param int $conversationid The id of a conversation.
2593      * @param string $name The main name of the area
2594      * @return void
2595      */
2596     public static function update_conversation_name(int $conversationid, string $name) {
2597         global $DB;
2599         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2600             if ($name <> $conversation->name) {
2601                 $conversation->name = $name;
2602                 $conversation->timemodified = time();
2603                 $DB->update_record('message_conversations', $conversation);
2604             }
2605         }
2606     }
2608     /**
2609      * Returns a list of conversation members.
2610      *
2611      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2612      * @param int $conversationid The id of the conversation
2613      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2614      * @param int $limitfrom
2615      * @param int $limitnum
2616      * @return array
2617      */
2618     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2619                                                     int $limitfrom = 0, int $limitnum = 0) : array {
2620         global $DB;
2622         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2623                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2624             $userids = array_keys($members);
2625             $members = helper::get_member_info($userid, $userids, $includecontactrequests);
2627             return $members;
2628         }
2630         return [];
2631     }