MDL-63303 message: add count_conversations to api
[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         // Ok, let's search for contacts first.
222         $contacts = array();
223         $sql = "SELECT $ufields, mub.id as isuserblocked
224                   FROM {user} u
225                   JOIN {message_contacts} mc
226                     ON u.id = mc.contactid
227              LEFT JOIN {message_users_blocked} mub
228                     ON (mub.userid = :userid2 AND mub.blockeduserid = u.id)
229                  WHERE mc.userid = :userid
230                    AND u.deleted = 0
231                    AND u.confirmed = 1
232                    AND " . $DB->sql_like($fullname, ':search', false) . "
233                    AND u.id $exclude
234               ORDER BY " . $DB->sql_fullname();
235         if ($users = $DB->get_records_sql($sql, array('userid' => $userid, 'userid2' => $userid,
236                 'search' => '%' . $search . '%') + $excludeparams, 0, $limitnum)) {
237             foreach ($users as $user) {
238                 $user->blocked = $user->isuserblocked ? 1 : 0;
239                 $contacts[] = helper::create_contact($user);
240             }
241         }
243         // Now, let's get the courses.
244         // Make sure to limit searches to enrolled courses.
245         $enrolledcourses = enrol_get_my_courses(array('id', 'cacherev'));
246         $courses = array();
247         // Really we want the user to be able to view the participants if they have the capability
248         // 'moodle/course:viewparticipants' or 'moodle/course:enrolreview', but since the search_courses function
249         // only takes required parameters we can't. However, the chance of a user having 'moodle/course:enrolreview' but
250         // *not* 'moodle/course:viewparticipants' are pretty much zero, so it is not worth addressing.
251         if ($arrcourses = \core_course_category::search_courses(array('search' => $search), array('limit' => $limitnum),
252                 array('moodle/course:viewparticipants'))) {
253             foreach ($arrcourses as $course) {
254                 if (isset($enrolledcourses[$course->id])) {
255                     $data = new \stdClass();
256                     $data->id = $course->id;
257                     $data->shortname = $course->shortname;
258                     $data->fullname = $course->fullname;
259                     $courses[] = $data;
260                 }
261             }
262         }
264         // Let's get those non-contacts. Toast them gears boi.
265         // Note - you can only block contacts, so these users will not be blocked, so no need to get that
266         // extra detail from the database.
267         $noncontacts = array();
268         $sql = "SELECT $ufields
269                   FROM {user} u
270                  WHERE u.deleted = 0
271                    AND u.confirmed = 1
272                    AND " . $DB->sql_like($fullname, ':search', false) . "
273                    AND u.id $exclude
274                    AND u.id NOT IN (SELECT contactid
275                                       FROM {message_contacts}
276                                      WHERE userid = :userid)
277               ORDER BY " . $DB->sql_fullname();
278         if ($users = $DB->get_records_sql($sql,  array('userid' => $userid, 'search' => '%' . $search . '%') + $excludeparams,
279                 0, $limitnum)) {
280             foreach ($users as $user) {
281                 $noncontacts[] = helper::create_contact($user);
282             }
283         }
285         return array($contacts, $courses, $noncontacts);
286     }
288     /**
289      * Handles searching for user.
290      *
291      * @param int $userid The user id doing the searching
292      * @param string $search The string the user is searching
293      * @param int $limitfrom
294      * @param int $limitnum
295      * @return array
296      */
297     public static function message_search_users(int $userid, string $search, int $limitfrom = 0, int $limitnum = 20) : array {
298         global $CFG, $DB;
300         // Check if messaging is enabled.
301         if (empty($CFG->messaging)) {
302             throw new \moodle_exception('disabled', 'message');
303         }
305         // Used to search for contacts.
306         $fullname = $DB->sql_fullname();
308         // Users not to include.
309         $excludeusers = array($userid, $CFG->siteguest);
310         list($exclude, $excludeparams) = $DB->get_in_or_equal($excludeusers, SQL_PARAMS_NAMED, 'param', false);
312         $params = array('search' => '%' . $search . '%', 'userid1' => $userid, 'userid2' => $userid);
314         // Ok, let's search for contacts first.
315         $sql = "SELECT u.id
316                   FROM {user} u
317                   JOIN {message_contacts} mc
318                     ON (u.id = mc.contactid AND mc.userid = :userid1) OR (u.id = mc.userid AND mc.contactid = :userid2)
319                  WHERE u.deleted = 0
320                    AND u.confirmed = 1
321                    AND " . $DB->sql_like($fullname, ':search', false) . "
322                    AND u.id $exclude
323               ORDER BY " . $DB->sql_fullname();
324         $foundusers = $DB->get_records_sql_menu($sql, $params + $excludeparams, $limitfrom, $limitnum);
326         $orderedcontacts = array();
327         if (!empty($foundusers)) {
328             $contacts = helper::get_member_info($userid, array_keys($foundusers));
329             // The get_member_info returns an associative array, so is not ordered in the same way.
330             // We need to reorder it again based on query's result.
331             foreach ($foundusers as $key => $value) {
332                 $contact = $contacts[$key];
333                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
334                 $orderedcontacts[] = $contact;
335             }
336         }
338         // Let's get those non-contacts.
339         // If site wide messaging is enabled, we just fetch any matched users which are non-contacts.
340         if ($CFG->messagingallusers) {
341             $sql = "SELECT u.id
342                   FROM {user} u
343                  WHERE u.deleted = 0
344                    AND u.confirmed = 1
345                    AND " . $DB->sql_like($fullname, ':search', false) . "
346                    AND u.id $exclude
347                    AND NOT EXISTS (SELECT mc.id
348                                      FROM {message_contacts} mc
349                                     WHERE (mc.userid = u.id AND mc.contactid = :userid1)
350                                        OR (mc.userid = :userid2 AND mc.contactid = u.id))
351               ORDER BY " . $DB->sql_fullname();
353             $foundusers = $DB->get_records_sql($sql, $params + $excludeparams, $limitfrom, $limitnum);
354         } else {
355             require_once($CFG->dirroot . '/user/lib.php');
356             // If site-wide messaging is disabled, then we should only be able to search for users who we are allowed to see.
357             // Because we can't achieve all the required visibility checks in SQL, we'll iterate through the non-contact records
358             // and stop once we have enough matching the 'visible' criteria.
359             // TODO: MDL-63983 - Improve the performance of non-contact searches when site-wide messaging is disabled (default).
361             // Use a local generator to achieve this iteration.
362             $getnoncontactusers = function ($limitfrom = 0, $limitnum = 0) use($fullname, $exclude, $params, $excludeparams) {
363                 global $DB;
364                 $sql = "SELECT u.*
365                       FROM {user} u
366                      WHERE u.deleted = 0
367                        AND u.confirmed = 1
368                        AND " . $DB->sql_like($fullname, ':search', false) . "
369                        AND u.id $exclude
370                        AND NOT EXISTS (SELECT mc.id
371                                          FROM {message_contacts} mc
372                                         WHERE (mc.userid = u.id AND mc.contactid = :userid1)
373                                            OR (mc.userid = :userid2 AND mc.contactid = u.id))
374                   ORDER BY " . $DB->sql_fullname();
375                 while ($records = $DB->get_records_sql($sql, $params + $excludeparams, $limitfrom, $limitnum)) {
376                     yield $records;
377                     $limitfrom += $limitnum;
378                 }
379             };
381             // Fetch in batches of $limitnum * 2 to improve the chances of matching a user without going back to the DB.
382             // The generator cannot function without a sensible limiter, so set one if this is not set.
383             $batchlimit = ($limitnum == 0) ? 20 : $limitnum;
385             // We need to make the offset param work with the generator.
386             // Basically, if we want to get say 10 records starting at the 40th record, we need to see 50 records and return only
387             // those after the 40th record. We can never pass the method's offset param to the generator as we need to manage the
388             // position within those valid records ourselves.
389             // See MDL-63983 dealing with performance improvements to this area of code.
390             $noofvalidseenrecords = 0;
391             $returnedusers = [];
392             foreach ($getnoncontactusers(0, $batchlimit) as $users) {
393                 foreach ($users as $id => $user) {
394                     $userdetails = \user_get_user_details_courses($user);
396                     // Return the user only if the searched field is returned.
397                     // Otherwise it means that the $USER was not allowed to search the returned user.
398                     if (!empty($userdetails) and !empty($userdetails['fullname'])) {
399                         // We know we've matched, but only save the record if it's within the offset area we need.
400                         if ($limitfrom == 0) {
401                             // No offset specified, so just save.
402                             $returnedusers[$id] = $user;
403                         } else {
404                             // There is an offset in play.
405                             // If we've passed enough records already (> offset value), then we can save this one.
406                             if ($noofvalidseenrecords >= $limitfrom) {
407                                 $returnedusers[$id] = $user;
408                             }
409                         }
410                         if (count($returnedusers) == $limitnum) {
411                             break 2;
412                         }
413                         $noofvalidseenrecords++;
414                     }
415                 }
416             }
417             $foundusers = $returnedusers;
418         }
420         $orderednoncontacts = array();
421         if (!empty($foundusers)) {
422             $noncontacts = helper::get_member_info($userid, array_keys($foundusers));
423             // The get_member_info returns an associative array, so is not ordered in the same way.
424             // We need to reorder it again based on query's result.
425             foreach ($foundusers as $key => $value) {
426                 $contact = $noncontacts[$key];
427                 $contact->conversations = self::get_conversations_between_users($userid, $key, 0, 1000);
428                 $orderednoncontacts[] = $contact;
429             }
430         }
432         return array($orderedcontacts, $orderednoncontacts);
433     }
435     /**
436      * Gets extra fields, like image url and subname for any conversations linked to components.
437      *
438      * The subname is like a subtitle for the conversation, to compliment it's name.
439      * The imageurl is the location of the image for the conversation, as might be seen on a listing of conversations for a user.
440      *
441      * @param array $conversations a list of conversations records.
442      * @return array the array of subnames, index by conversation id.
443      * @throws \coding_exception
444      * @throws \dml_exception
445      */
446     protected static function get_linked_conversation_extra_fields(array $conversations) : array {
447         global $DB;
449         $linkedconversations = [];
450         foreach ($conversations as $conversation) {
451             if (!is_null($conversation->component) && !is_null($conversation->itemtype)) {
452                 $linkedconversations[$conversation->component][$conversation->itemtype][$conversation->id]
453                     = $conversation->itemid;
454             }
455         }
456         if (empty($linkedconversations)) {
457             return [];
458         }
460         // TODO: MDL-63814: Working out the subname for linked conversations should be done in a generic way.
461         // Get the itemid, but only for course group linked conversation for now.
462         $extrafields = [];
463         if (!empty($linkeditems = $linkedconversations['core_group']['groups'])) { // Format: [conversationid => itemid].
464             // Get the name of the course to which the group belongs.
465             list ($groupidsql, $groupidparams) = $DB->get_in_or_equal(array_values($linkeditems), SQL_PARAMS_NAMED, 'groupid');
466             $sql = "SELECT g.*, c.shortname as courseshortname
467                       FROM {groups} g
468                       JOIN {course} c
469                         ON g.courseid = c.id
470                      WHERE g.id $groupidsql";
471             $courseinfo = $DB->get_records_sql($sql, $groupidparams);
472             foreach ($linkeditems as $convid => $groupid) {
473                 if (array_key_exists($groupid, $courseinfo)) {
474                     $group = $courseinfo[$groupid];
475                     // Subname.
476                     $extrafields[$convid]['subname'] = format_string($courseinfo[$groupid]->courseshortname);
478                     // Imageurl.
479                     $extrafields[$convid]['imageurl'] = '';
480                     if ($url = get_group_picture_url($group, $group->courseid, true)) {
481                         $extrafields[$convid]['imageurl'] = $url->out(false);
482                     }
483                 }
484             }
485         }
486         return $extrafields;
487     }
490     /**
491      * Returns the contacts and their conversation to display in the contacts area.
492      *
493      * ** WARNING **
494      * It is HIGHLY recommended to use a sensible limit when calling this function. Trying
495      * to retrieve too much information in a single call will cause performance problems.
496      * ** WARNING **
497      *
498      * This function has specifically been altered to break each of the data sets it
499      * requires into separate database calls. This is to avoid the performance problems
500      * observed when attempting to join large data sets (e.g. the message tables and
501      * the user table).
502      *
503      * While it is possible to gather the data in a single query, and it may even be
504      * more efficient with a correctly tuned database, we have opted to trade off some of
505      * the benefits of a single query in order to ensure this function will work on
506      * most databases with default tunings and with large data sets.
507      *
508      * @param int $userid The user id
509      * @param int $limitfrom
510      * @param int $limitnum
511      * @param int $type the type of the conversation, if you wish to filter to a certain type (see api constants).
512      * @param bool $favourites whether to include NO favourites (false) or ONLY favourites (true), or null to ignore this setting.
513      * @return array the array of conversations
514      * @throws \moodle_exception
515      */
516     public static function get_conversations($userid, $limitfrom = 0, $limitnum = 20, int $type = null,
517             bool $favourites = null) {
518         global $DB;
520         if (!is_null($type) && !in_array($type, [self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
521                 self::MESSAGE_CONVERSATION_TYPE_GROUP])) {
522             throw new \moodle_exception("Invalid value ($type) for type param, please see api constants.");
523         }
525         // We need to know which conversations are favourites, so we can either:
526         // 1) Include the 'isfavourite' attribute on conversations (when $favourite = null and we're including all conversations)
527         // 2) Restrict the results to ONLY those conversations which are favourites (when $favourite = true)
528         // 3) Restrict the results to ONLY those conversations which are NOT favourites (when $favourite = false).
529         $service = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
530         $favouriteconversations = $service->find_favourites_by_type('core_message', 'message_conversations');
531         $favouriteconversationids = array_column($favouriteconversations, 'itemid');
532         if ($favourites && empty($favouriteconversationids)) {
533             return []; // If we are aiming to return ONLY favourites, and we have none, there's nothing more to do.
534         }
536         // CONVERSATIONS AND MOST RECENT MESSAGE.
537         // Include those conversations with messages first (ordered by most recent message, desc), then add any conversations which
538         // don't have messages, such as newly created group conversations.
539         // Because we're sorting by message 'timecreated', those conversations without messages could be at either the start or the
540         // end of the results (behaviour for sorting of nulls differs between DB vendors), so we use the case to presort these.
542         // If we need to return ONLY favourites, or NO favourites, generate the SQL snippet.
543         $favouritesql = "";
544         $favouriteparams = [];
545         if (null !== $favourites && !empty($favouriteconversationids)) {
546             list ($insql, $favouriteparams) =
547                     $DB->get_in_or_equal($favouriteconversationids, SQL_PARAMS_NAMED, 'favouriteids', $favourites);
548             $favouritesql = " AND mc.id {$insql} ";
549         }
551         // If we need to restrict type, generate the SQL snippet.
552         $typesql = !is_null($type) ? " AND mc.type = :convtype " : "";
554         $sql = "SELECT m.id as messageid, mc.id as id, mc.name as conversationname, mc.type as conversationtype, m.useridfrom,
555                        m.smallmessage, m.fullmessage, m.fullmessageformat, m.fullmessagehtml, m.timecreated, mc.component,
556                        mc.itemtype, mc.itemid
557                   FROM {message_conversations} mc
558             INNER JOIN {message_conversation_members} mcm
559                     ON (mcm.conversationid = mc.id AND mcm.userid = :userid3)
560             LEFT JOIN (
561                           SELECT m.conversationid, MAX(m.id) AS messageid
562                             FROM {messages} m
563                       INNER JOIN (
564                                       SELECT m.conversationid, MAX(m.timecreated) as maxtime
565                                         FROM {messages} m
566                                   INNER JOIN {message_conversation_members} mcm
567                                           ON mcm.conversationid = m.conversationid
568                                    LEFT JOIN {message_user_actions} mua
569                                           ON (mua.messageid = m.id AND mua.userid = :userid AND mua.action = :action)
570                                        WHERE mua.id is NULL
571                                          AND mcm.userid = :userid2
572                                     GROUP BY m.conversationid
573                                  ) maxmessage
574                                ON maxmessage.maxtime = m.timecreated AND maxmessage.conversationid = m.conversationid
575                          GROUP BY m.conversationid
576                        ) lastmessage
577                     ON lastmessage.conversationid = mc.id
578             LEFT JOIN {messages} m
579                    ON m.id = lastmessage.messageid
580                 WHERE mc.id IS NOT NULL $typesql $favouritesql
581               ORDER BY (CASE WHEN m.timecreated IS NULL THEN 0 ELSE 1 END) DESC, m.timecreated DESC, id DESC";
583         $params = array_merge($favouriteparams, ['userid' => $userid, 'action' => self::MESSAGE_ACTION_DELETED,
584             'userid2' => $userid, 'userid3' => $userid, 'convtype' => $type]);
585         $conversationset = $DB->get_recordset_sql($sql, $params, $limitfrom, $limitnum);
587         $conversations = [];
588         $members = [];
589         $individualmembers = [];
590         $groupmembers = [];
591         foreach ($conversationset as $conversation) {
592             $conversations[$conversation->id] = $conversation;
593             $members[$conversation->id] = [];
594         }
595         $conversationset->close();
597         // If there are no conversations found, then return early.
598         if (empty($conversations)) {
599             return [];
600         }
602         // COMPONENT-LINKED CONVERSATION FIELDS.
603         // Conversations linked to components may have extra information, such as:
604         // - subname: Essentially a subtitle for the conversation. So you'd have "name: subname".
605         // - imageurl: A URL to the image for the linked conversation.
606         // For now, this is ONLY course groups.
607         $convextrafields = self::get_linked_conversation_extra_fields($conversations);
609         // MEMBERS.
610         // Ideally, we want to get 1 member for each conversation, but this depends on the type and whether there is a recent
611         // message or not.
612         //
613         // For 'individual' type conversations between 2 users, regardless of who sent the last message,
614         // we want the details of the other member in the conversation (i.e. not the current user).
615         //
616         // For 'group' type conversations, we want the details of the member who sent the last message, if there is one.
617         // This can be the current user or another group member, but for groups without messages, this will be empty.
618         //
619         // This also means that if type filtering is specified and only group conversations are returned, we don't need this extra
620         // query to get the 'other' user as we already have that information.
622         // Work out which members we have already, and which ones we might need to fetch.
623         // If all the last messages were from another user, then we don't need to fetch anything further.
624         foreach ($conversations as $conversation) {
625             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
626                 if (!is_null($conversation->useridfrom) && $conversation->useridfrom != $userid) {
627                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
628                     $individualmembers[$conversation->useridfrom] = $conversation->useridfrom;
629                 } else {
630                     $individualconversations[] = $conversation->id;
631                 }
632             } else if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
633                 // If we have a recent message, the sender is our member.
634                 if (!is_null($conversation->useridfrom)) {
635                     $members[$conversation->id][$conversation->useridfrom] = $conversation->useridfrom;
636                     $groupmembers[$conversation->useridfrom] = $conversation->useridfrom;
637                 }
638             }
639         }
640         // If we need to fetch any member information for any of the individual conversations.
641         // This is the case if any of the individual conversations have a recent message sent by the current user.
642         if (!empty($individualconversations)) {
643             list ($icidinsql, $icidinparams) = $DB->get_in_or_equal($individualconversations, SQL_PARAMS_NAMED, 'convid');
644             $indmembersql = "SELECT mcm.id, mcm.conversationid, mcm.userid
645                         FROM {message_conversation_members} mcm
646                        WHERE mcm.conversationid $icidinsql
647                        AND mcm.userid != :userid
648                        ORDER BY mcm.id";
649             $indmemberparams = array_merge($icidinparams, ['userid' => $userid]);
650             $conversationmembers = $DB->get_records_sql($indmembersql, $indmemberparams);
652             foreach ($conversationmembers as $mid => $member) {
653                 $members[$member->conversationid][$member->userid] = $member->userid;
654                 $individualmembers[$member->userid] = $member->userid;
655             }
656         }
658         // We could fail early here if we're sure that:
659         // a) we have no otherusers for all the conversations (users may have been deleted)
660         // b) we're sure that all conversations are individual (1:1).
662         // We need to pull out the list of users info corresponding to the memberids in the conversations.This
663         // needs to be done in a separate query to avoid doing a join on the messages tables and the user
664         // tables because on large sites these tables are massive which results in extremely slow
665         // performance (typically due to join buffer exhaustion).
666         if (!empty($individualmembers) || !empty($groupmembers)) {
667             // Now, we want to remove any duplicates from the group members array. For individual members we will
668             // be doing a more extensive call as we want their contact requests as well as privacy information,
669             // which is not necessary for group conversations.
670             $diffgroupmembers = array_diff($groupmembers, $individualmembers);
672             $individualmemberinfo = helper::get_member_info($userid, $individualmembers, true, true);
673             $groupmemberinfo = helper::get_member_info($userid, $diffgroupmembers);
675             // Don't use array_merge, as we lose array keys.
676             $memberinfo = $individualmemberinfo + $groupmemberinfo;
678             // Update the members array with the member information.
679             $deletedmembers = [];
680             foreach ($members as $convid => $memberarr) {
681                 foreach ($memberarr as $key => $memberid) {
682                     if (array_key_exists($memberid, $memberinfo)) {
683                         // If the user is deleted, remember that.
684                         if ($memberinfo[$memberid]->isdeleted) {
685                             $deletedmembers[$convid][] = $memberid;
686                         }
688                         $members[$convid][$key] = clone $memberinfo[$memberid];
690                         if ($conversations[$convid]->conversationtype == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
691                             // Remove data we don't need for group.
692                             $members[$convid][$key]->requirescontact = null;
693                             $members[$convid][$key]->canmessage = null;
694                             $members[$convid][$key]->contactrequests = [];
695                         }
696                     }
697                 }
698             }
699         }
701         // MEMBER COUNT.
702         $cids = array_column($conversations, 'id');
703         list ($cidinsql, $cidinparams) = $DB->get_in_or_equal($cids, SQL_PARAMS_NAMED, 'convid');
704         $membercountsql = "SELECT conversationid, count(id) AS membercount
705                              FROM {message_conversation_members} mcm
706                             WHERE mcm.conversationid $cidinsql
707                          GROUP BY mcm.conversationid";
708         $membercounts = $DB->get_records_sql($membercountsql, $cidinparams);
710         // UNREAD MESSAGE COUNT.
711         // Finally, let's get the unread messages count for this user so that we can add it
712         // to the conversation. Remember we need to ignore the messages the user sent.
713         $unreadcountssql = 'SELECT m.conversationid, count(m.id) as unreadcount
714                               FROM {messages} m
715                         INNER JOIN {message_conversations} mc
716                                 ON mc.id = m.conversationid
717                         INNER JOIN {message_conversation_members} mcm
718                                 ON m.conversationid = mcm.conversationid
719                          LEFT JOIN {message_user_actions} mua
720                                 ON (mua.messageid = m.id AND mua.userid = ? AND
721                                    (mua.action = ? OR mua.action = ?))
722                              WHERE mcm.userid = ?
723                                AND m.useridfrom != ?
724                                AND mua.id is NULL
725                           GROUP BY m.conversationid';
726         $unreadcounts = $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, self::MESSAGE_ACTION_DELETED,
727             $userid, $userid]);
729         // Now, create the final return structure.
730         $arrconversations = [];
731         foreach ($conversations as $conversation) {
732             // Do not include any individual conversation which:
733             // a) Contains a deleted member or
734             // b) Does not contain a recent message for the user (this happens if the user has deleted all messages).
735             // Group conversations with deleted users or no messages are always returned.
736             if ($conversation->conversationtype == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL
737                     && (isset($deletedmembers[$conversation->id]) || empty($conversation->messageid))) {
738                 continue;
739             }
741             $conv = new \stdClass();
742             $conv->id = $conversation->id;
743             $conv->name = $conversation->conversationname;
744             $conv->subname = $convextrafields[$conv->id]['subname'] ?? null;
745             $conv->imageurl = $convextrafields[$conv->id]['imageurl'] ?? null;
746             $conv->type = $conversation->conversationtype;
747             $conv->membercount = $membercounts[$conv->id]->membercount;
748             $conv->isfavourite = in_array($conv->id, $favouriteconversationids);
749             $conv->isread = isset($unreadcounts[$conv->id]) ? false : true;
750             $conv->unreadcount = isset($unreadcounts[$conv->id]) ? $unreadcounts[$conv->id]->unreadcount : null;
751             $conv->members = $members[$conv->id];
753             // Add the most recent message information.
754             $conv->messages = [];
755             if ($conversation->smallmessage) {
756                 $msg = new \stdClass();
757                 $msg->id = $conversation->messageid;
758                 $msg->text = message_format_message_text($conversation);
759                 $msg->useridfrom = $conversation->useridfrom;
760                 $msg->timecreated = $conversation->timecreated;
761                 $conv->messages[] = $msg;
762             }
764             $arrconversations[] = $conv;
765         }
766         return $arrconversations;
767     }
769     /**
770      * Returns all conversations between two users
771      *
772      * @param int $userid1 One of the user's id
773      * @param int $userid2 The other user's id
774      * @param int $limitfrom
775      * @param int $limitnum
776      * @return array
777      * @throws \dml_exception
778      */
779     public static function get_conversations_between_users(int $userid1, int $userid2,
780                                                            int $limitfrom = 0, int $limitnum = 20) : array {
782         global $DB;
784         if ($userid1 == $userid2) {
785             return array();
786         }
788         // Get all conversation where both user1 and user2 are members.
789         // TODO: Add subname value. Waiting for definite table structure.
790         $sql = "SELECT mc.id, mc.type, mc.name, mc.timecreated
791                   FROM {message_conversations} mc
792             INNER JOIN {message_conversation_members} mcm1
793                     ON mc.id = mcm1.conversationid
794             INNER JOIN {message_conversation_members} mcm2
795                     ON mc.id = mcm2.conversationid
796                  WHERE mcm1.userid = :userid1
797                    AND mcm2.userid = :userid2
798                    AND mc.enabled != 0
799               ORDER BY mc.timecreated DESC";
801         return $DB->get_records_sql($sql, array('userid1' => $userid1, 'userid2' => $userid2), $limitfrom, $limitnum);
802     }
804     /**
805      * Mark a conversation as a favourite for the given user.
806      *
807      * @param int $conversationid the id of the conversation to mark as a favourite.
808      * @param int $userid the id of the user to whom the favourite belongs.
809      * @return favourite the favourite object.
810      * @throws \moodle_exception if the user or conversation don't exist.
811      */
812     public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
813         if (!self::is_user_in_conversation($userid, $conversationid)) {
814             throw new \moodle_exception("Conversation doesn't exist or user is not a member");
815         }
816         $systemcontext = \context_system::instance();
817         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
818         if ($favourite = $ufservice->get_favourite('core_message', 'message_conversations', $conversationid, $systemcontext)) {
819             return $favourite;
820         } else {
821             return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, $systemcontext);
822         }
823     }
825     /**
826      * Unset a conversation as a favourite for the given user.
827      *
828      * @param int $conversationid the id of the conversation to unset as a favourite.
829      * @param int $userid the id to whom the favourite belongs.
830      * @throws \moodle_exception if the favourite does not exist for the user.
831      */
832     public static function unset_favourite_conversation(int $conversationid, int $userid) {
833         $ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
834         $ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
835     }
837     /**
838      * Returns the contacts to display in the contacts area.
839      *
840      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
841      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
842      * Followup: MDL-63915
843      *
844      * @param int $userid The user id
845      * @param int $limitfrom
846      * @param int $limitnum
847      * @return array
848      */
849     public static function get_contacts($userid, $limitfrom = 0, $limitnum = 0) {
850         global $DB;
852         $contactids = [];
853         $sql = "SELECT mc.*
854                   FROM {message_contacts} mc
855                  WHERE mc.userid = ? OR mc.contactid = ?
856               ORDER BY timecreated DESC";
857         if ($contacts = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
858             foreach ($contacts as $contact) {
859                 if ($userid == $contact->userid) {
860                     $contactids[] = $contact->contactid;
861                 } else {
862                     $contactids[] = $contact->userid;
863                 }
864             }
865         }
867         if (!empty($contactids)) {
868             list($insql, $inparams) = $DB->get_in_or_equal($contactids);
870             $sql = "SELECT u.*, mub.id as isblocked
871                       FROM {user} u
872                  LEFT JOIN {message_users_blocked} mub
873                         ON u.id = mub.blockeduserid
874                      WHERE u.id $insql";
875             if ($contacts = $DB->get_records_sql($sql, $inparams)) {
876                 $arrcontacts = [];
877                 foreach ($contacts as $contact) {
878                     $contact->blocked = $contact->isblocked ? 1 : 0;
879                     $arrcontacts[] = helper::create_contact($contact);
880                 }
882                 return $arrcontacts;
883             }
884         }
886         return [];
887     }
889     /**
890      * Returns the an array of the users the given user is in a conversation
891      * with who are a contact and the number of unread messages.
892      *
893      * @param int $userid The user id
894      * @param int $limitfrom
895      * @param int $limitnum
896      * @return array
897      */
898     public static function get_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
899         global $DB;
901         $userfields = \user_picture::fields('u', array('lastaccess'));
902         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
903                               FROM {message_contacts} mc
904                         INNER JOIN {user} u
905                                 ON (u.id = mc.contactid OR u.id = mc.userid)
906                          LEFT JOIN {messages} m
907                                 ON ((m.useridfrom = mc.contactid OR m.useridfrom = mc.userid) AND m.useridfrom != ?)
908                          LEFT JOIN {message_conversation_members} mcm
909                                 ON mcm.conversationid = m.conversationid AND mcm.userid = ? AND mcm.userid != m.useridfrom
910                          LEFT JOIN {message_user_actions} mua
911                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
912                          LEFT JOIN {message_users_blocked} mub
913                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
914                              WHERE mua.id is NULL
915                                AND mub.id is NULL
916                                AND (mc.userid = ? OR mc.contactid = ?)
917                                AND u.id != ?
918                                AND u.deleted = 0
919                           GROUP BY $userfields";
921         return $DB->get_records_sql($unreadcountssql, [$userid, $userid, $userid, self::MESSAGE_ACTION_READ,
922             $userid, $userid, $userid, $userid], $limitfrom, $limitnum);
923     }
925     /**
926      * Returns the an array of the users the given user is in a conversation
927      * with who are not a contact and the number of unread messages.
928      *
929      * @param int $userid The user id
930      * @param int $limitfrom
931      * @param int $limitnum
932      * @return array
933      */
934     public static function get_non_contacts_with_unread_message_count($userid, $limitfrom = 0, $limitnum = 0) {
935         global $DB;
937         $userfields = \user_picture::fields('u', array('lastaccess'));
938         $unreadcountssql = "SELECT $userfields, count(m.id) as messagecount
939                               FROM {user} u
940                         INNER JOIN {messages} m
941                                 ON m.useridfrom = u.id
942                         INNER JOIN {message_conversation_members} mcm
943                                 ON mcm.conversationid = m.conversationid
944                          LEFT JOIN {message_user_actions} mua
945                                 ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
946                          LEFT JOIN {message_contacts} mc
947                                 ON (mc.userid = ? AND mc.contactid = u.id)
948                          LEFT JOIN {message_users_blocked} mub
949                                 ON (mub.userid = ? AND mub.blockeduserid = u.id)
950                              WHERE mcm.userid = ?
951                                AND mcm.userid != m.useridfrom
952                                AND mua.id is NULL
953                                AND mub.id is NULL
954                                AND mc.id is NULL
955                                AND u.deleted = 0
956                           GROUP BY $userfields";
958         return $DB->get_records_sql($unreadcountssql, [$userid, self::MESSAGE_ACTION_READ, $userid, $userid, $userid],
959             $limitfrom, $limitnum);
960     }
962     /**
963      * Returns the messages to display in the message area.
964      *
965      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
966      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
967      * Followup: MDL-63915
968      *
969      * @param int $userid the current user
970      * @param int $otheruserid the other user
971      * @param int $limitfrom
972      * @param int $limitnum
973      * @param string $sort
974      * @param int $timefrom the time from the message being sent
975      * @param int $timeto the time up until the message being sent
976      * @return array
977      */
978     public static function get_messages($userid, $otheruserid, $limitfrom = 0, $limitnum = 0,
979             $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
981         if (!empty($timefrom)) {
982             // Get the conversation between userid and otheruserid.
983             $userids = [$userid, $otheruserid];
984             if (!$conversationid = self::get_conversation_between_users($userids)) {
985                 // This method was always used for individual conversations.
986                 $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
987                 $conversationid = $conversation->id;
988             }
990             // Check the cache to see if we even need to do a DB query.
991             $cache = \cache::make('core', 'message_time_last_message_between_users');
992             $key = helper::get_last_message_time_created_cache_key($conversationid);
993             $lastcreated = $cache->get($key);
995             // The last known message time is earlier than the one being requested so we can
996             // just return an empty result set rather than having to query the DB.
997             if ($lastcreated && $lastcreated < $timefrom) {
998                 return [];
999             }
1000         }
1002         $arrmessages = array();
1003         if ($messages = helper::get_messages($userid, $otheruserid, 0, $limitfrom, $limitnum,
1004                                              $sort, $timefrom, $timeto)) {
1005             $arrmessages = helper::create_messages($userid, $messages);
1006         }
1008         return $arrmessages;
1009     }
1011     /**
1012      * Returns the messages for the defined conversation.
1013      *
1014      * @param  int $userid The current user.
1015      * @param  int $convid The conversation where the messages belong. Could be an object or just the id.
1016      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
1017      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
1018      * @param  string $sort The column name to order by including optionally direction.
1019      * @param  int $timefrom The time from the message being sent.
1020      * @param  int $timeto The time up until the message being sent.
1021      * @return array of messages
1022      */
1023     public static function get_conversation_messages(int $userid, int $convid, int $limitfrom = 0, int $limitnum = 0,
1024         string $sort = 'timecreated ASC', int $timefrom = 0, int $timeto = 0) : array {
1026         if (!empty($timefrom)) {
1027             // Check the cache to see if we even need to do a DB query.
1028             $cache = \cache::make('core', 'message_time_last_message_between_users');
1029             $key = helper::get_last_message_time_created_cache_key($convid);
1030             $lastcreated = $cache->get($key);
1032             // The last known message time is earlier than the one being requested so we can
1033             // just return an empty result set rather than having to query the DB.
1034             if ($lastcreated && $lastcreated < $timefrom) {
1035                 return [];
1036             }
1037         }
1039         $messages = helper::get_conversation_messages($userid, $convid, 0, $limitfrom, $limitnum, $sort, $timefrom, $timeto);
1040         return helper::format_conversation_messages($userid, $convid, $messages);
1041     }
1043     /**
1044      * Returns the most recent message between two users.
1045      *
1046      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1047      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1048      * Followup: MDL-63915
1049      *
1050      * @param int $userid the current user
1051      * @param int $otheruserid the other user
1052      * @return \stdClass|null
1053      */
1054     public static function get_most_recent_message($userid, $otheruserid) {
1055         // We want two messages here so we get an accurate 'blocktime' value.
1056         if ($messages = helper::get_messages($userid, $otheruserid, 0, 0, 2, 'timecreated DESC')) {
1057             // Swap the order so we now have them in historical order.
1058             $messages = array_reverse($messages);
1059             $arrmessages = helper::create_messages($userid, $messages);
1060             return array_pop($arrmessages);
1061         }
1063         return null;
1064     }
1066     /**
1067      * Returns the most recent message in a conversation.
1068      *
1069      * @param int $convid The conversation identifier.
1070      * @param int $currentuserid The current user identifier.
1071      * @return \stdClass|null The most recent message.
1072      */
1073     public static function get_most_recent_conversation_message(int $convid, int $currentuserid = 0) {
1074         global $USER;
1076         if (empty($currentuserid)) {
1077             $currentuserid = $USER->id;
1078         }
1080         if ($messages = helper::get_conversation_messages($currentuserid, $convid, 0, 0, 1, 'timecreated DESC')) {
1081             $convmessages = helper::format_conversation_messages($currentuserid, $convid, $messages);
1082             return array_pop($convmessages['messages']);
1083         }
1085         return null;
1086     }
1088     /**
1089      * Returns the profile information for a contact for a user.
1090      *
1091      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
1092      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
1093      * Followup: MDL-63915
1094      *
1095      * @param int $userid The user id
1096      * @param int $otheruserid The id of the user whose profile we want to view.
1097      * @return \stdClass
1098      */
1099     public static function get_profile($userid, $otheruserid) {
1100         global $CFG, $PAGE;
1102         require_once($CFG->dirroot . '/user/lib.php');
1104         $user = \core_user::get_user($otheruserid, '*', MUST_EXIST);
1106         // Create the data we are going to pass to the renderable.
1107         $data = new \stdClass();
1108         $data->userid = $otheruserid;
1109         $data->fullname = fullname($user);
1110         $data->city = '';
1111         $data->country = '';
1112         $data->email = '';
1113         $data->isonline = null;
1114         // Get the user picture data - messaging has always shown these to the user.
1115         $userpicture = new \user_picture($user);
1116         $userpicture->size = 1; // Size f1.
1117         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
1118         $userpicture->size = 0; // Size f2.
1119         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
1121         $userfields = user_get_user_details($user, null, array('city', 'country', 'email', 'lastaccess'));
1122         if ($userfields) {
1123             if (isset($userfields['city'])) {
1124                 $data->city = $userfields['city'];
1125             }
1126             if (isset($userfields['country'])) {
1127                 $data->country = $userfields['country'];
1128             }
1129             if (isset($userfields['email'])) {
1130                 $data->email = $userfields['email'];
1131             }
1132             if (isset($userfields['lastaccess'])) {
1133                 $data->isonline = helper::is_online($userfields['lastaccess']);
1134             }
1135         }
1137         $data->isblocked = self::is_blocked($userid, $otheruserid);
1138         $data->iscontact = self::is_contact($userid, $otheruserid);
1140         return $data;
1141     }
1143     /**
1144      * Checks if a user can delete messages they have either received or sent.
1145      *
1146      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1147      *  but will still seem as if it was by the user)
1148      * @param int $conversationid The id of the conversation
1149      * @return bool Returns true if a user can delete the conversation, false otherwise.
1150      */
1151     public static function can_delete_conversation(int $userid, int $conversationid = null) : bool {
1152         global $USER;
1154         if (is_null($conversationid)) {
1155             debugging('\core_message\api::can_delete_conversation() now expects a \'conversationid\' to be passed.',
1156                 DEBUG_DEVELOPER);
1157             return false;
1158         }
1160         $systemcontext = \context_system::instance();
1162         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1163             return true;
1164         }
1166         if (!self::is_user_in_conversation($userid, $conversationid)) {
1167             return false;
1168         }
1170         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1171                 $USER->id == $userid) {
1172             return true;
1173         }
1175         return false;
1176     }
1178     /**
1179      * Deletes a conversation.
1180      *
1181      * This function does not verify any permissions.
1182      *
1183      * @deprecated since 3.6
1184      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1185      *  but will still seem as if it was by the user)
1186      * @param int $otheruserid The id of the other user in the conversation
1187      * @return bool
1188      */
1189     public static function delete_conversation($userid, $otheruserid) {
1190         debugging('\core_message\api::delete_conversation() is deprecated, please use ' .
1191             '\core_message\api::delete_conversation_by_id() instead.', DEBUG_DEVELOPER);
1193         $conversationid = self::get_conversation_between_users([$userid, $otheruserid]);
1195         // If there is no conversation, there is nothing to do.
1196         if (!$conversationid) {
1197             return true;
1198         }
1200         self::delete_conversation_by_id($userid, $conversationid);
1202         return true;
1203     }
1205     /**
1206      * Deletes a conversation for a specified user.
1207      *
1208      * This function does not verify any permissions.
1209      *
1210      * @param int $userid The user id of who we want to delete the messages for (this may be done by the admin
1211      *  but will still seem as if it was by the user)
1212      * @param int $conversationid The id of the other user in the conversation
1213      */
1214     public static function delete_conversation_by_id(int $userid, int $conversationid) {
1215         global $DB, $USER;
1217         // Get all messages belonging to this conversation that have not already been deleted by this user.
1218         $sql = "SELECT m.*
1219                  FROM {messages} m
1220            INNER JOIN {message_conversations} mc
1221                    ON m.conversationid = mc.id
1222             LEFT JOIN {message_user_actions} mua
1223                    ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1224                 WHERE mua.id is NULL
1225                   AND mc.id = ?
1226              ORDER BY m.timecreated ASC";
1227         $messages = $DB->get_records_sql($sql, [$userid, self::MESSAGE_ACTION_DELETED, $conversationid]);
1229         // Ok, mark these as deleted.
1230         foreach ($messages as $message) {
1231             $mua = new \stdClass();
1232             $mua->userid = $userid;
1233             $mua->messageid = $message->id;
1234             $mua->action = self::MESSAGE_ACTION_DELETED;
1235             $mua->timecreated = time();
1236             $mua->id = $DB->insert_record('message_user_actions', $mua);
1238             \core\event\message_deleted::create_from_ids($userid, $USER->id,
1239                 $message->id, $mua->id)->trigger();
1240         }
1241     }
1243     /**
1244      * Returns the count of unread conversations (collection of messages from a single user) for
1245      * the given user.
1246      *
1247      * @param \stdClass $user the user who's conversations should be counted
1248      * @return int the count of the user's unread conversations
1249      */
1250     public static function count_unread_conversations($user = null) {
1251         global $USER, $DB;
1253         if (empty($user)) {
1254             $user = $USER;
1255         }
1257         $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1258                   FROM {messages} m
1259             INNER JOIN {message_conversations} mc
1260                     ON m.conversationid = mc.id
1261             INNER JOIN {message_conversation_members} mcm
1262                     ON mc.id = mcm.conversationid
1263              LEFT JOIN {message_user_actions} mua
1264                     ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1265                  WHERE mcm.userid = ?
1266                    AND mcm.userid != m.useridfrom
1267                    AND mua.id is NULL";
1269         return $DB->count_records_sql($sql, [$user->id, self::MESSAGE_ACTION_READ, $user->id]);
1270     }
1272     /**
1273      * Checks if a user can mark all messages as read.
1274      *
1275      * @param int $userid The user id of who we want to mark the messages for
1276      * @param int $conversationid The id of the conversation
1277      * @return bool true if user is permitted, false otherwise
1278      * @since 3.6
1279      */
1280     public static function can_mark_all_messages_as_read(int $userid, int $conversationid) : bool {
1281         global $USER;
1283         $systemcontext = \context_system::instance();
1285         if (has_capability('moodle/site:readallmessages', $systemcontext)) {
1286             return true;
1287         }
1289         if (!self::is_user_in_conversation($userid, $conversationid)) {
1290             return false;
1291         }
1293         if ($USER->id == $userid) {
1294             return true;
1295         }
1297         return false;
1298     }
1300     /**
1301      * Returns the count of conversations (collection of messages from a single user) for
1302      * the given user.
1303      *
1304      * @param \stdClass $user The user who's conversations should be counted
1305      * @param int $type The conversation type
1306      * @param bool $excludefavourites Exclude favourite conversations
1307      * @return int the count of the user's unread conversations
1308      */
1309     public static function count_conversations($user, int $type = null, bool $excludefavourites = false) {
1310         global $DB;
1312         $params = [];
1313         $favouritessql = '';
1315         if ($excludefavourites) {
1316             $favouritessql = "AND m.conversationid NOT IN (
1317                                 SELECT itemid
1318                                 FROM {favourite}
1319                                 WHERE component = 'core_message'
1320                                 AND itemtype = 'message_conversations'
1321                                 AND userid = ?
1322                             )";
1323             $params[] = $user->id;
1324         }
1326         switch($type) {
1327             case null:
1328                 $params = array_merge([$user->id, self::MESSAGE_ACTION_DELETED, $user->id], $params);
1329                 $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1330                           FROM {messages} m
1331                      LEFT JOIN {message_conversations} c
1332                             ON m.conversationid = c.id
1333                      LEFT JOIN {message_user_actions} ma
1334                             ON ma.messageid = m.id
1335                      LEFT JOIN {message_conversation_members} mcm
1336                             ON m.conversationid = mcm.conversationid
1337                          WHERE mcm.userid = ?
1338                            AND (
1339                                     c.type != " . self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL . "
1340                                     OR
1341                                     (
1342                                         (ma.action IS NULL OR ma.action != ? OR ma.userid != ?)
1343                                         AND c.type = " . self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL . "
1344                                     )
1345                                 )
1346                                ${favouritessql}";
1347                 break;
1348             case self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL:
1349                 $params = array_merge([self::MESSAGE_ACTION_DELETED, $user->id, $user->id], $params);
1350                 $sql = "SELECT COUNT(DISTINCT(m.conversationid))
1351                           FROM {messages} m
1352                      LEFT JOIN {message_conversations} c
1353                             ON m.conversationid = c.id
1354                      LEFT JOIN {message_user_actions} ma
1355                             ON ma.messageid = m.id
1356                      LEFT JOIN {message_conversation_members} mcm
1357                             ON m.conversationid = mcm.conversationid
1358                          WHERE (ma.action IS NULL OR ma.action != ? OR ma.userid != ?)
1359                            AND mcm.userid = ?
1360                            AND c.type = " . self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL . "
1361                                ${favouritessql}";
1362                 break;
1363             default:
1364                 $params = array_merge([$user->id, $type], $params);
1365                 $sql = "SELECT COUNT(m.conversationid)
1366                           FROM {message_conversation_members} m
1367                      LEFT JOIN {message_conversations} c
1368                             ON m.conversationid = c.id
1369                          WHERE m.userid = ?
1370                            AND c.type = ?
1371                                ${favouritessql}";
1373         }
1375         return $DB->count_records_sql($sql, $params);
1376     }
1378     /**
1379      * Marks all messages being sent to a user in a particular conversation.
1380      *
1381      * If $conversationdid is null then it marks all messages as read sent to $userid.
1382      *
1383      * @param int $userid
1384      * @param int|null $conversationid The conversation the messages belong to mark as read, if null mark all
1385      */
1386     public static function mark_all_messages_as_read($userid, $conversationid = null) {
1387         global $DB;
1389         $messagesql = "SELECT m.*
1390                          FROM {messages} m
1391                    INNER JOIN {message_conversations} mc
1392                            ON mc.id = m.conversationid
1393                    INNER JOIN {message_conversation_members} mcm
1394                            ON mcm.conversationid = mc.id
1395                     LEFT JOIN {message_user_actions} mua
1396                            ON (mua.messageid = m.id AND mua.userid = ? AND mua.action = ?)
1397                         WHERE mua.id is NULL
1398                           AND mcm.userid = ?
1399                           AND m.useridfrom != ?";
1400         $messageparams = [];
1401         $messageparams[] = $userid;
1402         $messageparams[] = self::MESSAGE_ACTION_READ;
1403         $messageparams[] = $userid;
1404         $messageparams[] = $userid;
1405         if (!is_null($conversationid)) {
1406             $messagesql .= " AND mc.id = ?";
1407             $messageparams[] = $conversationid;
1408         }
1410         $messages = $DB->get_recordset_sql($messagesql, $messageparams);
1411         foreach ($messages as $message) {
1412             self::mark_message_as_read($userid, $message);
1413         }
1414         $messages->close();
1415     }
1417     /**
1418      * Marks all notifications being sent from one user to another user as read.
1419      *
1420      * If the from user is null then it marks all notifications as read sent to the to user.
1421      *
1422      * @param int $touserid the id of the message recipient
1423      * @param int|null $fromuserid the id of the message sender, null if all messages
1424      * @return void
1425      */
1426     public static function mark_all_notifications_as_read($touserid, $fromuserid = null) {
1427         global $DB;
1429         $notificationsql = "SELECT n.*
1430                               FROM {notifications} n
1431                              WHERE useridto = ?
1432                                AND timeread is NULL";
1433         $notificationsparams = [$touserid];
1434         if (!empty($fromuserid)) {
1435             $notificationsql .= " AND useridfrom = ?";
1436             $notificationsparams[] = $fromuserid;
1437         }
1439         $notifications = $DB->get_recordset_sql($notificationsql, $notificationsparams);
1440         foreach ($notifications as $notification) {
1441             self::mark_notification_as_read($notification);
1442         }
1443         $notifications->close();
1444     }
1446     /**
1447      * Marks ALL messages being sent from $fromuserid to $touserid as read.
1448      *
1449      * Can be filtered by type.
1450      *
1451      * @deprecated since 3.5
1452      * @param int $touserid the id of the message recipient
1453      * @param int $fromuserid the id of the message sender
1454      * @param string $type filter the messages by type, either MESSAGE_TYPE_NOTIFICATION, MESSAGE_TYPE_MESSAGE or '' for all.
1455      * @return void
1456      */
1457     public static function mark_all_read_for_user($touserid, $fromuserid = 0, $type = '') {
1458         debugging('\core_message\api::mark_all_read_for_user is deprecated. Please either use ' .
1459             '\core_message\api::mark_all_notifications_read_for_user or \core_message\api::mark_all_messages_read_for_user',
1460             DEBUG_DEVELOPER);
1462         $type = strtolower($type);
1464         $conversationid = null;
1465         $ignoremessages = false;
1466         if (!empty($fromuserid)) {
1467             $conversationid = self::get_conversation_between_users([$touserid, $fromuserid]);
1468             if (!$conversationid) { // If there is no conversation between the users then there are no messages to mark.
1469                 $ignoremessages = true;
1470             }
1471         }
1473         if (!empty($type)) {
1474             if ($type == MESSAGE_TYPE_NOTIFICATION) {
1475                 self::mark_all_notifications_as_read($touserid, $fromuserid);
1476             } else if ($type == MESSAGE_TYPE_MESSAGE) {
1477                 if (!$ignoremessages) {
1478                     self::mark_all_messages_as_read($touserid, $conversationid);
1479                 }
1480             }
1481         } else { // We want both.
1482             self::mark_all_notifications_as_read($touserid, $fromuserid);
1483             if (!$ignoremessages) {
1484                 self::mark_all_messages_as_read($touserid, $conversationid);
1485             }
1486         }
1487     }
1489     /**
1490      * Returns message preferences.
1491      *
1492      * @param array $processors
1493      * @param array $providers
1494      * @param \stdClass $user
1495      * @return \stdClass
1496      * @since 3.2
1497      */
1498     public static function get_all_message_preferences($processors, $providers, $user) {
1499         $preferences = helper::get_providers_preferences($providers, $user->id);
1500         $preferences->userdefaultemail = $user->email; // May be displayed by the email processor.
1502         // For every processors put its options on the form (need to get function from processor's lib.php).
1503         foreach ($processors as $processor) {
1504             $processor->object->load_data($preferences, $user->id);
1505         }
1507         // Load general messaging preferences.
1508         $preferences->blocknoncontacts = self::get_user_privacy_messaging_preference($user->id);
1509         $preferences->mailformat = $user->mailformat;
1510         $preferences->mailcharset = get_user_preferences('mailcharset', '', $user->id);
1512         return $preferences;
1513     }
1515     /**
1516      * Count the number of users blocked by a user.
1517      *
1518      * @param \stdClass $user The user object
1519      * @return int the number of blocked users
1520      */
1521     public static function count_blocked_users($user = null) {
1522         global $USER, $DB;
1524         if (empty($user)) {
1525             $user = $USER;
1526         }
1528         $sql = "SELECT count(mub.id)
1529                   FROM {message_users_blocked} mub
1530                  WHERE mub.userid = :userid";
1531         return $DB->count_records_sql($sql, array('userid' => $user->id));
1532     }
1534     /**
1535      * Determines if a user is permitted to send another user a private message.
1536      * If no sender is provided then it defaults to the logged in user.
1537      *
1538      * @param \stdClass $recipient The user object.
1539      * @param \stdClass|null $sender The user object.
1540      * @return bool true if user is permitted, false otherwise.
1541      */
1542     public static function can_post_message($recipient, $sender = null) {
1543         global $USER;
1545         if (is_null($sender)) {
1546             // The message is from the logged in user, unless otherwise specified.
1547             $sender = $USER;
1548         }
1550         $systemcontext = \context_system::instance();
1551         if (!has_capability('moodle/site:sendmessage', $systemcontext, $sender)) {
1552             return false;
1553         }
1555         if (has_capability('moodle/site:readallmessages', $systemcontext, $sender->id)) {
1556             return true;
1557         }
1559         // Check if the recipient can be messaged by the sender.
1560         return (self::can_contact_user($recipient->id, $sender->id));
1561     }
1563     /**
1564      * Determines if a user is permitted to send a message to a given conversation.
1565      * If no sender is provided then it defaults to the logged in user.
1566      *
1567      * @param int $userid the id of the user on which the checks will be applied.
1568      * @param int $conversationid the id of the conversation we wish to check.
1569      * @return bool true if the user can send a message to the conversation, false otherwise.
1570      * @throws \moodle_exception
1571      */
1572     public static function can_send_message_to_conversation(int $userid, int $conversationid) : bool {
1573         global $DB;
1575         $systemcontext = \context_system::instance();
1576         if (!has_capability('moodle/site:sendmessage', $systemcontext, $userid)) {
1577             return false;
1578         }
1580         if (!self::is_user_in_conversation($userid, $conversationid)) {
1581             return false;
1582         }
1584         // User can post messages and is in the conversation, but we need to check the conversation type to
1585         // know whether or not to check the user privacy settings via can_contact_user().
1586         $conversation = $DB->get_record('message_conversations', ['id' => $conversationid], '*', MUST_EXIST);
1587         if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_GROUP) {
1588             return true;
1589         } else if ($conversation->type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
1590             // Get the other user in the conversation.
1591             $members = self::get_conversation_members($userid, $conversationid);
1592             $otheruser = array_filter($members, function($member) use($userid) {
1593                 return $member->id != $userid;
1594             });
1595             $otheruser = reset($otheruser);
1597             return self::can_contact_user($otheruser->id, $userid);
1598         } else {
1599             throw new \moodle_exception("Invalid conversation type '$conversation->type'.");
1600         }
1601     }
1603     /**
1604      * Send a message from a user to a conversation.
1605      *
1606      * This method will create the basic eventdata and delegate to message creation to message_send.
1607      * The message_send() method is responsible for event data that is specific to each recipient.
1608      *
1609      * @param int $userid the sender id.
1610      * @param int $conversationid the conversation id.
1611      * @param string $message the message to send.
1612      * @param int $format the format of the message to send.
1613      * @return \stdClass the message created.
1614      * @throws \coding_exception
1615      * @throws \moodle_exception if the user is not permitted to send a message to the conversation.
1616      */
1617     public static function send_message_to_conversation(int $userid, int $conversationid, string $message,
1618                                                         int $format) : \stdClass {
1619         global $DB;
1621         if (!self::can_send_message_to_conversation($userid, $conversationid)) {
1622             throw new \moodle_exception("User $userid cannot send a message to conversation $conversationid");
1623         }
1625         $eventdata = new \core\message\message();
1626         $eventdata->courseid         = 1;
1627         $eventdata->component        = 'moodle';
1628         $eventdata->name             = 'instantmessage';
1629         $eventdata->userfrom         = $userid;
1630         $eventdata->convid           = $conversationid;
1632         if ($format == FORMAT_HTML) {
1633             $eventdata->fullmessagehtml  = $message;
1634             // Some message processors may revert to sending plain text even if html is supplied,
1635             // so we keep both plain and html versions if we're intending to send html.
1636             $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
1637         } else {
1638             $eventdata->fullmessage      = $message;
1639             $eventdata->fullmessagehtml  = '';
1640         }
1642         $eventdata->fullmessageformat = $format;
1643         $eventdata->smallmessage = $message; // Store the message unfiltered. Clean up on output.
1645         $eventdata->timecreated     = time();
1646         $eventdata->notification    = 0;
1647         $messageid = message_send($eventdata);
1649         $messagerecord = $DB->get_record('messages', ['id' => $messageid], 'id, useridfrom, fullmessage, timecreated');
1650         $message = (object) [
1651             'id' => $messagerecord->id,
1652             'useridfrom' => $messagerecord->useridfrom,
1653             'text' => $messagerecord->fullmessage,
1654             'timecreated' => $messagerecord->timecreated
1655         ];
1656         return $message;
1657     }
1659     /**
1660      * Get the messaging preference for a user.
1661      * If the user has not any messaging privacy preference:
1662      * - When $CFG->messagingallusers = false the default user preference is MESSAGE_PRIVACY_COURSEMEMBER.
1663      * - When $CFG->messagingallusers = true the default user preference is MESSAGE_PRIVACY_SITE.
1664      *
1665      * @param  int    $userid The user identifier.
1666      * @return int    The default messaging preference.
1667      */
1668     public static function get_user_privacy_messaging_preference(int $userid) : int {
1669         global $CFG;
1671         // When $CFG->messagingallusers is enabled, default value for the messaging preference will be "Anyone on the site";
1672         // otherwise, the default value will be "My contacts and anyone in my courses".
1673         if (empty($CFG->messagingallusers)) {
1674             $defaultprefvalue = self::MESSAGE_PRIVACY_COURSEMEMBER;
1675         } else {
1676             $defaultprefvalue = self::MESSAGE_PRIVACY_SITE;
1677         }
1678         $privacypreference = get_user_preferences('message_blocknoncontacts', $defaultprefvalue, $userid);
1680         // When the $CFG->messagingallusers privacy setting is disabled, MESSAGE_PRIVACY_SITE is
1681         // also disabled, so it has to be replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1682         if (empty($CFG->messagingallusers) && $privacypreference == self::MESSAGE_PRIVACY_SITE) {
1683             $privacypreference = self::MESSAGE_PRIVACY_COURSEMEMBER;
1684         }
1686         return $privacypreference;
1687     }
1689     /**
1690      * Checks if the recipient is allowing messages from users that aren't a
1691      * contact. If not then it checks to make sure the sender is in the
1692      * recipient's contacts.
1693      *
1694      * @deprecated since 3.6
1695      * @param \stdClass $recipient The user object.
1696      * @param \stdClass|null $sender The user object.
1697      * @return bool true if $sender is blocked, false otherwise.
1698      */
1699     public static function is_user_non_contact_blocked($recipient, $sender = null) {
1700         debugging('\core_message\api::is_user_non_contact_blocked() is deprecated', DEBUG_DEVELOPER);
1702         global $USER, $CFG;
1704         if (is_null($sender)) {
1705             // The message is from the logged in user, unless otherwise specified.
1706             $sender = $USER;
1707         }
1709         $privacypreference = self::get_user_privacy_messaging_preference($recipient->id);
1710         switch ($privacypreference) {
1711             case self::MESSAGE_PRIVACY_SITE:
1712                 if (!empty($CFG->messagingallusers)) {
1713                     // Users can be messaged without being contacts or members of the same course.
1714                     break;
1715                 }
1716                 // When the $CFG->messagingallusers privacy setting is disabled, continue with the next
1717                 // case, because MESSAGE_PRIVACY_SITE is replaced to MESSAGE_PRIVACY_COURSEMEMBER.
1718             case self::MESSAGE_PRIVACY_COURSEMEMBER:
1719                 // Confirm the sender and the recipient are both members of the same course.
1720                 if (enrol_sharing_course($recipient, $sender)) {
1721                     // All good, the recipient and the sender are members of the same course.
1722                     return false;
1723                 }
1724             case self::MESSAGE_PRIVACY_ONLYCONTACTS:
1725                 // True if they aren't contacts (they can't send a message because of the privacy settings), false otherwise.
1726                 return !self::is_contact($sender->id, $recipient->id);
1727         }
1729         return false;
1730     }
1732     /**
1733      * Checks if the recipient has specifically blocked the sending user.
1734      *
1735      * Note: This function will always return false if the sender has the
1736      * readallmessages capability at the system context level.
1737      *
1738      * @deprecated since 3.6
1739      * @param int $recipientid User ID of the recipient.
1740      * @param int $senderid User ID of the sender.
1741      * @return bool true if $sender is blocked, false otherwise.
1742      */
1743     public static function is_user_blocked($recipientid, $senderid = null) {
1744         debugging('\core_message\api::is_user_blocked is deprecated and should not be used.',
1745             DEBUG_DEVELOPER);
1747         global $USER;
1749         if (is_null($senderid)) {
1750             // The message is from the logged in user, unless otherwise specified.
1751             $senderid = $USER->id;
1752         }
1754         $systemcontext = \context_system::instance();
1755         if (has_capability('moodle/site:readallmessages', $systemcontext, $senderid)) {
1756             return false;
1757         }
1759         if (self::is_blocked($recipientid, $senderid)) {
1760             return true;
1761         }
1763         return false;
1764     }
1766     /**
1767      * Get specified message processor, validate corresponding plugin existence and
1768      * system configuration.
1769      *
1770      * @param string $name  Name of the processor.
1771      * @param bool $ready only return ready-to-use processors.
1772      * @return mixed $processor if processor present else empty array.
1773      * @since Moodle 3.2
1774      */
1775     public static function get_message_processor($name, $ready = false) {
1776         global $DB, $CFG;
1778         $processor = $DB->get_record('message_processors', array('name' => $name));
1779         if (empty($processor)) {
1780             // Processor not found, return.
1781             return array();
1782         }
1784         $processor = self::get_processed_processor_object($processor);
1785         if ($ready) {
1786             if ($processor->enabled && $processor->configured) {
1787                 return $processor;
1788             } else {
1789                 return array();
1790             }
1791         } else {
1792             return $processor;
1793         }
1794     }
1796     /**
1797      * Returns weather a given processor is enabled or not.
1798      * Note:- This doesn't check if the processor is configured or not.
1799      *
1800      * @param string $name Name of the processor
1801      * @return bool
1802      */
1803     public static function is_processor_enabled($name) {
1805         $cache = \cache::make('core', 'message_processors_enabled');
1806         $status = $cache->get($name);
1808         if ($status === false) {
1809             $processor = self::get_message_processor($name);
1810             if (!empty($processor)) {
1811                 $cache->set($name, $processor->enabled);
1812                 return $processor->enabled;
1813             } else {
1814                 return false;
1815             }
1816         }
1818         return $status;
1819     }
1821     /**
1822      * Set status of a processor.
1823      *
1824      * @param \stdClass $processor processor record.
1825      * @param 0|1 $enabled 0 or 1 to set the processor status.
1826      * @return bool
1827      * @since Moodle 3.2
1828      */
1829     public static function update_processor_status($processor, $enabled) {
1830         global $DB;
1831         $cache = \cache::make('core', 'message_processors_enabled');
1832         $cache->delete($processor->name);
1833         return $DB->set_field('message_processors', 'enabled', $enabled, array('id' => $processor->id));
1834     }
1836     /**
1837      * Given a processor object, loads information about it's settings and configurations.
1838      * This is not a public api, instead use @see \core_message\api::get_message_processor()
1839      * or @see \get_message_processors()
1840      *
1841      * @param \stdClass $processor processor object
1842      * @return \stdClass processed processor object
1843      * @since Moodle 3.2
1844      */
1845     public static function get_processed_processor_object(\stdClass $processor) {
1846         global $CFG;
1848         $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
1849         if (is_readable($processorfile)) {
1850             include_once($processorfile);
1851             $processclass = 'message_output_' . $processor->name;
1852             if (class_exists($processclass)) {
1853                 $pclass = new $processclass();
1854                 $processor->object = $pclass;
1855                 $processor->configured = 0;
1856                 if ($pclass->is_system_configured()) {
1857                     $processor->configured = 1;
1858                 }
1859                 $processor->hassettings = 0;
1860                 if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
1861                     $processor->hassettings = 1;
1862                 }
1863                 $processor->available = 1;
1864             } else {
1865                 print_error('errorcallingprocessor', 'message');
1866             }
1867         } else {
1868             $processor->available = 0;
1869         }
1870         return $processor;
1871     }
1873     /**
1874      * Retrieve users blocked by $user1
1875      *
1876      * @param int $userid The user id of the user whos blocked users we are returning
1877      * @return array the users blocked
1878      */
1879     public static function get_blocked_users($userid) {
1880         global $DB;
1882         $userfields = \user_picture::fields('u', array('lastaccess'));
1883         $blockeduserssql = "SELECT $userfields
1884                               FROM {message_users_blocked} mub
1885                         INNER JOIN {user} u
1886                                 ON u.id = mub.blockeduserid
1887                              WHERE u.deleted = 0
1888                                AND mub.userid = ?
1889                           GROUP BY $userfields
1890                           ORDER BY u.firstname ASC";
1891         return $DB->get_records_sql($blockeduserssql, [$userid]);
1892     }
1894     /**
1895      * Mark a single message as read.
1896      *
1897      * @param int $userid The user id who marked the message as read
1898      * @param \stdClass $message The message
1899      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1900      */
1901     public static function mark_message_as_read($userid, $message, $timeread = null) {
1902         global $DB;
1904         if (is_null($timeread)) {
1905             $timeread = time();
1906         }
1908         $mua = new \stdClass();
1909         $mua->userid = $userid;
1910         $mua->messageid = $message->id;
1911         $mua->action = self::MESSAGE_ACTION_READ;
1912         $mua->timecreated = $timeread;
1913         $mua->id = $DB->insert_record('message_user_actions', $mua);
1915         // Get the context for the user who received the message.
1916         $context = \context_user::instance($userid, IGNORE_MISSING);
1917         // If the user no longer exists the context value will be false, in this case use the system context.
1918         if ($context === false) {
1919             $context = \context_system::instance();
1920         }
1922         // Trigger event for reading a message.
1923         $event = \core\event\message_viewed::create(array(
1924             'objectid' => $mua->id,
1925             'userid' => $userid, // Using the user who read the message as they are the ones performing the action.
1926             'context' => $context,
1927             'relateduserid' => $message->useridfrom,
1928             'other' => array(
1929                 'messageid' => $message->id
1930             )
1931         ));
1932         $event->trigger();
1933     }
1935     /**
1936      * Mark a single notification as read.
1937      *
1938      * @param \stdClass $notification The notification
1939      * @param int|null $timeread The time the message was marked as read, if null will default to time()
1940      */
1941     public static function mark_notification_as_read($notification, $timeread = null) {
1942         global $DB;
1944         if (is_null($timeread)) {
1945             $timeread = time();
1946         }
1948         if (is_null($notification->timeread)) {
1949             $updatenotification = new \stdClass();
1950             $updatenotification->id = $notification->id;
1951             $updatenotification->timeread = $timeread;
1953             $DB->update_record('notifications', $updatenotification);
1955             // Trigger event for reading a notification.
1956             \core\event\notification_viewed::create_from_ids(
1957                 $notification->useridfrom,
1958                 $notification->useridto,
1959                 $notification->id
1960             )->trigger();
1961         }
1962     }
1964     /**
1965      * Checks if a user can delete a message.
1966      *
1967      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
1968      *  but will still seem as if it was by the user)
1969      * @param int $messageid The message id
1970      * @return bool Returns true if a user can delete the message, false otherwise.
1971      */
1972     public static function can_delete_message($userid, $messageid) {
1973         global $DB, $USER;
1975         $systemcontext = \context_system::instance();
1977         $conversationid = $DB->get_field('messages', 'conversationid', ['id' => $messageid], MUST_EXIST);
1979         if (has_capability('moodle/site:deleteanymessage', $systemcontext)) {
1980             return true;
1981         }
1983         if (!self::is_user_in_conversation($userid, $conversationid)) {
1984             return false;
1985         }
1987         if (has_capability('moodle/site:deleteownmessage', $systemcontext) &&
1988                 $USER->id == $userid) {
1989             return true;
1990         }
1992         return false;
1993     }
1995     /**
1996      * Deletes a message.
1997      *
1998      * This function does not verify any permissions.
1999      *
2000      * @param int $userid the user id of who we want to delete the message for (this may be done by the admin
2001      *  but will still seem as if it was by the user)
2002      * @param int $messageid The message id
2003      * @return bool
2004      */
2005     public static function delete_message($userid, $messageid) {
2006         global $DB, $USER;
2008         if (!$DB->record_exists('messages', ['id' => $messageid])) {
2009             return false;
2010         }
2012         // Check if the user has already deleted this message.
2013         if (!$DB->record_exists('message_user_actions', ['userid' => $userid,
2014                 'messageid' => $messageid, 'action' => self::MESSAGE_ACTION_DELETED])) {
2015             $mua = new \stdClass();
2016             $mua->userid = $userid;
2017             $mua->messageid = $messageid;
2018             $mua->action = self::MESSAGE_ACTION_DELETED;
2019             $mua->timecreated = time();
2020             $mua->id = $DB->insert_record('message_user_actions', $mua);
2022             // Trigger event for deleting a message.
2023             \core\event\message_deleted::create_from_ids($userid, $USER->id,
2024                 $messageid, $mua->id)->trigger();
2026             return true;
2027         }
2029         return false;
2030     }
2032     /**
2033      * Returns the conversation between two users.
2034      *
2035      * @param array $userids
2036      * @return int|bool The id of the conversation, false if not found
2037      */
2038     public static function get_conversation_between_users(array $userids) {
2039         global $DB;
2041         $conversations = self::get_individual_conversations_between_users([$userids]);
2042         $conversation = $conversations[0];
2044         if ($conversation) {
2045             return $conversation->id;
2046         }
2048         return false;
2049     }
2051     /**
2052      * Returns the conversations between sets of users.
2053      *
2054      * The returned array of results will be in the same order as the requested
2055      * arguments, null will be returned if there is no conversation for that user
2056      * pair.
2057      *
2058      * For example:
2059      * If we have 6 users with ids 1, 2, 3, 4, 5, 6 where only 2 conversations
2060      * exist. One between 1 and 2 and another between 5 and 6.
2061      *
2062      * Then if we call:
2063      * $conversations = get_individual_conversations_between_users([[1,2], [3,4], [5,6]]);
2064      *
2065      * The conversations array will look like:
2066      * [<conv_record>, null, <conv_record>];
2067      *
2068      * Where null is returned for the pairing of [3, 4] since no record exists.
2069      *
2070      * @param array $useridsets An array of arrays where the inner array is the set of user ids
2071      * @return stdClass[] Array of conversation records
2072      */
2073     public static function get_individual_conversations_between_users(array $useridsets) : array {
2074         global $DB;
2076         if (empty($useridsets)) {
2077             return [];
2078         }
2080         $hashes = array_map(function($userids) {
2081             return  helper::get_conversation_hash($userids);
2082         }, $useridsets);
2084         list($inorequalsql, $params) = $DB->get_in_or_equal($hashes);
2085         array_unshift($params, self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL);
2086         $where = "type = ? AND convhash ${inorequalsql}";
2087         $conversations = array_fill(0, count($hashes), null);
2088         $records = $DB->get_records_select('message_conversations', $where, $params);
2090         foreach (array_values($records) as $record) {
2091             $index = array_search($record->convhash, $hashes);
2092             if ($index !== false) {
2093                 $conversations[$index] = $record;
2094             }
2095         }
2097         return $conversations;
2098     }
2100     /**
2101      * Creates a conversation between two users.
2102      *
2103      * @deprecated since 3.6
2104      * @param array $userids
2105      * @return int The id of the conversation
2106      */
2107     public static function create_conversation_between_users(array $userids) {
2108         debugging('\core_message\api::create_conversation_between_users is deprecated, please use ' .
2109             '\core_message\api::create_conversation instead.', DEBUG_DEVELOPER);
2111         // This method was always used for individual conversations.
2112         $conversation = self::create_conversation(self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL, $userids);
2114         return $conversation->id;
2115     }
2117     /**
2118      * Creates a conversation with selected users and messages.
2119      *
2120      * @param int $type The type of conversation
2121      * @param int[] $userids The array of users to add to the conversation
2122      * @param string|null $name The name of the conversation
2123      * @param int $enabled Determines if the conversation is created enabled or disabled
2124      * @param string|null $component Defines the Moodle component which the conversation belongs to, if any
2125      * @param string|null $itemtype Defines the type of the component
2126      * @param int|null $itemid The id of the component
2127      * @param int|null $contextid The id of the context
2128      * @return \stdClass
2129      */
2130     public static function create_conversation(int $type, array $userids, string $name = null,
2131             int $enabled = self::MESSAGE_CONVERSATION_ENABLED, string $component = null,
2132             string $itemtype = null, int $itemid = null, int $contextid = null) {
2134         global $DB;
2136         $validtypes = [
2137             self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL,
2138             self::MESSAGE_CONVERSATION_TYPE_GROUP
2139         ];
2141         if (!in_array($type, $validtypes)) {
2142             throw new \moodle_exception('An invalid conversation type was specified.');
2143         }
2145         // Sanity check.
2146         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2147             if (count($userids) > 2) {
2148                 throw new \moodle_exception('An individual conversation can not have more than two users.');
2149             }
2150         }
2152         $conversation = new \stdClass();
2153         $conversation->type = $type;
2154         $conversation->name = $name;
2155         $conversation->convhash = null;
2156         if ($type == self::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
2157             $conversation->convhash = helper::get_conversation_hash($userids);
2158         }
2159         $conversation->component = $component;
2160         $conversation->itemtype = $itemtype;
2161         $conversation->itemid = $itemid;
2162         $conversation->contextid = $contextid;
2163         $conversation->enabled = $enabled;
2164         $conversation->timecreated = time();
2165         $conversation->timemodified = $conversation->timecreated;
2166         $conversation->id = $DB->insert_record('message_conversations', $conversation);
2168         // Add users to this conversation.
2169         $arrmembers = [];
2170         foreach ($userids as $userid) {
2171             $member = new \stdClass();
2172             $member->conversationid = $conversation->id;
2173             $member->userid = $userid;
2174             $member->timecreated = time();
2175             $member->id = $DB->insert_record('message_conversation_members', $member);
2177             $arrmembers[] = $member;
2178         }
2180         $conversation->members = $arrmembers;
2182         return $conversation;
2183     }
2185     /**
2186      * Checks if a user can create a group conversation.
2187      *
2188      * @param int $userid The id of the user attempting to create the conversation
2189      * @param \context $context The context they are creating the conversation from, most likely course context
2190      * @return bool
2191      */
2192     public static function can_create_group_conversation(int $userid, \context $context) : bool {
2193         global $CFG;
2195         // If we can't message at all, then we can't create a conversation.
2196         if (empty($CFG->messaging)) {
2197             return false;
2198         }
2200         // We need to check they have the capability to create the conversation.
2201         return has_capability('moodle/course:creategroupconversations', $context, $userid);
2202     }
2204     /**
2205      * Checks if a user can create a contact request.
2206      *
2207      * @param int $userid The id of the user who is creating the contact request
2208      * @param int $requesteduserid The id of the user being requested
2209      * @return bool
2210      */
2211     public static function can_create_contact(int $userid, int $requesteduserid) : bool {
2212         global $CFG;
2214         // If we can't message at all, then we can't create a contact.
2215         if (empty($CFG->messaging)) {
2216             return false;
2217         }
2219         // If we can message anyone on the site then we can create a contact.
2220         if ($CFG->messagingallusers) {
2221             return true;
2222         }
2224         // We need to check if they are in the same course.
2225         return enrol_sharing_course($userid, $requesteduserid);
2226     }
2228     /**
2229      * Handles creating a contact request.
2230      *
2231      * @param int $userid The id of the user who is creating the contact request
2232      * @param int $requesteduserid The id of the user being requested
2233      * @return \stdClass the request
2234      */
2235     public static function create_contact_request(int $userid, int $requesteduserid) : \stdClass {
2236         global $DB;
2238         $request = new \stdClass();
2239         $request->userid = $userid;
2240         $request->requesteduserid = $requesteduserid;
2241         $request->timecreated = time();
2243         $request->id = $DB->insert_record('message_contact_requests', $request);
2245         return $request;
2246     }
2249     /**
2250      * Handles confirming a contact request.
2251      *
2252      * @param int $userid The id of the user who created the contact request
2253      * @param int $requesteduserid The id of the user confirming the request
2254      */
2255     public static function confirm_contact_request(int $userid, int $requesteduserid) {
2256         global $DB;
2258         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2259                 'requesteduserid' => $requesteduserid])) {
2260             self::add_contact($userid, $requesteduserid);
2262             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2263         }
2264     }
2266     /**
2267      * Handles declining a contact request.
2268      *
2269      * @param int $userid The id of the user who created the contact request
2270      * @param int $requesteduserid The id of the user declining the request
2271      */
2272     public static function decline_contact_request(int $userid, int $requesteduserid) {
2273         global $DB;
2275         if ($request = $DB->get_record('message_contact_requests', ['userid' => $userid,
2276                 'requesteduserid' => $requesteduserid])) {
2277             $DB->delete_records('message_contact_requests', ['id' => $request->id]);
2278         }
2279     }
2281     /**
2282      * Handles returning the contact requests for a user.
2283      *
2284      * This also includes the user data necessary to display information
2285      * about the user.
2286      *
2287      * It will not include blocked users.
2288      *
2289      * @param int $userid
2290      * @param int $limitfrom
2291      * @param int $limitnum
2292      * @return array The list of contact requests
2293      */
2294     public static function get_contact_requests(int $userid, int $limitfrom = 0, int $limitnum = 0) : array {
2295         global $DB;
2297         $sql = "SELECT mcr.userid
2298                   FROM {message_contact_requests} mcr
2299              LEFT JOIN {message_users_blocked} mub
2300                     ON (mub.userid = ? AND mub.blockeduserid = mcr.userid)
2301                  WHERE mcr.requesteduserid = ?
2302                    AND mub.id is NULL
2303               ORDER BY mcr.timecreated ASC";
2304         if ($contactrequests = $DB->get_records_sql($sql, [$userid, $userid], $limitfrom, $limitnum)) {
2305             $userids = array_keys($contactrequests);
2306             return helper::get_member_info($userid, $userids);
2307         }
2309         return [];
2310     }
2312     /**
2313      * Count how many contact requests the user has received.
2314      *
2315      * @param \stdClass $user The user to fetch contact requests for
2316      * @return int The count
2317      */
2318     public static function count_received_contact_requests(\stdClass $user) : int {
2319         global $DB;
2320         return $DB->count_records('message_contact_requests', ['requesteduserid' => $user->id]);
2321     }
2323     /**
2324      * Handles adding a contact.
2325      *
2326      * @param int $userid The id of the user who requested to be a contact
2327      * @param int $contactid The id of the contact
2328      */
2329     public static function add_contact(int $userid, int $contactid) {
2330         global $DB;
2332         $messagecontact = new \stdClass();
2333         $messagecontact->userid = $userid;
2334         $messagecontact->contactid = $contactid;
2335         $messagecontact->timecreated = time();
2336         $messagecontact->id = $DB->insert_record('message_contacts', $messagecontact);
2338         $eventparams = [
2339             'objectid' => $messagecontact->id,
2340             'userid' => $userid,
2341             'relateduserid' => $contactid,
2342             'context' => \context_user::instance($userid)
2343         ];
2344         $event = \core\event\message_contact_added::create($eventparams);
2345         $event->add_record_snapshot('message_contacts', $messagecontact);
2346         $event->trigger();
2347     }
2349     /**
2350      * Handles removing a contact.
2351      *
2352      * @param int $userid The id of the user who is removing a user as a contact
2353      * @param int $contactid The id of the user to be removed as a contact
2354      */
2355     public static function remove_contact(int $userid, int $contactid) {
2356         global $DB;
2358         if ($contact = self::get_contact($userid, $contactid)) {
2359             $DB->delete_records('message_contacts', ['id' => $contact->id]);
2361             $event = \core\event\message_contact_removed::create(array(
2362                 'objectid' => $contact->id,
2363                 'userid' => $userid,
2364                 'relateduserid' => $contactid,
2365                 'context' => \context_user::instance($userid)
2366             ));
2367             $event->add_record_snapshot('message_contacts', $contact);
2368             $event->trigger();
2369         }
2370     }
2372     /**
2373      * Handles blocking a user.
2374      *
2375      * @param int $userid The id of the user who is blocking
2376      * @param int $usertoblockid The id of the user being blocked
2377      */
2378     public static function block_user(int $userid, int $usertoblockid) {
2379         global $DB;
2381         $blocked = new \stdClass();
2382         $blocked->userid = $userid;
2383         $blocked->blockeduserid = $usertoblockid;
2384         $blocked->timecreated = time();
2385         $blocked->id = $DB->insert_record('message_users_blocked', $blocked);
2387         // Trigger event for blocking a contact.
2388         $event = \core\event\message_user_blocked::create(array(
2389             'objectid' => $blocked->id,
2390             'userid' => $userid,
2391             'relateduserid' => $usertoblockid,
2392             'context' => \context_user::instance($userid)
2393         ));
2394         $event->add_record_snapshot('message_users_blocked', $blocked);
2395         $event->trigger();
2396     }
2398     /**
2399      * Handles unblocking a user.
2400      *
2401      * @param int $userid The id of the user who is unblocking
2402      * @param int $usertounblockid The id of the user being unblocked
2403      */
2404     public static function unblock_user(int $userid, int $usertounblockid) {
2405         global $DB;
2407         if ($blockeduser = $DB->get_record('message_users_blocked',
2408                 ['userid' => $userid, 'blockeduserid' => $usertounblockid])) {
2409             $DB->delete_records('message_users_blocked', ['id' => $blockeduser->id]);
2411             // Trigger event for unblocking a contact.
2412             $event = \core\event\message_user_unblocked::create(array(
2413                 'objectid' => $blockeduser->id,
2414                 'userid' => $userid,
2415                 'relateduserid' => $usertounblockid,
2416                 'context' => \context_user::instance($userid)
2417             ));
2418             $event->add_record_snapshot('message_users_blocked', $blockeduser);
2419             $event->trigger();
2420         }
2421     }
2423     /**
2424      * Checks if users are already contacts.
2425      *
2426      * @param int $userid The id of one of the users
2427      * @param int $contactid The id of the other user
2428      * @return bool Returns true if they are a contact, false otherwise
2429      */
2430     public static function is_contact(int $userid, int $contactid) : bool {
2431         global $DB;
2433         $sql = "SELECT id
2434                   FROM {message_contacts} mc
2435                  WHERE (mc.userid = ? AND mc.contactid = ?)
2436                     OR (mc.userid = ? AND mc.contactid = ?)";
2437         return $DB->record_exists_sql($sql, [$userid, $contactid, $contactid, $userid]);
2438     }
2440     /**
2441      * Returns the row in the database table message_contacts that represents the contact between two people.
2442      *
2443      * @param int $userid The id of one of the users
2444      * @param int $contactid The id of the other user
2445      * @return mixed A fieldset object containing the record, false otherwise
2446      */
2447     public static function get_contact(int $userid, int $contactid) {
2448         global $DB;
2450         $sql = "SELECT mc.*
2451                   FROM {message_contacts} mc
2452                  WHERE (mc.userid = ? AND mc.contactid = ?)
2453                     OR (mc.userid = ? AND mc.contactid = ?)";
2454         return $DB->get_record_sql($sql, [$userid, $contactid, $contactid, $userid]);
2455     }
2457     /**
2458      * Checks if a user is already blocked.
2459      *
2460      * @param int $userid
2461      * @param int $blockeduserid
2462      * @return bool Returns true if they are a blocked, false otherwise
2463      */
2464     public static function is_blocked(int $userid, int $blockeduserid) : bool {
2465         global $DB;
2467         return $DB->record_exists('message_users_blocked', ['userid' => $userid, 'blockeduserid' => $blockeduserid]);
2468     }
2470     /**
2471      * Get contact requests between users.
2472      *
2473      * @param int $userid The id of the user who is creating the contact request
2474      * @param int $requesteduserid The id of the user being requested
2475      * @return \stdClass[]
2476      */
2477     public static function get_contact_requests_between_users(int $userid, int $requesteduserid) : array {
2478         global $DB;
2480         $sql = "SELECT *
2481                   FROM {message_contact_requests} mcr
2482                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2483                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2484         return $DB->get_records_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2485     }
2487     /**
2488      * Checks if a contact request already exists between users.
2489      *
2490      * @param int $userid The id of the user who is creating the contact request
2491      * @param int $requesteduserid The id of the user being requested
2492      * @return bool Returns true if a contact request exists, false otherwise
2493      */
2494     public static function does_contact_request_exist(int $userid, int $requesteduserid) : bool {
2495         global $DB;
2497         $sql = "SELECT id
2498                   FROM {message_contact_requests} mcr
2499                  WHERE (mcr.userid = ? AND mcr.requesteduserid = ?)
2500                     OR (mcr.userid = ? AND mcr.requesteduserid = ?)";
2501         return $DB->record_exists_sql($sql, [$userid, $requesteduserid, $requesteduserid, $userid]);
2502     }
2504     /**
2505      * Checks if a user is already in a conversation.
2506      *
2507      * @param int $userid The id of the user we want to check if they are in a group
2508      * @param int $conversationid The id of the conversation
2509      * @return bool Returns true if a contact request exists, false otherwise
2510      */
2511     public static function is_user_in_conversation(int $userid, int $conversationid) : bool {
2512         global $DB;
2514         return $DB->record_exists('message_conversation_members', ['conversationid' => $conversationid,
2515             'userid' => $userid]);
2516     }
2518     /**
2519      * Checks if the sender can message the recipient.
2520      *
2521      * @param int $recipientid
2522      * @param int $senderid
2523      * @return bool true if recipient hasn't blocked sender and sender can contact to recipient, false otherwise.
2524      */
2525     protected static function can_contact_user(int $recipientid, int $senderid) : bool {
2526         if (has_capability('moodle/site:messageanyuser', \context_system::instance(), $senderid)) {
2527             // The sender has the ability to contact any user across the entire site.
2528             return true;
2529         }
2531         // The initial value of $cancontact is null to indicate that a value has not been determined.
2532         $cancontact = null;
2534         if (self::is_blocked($recipientid, $senderid)) {
2535             // The recipient has specifically blocked this sender.
2536             $cancontact = false;
2537         }
2539         $sharedcourses = null;
2540         if (null === $cancontact) {
2541             // There are three user preference options:
2542             // - Site: Allow anyone not explicitly blocked to contact me;
2543             // - Course members: Allow anyone I am in a course with to contact me; and
2544             // - Contacts: Only allow my contacts to contact me.
2545             //
2546             // The Site option is only possible when the messagingallusers site setting is also enabled.
2548             $privacypreference = self::get_user_privacy_messaging_preference($recipientid);
2549             if (self::MESSAGE_PRIVACY_SITE === $privacypreference) {
2550                 // The user preference is to allow any user to contact them.
2551                 // No need to check anything else.
2552                 $cancontact = true;
2553             } else {
2554                 // This user only allows their own contacts, and possibly course peers, to contact them.
2555                 // If the users are contacts then we can avoid the more expensive shared courses check.
2556                 $cancontact = self::is_contact($senderid, $recipientid);
2558                 if (!$cancontact && self::MESSAGE_PRIVACY_COURSEMEMBER === $privacypreference) {
2559                     // The users are not contacts and the user allows course member messaging.
2560                     // Check whether these two users share any course together.
2561                     $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2562                     $cancontact = (!empty($sharedcourses));
2563                 }
2564             }
2565         }
2567         if (false === $cancontact) {
2568             // At the moment the users cannot contact one another.
2569             // Check whether the messageanyuser capability applies in any of the shared courses.
2570             // This is intended to allow teachers to message students regardless of message settings.
2572             // Note: You cannot use empty($sharedcourses) here because this may be an empty array.
2573             if (null === $sharedcourses) {
2574                 $sharedcourses = enrol_get_shared_courses($recipientid, $senderid, true);
2575             }
2577             foreach ($sharedcourses as $course) {
2578                 // Note: enrol_get_shared_courses will preload any shared context.
2579                 if (has_capability('moodle/site:messageanyuser', \context_course::instance($course->id), $senderid)) {
2580                     $cancontact = true;
2581                     break;
2582                 }
2583             }
2584         }
2586         return $cancontact;
2587     }
2589     /**
2590      * Add some new members to an existing conversation.
2591      *
2592      * @param array $userids User ids array to add as members.
2593      * @param int $convid The conversation id. Must exists.
2594      * @throws \dml_missing_record_exception If convid conversation doesn't exist
2595      * @throws \dml_exception If there is a database error
2596      * @throws \moodle_exception If trying to add a member(s) to a non-group conversation
2597      */
2598     public static function add_members_to_conversation(array $userids, int $convid) {
2599         global $DB;
2601         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2603         // We can only add members to a group conversation.
2604         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2605             throw new \moodle_exception('You can not add members to a non-group conversation.');
2606         }
2608         // Be sure we are not trying to add a non existing user to the conversation. Work only with existing users.
2609         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2610         $existingusers = $DB->get_fieldset_select('user', 'id', "id $useridcondition", $params);
2612         // Be sure we are not adding a user is already member of the conversation. Take all the members.
2613         $memberuserids = array_values($DB->get_records_menu(
2614             'message_conversation_members', ['conversationid' => $convid], 'id', 'id, userid')
2615         );
2617         // Work with existing new members.
2618         $members = array();
2619         $newuserids = array_diff($existingusers, $memberuserids);
2620         foreach ($newuserids as $userid) {
2621             $member = new \stdClass();
2622             $member->conversationid = $convid;
2623             $member->userid = $userid;
2624             $member->timecreated = time();
2625             $members[] = $member;
2626         }
2628         $DB->insert_records('message_conversation_members', $members);
2629     }
2631     /**
2632      * Remove some members from an existing conversation.
2633      *
2634      * @param array $userids The user ids to remove from conversation members.
2635      * @param int $convid The conversation id. Must exists.
2636      * @throws \dml_exception
2637      * @throws \moodle_exception If trying to remove a member(s) from a non-group conversation
2638      */
2639     public static function remove_members_from_conversation(array $userids, int $convid) {
2640         global $DB;
2642         $conversation = $DB->get_record('message_conversations', ['id' => $convid], '*', MUST_EXIST);
2644         if ($conversation->type != self::MESSAGE_CONVERSATION_TYPE_GROUP) {
2645             throw new \moodle_exception('You can not remove members from a non-group conversation.');
2646         }
2648         list($useridcondition, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
2649         $params['convid'] = $convid;
2651         $DB->delete_records_select('message_conversation_members',
2652             "conversationid = :convid AND userid $useridcondition", $params);
2653     }
2655     /**
2656      * Count conversation members.
2657      *
2658      * @param int $convid The conversation id.
2659      * @return int Number of conversation members.
2660      * @throws \dml_exception
2661      */
2662     public static function count_conversation_members(int $convid) : int {
2663         global $DB;
2665         return $DB->count_records('message_conversation_members', ['conversationid' => $convid]);
2666     }
2668     /**
2669      * Checks whether or not a conversation area is enabled.
2670      *
2671      * @param string $component Defines the Moodle component which the area was added to.
2672      * @param string $itemtype Defines the type of the component.
2673      * @param int $itemid The id of the component.
2674      * @param int $contextid The id of the context.
2675      * @return bool Returns if a conversation area exists and is enabled, false otherwise
2676      */
2677     public static function is_conversation_area_enabled(string $component, string $itemtype, int $itemid, int $contextid) : bool {
2678         global $DB;
2680         return $DB->record_exists('message_conversations',
2681             [
2682                 'itemid' => $itemid,
2683                 'contextid' => $contextid,
2684                 'component' => $component,
2685                 'itemtype' => $itemtype,
2686                 'enabled' => self::MESSAGE_CONVERSATION_ENABLED
2687             ]
2688         );
2689     }
2691     /**
2692      * Get conversation by area.
2693      *
2694      * @param string $component Defines the Moodle component which the area was added to.
2695      * @param string $itemtype Defines the type of the component.
2696      * @param int $itemid The id of the component.
2697      * @param int $contextid The id of the context.
2698      * @return \stdClass
2699      */
2700     public static function get_conversation_by_area(string $component, string $itemtype, int $itemid, int $contextid) {
2701         global $DB;
2703         return $DB->get_record('message_conversations',
2704             [
2705                 'itemid' => $itemid,
2706                 'contextid' => $contextid,
2707                 'component' => $component,
2708                 'itemtype'  => $itemtype
2709             ]
2710         );
2711     }
2713     /**
2714      * Enable a conversation.
2715      *
2716      * @param int $conversationid The id of the conversation.
2717      * @return void
2718      */
2719     public static function enable_conversation(int $conversationid) {
2720         global $DB;
2722         $conversation = new \stdClass();
2723         $conversation->id = $conversationid;
2724         $conversation->enabled = self::MESSAGE_CONVERSATION_ENABLED;
2725         $conversation->timemodified = time();
2726         $DB->update_record('message_conversations', $conversation);
2727     }
2729     /**
2730      * Disable a conversation.
2731      *
2732      * @param int $conversationid The id of the conversation.
2733      * @return void
2734      */
2735     public static function disable_conversation(int $conversationid) {
2736         global $DB;
2738         $conversation = new \stdClass();
2739         $conversation->id = $conversationid;
2740         $conversation->enabled = self::MESSAGE_CONVERSATION_DISABLED;
2741         $conversation->timemodified = time();
2742         $DB->update_record('message_conversations', $conversation);
2743     }
2745     /**
2746      * Update the name of a conversation.
2747      *
2748      * @param int $conversationid The id of a conversation.
2749      * @param string $name The main name of the area
2750      * @return void
2751      */
2752     public static function update_conversation_name(int $conversationid, string $name) {
2753         global $DB;
2755         if ($conversation = $DB->get_record('message_conversations', array('id' => $conversationid))) {
2756             if ($name <> $conversation->name) {
2757                 $conversation->name = $name;
2758                 $conversation->timemodified = time();
2759                 $DB->update_record('message_conversations', $conversation);
2760             }
2761         }
2762     }
2764     /**
2765      * Returns a list of conversation members.
2766      *
2767      * @param int $userid The user we are returning the conversation members for, used by helper::get_member_info.
2768      * @param int $conversationid The id of the conversation
2769      * @param bool $includecontactrequests Do we want to include contact requests with this data?
2770      * @param int $limitfrom
2771      * @param int $limitnum
2772      * @return array
2773      */
2774     public static function get_conversation_members(int $userid, int $conversationid, bool $includecontactrequests = false,
2775                                                     int $limitfrom = 0, int $limitnum = 0) : array {
2776         global $DB;
2778         if ($members = $DB->get_records('message_conversation_members', ['conversationid' => $conversationid],
2779                 'timecreated ASC, id ASC', 'userid', $limitfrom, $limitnum)) {
2780             $userids = array_keys($members);
2781             $members = helper::get_member_info($userid, $userids, $includecontactrequests);
2783             return $members;
2784         }
2786         return [];
2787     }