d2c4ececffc88f8d13e21d643a0b5e6652030fbb
[moodle.git] / message / classes / helper.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 helper class 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 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Helper class for the message area.
31  *
32  * @copyright  2016 Mark Nelson <markn@moodle.com>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class helper {
37     /**
38      * Helper function to retrieve the messages between two users
39      *
40      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
41      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
42      * Followup: MDL-63915
43      *
44      * @param int $userid the current user
45      * @param int $otheruserid the other user
46      * @param int $timedeleted the time the message was deleted
47      * @param int $limitfrom
48      * @param int $limitnum
49      * @param string $sort
50      * @param int $timefrom the time from the message being sent
51      * @param int $timeto the time up until the message being sent
52      * @return array of messages
53      */
54     public static function get_messages($userid, $otheruserid, $timedeleted = 0, $limitfrom = 0, $limitnum = 0,
55                                         $sort = 'timecreated ASC', $timefrom = 0, $timeto = 0) {
56         global $DB;
58         $hash = self::get_conversation_hash([$userid, $otheruserid]);
60         $sql = "SELECT m.id, m.useridfrom, m.subject, m.fullmessage, m.fullmessagehtml,
61                        m.fullmessageformat, m.smallmessage, m.timecreated, muaread.timecreated AS timeread
62                   FROM {message_conversations} mc
63             INNER JOIN {messages} m
64                     ON m.conversationid = mc.id
65              LEFT JOIN {message_user_actions} muaread
66                     ON (muaread.messageid = m.id
67                    AND muaread.userid = :userid1
68                    AND muaread.action = :readaction)";
69         $params = ['userid1' => $userid, 'readaction' => api::MESSAGE_ACTION_READ, 'convhash' => $hash];
71         if (empty($timedeleted)) {
72             $sql .= " LEFT JOIN {message_user_actions} mua
73                              ON (mua.messageid = m.id
74                             AND mua.userid = :userid2
75                             AND mua.action = :deleteaction
76                             AND mua.timecreated is NOT NULL)";
77         } else {
78             $sql .= " INNER JOIN {message_user_actions} mua
79                               ON (mua.messageid = m.id
80                              AND mua.userid = :userid2
81                              AND mua.action = :deleteaction
82                              AND mua.timecreated = :timedeleted)";
83             $params['timedeleted'] = $timedeleted;
84         }
86         $params['userid2'] = $userid;
87         $params['deleteaction'] = api::MESSAGE_ACTION_DELETED;
89         $sql .= " WHERE mc.convhash = :convhash";
91         if (!empty($timefrom)) {
92             $sql .= " AND m.timecreated >= :timefrom";
93             $params['timefrom'] = $timefrom;
94         }
96         if (!empty($timeto)) {
97             $sql .= " AND m.timecreated <= :timeto";
98             $params['timeto'] = $timeto;
99         }
101         if (empty($timedeleted)) {
102             $sql .= " AND mua.id is NULL";
103         }
105         $sql .= " ORDER BY m.$sort";
107         $messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
108         foreach ($messages as &$message) {
109             $message->useridto = ($message->useridfrom == $userid) ? $otheruserid : $userid;
110         }
112         return $messages;
113     }
115     /**
116      * Helper function to retrieve conversation messages.
117      *
118      * @param  int $userid The current user.
119      * @param  int $convid The conversation identifier.
120      * @param  int $timedeleted The time the message was deleted
121      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
122      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
123      * @param  string $sort The column name to order by including optionally direction.
124      * @param  int $timefrom The time from the message being sent.
125      * @param  int $timeto The time up until the message being sent.
126      * @return array of messages
127      */
128     public static function get_conversation_messages(int $userid, int $convid, int $timedeleted = 0, int $limitfrom = 0,
129                                                      int $limitnum = 0, string $sort = 'timecreated ASC', int $timefrom = 0,
130                                                      int $timeto = 0) : array {
131         global $DB;
133         $sql = "SELECT m.id, m.useridfrom, m.subject, m.fullmessage, m.fullmessagehtml,
134                        m.fullmessageformat, m.smallmessage, m.timecreated, muaread.timecreated AS timeread
135                   FROM {message_conversations} mc
136             INNER JOIN {messages} m
137                     ON m.conversationid = mc.id
138              LEFT JOIN {message_user_actions} muaread
139                     ON (muaread.messageid = m.id
140                    AND muaread.userid = :userid1
141                    AND muaread.action = :readaction)";
142         $params = ['userid1' => $userid, 'readaction' => api::MESSAGE_ACTION_READ, 'convid' => $convid];
144         if (empty($timedeleted)) {
145             $sql .= " LEFT JOIN {message_user_actions} mua
146                              ON (mua.messageid = m.id
147                             AND mua.userid = :userid2
148                             AND mua.action = :deleteaction
149                             AND mua.timecreated is NOT NULL)";
150         } else {
151             $sql .= " INNER JOIN {message_user_actions} mua
152                               ON (mua.messageid = m.id
153                              AND mua.userid = :userid2
154                              AND mua.action = :deleteaction
155                              AND mua.timecreated = :timedeleted)";
156             $params['timedeleted'] = $timedeleted;
157         }
159         $params['userid2'] = $userid;
160         $params['deleteaction'] = api::MESSAGE_ACTION_DELETED;
162         $sql .= " WHERE mc.id = :convid";
164         if (!empty($timefrom)) {
165             $sql .= " AND m.timecreated >= :timefrom";
166             $params['timefrom'] = $timefrom;
167         }
169         if (!empty($timeto)) {
170             $sql .= " AND m.timecreated <= :timeto";
171             $params['timeto'] = $timeto;
172         }
174         if (empty($timedeleted)) {
175             $sql .= " AND mua.id is NULL";
176         }
178         $sql .= " ORDER BY m.$sort";
180         $messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
182         return $messages;
183     }
185     /**
186      * Helper function to return a conversation messages with the involved members (only the ones
187      * who have sent any of these messages).
188      *
189      * @param int $userid The current userid.
190      * @param int $convid The conversation id.
191      * @param array $messages The formated array messages.
192      * @return array A conversation array with the messages and the involved members.
193      */
194     public static function format_conversation_messages(int $userid, int $convid, array $messages) : array {
195         global $USER;
197         // Create the conversation array.
198         $conversation = array(
199             'id' => $convid,
200         );
202         // Store the messages.
203         $arrmessages = array();
205         foreach ($messages as $message) {
206             // Store the message information.
207             $msg = new \stdClass();
208             $msg->id = $message->id;
209             $msg->useridfrom = $message->useridfrom;
210             $msg->text = message_format_message_text($message);
211             $msg->timecreated = $message->timecreated;
212             $arrmessages[] = $msg;
213         }
214         // Add the messages to the conversation.
215         $conversation['messages'] = $arrmessages;
217         // Get the users who have sent any of the $messages.
218         $memberids = array_unique(array_map(function($message) {
219             return $message->useridfrom;
220         }, $messages));
222         if (!empty($memberids)) {
223             // Get members information.
224             $conversation['members'] = self::get_member_info($userid, $memberids);
225         } else {
226             $conversation['members'] = array();
227         }
229         return $conversation;
230     }
232     /**
233      * Helper function to return an array of messages.
234      *
235      * TODO: This function should be removed once the new group messaging UI is in place and the old messaging UI is removed.
236      * For now we are not removing/deprecating this function for backwards compatibility with messaging UI.
237      * Followup: MDL-63915
238      *
239      * @param int $userid
240      * @param array $messages
241      * @return array
242      */
243     public static function create_messages($userid, $messages) {
244         // Store the messages.
245         $arrmessages = array();
247         // We always view messages from oldest to newest, ensure we have it in that order.
248         $lastmessage = end($messages);
249         $firstmessage = reset($messages);
250         if ($lastmessage->timecreated < $firstmessage->timecreated) {
251             $messages = array_reverse($messages);
252         }
254         // Keeps track of the last day, month and year combo we were viewing.
255         $day = '';
256         $month = '';
257         $year = '';
258         foreach ($messages as $message) {
259             // Check if we are now viewing a different block period.
260             $displayblocktime = false;
261             $date = usergetdate($message->timecreated);
262             if ($day != $date['mday'] || $month != $date['month'] || $year != $date['year']) {
263                 $day = $date['mday'];
264                 $month = $date['month'];
265                 $year = $date['year'];
266                 $displayblocktime = true;
267             }
268             // Store the message to pass to the renderable.
269             $msg = new \stdClass();
270             $msg->id = $message->id;
271             $msg->text = message_format_message_text($message);
272             $msg->currentuserid = $userid;
273             $msg->useridfrom = $message->useridfrom;
274             $msg->useridto = $message->useridto;
275             $msg->displayblocktime = $displayblocktime;
276             $msg->timecreated = $message->timecreated;
277             $msg->timeread = $message->timeread;
278             $arrmessages[] = $msg;
279         }
281         return $arrmessages;
282     }
284     /**
285      * Helper function for creating a contact object.
286      *
287      * @param \stdClass $contact
288      * @param string $prefix
289      * @return \stdClass
290      */
291     public static function create_contact($contact, $prefix = '') {
292         global $PAGE;
294         // Create the data we are going to pass to the renderable.
295         $userfields = \user_picture::unalias($contact, array('lastaccess'), $prefix . 'id', $prefix);
296         $data = new \stdClass();
297         $data->userid = $userfields->id;
298         $data->useridfrom = null;
299         $data->fullname = fullname($userfields);
300         // Get the user picture data.
301         $userpicture = new \user_picture($userfields);
302         $userpicture->size = 1; // Size f1.
303         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
304         $userpicture->size = 0; // Size f2.
305         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
306         // Store the message if we have it.
307         $data->ismessaging = false;
308         $data->lastmessage = null;
309         $data->lastmessagedate = null;
310         $data->messageid = null;
311         if (isset($contact->smallmessage)) {
312             $data->ismessaging = true;
313             // Strip the HTML tags from the message for displaying in the contact area.
314             $data->lastmessage = clean_param($contact->smallmessage, PARAM_NOTAGS);
315             $data->lastmessagedate = $contact->timecreated;
316             $data->useridfrom = $contact->useridfrom;
317             if (isset($contact->messageid)) {
318                 $data->messageid = $contact->messageid;
319             }
320         }
321         $data->isonline = null;
322         $user = \core_user::get_user($data->userid);
323         if (self::show_online_status($user)) {
324             $data->isonline = self::is_online($userfields->lastaccess);
325         }
326         $data->isblocked = isset($contact->blocked) ? (bool) $contact->blocked : false;
327         $data->isread = isset($contact->isread) ? (bool) $contact->isread : false;
328         $data->unreadcount = isset($contact->unreadcount) ? $contact->unreadcount : null;
330         return $data;
331     }
333     /**
334      * Helper function for checking if we should show the user's online status.
335      *
336      * @param \stdClass $user
337      * @return boolean
338      */
339     public static function show_online_status($user) {
340         global $CFG;
342         require_once($CFG->dirroot . '/user/lib.php');
344         if ($lastaccess = user_get_user_details($user, null, array('lastaccess'))) {
345             if (isset($lastaccess['lastaccess'])) {
346                 return true;
347             }
348         }
350         return false;
351     }
353     /**
354      * Helper function for checking the time meets the 'online' condition.
355      *
356      * @param int $lastaccess
357      * @return boolean
358      */
359     public static function is_online($lastaccess) {
360         global $CFG;
362         // Variable to check if we consider this user online or not.
363         $timetoshowusers = 300; // Seconds default.
364         if (isset($CFG->block_online_users_timetosee)) {
365             $timetoshowusers = $CFG->block_online_users_timetosee * 60;
366         }
367         $time = time() - $timetoshowusers;
369         return $lastaccess >= $time;
370     }
372     /**
373      * Get providers preferences.
374      *
375      * @param array $providers
376      * @param int $userid
377      * @return \stdClass
378      */
379     public static function get_providers_preferences($providers, $userid) {
380         $preferences = new \stdClass();
382         // Get providers preferences.
383         foreach ($providers as $provider) {
384             foreach (array('loggedin', 'loggedoff') as $state) {
385                 $linepref = get_user_preferences('message_provider_' . $provider->component . '_' . $provider->name
386                     . '_' . $state, '', $userid);
387                 if ($linepref == '') {
388                     continue;
389                 }
390                 $lineprefarray = explode(',', $linepref);
391                 $preferences->{$provider->component.'_'.$provider->name.'_'.$state} = array();
392                 foreach ($lineprefarray as $pref) {
393                     $preferences->{$provider->component.'_'.$provider->name.'_'.$state}[$pref] = 1;
394                 }
395             }
396         }
398         return $preferences;
399     }
401     /**
402      * Requires the JS libraries for the toggle contact button.
403      *
404      * @return void
405      */
406     public static function togglecontact_requirejs() {
407         global $PAGE;
409         static $done = false;
410         if ($done) {
411             return;
412         }
414         $PAGE->requires->js_call_amd('core_message/toggle_contact_button', 'enhance', array('#toggle-contact-button'));
415         $done = true;
416     }
418     /**
419      * Returns the attributes to place on a contact button.
420      *
421      * @param object $user User object.
422      * @param bool $iscontact
423      * @return array
424      */
425     public static function togglecontact_link_params($user, $iscontact = false) {
426         $params = array(
427             'data-userid' => $user->id,
428             'data-is-contact' => $iscontact,
429             'id' => 'toggle-contact-button',
430             'role' => 'button',
431             'class' => 'ajax-contact-button',
432         );
434         return $params;
435     }
437     /**
438      * Returns the conversation hash between users for easy look-ups in the DB.
439      *
440      * @param array $userids
441      * @return string
442      */
443     public static function get_conversation_hash(array $userids) {
444         sort($userids);
446         return sha1(implode('-', $userids));
447     }
449     /**
450      * Returns the cache key for the time created value of the last message of this conversation.
451      *
452      * @param int $convid The conversation identifier.
453      * @return string The key.
454      */
455     public static function get_last_message_time_created_cache_key(int $convid) {
456         return $convid;
457     }
459     /**
460      * Checks if legacy messages exist for a given user.
461      *
462      * @param int $userid
463      * @return bool
464      */
465     public static function legacy_messages_exist($userid) {
466         global $DB;
468         $sql = "SELECT id
469                   FROM {message} m
470                  WHERE useridfrom = ?
471                     OR useridto = ?";
472         $messageexists = $DB->record_exists_sql($sql, [$userid, $userid]);
474         $sql = "SELECT id
475                   FROM {message_read} m
476                  WHERE useridfrom = ?
477                     OR useridto = ?";
478         $messagereadexists = $DB->record_exists_sql($sql, [$userid, $userid]);
480         return $messageexists || $messagereadexists;
481     }
483     /**
484      * Returns conversation member info for the supplied users, relative to the supplied referenceuserid.
485      *
486      * This is the basic structure used when returning members, and includes information about the relationship between each member
487      * and the referenceuser, such as a whether the referenceuser has marked the member as a contact, or has blocked them.
488      *
489      * @param int $referenceuserid the id of the user which check contact and blocked status.
490      * @param array $userids
491      * @param bool $includecontactrequests Do we want to include contact requests with this data?
492      * @param bool $includeprivacyinfo Do we want to include whether the user can message another, and if the user
493      *             requires a contact.
494      * @return array the array of objects containing member info, indexed by userid.
495      * @throws \coding_exception
496      * @throws \dml_exception
497      */
498     public static function get_member_info(int $referenceuserid, array $userids, bool $includecontactrequests = false,
499                                            bool $includeprivacyinfo = false) : array {
500         global $DB, $PAGE;
502         // Prevent exception being thrown when array is empty.
503         if (empty($userids)) {
504             return [];
505         }
507         list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
508         $userfields = \user_picture::fields('u', array('lastaccess'));
509         $userssql = "SELECT $userfields, u.deleted, mc.id AS contactid, mub.id AS blockedid
510                        FROM {user} u
511                   LEFT JOIN {message_contacts} mc
512                          ON ((mc.userid = ? AND mc.contactid = u.id) OR (mc.userid = u.id AND mc.contactid = ?))
513                   LEFT JOIN {message_users_blocked} mub
514                          ON (mub.userid = ? AND mub.blockeduserid = u.id)
515                       WHERE u.id $useridsql";
516         $usersparams = array_merge([$referenceuserid, $referenceuserid, $referenceuserid], $usersparams);
517         $otherusers = $DB->get_records_sql($userssql, $usersparams);
519         $members = [];
520         foreach ($otherusers as $member) {
521             // Set basic data.
522             $data = new \stdClass();
523             $data->id = $member->id;
524             $data->fullname = fullname($member);
526             // Set the user picture data.
527             $userpicture = new \user_picture($member);
528             $userpicture->size = 1; // Size f1.
529             $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
530             $userpicture->size = 0; // Size f2.
531             $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
533             // Set online status indicators.
534             $data->isonline = false;
535             $data->showonlinestatus = false;
536             if (!$member->deleted) {
537                 $data->isonline = self::show_online_status($member) ? self::is_online($member->lastaccess) : null;
538                 $data->showonlinestatus = is_null($data->isonline) ? false : true;
539             }
541             // Set contact and blocked status indicators.
542             $data->iscontact = ($member->contactid) ? true : false;
543             $data->isblocked = ($member->blockedid) ? true : false;
545             $data->isdeleted = ($member->deleted) ? true : false;
547             $data->requirescontact = null;
548             $data->canmessage = null;
549             if ($includeprivacyinfo) {
550                 $privacysetting = api::get_user_privacy_messaging_preference($member->id);
551                 $data->requirescontact = $privacysetting == api::MESSAGE_PRIVACY_ONLYCONTACTS;
553                 $recipient = new \stdClass();
554                 $recipient->id = $member->id;
556                 $sender = new \stdClass();
557                 $sender->id = $referenceuserid;
559                 $data->canmessage = api::can_post_message($recipient, $sender);
560             }
562             // Populate the contact requests, even if we don't need them.
563             $data->contactrequests = [];
565             $members[$data->id] = $data;
566         }
568         // Check if we want to include contact requests as well.
569         if (!empty($members) && $includecontactrequests) {
570             list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
572             $wheresql = "(userid $useridsql AND requesteduserid = ?) OR (userid = ? AND requesteduserid $useridsql)";
573             $params = array_merge($usersparams, [$referenceuserid, $referenceuserid], $usersparams);
574             if ($contactrequests = $DB->get_records_select('message_contact_requests', $wheresql, $params,
575                     'timecreated ASC, id ASC')) {
576                 foreach ($contactrequests as $contactrequest) {
577                     if (isset($members[$contactrequest->userid])) {
578                         $members[$contactrequest->userid]->contactrequests[] = $contactrequest;
579                     }
580                     if (isset($members[$contactrequest->requesteduserid])) {
581                         $members[$contactrequest->requesteduserid]->contactrequests[] = $contactrequest;
582                     }
583                 }
584             }
585         }
587         return $members;
588     }
590     /**
591      * Backwards compatibility formatter, transforming the new output of get_conversations() into the old format.
592      *
593      * @param array $conversations the array of conversations, which must come from get_conversations().
594      * @return array the array of conversations, formatted in the legacy style.
595      */
596     public static function get_conversations_legacy_formatter(array $conversations) : array {
597         // Transform new data format back into the old format, just for BC during the deprecation life cycle.
598         $tmp = [];
599         foreach ($conversations as $id => $conv) {
600             // Only individual conversations were supported in legacy messaging.
601             if ($conv->type != \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL) {
602                 continue;
603             }
604             $data = new \stdClass();
605             // The logic for the 'other user' is as follows:
606             // If a conversation is of type 'individual', the other user is always the member who is not the current user.
607             // If the conversation is of type 'group', the other user is always the sender of the most recent message.
608             // The get_conversations method already follows this logic, so we just need the first member.
609             $otheruser = reset($conv->members);
610             $data->userid = $otheruser->id;
611             $data->useridfrom = $conv->messages[0]->useridfrom ?? null;
612             $data->fullname = $conv->members[$otheruser->id]->fullname;
613             $data->profileimageurl = $conv->members[$otheruser->id]->profileimageurl;
614             $data->profileimageurlsmall = $conv->members[$otheruser->id]->profileimageurlsmall;
615             $data->ismessaging = isset($conv->messages[0]->text) ? true : false;
616             $data->lastmessage = $conv->messages[0]->text ? clean_param($conv->messages[0]->text, PARAM_NOTAGS) : null;
617             $data->lastmessagedate = $conv->messages[0]->timecreated ?? null;
618             $data->messageid = $conv->messages[0]->id ?? null;
619             $data->isonline = $conv->members[$otheruser->id]->isonline ?? null;
620             $data->isblocked = $conv->members[$otheruser->id]->isblocked ?? null;
621             $data->isread = $conv->isread;
622             $data->unreadcount = $conv->unreadcount;
623             $tmp[$data->userid] = $data;
624         }
625         return $tmp;
626     }