Merge branch 'MDL-25616_recent_messages' of git://github.com/andyjdavis/moodle
[moodle.git] / message / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library functions for messaging
20  *
21  * @copyright Luis Rodrigues
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package message
24  */
26 require_once($CFG->libdir.'/eventslib.php');
29 define ('MESSAGE_SHORTLENGTH', 300);
31 //$PAGE isnt set if we're being loaded by cron which doesnt display popups anyway
32 if (isset($PAGE)) {
33     $PAGE->set_popup_notification_allowed(false); // We are in a message window (so don't pop up a new one)
34 }
36 define ('MESSAGE_DISCUSSION_WIDTH',600);
37 define ('MESSAGE_DISCUSSION_HEIGHT',500);
39 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
41 define ('CONTACT_ID','id');
43 define('MESSAGE_HISTORY_SHORT',0);
44 define('MESSAGE_HISTORY_ALL',1);
46 //some constants used as function arguments. Just to make function calls a bit more understandable
47 define('IS_CONTACT',true);
48 define('IS_NOT_CONTACT',false);
50 define('IS_BLOCKED',true);
51 define('IS_NOT_BLOCKED',false);
53 define('VIEW_PARAM','viewing');
55 define('VIEW_UNREAD_MESSAGES','unread');
56 define('VIEW_RECENT_CONVERSATIONS','recentconversations');
57 define('VIEW_RECENT_NOTIFICATIONS','recentnotifications');
58 define('VIEW_CONTACTS','contacts');
59 define('VIEW_BLOCKED','blockedusers');
60 define('VIEW_COURSE','course_');
61 define('VIEW_SEARCH','search');
63 define('MESSAGE_USER1_PARAM','user1');
64 define('MESSAGE_USER2_PARAM','user2');
66 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
68 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
70 define('MESSAGE_CONTACTS_PER_PAGE',10);
72 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
73     $CFG->message_contacts_refresh = 60;
74 }
75 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
76     $CFG->message_chat_refresh = 5;
77 }
78 if (!isset($CFG->message_offline_time)) {
79     $CFG->message_offline_time = 300;
80 }
82 /**
83 * Print the selector that allows the user to view their contacts, course participants, their recent
84 * conversations etc
85 * @param int $countunreadtotal how many unread messages does the user have?
86 * @param int $viewing What is the user viewing? ie VIEW_UNREAD_MESSAGES, VIEW_SEARCH etc
87 * @param object $user1 the user whose messages are being viewed
88 * @param object $user2 the user $user1 is talking to
89 * @param array $blockedusers an array of users blocked by $user1
90 * @param array $onlinecontacts an array of $user1's online contacts
91 * @param array $offlinecontacts an array of $user1's offline contacts
92 * @param array $strangers an array of users who have messaged $user1 who aren't contacts
93 * @param bool $showcontactactionlinks show action links (add/remove contact etc) next to the users in the contact selector
94 * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
95 * @return void
96 */
97 function message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
98     global $PAGE;
100     echo html_writer::start_tag('div', array('class' => 'contactselector mdl-align'));
102     //if 0 unread messages and they've requested unread messages then show contacts
103     if ($countunreadtotal == 0 && $viewing == VIEW_UNREAD_MESSAGES) {
104         $viewing = VIEW_CONTACTS;
105     }
107     //if they have no blocked users and they've requested blocked users switch them over to contacts
108     if (count($blockedusers) == 0 && $viewing == VIEW_BLOCKED) {
109         $viewing = VIEW_CONTACTS;
110     }
112     $onlyactivecourses = true;
113     $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
114     $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
116     $strunreadmessages = null;
117     if ($countunreadtotal>0) { //if there are unread messages
118         $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
119     }
121     message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
123     if ($viewing == VIEW_UNREAD_MESSAGES) {
124         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
125     } else if ($viewing == VIEW_CONTACTS || $viewing == VIEW_SEARCH || $viewing == VIEW_RECENT_CONVERSATIONS || $viewing == VIEW_RECENT_NOTIFICATIONS) {
126         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
127     } else if ($viewing == VIEW_BLOCKED) {
128         message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
129     } else if (substr($viewing, 0, 7) == VIEW_COURSE) {
130         $courseidtoshow = intval(substr($viewing, 7));
132         if (!empty($courseidtoshow)
133             && array_key_exists($courseidtoshow, $coursecontexts)
134             && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
136             message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
137         } else {
138             //shouldn't get here. User trying to access a course they're not in perhaps.
139             add_to_log(SITEID, 'message', 'view', 'index.php', $viewing);
140         }
141     }
143     echo html_writer::start_tag('form', array('action' => 'index.php','method' => 'GET'));
144     echo html_writer::start_tag('fieldset');
145     $managebuttonclass = 'visible';
146     if ($viewing == VIEW_SEARCH) {
147         $managebuttonclass = 'hiddenelement';
148     }
149     $strmanagecontacts = get_string('search','message');
150     echo html_writer::empty_tag('input', array('type' => 'hidden','name' => VIEW_PARAM,'value' => VIEW_SEARCH));
151     echo html_writer::empty_tag('input', array('type' => 'submit','value' => $strmanagecontacts,'class' => $managebuttonclass));
152     echo html_writer::end_tag('fieldset');
153     echo html_writer::end_tag('form');
155     echo html_writer::end_tag('div');
158 /**
159 * Print course participants. Called by message_print_contact_selector()
160 * @param object $context the course context
161 * @param int $courseid the course ID
162 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
163 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
164 * @param string $titletodisplay Optionally specify a title to display above the participants
165 * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
166 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
167 * @return void
168 */
169 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
170     global $DB, $USER, $PAGE, $OUTPUT;
172     if (empty($titletodisplay)) {
173         $titletodisplay = get_string('participants');
174     }
176     $countparticipants = count_enrolled_users($context);
177     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
179     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
180     echo $OUTPUT->render($pagingbar);
182     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
184     echo html_writer::start_tag('tr');
185     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
186     echo html_writer::end_tag('tr');
188     //todo these need to come from somewhere if the course participants list is to show users with unread messages
189     $iscontact = true;
190     $isblocked = false;
191     foreach ($participants as $participant) {
192         if ($participant->id != $USER->id) {
193             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
194             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
195         }
196     }
198     echo html_writer::end_tag('table');
201 /**
202 * Retrieve users blocked by $user1
203 * @param object $user1 the user whose messages are being viewed
204 * @param object $user2 the user $user1 is talking to. If they are being blocked
205 *                      they will have a variable called 'isblocked' added to their user object
206 * @return array the users blocked by $user1
207 */
208 function message_get_blocked_users($user1=null, $user2=null) {
209     global $DB, $USER;
211     if (empty($user1)) {
212         $user1 = $USER;
213     }
215     if (!empty($user2)) {
216         $user2->isblocked = false;
217     }
219     $userfields = user_picture::fields('u', array('lastaccess'));
220     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
221                           FROM {message_contacts} mc
222                           JOIN {user} u ON u.id = mc.contactid
223                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
224                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
225                       GROUP BY $userfields
226                       ORDER BY u.firstname ASC";
227     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
229     $blockedusers = array();
230     if (!empty($rs)) {
231         foreach($rs as $rd) {
232             $blockedusers[] = $rd;
234             if (!empty($user2) && $user2->id == $rd->id) {
235                 $user2->isblocked = true;
236             }
237         }
238         unset($rd);
239         $rs->close();
240     }
242     return $blockedusers;
245 /**
246 * Print users blocked by $user1. Called by message_print_contact_selector()
247 * @param array $blockedusers the users blocked by $user1
248 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
249 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
250 * @param string $titletodisplay Optionally specify a title to display above the participants
251 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
252 * @return void
253 */
254 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
255     global $DB, $USER;
257     $countblocked = count($blockedusers);
259     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
261     if (!empty($titletodisplay)) {
262         echo html_writer::start_tag('tr');
263         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
264         echo html_writer::end_tag('tr');
265     }
267     if ($countblocked) {
268         echo html_writer::start_tag('tr');
269         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
270         echo html_writer::end_tag('tr');
272         foreach ($blockedusers as $blockeduser) {
273             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
274         }
275     }
277     echo html_writer::end_tag('table');
280 /**
281 * Retrieve $user1's contacts (online, offline and strangers)
282 * @param object $user1 the user whose messages are being viewed
283 * @param object $user2 the user $user1 is talking to. If they are a contact
284 *                      they will have a variable called 'iscontact' added to their user object
285 * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
286 */
287 function message_get_contacts($user1=null, $user2=null) {
288     global $DB, $CFG, $USER;
290     if (empty($user1)) {
291         $user1 = $USER;
292     }
294     if (!empty($user2)) {
295         $user2->iscontact = false;
296     }
298     $timetoshowusers = 300; //Seconds default
299     if (isset($CFG->block_online_users_timetosee)) {
300         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
301     }
303     // time which a user is counting as being active since
304     $timefrom = time()-$timetoshowusers;
306     // people in our contactlist who are online
307     $onlinecontacts  = array();
308     // people in our contactlist who are offline
309     $offlinecontacts = array();
310     // people who are not in our contactlist but have sent us a message
311     $strangers       = array();
313     $userfields = user_picture::fields('u', array('lastaccess'));
315     // get all in our contactlist who are not blocked in our contact list
316     // and count messages we have waiting from each of them
317     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
318                      FROM {message_contacts} mc
319                      JOIN {user} u ON u.id = mc.contactid
320                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
321                     WHERE mc.userid = ? AND mc.blocked = 0
322                  GROUP BY $userfields
323                  ORDER BY u.firstname ASC";
325     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
326     foreach ($rs as $rd) {
327         if ($rd->lastaccess >= $timefrom) {
328             // they have been active recently, so are counted online
329             $onlinecontacts[] = $rd;
331         } else {
332             $offlinecontacts[] = $rd;
333         }
335         if (!empty($user2) && $user2->id == $rd->id) {
336             $user2->iscontact = true;
337         }
338     }
339     $rs->close();
341     // get messages from anyone who isn't in our contact list and count the number
342     // of messages we have from each of them
343     $strangersql = "SELECT $userfields, count(m.id) as messagecount
344                       FROM {message} m
345                       JOIN {user} u  ON u.id = m.useridfrom
346                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
347                      WHERE mc.id IS NULL AND m.useridto = ?
348                   GROUP BY $userfields
349                   ORDER BY u.firstname ASC";
351     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
352     foreach ($rs as $rd) {
353         $strangers[] = $rd;
354     }
355     $rs->close();
357     return array($onlinecontacts, $offlinecontacts, $strangers);
360 /**
361 * Print $user1's contacts. Called by message_print_contact_selector()
362 * @param array $onlinecontacts $user1's contacts which are online
363 * @param array $offlinecontacts $user1's contacts which are offline
364 * @param array $strangers users which are not contacts but who have messaged $user1
365 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
366 * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
367 *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
368 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
369 * @param string $titletodisplay Optionally specify a title to display above the participants
370 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
371 * @return void
372 */
373 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
374     global $CFG, $PAGE, $OUTPUT;
376     $countonlinecontacts  = count($onlinecontacts);
377     $countofflinecontacts = count($offlinecontacts);
378     $countstrangers       = count($strangers);
380     if ($countonlinecontacts + $countofflinecontacts == 0) {
381         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
382     }
384     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
386     if (!empty($titletodisplay)) {
387         message_print_heading($titletodisplay);
388     }
390     if($countonlinecontacts) {
391         /// print out list of online contacts
393         if (empty($titletodisplay)) {
394             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
395         }
397         foreach ($onlinecontacts as $contact) {
398             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
399                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
400             }
401         }
402     }
404     if ($countofflinecontacts) {
405         /// print out list of offline contacts
407         if (empty($titletodisplay)) {
408             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
409         }
411         foreach ($offlinecontacts as $contact) {
412             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
413                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
414             }
415         }
417     }
419     /// print out list of incoming contacts
420     if ($countstrangers) {
421         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
423         foreach ($strangers as $stranger) {
424             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
425                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
426             }
427         }
428     }
430     echo html_writer::end_tag('table');
432     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
433         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
434     }
436     /*if ($refresh) {
437         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
439         echo $OUTPUT->container_start('messagejsautorefresh note center');
440         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
441         echo $OUTPUT->container_end();
443         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
444         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
445         echo $OUTPUT->container_end();
446     }*/
449 /**
450 * Print a select box allowing the user to choose to view new messages, course participants etc.
451 * Called by message_print_contact_selector()
452 * @param int $viewing What page is the user viewing ie VIEW_UNREAD_MESSAGES, VIEW_RECENT_CONVERSATIONS etc
453 * @param array $courses array of course objects. The courses the user is enrolled in.
454 * @param array $coursecontexts array of course contexts. Keyed on course id.
455 * @param int $countunreadtotal how many unread messages does the user have?
456 * @param int $countblocked how many users has the current user blocked?
457 * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
458 * @return void
459 */
460 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
461     $options = array();
463     if ($countunreadtotal>0) { //if there are unread messages
464         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
465     }
467     $str = get_string('mycontacts', 'message');
468     $options[VIEW_CONTACTS] = $str;
470     $options[VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
471     $options[VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
473     if (!empty($courses)) {
474         $courses_options = array();
476         foreach($courses as $course) {
477             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
478                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
479             }
480         }
482         if (!empty($courses_options)) {
483             $options[] = array(get_string('courses') => $courses_options);
484         }
485     }
487     if ($countblocked>0) {
488         $str = get_string('blockedusers','message', $countblocked);
489         $options[VIEW_BLOCKED] = $str;
490     }
492     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
493         echo html_writer::start_tag('fieldset');
494             echo html_writer::select($options, VIEW_PARAM, $viewing, false, array('id' => VIEW_PARAM,'onchange' => 'this.form.submit()'));
495         echo html_writer::end_tag('fieldset');
496     echo html_writer::end_tag('form');
499 /**
500 * Load the course contexts for all of the users courses
501 * @param array $courses array of course objects. The courses the user is enrolled in.
502 * @return array of course contexts
503 */
504 function message_get_course_contexts($courses) {
505     $coursecontexts = array();
507     foreach($courses as $course) {
508         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
509     }
511     return $coursecontexts;
514 /**
515  * strip off action parameters like 'removecontact'
516  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
517  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
518  */
519 function message_remove_url_params($moodleurl) {
520     $newurl = new moodle_url($moodleurl);
521     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
522     return $newurl->out();
525 /**
526  * Count the number of messages with a field having a specified value.
527  * if $field is empty then return count of the whole array
528  * if $field is non-existent then return 0
529  * @param array $messagearray array of message objects
530  * @param string $field the field to inspect on the message objects
531  * @param string $value the value to test the field against
532  */
533 function message_count_messages($messagearray, $field='', $value='') {
534     if (!is_array($messagearray)) return 0;
535     if ($field == '' or empty($messagearray)) return count($messagearray);
537     $count = 0;
538     foreach ($messagearray as $message) {
539         $count += ($message->$field == $value) ? 1 : 0;
540     }
541     return $count;
544 /**
545  * Returns the count of unread messages for user. Either from a specific user or from all users.
546  * @param object $user1 the first user. Defaults to $USER
547  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
548  * @return int the count of $user1's unread messages
549  */
550 function message_count_unread_messages($user1=null, $user2=null) {
551     global $USER, $DB;
553     if (empty($user1)) {
554         $user1 = $USER;
555     }
557     if (!empty($user2)) {
558         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
559             array($user1->id, $user2->id), "COUNT('id')");
560     } else {
561         return $DB->count_records_select('message', "useridto = ?",
562             array($user1->id), "COUNT('id')");
563     }
566 /**
567  * Count the number of users blocked by $user1
568  * @param $user1
569  */
570 function message_count_blocked_users($user1=null) {
571     global $USER, $DB;
573     if (empty($user1)) {
574         $user1 = $USER;
575     }
577     $sql = "SELECT count(mc.id)
578             FROM {message_contacts} mc
579             WHERE mc.userid = :userid AND mc.blocked = 1";
580     $params = array('userid' => $user1->id);
582     return $DB->count_records_sql($sql, $params);
585 /**
586  * Print the search form and search results if a search has been performed
587  * @param  boolean $advancedsearch show basic or advanced search form
588  * @param  object $user1 the current user
589  * @return boolean true if a search was performed
590  */
591 function message_print_search($advancedsearch = false, $user1=null) {
592     $frm = data_submitted();
594     $doingsearch = false;
595     if ($frm) {
596         if (confirm_sesskey()) {
597             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
598         } else {
599             $frm = false;
600         }
601     }
603     if (!empty($frm->combinedsearch)) {
604         $combinedsearchstring = $frm->combinedsearch;
605     } else {
606         //$combinedsearchstring = get_string('searchcombined','message').'...';
607         $combinedsearchstring = '';
608     }
610     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
612     if ($doingsearch) {
613         if ($advancedsearch) {
615             $messagesearch = '';
616             if (!empty($frm->keywords)) {
617                 $messagesearch = $frm->keywords;
618             }
619             $personsearch = '';
620             if (!empty($frm->name)) {
621                 $personsearch = $frm->name;
622             }
623             include('search_advanced.html');
624         } else {
625             include('search.html');
626         }
628         $showicontext = false;
629         message_print_search_results($frm, $showicontext, $user1);
631         return true;
632     } else {
634         if ($advancedsearch) {
635             $personsearch = $messagesearch = '';
636             include('search_advanced.html');
637         } else {
638             include('search.html');
639         }
640         return false;
641     }
644 /*function message_print_settings() {
645     global $USER, $OUTPUT, $PAGE;
647     if ($frm = data_submitted() and confirm_sesskey()) {
649         $pref = array();
650         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
651         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
653         set_user_preferences($pref);
655         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
656     }
658     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
659     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
661     include('settings.html');
662 }*/
664 /**
665  * Get the users recent conversations meaning all the people they've recently
666  * sent or received a message from plus the most recent message sent to or received from each other user
667  * @param object $user the current user
668  * @param int $limitfrom can be used for paging
669  * @param int $limitto can be used for paging
670  * @return array
671  */
672 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
673     global $DB;
675     $userfields = user_picture::fields('u', array('lastaccess'));
676     //This query retrieves the last message received from and sent to each user
677     //It unions that data then, within that set, it finds the most recent message you've exchanged with each user over all
678     //It then joins with some other tables to get some additional data we need
680     //message ID is used instead of timecreated as it should sort the same and will be much faster
682     //There is a separate query for read and unread queries as they are stored in different tables
683     //They were originally retrieved in one query but it was so large that it was difficult to be confident in its correctness
684     $sql = "SELECT $userfields, mr.id as mid, mr.smallmessage, mr.fullmessage, mr.timecreated, mc.id as contactlistid, mc.blocked
685               FROM {message_read} mr
686               JOIN (
687                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
688                       FROM (
689                            SELECT mr1.useridto AS userid, MAX(mr1.id) AS mid
690                              FROM {message_read} mr1
691                             WHERE mr1.useridfrom = :userid1
692                                   AND mr1.notification = 0
693                          GROUP BY mr1.useridto
694                                   UNION
695                            SELECT mr2.useridfrom AS userid, MAX(mr2.id) AS mid
696                              FROM {message_read} mr2
697                             WHERE mr2.useridto = :userid2
698                                   AND mr2.notification = 0
699                          GROUP BY mr2.useridfrom
700                            ) messages
701                   GROUP BY messages.userid
702                    ) messages2 ON mr.id = messages2.mid AND (mr.useridto = messages2.userid OR mr.useridfrom = messages2.userid)
703               JOIN {user} u ON u.id = messages2.userid
704          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
705              WHERE u.deleted = '0'
706           ORDER BY mr.id DESC";
707     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id);
708     $read =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
710     $sql = "SELECT $userfields, m.id as mid, m.smallmessage, m.fullmessage, m.timecreated, mc.id as contactlistid, mc.blocked
711               FROM {message} m
712               JOIN (
713                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
714                       FROM (
715                            SELECT m1.useridto AS userid, MAX(m1.id) AS mid
716                              FROM {message} m1
717                             WHERE m1.useridfrom = :userid1
718                                   AND m1.notification = 0
719                          GROUP BY m1.useridto
720                                   UNION
721                            SELECT m2.useridfrom AS userid, MAX(m2.id) AS mid
722                              FROM {message} m2
723                             WHERE m2.useridto = :userid2
724                                   AND m2.notification = 0
725                          GROUP BY m2.useridfrom
726                            ) messages
727                   GROUP BY messages.userid
728                    ) messages2 ON m.id = messages2.mid AND (m.useridto = messages2.userid OR m.useridfrom = messages2.userid)
729               JOIN {user} u ON u.id = messages2.userid
730          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
731              WHERE u.deleted = '0'
732              ORDER BY m.id DESC";
733     $unread =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
735     $conversations = array();
737     //Union the 2 result sets together looking for the message with the most recent timecreated for each other user
738     //$conversation->id (the array key) is the other user's ID
739     $conversation_arrays = array($unread, $read);
740     foreach ($conversation_arrays as $conversation_array) {
741         foreach ($conversation_array as $conversation) {
742             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
743                 $conversations[$conversation->id] = $conversation;
744             }
745         }
746     }
748     //Sort the conversations. This is a bit complicated as we need to sort by $conversation->timecreated
749     //and there may be multiple conversations with the same timecreated value.
750     //The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
751     usort($conversations, "conversationsort");
753     return $conversations;
756 /**
757  * Sort function used to order conversations
758  * @param object $a A conversation object
759  * @param object $b A conversation object
760  * @return integer
761  */
762 function conversationsort($a, $b)
764     if ($a->timecreated == $b->timecreated) {
765         return 0;
766     }
767     return ($a->timecreated > $b->timecreated) ? -1 : 1;
770 /**
771  * Get the users recent event notifications
772  * @param object $user the current user
773  * @param int $limitfrom can be used for paging
774  * @param int $limitto can be used for paging
775  * @return array
776  */
777 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
778     global $DB;
780     $userfields = user_picture::fields('u', array('lastaccess'));
781     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.smallmessage, mr.fullmessage, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
782               FROM {message_read} mr
783                    JOIN {user} u ON u.id=mr.useridfrom
784              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
785              ORDER BY mr.id DESC";//ordering by id should give the same result as ordering by timecreated but will be faster
786     $params = array('userid1' => $user->id, 'notification' => 1);
788     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
789     return $notifications;
792 /**
793  * Print the user's recent conversations
794  * @param object $user1 the current user
795  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
796  */
797 function message_print_recent_conversations($user=null, $showicontext=false) {
798     global $USER;
800     echo html_writer::start_tag('p', array('class' => 'heading'));
801     echo get_string('mostrecentconversations', 'message');
802     echo html_writer::end_tag('p');
804     if (empty($user)) {
805         $user = $USER;
806     }
808     $conversations = message_get_recent_conversations($user);
810     $showotheruser = true;
811     message_print_recent_messages_table($conversations, $user, $showotheruser, $showicontext);
814 /**
815  * Print the user's recent notifications
816  * @param object $user1 the current user
817  */
818 function message_print_recent_notifications($user=null) {
819     global $USER;
821     echo html_writer::start_tag('p', array('class' => 'heading'));
822     echo get_string('mostrecentnotifications', 'message');
823     echo html_writer::end_tag('p');
825     if (empty($user)) {
826         $user = $USER;
827     }
829     $notifications = message_get_recent_notifications($user);
831     $showicontext = false;
832     $showotheruser = false;
833     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext);
836 /**
837  * Print a list of recent messages
838  * @staticvar type $dateformat
839  * @param array $messages the messages to display
840  * @param object $user the current user
841  * @param bool $showotheruser display information on the other user?
842  * @param bool $showicontext show text next to the action icons?
843  */
844 function message_print_recent_messages_table($messages, $user=null, $showotheruser=true, $showicontext=false) {
845     global $OUTPUT;
846     static $dateformat;
848     if (empty($dateformat)) {
849         $dateformat = get_string('strftimedatetimeshort');
850     }
852     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
853     foreach ($messages as $message) {
854         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
856         if ($showotheruser) {
857             if ( $message->contactlistid )  {
858                 if ($message->blocked == 0) { /// not blocked
859                     $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
860                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
861                 } else { // blocked
862                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
863                     $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
864                 }
865             } else {
866                 $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
867                 $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
868             }
870             //should we show just the icon or icon and text?
871             $histicontext = 'icon';
872             if ($showicontext) {
873                 $histicontext = 'both';
874             }
875             $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
877             echo html_writer::start_tag('span', array('class' => 'otheruser'));
879             echo html_writer::start_tag('span', array('class' => 'pix'));
880             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
881             echo html_writer::end_tag('span');
883             echo html_writer::start_tag('span', array('class' => 'contact'));
885             $link = new moodle_url("/message/index.php?id=$message->id");
886             $action = null;
887             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
889             echo html_writer::end_tag('span');//end contact
891             echo $strcontact.$strblock.$strhistory;
892             echo html_writer::end_tag('span');//end otheruser
893         }
894         $messagetoprint = null;
895         if (!empty($message->smallmessage)) {
896             $messagetoprint = $message->smallmessage;
897         } else {
898             $messagetoprint = $message->fullmessage;
899         }
901         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
902         echo html_writer::tag('span', format_text($messagetoprint, FORMAT_HTML), array('class' => 'themessage'));
903         echo message_format_contexturl($message);
904         echo html_writer::end_tag('div');//end singlemessage
905     }
906     echo html_writer::end_tag('div');//end messagerecent
909 /**
910  * Add the selected user as a contact for the current user
911  * @param int $contactid the ID of the user to add as a contact
912  * @param int $blocked 1 if you wish to block the contact
913  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
914  *                  Otherwise returns the result of update_record() or insert_record()
915  */
916 function message_add_contact($contactid, $blocked=0) {
917     global $USER, $DB;
919     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
920         return false;
921     }
923     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
924     /// record already exists - we may be changing blocking status
926         if ($contact->blocked !== $blocked) {
927         /// change to blocking status
928             $contact->blocked = $blocked;
929             return $DB->update_record('message_contacts', $contact);
930         } else {
931         /// no changes to blocking status
932             return true;
933         }
935     } else {
936     /// new contact record
937         unset($contact);
938         $contact->userid = $USER->id;
939         $contact->contactid = $contactid;
940         $contact->blocked = $blocked;
941         return $DB->insert_record('message_contacts', $contact, false);
942     }
945 /**
946  * remove a contact
947  * @param type $contactid the user ID of the contact to remove
948  * @return bool returns the result of delete_records()
949  */
950 function message_remove_contact($contactid) {
951     global $USER, $DB;
952     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
955 /**
956  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
957  * @param int $contactid the user ID of the contact to unblock
958  * @return bool returns the result of delete_records()
959  */
960 function message_unblock_contact($contactid) {
961     global $USER, $DB;
962     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
965 /**
966  * block a user
967  * @param int $contactid the user ID of the user to block
968  */
969 function message_block_contact($contactid) {
970     return message_add_contact($contactid, 1);
973 /**
974  * Load a user's contact record
975  * @param int $contactid the user ID of the user whose contact record you want
976  */
977 function message_get_contact($contactid) {
978     global $USER, $DB;
979     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
982 /**
983  * Print the results of a message search
984  * @param mixed $frm submitted form data
985  * @param bool $showicontext show text next to action icons?
986  * @param object $user1 the current user
987  */
988 function message_print_search_results($frm, $showicontext=false, $user1=null) {
989     global $USER, $DB, $OUTPUT;
991     if (empty($user1)) {
992         $user1 = $USER;
993     }
995     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
997     $personsearch = false;
998     $personsearchstring = null;
999     if (!empty($frm->personsubmit) and !empty($frm->name)) {
1000         $personsearch = true;
1001         $personsearchstring = $frm->name;
1002     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1003         $personsearch = true;
1004         $personsearchstring = $frm->combinedsearch;
1005     }
1007     /// search for person
1008     if ($personsearch) {
1009         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1010             $users = array();
1011             $mycourses = enrol_get_my_courses();
1012             foreach ($mycourses as $mycourse) {
1013                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
1014                     foreach ($susers as $suser) $users[$suser->id] = $suser;
1015                 }
1016             }
1017         } else {
1018             $users = message_search_users(SITEID, $personsearchstring);
1019         }
1021         if (!empty($users)) {
1022             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1023             echo get_string('userssearchresults', 'message', count($users));
1024             echo html_writer::end_tag('p');
1026             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1027             foreach ($users as $user) {
1029                 if ( $user->contactlistid )  {
1030                     if ($user->blocked == 0) { /// not blocked
1031                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1032                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1033                     } else { // blocked
1034                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1035                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1036                     }
1037                 } else {
1038                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1039                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1040                 }
1042                 //should we show just the icon or icon and text?
1043                 $histicontext = 'icon';
1044                 if ($showicontext) {
1045                     $histicontext = 'both';
1046                 }
1047                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1049                 echo html_writer::start_tag('tr');
1051                 echo html_writer::start_tag('td', array('class' => 'pix'));
1052                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1053                 echo html_writer::end_tag('td');
1055                 echo html_writer::start_tag('td',array('class' => 'contact'));
1056                 $action = null;
1057                 $link = new moodle_url("/message/index.php?id=$user->id");
1058                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1059                 echo html_writer::end_tag('td');
1061                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1062                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1063                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1065                 echo html_writer::end_tag('tr');
1066             }
1067             echo html_writer::end_tag('table');
1069         } else {
1070             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1071             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1072             echo html_writer::end_tag('p');
1073         }
1074     }
1076     // search messages for keywords
1077     $messagesearch = false;
1078     $messagesearchstring = null;
1079     if (!empty($frm->keywords)) {
1080         $messagesearch = true;
1081         $messagesearchstring = clean_text(trim($frm->keywords));
1082     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1083         $messagesearch = true;
1084         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1085     }
1087     if ($messagesearch) {
1088         if ($messagesearchstring) {
1089             $keywords = explode(' ', $messagesearchstring);
1090         } else {
1091             $keywords = array();
1092         }
1093         $tome     = false;
1094         $fromme   = false;
1095         $courseid = 'none';
1097         if (empty($frm->keywordsoption)) {
1098             $frm->keywordsoption = 'allmine';
1099         }
1101         switch ($frm->keywordsoption) {
1102             case 'tome':
1103                 $tome   = true;
1104                 break;
1105             case 'fromme':
1106                 $fromme = true;
1107                 break;
1108             case 'allmine':
1109                 $tome   = true;
1110                 $fromme = true;
1111                 break;
1112             case 'allusers':
1113                 $courseid = SITEID;
1114                 break;
1115             case 'courseusers':
1116                 $courseid = $frm->courseid;
1117                 break;
1118             default:
1119                 $tome   = true;
1120                 $fromme = true;
1121         }
1123         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1125         /// get a list of contacts
1126             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1127                 $contacts = array();
1128             }
1130         /// print heading with number of results
1131             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1132             $countresults = count($messages);
1133             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1134                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1135             } else {
1136                 echo get_string('keywordssearchresults', 'message', $countresults);
1137             }
1138             echo html_writer::end_tag('p');
1140         /// print table headings
1141             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1143             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1144             $headertdend   = html_writer::end_tag('td');
1145             echo html_writer::start_tag('tr');
1146             echo $headertdstart.get_string('from').$headertdend;
1147             echo $headertdstart.get_string('to').$headertdend;
1148             echo $headertdstart.get_string('message', 'message').$headertdend;
1149             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1150             echo html_writer::end_tag('tr');
1152             $blockedcount = 0;
1153             $dateformat = get_string('strftimedatetimeshort');
1154             $strcontext = get_string('context', 'message');
1155             foreach ($messages as $message) {
1157             /// ignore messages to and from blocked users unless $frm->includeblocked is set
1158                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1159                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1160                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1161                                                 )
1162                    ) {
1163                     $blockedcount ++;
1164                     continue;
1165                 }
1167             /// load up user to record
1168                 if ($message->useridto !== $USER->id) {
1169                     $userto = $DB->get_record('user', array('id' => $message->useridto));
1170                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1171                                     ($contacts[$message->useridto]->blocked == 0) );
1172                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1173                                     ($contacts[$message->useridto]->blocked == 1) );
1174                 } else {
1175                     $userto = false;
1176                     $tocontact = false;
1177                     $toblocked = false;
1178                 }
1180             /// load up user from record
1181                 if ($message->useridfrom !== $USER->id) {
1182                     $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
1183                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1184                                     ($contacts[$message->useridfrom]->blocked == 0) );
1185                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1186                                     ($contacts[$message->useridfrom]->blocked == 1) );
1187                 } else {
1188                     $userfrom = false;
1189                     $fromcontact = false;
1190                     $fromblocked = false;
1191                 }
1193             /// find date string for this message
1194                 $date = usergetdate($message->timecreated);
1195                 $datestring = $date['year'].$date['mon'].$date['mday'];
1197             /// print out message row
1198                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1200                 echo html_writer::start_tag('td', array('class' => 'contact'));
1201                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1202                 echo html_writer::end_tag('td');
1204                 echo html_writer::start_tag('td', array('class' => 'contact'));
1205                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1206                 echo html_writer::end_tag('td');
1208                 echo html_writer::start_tag('td', array('class' => 'summary'));
1209                 echo message_get_fragment($message->fullmessage, $keywords);
1210                 echo html_writer::start_tag('div', array('class' => 'link'));
1212                 //find the user involved that isn't the current user
1213                 $user2id = null;
1214                 if ($user1->id == $message->useridto) {
1215                     $user2id = $message->useridfrom;
1216                 } else {
1217                     $user2id = $message->useridto;
1218                 }
1219                 message_history_link($user1->id, $user2id, false,
1220                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1221                 echo html_writer::end_tag('div');
1222                 echo html_writer::end_tag('td');
1224                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1226                 echo html_writer::end_tag('tr');
1227             }
1230             if ($blockedcount > 0) {
1231                 echo html_writer::start_tag('tr');
1232                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1233                 echo html_writer::end_tag('tr');
1234             }
1235             echo html_writer::end_tag('table');
1237         } else {
1238             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1239         }
1240     }
1242     if (!$personsearch && !$messagesearch) {
1243         //they didn't enter any search terms
1244         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1245     }
1247     //echo '<br />';
1248     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
1250     echo html_writer::end_tag('div');
1253 /**
1254  * Print information on a user. Used when printing search results.
1255  * @param object/bool $user the user to display or false if you just want $USER
1256  * @param bool $iscontact is the user being displayed a contact?
1257  * @param bool $isblocked is the user being displayed blocked?
1258  * @param bool $includeicontext include text next to the action icons?
1259  */
1260 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1261     global $USER, $OUTPUT;
1263     if ($user === false) {
1264         echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
1265     } else {
1266         echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1267         echo '&nbsp;';
1269         $return = false;
1270         $script = null;
1271         if ($iscontact) {
1272             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1273         } else {
1274             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1275         }
1276         echo '&nbsp;';
1277         if ($isblocked) {
1278             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1279         } else {
1280             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1281         }
1283         $popupoptions = array(
1284                 'height' => MESSAGE_DISCUSSION_HEIGHT,
1285                 'width' => MESSAGE_DISCUSSION_WIDTH,
1286                 'menubar' => false,
1287                 'location' => false,
1288                 'status' => true,
1289                 'scrollbars' => true,
1290                 'resizable' => true);
1292         $link = new moodle_url("/message/index.php?id=$user->id");
1293         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
1294         $action = null;
1295         echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1297     }
1300 /**
1301  * Print a message contact link
1302  * @staticvar type $str
1303  * @param int $userid the ID of the user to apply to action to
1304  * @param string $linktype can be add, remove, block or unblock
1305  * @param bool $return if true return the link as a string. If false echo the link.
1306  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1307  * @param bool $text include text next to the icons?
1308  * @param bool $icon include a graphical icon?
1309  * @return string  if $return is true otherwise bool
1310  */
1311 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1312     global $OUTPUT, $PAGE;
1314     //hold onto the strings as we're probably creating a bunch of links
1315     static $str;
1317     if (empty($script)) {
1318         //strip off previous action params like 'removecontact'
1319         $script = message_remove_url_params($PAGE->url);
1320     }
1322     if (empty($str->blockcontact)) {
1323        $str->blockcontact   =  get_string('blockcontact', 'message');
1324        $str->unblockcontact =  get_string('unblockcontact', 'message');
1325        $str->removecontact  =  get_string('removecontact', 'message');
1326        $str->addcontact     =  get_string('addcontact', 'message');
1327     }
1329     $command = $linktype.'contact';
1330     $string  = $str->{$command};
1332     $safealttext = s($string);
1334     $safestring = '';
1335     if (!empty($text)) {
1336         $safestring = $safealttext;
1337     }
1339     $img = '';
1340     if ($icon) {
1341         $iconpath = null;
1342         switch ($linktype) {
1343             case 'block':
1344                 $iconpath = 't/block';
1345                 break;
1346             case 'unblock':
1347                 $iconpath = 't/userblue';
1348                 break;
1349             case 'remove':
1350                 $iconpath = 'i/cross_red_big';
1351                 break;
1352             case 'add':
1353             default:
1354                 $iconpath = 't/addgreen';
1355         }
1357         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1358     }
1360     $output = '<span class="'.$linktype.'contact">'.
1361               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1362               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1363               $img.
1364               $safestring.'</a></span>';
1366     if ($return) {
1367         return $output;
1368     } else {
1369         echo $output;
1370         return true;
1371     }
1374 /**
1375  * echo or return a link to take the user to the full message history between themselves and another user
1376  * @staticvar type $strmessagehistory
1377  * @param int $userid1 the ID of the current user
1378  * @param int $userid2 the ID of the other user
1379  * @param bool $return true to return the link as a string. False to echo the link.
1380  * @param string $keywords any keywords to highlight in the message history
1381  * @param string $position anchor name to jump to within the message history
1382  * @param string $linktext optionally specify the link text
1383  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1384  */
1385 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1386     global $OUTPUT;
1388     static $strmessagehistory;
1390     if (empty($strmessagehistory)) {
1391         $strmessagehistory = get_string('messagehistory', 'message');
1392     }
1394     if ($position) {
1395         $position = "#$position";
1396     }
1397     if ($keywords) {
1398         $keywords = "&search=".urlencode($keywords);
1399     }
1401     if ($linktext == 'icon') {  // Icon only
1402         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1403     } else if ($linktext == 'both') {  // Icon and standard name
1404         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1405         $fulllink .= '&nbsp;'.$strmessagehistory;
1406     } else if ($linktext) {    // Custom name
1407         $fulllink = $linktext;
1408     } else {                   // Standard name only
1409         $fulllink = $strmessagehistory;
1410     }
1412     $popupoptions = array(
1413             'height' => 500,
1414             'width' => 500,
1415             'menubar' => false,
1416             'location' => false,
1417             'status' => true,
1418             'scrollbars' => true,
1419             'resizable' => true);
1421     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1422     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1423     $action = null;
1424     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1426     $str = '<span class="history">'.$str.'</span>';
1428     if ($return) {
1429         return $str;
1430     } else {
1431         echo $str;
1432         return true;
1433     }
1437 /**
1438  * Search through course users
1439  *
1440  * If $coursid specifies the site course then this function searches
1441  * through all undeleted and confirmed users
1442  * @param int $courseid The course in question.
1443  * @param string $searchtext the text to search for
1444  * @param string $sort the column name to order by
1445  * @param string $exceptions comma separated list of user IDs to exclude
1446  * @return array  An array of {@link $USER} records.
1447  */
1448 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1449     global $CFG, $USER, $DB;
1451     $fullname = $DB->sql_fullname();
1453     if (!empty($exceptions)) {
1454         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1455     } else {
1456         $except = '';
1457     }
1459     if (!empty($sort)) {
1460         $order = ' ORDER BY '. $sort;
1461     } else {
1462         $order = '';
1463     }
1465     $ufields = user_picture::fields('u');
1466     if (!$courseid or $courseid == SITEID) {
1467         $params = array($USER->id, "%$searchtext%");
1468         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1469                                        FROM {user} u
1470                                        LEFT JOIN {message_contacts} mc
1471                                             ON mc.contactid = u.id AND mc.userid = ?
1472                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1473                                             AND (".$DB->sql_like($fullname, '?', false).")
1474                                             $except
1475                                      $order", $params);
1476     } else {
1477 //TODO: add enabled enrolment join here (skodak)
1478         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1479         $contextlists = get_related_contexts_string($context);
1481         // everyone who has a role assignment in this course or higher
1482         $params = array($USER->id, "%$searchtext%");
1483         $users = $DB->get_records_sql("SELECT $ufields,
1484                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1485                                          JOIN {role_assignments} ra ON ra.userid = u.id
1486                                          LEFT JOIN {message_contacts} mc
1487                                               ON mc.contactid = u.id AND mc.userid = ?
1488                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1489                                               AND ra.contextid $contextlists
1490                                               AND (".$DB->sql_like($fullname, '?', false).")
1491                                               $except
1492                                        $order", $params);
1494         return $users;
1495     }
1498 /**
1499  * search a user's messages
1500  * @param array $searchterms an array of search terms (strings)
1501  * @param bool $fromme include messages from the user?
1502  * @param bool $tome include messages to the user?
1503  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1504  * @param int $userid the user ID of the current user
1505  * @return mixed An array of messages or false if no matching messages were found
1506  */
1507 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1508 /// Returns a list of posts found using an array of search terms
1509 /// eg   word  +word -word
1510 ///
1511     global $CFG, $USER, $DB;
1513     /// If no userid sent then assume current user
1514     if ($userid == 0) $userid = $USER->id;
1516     /// Some differences in SQL syntax
1517     if ($DB->sql_regex_supported()) {
1518         $REGEXP    = $DB->sql_regex(true);
1519         $NOTREGEXP = $DB->sql_regex(false);
1520     }
1522     $searchcond = array();
1523     $params = array();
1524     $i = 0;
1526     //preprocess search terms to check whether we have at least 1 eligible search term
1527     //if we do we can drop words around it like 'a'
1528     $dropshortwords = false;
1529     foreach ($searchterms as $searchterm) {
1530         if (strlen($searchterm) >= 2) {
1531             $dropshortwords = true;
1532         }
1533     }
1535     foreach ($searchterms as $searchterm) {
1536         $i++;
1538         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1540         if ($dropshortwords && strlen($searchterm) < 2) {
1541             continue;
1542         }
1543     /// Under Oracle and MSSQL, trim the + and - operators and perform
1544     /// simpler LIKE search
1545         if (!$DB->sql_regex_supported()) {
1546             if (substr($searchterm, 0, 1) == '-') {
1547                 $NOT = true;
1548             }
1549             $searchterm = trim($searchterm, '+-');
1550         }
1552         if (substr($searchterm,0,1) == "+") {
1553             $searchterm = substr($searchterm,1);
1554             $searchterm = preg_quote($searchterm, '|');
1555             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1556             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1558         } else if (substr($searchterm,0,1) == "-") {
1559             $searchterm = substr($searchterm,1);
1560             $searchterm = preg_quote($searchterm, '|');
1561             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1562             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1564         } else {
1565             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1566             $params['ss'.$i] = "%$searchterm%";
1567         }
1568     }
1570     if (empty($searchcond)) {
1571         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1572         $params['ss1'] = "%";
1573     } else {
1574         $searchcond = implode(" AND ", $searchcond);
1575     }
1577     /// There are several possibilities
1578     /// 1. courseid = SITEID : The admin is searching messages by all users
1579     /// 2. courseid = ??     : A teacher is searching messages by users in
1580     ///                        one of their courses - currently disabled
1581     /// 3. courseid = none   : User is searching their own messages;
1582     ///    a.  Messages from user
1583     ///    b.  Messages to user
1584     ///    c.  Messages to and from user
1586     if ($courseid == SITEID) { /// admin is searching all messages
1587         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1588                                             FROM {message_read} m
1589                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1590         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1591                                             FROM {message} m
1592                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1594     } else if ($courseid !== 'none') {
1595         /// This has not been implemented due to security concerns
1596         $m_read   = array();
1597         $m_unread = array();
1599     } else {
1601         if ($fromme and $tome) {
1602             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1603             $params['userid1'] = $userid;
1604             $params['userid2'] = $userid;
1606         } else if ($fromme) {
1607             $searchcond .= " AND m.useridfrom=:userid";
1608             $params['userid'] = $userid;
1610         } else if ($tome) {
1611             $searchcond .= " AND m.useridto=:userid";
1612             $params['userid'] = $userid;
1613         }
1615         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1616                                             FROM {message_read} m
1617                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1618         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1619                                             FROM {message} m
1620                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1622     }
1624     /// The keys may be duplicated in $m_read and $m_unread so we can't
1625     /// do a simple concatenation
1626     $message = array();
1627     foreach ($m_read as $m) {
1628         $messages[] = $m;
1629     }
1630     foreach ($m_unread as $m) {
1631         $messages[] = $m;
1632     }
1634     return (empty($messages)) ? false : $messages;
1637 /**
1638  * Given a message object that we already know has a long message
1639  * this function truncates the message nicely to the first
1640  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1641  * @param string $message the message
1642  * @param int $minlength the minimum length to trim the message to
1643  * @return string the shortened message
1644  */
1645 function message_shorten_message($message, $minlength = 0) {
1646     $i = 0;
1647     $tag = false;
1648     $length = strlen($message);
1649     $count = 0;
1650     $stopzone = false;
1651     $truncate = 0;
1652     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1655     for ($i=0; $i<$length; $i++) {
1656         $char = $message[$i];
1658         switch ($char) {
1659             case "<":
1660                 $tag = true;
1661                 break;
1662             case ">":
1663                 $tag = false;
1664                 break;
1665             default:
1666                 if (!$tag) {
1667                     if ($stopzone) {
1668                         if ($char == '.' or $char == ' ') {
1669                             $truncate = $i+1;
1670                             break 2;
1671                         }
1672                     }
1673                     $count++;
1674                 }
1675                 break;
1676         }
1677         if (!$stopzone) {
1678             if ($count > $minlength) {
1679                 $stopzone = true;
1680             }
1681         }
1682     }
1684     if (!$truncate) {
1685         $truncate = $i;
1686     }
1688     return substr($message, 0, $truncate);
1692 /**
1693  * Given a string and an array of keywords, this function looks
1694  * for the first keyword in the string, and then chops out a
1695  * small section from the text that shows that word in context.
1696  * @param string $message the text to search
1697  * @param array $keywords array of keywords to find
1698  */
1699 function message_get_fragment($message, $keywords) {
1701     $fullsize = 160;
1702     $halfsize = (int)($fullsize/2);
1704     $message = strip_tags($message);
1706     foreach ($keywords as $keyword) {  // Just get the first one
1707         if ($keyword !== '') {
1708             break;
1709         }
1710     }
1711     if (empty($keyword)) {   // None found, so just return start of message
1712         return message_shorten_message($message, 30);
1713     }
1715     $leadin = $leadout = '';
1717 /// Find the start of the fragment
1718     $start = 0;
1719     $length = strlen($message);
1721     $pos = strpos($message, $keyword);
1722     if ($pos > $halfsize) {
1723         $start = $pos - $halfsize;
1724         $leadin = '...';
1725     }
1726 /// Find the end of the fragment
1727     $end = $start + $fullsize;
1728     if ($end > $length) {
1729         $end = $length;
1730     } else {
1731         $leadout = '...';
1732     }
1734 /// Pull out the fragment and format it
1736     $fragment = substr($message, $start, $end - $start);
1737     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1738     return $fragment;
1741 /**
1742  * Retrieve the messages between two users
1743  * @param object $user1 the current user
1744  * @param object $user2 the other user
1745  * @param int $limitnum the maximum number of messages to retrieve
1746  * @param bool $viewingnewmessages are we currently viewing new messages?
1747  */
1748 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1749     global $DB, $CFG;
1751     $messages = array();
1753     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1754     //desc to get the last $limitnum messages then flip the order in php
1755     $sort = 'asc';
1756     if ($limitnum>0) {
1757         $sort = 'desc';
1758     }
1760     $notificationswhere = null;
1761     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1762     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1763         $notificationswhere = 'AND notification=0';
1764     }
1766     //prevent notifications of your own actions appearing in your own message history
1767     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1769     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1770                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1771                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1772                                                     "timecreated $sort", '*', 0, $limitnum)) {
1773         foreach ($messages_read as $message) {
1774             $messages[$message->timecreated] = $message;
1775         }
1776     }
1777     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1778                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1779                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1780                                                     "timecreated $sort", '*', 0, $limitnum)) {
1781         foreach ($messages_new as $message) {
1782             $messages[$message->timecreated] = $message;
1783         }
1784     }
1786     //if we only want the last $limitnum messages
1787     ksort($messages);
1788     $messagecount = count($messages);
1789     if ($limitnum>0 && $messagecount>$limitnum) {
1790         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1791     }
1793     return $messages;
1796 /**
1797  * Print the message history between two users
1798  * @param object $user1 the current user
1799  * @param object $user2 the other user
1800  * @param string $search search terms to highlight
1801  * @param int $messagelimit maximum number of messages to return
1802  * @param string $messagehistorylink the html for the message history link or false
1803  * @param bool $viewingnewmessages are we currently viewing new messages?
1804  */
1805 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1806     global $CFG, $OUTPUT;
1808     echo $OUTPUT->box_start('center');
1809     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1810     echo html_writer::start_tag('tr');
1812     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1813     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1814     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1815     echo html_writer::end_tag('td');
1817     echo html_writer::start_tag('td', array('align' => 'center'));
1818     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/left'), 'alt' => get_string('from')));
1819     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/right'), 'alt' => get_string('to')));
1820     echo html_writer::end_tag('td');
1822     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
1823     echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
1824     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
1826     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1827         $incontactlist = $user2->iscontact;
1828         $isblocked = $user2->isblocked;
1830         $script = null;
1831         $text = true;
1832         $icon = false;
1834         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1835         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1836         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1838         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
1839     }
1841     echo html_writer::end_tag('td');
1842     echo html_writer::end_tag('tr');
1843     echo html_writer::end_tag('table');
1844     echo $OUTPUT->box_end();
1846     if (!empty($messagehistorylink)) {
1847         echo $messagehistorylink;
1848     }
1850     /// Get all the messages and print them
1851     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1852         $tablecontents = '';
1854         $current = new stdClass();
1855         $current->mday = '';
1856         $current->month = '';
1857         $current->year = '';
1858         $messagedate = get_string('strftimetime');
1859         $blockdate   = get_string('strftimedaydate');
1860         foreach ($messages as $message) {
1861             if ($message->notification) {
1862                 $notificationclass = ' notification';
1863             } else {
1864                 $notificationclass = null;
1865             }
1866             $date = usergetdate($message->timecreated);
1867             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1868                 $current->mday = $date['mday'];
1869                 $current->month = $date['month'];
1870                 $current->year = $date['year'];
1872                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
1873                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
1875                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
1876             }
1878             $formatted_message = $side = null;
1879             if ($message->useridfrom == $user1->id) {
1880                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
1881                 $side = 'left';
1882             } else {
1883                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
1884                 $side = 'right';
1885             }
1886             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
1887         }
1889         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
1890     } else {
1891         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
1892     }
1895 /**
1896  * Format a message for display in the message history
1897  * @param object $message the message object
1898  * @param string $format optional date format
1899  * @param string $keywords keywords to highlight
1900  * @param string $class CSS class to apply to the div around the message
1901  * @return string the formatted message
1902  */
1903 function message_format_message($message, $format='', $keywords='', $class='other') {
1905     static $dateformat;
1907     //if we haven't previously set the date format or they've supplied a new one
1908     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1909         if ($format) {
1910             $dateformat = $format;
1911         } else {
1912             $dateformat = get_string('strftimedatetimeshort');
1913         }
1914     }
1915     $time = userdate($message->timecreated, $dateformat);
1916     $options = new stdClass();
1917     $options->para = false;
1919     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1920     if (!empty($message->smallmessage)) {
1921         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1922     } else {
1923         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1924     }
1926     $messagetext .= message_format_contexturl($message);
1928     if ($keywords) {
1929         $messagetext = highlight($keywords, $messagetext);
1930     }
1932     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1935 /**
1936  * Format a the context url and context url name of a message for display
1937  * @param object $message the message object
1938  * @return string the formatted string
1939  */
1940 function message_format_contexturl($message) {
1941     $s = null;
1943     if (!empty($message->contexturl)) {
1944         $displaytext = null;
1945         if (!empty($message->contexturlname)) {
1946             $displaytext= $message->contexturlname;
1947         } else {
1948             $displaytext= $message->contexturl;
1949         }
1950         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
1951             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1952         $s .= html_writer::end_tag('div');
1953     }
1955     return $s;
1958 /**
1959  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
1960  * @param object $userfrom the message sender
1961  * @param object $userto the message recipient
1962  * @param string $message the message
1963  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
1964  * @return int|false the ID of the new message or false
1965  */
1966 function message_post_message($userfrom, $userto, $message, $format) {
1967     global $SITE, $CFG, $USER;
1969     $eventdata = new stdClass();
1970     $eventdata->component        = 'moodle';
1971     $eventdata->name             = 'instantmessage';
1972     $eventdata->userfrom         = $userfrom;
1973     $eventdata->userto           = $userto;
1975     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1976     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1978     if ($format == FORMAT_HTML) {
1979         $eventdata->fullmessage      = '';
1980         $eventdata->fullmessagehtml  = $message;
1981     } else {
1982         $eventdata->fullmessage      = $message;
1983         $eventdata->fullmessagehtml  = '';
1984     }
1986     $eventdata->fullmessageformat = $format;
1987     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1989     $s = new stdClass();
1990     $s->sitename = $SITE->shortname;
1991     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1993     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1994     if (!empty($eventdata->fullmessage)) {
1995         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1996     }
1997     if (!empty($eventdata->fullmessagehtml)) {
1998         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1999     }
2001     $eventdata->timecreated     = time();
2002     return message_send($eventdata);
2006 /**
2007  * Returns a list of all user ids who have used messaging in the site
2008  * This was the simple way to code the SQL ... is it going to blow up
2009  * on large datasets?
2010  */
2011 function message_get_participants() {
2012     global $CFG, $DB;
2014         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
2015                                UNION SELECT useridto as id,1 FROM {message}
2016                                UNION SELECT useridfrom as id,1 FROM {message_read}
2017                                UNION SELECT useridto as id,1 FROM {message_read}
2018                                UNION SELECT userid as id,1 FROM {message_contacts}
2019                                UNION SELECT contactid as id,1 from {message_contacts}");
2022 /**
2023  * Print a row of contactlist displaying user picture, messages waiting and
2024  * block links etc
2025  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2026  * @param bool $incontactlist is the user a contact of ours?
2027  * @param bool $isblocked is the user blocked?
2028  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2029  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2030  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2031  */
2032 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2033     global $OUTPUT, $USER;
2034     $fullname  = fullname($contact);
2035     $fullnamelink  = $fullname;
2037     $linkclass = '';
2038     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2039         $linkclass = 'messageselecteduser';
2040     }
2042     /// are there any unread messages for this contact?
2043     if ($contact->messagecount > 0 ){
2044         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2045     }
2047     $strcontact = $strblock = $strhistory = null;
2049     if ($showactionlinks) {
2050         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2051         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2052         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2053     }
2055     echo html_writer::start_tag('tr');
2056     echo html_writer::start_tag('td', array('class' => 'pix'));
2057     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => SITEID));
2058     echo html_writer::end_tag('td');
2060     echo html_writer::start_tag('td', array('class' => 'contact'));
2062     $popupoptions = array(
2063             'height' => MESSAGE_DISCUSSION_HEIGHT,
2064             'width' => MESSAGE_DISCUSSION_WIDTH,
2065             'menubar' => false,
2066             'location' => false,
2067             'status' => true,
2068             'scrollbars' => true,
2069             'resizable' => true);
2071     $link = $action = null;
2072     if (!empty($selectcontacturl)) {
2073         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
2074     } else {
2075         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2076         $link = new moodle_url("/message/index.php?id=$contact->id");
2077         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2078     }
2079     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2081     echo html_writer::end_tag('td');
2083     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2085     echo html_writer::end_tag('tr');
2088 /**
2089  * Constructs the add/remove contact link to display next to other users
2090  * @param bool $incontactlist is the user a contact
2091  * @param bool $isblocked is the user blocked
2092  * @param type $contact contact object
2093  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2094  * @param bool $text include text next to the icons?
2095  * @param bool $icon include a graphical icon?
2096  * @return string
2097  */
2098 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2099     $strcontact = '';
2101     if($incontactlist){
2102         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2103     } else if ($isblocked) {
2104         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2105     } else{
2106         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2107     }
2109     return $strcontact;
2112 /**
2113  * Constructs the block contact link to display next to other users
2114  * @param bool $incontactlist is the user a contact
2115  * @param bool $isblocked is the user blocked
2116  * @param type $contact contact object
2117  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2118  * @param bool $text include text next to the icons?
2119  * @param bool $icon include a graphical icon?
2120  * @return string
2121  */
2122 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2123     $strblock   = '';
2125     //commented out to allow the user to block a contact without having to remove them first
2126     /*if ($incontactlist) {
2127         //$strblock = '';
2128     } else*/
2129     if ($isblocked) {
2130         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2131     } else{
2132         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2133     }
2135     return $strblock;
2138  /**
2139   * Moves messages from a particular user from the message table (unread messages) to message_read
2140   * This is typically only used when a user is deleted
2141   * @param object $userid User id
2142   * @return boolean success
2143   */
2144 function message_move_userfrom_unread2read($userid) {
2145     global $DB;
2147     // move all unread messages from message table to message_read
2148     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2149         foreach ($messages as $message) {
2150             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2151         }
2152     }
2153     return true;
2156 /*function message_get_popup_messages($destuserid, $fromuserid=NULL){
2157     global $DB;
2159     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
2161     $messagesproc = $DB->get_records('message_working', array('processorid' => $processor->id), 'id ASC');
2163     //for every message to process check if it's for current user and process
2164     $messages = array();
2165     foreach ($messagesproc as $msgp){
2166         $query = array('id' => $msgp->unreadmessageid, 'useridto' => $destuserid);
2167         if ($fromuserid){
2168             $query['useridfrom'] = $fromuserid;
2169         }
2170         if ($message = $DB->get_record('message', $query)){
2171             $messages[] = $message;
2172             /// Move the entry to the other table
2173             $message->timeread = time();
2174             $messageid = $message->id;
2175             unset($message->id);
2177             //delete what we've processed and check if can move message
2178             $DB->delete_records('message_working', array('id' => $msgp->id));
2179             if ( $DB->count_records('message_working', array('unreadmessageid' => $messageid)) == 0){
2180                 message_mark_message_read($message, time(), true);
2181             }
2182         }
2183     }
2184     return $messages;
2185 }*/
2187 /**
2188 * marks ALL messages being sent from $fromuserid to $touserid as read
2189 * @param int $touserid the id of the message recipient
2190 * @param int $fromuserid the id of the message sender
2191 * @return void
2192 */
2193 function message_mark_messages_read($touserid, $fromuserid){
2194     global $DB;
2196     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2197     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2199     foreach ($messages as $message) {
2200         message_mark_message_read($message, time());
2201     }
2204 /**
2205 * Mark a single message as read
2206 * @param message an object with an object property ie $message->id which is an id in the message table
2207 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2208 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2209 * @return int the ID of the message in the message_read table
2210 */
2211 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2212     global $DB;
2214     $message->timeread = $timeread;
2216     $messageid = $message->id;
2217     unset($message->id);//unset because it will get a new id on insert into message_read
2219     //If any processors have pending actions abort them
2220     if (!$messageworkingempty) {
2221         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2222     }
2223     $messagereadid = $DB->insert_record('message_read', $message);
2224     $DB->delete_records('message', array('id' => $messageid));
2225     return $messagereadid;
2228 /**
2229  * A helper function that prints a formatted heading
2230  * @param string $title the heading to display
2231  * @param int $colspan
2232  */
2233 function message_print_heading($title, $colspan=3) {
2234     echo html_writer::start_tag('tr');
2235     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2236     echo html_writer::end_tag('tr');