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