474b27429fec1cd397fbff04fc4f75344f9f7aeb
[moodle.git] / message / lib.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  * Library functions for messaging
19  *
20  * @package   core_message
21  * @copyright 2008 Luis Rodrigues
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 define('MESSAGE_SHORTLENGTH', 300);
27 define('MESSAGE_HISTORY_ALL', 1);
29 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
31 define('MESSAGE_TYPE_NOTIFICATION', 'notification');
32 define('MESSAGE_TYPE_MESSAGE', 'message');
34 /**
35  * Define contants for messaging default settings population. For unambiguity of
36  * plugin developer intentions we use 4-bit value (LSB numbering):
37  * bit 0 - whether to send message when user is loggedin (MESSAGE_DEFAULT_LOGGEDIN)
38  * bit 1 - whether to send message when user is loggedoff (MESSAGE_DEFAULT_LOGGEDOFF)
39  * bit 2..3 - messaging permission (MESSAGE_DISALLOWED|MESSAGE_PERMITTED|MESSAGE_FORCED)
40  *
41  * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
42  */
44 define('MESSAGE_DEFAULT_LOGGEDIN', 0x01); // 0001
45 define('MESSAGE_DEFAULT_LOGGEDOFF', 0x02); // 0010
47 define('MESSAGE_DISALLOWED', 0x04); // 0100
48 define('MESSAGE_PERMITTED', 0x08); // 1000
49 define('MESSAGE_FORCED', 0x0c); // 1100
51 define('MESSAGE_PERMITTED_MASK', 0x0c); // 1100
53 /**
54  * Set default value for default outputs permitted setting
55  */
56 define('MESSAGE_DEFAULT_PERMITTED', 'permitted');
58 /**
59  * Set default values for polling.
60  */
61 define('MESSAGE_DEFAULT_MIN_POLL_IN_SECONDS', 10);
62 define('MESSAGE_DEFAULT_MAX_POLL_IN_SECONDS', 2 * MINSECS);
63 define('MESSAGE_DEFAULT_TIMEOUT_POLL_IN_SECONDS', 5 * MINSECS);
65 /**
66  * Returns the count of unread messages for user. Either from a specific user or from all users.
67  *
68  * @param object $user1 the first user. Defaults to $USER
69  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
70  * @return int the count of $user1's unread messages
71  */
72 function message_count_unread_messages($user1=null, $user2=null) {
73     global $USER, $DB;
75     if (empty($user1)) {
76         $user1 = $USER;
77     }
79     $sql = "SELECT COUNT(m.id)
80               FROM {messages} m
81         INNER JOIN {message_conversations} mc
82                 ON mc.id = m.conversationid
83         INNER JOIN {message_conversation_members} mcm
84                 ON mcm.conversationid = mc.id
85          LEFT JOIN {message_user_actions} mua
86                 ON (mua.messageid = m.id AND mua.userid = ? AND (mua.action = ? OR mua.action = ?))
87              WHERE mua.id is NULL
88                AND mcm.userid = ?";
89     $params = [$user1->id, \core_message\api::MESSAGE_ACTION_DELETED, \core_message\api::MESSAGE_ACTION_READ, $user1->id];
91     if (!empty($user2)) {
92         $sql .= " AND m.useridfrom = ?";
93         $params[] = $user2->id;
94     } else {
95         $sql .= " AND m.useridfrom <> ?";
96         $params[] = $user1->id;
97     }
99     return $DB->count_records_sql($sql, $params);
102 /**
103  * Try to guess how to convert the message to html.
104  *
105  * @access private
106  *
107  * @param stdClass $message
108  * @param bool $forcetexttohtml
109  * @return string html fragment
110  */
111 function message_format_message_text($message, $forcetexttohtml = false) {
112     // Note: this is a very nasty hack that tries to work around the weird messaging rules and design.
114     $options = new stdClass();
115     $options->para = false;
116     $options->blanktarget = true;
118     $format = $message->fullmessageformat;
120     if (strval($message->smallmessage) !== '') {
121         if (!empty($message->notification)) {
122             if (strval($message->fullmessagehtml) !== '' or strval($message->fullmessage) !== '') {
123                 $format = FORMAT_PLAIN;
124             }
125         }
126         $messagetext = $message->smallmessage;
128     } else if ($message->fullmessageformat == FORMAT_HTML) {
129         if (strval($message->fullmessagehtml) !== '') {
130             $messagetext = $message->fullmessagehtml;
131         } else {
132             $messagetext = $message->fullmessage;
133             $format = FORMAT_MOODLE;
134         }
136     } else {
137         if (strval($message->fullmessage) !== '') {
138             $messagetext = $message->fullmessage;
139         } else {
140             $messagetext = $message->fullmessagehtml;
141             $format = FORMAT_HTML;
142         }
143     }
145     if ($forcetexttohtml) {
146         // This is a crazy hack, why not set proper format when creating the notifications?
147         if ($format === FORMAT_PLAIN) {
148             $format = FORMAT_MOODLE;
149         }
150     }
151     return format_text($messagetext, $format, $options);
154 /**
155  * Search through course users.
156  *
157  * If $courseids contains the site course then this function searches
158  * through all undeleted and confirmed users.
159  *
160  * @param int|array $courseids Course ID or array of course IDs.
161  * @param string $searchtext the text to search for.
162  * @param string $sort the column name to order by.
163  * @param string|array $exceptions comma separated list or array of user IDs to exclude.
164  * @return array An array of {@link $USER} records.
165  */
166 function message_search_users($courseids, $searchtext, $sort='', $exceptions='') {
167     global $CFG, $USER, $DB;
169     // Basic validation to ensure that the parameter $courseids is not an empty array or an empty value.
170     if (!$courseids) {
171         $courseids = array(SITEID);
172     }
174     // Allow an integer to be passed.
175     if (!is_array($courseids)) {
176         $courseids = array($courseids);
177     }
179     $fullname = $DB->sql_fullname();
180     $ufields = user_picture::fields('u');
182     if (!empty($sort)) {
183         $order = ' ORDER BY '. $sort;
184     } else {
185         $order = '';
186     }
188     $params = array(
189         'userid' => $USER->id,
190         'userid2' => $USER->id,
191         'query' => "%$searchtext%"
192     );
194     if (empty($exceptions)) {
195         $exceptions = array();
196     } else if (!empty($exceptions) && is_string($exceptions)) {
197         $exceptions = explode(',', $exceptions);
198     }
200     // Ignore self and guest account.
201     $exceptions[] = $USER->id;
202     $exceptions[] = $CFG->siteguest;
204     // Exclude exceptions from the search result.
205     list($except, $params_except) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'param', false);
206     $except = ' AND u.id ' . $except;
207     $params = array_merge($params_except, $params);
209     if (in_array(SITEID, $courseids)) {
210         // Search on site level.
211         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mub.id as userblockedid
212                                        FROM {user} u
213                                        LEFT JOIN {message_contacts} mc
214                                             ON mc.contactid = u.id AND mc.userid = :userid
215                                        LEFT JOIN {message_users_blocked} mub
216                                             ON mub.userid = :userid2 AND mub.blockeduserid = u.id
217                                       WHERE u.deleted = '0' AND u.confirmed = '1'
218                                             AND (".$DB->sql_like($fullname, ':query', false).")
219                                             $except
220                                      $order", $params);
221     } else {
222         // Search in courses.
224         // Getting the context IDs or each course.
225         $contextids = array();
226         foreach ($courseids as $courseid) {
227             $context = context_course::instance($courseid);
228             $contextids = array_merge($contextids, $context->get_parent_context_ids(true));
229         }
230         list($contextwhere, $contextparams) = $DB->get_in_or_equal(array_unique($contextids), SQL_PARAMS_NAMED, 'context');
231         $params = array_merge($params, $contextparams);
233         // Everyone who has a role assignment in this course or higher.
234         // TODO: add enabled enrolment join here (skodak)
235         $users = $DB->get_records_sql("SELECT DISTINCT $ufields, mc.id as contactlistid, mub.id as userblockedid
236                                          FROM {user} u
237                                          JOIN {role_assignments} ra ON ra.userid = u.id
238                                          LEFT JOIN {message_contacts} mc
239                                               ON mc.contactid = u.id AND mc.userid = :userid
240                                          LEFT JOIN {message_users_blocked} mub
241                                               ON mub.userid = :userid2 AND mub.blockeduserid = u.id
242                                         WHERE u.deleted = '0' AND u.confirmed = '1'
243                                               AND (".$DB->sql_like($fullname, ':query', false).")
244                                               AND ra.contextid $contextwhere
245                                               $except
246                                        $order", $params);
248         return $users;
249     }
252 /**
253  * Format a message for display in the message history
254  *
255  * @param object $message the message object
256  * @param string $format optional date format
257  * @param string $keywords keywords to highlight
258  * @param string $class CSS class to apply to the div around the message
259  * @return string the formatted message
260  */
261 function message_format_message($message, $format='', $keywords='', $class='other') {
263     static $dateformat;
265     //if we haven't previously set the date format or they've supplied a new one
266     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
267         if ($format) {
268             $dateformat = $format;
269         } else {
270             $dateformat = get_string('strftimedatetimeshort');
271         }
272     }
273     $time = userdate($message->timecreated, $dateformat);
275     $messagetext = message_format_message_text($message, false);
277     if ($keywords) {
278         $messagetext = highlight($keywords, $messagetext);
279     }
281     $messagetext .= message_format_contexturl($message);
283     $messagetext = clean_text($messagetext, FORMAT_HTML);
285     return <<<TEMPLATE
286 <div class='message $class'>
287     <a name="m{$message->id}"></a>
288     <span class="message-meta"><span class="time">$time</span></span>: <span class="text">$messagetext</span>
289 </div>
290 TEMPLATE;
293 /**
294  * Format a the context url and context url name of a message for display
295  *
296  * @param object $message the message object
297  * @return string the formatted string
298  */
299 function message_format_contexturl($message) {
300     $s = null;
302     if (!empty($message->contexturl)) {
303         $displaytext = null;
304         if (!empty($message->contexturlname)) {
305             $displaytext= $message->contexturlname;
306         } else {
307             $displaytext= $message->contexturl;
308         }
309         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
310             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
311         $s .= html_writer::end_tag('div');
312     }
314     return $s;
317 /**
318  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
319  *
320  * @param object $userfrom the message sender
321  * @param object $userto the message recipient
322  * @param string $message the message
323  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
324  * @return int|false the ID of the new message or false
325  */
326 function message_post_message($userfrom, $userto, $message, $format) {
327     global $SITE, $CFG, $USER;
329     $eventdata = new \core\message\message();
330     $eventdata->courseid         = 1;
331     $eventdata->component        = 'moodle';
332     $eventdata->name             = 'instantmessage';
333     $eventdata->userfrom         = $userfrom;
334     $eventdata->userto           = $userto;
336     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
337     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
339     if ($format == FORMAT_HTML) {
340         $eventdata->fullmessagehtml  = $message;
341         //some message processors may revert to sending plain text even if html is supplied
342         //so we keep both plain and html versions if we're intending to send html
343         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
344     } else {
345         $eventdata->fullmessage      = $message;
346         $eventdata->fullmessagehtml  = '';
347     }
349     $eventdata->fullmessageformat = $format;
350     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
352     $s = new stdClass();
353     $s->sitename = format_string($SITE->shortname, true, array('context' => context_course::instance(SITEID)));
354     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
356     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
357     if (!empty($eventdata->fullmessage)) {
358         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
359     }
360     if (!empty($eventdata->fullmessagehtml)) {
361         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
362     }
364     $eventdata->timecreated     = time();
365     $eventdata->notification    = 0;
366     return message_send($eventdata);
369 /**
370  * Get all message processors, validate corresponding plugin existance and
371  * system configuration
372  *
373  * @param bool $ready only return ready-to-use processors
374  * @param bool $reset Reset list of message processors (used in unit tests)
375  * @param bool $resetonly Just reset, then exit
376  * @return mixed $processors array of objects containing information on message processors
377  */
378 function get_message_processors($ready = false, $reset = false, $resetonly = false) {
379     global $DB, $CFG;
381     static $processors;
382     if ($reset) {
383         $processors = array();
385         if ($resetonly) {
386             return $processors;
387         }
388     }
390     if (empty($processors)) {
391         // Get all processors, ensure the name column is the first so it will be the array key
392         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
393         foreach ($processors as &$processor){
394             $processor = \core_message\api::get_processed_processor_object($processor);
395         }
396     }
397     if ($ready) {
398         // Filter out enabled and system_configured processors
399         $readyprocessors = $processors;
400         foreach ($readyprocessors as $readyprocessor) {
401             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
402                 unset($readyprocessors[$readyprocessor->name]);
403             }
404         }
405         return $readyprocessors;
406     }
408     return $processors;
411 /**
412  * Get all message providers, validate their plugin existance and
413  * system configuration
414  *
415  * @return mixed $processors array of objects containing information on message processors
416  */
417 function get_message_providers() {
418     global $CFG, $DB;
420     $pluginman = core_plugin_manager::instance();
422     $providers = $DB->get_records('message_providers', null, 'name');
424     // Remove all the providers whose plugins are disabled or don't exist
425     foreach ($providers as $providerid => $provider) {
426         $plugin = $pluginman->get_plugin_info($provider->component);
427         if ($plugin) {
428             if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
429                 unset($providers[$providerid]);   // Plugins does not exist
430                 continue;
431             }
432             if ($plugin->is_enabled() === false) {
433                 unset($providers[$providerid]);   // Plugin disabled
434                 continue;
435             }
436         }
437     }
438     return $providers;
441 /**
442  * Get an instance of the message_output class for one of the output plugins.
443  * @param string $type the message output type. E.g. 'email' or 'jabber'.
444  * @return message_output message_output the requested class.
445  */
446 function get_message_processor($type) {
447     global $CFG;
449     // Note, we cannot use the get_message_processors function here, becaues this
450     // code is called during install after installing each messaging plugin, and
451     // get_message_processors caches the list of installed plugins.
453     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
454     if (!is_readable($processorfile)) {
455         throw new coding_exception('Unknown message processor type ' . $type);
456     }
458     include_once($processorfile);
460     $processclass = 'message_output_' . $type;
461     if (!class_exists($processclass)) {
462         throw new coding_exception('Message processor ' . $type .
463                 ' does not define the right class');
464     }
466     return new $processclass();
469 /**
470  * Get messaging outputs default (site) preferences
471  *
472  * @return object $processors object containing information on message processors
473  */
474 function get_message_output_default_preferences() {
475     return get_config('message');
478 /**
479  * Translate message default settings from binary value to the array of string
480  * representing the settings to be stored. Also validate the provided value and
481  * use default if it is malformed.
482  *
483  * @param  int    $plugindefault Default setting suggested by plugin
484  * @param  string $processorname The name of processor
485  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
486  */
487 function translate_message_default_setting($plugindefault, $processorname) {
488     // Preset translation arrays
489     $permittedvalues = array(
490         0x04 => 'disallowed',
491         0x08 => 'permitted',
492         0x0c => 'forced',
493     );
495     $loggedinstatusvalues = array(
496         0x00 => null, // use null if loggedin/loggedoff is not defined
497         0x01 => 'loggedin',
498         0x02 => 'loggedoff',
499     );
501     // define the default setting
502     $processor = get_message_processor($processorname);
503     $default = $processor->get_default_messaging_settings();
505     // Validate the value. It should not exceed the maximum size
506     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
507         debugging(get_string('errortranslatingdefault', 'message'));
508         $plugindefault = $default;
509     }
510     // Use plugin default setting of 'permitted' is 0
511     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
512         $plugindefault = $default;
513     }
515     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
516     $loggedin = $loggedoff = null;
518     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
519         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
520         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
521     }
523     return array($permitted, $loggedin, $loggedoff);
526 /**
527  * Get messages sent or/and received by the specified users.
528  * Please note that this function return deleted messages too. Besides, only individual conversation messages
529  * are returned to maintain backwards compatibility.
530  *
531  * @param  int      $useridto       the user id who received the message
532  * @param  int      $useridfrom     the user id who sent the message. -10 or -20 for no-reply or support user
533  * @param  int      $notifications  1 for retrieving notifications, 0 for messages, -1 for both
534  * @param  bool     $read           true for retrieving read messages, false for unread
535  * @param  string   $sort           the column name to order by including optionally direction
536  * @param  int      $limitfrom      limit from
537  * @param  int      $limitnum       limit num
538  * @return external_description
539  * @since  2.8
540  */
541 function message_get_messages($useridto, $useridfrom = 0, $notifications = -1, $read = true,
542                                 $sort = 'mr.timecreated DESC', $limitfrom = 0, $limitnum = 0) {
543     global $DB;
545     // If the 'useridto' value is empty then we are going to retrieve messages sent by the useridfrom to any user.
546     if (empty($useridto)) {
547         $userfields = get_all_user_name_fields(true, 'u', '', 'userto');
548         $messageuseridtosql = 'u.id as useridto';
549     } else {
550         $userfields = get_all_user_name_fields(true, 'u', '', 'userfrom');
551         $messageuseridtosql = "$useridto as useridto";
552     }
554     // Create the SQL we will be using.
555     $messagesql = "SELECT mr.*, $userfields, 0 as notification, '' as contexturl, '' as contexturlname,
556                           mua.timecreated as timeusertodeleted, mua2.timecreated as timeread,
557                           mua3.timecreated as timeuserfromdeleted, $messageuseridtosql
558                      FROM {messages} mr
559                INNER JOIN {message_conversations} mc
560                        ON mc.id = mr.conversationid
561                INNER JOIN {message_conversation_members} mcm
562                        ON mcm.conversationid = mc.id ";
564     $notificationsql = "SELECT mr.*, $userfields, 1 as notification
565                           FROM {notifications} mr ";
567     $messagejoinsql = "LEFT JOIN {message_user_actions} mua
568                               ON (mua.messageid = mr.id AND mua.userid = mcm.userid AND mua.action = ?)
569                        LEFT JOIN {message_user_actions} mua2
570                               ON (mua2.messageid = mr.id AND mua2.userid = mcm.userid AND mua2.action = ?)
571                        LEFT JOIN {message_user_actions} mua3
572                               ON (mua3.messageid = mr.id AND mua3.userid = mr.useridfrom AND mua3.action = ?)";
573     $messagejoinparams = [\core_message\api::MESSAGE_ACTION_DELETED, \core_message\api::MESSAGE_ACTION_READ,
574         \core_message\api::MESSAGE_ACTION_DELETED];
575     $notificationsparams = [];
577     // If the 'useridto' value is empty then we are going to retrieve messages sent by the useridfrom to any user.
578     if (empty($useridto)) {
579         // Create the messaging query and params.
580         $messagesql .= "INNER JOIN {user} u
581                                 ON u.id = mcm.userid
582                                 $messagejoinsql
583                              WHERE mr.useridfrom = ?
584                                AND mr.useridfrom != mcm.userid
585                                AND u.deleted = 0
586                                AND mc.type = ? ";
587         $messageparams = array_merge($messagejoinparams, [$useridfrom, \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL]);
589         // Create the notifications query and params.
590         $notificationsql .= "INNER JOIN {user} u
591                                      ON u.id = mr.useridto
592                                   WHERE mr.useridfrom = ?
593                                     AND u.deleted = 0 ";
594         $notificationsparams[] = $useridfrom;
595     } else {
596         // Create the messaging query and params.
597         // Left join because useridfrom may be -10 or -20 (no-reply and support users).
598         $messagesql .= "LEFT JOIN {user} u
599                                ON u.id = mr.useridfrom
600                                $messagejoinsql
601                             WHERE mcm.userid = ?
602                               AND mr.useridfrom != mcm.userid
603                               AND u.deleted = 0
604                               AND mc.type = ? ";
605         $messageparams = array_merge($messagejoinparams, [$useridto, \core_message\api::MESSAGE_CONVERSATION_TYPE_INDIVIDUAL]);
607         // If we're dealing with messages only and both useridto and useridfrom are set,
608         // try to get a conversation between the users. Break early if we can't find one.
609         if (!empty($useridfrom) && $notifications == 0) {
610             $messagesql .= " AND mr.useridfrom = ? ";
611             $messageparams[] = $useridfrom;
613             // There should be an individual conversation between the users. If not, we can return early.
614             $conversationid = \core_message\api::get_conversation_between_users([$useridto, $useridfrom]);
615             if (empty($conversationid)) {
616                 return [];
617             }
618             $messagesql .= " AND mc.id = ? ";
619             $messageparams[] = $conversationid;
620         }
622         // Create the notifications query and params.
623         // Left join because useridfrom may be -10 or -20 (no-reply and support users).
624         $notificationsql .= "LEFT JOIN {user} u
625                                     ON (u.id = mr.useridfrom AND u.deleted = 0)
626                                  WHERE mr.useridto = ? ";
627         $notificationsparams[] = $useridto;
628         if (!empty($useridfrom)) {
629             $notificationsql .= " AND mr.useridfrom = ? ";
630             $notificationsparams[] = $useridfrom;
631         }
632     }
633     if ($read) {
634         $notificationsql .= "AND mr.timeread IS NOT NULL ";
635     } else {
636         $notificationsql .= "AND mr.timeread IS NULL ";
637     }
638     $messagesql .= "ORDER BY $sort";
639     $notificationsql .= "ORDER BY $sort";
641     // Handle messages if needed.
642     if ($notifications === -1 || $notifications === 0) {
643         $messages = $DB->get_records_sql($messagesql, $messageparams, $limitfrom, $limitnum);
644         // Get rid of the messages that have either been read or not read depending on the value of $read.
645         $messages = array_filter($messages, function ($message) use ($read) {
646             if ($read) {
647                 return !is_null($message->timeread);
648             }
650             return is_null($message->timeread);
651         });
652     }
654     // All.
655     if ($notifications === -1) {
656         return array_merge($messages, $DB->get_records_sql($notificationsql, $notificationsparams, $limitfrom, $limitnum));
657     } else if ($notifications === 1) { // Just notifications.
658         return $DB->get_records_sql($notificationsql, $notificationsparams, $limitfrom, $limitnum);
659     }
661     // Just messages.
662     return $messages;
665 /**
666  * Handles displaying processor settings in a fragment.
667  *
668  * @param array $args
669  * @return bool|string
670  * @throws moodle_exception
671  */
672 function message_output_fragment_processor_settings($args = []) {
673     global $PAGE;
675     if (!isset($args['type'])) {
676         throw new moodle_exception('Must provide a processor type');
677     }
679     if (!isset($args['userid'])) {
680         throw new moodle_exception('Must provide a userid');
681     }
683     $type = $args['type'];
684     $userid = $args['userid'];
686     $user = core_user::get_user($userid, '*', MUST_EXIST);
687     $processor = get_message_processor($type);
688     $providers = message_get_providers_for_user($userid);
689     $processorwrapper = new stdClass();
690     $processorwrapper->object = $processor;
691     $preferences = \core_message\api::get_all_message_preferences([$processorwrapper], $providers, $user);
693     $processoroutput = new \core_message\output\preferences\processor($processor, $preferences, $user, $type);
694     $renderer = $PAGE->get_renderer('core', 'message');
696     return $renderer->render_from_template('core_message/preferences_processor', $processoroutput->export_for_template($renderer));
699 /**
700  * Checks if current user is allowed to edit messaging preferences of another user
701  *
702  * @param stdClass $user user whose preferences we are updating
703  * @return bool
704  */
705 function core_message_can_edit_message_profile($user) {
706     global $USER;
707     if ($user->id == $USER->id) {
708         return has_capability('moodle/user:editownmessageprofile', context_system::instance());
709     } else {
710         $personalcontext = context_user::instance($user->id);
711         if (!has_capability('moodle/user:editmessageprofile', $personalcontext)) {
712             return false;
713         }
714         if (isguestuser($user)) {
715             return false;
716         }
717         // No editing of admins by non-admins.
718         if (is_siteadmin($user) and !is_siteadmin($USER)) {
719             return false;
720         }
721         return true;
722     }
725 /**
726  * Implements callback user_preferences, whitelists preferences that users are allowed to update directly
727  *
728  * Used in {@see core_user::fill_preferences_cache()}, see also {@see useredit_update_user_preference()}
729  *
730  * @return array
731  */
732 function core_message_user_preferences() {
733     $preferences = [];
734     $preferences['message_blocknoncontacts'] = array(
735         'type' => PARAM_INT,
736         'null' => NULL_NOT_ALLOWED,
737         'default' => 0,
738         'choices' => array(
739             \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS,
740             \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER,
741             \core_message\api::MESSAGE_PRIVACY_SITE
742         ),
743         'cleancallback' => function ($value) {
744             global $CFG;
746             // When site-wide messaging between users is disabled, MESSAGE_PRIVACY_SITE should be converted.
747             if (empty($CFG->messagingallusers) && $value === \core_message\api::MESSAGE_PRIVACY_SITE) {
748                 return \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER;
749             }
750             return $value;
751         }
752     );
753     $preferences['message_entertosend'] = array(
754         'type' => PARAM_BOOL,
755         'null' => NULL_NOT_ALLOWED,
756         'default' => false
757     );
758     $preferences['/^message_provider_([\w\d_]*)_logged(in|off)$/'] = array('isregex' => true, 'type' => PARAM_NOTAGS,
759         'null' => NULL_NOT_ALLOWED, 'default' => 'none',
760         'permissioncallback' => function ($user, $preferencename) {
761             global $CFG;
762             require_once($CFG->libdir.'/messagelib.php');
763             if (core_message_can_edit_message_profile($user) &&
764                     preg_match('/^message_provider_([\w\d_]*)_logged(in|off)$/', $preferencename, $matches)) {
765                 $providers = message_get_providers_for_user($user->id);
766                 foreach ($providers as $provider) {
767                     if ($matches[1] === $provider->component . '_' . $provider->name) {
768                        return true;
769                     }
770                 }
771             }
772             return false;
773         },
774         'cleancallback' => function ($value, $preferencename) {
775             if ($value === 'none' || empty($value)) {
776                 return 'none';
777             }
778             $parts = explode('/,/', $value);
779             $processors = array_keys(get_message_processors());
780             array_filter($parts, function($v) use ($processors) {return in_array($v, $processors);});
781             return $parts ? join(',', $parts) : 'none';
782         });
783     return $preferences;
786 /**
787  * Renders the popup.
788  *
789  * @param renderer_base $renderer
790  * @return string The HTML
791  */
792 function core_message_render_navbar_output(\renderer_base $renderer) {
793     global $USER, $CFG;
795     // Early bail out conditions.
796     if (!isloggedin() || isguestuser() || user_not_fully_set_up($USER) ||
797         get_user_preferences('auth_forcepasswordchange') ||
798         (!$USER->policyagreed && !is_siteadmin() &&
799             ($manager = new \core_privacy\local\sitepolicy\manager()) && $manager->is_defined())) {
800         return '';
801     }
803     $output = '';
805     // Add the messages popover.
806     if (!empty($CFG->messaging)) {
807         $unreadcount = \core_message\api::count_unread_conversations($USER);
808         $requestcount = \core_message\api::get_received_contact_requests_count($USER->id);
809         $context = [
810             'userid' => $USER->id,
811             'unreadcount' => $unreadcount + $requestcount
812         ];
813         $output .= $renderer->render_from_template('core_message/message_popover', $context);
814     }
816     return $output;
819 /**
820  * Render the message drawer to be included in the top of the body of
821  * each page.
822  *
823  * @return string HTML
824  */
825 function core_message_standard_after_main_region_html() {
826     global $USER, $CFG, $PAGE;
828     // Early bail out conditions.
829     if (empty($CFG->messaging) || !isloggedin() || isguestuser() || user_not_fully_set_up($USER) ||
830         get_user_preferences('auth_forcepasswordchange') ||
831         (!$USER->policyagreed && !is_siteadmin() &&
832             ($manager = new \core_privacy\local\sitepolicy\manager()) && $manager->is_defined())) {
833         return '';
834     }
836     $renderer = $PAGE->get_renderer('core');
837     $requestcount = \core_message\api::get_received_contact_requests_count($USER->id);
838     $contactscount = \core_message\api::count_contacts($USER->id);
840     $choices = [];
841     $choices[] = [
842         'value' => \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS,
843         'text' => get_string('contactableprivacy_onlycontacts', 'message')
844     ];
845     $choices[] = [
846         'value' => \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER,
847         'text' => get_string('contactableprivacy_coursemember', 'message')
848     ];
849     if (!empty($CFG->messagingallusers)) {
850         // Add the MESSAGE_PRIVACY_SITE option when site-wide messaging between users is enabled.
851         $choices[] = [
852             'value' => \core_message\api::MESSAGE_PRIVACY_SITE,
853             'text' => get_string('contactableprivacy_site', 'message')
854         ];
855     }
857     // Enter to send.
858     $entertosend = get_user_preferences('message_entertosend', false, $USER);
860     return $renderer->render_from_template('core_message/message_drawer', [
861         'contactrequestcount' => $requestcount,
862         'loggedinuser' => [
863             'id' => $USER->id,
864             'midnight' => usergetmidnight(time())
865         ],
866         'contacts' => [
867             'sectioncontacts' => [
868                 'placeholders' => array_fill(0, $contactscount > 50 ? 50 : $contactscount, true)
869             ],
870             'sectionrequests' => [
871                 'placeholders' => array_fill(0, $requestcount > 50 ? 50 : $requestcount, true)
872             ],
873         ],
874         'settings' => [
875             'privacy' => $choices,
876             'entertosend' => $entertosend
877         ]
878     ]);