Merge branch 'MDL-63945_master' of git://github.com/markn86/moodle
[moodle.git] / message / classes / api.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Contains class used to return information to display for the message area.
19  *
20  * @package    core_message
21  * @copyright  2016 Mark Nelson <markn@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_message;
27 use core_favourites\local\entity\favourite;
29 defined('MOODLE_INTERNAL') || die();
31 require_once($CFG->dirroot . '/lib/messagelib.php');
33 /**
34  * Class used to return information to display for the message area.
35  *
36  * @copyright  2016 Mark Nelson <markn@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class api {
41     /**
42      * The action for reading a message.
43      */
44     const MESSAGE_ACTION_READ = 1;
46     /**
47      * The action for deleting a message.
48      */
49     const MESSAGE_ACTION_DELETED = 2;
51     /**
52      * The privacy setting for being messaged by anyone within courses user is member of.
53      */
54     const MESSAGE_PRIVACY_COURSEMEMBER = 0;
56     /**
57      * The privacy setting for being messaged only by contacts.
58      */
59     const MESSAGE_PRIVACY_ONLYCONTACTS = 1;
61     /**
62      * The privacy setting for being messaged by anyone on the site.
63      */
64     const MESSAGE_PRIVACY_SITE = 2;
66     /**
67      * An individual conversation.
68      */
69     const MESSAGE_CONVERSATION_TYPE_INDIVIDUAL = 1;
71     /**
72      * A group conversation.
73      */
74     const MESSAGE_CONVERSATION_TYPE_GROUP = 2;
76     /**
77      * The state for an enabled conversation area.
78      */
79     const MESSAGE_CONVERSATION_ENABLED = 1;
81     /**
82      * The state for a disabled conversation area.
83      */
84     const MESSAGE_CONVERSATION_DISABLED = 0;
86     /**
87      * Handles searching for messages in the message area.
88      *
89      * @param int $userid The user id doing the searching
90      * @param string $search The string the user is searching
91      * @param int $limitfrom
92      * @param int $limitnum
93      * @return array
94      */
95     public static function search_messages($userid, $search, $limitfrom = 0, $limitnum = 0) {
96         global $DB;
98         // Get the user fields we want.
99         $ufields = \user_picture::fields('u', array('lastaccess'), 'userfrom_id', 'userfrom_');
100         $ufields2 = \user_picture::fields('u2', array('lastaccess'), 'userto_id', 'userto_');
102         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto, m.subject, m.fullmessage, m.fullmessagehtml, m.fullmessageformat,
103                        m.smallmessage, m.timecreated, 0 as isread, $ufields, mub.id as userfrom_blocked, $ufields2,
104                        mub2.id as userto_blocked
105                   FROM {messages} m
106             INNER JOIN {user} u
107                     ON u.id = m.useridfrom
108             INNER JOIN {message_conversations} mc
109                     ON mc.id = m.conversationid
110             INNER JOIN {message_conversation_members} mcm
111                     ON mcm.conversationid = m.conversationid
112             INNER JOIN {user} u2
113                     ON u2.id = mcm.userid
114              LEFT JOIN {message_users_blocked} mub
115                     ON (mub.blockeduserid = u.id AND mub.userid = ?)
116              LEFT JOIN {message_users_blocked} mub2
117                     ON (mub2.blockeduserid = u2.id AND mub2.userid = ?)
118              LEFT JOIN {message_user_actions} mua
119                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
120                  WHERE (m.useridfrom = ? OR mcm.userid = ?)
121                    AND m.useridfrom != mcm.userid
122                    AND u.deleted = 0
123                    AND u2.deleted = 0
124                    AND mua.id is NULL
125                    AND " . $DB->sql_like('smallmessage', '?', false) . "
126               ORDER BY timecreated DESC";
128         $params = array($userid, $userid, $userid, self::MESSAGE_ACTION_DELETED, $userid, $userid, '%' . $search . '%');
130         // Convert the messages into searchable contacts with their last message being the message that was searched.
131         $conversations = array();
132         if ($messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
133             foreach ($messages as $message) {
134                 $prefix = 'userfrom_';
135                 if ($userid == $message->useridfrom) {
136                     $prefix = 'userto_';
137                     // If it from the user, then mark it as read, even if it wasn't by the receiver.
138                     $message->isread = true;
139                 }
140                 $blockedcol = $prefix . 'blocked';
141                 $message->blocked = $message->$blockedcol ? 1 : 0;
143                 $message->messageid = $message->id;
144                 $conversations[] = helper::create_contact($message, $prefix);
145             }
146         }
148         return $conversations;
149     }
151     /**
152      * Handles searching for user in a particular course in the message area.
153      *
154      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
155      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
156      * But we are deprecating data_for_messagearea_search_users_in_course external function.
157      * Followup: MDL-63915
158      *
159      * @param int $userid The user id doing the searching
160      * @param int $courseid The id of the course we are searching in
161      * @param string $search The string the user is searching
162      * @param int $limitfrom
163      * @param int $limitnum
164      * @return array
165      */
166     public static function search_users_in_course($userid, $courseid, $search, $limitfrom = 0, $limitnum = 0) {
167         global $DB;
169         // Get all the users in the course.
170         list($esql, $params) = get_enrolled_sql(\context_course::instance($courseid), '', 0, true);
171         $sql = "SELECT u.*, mub.id as isblocked
172                   FROM {user} u
173                   JOIN ($esql) je
174                     ON je.id = u.id
175              LEFT JOIN {message_users_blocked} mub
176                     ON (mub.blockeduserid = u.id AND mub.userid = :userid)
177                  WHERE u.deleted = 0";
178         // Add more conditions.
179         $fullname = $DB->sql_fullname();
180         $sql .= " AND u.id != :userid2
181                   AND " . $DB->sql_like($fullname, ':search', false) . "
182              ORDER BY " . $DB->sql_fullname();
183         $params = array_merge(array('userid' => $userid, 'userid2' => $userid, 'search' => '%' . $search . '%'), $params);
185         // Convert all the user records into contacts.
186         $contacts = array();
187         if ($users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
188             foreach ($users as $user) {
189                 $user->blocked = $user->isblocked ? 1 : 0;
190                 $contacts[] = helper::create_contact($user);
191             }
192         }
194         return $contacts;
195     }
197     /**
198      * Handles searching for user in the message area.
199      *
200      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
201      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
202      * But we are deprecating data_for_messagearea_search_users external function.
203      * Followup: MDL-63915
204      *
205      * @param int $userid The user id doing the searching
206      * @param string $search The string the user is searching
207      * @param int $limitnum
208      * @return array
209      */
210     public static function search_users($userid, $search, $limitnum = 0) {
211         global $CFG, $DB;
213         // Used to search for contacts.
214         $fullname = $DB->sql_fullname();
215         $ufields = \user_picture::fields('u', array('lastaccess'));
217         // Users not to include.
218         $excludeusers = array($userid, $CFG->siteguest);
219         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
221         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid, 'userid3' => $userid);
223         // Ok, let's search for contacts first.
224         $contacts = array();
225         $sql = "SELECT $ufields, mub.id as isuserblocked
226                 FROM {user} u
227                 JOIN {message_contacts} mc
228                   ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
229            LEFT JOIN {message_users_blocked} mub
230                   ON (mub.userid = :userid3 AND mub.blockeduserid = u.id)
231                WHERE u.deleted = 0
232                  AND u.confirmed = 1
233                  AND " . $DB->sql_like($fullname, ':search', false) . "
234                  AND u.id $exclude
235             ORDER BY " . $DB->sql_fullname();
237         if ($users = $DB->get_records_sql($sql, $params + $excludeparams, 0, $limitnum)) {
238             foreach ($users as $user) {
239                 $user->blocked = $user->isuserblocked ? 1 : 0;
240                 $contacts[] = helper::create_contact($user);
241             }
242         }
244         // Now, let's get the courses.
245         // Make sure to limit searches to enrolled courses.
246         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
247         $courses = array();
248         // Really we want the user to be able to view the participants if they have the capability
249         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
250         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
251         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
252         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
253                 array('moodle/course:viewparticipants'))) {
254             foreach ($arrcourses as $course) {
255                 if (isset($enrolledcourses[$course->id])) {
256                     $data = new \stdClass();
257                     $data->id = $course->id;
258                     $data->shortname = $course->shortname;
259                     $data->fullname = $course->fullname;
260                     $courses[] = $data;
261                 }
262             }
263         }
265         // Let's get those non-contacts.
266         $noncontacts = array();
267         if ($CFG->messagingallusers) {
268             // In case $CFG->messagingallusers is enabled, search for all users site-wide but are not user's contact.
269             $sql = "SELECT $ufields
270                       FROM {user} u
271                  LEFT JOIN {message_users_blocked} mub
272                         ON (mub.userid = :userid1 AND mub.blockeduserid = u.id)
273                      WHERE u.deleted = 0
274                        AND u.confirmed = 1
275                        AND " . $DB->sql_like($fullname, ':search', false) . "
276                        AND u.id $exclude
277                        AND NOT EXISTS (SELECT mc.id
278                                          FROM {message_contacts} mc
279                                         WHERE (mc.userid = u.id AND mc.contactid = :userid2)
280                                            OR (mc.userid = :userid3 AND mc.contactid = u.id))
281                   ORDER BY " . $DB->sql_fullname();
282         } else {
283             // In case $CFG->messagingallusers is disabled, search for users you have a conversation with.
284             // Messaging setting could change, so could exist an old conversation with users you cannot message anymore.
285             $sql = "SELECT $ufields, mub.id as isuserblocked
286                       FROM {user} u
287                  LEFT JOIN {message_users_blocked} mub
288                         ON (mub.userid = :userid1 AND mub.blockeduserid = u.id)
289                 INNER JOIN {message_conversation_members} cm
290                         ON u.id = cm.userid
291                 INNER JOIN {message_conversation_members} cm2
292                         ON cm.conversationid = cm2.conversationid AND cm2.userid = :userid
293                      WHERE u.deleted = 0
294                        AND u.confirmed = 1
295                        AND " . $DB->sql_like($fullname, ':search', false) . "
296                        AND u.id $exclude
297                        AND NOT EXISTS (SELECT mc.id
298                                          FROM {message_contacts} mc
299                                         WHERE (mc.userid = u.id AND mc.contactid = :userid2)
300                                            OR (mc.userid = :userid3 AND mc.contactid = u.id))
301                   ORDER BY " . $DB->sql_fullname();
302             $params['userid'] = $userid;
303         }
304         if ($users = $DB->get_records_sql($sql,  $params + $excludeparams, 0, $limitnum)) {
305             foreach ($users as $user) {
306                 $noncontacts[] = helper::create_contact($user);
307             }
308         }
310         return array($contacts, $courses, $noncontacts);
311     }
313     /**
314      * Handles searching for user.
315      *
316      * @param int $userid The user id doing the searching
317      * @param string $search The string the user is searching
318      * @param int $limitfrom
319      * @param int $limitnum
320      * @return array
321      */
322     public static function message_search_users(int $userid, string $search, int $limitfrom = 0, int $limitnum = 1000) : array {
323         global $CFG, $DB;
325         // Used to search for contacts.
326         $fullname = $DB->sql_fullname();
328         // Users not to include.
329         $excludeusers = array($userid, $CFG->siteguest);
330         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
332         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid);
334         // Ok, let's search for contacts first.
335         $sql = "SELECT u.id
336                   FROM {user} u
337                   JOIN {message_contacts} mc
338                     ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
339                  WHERE u.deleted = 0
340                    AND u.confirmed = 1
341                    AND " . $DB->sql_like($fullname, ':search', false) . "
342                    AND u.id $exclude
343               ORDER BY " . $DB->sql_fullname();
344         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
346         $orderedcontacs = array();
347         if (!empty($foundusers)) {
348             $contacts = helper::get_member_info($userid, array_keys($foundusers));
349             // The get_member_info returns an associative array, so is not ordered in the same way.
350             // We need to reorder it again based on query's result.
351             foreach ($foundusers as $key => $value) {
352                 $contact = $contacts[$key];
353                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
354                 $orderedcontacs[] = $contact;
355             }
356         }
358         // Let's get those non-contacts.
359         if ($CFG->messagingallusers) {
360             // In case $CFG->messagingallusers is enabled, search for all users site-wide but are not user's contact.
361             $sql = "SELECT u.id
362                       FROM {user} u
363                      WHERE u.deleted = 0
364                        AND u.confirmed = 1
365                        AND " . $DB->sql_like($fullname, ':search', false) . "
366                        AND u.id $exclude
367                        AND NOT EXISTS (SELECT mc.id
368                                          FROM {message_contacts} mc
369                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
370                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
371                   ORDER BY " . $DB->sql_fullname();
372         } else {
373             // In case $CFG->messagingallusers is disabled, search for users you have a conversation with.
374             // Messaging setting could change, so could exist an old conversation with users you cannot message anymore.
375             $sql = "SELECT u.id
376                       FROM {user} u
377                 INNER JOIN {message_conversation_members} cm
378                         ON u.id = cm.userid
379                 INNER JOIN {message_conversation_members} cm2
380                         ON cm.conversationid = cm2.conversationid AND cm2.userid = :userid
381                      WHERE u.deleted = 0
382                        AND u.confirmed = 1
383                        AND " . $DB->sql_like($fullname, ':search', false) . "
384                        AND u.id $exclude
385                        AND NOT EXISTS (SELECT mc.id
386                                          FROM {message_contacts} mc
387                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
388                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
389                   ORDER BY " . $DB->sql_fullname();
390             $params['userid'] = $userid;
391         }
392         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
394         $orderednoncontacs = array();
395         if (!empty($foundusers)) {
396             $noncontacts = helper::get_member_info($userid, array_keys($foundusers));
397             // The get_member_info returns an associative array, so is not ordered in the same way.
398             // We need to reorder it again based on query's result.
399             foreach ($foundusers as $key => $value) {
400                 $contact = $noncontacts[$key];
401                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
402                 $orderednoncontacs[] = $contact;
403             }
404         }
406         return array($orderedcontacs, $orderednoncontacs);
407     }
409     /**
410      * Gets extra fields, like image url and subname for any conversations linked to components.
411      *
412      * The subname is like a subtitle for the conversation, to compliment it's name.
413      * The imageurl is the location of the image for the conversation, as might be seen on a listing of conversations for a user.
414      *
415      * @param array $conversations a list of conversations records.
416      * @return array the array of subnames, index by conversation id.
417      * @throws \coding_exception
418      * @throws \dml_exception
419      */
420     protected static function get_linked_conversation_extra_fields(array $conversations) : array {
421         global $DB;
423         $linkedconversations = [];
424         foreach ($conversations as $conversation) {
425             if (!is_null($conversation->component) && !is_null($conversation->itemtype)) {
426                 $linkedconversations[$conversation->component][$conversation->itemtype][$conversation->id]
427                     = $conversation->itemid;
428             }
429         }
430         if (empty($linkedconversations)) {
431             return [];
432         }
434         // TODO: MDL-63814: Working out the subname for linked conversations should be done in a generic way.
435         // Get the itemid, but only for course group linked conversation for now.
436         $extrafields = [];
437         if (!empty($linkeditems = $linkedconversations['core_group']['groups'])) { // Format: [conversationid => itemid].
438             // Get the name of the course to which the group belongs.
439             list ($groupidsql, $groupidparams) = $DB->get_in_or_equal(array_values($linkeditems), SQL_PARAMS_NAMED, 'groupid');
440             $sql = "SELECT g.*, c.shortname as courseshortname
441                       FROM {groups} g
442                       JOIN {course} c
443                         ON g.courseid = c.id
444                      WHERE g.id $groupidsql";
445             $courseinfo = $DB->get_records_sql($sql, $groupidparams);
446             foreach ($linkeditems as $convid => $groupid) {
447                 if (array_key_exists($groupid, $courseinfo)) {
448                     $group = $courseinfo[$groupid];
449                     // Subname.
450                     $extrafields[$convid]['subname'] = format_string($courseinfo[$groupid]->courseshortname);
452                     // Imageurl.
453                     $extrafields[$convid]['imageurl'] = '';
454                     if ($url = get_group_picture_url($group, $group->courseid, true)) {
455                         $extrafields[$convid]['imageurl'] = $url->out(false);
456                     }
457                 }
458             }
459         }
460         return $extrafields;
461     }
464     /**
465      * Returns the contacts and their conversation to display in the contacts area.
466      *
467      * ** WARNING **
468      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
469      * to retrieve too much information in a single call will cause performance problems.
470      * ** WARNING **
471      *
472      * This function has specifically been altered to break each of the data sets it
473      * requires into separate database calls. This is to avoid the performance problems
474      * observed when attempting to join large data sets (e.g. the message tables and
475      * the user table).
476      *
477      * While it is possible to gather the data in a single query, and it may even be
478      * more efficient with a correctly tuned database, we have opted to trade off some of
479      * the benefits of a single query in order to ensure this function will work on
480      * most databases with default tunings and with large data sets.
481      *
482      * @param int $userid The user id
483      * @param int $limitfrom
484      * @param int $limitnum
485      * @param int $type the type of the conversation, if you wish to filter to a certain type (see api constants).
486      * @param bool $favourites whether to include NO favourites (false) or ONLY favourites (true), or null to ignore this setting.
487      * @return array the array of conversations
488      * @throws \moodle_exception
489      */
490     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20, int $type = null,
491             bool $favourites = null) {
492         global $DB;
494         if (!is_null($type) && !in_array($type, [self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
495                 self::MESSAGE_CONVERSATION_TYPE_GROUP])) {
496             throw new \moodle_exception("Invalid value ($type) for type param, please see api constants.");
497         }
499         // We need to know which conversations are favourites, so we can either:
500         // 1) Include the 'isfavourite' attribute on conversations (when $favourite = null and we're including all conversations)
501         // 2) Restrict the results to ONLY those conversations which are favourites (when $favourite = true)
502         // 3) Restrict the results to ONLY those conversations which are NOT favourites (when $favourite = false).
503         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
504         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
505         $favouriteconversationids = array_column($favouriteconversations, 'itemid');
506         if ($favourites && empty($favouriteconversationids)) {
507             return []; // If we are aiming to return ONLY favourites, and we have none, there's nothing more to do.
508         }
510         // CONVERSATIONS AND MOST RECENT MESSAGE.
511         // Include those conversations with messages first (ordered by most recent message, desc), then add any conversations which
512         // don't have messages, such as newly created group conversations.
513         // Because we're sorting by message 'timecreated', those conversations without messages could be at either the start or the
514         // end of the results (behaviour for sorting of nulls differs between DB vendors), so we use the case to presort these.
516         // If we need to return ONLY favourites, or NO favourites, generate the SQL snippet.
517         $favouritesql = "";
518         $favouriteparams = [];
519         if (is_bool($favourites)) {
520             if (!empty($favouriteconversationids)) {
521                 list ($insql, $inparams) = $DB->get_in_or_equal($favouriteconversationids, SQL_PARAMS_NAMED, 'favouriteids');
522                 $favouritesql = $favourites ? " AND mc.id {$insql} " : " AND mc.id NOT {$insql} ";
523                 $favouriteparams = $inparams;
524             }
525         }
527         // If we need to restrict type, generate the SQL snippet.
528         $typesql = !is_null($type) ? " AND mc.type = :convtype " : "";
530         $sql = "SELECT m.id as messageid, mc.id as id, mc.name as conversationname, mc.type as conversationtype, m.useridfrom,
531                        m.smallmessage, m.fullmessage, m.fullmessageformat, m.fullmessagehtml, m.timecreated, mc.component,
532                        mc.itemtype, mc.itemid
533                   FROM {message_conversations} mc
534             INNER JOIN {message_conversation_members} mcm
535                     ON (mcm.conversationid = mc.id AND mcm.userid = :userid3)
536             LEFT JOIN (
537                           SELECT m.conversationid, MAX(m.id) AS messageid
538                             FROM {messages} m
539                       INNER JOIN (
540                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
541                                         FROM {messages} m
542                                   INNER JOIN {message_conversation_members} mcm
543                                           ON mcm.conversationid = m.conversationid
544                                    LEFT JOIN {message_user_actions} mua
545                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
546                                        WHERE mua.id is NULL
547                                          AND mcm.userid = :userid2
548                                     GROUP BY m.conversationid
549                                  ) maxmessage
550                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
551                          GROUP BY m.conversationid
552                        ) lastmessage
553                     ON lastmessage.conversationid = mc.id
554             LEFT JOIN {messages} m
555                    ON m.id = lastmessage.messageid
556                 WHERE mc.id IS NOT NULL $typesql $favouritesql
557               ORDER BY (CASE WHEN m.timecreated IS NULL THEN 0 ELSE 1 END) DESC, m.timecreated DESC, id DESC";
559         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
560             'userid2' => $userid, 'userid3' => $userid, 'convtype' => $type]);
561         $conversationset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
563         $conversations = [];
564         $members = [];
565         $individualmembers = [];
566         $groupmembers = [];
567         foreach ($conversationset as $conversation) {
568             $conversations[$conversation->id] = $conversation;
569             $members[$conversation->id] = [];
570         }
571         $conversationset->close();
573         // If there are no conversations found, then return early.
574         if (empty($conversations)) {
575             return [];
576         }
578         // COMPONENT-LINKED CONVERSATION FIELDS.
579         // Conversations linked to components may have extra information, such as:
580         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
581         // - imageurl: A URL to the image for the linked conversation.
582         // For now, this is ONLY course groups.
583         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
585         // MEMBERS.
586         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
587         // message or not.
588         //
589         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
590         // we want the details of the other member in the conversation (i.e. not the current user).
591         //
592         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
593         // This can be the current user or another group member, but for groups without messages, this will be empty.
594         //
595         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
596         // query to get the 'other' user as we already have that information.
598         // Work out which members we have already, and which ones we might need to fetch.
599         // If all the last messages were from another user, then we don't need to fetch anything further.
600         foreach ($conversations as $conversation) {
601             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
602                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
603                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
604                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
605                 } else {
606                     $individualconversations[] = $conversation->id;
607                 }
608             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
609                 // If we have a recent message, the sender is our member.
610                 if (!is_null($conversation->useridfrom)) {
611                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
612                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
613                 }
614             }
615         }
616         // If we need to fetch any member information for any of the individual conversations.
617         // This is the case if any of the individual conversations have a recent message sent by the current user.
618         if (!empty($individualconversations)) {
619             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
620             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
621                         FROM {message_conversation_members} mcm
622                        WHERE mcm.conversationid $icidinsql
623                        AND mcm.userid != :userid
624                        ORDER BY mcm.id";
625             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
626             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
628             foreach ($conversationmembers as $mid => $member) {
629                 $members[$member->conversationid][$member->userid] = $member->userid;
630                 $individualmembers[$member->userid] = $member->userid;
631             }
632         }
634         // We could fail early here if we're sure that:
635         // a) we have no otherusers for all the conversations (users may have been deleted)
636         // b) we're sure that all conversations are individual (1:1).
638         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
639         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
640         // tables because on large sites these tables are massive which results in extremely slow
641         // performance (typically due to join buffer exhaustion).
642         if (!empty($individualmembers) || !empty($groupmembers)) {
643             // Now, we want to remove any duplicates from the group members array. For individual members we will
644             // be doing a more extensive call as we want their contact requests as well as privacy information,
645             // which is not necessary for group conversations.
646             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
648             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
649             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
651             // Don't use array_merge, as we lose array keys.
652             $memberinfo = $individualmemberinfo + $groupmemberinfo;
654             // Update the members array with the member information.
655             $deletedmembers = [];
656             foreach ($members as $convid => $memberarr) {
657                 foreach ($memberarr as $key => $memberid) {
658                     if (array_key_exists($memberid, $memberinfo)) {
659                         // If the user is deleted, remember that.
660                         if ($memberinfo[$memberid]->isdeleted) {
661                             $deletedmembers[$convid][] = $memberid;
662                         }
664                         $members[$convid][$key] = clone $memberinfo[$memberid];
666                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
667                             // Remove data we don't need for group.
668                             $members[$convid][$key]->requirescontact = null;
669                             $members[$convid][$key]->canmessage = null;
670                             $members[$convid][$key]->contactrequests = [];
671                         }
672                     }
673                 }
674             }
675         }
677         // MEMBER COUNT.
678         $cids = array_column($conversations, 'id');
679         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
680         $membercountsql = "SELECT conversationid, count(id) AS membercount
681                              FROM {message_conversation_members} mcm
682                             WHERE mcm.conversationid $cidinsql
683                          GROUP BY mcm.conversationid";
684         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
686         // UNREAD MESSAGE COUNT.
687         // Finally, let's get the unread messages count for this user so that we can add it
688         // to the conversation. Remember we need to ignore the messages the user sent.
689         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
690                               FROM {messages} m
691                         INNER JOIN {message_conversations} mc
692                                 ON mc.id = m.conversationid
693                         INNER JOIN {message_conversation_members} mcm
694                                 ON m.conversationid = mcm.conversationid
695                          LEFT JOIN {message_user_actions} mua
696                                 ON (mua.messageid = m.id AND mua.userid = ? AND
697                                    (mua.action = ? OR mua.action = ?))
698                              WHERE mcm.userid = ?
699                                AND m.useridfrom != ?
700                                AND mua.id is NULL
701                           GROUP BY m.conversationid';
702         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
703             $userid, $userid]);
705         // Now, create the final return structure.
706         $arrconversations = [];
707         foreach ($conversations as $conversation) {
708             // Do not include any individual conversation which:
709             // a) Contains a deleted member or
710             // b) Does not contain a recent message for the user (this happens if the user has deleted all messages).
711             // Group conversations with deleted users or no messages are always returned.
712             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
713                     && (isset($deletedmembers[$conversation->id]) || empty($conversation->messageid))) {
714                 continue;
715             }
717             $conv = new \stdClass();
718             $conv->id = $conversation->id;
719             $conv->name = $conversation->conversationname;
720             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
721             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
722             $conv->type = $conversation->conversationtype;
723             $conv->membercount = $membercounts[$conv->id]->membercount;
724             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
725             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
726             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
727             $conv->members = $members[$conv->id];
729             // Add the most recent message information.
730             $conv->messages = [];
731             if ($conversation->smallmessage) {
732                 $msg = new \stdClass();
733                 $msg->id = $conversation->messageid;
734                 $msg->text = message_format_message_text($conversation);
735                 $msg->useridfrom = $conversation->useridfrom;
736                 $msg->timecreated = $conversation->timecreated;
737                 $conv->messages[] = $msg;
738             }
740             $arrconversations[] = $conv;
741         }
742         return $arrconversations;
743     }
745     /**
746      * Returns all conversations between two users
747      *
748      * @param int $userid1 One of the user's id
749      * @param int $userid2 The other user's id
750      * @param int $limitfrom
751      * @param int $limitnum
752      * @return array
753      * @throws \dml_exception
754      */
755     public static function get_conversations_between_users(int $userid1, int $userid2,
756                                                            int $limitfrom = 0, int $limitnum = 20) : array {
758         global $DB;
760         if ($userid1 == $userid2) {
761             return array();
762         }
764         // Get all conversation where both user1 and user2 are members.
765         // TODO: Add subname value. Waiting for definite table structure.
766         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
767                   FROM {message_conversations} mc
768             INNER JOIN {message_conversation_members} mcm1
769                     ON mc.id = mcm1.conversationid
770             INNER JOIN {message_conversation_members} mcm2
771                     ON mc.id = mcm2.conversationid
772                  WHERE mcm1.userid = :userid1
773                    AND mcm2.userid = :userid2
774                    AND mc.enabled != 0
775               ORDER BY mc.timecreated DESC";
777         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
778     }
780     /**
781      * Mark a conversation as a favourite for the given user.
782      *
783      * @param int $conversationid the id of the conversation to mark as a favourite.
784      * @param int $userid the id of the user to whom the favourite belongs.
785      * @return favourite the favourite object.
786      * @throws \moodle_exception if the user or conversation don't exist.
787      */
788     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
789         if (!self::is_user_in_conversation($userid, $conversationid)) {
790             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
791         }
792         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
793         return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
794     }
796     /**
797      * Unset a conversation as a favourite for the given user.
798      *
799      * @param int $conversationid the id of the conversation to unset as a favourite.
800      * @param int $userid the id to whom the favourite belongs.
801      * @throws \moodle_exception if the favourite does not exist for the user.
802      */
803     public static function unset_favourite_conversation(int $conversationid, int $userid) {
804         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
805         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
806     }
808     /**
809      * Returns the contacts to display in the contacts area.
810      *
811      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
812      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
813      * Followup: MDL-63915
814      *
815      * @param int $userid The user id
816      * @param int $limitfrom
817      * @param int $limitnum
818      * @return array
819      */
820     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
821         global $DB;
823         $contactids = [];
824         $sql = "SELECT mc.*
825                   FROM {message_contacts} mc
826                  WHERE mc.userid = ? OR mc.contactid = ?
827               ORDER BY timecreated DESC";
828         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
829             foreach ($contacts as $contact) {
830                 if ($userid == $contact->userid) {
831                     $contactids[] = $contact->contactid;
832                 } else {
833                     $contactids[] = $contact->userid;
834                 }
835             }
836         }
838         if (!empty($contactids)) {
839             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
841             $sql = "SELECT u.*, mub.id as isblocked
842                       FROM {user} u
843                  LEFT JOIN {message_users_blocked} mub
844                         ON u.id = mub.blockeduserid
845                      WHERE u.id $insql";
846             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
847                 $arrcontacts = [];
848                 foreach ($contacts as $contact) {
849                     $contact->blocked = $contact->isblocked ? 1 : 0;
850                     $arrcontacts[] = helper::create_contact($contact);
851                 }
853                 return $arrcontacts;
854             }
855         }
857         return [];
858     }
860     /**
861      * Returns the an array of the users the given user is in a conversation
862      * with who are a contact and the number of unread messages.
863      *
864      * @param int $userid The user id
865      * @param int $limitfrom
866      * @param int $limitnum
867      * @return array
868      */
869     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
870         global $DB;
872         $userfields = \user_picture::fields('u', array('lastaccess'));
873         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
874                               FROM {message_contacts} mc
875                         INNER JOIN {user} u
876                                 ON (u.id = mc.contactid OR u.id = mc.userid)
877                          LEFT JOIN {messages} m
878                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
879                          LEFT JOIN {message_conversation_members} mcm
880                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
881                          LEFT JOIN {message_user_actions} mua
882                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
883                          LEFT JOIN {message_users_blocked} mub
884                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
885                              WHERE mua.id is NULL
886                                AND mub.id is NULL
887                                AND (mc.userid = ? OR mc.contactid = ?)
888                                AND u.id != ?
889                                AND u.deleted = 0
890                           GROUP BY $userfields";
892         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
893             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
894     }
896     /**
897      * Returns the an array of the users the given user is in a conversation
898      * with who are not a contact and the number of unread messages.
899      *
900      * @param int $userid The user id
901      * @param int $limitfrom
902      * @param int $limitnum
903      * @return array
904      */
905     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
906         global $DB;
908         $userfields = \user_picture::fields('u', array('lastaccess'));
909         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
910                               FROM {user} u
911                         INNER JOIN {messages} m
912                                 ON m.useridfrom = u.id
913                         INNER JOIN {message_conversation_members} mcm
914                                 ON mcm.conversationid = m.conversationid
915                          LEFT JOIN {message_user_actions} mua
916                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
917                          LEFT JOIN {message_contacts} mc
918                                 ON (mc.userid = ? AND mc.contactid = u.id)
919                          LEFT JOIN {message_users_blocked} mub
920                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
921                              WHERE mcm.userid = ?
922                                AND mcm.userid != m.useridfrom
923                                AND mua.id is NULL
924                                AND mub.id is NULL
925                                AND mc.id is NULL
926                                AND u.deleted = 0
927                           GROUP BY $userfields";
929         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
930             $limitfrom, $limitnum);
931     }
933     /**
934      * Returns the messages to display in the message area.
935      *
936      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
937      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
938      * Followup: MDL-63915
939      *
940      * @param int $userid the current user
941      * @param int $otheruserid the other user
942      * @param int $limitfrom
943      * @param int $limitnum
944      * @param string $sort
945      * @param int $timefrom the time from the message being sent
946      * @param int $timeto the time up until the message being sent
947      * @return array
948      */
949     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
950             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
952         if (!empty($timefrom)) {
953             // Get the conversation between userid and otheruserid.
954             $userids = [$userid, $otheruserid];
955             if (!$conversationid = self::get_conversation_between_users($userids)) {
956                 // This method was always used for individual conversations.
957                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
958                 $conversationid = $conversation->id;
959             }
961             // Check the cache to see if we even need to do a DB query.
962             $cache = \cache::make('core', 'message_time_last_message_between_users');
963             $key = helper::get_last_message_time_created_cache_key($conversationid);
964             $lastcreated = $cache->get($key);
966             // The last known message time is earlier than the one being requested so we can
967             // just return an empty result set rather than having to query the DB.
968             if ($lastcreated && $lastcreated < $timefrom) {
969                 return [];
970             }
971         }
973         $arrmessages = array();
974         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
975                                              $sort, $timefrom, $timeto)) {
976             $arrmessages = helper::create_messages($userid, $messages);
977         }
979         return $arrmessages;
980     }
982     /**
983      * Returns the messages for the defined conversation.
984      *
985      * @param  int $userid The current user.
986      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
987      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
988      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
989      * @param  string $sort The column name to order by including optionally direction.
990      * @param  int $timefrom The time from the message being sent.
991      * @param  int $timeto The time up until the message being sent.
992      * @return array of messages
993      */
994     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
995         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
997         if (!empty($timefrom)) {
998             // Check the cache to see if we even need to do a DB query.
999             $cache = \cache::make('core', 'message_time_last_message_between_users');
1000             $key = helper::get_last_message_time_created_cache_key($convid);
1001             $lastcreated = $cache->get($key);
1003             // The last known message time is earlier than the one being requested so we can
1004             // just return an empty result set rather than having to query the DB.
1005             if ($lastcreated && $lastcreated < $timefrom) {
1006                 return [];
1007             }
1008         }
1010         $arrmessages = array();
1011         if ($messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto)) {
1012             $arrmessages = helper::format_conversation_messages($userid, $convid, $messages);
1013         }
1015         return $arrmessages;
1016     }
1018     /**
1019      * Returns the most recent message between two users.
1020      *
1021      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1022      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1023      * Followup: MDL-63915
1024      *
1025      * @param int $userid the current user
1026      * @param int $otheruserid the other user
1027      * @return \stdClass|null
1028      */
1029     public static function get_most_recent_message($userid, $otheruserid) {
1030         // We want two messages here so we get an accurate 'blocktime' value.
1031         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1032             // Swap the order so we now have them in historical order.
1033             $messages = array_reverse($messages);
1034             $arrmessages = helper::create_messages($userid, $messages);
1035             return array_pop($arrmessages);
1036         }
1038         return null;
1039     }
1041     /**
1042      * Returns the most recent message in a conversation.
1043      *
1044      * @param int $convid The conversation identifier.
1045      * @param int $currentuserid The current user identifier.
1046      * @return \stdClass|null The most recent message.
1047      */
1048     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1049         global $USER;
1051         if (empty($currentuserid)) {
1052             $currentuserid = $USER->id;
1053         }
1055         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1056             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1057             return array_pop($convmessages['messages']);
1058         }
1060         return null;
1061     }
1063     /**
1064      * Returns the profile information for a contact for a user.
1065      *
1066      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1067      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1068      * Followup: MDL-63915
1069      *
1070      * @param int $userid The user id
1071      * @param int $otheruserid The id of the user whose profile we want to view.
1072      * @return \stdClass
1073      */
1074     public static function get_profile($userid, $otheruserid) {
1075         global $CFG, $PAGE;
1077         require_once($CFG->dirroot . '/user/lib.php');
1079         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1081         // Create the data we are going to pass to the renderable.
1082         $data = new \stdClass();
1083         $data->userid = $otheruserid;
1084         $data->fullname = fullname($user);
1085         $data->city = '';
1086         $data->country = '';
1087         $data->email = '';
1088         $data->isonline = null;
1089         // Get the user picture data - messaging has always shown these to the user.
1090         $userpicture = new \user_picture($user);
1091         $userpicture->size = 1; // Size f1.
1092         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1093         $userpicture->size = 0; // Size f2.
1094         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1096         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1097         if ($userfields) {
1098             if (isset($userfields['city'])) {
1099                 $data->city = $userfields['city'];
1100             }
1101             if (isset($userfields['country'])) {
1102                 $data->country = $userfields['country'];
1103             }
1104             if (isset($userfields['email'])) {
1105                 $data->email = $userfields['email'];
1106             }
1107             if (isset($userfields['lastaccess'])) {
1108                 $data->isonline = helper::is_online($userfields['lastaccess']);
1109             }
1110         }
1112         $data->isblocked = self::is_blocked($userid, $otheruserid);
1113         $data->iscontact = self::is_contact($userid, $otheruserid);
1115         return $data;
1116     }
1118     /**
1119      * Checks if a user can delete messages they have either received or sent.
1120      *
1121      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1122      *  but will still seem as if it was by the user)
1123      * @param int $conversationid The id of the conversation
1124      * @return bool Returns true if a user can delete the conversation, false otherwise.
1125      */
1126     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1127         global $USER;
1129         if (is_null($conversationid)) {
1130             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1131                 DEBUG_DEVELOPER);
1132             return false;
1133         }
1135         $systemcontext = \context_system::instance();
1137         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1138             return true;
1139         }
1141         if (!self::is_user_in_conversation($userid, $conversationid)) {
1142             return false;
1143         }
1145         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1146                 $USER->id == $userid) {
1147             return true;
1148         }
1150         return false;
1151     }
1153     /**
1154      * Deletes a conversation.
1155      *
1156      * This function does not verify any permissions.
1157      *
1158      * @deprecated since 3.6
1159      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1160      *  but will still seem as if it was by the user)
1161      * @param int $otheruserid The id of the other user in the conversation
1162      * @return bool
1163      */
1164     public static function delete_conversation($userid, $otheruserid) {
1165         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1166             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1168         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1170         // If there is no conversation, there is nothing to do.
1171         if (!$conversationid) {
1172             return true;
1173         }
1175         self::delete_conversation_by_id($userid, $conversationid);
1177         return true;
1178     }
1180     /**
1181      * Deletes a conversation for a specified user.
1182      *
1183      * This function does not verify any permissions.
1184      *
1185      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1186      *  but will still seem as if it was by the user)
1187      * @param int $conversationid The id of the other user in the conversation
1188      */
1189     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1190         global $DB, $USER;
1192         // Get all messages belonging to this conversation that have not already been deleted by this user.
1193         $sql = "SELECT m.*
1194                  FROM {messages} m
1195            INNER JOIN {message_conversations} mc
1196                    ON m.conversationid = mc.id
1197             LEFT JOIN {message_user_actions} mua
1198                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1199                 WHERE mua.id is NULL
1200                   AND mc.id = ?
1201              ORDER BY m.timecreated ASC";
1202         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1204         // Ok, mark these as deleted.
1205         foreach ($messages as $message) {
1206             $mua = new \stdClass();
1207             $mua->userid = $userid;
1208             $mua->messageid = $message->id;
1209             $mua->action = self::MESSAGE_ACTION_DELETED;
1210             $mua->timecreated = time();
1211             $mua->id = $DB->insert_record('message_user_actions', $mua);
1213             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1214                 $message->id, $mua->id)->trigger();
1215         }
1216     }
1218     /**
1219      * Returns the count of unread conversations (collection of messages from a single user) for
1220      * the given user.
1221      *
1222      * @param \stdClass $user the user who's conversations should be counted
1223      * @return int the count of the user's unread conversations
1224      */
1225     public static function count_unread_conversations($user = null) {
1226         global $USER, $DB;
1228         if (empty($user)) {
1229             $user = $USER;
1230         }
1232         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1233                   FROM {messages} m
1234             INNER JOIN {message_conversations} mc
1235                     ON m.conversationid = mc.id
1236             INNER JOIN {message_conversation_members} mcm
1237                     ON mc.id = mcm.conversationid
1238              LEFT JOIN {message_user_actions} mua
1239                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1240                  WHERE mcm.userid = ?
1241                    AND mcm.userid != m.useridfrom
1242                    AND mua.id is NULL";
1244         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1245     }
1247     /**
1248      * Checks if a user can mark all messages as read.
1249      *
1250      * @param int $userid The user id of who we want to mark the messages for
1251      * @param int $conversationid The id of the conversation
1252      * @return bool true if user is permitted, false otherwise
1253      * @since 3.6
1254      */
1255     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1256         global $USER;
1258         $systemcontext = \context_system::instance();
1260         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1261             return true;
1262         }
1264         if (!self::is_user_in_conversation($userid, $conversationid)) {
1265             return false;
1266         }
1268         if ($USER->id == $userid) {
1269             return true;
1270         }
1272         return false;
1273     }
1275     /**
1276      * Marks all messages being sent to a user in a particular conversation.
1277      *
1278      * If $conversationdid is null then it marks all messages as read sent to $userid.
1279      *
1280      * @param int $userid
1281      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1282      */
1283     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1284         global $DB;
1286         $messagesql = "SELECT m.*
1287                          FROM {messages} m
1288                    INNER JOIN {message_conversations} mc
1289                            ON mc.id = m.conversationid
1290                    INNER JOIN {message_conversation_members} mcm
1291                            ON mcm.conversationid = mc.id
1292                     LEFT JOIN {message_user_actions} mua
1293                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1294                         WHERE mua.id is NULL
1295                           AND mcm.userid = ?
1296                           AND m.useridfrom != ?";
1297         $messageparams = [];
1298         $messageparams[] = $userid;
1299         $messageparams[] = self::MESSAGE_ACTION_READ;
1300         $messageparams[] = $userid;
1301         $messageparams[] = $userid;
1302         if (!is_null($conversationid)) {
1303             $messagesql .= " AND mc.id = ?";
1304             $messageparams[] = $conversationid;
1305         }
1307         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1308         foreach ($messages as $message) {
1309             self::mark_message_as_read($userid, $message);
1310         }
1311         $messages->close();
1312     }
1314     /**
1315      * Marks all notifications being sent from one user to another user as read.
1316      *
1317      * If the from user is null then it marks all notifications as read sent to the to user.
1318      *
1319      * @param int $touserid the id of the message recipient
1320      * @param int|null $fromuserid the id of the message sender, null if all messages
1321      * @return void
1322      */
1323     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1324         global $DB;
1326         $notificationsql = "SELECT n.*
1327                               FROM {notifications} n
1328                              WHERE useridto = ?
1329                                AND timeread is NULL";
1330         $notificationsparams = [$touserid];
1331         if (!empty($fromuserid)) {
1332             $notificationsql .= " AND useridfrom = ?";
1333             $notificationsparams[] = $fromuserid;
1334         }
1336         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1337         foreach ($notifications as $notification) {
1338             self::mark_notification_as_read($notification);
1339         }
1340         $notifications->close();
1341     }
1343     /**
1344      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1345      *
1346      * Can be filtered by type.
1347      *
1348      * @deprecated since 3.5
1349      * @param int $touserid the id of the message recipient
1350      * @param int $fromuserid the id of the message sender
1351      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1352      * @return void
1353      */
1354     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1355         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1356             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1357             DEBUG_DEVELOPER);
1359         $type = strtolower($type);
1361         $conversationid = null;
1362         $ignoremessages = false;
1363         if (!empty($fromuserid)) {
1364             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1365             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1366                 $ignoremessages = true;
1367             }
1368         }
1370         if (!empty($type)) {
1371             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1372                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1373             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1374                 if (!$ignoremessages) {
1375                     self::mark_all_messages_as_read($touserid, $conversationid);
1376                 }
1377             }
1378         } else { // We want both.
1379             self::mark_all_notifications_as_read($touserid, $fromuserid);
1380             if (!$ignoremessages) {
1381                 self::mark_all_messages_as_read($touserid, $conversationid);
1382             }
1383         }
1384     }
1386     /**
1387      * Returns message preferences.
1388      *
1389      * @param array $processors
1390      * @param array $providers
1391      * @param \stdClass $user
1392      * @return \stdClass
1393      * @since 3.2
1394      */
1395     public static function get_all_message_preferences($processors, $providers, $user) {
1396         $preferences = helper::get_providers_preferences($providers, $user->id);
1397         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1399         // For every processors put its options on the form (need to get function from processor's lib.php).
1400         foreach ($processors as $processor) {
1401             $processor->object->load_data($preferences, $user->id);
1402         }
1404         // Load general messaging preferences.
1405         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1406         $preferences->mailformat = $user->mailformat;
1407         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1409         return $preferences;
1410     }
1412     /**
1413      * Count the number of users blocked by a user.
1414      *
1415      * @param \stdClass $user The user object
1416      * @return int the number of blocked users
1417      */
1418     public static function count_blocked_users($user = null) {
1419         global $USER, $DB;
1421         if (empty($user)) {
1422             $user = $USER;
1423         }
1425         $sql = "SELECT count(mub.id)
1426                   FROM {message_users_blocked} mub
1427                  WHERE mub.userid = :userid";
1428         return $DB->count_records_sql($sql, array('userid' => $user->id));
1429     }
1431     /**
1432      * Determines if a user is permitted to send another user a private message.
1433      * If no sender is provided then it defaults to the logged in user.
1434      *
1435      * @param \stdClass $recipient The user object.
1436      * @param \stdClass|null $sender The user object.
1437      * @return bool true if user is permitted, false otherwise.
1438      */
1439     public static function can_post_message($recipient, $sender = null) {
1440         global $USER;
1442         if (is_null($sender)) {
1443             // The message is from the logged in user, unless otherwise specified.
1444             $sender = $USER;
1445         }
1447         $systemcontext = \context_system::instance();
1448         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1449             return false;
1450         }
1452         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1453             return true;
1454         }
1456         // Check if the recipient can be messaged by the sender.
1457         return (self::can_contact_user($recipient->id, $sender->id));
1458     }
1460     /**
1461      * Determines if a user is permitted to send a message to a given conversation.
1462      * If no sender is provided then it defaults to the logged in user.
1463      *
1464      * @param int $userid the id of the user on which the checks will be applied.
1465      * @param int $conversationid the id of the conversation we wish to check.
1466      * @return bool true if the user can send a message to the conversation, false otherwise.
1467      * @throws \moodle_exception
1468      */
1469     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1470         global $DB;
1472         $systemcontext = \context_system::instance();
1473         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1474             return false;
1475         }
1477         if (!self::is_user_in_conversation($userid, $conversationid)) {
1478             return false;
1479         }
1481         // User can post messages and is in the conversation, but we need to check the conversation type to
1482         // know whether or not to check the user privacy settings via can_contact_user().
1483         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1484         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1485             return true;
1486         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1487             // Get the other user in the conversation.
1488             $members = self::get_conversation_members($userid, $conversationid);
1489             $otheruser = array_filter($members, function($member) use($userid) {
1490                 return $member->id != $userid;
1491             });
1492             $otheruser = reset($otheruser);
1494             return self::can_contact_user($otheruser->id, $userid);
1495         } else {
1496             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1497         }
1498     }
1500     /**
1501      * Send a message from a user to a conversation.
1502      *
1503      * This method will create the basic eventdata and delegate to message creation to message_send.
1504      * The message_send() method is responsible for event data that is specific to each recipient.
1505      *
1506      * @param int $userid the sender id.
1507      * @param int $conversationid the conversation id.
1508      * @param string $message the message to send.
1509      * @param int $format the format of the message to send.
1510      * @return \stdClass the message created.
1511      * @throws \coding_exception
1512      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1513      */
1514     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1515                                                         int $format) : \stdClass {
1516         global $DB;
1518         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1519             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1520         }
1522         $eventdata = new \core\message\message();
1523         $eventdata->courseid         = 1;
1524         $eventdata->component        = 'moodle';
1525         $eventdata->name             = 'instantmessage';
1526         $eventdata->userfrom         = $userid;
1527         $eventdata->convid           = $conversationid;
1529         if ($format == FORMAT_HTML) {
1530             $eventdata->fullmessagehtml  = $message;
1531             // Some message processors may revert to sending plain text even if html is supplied,
1532             // so we keep both plain and html versions if we're intending to send html.
1533             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1534         } else {
1535             $eventdata->fullmessage      = $message;
1536             $eventdata->fullmessagehtml  = '';
1537         }
1539         $eventdata->fullmessageformat = $format;
1540         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1542         $eventdata->timecreated     = time();
1543         $eventdata->notification    = 0;
1544         $messageid = message_send($eventdata);
1546         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1547         $message = (object) [
1548             'id' => $messagerecord->id,
1549             'useridfrom' => $messagerecord->useridfrom,
1550             'text' => $messagerecord->fullmessage,
1551             'timecreated' => $messagerecord->timecreated
1552         ];
1553         return $message;
1554     }
1556     /**
1557      * Get the messaging preference for a user.
1558      * If the user has not any messaging privacy preference:
1559      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1560      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1561      *
1562      * @param  int    $userid The user identifier.
1563      * @return int    The default messaging preference.
1564      */
1565     public static function get_user_privacy_messaging_preference(int $userid) : int {
1566         global $CFG;
1568         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1569         // otherwise, the default value will be "My contacts and anyone in my courses".
1570         if (empty($CFG->messagingallusers)) {
1571             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1572         } else {
1573             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1574         }
1575         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
1577         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1578         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1579         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1580             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1581         }
1583         return $privacypreference;
1584     }
1586     /**
1587      * Checks if the recipient is allowing messages from users that aren't a
1588      * contact. If not then it checks to make sure the sender is in the
1589      * recipient's contacts.
1590      *
1591      * @deprecated since 3.6
1592      * @param \stdClass $recipient The user object.
1593      * @param \stdClass|null $sender The user object.
1594      * @return bool true if $sender is blocked, false otherwise.
1595      */
1596     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1597         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1599         global $USER, $CFG;
1601         if (is_null($sender)) {
1602             // The message is from the logged in user, unless otherwise specified.
1603             $sender = $USER;
1604         }
1606         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1607         switch ($privacypreference) {
1608             case self::MESSAGE_PRIVACY_SITE:
1609                 if (!empty($CFG->messagingallusers)) {
1610                     // Users can be messaged without being contacts or members of the same course.
1611                     break;
1612                 }
1613                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1614                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1615             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1616                 // Confirm the sender and the recipient are both members of the same course.
1617                 if (enrol_sharing_course($recipient, $sender)) {
1618                     // All good, the recipient and the sender are members of the same course.
1619                     return false;
1620                 }
1621             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1622                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1623                 return !self::is_contact($sender->id, $recipient->id);
1624         }
1626         return false;
1627     }
1629     /**
1630      * Checks if the recipient has specifically blocked the sending user.
1631      *
1632      * Note: This function will always return false if the sender has the
1633      * readallmessages capability at the system context level.
1634      *
1635      * @deprecated since 3.6
1636      * @param int $recipientid User ID of the recipient.
1637      * @param int $senderid User ID of the sender.
1638      * @return bool true if $sender is blocked, false otherwise.
1639      */
1640     public static function is_user_blocked($recipientid, $senderid = null) {
1641         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1642             DEBUG_DEVELOPER);
1644         global $USER;
1646         if (is_null($senderid)) {
1647             // The message is from the logged in user, unless otherwise specified.
1648             $senderid = $USER->id;
1649         }
1651         $systemcontext = \context_system::instance();
1652         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1653             return false;
1654         }
1656         if (self::is_blocked($recipientid, $senderid)) {
1657             return true;
1658         }
1660         return false;
1661     }
1663     /**
1664      * Get specified message processor, validate corresponding plugin existence and
1665      * system configuration.
1666      *
1667      * @param string $name  Name of the processor.
1668      * @param bool $ready only return ready-to-use processors.
1669      * @return mixed $processor if processor present else empty array.
1670      * @since Moodle 3.2
1671      */
1672     public static function get_message_processor($name, $ready = false) {
1673         global $DB, $CFG;
1675         $processor = $DB->get_record('message_processors', array('name' => $name));
1676         if (empty($processor)) {
1677             // Processor not found, return.
1678             return array();
1679         }
1681         $processor = self::get_processed_processor_object($processor);
1682         if ($ready) {
1683             if ($processor->enabled && $processor->configured) {
1684                 return $processor;
1685             } else {
1686                 return array();
1687             }
1688         } else {
1689             return $processor;
1690         }
1691     }
1693     /**
1694      * Returns weather a given processor is enabled or not.
1695      * Note:- This doesn't check if the processor is configured or not.
1696      *
1697      * @param string $name Name of the processor
1698      * @return bool
1699      */
1700     public static function is_processor_enabled($name) {
1702         $cache = \cache::make('core', 'message_processors_enabled');
1703         $status = $cache->get($name);
1705         if ($status === false) {
1706             $processor = self::get_message_processor($name);
1707             if (!empty($processor)) {
1708                 $cache->set($name, $processor->enabled);
1709                 return $processor->enabled;
1710             } else {
1711                 return false;
1712             }
1713         }
1715         return $status;
1716     }
1718     /**
1719      * Set status of a processor.
1720      *
1721      * @param \stdClass $processor processor record.
1722      * @param 0|1 $enabled 0 or 1 to set the processor status.
1723      * @return bool
1724      * @since Moodle 3.2
1725      */
1726     public static function update_processor_status($processor, $enabled) {
1727         global $DB;
1728         $cache = \cache::make('core', 'message_processors_enabled');
1729         $cache->delete($processor->name);
1730         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1731     }
1733     /**
1734      * Given a processor object, loads information about it's settings and configurations.
1735      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1736      * or @see \get_message_processors()
1737      *
1738      * @param \stdClass $processor processor object
1739      * @return \stdClass processed processor object
1740      * @since Moodle 3.2
1741      */
1742     public static function get_processed_processor_object(\stdClass $processor) {
1743         global $CFG;
1745         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1746         if (is_readable($processorfile)) {
1747             include_once($processorfile);
1748             $processclass = 'message_output_' . $processor->name;
1749             if (class_exists($processclass)) {
1750                 $pclass = new $processclass();
1751                 $processor->object = $pclass;
1752                 $processor->configured = 0;
1753                 if ($pclass->is_system_configured()) {
1754                     $processor->configured = 1;
1755                 }
1756                 $processor->hassettings = 0;
1757                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1758                     $processor->hassettings = 1;
1759                 }
1760                 $processor->available = 1;
1761             } else {
1762                 print_error('errorcallingprocessor', 'message');
1763             }
1764         } else {
1765             $processor->available = 0;
1766         }
1767         return $processor;
1768     }
1770     /**
1771      * Retrieve users blocked by $user1
1772      *
1773      * @param int $userid The user id of the user whos blocked users we are returning
1774      * @return array the users blocked
1775      */
1776     public static function get_blocked_users($userid) {
1777         global $DB;
1779         $userfields = \user_picture::fields('u', array('lastaccess'));
1780         $blockeduserssql = "SELECT $userfields
1781                               FROM {message_users_blocked} mub
1782                         INNER JOIN {user} u
1783                                 ON u.id = mub.blockeduserid
1784                              WHERE u.deleted = 0
1785                                AND mub.userid = ?
1786                           GROUP BY $userfields
1787                           ORDER BY u.firstname ASC";
1788         return $DB->get_records_sql($blockeduserssql, [$userid]);
1789     }
1791     /**
1792      * Mark a single message as read.
1793      *
1794      * @param int $userid The user id who marked the message as read
1795      * @param \stdClass $message The message
1796      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1797      */
1798     public static function mark_message_as_read($userid, $message, $timeread = null) {
1799         global $DB;
1801         if (is_null($timeread)) {
1802             $timeread = time();
1803         }
1805         $mua = new \stdClass();
1806         $mua->userid = $userid;
1807         $mua->messageid = $message->id;
1808         $mua->action = self::MESSAGE_ACTION_READ;
1809         $mua->timecreated = $timeread;
1810         $mua->id = $DB->insert_record('message_user_actions', $mua);
1812         // Get the context for the user who received the message.
1813         $context = \context_user::instance($userid, IGNORE_MISSING);
1814         // If the user no longer exists the context value will be false, in this case use the system context.
1815         if ($context === false) {
1816             $context = \context_system::instance();
1817         }
1819         // Trigger event for reading a message.
1820         $event = \core\event\message_viewed::create(array(
1821             'objectid' => $mua->id,
1822             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1823             'context' => $context,
1824             'relateduserid' => $message->useridfrom,
1825             'other' => array(
1826                 'messageid' => $message->id
1827             )
1828         ));
1829         $event->trigger();
1830     }
1832     /**
1833      * Mark a single notification as read.
1834      *
1835      * @param \stdClass $notification The notification
1836      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1837      */
1838     public static function mark_notification_as_read($notification, $timeread = null) {
1839         global $DB;
1841         if (is_null($timeread)) {
1842             $timeread = time();
1843         }
1845         if (is_null($notification->timeread)) {
1846             $updatenotification = new \stdClass();
1847             $updatenotification->id = $notification->id;
1848             $updatenotification->timeread = $timeread;
1850             $DB->update_record('notifications', $updatenotification);
1852             // Trigger event for reading a notification.
1853             \core\event\notification_viewed::create_from_ids(
1854                 $notification->useridfrom,
1855                 $notification->useridto,
1856                 $notification->id
1857             )->trigger();
1858         }
1859     }
1861     /**
1862      * Checks if a user can delete a message.
1863      *
1864      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1865      *  but will still seem as if it was by the user)
1866      * @param int $messageid The message id
1867      * @return bool Returns true if a user can delete the message, false otherwise.
1868      */
1869     public static function can_delete_message($userid, $messageid) {
1870         global $DB, $USER;
1872         $systemcontext = \context_system::instance();
1874         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
1876         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1877             return true;
1878         }
1880         if (!self::is_user_in_conversation($userid, $conversationid)) {
1881             return false;
1882         }
1884         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1885                 $USER->id == $userid) {
1886             return true;
1887         }
1889         return false;
1890     }
1892     /**
1893      * Deletes a message.
1894      *
1895      * This function does not verify any permissions.
1896      *
1897      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1898      *  but will still seem as if it was by the user)
1899      * @param int $messageid The message id
1900      * @return bool
1901      */
1902     public static function delete_message($userid, $messageid) {
1903         global $DB, $USER;
1905         if (!$DB->record_exists('messages', ['id' => $messageid])) {
1906             return false;
1907         }
1909         // Check if the user has already deleted this message.
1910         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
1911                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
1912             $mua = new \stdClass();
1913             $mua->userid = $userid;
1914             $mua->messageid = $messageid;
1915             $mua->action = self::MESSAGE_ACTION_DELETED;
1916             $mua->timecreated = time();
1917             $mua->id = $DB->insert_record('message_user_actions', $mua);
1919             // Trigger event for deleting a message.
1920             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1921                 $messageid, $mua->id)->trigger();
1923             return true;
1924         }
1926         return false;
1927     }
1929     /**
1930      * Returns the conversation between two users.
1931      *
1932      * @param array $userids
1933      * @return int|bool The id of the conversation, false if not found
1934      */
1935     public static function get_conversation_between_users(array $userids) {
1936         global $DB;
1938         $hash = helper::get_conversation_hash($userids);
1940         $params = [
1941             'type' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1942             'convhash' => $hash
1943         ];
1944         if ($conversation = $DB->get_record('message_conversations', $params)) {
1945             return $conversation->id;
1946         }
1948         return false;
1949     }
1951     /**
1952      * Creates a conversation between two users.
1953      *
1954      * @deprecated since 3.6
1955      * @param array $userids
1956      * @return int The id of the conversation
1957      */
1958     public static function create_conversation_between_users(array $userids) {
1959         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
1960             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
1962         // This method was always used for individual conversations.
1963         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1965         return $conversation->id;
1966     }
1968     /**
1969      * Creates a conversation with selected users and messages.
1970      *
1971      * @param int $type The type of conversation
1972      * @param int[] $userids The array of users to add to the conversation
1973      * @param string|null $name The name of the conversation
1974      * @param int $enabled Determines if the conversation is created enabled or disabled
1975      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
1976      * @param string|null $itemtype Defines the type of the component
1977      * @param int|null $itemid The id of the component
1978      * @param int|null $contextid The id of the context
1979      * @return \stdClass
1980      */
1981     public static function create_conversation(int $type, array $userids, string $name = null,
1982             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
1983             string $itemtype = null, int $itemid = null, int $contextid = null) {
1985         global $DB;
1987         // Sanity check.
1988         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1989             if (count($userids) > 2) {
1990                 throw new \moodle_exception('An individual conversation can not have more than two users.');
1991             }
1992         }
1994         $conversation = new \stdClass();
1995         $conversation->type = $type;
1996         $conversation->name = $name;
1997         $conversation->convhash = null;
1998         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1999             $conversation->convhash = helper::get_conversation_hash($userids);
2000         }
2001         $conversation->component = $component;
2002         $conversation->itemtype = $itemtype;
2003         $conversation->itemid = $itemid;
2004         $conversation->contextid = $contextid;
2005         $conversation->enabled = $enabled;
2006         $conversation->timecreated = time();
2007         $conversation->timemodified = $conversation->timecreated;
2008         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2010         // Add users to this conversation.
2011         $arrmembers = [];
2012         foreach ($userids as $userid) {
2013             $member = new \stdClass();
2014             $member->conversationid = $conversation->id;
2015             $member->userid = $userid;
2016             $member->timecreated = time();
2017             $member->id = $DB->insert_record('message_conversation_members', $member);
2019             $arrmembers[] = $member;
2020         }
2022         $conversation->members = $arrmembers;
2024         return $conversation;
2025     }
2027     /**
2028      * Checks if a user can create a group conversation.
2029      *
2030      * @param int $userid The id of the user attempting to create the conversation
2031      * @param \context $context The context they are creating the conversation from, most likely course context
2032      * @return bool
2033      */
2034     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2035         global $CFG;
2037         // If we can't message at all, then we can't create a conversation.
2038         if (empty($CFG->messaging)) {
2039             return false;
2040         }
2042         // We need to check they have the capability to create the conversation.
2043         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2044     }
2046     /**
2047      * Checks if a user can create a contact request.
2048      *
2049      * @param int $userid The id of the user who is creating the contact request
2050      * @param int $requesteduserid The id of the user being requested
2051      * @return bool
2052      */
2053     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2054         global $CFG;
2056         // If we can't message at all, then we can't create a contact.
2057         if (empty($CFG->messaging)) {
2058             return false;
2059         }
2061         // If we can message anyone on the site then we can create a contact.
2062         if ($CFG->messagingallusers) {
2063             return true;
2064         }
2066         // We need to check if they are in the same course.
2067         return enrol_sharing_course($userid, $requesteduserid);
2068     }
2070     /**
2071      * Handles creating a contact request.
2072      *
2073      * @param int $userid The id of the user who is creating the contact request
2074      * @param int $requesteduserid The id of the user being requested
2075      */
2076     public static function create_contact_request(int $userid, int $requesteduserid) {
2077         global $DB;
2079         $request = new \stdClass();
2080         $request->userid = $userid;
2081         $request->requesteduserid = $requesteduserid;
2082         $request->timecreated = time();
2084         $DB->insert_record('message_contact_requests', $request);
2086         // Send a notification.
2087         $userfrom = \core_user::get_user($userid);
2088         $userfromfullname = fullname($userfrom);
2089         $userto = \core_user::get_user($requesteduserid);
2090         $url = new \moodle_url('/message/pendingcontactrequests.php');
2092         $subject = get_string('messagecontactrequestsnotificationsubject', 'core_message', $userfromfullname);
2093         $fullmessage = get_string('messagecontactrequestsnotification', 'core_message', $userfromfullname);
2095         $message = new \core\message\message();
2096         $message->courseid = SITEID;
2097         $message->component = 'moodle';
2098         $message->name = 'messagecontactrequests';
2099         $message->notification = 1;
2100         $message->userfrom = $userfrom;
2101         $message->userto = $userto;
2102         $message->subject = $subject;
2103         $message->fullmessage = text_to_html($fullmessage);
2104         $message->fullmessageformat = FORMAT_HTML;
2105         $message->fullmessagehtml = $fullmessage;
2106         $message->smallmessage = '';
2107         $message->contexturl = $url->out(false);
2109         message_send($message);
2110     }
2113     /**
2114      * Handles confirming a contact request.
2115      *
2116      * @param int $userid The id of the user who created the contact request
2117      * @param int $requesteduserid The id of the user confirming the request
2118      */
2119     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2120         global $DB;
2122         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2123                 'requesteduserid' => $requesteduserid])) {
2124             self::add_contact($userid, $requesteduserid);
2126             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2127         }
2128     }
2130     /**
2131      * Handles declining a contact request.
2132      *
2133      * @param int $userid The id of the user who created the contact request
2134      * @param int $requesteduserid The id of the user declining the request
2135      */
2136     public static function decline_contact_request(int $userid, int $requesteduserid) {
2137         global $DB;
2139         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2140                 'requesteduserid' => $requesteduserid])) {
2141             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2142         }
2143     }
2145     /**
2146      * Handles returning the contact requests for a user.
2147      *
2148      * This also includes the user data necessary to display information
2149      * about the user.
2150      *
2151      * It will not include blocked users.
2152      *
2153      * @param int $userid
2154      * @param int $limitfrom
2155      * @param int $limitnum
2156      * @return array The list of contact requests
2157      */
2158     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2159         global $DB;
2161         $sql = "SELECT mcr.userid
2162                   FROM {message_contact_requests} mcr
2163              LEFT JOIN {message_users_blocked} mub
2164                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2165                  WHERE mcr.requesteduserid = ?
2166                    AND mub.id is NULL
2167               ORDER BY mcr.timecreated ASC";
2168         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2169             $userids = array_keys($contactrequests);
2170             return helper::get_member_info($userid, $userids);
2171         }
2173         return [];
2174     }
2176     /**
2177      * Handles adding a contact.
2178      *
2179      * @param int $userid The id of the user who requested to be a contact
2180      * @param int $contactid The id of the contact
2181      */
2182     public static function add_contact(int $userid, int $contactid) {
2183         global $DB;
2185         $messagecontact = new \stdClass();
2186         $messagecontact->userid = $userid;
2187         $messagecontact->contactid = $contactid;
2188         $messagecontact->timecreated = time();
2189         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2191         $eventparams = [
2192             'objectid' => $messagecontact->id,
2193             'userid' => $userid,
2194             'relateduserid' => $contactid,
2195             'context' => \context_user::instance($userid)
2196         ];
2197         $event = \core\event\message_contact_added::create($eventparams);
2198         $event->add_record_snapshot('message_contacts', $messagecontact);
2199         $event->trigger();
2200     }
2202     /**
2203      * Handles removing a contact.
2204      *
2205      * @param int $userid The id of the user who is removing a user as a contact
2206      * @param int $contactid The id of the user to be removed as a contact
2207      */
2208     public static function remove_contact(int $userid, int $contactid) {
2209         global $DB;
2211         if ($contact = self::get_contact($userid, $contactid)) {
2212             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2214             $event = \core\event\message_contact_removed::create(array(
2215                 'objectid' => $contact->id,
2216                 'userid' => $userid,
2217                 'relateduserid' => $contactid,
2218                 'context' => \context_user::instance($userid)
2219             ));
2220             $event->add_record_snapshot('message_contacts', $contact);
2221             $event->trigger();
2222         }
2223     }
2225     /**
2226      * Handles blocking a user.
2227      *
2228      * @param int $userid The id of the user who is blocking
2229      * @param int $usertoblockid The id of the user being blocked
2230      */
2231     public static function block_user(int $userid, int $usertoblockid) {
2232         global $DB;
2234         $blocked = new \stdClass();
2235         $blocked->userid = $userid;
2236         $blocked->blockeduserid = $usertoblockid;
2237         $blocked->timecreated = time();
2238         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2240         // Trigger event for blocking a contact.
2241         $event = \core\event\message_user_blocked::create(array(
2242             'objectid' => $blocked->id,
2243             'userid' => $userid,
2244             'relateduserid' => $usertoblockid,
2245             'context' => \context_user::instance($userid)
2246         ));
2247         $event->add_record_snapshot('message_users_blocked', $blocked);
2248         $event->trigger();
2249     }
2251     /**
2252      * Handles unblocking a user.
2253      *
2254      * @param int $userid The id of the user who is unblocking
2255      * @param int $usertounblockid The id of the user being unblocked
2256      */
2257     public static function unblock_user(int $userid, int $usertounblockid) {
2258         global $DB;
2260         if ($blockeduser = $DB->get_record('message_users_blocked',
2261                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2262             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2264             // Trigger event for unblocking a contact.
2265             $event = \core\event\message_user_unblocked::create(array(
2266                 'objectid' => $blockeduser->id,
2267                 'userid' => $userid,
2268                 'relateduserid' => $usertounblockid,
2269                 'context' => \context_user::instance($userid)
2270             ));
2271             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2272             $event->trigger();
2273         }
2274     }
2276     /**
2277      * Checks if users are already contacts.
2278      *
2279      * @param int $userid The id of one of the users
2280      * @param int $contactid The id of the other user
2281      * @return bool Returns true if they are a contact, false otherwise
2282      */
2283     public static function is_contact(int $userid, int $contactid) : bool {
2284         global $DB;
2286         $sql = "SELECT id
2287                   FROM {message_contacts} mc
2288                  WHERE (mc.userid = ? AND mc.contactid = ?)
2289                     OR (mc.userid = ? AND mc.contactid = ?)";
2290         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2291     }
2293     /**
2294      * Returns the row in the database table message_contacts that represents the contact between two people.
2295      *
2296      * @param int $userid The id of one of the users
2297      * @param int $contactid The id of the other user
2298      * @return mixed A fieldset object containing the record, false otherwise
2299      */
2300     public static function get_contact(int $userid, int $contactid) {
2301         global $DB;
2303         $sql = "SELECT mc.*
2304                   FROM {message_contacts} mc
2305                  WHERE (mc.userid = ? AND mc.contactid = ?)
2306                     OR (mc.userid = ? AND mc.contactid = ?)";
2307         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2308     }
2310     /**
2311      * Checks if a user is already blocked.
2312      *
2313      * @param int $userid
2314      * @param int $blockeduserid
2315      * @return bool Returns true if they are a blocked, false otherwise
2316      */
2317     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2318         global $DB;
2320         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2321     }
2323     /**
2324      * Checks if a contact request already exists between users.
2325      *
2326      * @param int $userid The id of the user who is creating the contact request
2327      * @param int $requesteduserid The id of the user being requested
2328      * @return bool Returns true if a contact request exists, false otherwise
2329      */
2330     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2331         global $DB;
2333         $sql = "SELECT id
2334                   FROM {message_contact_requests} mcr
2335                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2336                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2337         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2338     }
2340     /**
2341      * Checks if a user is already in a conversation.
2342      *
2343      * @param int $userid The id of the user we want to check if they are in a group
2344      * @param int $conversationid The id of the conversation
2345      * @return bool Returns true if a contact request exists, false otherwise
2346      */
2347     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2348         global $DB;
2350         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2351             'userid' => $userid]);
2352     }
2354     /**
2355      * Checks if the sender can message the recipient.
2356      *
2357      * @param int $recipientid
2358      * @param int $senderid
2359      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2360      */
2361     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2362         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2363             // The sender has the ability to contact any user across the entire site.
2364             return true;
2365         }
2367         // The initial value of $cancontact is null to indicate that a value has not been determined.
2368         $cancontact = null;
2370         if (self::is_blocked($recipientid, $senderid)) {
2371             // The recipient has specifically blocked this sender.
2372             $cancontact = false;
2373         }
2375         $sharedcourses = null;
2376         if (null === $cancontact) {
2377             // There are three user preference options:
2378             // - Site: Allow anyone not explicitly blocked to contact me;
2379             // - Course members: Allow anyone I am in a course with to contact me; and
2380             // - Contacts: Only allow my contacts to contact me.
2381             //
2382             // The Site option is only possible when the messagingallusers site setting is also enabled.
2384             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2385             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2386                 // The user preference is to allow any user to contact them.
2387                 // No need to check anything else.
2388                 $cancontact = true;
2389             } else {
2390                 // This user only allows their own contacts, and possibly course peers, to contact them.
2391                 // If the users are contacts then we can avoid the more expensive shared courses check.
2392                 $cancontact = self::is_contact($senderid, $recipientid);
2394                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2395                     // The users are not contacts and the user allows course member messaging.
2396                     // Check whether these two users share any course together.
2397                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2398                     $cancontact = (!empty($sharedcourses));
2399                 }
2400             }
2401         }
2403         if (false === $cancontact) {
2404             // At the moment the users cannot contact one another.
2405             // Check whether the messageanyuser capability applies in any of the shared courses.
2406             // This is intended to allow teachers to message students regardless of message settings.
2408             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2409             if (null === $sharedcourses) {
2410                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2411             }
2413             foreach ($sharedcourses as $course) {
2414                 // Note: enrol_get_shared_courses will preload any shared context.
2415                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2416                     $cancontact = true;
2417                     break;
2418                 }
2419             }
2420         }
2422         return $cancontact;
2423     }
2425     /**
2426      * Add some new members to an existing conversation.
2427      *
2428      * @param array $userids User ids array to add as members.
2429      * @param int $convid The conversation id. Must exists.
2430      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2431      * @throws \dml_exception If there is a database error
2432      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2433      */
2434     public static function add_members_to_conversation(array $userids, int $convid) {
2435         global $DB;
2437         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2439         // We can only add members to a group conversation.
2440         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2441             throw new \moodle_exception('You can not add members to a non-group conversation.');
2442         }
2444         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2445         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2446         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2448         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2449         $memberuserids = array_values($DB->get_records_menu(
2450             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2451         );
2453         // Work with existing new members.
2454         $members = array();
2455         $newuserids = array_diff($existingusers, $memberuserids);
2456         foreach ($newuserids as $userid) {
2457             $member = new \stdClass();
2458             $member->conversationid = $convid;
2459             $member->userid = $userid;
2460             $member->timecreated = time();
2461             $members[] = $member;
2462         }
2464         $DB->insert_records('message_conversation_members', $members);
2465     }
2467     /**
2468      * Remove some members from an existing conversation.
2469      *
2470      * @param array $userids The user ids to remove from conversation members.
2471      * @param int $convid The conversation id. Must exists.
2472      * @throws \dml_exception
2473      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2474      */
2475     public static function remove_members_from_conversation(array $userids, int $convid) {
2476         global $DB;
2478         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2480         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2481             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2482         }
2484         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2485         $params['convid'] = $convid;
2487         $DB->delete_records_select('message_conversation_members',
2488             "conversationid = :convid AND userid $useridcondition", $params);
2489     }
2491     /**
2492      * Count conversation members.
2493      *
2494      * @param int $convid The conversation id.
2495      * @return int Number of conversation members.
2496      * @throws \dml_exception
2497      */
2498     public static function count_conversation_members(int $convid) : int {
2499         global $DB;
2501         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2502     }
2504     /**
2505      * Checks whether or not a conversation area is enabled.
2506      *
2507      * @param string $component Defines the Moodle component which the area was added to.
2508      * @param string $itemtype Defines the type of the component.
2509      * @param int $itemid The id of the component.
2510      * @param int $contextid The id of the context.
2511      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2512      */
2513     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2514         global $DB;
2516         return $DB->record_exists('message_conversations',
2517             [
2518                 'itemid' => $itemid,
2519                 'contextid' => $contextid,
2520                 'component' => $component,
2521                 'itemtype' => $itemtype,
2522                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2523             ]
2524         );
2525     }
2527     /**
2528      * Get conversation by area.
2529      *
2530      * @param string $component Defines the Moodle component which the area was added to.
2531      * @param string $itemtype Defines the type of the component.
2532      * @param int $itemid The id of the component.
2533      * @param int $contextid The id of the context.
2534      * @return \stdClass
2535      */
2536     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2537         global $DB;
2539         return $DB->get_record('message_conversations',
2540             [
2541                 'itemid' => $itemid,
2542                 'contextid' => $contextid,
2543                 'component' => $component,
2544                 'itemtype'  => $itemtype
2545             ]
2546         );
2547     }
2549     /**
2550      * Enable a conversation.
2551      *
2552      * @param int $conversationid The id of the conversation.
2553      * @return void
2554      */
2555     public static function enable_conversation(int $conversationid) {
2556         global $DB;
2558         $conversation = new \stdClass();
2559         $conversation->id = $conversationid;
2560         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2561         $conversation->timemodified = time();
2562         $DB->update_record('message_conversations', $conversation);
2563     }
2565     /**
2566      * Disable a conversation.
2567      *
2568      * @param int $conversationid The id of the conversation.
2569      * @return void
2570      */
2571     public static function disable_conversation(int $conversationid) {
2572         global $DB;
2574         $conversation = new \stdClass();
2575         $conversation->id = $conversationid;
2576         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2577         $conversation->timemodified = time();
2578         $DB->update_record('message_conversations', $conversation);
2579     }
2581     /**
2582      * Update the name of a conversation.
2583      *
2584      * @param int $conversationid The id of a conversation.
2585      * @param string $name The main name of the area
2586      * @return void
2587      */
2588     public static function update_conversation_name(int $conversationid, string $name) {
2589         global $DB;
2591         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2592             if ($name <> $conversation->name) {
2593                 $conversation->name = $name;
2594                 $conversation->timemodified = time();
2595                 $DB->update_record('message_conversations', $conversation);
2596             }
2597         }
2598     }
2600     /**
2601      * Returns a list of conversation members.
2602      *
2603      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2604      * @param int $conversationid The id of the conversation
2605      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2606      * @param int $limitfrom
2607      * @param int $limitnum
2608      * @return array
2609      */
2610     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2611                                                     int $limitfrom = 0, int $limitnum = 0) : array {
2612         global $DB;
2614         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2615                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2616             $userids = array_keys($members);
2617             $members = helper::get_member_info($userid, $userids, $includecontactrequests);
2619             return $members;
2620         }
2622         return [];
2623     }