MDL-67782 message: fix messages max length
[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 require_once($CFG->dirroot . '/message/lib.php');
31 /**
32  * Helper class for the message area.
33  *
34  * @copyright  2016 Mark Nelson <markn@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class helper {
39     /**
40      * @deprecated since 3.6
41      */
42     public static function get_messages() {
43         throw new \coding_exception('\core_message\helper::get_messages has been removed.');
44     }
46     /**
47      * Helper function to retrieve conversation messages.
48      *
49      * @param  int $userid The current user.
50      * @param  int $convid The conversation identifier.
51      * @param  int $timedeleted The time the message was deleted
52      * @param  int $limitfrom Return a subset of records, starting at this point (optional).
53      * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
54      * @param  string $sort The column name to order by including optionally direction.
55      * @param  int $timefrom The time from the message being sent.
56      * @param  int $timeto The time up until the message being sent.
57      * @return array of messages
58      */
59     public static function get_conversation_messages(int $userid, int $convid, int $timedeleted = 0, int $limitfrom = 0,
60                                                      int $limitnum = 0, string $sort = 'timecreated ASC', int $timefrom = 0,
61                                                      int $timeto = 0) : array {
62         global $DB;
64         $sql = "SELECT m.id, m.useridfrom, m.subject, m.fullmessage, m.fullmessagehtml,
65                        m.fullmessageformat, m.fullmessagetrust, m.smallmessage, m.timecreated,
66                        mc.contextid, muaread.timecreated AS timeread
67                   FROM {message_conversations} mc
68             INNER JOIN {messages} m
69                     ON m.conversationid = mc.id
70              LEFT JOIN {message_user_actions} muaread
71                     ON (muaread.messageid = m.id
72                    AND muaread.userid = :userid1
73                    AND muaread.action = :readaction)";
74         $params = ['userid1' => $userid, 'readaction' => api::MESSAGE_ACTION_READ, 'convid' => $convid];
76         if (empty($timedeleted)) {
77             $sql .= " LEFT JOIN {message_user_actions} mua
78                              ON (mua.messageid = m.id
79                             AND mua.userid = :userid2
80                             AND mua.action = :deleteaction
81                             AND mua.timecreated is NOT NULL)";
82         } else {
83             $sql .= " INNER JOIN {message_user_actions} mua
84                               ON (mua.messageid = m.id
85                              AND mua.userid = :userid2
86                              AND mua.action = :deleteaction
87                              AND mua.timecreated = :timedeleted)";
88             $params['timedeleted'] = $timedeleted;
89         }
91         $params['userid2'] = $userid;
92         $params['deleteaction'] = api::MESSAGE_ACTION_DELETED;
94         $sql .= " WHERE mc.id = :convid";
96         if (!empty($timefrom)) {
97             $sql .= " AND m.timecreated >= :timefrom";
98             $params['timefrom'] = $timefrom;
99         }
101         if (!empty($timeto)) {
102             $sql .= " AND m.timecreated <= :timeto";
103             $params['timeto'] = $timeto;
104         }
106         if (empty($timedeleted)) {
107             $sql .= " AND mua.id is NULL";
108         }
110         $sql .= " ORDER BY m.$sort";
112         $messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
114         return $messages;
115     }
117     /**
118      * Helper function to return a conversation messages with the involved members (only the ones
119      * who have sent any of these messages).
120      *
121      * @param int $userid The current userid.
122      * @param int $convid The conversation id.
123      * @param array $messages The formated array messages.
124      * @return array A conversation array with the messages and the involved members.
125      */
126     public static function format_conversation_messages(int $userid, int $convid, array $messages) : array {
127         global $USER;
129         // Create the conversation array.
130         $conversation = array(
131             'id' => $convid,
132         );
134         // Store the messages.
135         $arrmessages = array();
137         foreach ($messages as $message) {
138             // Store the message information.
139             $msg = new \stdClass();
140             $msg->id = $message->id;
141             $msg->useridfrom = $message->useridfrom;
142             $msg->text = message_format_message_text($message);
143             $msg->timecreated = $message->timecreated;
144             $arrmessages[] = $msg;
145         }
146         // Add the messages to the conversation.
147         $conversation['messages'] = $arrmessages;
149         // Get the users who have sent any of the $messages.
150         $memberids = array_unique(array_map(function($message) {
151             return $message->useridfrom;
152         }, $messages));
154         if (!empty($memberids)) {
155             // Get members information.
156             $conversation['members'] = self::get_member_info($userid, $memberids);
157         } else {
158             $conversation['members'] = array();
159         }
161         return $conversation;
162     }
164     /**
165      * @deprecated since 3.6
166      */
167     public static function create_messages() {
168         throw new \coding_exception('\core_message\helper::create_messages has been removed.');
169     }
171     /**
172      * Helper function for creating a contact object.
173      *
174      * @param \stdClass $contact
175      * @param string $prefix
176      * @return \stdClass
177      */
178     public static function create_contact($contact, $prefix = '') {
179         global $PAGE;
181         // Create the data we are going to pass to the renderable.
182         $userfields = \user_picture::unalias($contact, array('lastaccess'), $prefix . 'id', $prefix);
183         $data = new \stdClass();
184         $data->userid = $userfields->id;
185         $data->useridfrom = null;
186         $data->fullname = fullname($userfields);
187         // Get the user picture data.
188         $userpicture = new \user_picture($userfields);
189         $userpicture->size = 1; // Size f1.
190         $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
191         $userpicture->size = 0; // Size f2.
192         $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
193         // Store the message if we have it.
194         $data->ismessaging = false;
195         $data->lastmessage = null;
196         $data->lastmessagedate = null;
197         $data->messageid = null;
198         if (isset($contact->smallmessage)) {
199             $data->ismessaging = true;
200             // Strip the HTML tags from the message for displaying in the contact area.
201             $data->lastmessage = clean_param($contact->smallmessage, PARAM_NOTAGS);
202             $data->lastmessagedate = $contact->timecreated;
203             $data->useridfrom = $contact->useridfrom;
204             if (isset($contact->messageid)) {
205                 $data->messageid = $contact->messageid;
206             }
207         }
208         $data->isonline = null;
209         $user = \core_user::get_user($data->userid);
210         if (self::show_online_status($user)) {
211             $data->isonline = self::is_online($userfields->lastaccess);
212         }
213         $data->isblocked = isset($contact->blocked) ? (bool) $contact->blocked : false;
214         $data->isread = isset($contact->isread) ? (bool) $contact->isread : false;
215         $data->unreadcount = isset($contact->unreadcount) ? $contact->unreadcount : null;
216         $data->conversationid = $contact->conversationid ?? null;
218         return $data;
219     }
221     /**
222      * Helper function for checking if we should show the user's online status.
223      *
224      * @param \stdClass $user
225      * @return boolean
226      */
227     public static function show_online_status($user) {
228         global $CFG;
230         require_once($CFG->dirroot . '/user/lib.php');
232         if ($lastaccess = user_get_user_details($user, null, array('lastaccess'))) {
233             if (isset($lastaccess['lastaccess'])) {
234                 return true;
235             }
236         }
238         return false;
239     }
241     /**
242      * Helper function for checking the time meets the 'online' condition.
243      *
244      * @param int $lastaccess
245      * @return boolean
246      */
247     public static function is_online($lastaccess) {
248         global $CFG;
250         // Variable to check if we consider this user online or not.
251         $timetoshowusers = 300; // Seconds default.
252         if (isset($CFG->block_online_users_timetosee)) {
253             $timetoshowusers = $CFG->block_online_users_timetosee * 60;
254         }
255         $time = time() - $timetoshowusers;
257         return $lastaccess >= $time;
258     }
260     /**
261      * Get providers preferences.
262      *
263      * @param array $providers
264      * @param int $userid
265      * @return \stdClass
266      */
267     public static function get_providers_preferences($providers, $userid) {
268         $preferences = new \stdClass();
270         // Get providers preferences.
271         foreach ($providers as $provider) {
272             foreach (array('loggedin', 'loggedoff') as $state) {
273                 $linepref = get_user_preferences('message_provider_' . $provider->component . '_' . $provider->name
274                     . '_' . $state, '', $userid);
275                 if ($linepref == '') {
276                     continue;
277                 }
278                 $lineprefarray = explode(',', $linepref);
279                 $preferences->{$provider->component.'_'.$provider->name.'_'.$state} = array();
280                 foreach ($lineprefarray as $pref) {
281                     $preferences->{$provider->component.'_'.$provider->name.'_'.$state}[$pref] = 1;
282                 }
283             }
284         }
286         return $preferences;
287     }
289     /**
290      * Requires the JS libraries for the toggle contact button.
291      *
292      * @return void
293      */
294     public static function togglecontact_requirejs() {
295         global $PAGE;
297         static $done = false;
298         if ($done) {
299             return;
300         }
302         $PAGE->requires->js_call_amd('core_message/toggle_contact_button', 'enhance', array('#toggle-contact-button'));
303         $done = true;
304     }
306     /**
307      * Returns the attributes to place on a contact button.
308      *
309      * @param object $user User object.
310      * @param bool $iscontact
311      * @return array
312      */
313     public static function togglecontact_link_params($user, $iscontact = false) {
314         global $USER;
315         $params = array(
316             'data-currentuserid' => $USER->id,
317             'data-userid' => $user->id,
318             'data-is-contact' => $iscontact,
319             'id' => 'toggle-contact-button',
320             'role' => 'button',
321             'class' => 'ajax-contact-button',
322         );
324         return $params;
325     }
327     /**
328      * Requires the JS libraries for the message user button.
329      *
330      * @return void
331      */
332     public static function messageuser_requirejs() {
333         global $PAGE;
335         static $done = false;
336         if ($done) {
337             return;
338         }
340         $PAGE->requires->js_call_amd('core_message/message_user_button', 'send', array('#message-user-button'));
341         $done = true;
342     }
344     /**
345      * Returns the attributes to place on the message user button.
346      *
347      * @param int $useridto
348      * @return array
349      */
350     public static function messageuser_link_params(int $useridto) : array {
351         global $USER;
353         return [
354             'id' => 'message-user-button',
355             'role' => 'button',
356             'data-conversationid' => api::get_conversation_between_users([$USER->id, $useridto]),
357             'data-userid' => $useridto,
358         ];
359     }
361     /**
362      * Returns the conversation hash between users for easy look-ups in the DB.
363      *
364      * @param array $userids
365      * @return string
366      */
367     public static function get_conversation_hash(array $userids) {
368         sort($userids);
370         return sha1(implode('-', $userids));
371     }
373     /**
374      * Returns the cache key for the time created value of the last message of this conversation.
375      *
376      * @param int $convid The conversation identifier.
377      * @return string The key.
378      */
379     public static function get_last_message_time_created_cache_key(int $convid) {
380         return $convid;
381     }
383     /**
384      * Checks if legacy messages exist for a given user.
385      *
386      * @param int $userid
387      * @return bool
388      */
389     public static function legacy_messages_exist($userid) {
390         global $DB;
392         $sql = "SELECT id
393                   FROM {message} m
394                  WHERE useridfrom = ?
395                     OR useridto = ?";
396         $messageexists = $DB->record_exists_sql($sql, [$userid, $userid]);
398         $sql = "SELECT id
399                   FROM {message_read} m
400                  WHERE useridfrom = ?
401                     OR useridto = ?";
402         $messagereadexists = $DB->record_exists_sql($sql, [$userid, $userid]);
404         return $messageexists || $messagereadexists;
405     }
407     /**
408      * Returns conversation member info for the supplied users, relative to the supplied referenceuserid.
409      *
410      * This is the basic structure used when returning members, and includes information about the relationship between each member
411      * and the referenceuser, such as a whether the referenceuser has marked the member as a contact, or has blocked them.
412      *
413      * @param int $referenceuserid the id of the user which check contact and blocked status.
414      * @param array $userids
415      * @param bool $includecontactrequests Do we want to include contact requests with this data?
416      * @param bool $includeprivacyinfo Do we want to include whether the user can message another, and if the user
417      *             requires a contact.
418      * @return array the array of objects containing member info, indexed by userid.
419      * @throws \coding_exception
420      * @throws \dml_exception
421      */
422     public static function get_member_info(int $referenceuserid, array $userids, bool $includecontactrequests = false,
423                                            bool $includeprivacyinfo = false) : array {
424         global $DB, $PAGE;
426         // Prevent exception being thrown when array is empty.
427         if (empty($userids)) {
428             return [];
429         }
431         list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
432         $userfields = \user_picture::fields('u', array('lastaccess'));
433         $userssql = "SELECT $userfields, u.deleted, mc.id AS contactid, mub.id AS blockedid
434                        FROM {user} u
435                   LEFT JOIN {message_contacts} mc
436                          ON ((mc.userid = ? AND mc.contactid = u.id) OR (mc.userid = u.id AND mc.contactid = ?))
437                   LEFT JOIN {message_users_blocked} mub
438                          ON (mub.userid = ? AND mub.blockeduserid = u.id)
439                       WHERE u.id $useridsql";
440         $usersparams = array_merge([$referenceuserid, $referenceuserid, $referenceuserid], $usersparams);
441         $otherusers = $DB->get_records_sql($userssql, $usersparams);
443         $members = [];
444         foreach ($otherusers as $member) {
445             // Set basic data.
446             $data = new \stdClass();
447             $data->id = $member->id;
448             $data->fullname = fullname($member);
450             // Create the URL for their profile.
451             $profileurl = new \moodle_url('/user/profile.php', ['id' => $member->id]);
452             $data->profileurl = $profileurl->out(false);
454             // Set the user picture data.
455             $userpicture = new \user_picture($member);
456             $userpicture->size = 1; // Size f1.
457             $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
458             $userpicture->size = 0; // Size f2.
459             $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
461             // Set online status indicators.
462             $data->isonline = false;
463             $data->showonlinestatus = false;
464             if (!$member->deleted) {
465                 $data->isonline = self::show_online_status($member) ? self::is_online($member->lastaccess) : null;
466                 $data->showonlinestatus = is_null($data->isonline) ? false : true;
467             }
469             // Set contact and blocked status indicators.
470             $data->iscontact = ($member->contactid) ? true : false;
472             // We don't want that a user has been blocked if they can message the user anyways.
473             $canmessageifblocked = api::can_send_message($referenceuserid, $member->id, true);
474             $data->isblocked = ($member->blockedid && !$canmessageifblocked) ? true : false;
476             $data->isdeleted = ($member->deleted) ? true : false;
478             $data->requirescontact = null;
479             $data->canmessage = null;
480             $data->canmessageevenifblocked = null;
481             if ($includeprivacyinfo) {
482                 $privacysetting = api::get_user_privacy_messaging_preference($member->id);
483                 $data->requirescontact = $privacysetting == api::MESSAGE_PRIVACY_ONLYCONTACTS;
485                 // Here we check that if the sender wanted to block the recipient, the
486                 // recipient would still be able to message them regardless.
487                 $data->canmessageevenifblocked = !$data->isdeleted && $canmessageifblocked;
488                 $data->canmessage = !$data->isdeleted && api::can_send_message($member->id, $referenceuserid);
489             }
491             // Populate the contact requests, even if we don't need them.
492             $data->contactrequests = [];
494             $members[$data->id] = $data;
495         }
497         // Check if we want to include contact requests as well.
498         if (!empty($members) && $includecontactrequests) {
499             list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
501             $wheresql = "(userid $useridsql AND requesteduserid = ?) OR (userid = ? AND requesteduserid $useridsql)";
502             $params = array_merge($usersparams, [$referenceuserid, $referenceuserid], $usersparams);
503             if ($contactrequests = $DB->get_records_select('message_contact_requests', $wheresql, $params,
504                     'timecreated ASC, id ASC')) {
505                 foreach ($contactrequests as $contactrequest) {
506                     if (isset($members[$contactrequest->userid])) {
507                         $members[$contactrequest->userid]->contactrequests[] = $contactrequest;
508                     }
509                     if (isset($members[$contactrequest->requesteduserid])) {
510                         $members[$contactrequest->requesteduserid]->contactrequests[] = $contactrequest;
511                     }
512                 }
513             }
514         }
516         // Remove any userids not in $members. This can happen in the case of a user who has been deleted
517         // from the Moodle database table (which can happen in earlier versions of Moodle).
518         $userids = array_filter($userids, function($userid) use ($members) {
519             return isset($members[$userid]);
520         });
522         // Return member information in the same order as the userids originally provided.
523         $members = array_replace(array_flip($userids), $members);
525         return $members;
526     }
527     /**
528      * @deprecated since 3.6
529      */
530     public static function get_conversations_legacy_formatter() {
531         throw new \coding_exception('\core_message\helper::get_conversations_legacy_formatter has been removed.');
532     }
534     /**
535      * Renders the messaging widget.
536      *
537      * @param bool $isdrawer Are we are rendering the drawer or is this on a full page?
538      * @param int|null $sendtouser The ID of the user we want to send a message to
539      * @param int|null $conversationid The ID of the conversation we want to load
540      * @param string|null $view The first view to load in the message widget
541      * @return string The HTML.
542      */
543     public static function render_messaging_widget(
544         bool $isdrawer,
545         int $sendtouser = null,
546         int $conversationid = null,
547         string $view = null
548     ) {
549         global $USER, $CFG, $PAGE;
551         // Early bail out conditions.
552         if (empty($CFG->messaging) || !isloggedin() || isguestuser() || user_not_fully_set_up($USER) ||
553             get_user_preferences('auth_forcepasswordchange') ||
554             (!$USER->policyagreed && !is_siteadmin() &&
555                 ($manager = new \core_privacy\local\sitepolicy\manager()) && $manager->is_defined())) {
556             return '';
557         }
559         $renderer = $PAGE->get_renderer('core');
560         $requestcount = \core_message\api::get_received_contact_requests_count($USER->id);
561         $contactscount = \core_message\api::count_contacts($USER->id);
563         $choices = [];
564         $choices[] = [
565             'value' => \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS,
566             'text' => get_string('contactableprivacy_onlycontacts', 'message')
567         ];
568         $choices[] = [
569             'value' => \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER,
570             'text' => get_string('contactableprivacy_coursemember', 'message')
571         ];
572         if (!empty($CFG->messagingallusers)) {
573             // Add the MESSAGE_PRIVACY_SITE option when site-wide messaging between users is enabled.
574             $choices[] = [
575                 'value' => \core_message\api::MESSAGE_PRIVACY_SITE,
576                 'text' => get_string('contactableprivacy_site', 'message')
577             ];
578         }
580         // Enter to send.
581         $entertosend = get_user_preferences('message_entertosend', $CFG->messagingdefaultpressenter, $USER);
583         $notification = '';
584         if (!get_user_preferences('core_message_migrate_data', false)) {
585             $notification = get_string('messagingdatahasnotbeenmigrated', 'message');
586         }
588         if ($isdrawer) {
589             $template = 'core_message/message_drawer';
590             $messageurl = new \moodle_url('/message/index.php');
591         } else {
592             $template = 'core_message/message_index';
593             $messageurl = null;
594         }
596         $templatecontext = [
597             'contactrequestcount' => $requestcount,
598             'loggedinuser' => [
599                 'id' => $USER->id,
600                 'midnight' => usergetmidnight(time())
601             ],
602             // The starting timeout value for message polling.
603             'messagepollmin' => $CFG->messagingminpoll ?? MESSAGE_DEFAULT_MIN_POLL_IN_SECONDS,
604             // The maximum value that message polling timeout can reach.
605             'messagepollmax' => $CFG->messagingmaxpoll ?? MESSAGE_DEFAULT_MAX_POLL_IN_SECONDS,
606             // The timeout to reset back to after the max polling time has been reached.
607             'messagepollaftermax' => $CFG->messagingtimeoutpoll ?? MESSAGE_DEFAULT_TIMEOUT_POLL_IN_SECONDS,
608             'contacts' => [
609                 'sectioncontacts' => [
610                     'placeholders' => array_fill(0, $contactscount > 50 ? 50 : $contactscount, true)
611                 ],
612                 'sectionrequests' => [
613                     'placeholders' => array_fill(0, $requestcount > 50 ? 50 : $requestcount, true)
614                 ],
615             ],
616             'settings' => [
617                 'privacy' => $choices,
618                 'entertosend' => $entertosend
619             ],
620             'overview' => [
621                 'messageurl' => $messageurl,
622                 'notification' => $notification
623             ],
624             'isdrawer' => $isdrawer,
625             'showemojipicker' => !empty($CFG->allowemojipicker),
626             'messagemaxlength' => api::MESSAGE_MAX_LENGTH,
627         ];
629         if ($sendtouser || $conversationid) {
630             $route = [
631                 'path' => 'view-conversation',
632                 'params' => $conversationid ? [$conversationid] : [null, 'create', $sendtouser]
633             ];
634         } else if ($view === 'contactrequests') {
635             $route = [
636                 'path' => 'view-contacts',
637                 'params' => ['requests']
638             ];
639         } else {
640             $route = null;
641         }
643         $templatecontext['route'] = json_encode($route);
645         return $renderer->render_from_template($template, $templatecontext);
646     }
648     /**
649      * Returns user details for a user, if they are visible to the current user in the message search.
650      *
651      * This method checks the visibility of a user specifically for the purpose of inclusion in the message search results.
652      * Visibility depends on the site-wide messaging setting 'messagingallusers':
653      * If enabled, visibility depends only on the core notion of visibility; a visible site or course profile.
654      * If disabled, visibility requires that the user be sharing a course with the searching user, and have a visible profile there.
655      * The current user is always returned.
656      *
657      * @param \stdClass $user
658      * @return array the array of userdetails, if visible, or an empty array otherwise.
659      */
660     public static function search_get_user_details(\stdClass $user) : array {
661         global $CFG, $USER;
662         require_once($CFG->dirroot . '/user/lib.php');
664         if ($CFG->messagingallusers || $user->id == $USER->id) {
665             return \user_get_user_details_courses($user) ?? []; // This checks visibility of site and course profiles.
666         } else {
667             // Messaging specific: user must share a course with the searching user AND have a visible profile there.
668             $sharedcourses = enrol_get_shared_courses($USER, $user);
669             foreach ($sharedcourses as $course) {
670                 if (user_can_view_profile($user, $course)) {
671                     $userdetails = user_get_user_details($user, $course);
672                     if (!is_null($userdetails)) {
673                         return $userdetails;
674                     }
675                 }
676             }
677         }
678         return [];
679     }