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