9408c0733fec8e65fa65d6bffe9e730786b440ec
[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 require_once($CFG->libdir.'/eventslib.php');
27 define ('MESSAGE_SHORTLENGTH', 300);
29 define ('MESSAGE_DISCUSSION_WIDTH',600);
30 define ('MESSAGE_DISCUSSION_HEIGHT',500);
32 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
34 define('MESSAGE_HISTORY_SHORT',0);
35 define('MESSAGE_HISTORY_ALL',1);
37 define('MESSAGE_VIEW_UNREAD_MESSAGES','unread');
38 define('MESSAGE_VIEW_RECENT_CONVERSATIONS','recentconversations');
39 define('MESSAGE_VIEW_RECENT_NOTIFICATIONS','recentnotifications');
40 define('MESSAGE_VIEW_CONTACTS','contacts');
41 define('MESSAGE_VIEW_BLOCKED','blockedusers');
42 define('MESSAGE_VIEW_COURSE','course_');
43 define('MESSAGE_VIEW_SEARCH','search');
45 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
47 define('MESSAGE_CONTACTS_PER_PAGE',10);
48 define('MESSAGE_MAX_COURSE_NAME_LENGTH', 30);
50 /**
51  * Define contants for messaging default settings population. For unambiguity of
52  * plugin developer intentions we use 4-bit value (LSB numbering):
53  * bit 0 - whether to send message when user is loggedin (MESSAGE_DEFAULT_LOGGEDIN)
54  * bit 1 - whether to send message when user is loggedoff (MESSAGE_DEFAULT_LOGGEDOFF)
55  * bit 2..3 - messaging permission (MESSAGE_DISALLOWED|MESSAGE_PERMITTED|MESSAGE_FORCED)
56  *
57  * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
58  */
60 define('MESSAGE_DEFAULT_LOGGEDIN', 0x01); // 0001
61 define('MESSAGE_DEFAULT_LOGGEDOFF', 0x02); // 0010
63 define('MESSAGE_DISALLOWED', 0x04); // 0100
64 define('MESSAGE_PERMITTED', 0x08); // 1000
65 define('MESSAGE_FORCED', 0x0c); // 1100
67 define('MESSAGE_PERMITTED_MASK', 0x0c); // 1100
69 /**
70  * Set default value for default outputs permitted setting
71  */
72 define('MESSAGE_DEFAULT_PERMITTED', 'permitted');
74 /**
75  * Print the selector that allows the user to view their contacts, course participants, their recent
76  * conversations etc
77  *
78  * @param int $countunreadtotal how many unread messages does the user have?
79  * @param int $viewing What is the user viewing? ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_SEARCH etc
80  * @param object $user1 the user whose messages are being viewed
81  * @param object $user2 the user $user1 is talking to
82  * @param array $blockedusers an array of users blocked by $user1
83  * @param array $onlinecontacts an array of $user1's online contacts
84  * @param array $offlinecontacts an array of $user1's offline contacts
85  * @param array $strangers an array of users who have messaged $user1 who aren't contacts
86  * @param bool $showactionlinks show action links (add/remove contact etc)
87  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
88  * @return void
89  */
90 function message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showactionlinks, $page=0) {
91     global $PAGE;
93     echo html_writer::start_tag('div', array('class' => 'contactselector mdl-align'));
95     //if 0 unread messages and they've requested unread messages then show contacts
96     if ($countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
97         $viewing = MESSAGE_VIEW_CONTACTS;
98     }
100     //if they have no blocked users and they've requested blocked users switch them over to contacts
101     if (count($blockedusers) == 0 && $viewing == MESSAGE_VIEW_BLOCKED) {
102         $viewing = MESSAGE_VIEW_CONTACTS;
103     }
105     $onlyactivecourses = true;
106     $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
107     $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
109     $strunreadmessages = null;
110     if ($countunreadtotal>0) { //if there are unread messages
111         $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
112     }
114     message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages, $user1);
116     if ($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
117         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showactionlinks,$strunreadmessages, $user2);
118     } else if ($viewing == MESSAGE_VIEW_CONTACTS || $viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS || $viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
119         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 0, $showactionlinks, $strunreadmessages, $user2);
120     } else if ($viewing == MESSAGE_VIEW_BLOCKED) {
121         message_print_blocked_users($blockedusers, $PAGE->url, $showactionlinks, null, $user2);
122     } else if (substr($viewing, 0, 7) == MESSAGE_VIEW_COURSE) {
123         $courseidtoshow = intval(substr($viewing, 7));
125         if (!empty($courseidtoshow)
126             && array_key_exists($courseidtoshow, $coursecontexts)
127             && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
129             message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showactionlinks, null, $page, $user2);
130         }
131     }
133     // Only show the search button if we're viewing our own messages.
134     // Search isn't currently able to deal with user A wanting to search user B's messages.
135     if ($showactionlinks) {
136         echo html_writer::start_tag('form', array('action' => 'index.php','method' => 'GET'));
137         echo html_writer::start_tag('fieldset');
138         $managebuttonclass = 'visible';
139         if ($viewing == MESSAGE_VIEW_SEARCH) {
140             $managebuttonclass = 'hiddenelement';
141         }
142         $strmanagecontacts = get_string('search','message');
143         echo html_writer::empty_tag('input', array('type' => 'hidden','name' => 'viewing','value' => MESSAGE_VIEW_SEARCH));
144         echo html_writer::empty_tag('input', array('type' => 'submit','value' => $strmanagecontacts,'class' => $managebuttonclass));
145         echo html_writer::end_tag('fieldset');
146         echo html_writer::end_tag('form');
147     }
149     echo html_writer::end_tag('div');
152 /**
153  * Print course participants. Called by message_print_contact_selector()
154  *
155  * @param object $context the course context
156  * @param int $courseid the course ID
157  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
158  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
159  * @param string $titletodisplay Optionally specify a title to display above the participants
160  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
161  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
162  * @return void
163  */
164 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
165     global $DB, $USER, $PAGE, $OUTPUT;
167     if (empty($titletodisplay)) {
168         $titletodisplay = get_string('participants');
169     }
171     $countparticipants = count_enrolled_users($context);
173     list($esql, $params) = get_enrolled_sql($context);
174     $params['mcuserid'] = $USER->id;
175     $ufields = user_picture::fields('u');
177     $sql = "SELECT $ufields, mc.id as contactlistid, mc.blocked
178               FROM {user} u
179               JOIN ($esql) je ON je.id = u.id
180               LEFT JOIN {message_contacts} mc ON mc.contactid = u.id AND mc.userid = :mcuserid
181              WHERE u.deleted = 0";
183     $participants = $DB->get_records_sql($sql, $params, $page * MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
185     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
186     echo $OUTPUT->render($pagingbar);
188     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
190     echo html_writer::start_tag('tr');
191     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
192     echo html_writer::end_tag('tr');
194     foreach ($participants as $participant) {
195         if ($participant->id != $USER->id) {
197             $iscontact = false;
198             $isblocked = false;
199             if ( $participant->contactlistid )  {
200                 if ($participant->blocked == 0) {
201                     // Is contact. Is not blocked.
202                     $iscontact = true;
203                     $isblocked = false;
204                 } else {
205                     // Is blocked.
206                     $iscontact = false;
207                     $isblocked = true;
208                 }
209             }
211             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
212             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
213         }
214     }
216     echo html_writer::end_tag('table');
219 /**
220  * Retrieve users blocked by $user1
221  *
222  * @param object $user1 the user whose messages are being viewed
223  * @param object $user2 the user $user1 is talking to. If they are being blocked
224  *                      they will have a variable called 'isblocked' added to their user object
225  * @return array the users blocked by $user1
226  */
227 function message_get_blocked_users($user1=null, $user2=null) {
228     global $DB, $USER;
230     if (empty($user1)) {
231         $user1 = $USER;
232     }
234     if (!empty($user2)) {
235         $user2->isblocked = false;
236     }
238     $blockedusers = array();
240     $userfields = user_picture::fields('u', array('lastaccess'));
241     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
242                           FROM {message_contacts} mc
243                           JOIN {user} u ON u.id = mc.contactid
244                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
245                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
246                       GROUP BY $userfields
247                       ORDER BY u.firstname ASC";
248     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
250     foreach($rs as $rd) {
251         $blockedusers[] = $rd;
253         if (!empty($user2) && $user2->id == $rd->id) {
254             $user2->isblocked = true;
255         }
256     }
257     $rs->close();
259     return $blockedusers;
262 /**
263  * Print users blocked by $user1. Called by message_print_contact_selector()
264  *
265  * @param array $blockedusers the users blocked by $user1
266  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
267  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
268  * @param string $titletodisplay Optionally specify a title to display above the participants
269  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
270  * @return void
271  */
272 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
273     global $DB, $USER;
275     $countblocked = count($blockedusers);
277     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
279     if (!empty($titletodisplay)) {
280         echo html_writer::start_tag('tr');
281         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
282         echo html_writer::end_tag('tr');
283     }
285     if ($countblocked) {
286         echo html_writer::start_tag('tr');
287         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
288         echo html_writer::end_tag('tr');
290         $isuserblocked = true;
291         $isusercontact = false;
292         foreach ($blockedusers as $blockeduser) {
293             message_print_contactlist_user($blockeduser, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
294         }
295     }
297     echo html_writer::end_tag('table');
300 /**
301  * Retrieve $user1's contacts (online, offline and strangers)
302  *
303  * @param object $user1 the user whose messages are being viewed
304  * @param object $user2 the user $user1 is talking to. If they are a contact
305  *                      they will have a variable called 'iscontact' added to their user object
306  * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
307  */
308 function message_get_contacts($user1=null, $user2=null) {
309     global $DB, $CFG, $USER;
311     if (empty($user1)) {
312         $user1 = $USER;
313     }
315     if (!empty($user2)) {
316         $user2->iscontact = false;
317     }
319     $timetoshowusers = 300; //Seconds default
320     if (isset($CFG->block_online_users_timetosee)) {
321         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
322     }
324     // time which a user is counting as being active since
325     $timefrom = time()-$timetoshowusers;
327     // people in our contactlist who are online
328     $onlinecontacts  = array();
329     // people in our contactlist who are offline
330     $offlinecontacts = array();
331     // people who are not in our contactlist but have sent us a message
332     $strangers       = array();
334     $userfields = user_picture::fields('u', array('lastaccess'));
336     // get all in our contactlist who are not blocked in our contact list
337     // and count messages we have waiting from each of them
338     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
339                      FROM {message_contacts} mc
340                      JOIN {user} u ON u.id = mc.contactid
341                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
342                     WHERE mc.userid = ? AND mc.blocked = 0
343                  GROUP BY $userfields
344                  ORDER BY u.firstname ASC";
346     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
347     foreach ($rs as $rd) {
348         if ($rd->lastaccess >= $timefrom) {
349             // they have been active recently, so are counted online
350             $onlinecontacts[] = $rd;
352         } else {
353             $offlinecontacts[] = $rd;
354         }
356         if (!empty($user2) && $user2->id == $rd->id) {
357             $user2->iscontact = true;
358         }
359     }
360     $rs->close();
362     // get messages from anyone who isn't in our contact list and count the number
363     // of messages we have from each of them
364     $strangersql = "SELECT $userfields, count(m.id) as messagecount
365                       FROM {message} m
366                       JOIN {user} u  ON u.id = m.useridfrom
367                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
368                      WHERE mc.id IS NULL AND m.useridto = ?
369                   GROUP BY $userfields
370                   ORDER BY u.firstname ASC";
372     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
373     // Add user id as array index, so supportuser and noreply user don't get duplicated (if they are real users).
374     foreach ($rs as $rd) {
375         $strangers[$rd->id] = $rd;
376     }
377     $rs->close();
379     // Add noreply user and support user to the list, if they don't exist.
380     $supportuser = core_user::get_support_user();
381     if (!isset($strangers[$supportuser->id])) {
382         $supportuser->messagecount = message_count_unread_messages($USER, $supportuser);
383         if ($supportuser->messagecount > 0) {
384             $strangers[$supportuser->id] = $supportuser;
385         }
386     }
388     $noreplyuser = core_user::get_noreply_user();
389     if (!isset($strangers[$noreplyuser->id])) {
390         $noreplyuser->messagecount = message_count_unread_messages($USER, $noreplyuser);
391         if ($noreplyuser->messagecount > 0) {
392             $strangers[$noreplyuser->id] = $noreplyuser;
393         }
394     }
395     return array($onlinecontacts, $offlinecontacts, $strangers);
398 /**
399  * Print $user1's contacts. Called by message_print_contact_selector()
400  *
401  * @param array $onlinecontacts $user1's contacts which are online
402  * @param array $offlinecontacts $user1's contacts which are offline
403  * @param array $strangers users which are not contacts but who have messaged $user1
404  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
405  * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
406  *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
407  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
408  * @param string $titletodisplay Optionally specify a title to display above the participants
409  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
410  * @return void
411  */
412 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
413     global $CFG, $PAGE, $OUTPUT;
415     $countonlinecontacts  = count($onlinecontacts);
416     $countofflinecontacts = count($offlinecontacts);
417     $countstrangers       = count($strangers);
418     $isuserblocked = null;
420     if ($countonlinecontacts + $countofflinecontacts == 0) {
421         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
422     }
424     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
426     if (!empty($titletodisplay)) {
427         message_print_heading($titletodisplay);
428     }
430     if($countonlinecontacts) {
431         // Print out list of online contacts.
433         if (empty($titletodisplay)) {
434             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
435         }
437         $isuserblocked = false;
438         $isusercontact = true;
439         foreach ($onlinecontacts as $contact) {
440             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
441                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
442             }
443         }
444     }
446     if ($countofflinecontacts) {
447         // Print out list of offline contacts.
449         if (empty($titletodisplay)) {
450             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
451         }
453         $isuserblocked = false;
454         $isusercontact = true;
455         foreach ($offlinecontacts as $contact) {
456             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
457                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
458             }
459         }
461     }
463     // Print out list of incoming contacts.
464     if ($countstrangers) {
465         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
467         $isuserblocked = false;
468         $isusercontact = false;
469         foreach ($strangers as $stranger) {
470             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
471                 message_print_contactlist_user($stranger, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
472             }
473         }
474     }
476     echo html_writer::end_tag('table');
478     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
479         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
480     }
483 /**
484  * Print a select box allowing the user to choose to view new messages, course participants etc.
485  *
486  * Called by message_print_contact_selector()
487  * @param int $viewing What page is the user viewing ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_RECENT_CONVERSATIONS etc
488  * @param array $courses array of course objects. The courses the user is enrolled in.
489  * @param array $coursecontexts array of course contexts. Keyed on course id.
490  * @param int $countunreadtotal how many unread messages does the user have?
491  * @param int $countblocked how many users has the current user blocked?
492  * @param stdClass $user1 The user whose messages we are viewing.
493  * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
494  * @return void
495  */
496 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages, $user1 = null) {
497     $options = array();
499     if ($countunreadtotal>0) { //if there are unread messages
500         $options[MESSAGE_VIEW_UNREAD_MESSAGES] = $strunreadmessages;
501     }
503     $str = get_string('contacts', 'message');
504     $options[MESSAGE_VIEW_CONTACTS] = $str;
506     $options[MESSAGE_VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
507     $options[MESSAGE_VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
509     if (!empty($courses)) {
510         $courses_options = array();
512         foreach($courses as $course) {
513             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
514                 //Not using short_text() as we want the end of the course name. Not the beginning.
515                 $shortname = format_string($course->shortname, true, array('context' => $coursecontexts[$course->id]));
516                 if (core_text::strlen($shortname) > MESSAGE_MAX_COURSE_NAME_LENGTH) {
517                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = '...'.core_text::substr($shortname, -MESSAGE_MAX_COURSE_NAME_LENGTH);
518                 } else {
519                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = $shortname;
520                 }
521             }
522         }
524         if (!empty($courses_options)) {
525             $options[] = array(get_string('courses') => $courses_options);
526         }
527     }
529     if ($countblocked>0) {
530         $str = get_string('blockedusers','message', $countblocked);
531         $options[MESSAGE_VIEW_BLOCKED] = $str;
532     }
534     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
535     echo html_writer::start_tag('fieldset');
536     if ( !empty($user1) && !empty($user1->id) ) {
537         echo html_writer::empty_tag('input', array('type' => 'hidden','name' => 'user1','value' => $user1->id));
538     }
539     echo html_writer::label(get_string('messagenavigation', 'message'), 'viewing');
540     echo html_writer::select($options, 'viewing', $viewing, false, array('id' => 'viewing','onchange' => 'this.form.submit()'));
541     echo html_writer::end_tag('fieldset');
542     echo html_writer::end_tag('form');
545 /**
546  * Load the course contexts for all of the users courses
547  *
548  * @param array $courses array of course objects. The courses the user is enrolled in.
549  * @return array of course contexts
550  */
551 function message_get_course_contexts($courses) {
552     $coursecontexts = array();
554     foreach($courses as $course) {
555         $coursecontexts[$course->id] = context_course::instance($course->id);
556     }
558     return $coursecontexts;
561 /**
562  * strip off action parameters like 'removecontact'
563  *
564  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
565  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
566  */
567 function message_remove_url_params($moodleurl) {
568     $newurl = new moodle_url($moodleurl);
569     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
570     return $newurl->out();
573 /**
574  * Count the number of messages with a field having a specified value.
575  * if $field is empty then return count of the whole array
576  * if $field is non-existent then return 0
577  *
578  * @param array $messagearray array of message objects
579  * @param string $field the field to inspect on the message objects
580  * @param string $value the value to test the field against
581  */
582 function message_count_messages($messagearray, $field='', $value='') {
583     if (!is_array($messagearray)) return 0;
584     if ($field == '' or empty($messagearray)) return count($messagearray);
586     $count = 0;
587     foreach ($messagearray as $message) {
588         $count += ($message->$field == $value) ? 1 : 0;
589     }
590     return $count;
593 /**
594  * Returns the count of unread messages for user. Either from a specific user or from all users.
595  *
596  * @param object $user1 the first user. Defaults to $USER
597  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
598  * @return int the count of $user1's unread messages
599  */
600 function message_count_unread_messages($user1=null, $user2=null) {
601     global $USER, $DB;
603     if (empty($user1)) {
604         $user1 = $USER;
605     }
607     if (!empty($user2)) {
608         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
609             array($user1->id, $user2->id), "COUNT('id')");
610     } else {
611         return $DB->count_records_select('message', "useridto = ?",
612             array($user1->id), "COUNT('id')");
613     }
616 /**
617  * Count the number of users blocked by $user1
618  *
619  * @param object $user1 user object
620  * @return int the number of blocked users
621  */
622 function message_count_blocked_users($user1=null) {
623     global $USER, $DB;
625     if (empty($user1)) {
626         $user1 = $USER;
627     }
629     $sql = "SELECT count(mc.id)
630             FROM {message_contacts} mc
631             WHERE mc.userid = :userid AND mc.blocked = 1";
632     $params = array('userid' => $user1->id);
634     return $DB->count_records_sql($sql, $params);
637 /**
638  * Print the search form and search results if a search has been performed
639  *
640  * @param  boolean $advancedsearch show basic or advanced search form
641  * @param  object $user1 the current user
642  * @return boolean true if a search was performed
643  */
644 function message_print_search($advancedsearch = false, $user1=null) {
645     $frm = data_submitted();
647     $doingsearch = false;
648     if ($frm) {
649         if (confirm_sesskey()) {
650             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
651         } else {
652             $frm = false;
653         }
654     }
656     if (!empty($frm->combinedsearch)) {
657         $combinedsearchstring = $frm->combinedsearch;
658     } else {
659         //$combinedsearchstring = get_string('searchcombined','message').'...';
660         $combinedsearchstring = '';
661     }
663     if ($doingsearch) {
664         if ($advancedsearch) {
666             $messagesearch = '';
667             if (!empty($frm->keywords)) {
668                 $messagesearch = $frm->keywords;
669             }
670             $personsearch = '';
671             if (!empty($frm->name)) {
672                 $personsearch = $frm->name;
673             }
674             include('search_advanced.html');
675         } else {
676             include('search.html');
677         }
679         $showicontext = false;
680         message_print_search_results($frm, $showicontext, $user1);
682         return true;
683     } else {
685         if ($advancedsearch) {
686             $personsearch = $messagesearch = '';
687             include('search_advanced.html');
688         } else {
689             include('search.html');
690         }
691         return false;
692     }
695 /**
696  * Get the users recent conversations meaning all the people they've recently
697  * sent or received a message from plus the most recent message sent to or received from each other user
698  *
699  * @param object $user the current user
700  * @param int $limitfrom can be used for paging
701  * @param int $limitto can be used for paging
702  * @return array
703  */
704 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
705     global $DB;
707     $userfields = user_picture::fields('otheruser', array('lastaccess'));
709     // This query retrieves the most recent message received from or sent to
710     // seach other user.
711     //
712     // If two messages have the same timecreated, we take the one with the
713     // larger id.
714     //
715     // There is a separate query for read and unread messages as they are stored
716     // in different tables. They were originally retrieved in one query but it
717     // was so large that it was difficult to be confident in its correctness.
718     $sql = "SELECT $userfields,
719                    message.id as mid, message.notification, message.smallmessage, message.fullmessage,
720                    message.fullmessagehtml, message.fullmessageformat, message.timecreated,
721                    contact.id as contactlistid, contact.blocked
723               FROM {message_read} message
724               JOIN {user} otheruser ON otheruser.id = CASE
725                                 WHEN message.useridto = :userid1 THEN message.useridfrom
726                                                                  ELSE message.useridto END
727          LEFT JOIN {message_contacts} contact ON contact.userid = :userid2 AND contact.contactid = otheruser.id
729              WHERE otheruser.deleted = 0
730                AND (message.useridto = :userid3 OR message.useridfrom = :userid4)
731                AND message.notification = 0
732                AND NOT EXISTS (
733                         SELECT 1
734                           FROM {message_read} othermessage
735                          WHERE ((othermessage.useridto = :userid5 AND othermessage.useridfrom = otheruser.id) OR
736                                 (othermessage.useridfrom = :userid6 AND othermessage.useridto = otheruser.id))
737                            AND (othermessage.timecreated > message.timecreated OR (
738                                 othermessage.timecreated = message.timecreated AND othermessage.id > message.id))
739                    )
741           ORDER BY message.timecreated DESC";
742     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id,
743             'userid4' => $user->id, 'userid5' => $user->id, 'userid6' => $user->id);
744     $read = $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
746     // We want to get the messages that have not been read. These are stored in the 'message' table. It is the
747     // exact same query as the one above, except for the table we are querying. So, simply replace references to
748     // the 'message_read' table with the 'message' table.
749     $sql = str_replace('{message_read}', '{message}', $sql);
750     $unread = $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
752     $conversations = array();
754     // Union the 2 result sets together looking for the message with the most
755     // recent timecreated for each other user.
756     // $conversation->id (the array key) is the other user's ID.
757     $conversation_arrays = array($unread, $read);
758     foreach ($conversation_arrays as $conversation_array) {
759         foreach ($conversation_array as $conversation) {
760             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
761                 $conversations[$conversation->id] = $conversation;
762             }
763         }
764     }
766     // Sort the conversations by $conversation->timecreated, newest to oldest
767     // There may be multiple conversations with the same timecreated
768     // The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
769     $result = core_collator::asort_objects_by_property($conversations, 'timecreated', core_collator::SORT_NUMERIC);
770     $conversations = array_reverse($conversations);
772     return $conversations;
775 /**
776  * Get the users recent event notifications
777  *
778  * @param object $user the current user
779  * @param int $limitfrom can be used for paging
780  * @param int $limitto can be used for paging
781  * @return array
782  */
783 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
784     global $DB;
786     $userfields = user_picture::fields('u', array('lastaccess'));
787     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.notification, mr.smallmessage, mr.fullmessage, mr.fullmessagehtml, mr.fullmessageformat, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
788               FROM {message_read} mr
789                    JOIN {user} u ON u.id=mr.useridfrom
790              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
791              ORDER BY mr.timecreated DESC";
792     $params = array('userid1' => $user->id, 'notification' => 1);
794     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
795     return $notifications;
798 /**
799  * Print the user's recent conversations
800  *
801  * @param stdClass $user the current user
802  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
803  */
804 function message_print_recent_conversations($user1 = null, $showicontext = false, $showactionlinks = true) {
805     global $USER;
807     echo html_writer::start_tag('p', array('class' => 'heading'));
808     echo get_string('mostrecentconversations', 'message');
809     echo html_writer::end_tag('p');
811     if (empty($user1)) {
812         $user1 = $USER;
813     }
815     $conversations = message_get_recent_conversations($user1);
817     // Attach context url information to create the "View this conversation" type links
818     foreach($conversations as $conversation) {
819         $conversation->contexturl = new moodle_url("/message/index.php?user1={$user1->id}&user2={$conversation->id}");
820         $conversation->contexturlname = get_string('thisconversation', 'message');
821     }
823     $showotheruser = true;
824     message_print_recent_messages_table($conversations, $user1, $showotheruser, $showicontext, false, $showactionlinks);
827 /**
828  * Print the user's recent notifications
829  *
830  * @param stdClass $user the current user
831  */
832 function message_print_recent_notifications($user=null) {
833     global $USER;
835     echo html_writer::start_tag('p', array('class' => 'heading'));
836     echo get_string('mostrecentnotifications', 'message');
837     echo html_writer::end_tag('p');
839     if (empty($user)) {
840         $user = $USER;
841     }
843     $notifications = message_get_recent_notifications($user);
845     $showicontext = false;
846     $showotheruser = false;
847     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext, true);
850 /**
851  * Print a list of recent messages
852  *
853  * @access private
854  *
855  * @param array $messages the messages to display
856  * @param stdClass $user the current user
857  * @param bool $showotheruser display information on the other user?
858  * @param bool $showicontext show text next to the action icons?
859  * @param bool $forcetexttohtml Force text to go through @see text_to_html() via @see format_text()
860  * @param bool $showactionlinks
861  * @return void
862  */
863 function message_print_recent_messages_table($messages, $user = null, $showotheruser = true, $showicontext = false, $forcetexttohtml = false, $showactionlinks = true) {
864     global $OUTPUT;
865     static $dateformat;
867     if (empty($dateformat)) {
868         $dateformat = get_string('strftimedatetimeshort');
869     }
871     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
872     foreach ($messages as $message) {
873         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
875         if ($showotheruser) {
876             $strcontact = $strblock = $strhistory = null;
878             if ($showactionlinks) {
879                 if ( $message->contactlistid )  {
880                     if ($message->blocked == 0) { // The other user isn't blocked.
881                         $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
882                         $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
883                     } else { // The other user is blocked.
884                         $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
885                         $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
886                     }
887                 } else {
888                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
889                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
890                 }
892                 //should we show just the icon or icon and text?
893                 $histicontext = 'icon';
894                 if ($showicontext) {
895                     $histicontext = 'both';
896                 }
897                 $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
898             }
899             echo html_writer::start_tag('span', array('class' => 'otheruser'));
901             echo html_writer::start_tag('span', array('class' => 'pix'));
902             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
903             echo html_writer::end_tag('span');
905             echo html_writer::start_tag('span', array('class' => 'contact'));
907             $link = new moodle_url("/message/index.php?user1={$user->id}&user2=$message->id");
908             $action = null;
909             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
911             echo html_writer::end_tag('span');//end contact
913             if ($showactionlinks) {
914                 echo $strcontact.$strblock.$strhistory;
915             }
916             echo html_writer::end_tag('span');//end otheruser
917         }
919         $messagetext = message_format_message_text($message, $forcetexttohtml);
921         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
922         echo html_writer::tag('span', $messagetext, array('class' => 'themessage'));
923         echo message_format_contexturl($message);
924         echo html_writer::end_tag('div');//end singlemessage
925     }
926     echo html_writer::end_tag('div');//end messagerecent
929 /**
930  * Try to guess how to convert the message to html.
931  *
932  * @access private
933  *
934  * @param stdClass $message
935  * @param bool $forcetexttohtml
936  * @return string html fragment
937  */
938 function message_format_message_text($message, $forcetexttohtml = false) {
939     // Note: this is a very nasty hack that tries to work around the weird messaging rules and design.
941     $options = new stdClass();
942     $options->para = false;
944     $format = $message->fullmessageformat;
946     if ($message->smallmessage !== '') {
947         if ($message->notification == 1) {
948             if ($message->fullmessagehtml !== '' or $message->fullmessage !== '') {
949                 $format = FORMAT_PLAIN;
950             }
951         }
952         $messagetext = $message->smallmessage;
954     } else if ($message->fullmessageformat == FORMAT_HTML) {
955         if ($message->fullmessagehtml !== '') {
956             $messagetext = $message->fullmessagehtml;
957         } else {
958             $messagetext = $message->fullmessage;
959             $format = FORMAT_MOODLE;
960         }
962     } else {
963         if ($message->fullmessage !== '') {
964             $messagetext = $message->fullmessage;
965         } else {
966             $messagetext = $message->fullmessagehtml;
967             $format = FORMAT_HTML;
968         }
969     }
971     if ($forcetexttohtml) {
972         // This is a crazy hack, why not set proper format when creating the notifications?
973         if ($format === FORMAT_PLAIN) {
974             $format = FORMAT_MOODLE;
975         }
976     }
977     return format_text($messagetext, $format, $options);
980 /**
981  * Add the selected user as a contact for the current user
982  *
983  * @param int $contactid the ID of the user to add as a contact
984  * @param int $blocked 1 if you wish to block the contact
985  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
986  *                  Otherwise returns the result of update_record() or insert_record()
987  */
988 function message_add_contact($contactid, $blocked=0) {
989     global $USER, $DB;
991     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
992         return false;
993     }
995     // Check if a record already exists as we may be changing blocking status.
996     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
997         // Check if blocking status has been changed.
998         if ($contact->blocked !== $blocked) {
999             $contact->blocked = $blocked;
1000             $DB->update_record('message_contacts', $contact);
1002             if ($blocked == 1) {
1003                 // Trigger event for blocking a contact.
1004                 $event = \core\event\message_contact_blocked::create(array(
1005                     'objectid' => $contact->id,
1006                     'userid' => $contact->userid,
1007                     'relateduserid' => $contact->contactid,
1008                     'context'  => context_user::instance($contact->userid)
1009                 ));
1010                 $event->add_record_snapshot('message_contacts', $contact);
1011                 $event->trigger();
1012             } else {
1013                 // Trigger event for unblocking a contact.
1014                 $event = \core\event\message_contact_unblocked::create(array(
1015                     'objectid' => $contact->id,
1016                     'userid' => $contact->userid,
1017                     'relateduserid' => $contact->contactid,
1018                     'context'  => context_user::instance($contact->userid)
1019                 ));
1020                 $event->add_record_snapshot('message_contacts', $contact);
1021                 $event->trigger();
1022             }
1024             return true;
1025         } else {
1026             // No change to blocking status.
1027             return true;
1028         }
1030     } else {
1031         // New contact record.
1032         $contact = new stdClass();
1033         $contact->userid = $USER->id;
1034         $contact->contactid = $contactid;
1035         $contact->blocked = $blocked;
1036         $contact->id = $DB->insert_record('message_contacts', $contact);
1038         $eventparams = array(
1039             'objectid' => $contact->id,
1040             'userid' => $contact->userid,
1041             'relateduserid' => $contact->contactid,
1042             'context'  => context_user::instance($contact->userid)
1043         );
1045         if ($blocked) {
1046             $event = \core\event\message_contact_blocked::create($eventparams);
1047         } else {
1048             $event = \core\event\message_contact_added::create($eventparams);
1049         }
1050         // Trigger event.
1051         $event->trigger();
1053         return true;
1054     }
1057 /**
1058  * remove a contact
1059  *
1060  * @param int $contactid the user ID of the contact to remove
1061  * @return bool returns the result of delete_records()
1062  */
1063 function message_remove_contact($contactid) {
1064     global $USER, $DB;
1066     if ($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) {
1067         $DB->delete_records('message_contacts', array('id' => $contact->id));
1069         // Trigger event for removing a contact.
1070         $event = \core\event\message_contact_removed::create(array(
1071             'objectid' => $contact->id,
1072             'userid' => $contact->userid,
1073             'relateduserid' => $contact->contactid,
1074             'context'  => context_user::instance($contact->userid)
1075         ));
1076         $event->add_record_snapshot('message_contacts', $contact);
1077         $event->trigger();
1079         return true;
1080     }
1082     return false;
1085 /**
1086  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
1087  *
1088  * @param int $contactid the user ID of the contact to unblock
1089  * @return bool returns the result of delete_records()
1090  */
1091 function message_unblock_contact($contactid) {
1092     return message_add_contact($contactid, 0);
1095 /**
1096  * Block a user.
1097  *
1098  * @param int $contactid the user ID of the user to block
1099  * @return bool
1100  */
1101 function message_block_contact($contactid) {
1102     return message_add_contact($contactid, 1);
1105 /**
1106  * Load a user's contact record
1107  *
1108  * @param int $contactid the user ID of the user whose contact record you want
1109  * @return array message contacts
1110  */
1111 function message_get_contact($contactid) {
1112     global $USER, $DB;
1113     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
1116 /**
1117  * Print the results of a message search
1118  *
1119  * @param mixed $frm submitted form data
1120  * @param bool $showicontext show text next to action icons?
1121  * @param object $currentuser the current user
1122  * @return void
1123  */
1124 function message_print_search_results($frm, $showicontext=false, $currentuser=null) {
1125     global $USER, $DB, $OUTPUT;
1127     if (empty($currentuser)) {
1128         $currentuser = $USER;
1129     }
1131     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
1133     $personsearch = false;
1134     $personsearchstring = null;
1135     if (!empty($frm->personsubmit) and !empty($frm->name)) {
1136         $personsearch = true;
1137         $personsearchstring = $frm->name;
1138     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1139         $personsearch = true;
1140         $personsearchstring = $frm->combinedsearch;
1141     }
1143     // Search for person.
1144     if ($personsearch) {
1145         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1146             $users = array();
1147             $mycourses = enrol_get_my_courses('id');
1148             $mycoursesids = array();
1149             foreach ($mycourses as $mycourse) {
1150                 $mycoursesids[] = $mycourse->id;
1151             }
1152             $susers = message_search_users($mycoursesids, $personsearchstring);
1153             foreach ($susers as $suser) {
1154                 $users[$suser->id] = $suser;
1155             }
1156         } else {
1157             $users = message_search_users(SITEID, $personsearchstring);
1158         }
1160         if (!empty($users)) {
1161             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1162             echo get_string('userssearchresults', 'message', count($users));
1163             echo html_writer::end_tag('p');
1165             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1166             foreach ($users as $user) {
1168                 if ( $user->contactlistid )  {
1169                     if ($user->blocked == 0) { // User is not blocked.
1170                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1171                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1172                     } else { // blocked
1173                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1174                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1175                     }
1176                 } else {
1177                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1178                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1179                 }
1181                 // Should we show just the icon or icon and text?
1182                 $histicontext = 'icon';
1183                 if ($showicontext) {
1184                     $histicontext = 'both';
1185                 }
1186                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1188                 echo html_writer::start_tag('tr');
1190                 echo html_writer::start_tag('td', array('class' => 'pix'));
1191                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1192                 echo html_writer::end_tag('td');
1194                 echo html_writer::start_tag('td',array('class' => 'contact'));
1195                 $action = null;
1196                 $link = new moodle_url("/message/index.php?id=$user->id");
1197                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1198                 echo html_writer::end_tag('td');
1200                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1201                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1202                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1204                 echo html_writer::end_tag('tr');
1205             }
1206             echo html_writer::end_tag('table');
1208         } else {
1209             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1210             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1211             echo html_writer::end_tag('p');
1212         }
1213     }
1215     // search messages for keywords
1216     $messagesearch = false;
1217     $messagesearchstring = null;
1218     if (!empty($frm->keywords)) {
1219         $messagesearch = true;
1220         $messagesearchstring = clean_text(trim($frm->keywords));
1221     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1222         $messagesearch = true;
1223         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1224     }
1226     if ($messagesearch) {
1227         if ($messagesearchstring) {
1228             $keywords = explode(' ', $messagesearchstring);
1229         } else {
1230             $keywords = array();
1231         }
1232         $tome     = false;
1233         $fromme   = false;
1234         $courseid = 'none';
1236         if (empty($frm->keywordsoption)) {
1237             $frm->keywordsoption = 'allmine';
1238         }
1240         switch ($frm->keywordsoption) {
1241             case 'tome':
1242                 $tome   = true;
1243                 break;
1244             case 'fromme':
1245                 $fromme = true;
1246                 break;
1247             case 'allmine':
1248                 $tome   = true;
1249                 $fromme = true;
1250                 break;
1251             case 'allusers':
1252                 $courseid = SITEID;
1253                 break;
1254             case 'courseusers':
1255                 $courseid = $frm->courseid;
1256                 break;
1257             default:
1258                 $tome   = true;
1259                 $fromme = true;
1260         }
1262         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1264             // Get a list of contacts.
1265             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1266                 $contacts = array();
1267             }
1269             // Print heading with number of results.
1270             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1271             $countresults = count($messages);
1272             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1273                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1274             } else {
1275                 echo get_string('keywordssearchresults', 'message', $countresults);
1276             }
1277             echo html_writer::end_tag('p');
1279             // Print table headings.
1280             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1282             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1283             $headertdend   = html_writer::end_tag('td');
1284             echo html_writer::start_tag('tr');
1285             echo $headertdstart.get_string('from').$headertdend;
1286             echo $headertdstart.get_string('to').$headertdend;
1287             echo $headertdstart.get_string('message', 'message').$headertdend;
1288             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1289             echo html_writer::end_tag('tr');
1291             $blockedcount = 0;
1292             $dateformat = get_string('strftimedatetimeshort');
1293             $strcontext = get_string('context', 'message');
1294             foreach ($messages as $message) {
1296                 // Ignore messages to and from blocked users unless $frm->includeblocked is set.
1297                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1298                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1299                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1300                                                 )
1301                    ) {
1302                     $blockedcount ++;
1303                     continue;
1304                 }
1306                 // Load user-to record.
1307                 if ($message->useridto !== $USER->id) {
1308                     $userto = core_user::get_user($message->useridto);
1309                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1310                                     ($contacts[$message->useridto]->blocked == 0) );
1311                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1312                                     ($contacts[$message->useridto]->blocked == 1) );
1313                 } else {
1314                     $userto = false;
1315                     $tocontact = false;
1316                     $toblocked = false;
1317                 }
1319                 // Load user-from record.
1320                 if ($message->useridfrom !== $USER->id) {
1321                     $userfrom = core_user::get_user($message->useridfrom);
1322                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1323                                     ($contacts[$message->useridfrom]->blocked == 0) );
1324                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1325                                     ($contacts[$message->useridfrom]->blocked == 1) );
1326                 } else {
1327                     $userfrom = false;
1328                     $fromcontact = false;
1329                     $fromblocked = false;
1330                 }
1332                 // Find date string for this message.
1333                 $date = usergetdate($message->timecreated);
1334                 $datestring = $date['year'].$date['mon'].$date['mday'];
1336                 // Print out message row.
1337                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1339                 echo html_writer::start_tag('td', array('class' => 'contact'));
1340                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1341                 echo html_writer::end_tag('td');
1343                 echo html_writer::start_tag('td', array('class' => 'contact'));
1344                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1345                 echo html_writer::end_tag('td');
1347                 echo html_writer::start_tag('td', array('class' => 'summary'));
1348                 echo message_get_fragment($message->smallmessage, $keywords);
1349                 echo html_writer::start_tag('div', array('class' => 'link'));
1351                 // If the user clicks the context link display message sender on the left.
1352                 // EXCEPT if the current user is in the conversation. Current user == always on the left.
1353                 $leftsideuserid = $rightsideuserid = null;
1354                 if ($currentuser->id == $message->useridto) {
1355                     $leftsideuserid = $message->useridto;
1356                     $rightsideuserid = $message->useridfrom;
1357                 } else {
1358                     $leftsideuserid = $message->useridfrom;
1359                     $rightsideuserid = $message->useridto;
1360                 }
1361                 message_history_link($leftsideuserid, $rightsideuserid, false,
1362                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1363                 echo html_writer::end_tag('div');
1364                 echo html_writer::end_tag('td');
1366                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1368                 echo html_writer::end_tag('tr');
1369             }
1372             if ($blockedcount > 0) {
1373                 echo html_writer::start_tag('tr');
1374                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1375                 echo html_writer::end_tag('tr');
1376             }
1377             echo html_writer::end_tag('table');
1379         } else {
1380             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1381         }
1382     }
1384     if (!$personsearch && !$messagesearch) {
1385         //they didn't enter any search terms
1386         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1387     }
1389     echo html_writer::end_tag('div');
1392 /**
1393  * Print information on a user. Used when printing search results.
1394  *
1395  * @param object/bool $user the user to display or false if you just want $USER
1396  * @param bool $iscontact is the user being displayed a contact?
1397  * @param bool $isblocked is the user being displayed blocked?
1398  * @param bool $includeicontext include text next to the action icons?
1399  * @return void
1400  */
1401 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1402     global $USER, $OUTPUT;
1404     $userpictureparams = array('size' => 20, 'courseid' => SITEID);
1406     if ($user === false) {
1407         echo $OUTPUT->user_picture($USER, $userpictureparams);
1408     } else if (core_user::is_real_user($user->id)) { // If not real user, then don't show any links.
1409         $userpictureparams['link'] = false;
1410         echo $OUTPUT->user_picture($USER, $userpictureparams);
1411         echo fullname($user);
1412     } else {
1413         echo $OUTPUT->user_picture($user, $userpictureparams);
1415         $link = new moodle_url("/message/index.php?id=$user->id");
1416         echo $OUTPUT->action_link($link, fullname($user), null, array('title' =>
1417                 get_string('sendmessageto', 'message', fullname($user))));
1419         $return = false;
1420         $script = null;
1421         if ($iscontact) {
1422             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1423         } else {
1424             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1425         }
1427         if ($isblocked) {
1428             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1429         } else {
1430             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1431         }
1432     }
1435 /**
1436  * Print a message contact link
1437  *
1438  * @param int $userid the ID of the user to apply to action to
1439  * @param string $linktype can be add, remove, block or unblock
1440  * @param bool $return if true return the link as a string. If false echo the link.
1441  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1442  * @param bool $text include text next to the icons?
1443  * @param bool $icon include a graphical icon?
1444  * @return string  if $return is true otherwise bool
1445  */
1446 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1447     global $OUTPUT, $PAGE;
1449     //hold onto the strings as we're probably creating a bunch of links
1450     static $str;
1452     if (empty($script)) {
1453         //strip off previous action params like 'removecontact'
1454         $script = message_remove_url_params($PAGE->url);
1455     }
1457     if (empty($str->blockcontact)) {
1458        $str = new stdClass();
1459        $str->blockcontact   =  get_string('blockcontact', 'message');
1460        $str->unblockcontact =  get_string('unblockcontact', 'message');
1461        $str->removecontact  =  get_string('removecontact', 'message');
1462        $str->addcontact     =  get_string('addcontact', 'message');
1463     }
1465     $command = $linktype.'contact';
1466     $string  = $str->{$command};
1468     $safealttext = s($string);
1470     $safestring = '';
1471     if (!empty($text)) {
1472         $safestring = $safealttext;
1473     }
1475     $img = '';
1476     if ($icon) {
1477         $iconpath = null;
1478         switch ($linktype) {
1479             case 'block':
1480                 $iconpath = 't/block';
1481                 break;
1482             case 'unblock':
1483                 $iconpath = 't/unblock';
1484                 break;
1485             case 'remove':
1486                 $iconpath = 't/removecontact';
1487                 break;
1488             case 'add':
1489             default:
1490                 $iconpath = 't/addcontact';
1491         }
1493         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1494     }
1496     $output = '<span class="'.$linktype.'contact">'.
1497               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1498               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1499               $img.
1500               $safestring.'</a></span>';
1502     if ($return) {
1503         return $output;
1504     } else {
1505         echo $output;
1506         return true;
1507     }
1510 /**
1511  * echo or return a link to take the user to the full message history between themselves and another user
1512  *
1513  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
1514  * @param int $userid2 the ID of the other user
1515  * @param bool $return true to return the link as a string. False to echo the link.
1516  * @param string $keywords any keywords to highlight in the message history
1517  * @param string $position anchor name to jump to within the message history
1518  * @param string $linktext optionally specify the link text
1519  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1520  */
1521 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1522     global $OUTPUT, $PAGE;
1523     static $strmessagehistory;
1525     if (empty($strmessagehistory)) {
1526         $strmessagehistory = get_string('messagehistory', 'message');
1527     }
1529     if ($position) {
1530         $position = "#$position";
1531     }
1532     if ($keywords) {
1533         $keywords = "&search=".urlencode($keywords);
1534     }
1536     if ($linktext == 'icon') {  // Icon only
1537         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1538     } else if ($linktext == 'both') {  // Icon and standard name
1539         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="" />';
1540         $fulllink .= '&nbsp;'.$strmessagehistory;
1541     } else if ($linktext) {    // Custom name
1542         $fulllink = $linktext;
1543     } else {                   // Standard name only
1544         $fulllink = $strmessagehistory;
1545     }
1547     $popupoptions = array(
1548             'height' => 500,
1549             'width' => 500,
1550             'menubar' => false,
1551             'location' => false,
1552             'status' => true,
1553             'scrollbars' => true,
1554             'resizable' => true);
1556     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
1557     if ($PAGE->url && $PAGE->url->get_param('viewing')) {
1558         $link->param('viewing', $PAGE->url->get_param('viewing'));
1559     }
1560     $action = null;
1561     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1563     $str = '<span class="history">'.$str.'</span>';
1565     if ($return) {
1566         return $str;
1567     } else {
1568         echo $str;
1569         return true;
1570     }
1574 /**
1575  * Search through course users.
1576  *
1577  * If $courseids contains the site course then this function searches
1578  * through all undeleted and confirmed users.
1579  *
1580  * @param int|array $courseids Course ID or array of course IDs.
1581  * @param string $searchtext the text to search for.
1582  * @param string $sort the column name to order by.
1583  * @param string|array $exceptions comma separated list or array of user IDs to exclude.
1584  * @return array An array of {@link $USER} records.
1585  */
1586 function message_search_users($courseids, $searchtext, $sort='', $exceptions='') {
1587     global $CFG, $USER, $DB;
1589     // Basic validation to ensure that the parameter $courseids is not an empty array or an empty value.
1590     if (!$courseids) {
1591         $courseids = array(SITEID);
1592     }
1594     // Allow an integer to be passed.
1595     if (!is_array($courseids)) {
1596         $courseids = array($courseids);
1597     }
1599     $fullname = $DB->sql_fullname();
1600     $ufields = user_picture::fields('u');
1602     if (!empty($sort)) {
1603         $order = ' ORDER BY '. $sort;
1604     } else {
1605         $order = '';
1606     }
1608     $params = array(
1609         'userid' => $USER->id,
1610         'query' => "%$searchtext%"
1611     );
1613     if (empty($exceptions)) {
1614         $exceptions = array();
1615     } else if (!empty($exceptions) && is_string($exceptions)) {
1616         $exceptions = explode(',', $exceptions);
1617     }
1619     // Ignore self and guest account.
1620     $exceptions[] = $USER->id;
1621     $exceptions[] = $CFG->siteguest;
1623     // Exclude exceptions from the search result.
1624     list($except, $params_except) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'param', false);
1625     $except = ' AND u.id ' . $except;
1626     $params = array_merge($params_except, $params);
1628     if (in_array(SITEID, $courseids)) {
1629         // Search on site level.
1630         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1631                                        FROM {user} u
1632                                        LEFT JOIN {message_contacts} mc
1633                                             ON mc.contactid = u.id AND mc.userid = :userid
1634                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1635                                             AND (".$DB->sql_like($fullname, ':query', false).")
1636                                             $except
1637                                      $order", $params);
1638     } else {
1639         // Search in courses.
1641         // Getting the context IDs or each course.
1642         $contextids = array();
1643         foreach ($courseids as $courseid) {
1644             $context = context_course::instance($courseid);
1645             $contextids = array_merge($contextids, $context->get_parent_context_ids(true));
1646         }
1647         list($contextwhere, $contextparams) = $DB->get_in_or_equal(array_unique($contextids), SQL_PARAMS_NAMED, 'context');
1648         $params = array_merge($params, $contextparams);
1650         // Everyone who has a role assignment in this course or higher.
1651         // TODO: add enabled enrolment join here (skodak)
1652         $users = $DB->get_records_sql("SELECT DISTINCT $ufields, mc.id as contactlistid, mc.blocked
1653                                          FROM {user} u
1654                                          JOIN {role_assignments} ra ON ra.userid = u.id
1655                                          LEFT JOIN {message_contacts} mc
1656                                               ON mc.contactid = u.id AND mc.userid = :userid
1657                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1658                                               AND (".$DB->sql_like($fullname, ':query', false).")
1659                                               AND ra.contextid $contextwhere
1660                                               $except
1661                                        $order", $params);
1663         return $users;
1664     }
1667 /**
1668  * Search a user's messages
1669  *
1670  * Returns a list of posts found using an array of search terms
1671  * eg   word  +word -word
1672  *
1673  * @param array $searchterms an array of search terms (strings)
1674  * @param bool $fromme include messages from the user?
1675  * @param bool $tome include messages to the user?
1676  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1677  * @param int $userid the user ID of the current user
1678  * @return mixed An array of messages or false if no matching messages were found
1679  */
1680 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1681     global $CFG, $USER, $DB;
1683     // If user is searching all messages check they are allowed to before doing anything else.
1684     if ($courseid == SITEID && !has_capability('moodle/site:readallmessages', context_system::instance())) {
1685         print_error('accessdenied','admin');
1686     }
1688     // If no userid sent then assume current user.
1689     if ($userid == 0) $userid = $USER->id;
1691     // Some differences in SQL syntax.
1692     if ($DB->sql_regex_supported()) {
1693         $REGEXP    = $DB->sql_regex(true);
1694         $NOTREGEXP = $DB->sql_regex(false);
1695     }
1697     $searchcond = array();
1698     $params = array();
1699     $i = 0;
1701     // Preprocess search terms to check whether we have at least 1 eligible search term.
1702     // If we do we can drop words around it like 'a'.
1703     $dropshortwords = false;
1704     foreach ($searchterms as $searchterm) {
1705         if (strlen($searchterm) >= 2) {
1706             $dropshortwords = true;
1707         }
1708     }
1710     foreach ($searchterms as $searchterm) {
1711         $i++;
1713         $NOT = false; // Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle.
1715         if ($dropshortwords && strlen($searchterm) < 2) {
1716             continue;
1717         }
1718         // Under Oracle and MSSQL, trim the + and - operators and perform simpler LIKE search.
1719         if (!$DB->sql_regex_supported()) {
1720             if (substr($searchterm, 0, 1) == '-') {
1721                 $NOT = true;
1722             }
1723             $searchterm = trim($searchterm, '+-');
1724         }
1726         if (substr($searchterm,0,1) == "+") {
1727             $searchterm = substr($searchterm,1);
1728             $searchterm = preg_quote($searchterm, '|');
1729             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1730             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1732         } else if (substr($searchterm,0,1) == "-") {
1733             $searchterm = substr($searchterm,1);
1734             $searchterm = preg_quote($searchterm, '|');
1735             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1736             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1738         } else {
1739             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1740             $params['ss'.$i] = "%$searchterm%";
1741         }
1742     }
1744     if (empty($searchcond)) {
1745         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1746         $params['ss1'] = "%";
1747     } else {
1748         $searchcond = implode(" AND ", $searchcond);
1749     }
1751     // There are several possibilities
1752     // 1. courseid = SITEID : The admin is searching messages by all users
1753     // 2. courseid = ??     : A teacher is searching messages by users in
1754     //                        one of their courses - currently disabled
1755     // 3. courseid = none   : User is searching their own messages;
1756     //    a.  Messages from user
1757     //    b.  Messages to user
1758     //    c.  Messages to and from user
1760     if ($courseid == SITEID) { // Admin is searching all messages.
1761         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1762                                             FROM {message_read} m
1763                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1764         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1765                                             FROM {message} m
1766                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1768     } else if ($courseid !== 'none') {
1769         // This has not been implemented due to security concerns.
1770         $m_read   = array();
1771         $m_unread = array();
1773     } else {
1775         if ($fromme and $tome) {
1776             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1777             $params['userid1'] = $userid;
1778             $params['userid2'] = $userid;
1780         } else if ($fromme) {
1781             $searchcond .= " AND m.useridfrom=:userid";
1782             $params['userid'] = $userid;
1784         } else if ($tome) {
1785             $searchcond .= " AND m.useridto=:userid";
1786             $params['userid'] = $userid;
1787         }
1789         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1790                                             FROM {message_read} m
1791                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1792         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1793                                             FROM {message} m
1794                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1796     }
1798     /// The keys may be duplicated in $m_read and $m_unread so we can't
1799     /// do a simple concatenation
1800     $messages = array();
1801     foreach ($m_read as $m) {
1802         $messages[] = $m;
1803     }
1804     foreach ($m_unread as $m) {
1805         $messages[] = $m;
1806     }
1808     return (empty($messages)) ? false : $messages;
1811 /**
1812  * Given a message object that we already know has a long message
1813  * this function truncates the message nicely to the first
1814  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1815  *
1816  * @param string $message the message
1817  * @param int $minlength the minimum length to trim the message to
1818  * @return string the shortened message
1819  */
1820 function message_shorten_message($message, $minlength = 0) {
1821     $i = 0;
1822     $tag = false;
1823     $length = strlen($message);
1824     $count = 0;
1825     $stopzone = false;
1826     $truncate = 0;
1827     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1830     for ($i=0; $i<$length; $i++) {
1831         $char = $message[$i];
1833         switch ($char) {
1834             case "<":
1835                 $tag = true;
1836                 break;
1837             case ">":
1838                 $tag = false;
1839                 break;
1840             default:
1841                 if (!$tag) {
1842                     if ($stopzone) {
1843                         if ($char == '.' or $char == ' ') {
1844                             $truncate = $i+1;
1845                             break 2;
1846                         }
1847                     }
1848                     $count++;
1849                 }
1850                 break;
1851         }
1852         if (!$stopzone) {
1853             if ($count > $minlength) {
1854                 $stopzone = true;
1855             }
1856         }
1857     }
1859     if (!$truncate) {
1860         $truncate = $i;
1861     }
1863     return substr($message, 0, $truncate);
1867 /**
1868  * Given a string and an array of keywords, this function looks
1869  * for the first keyword in the string, and then chops out a
1870  * small section from the text that shows that word in context.
1871  *
1872  * @param string $message the text to search
1873  * @param array $keywords array of keywords to find
1874  */
1875 function message_get_fragment($message, $keywords) {
1877     $fullsize = 160;
1878     $halfsize = (int)($fullsize/2);
1880     $message = strip_tags($message);
1882     foreach ($keywords as $keyword) {  // Just get the first one
1883         if ($keyword !== '') {
1884             break;
1885         }
1886     }
1887     if (empty($keyword)) {   // None found, so just return start of message
1888         return message_shorten_message($message, 30);
1889     }
1891     $leadin = $leadout = '';
1893 /// Find the start of the fragment
1894     $start = 0;
1895     $length = strlen($message);
1897     $pos = strpos($message, $keyword);
1898     if ($pos > $halfsize) {
1899         $start = $pos - $halfsize;
1900         $leadin = '...';
1901     }
1902 /// Find the end of the fragment
1903     $end = $start + $fullsize;
1904     if ($end > $length) {
1905         $end = $length;
1906     } else {
1907         $leadout = '...';
1908     }
1910 /// Pull out the fragment and format it
1912     $fragment = substr($message, $start, $end - $start);
1913     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1914     return $fragment;
1917 /**
1918  * Retrieve the messages between two users
1919  *
1920  * @param object $user1 the current user
1921  * @param object $user2 the other user
1922  * @param int $limitnum the maximum number of messages to retrieve
1923  * @param bool $viewingnewmessages are we currently viewing new messages?
1924  */
1925 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1926     global $DB, $CFG;
1928     $messages = array();
1930     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1931     //desc to get the last $limitnum messages then flip the order in php
1932     $sort = 'asc';
1933     if ($limitnum>0) {
1934         $sort = 'desc';
1935     }
1937     $notificationswhere = null;
1938     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1939     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1940         $notificationswhere = 'AND notification=0';
1941     }
1943     //prevent notifications of your own actions appearing in your own message history
1944     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1946     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1947                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1948                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1949                                                     "timecreated $sort", '*', 0, $limitnum)) {
1950         foreach ($messages_read as $message) {
1951             $messages[] = $message;
1952         }
1953     }
1954     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1955                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1956                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1957                                                     "timecreated $sort", '*', 0, $limitnum)) {
1958         foreach ($messages_new as $message) {
1959             $messages[] = $message;
1960         }
1961     }
1963     $result = core_collator::asort_objects_by_property($messages, 'timecreated', core_collator::SORT_NUMERIC);
1965     //if we only want the last $limitnum messages
1966     $messagecount = count($messages);
1967     if ($limitnum > 0 && $messagecount > $limitnum) {
1968         $messages = array_slice($messages, $messagecount - $limitnum, $limitnum, true);
1969     }
1971     return $messages;
1974 /**
1975  * Print the message history between two users
1976  *
1977  * @param object $user1 the current user
1978  * @param object $user2 the other user
1979  * @param string $search search terms to highlight
1980  * @param int $messagelimit maximum number of messages to return
1981  * @param string $messagehistorylink the html for the message history link or false
1982  * @param bool $viewingnewmessages are we currently viewing new messages?
1983  */
1984 function message_print_message_history($user1, $user2 ,$search = '', $messagelimit = 0, $messagehistorylink = false, $viewingnewmessages = false, $showactionlinks = true) {
1985     global $CFG, $OUTPUT;
1987     echo $OUTPUT->box_start('center');
1988     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1989     echo html_writer::start_tag('tr');
1991     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1992     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1993     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1994     echo html_writer::end_tag('td');
1996     echo html_writer::start_tag('td', array('align' => 'center'));
1997     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('i/twoway'), 'alt' => ''));
1998     echo html_writer::end_tag('td');
2000     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
2001     // Show user picture with link is real user else without link.
2002     if (core_user::is_real_user($user2->id)) {
2003         echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
2004     } else {
2005         echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID, 'link' => false));
2006     }
2007     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
2009     if ($showactionlinks && isset($user2->iscontact) && isset($user2->isblocked)) {
2011         $script = null;
2012         $text = true;
2013         $icon = false;
2015         $strcontact = message_get_contact_add_remove_link($user2->iscontact, $user2->isblocked, $user2, $script, $text, $icon);
2016         $strblock   = message_get_contact_block_link($user2->iscontact, $user2->isblocked, $user2, $script, $text, $icon);
2017         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
2019         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
2020     }
2022     echo html_writer::end_tag('td');
2023     echo html_writer::end_tag('tr');
2024     echo html_writer::end_tag('table');
2025     echo $OUTPUT->box_end();
2027     if (!empty($messagehistorylink)) {
2028         echo $messagehistorylink;
2029     }
2031     /// Get all the messages and print them
2032     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
2033         $tablecontents = '';
2035         $current = new stdClass();
2036         $current->mday = '';
2037         $current->month = '';
2038         $current->year = '';
2039         $messagedate = get_string('strftimetime');
2040         $blockdate   = get_string('strftimedaydate');
2041         foreach ($messages as $message) {
2042             if ($message->notification) {
2043                 $notificationclass = ' notification';
2044             } else {
2045                 $notificationclass = null;
2046             }
2047             $date = usergetdate($message->timecreated);
2048             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
2049                 $current->mday = $date['mday'];
2050                 $current->month = $date['month'];
2051                 $current->year = $date['year'];
2053                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
2054                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
2056                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
2057             }
2059             $formatted_message = $side = null;
2060             if ($message->useridfrom == $user1->id) {
2061                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
2062                 $side = 'left';
2063             } else {
2064                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
2065                 $side = 'right';
2066             }
2067             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
2068         }
2070         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
2071     } else {
2072         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
2073     }
2076 /**
2077  * Format a message for display in the message history
2078  *
2079  * @param object $message the message object
2080  * @param string $format optional date format
2081  * @param string $keywords keywords to highlight
2082  * @param string $class CSS class to apply to the div around the message
2083  * @return string the formatted message
2084  */
2085 function message_format_message($message, $format='', $keywords='', $class='other') {
2087     static $dateformat;
2089     //if we haven't previously set the date format or they've supplied a new one
2090     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
2091         if ($format) {
2092             $dateformat = $format;
2093         } else {
2094             $dateformat = get_string('strftimedatetimeshort');
2095         }
2096     }
2097     $time = userdate($message->timecreated, $dateformat);
2099     $messagetext = message_format_message_text($message, false);
2101     if ($keywords) {
2102         $messagetext = highlight($keywords, $messagetext);
2103     }
2105     $messagetext .= message_format_contexturl($message);
2107     $messagetext = clean_text($messagetext, FORMAT_HTML);
2109     return <<<TEMPLATE
2110 <div class='message $class'>
2111     <a name="m{$message->id}"></a>
2112     <span class="message-meta"><span class="time">$time</span></span>: <span class="text">$messagetext</span>
2113 </div>
2114 TEMPLATE;
2117 /**
2118  * Format a the context url and context url name of a message for display
2119  *
2120  * @param object $message the message object
2121  * @return string the formatted string
2122  */
2123 function message_format_contexturl($message) {
2124     $s = null;
2126     if (!empty($message->contexturl)) {
2127         $displaytext = null;
2128         if (!empty($message->contexturlname)) {
2129             $displaytext= $message->contexturlname;
2130         } else {
2131             $displaytext= $message->contexturl;
2132         }
2133         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
2134             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
2135         $s .= html_writer::end_tag('div');
2136     }
2138     return $s;
2141 /**
2142  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
2143  *
2144  * @param object $userfrom the message sender
2145  * @param object $userto the message recipient
2146  * @param string $message the message
2147  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
2148  * @return int|false the ID of the new message or false
2149  */
2150 function message_post_message($userfrom, $userto, $message, $format) {
2151     global $SITE, $CFG, $USER;
2153     $eventdata = new stdClass();
2154     $eventdata->component        = 'moodle';
2155     $eventdata->name             = 'instantmessage';
2156     $eventdata->userfrom         = $userfrom;
2157     $eventdata->userto           = $userto;
2159     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
2160     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
2162     if ($format == FORMAT_HTML) {
2163         $eventdata->fullmessagehtml  = $message;
2164         //some message processors may revert to sending plain text even if html is supplied
2165         //so we keep both plain and html versions if we're intending to send html
2166         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
2167     } else {
2168         $eventdata->fullmessage      = $message;
2169         $eventdata->fullmessagehtml  = '';
2170     }
2172     $eventdata->fullmessageformat = $format;
2173     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
2175     $s = new stdClass();
2176     $s->sitename = format_string($SITE->shortname, true, array('context' => context_course::instance(SITEID)));
2177     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
2179     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
2180     if (!empty($eventdata->fullmessage)) {
2181         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
2182     }
2183     if (!empty($eventdata->fullmessagehtml)) {
2184         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
2185     }
2187     $eventdata->timecreated     = time();
2188     $eventdata->notification    = 0;
2189     return message_send($eventdata);
2192 /**
2193  * Print a row of contactlist displaying user picture, messages waiting and
2194  * block links etc
2195  *
2196  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2197  * @param bool $incontactlist is the user a contact of ours?
2198  * @param bool $isblocked is the user blocked?
2199  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2200  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2201  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2202  * @return void
2203  */
2204 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2205     global $OUTPUT, $USER, $COURSE;
2206     $fullname  = fullname($contact);
2207     $fullnamelink  = $fullname;
2209     $linkclass = '';
2210     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2211         $linkclass = 'messageselecteduser';
2212     }
2214     // Are there any unread messages for this contact?
2215     if ($contact->messagecount > 0 ){
2216         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2217     }
2219     $strcontact = $strblock = $strhistory = null;
2221     if ($showactionlinks) {
2222         // Show block and delete links if user is real user.
2223         if (core_user::is_real_user($contact->id)) {
2224             $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2225             $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2226         }
2227         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2228     }
2230     echo html_writer::start_tag('tr');
2231     echo html_writer::start_tag('td', array('class' => 'pix'));
2232     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => $COURSE->id));
2233     echo html_writer::end_tag('td');
2235     echo html_writer::start_tag('td', array('class' => 'contact'));
2237     $popupoptions = array(
2238             'height' => MESSAGE_DISCUSSION_HEIGHT,
2239             'width' => MESSAGE_DISCUSSION_WIDTH,
2240             'menubar' => false,
2241             'location' => false,
2242             'status' => true,
2243             'scrollbars' => true,
2244             'resizable' => true);
2246     $link = $action = null;
2247     if (!empty($selectcontacturl)) {
2248         $link = new moodle_url($selectcontacturl.'&user2='.$contact->id);
2249     } else {
2250         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2251         $link = new moodle_url("/message/index.php?id=$contact->id");
2252         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2253     }
2254     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2256     echo html_writer::end_tag('td');
2258     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2260     echo html_writer::end_tag('tr');
2263 /**
2264  * Constructs the add/remove contact link to display next to other users
2265  *
2266  * @param bool $incontactlist is the user a contact
2267  * @param bool $isblocked is the user blocked
2268  * @param stdClass $contact contact object
2269  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2270  * @param bool $text include text next to the icons?
2271  * @param bool $icon include a graphical icon?
2272  * @return string
2273  */
2274 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2275     $strcontact = '';
2277     if($incontactlist){
2278         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2279     } else if ($isblocked) {
2280         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2281     } else{
2282         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2283     }
2285     return $strcontact;
2288 /**
2289  * Constructs the block contact link to display next to other users
2290  *
2291  * @param bool $incontactlist is the user a contact?
2292  * @param bool $isblocked is the user blocked?
2293  * @param stdClass $contact contact object
2294  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2295  * @param bool $text include text next to the icons?
2296  * @param bool $icon include a graphical icon?
2297  * @return string
2298  */
2299 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2300     $strblock   = '';
2302     //commented out to allow the user to block a contact without having to remove them first
2303     /*if ($incontactlist) {
2304         //$strblock = '';
2305     } else*/
2306     if ($isblocked) {
2307         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2308     } else{
2309         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2310     }
2312     return $strblock;
2315 /**
2316  * Moves messages from a particular user from the message table (unread messages) to message_read
2317  * This is typically only used when a user is deleted
2318  *
2319  * @param object $userid User id
2320  * @return boolean success
2321  */
2322 function message_move_userfrom_unread2read($userid) {
2323     global $DB;
2325     // move all unread messages from message table to message_read
2326     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2327         foreach ($messages as $message) {
2328             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2329         }
2330     }
2331     return true;
2334 /**
2335  * marks ALL messages being sent from $fromuserid to $touserid as read
2336  *
2337  * @param int $touserid the id of the message recipient
2338  * @param int $fromuserid the id of the message sender
2339  * @return void
2340  */
2341 function message_mark_messages_read($touserid, $fromuserid) {
2342     global $DB;
2344     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2345     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2347     foreach ($messages as $message) {
2348         message_mark_message_read($message, time());
2349     }
2351     $messages->close();
2354 /**
2355  * Mark a single message as read
2356  *
2357  * @param stdClass $message An object with an object property ie $message->id which is an id in the message table
2358  * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2359  * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2360  * @return int the ID of the message in the message_read table
2361  */
2362 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2363     global $DB;
2365     $message->timeread = $timeread;
2367     $messageid = $message->id;
2368     unset($message->id);//unset because it will get a new id on insert into message_read
2370     //If any processors have pending actions abort them
2371     if (!$messageworkingempty) {
2372         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2373     }
2374     $messagereadid = $DB->insert_record('message_read', $message);
2376     $DB->delete_records('message', array('id' => $messageid));
2378     // Trigger event for reading a message.
2379     $event = \core\event\message_viewed::create(array(
2380         'objectid' => $messagereadid,
2381         'userid' => $message->useridto, // Using the user who read the message as they are the ones performing the action.
2382         'context'  => context_user::instance($message->useridto),
2383         'relateduserid' => $message->useridfrom,
2384         'other' => array(
2385             'messageid' => $messageid
2386         )
2387     ));
2388     $event->trigger();
2390     return $messagereadid;
2393 /**
2394  * A helper function that prints a formatted heading
2395  *
2396  * @param string $title the heading to display
2397  * @param int $colspan
2398  * @return void
2399  */
2400 function message_print_heading($title, $colspan=3) {
2401     echo html_writer::start_tag('tr');
2402     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2403     echo html_writer::end_tag('tr');
2406 /**
2407  * Get all message processors, validate corresponding plugin existance and
2408  * system configuration
2409  *
2410  * @param bool $ready only return ready-to-use processors
2411  * @param bool $reset Reset list of message processors (used in unit tests)
2412  * @return mixed $processors array of objects containing information on message processors
2413  */
2414 function get_message_processors($ready = false, $reset = false) {
2415     global $DB, $CFG;
2417     static $processors;
2418     if ($reset) {
2419         $processors = array();
2420     }
2422     if (empty($processors)) {
2423         // Get all processors, ensure the name column is the first so it will be the array key
2424         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
2425         foreach ($processors as &$processor){
2426             $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2427             if (is_readable($processorfile)) {
2428                 include_once($processorfile);
2429                 $processclass = 'message_output_' . $processor->name;
2430                 if (class_exists($processclass)) {
2431                     $pclass = new $processclass();
2432                     $processor->object = $pclass;
2433                     $processor->configured = 0;
2434                     if ($pclass->is_system_configured()) {
2435                         $processor->configured = 1;
2436                     }
2437                     $processor->hassettings = 0;
2438                     if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2439                         $processor->hassettings = 1;
2440                     }
2441                     $processor->available = 1;
2442                 } else {
2443                     print_error('errorcallingprocessor', 'message');
2444                 }
2445             } else {
2446                 $processor->available = 0;
2447             }
2448         }
2449     }
2450     if ($ready) {
2451         // Filter out enabled and system_configured processors
2452         $readyprocessors = $processors;
2453         foreach ($readyprocessors as $readyprocessor) {
2454             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
2455                 unset($readyprocessors[$readyprocessor->name]);
2456             }
2457         }
2458         return $readyprocessors;
2459     }
2461     return $processors;
2464 /**
2465  * Get all message providers, validate their plugin existance and
2466  * system configuration
2467  *
2468  * @return mixed $processors array of objects containing information on message processors
2469  */
2470 function get_message_providers() {
2471     global $CFG, $DB;
2473     $pluginman = core_plugin_manager::instance();
2475     $providers = $DB->get_records('message_providers', null, 'name');
2477     // Remove all the providers whose plugins are disabled or don't exist
2478     foreach ($providers as $providerid => $provider) {
2479         $plugin = $pluginman->get_plugin_info($provider->component);
2480         if ($plugin) {
2481             if ($plugin->get_status() === core_plugin_manager::PLUGIN_STATUS_MISSING) {
2482                 unset($providers[$providerid]);   // Plugins does not exist
2483                 continue;
2484             }
2485             if ($plugin->is_enabled() === false) {
2486                 unset($providers[$providerid]);   // Plugin disabled
2487                 continue;
2488             }
2489         }
2490     }
2491     return $providers;
2494 /**
2495  * Get an instance of the message_output class for one of the output plugins.
2496  * @param string $type the message output type. E.g. 'email' or 'jabber'.
2497  * @return message_output message_output the requested class.
2498  */
2499 function get_message_processor($type) {
2500     global $CFG;
2502     // Note, we cannot use the get_message_processors function here, becaues this
2503     // code is called during install after installing each messaging plugin, and
2504     // get_message_processors caches the list of installed plugins.
2506     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
2507     if (!is_readable($processorfile)) {
2508         throw new coding_exception('Unknown message processor type ' . $type);
2509     }
2511     include_once($processorfile);
2513     $processclass = 'message_output_' . $type;
2514     if (!class_exists($processclass)) {
2515         throw new coding_exception('Message processor ' . $type .
2516                 ' does not define the right class');
2517     }
2519     return new $processclass();
2522 /**
2523  * Get messaging outputs default (site) preferences
2524  *
2525  * @return object $processors object containing information on message processors
2526  */
2527 function get_message_output_default_preferences() {
2528     return get_config('message');
2531 /**
2532  * Translate message default settings from binary value to the array of string
2533  * representing the settings to be stored. Also validate the provided value and
2534  * use default if it is malformed.
2535  *
2536  * @param  int    $plugindefault Default setting suggested by plugin
2537  * @param  string $processorname The name of processor
2538  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
2539  */
2540 function translate_message_default_setting($plugindefault, $processorname) {
2541     // Preset translation arrays
2542     $permittedvalues = array(
2543         0x04 => 'disallowed',
2544         0x08 => 'permitted',
2545         0x0c => 'forced',
2546     );
2548     $loggedinstatusvalues = array(
2549         0x00 => null, // use null if loggedin/loggedoff is not defined
2550         0x01 => 'loggedin',
2551         0x02 => 'loggedoff',
2552     );
2554     // define the default setting
2555     $processor = get_message_processor($processorname);
2556     $default = $processor->get_default_messaging_settings();
2558     // Validate the value. It should not exceed the maximum size
2559     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
2560         debugging(get_string('errortranslatingdefault', 'message'));
2561         $plugindefault = $default;
2562     }
2563     // Use plugin default setting of 'permitted' is 0
2564     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
2565         $plugindefault = $default;
2566     }
2568     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
2569     $loggedin = $loggedoff = null;
2571     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
2572         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
2573         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
2574     }
2576     return array($permitted, $loggedin, $loggedoff);
2579 /**
2580  * Return a list of page types
2581  * @param string $pagetype current page type
2582  * @param stdClass $parentcontext Block's parent context
2583  * @param stdClass $currentcontext Current context of block
2584  */
2585 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
2586     return array('messages-*'=>get_string('page-message-x', 'message'));
2589 /**
2590  * Is $USER one of the supplied users?
2591  *
2592  * $user2 will be null if viewing a user's recent conversations
2593  *
2594  * @param stdClass the first user
2595  * @param stdClass the second user or null
2596  * @return bool True if the current user is one of either $user1 or $user2
2597  */
2598 function message_current_user_is_involved($user1, $user2) {
2599     global $USER;
2601     if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2602         throw new coding_exception('Invalid user object detected. Missing id.');
2603     }
2605     if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2606         return false;
2607     }
2608     return true;