0d76548cdfc1c6033fddfd03957811af28011c2b
[moodle.git] / message / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library functions for messaging
19  *
20  * @package   core_message
21  * @copyright 2008 Luis Rodrigues
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->libdir.'/eventslib.php');
27 define ('MESSAGE_SHORTLENGTH', 300);
29 //$PAGE isnt set if we're being loaded by cron which doesnt display popups anyway
30 if (isset($PAGE)) {
31     //TODO: this is a mega crazy hack - it is not acceptable to call anything when including lib!!! (skodak)
32     $PAGE->set_popup_notification_allowed(false); // We are in a message window (so don't pop up a new one)
33 }
35 define ('MESSAGE_DISCUSSION_WIDTH',600);
36 define ('MESSAGE_DISCUSSION_HEIGHT',500);
38 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
40 define('MESSAGE_HISTORY_SHORT',0);
41 define('MESSAGE_HISTORY_ALL',1);
43 define('MESSAGE_VIEW_UNREAD_MESSAGES','unread');
44 define('MESSAGE_VIEW_RECENT_CONVERSATIONS','recentconversations');
45 define('MESSAGE_VIEW_RECENT_NOTIFICATIONS','recentnotifications');
46 define('MESSAGE_VIEW_CONTACTS','contacts');
47 define('MESSAGE_VIEW_BLOCKED','blockedusers');
48 define('MESSAGE_VIEW_COURSE','course_');
49 define('MESSAGE_VIEW_SEARCH','search');
51 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
53 define('MESSAGE_CONTACTS_PER_PAGE',10);
54 define('MESSAGE_MAX_COURSE_NAME_LENGTH', 30);
56 /**
57  * Define contants for messaging default settings population. For unambiguity of
58  * plugin developer intentions we use 4-bit value (LSB numbering):
59  * bit 0 - whether to send message when user is loggedin (MESSAGE_DEFAULT_LOGGEDIN)
60  * bit 1 - whether to send message when user is loggedoff (MESSAGE_DEFAULT_LOGGEDOFF)
61  * bit 2..3 - messaging permission (MESSAGE_DISALLOWED|MESSAGE_PERMITTED|MESSAGE_FORCED)
62  *
63  * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
64  */
66 define('MESSAGE_DEFAULT_LOGGEDIN', 0x01); // 0001
67 define('MESSAGE_DEFAULT_LOGGEDOFF', 0x02); // 0010
69 define('MESSAGE_DISALLOWED', 0x04); // 0100
70 define('MESSAGE_PERMITTED', 0x08); // 1000
71 define('MESSAGE_FORCED', 0x0c); // 1100
73 define('MESSAGE_PERMITTED_MASK', 0x0c); // 1100
75 /**
76  * Set default value for default outputs permitted setting
77  */
78 define('MESSAGE_DEFAULT_PERMITTED', 'permitted');
80 /**
81  * Print the selector that allows the user to view their contacts, course participants, their recent
82  * conversations etc
83  *
84  * @param int $countunreadtotal how many unread messages does the user have?
85  * @param int $viewing What is the user viewing? ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_SEARCH etc
86  * @param object $user1 the user whose messages are being viewed
87  * @param object $user2 the user $user1 is talking to
88  * @param array $blockedusers an array of users blocked by $user1
89  * @param array $onlinecontacts an array of $user1's online contacts
90  * @param array $offlinecontacts an array of $user1's offline contacts
91  * @param array $strangers an array of users who have messaged $user1 who aren't contacts
92  * @param bool $showactionlinks show action links (add/remove contact etc)
93  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
94  * @return void
95  */
96 function message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showactionlinks, $page=0) {
97     global $PAGE;
99     echo html_writer::start_tag('div', array('class' => 'contactselector mdl-align'));
101     //if 0 unread messages and they've requested unread messages then show contacts
102     if ($countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
103         $viewing = MESSAGE_VIEW_CONTACTS;
104     }
106     //if they have no blocked users and they've requested blocked users switch them over to contacts
107     if (count($blockedusers) == 0 && $viewing == MESSAGE_VIEW_BLOCKED) {
108         $viewing = MESSAGE_VIEW_CONTACTS;
109     }
111     $onlyactivecourses = true;
112     $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
113     $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
115     $strunreadmessages = null;
116     if ($countunreadtotal>0) { //if there are unread messages
117         $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
118     }
120     message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages, $user1);
122     if ($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
123         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showactionlinks,$strunreadmessages, $user2);
124     } else if ($viewing == MESSAGE_VIEW_CONTACTS || $viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS || $viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
125         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 0, $showactionlinks, $strunreadmessages, $user2);
126     } else if ($viewing == MESSAGE_VIEW_BLOCKED) {
127         message_print_blocked_users($blockedusers, $PAGE->url, $showactionlinks, null, $user2);
128     } else if (substr($viewing, 0, 7) == MESSAGE_VIEW_COURSE) {
129         $courseidtoshow = intval(substr($viewing, 7));
131         if (!empty($courseidtoshow)
132             && array_key_exists($courseidtoshow, $coursecontexts)
133             && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
135             message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showactionlinks, null, $page, $user2);
136         } else {
137             //shouldn't get here. User trying to access a course they're not in perhaps.
138             add_to_log(SITEID, 'message', 'view', 'index.php', $viewing);
139         }
140     }
142     // Only show the search button if we're viewing our own messages.
143     // Search isn't currently able to deal with user A wanting to search user B's messages.
144     if ($showactionlinks) {
145         echo html_writer::start_tag('form', array('action' => 'index.php','method' => 'GET'));
146         echo html_writer::start_tag('fieldset');
147         $managebuttonclass = 'visible';
148         if ($viewing == MESSAGE_VIEW_SEARCH) {
149             $managebuttonclass = 'hiddenelement';
150         }
151         $strmanagecontacts = get_string('search','message');
152         echo html_writer::empty_tag('input', array('type' => 'hidden','name' => 'viewing','value' => MESSAGE_VIEW_SEARCH));
153         echo html_writer::empty_tag('input', array('type' => 'submit','value' => $strmanagecontacts,'class' => $managebuttonclass));
154         echo html_writer::end_tag('fieldset');
155         echo html_writer::end_tag('form');
156     }
158     echo html_writer::end_tag('div');
161 /**
162  * Print course participants. Called by message_print_contact_selector()
163  *
164  * @param object $context the course context
165  * @param int $courseid the course ID
166  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
167  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
168  * @param string $titletodisplay Optionally specify a title to display above the participants
169  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
170  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
171  * @return void
172  */
173 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
174     global $DB, $USER, $PAGE, $OUTPUT;
176     if (empty($titletodisplay)) {
177         $titletodisplay = get_string('participants');
178     }
180     $countparticipants = count_enrolled_users($context);
182     list($esql, $params) = get_enrolled_sql($context);
183     $params['mcuserid'] = $USER->id;
184     $ufields = user_picture::fields('u');
186     $sql = "SELECT $ufields, mc.id as contactlistid, mc.blocked
187               FROM {user} u
188               JOIN ($esql) je ON je.id = u.id
189               LEFT JOIN {message_contacts} mc ON mc.contactid = u.id AND mc.userid = :mcuserid
190              WHERE u.deleted = 0";
192     $participants = $DB->get_records_sql($sql, $params, $page * MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
194     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
195     echo $OUTPUT->render($pagingbar);
197     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
199     echo html_writer::start_tag('tr');
200     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
201     echo html_writer::end_tag('tr');
203     foreach ($participants as $participant) {
204         if ($participant->id != $USER->id) {
206             $iscontact = false;
207             $isblocked = false;
208             if ( $participant->contactlistid )  {
209                 if ($participant->blocked == 0) {
210                     // Is contact. Is not blocked.
211                     $iscontact = true;
212                     $isblocked = false;
213                 } else {
214                     // Is blocked.
215                     $iscontact = false;
216                     $isblocked = true;
217                 }
218             }
220             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
221             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
222         }
223     }
225     echo html_writer::end_tag('table');
228 /**
229  * Retrieve users blocked by $user1
230  *
231  * @param object $user1 the user whose messages are being viewed
232  * @param object $user2 the user $user1 is talking to. If they are being blocked
233  *                      they will have a variable called 'isblocked' added to their user object
234  * @return array the users blocked by $user1
235  */
236 function message_get_blocked_users($user1=null, $user2=null) {
237     global $DB, $USER;
239     if (empty($user1)) {
240         $user1 = $USER;
241     }
243     if (!empty($user2)) {
244         $user2->isblocked = false;
245     }
247     $blockedusers = array();
249     $userfields = user_picture::fields('u', array('lastaccess'));
250     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
251                           FROM {message_contacts} mc
252                           JOIN {user} u ON u.id = mc.contactid
253                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
254                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
255                       GROUP BY $userfields
256                       ORDER BY u.firstname ASC";
257     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
259     foreach($rs as $rd) {
260         $blockedusers[] = $rd;
262         if (!empty($user2) && $user2->id == $rd->id) {
263             $user2->isblocked = true;
264         }
265     }
266     $rs->close();
268     return $blockedusers;
271 /**
272  * Print users blocked by $user1. Called by message_print_contact_selector()
273  *
274  * @param array $blockedusers the users blocked by $user1
275  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
276  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
277  * @param string $titletodisplay Optionally specify a title to display above the participants
278  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
279  * @return void
280  */
281 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
282     global $DB, $USER;
284     $countblocked = count($blockedusers);
286     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
288     if (!empty($titletodisplay)) {
289         echo html_writer::start_tag('tr');
290         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
291         echo html_writer::end_tag('tr');
292     }
294     if ($countblocked) {
295         echo html_writer::start_tag('tr');
296         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
297         echo html_writer::end_tag('tr');
299         $isuserblocked = true;
300         $isusercontact = false;
301         foreach ($blockedusers as $blockeduser) {
302             message_print_contactlist_user($blockeduser, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
303         }
304     }
306     echo html_writer::end_tag('table');
309 /**
310  * Retrieve $user1's contacts (online, offline and strangers)
311  *
312  * @param object $user1 the user whose messages are being viewed
313  * @param object $user2 the user $user1 is talking to. If they are a contact
314  *                      they will have a variable called 'iscontact' added to their user object
315  * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
316  */
317 function message_get_contacts($user1=null, $user2=null) {
318     global $DB, $CFG, $USER;
320     if (empty($user1)) {
321         $user1 = $USER;
322     }
324     if (!empty($user2)) {
325         $user2->iscontact = false;
326     }
328     $timetoshowusers = 300; //Seconds default
329     if (isset($CFG->block_online_users_timetosee)) {
330         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
331     }
333     // time which a user is counting as being active since
334     $timefrom = time()-$timetoshowusers;
336     // people in our contactlist who are online
337     $onlinecontacts  = array();
338     // people in our contactlist who are offline
339     $offlinecontacts = array();
340     // people who are not in our contactlist but have sent us a message
341     $strangers       = array();
343     $userfields = user_picture::fields('u', array('lastaccess'));
345     // get all in our contactlist who are not blocked in our contact list
346     // and count messages we have waiting from each of them
347     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
348                      FROM {message_contacts} mc
349                      JOIN {user} u ON u.id = mc.contactid
350                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
351                     WHERE mc.userid = ? AND mc.blocked = 0
352                  GROUP BY $userfields
353                  ORDER BY u.firstname ASC";
355     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
356     foreach ($rs as $rd) {
357         if ($rd->lastaccess >= $timefrom) {
358             // they have been active recently, so are counted online
359             $onlinecontacts[] = $rd;
361         } else {
362             $offlinecontacts[] = $rd;
363         }
365         if (!empty($user2) && $user2->id == $rd->id) {
366             $user2->iscontact = true;
367         }
368     }
369     $rs->close();
371     // get messages from anyone who isn't in our contact list and count the number
372     // of messages we have from each of them
373     $strangersql = "SELECT $userfields, count(m.id) as messagecount
374                       FROM {message} m
375                       JOIN {user} u  ON u.id = m.useridfrom
376                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
377                      WHERE mc.id IS NULL AND m.useridto = ?
378                   GROUP BY $userfields
379                   ORDER BY u.firstname ASC";
381     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
382     foreach ($rs as $rd) {
383         $strangers[] = $rd;
384     }
385     $rs->close();
387     return array($onlinecontacts, $offlinecontacts, $strangers);
390 /**
391  * Print $user1's contacts. Called by message_print_contact_selector()
392  *
393  * @param array $onlinecontacts $user1's contacts which are online
394  * @param array $offlinecontacts $user1's contacts which are offline
395  * @param array $strangers users which are not contacts but who have messaged $user1
396  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
397  * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
398  *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
399  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
400  * @param string $titletodisplay Optionally specify a title to display above the participants
401  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
402  * @return void
403  */
404 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
405     global $CFG, $PAGE, $OUTPUT;
407     $countonlinecontacts  = count($onlinecontacts);
408     $countofflinecontacts = count($offlinecontacts);
409     $countstrangers       = count($strangers);
410     $isuserblocked = null;
412     if ($countonlinecontacts + $countofflinecontacts == 0) {
413         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
414     }
416     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
418     if (!empty($titletodisplay)) {
419         message_print_heading($titletodisplay);
420     }
422     if($countonlinecontacts) {
423         // Print out list of online contacts.
425         if (empty($titletodisplay)) {
426             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
427         }
429         $isuserblocked = false;
430         $isusercontact = true;
431         foreach ($onlinecontacts as $contact) {
432             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
433                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
434             }
435         }
436     }
438     if ($countofflinecontacts) {
439         // Print out list of offline contacts.
441         if (empty($titletodisplay)) {
442             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
443         }
445         $isuserblocked = false;
446         $isusercontact = true;
447         foreach ($offlinecontacts as $contact) {
448             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
449                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
450             }
451         }
453     }
455     // Print out list of incoming contacts.
456     if ($countstrangers) {
457         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
459         $isuserblocked = false;
460         $isusercontact = false;
461         foreach ($strangers as $stranger) {
462             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
463                 message_print_contactlist_user($stranger, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
464             }
465         }
466     }
468     echo html_writer::end_tag('table');
470     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
471         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
472     }
475 /**
476  * Print a select box allowing the user to choose to view new messages, course participants etc.
477  *
478  * Called by message_print_contact_selector()
479  * @param int $viewing What page is the user viewing ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_RECENT_CONVERSATIONS etc
480  * @param array $courses array of course objects. The courses the user is enrolled in.
481  * @param array $coursecontexts array of course contexts. Keyed on course id.
482  * @param int $countunreadtotal how many unread messages does the user have?
483  * @param int $countblocked how many users has the current user blocked?
484  * @param stdClass $user1 The user whose messages we are viewing.
485  * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
486  * @return void
487  */
488 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages, $user1 = null) {
489     $options = array();
491     if ($countunreadtotal>0) { //if there are unread messages
492         $options[MESSAGE_VIEW_UNREAD_MESSAGES] = $strunreadmessages;
493     }
495     $str = get_string('mycontacts', 'message');
496     $options[MESSAGE_VIEW_CONTACTS] = $str;
498     $options[MESSAGE_VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
499     $options[MESSAGE_VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
501     if (!empty($courses)) {
502         $courses_options = array();
504         foreach($courses as $course) {
505             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
506                 //Not using short_text() as we want the end of the course name. Not the beginning.
507                 $shortname = format_string($course->shortname, true, array('context' => $coursecontexts[$course->id]));
508                 if (textlib::strlen($shortname) > MESSAGE_MAX_COURSE_NAME_LENGTH) {
509                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = '...'.textlib::substr($shortname, -MESSAGE_MAX_COURSE_NAME_LENGTH);
510                 } else {
511                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = $shortname;
512                 }
513             }
514         }
516         if (!empty($courses_options)) {
517             $options[] = array(get_string('courses') => $courses_options);
518         }
519     }
521     if ($countblocked>0) {
522         $str = get_string('blockedusers','message', $countblocked);
523         $options[MESSAGE_VIEW_BLOCKED] = $str;
524     }
526     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
527     echo html_writer::start_tag('fieldset');
528     if ( !empty($user1) && !empty($user1->id) ) {
529         echo html_writer::empty_tag('input', array('type' => 'hidden','name' => 'user1','value' => $user1->id));
530     }
531     echo html_writer::label(get_string('messagenavigation', 'message'), 'viewing');
532     echo html_writer::select($options, 'viewing', $viewing, false, array('id' => 'viewing','onchange' => 'this.form.submit()'));
533     echo html_writer::end_tag('fieldset');
534     echo html_writer::end_tag('form');
537 /**
538  * Load the course contexts for all of the users courses
539  *
540  * @param array $courses array of course objects. The courses the user is enrolled in.
541  * @return array of course contexts
542  */
543 function message_get_course_contexts($courses) {
544     $coursecontexts = array();
546     foreach($courses as $course) {
547         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
548     }
550     return $coursecontexts;
553 /**
554  * strip off action parameters like 'removecontact'
555  *
556  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
557  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
558  */
559 function message_remove_url_params($moodleurl) {
560     $newurl = new moodle_url($moodleurl);
561     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
562     return $newurl->out();
565 /**
566  * Count the number of messages with a field having a specified value.
567  * if $field is empty then return count of the whole array
568  * if $field is non-existent then return 0
569  *
570  * @param array $messagearray array of message objects
571  * @param string $field the field to inspect on the message objects
572  * @param string $value the value to test the field against
573  */
574 function message_count_messages($messagearray, $field='', $value='') {
575     if (!is_array($messagearray)) return 0;
576     if ($field == '' or empty($messagearray)) return count($messagearray);
578     $count = 0;
579     foreach ($messagearray as $message) {
580         $count += ($message->$field == $value) ? 1 : 0;
581     }
582     return $count;
585 /**
586  * Returns the count of unread messages for user. Either from a specific user or from all users.
587  *
588  * @param object $user1 the first user. Defaults to $USER
589  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
590  * @return int the count of $user1's unread messages
591  */
592 function message_count_unread_messages($user1=null, $user2=null) {
593     global $USER, $DB;
595     if (empty($user1)) {
596         $user1 = $USER;
597     }
599     if (!empty($user2)) {
600         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
601             array($user1->id, $user2->id), "COUNT('id')");
602     } else {
603         return $DB->count_records_select('message', "useridto = ?",
604             array($user1->id), "COUNT('id')");
605     }
608 /**
609  * Count the number of users blocked by $user1
610  *
611  * @param object $user1 user object
612  * @return int the number of blocked users
613  */
614 function message_count_blocked_users($user1=null) {
615     global $USER, $DB;
617     if (empty($user1)) {
618         $user1 = $USER;
619     }
621     $sql = "SELECT count(mc.id)
622             FROM {message_contacts} mc
623             WHERE mc.userid = :userid AND mc.blocked = 1";
624     $params = array('userid' => $user1->id);
626     return $DB->count_records_sql($sql, $params);
629 /**
630  * Print the search form and search results if a search has been performed
631  *
632  * @param  boolean $advancedsearch show basic or advanced search form
633  * @param  object $user1 the current user
634  * @return boolean true if a search was performed
635  */
636 function message_print_search($advancedsearch = false, $user1=null) {
637     $frm = data_submitted();
639     $doingsearch = false;
640     if ($frm) {
641         if (confirm_sesskey()) {
642             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
643         } else {
644             $frm = false;
645         }
646     }
648     if (!empty($frm->combinedsearch)) {
649         $combinedsearchstring = $frm->combinedsearch;
650     } else {
651         //$combinedsearchstring = get_string('searchcombined','message').'...';
652         $combinedsearchstring = '';
653     }
655     if ($doingsearch) {
656         if ($advancedsearch) {
658             $messagesearch = '';
659             if (!empty($frm->keywords)) {
660                 $messagesearch = $frm->keywords;
661             }
662             $personsearch = '';
663             if (!empty($frm->name)) {
664                 $personsearch = $frm->name;
665             }
666             include('search_advanced.html');
667         } else {
668             include('search.html');
669         }
671         $showicontext = false;
672         message_print_search_results($frm, $showicontext, $user1);
674         return true;
675     } else {
677         if ($advancedsearch) {
678             $personsearch = $messagesearch = '';
679             include('search_advanced.html');
680         } else {
681             include('search.html');
682         }
683         return false;
684     }
687 /**
688  * Get the users recent conversations meaning all the people they've recently
689  * sent or received a message from plus the most recent message sent to or received from each other user
690  *
691  * @param object $user the current user
692  * @param int $limitfrom can be used for paging
693  * @param int $limitto can be used for paging
694  * @return array
695  */
696 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
697     global $DB;
699     $userfields = user_picture::fields('u', array('lastaccess'));
700     //This query retrieves the last message received from and sent to each user
701     //It unions that data then, within that set, it finds the most recent message you've exchanged with each user over all
702     //It then joins with some other tables to get some additional data we need
704     //message ID is used instead of timecreated as it should sort the same and will be much faster
706     //There is a separate query for read and unread queries as they are stored in different tables
707     //They were originally retrieved in one query but it was so large that it was difficult to be confident in its correctness
708     $sql = "SELECT $userfields, mr.id as mid, mr.smallmessage, mr.fullmessage, mr.timecreated, mc.id as contactlistid, mc.blocked
709               FROM {message_read} mr
710               JOIN (
711                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
712                       FROM (
713                            SELECT mr1.useridto AS userid, MAX(mr1.id) AS mid
714                              FROM {message_read} mr1
715                             WHERE mr1.useridfrom = :userid1
716                                   AND mr1.notification = 0
717                          GROUP BY mr1.useridto
718                                   UNION
719                            SELECT mr2.useridfrom AS userid, MAX(mr2.id) AS mid
720                              FROM {message_read} mr2
721                             WHERE mr2.useridto = :userid2
722                                   AND mr2.notification = 0
723                          GROUP BY mr2.useridfrom
724                            ) messages
725                   GROUP BY messages.userid
726                    ) messages2 ON mr.id = messages2.mid AND (mr.useridto = messages2.userid OR mr.useridfrom = messages2.userid)
727               JOIN {user} u ON u.id = messages2.userid
728          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
729              WHERE u.deleted = '0'
730           ORDER BY mr.id DESC";
731     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id);
732     $read =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
734     $sql = "SELECT $userfields, m.id as mid, m.smallmessage, m.fullmessage, m.timecreated, mc.id as contactlistid, mc.blocked
735               FROM {message} m
736               JOIN (
737                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
738                       FROM (
739                            SELECT m1.useridto AS userid, MAX(m1.id) AS mid
740                              FROM {message} m1
741                             WHERE m1.useridfrom = :userid1
742                                   AND m1.notification = 0
743                          GROUP BY m1.useridto
744                                   UNION
745                            SELECT m2.useridfrom AS userid, MAX(m2.id) AS mid
746                              FROM {message} m2
747                             WHERE m2.useridto = :userid2
748                                   AND m2.notification = 0
749                          GROUP BY m2.useridfrom
750                            ) messages
751                   GROUP BY messages.userid
752                    ) messages2 ON m.id = messages2.mid AND (m.useridto = messages2.userid OR m.useridfrom = messages2.userid)
753               JOIN {user} u ON u.id = messages2.userid
754          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
755              WHERE u.deleted = '0'
756              ORDER BY m.id DESC";
757     $unread =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
759     $conversations = array();
761     //Union the 2 result sets together looking for the message with the most recent timecreated for each other user
762     //$conversation->id (the array key) is the other user's ID
763     $conversation_arrays = array($unread, $read);
764     foreach ($conversation_arrays as $conversation_array) {
765         foreach ($conversation_array as $conversation) {
766             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
767                 $conversations[$conversation->id] = $conversation;
768             }
769         }
770     }
772     // Sort the conversations by $conversation->timecreated, newest to oldest
773     // There may be multiple conversations with the same timecreated
774     // The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
775     $result = collatorlib::asort_objects_by_property($conversations, 'timecreated', collatorlib::SORT_NUMERIC);
776     $conversations = array_reverse($conversations);
778     return $conversations;
781 /**
782  * Get the users recent event notifications
783  *
784  * @param object $user the current user
785  * @param int $limitfrom can be used for paging
786  * @param int $limitto can be used for paging
787  * @return array
788  */
789 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
790     global $DB;
792     $userfields = user_picture::fields('u', array('lastaccess'));
793     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.smallmessage, mr.fullmessage, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
794               FROM {message_read} mr
795                    JOIN {user} u ON u.id=mr.useridfrom
796              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
797              ORDER BY mr.id DESC";//ordering by id should give the same result as ordering by timecreated but will be faster
798     $params = array('userid1' => $user->id, 'notification' => 1);
800     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
801     return $notifications;
804 /**
805  * Print the user's recent conversations
806  *
807  * @param stdClass $user the current user
808  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
809  */
810 function message_print_recent_conversations($user1 = null, $showicontext = false, $showactionlinks = true) {
811     global $USER;
813     echo html_writer::start_tag('p', array('class' => 'heading'));
814     echo get_string('mostrecentconversations', 'message');
815     echo html_writer::end_tag('p');
817     if (empty($user1)) {
818         $user1 = $USER;
819     }
821     $conversations = message_get_recent_conversations($user1);
823     // Attach context url information to create the "View this conversation" type links
824     foreach($conversations as $conversation) {
825         $conversation->contexturl = new moodle_url("/message/index.php?user1={$user1->id}&user2={$conversation->id}");
826         $conversation->contexturlname = get_string('thisconversation', 'message');
827     }
829     $showotheruser = true;
830     message_print_recent_messages_table($conversations, $user1, $showotheruser, $showicontext, false, $showactionlinks);
833 /**
834  * Print the user's recent notifications
835  *
836  * @param stdClass $user the current user
837  */
838 function message_print_recent_notifications($user=null) {
839     global $USER;
841     echo html_writer::start_tag('p', array('class' => 'heading'));
842     echo get_string('mostrecentnotifications', 'message');
843     echo html_writer::end_tag('p');
845     if (empty($user)) {
846         $user = $USER;
847     }
849     $notifications = message_get_recent_notifications($user);
851     $showicontext = false;
852     $showotheruser = false;
853     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext);
856 /**
857  * Print a list of recent messages
858  *
859  * @param array $messages the messages to display
860  * @param object $user the current user
861  * @param bool $showotheruser display information on the other user?
862  * @param bool $showicontext show text next to the action icons?
863  * @return void
864  */
865 function message_print_recent_messages_table($messages, $user = null, $showotheruser = true, $showicontext = false, $forcetexttohtml = false, $showactionlinks = true) {
866     global $OUTPUT;
867     static $dateformat;
869     if (empty($dateformat)) {
870         $dateformat = get_string('strftimedatetimeshort');
871     }
873     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
874     foreach ($messages as $message) {
875         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
877         if ($showotheruser) {
878             $strcontact = $strblock = $strhistory = null;
880             if ($showactionlinks) {
881                 if ( $message->contactlistid )  {
882                     if ($message->blocked == 0) { // The other user isn't blocked.
883                         $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
884                         $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
885                     } else { // The other user is blocked.
886                         $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
887                         $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
888                     }
889                 } else {
890                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
891                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
892                 }
894                 //should we show just the icon or icon and text?
895                 $histicontext = 'icon';
896                 if ($showicontext) {
897                     $histicontext = 'both';
898                 }
899                 $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
900             }
901             echo html_writer::start_tag('span', array('class' => 'otheruser'));
903             echo html_writer::start_tag('span', array('class' => 'pix'));
904             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
905             echo html_writer::end_tag('span');
907             echo html_writer::start_tag('span', array('class' => 'contact'));
909             $link = new moodle_url("/message/index.php?user1={$user->id}&user2=$message->id");
910             $action = null;
911             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
913             echo html_writer::end_tag('span');//end contact
915             if ($showactionlinks) {
916                 echo $strcontact.$strblock.$strhistory;
917             }
918             echo html_writer::end_tag('span');//end otheruser
919         }
920         $messagetoprint = null;
921         if (!empty($message->smallmessage)) {
922             $messagetoprint = $message->smallmessage;
923         } else {
924             $messagetoprint = $message->fullmessage;
925         }
927         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
928         echo html_writer::tag('span', format_text($messagetoprint, FORMAT_HTML), array('class' => 'themessage'));
929         echo message_format_contexturl($message);
930         echo html_writer::end_tag('div');//end singlemessage
931     }
932     echo html_writer::end_tag('div');//end messagerecent
935 /**
936  * Add the selected user as a contact for the current user
937  *
938  * @param int $contactid the ID of the user to add as a contact
939  * @param int $blocked 1 if you wish to block the contact
940  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
941  *                  Otherwise returns the result of update_record() or insert_record()
942  */
943 function message_add_contact($contactid, $blocked=0) {
944     global $USER, $DB;
946     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
947         return false;
948     }
950     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
951     // A record already exists. We may be changing blocking status.
953         if ($contact->blocked !== $blocked) {
954             // Blocking status has been changed.
955             $contact->blocked = $blocked;
956             return $DB->update_record('message_contacts', $contact);
957         } else {
958             // No change to blocking status.
959             return true;
960         }
962     } else {
963         // New contact record.
964         $contact = new stdClass();
965         $contact->userid = $USER->id;
966         $contact->contactid = $contactid;
967         $contact->blocked = $blocked;
968         return $DB->insert_record('message_contacts', $contact, false);
969     }
972 /**
973  * remove a contact
974  *
975  * @param int $contactid the user ID of the contact to remove
976  * @return bool returns the result of delete_records()
977  */
978 function message_remove_contact($contactid) {
979     global $USER, $DB;
980     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
983 /**
984  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
985  *
986  * @param int $contactid the user ID of the contact to unblock
987  * @return bool returns the result of delete_records()
988  */
989 function message_unblock_contact($contactid) {
990     global $USER, $DB;
991     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
994 /**
995  * block a user
996  *
997  * @param int $contactid the user ID of the user to block
998  */
999 function message_block_contact($contactid) {
1000     return message_add_contact($contactid, 1);
1003 /**
1004  * Load a user's contact record
1005  *
1006  * @param int $contactid the user ID of the user whose contact record you want
1007  * @return array message contacts
1008  */
1009 function message_get_contact($contactid) {
1010     global $USER, $DB;
1011     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
1014 /**
1015  * Print the results of a message search
1016  *
1017  * @param mixed $frm submitted form data
1018  * @param bool $showicontext show text next to action icons?
1019  * @param object $currentuser the current user
1020  * @return void
1021  */
1022 function message_print_search_results($frm, $showicontext=false, $currentuser=null) {
1023     global $USER, $DB, $OUTPUT;
1025     if (empty($currentuser)) {
1026         $currentuser = $USER;
1027     }
1029     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
1031     $personsearch = false;
1032     $personsearchstring = null;
1033     if (!empty($frm->personsubmit) and !empty($frm->name)) {
1034         $personsearch = true;
1035         $personsearchstring = $frm->name;
1036     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1037         $personsearch = true;
1038         $personsearchstring = $frm->combinedsearch;
1039     }
1041     // Search for person.
1042     if ($personsearch) {
1043         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1044             $users = array();
1045             $mycourses = enrol_get_my_courses();
1046             foreach ($mycourses as $mycourse) {
1047                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
1048                     foreach ($susers as $suser) $users[$suser->id] = $suser;
1049                 }
1050             }
1051         } else {
1052             $users = message_search_users(SITEID, $personsearchstring);
1053         }
1055         if (!empty($users)) {
1056             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1057             echo get_string('userssearchresults', 'message', count($users));
1058             echo html_writer::end_tag('p');
1060             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1061             foreach ($users as $user) {
1063                 if ( $user->contactlistid )  {
1064                     if ($user->blocked == 0) { // User is not blocked.
1065                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1066                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1067                     } else { // blocked
1068                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1069                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1070                     }
1071                 } else {
1072                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1073                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1074                 }
1076                 // Should we show just the icon or icon and text?
1077                 $histicontext = 'icon';
1078                 if ($showicontext) {
1079                     $histicontext = 'both';
1080                 }
1081                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1083                 echo html_writer::start_tag('tr');
1085                 echo html_writer::start_tag('td', array('class' => 'pix'));
1086                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1087                 echo html_writer::end_tag('td');
1089                 echo html_writer::start_tag('td',array('class' => 'contact'));
1090                 $action = null;
1091                 $link = new moodle_url("/message/index.php?id=$user->id");
1092                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1093                 echo html_writer::end_tag('td');
1095                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1096                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1097                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1099                 echo html_writer::end_tag('tr');
1100             }
1101             echo html_writer::end_tag('table');
1103         } else {
1104             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1105             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1106             echo html_writer::end_tag('p');
1107         }
1108     }
1110     // search messages for keywords
1111     $messagesearch = false;
1112     $messagesearchstring = null;
1113     if (!empty($frm->keywords)) {
1114         $messagesearch = true;
1115         $messagesearchstring = clean_text(trim($frm->keywords));
1116     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1117         $messagesearch = true;
1118         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1119     }
1121     if ($messagesearch) {
1122         if ($messagesearchstring) {
1123             $keywords = explode(' ', $messagesearchstring);
1124         } else {
1125             $keywords = array();
1126         }
1127         $tome     = false;
1128         $fromme   = false;
1129         $courseid = 'none';
1131         if (empty($frm->keywordsoption)) {
1132             $frm->keywordsoption = 'allmine';
1133         }
1135         switch ($frm->keywordsoption) {
1136             case 'tome':
1137                 $tome   = true;
1138                 break;
1139             case 'fromme':
1140                 $fromme = true;
1141                 break;
1142             case 'allmine':
1143                 $tome   = true;
1144                 $fromme = true;
1145                 break;
1146             case 'allusers':
1147                 $courseid = SITEID;
1148                 break;
1149             case 'courseusers':
1150                 $courseid = $frm->courseid;
1151                 break;
1152             default:
1153                 $tome   = true;
1154                 $fromme = true;
1155         }
1157         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1159             // Get a list of contacts.
1160             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1161                 $contacts = array();
1162             }
1164             // Print heading with number of results.
1165             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1166             $countresults = count($messages);
1167             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1168                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1169             } else {
1170                 echo get_string('keywordssearchresults', 'message', $countresults);
1171             }
1172             echo html_writer::end_tag('p');
1174             // Print table headings.
1175             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1177             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1178             $headertdend   = html_writer::end_tag('td');
1179             echo html_writer::start_tag('tr');
1180             echo $headertdstart.get_string('from').$headertdend;
1181             echo $headertdstart.get_string('to').$headertdend;
1182             echo $headertdstart.get_string('message', 'message').$headertdend;
1183             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1184             echo html_writer::end_tag('tr');
1186             $blockedcount = 0;
1187             $dateformat = get_string('strftimedatetimeshort');
1188             $strcontext = get_string('context', 'message');
1189             foreach ($messages as $message) {
1191                 // Ignore messages to and from blocked users unless $frm->includeblocked is set.
1192                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1193                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1194                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1195                                                 )
1196                    ) {
1197                     $blockedcount ++;
1198                     continue;
1199                 }
1201                 // Load user-to record.
1202                 if ($message->useridto !== $USER->id) {
1203                     $userto = $DB->get_record('user', array('id' => $message->useridto));
1204                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1205                                     ($contacts[$message->useridto]->blocked == 0) );
1206                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1207                                     ($contacts[$message->useridto]->blocked == 1) );
1208                 } else {
1209                     $userto = false;
1210                     $tocontact = false;
1211                     $toblocked = false;
1212                 }
1214                 // Load user-from record.
1215                 if ($message->useridfrom !== $USER->id) {
1216                     $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
1217                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1218                                     ($contacts[$message->useridfrom]->blocked == 0) );
1219                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1220                                     ($contacts[$message->useridfrom]->blocked == 1) );
1221                 } else {
1222                     $userfrom = false;
1223                     $fromcontact = false;
1224                     $fromblocked = false;
1225                 }
1227                 // Find date string for this message.
1228                 $date = usergetdate($message->timecreated);
1229                 $datestring = $date['year'].$date['mon'].$date['mday'];
1231                 // Print out message row.
1232                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1234                 echo html_writer::start_tag('td', array('class' => 'contact'));
1235                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1236                 echo html_writer::end_tag('td');
1238                 echo html_writer::start_tag('td', array('class' => 'contact'));
1239                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1240                 echo html_writer::end_tag('td');
1242                 echo html_writer::start_tag('td', array('class' => 'summary'));
1243                 echo message_get_fragment($message->smallmessage, $keywords);
1244                 echo html_writer::start_tag('div', array('class' => 'link'));
1246                 // If the user clicks the context link display message sender on the left.
1247                 // EXCEPT if the current user is in the conversation. Current user == always on the left.
1248                 $leftsideuserid = $rightsideuserid = null;
1249                 if ($currentuser->id == $message->useridto) {
1250                     $leftsideuserid = $message->useridto;
1251                     $rightsideuserid = $message->useridfrom;
1252                 } else {
1253                     $leftsideuserid = $message->useridfrom;
1254                     $rightsideuserid = $message->useridto;
1255                 }
1256                 message_history_link($leftsideuserid, $rightsideuserid, false,
1257                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1258                 echo html_writer::end_tag('div');
1259                 echo html_writer::end_tag('td');
1261                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1263                 echo html_writer::end_tag('tr');
1264             }
1267             if ($blockedcount > 0) {
1268                 echo html_writer::start_tag('tr');
1269                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1270                 echo html_writer::end_tag('tr');
1271             }
1272             echo html_writer::end_tag('table');
1274         } else {
1275             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1276         }
1277     }
1279     if (!$personsearch && !$messagesearch) {
1280         //they didn't enter any search terms
1281         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1282     }
1284     echo html_writer::end_tag('div');
1287 /**
1288  * Print information on a user. Used when printing search results.
1289  *
1290  * @param object/bool $user the user to display or false if you just want $USER
1291  * @param bool $iscontact is the user being displayed a contact?
1292  * @param bool $isblocked is the user being displayed blocked?
1293  * @param bool $includeicontext include text next to the action icons?
1294  * @return void
1295  */
1296 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1297     global $USER, $OUTPUT;
1299     if ($user === false) {
1300         echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
1301     } else {
1302         echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1303         echo '&nbsp;';
1305         $return = false;
1306         $script = null;
1307         if ($iscontact) {
1308             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1309         } else {
1310             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1311         }
1312         echo '&nbsp;';
1313         if ($isblocked) {
1314             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1315         } else {
1316             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1317         }
1319         $popupoptions = array(
1320                 'height' => MESSAGE_DISCUSSION_HEIGHT,
1321                 'width' => MESSAGE_DISCUSSION_WIDTH,
1322                 'menubar' => false,
1323                 'location' => false,
1324                 'status' => true,
1325                 'scrollbars' => true,
1326                 'resizable' => true);
1328         $link = new moodle_url("/message/index.php?id=$user->id");
1329         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
1330         $action = null;
1331         echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1333     }
1336 /**
1337  * Print a message contact link
1338  *
1339  * @param int $userid the ID of the user to apply to action to
1340  * @param string $linktype can be add, remove, block or unblock
1341  * @param bool $return if true return the link as a string. If false echo the link.
1342  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1343  * @param bool $text include text next to the icons?
1344  * @param bool $icon include a graphical icon?
1345  * @return string  if $return is true otherwise bool
1346  */
1347 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1348     global $OUTPUT, $PAGE;
1350     //hold onto the strings as we're probably creating a bunch of links
1351     static $str;
1353     if (empty($script)) {
1354         //strip off previous action params like 'removecontact'
1355         $script = message_remove_url_params($PAGE->url);
1356     }
1358     if (empty($str->blockcontact)) {
1359        $str = new stdClass();
1360        $str->blockcontact   =  get_string('blockcontact', 'message');
1361        $str->unblockcontact =  get_string('unblockcontact', 'message');
1362        $str->removecontact  =  get_string('removecontact', 'message');
1363        $str->addcontact     =  get_string('addcontact', 'message');
1364     }
1366     $command = $linktype.'contact';
1367     $string  = $str->{$command};
1369     $safealttext = s($string);
1371     $safestring = '';
1372     if (!empty($text)) {
1373         $safestring = $safealttext;
1374     }
1376     $img = '';
1377     if ($icon) {
1378         $iconpath = null;
1379         switch ($linktype) {
1380             case 'block':
1381                 $iconpath = 't/block';
1382                 break;
1383             case 'unblock':
1384                 $iconpath = 't/userblue';
1385                 break;
1386             case 'remove':
1387                 $iconpath = 'i/cross_red_big';
1388                 break;
1389             case 'add':
1390             default:
1391                 $iconpath = 't/addgreen';
1392         }
1394         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1395     }
1397     $output = '<span class="'.$linktype.'contact">'.
1398               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1399               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1400               $img.
1401               $safestring.'</a></span>';
1403     if ($return) {
1404         return $output;
1405     } else {
1406         echo $output;
1407         return true;
1408     }
1411 /**
1412  * echo or return a link to take the user to the full message history between themselves and another user
1413  *
1414  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
1415  * @param int $userid2 the ID of the other user
1416  * @param bool $return true to return the link as a string. False to echo the link.
1417  * @param string $keywords any keywords to highlight in the message history
1418  * @param string $position anchor name to jump to within the message history
1419  * @param string $linktext optionally specify the link text
1420  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1421  */
1422 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1423     global $OUTPUT;
1424     static $strmessagehistory;
1426     if (empty($strmessagehistory)) {
1427         $strmessagehistory = get_string('messagehistory', 'message');
1428     }
1430     if ($position) {
1431         $position = "#$position";
1432     }
1433     if ($keywords) {
1434         $keywords = "&search=".urlencode($keywords);
1435     }
1437     if ($linktext == 'icon') {  // Icon only
1438         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1439     } else if ($linktext == 'both') {  // Icon and standard name
1440         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1441         $fulllink .= '&nbsp;'.$strmessagehistory;
1442     } else if ($linktext) {    // Custom name
1443         $fulllink = $linktext;
1444     } else {                   // Standard name only
1445         $fulllink = $strmessagehistory;
1446     }
1448     $popupoptions = array(
1449             'height' => 500,
1450             'width' => 500,
1451             'menubar' => false,
1452             'location' => false,
1453             'status' => true,
1454             'scrollbars' => true,
1455             'resizable' => true);
1457     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
1458     $action = null;
1459     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1461     $str = '<span class="history">'.$str.'</span>';
1463     if ($return) {
1464         return $str;
1465     } else {
1466         echo $str;
1467         return true;
1468     }
1472 /**
1473  * Search through course users
1474  *
1475  * If $coursid specifies the site course then this function searches
1476  * through all undeleted and confirmed users
1477  * @param int $courseid The course in question.
1478  * @param string $searchtext the text to search for
1479  * @param string $sort the column name to order by
1480  * @param string $exceptions comma separated list of user IDs to exclude
1481  * @return array  An array of {@link $USER} records.
1482  */
1483 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1484     global $CFG, $USER, $DB;
1486     $fullname = $DB->sql_fullname();
1488     if (!empty($exceptions)) {
1489         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1490     } else {
1491         $except = '';
1492     }
1494     if (!empty($sort)) {
1495         $order = ' ORDER BY '. $sort;
1496     } else {
1497         $order = '';
1498     }
1500     $ufields = user_picture::fields('u');
1501     if (!$courseid or $courseid == SITEID) {
1502         $params = array($USER->id, "%$searchtext%");
1503         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1504                                        FROM {user} u
1505                                        LEFT JOIN {message_contacts} mc
1506                                             ON mc.contactid = u.id AND mc.userid = ?
1507                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1508                                             AND (".$DB->sql_like($fullname, '?', false).")
1509                                             $except
1510                                      $order", $params);
1511     } else {
1512 //TODO: add enabled enrolment join here (skodak)
1513         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1514         $contextlists = get_related_contexts_string($context);
1516         // everyone who has a role assignment in this course or higher
1517         $params = array($USER->id, "%$searchtext%");
1518         $users = $DB->get_records_sql("SELECT DISTINCT $ufields, mc.id as contactlistid, mc.blocked
1519                                          FROM {user} u
1520                                          JOIN {role_assignments} ra ON ra.userid = u.id
1521                                          LEFT JOIN {message_contacts} mc
1522                                               ON mc.contactid = u.id AND mc.userid = ?
1523                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1524                                               AND ra.contextid $contextlists
1525                                               AND (".$DB->sql_like($fullname, '?', false).")
1526                                               $except
1527                                        $order", $params);
1529         return $users;
1530     }
1533 /**
1534  * Search a user's messages
1535  *
1536  * Returns a list of posts found using an array of search terms
1537  * eg   word  +word -word
1538  *
1539  * @param array $searchterms an array of search terms (strings)
1540  * @param bool $fromme include messages from the user?
1541  * @param bool $tome include messages to the user?
1542  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1543  * @param int $userid the user ID of the current user
1544  * @return mixed An array of messages or false if no matching messages were found
1545  */
1546 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1547     global $CFG, $USER, $DB;
1549     // If user is searching all messages check they are allowed to before doing anything else
1550     if ($courseid == SITEID && !has_capability('moodle/site:readallmessages', get_context_instance(CONTEXT_SYSTEM))) {
1551         print_error('accessdenied','admin');
1552     }
1554     // If no userid sent then assume current user.
1555     if ($userid == 0) $userid = $USER->id;
1557     // Some differences in SQL syntax.
1558     if ($DB->sql_regex_supported()) {
1559         $REGEXP    = $DB->sql_regex(true);
1560         $NOTREGEXP = $DB->sql_regex(false);
1561     }
1563     $searchcond = array();
1564     $params = array();
1565     $i = 0;
1567     // Preprocess search terms to check whether we have at least 1 eligible search term.
1568     // If we do we can drop words around it like 'a'.
1569     $dropshortwords = false;
1570     foreach ($searchterms as $searchterm) {
1571         if (strlen($searchterm) >= 2) {
1572             $dropshortwords = true;
1573         }
1574     }
1576     foreach ($searchterms as $searchterm) {
1577         $i++;
1579         $NOT = false; // Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle.
1581         if ($dropshortwords && strlen($searchterm) < 2) {
1582             continue;
1583         }
1584         // Under Oracle and MSSQL, trim the + and - operators and perform simpler LIKE search.
1585         if (!$DB->sql_regex_supported()) {
1586             if (substr($searchterm, 0, 1) == '-') {
1587                 $NOT = true;
1588             }
1589             $searchterm = trim($searchterm, '+-');
1590         }
1592         if (substr($searchterm,0,1) == "+") {
1593             $searchterm = substr($searchterm,1);
1594             $searchterm = preg_quote($searchterm, '|');
1595             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1596             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1598         } else if (substr($searchterm,0,1) == "-") {
1599             $searchterm = substr($searchterm,1);
1600             $searchterm = preg_quote($searchterm, '|');
1601             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1602             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1604         } else {
1605             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1606             $params['ss'.$i] = "%$searchterm%";
1607         }
1608     }
1610     if (empty($searchcond)) {
1611         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1612         $params['ss1'] = "%";
1613     } else {
1614         $searchcond = implode(" AND ", $searchcond);
1615     }
1617     // There are several possibilities
1618     // 1. courseid = SITEID : The admin is searching messages by all users
1619     // 2. courseid = ??     : A teacher is searching messages by users in
1620     //                        one of their courses - currently disabled
1621     // 3. courseid = none   : User is searching their own messages;
1622     //    a.  Messages from user
1623     //    b.  Messages to user
1624     //    c.  Messages to and from user
1626     if ($courseid == SITEID) { // Admin is searching all messages.
1627         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1628                                             FROM {message_read} m
1629                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1630         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1631                                             FROM {message} m
1632                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1634     } else if ($courseid !== 'none') {
1635         // This has not been implemented due to security concerns.
1636         $m_read   = array();
1637         $m_unread = array();
1639     } else {
1641         if ($fromme and $tome) {
1642             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1643             $params['userid1'] = $userid;
1644             $params['userid2'] = $userid;
1646         } else if ($fromme) {
1647             $searchcond .= " AND m.useridfrom=:userid";
1648             $params['userid'] = $userid;
1650         } else if ($tome) {
1651             $searchcond .= " AND m.useridto=:userid";
1652             $params['userid'] = $userid;
1653         }
1655         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1656                                             FROM {message_read} m
1657                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1658         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.smallmessage, m.fullmessage, m.timecreated
1659                                             FROM {message} m
1660                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1662     }
1664     /// The keys may be duplicated in $m_read and $m_unread so we can't
1665     /// do a simple concatenation
1666     $messages = array();
1667     foreach ($m_read as $m) {
1668         $messages[] = $m;
1669     }
1670     foreach ($m_unread as $m) {
1671         $messages[] = $m;
1672     }
1674     return (empty($messages)) ? false : $messages;
1677 /**
1678  * Given a message object that we already know has a long message
1679  * this function truncates the message nicely to the first
1680  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1681  *
1682  * @param string $message the message
1683  * @param int $minlength the minimum length to trim the message to
1684  * @return string the shortened message
1685  */
1686 function message_shorten_message($message, $minlength = 0) {
1687     $i = 0;
1688     $tag = false;
1689     $length = strlen($message);
1690     $count = 0;
1691     $stopzone = false;
1692     $truncate = 0;
1693     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1696     for ($i=0; $i<$length; $i++) {
1697         $char = $message[$i];
1699         switch ($char) {
1700             case "<":
1701                 $tag = true;
1702                 break;
1703             case ">":
1704                 $tag = false;
1705                 break;
1706             default:
1707                 if (!$tag) {
1708                     if ($stopzone) {
1709                         if ($char == '.' or $char == ' ') {
1710                             $truncate = $i+1;
1711                             break 2;
1712                         }
1713                     }
1714                     $count++;
1715                 }
1716                 break;
1717         }
1718         if (!$stopzone) {
1719             if ($count > $minlength) {
1720                 $stopzone = true;
1721             }
1722         }
1723     }
1725     if (!$truncate) {
1726         $truncate = $i;
1727     }
1729     return substr($message, 0, $truncate);
1733 /**
1734  * Given a string and an array of keywords, this function looks
1735  * for the first keyword in the string, and then chops out a
1736  * small section from the text that shows that word in context.
1737  *
1738  * @param string $message the text to search
1739  * @param array $keywords array of keywords to find
1740  */
1741 function message_get_fragment($message, $keywords) {
1743     $fullsize = 160;
1744     $halfsize = (int)($fullsize/2);
1746     $message = strip_tags($message);
1748     foreach ($keywords as $keyword) {  // Just get the first one
1749         if ($keyword !== '') {
1750             break;
1751         }
1752     }
1753     if (empty($keyword)) {   // None found, so just return start of message
1754         return message_shorten_message($message, 30);
1755     }
1757     $leadin = $leadout = '';
1759 /// Find the start of the fragment
1760     $start = 0;
1761     $length = strlen($message);
1763     $pos = strpos($message, $keyword);
1764     if ($pos > $halfsize) {
1765         $start = $pos - $halfsize;
1766         $leadin = '...';
1767     }
1768 /// Find the end of the fragment
1769     $end = $start + $fullsize;
1770     if ($end > $length) {
1771         $end = $length;
1772     } else {
1773         $leadout = '...';
1774     }
1776 /// Pull out the fragment and format it
1778     $fragment = substr($message, $start, $end - $start);
1779     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1780     return $fragment;
1783 /**
1784  * Retrieve the messages between two users
1785  *
1786  * @param object $user1 the current user
1787  * @param object $user2 the other user
1788  * @param int $limitnum the maximum number of messages to retrieve
1789  * @param bool $viewingnewmessages are we currently viewing new messages?
1790  */
1791 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1792     global $DB, $CFG;
1794     $messages = array();
1796     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1797     //desc to get the last $limitnum messages then flip the order in php
1798     $sort = 'asc';
1799     if ($limitnum>0) {
1800         $sort = 'desc';
1801     }
1803     $notificationswhere = null;
1804     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1805     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1806         $notificationswhere = 'AND notification=0';
1807     }
1809     //prevent notifications of your own actions appearing in your own message history
1810     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1812     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1813                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1814                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1815                                                     "timecreated $sort", '*', 0, $limitnum)) {
1816         foreach ($messages_read as $message) {
1817             $messages[] = $message;
1818         }
1819     }
1820     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1821                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1822                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1823                                                     "timecreated $sort", '*', 0, $limitnum)) {
1824         foreach ($messages_new as $message) {
1825             $messages[] = $message;
1826         }
1827     }
1829     $result = collatorlib::asort_objects_by_property($messages, 'timecreated', collatorlib::SORT_NUMERIC);
1831     //if we only want the last $limitnum messages
1832     $messagecount = count($messages);
1833     if ($limitnum > 0 && $messagecount > $limitnum) {
1834         $messages = array_slice($messages, $messagecount - $limitnum, $limitnum, true);
1835     }
1837     return $messages;
1840 /**
1841  * Print the message history between two users
1842  *
1843  * @param object $user1 the current user
1844  * @param object $user2 the other user
1845  * @param string $search search terms to highlight
1846  * @param int $messagelimit maximum number of messages to return
1847  * @param string $messagehistorylink the html for the message history link or false
1848  * @param bool $viewingnewmessages are we currently viewing new messages?
1849  */
1850 function message_print_message_history($user1, $user2 ,$search = '', $messagelimit = 0, $messagehistorylink = false, $viewingnewmessages = false, $showactionlinks = true) {
1851     global $CFG, $OUTPUT;
1853     echo $OUTPUT->box_start('center');
1854     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1855     echo html_writer::start_tag('tr');
1857     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1858     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1859     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1860     echo html_writer::end_tag('td');
1862     echo html_writer::start_tag('td', array('align' => 'center'));
1863     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/left'), 'alt' => get_string('from')));
1864     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/right'), 'alt' => get_string('to')));
1865     echo html_writer::end_tag('td');
1867     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
1868     echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
1869     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
1871     if ($showactionlinks && isset($user2->iscontact) && isset($user2->isblocked)) {
1873         $script = null;
1874         $text = true;
1875         $icon = false;
1877         $strcontact = message_get_contact_add_remove_link($user2->iscontact, $user2->isblocked, $user2, $script, $text, $icon);
1878         $strblock   = message_get_contact_block_link($user2->iscontact, $user2->isblocked, $user2, $script, $text, $icon);
1879         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1881         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
1882     }
1884     echo html_writer::end_tag('td');
1885     echo html_writer::end_tag('tr');
1886     echo html_writer::end_tag('table');
1887     echo $OUTPUT->box_end();
1889     if (!empty($messagehistorylink)) {
1890         echo $messagehistorylink;
1891     }
1893     /// Get all the messages and print them
1894     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1895         $tablecontents = '';
1897         $current = new stdClass();
1898         $current->mday = '';
1899         $current->month = '';
1900         $current->year = '';
1901         $messagedate = get_string('strftimetime');
1902         $blockdate   = get_string('strftimedaydate');
1903         foreach ($messages as $message) {
1904             if ($message->notification) {
1905                 $notificationclass = ' notification';
1906             } else {
1907                 $notificationclass = null;
1908             }
1909             $date = usergetdate($message->timecreated);
1910             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1911                 $current->mday = $date['mday'];
1912                 $current->month = $date['month'];
1913                 $current->year = $date['year'];
1915                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
1916                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
1918                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
1919             }
1921             $formatted_message = $side = null;
1922             if ($message->useridfrom == $user1->id) {
1923                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
1924                 $side = 'left';
1925             } else {
1926                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
1927                 $side = 'right';
1928             }
1929             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
1930         }
1932         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
1933     } else {
1934         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
1935     }
1938 /**
1939  * Format a message for display in the message history
1940  *
1941  * @param object $message the message object
1942  * @param string $format optional date format
1943  * @param string $keywords keywords to highlight
1944  * @param string $class CSS class to apply to the div around the message
1945  * @return string the formatted message
1946  */
1947 function message_format_message($message, $format='', $keywords='', $class='other') {
1949     static $dateformat;
1951     //if we haven't previously set the date format or they've supplied a new one
1952     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1953         if ($format) {
1954             $dateformat = $format;
1955         } else {
1956             $dateformat = get_string('strftimedatetimeshort');
1957         }
1958     }
1959     $time = userdate($message->timecreated, $dateformat);
1960     $options = new stdClass();
1961     $options->para = false;
1963     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1964     if (!empty($message->smallmessage)) {
1965         $messagetext = $message->smallmessage;
1966     } else {
1967         $messagetext = $message->fullmessage;
1968     }
1969     if ($message->fullmessageformat == FORMAT_HTML) {
1970         //dont escape html tags by calling s() if html format or they will display in the UI
1971         $messagetext = html_to_text(format_text($messagetext, $message->fullmessageformat, $options));
1972     } else {
1973         $messagetext = format_text(s($messagetext), $message->fullmessageformat, $options);
1974     }
1976     $messagetext .= message_format_contexturl($message);
1978     if ($keywords) {
1979         $messagetext = highlight($keywords, $messagetext);
1980     }
1982     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1985 /**
1986  * Format a the context url and context url name of a message for display
1987  *
1988  * @param object $message the message object
1989  * @return string the formatted string
1990  */
1991 function message_format_contexturl($message) {
1992     $s = null;
1994     if (!empty($message->contexturl)) {
1995         $displaytext = null;
1996         if (!empty($message->contexturlname)) {
1997             $displaytext= $message->contexturlname;
1998         } else {
1999             $displaytext= $message->contexturl;
2000         }
2001         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
2002             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
2003         $s .= html_writer::end_tag('div');
2004     }
2006     return $s;
2009 /**
2010  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
2011  *
2012  * @param object $userfrom the message sender
2013  * @param object $userto the message recipient
2014  * @param string $message the message
2015  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
2016  * @return int|false the ID of the new message or false
2017  */
2018 function message_post_message($userfrom, $userto, $message, $format) {
2019     global $SITE, $CFG, $USER;
2021     $eventdata = new stdClass();
2022     $eventdata->component        = 'moodle';
2023     $eventdata->name             = 'instantmessage';
2024     $eventdata->userfrom         = $userfrom;
2025     $eventdata->userto           = $userto;
2027     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
2028     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
2030     if ($format == FORMAT_HTML) {
2031         $eventdata->fullmessagehtml  = $message;
2032         //some message processors may revert to sending plain text even if html is supplied
2033         //so we keep both plain and html versions if we're intending to send html
2034         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
2035     } else {
2036         $eventdata->fullmessage      = $message;
2037         $eventdata->fullmessagehtml  = '';
2038     }
2040     $eventdata->fullmessageformat = $format;
2041     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
2043     $s = new stdClass();
2044     $s->sitename = format_string($SITE->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
2045     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
2047     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
2048     if (!empty($eventdata->fullmessage)) {
2049         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
2050     }
2051     if (!empty($eventdata->fullmessagehtml)) {
2052         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
2053     }
2055     $eventdata->timecreated     = time();
2056     return message_send($eventdata);
2059 /**
2060  * Print a row of contactlist displaying user picture, messages waiting and
2061  * block links etc
2062  *
2063  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2064  * @param bool $incontactlist is the user a contact of ours?
2065  * @param bool $isblocked is the user blocked?
2066  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2067  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2068  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2069  * @return void
2070  */
2071 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2072     global $OUTPUT, $USER;
2073     $fullname  = fullname($contact);
2074     $fullnamelink  = $fullname;
2076     $linkclass = '';
2077     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2078         $linkclass = 'messageselecteduser';
2079     }
2081     // Are there any unread messages for this contact?
2082     if ($contact->messagecount > 0 ){
2083         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2084     }
2086     $strcontact = $strblock = $strhistory = null;
2088     if ($showactionlinks) {
2089         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2090         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2091         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2092     }
2094     echo html_writer::start_tag('tr');
2095     echo html_writer::start_tag('td', array('class' => 'pix'));
2096     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => SITEID));
2097     echo html_writer::end_tag('td');
2099     echo html_writer::start_tag('td', array('class' => 'contact'));
2101     $popupoptions = array(
2102             'height' => MESSAGE_DISCUSSION_HEIGHT,
2103             'width' => MESSAGE_DISCUSSION_WIDTH,
2104             'menubar' => false,
2105             'location' => false,
2106             'status' => true,
2107             'scrollbars' => true,
2108             'resizable' => true);
2110     $link = $action = null;
2111     if (!empty($selectcontacturl)) {
2112         $link = new moodle_url($selectcontacturl.'&user2='.$contact->id);
2113     } else {
2114         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2115         $link = new moodle_url("/message/index.php?id=$contact->id");
2116         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2117     }
2118     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2120     echo html_writer::end_tag('td');
2122     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2124     echo html_writer::end_tag('tr');
2127 /**
2128  * Constructs the add/remove contact link to display next to other users
2129  *
2130  * @param bool $incontactlist is the user a contact
2131  * @param bool $isblocked is the user blocked
2132  * @param stdClass $contact contact object
2133  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2134  * @param bool $text include text next to the icons?
2135  * @param bool $icon include a graphical icon?
2136  * @return string
2137  */
2138 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2139     $strcontact = '';
2141     if($incontactlist){
2142         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2143     } else if ($isblocked) {
2144         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2145     } else{
2146         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2147     }
2149     return $strcontact;
2152 /**
2153  * Constructs the block contact link to display next to other users
2154  *
2155  * @param bool $incontactlist is the user a contact?
2156  * @param bool $isblocked is the user blocked?
2157  * @param stdClass $contact contact object
2158  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2159  * @param bool $text include text next to the icons?
2160  * @param bool $icon include a graphical icon?
2161  * @return string
2162  */
2163 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2164     $strblock   = '';
2166     //commented out to allow the user to block a contact without having to remove them first
2167     /*if ($incontactlist) {
2168         //$strblock = '';
2169     } else*/
2170     if ($isblocked) {
2171         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2172     } else{
2173         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2174     }
2176     return $strblock;
2179 /**
2180  * Moves messages from a particular user from the message table (unread messages) to message_read
2181  * This is typically only used when a user is deleted
2182  *
2183  * @param object $userid User id
2184  * @return boolean success
2185  */
2186 function message_move_userfrom_unread2read($userid) {
2187     global $DB;
2189     // move all unread messages from message table to message_read
2190     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2191         foreach ($messages as $message) {
2192             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2193         }
2194     }
2195     return true;
2198 /**
2199  * marks ALL messages being sent from $fromuserid to $touserid as read
2200  *
2201  * @param int $touserid the id of the message recipient
2202  * @param int $fromuserid the id of the message sender
2203  * @return void
2204  */
2205 function message_mark_messages_read($touserid, $fromuserid){
2206     global $DB;
2208     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2209     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2211     foreach ($messages as $message) {
2212         message_mark_message_read($message, time());
2213     }
2215     $messages->close();
2218 /**
2219  * Mark a single message as read
2220  *
2221  * @param stdClass $message An object with an object property ie $message->id which is an id in the message table
2222  * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2223  * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2224  * @return int the ID of the message in the message_read table
2225  */
2226 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2227     global $DB;
2229     $message->timeread = $timeread;
2231     $messageid = $message->id;
2232     unset($message->id);//unset because it will get a new id on insert into message_read
2234     //If any processors have pending actions abort them
2235     if (!$messageworkingempty) {
2236         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2237     }
2238     $messagereadid = $DB->insert_record('message_read', $message);
2239     $DB->delete_records('message', array('id' => $messageid));
2240     return $messagereadid;
2243 /**
2244  * A helper function that prints a formatted heading
2245  *
2246  * @param string $title the heading to display
2247  * @param int $colspan
2248  * @return void
2249  */
2250 function message_print_heading($title, $colspan=3) {
2251     echo html_writer::start_tag('tr');
2252     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2253     echo html_writer::end_tag('tr');
2256 /**
2257  * Get all message processors, validate corresponding plugin existance and
2258  * system configuration
2259  *
2260  * @param bool $ready only return ready-to-use processors
2261  * @return mixed $processors array of objects containing information on message processors
2262  */
2263 function get_message_processors($ready = false) {
2264     global $DB, $CFG;
2266     static $processors;
2268     if (empty($processors)) {
2269         // Get all processors, ensure the name column is the first so it will be the array key
2270         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
2271         foreach ($processors as &$processor){
2272             $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2273             if (is_readable($processorfile)) {
2274                 include_once($processorfile);
2275                 $processclass = 'message_output_' . $processor->name;
2276                 if (class_exists($processclass)) {
2277                     $pclass = new $processclass();
2278                     $processor->object = $pclass;
2279                     $processor->configured = 0;
2280                     if ($pclass->is_system_configured()) {
2281                         $processor->configured = 1;
2282                     }
2283                     $processor->hassettings = 0;
2284                     if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2285                         $processor->hassettings = 1;
2286                     }
2287                     $processor->available = 1;
2288                 } else {
2289                     print_error('errorcallingprocessor', 'message');
2290                 }
2291             } else {
2292                 $processor->available = 0;
2293             }
2294         }
2295     }
2296     if ($ready) {
2297         // Filter out enabled and system_configured processors
2298         $readyprocessors = $processors;
2299         foreach ($readyprocessors as $readyprocessor) {
2300             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
2301                 unset($readyprocessors[$readyprocessor->name]);
2302             }
2303         }
2304         return $readyprocessors;
2305     }
2307     return $processors;
2310 /**
2311  * Get all message providers, validate their plugin existance and
2312  * system configuration
2313  *
2314  * @return mixed $processors array of objects containing information on message processors
2315  */
2316 function get_message_providers() {
2317     global $CFG, $DB;
2318     require_once($CFG->libdir . '/pluginlib.php');
2319     $pluginman = plugin_manager::instance();
2321     $providers = $DB->get_records('message_providers', null, 'name');
2323     // Remove all the providers whose plugins are disabled or don't exist
2324     foreach ($providers as $providerid => $provider) {
2325         $plugin = $pluginman->get_plugin_info($provider->component);
2326         if ($plugin) {
2327             if ($plugin->get_status() === plugin_manager::PLUGIN_STATUS_MISSING) {
2328                 unset($providers[$providerid]);   // Plugins does not exist
2329                 continue;
2330             }
2331             if ($plugin->is_enabled() === false) {
2332                 unset($providers[$providerid]);   // Plugin disabled
2333                 continue;
2334             }
2335         }
2336     }
2337     return $providers;
2340 /**
2341  * Get an instance of the message_output class for one of the output plugins.
2342  * @param string $type the message output type. E.g. 'email' or 'jabber'.
2343  * @return message_output message_output the requested class.
2344  */
2345 function get_message_processor($type) {
2346     global $CFG;
2348     // Note, we cannot use the get_message_processors function here, becaues this
2349     // code is called during install after installing each messaging plugin, and
2350     // get_message_processors caches the list of installed plugins.
2352     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
2353     if (!is_readable($processorfile)) {
2354         throw new coding_exception('Unknown message processor type ' . $type);
2355     }
2357     include_once($processorfile);
2359     $processclass = 'message_output_' . $type;
2360     if (!class_exists($processclass)) {
2361         throw new coding_exception('Message processor ' . $type .
2362                 ' does not define the right class');
2363     }
2365     return new $processclass();
2368 /**
2369  * Get messaging outputs default (site) preferences
2370  *
2371  * @return object $processors object containing information on message processors
2372  */
2373 function get_message_output_default_preferences() {
2374     return get_config('message');
2377 /**
2378  * Translate message default settings from binary value to the array of string
2379  * representing the settings to be stored. Also validate the provided value and
2380  * use default if it is malformed.
2381  *
2382  * @param  int    $plugindefault Default setting suggested by plugin
2383  * @param  string $processorname The name of processor
2384  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
2385  */
2386 function translate_message_default_setting($plugindefault, $processorname) {
2387     // Preset translation arrays
2388     $permittedvalues = array(
2389         0x04 => 'disallowed',
2390         0x08 => 'permitted',
2391         0x0c => 'forced',
2392     );
2394     $loggedinstatusvalues = array(
2395         0x00 => null, // use null if loggedin/loggedoff is not defined
2396         0x01 => 'loggedin',
2397         0x02 => 'loggedoff',
2398     );
2400     // define the default setting
2401     $processor = get_message_processor($processorname);
2402     $default = $processor->get_default_messaging_settings();
2404     // Validate the value. It should not exceed the maximum size
2405     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
2406         debugging(get_string('errortranslatingdefault', 'message'));
2407         $plugindefault = $default;
2408     }
2409     // Use plugin default setting of 'permitted' is 0
2410     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
2411         $plugindefault = $default;
2412     }
2414     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
2415     $loggedin = $loggedoff = null;
2417     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
2418         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
2419         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
2420     }
2422     return array($permitted, $loggedin, $loggedoff);
2425 /**
2426  * Return a list of page types
2427  * @param string $pagetype current page type
2428  * @param stdClass $parentcontext Block's parent context
2429  * @param stdClass $currentcontext Current context of block
2430  */
2431 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
2432     return array('messages-*'=>get_string('page-message-x', 'message'));
2435 /**
2436  * Is $USER one of the supplied users?
2437  *
2438  * $user2 will be null if viewing a user's recent conversations
2439  *
2440  * @param stdClass the first user
2441  * @param stdClass the second user or null
2442  * @return bool True if the current user is one of either $user1 or $user2
2443  */
2444 function message_current_user_is_involved($user1, $user2) {
2445     global $USER;
2447     if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2448         throw new coding_exception('Invalid user object detected. Missing id.');
2449     }
2451     if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2452         return false;
2453     }
2454     return true;