0d81b3a578fef7c601cee20d1b957b9c04cd52f8
[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 $showcontactactionlinks show action links (add/remove contact etc) next to the users in the contact selector
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, $showcontactactionlinks, $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);
116     if ($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
117         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showcontactactionlinks,$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, $showcontactactionlinks, $strunreadmessages, $user2);
120     } else if ($viewing == MESSAGE_VIEW_BLOCKED) {
121         message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, 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, $showcontactactionlinks, null, $page, $user2);
130         } else {
131             //shouldn't get here. User trying to access a course they're not in perhaps.
132             add_to_log(SITEID, 'message', 'view', 'index.php', $viewing);
133         }
134     }
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');
148     echo html_writer::end_tag('div');
151 /**
152  * Print course participants. Called by message_print_contact_selector()
153  *
154  * @param object $context the course context
155  * @param int $courseid the course ID
156  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
157  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
158  * @param string $titletodisplay Optionally specify a title to display above the participants
159  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
160  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
161  * @return void
162  */
163 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
164     global $DB, $USER, $PAGE, $OUTPUT;
166     if (empty($titletodisplay)) {
167         $titletodisplay = get_string('participants');
168     }
170     $countparticipants = count_enrolled_users($context);
172     list($esql, $params) = get_enrolled_sql($context);
173     $params['mcuserid'] = $USER->id;
174     $ufields = user_picture::fields('u');
176     $sql = "SELECT $ufields, mc.id as contactlistid, mc.blocked
177               FROM {user} u
178               JOIN ($esql) je ON je.id = u.id
179               LEFT JOIN {message_contacts} mc ON mc.contactid = u.id AND mc.userid = :mcuserid
180              WHERE u.deleted = 0";
182     $participants = $DB->get_records_sql($sql, $params, $page * MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
184     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
185     echo $OUTPUT->render($pagingbar);
187     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
189     echo html_writer::start_tag('tr');
190     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
191     echo html_writer::end_tag('tr');
193     foreach ($participants as $participant) {
194         if ($participant->id != $USER->id) {
196             $iscontact = false;
197             $isblocked = false;
198             if ( $participant->contactlistid )  {
199                 if ($participant->blocked == 0) {
200                     // Is contact. Is not blocked.
201                     $iscontact = true;
202                     $isblocked = false;
203                 } else {
204                     // Is blocked.
205                     $iscontact = false;
206                     $isblocked = true;
207                 }
208             }
210             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
211             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
212         }
213     }
215     echo html_writer::end_tag('table');
218 /**
219  * Retrieve users blocked by $user1
220  *
221  * @param object $user1 the user whose messages are being viewed
222  * @param object $user2 the user $user1 is talking to. If they are being blocked
223  *                      they will have a variable called 'isblocked' added to their user object
224  * @return array the users blocked by $user1
225  */
226 function message_get_blocked_users($user1=null, $user2=null) {
227     global $DB, $USER;
229     if (empty($user1)) {
230         $user1 = $USER;
231     }
233     if (!empty($user2)) {
234         $user2->isblocked = false;
235     }
237     $blockedusers = array();
239     $userfields = user_picture::fields('u', array('lastaccess'));
240     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
241                           FROM {message_contacts} mc
242                           JOIN {user} u ON u.id = mc.contactid
243                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
244                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
245                       GROUP BY $userfields
246                       ORDER BY u.firstname ASC";
247     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
249     foreach($rs as $rd) {
250         $blockedusers[] = $rd;
252         if (!empty($user2) && $user2->id == $rd->id) {
253             $user2->isblocked = true;
254         }
255     }
256     $rs->close();
258     return $blockedusers;
261 /**
262  * Print users blocked by $user1. Called by message_print_contact_selector()
263  *
264  * @param array $blockedusers the users blocked by $user1
265  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
266  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
267  * @param string $titletodisplay Optionally specify a title to display above the participants
268  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
269  * @return void
270  */
271 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
272     global $DB, $USER;
274     $countblocked = count($blockedusers);
276     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
278     if (!empty($titletodisplay)) {
279         echo html_writer::start_tag('tr');
280         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
281         echo html_writer::end_tag('tr');
282     }
284     if ($countblocked) {
285         echo html_writer::start_tag('tr');
286         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
287         echo html_writer::end_tag('tr');
289         $isuserblocked = true;
290         $isusercontact = false;
291         foreach ($blockedusers as $blockeduser) {
292             message_print_contactlist_user($blockeduser, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
293         }
294     }
296     echo html_writer::end_tag('table');
299 /**
300  * Retrieve $user1's contacts (online, offline and strangers)
301  *
302  * @param object $user1 the user whose messages are being viewed
303  * @param object $user2 the user $user1 is talking to. If they are a contact
304  *                      they will have a variable called 'iscontact' added to their user object
305  * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
306  */
307 function message_get_contacts($user1=null, $user2=null) {
308     global $DB, $CFG, $USER;
310     if (empty($user1)) {
311         $user1 = $USER;
312     }
314     if (!empty($user2)) {
315         $user2->iscontact = false;
316     }
318     $timetoshowusers = 300; //Seconds default
319     if (isset($CFG->block_online_users_timetosee)) {
320         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
321     }
323     // time which a user is counting as being active since
324     $timefrom = time()-$timetoshowusers;
326     // people in our contactlist who are online
327     $onlinecontacts  = array();
328     // people in our contactlist who are offline
329     $offlinecontacts = array();
330     // people who are not in our contactlist but have sent us a message
331     $strangers       = array();
333     $userfields = user_picture::fields('u', array('lastaccess'));
335     // get all in our contactlist who are not blocked in our contact list
336     // and count messages we have waiting from each of them
337     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
338                      FROM {message_contacts} mc
339                      JOIN {user} u ON u.id = mc.contactid
340                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
341                     WHERE mc.userid = ? AND mc.blocked = 0
342                  GROUP BY $userfields
343                  ORDER BY u.firstname ASC";
345     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
346     foreach ($rs as $rd) {
347         if ($rd->lastaccess >= $timefrom) {
348             // they have been active recently, so are counted online
349             $onlinecontacts[] = $rd;
351         } else {
352             $offlinecontacts[] = $rd;
353         }
355         if (!empty($user2) && $user2->id == $rd->id) {
356             $user2->iscontact = true;
357         }
358     }
359     $rs->close();
361     // get messages from anyone who isn't in our contact list and count the number
362     // of messages we have from each of them
363     $strangersql = "SELECT $userfields, count(m.id) as messagecount
364                       FROM {message} m
365                       JOIN {user} u  ON u.id = m.useridfrom
366                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
367                      WHERE mc.id IS NULL AND m.useridto = ?
368                   GROUP BY $userfields
369                   ORDER BY u.firstname ASC";
371     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
372     foreach ($rs as $rd) {
373         $strangers[] = $rd;
374     }
375     $rs->close();
377     return array($onlinecontacts, $offlinecontacts, $strangers);
380 /**
381  * Print $user1's contacts. Called by message_print_contact_selector()
382  *
383  * @param array $onlinecontacts $user1's contacts which are online
384  * @param array $offlinecontacts $user1's contacts which are offline
385  * @param array $strangers users which are not contacts but who have messaged $user1
386  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
387  * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
388  *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
389  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
390  * @param string $titletodisplay Optionally specify a title to display above the participants
391  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
392  * @return void
393  */
394 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
395     global $CFG, $PAGE, $OUTPUT;
397     $countonlinecontacts  = count($onlinecontacts);
398     $countofflinecontacts = count($offlinecontacts);
399     $countstrangers       = count($strangers);
400     $isuserblocked = null;
402     if ($countonlinecontacts + $countofflinecontacts == 0) {
403         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
404     }
406     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
408     if (!empty($titletodisplay)) {
409         message_print_heading($titletodisplay);
410     }
412     if($countonlinecontacts) {
413         /// print out list of online contacts
415         if (empty($titletodisplay)) {
416             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
417         }
419         $isuserblocked = false;
420         $isusercontact = true;
421         foreach ($onlinecontacts as $contact) {
422             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
423                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
424             }
425         }
426     }
428     if ($countofflinecontacts) {
429         /// print out list of offline contacts
431         if (empty($titletodisplay)) {
432             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
433         }
435         $isuserblocked = false;
436         $isusercontact = true;
437         foreach ($offlinecontacts as $contact) {
438             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
439                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
440             }
441         }
443     }
445     /// print out list of incoming contacts
446     if ($countstrangers) {
447         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
449         $isuserblocked = false;
450         $isusercontact = false;
451         foreach ($strangers as $stranger) {
452             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
453                 message_print_contactlist_user($stranger, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
454             }
455         }
456     }
458     echo html_writer::end_tag('table');
460     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
461         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
462     }
465 /**
466  * Print a select box allowing the user to choose to view new messages, course participants etc.
467  *
468  * Called by message_print_contact_selector()
469  * @param int $viewing What page is the user viewing ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_RECENT_CONVERSATIONS etc
470  * @param array $courses array of course objects. The courses the user is enrolled in.
471  * @param array $coursecontexts array of course contexts. Keyed on course id.
472  * @param int $countunreadtotal how many unread messages does the user have?
473  * @param int $countblocked how many users has the current user blocked?
474  * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
475  * @return void
476  */
477 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
478     $options = array();
480     if ($countunreadtotal>0) { //if there are unread messages
481         $options[MESSAGE_VIEW_UNREAD_MESSAGES] = $strunreadmessages;
482     }
484     $str = get_string('mycontacts', 'message');
485     $options[MESSAGE_VIEW_CONTACTS] = $str;
487     $options[MESSAGE_VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
488     $options[MESSAGE_VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
490     if (!empty($courses)) {
491         $courses_options = array();
493         foreach($courses as $course) {
494             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
495                 //Not using short_text() as we want the end of the course name. Not the beginning.
496                 $shortname = format_string($course->shortname, true, array('context' => $coursecontexts[$course->id]));
497                 if (textlib::strlen($shortname) > MESSAGE_MAX_COURSE_NAME_LENGTH) {
498                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = '...'.textlib::substr($shortname, -MESSAGE_MAX_COURSE_NAME_LENGTH);
499                 } else {
500                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = $shortname;
501                 }
502             }
503         }
505         if (!empty($courses_options)) {
506             $options[] = array(get_string('courses') => $courses_options);
507         }
508     }
510     if ($countblocked>0) {
511         $str = get_string('blockedusers','message', $countblocked);
512         $options[MESSAGE_VIEW_BLOCKED] = $str;
513     }
515     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
516     echo html_writer::start_tag('fieldset');
517     echo html_writer::label(get_string('messagenavigation', 'message'), 'viewing');
518     echo html_writer::select($options, 'viewing', $viewing, false, array('id' => 'viewing','onchange' => 'this.form.submit()'));
519     echo html_writer::end_tag('fieldset');
520     echo html_writer::end_tag('form');
523 /**
524  * Load the course contexts for all of the users courses
525  *
526  * @param array $courses array of course objects. The courses the user is enrolled in.
527  * @return array of course contexts
528  */
529 function message_get_course_contexts($courses) {
530     $coursecontexts = array();
532     foreach($courses as $course) {
533         $coursecontexts[$course->id] = context_course::instance($course->id);
534     }
536     return $coursecontexts;
539 /**
540  * strip off action parameters like 'removecontact'
541  *
542  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
543  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
544  */
545 function message_remove_url_params($moodleurl) {
546     $newurl = new moodle_url($moodleurl);
547     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
548     return $newurl->out();
551 /**
552  * Count the number of messages with a field having a specified value.
553  * if $field is empty then return count of the whole array
554  * if $field is non-existent then return 0
555  *
556  * @param array $messagearray array of message objects
557  * @param string $field the field to inspect on the message objects
558  * @param string $value the value to test the field against
559  */
560 function message_count_messages($messagearray, $field='', $value='') {
561     if (!is_array($messagearray)) return 0;
562     if ($field == '' or empty($messagearray)) return count($messagearray);
564     $count = 0;
565     foreach ($messagearray as $message) {
566         $count += ($message->$field == $value) ? 1 : 0;
567     }
568     return $count;
571 /**
572  * Returns the count of unread messages for user. Either from a specific user or from all users.
573  *
574  * @param object $user1 the first user. Defaults to $USER
575  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
576  * @return int the count of $user1's unread messages
577  */
578 function message_count_unread_messages($user1=null, $user2=null) {
579     global $USER, $DB;
581     if (empty($user1)) {
582         $user1 = $USER;
583     }
585     if (!empty($user2)) {
586         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
587             array($user1->id, $user2->id), "COUNT('id')");
588     } else {
589         return $DB->count_records_select('message', "useridto = ?",
590             array($user1->id), "COUNT('id')");
591     }
594 /**
595  * Count the number of users blocked by $user1
596  *
597  * @param object $user1 user object
598  * @return int the number of blocked users
599  */
600 function message_count_blocked_users($user1=null) {
601     global $USER, $DB;
603     if (empty($user1)) {
604         $user1 = $USER;
605     }
607     $sql = "SELECT count(mc.id)
608             FROM {message_contacts} mc
609             WHERE mc.userid = :userid AND mc.blocked = 1";
610     $params = array('userid' => $user1->id);
612     return $DB->count_records_sql($sql, $params);
615 /**
616  * Print the search form and search results if a search has been performed
617  *
618  * @param  boolean $advancedsearch show basic or advanced search form
619  * @param  object $user1 the current user
620  * @return boolean true if a search was performed
621  */
622 function message_print_search($advancedsearch = false, $user1=null) {
623     $frm = data_submitted();
625     $doingsearch = false;
626     if ($frm) {
627         if (confirm_sesskey()) {
628             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
629         } else {
630             $frm = false;
631         }
632     }
634     if (!empty($frm->combinedsearch)) {
635         $combinedsearchstring = $frm->combinedsearch;
636     } else {
637         //$combinedsearchstring = get_string('searchcombined','message').'...';
638         $combinedsearchstring = '';
639     }
641     if ($doingsearch) {
642         if ($advancedsearch) {
644             $messagesearch = '';
645             if (!empty($frm->keywords)) {
646                 $messagesearch = $frm->keywords;
647             }
648             $personsearch = '';
649             if (!empty($frm->name)) {
650                 $personsearch = $frm->name;
651             }
652             include('search_advanced.html');
653         } else {
654             include('search.html');
655         }
657         $showicontext = false;
658         message_print_search_results($frm, $showicontext, $user1);
660         return true;
661     } else {
663         if ($advancedsearch) {
664             $personsearch = $messagesearch = '';
665             include('search_advanced.html');
666         } else {
667             include('search.html');
668         }
669         return false;
670     }
673 /**
674  * Get the users recent conversations meaning all the people they've recently
675  * sent or received a message from plus the most recent message sent to or received from each other user
676  *
677  * @param object $user the current user
678  * @param int $limitfrom can be used for paging
679  * @param int $limitto can be used for paging
680  * @return array
681  */
682 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
683     global $DB;
685     $userfields = user_picture::fields('u', array('lastaccess'));
686     //This query retrieves the last message received from and sent to each user
687     //It unions that data then, within that set, it finds the most recent message you've exchanged with each user over all
688     //It then joins with some other tables to get some additional data we need
690     //message ID is used instead of timecreated as it should sort the same and will be much faster
692     //There is a separate query for read and unread queries as they are stored in different tables
693     //They were originally retrieved in one query but it was so large that it was difficult to be confident in its correctness
694     $sql = "SELECT $userfields, mr.id as mid, mr.smallmessage, mr.fullmessage, mr.timecreated, mc.id as contactlistid, mc.blocked
695               FROM {message_read} mr
696               JOIN (
697                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
698                       FROM (
699                            SELECT mr1.useridto AS userid, MAX(mr1.id) AS mid
700                              FROM {message_read} mr1
701                             WHERE mr1.useridfrom = :userid1
702                                   AND mr1.notification = 0
703                          GROUP BY mr1.useridto
704                                   UNION
705                            SELECT mr2.useridfrom AS userid, MAX(mr2.id) AS mid
706                              FROM {message_read} mr2
707                             WHERE mr2.useridto = :userid2
708                                   AND mr2.notification = 0
709                          GROUP BY mr2.useridfrom
710                            ) messages
711                   GROUP BY messages.userid
712                    ) messages2 ON mr.id = messages2.mid AND (mr.useridto = messages2.userid OR mr.useridfrom = messages2.userid)
713               JOIN {user} u ON u.id = messages2.userid
714          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
715              WHERE u.deleted = '0'
716           ORDER BY mr.id DESC";
717     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id);
718     $read =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
720     $sql = "SELECT $userfields, m.id as mid, m.smallmessage, m.fullmessage, m.timecreated, mc.id as contactlistid, mc.blocked
721               FROM {message} m
722               JOIN (
723                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
724                       FROM (
725                            SELECT m1.useridto AS userid, MAX(m1.id) AS mid
726                              FROM {message} m1
727                             WHERE m1.useridfrom = :userid1
728                                   AND m1.notification = 0
729                          GROUP BY m1.useridto
730                                   UNION
731                            SELECT m2.useridfrom AS userid, MAX(m2.id) AS mid
732                              FROM {message} m2
733                             WHERE m2.useridto = :userid2
734                                   AND m2.notification = 0
735                          GROUP BY m2.useridfrom
736                            ) messages
737                   GROUP BY messages.userid
738                    ) messages2 ON m.id = messages2.mid AND (m.useridto = messages2.userid OR m.useridfrom = messages2.userid)
739               JOIN {user} u ON u.id = messages2.userid
740          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
741              WHERE u.deleted = '0'
742              ORDER BY m.id DESC";
743     $unread =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
745     $conversations = array();
747     //Union the 2 result sets together looking for the message with the most recent timecreated for each other user
748     //$conversation->id (the array key) is the other user's ID
749     $conversation_arrays = array($unread, $read);
750     foreach ($conversation_arrays as $conversation_array) {
751         foreach ($conversation_array as $conversation) {
752             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
753                 $conversations[$conversation->id] = $conversation;
754             }
755         }
756     }
758     // Sort the conversations by $conversation->timecreated, newest to oldest
759     // There may be multiple conversations with the same timecreated
760     // The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
761     $result = collatorlib::asort_objects_by_property($conversations, 'timecreated', collatorlib::SORT_NUMERIC);
762     $conversations = array_reverse($conversations);
764     return $conversations;
767 /**
768  * Get the users recent event notifications
769  *
770  * @param object $user the current user
771  * @param int $limitfrom can be used for paging
772  * @param int $limitto can be used for paging
773  * @return array
774  */
775 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
776     global $DB;
778     $userfields = user_picture::fields('u', array('lastaccess'));
779     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.smallmessage, mr.fullmessage, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
780               FROM {message_read} mr
781                    JOIN {user} u ON u.id=mr.useridfrom
782              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
783              ORDER BY mr.id DESC";//ordering by id should give the same result as ordering by timecreated but will be faster
784     $params = array('userid1' => $user->id, 'notification' => 1);
786     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
787     return $notifications;
790 /**
791  * Print the user's recent conversations
792  *
793  * @param stdClass $user the current user
794  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
795  */
796 function message_print_recent_conversations($user=null, $showicontext=false) {
797     global $USER;
799     echo html_writer::start_tag('p', array('class' => 'heading'));
800     echo get_string('mostrecentconversations', 'message');
801     echo html_writer::end_tag('p');
803     if (empty($user)) {
804         $user = $USER;
805     }
807     $conversations = message_get_recent_conversations($user);
809     // Attach context url information to create the "View this conversation" type links
810     foreach($conversations as $conversation) {
811         $conversation->contexturl = new moodle_url("/message/index.php?user2={$conversation->id}");
812         $conversation->contexturlname = get_string('thisconversation', 'message');
813     }
815     $showotheruser = true;
816     message_print_recent_messages_table($conversations, $user, $showotheruser, $showicontext);
819 /**
820  * Print the user's recent notifications
821  *
822  * @param stdClass $user the current user
823  */
824 function message_print_recent_notifications($user=null) {
825     global $USER;
827     echo html_writer::start_tag('p', array('class' => 'heading'));
828     echo get_string('mostrecentnotifications', 'message');
829     echo html_writer::end_tag('p');
831     if (empty($user)) {
832         $user = $USER;
833     }
835     $notifications = message_get_recent_notifications($user);
837     $showicontext = false;
838     $showotheruser = false;
839     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext, true);
842 /**
843  * Print a list of recent messages
844  *
845  * @param array $messages the messages to display
846  * @param object $user the current user
847  * @param bool $showotheruser display information on the other user?
848  * @param bool $showicontext show text next to the action icons?
849  * @param bool $forcetexttohtml Force text to go through @see text_to_html() via @see format_text()
850  * @return void
851  */
852 function message_print_recent_messages_table($messages, $user=null, $showotheruser=true, $showicontext=false, $forcetexttohtml=false) {
853     global $OUTPUT;
854     static $dateformat;
856     if (empty($dateformat)) {
857         $dateformat = get_string('strftimedatetimeshort');
858     }
860     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
861     foreach ($messages as $message) {
862         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
864         if ($showotheruser) {
865             if ( $message->contactlistid )  {
866                 if ($message->blocked == 0) { /// not blocked
867                     $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
868                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
869                 } else { // blocked
870                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
871                     $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
872                 }
873             } else {
874                 $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
875                 $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
876             }
878             //should we show just the icon or icon and text?
879             $histicontext = 'icon';
880             if ($showicontext) {
881                 $histicontext = 'both';
882             }
883             $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
885             echo html_writer::start_tag('span', array('class' => 'otheruser'));
887             echo html_writer::start_tag('span', array('class' => 'pix'));
888             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
889             echo html_writer::end_tag('span');
891             echo html_writer::start_tag('span', array('class' => 'contact'));
893             $link = new moodle_url("/message/index.php?id=$message->id");
894             $action = null;
895             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
897             echo html_writer::end_tag('span');//end contact
899             echo $strcontact.$strblock.$strhistory;
900             echo html_writer::end_tag('span');//end otheruser
901         }
902         $messagetoprint = null;
903         if (!empty($message->smallmessage)) {
904             $messagetoprint = $message->smallmessage;
905         } else {
906             $messagetoprint = $message->fullmessage;
907         }
909         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
910         echo html_writer::tag('span', format_text($messagetoprint, $forcetexttohtml?FORMAT_MOODLE:FORMAT_HTML), array('class' => 'themessage'));
911         echo message_format_contexturl($message);
912         echo html_writer::end_tag('div');//end singlemessage
913     }
914     echo html_writer::end_tag('div');//end messagerecent
917 /**
918  * Add the selected user as a contact for the current user
919  *
920  * @param int $contactid the ID of the user to add as a contact
921  * @param int $blocked 1 if you wish to block the contact
922  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
923  *                  Otherwise returns the result of update_record() or insert_record()
924  */
925 function message_add_contact($contactid, $blocked=0) {
926     global $USER, $DB;
928     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
929         return false;
930     }
932     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
933     /// record already exists - we may be changing blocking status
935         if ($contact->blocked !== $blocked) {
936         /// change to blocking status
937             $contact->blocked = $blocked;
938             return $DB->update_record('message_contacts', $contact);
939         } else {
940         /// no changes to blocking status
941             return true;
942         }
944     } else {
945     /// new contact record
946         $contact = new stdClass();
947         $contact->userid = $USER->id;
948         $contact->contactid = $contactid;
949         $contact->blocked = $blocked;
950         return $DB->insert_record('message_contacts', $contact, false);
951     }
954 /**
955  * remove a contact
956  *
957  * @param int $contactid the user ID of the contact to remove
958  * @return bool returns the result of delete_records()
959  */
960 function message_remove_contact($contactid) {
961     global $USER, $DB;
962     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
965 /**
966  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
967  *
968  * @param int $contactid the user ID of the contact to unblock
969  * @return bool returns the result of delete_records()
970  */
971 function message_unblock_contact($contactid) {
972     global $USER, $DB;
973     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
976 /**
977  * block a user
978  *
979  * @param int $contactid the user ID of the user to block
980  */
981 function message_block_contact($contactid) {
982     return message_add_contact($contactid, 1);
985 /**
986  * Load a user's contact record
987  *
988  * @param int $contactid the user ID of the user whose contact record you want
989  * @return array message contacts
990  */
991 function message_get_contact($contactid) {
992     global $USER, $DB;
993     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
996 /**
997  * Print the results of a message search
998  *
999  * @param mixed $frm submitted form data
1000  * @param bool $showicontext show text next to action icons?
1001  * @param object $currentuser the current user
1002  * @return void
1003  */
1004 function message_print_search_results($frm, $showicontext=false, $currentuser=null) {
1005     global $USER, $DB, $OUTPUT;
1007     if (empty($currentuser)) {
1008         $currentuser = $USER;
1009     }
1011     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
1013     $personsearch = false;
1014     $personsearchstring = null;
1015     if (!empty($frm->personsubmit) and !empty($frm->name)) {
1016         $personsearch = true;
1017         $personsearchstring = $frm->name;
1018     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1019         $personsearch = true;
1020         $personsearchstring = $frm->combinedsearch;
1021     }
1023     /// search for person
1024     if ($personsearch) {
1025         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1026             $users = array();
1027             $mycourses = enrol_get_my_courses();
1028             foreach ($mycourses as $mycourse) {
1029                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
1030                     foreach ($susers as $suser) $users[$suser->id] = $suser;
1031                 }
1032             }
1033         } else {
1034             $users = message_search_users(SITEID, $personsearchstring);
1035         }
1037         if (!empty($users)) {
1038             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1039             echo get_string('userssearchresults', 'message', count($users));
1040             echo html_writer::end_tag('p');
1042             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1043             foreach ($users as $user) {
1045                 if ( $user->contactlistid )  {
1046                     if ($user->blocked == 0) { /// not blocked
1047                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1048                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1049                     } else { // blocked
1050                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1051                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1052                     }
1053                 } else {
1054                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1055                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1056                 }
1058                 //should we show just the icon or icon and text?
1059                 $histicontext = 'icon';
1060                 if ($showicontext) {
1061                     $histicontext = 'both';
1062                 }
1063                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1065                 echo html_writer::start_tag('tr');
1067                 echo html_writer::start_tag('td', array('class' => 'pix'));
1068                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1069                 echo html_writer::end_tag('td');
1071                 echo html_writer::start_tag('td',array('class' => 'contact'));
1072                 $action = null;
1073                 $link = new moodle_url("/message/index.php?id=$user->id");
1074                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1075                 echo html_writer::end_tag('td');
1077                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1078                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1079                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1081                 echo html_writer::end_tag('tr');
1082             }
1083             echo html_writer::end_tag('table');
1085         } else {
1086             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1087             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1088             echo html_writer::end_tag('p');
1089         }
1090     }
1092     // search messages for keywords
1093     $messagesearch = false;
1094     $messagesearchstring = null;
1095     if (!empty($frm->keywords)) {
1096         $messagesearch = true;
1097         $messagesearchstring = clean_text(trim($frm->keywords));
1098     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1099         $messagesearch = true;
1100         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1101     }
1103     if ($messagesearch) {
1104         if ($messagesearchstring) {
1105             $keywords = explode(' ', $messagesearchstring);
1106         } else {
1107             $keywords = array();
1108         }
1109         $tome     = false;
1110         $fromme   = false;
1111         $courseid = 'none';
1113         if (empty($frm->keywordsoption)) {
1114             $frm->keywordsoption = 'allmine';
1115         }
1117         switch ($frm->keywordsoption) {
1118             case 'tome':
1119                 $tome   = true;
1120                 break;
1121             case 'fromme':
1122                 $fromme = true;
1123                 break;
1124             case 'allmine':
1125                 $tome   = true;
1126                 $fromme = true;
1127                 break;
1128             case 'allusers':
1129                 $courseid = SITEID;
1130                 break;
1131             case 'courseusers':
1132                 $courseid = $frm->courseid;
1133                 break;
1134             default:
1135                 $tome   = true;
1136                 $fromme = true;
1137         }
1139         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1141         /// get a list of contacts
1142             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1143                 $contacts = array();
1144             }
1146         /// print heading with number of results
1147             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1148             $countresults = count($messages);
1149             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1150                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1151             } else {
1152                 echo get_string('keywordssearchresults', 'message', $countresults);
1153             }
1154             echo html_writer::end_tag('p');
1156         /// print table headings
1157             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1159             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1160             $headertdend   = html_writer::end_tag('td');
1161             echo html_writer::start_tag('tr');
1162             echo $headertdstart.get_string('from').$headertdend;
1163             echo $headertdstart.get_string('to').$headertdend;
1164             echo $headertdstart.get_string('message', 'message').$headertdend;
1165             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1166             echo html_writer::end_tag('tr');
1168             $blockedcount = 0;
1169             $dateformat = get_string('strftimedatetimeshort');
1170             $strcontext = get_string('context', 'message');
1171             foreach ($messages as $message) {
1173             /// ignore messages to and from blocked users unless $frm->includeblocked is set
1174                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1175                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1176                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1177                                                 )
1178                    ) {
1179                     $blockedcount ++;
1180                     continue;
1181                 }
1183             /// load up user to record
1184                 if ($message->useridto !== $USER->id) {
1185                     $userto = $DB->get_record('user', array('id' => $message->useridto));
1186                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1187                                     ($contacts[$message->useridto]->blocked == 0) );
1188                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1189                                     ($contacts[$message->useridto]->blocked == 1) );
1190                 } else {
1191                     $userto = false;
1192                     $tocontact = false;
1193                     $toblocked = false;
1194                 }
1196             /// load up user from record
1197                 if ($message->useridfrom !== $USER->id) {
1198                     $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
1199                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1200                                     ($contacts[$message->useridfrom]->blocked == 0) );
1201                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1202                                     ($contacts[$message->useridfrom]->blocked == 1) );
1203                 } else {
1204                     $userfrom = false;
1205                     $fromcontact = false;
1206                     $fromblocked = false;
1207                 }
1209             /// find date string for this message
1210                 $date = usergetdate($message->timecreated);
1211                 $datestring = $date['year'].$date['mon'].$date['mday'];
1213             /// print out message row
1214                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1216                 echo html_writer::start_tag('td', array('class' => 'contact'));
1217                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1218                 echo html_writer::end_tag('td');
1220                 echo html_writer::start_tag('td', array('class' => 'contact'));
1221                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1222                 echo html_writer::end_tag('td');
1224                 echo html_writer::start_tag('td', array('class' => 'summary'));
1225                 echo message_get_fragment($message->smallmessage, $keywords);
1226                 echo html_writer::start_tag('div', array('class' => 'link'));
1228                 //If the user clicks the context link display message sender on the left
1229                 //EXCEPT if the current user is in the conversation. Current user == always on the left
1230                 $leftsideuserid = $rightsideuserid = null;
1231                 if ($currentuser->id == $message->useridto) {
1232                     $leftsideuserid = $message->useridto;
1233                     $rightsideuserid = $message->useridfrom;
1234                 } else {
1235                     $leftsideuserid = $message->useridfrom;
1236                     $rightsideuserid = $message->useridto;
1237                 }
1238                 message_history_link($leftsideuserid, $rightsideuserid, false,
1239                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1240                 echo html_writer::end_tag('div');
1241                 echo html_writer::end_tag('td');
1243                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1245                 echo html_writer::end_tag('tr');
1246             }
1249             if ($blockedcount > 0) {
1250                 echo html_writer::start_tag('tr');
1251                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1252                 echo html_writer::end_tag('tr');
1253             }
1254             echo html_writer::end_tag('table');
1256         } else {
1257             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1258         }
1259     }
1261     if (!$personsearch && !$messagesearch) {
1262         //they didn't enter any search terms
1263         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1264     }
1266     echo html_writer::end_tag('div');
1269 /**
1270  * Print information on a user. Used when printing search results.
1271  *
1272  * @param object/bool $user the user to display or false if you just want $USER
1273  * @param bool $iscontact is the user being displayed a contact?
1274  * @param bool $isblocked is the user being displayed blocked?
1275  * @param bool $includeicontext include text next to the action icons?
1276  * @return void
1277  */
1278 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1279     global $USER, $OUTPUT;
1281     if ($user === false) {
1282         echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
1283     } else {
1284         echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1286         $link = new moodle_url("/message/index.php?id=$user->id");
1287         echo $OUTPUT->action_link($link, fullname($user), null, array('title' =>
1288                 get_string('sendmessageto', 'message', fullname($user))));
1290         $return = false;
1291         $script = null;
1292         if ($iscontact) {
1293             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1294         } else {
1295             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1296         }
1298         if ($isblocked) {
1299             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1300         } else {
1301             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1302         }
1303     }
1306 /**
1307  * Print a message contact link
1308  *
1309  * @param int $userid the ID of the user to apply to action to
1310  * @param string $linktype can be add, remove, block or unblock
1311  * @param bool $return if true return the link as a string. If false echo the link.
1312  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1313  * @param bool $text include text next to the icons?
1314  * @param bool $icon include a graphical icon?
1315  * @return string  if $return is true otherwise bool
1316  */
1317 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1318     global $OUTPUT, $PAGE;
1320     //hold onto the strings as we're probably creating a bunch of links
1321     static $str;
1323     if (empty($script)) {
1324         //strip off previous action params like 'removecontact'
1325         $script = message_remove_url_params($PAGE->url);
1326     }
1328     if (empty($str->blockcontact)) {
1329        $str = new stdClass();
1330        $str->blockcontact   =  get_string('blockcontact', 'message');
1331        $str->unblockcontact =  get_string('unblockcontact', 'message');
1332        $str->removecontact  =  get_string('removecontact', 'message');
1333        $str->addcontact     =  get_string('addcontact', 'message');
1334     }
1336     $command = $linktype.'contact';
1337     $string  = $str->{$command};
1339     $safealttext = s($string);
1341     $safestring = '';
1342     if (!empty($text)) {
1343         $safestring = $safealttext;
1344     }
1346     $img = '';
1347     if ($icon) {
1348         $iconpath = null;
1349         switch ($linktype) {
1350             case 'block':
1351                 $iconpath = 't/block';
1352                 break;
1353             case 'unblock':
1354                 $iconpath = 't/unblock';
1355                 break;
1356             case 'remove':
1357                 $iconpath = 't/removecontact';
1358                 break;
1359             case 'add':
1360             default:
1361                 $iconpath = 't/addcontact';
1362         }
1364         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1365     }
1367     $output = '<span class="'.$linktype.'contact">'.
1368               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1369               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1370               $img.
1371               $safestring.'</a></span>';
1373     if ($return) {
1374         return $output;
1375     } else {
1376         echo $output;
1377         return true;
1378     }
1381 /**
1382  * echo or return a link to take the user to the full message history between themselves and another user
1383  *
1384  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
1385  * @param int $userid2 the ID of the other user
1386  * @param bool $return true to return the link as a string. False to echo the link.
1387  * @param string $keywords any keywords to highlight in the message history
1388  * @param string $position anchor name to jump to within the message history
1389  * @param string $linktext optionally specify the link text
1390  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1391  */
1392 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1393     global $OUTPUT;
1394     static $strmessagehistory;
1396     if (empty($strmessagehistory)) {
1397         $strmessagehistory = get_string('messagehistory', 'message');
1398     }
1400     if ($position) {
1401         $position = "#$position";
1402     }
1403     if ($keywords) {
1404         $keywords = "&search=".urlencode($keywords);
1405     }
1407     if ($linktext == 'icon') {  // Icon only
1408         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1409     } else if ($linktext == 'both') {  // Icon and standard name
1410         $fulllink = '<img src="'.$OUTPUT->pix_url('t/messages') . '" class="iconsmall" alt="" />';
1411         $fulllink .= '&nbsp;'.$strmessagehistory;
1412     } else if ($linktext) {    // Custom name
1413         $fulllink = $linktext;
1414     } else {                   // Standard name only
1415         $fulllink = $strmessagehistory;
1416     }
1418     $popupoptions = array(
1419             'height' => 500,
1420             'width' => 500,
1421             'menubar' => false,
1422             'location' => false,
1423             'status' => true,
1424             'scrollbars' => true,
1425             'resizable' => true);
1427     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
1428     $action = null;
1429     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1431     $str = '<span class="history">'.$str.'</span>';
1433     if ($return) {
1434         return $str;
1435     } else {
1436         echo $str;
1437         return true;
1438     }
1442 /**
1443  * Search through course users
1444  *
1445  * If $coursid specifies the site course then this function searches
1446  * through all undeleted and confirmed users
1447  * @param int $courseid The course in question.
1448  * @param string $searchtext the text to search for
1449  * @param string $sort the column name to order by
1450  * @param string $exceptions comma separated list of user IDs to exclude
1451  * @return array  An array of {@link $USER} records.
1452  */
1453 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1454     global $CFG, $USER, $DB;
1456     $fullname = $DB->sql_fullname();
1458     if (!empty($exceptions)) {
1459         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1460     } else {
1461         $except = '';
1462     }
1464     if (!empty($sort)) {
1465         $order = ' ORDER BY '. $sort;
1466     } else {
1467         $order = '';
1468     }
1470     $ufields = user_picture::fields('u');
1471     if (!$courseid or $courseid == SITEID) {
1472         $params = array($USER->id, "%$searchtext%");
1473         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1474                                        FROM {user} u
1475                                        LEFT JOIN {message_contacts} mc
1476                                             ON mc.contactid = u.id AND mc.userid = ?
1477                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1478                                             AND (".$DB->sql_like($fullname, '?', false).")
1479                                             $except
1480                                      $order", $params);
1481     } else {
1482 //TODO: add enabled enrolment join here (skodak)
1483         $context = context_course::instance($courseid);
1484         $contextlists = get_related_contexts_string($context);
1486         // everyone who has a role assignment in this course or higher
1487         $params = array($USER->id, "%$searchtext%");
1488         $users = $DB->get_records_sql("SELECT DISTINCT $ufields, mc.id as contactlistid, mc.blocked
1489                                          FROM {user} u
1490                                          JOIN {role_assignments} ra ON ra.userid = u.id
1491                                          LEFT JOIN {message_contacts} mc
1492                                               ON mc.contactid = u.id AND mc.userid = ?
1493                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1494                                               AND ra.contextid $contextlists
1495                                               AND (".$DB->sql_like($fullname, '?', false).")
1496                                               $except
1497                                        $order", $params);
1499         return $users;
1500     }
1503 /**
1504  * search a user's messages
1505  *
1506  * @param array $searchterms an array of search terms (strings)
1507  * @param bool $fromme include messages from the user?
1508  * @param bool $tome include messages to the user?
1509  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1510  * @param int $userid the user ID of the current user
1511  * @return mixed An array of messages or false if no matching messages were found
1512  */
1513 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1514 /// Returns a list of posts found using an array of search terms
1515 /// eg   word  +word -word
1516 ///
1517     global $CFG, $USER, $DB;
1519     // If user is searching all messages check they are allowed to before doing anything else
1520     if ($courseid == SITEID && !has_capability('moodle/site:readallmessages', context_system::instance())) {
1521         print_error('accessdenied','admin');
1522     }
1524     /// If no userid sent then assume current user
1525     if ($userid == 0) $userid = $USER->id;
1527     /// Some differences in SQL syntax
1528     if ($DB->sql_regex_supported()) {
1529         $REGEXP    = $DB->sql_regex(true);
1530         $NOTREGEXP = $DB->sql_regex(false);
1531     }
1533     $searchcond = array();
1534     $params = array();
1535     $i = 0;
1537     //preprocess search terms to check whether we have at least 1 eligible search term
1538     //if we do we can drop words around it like 'a'
1539     $dropshortwords = false;
1540     foreach ($searchterms as $searchterm) {
1541         if (strlen($searchterm) >= 2) {
1542             $dropshortwords = true;
1543         }
1544     }
1546     foreach ($searchterms as $searchterm) {
1547         $i++;
1549         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1551         if ($dropshortwords && strlen($searchterm) < 2) {
1552             continue;
1553         }
1554     /// Under Oracle and MSSQL, trim the + and - operators and perform
1555     /// simpler LIKE search
1556         if (!$DB->sql_regex_supported()) {
1557             if (substr($searchterm, 0, 1) == '-') {
1558                 $NOT = true;
1559             }
1560             $searchterm = trim($searchterm, '+-');
1561         }
1563         if (substr($searchterm,0,1) == "+") {
1564             $searchterm = substr($searchterm,1);
1565             $searchterm = preg_quote($searchterm, '|');
1566             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1567             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1569         } else if (substr($searchterm,0,1) == "-") {
1570             $searchterm = substr($searchterm,1);
1571             $searchterm = preg_quote($searchterm, '|');
1572             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1573             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1575         } else {
1576             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1577             $params['ss'.$i] = "%$searchterm%";
1578         }
1579     }
1581     if (empty($searchcond)) {
1582         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1583         $params['ss1'] = "%";
1584     } else {
1585         $searchcond = implode(" AND ", $searchcond);
1586     }
1588     /// There are several possibilities
1589     /// 1. courseid = SITEID : The admin is searching messages by all users
1590     /// 2. courseid = ??     : A teacher is searching messages by users in
1591     ///                        one of their courses - currently disabled
1592     /// 3. courseid = none   : User is searching their own messages;
1593     ///    a.  Messages from user
1594     ///    b.  Messages to user
1595     ///    c.  Messages to and from user
1597     if ($courseid == SITEID) { /// admin is searching all messages
1598         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1599                                             FROM {message_read} m
1600                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1601         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1602                                             FROM {message} m
1603                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1605     } else if ($courseid !== 'none') {
1606         /// This has not been implemented due to security concerns
1607         $m_read   = array();
1608         $m_unread = array();
1610     } else {
1612         if ($fromme and $tome) {
1613             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1614             $params['userid1'] = $userid;
1615             $params['userid2'] = $userid;
1617         } else if ($fromme) {
1618             $searchcond .= " AND m.useridfrom=:userid";
1619             $params['userid'] = $userid;
1621         } else if ($tome) {
1622             $searchcond .= " AND m.useridto=:userid";
1623             $params['userid'] = $userid;
1624         }
1626         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1627                                             FROM {message_read} m
1628                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1629         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1630                                             FROM {message} m
1631                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1633     }
1635     /// The keys may be duplicated in $m_read and $m_unread so we can't
1636     /// do a simple concatenation
1637     $messages = array();
1638     foreach ($m_read as $m) {
1639         $messages[] = $m;
1640     }
1641     foreach ($m_unread as $m) {
1642         $messages[] = $m;
1643     }
1645     return (empty($messages)) ? false : $messages;
1648 /**
1649  * Given a message object that we already know has a long message
1650  * this function truncates the message nicely to the first
1651  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1652  *
1653  * @param string $message the message
1654  * @param int $minlength the minimum length to trim the message to
1655  * @return string the shortened message
1656  */
1657 function message_shorten_message($message, $minlength = 0) {
1658     $i = 0;
1659     $tag = false;
1660     $length = strlen($message);
1661     $count = 0;
1662     $stopzone = false;
1663     $truncate = 0;
1664     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1667     for ($i=0; $i<$length; $i++) {
1668         $char = $message[$i];
1670         switch ($char) {
1671             case "<":
1672                 $tag = true;
1673                 break;
1674             case ">":
1675                 $tag = false;
1676                 break;
1677             default:
1678                 if (!$tag) {
1679                     if ($stopzone) {
1680                         if ($char == '.' or $char == ' ') {
1681                             $truncate = $i+1;
1682                             break 2;
1683                         }
1684                     }
1685                     $count++;
1686                 }
1687                 break;
1688         }
1689         if (!$stopzone) {
1690             if ($count > $minlength) {
1691                 $stopzone = true;
1692             }
1693         }
1694     }
1696     if (!$truncate) {
1697         $truncate = $i;
1698     }
1700     return substr($message, 0, $truncate);
1704 /**
1705  * Given a string and an array of keywords, this function looks
1706  * for the first keyword in the string, and then chops out a
1707  * small section from the text that shows that word in context.
1708  *
1709  * @param string $message the text to search
1710  * @param array $keywords array of keywords to find
1711  */
1712 function message_get_fragment($message, $keywords) {
1714     $fullsize = 160;
1715     $halfsize = (int)($fullsize/2);
1717     $message = strip_tags($message);
1719     foreach ($keywords as $keyword) {  // Just get the first one
1720         if ($keyword !== '') {
1721             break;
1722         }
1723     }
1724     if (empty($keyword)) {   // None found, so just return start of message
1725         return message_shorten_message($message, 30);
1726     }
1728     $leadin = $leadout = '';
1730 /// Find the start of the fragment
1731     $start = 0;
1732     $length = strlen($message);
1734     $pos = strpos($message, $keyword);
1735     if ($pos > $halfsize) {
1736         $start = $pos - $halfsize;
1737         $leadin = '...';
1738     }
1739 /// Find the end of the fragment
1740     $end = $start + $fullsize;
1741     if ($end > $length) {
1742         $end = $length;
1743     } else {
1744         $leadout = '...';
1745     }
1747 /// Pull out the fragment and format it
1749     $fragment = substr($message, $start, $end - $start);
1750     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1751     return $fragment;
1754 /**
1755  * Retrieve the messages between two users
1756  *
1757  * @param object $user1 the current user
1758  * @param object $user2 the other user
1759  * @param int $limitnum the maximum number of messages to retrieve
1760  * @param bool $viewingnewmessages are we currently viewing new messages?
1761  */
1762 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1763     global $DB, $CFG;
1765     $messages = array();
1767     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1768     //desc to get the last $limitnum messages then flip the order in php
1769     $sort = 'asc';
1770     if ($limitnum>0) {
1771         $sort = 'desc';
1772     }
1774     $notificationswhere = null;
1775     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1776     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1777         $notificationswhere = 'AND notification=0';
1778     }
1780     //prevent notifications of your own actions appearing in your own message history
1781     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1783     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1784                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1785                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1786                                                     "timecreated $sort", '*', 0, $limitnum)) {
1787         foreach ($messages_read as $message) {
1788             $messages[] = $message;
1789         }
1790     }
1791     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1792                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1793                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1794                                                     "timecreated $sort", '*', 0, $limitnum)) {
1795         foreach ($messages_new as $message) {
1796             $messages[] = $message;
1797         }
1798     }
1800     $result = collatorlib::asort_objects_by_property($messages, 'timecreated', collatorlib::SORT_NUMERIC);
1802     //if we only want the last $limitnum messages
1803     $messagecount = count($messages);
1804     if ($limitnum > 0 && $messagecount > $limitnum) {
1805         $messages = array_slice($messages, $messagecount - $limitnum, $limitnum, true);
1806     }
1808     return $messages;
1811 /**
1812  * Print the message history between two users
1813  *
1814  * @param object $user1 the current user
1815  * @param object $user2 the other user
1816  * @param string $search search terms to highlight
1817  * @param int $messagelimit maximum number of messages to return
1818  * @param string $messagehistorylink the html for the message history link or false
1819  * @param bool $viewingnewmessages are we currently viewing new messages?
1820  */
1821 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1822     global $CFG, $OUTPUT;
1824     echo $OUTPUT->box_start('center');
1825     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1826     echo html_writer::start_tag('tr');
1828     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1829     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1830     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1831     echo html_writer::end_tag('td');
1833     echo html_writer::start_tag('td', array('align' => 'center'));
1834     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('i/twoway'), 'alt' => ''));
1835     echo html_writer::end_tag('td');
1837     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
1838     echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
1839     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
1841     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1842         $incontactlist = $user2->iscontact;
1843         $isblocked = $user2->isblocked;
1845         $script = null;
1846         $text = true;
1847         $icon = false;
1849         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1850         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1851         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1853         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
1854     }
1856     echo html_writer::end_tag('td');
1857     echo html_writer::end_tag('tr');
1858     echo html_writer::end_tag('table');
1859     echo $OUTPUT->box_end();
1861     if (!empty($messagehistorylink)) {
1862         echo $messagehistorylink;
1863     }
1865     /// Get all the messages and print them
1866     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1867         $tablecontents = '';
1869         $current = new stdClass();
1870         $current->mday = '';
1871         $current->month = '';
1872         $current->year = '';
1873         $messagedate = get_string('strftimetime');
1874         $blockdate   = get_string('strftimedaydate');
1875         foreach ($messages as $message) {
1876             if ($message->notification) {
1877                 $notificationclass = ' notification';
1878             } else {
1879                 $notificationclass = null;
1880             }
1881             $date = usergetdate($message->timecreated);
1882             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1883                 $current->mday = $date['mday'];
1884                 $current->month = $date['month'];
1885                 $current->year = $date['year'];
1887                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
1888                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
1890                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
1891             }
1893             $formatted_message = $side = null;
1894             if ($message->useridfrom == $user1->id) {
1895                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
1896                 $side = 'left';
1897             } else {
1898                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
1899                 $side = 'right';
1900             }
1901             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
1902         }
1904         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
1905     } else {
1906         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
1907     }
1910 /**
1911  * Format a message for display in the message history
1912  *
1913  * @param object $message the message object
1914  * @param string $format optional date format
1915  * @param string $keywords keywords to highlight
1916  * @param string $class CSS class to apply to the div around the message
1917  * @return string the formatted message
1918  */
1919 function message_format_message($message, $format='', $keywords='', $class='other') {
1921     static $dateformat;
1923     //if we haven't previously set the date format or they've supplied a new one
1924     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1925         if ($format) {
1926             $dateformat = $format;
1927         } else {
1928             $dateformat = get_string('strftimedatetimeshort');
1929         }
1930     }
1931     $time = userdate($message->timecreated, $dateformat);
1932     $options = new stdClass();
1933     $options->para = false;
1935     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1936     if (!empty($message->smallmessage)) {
1937         $messagetext = $message->smallmessage;
1938     } else {
1939         $messagetext = $message->fullmessage;
1940     }
1941     if ($message->fullmessageformat == FORMAT_HTML) {
1942         //dont escape html tags by calling s() if html format or they will display in the UI
1943         $messagetext = html_to_text(format_text($messagetext, $message->fullmessageformat, $options));
1944     } else {
1945         $messagetext = format_text(s($messagetext), $message->fullmessageformat, $options);
1946     }
1948     $messagetext .= message_format_contexturl($message);
1950     if ($keywords) {
1951         $messagetext = highlight($keywords, $messagetext);
1952     }
1954     return <<<TEMPLATE
1955 <div class='message $class'>
1956     <a name="m'.{$message->id}.'"></a>
1957     <span class="message-meta"><span class="time">$time</span></span>: <span class="text">$messagetext</span>
1958 </div>
1959 TEMPLATE;
1962 /**
1963  * Format a the context url and context url name of a message for display
1964  *
1965  * @param object $message the message object
1966  * @return string the formatted string
1967  */
1968 function message_format_contexturl($message) {
1969     $s = null;
1971     if (!empty($message->contexturl)) {
1972         $displaytext = null;
1973         if (!empty($message->contexturlname)) {
1974             $displaytext= $message->contexturlname;
1975         } else {
1976             $displaytext= $message->contexturl;
1977         }
1978         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
1979             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1980         $s .= html_writer::end_tag('div');
1981     }
1983     return $s;
1986 /**
1987  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
1988  *
1989  * @param object $userfrom the message sender
1990  * @param object $userto the message recipient
1991  * @param string $message the message
1992  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
1993  * @return int|false the ID of the new message or false
1994  */
1995 function message_post_message($userfrom, $userto, $message, $format) {
1996     global $SITE, $CFG, $USER;
1998     $eventdata = new stdClass();
1999     $eventdata->component        = 'moodle';
2000     $eventdata->name             = 'instantmessage';
2001     $eventdata->userfrom         = $userfrom;
2002     $eventdata->userto           = $userto;
2004     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
2005     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
2007     if ($format == FORMAT_HTML) {
2008         $eventdata->fullmessagehtml  = $message;
2009         //some message processors may revert to sending plain text even if html is supplied
2010         //so we keep both plain and html versions if we're intending to send html
2011         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
2012     } else {
2013         $eventdata->fullmessage      = $message;
2014         $eventdata->fullmessagehtml  = '';
2015     }
2017     $eventdata->fullmessageformat = $format;
2018     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
2020     $s = new stdClass();
2021     $s->sitename = format_string($SITE->shortname, true, array('context' => context_course::instance(SITEID)));
2022     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
2024     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
2025     if (!empty($eventdata->fullmessage)) {
2026         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
2027     }
2028     if (!empty($eventdata->fullmessagehtml)) {
2029         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
2030     }
2032     $eventdata->timecreated     = time();
2033     return message_send($eventdata);
2036 /**
2037  * Print a row of contactlist displaying user picture, messages waiting and
2038  * block links etc
2039  *
2040  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2041  * @param bool $incontactlist is the user a contact of ours?
2042  * @param bool $isblocked is the user blocked?
2043  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2044  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2045  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2046  * @return void
2047  */
2048 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2049     global $OUTPUT, $USER;
2050     $fullname  = fullname($contact);
2051     $fullnamelink  = $fullname;
2053     $linkclass = '';
2054     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2055         $linkclass = 'messageselecteduser';
2056     }
2058     /// are there any unread messages for this contact?
2059     if ($contact->messagecount > 0 ){
2060         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2061     }
2063     $strcontact = $strblock = $strhistory = null;
2065     if ($showactionlinks) {
2066         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2067         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2068         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2069     }
2071     echo html_writer::start_tag('tr');
2072     echo html_writer::start_tag('td', array('class' => 'pix'));
2073     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => SITEID));
2074     echo html_writer::end_tag('td');
2076     echo html_writer::start_tag('td', array('class' => 'contact'));
2078     $popupoptions = array(
2079             'height' => MESSAGE_DISCUSSION_HEIGHT,
2080             'width' => MESSAGE_DISCUSSION_WIDTH,
2081             'menubar' => false,
2082             'location' => false,
2083             'status' => true,
2084             'scrollbars' => true,
2085             'resizable' => true);
2087     $link = $action = null;
2088     if (!empty($selectcontacturl)) {
2089         $link = new moodle_url($selectcontacturl.'&user2='.$contact->id);
2090     } else {
2091         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2092         $link = new moodle_url("/message/index.php?id=$contact->id");
2093         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2094     }
2095     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2097     echo html_writer::end_tag('td');
2099     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2101     echo html_writer::end_tag('tr');
2104 /**
2105  * Constructs the add/remove contact link to display next to other users
2106  *
2107  * @param bool $incontactlist is the user a contact
2108  * @param bool $isblocked is the user blocked
2109  * @param stdClass $contact contact object
2110  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2111  * @param bool $text include text next to the icons?
2112  * @param bool $icon include a graphical icon?
2113  * @return string
2114  */
2115 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2116     $strcontact = '';
2118     if($incontactlist){
2119         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2120     } else if ($isblocked) {
2121         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2122     } else{
2123         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2124     }
2126     return $strcontact;
2129 /**
2130  * Constructs the block contact link to display next to other users
2131  *
2132  * @param bool $incontactlist is the user a contact?
2133  * @param bool $isblocked is the user blocked?
2134  * @param stdClass $contact contact object
2135  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2136  * @param bool $text include text next to the icons?
2137  * @param bool $icon include a graphical icon?
2138  * @return string
2139  */
2140 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2141     $strblock   = '';
2143     //commented out to allow the user to block a contact without having to remove them first
2144     /*if ($incontactlist) {
2145         //$strblock = '';
2146     } else*/
2147     if ($isblocked) {
2148         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2149     } else{
2150         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2151     }
2153     return $strblock;
2156 /**
2157  * Moves messages from a particular user from the message table (unread messages) to message_read
2158  * This is typically only used when a user is deleted
2159  *
2160  * @param object $userid User id
2161  * @return boolean success
2162  */
2163 function message_move_userfrom_unread2read($userid) {
2164     global $DB;
2166     // move all unread messages from message table to message_read
2167     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2168         foreach ($messages as $message) {
2169             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2170         }
2171     }
2172     return true;
2175 /**
2176  * marks ALL messages being sent from $fromuserid to $touserid as read
2177  *
2178  * @param int $touserid the id of the message recipient
2179  * @param int $fromuserid the id of the message sender
2180  * @return void
2181  */
2182 function message_mark_messages_read($touserid, $fromuserid){
2183     global $DB;
2185     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2186     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2188     foreach ($messages as $message) {
2189         message_mark_message_read($message, time());
2190     }
2192     $messages->close();
2195 /**
2196  * Mark a single message as read
2197  *
2198  * @param stdClass $message An object with an object property ie $message->id which is an id in the message table
2199  * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2200  * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2201  * @return int the ID of the message in the message_read table
2202  */
2203 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2204     global $DB;
2206     $message->timeread = $timeread;
2208     $messageid = $message->id;
2209     unset($message->id);//unset because it will get a new id on insert into message_read
2211     //If any processors have pending actions abort them
2212     if (!$messageworkingempty) {
2213         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2214     }
2215     $messagereadid = $DB->insert_record('message_read', $message);
2216     $DB->delete_records('message', array('id' => $messageid));
2217     return $messagereadid;
2220 /**
2221  * A helper function that prints a formatted heading
2222  *
2223  * @param string $title the heading to display
2224  * @param int $colspan
2225  * @return void
2226  */
2227 function message_print_heading($title, $colspan=3) {
2228     echo html_writer::start_tag('tr');
2229     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2230     echo html_writer::end_tag('tr');
2233 /**
2234  * Get all message processors, validate corresponding plugin existance and
2235  * system configuration
2236  *
2237  * @param bool $ready only return ready-to-use processors
2238  * @return mixed $processors array of objects containing information on message processors
2239  */
2240 function get_message_processors($ready = false) {
2241     global $DB, $CFG;
2243     static $processors;
2245     if (empty($processors)) {
2246         // Get all processors, ensure the name column is the first so it will be the array key
2247         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
2248         foreach ($processors as &$processor){
2249             $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2250             if (is_readable($processorfile)) {
2251                 include_once($processorfile);
2252                 $processclass = 'message_output_' . $processor->name;
2253                 if (class_exists($processclass)) {
2254                     $pclass = new $processclass();
2255                     $processor->object = $pclass;
2256                     $processor->configured = 0;
2257                     if ($pclass->is_system_configured()) {
2258                         $processor->configured = 1;
2259                     }
2260                     $processor->hassettings = 0;
2261                     if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2262                         $processor->hassettings = 1;
2263                     }
2264                     $processor->available = 1;
2265                 } else {
2266                     print_error('errorcallingprocessor', 'message');
2267                 }
2268             } else {
2269                 $processor->available = 0;
2270             }
2271         }
2272     }
2273     if ($ready) {
2274         // Filter out enabled and system_configured processors
2275         $readyprocessors = $processors;
2276         foreach ($readyprocessors as $readyprocessor) {
2277             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
2278                 unset($readyprocessors[$readyprocessor->name]);
2279             }
2280         }
2281         return $readyprocessors;
2282     }
2284     return $processors;
2287 /**
2288  * Get all message providers, validate their plugin existance and
2289  * system configuration
2290  *
2291  * @return mixed $processors array of objects containing information on message processors
2292  */
2293 function get_message_providers() {
2294     global $CFG, $DB;
2295     require_once($CFG->libdir . '/pluginlib.php');
2296     $pluginman = plugin_manager::instance();
2298     $providers = $DB->get_records('message_providers', null, 'name');
2300     // Remove all the providers whose plugins are disabled or don't exist
2301     foreach ($providers as $providerid => $provider) {
2302         $plugin = $pluginman->get_plugin_info($provider->component);
2303         if ($plugin) {
2304             if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
2305                 unset($providers[$providerid]);   // Plugins does not exist
2306                 continue;
2307             }
2308             if ($plugin->is_enabled() === false) {
2309                 unset($providers[$providerid]);   // Plugin disabled
2310                 continue;
2311             }
2312         }
2313     }
2314     return $providers;
2317 /**
2318  * Get an instance of the message_output class for one of the output plugins.
2319  * @param string $type the message output type. E.g. 'email' or 'jabber'.
2320  * @return message_output message_output the requested class.
2321  */
2322 function get_message_processor($type) {
2323     global $CFG;
2325     // Note, we cannot use the get_message_processors function here, becaues this
2326     // code is called during install after installing each messaging plugin, and
2327     // get_message_processors caches the list of installed plugins.
2329     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
2330     if (!is_readable($processorfile)) {
2331         throw new coding_exception('Unknown message processor type ' . $type);
2332     }
2334     include_once($processorfile);
2336     $processclass = 'message_output_' . $type;
2337     if (!class_exists($processclass)) {
2338         throw new coding_exception('Message processor ' . $type .
2339                 ' does not define the right class');
2340     }
2342     return new $processclass();
2345 /**
2346  * Get messaging outputs default (site) preferences
2347  *
2348  * @return object $processors object containing information on message processors
2349  */
2350 function get_message_output_default_preferences() {
2351     return get_config('message');
2354 /**
2355  * Translate message default settings from binary value to the array of string
2356  * representing the settings to be stored. Also validate the provided value and
2357  * use default if it is malformed.
2358  *
2359  * @param  int    $plugindefault Default setting suggested by plugin
2360  * @param  string $processorname The name of processor
2361  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
2362  */
2363 function translate_message_default_setting($plugindefault, $processorname) {
2364     // Preset translation arrays
2365     $permittedvalues = array(
2366         0x04 => 'disallowed',
2367         0x08 => 'permitted',
2368         0x0c => 'forced',
2369     );
2371     $loggedinstatusvalues = array(
2372         0x00 => null, // use null if loggedin/loggedoff is not defined
2373         0x01 => 'loggedin',
2374         0x02 => 'loggedoff',
2375     );
2377     // define the default setting
2378     $processor = get_message_processor($processorname);
2379     $default = $processor->get_default_messaging_settings();
2381     // Validate the value. It should not exceed the maximum size
2382     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
2383         debugging(get_string('errortranslatingdefault', 'message'));
2384         $plugindefault = $default;
2385     }
2386     // Use plugin default setting of 'permitted' is 0
2387     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
2388         $plugindefault = $default;
2389     }
2391     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
2392     $loggedin = $loggedoff = null;
2394     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
2395         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
2396         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
2397     }
2399     return array($permitted, $loggedin, $loggedoff);
2402 /**
2403  * Return a list of page types
2404  * @param string $pagetype current page type
2405  * @param stdClass $parentcontext Block's parent context
2406  * @param stdClass $currentcontext Current context of block
2407  */
2408 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
2409     return array('messages-*'=>get_string('page-message-x', 'message'));
2412 /**
2413  * Is $USER one of the supplied users?
2414  *
2415  * $user2 will be null if viewing a user's recent conversations
2416  *
2417  * @param stdClass the first user
2418  * @param stdClass the second user or null
2419  * @return bool True if the current user is one of either $user1 or $user2
2420  */
2421 function message_current_user_is_involved($user1, $user2) {
2422     global $USER;
2424     if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2425         throw new coding_exception('Invalid user object detected. Missing id.');
2426     }
2428     if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2429         return false;
2430     }
2431     return true;