message MDL-25616 adding recent conversations and recent notifications screens
[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('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
65 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
67 define('MESSAGE_CONTACTS_PER_PAGE',10);
69 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
70     $CFG->message_contacts_refresh = 60;
71 }
72 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
73     $CFG->message_chat_refresh = 5;
74 }
75 if (!isset($CFG->message_offline_time)) {
76     $CFG->message_offline_time = 300;
77 }
79 /**
80 * Print the selector that allows the user to view their contacts, course participants, their recent
81 * conversations etc
82 * @param int $countunreadtotal how many unread messages does the user have?
83 * @param int $viewing What is the user viewing? ie VIEW_UNREAD_MESSAGES, VIEW_SEARCH etc
84 * @param object $user1 the user whose messages are being viewed
85 * @param object $user2 the user $user1 is talking to
86 * @param array $blockedusers an array of users blocked by $user1
87 * @param array $onlinecontacts an array of $user1's online contacts
88 * @param array $offlinecontacts an array of $user1's offline contacts
89 * @param array $strangers an array of users who have messaged $user1 who aren't contacts
90 * @param bool $showcontactactionlinks show action links (add/remove contact etc) next to the users in the contact selector
91 * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
92 * @return void
93 */
94 function message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
95     global $PAGE;
97     echo html_writer::start_tag('div', array('class' => 'contactselector mdl-align'));
99     //if 0 unread messages and they've requested unread messages then show contacts
100     if ($countunreadtotal == 0 && $viewing == VIEW_UNREAD_MESSAGES) {
101         $viewing = VIEW_CONTACTS;
102     }
104     //if they have no blocked users and they've requested blocked users switch them over to contacts
105     if (count($blockedusers) == 0 && $viewing == VIEW_BLOCKED) {
106         $viewing = VIEW_CONTACTS;
107     }
109     $onlyactivecourses = true;
110     $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
111     $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
113     $strunreadmessages = null;
114     if ($countunreadtotal>0) { //if there are unread messages
115         $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
116     }
118     message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
120     if ($viewing == VIEW_UNREAD_MESSAGES) {
121         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
122     } else if ($viewing == VIEW_CONTACTS || $viewing == VIEW_SEARCH || $viewing == VIEW_RECENT_CONVERSATIONS || $viewing == VIEW_RECENT_NOTIFICATIONS) {
123         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
124     } else if ($viewing == VIEW_BLOCKED) {
125         message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
126     } else if (substr($viewing, 0, 7) == VIEW_COURSE) {
127         $courseidtoshow = intval(substr($viewing, 7));
129         if (!empty($courseidtoshow)
130             && array_key_exists($courseidtoshow, $coursecontexts)
131             && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
133             message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
134         } else {
135             //shouldn't get here. User trying to access a course they're not in perhaps.
136             add_to_log(SITEID, 'message', 'view', 'index.php', $viewing);
137         }
138     }
140     echo html_writer::start_tag('form', array('action' => 'index.php','method' => 'GET'));
141     echo html_writer::start_tag('fieldset');
142     $managebuttonclass = 'visible';
143     if ($viewing == VIEW_SEARCH) {
144         $managebuttonclass = 'hiddenelement';
145     }
146     $strmanagecontacts = get_string('search','message');
147     echo html_writer::empty_tag('input', array('type' => 'hidden','name' => VIEW_PARAM,'value' => VIEW_SEARCH));
148     echo html_writer::empty_tag('input', array('type' => 'submit','value' => $strmanagecontacts,'class' => $managebuttonclass));
149     echo html_writer::end_tag('fieldset');
150     echo html_writer::end_tag('form');
152     echo html_writer::end_tag('div');
155 /**
156 * Print course participants. Called by message_print_contact_selector()
157 * @param object $context the course context
158 * @param int $courseid the course ID
159 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
160 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
161 * @param string $titletodisplay Optionally specify a title to display above the participants
162 * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
163 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
164 * @return void
165 */
166 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
167     global $DB, $USER, $PAGE, $OUTPUT;
169     if (empty($titletodisplay)) {
170         $titletodisplay = get_string('participants');
171     }
173     $countparticipants = count_enrolled_users($context);
174     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
176     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
177     echo $OUTPUT->render($pagingbar);
179     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
181     echo html_writer::start_tag('tr');
182     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
183     echo html_writer::end_tag('tr');
185     //todo these need to come from somewhere if the course participants list is to show users with unread messages
186     $iscontact = true;
187     $isblocked = false;
188     foreach ($participants as $participant) {
189         if ($participant->id != $USER->id) {
190             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
191             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
192         }
193     }
195     echo html_writer::end_tag('table');
198 /**
199 * Retrieve users blocked by $user1
200 * @param object $user1 the user whose messages are being viewed
201 * @param object $user2 the user $user1 is talking to. If they are being blocked
202 *                      they will have a variable called 'isblocked' added to their user object
203 * @return array the users blocked by $user1
204 */
205 function message_get_blocked_users($user1=null, $user2=null) {
206     global $DB, $USER;
208     if (empty($user1)) {
209         $user1 = $USER;
210     }
212     if (!empty($user2)) {
213         $user2->isblocked = false;
214     }
216     $userfields = user_picture::fields('u', array('lastaccess'));
217     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
218                           FROM {message_contacts} mc
219                           JOIN {user} u ON u.id = mc.contactid
220                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
221                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
222                       GROUP BY $userfields
223                       ORDER BY u.firstname ASC";
224     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
226     $blockedusers = array();
227     if (!empty($rs)) {
228         foreach($rs as $rd) {
229             $blockedusers[] = $rd;
231             if (!empty($user2) && $user2->id == $rd->id) {
232                 $user2->isblocked = true;
233             }
234         }
235         unset($rd);
236         $rs->close();
237     }
239     return $blockedusers;
242 /**
243 * Print users blocked by $user1. Called by message_print_contact_selector()
244 * @param array $blockedusers the users blocked by $user1
245 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
246 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
247 * @param string $titletodisplay Optionally specify a title to display above the participants
248 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
249 * @return void
250 */
251 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
252     global $DB, $USER;
254     $countblocked = count($blockedusers);
256     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
258     if (!empty($titletodisplay)) {
259         echo html_writer::start_tag('tr');
260         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
261         echo html_writer::end_tag('tr');
262     }
264     if ($countblocked) {
265         echo html_writer::start_tag('tr');
266         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
267         echo html_writer::end_tag('tr');
269         foreach ($blockedusers as $blockeduser) {
270             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
271         }
272     }
274     echo html_writer::end_tag('table');
277 /**
278 * Retrieve $user1's contacts (online, offline and strangers)
279 * @param object $user1 the user whose messages are being viewed
280 * @param object $user2 the user $user1 is talking to. If they are a contact
281 *                      they will have a variable called 'iscontact' added to their user object
282 * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
283 */
284 function message_get_contacts($user1=null, $user2=null) {
285     global $DB, $CFG, $USER;
287     if (empty($user1)) {
288         $user1 = $USER;
289     }
291     if (!empty($user2)) {
292         $user2->iscontact = false;
293     }
295     $timetoshowusers = 300; //Seconds default
296     if (isset($CFG->block_online_users_timetosee)) {
297         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
298     }
300     // time which a user is counting as being active since
301     $timefrom = time()-$timetoshowusers;
303     // people in our contactlist who are online
304     $onlinecontacts  = array();
305     // people in our contactlist who are offline
306     $offlinecontacts = array();
307     // people who are not in our contactlist but have sent us a message
308     $strangers       = array();
310     $userfields = user_picture::fields('u', array('lastaccess'));
312     // get all in our contactlist who are not blocked in our contact list
313     // and count messages we have waiting from each of them
314     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
315                      FROM {message_contacts} mc
316                      JOIN {user} u ON u.id = mc.contactid
317                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
318                     WHERE mc.userid = ? AND mc.blocked = 0
319                  GROUP BY $userfields
320                  ORDER BY u.firstname ASC";
322     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
323     foreach ($rs as $rd) {
324         if ($rd->lastaccess >= $timefrom) {
325             // they have been active recently, so are counted online
326             $onlinecontacts[] = $rd;
328         } else {
329             $offlinecontacts[] = $rd;
330         }
332         if (!empty($user2) && $user2->id == $rd->id) {
333             $user2->iscontact = true;
334         }
335     }
336     $rs->close();
338     // get messages from anyone who isn't in our contact list and count the number
339     // of messages we have from each of them
340     $strangersql = "SELECT $userfields, count(m.id) as messagecount
341                       FROM {message} m
342                       JOIN {user} u  ON u.id = m.useridfrom
343                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
344                      WHERE mc.id IS NULL AND m.useridto = ?
345                   GROUP BY $userfields
346                   ORDER BY u.firstname ASC";
348     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
349     foreach ($rs as $rd) {
350         $strangers[] = $rd;
351     }
352     $rs->close();
354     return array($onlinecontacts, $offlinecontacts, $strangers);
357 /**
358 * Print $user1's contacts. Called by message_print_contact_selector()
359 * @param array $onlinecontacts $user1's contacts which are online
360 * @param array $offlinecontacts $user1's contacts which are offline
361 * @param array $strangers users which are not contacts but who have messaged $user1
362 * @param string $contactselecturl the url to send the user to when a contact's name is clicked
363 * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
364 *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
365 * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
366 * @param string $titletodisplay Optionally specify a title to display above the participants
367 * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
368 * @return void
369 */
370 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
371     global $CFG, $PAGE, $OUTPUT;
373     $countonlinecontacts  = count($onlinecontacts);
374     $countofflinecontacts = count($offlinecontacts);
375     $countstrangers       = count($strangers);
377     if ($countonlinecontacts + $countofflinecontacts == 0) {
378         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
379     }
381     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
383     if (!empty($titletodisplay)) {
384         message_print_heading($titletodisplay);
385     }
387     if($countonlinecontacts) {
388         /// print out list of online contacts
390         if (empty($titletodisplay)) {
391             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
392         }
394         foreach ($onlinecontacts as $contact) {
395             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
396                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
397             }
398         }
399     }
401     if ($countofflinecontacts) {
402         /// print out list of offline contacts
404         if (empty($titletodisplay)) {
405             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
406         }
408         foreach ($offlinecontacts as $contact) {
409             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
410                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
411             }
412         }
414     }
416     /// print out list of incoming contacts
417     if ($countstrangers) {
418         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
420         foreach ($strangers as $stranger) {
421             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
422                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
423             }
424         }
425     }
427     echo html_writer::end_tag('table');
429     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
430         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
431     }
433     /*if ($refresh) {
434         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
436         echo $OUTPUT->container_start('messagejsautorefresh note center');
437         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
438         echo $OUTPUT->container_end();
440         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
441         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
442         echo $OUTPUT->container_end();
443     }*/
446 /**
447 * Print a select box allowing the user to choose to view new messages, course participants etc.
448 * Called by message_print_contact_selector()
449 * @param int $viewing What page is the user viewing ie VIEW_UNREAD_MESSAGES, VIEW_RECENT_CONVERSATIONS etc
450 * @param array $courses array of course objects. The courses the user is enrolled in.
451 * @param array $coursecontexts array of course contexts. Keyed on course id.
452 * @param int $countunreadtotal how many unread messages does the user have?
453 * @param int $countblocked how many users has the current user blocked?
454 * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
455 * @return void
456 */
457 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
458     $options = array();
460     if ($countunreadtotal>0) { //if there are unread messages
461         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
462     }
464     $str = get_string('mycontacts', 'message');
465     $options[VIEW_CONTACTS] = $str;
467     $options[VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
468     $options[VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
470     if (!empty($courses)) {
471         $courses_options = array();
473         foreach($courses as $course) {
474             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
475                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
476             }
477         }
479         if (!empty($courses_options)) {
480             $options[] = array(get_string('courses') => $courses_options);
481         }
482     }
484     if ($countblocked>0) {
485         $str = get_string('blockedusers','message', $countblocked);
486         $options[VIEW_BLOCKED] = $str;
487     }
489     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
490         echo html_writer::start_tag('fieldset');
491             echo html_writer::select($options, VIEW_PARAM, $viewing, false, array('id' => VIEW_PARAM,'onchange' => 'this.form.submit()'));
492         echo html_writer::end_tag('fieldset');
493     echo html_writer::end_tag('form');
496 /**
497 * Load the course contexts for all of the users courses
498 * @param array $courses array of course objects. The courses the user is enrolled in.
499 * @return array of course contexts
500 */
501 function message_get_course_contexts($courses) {
502     $coursecontexts = array();
504     foreach($courses as $course) {
505         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
506     }
508     return $coursecontexts;
511 /**
512  * strip off action parameters like 'removecontact'
513  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
514  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
515  */
516 function message_remove_url_params($moodleurl) {
517     $newurl = new moodle_url($moodleurl);
518     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
519     return $newurl->out();
522 /**
523  * Count the number of messages with a field having a specified value.
524  * if $field is empty then return count of the whole array
525  * if $field is non-existent then return 0
526  * @param array $messagearray array of message objects
527  * @param string $field the field to inspect on the message objects
528  * @param string $value the value to test the field against
529  */
530 function message_count_messages($messagearray, $field='', $value='') {
531     if (!is_array($messagearray)) return 0;
532     if ($field == '' or empty($messagearray)) return count($messagearray);
534     $count = 0;
535     foreach ($messagearray as $message) {
536         $count += ($message->$field == $value) ? 1 : 0;
537     }
538     return $count;
541 /**
542  * Returns the count of unread messages for user. Either from a specific user or from all users.
543  * @param object $user1 the first user. Defaults to $USER
544  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
545  * @return int the count of $user1's unread messages
546  */
547 function message_count_unread_messages($user1=null, $user2=null) {
548     global $USER, $DB;
550     if (empty($user1)) {
551         $user1 = $USER;
552     }
554     if (!empty($user2)) {
555         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
556             array($user1->id, $user2->id), "COUNT('id')");
557     } else {
558         return $DB->count_records_select('message', "useridto = ?",
559             array($user1->id), "COUNT('id')");
560     }
563 /**
564  * Count the number of users blocked by $user1
565  * @param $user1
566  */
567 function message_count_blocked_users($user1=null) {
568     global $USER, $DB;
570     if (empty($user1)) {
571         $user1 = $USER;
572     }
574     $sql = "SELECT count(mc.id)
575             FROM {message_contacts} mc
576             WHERE mc.userid = :userid AND mc.blocked = 1";
577     $params = array('userid' => $user1->id);
579     return $DB->count_records_sql($sql, $params);
582 /**
583  * Print the search form and search results if a search has been performed
584  * @param  boolean $advancedsearch show basic or advanced search form
585  * @param  object $user1 the current user
586  * @return boolean true if a search was performed
587  */
588 function message_print_search($advancedsearch = false, $user1=null) {
589     $frm = data_submitted();
591     $doingsearch = false;
592     if ($frm) {
593         if (confirm_sesskey()) {
594             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
595         } else {
596             $frm = false;
597         }
598     }
600     if (!empty($frm->combinedsearch)) {
601         $combinedsearchstring = $frm->combinedsearch;
602     } else {
603         //$combinedsearchstring = get_string('searchcombined','message').'...';
604         $combinedsearchstring = '';
605     }
607     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
609     if ($doingsearch) {
610         if ($advancedsearch) {
612             $messagesearch = '';
613             if (!empty($frm->keywords)) {
614                 $messagesearch = $frm->keywords;
615             }
616             $personsearch = '';
617             if (!empty($frm->name)) {
618                 $personsearch = $frm->name;
619             }
620             include('search_advanced.html');
621         } else {
622             include('search.html');
623         }
625         $showicontext = false;
626         message_print_search_results($frm, $showicontext, $user1);
628         return true;
629     } else {
631         if ($advancedsearch) {
632             $personsearch = $messagesearch = '';
633             include('search_advanced.html');
634         } else {
635             include('search.html');
636         }
637         return false;
638     }
641 /*function message_print_settings() {
642     global $USER, $OUTPUT, $PAGE;
644     if ($frm = data_submitted() and confirm_sesskey()) {
646         $pref = array();
647         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
648         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
650         set_user_preferences($pref);
652         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
653     }
655     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
656     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
658     include('settings.html');
659 }*/
661 /**
662  * Get the users recent conversations meaning all the people they've recently
663  * sent or received a message from plus the most recent message sent to or received from each other user
664  * @param object $user the current user
665  * @param int $limitfrom can be used for paging
666  * @param int $limitto can be used for paging
667  * @return array
668  */
669 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
670     global $DB;
672     $userfields = user_picture::fields('u', array('lastaccess'));
673     //This query retrieves the last message received from and sent to each user
674     //It unions that data then, within that set, it finds the most recent message you've exchanged with each user over all
675     //It then joins with some other tables to get some additional data we need
677     //message ID is used instead of timecreated as it should sort the same and will be much faster
679     //There is a separate query for read and unread queries as they are stored in different tables
680     //They were originally retrieved in one query but it was so large that it was difficult to be confident in its correctness
681     $sql = "SELECT $userfields, mr.id as mid, mr.smallmessage, mr.fullmessage, mr.timecreated, mc.id as contactlistid, mc.blocked
682               FROM {message_read} mr
683               JOIN (
684                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
685                       FROM (
686                            SELECT mr1.useridto AS userid, MAX(mr1.id) AS mid
687                              FROM {message_read} mr1
688                             WHERE mr1.useridfrom = :userid1
689                                   AND mr1.notification = 0
690                          GROUP BY mr1.useridto
691                                   UNION
692                            SELECT mr2.useridfrom AS userid, MAX(mr2.id) AS mid
693                              FROM {message_read} mr2
694                             WHERE mr2.useridto = :userid2
695                                   AND mr2.notification = 0
696                          GROUP BY mr2.useridfrom
697                            ) messages
698                   GROUP BY messages.userid
699                    ) messages2 ON mr.id = messages2.mid AND (mr.useridto = messages2.userid OR mr.useridfrom = messages2.userid)
700               JOIN {user} u ON u.id = messages2.userid
701          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
702              WHERE u.deleted = '0'
703           ORDER BY mr.id DESC";
704     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id);
705     $read =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
707     $sql = "SELECT $userfields, m.id as mid, m.smallmessage, m.fullmessage, m.timecreated, mc.id as contactlistid, mc.blocked
708               FROM {message} m
709               JOIN (
710                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
711                       FROM (
712                            SELECT m1.useridto AS userid, MAX(m1.id) AS mid
713                              FROM {message} m1
714                             WHERE m1.useridfrom = :userid1
715                                   AND m1.notification = 0
716                          GROUP BY m1.useridto
717                                   UNION
718                            SELECT m2.useridfrom AS userid, MAX(m2.id) AS mid
719                              FROM {message} m2
720                             WHERE m2.useridto = :userid2
721                                   AND m2.notification = 0
722                          GROUP BY m2.useridfrom
723                            ) messages
724                   GROUP BY messages.userid
725                    ) messages2 ON m.id = messages2.mid AND (m.useridto = messages2.userid OR m.useridfrom = messages2.userid)
726               JOIN {user} u ON u.id = messages2.userid
727          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
728              WHERE u.deleted = '0'
729              ORDER BY m.id DESC";
730     $unread =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
732     $conversations = array();
734     //Union the 2 result sets together looking for the message with the most recent timecreated for each other user
735     //$conversation->id (the array key) is the other user's ID
736     $conversation_arrays = array($unread, $read);
737     foreach ($conversation_arrays as $conversation_array) {
738         foreach ($conversation_array as $conversation) {
739             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
740                 $conversations[$conversation->id] = $conversation;
741             }
742         }
743     }
745     //Sort the conversations. This is a bit complicated as we need to sort by $conversation->timecreated
746     //and there may be multiple conversations with the same timecreated value.
747     //The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
748     usort($conversations, "conversationsort");
750     return $conversations;
753 /**
754  * Sort function used to order conversations
755  * @param object $a A conversation object
756  * @param object $b A conversation object
757  * @return integer
758  */
759 function conversationsort($a, $b)
761     if ($a->timecreated == $b->timecreated) {
762         return 0;
763     }
764     return ($a->timecreated > $b->timecreated) ? -1 : 1;
767 /**
768  * Get the users recent event notifications
769  * @param object $user the current user
770  * @param int $limitfrom can be used for paging
771  * @param int $limitto can be used for paging
772  * @return array
773  */
774 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
775     global $DB;
777     $userfields = user_picture::fields('u', array('lastaccess'));
778     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.smallmessage, mr.fullmessage, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
779               FROM {message_read} mr
780                    JOIN {user} u ON u.id=mr.useridfrom
781              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
782              ORDER BY mr.id DESC";//ordering by id should give the same result as ordering by timecreated but will be faster
783     $params = array('userid1' => $user->id, 'notification' => 1);
785     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
786     return $notifications;
789 /**
790  * Print the user's recent conversations
791  * @param object $user1 the current user
792  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
793  */
794 function message_print_recent_conversations($user=null, $showicontext=false) {
795     global $USER;
797     echo html_writer::start_tag('p', array('class' => 'heading'));
798     echo get_string('mostrecentconversations', 'message');
799     echo html_writer::end_tag('p');
801     if (empty($user)) {
802         $user = $USER;
803     }
805     $conversations = message_get_recent_conversations($user);
807     $showotheruser = true;
808     message_print_recent_messages_table($conversations, $user, $showotheruser, $showicontext);
811 /**
812  * Print the user's recent notifications
813  * @param object $user1 the current user
814  */
815 function message_print_recent_notifications($user=null) {
816     global $USER;
818     echo html_writer::start_tag('p', array('class' => 'heading'));
819     echo get_string('mostrecentnotifications', 'message');
820     echo html_writer::end_tag('p');
822     if (empty($user)) {
823         $user = $USER;
824     }
826     $notifications = message_get_recent_notifications($user);
828     $showicontext = false;
829     $showotheruser = false;
830     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext);
833 /**
834  * Print a list of recent messages
835  * @staticvar type $dateformat
836  * @param array $messages the messages to display
837  * @param object $user the current user
838  * @param bool $showotheruser display information on the other user?
839  * @param bool $showicontext show text next to the action icons?
840  */
841 function message_print_recent_messages_table($messages, $user=null, $showotheruser=true, $showicontext=false) {
842     global $OUTPUT;
843     static $dateformat;
845     if (empty($dateformat)) {
846         $dateformat = get_string('strftimedatetimeshort');
847     }
849     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
850     foreach ($messages as $message) {
851         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
853         if ($showotheruser) {
854             if ( $message->contactlistid )  {
855                 if ($message->blocked == 0) { /// not blocked
856                     $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
857                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
858                 } else { // blocked
859                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
860                     $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
861                 }
862             } else {
863                 $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
864                 $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
865             }
867             //should we show just the icon or icon and text?
868             $histicontext = 'icon';
869             if ($showicontext) {
870                 $histicontext = 'both';
871             }
872             $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
874             echo html_writer::start_tag('span', array('class' => 'otheruser'));
876             echo html_writer::start_tag('span', array('class' => 'pix'));
877             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
878             echo html_writer::end_tag('span');
880             echo html_writer::start_tag('span', array('class' => 'contact'));
882             $link = new moodle_url("/message/index.php?id=$message->id");
883             $action = null;
884             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
886             echo html_writer::end_tag('span');//end contact
888             echo $strcontact.$strblock.$strhistory;
889             echo html_writer::end_tag('span');//end otheruser
890         }
891         $messagetoprint = null;
892         if (!empty($message->smallmessage)) {
893             $messagetoprint = $message->smallmessage;
894         } else {
895             $messagetoprint = $message->fullmessage;
896         }
898         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
899         echo html_writer::tag('span', format_text($messagetoprint, FORMAT_HTML), array('class' => 'themessage'));
900         echo message_format_contexturl($message);
901         echo html_writer::end_tag('div');//end singlemessage
902     }
903     echo html_writer::end_tag('div');//end messagerecent
906 /**
907  * Add the selected user as a contact for the current user
908  * @param int $contactid the ID of the user to add as a contact
909  * @param int $blocked 1 if you wish to block the contact
910  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
911  *                  Otherwise returns the result of update_record() or insert_record()
912  */
913 function message_add_contact($contactid, $blocked=0) {
914     global $USER, $DB;
916     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
917         return false;
918     }
920     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
921     /// record already exists - we may be changing blocking status
923         if ($contact->blocked !== $blocked) {
924         /// change to blocking status
925             $contact->blocked = $blocked;
926             return $DB->update_record('message_contacts', $contact);
927         } else {
928         /// no changes to blocking status
929             return true;
930         }
932     } else {
933     /// new contact record
934         unset($contact);
935         $contact->userid = $USER->id;
936         $contact->contactid = $contactid;
937         $contact->blocked = $blocked;
938         return $DB->insert_record('message_contacts', $contact, false);
939     }
942 /**
943  * remove a contact
944  * @param type $contactid the user ID of the contact to remove
945  * @return bool returns the result of delete_records()
946  */
947 function message_remove_contact($contactid) {
948     global $USER, $DB;
949     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
952 /**
953  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
954  * @param int $contactid the user ID of the contact to unblock
955  * @return bool returns the result of delete_records()
956  */
957 function message_unblock_contact($contactid) {
958     global $USER, $DB;
959     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
962 /**
963  * block a user
964  * @param int $contactid the user ID of the user to block
965  */
966 function message_block_contact($contactid) {
967     return message_add_contact($contactid, 1);
970 /**
971  * Load a user's contact record
972  * @param int $contactid the user ID of the user whose contact record you want
973  */
974 function message_get_contact($contactid) {
975     global $USER, $DB;
976     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
979 /**
980  * Print the results of a message search
981  * @param mixed $frm submitted form data
982  * @param bool $showicontext show text next to action icons?
983  * @param object $user1 the current user
984  */
985 function message_print_search_results($frm, $showicontext=false, $user1=null) {
986     global $USER, $DB, $OUTPUT;
988     if (empty($user1)) {
989         $user1 = $USER;
990     }
992     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
994     $personsearch = false;
995     $personsearchstring = null;
996     if (!empty($frm->personsubmit) and !empty($frm->name)) {
997         $personsearch = true;
998         $personsearchstring = $frm->name;
999     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1000         $personsearch = true;
1001         $personsearchstring = $frm->combinedsearch;
1002     }
1004     /// search for person
1005     if ($personsearch) {
1006         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1007             $users = array();
1008             $mycourses = enrol_get_my_courses();
1009             foreach ($mycourses as $mycourse) {
1010                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
1011                     foreach ($susers as $suser) $users[$suser->id] = $suser;
1012                 }
1013             }
1014         } else {
1015             $users = message_search_users(SITEID, $personsearchstring);
1016         }
1018         if (!empty($users)) {
1019             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1020             echo get_string('userssearchresults', 'message', count($users));
1021             echo html_writer::end_tag('p');
1023             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1024             foreach ($users as $user) {
1026                 if ( $user->contactlistid )  {
1027                     if ($user->blocked == 0) { /// not blocked
1028                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1029                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1030                     } else { // blocked
1031                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1032                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1033                     }
1034                 } else {
1035                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1036                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1037                 }
1039                 //should we show just the icon or icon and text?
1040                 $histicontext = 'icon';
1041                 if ($showicontext) {
1042                     $histicontext = 'both';
1043                 }
1044                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1046                 echo html_writer::start_tag('tr');
1048                 echo html_writer::start_tag('td', array('class' => 'pix'));
1049                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1050                 echo html_writer::end_tag('td');
1052                 echo html_writer::start_tag('td',array('class' => 'contact'));
1053                 $action = null;
1054                 $link = new moodle_url("/message/index.php?id=$user->id");
1055                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1056                 echo html_writer::end_tag('td');
1058                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1059                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1060                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1062                 echo html_writer::end_tag('tr');
1063             }
1064             echo html_writer::end_tag('table');
1066         } else {
1067             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1068             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1069             echo html_writer::end_tag('p');
1070         }
1071     }
1073     // search messages for keywords
1074     $messagesearch = false;
1075     $messagesearchstring = null;
1076     if (!empty($frm->keywords)) {
1077         $messagesearch = true;
1078         $messagesearchstring = clean_text(trim($frm->keywords));
1079     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1080         $messagesearch = true;
1081         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1082     }
1084     if ($messagesearch) {
1085         if ($messagesearchstring) {
1086             $keywords = explode(' ', $messagesearchstring);
1087         } else {
1088             $keywords = array();
1089         }
1090         $tome     = false;
1091         $fromme   = false;
1092         $courseid = 'none';
1094         if (empty($frm->keywordsoption)) {
1095             $frm->keywordsoption = 'allmine';
1096         }
1098         switch ($frm->keywordsoption) {
1099             case 'tome':
1100                 $tome   = true;
1101                 break;
1102             case 'fromme':
1103                 $fromme = true;
1104                 break;
1105             case 'allmine':
1106                 $tome   = true;
1107                 $fromme = true;
1108                 break;
1109             case 'allusers':
1110                 $courseid = SITEID;
1111                 break;
1112             case 'courseusers':
1113                 $courseid = $frm->courseid;
1114                 break;
1115             default:
1116                 $tome   = true;
1117                 $fromme = true;
1118         }
1120         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1122         /// get a list of contacts
1123             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1124                 $contacts = array();
1125             }
1127         /// print heading with number of results
1128             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1129             $countresults = count($messages);
1130             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1131                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1132             } else {
1133                 echo get_string('keywordssearchresults', 'message', $countresults);
1134             }
1135             echo html_writer::end_tag('p');
1137         /// print table headings
1138             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1140             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1141             $headertdend   = html_writer::end_tag('td');
1142             echo html_writer::start_tag('tr');
1143             echo $headertdstart.get_string('from').$headertdend;
1144             echo $headertdstart.get_string('to').$headertdend;
1145             echo $headertdstart.get_string('message', 'message').$headertdend;
1146             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1147             echo html_writer::end_tag('tr');
1149             $blockedcount = 0;
1150             $dateformat = get_string('strftimedatetimeshort');
1151             $strcontext = get_string('context', 'message');
1152             foreach ($messages as $message) {
1154             /// ignore messages to and from blocked users unless $frm->includeblocked is set
1155                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1156                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1157                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1158                                                 )
1159                    ) {
1160                     $blockedcount ++;
1161                     continue;
1162                 }
1164             /// load up user to record
1165                 if ($message->useridto !== $USER->id) {
1166                     $userto = $DB->get_record('user', array('id' => $message->useridto));
1167                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1168                                     ($contacts[$message->useridto]->blocked == 0) );
1169                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1170                                     ($contacts[$message->useridto]->blocked == 1) );
1171                 } else {
1172                     $userto = false;
1173                     $tocontact = false;
1174                     $toblocked = false;
1175                 }
1177             /// load up user from record
1178                 if ($message->useridfrom !== $USER->id) {
1179                     $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
1180                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1181                                     ($contacts[$message->useridfrom]->blocked == 0) );
1182                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1183                                     ($contacts[$message->useridfrom]->blocked == 1) );
1184                 } else {
1185                     $userfrom = false;
1186                     $fromcontact = false;
1187                     $fromblocked = false;
1188                 }
1190             /// find date string for this message
1191                 $date = usergetdate($message->timecreated);
1192                 $datestring = $date['year'].$date['mon'].$date['mday'];
1194             /// print out message row
1195                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1197                 echo html_writer::start_tag('td', array('class' => 'contact'));
1198                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1199                 echo html_writer::end_tag('td');
1201                 echo html_writer::start_tag('td', array('class' => 'contact'));
1202                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1203                 echo html_writer::end_tag('td');
1205                 echo html_writer::start_tag('td', array('class' => 'summary'));
1206                 echo message_get_fragment($message->fullmessage, $keywords);
1207                 echo html_writer::start_tag('div', array('class' => 'link'));
1209                 //find the user involved that isn't the current user
1210                 $user2id = null;
1211                 if ($user1->id == $message->useridto) {
1212                     $user2id = $message->useridfrom;
1213                 } else {
1214                     $user2id = $message->useridto;
1215                 }
1216                 message_history_link($user1->id, $user2id, false,
1217                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1218                 echo html_writer::end_tag('div');
1219                 echo html_writer::end_tag('td');
1221                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1223                 echo html_writer::end_tag('tr');
1224             }
1227             if ($blockedcount > 0) {
1228                 echo html_writer::start_tag('tr');
1229                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1230                 echo html_writer::end_tag('tr');
1231             }
1232             echo html_writer::end_tag('table');
1234         } else {
1235             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1236         }
1237     }
1239     if (!$personsearch && !$messagesearch) {
1240         //they didn't enter any search terms
1241         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1242     }
1244     //echo '<br />';
1245     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
1247     echo html_writer::end_tag('div');
1250 /**
1251  * Print information on a user. Used when printing search results.
1252  * @param object/bool $user the user to display or false if you just want $USER
1253  * @param bool $iscontact is the user being displayed a contact?
1254  * @param bool $isblocked is the user being displayed blocked?
1255  * @param bool $includeicontext include text next to the action icons?
1256  */
1257 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1258     global $USER, $OUTPUT;
1260     if ($user === false) {
1261         echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
1262     } else {
1263         echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1264         echo '&nbsp;';
1266         $return = false;
1267         $script = null;
1268         if ($iscontact) {
1269             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1270         } else {
1271             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1272         }
1273         echo '&nbsp;';
1274         if ($isblocked) {
1275             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1276         } else {
1277             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1278         }
1280         $popupoptions = array(
1281                 'height' => MESSAGE_DISCUSSION_HEIGHT,
1282                 'width' => MESSAGE_DISCUSSION_WIDTH,
1283                 'menubar' => false,
1284                 'location' => false,
1285                 'status' => true,
1286                 'scrollbars' => true,
1287                 'resizable' => true);
1289         $link = new moodle_url("/message/index.php?id=$user->id");
1290         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
1291         $action = null;
1292         echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1294     }
1297 /**
1298  * Print a message contact link
1299  * @staticvar type $str
1300  * @param int $userid the ID of the user to apply to action to
1301  * @param string $linktype can be add, remove, block or unblock
1302  * @param bool $return if true return the link as a string. If false echo the link.
1303  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1304  * @param bool $text include text next to the icons?
1305  * @param bool $icon include a graphical icon?
1306  * @return string  if $return is true otherwise bool
1307  */
1308 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1309     global $OUTPUT, $PAGE;
1311     //hold onto the strings as we're probably creating a bunch of links
1312     static $str;
1314     if (empty($script)) {
1315         //strip off previous action params like 'removecontact'
1316         $script = message_remove_url_params($PAGE->url);
1317     }
1319     if (empty($str->blockcontact)) {
1320        $str->blockcontact   =  get_string('blockcontact', 'message');
1321        $str->unblockcontact =  get_string('unblockcontact', 'message');
1322        $str->removecontact  =  get_string('removecontact', 'message');
1323        $str->addcontact     =  get_string('addcontact', 'message');
1324     }
1326     $command = $linktype.'contact';
1327     $string  = $str->{$command};
1329     $safealttext = s($string);
1331     $safestring = '';
1332     if (!empty($text)) {
1333         $safestring = $safealttext;
1334     }
1336     $img = '';
1337     if ($icon) {
1338         $iconpath = null;
1339         switch ($linktype) {
1340             case 'block':
1341                 $iconpath = 't/block';
1342                 break;
1343             case 'unblock':
1344                 $iconpath = 't/userblue';
1345                 break;
1346             case 'remove':
1347                 $iconpath = 'i/cross_red_big';
1348                 break;
1349             case 'add':
1350             default:
1351                 $iconpath = 't/addgreen';
1352         }
1354         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1355     }
1357     $output = '<span class="'.$linktype.'contact">'.
1358               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1359               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1360               $img.
1361               $safestring.'</a></span>';
1363     if ($return) {
1364         return $output;
1365     } else {
1366         echo $output;
1367         return true;
1368     }
1371 /**
1372  * echo or return a link to take the user to the full message history between themselves and another user
1373  * @staticvar type $strmessagehistory
1374  * @param int $userid1 the ID of the current user
1375  * @param int $userid2 the ID of the other user
1376  * @param bool $return true to return the link as a string. False to echo the link.
1377  * @param string $keywords any keywords to highlight in the message history
1378  * @param string $position anchor name to jump to within the message history
1379  * @param string $linktext optionally specify the link text
1380  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1381  */
1382 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1383     global $OUTPUT;
1385     static $strmessagehistory;
1387     if (empty($strmessagehistory)) {
1388         $strmessagehistory = get_string('messagehistory', 'message');
1389     }
1391     if ($position) {
1392         $position = "#$position";
1393     }
1394     if ($keywords) {
1395         $keywords = "&search=".urlencode($keywords);
1396     }
1398     if ($linktext == 'icon') {  // Icon only
1399         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1400     } else if ($linktext == 'both') {  // Icon and standard name
1401         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1402         $fulllink .= '&nbsp;'.$strmessagehistory;
1403     } else if ($linktext) {    // Custom name
1404         $fulllink = $linktext;
1405     } else {                   // Standard name only
1406         $fulllink = $strmessagehistory;
1407     }
1409     $popupoptions = array(
1410             'height' => 500,
1411             'width' => 500,
1412             'menubar' => false,
1413             'location' => false,
1414             'status' => true,
1415             'scrollbars' => true,
1416             'resizable' => true);
1418     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1419     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1420     $action = null;
1421     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1423     $str = '<span class="history">'.$str.'</span>';
1425     if ($return) {
1426         return $str;
1427     } else {
1428         echo $str;
1429         return true;
1430     }
1434 /**
1435  * Search through course users
1436  *
1437  * If $coursid specifies the site course then this function searches
1438  * through all undeleted and confirmed users
1439  * @param int $courseid The course in question.
1440  * @param string $searchtext the text to search for
1441  * @param string $sort the column name to order by
1442  * @param string $exceptions comma separated list of user IDs to exclude
1443  * @return array  An array of {@link $USER} records.
1444  */
1445 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1446     global $CFG, $USER, $DB;
1448     $fullname = $DB->sql_fullname();
1450     if (!empty($exceptions)) {
1451         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1452     } else {
1453         $except = '';
1454     }
1456     if (!empty($sort)) {
1457         $order = ' ORDER BY '. $sort;
1458     } else {
1459         $order = '';
1460     }
1462     $ufields = user_picture::fields('u');
1463     if (!$courseid or $courseid == SITEID) {
1464         $params = array($USER->id, "%$searchtext%");
1465         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1466                                        FROM {user} u
1467                                        LEFT JOIN {message_contacts} mc
1468                                             ON mc.contactid = u.id AND mc.userid = ?
1469                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1470                                             AND (".$DB->sql_like($fullname, '?', false).")
1471                                             $except
1472                                      $order", $params);
1473     } else {
1474 //TODO: add enabled enrolment join here (skodak)
1475         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1476         $contextlists = get_related_contexts_string($context);
1478         // everyone who has a role assignment in this course or higher
1479         $params = array($USER->id, "%$searchtext%");
1480         $users = $DB->get_records_sql("SELECT $ufields,
1481                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1482                                          JOIN {role_assignments} ra ON ra.userid = u.id
1483                                          LEFT JOIN {message_contacts} mc
1484                                               ON mc.contactid = u.id AND mc.userid = ?
1485                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1486                                               AND ra.contextid $contextlists
1487                                               AND (".$DB->sql_like($fullname, '?', false).")
1488                                               $except
1489                                        $order", $params);
1491         return $users;
1492     }
1495 /**
1496  * search a user's messages
1497  * @param array $searchterms an array of search terms (strings)
1498  * @param bool $fromme include messages from the user?
1499  * @param bool $tome include messages to the user?
1500  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1501  * @param int $userid the user ID of the current user
1502  * @return mixed An array of messages or false if no matching messages were found
1503  */
1504 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1505 /// Returns a list of posts found using an array of search terms
1506 /// eg   word  +word -word
1507 ///
1508     global $CFG, $USER, $DB;
1510     /// If no userid sent then assume current user
1511     if ($userid == 0) $userid = $USER->id;
1513     /// Some differences in SQL syntax
1514     if ($DB->sql_regex_supported()) {
1515         $REGEXP    = $DB->sql_regex(true);
1516         $NOTREGEXP = $DB->sql_regex(false);
1517     }
1519     $searchcond = array();
1520     $params = array();
1521     $i = 0;
1523     //preprocess search terms to check whether we have at least 1 eligible search term
1524     //if we do we can drop words around it like 'a'
1525     $dropshortwords = false;
1526     foreach ($searchterms as $searchterm) {
1527         if (strlen($searchterm) >= 2) {
1528             $dropshortwords = true;
1529         }
1530     }
1532     foreach ($searchterms as $searchterm) {
1533         $i++;
1535         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1537         if ($dropshortwords && strlen($searchterm) < 2) {
1538             continue;
1539         }
1540     /// Under Oracle and MSSQL, trim the + and - operators and perform
1541     /// simpler LIKE search
1542         if (!$DB->sql_regex_supported()) {
1543             if (substr($searchterm, 0, 1) == '-') {
1544                 $NOT = true;
1545             }
1546             $searchterm = trim($searchterm, '+-');
1547         }
1549         if (substr($searchterm,0,1) == "+") {
1550             $searchterm = substr($searchterm,1);
1551             $searchterm = preg_quote($searchterm, '|');
1552             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1553             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1555         } else if (substr($searchterm,0,1) == "-") {
1556             $searchterm = substr($searchterm,1);
1557             $searchterm = preg_quote($searchterm, '|');
1558             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1559             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1561         } else {
1562             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1563             $params['ss'.$i] = "%$searchterm%";
1564         }
1565     }
1567     if (empty($searchcond)) {
1568         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1569         $params['ss1'] = "%";
1570     } else {
1571         $searchcond = implode(" AND ", $searchcond);
1572     }
1574     /// There are several possibilities
1575     /// 1. courseid = SITEID : The admin is searching messages by all users
1576     /// 2. courseid = ??     : A teacher is searching messages by users in
1577     ///                        one of their courses - currently disabled
1578     /// 3. courseid = none   : User is searching their own messages;
1579     ///    a.  Messages from user
1580     ///    b.  Messages to user
1581     ///    c.  Messages to and from user
1583     if ($courseid == SITEID) { /// admin is searching all messages
1584         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1585                                             FROM {message_read} m
1586                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1587         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1588                                             FROM {message} m
1589                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1591     } else if ($courseid !== 'none') {
1592         /// This has not been implemented due to security concerns
1593         $m_read   = array();
1594         $m_unread = array();
1596     } else {
1598         if ($fromme and $tome) {
1599             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1600             $params['userid1'] = $userid;
1601             $params['userid2'] = $userid;
1603         } else if ($fromme) {
1604             $searchcond .= " AND m.useridfrom=:userid";
1605             $params['userid'] = $userid;
1607         } else if ($tome) {
1608             $searchcond .= " AND m.useridto=:userid";
1609             $params['userid'] = $userid;
1610         }
1612         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1613                                             FROM {message_read} m
1614                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1615         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1616                                             FROM {message} m
1617                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1619     }
1621     /// The keys may be duplicated in $m_read and $m_unread so we can't
1622     /// do a simple concatenation
1623     $message = array();
1624     foreach ($m_read as $m) {
1625         $messages[] = $m;
1626     }
1627     foreach ($m_unread as $m) {
1628         $messages[] = $m;
1629     }
1631     return (empty($messages)) ? false : $messages;
1634 /**
1635  * Given a message object that we already know has a long message
1636  * this function truncates the message nicely to the first
1637  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1638  * @param string $message the message
1639  * @param int $minlength the minimum length to trim the message to
1640  * @return string the shortened message
1641  */
1642 function message_shorten_message($message, $minlength = 0) {
1643     $i = 0;
1644     $tag = false;
1645     $length = strlen($message);
1646     $count = 0;
1647     $stopzone = false;
1648     $truncate = 0;
1649     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1652     for ($i=0; $i<$length; $i++) {
1653         $char = $message[$i];
1655         switch ($char) {
1656             case "<":
1657                 $tag = true;
1658                 break;
1659             case ">":
1660                 $tag = false;
1661                 break;
1662             default:
1663                 if (!$tag) {
1664                     if ($stopzone) {
1665                         if ($char == '.' or $char == ' ') {
1666                             $truncate = $i+1;
1667                             break 2;
1668                         }
1669                     }
1670                     $count++;
1671                 }
1672                 break;
1673         }
1674         if (!$stopzone) {
1675             if ($count > $minlength) {
1676                 $stopzone = true;
1677             }
1678         }
1679     }
1681     if (!$truncate) {
1682         $truncate = $i;
1683     }
1685     return substr($message, 0, $truncate);
1689 /**
1690  * Given a string and an array of keywords, this function looks
1691  * for the first keyword in the string, and then chops out a
1692  * small section from the text that shows that word in context.
1693  * @param string $message the text to search
1694  * @param array $keywords array of keywords to find
1695  */
1696 function message_get_fragment($message, $keywords) {
1698     $fullsize = 160;
1699     $halfsize = (int)($fullsize/2);
1701     $message = strip_tags($message);
1703     foreach ($keywords as $keyword) {  // Just get the first one
1704         if ($keyword !== '') {
1705             break;
1706         }
1707     }
1708     if (empty($keyword)) {   // None found, so just return start of message
1709         return message_shorten_message($message, 30);
1710     }
1712     $leadin = $leadout = '';
1714 /// Find the start of the fragment
1715     $start = 0;
1716     $length = strlen($message);
1718     $pos = strpos($message, $keyword);
1719     if ($pos > $halfsize) {
1720         $start = $pos - $halfsize;
1721         $leadin = '...';
1722     }
1723 /// Find the end of the fragment
1724     $end = $start + $fullsize;
1725     if ($end > $length) {
1726         $end = $length;
1727     } else {
1728         $leadout = '...';
1729     }
1731 /// Pull out the fragment and format it
1733     $fragment = substr($message, $start, $end - $start);
1734     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1735     return $fragment;
1738 /**
1739  * Retrieve the messages between two users
1740  * @param object $user1 the current user
1741  * @param object $user2 the other user
1742  * @param int $limitnum the maximum number of messages to retrieve
1743  * @param bool $viewingnewmessages are we currently viewing new messages?
1744  */
1745 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1746     global $DB, $CFG;
1748     $messages = array();
1750     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1751     //desc to get the last $limitnum messages then flip the order in php
1752     $sort = 'asc';
1753     if ($limitnum>0) {
1754         $sort = 'desc';
1755     }
1757     $notificationswhere = null;
1758     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1759     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1760         $notificationswhere = 'AND notification=0';
1761     }
1763     //prevent notifications of your own actions appearing in your own message history
1764     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1766     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1767                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1768                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1769                                                     "timecreated $sort", '*', 0, $limitnum)) {
1770         foreach ($messages_read as $message) {
1771             $messages[$message->timecreated] = $message;
1772         }
1773     }
1774     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1775                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1776                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1777                                                     "timecreated $sort", '*', 0, $limitnum)) {
1778         foreach ($messages_new as $message) {
1779             $messages[$message->timecreated] = $message;
1780         }
1781     }
1783     //if we only want the last $limitnum messages
1784     ksort($messages);
1785     $messagecount = count($messages);
1786     if ($limitnum>0 && $messagecount>$limitnum) {
1787         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1788     }
1790     return $messages;
1793 /**
1794  * Print the message history between two users
1795  * @param object $user1 the current user
1796  * @param object $user2 the other user
1797  * @param string $search search terms to highlight
1798  * @param int $messagelimit maximum number of messages to return
1799  * @param string $messagehistorylink the html for the message history link or false
1800  * @param bool $viewingnewmessages are we currently viewing new messages?
1801  */
1802 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1803     global $CFG, $OUTPUT;
1805     echo $OUTPUT->box_start('center');
1806     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1807     echo html_writer::start_tag('tr');
1809     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1810     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1811     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1812     echo html_writer::end_tag('td');
1814     echo html_writer::start_tag('td', array('align' => 'center'));
1815     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/left'), 'alt' => get_string('from')));
1816     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/right'), 'alt' => get_string('to')));
1817     echo html_writer::end_tag('td');
1819     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
1820     echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
1821     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
1823     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1824         $incontactlist = $user2->iscontact;
1825         $isblocked = $user2->isblocked;
1827         $script = null;
1828         $text = true;
1829         $icon = false;
1831         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1832         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1833         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1835         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
1836     }
1838     echo html_writer::end_tag('td');
1839     echo html_writer::end_tag('tr');
1840     echo html_writer::end_tag('table');
1841     echo $OUTPUT->box_end();
1843     if (!empty($messagehistorylink)) {
1844         echo $messagehistorylink;
1845     }
1847     /// Get all the messages and print them
1848     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1849         $tablecontents = '';
1851         $current = new stdClass();
1852         $current->mday = '';
1853         $current->month = '';
1854         $current->year = '';
1855         $messagedate = get_string('strftimetime');
1856         $blockdate   = get_string('strftimedaydate');
1857         foreach ($messages as $message) {
1858             if ($message->notification) {
1859                 $notificationclass = ' notification';
1860             } else {
1861                 $notificationclass = null;
1862             }
1863             $date = usergetdate($message->timecreated);
1864             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1865                 $current->mday = $date['mday'];
1866                 $current->month = $date['month'];
1867                 $current->year = $date['year'];
1869                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
1870                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
1872                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
1873             }
1875             $formatted_message = $side = null;
1876             if ($message->useridfrom == $user1->id) {
1877                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
1878                 $side = 'left';
1879             } else {
1880                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
1881                 $side = 'right';
1882             }
1883             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
1884         }
1886         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
1887     } else {
1888         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
1889     }
1892 /**
1893  * Format a message for display in the message history
1894  * @param object $message the message object
1895  * @param string $format optional date format
1896  * @param string $keywords keywords to highlight
1897  * @param string $class CSS class to apply to the div around the message
1898  * @return string the formatted message
1899  */
1900 function message_format_message($message, $format='', $keywords='', $class='other') {
1902     static $dateformat;
1904     //if we haven't previously set the date format or they've supplied a new one
1905     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1906         if ($format) {
1907             $dateformat = $format;
1908         } else {
1909             $dateformat = get_string('strftimedatetimeshort');
1910         }
1911     }
1912     $time = userdate($message->timecreated, $dateformat);
1913     $options = new stdClass();
1914     $options->para = false;
1916     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1917     if (!empty($message->smallmessage)) {
1918         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1919     } else {
1920         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1921     }
1923     $messagetext .= message_format_contexturl($message);
1925     if ($keywords) {
1926         $messagetext = highlight($keywords, $messagetext);
1927     }
1929     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1932 /**
1933  * Format a the context url and context url name of a message for display
1934  * @param object $message the message object
1935  * @return string the formatted string
1936  */
1937 function message_format_contexturl($message) {
1938     $s = null;
1940     if (!empty($message->contexturl)) {
1941         $displaytext = null;
1942         if (!empty($message->contexturlname)) {
1943             $displaytext= $message->contexturlname;
1944         } else {
1945             $displaytext= $message->contexturl;
1946         }
1947         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
1948             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1949         $s .= html_writer::end_tag('div');
1950     }
1952     return $s;
1955 /**
1956  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
1957  * @param object $userfrom the message sender
1958  * @param object $userto the message recipient
1959  * @param string $message the message
1960  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
1961  */
1962 function message_post_message($userfrom, $userto, $message, $format) {
1963     global $SITE, $CFG, $USER;
1965     $eventdata = new stdClass();
1966     $eventdata->component        = 'moodle';
1967     $eventdata->name             = 'instantmessage';
1968     $eventdata->userfrom         = $userfrom;
1969     $eventdata->userto           = $userto;
1971     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1972     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1974     if ($format == FORMAT_HTML) {
1975         $eventdata->fullmessage      = '';
1976         $eventdata->fullmessagehtml  = $message;
1977     } else {
1978         $eventdata->fullmessage      = $message;
1979         $eventdata->fullmessagehtml  = '';
1980     }
1982     $eventdata->fullmessageformat = $format;
1983     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1985     $s = new stdClass();
1986     $s->sitename = $SITE->shortname;
1987     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1989     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1990     if (!empty($eventdata->fullmessage)) {
1991         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1992     }
1993     if (!empty($eventdata->fullmessagehtml)) {
1994         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1995     }
1997     $eventdata->timecreated     = time();
1998     return message_send($eventdata);
2002 /**
2003  * Returns a list of all user ids who have used messaging in the site
2004  * This was the simple way to code the SQL ... is it going to blow up
2005  * on large datasets?
2006  */
2007 function message_get_participants() {
2008     global $CFG, $DB;
2010         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
2011                                UNION SELECT useridto as id,1 FROM {message}
2012                                UNION SELECT useridfrom as id,1 FROM {message_read}
2013                                UNION SELECT useridto as id,1 FROM {message_read}
2014                                UNION SELECT userid as id,1 FROM {message_contacts}
2015                                UNION SELECT contactid as id,1 from {message_contacts}");
2018 /**
2019  * Print a row of contactlist displaying user picture, messages waiting and
2020  * block links etc
2021  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2022  * @param bool $incontactlist is the user a contact of ours?
2023  * @param bool $isblocked is the user blocked?
2024  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2025  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2026  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2027  */
2028 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2029     global $OUTPUT, $USER;
2030     $fullname  = fullname($contact);
2031     $fullnamelink  = $fullname;
2033     $linkclass = '';
2034     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2035         $linkclass = 'messageselecteduser';
2036     }
2038     /// are there any unread messages for this contact?
2039     if ($contact->messagecount > 0 ){
2040         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2041     }
2043     $strcontact = $strblock = $strhistory = null;
2045     if ($showactionlinks) {
2046         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2047         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2048         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2049     }
2051     echo html_writer::start_tag('tr');
2052     echo html_writer::start_tag('td', array('class' => 'pix'));
2053     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => SITEID));
2054     echo html_writer::end_tag('td');
2056     echo html_writer::start_tag('td', array('class' => 'contact'));
2058     $popupoptions = array(
2059             'height' => MESSAGE_DISCUSSION_HEIGHT,
2060             'width' => MESSAGE_DISCUSSION_WIDTH,
2061             'menubar' => false,
2062             'location' => false,
2063             'status' => true,
2064             'scrollbars' => true,
2065             'resizable' => true);
2067     $link = $action = null;
2068     if (!empty($selectcontacturl)) {
2069         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
2070     } else {
2071         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2072         $link = new moodle_url("/message/index.php?id=$contact->id");
2073         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2074     }
2075     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2077     echo html_writer::end_tag('td');
2079     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2081     echo html_writer::end_tag('tr');
2084 /**
2085  * Constructs the add/remove contact link to display next to other users
2086  * @param bool $incontactlist is the user a contact
2087  * @param bool $isblocked is the user blocked
2088  * @param type $contact contact object
2089  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2090  * @param bool $text include text next to the icons?
2091  * @param bool $icon include a graphical icon?
2092  * @return string
2093  */
2094 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2095     $strcontact = '';
2097     if($incontactlist){
2098         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2099     } else if ($isblocked) {
2100         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2101     } else{
2102         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2103     }
2105     return $strcontact;
2108 /**
2109  * Constructs the block contact link to display next to other users
2110  * @param bool $incontactlist is the user a contact
2111  * @param bool $isblocked is the user blocked
2112  * @param type $contact contact object
2113  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2114  * @param bool $text include text next to the icons?
2115  * @param bool $icon include a graphical icon?
2116  * @return string
2117  */
2118 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2119     $strblock   = '';
2121     //commented out to allow the user to block a contact without having to remove them first
2122     /*if ($incontactlist) {
2123         //$strblock = '';
2124     } else*/
2125     if ($isblocked) {
2126         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2127     } else{
2128         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2129     }
2131     return $strblock;
2134  /**
2135   * Moves messages from a particular user from the message table (unread messages) to message_read
2136   * This is typically only used when a user is deleted
2137   * @param object $userid User id
2138   * @return boolean success
2139   */
2140 function message_move_userfrom_unread2read($userid) {
2141     global $DB;
2143     // move all unread messages from message table to message_read
2144     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2145         foreach ($messages as $message) {
2146             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2147         }
2148     }
2149     return true;
2152 /*function message_get_popup_messages($destuserid, $fromuserid=NULL){
2153     global $DB;
2155     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
2157     $messagesproc = $DB->get_records('message_working', array('processorid' => $processor->id), 'id ASC');
2159     //for every message to process check if it's for current user and process
2160     $messages = array();
2161     foreach ($messagesproc as $msgp){
2162         $query = array('id' => $msgp->unreadmessageid, 'useridto' => $destuserid);
2163         if ($fromuserid){
2164             $query['useridfrom'] = $fromuserid;
2165         }
2166         if ($message = $DB->get_record('message', $query)){
2167             $messages[] = $message;
2168             /// Move the entry to the other table
2169             $message->timeread = time();
2170             $messageid = $message->id;
2171             unset($message->id);
2173             //delete what we've processed and check if can move message
2174             $DB->delete_records('message_working', array('id' => $msgp->id));
2175             if ( $DB->count_records('message_working', array('unreadmessageid' => $messageid)) == 0){
2176                 message_mark_message_read($message, time(), true);
2177             }
2178         }
2179     }
2180     return $messages;
2181 }*/
2183 /**
2184 * marks ALL messages being sent from $fromuserid to $touserid as read
2185 * @param int $touserid the id of the message recipient
2186 * @param int $fromuserid the id of the message sender
2187 * @return void
2188 */
2189 function message_mark_messages_read($touserid, $fromuserid){
2190     global $DB;
2192     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2193     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2195     foreach ($messages as $message) {
2196         message_mark_message_read($message, time());
2197     }
2200 /**
2201 * Mark a single message as read
2202 * @param message an object with an object property ie $message->id which is an id in the message table
2203 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2204 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2205 * @return void
2206 */
2207 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2208     global $DB;
2210     $message->timeread = $timeread;
2212     $messageid = $message->id;
2213     unset($message->id);//unset because it will get a new id on insert into message_read
2215     //If any processors have pending actions abort them
2216     if (!$messageworkingempty) {
2217         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2218     }
2219     $DB->insert_record('message_read', $message);
2220     $DB->delete_records('message', array('id' => $messageid));
2223 /**
2224  * A helper function that prints a formatted heading
2225  * @param string $title the heading to display
2226  * @param int $colspan
2227  */
2228 function message_print_heading($title, $colspan=3) {
2229     echo html_writer::start_tag('tr');
2230     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2231     echo html_writer::end_tag('tr');