4eccf2be9b0e62f193fb71479c8f516a875a6356
[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      * Handles searching for messages in the message area.
78      *
79      * @param int $userid The user id doing the searching
80      * @param string $search The string the user is searching
81      * @param int $limitfrom
82      * @param int $limitnum
83      * @return array
84      */
85     public static function search_messages($userid, $search, $limitfrom = 0, $limitnum = 0) {
86         global $DB;
88         // Get the user fields we want.
89         $ufields = \user_picture::fields('u', array('lastaccess'), 'userfrom_id', 'userfrom_');
90         $ufields2 = \user_picture::fields('u2', array('lastaccess'), 'userto_id', 'userto_');
92         $sql = "SELECT m.id, m.useridfrom, mcm.userid as useridto, m.subject, m.fullmessage, m.fullmessagehtml, m.fullmessageformat,
93                        m.smallmessage, m.timecreated, 0 as isread, $ufields, mub.id as userfrom_blocked, $ufields2,
94                        mub2.id as userto_blocked
95                   FROM {messages} m
96             INNER JOIN {user} u
97                     ON u.id = m.useridfrom
98             INNER JOIN {message_conversations} mc
99                     ON mc.id = m.conversationid
100             INNER JOIN {message_conversation_members} mcm
101                     ON mcm.conversationid = m.conversationid
102             INNER JOIN {user} u2
103                     ON u2.id = mcm.userid
104              LEFT JOIN {message_users_blocked} mub
105                     ON (mub.blockeduserid = u.id AND mub.userid = ?)
106              LEFT JOIN {message_users_blocked} mub2
107                     ON (mub2.blockeduserid = u2.id AND mub2.userid = ?)
108              LEFT JOIN {message_user_actions} mua
109                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
110                  WHERE (m.useridfrom = ? OR mcm.userid = ?)
111                    AND m.useridfrom != mcm.userid
112                    AND u.deleted = 0
113                    AND u2.deleted = 0
114                    AND mua.id is NULL
115                    AND " . $DB->sql_like('smallmessage', '?', false) . "
116               ORDER BY timecreated DESC";
118         $params = array($userid, $userid, $userid, self::MESSAGE_ACTION_DELETED, $userid, $userid, '%' . $search . '%');
120         // Convert the messages into searchable contacts with their last message being the message that was searched.
121         $conversations = array();
122         if ($messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
123             foreach ($messages as $message) {
124                 $prefix = 'userfrom_';
125                 if ($userid == $message->useridfrom) {
126                     $prefix = 'userto_';
127                     // If it from the user, then mark it as read, even if it wasn't by the receiver.
128                     $message->isread = true;
129                 }
130                 $blockedcol = $prefix . 'blocked';
131                 $message->blocked = $message->$blockedcol ? 1 : 0;
133                 $message->messageid = $message->id;
134                 $conversations[] = helper::create_contact($message, $prefix);
135             }
136         }
138         return $conversations;
139     }
141     /**
142      * Handles searching for user in a particular course in the message area.
143      *
144      * @param int $userid The user id doing the searching
145      * @param int $courseid The id of the course we are searching in
146      * @param string $search The string the user is searching
147      * @param int $limitfrom
148      * @param int $limitnum
149      * @return array
150      */
151     public static function search_users_in_course($userid, $courseid, $search, $limitfrom = 0, $limitnum = 0) {
152         global $DB;
154         // Get all the users in the course.
155         list($esql, $params) = get_enrolled_sql(\context_course::instance($courseid), '', 0, true);
156         $sql = "SELECT u.*, mub.id as isblocked
157                   FROM {user} u
158                   JOIN ($esql) je
159                     ON je.id = u.id
160              LEFT JOIN {message_users_blocked} mub
161                     ON (mub.blockeduserid = u.id AND mub.userid = :userid)
162                  WHERE u.deleted = 0";
163         // Add more conditions.
164         $fullname = $DB->sql_fullname();
165         $sql .= " AND u.id != :userid2
166                   AND " . $DB->sql_like($fullname, ':search', false) . "
167              ORDER BY " . $DB->sql_fullname();
168         $params = array_merge(array('userid' => $userid, 'userid2' => $userid, 'search' => '%' . $search . '%'), $params);
170         // Convert all the user records into contacts.
171         $contacts = array();
172         if ($users = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
173             foreach ($users as $user) {
174                 $user->blocked = $user->isblocked ? 1 : 0;
175                 $contacts[] = helper::create_contact($user);
176             }
177         }
179         return $contacts;
180     }
182     /**
183      * Handles searching for user in the message area.
184      *
185      * @param int $userid The user id doing the searching
186      * @param string $search The string the user is searching
187      * @param int $limitnum
188      * @return array
189      */
190     public static function search_users($userid, $search, $limitnum = 0) {
191         global $CFG, $DB;
193         // Used to search for contacts.
194         $fullname = $DB->sql_fullname();
195         $ufields = \user_picture::fields('u', array('lastaccess'));
197         // Users not to include.
198         $excludeusers = array($userid, $CFG->siteguest);
199         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
201         // Ok, let's search for contacts first.
202         $contacts = array();
203         $sql = "SELECT $ufields, mub.id as isuserblocked
204                   FROM {user} u
205                   JOIN {message_contacts} mc
206                     ON u.id = mc.contactid
207              LEFT JOIN {message_users_blocked} mub
208                     ON (mub.userid = :userid2 AND mub.blockeduserid = u.id)
209                  WHERE mc.userid = :userid
210                    AND u.deleted = 0
211                    AND u.confirmed = 1
212                    AND " . $DB->sql_like($fullname, ':search', false) . "
213                    AND u.id $exclude
214               ORDER BY " . $DB->sql_fullname();
215         if ($users = $DB->get_records_sql($sql, array('userid' => $userid, 'userid2' => $userid,
216                 'search' => '%' . $search . '%') + $excludeparams, 0, $limitnum)) {
217             foreach ($users as $user) {
218                 $user->blocked = $user->isuserblocked ? 1 : 0;
219                 $contacts[] = helper::create_contact($user);
220             }
221         }
223         // Now, let's get the courses.
224         // Make sure to limit searches to enrolled courses.
225         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
226         $courses = array();
227         // Really we want the user to be able to view the participants if they have the capability
228         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
229         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
230         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
231         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
232                 array('moodle/course:viewparticipants'))) {
233             foreach ($arrcourses as $course) {
234                 if (isset($enrolledcourses[$course->id])) {
235                     $data = new \stdClass();
236                     $data->id = $course->id;
237                     $data->shortname = $course->shortname;
238                     $data->fullname = $course->fullname;
239                     $courses[] = $data;
240                 }
241             }
242         }
244         // Let's get those non-contacts. Toast them gears boi.
245         // Note - you can only block contacts, so these users will not be blocked, so no need to get that
246         // extra detail from the database.
247         $noncontacts = array();
248         $sql = "SELECT $ufields
249                   FROM {user} u
250                  WHERE u.deleted = 0
251                    AND u.confirmed = 1
252                    AND " . $DB->sql_like($fullname, ':search', false) . "
253                    AND u.id $exclude
254                    AND u.id NOT IN (SELECT contactid
255                                       FROM {message_contacts}
256                                      WHERE userid = :userid)
257               ORDER BY " . $DB->sql_fullname();
258         if ($users = $DB->get_records_sql($sql,  array('userid' => $userid, 'search' => '%' . $search . '%') + $excludeparams,
259                 0, $limitnum)) {
260             foreach ($users as $user) {
261                 $noncontacts[] = helper::create_contact($user);
262             }
263         }
265         return array($contacts, $courses, $noncontacts);
266     }
268     /**
269      * Returns the contacts and their conversation to display in the contacts area.
270      *
271      * ** WARNING **
272      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
273      * to retrieve too much information in a single call will cause performance problems.
274      * ** WARNING **
275      *
276      * This function has specifically been altered to break each of the data sets it
277      * requires into separate database calls. This is to avoid the performance problems
278      * observed when attempting to join large data sets (e.g. the message tables and
279      * the user table).
280      *
281      * While it is possible to gather the data in a single query, and it may even be
282      * more efficient with a correctly tuned database, we have opted to trade off some of
283      * the benefits of a single query in order to ensure this function will work on
284      * most databases with default tunings and with large data sets.
285      *
286      * @param int $userid The user id
287      * @param int $limitfrom
288      * @param int $limitnum
289      * @param int $type the conversation type.
290      * @param bool $favouritesonly whether to retrieve only the favourite conversations for the user, or not.
291      * @return array
292      */
293     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20, int $type = null,
294             bool $favouritesonly = false) {
295         global $DB;
297         $favouritesql = "";
298         $favouriteparams = [];
299         if ($favouritesonly) {
300             // Ask the favourites subsystem for the user's favourite conversations.
301             $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
302             $favourites = $service->find_favourites_by_type('core_message', 'message_conversations');
303             if (empty($favourites)) {
304                 return []; // No favourited conversations, so return none.
305             }
306             $favids = array_values(array_map(function ($fav) {
307                 return $fav->itemid;
308             }, $favourites));
309             list ($insql, $inparams) = $DB->get_in_or_equal($favids, SQL_PARAMS_NAMED, 'favouriteids');
310             $favouritesql = " AND m.conversationid {$insql} ";
311             $favouriteparams = $inparams;
312         }
314         // Get the last message from each conversation that the user belongs to.
315         $sql = "SELECT m.id, m.conversationid, m.useridfrom, mcm2.userid as useridto, m.smallmessage, m.timecreated
316                   FROM {messages} m
317             INNER JOIN (
318                           SELECT MAX(m.id) AS messageid
319                             FROM {messages} m
320                       INNER JOIN (
321                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
322                                         FROM {messages} m
323                                   INNER JOIN {message_conversation_members} mcm
324                                           ON mcm.conversationid = m.conversationid
325                                    LEFT JOIN {message_user_actions} mua
326                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
327                                        WHERE mua.id is NULL
328                                          AND mcm.userid = :userid2
329                                     GROUP BY m.conversationid
330                                  ) maxmessage
331                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
332                          GROUP BY m.conversationid
333                        ) lastmessage
334                     ON lastmessage.messageid = m.id
335             INNER JOIN {message_conversation_members} mcm
336                     ON mcm.conversationid = m.conversationid
337             INNER JOIN {message_conversation_members} mcm2
338                     ON mcm2.conversationid = m.conversationid
339                  WHERE mcm.userid = m.useridfrom
340                    AND mcm.id != mcm2.id $favouritesql
341               ORDER BY m.timecreated DESC";
343         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
344             'userid2' => $userid]);
345         $messageset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
347         $messages = [];
348         foreach ($messageset as $message) {
349             $messages[$message->id] = $message;
350         }
351         $messageset->close();
353         // If there are no messages return early.
354         if (empty($messages)) {
355             return [];
356         }
358         // We need to pull out the list of other users that are part of each of these conversations. This
359         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
360         // tables because on large sites these tables are massive which results in extremely slow
361         // performance (typically due to join buffer exhaustion).
362         $otheruserids = array_map(function($message) use ($userid) {
363             return ($message->useridfrom == $userid) ? $message->useridto : $message->useridfrom;
364         }, array_values($messages));
366         // Ok, let's get the other members in the conversations.
367         list($useridsql, $usersparams) = $DB->get_in_or_equal($otheruserids);
368         $userfields = \user_picture::fields('u', array('lastaccess'));
369         $userssql = "SELECT $userfields
370                        FROM {user} u
371                       WHERE id $useridsql
372                         AND deleted = 0";
373         $otherusers = $DB->get_records_sql($userssql, $usersparams);
375         // If there are no other users (user may have been deleted), then do not continue.
376         if (empty($otherusers)) {
377             return [];
378         }
380         $contactssql = "SELECT contactid
381                           FROM {message_contacts}
382                          WHERE userid = ?
383                            AND contactid $useridsql";
384         $contacts = $DB->get_records_sql($contactssql, array_merge([$userid], $usersparams));
386         // Finally, let's get the unread messages count for this user so that we can add them
387         // to the conversation. Remember we need to ignore the messages the user sent.
388         $unreadcountssql = 'SELECT m.useridfrom, count(m.id) as count
389                               FROM {messages} m
390                         INNER JOIN {message_conversations} mc
391                                 ON mc.id = m.conversationid
392                         INNER JOIN {message_conversation_members} mcm
393                                 ON m.conversationid = mcm.conversationid
394                          LEFT JOIN {message_user_actions} mua
395                                 ON (mua.messageid = m.id AND mua.userid = ? AND
396                                    (mua.action = ? OR mua.action = ?))
397                              WHERE mcm.userid = ?
398                                AND m.useridfrom != ?
399                                AND mua.id is NULL
400                           GROUP BY useridfrom';
401         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
402             $userid, $userid]);
404         // Get rid of the table prefix.
405         $userfields = str_replace('u.', '', $userfields);
406         $userproperties = explode(',', $userfields);
407         $arrconversations = array();
408         foreach ($messages as $message) {
409             $conversation = new \stdClass();
410             $otheruserid = ($message->useridfrom == $userid) ? $message->useridto : $message->useridfrom;
411             $otheruser = isset($otherusers[$otheruserid]) ? $otherusers[$otheruserid] : null;
412             $contact = isset($contacts[$otheruserid]) ? $contacts[$otheruserid] : null;
414             // It's possible the other user was deleted, so, skip.
415             if (is_null($otheruser)) {
416                 continue;
417             }
419             // Add the other user's information to the conversation, if we have one.
420             foreach ($userproperties as $prop) {
421                 $conversation->$prop = ($otheruser) ? $otheruser->$prop : null;
422             }
424             // Add the contact's information, if we have one.
425             $conversation->blocked = ($contact) ? $contact->blocked : null;
427             // Add the message information.
428             $conversation->messageid = $message->id;
429             $conversation->smallmessage = $message->smallmessage;
430             $conversation->useridfrom = $message->useridfrom;
432             // Only consider it unread if $user has unread messages.
433             if (isset($unreadcounts[$otheruserid])) {
434                 $conversation->isread = false;
435                 $conversation->unreadcount = $unreadcounts[$otheruserid]->count;
436             } else {
437                 $conversation->isread = true;
438             }
440             $arrconversations[$otheruserid] = helper::create_contact($conversation);
441         }
443         return $arrconversations;
444     }
446     /**
447      * Mark a conversation as a favourite for the given user.
448      *
449      * @param int $conversationid the id of the conversation to mark as a favourite.
450      * @param int $userid the id of the user to whom the favourite belongs.
451      * @return favourite the favourite object.
452      * @throws \moodle_exception if the user or conversation don't exist.
453      */
454     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
455         if (!self::is_user_in_conversation($userid, $conversationid)) {
456             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
457         }
458         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
459         return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
460     }
462     /**
463      * Unset a conversation as a favourite for the given user.
464      *
465      * @param int $conversationid the id of the conversation to unset as a favourite.
466      * @param int $userid the id to whom the favourite belongs.
467      * @throws \moodle_exception if the favourite does not exist for the user.
468      */
469     public static function unset_favourite_conversation(int $conversationid, int $userid) {
470         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
471         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
472     }
474     /**
475      * Returns the contacts to display in the contacts area.
476      *
477      * @param int $userid The user id
478      * @param int $limitfrom
479      * @param int $limitnum
480      * @return array
481      */
482     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
483         global $DB;
485         $contactids = [];
486         $sql = "SELECT mc.*
487                   FROM {message_contacts} mc
488                  WHERE mc.userid = ? OR mc.contactid = ?
489               ORDER BY timecreated DESC";
490         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
491             foreach ($contacts as $contact) {
492                 if ($userid == $contact->userid) {
493                     $contactids[] = $contact->contactid;
494                 } else {
495                     $contactids[] = $contact->userid;
496                 }
497             }
498         }
500         if (!empty($contactids)) {
501             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
503             $sql = "SELECT u.*, mub.id as isblocked
504                       FROM {user} u
505                  LEFT JOIN {message_users_blocked} mub
506                         ON u.id = mub.blockeduserid
507                      WHERE u.id $insql";
508             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
509                 $arrcontacts = [];
510                 foreach ($contacts as $contact) {
511                     $contact->blocked = $contact->isblocked ? 1 : 0;
512                     $arrcontacts[] = helper::create_contact($contact);
513                 }
515                 return $arrcontacts;
516             }
517         }
519         return [];
520     }
522     /**
523      * Returns the an array of the users the given user is in a conversation
524      * with who are a contact and the number of unread messages.
525      *
526      * @param int $userid The user id
527      * @param int $limitfrom
528      * @param int $limitnum
529      * @return array
530      */
531     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
532         global $DB;
534         $userfields = \user_picture::fields('u', array('lastaccess'));
535         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
536                               FROM {message_contacts} mc
537                         INNER JOIN {user} u
538                                 ON (u.id = mc.contactid OR u.id = mc.userid)
539                          LEFT JOIN {messages} m
540                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
541                          LEFT JOIN {message_conversation_members} mcm
542                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
543                          LEFT JOIN {message_user_actions} mua
544                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
545                          LEFT JOIN {message_users_blocked} mub
546                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
547                              WHERE mua.id is NULL
548                                AND mub.id is NULL
549                                AND (mc.userid = ? OR mc.contactid = ?)
550                                AND u.id != ?
551                                AND u.deleted = 0
552                           GROUP BY $userfields";
554         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
555             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
556     }
558     /**
559      * Returns the an array of the users the given user is in a conversation
560      * with who are not a contact and the number of unread messages.
561      *
562      * @param int $userid The user id
563      * @param int $limitfrom
564      * @param int $limitnum
565      * @return array
566      */
567     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
568         global $DB;
570         $userfields = \user_picture::fields('u', array('lastaccess'));
571         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
572                               FROM {user} u
573                         INNER JOIN {messages} m
574                                 ON m.useridfrom = u.id
575                         INNER JOIN {message_conversation_members} mcm
576                                 ON mcm.conversationid = m.conversationid
577                          LEFT JOIN {message_user_actions} mua
578                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
579                          LEFT JOIN {message_contacts} mc
580                                 ON (mc.userid = ? AND mc.contactid = u.id)
581                          LEFT JOIN {message_users_blocked} mub
582                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
583                              WHERE mcm.userid = ?
584                                AND mcm.userid != m.useridfrom
585                                AND mua.id is NULL
586                                AND mub.id is NULL
587                                AND mc.id is NULL
588                                AND u.deleted = 0
589                           GROUP BY $userfields";
591         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
592             $limitfrom, $limitnum);
593     }
595     /**
596      * Returns the messages to display in the message area.
597      *
598      * @param int $userid the current user
599      * @param int $otheruserid the other user
600      * @param int $limitfrom
601      * @param int $limitnum
602      * @param string $sort
603      * @param int $timefrom the time from the message being sent
604      * @param int $timeto the time up until the message being sent
605      * @return array
606      */
607     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
608         $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
610         if (!empty($timefrom)) {
611             // Get the conversation between userid and otheruserid.
612             $userids = [$userid, $otheruserid];
613             if (!$conversationid = self::get_conversation_between_users($userids)) {
614                 // This method was always used for individual conversations.
615                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
616                 $conversationid = $conversation->id;
617             }
619             // Check the cache to see if we even need to do a DB query.
620             $cache = \cache::make('core', 'message_time_last_message_in_conversation');
621             $lastcreated = $cache->get($conversationid);
623             // The last known message time is earlier than the one being requested so we can
624             // just return an empty result set rather than having to query the DB.
625             if ($lastcreated && $lastcreated < $timefrom) {
626                 return [];
627             }
628         }
630         $arrmessages = array();
631         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
632                                              $sort, $timefrom, $timeto)) {
633             $arrmessages = helper::create_messages($userid, $messages);
634         }
636         return $arrmessages;
637     }
639     /**
640      * Returns the messages for the defined conversation.
641      *
642      * @param  int $userid The current user.
643      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
644      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
645      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
646      * @param  string $sort The column name to order by including optionally direction.
647      * @param  int $timefrom The time from the message being sent.
648      * @param  int $timeto The time up until the message being sent.
649      * @return array of messages
650      */
651     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
652         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
654         if (!empty($timefrom)) {
655             // Check the cache to see if we even need to do a DB query.
656             $cache = \cache::make('core', 'message_time_last_message_in_conversation');
657             $lastcreated = $cache->get($convid);
659             // The last known message time is earlier than the one being requested so we can
660             // just return an empty result set rather than having to query the DB.
661             if ($lastcreated && $lastcreated < $timefrom) {
662                 return [];
663             }
664         }
666         $arrmessages = array();
667         if ($messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto)) {
668             $arrmessages = helper::format_conversation_messages($userid, $convid, $messages);
669         }
671         return $arrmessages;
672     }
674     /**
675      * Returns the most recent message between two users.
676      *
677      * @param int $userid the current user
678      * @param int $otheruserid the other user
679      * @return \stdClass|null
680      */
681     public static function get_most_recent_message($userid, $otheruserid) {
682         // We want two messages here so we get an accurate 'blocktime' value.
683         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
684             // Swap the order so we now have them in historical order.
685             $messages = array_reverse($messages);
686             $arrmessages = helper::create_messages($userid, $messages);
687             return array_pop($arrmessages);
688         }
690         return null;
691     }
693     /**
694      * Returns the most recent message in a conversation.
695      *
696      * @param int $convid The conversation identifier.
697      * @param int $currentuserid The current user identifier.
698      * @return \stdClass|null The most recent message.
699      */
700     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
701         global $USER;
703         if (empty($currentuserid)) {
704             $currentuserid = $USER->id;
705         }
707         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
708             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
709             return array_pop($convmessages['messages']);
710         }
712         return null;
713     }
715     /**
716      * Returns the profile information for a contact for a user.
717      *
718      * @param int $userid The user id
719      * @param int $otheruserid The id of the user whose profile we want to view.
720      * @return \stdClass
721      */
722     public static function get_profile($userid, $otheruserid) {
723         global $CFG, $PAGE;
725         require_once($CFG->dirroot . '/user/lib.php');
727         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
729         // Create the data we are going to pass to the renderable.
730         $data = new \stdClass();
731         $data->userid = $otheruserid;
732         $data->fullname = fullname($user);
733         $data->city = '';
734         $data->country = '';
735         $data->email = '';
736         $data->isonline = null;
737         // Get the user picture data - messaging has always shown these to the user.
738         $userpicture = new \user_picture($user);
739         $userpicture->size = 1; // Size f1.
740         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
741         $userpicture->size = 0; // Size f2.
742         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
744         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
745         if ($userfields) {
746             if (isset($userfields['city'])) {
747                 $data->city = $userfields['city'];
748             }
749             if (isset($userfields['country'])) {
750                 $data->country = $userfields['country'];
751             }
752             if (isset($userfields['email'])) {
753                 $data->email = $userfields['email'];
754             }
755             if (isset($userfields['lastaccess'])) {
756                 $data->isonline = helper::is_online($userfields['lastaccess']);
757             }
758         }
760         $data->isblocked = self::is_blocked($userid, $otheruserid);
761         $data->iscontact = self::is_contact($userid, $otheruserid);
763         return $data;
764     }
766     /**
767      * Checks if a user can delete messages they have either received or sent.
768      *
769      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
770      *  but will still seem as if it was by the user)
771      * @param int $conversationid The id of the conversation
772      * @return bool Returns true if a user can delete the conversation, false otherwise.
773      */
774     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
775         global $USER;
777         if (is_null($conversationid)) {
778             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
779                 DEBUG_DEVELOPER);
780             return false;
781         }
783         $systemcontext = \context_system::instance();
785         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
786             return true;
787         }
789         if (!self::is_user_in_conversation($userid, $conversationid)) {
790             return false;
791         }
793         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
794                 $USER->id == $userid) {
795             return true;
796         }
798         return false;
799     }
801     /**
802      * Deletes a conversation.
803      *
804      * This function does not verify any permissions.
805      *
806      * @deprecated since 3.6
807      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
808      *  but will still seem as if it was by the user)
809      * @param int $otheruserid The id of the other user in the conversation
810      * @return bool
811      */
812     public static function delete_conversation($userid, $otheruserid) {
813         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
814             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
816         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
818         // If there is no conversation, there is nothing to do.
819         if (!$conversationid) {
820             return true;
821         }
823         self::delete_conversation_by_id($userid, $conversationid);
825         return true;
826     }
828     /**
829      * Deletes a conversation for a specified user.
830      *
831      * This function does not verify any permissions.
832      *
833      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
834      *  but will still seem as if it was by the user)
835      * @param int $conversationid The id of the other user in the conversation
836      */
837     public static function delete_conversation_by_id(int $userid, int $conversationid) {
838         global $DB, $USER;
840         // Get all messages belonging to this conversation that have not already been deleted by this user.
841         $sql = "SELECT m.*
842                  FROM {messages} m
843            INNER JOIN {message_conversations} mc
844                    ON m.conversationid = mc.id
845             LEFT JOIN {message_user_actions} mua
846                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
847                 WHERE mua.id is NULL
848                   AND mc.id = ?
849              ORDER BY m.timecreated ASC";
850         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
852         // Ok, mark these as deleted.
853         foreach ($messages as $message) {
854             $mua = new \stdClass();
855             $mua->userid = $userid;
856             $mua->messageid = $message->id;
857             $mua->action = self::MESSAGE_ACTION_DELETED;
858             $mua->timecreated = time();
859             $mua->id = $DB->insert_record('message_user_actions', $mua);
861             \core\event\message_deleted::create_from_ids($userid, $USER->id,
862                 $message->id, $mua->id)->trigger();
863         }
864     }
866     /**
867      * Returns the count of unread conversations (collection of messages from a single user) for
868      * the given user.
869      *
870      * @param \stdClass $user the user who's conversations should be counted
871      * @return int the count of the user's unread conversations
872      */
873     public static function count_unread_conversations($user = null) {
874         global $USER, $DB;
876         if (empty($user)) {
877             $user = $USER;
878         }
880         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
881                   FROM {messages} m
882             INNER JOIN {message_conversations} mc
883                     ON m.conversationid = mc.id
884             INNER JOIN {message_conversation_members} mcm
885                     ON mc.id = mcm.conversationid
886              LEFT JOIN {message_user_actions} mua
887                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
888                  WHERE mcm.userid = ?
889                    AND mcm.userid != m.useridfrom
890                    AND mua.id is NULL";
892         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
893     }
895     /**
896      * Checks if a user can mark all messages as read.
897      *
898      * @param int $userid The user id of who we want to mark the messages for
899      * @param int $conversationid The id of the conversation
900      * @return bool true if user is permitted, false otherwise
901      * @since 3.6
902      */
903     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
904         global $USER;
906         $systemcontext = \context_system::instance();
908         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
909             return true;
910         }
912         if (!self::is_user_in_conversation($userid, $conversationid)) {
913             return false;
914         }
916         if ($USER->id == $userid) {
917             return true;
918         }
920         return false;
921     }
923     /**
924      * Marks all messages being sent to a user in a particular conversation.
925      *
926      * If $conversationdid is null then it marks all messages as read sent to $userid.
927      *
928      * @param int $userid
929      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
930      */
931     public static function mark_all_messages_as_read($userid, $conversationid = null) {
932         global $DB;
934         $messagesql = "SELECT m.*
935                          FROM {messages} m
936                    INNER JOIN {message_conversations} mc
937                            ON mc.id = m.conversationid
938                    INNER JOIN {message_conversation_members} mcm
939                            ON mcm.conversationid = mc.id
940                     LEFT JOIN {message_user_actions} mua
941                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
942                         WHERE mua.id is NULL
943                           AND mcm.userid = ?
944                           AND m.useridfrom != ?";
945         $messageparams = [];
946         $messageparams[] = $userid;
947         $messageparams[] = self::MESSAGE_ACTION_READ;
948         $messageparams[] = $userid;
949         $messageparams[] = $userid;
950         if (!is_null($conversationid)) {
951             $messagesql .= " AND mc.id = ?";
952             $messageparams[] = $conversationid;
953         }
955         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
956         foreach ($messages as $message) {
957             self::mark_message_as_read($userid, $message);
958         }
959         $messages->close();
960     }
962     /**
963      * Marks all notifications being sent from one user to another user as read.
964      *
965      * If the from user is null then it marks all notifications as read sent to the to user.
966      *
967      * @param int $touserid the id of the message recipient
968      * @param int|null $fromuserid the id of the message sender, null if all messages
969      * @return void
970      */
971     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
972         global $DB;
974         $notificationsql = "SELECT n.*
975                               FROM {notifications} n
976                              WHERE useridto = ?
977                                AND timeread is NULL";
978         $notificationsparams = [$touserid];
979         if (!empty($fromuserid)) {
980             $notificationsql .= " AND useridfrom = ?";
981             $notificationsparams[] = $fromuserid;
982         }
984         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
985         foreach ($notifications as $notification) {
986             self::mark_notification_as_read($notification);
987         }
988         $notifications->close();
989     }
991     /**
992      * Marks ALL messages being sent from $fromuserid to $touserid as read.
993      *
994      * Can be filtered by type.
995      *
996      * @deprecated since 3.5
997      * @param int $touserid the id of the message recipient
998      * @param int $fromuserid the id of the message sender
999      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1000      * @return void
1001      */
1002     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1003         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1004             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1005             DEBUG_DEVELOPER);
1007         $type = strtolower($type);
1009         $conversationid = null;
1010         $ignoremessages = false;
1011         if (!empty($fromuserid)) {
1012             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1013             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1014                 $ignoremessages = true;
1015             }
1016         }
1018         if (!empty($type)) {
1019             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1020                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1021             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1022                 if (!$ignoremessages) {
1023                     self::mark_all_messages_as_read($touserid, $conversationid);
1024                 }
1025             }
1026         } else { // We want both.
1027             self::mark_all_notifications_as_read($touserid, $fromuserid);
1028             if (!$ignoremessages) {
1029                 self::mark_all_messages_as_read($touserid, $conversationid);
1030             }
1031         }
1032     }
1034     /**
1035      * Returns message preferences.
1036      *
1037      * @param array $processors
1038      * @param array $providers
1039      * @param \stdClass $user
1040      * @return \stdClass
1041      * @since 3.2
1042      */
1043     public static function get_all_message_preferences($processors, $providers, $user) {
1044         $preferences = helper::get_providers_preferences($providers, $user->id);
1045         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1047         // For every processors put its options on the form (need to get function from processor's lib.php).
1048         foreach ($processors as $processor) {
1049             $processor->object->load_data($preferences, $user->id);
1050         }
1052         // Load general messaging preferences.
1053         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1054         $preferences->mailformat = $user->mailformat;
1055         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1057         return $preferences;
1058     }
1060     /**
1061      * Count the number of users blocked by a user.
1062      *
1063      * @param \stdClass $user The user object
1064      * @return int the number of blocked users
1065      */
1066     public static function count_blocked_users($user = null) {
1067         global $USER, $DB;
1069         if (empty($user)) {
1070             $user = $USER;
1071         }
1073         $sql = "SELECT count(mub.id)
1074                   FROM {message_users_blocked} mub
1075                  WHERE mub.userid = :userid";
1076         return $DB->count_records_sql($sql, array('userid' => $user->id));
1077     }
1079     /**
1080      * Determines if a user is permitted to send another user a private message.
1081      * If no sender is provided then it defaults to the logged in user.
1082      *
1083      * @param \stdClass $recipient The user object.
1084      * @param \stdClass|null $sender The user object.
1085      * @return bool true if user is permitted, false otherwise.
1086      */
1087     public static function can_post_message($recipient, $sender = null) {
1088         global $USER;
1090         if (is_null($sender)) {
1091             // The message is from the logged in user, unless otherwise specified.
1092             $sender = $USER;
1093         }
1095         $systemcontext = \context_system::instance();
1096         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1097             return false;
1098         }
1100         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1101             return true;
1102         }
1104         // Check if the recipient can be messaged by the sender.
1105         return (self::can_contact_user($recipient, $sender));
1106     }
1108     /**
1109      * Get the messaging preference for a user.
1110      * If the user has not any messaging privacy preference:
1111      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1112      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1113      *
1114      * @param  int    $userid The user identifier.
1115      * @return int    The default messaging preference.
1116      */
1117     public static function get_user_privacy_messaging_preference(int $userid) : int {
1118         global $CFG;
1120         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1121         // otherwise, the default value will be "My contacts and anyone in my courses".
1122         if (empty($CFG->messagingallusers)) {
1123             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1124         } else {
1125             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1126         }
1127         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
1129         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1130         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1131         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1132             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1133         }
1135         return $privacypreference;
1136     }
1138     /**
1139      * Checks if the recipient is allowing messages from users that aren't a
1140      * contact. If not then it checks to make sure the sender is in the
1141      * recipient's contacts.
1142      *
1143      * @deprecated since 3.6
1144      * @param \stdClass $recipient The user object.
1145      * @param \stdClass|null $sender The user object.
1146      * @return bool true if $sender is blocked, false otherwise.
1147      */
1148     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1149         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1151         global $USER, $CFG;
1153         if (is_null($sender)) {
1154             // The message is from the logged in user, unless otherwise specified.
1155             $sender = $USER;
1156         }
1158         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1159         switch ($privacypreference) {
1160             case self::MESSAGE_PRIVACY_SITE:
1161                 if (!empty($CFG->messagingallusers)) {
1162                     // Users can be messaged without being contacts or members of the same course.
1163                     break;
1164                 }
1165                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1166                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1167             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1168                 // Confirm the sender and the recipient are both members of the same course.
1169                 if (enrol_sharing_course($recipient, $sender)) {
1170                     // All good, the recipient and the sender are members of the same course.
1171                     return false;
1172                 }
1173             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1174                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1175                 return !self::is_contact($sender->id, $recipient->id);
1176         }
1178         return false;
1179     }
1181     /**
1182      * Checks if the recipient has specifically blocked the sending user.
1183      *
1184      * Note: This function will always return false if the sender has the
1185      * readallmessages capability at the system context level.
1186      *
1187      * @deprecated since 3.6
1188      * @param int $recipientid User ID of the recipient.
1189      * @param int $senderid User ID of the sender.
1190      * @return bool true if $sender is blocked, false otherwise.
1191      */
1192     public static function is_user_blocked($recipientid, $senderid = null) {
1193         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1194             DEBUG_DEVELOPER);
1196         global $USER;
1198         if (is_null($senderid)) {
1199             // The message is from the logged in user, unless otherwise specified.
1200             $senderid = $USER->id;
1201         }
1203         $systemcontext = \context_system::instance();
1204         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1205             return false;
1206         }
1208         if (self::is_blocked($recipientid, $senderid)) {
1209             return true;
1210         }
1212         return false;
1213     }
1215     /**
1216      * Get specified message processor, validate corresponding plugin existence and
1217      * system configuration.
1218      *
1219      * @param string $name  Name of the processor.
1220      * @param bool $ready only return ready-to-use processors.
1221      * @return mixed $processor if processor present else empty array.
1222      * @since Moodle 3.2
1223      */
1224     public static function get_message_processor($name, $ready = false) {
1225         global $DB, $CFG;
1227         $processor = $DB->get_record('message_processors', array('name' => $name));
1228         if (empty($processor)) {
1229             // Processor not found, return.
1230             return array();
1231         }
1233         $processor = self::get_processed_processor_object($processor);
1234         if ($ready) {
1235             if ($processor->enabled && $processor->configured) {
1236                 return $processor;
1237             } else {
1238                 return array();
1239             }
1240         } else {
1241             return $processor;
1242         }
1243     }
1245     /**
1246      * Returns weather a given processor is enabled or not.
1247      * Note:- This doesn't check if the processor is configured or not.
1248      *
1249      * @param string $name Name of the processor
1250      * @return bool
1251      */
1252     public static function is_processor_enabled($name) {
1254         $cache = \cache::make('core', 'message_processors_enabled');
1255         $status = $cache->get($name);
1257         if ($status === false) {
1258             $processor = self::get_message_processor($name);
1259             if (!empty($processor)) {
1260                 $cache->set($name, $processor->enabled);
1261                 return $processor->enabled;
1262             } else {
1263                 return false;
1264             }
1265         }
1267         return $status;
1268     }
1270     /**
1271      * Set status of a processor.
1272      *
1273      * @param \stdClass $processor processor record.
1274      * @param 0|1 $enabled 0 or 1 to set the processor status.
1275      * @return bool
1276      * @since Moodle 3.2
1277      */
1278     public static function update_processor_status($processor, $enabled) {
1279         global $DB;
1280         $cache = \cache::make('core', 'message_processors_enabled');
1281         $cache->delete($processor->name);
1282         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1283     }
1285     /**
1286      * Given a processor object, loads information about it's settings and configurations.
1287      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1288      * or @see \get_message_processors()
1289      *
1290      * @param \stdClass $processor processor object
1291      * @return \stdClass processed processor object
1292      * @since Moodle 3.2
1293      */
1294     public static function get_processed_processor_object(\stdClass $processor) {
1295         global $CFG;
1297         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1298         if (is_readable($processorfile)) {
1299             include_once($processorfile);
1300             $processclass = 'message_output_' . $processor->name;
1301             if (class_exists($processclass)) {
1302                 $pclass = new $processclass();
1303                 $processor->object = $pclass;
1304                 $processor->configured = 0;
1305                 if ($pclass->is_system_configured()) {
1306                     $processor->configured = 1;
1307                 }
1308                 $processor->hassettings = 0;
1309                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1310                     $processor->hassettings = 1;
1311                 }
1312                 $processor->available = 1;
1313             } else {
1314                 print_error('errorcallingprocessor', 'message');
1315             }
1316         } else {
1317             $processor->available = 0;
1318         }
1319         return $processor;
1320     }
1322     /**
1323      * Retrieve users blocked by $user1
1324      *
1325      * @param int $userid The user id of the user whos blocked users we are returning
1326      * @return array the users blocked
1327      */
1328     public static function get_blocked_users($userid) {
1329         global $DB;
1331         $userfields = \user_picture::fields('u', array('lastaccess'));
1332         $blockeduserssql = "SELECT $userfields
1333                               FROM {message_users_blocked} mub
1334                         INNER JOIN {user} u
1335                                 ON u.id = mub.blockeduserid
1336                              WHERE u.deleted = 0
1337                                AND mub.userid = ?
1338                           GROUP BY $userfields
1339                           ORDER BY u.firstname ASC";
1340         return $DB->get_records_sql($blockeduserssql, [$userid]);
1341     }
1343     /**
1344      * Mark a single message as read.
1345      *
1346      * @param int $userid The user id who marked the message as read
1347      * @param \stdClass $message The message
1348      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1349      */
1350     public static function mark_message_as_read($userid, $message, $timeread = null) {
1351         global $DB;
1353         if (is_null($timeread)) {
1354             $timeread = time();
1355         }
1357         $mua = new \stdClass();
1358         $mua->userid = $userid;
1359         $mua->messageid = $message->id;
1360         $mua->action = self::MESSAGE_ACTION_READ;
1361         $mua->timecreated = $timeread;
1362         $mua->id = $DB->insert_record('message_user_actions', $mua);
1364         // Get the context for the user who received the message.
1365         $context = \context_user::instance($userid, IGNORE_MISSING);
1366         // If the user no longer exists the context value will be false, in this case use the system context.
1367         if ($context === false) {
1368             $context = \context_system::instance();
1369         }
1371         // Trigger event for reading a message.
1372         $event = \core\event\message_viewed::create(array(
1373             'objectid' => $mua->id,
1374             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1375             'context' => $context,
1376             'relateduserid' => $message->useridfrom,
1377             'other' => array(
1378                 'messageid' => $message->id
1379             )
1380         ));
1381         $event->trigger();
1382     }
1384     /**
1385      * Mark a single notification as read.
1386      *
1387      * @param \stdClass $notification The notification
1388      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1389      */
1390     public static function mark_notification_as_read($notification, $timeread = null) {
1391         global $DB;
1393         if (is_null($timeread)) {
1394             $timeread = time();
1395         }
1397         if (is_null($notification->timeread)) {
1398             $updatenotification = new \stdClass();
1399             $updatenotification->id = $notification->id;
1400             $updatenotification->timeread = $timeread;
1402             $DB->update_record('notifications', $updatenotification);
1404             // Trigger event for reading a notification.
1405             \core\event\notification_viewed::create_from_ids(
1406                 $notification->useridfrom,
1407                 $notification->useridto,
1408                 $notification->id
1409             )->trigger();
1410         }
1411     }
1413     /**
1414      * Checks if a user can delete a message.
1415      *
1416      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1417      *  but will still seem as if it was by the user)
1418      * @param int $messageid The message id
1419      * @return bool Returns true if a user can delete the message, false otherwise.
1420      */
1421     public static function can_delete_message($userid, $messageid) {
1422         global $DB, $USER;
1424         $systemcontext = \context_system::instance();
1426         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
1428         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1429             return true;
1430         }
1432         if (!self::is_user_in_conversation($userid, $conversationid)) {
1433             return false;
1434         }
1436         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1437                 $USER->id == $userid) {
1438             return true;
1439         }
1441         return false;
1442     }
1444     /**
1445      * Deletes a message.
1446      *
1447      * This function does not verify any permissions.
1448      *
1449      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1450      *  but will still seem as if it was by the user)
1451      * @param int $messageid The message id
1452      * @return bool
1453      */
1454     public static function delete_message($userid, $messageid) {
1455         global $DB, $USER;
1457         if (!$DB->record_exists('messages', ['id' => $messageid])) {
1458             return false;
1459         }
1461         // Check if the user has already deleted this message.
1462         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
1463                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
1464             $mua = new \stdClass();
1465             $mua->userid = $userid;
1466             $mua->messageid = $messageid;
1467             $mua->action = self::MESSAGE_ACTION_DELETED;
1468             $mua->timecreated = time();
1469             $mua->id = $DB->insert_record('message_user_actions', $mua);
1471             // Trigger event for deleting a message.
1472             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1473                 $messageid, $mua->id)->trigger();
1475             return true;
1476         }
1478         return false;
1479     }
1481     /**
1482      * Returns the conversation between two users.
1483      *
1484      * @param array $userids
1485      * @return int|bool The id of the conversation, false if not found
1486      */
1487     public static function get_conversation_between_users(array $userids) {
1488         global $DB;
1490         $hash = helper::get_conversation_hash($userids);
1492         $params = [
1493             'type' => self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
1494             'convhash' => $hash
1495         ];
1496         if ($conversation = $DB->get_record('message_conversations', $params)) {
1497             return $conversation->id;
1498         }
1500         return false;
1501     }
1503     /**
1504      * Creates a conversation between two users.
1505      *
1506      * @deprecated since 3.6
1507      * @param array $userids
1508      * @return int The id of the conversation
1509      */
1510     public static function create_conversation_between_users(array $userids) {
1511         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
1512             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
1514         // This method was always used for individual conversations.
1515         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
1517         return $conversation->id;
1518     }
1520     /**
1521      * Creates a conversation with selected users and messages.
1522      *
1523      * @param int $type The type of conversation
1524      * @param int[] $userids The array of users to add to the conversation
1525      * @param string $name The name of the conversation
1526      * @return \stdClass
1527      */
1528     public static function create_conversation(int $type, array $userids, string $name = null) {
1529         global $DB;
1531         // Sanity check.
1532         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1533             if (count($userids) > 2) {
1534                 throw new \moodle_exception('An individual conversation can not have more than two users.');
1535             }
1536         }
1538         $conversation = new \stdClass();
1539         $conversation->type = $type;
1540         $conversation->name = $name;
1541         $conversation->convhash = null;
1542         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1543             $conversation->convhash = helper::get_conversation_hash($userids);
1544         }
1545         $conversation->timecreated = time();
1546         $conversation->id = $DB->insert_record('message_conversations', $conversation);
1548         // Add users to this conversation.
1549         $arrmembers = [];
1550         foreach ($userids as $userid) {
1551             $member = new \stdClass();
1552             $member->conversationid = $conversation->id;
1553             $member->userid = $userid;
1554             $member->timecreated = time();
1555             $member->id = $DB->insert_record('message_conversation_members', $member);
1557             $arrmembers[] = $member;
1558         }
1560         $conversation->members = $arrmembers;
1562         return $conversation;
1563     }
1565     /**
1566      * Checks if a user can create a group conversation.
1567      *
1568      * @param int $userid The id of the user attempting to create the conversation
1569      * @param \context $context The context they are creating the conversation from, most likely course context
1570      * @return bool
1571      */
1572     public static function can_create_group_conversation(int $userid, \context $context) : bool {
1573         global $CFG;
1575         // If we can't message at all, then we can't create a conversation.
1576         if (empty($CFG->messaging)) {
1577             return false;
1578         }
1580         // We need to check they have the capability to create the conversation.
1581         return has_capability('moodle/course:creategroupconversations', $context, $userid);
1582     }
1584     /**
1585      * Checks if a user can create a contact request.
1586      *
1587      * @param int $userid The id of the user who is creating the contact request
1588      * @param int $requesteduserid The id of the user being requested
1589      * @return bool
1590      */
1591     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
1592         global $CFG;
1594         // If we can't message at all, then we can't create a contact.
1595         if (empty($CFG->messaging)) {
1596             return false;
1597         }
1599         // If we can message anyone on the site then we can create a contact.
1600         if ($CFG->messagingallusers) {
1601             return true;
1602         }
1604         // We need to check if they are in the same course.
1605         return enrol_sharing_course($userid, $requesteduserid);
1606     }
1608     /**
1609      * Handles creating a contact request.
1610      *
1611      * @param int $userid The id of the user who is creating the contact request
1612      * @param int $requesteduserid The id of the user being requested
1613      */
1614     public static function create_contact_request(int $userid, int $requesteduserid) {
1615         global $DB;
1617         $request = new \stdClass();
1618         $request->userid = $userid;
1619         $request->requesteduserid = $requesteduserid;
1620         $request->timecreated = time();
1622         $DB->insert_record('message_contact_requests', $request);
1624         // Send a notification.
1625         $userfrom = \core_user::get_user($userid);
1626         $userfromfullname = fullname($userfrom);
1627         $userto = \core_user::get_user($requesteduserid);
1628         $url = new \moodle_url('/message/pendingcontactrequests.php');
1630         $subject = get_string('messagecontactrequestsnotificationsubject', 'core_message', $userfromfullname);
1631         $fullmessage = get_string('messagecontactrequestsnotification', 'core_message', $userfromfullname);
1633         $message = new \core\message\message();
1634         $message->courseid = SITEID;
1635         $message->component = 'moodle';
1636         $message->name = 'messagecontactrequests';
1637         $message->notification = 1;
1638         $message->userfrom = $userfrom;
1639         $message->userto = $userto;
1640         $message->subject = $subject;
1641         $message->fullmessage = text_to_html($fullmessage);
1642         $message->fullmessageformat = FORMAT_HTML;
1643         $message->fullmessagehtml = $fullmessage;
1644         $message->smallmessage = '';
1645         $message->contexturl = $url->out(false);
1647         message_send($message);
1648     }
1651     /**
1652      * Handles confirming a contact request.
1653      *
1654      * @param int $userid The id of the user who created the contact request
1655      * @param int $requesteduserid The id of the user confirming the request
1656      */
1657     public static function confirm_contact_request(int $userid, int $requesteduserid) {
1658         global $DB;
1660         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
1661                 'requesteduserid' => $requesteduserid])) {
1662             self::add_contact($userid, $requesteduserid);
1664             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
1665         }
1666     }
1668     /**
1669      * Handles declining a contact request.
1670      *
1671      * @param int $userid The id of the user who created the contact request
1672      * @param int $requesteduserid The id of the user declining the request
1673      */
1674     public static function decline_contact_request(int $userid, int $requesteduserid) {
1675         global $DB;
1677         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
1678                 'requesteduserid' => $requesteduserid])) {
1679             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
1680         }
1681     }
1683     /**
1684      * Handles returning the contact requests for a user.
1685      *
1686      * This also includes the user data necessary to display information
1687      * about the user.
1688      *
1689      * It will not include blocked users.
1690      *
1691      * @param int $userid
1692      * @return array The list of contact requests
1693      */
1694     public static function get_contact_requests(int $userid) : array {
1695         global $DB;
1697         // Used to search for contacts.
1698         $ufields = \user_picture::fields('u');
1700         $sql = "SELECT $ufields, mcr.id as contactrequestid
1701                   FROM {user} u
1702                   JOIN {message_contact_requests} mcr
1703                     ON u.id = mcr.userid
1704              LEFT JOIN {message_users_blocked} mub
1705                     ON (mub.userid = ? AND mub.blockeduserid = u.id)
1706                  WHERE mcr.requesteduserid = ?
1707                    AND u.deleted = 0
1708                    AND mub.id is NULL
1709               ORDER BY mcr.timecreated DESC";
1711         return $DB->get_records_sql($sql, [$userid, $userid]);
1712     }
1714     /**
1715      * Handles adding a contact.
1716      *
1717      * @param int $userid The id of the user who requested to be a contact
1718      * @param int $contactid The id of the contact
1719      */
1720     public static function add_contact(int $userid, int $contactid) {
1721         global $DB;
1723         $messagecontact = new \stdClass();
1724         $messagecontact->userid = $userid;
1725         $messagecontact->contactid = $contactid;
1726         $messagecontact->timecreated = time();
1727         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
1729         $eventparams = [
1730             'objectid' => $messagecontact->id,
1731             'userid' => $userid,
1732             'relateduserid' => $contactid,
1733             'context' => \context_user::instance($userid)
1734         ];
1735         $event = \core\event\message_contact_added::create($eventparams);
1736         $event->add_record_snapshot('message_contacts', $messagecontact);
1737         $event->trigger();
1738     }
1740     /**
1741      * Handles removing a contact.
1742      *
1743      * @param int $userid The id of the user who is removing a user as a contact
1744      * @param int $contactid The id of the user to be removed as a contact
1745      */
1746     public static function remove_contact(int $userid, int $contactid) {
1747         global $DB;
1749         if ($contact = self::get_contact($userid, $contactid)) {
1750             $DB->delete_records('message_contacts', ['id' => $contact->id]);
1752             $event = \core\event\message_contact_removed::create(array(
1753                 'objectid' => $contact->id,
1754                 'userid' => $userid,
1755                 'relateduserid' => $contactid,
1756                 'context' => \context_user::instance($userid)
1757             ));
1758             $event->add_record_snapshot('message_contacts', $contact);
1759             $event->trigger();
1760         }
1761     }
1763     /**
1764      * Handles blocking a user.
1765      *
1766      * @param int $userid The id of the user who is blocking
1767      * @param int $usertoblockid The id of the user being blocked
1768      */
1769     public static function block_user(int $userid, int $usertoblockid) {
1770         global $DB;
1772         $blocked = new \stdClass();
1773         $blocked->userid = $userid;
1774         $blocked->blockeduserid = $usertoblockid;
1775         $blocked->timecreated = time();
1776         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
1778         // Trigger event for blocking a contact.
1779         $event = \core\event\message_user_blocked::create(array(
1780             'objectid' => $blocked->id,
1781             'userid' => $userid,
1782             'relateduserid' => $usertoblockid,
1783             'context' => \context_user::instance($userid)
1784         ));
1785         $event->add_record_snapshot('message_users_blocked', $blocked);
1786         $event->trigger();
1787     }
1789     /**
1790      * Handles unblocking a user.
1791      *
1792      * @param int $userid The id of the user who is unblocking
1793      * @param int $usertounblockid The id of the user being unblocked
1794      */
1795     public static function unblock_user(int $userid, int $usertounblockid) {
1796         global $DB;
1798         if ($blockeduser = $DB->get_record('message_users_blocked',
1799                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
1800             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
1802             // Trigger event for unblocking a contact.
1803             $event = \core\event\message_user_unblocked::create(array(
1804                 'objectid' => $blockeduser->id,
1805                 'userid' => $userid,
1806                 'relateduserid' => $usertounblockid,
1807                 'context' => \context_user::instance($userid)
1808             ));
1809             $event->add_record_snapshot('message_users_blocked', $blockeduser);
1810             $event->trigger();
1811         }
1812     }
1814     /**
1815      * Checks if users are already contacts.
1816      *
1817      * @param int $userid The id of one of the users
1818      * @param int $contactid The id of the other user
1819      * @return bool Returns true if they are a contact, false otherwise
1820      */
1821     public static function is_contact(int $userid, int $contactid) : bool {
1822         global $DB;
1824         $sql = "SELECT id
1825                   FROM {message_contacts} mc
1826                  WHERE (mc.userid = ? AND mc.contactid = ?)
1827                     OR (mc.userid = ? AND mc.contactid = ?)";
1828         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
1829     }
1831     /**
1832      * Returns the row in the database table message_contacts that represents the contact between two people.
1833      *
1834      * @param int $userid The id of one of the users
1835      * @param int $contactid The id of the other user
1836      * @return mixed A fieldset object containing the record, false otherwise
1837      */
1838     public static function get_contact(int $userid, int $contactid) {
1839         global $DB;
1841         $sql = "SELECT mc.*
1842                   FROM {message_contacts} mc
1843                  WHERE (mc.userid = ? AND mc.contactid = ?)
1844                     OR (mc.userid = ? AND mc.contactid = ?)";
1845         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
1846     }
1848     /**
1849      * Checks if a user is already blocked.
1850      *
1851      * @param int $userid
1852      * @param int $blockeduserid
1853      * @return bool Returns true if they are a blocked, false otherwise
1854      */
1855     public static function is_blocked(int $userid, int $blockeduserid) : bool {
1856         global $DB;
1858         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
1859     }
1861     /**
1862      * Checks if a contact request already exists between users.
1863      *
1864      * @param int $userid The id of the user who is creating the contact request
1865      * @param int $requesteduserid The id of the user being requested
1866      * @return bool Returns true if a contact request exists, false otherwise
1867      */
1868     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
1869         global $DB;
1871         $sql = "SELECT id
1872                   FROM {message_contact_requests} mcr
1873                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
1874                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
1875         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
1876     }
1878     /**
1879      * Checks if a user is already in a conversation.
1880      *
1881      * @param int $userid The id of the user we want to check if they are in a group
1882      * @param int $conversationid The id of the conversation
1883      * @return bool Returns true if a contact request exists, false otherwise
1884      */
1885     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
1886         global $DB;
1888         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
1889             'userid' => $userid]);
1890     }
1892     /**
1893      * Checks if the sender can message the recipient.
1894      *
1895      * @param \stdClass $recipient The user object.
1896      * @param \stdClass $sender The user object.
1897      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
1898      */
1899     protected static function can_contact_user(\stdClass $recipient, \stdClass $sender) : bool {
1900         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $sender->id)) {
1901             // The sender has the ability to contact any user across the entire site.
1902             return true;
1903         }
1905         // The initial value of $cancontact is null to indicate that a value has not been determined.
1906         $cancontact = null;
1908         if (self::is_blocked($recipient->id, $sender->id)) {
1909             // The recipient has specifically blocked this sender.
1910             $cancontact = false;
1911         }
1913         $sharedcourses = null;
1914         if (null === $cancontact) {
1915             // There are three user preference options:
1916             // - Site: Allow anyone not explicitly blocked to contact me;
1917             // - Course members: Allow anyone I am in a course with to contact me; and
1918             // - Contacts: Only allow my contacts to contact me.
1919             //
1920             // The Site option is only possible when the messagingallusers site setting is also enabled.
1922             $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1923             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
1924                 // The user preference is to allow any user to contact them.
1925                 // No need to check anything else.
1926                 $cancontact = true;
1927             } else {
1928                 // This user only allows their own contacts, and possibly course peers, to contact them.
1929                 // If the users are contacts then we can avoid the more expensive shared courses check.
1930                 $cancontact = self::is_contact($sender->id, $recipient->id);
1932                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
1933                     // The users are not contacts and the user allows course member messaging.
1934                     // Check whether these two users share any course together.
1935                     $sharedcourses = enrol_get_shared_courses($recipient->id, $sender->id, true);
1936                     $cancontact = (!empty($sharedcourses));
1937                 }
1938             }
1939         }
1941         if (false === $cancontact) {
1942             // At the moment the users cannot contact one another.
1943             // Check whether the messageanyuser capability applies in any of the shared courses.
1944             // This is intended to allow teachers to message students regardless of message settings.
1946             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
1947             if (null === $sharedcourses) {
1948                 $sharedcourses = enrol_get_shared_courses($recipient->id, $sender->id, true);
1949             }
1951             foreach ($sharedcourses as $course) {
1952                 // Note: enrol_get_shared_courses will preload any shared context.
1953                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $sender->id)) {
1954                     $cancontact = true;
1955                     break;
1956                 }
1957             }
1958         }
1960         return $cancontact;
1961     }
1963     /**
1964      * Add some new members to an existing conversation.
1965      *
1966      * @param array $userids User ids array to add as members.
1967      * @param int $convid The conversation id. Must exists.
1968      * @throws \dml_missing_record_exception If convid conversation doesn't exist
1969      * @throws \dml_exception If there is a database error
1970      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
1971      */
1972     public static function add_members_to_conversation(array $userids, int $convid) {
1973         global $DB;
1975         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
1977         // We can only add members to a group conversation.
1978         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1979             throw new \moodle_exception('You can not add members to a non-group conversation.');
1980         }
1982         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
1983         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
1984         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
1986         // Be sure we are not adding a user is already member of the conversation. Take all the members.
1987         $memberuserids = array_values($DB->get_records_menu(
1988             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
1989         );
1991         // Work with existing new members.
1992         $members = array();
1993         $newuserids = array_diff($existingusers, $memberuserids);
1994         foreach ($newuserids as $userid) {
1995             $member = new \stdClass();
1996             $member->conversationid = $convid;
1997             $member->userid = $userid;
1998             $member->timecreated = time();
1999             $members[] = $member;
2000         }
2002         $DB->insert_records('message_conversation_members', $members);
2003     }
2005     /**
2006      * Remove some members from an existing conversation.
2007      *
2008      * @param array $userids The user ids to remove from conversation members.
2009      * @param int $convid The conversation id. Must exists.
2010      * @throws \dml_exception
2011      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2012      */
2013     public static function remove_members_from_conversation(array $userids, int $convid) {
2014         global $DB;
2016         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2018         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2019             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2020         }
2022         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2023         $params['convid'] = $convid;
2025         $DB->delete_records_select('message_conversation_members',
2026             "conversationid = :convid AND userid $useridcondition", $params);
2027     }
2029     /**
2030      * Count conversation members.
2031      *
2032      * @param int $convid The conversation id.
2033      * @return int Number of conversation members.
2034      * @throws \dml_exception
2035      */
2036     public static function count_conversation_members(int $convid) : int {
2037         global $DB;
2039         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2040     }