c71f62cd8b078674c88e91e4db654fa12df341d1
[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 //TODO: defaults must be initialised via settings - this is a bad hack! (skodak)
81 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
82     $CFG->message_contacts_refresh = 60;
83 }
84 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
85     $CFG->message_chat_refresh = 5;
86 }
87 if (!isset($CFG->message_offline_time)) {
88     $CFG->message_offline_time = 300;
89 }
91 /**
92  * Print the selector that allows the user to view their contacts, course participants, their recent
93  * conversations etc
94  *
95  * @param int $countunreadtotal how many unread messages does the user have?
96  * @param int $viewing What is the user viewing? ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_SEARCH etc
97  * @param object $user1 the user whose messages are being viewed
98  * @param object $user2 the user $user1 is talking to
99  * @param array $blockedusers an array of users blocked by $user1
100  * @param array $onlinecontacts an array of $user1's online contacts
101  * @param array $offlinecontacts an array of $user1's offline contacts
102  * @param array $strangers an array of users who have messaged $user1 who aren't contacts
103  * @param bool $showcontactactionlinks show action links (add/remove contact etc) next to the users in the contact selector
104  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
105  * @return void
106  */
107 function message_print_contact_selector($countunreadtotal, $viewing, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
108     global $PAGE;
110     echo html_writer::start_tag('div', array('class' => 'contactselector mdl-align'));
112     //if 0 unread messages and they've requested unread messages then show contacts
113     if ($countunreadtotal == 0 && $viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
114         $viewing = MESSAGE_VIEW_CONTACTS;
115     }
117     //if they have no blocked users and they've requested blocked users switch them over to contacts
118     if (count($blockedusers) == 0 && $viewing == MESSAGE_VIEW_BLOCKED) {
119         $viewing = MESSAGE_VIEW_CONTACTS;
120     }
122     $onlyactivecourses = true;
123     $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
124     $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
126     $strunreadmessages = null;
127     if ($countunreadtotal>0) { //if there are unread messages
128         $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
129     }
131     message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
133     if ($viewing == MESSAGE_VIEW_UNREAD_MESSAGES) {
134         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
135     } else if ($viewing == MESSAGE_VIEW_CONTACTS || $viewing == MESSAGE_VIEW_SEARCH || $viewing == MESSAGE_VIEW_RECENT_CONVERSATIONS || $viewing == MESSAGE_VIEW_RECENT_NOTIFICATIONS) {
136         message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
137     } else if ($viewing == MESSAGE_VIEW_BLOCKED) {
138         message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
139     } else if (substr($viewing, 0, 7) == MESSAGE_VIEW_COURSE) {
140         $courseidtoshow = intval(substr($viewing, 7));
142         if (!empty($courseidtoshow)
143             && array_key_exists($courseidtoshow, $coursecontexts)
144             && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
146             message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
147         } else {
148             //shouldn't get here. User trying to access a course they're not in perhaps.
149             add_to_log(SITEID, 'message', 'view', 'index.php', $viewing);
150         }
151     }
153     echo html_writer::start_tag('form', array('action' => 'index.php','method' => 'GET'));
154     echo html_writer::start_tag('fieldset');
155     $managebuttonclass = 'visible';
156     if ($viewing == MESSAGE_VIEW_SEARCH) {
157         $managebuttonclass = 'hiddenelement';
158     }
159     $strmanagecontacts = get_string('search','message');
160     echo html_writer::empty_tag('input', array('type' => 'hidden','name' => 'viewing','value' => MESSAGE_VIEW_SEARCH));
161     echo html_writer::empty_tag('input', array('type' => 'submit','value' => $strmanagecontacts,'class' => $managebuttonclass));
162     echo html_writer::end_tag('fieldset');
163     echo html_writer::end_tag('form');
165     echo html_writer::end_tag('div');
168 /**
169  * Print course participants. Called by message_print_contact_selector()
170  *
171  * @param object $context the course context
172  * @param int $courseid the course ID
173  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
174  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
175  * @param string $titletodisplay Optionally specify a title to display above the participants
176  * @param int $page if there are so many users listed that they have to be split into pages what page are we viewing
177  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of participants
178  * @return void
179  */
180 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
181     global $DB, $USER, $PAGE, $OUTPUT;
183     if (empty($titletodisplay)) {
184         $titletodisplay = get_string('participants');
185     }
187     $countparticipants = count_enrolled_users($context);
188     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
190     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
191     echo $OUTPUT->render($pagingbar);
193     echo html_writer::start_tag('table', array('id' => 'message_participants', 'class' => 'boxaligncenter', 'cellspacing' => '2', 'cellpadding' => '0', 'border' => '0'));
195     echo html_writer::start_tag('tr');
196     echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
197     echo html_writer::end_tag('tr');
199     //todo these need to come from somewhere if the course participants list is to show users with unread messages
200     $iscontact = true;
201     $isblocked = false;
202     foreach ($participants as $participant) {
203         if ($participant->id != $USER->id) {
204             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
205             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
206         }
207     }
209     echo html_writer::end_tag('table');
212 /**
213  * Retrieve users blocked by $user1
214  *
215  * @param object $user1 the user whose messages are being viewed
216  * @param object $user2 the user $user1 is talking to. If they are being blocked
217  *                      they will have a variable called 'isblocked' added to their user object
218  * @return array the users blocked by $user1
219  */
220 function message_get_blocked_users($user1=null, $user2=null) {
221     global $DB, $USER;
223     if (empty($user1)) {
224         $user1 = $USER;
225     }
227     if (!empty($user2)) {
228         $user2->isblocked = false;
229     }
231     $blockedusers = array();
233     $userfields = user_picture::fields('u', array('lastaccess'));
234     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
235                           FROM {message_contacts} mc
236                           JOIN {user} u ON u.id = mc.contactid
237                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
238                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
239                       GROUP BY $userfields
240                       ORDER BY u.firstname ASC";
241     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1' => $user1->id, 'user1id2' => $user1->id));
243     foreach($rs as $rd) {
244         $blockedusers[] = $rd;
246         if (!empty($user2) && $user2->id == $rd->id) {
247             $user2->isblocked = true;
248         }
249     }
250     $rs->close();
252     return $blockedusers;
255 /**
256  * Print users blocked by $user1. Called by message_print_contact_selector()
257  *
258  * @param array $blockedusers the users blocked by $user1
259  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
260  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
261  * @param string $titletodisplay Optionally specify a title to display above the participants
262  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of blocked users
263  * @return void
264  */
265 function message_print_blocked_users($blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
266     global $DB, $USER;
268     $countblocked = count($blockedusers);
270     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
272     if (!empty($titletodisplay)) {
273         echo html_writer::start_tag('tr');
274         echo html_writer::tag('td', $titletodisplay, array('colspan' => 3, 'class' => 'heading'));
275         echo html_writer::end_tag('tr');
276     }
278     if ($countblocked) {
279         echo html_writer::start_tag('tr');
280         echo html_writer::tag('td', get_string('blockedusers', 'message', $countblocked), array('colspan' => 3, 'class' => 'heading'));
281         echo html_writer::end_tag('tr');
283         $isuserblocked = true;
284         $isusercontact = false;
285         foreach ($blockedusers as $blockeduser) {
286             message_print_contactlist_user($blockeduser, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
287         }
288     }
290     echo html_writer::end_tag('table');
293 /**
294  * Retrieve $user1's contacts (online, offline and strangers)
295  *
296  * @param object $user1 the user whose messages are being viewed
297  * @param object $user2 the user $user1 is talking to. If they are a contact
298  *                      they will have a variable called 'iscontact' added to their user object
299  * @return array containing 3 arrays. array($onlinecontacts, $offlinecontacts, $strangers)
300  */
301 function message_get_contacts($user1=null, $user2=null) {
302     global $DB, $CFG, $USER;
304     if (empty($user1)) {
305         $user1 = $USER;
306     }
308     if (!empty($user2)) {
309         $user2->iscontact = false;
310     }
312     $timetoshowusers = 300; //Seconds default
313     if (isset($CFG->block_online_users_timetosee)) {
314         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
315     }
317     // time which a user is counting as being active since
318     $timefrom = time()-$timetoshowusers;
320     // people in our contactlist who are online
321     $onlinecontacts  = array();
322     // people in our contactlist who are offline
323     $offlinecontacts = array();
324     // people who are not in our contactlist but have sent us a message
325     $strangers       = array();
327     $userfields = user_picture::fields('u', array('lastaccess'));
329     // get all in our contactlist who are not blocked in our contact list
330     // and count messages we have waiting from each of them
331     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
332                      FROM {message_contacts} mc
333                      JOIN {user} u ON u.id = mc.contactid
334                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
335                     WHERE mc.userid = ? AND mc.blocked = 0
336                  GROUP BY $userfields
337                  ORDER BY u.firstname ASC";
339     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
340     foreach ($rs as $rd) {
341         if ($rd->lastaccess >= $timefrom) {
342             // they have been active recently, so are counted online
343             $onlinecontacts[] = $rd;
345         } else {
346             $offlinecontacts[] = $rd;
347         }
349         if (!empty($user2) && $user2->id == $rd->id) {
350             $user2->iscontact = true;
351         }
352     }
353     $rs->close();
355     // get messages from anyone who isn't in our contact list and count the number
356     // of messages we have from each of them
357     $strangersql = "SELECT $userfields, count(m.id) as messagecount
358                       FROM {message} m
359                       JOIN {user} u  ON u.id = m.useridfrom
360                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
361                      WHERE mc.id IS NULL AND m.useridto = ?
362                   GROUP BY $userfields
363                   ORDER BY u.firstname ASC";
365     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
366     foreach ($rs as $rd) {
367         $strangers[] = $rd;
368     }
369     $rs->close();
371     return array($onlinecontacts, $offlinecontacts, $strangers);
374 /**
375  * Print $user1's contacts. Called by message_print_contact_selector()
376  *
377  * @param array $onlinecontacts $user1's contacts which are online
378  * @param array $offlinecontacts $user1's contacts which are offline
379  * @param array $strangers users which are not contacts but who have messaged $user1
380  * @param string $contactselecturl the url to send the user to when a contact's name is clicked
381  * @param int $minmessages The minimum number of unread messages required from a user for them to be displayed
382  *                         Typically 0 (show all contacts) or 1 (only show contacts from whom we have a new message)
383  * @param bool $showactionlinks show action links (add/remove contact etc) next to the users
384  * @param string $titletodisplay Optionally specify a title to display above the participants
385  * @param object $user2 the user $user1 is talking to. They will be highlighted if they appear in the list of contacts
386  * @return void
387  */
388 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
389     global $CFG, $PAGE, $OUTPUT;
391     $countonlinecontacts  = count($onlinecontacts);
392     $countofflinecontacts = count($offlinecontacts);
393     $countstrangers       = count($strangers);
394     $isuserblocked = null;
396     if ($countonlinecontacts + $countofflinecontacts == 0) {
397         echo html_writer::tag('div', get_string('contactlistempty', 'message'), array('class' => 'heading'));
398     }
400     echo html_writer::start_tag('table', array('id' => 'message_contacts', 'class' => 'boxaligncenter'));
402     if (!empty($titletodisplay)) {
403         message_print_heading($titletodisplay);
404     }
406     if($countonlinecontacts) {
407         /// print out list of online contacts
409         if (empty($titletodisplay)) {
410             message_print_heading(get_string('onlinecontacts', 'message', $countonlinecontacts));
411         }
413         $isuserblocked = false;
414         $isusercontact = true;
415         foreach ($onlinecontacts as $contact) {
416             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
417                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
418             }
419         }
420     }
422     if ($countofflinecontacts) {
423         /// print out list of offline contacts
425         if (empty($titletodisplay)) {
426             message_print_heading(get_string('offlinecontacts', 'message', $countofflinecontacts));
427         }
429         $isuserblocked = false;
430         $isusercontact = true;
431         foreach ($offlinecontacts as $contact) {
432             if ($minmessages == 0 || $contact->messagecount >= $minmessages) {
433                 message_print_contactlist_user($contact, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
434             }
435         }
437     }
439     /// print out list of incoming contacts
440     if ($countstrangers) {
441         message_print_heading(get_string('incomingcontacts', 'message', $countstrangers));
443         $isuserblocked = false;
444         $isusercontact = false;
445         foreach ($strangers as $stranger) {
446             if ($minmessages == 0 || $stranger->messagecount >= $minmessages) {
447                 message_print_contactlist_user($stranger, $isusercontact, $isuserblocked, $contactselecturl, $showactionlinks, $user2);
448             }
449         }
450     }
452     echo html_writer::end_tag('table');
454     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
455         echo html_writer::tag('div','('.get_string('addsomecontactsincoming', 'message').')',array('class' => 'note'));
456     }
459 /**
460  * Print a select box allowing the user to choose to view new messages, course participants etc.
461  *
462  * Called by message_print_contact_selector()
463  * @param int $viewing What page is the user viewing ie MESSAGE_VIEW_UNREAD_MESSAGES, MESSAGE_VIEW_RECENT_CONVERSATIONS etc
464  * @param array $courses array of course objects. The courses the user is enrolled in.
465  * @param array $coursecontexts array of course contexts. Keyed on course id.
466  * @param int $countunreadtotal how many unread messages does the user have?
467  * @param int $countblocked how many users has the current user blocked?
468  * @param string $strunreadmessages a preconstructed message about the number of unread messages the user has
469  * @return void
470  */
471 function message_print_usergroup_selector($viewing, $courses, $coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
472     $options = array();
474     if ($countunreadtotal>0) { //if there are unread messages
475         $options[MESSAGE_VIEW_UNREAD_MESSAGES] = $strunreadmessages;
476     }
478     $str = get_string('mycontacts', 'message');
479     $options[MESSAGE_VIEW_CONTACTS] = $str;
481     $options[MESSAGE_VIEW_RECENT_CONVERSATIONS] = get_string('mostrecentconversations', 'message');
482     $options[MESSAGE_VIEW_RECENT_NOTIFICATIONS] = get_string('mostrecentnotifications', 'message');
484     if (!empty($courses)) {
485         $courses_options = array();
487         foreach($courses as $course) {
488             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
489                 //Not using short_text() as we want the end of the course name. Not the beginning.
490                 $shortname = format_string($course->shortname, true, array('context' => $coursecontexts[$course->id]));
491                 if (textlib::strlen($shortname) > MESSAGE_MAX_COURSE_NAME_LENGTH) {
492                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = '...'.textlib::substr($shortname, -MESSAGE_MAX_COURSE_NAME_LENGTH);
493                 } else {
494                     $courses_options[MESSAGE_VIEW_COURSE.$course->id] = $shortname;
495                 }
496             }
497         }
499         if (!empty($courses_options)) {
500             $options[] = array(get_string('courses') => $courses_options);
501         }
502     }
504     if ($countblocked>0) {
505         $str = get_string('blockedusers','message', $countblocked);
506         $options[MESSAGE_VIEW_BLOCKED] = $str;
507     }
509     echo html_writer::start_tag('form', array('id' => 'usergroupform','method' => 'get','action' => ''));
510         echo html_writer::start_tag('fieldset');
511             echo html_writer::select($options, 'viewing', $viewing, false, array('id' => 'viewing','onchange' => 'this.form.submit()'));
512         echo html_writer::end_tag('fieldset');
513     echo html_writer::end_tag('form');
516 /**
517  * Load the course contexts for all of the users courses
518  *
519  * @param array $courses array of course objects. The courses the user is enrolled in.
520  * @return array of course contexts
521  */
522 function message_get_course_contexts($courses) {
523     $coursecontexts = array();
525     foreach($courses as $course) {
526         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
527     }
529     return $coursecontexts;
532 /**
533  * strip off action parameters like 'removecontact'
534  *
535  * @param moodle_url/string $moodleurl a URL. Typically the current page URL.
536  * @return string the URL minus parameters that perform actions (like adding/removing/blocking a contact).
537  */
538 function message_remove_url_params($moodleurl) {
539     $newurl = new moodle_url($moodleurl);
540     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
541     return $newurl->out();
544 /**
545  * Count the number of messages with a field having a specified value.
546  * if $field is empty then return count of the whole array
547  * if $field is non-existent then return 0
548  *
549  * @param array $messagearray array of message objects
550  * @param string $field the field to inspect on the message objects
551  * @param string $value the value to test the field against
552  */
553 function message_count_messages($messagearray, $field='', $value='') {
554     if (!is_array($messagearray)) return 0;
555     if ($field == '' or empty($messagearray)) return count($messagearray);
557     $count = 0;
558     foreach ($messagearray as $message) {
559         $count += ($message->$field == $value) ? 1 : 0;
560     }
561     return $count;
564 /**
565  * Returns the count of unread messages for user. Either from a specific user or from all users.
566  *
567  * @param object $user1 the first user. Defaults to $USER
568  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
569  * @return int the count of $user1's unread messages
570  */
571 function message_count_unread_messages($user1=null, $user2=null) {
572     global $USER, $DB;
574     if (empty($user1)) {
575         $user1 = $USER;
576     }
578     if (!empty($user2)) {
579         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
580             array($user1->id, $user2->id), "COUNT('id')");
581     } else {
582         return $DB->count_records_select('message', "useridto = ?",
583             array($user1->id), "COUNT('id')");
584     }
587 /**
588  * Count the number of users blocked by $user1
589  *
590  * @param object $user1 user object
591  * @return int the number of blocked users
592  */
593 function message_count_blocked_users($user1=null) {
594     global $USER, $DB;
596     if (empty($user1)) {
597         $user1 = $USER;
598     }
600     $sql = "SELECT count(mc.id)
601             FROM {message_contacts} mc
602             WHERE mc.userid = :userid AND mc.blocked = 1";
603     $params = array('userid' => $user1->id);
605     return $DB->count_records_sql($sql, $params);
608 /**
609  * Print the search form and search results if a search has been performed
610  *
611  * @param  boolean $advancedsearch show basic or advanced search form
612  * @param  object $user1 the current user
613  * @return boolean true if a search was performed
614  */
615 function message_print_search($advancedsearch = false, $user1=null) {
616     $frm = data_submitted();
618     $doingsearch = false;
619     if ($frm) {
620         if (confirm_sesskey()) {
621             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
622         } else {
623             $frm = false;
624         }
625     }
627     if (!empty($frm->combinedsearch)) {
628         $combinedsearchstring = $frm->combinedsearch;
629     } else {
630         //$combinedsearchstring = get_string('searchcombined','message').'...';
631         $combinedsearchstring = '';
632     }
634     if ($doingsearch) {
635         if ($advancedsearch) {
637             $messagesearch = '';
638             if (!empty($frm->keywords)) {
639                 $messagesearch = $frm->keywords;
640             }
641             $personsearch = '';
642             if (!empty($frm->name)) {
643                 $personsearch = $frm->name;
644             }
645             include('search_advanced.html');
646         } else {
647             include('search.html');
648         }
650         $showicontext = false;
651         message_print_search_results($frm, $showicontext, $user1);
653         return true;
654     } else {
656         if ($advancedsearch) {
657             $personsearch = $messagesearch = '';
658             include('search_advanced.html');
659         } else {
660             include('search.html');
661         }
662         return false;
663     }
666 /**
667  * Get the users recent conversations meaning all the people they've recently
668  * sent or received a message from plus the most recent message sent to or received from each other user
669  *
670  * @param object $user the current user
671  * @param int $limitfrom can be used for paging
672  * @param int $limitto can be used for paging
673  * @return array
674  */
675 function message_get_recent_conversations($user, $limitfrom=0, $limitto=100) {
676     global $DB;
678     $userfields = user_picture::fields('u', array('lastaccess'));
679     //This query retrieves the last message received from and sent to each user
680     //It unions that data then, within that set, it finds the most recent message you've exchanged with each user over all
681     //It then joins with some other tables to get some additional data we need
683     //message ID is used instead of timecreated as it should sort the same and will be much faster
685     //There is a separate query for read and unread queries as they are stored in different tables
686     //They were originally retrieved in one query but it was so large that it was difficult to be confident in its correctness
687     $sql = "SELECT $userfields, mr.id as mid, mr.smallmessage, mr.fullmessage, mr.timecreated, mc.id as contactlistid, mc.blocked
688               FROM {message_read} mr
689               JOIN (
690                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
691                       FROM (
692                            SELECT mr1.useridto AS userid, MAX(mr1.id) AS mid
693                              FROM {message_read} mr1
694                             WHERE mr1.useridfrom = :userid1
695                                   AND mr1.notification = 0
696                          GROUP BY mr1.useridto
697                                   UNION
698                            SELECT mr2.useridfrom AS userid, MAX(mr2.id) AS mid
699                              FROM {message_read} mr2
700                             WHERE mr2.useridto = :userid2
701                                   AND mr2.notification = 0
702                          GROUP BY mr2.useridfrom
703                            ) messages
704                   GROUP BY messages.userid
705                    ) messages2 ON mr.id = messages2.mid AND (mr.useridto = messages2.userid OR mr.useridfrom = messages2.userid)
706               JOIN {user} u ON u.id = messages2.userid
707          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
708              WHERE u.deleted = '0'
709           ORDER BY mr.id DESC";
710     $params = array('userid1' => $user->id, 'userid2' => $user->id, 'userid3' => $user->id);
711     $read =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
713     $sql = "SELECT $userfields, m.id as mid, m.smallmessage, m.fullmessage, m.timecreated, mc.id as contactlistid, mc.blocked
714               FROM {message} m
715               JOIN (
716                     SELECT messages.userid AS userid, MAX(messages.mid) AS mid
717                       FROM (
718                            SELECT m1.useridto AS userid, MAX(m1.id) AS mid
719                              FROM {message} m1
720                             WHERE m1.useridfrom = :userid1
721                                   AND m1.notification = 0
722                          GROUP BY m1.useridto
723                                   UNION
724                            SELECT m2.useridfrom AS userid, MAX(m2.id) AS mid
725                              FROM {message} m2
726                             WHERE m2.useridto = :userid2
727                                   AND m2.notification = 0
728                          GROUP BY m2.useridfrom
729                            ) messages
730                   GROUP BY messages.userid
731                    ) messages2 ON m.id = messages2.mid AND (m.useridto = messages2.userid OR m.useridfrom = messages2.userid)
732               JOIN {user} u ON u.id = messages2.userid
733          LEFT JOIN {message_contacts} mc ON mc.userid = :userid3 AND mc.contactid = u.id
734              WHERE u.deleted = '0'
735              ORDER BY m.id DESC";
736     $unread =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
738     $conversations = array();
740     //Union the 2 result sets together looking for the message with the most recent timecreated for each other user
741     //$conversation->id (the array key) is the other user's ID
742     $conversation_arrays = array($unread, $read);
743     foreach ($conversation_arrays as $conversation_array) {
744         foreach ($conversation_array as $conversation) {
745             if (empty($conversations[$conversation->id]) || $conversations[$conversation->id]->timecreated < $conversation->timecreated ) {
746                 $conversations[$conversation->id] = $conversation;
747             }
748         }
749     }
751     //Sort the conversations. This is a bit complicated as we need to sort by $conversation->timecreated
752     //and there may be multiple conversations with the same timecreated value.
753     //The conversations array contains both read and unread messages (different tables) so sorting by ID won't work
754     usort($conversations, "conversationsort");
756     return $conversations;
759 /**
760  * Sort function used to order conversations
761  *
762  * @param object $a A conversation object
763  * @param object $b A conversation object
764  * @return integer
765  */
766 function conversationsort($a, $b)
768     if ($a->timecreated == $b->timecreated) {
769         return 0;
770     }
771     return ($a->timecreated > $b->timecreated) ? -1 : 1;
774 /**
775  * Get the users recent event notifications
776  *
777  * @param object $user the current user
778  * @param int $limitfrom can be used for paging
779  * @param int $limitto can be used for paging
780  * @return array
781  */
782 function message_get_recent_notifications($user, $limitfrom=0, $limitto=100) {
783     global $DB;
785     $userfields = user_picture::fields('u', array('lastaccess'));
786     $sql = "SELECT mr.id AS message_read_id, $userfields, mr.smallmessage, mr.fullmessage, mr.timecreated as timecreated, mr.contexturl, mr.contexturlname
787               FROM {message_read} mr
788                    JOIN {user} u ON u.id=mr.useridfrom
789              WHERE mr.useridto = :userid1 AND u.deleted = '0' AND mr.notification = :notification
790              ORDER BY mr.id DESC";//ordering by id should give the same result as ordering by timecreated but will be faster
791     $params = array('userid1' => $user->id, 'notification' => 1);
793     $notifications =  $DB->get_records_sql($sql, $params, $limitfrom, $limitto);
794     return $notifications;
797 /**
798  * Print the user's recent conversations
799  *
800  * @param stdClass $user the current user
801  * @param bool $showicontext flag indicating whether or not to show text next to the action icons
802  */
803 function message_print_recent_conversations($user=null, $showicontext=false) {
804     global $USER;
806     echo html_writer::start_tag('p', array('class' => 'heading'));
807     echo get_string('mostrecentconversations', 'message');
808     echo html_writer::end_tag('p');
810     if (empty($user)) {
811         $user = $USER;
812     }
814     $conversations = message_get_recent_conversations($user);
816     $showotheruser = true;
817     message_print_recent_messages_table($conversations, $user, $showotheruser, $showicontext);
820 /**
821  * Print the user's recent notifications
822  *
823  * @param stdClass $user the current user
824  */
825 function message_print_recent_notifications($user=null) {
826     global $USER;
828     echo html_writer::start_tag('p', array('class' => 'heading'));
829     echo get_string('mostrecentnotifications', 'message');
830     echo html_writer::end_tag('p');
832     if (empty($user)) {
833         $user = $USER;
834     }
836     $notifications = message_get_recent_notifications($user);
838     $showicontext = false;
839     $showotheruser = false;
840     message_print_recent_messages_table($notifications, $user, $showotheruser, $showicontext);
843 /**
844  * Print a list of recent messages
845  *
846  * @param array $messages the messages to display
847  * @param object $user the current user
848  * @param bool $showotheruser display information on the other user?
849  * @param bool $showicontext show text next to the action icons?
850  * @return void
851  */
852 function message_print_recent_messages_table($messages, $user=null, $showotheruser=true, $showicontext=false) {
853     global $OUTPUT;
854     static $dateformat;
856     if (empty($dateformat)) {
857         $dateformat = get_string('strftimedatetimeshort');
858     }
860     echo html_writer::start_tag('div', array('class' => 'messagerecent'));
861     foreach ($messages as $message) {
862         echo html_writer::start_tag('div', array('class' => 'singlemessage'));
864         if ($showotheruser) {
865             if ( $message->contactlistid )  {
866                 if ($message->blocked == 0) { /// not blocked
867                     $strcontact = message_contact_link($message->id, 'remove', true, null, $showicontext);
868                     $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
869                 } else { // blocked
870                     $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
871                     $strblock   = message_contact_link($message->id, 'unblock', true, null, $showicontext);
872                 }
873             } else {
874                 $strcontact = message_contact_link($message->id, 'add', true, null, $showicontext);
875                 $strblock   = message_contact_link($message->id, 'block', true, null, $showicontext);
876             }
878             //should we show just the icon or icon and text?
879             $histicontext = 'icon';
880             if ($showicontext) {
881                 $histicontext = 'both';
882             }
883             $strhistory = message_history_link($user->id, $message->id, true, '', '', $histicontext);
885             echo html_writer::start_tag('span', array('class' => 'otheruser'));
887             echo html_writer::start_tag('span', array('class' => 'pix'));
888             echo $OUTPUT->user_picture($message, array('size' => 20, 'courseid' => SITEID));
889             echo html_writer::end_tag('span');
891             echo html_writer::start_tag('span', array('class' => 'contact'));
893             $link = new moodle_url("/message/index.php?id=$message->id");
894             $action = null;
895             echo $OUTPUT->action_link($link, fullname($message), $action, array('title' => get_string('sendmessageto', 'message', fullname($message))));
897             echo html_writer::end_tag('span');//end contact
899             echo $strcontact.$strblock.$strhistory;
900             echo html_writer::end_tag('span');//end otheruser
901         }
902         $messagetoprint = null;
903         if (!empty($message->smallmessage)) {
904             $messagetoprint = $message->smallmessage;
905         } else {
906             $messagetoprint = $message->fullmessage;
907         }
909         echo html_writer::tag('span', userdate($message->timecreated, $dateformat), array('class' => 'messagedate'));
910         echo html_writer::tag('span', format_text($messagetoprint, FORMAT_HTML), array('class' => 'themessage'));
911         echo message_format_contexturl($message);
912         echo html_writer::end_tag('div');//end singlemessage
913     }
914     echo html_writer::end_tag('div');//end messagerecent
917 /**
918  * Add the selected user as a contact for the current user
919  *
920  * @param int $contactid the ID of the user to add as a contact
921  * @param int $blocked 1 if you wish to block the contact
922  * @return bool/int false if the $contactid isnt a valid user id. True if no changes made.
923  *                  Otherwise returns the result of update_record() or insert_record()
924  */
925 function message_add_contact($contactid, $blocked=0) {
926     global $USER, $DB;
928     if (!$DB->record_exists('user', array('id' => $contactid))) { // invalid userid
929         return false;
930     }
932     if (($contact = $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid))) !== false) {
933     /// record already exists - we may be changing blocking status
935         if ($contact->blocked !== $blocked) {
936         /// change to blocking status
937             $contact->blocked = $blocked;
938             return $DB->update_record('message_contacts', $contact);
939         } else {
940         /// no changes to blocking status
941             return true;
942         }
944     } else {
945     /// new contact record
946         $contact = new stdClass();
947         $contact->userid = $USER->id;
948         $contact->contactid = $contactid;
949         $contact->blocked = $blocked;
950         return $DB->insert_record('message_contacts', $contact, false);
951     }
954 /**
955  * remove a contact
956  *
957  * @param int $contactid the user ID of the contact to remove
958  * @return bool returns the result of delete_records()
959  */
960 function message_remove_contact($contactid) {
961     global $USER, $DB;
962     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
965 /**
966  * Unblock a contact. Note that this reverts the previously blocked user back to a non-contact.
967  *
968  * @param int $contactid the user ID of the contact to unblock
969  * @return bool returns the result of delete_records()
970  */
971 function message_unblock_contact($contactid) {
972     global $USER, $DB;
973     return $DB->delete_records('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
976 /**
977  * block a user
978  *
979  * @param int $contactid the user ID of the user to block
980  */
981 function message_block_contact($contactid) {
982     return message_add_contact($contactid, 1);
985 /**
986  * Load a user's contact record
987  *
988  * @param int $contactid the user ID of the user whose contact record you want
989  * @return array message contacts
990  */
991 function message_get_contact($contactid) {
992     global $USER, $DB;
993     return $DB->get_record('message_contacts', array('userid' => $USER->id, 'contactid' => $contactid));
996 /**
997  * Print the results of a message search
998  *
999  * @param mixed $frm submitted form data
1000  * @param bool $showicontext show text next to action icons?
1001  * @param object $currentuser the current user
1002  * @return void
1003  */
1004 function message_print_search_results($frm, $showicontext=false, $currentuser=null) {
1005     global $USER, $DB, $OUTPUT;
1007     if (empty($currentuser)) {
1008         $currentuser = $USER;
1009     }
1011     echo html_writer::start_tag('div', array('class' => 'mdl-left'));
1013     $personsearch = false;
1014     $personsearchstring = null;
1015     if (!empty($frm->personsubmit) and !empty($frm->name)) {
1016         $personsearch = true;
1017         $personsearchstring = $frm->name;
1018     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1019         $personsearch = true;
1020         $personsearchstring = $frm->combinedsearch;
1021     }
1023     /// search for person
1024     if ($personsearch) {
1025         if (optional_param('mycourses', 0, PARAM_BOOL)) {
1026             $users = array();
1027             $mycourses = enrol_get_my_courses();
1028             foreach ($mycourses as $mycourse) {
1029                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
1030                     foreach ($susers as $suser) $users[$suser->id] = $suser;
1031                 }
1032             }
1033         } else {
1034             $users = message_search_users(SITEID, $personsearchstring);
1035         }
1037         if (!empty($users)) {
1038             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1039             echo get_string('userssearchresults', 'message', count($users));
1040             echo html_writer::end_tag('p');
1042             echo html_writer::start_tag('table', array('class' => 'messagesearchresults'));
1043             foreach ($users as $user) {
1045                 if ( $user->contactlistid )  {
1046                     if ($user->blocked == 0) { /// not blocked
1047                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
1048                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1049                     } else { // blocked
1050                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1051                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
1052                     }
1053                 } else {
1054                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
1055                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
1056                 }
1058                 //should we show just the icon or icon and text?
1059                 $histicontext = 'icon';
1060                 if ($showicontext) {
1061                     $histicontext = 'both';
1062                 }
1063                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
1065                 echo html_writer::start_tag('tr');
1067                 echo html_writer::start_tag('td', array('class' => 'pix'));
1068                 echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1069                 echo html_writer::end_tag('td');
1071                 echo html_writer::start_tag('td',array('class' => 'contact'));
1072                 $action = null;
1073                 $link = new moodle_url("/message/index.php?id=$user->id");
1074                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1075                 echo html_writer::end_tag('td');
1077                 echo html_writer::tag('td', $strcontact, array('class' => 'link'));
1078                 echo html_writer::tag('td', $strblock, array('class' => 'link'));
1079                 echo html_writer::tag('td', $strhistory, array('class' => 'link'));
1081                 echo html_writer::end_tag('tr');
1082             }
1083             echo html_writer::end_tag('table');
1085         } else {
1086             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1087             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
1088             echo html_writer::end_tag('p');
1089         }
1090     }
1092     // search messages for keywords
1093     $messagesearch = false;
1094     $messagesearchstring = null;
1095     if (!empty($frm->keywords)) {
1096         $messagesearch = true;
1097         $messagesearchstring = clean_text(trim($frm->keywords));
1098     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
1099         $messagesearch = true;
1100         $messagesearchstring = clean_text(trim($frm->combinedsearch));
1101     }
1103     if ($messagesearch) {
1104         if ($messagesearchstring) {
1105             $keywords = explode(' ', $messagesearchstring);
1106         } else {
1107             $keywords = array();
1108         }
1109         $tome     = false;
1110         $fromme   = false;
1111         $courseid = 'none';
1113         if (empty($frm->keywordsoption)) {
1114             $frm->keywordsoption = 'allmine';
1115         }
1117         switch ($frm->keywordsoption) {
1118             case 'tome':
1119                 $tome   = true;
1120                 break;
1121             case 'fromme':
1122                 $fromme = true;
1123                 break;
1124             case 'allmine':
1125                 $tome   = true;
1126                 $fromme = true;
1127                 break;
1128             case 'allusers':
1129                 $courseid = SITEID;
1130                 break;
1131             case 'courseusers':
1132                 $courseid = $frm->courseid;
1133                 break;
1134             default:
1135                 $tome   = true;
1136                 $fromme = true;
1137         }
1139         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
1141         /// get a list of contacts
1142             if (($contacts = $DB->get_records('message_contacts', array('userid' => $USER->id), '', 'contactid, blocked') ) === false) {
1143                 $contacts = array();
1144             }
1146         /// print heading with number of results
1147             echo html_writer::start_tag('p', array('class' => 'heading searchresultcount'));
1148             $countresults = count($messages);
1149             if ($countresults == MESSAGE_SEARCH_MAX_RESULTS) {
1150                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
1151             } else {
1152                 echo get_string('keywordssearchresults', 'message', $countresults);
1153             }
1154             echo html_writer::end_tag('p');
1156         /// print table headings
1157             echo html_writer::start_tag('table', array('class' => 'messagesearchresults', 'cellspacing' => '0'));
1159             $headertdstart = html_writer::start_tag('td', array('class' => 'messagesearchresultscol'));
1160             $headertdend   = html_writer::end_tag('td');
1161             echo html_writer::start_tag('tr');
1162             echo $headertdstart.get_string('from').$headertdend;
1163             echo $headertdstart.get_string('to').$headertdend;
1164             echo $headertdstart.get_string('message', 'message').$headertdend;
1165             echo $headertdstart.get_string('timesent', 'message').$headertdend;
1166             echo html_writer::end_tag('tr');
1168             $blockedcount = 0;
1169             $dateformat = get_string('strftimedatetimeshort');
1170             $strcontext = get_string('context', 'message');
1171             foreach ($messages as $message) {
1173             /// ignore messages to and from blocked users unless $frm->includeblocked is set
1174                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
1175                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
1176                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
1177                                                 )
1178                    ) {
1179                     $blockedcount ++;
1180                     continue;
1181                 }
1183             /// load up user to record
1184                 if ($message->useridto !== $USER->id) {
1185                     $userto = $DB->get_record('user', array('id' => $message->useridto));
1186                     $tocontact = (array_key_exists($message->useridto, $contacts) and
1187                                     ($contacts[$message->useridto]->blocked == 0) );
1188                     $toblocked = (array_key_exists($message->useridto, $contacts) and
1189                                     ($contacts[$message->useridto]->blocked == 1) );
1190                 } else {
1191                     $userto = false;
1192                     $tocontact = false;
1193                     $toblocked = false;
1194                 }
1196             /// load up user from record
1197                 if ($message->useridfrom !== $USER->id) {
1198                     $userfrom = $DB->get_record('user', array('id' => $message->useridfrom));
1199                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
1200                                     ($contacts[$message->useridfrom]->blocked == 0) );
1201                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
1202                                     ($contacts[$message->useridfrom]->blocked == 1) );
1203                 } else {
1204                     $userfrom = false;
1205                     $fromcontact = false;
1206                     $fromblocked = false;
1207                 }
1209             /// find date string for this message
1210                 $date = usergetdate($message->timecreated);
1211                 $datestring = $date['year'].$date['mon'].$date['mday'];
1213             /// print out message row
1214                 echo html_writer::start_tag('tr', array('valign' => 'top'));
1216                 echo html_writer::start_tag('td', array('class' => 'contact'));
1217                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
1218                 echo html_writer::end_tag('td');
1220                 echo html_writer::start_tag('td', array('class' => 'contact'));
1221                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
1222                 echo html_writer::end_tag('td');
1224                 echo html_writer::start_tag('td', array('class' => 'summary'));
1225                 echo message_get_fragment($message->fullmessage, $keywords);
1226                 echo html_writer::start_tag('div', array('class' => 'link'));
1228                 //If the user clicks the context link display message sender on the left
1229                 //EXCEPT if the current user is in the conversation. Current user == always on the left
1230                 $leftsideuserid = $rightsideuserid = null;
1231                 if ($currentuser->id == $message->useridto) {
1232                     $leftsideuserid = $message->useridto;
1233                     $rightsideuserid = $message->useridfrom;
1234                 } else {
1235                     $leftsideuserid = $message->useridfrom;
1236                     $rightsideuserid = $message->useridto;
1237                 }
1238                 message_history_link($leftsideuserid, $rightsideuserid, false,
1239                                      $messagesearchstring, 'm'.$message->id, $strcontext);
1240                 echo html_writer::end_tag('div');
1241                 echo html_writer::end_tag('td');
1243                 echo html_writer::tag('td', userdate($message->timecreated, $dateformat), array('class' => 'date'));
1245                 echo html_writer::end_tag('tr');
1246             }
1249             if ($blockedcount > 0) {
1250                 echo html_writer::start_tag('tr');
1251                 echo html_writer::tag('td', get_string('blockedmessages', 'message', $blockedcount), array('colspan' => 4, 'align' => 'center'));
1252                 echo html_writer::end_tag('tr');
1253             }
1254             echo html_writer::end_tag('table');
1256         } else {
1257             echo html_writer::tag('p', get_string('keywordssearchresults', 'message', 0), array('class' => 'heading'));
1258         }
1259     }
1261     if (!$personsearch && !$messagesearch) {
1262         //they didn't enter any search terms
1263         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
1264     }
1266     echo html_writer::end_tag('div');
1269 /**
1270  * Print information on a user. Used when printing search results.
1271  *
1272  * @param object/bool $user the user to display or false if you just want $USER
1273  * @param bool $iscontact is the user being displayed a contact?
1274  * @param bool $isblocked is the user being displayed blocked?
1275  * @param bool $includeicontext include text next to the action icons?
1276  * @return void
1277  */
1278 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
1279     global $USER, $OUTPUT;
1281     if ($user === false) {
1282         echo $OUTPUT->user_picture($USER, array('size' => 20, 'courseid' => SITEID));
1283     } else {
1284         echo $OUTPUT->user_picture($user, array('size' => 20, 'courseid' => SITEID));
1285         echo '&nbsp;';
1287         $return = false;
1288         $script = null;
1289         if ($iscontact) {
1290             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
1291         } else {
1292             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
1293         }
1294         echo '&nbsp;';
1295         if ($isblocked) {
1296             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
1297         } else {
1298             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
1299         }
1301         $popupoptions = array(
1302                 'height' => MESSAGE_DISCUSSION_HEIGHT,
1303                 'width' => MESSAGE_DISCUSSION_WIDTH,
1304                 'menubar' => false,
1305                 'location' => false,
1306                 'status' => true,
1307                 'scrollbars' => true,
1308                 'resizable' => true);
1310         $link = new moodle_url("/message/index.php?id=$user->id");
1311         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
1312         $action = null;
1313         echo $OUTPUT->action_link($link, fullname($user), $action, array('title' => get_string('sendmessageto', 'message', fullname($user))));
1315     }
1318 /**
1319  * Print a message contact link
1320  *
1321  * @param int $userid the ID of the user to apply to action to
1322  * @param string $linktype can be add, remove, block or unblock
1323  * @param bool $return if true return the link as a string. If false echo the link.
1324  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
1325  * @param bool $text include text next to the icons?
1326  * @param bool $icon include a graphical icon?
1327  * @return string  if $return is true otherwise bool
1328  */
1329 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
1330     global $OUTPUT, $PAGE;
1332     //hold onto the strings as we're probably creating a bunch of links
1333     static $str;
1335     if (empty($script)) {
1336         //strip off previous action params like 'removecontact'
1337         $script = message_remove_url_params($PAGE->url);
1338     }
1340     if (empty($str->blockcontact)) {
1341        $str = new stdClass();
1342        $str->blockcontact   =  get_string('blockcontact', 'message');
1343        $str->unblockcontact =  get_string('unblockcontact', 'message');
1344        $str->removecontact  =  get_string('removecontact', 'message');
1345        $str->addcontact     =  get_string('addcontact', 'message');
1346     }
1348     $command = $linktype.'contact';
1349     $string  = $str->{$command};
1351     $safealttext = s($string);
1353     $safestring = '';
1354     if (!empty($text)) {
1355         $safestring = $safealttext;
1356     }
1358     $img = '';
1359     if ($icon) {
1360         $iconpath = null;
1361         switch ($linktype) {
1362             case 'block':
1363                 $iconpath = 't/block';
1364                 break;
1365             case 'unblock':
1366                 $iconpath = 't/userblue';
1367                 break;
1368             case 'remove':
1369                 $iconpath = 'i/cross_red_big';
1370                 break;
1371             case 'add':
1372             default:
1373                 $iconpath = 't/addgreen';
1374         }
1376         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1377     }
1379     $output = '<span class="'.$linktype.'contact">'.
1380               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1381               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1382               $img.
1383               $safestring.'</a></span>';
1385     if ($return) {
1386         return $output;
1387     } else {
1388         echo $output;
1389         return true;
1390     }
1393 /**
1394  * echo or return a link to take the user to the full message history between themselves and another user
1395  *
1396  * @param int $userid1 the ID of the user displayed on the left (usually the current user)
1397  * @param int $userid2 the ID of the other user
1398  * @param bool $return true to return the link as a string. False to echo the link.
1399  * @param string $keywords any keywords to highlight in the message history
1400  * @param string $position anchor name to jump to within the message history
1401  * @param string $linktext optionally specify the link text
1402  * @return string|bool. Returns a string if $return is true. Otherwise returns a boolean.
1403  */
1404 function message_history_link($userid1, $userid2, $return=false, $keywords='', $position='', $linktext='') {
1405     global $OUTPUT;
1406     static $strmessagehistory;
1408     if (empty($strmessagehistory)) {
1409         $strmessagehistory = get_string('messagehistory', 'message');
1410     }
1412     if ($position) {
1413         $position = "#$position";
1414     }
1415     if ($keywords) {
1416         $keywords = "&search=".urlencode($keywords);
1417     }
1419     if ($linktext == 'icon') {  // Icon only
1420         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1421     } else if ($linktext == 'both') {  // Icon and standard name
1422         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1423         $fulllink .= '&nbsp;'.$strmessagehistory;
1424     } else if ($linktext) {    // Custom name
1425         $fulllink = $linktext;
1426     } else {                   // Standard name only
1427         $fulllink = $strmessagehistory;
1428     }
1430     $popupoptions = array(
1431             'height' => 500,
1432             'width' => 500,
1433             'menubar' => false,
1434             'location' => false,
1435             'status' => true,
1436             'scrollbars' => true,
1437             'resizable' => true);
1439     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user1=$userid1&user2=$userid2$keywords$position");
1440     $action = null;
1441     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title' => $strmessagehistory));
1443     $str = '<span class="history">'.$str.'</span>';
1445     if ($return) {
1446         return $str;
1447     } else {
1448         echo $str;
1449         return true;
1450     }
1454 /**
1455  * Search through course users
1456  *
1457  * If $coursid specifies the site course then this function searches
1458  * through all undeleted and confirmed users
1459  * @param int $courseid The course in question.
1460  * @param string $searchtext the text to search for
1461  * @param string $sort the column name to order by
1462  * @param string $exceptions comma separated list of user IDs to exclude
1463  * @return array  An array of {@link $USER} records.
1464  */
1465 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1466     global $CFG, $USER, $DB;
1468     $fullname = $DB->sql_fullname();
1470     if (!empty($exceptions)) {
1471         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1472     } else {
1473         $except = '';
1474     }
1476     if (!empty($sort)) {
1477         $order = ' ORDER BY '. $sort;
1478     } else {
1479         $order = '';
1480     }
1482     $ufields = user_picture::fields('u');
1483     if (!$courseid or $courseid == SITEID) {
1484         $params = array($USER->id, "%$searchtext%");
1485         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1486                                        FROM {user} u
1487                                        LEFT JOIN {message_contacts} mc
1488                                             ON mc.contactid = u.id AND mc.userid = ?
1489                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1490                                             AND (".$DB->sql_like($fullname, '?', false).")
1491                                             $except
1492                                      $order", $params);
1493     } else {
1494 //TODO: add enabled enrolment join here (skodak)
1495         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1496         $contextlists = get_related_contexts_string($context);
1498         // everyone who has a role assignment in this course or higher
1499         $params = array($USER->id, "%$searchtext%");
1500         $users = $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1501                                          FROM {user} u
1502                                          JOIN {role_assignments} ra ON ra.userid = u.id
1503                                          LEFT JOIN {message_contacts} mc
1504                                               ON mc.contactid = u.id AND mc.userid = ?
1505                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1506                                               AND ra.contextid $contextlists
1507                                               AND (".$DB->sql_like($fullname, '?', false).")
1508                                               $except
1509                                        $order", $params);
1511         return $users;
1512     }
1515 /**
1516  * search a user's messages
1517  *
1518  * @param array $searchterms an array of search terms (strings)
1519  * @param bool $fromme include messages from the user?
1520  * @param bool $tome include messages to the user?
1521  * @param mixed $courseid SITEID for admins searching all messages. Other behaviour not yet implemented
1522  * @param int $userid the user ID of the current user
1523  * @return mixed An array of messages or false if no matching messages were found
1524  */
1525 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1526 /// Returns a list of posts found using an array of search terms
1527 /// eg   word  +word -word
1528 ///
1529     global $CFG, $USER, $DB;
1531     /// If no userid sent then assume current user
1532     if ($userid == 0) $userid = $USER->id;
1534     /// Some differences in SQL syntax
1535     if ($DB->sql_regex_supported()) {
1536         $REGEXP    = $DB->sql_regex(true);
1537         $NOTREGEXP = $DB->sql_regex(false);
1538     }
1540     $searchcond = array();
1541     $params = array();
1542     $i = 0;
1544     //preprocess search terms to check whether we have at least 1 eligible search term
1545     //if we do we can drop words around it like 'a'
1546     $dropshortwords = false;
1547     foreach ($searchterms as $searchterm) {
1548         if (strlen($searchterm) >= 2) {
1549             $dropshortwords = true;
1550         }
1551     }
1553     foreach ($searchterms as $searchterm) {
1554         $i++;
1556         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1558         if ($dropshortwords && strlen($searchterm) < 2) {
1559             continue;
1560         }
1561     /// Under Oracle and MSSQL, trim the + and - operators and perform
1562     /// simpler LIKE search
1563         if (!$DB->sql_regex_supported()) {
1564             if (substr($searchterm, 0, 1) == '-') {
1565                 $NOT = true;
1566             }
1567             $searchterm = trim($searchterm, '+-');
1568         }
1570         if (substr($searchterm,0,1) == "+") {
1571             $searchterm = substr($searchterm,1);
1572             $searchterm = preg_quote($searchterm, '|');
1573             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1574             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1576         } else if (substr($searchterm,0,1) == "-") {
1577             $searchterm = substr($searchterm,1);
1578             $searchterm = preg_quote($searchterm, '|');
1579             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1580             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1582         } else {
1583             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1584             $params['ss'.$i] = "%$searchterm%";
1585         }
1586     }
1588     if (empty($searchcond)) {
1589         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1590         $params['ss1'] = "%";
1591     } else {
1592         $searchcond = implode(" AND ", $searchcond);
1593     }
1595     /// There are several possibilities
1596     /// 1. courseid = SITEID : The admin is searching messages by all users
1597     /// 2. courseid = ??     : A teacher is searching messages by users in
1598     ///                        one of their courses - currently disabled
1599     /// 3. courseid = none   : User is searching their own messages;
1600     ///    a.  Messages from user
1601     ///    b.  Messages to user
1602     ///    c.  Messages to and from user
1604     if ($courseid == SITEID) { /// admin is searching all messages
1605         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1606                                             FROM {message_read} m
1607                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1608         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1609                                             FROM {message} m
1610                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1612     } else if ($courseid !== 'none') {
1613         /// This has not been implemented due to security concerns
1614         $m_read   = array();
1615         $m_unread = array();
1617     } else {
1619         if ($fromme and $tome) {
1620             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1621             $params['userid1'] = $userid;
1622             $params['userid2'] = $userid;
1624         } else if ($fromme) {
1625             $searchcond .= " AND m.useridfrom=:userid";
1626             $params['userid'] = $userid;
1628         } else if ($tome) {
1629             $searchcond .= " AND m.useridto=:userid";
1630             $params['userid'] = $userid;
1631         }
1633         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1634                                             FROM {message_read} m
1635                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1636         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1637                                             FROM {message} m
1638                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1640     }
1642     /// The keys may be duplicated in $m_read and $m_unread so we can't
1643     /// do a simple concatenation
1644     $messages = array();
1645     foreach ($m_read as $m) {
1646         $messages[] = $m;
1647     }
1648     foreach ($m_unread as $m) {
1649         $messages[] = $m;
1650     }
1652     return (empty($messages)) ? false : $messages;
1655 /**
1656  * Given a message object that we already know has a long message
1657  * this function truncates the message nicely to the first
1658  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1659  *
1660  * @param string $message the message
1661  * @param int $minlength the minimum length to trim the message to
1662  * @return string the shortened message
1663  */
1664 function message_shorten_message($message, $minlength = 0) {
1665     $i = 0;
1666     $tag = false;
1667     $length = strlen($message);
1668     $count = 0;
1669     $stopzone = false;
1670     $truncate = 0;
1671     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1674     for ($i=0; $i<$length; $i++) {
1675         $char = $message[$i];
1677         switch ($char) {
1678             case "<":
1679                 $tag = true;
1680                 break;
1681             case ">":
1682                 $tag = false;
1683                 break;
1684             default:
1685                 if (!$tag) {
1686                     if ($stopzone) {
1687                         if ($char == '.' or $char == ' ') {
1688                             $truncate = $i+1;
1689                             break 2;
1690                         }
1691                     }
1692                     $count++;
1693                 }
1694                 break;
1695         }
1696         if (!$stopzone) {
1697             if ($count > $minlength) {
1698                 $stopzone = true;
1699             }
1700         }
1701     }
1703     if (!$truncate) {
1704         $truncate = $i;
1705     }
1707     return substr($message, 0, $truncate);
1711 /**
1712  * Given a string and an array of keywords, this function looks
1713  * for the first keyword in the string, and then chops out a
1714  * small section from the text that shows that word in context.
1715  *
1716  * @param string $message the text to search
1717  * @param array $keywords array of keywords to find
1718  */
1719 function message_get_fragment($message, $keywords) {
1721     $fullsize = 160;
1722     $halfsize = (int)($fullsize/2);
1724     $message = strip_tags($message);
1726     foreach ($keywords as $keyword) {  // Just get the first one
1727         if ($keyword !== '') {
1728             break;
1729         }
1730     }
1731     if (empty($keyword)) {   // None found, so just return start of message
1732         return message_shorten_message($message, 30);
1733     }
1735     $leadin = $leadout = '';
1737 /// Find the start of the fragment
1738     $start = 0;
1739     $length = strlen($message);
1741     $pos = strpos($message, $keyword);
1742     if ($pos > $halfsize) {
1743         $start = $pos - $halfsize;
1744         $leadin = '...';
1745     }
1746 /// Find the end of the fragment
1747     $end = $start + $fullsize;
1748     if ($end > $length) {
1749         $end = $length;
1750     } else {
1751         $leadout = '...';
1752     }
1754 /// Pull out the fragment and format it
1756     $fragment = substr($message, $start, $end - $start);
1757     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1758     return $fragment;
1761 /**
1762  * Retrieve the messages between two users
1763  *
1764  * @param object $user1 the current user
1765  * @param object $user2 the other user
1766  * @param int $limitnum the maximum number of messages to retrieve
1767  * @param bool $viewingnewmessages are we currently viewing new messages?
1768  */
1769 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1770     global $DB, $CFG;
1772     $messages = array();
1774     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1775     //desc to get the last $limitnum messages then flip the order in php
1776     $sort = 'asc';
1777     if ($limitnum>0) {
1778         $sort = 'desc';
1779     }
1781     $notificationswhere = null;
1782     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1783     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1784         $notificationswhere = 'AND notification=0';
1785     }
1787     //prevent notifications of your own actions appearing in your own message history
1788     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1790     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1791                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1792                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1793                                                     "timecreated $sort", '*', 0, $limitnum)) {
1794         foreach ($messages_read as $message) {
1795             $messages[$message->timecreated] = $message;
1796         }
1797     }
1798     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1799                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1800                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1801                                                     "timecreated $sort", '*', 0, $limitnum)) {
1802         foreach ($messages_new as $message) {
1803             $messages[$message->timecreated] = $message;
1804         }
1805     }
1807     //if we only want the last $limitnum messages
1808     ksort($messages);
1809     $messagecount = count($messages);
1810     if ($limitnum>0 && $messagecount>$limitnum) {
1811         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1812     }
1814     return $messages;
1817 /**
1818  * Print the message history between two users
1819  *
1820  * @param object $user1 the current user
1821  * @param object $user2 the other user
1822  * @param string $search search terms to highlight
1823  * @param int $messagelimit maximum number of messages to return
1824  * @param string $messagehistorylink the html for the message history link or false
1825  * @param bool $viewingnewmessages are we currently viewing new messages?
1826  */
1827 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1828     global $CFG, $OUTPUT;
1830     echo $OUTPUT->box_start('center');
1831     echo html_writer::start_tag('table', array('cellpadding' => '10', 'class' => 'message_user_pictures'));
1832     echo html_writer::start_tag('tr');
1834     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user1'));
1835     echo $OUTPUT->user_picture($user1, array('size' => 100, 'courseid' => SITEID));
1836     echo html_writer::tag('div', fullname($user1), array('class' => 'heading'));
1837     echo html_writer::end_tag('td');
1839     echo html_writer::start_tag('td', array('align' => 'center'));
1840     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/left'), 'alt' => get_string('from')));
1841     echo html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/right'), 'alt' => get_string('to')));
1842     echo html_writer::end_tag('td');
1844     echo html_writer::start_tag('td', array('align' => 'center', 'id' => 'user2'));
1845     echo $OUTPUT->user_picture($user2, array('size' => 100, 'courseid' => SITEID));
1846     echo html_writer::tag('div', fullname($user2), array('class' => 'heading'));
1848     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1849         $incontactlist = $user2->iscontact;
1850         $isblocked = $user2->isblocked;
1852         $script = null;
1853         $text = true;
1854         $icon = false;
1856         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1857         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1858         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1860         echo html_writer::tag('div', $useractionlinks, array('class' => 'useractionlinks'));
1861     }
1863     echo html_writer::end_tag('td');
1864     echo html_writer::end_tag('tr');
1865     echo html_writer::end_tag('table');
1866     echo $OUTPUT->box_end();
1868     if (!empty($messagehistorylink)) {
1869         echo $messagehistorylink;
1870     }
1872     /// Get all the messages and print them
1873     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1874         $tablecontents = '';
1876         $current = new stdClass();
1877         $current->mday = '';
1878         $current->month = '';
1879         $current->year = '';
1880         $messagedate = get_string('strftimetime');
1881         $blockdate   = get_string('strftimedaydate');
1882         foreach ($messages as $message) {
1883             if ($message->notification) {
1884                 $notificationclass = ' notification';
1885             } else {
1886                 $notificationclass = null;
1887             }
1888             $date = usergetdate($message->timecreated);
1889             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1890                 $current->mday = $date['mday'];
1891                 $current->month = $date['month'];
1892                 $current->year = $date['year'];
1894                 $datestring = html_writer::empty_tag('a', array('name' => $date['year'].$date['mon'].$date['mday']));
1895                 $tablecontents .= html_writer::tag('div', $datestring, array('class' => 'mdl-align heading'));
1897                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'mdl-align');
1898             }
1900             $formatted_message = $side = null;
1901             if ($message->useridfrom == $user1->id) {
1902                 $formatted_message = message_format_message($message, $messagedate, $search, 'me');
1903                 $side = 'left';
1904             } else {
1905                 $formatted_message = message_format_message($message, $messagedate, $search, 'other');
1906                 $side = 'right';
1907             }
1908             $tablecontents .= html_writer::tag('div', $formatted_message, array('class' => "mdl-left $side $notificationclass"));
1909         }
1911         echo html_writer::nonempty_tag('div', $tablecontents, array('class' => 'mdl-left messagehistory'));
1912     } else {
1913         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class' => 'mdl-align messagehistory'));
1914     }
1917 /**
1918  * Format a message for display in the message history
1919  *
1920  * @param object $message the message object
1921  * @param string $format optional date format
1922  * @param string $keywords keywords to highlight
1923  * @param string $class CSS class to apply to the div around the message
1924  * @return string the formatted message
1925  */
1926 function message_format_message($message, $format='', $keywords='', $class='other') {
1928     static $dateformat;
1930     //if we haven't previously set the date format or they've supplied a new one
1931     if ( empty($dateformat) || (!empty($format) && $dateformat != $format) ) {
1932         if ($format) {
1933             $dateformat = $format;
1934         } else {
1935             $dateformat = get_string('strftimedatetimeshort');
1936         }
1937     }
1938     $time = userdate($message->timecreated, $dateformat);
1939     $options = new stdClass();
1940     $options->para = false;
1942     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1943     if (!empty($message->smallmessage)) {
1944         $messagetext = $message->smallmessage;
1945     } else {
1946         $messagetext = $message->fullmessage;
1947     }
1948     if ($message->fullmessageformat == FORMAT_HTML) {
1949         //dont escape html tags by calling s() if html format or they will display in the UI
1950         $messagetext = html_to_text(format_text($messagetext, $message->fullmessageformat, $options));
1951     } else {
1952         $messagetext = format_text(s($messagetext), $message->fullmessageformat, $options);
1953     }
1955     $messagetext .= message_format_contexturl($message);
1957     if ($keywords) {
1958         $messagetext = highlight($keywords, $messagetext);
1959     }
1961     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1964 /**
1965  * Format a the context url and context url name of a message for display
1966  *
1967  * @param object $message the message object
1968  * @return string the formatted string
1969  */
1970 function message_format_contexturl($message) {
1971     $s = null;
1973     if (!empty($message->contexturl)) {
1974         $displaytext = null;
1975         if (!empty($message->contexturlname)) {
1976             $displaytext= $message->contexturlname;
1977         } else {
1978             $displaytext= $message->contexturl;
1979         }
1980         $s .= html_writer::start_tag('div',array('class' => 'messagecontext'));
1981             $s .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1982         $s .= html_writer::end_tag('div');
1983     }
1985     return $s;
1988 /**
1989  * Send a message from one user to another. Will be delivered according to the message recipients messaging preferences
1990  *
1991  * @param object $userfrom the message sender
1992  * @param object $userto the message recipient
1993  * @param string $message the message
1994  * @param int $format message format such as FORMAT_PLAIN or FORMAT_HTML
1995  * @return int|false the ID of the new message or false
1996  */
1997 function message_post_message($userfrom, $userto, $message, $format) {
1998     global $SITE, $CFG, $USER;
2000     $eventdata = new stdClass();
2001     $eventdata->component        = 'moodle';
2002     $eventdata->name             = 'instantmessage';
2003     $eventdata->userfrom         = $userfrom;
2004     $eventdata->userto           = $userto;
2006     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
2007     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
2009     if ($format == FORMAT_HTML) {
2010         $eventdata->fullmessagehtml  = $message;
2011         //some message processors may revert to sending plain text even if html is supplied
2012         //so we keep both plain and html versions if we're intending to send html
2013         $eventdata->fullmessage = html_to_text($eventdata->fullmessagehtml);
2014     } else {
2015         $eventdata->fullmessage      = $message;
2016         $eventdata->fullmessagehtml  = '';
2017     }
2019     $eventdata->fullmessageformat = $format;
2020     $eventdata->smallmessage     = $message;//store the message unfiltered. Clean up on output.
2022     $s = new stdClass();
2023     $s->sitename = format_string($SITE->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, SITEID)));
2024     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
2026     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
2027     if (!empty($eventdata->fullmessage)) {
2028         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
2029     }
2030     if (!empty($eventdata->fullmessagehtml)) {
2031         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
2032     }
2034     $eventdata->timecreated     = time();
2035     return message_send($eventdata);
2039 /**
2040  * Returns a list of all user ids who have used messaging in the site
2041  * This was the simple way to code the SQL ... is it going to blow up
2042  * on large datasets?
2043  *
2044  * @deprecated To be deleted in 2.2 MDL-31709
2045  * @return array
2046  */
2047 function message_get_participants() {
2048     global $CFG, $DB;
2050         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
2051                                UNION SELECT useridto as id,1 FROM {message}
2052                                UNION SELECT useridfrom as id,1 FROM {message_read}
2053                                UNION SELECT useridto as id,1 FROM {message_read}
2054                                UNION SELECT userid as id,1 FROM {message_contacts}
2055                                UNION SELECT contactid as id,1 from {message_contacts}");
2058 /**
2059  * Print a row of contactlist displaying user picture, messages waiting and
2060  * block links etc
2061  *
2062  * @param object $contact contact object containing all fields required for $OUTPUT->user_picture()
2063  * @param bool $incontactlist is the user a contact of ours?
2064  * @param bool $isblocked is the user blocked?
2065  * @param string $selectcontacturl the url to send the user to when a contact's name is clicked
2066  * @param bool $showactionlinks display action links next to the other users (add contact, block user etc)
2067  * @param object $selecteduser the user the current user is viewing (if any). They will be highlighted.
2068  * @return void
2069  */
2070 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
2071     global $OUTPUT, $USER;
2072     $fullname  = fullname($contact);
2073     $fullnamelink  = $fullname;
2075     $linkclass = '';
2076     if (!empty($selecteduser) && $contact->id == $selecteduser->id) {
2077         $linkclass = 'messageselecteduser';
2078     }
2080     /// are there any unread messages for this contact?
2081     if ($contact->messagecount > 0 ){
2082         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
2083     }
2085     $strcontact = $strblock = $strhistory = null;
2087     if ($showactionlinks) {
2088         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
2089         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
2090         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
2091     }
2093     echo html_writer::start_tag('tr');
2094     echo html_writer::start_tag('td', array('class' => 'pix'));
2095     echo $OUTPUT->user_picture($contact, array('size' => 20, 'courseid' => SITEID));
2096     echo html_writer::end_tag('td');
2098     echo html_writer::start_tag('td', array('class' => 'contact'));
2100     $popupoptions = array(
2101             'height' => MESSAGE_DISCUSSION_HEIGHT,
2102             'width' => MESSAGE_DISCUSSION_WIDTH,
2103             'menubar' => false,
2104             'location' => false,
2105             'status' => true,
2106             'scrollbars' => true,
2107             'resizable' => true);
2109     $link = $action = null;
2110     if (!empty($selectcontacturl)) {
2111         $link = new moodle_url($selectcontacturl.'&user2='.$contact->id);
2112     } else {
2113         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
2114         $link = new moodle_url("/message/index.php?id=$contact->id");
2115         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
2116     }
2117     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class' => $linkclass,'title' => get_string('sendmessageto', 'message', $fullname)));
2119     echo html_writer::end_tag('td');
2121     echo html_writer::tag('td', '&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory, array('class' => 'link'));
2123     echo html_writer::end_tag('tr');
2126 /**
2127  * Constructs the add/remove contact link to display next to other users
2128  *
2129  * @param bool $incontactlist is the user a contact
2130  * @param bool $isblocked is the user blocked
2131  * @param stdClass $contact contact object
2132  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2133  * @param bool $text include text next to the icons?
2134  * @param bool $icon include a graphical icon?
2135  * @return string
2136  */
2137 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2138     $strcontact = '';
2140     if($incontactlist){
2141         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
2142     } else if ($isblocked) {
2143         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2144     } else{
2145         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
2146     }
2148     return $strcontact;
2151 /**
2152  * Constructs the block contact link to display next to other users
2153  *
2154  * @param bool $incontactlist is the user a contact?
2155  * @param bool $isblocked is the user blocked?
2156  * @param stdClass $contact contact object
2157  * @param string $script the URL to send the user to when the link is clicked. If null, the current page.
2158  * @param bool $text include text next to the icons?
2159  * @param bool $icon include a graphical icon?
2160  * @return string
2161  */
2162 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
2163     $strblock   = '';
2165     //commented out to allow the user to block a contact without having to remove them first
2166     /*if ($incontactlist) {
2167         //$strblock = '';
2168     } else*/
2169     if ($isblocked) {
2170         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
2171     } else{
2172         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
2173     }
2175     return $strblock;
2178 /**
2179  * Moves messages from a particular user from the message table (unread messages) to message_read
2180  * This is typically only used when a user is deleted
2181  *
2182  * @param object $userid User id
2183  * @return boolean success
2184  */
2185 function message_move_userfrom_unread2read($userid) {
2186     global $DB;
2188     // move all unread messages from message table to message_read
2189     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
2190         foreach ($messages as $message) {
2191             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
2192         }
2193     }
2194     return true;
2197 /**
2198  * marks ALL messages being sent from $fromuserid to $touserid as read
2199  *
2200  * @param int $touserid the id of the message recipient
2201  * @param int $fromuserid the id of the message sender
2202  * @return void
2203  */
2204 function message_mark_messages_read($touserid, $fromuserid){
2205     global $DB;
2207     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
2208     $messages = $DB->get_recordset_sql($sql, array('useridto' => $touserid,'useridfrom' => $fromuserid));
2210     foreach ($messages as $message) {
2211         message_mark_message_read($message, time());
2212     }
2214     $messages->close();
2217 /**
2218  * Mark a single message as read
2219  *
2220  * @param stdClass $message An object with an object property ie $message->id which is an id in the message table
2221  * @param int $timeread the timestamp for when the message should be marked read. Usually time().
2222  * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
2223  * @return int the ID of the message in the message_read table
2224  */
2225 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
2226     global $DB;
2228     $message->timeread = $timeread;
2230     $messageid = $message->id;
2231     unset($message->id);//unset because it will get a new id on insert into message_read
2233     //If any processors have pending actions abort them
2234     if (!$messageworkingempty) {
2235         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
2236     }
2237     $messagereadid = $DB->insert_record('message_read', $message);
2238     $DB->delete_records('message', array('id' => $messageid));
2239     return $messagereadid;
2242 /**
2243  * A helper function that prints a formatted heading
2244  *
2245  * @param string $title the heading to display
2246  * @param int $colspan
2247  * @return void
2248  */
2249 function message_print_heading($title, $colspan=3) {
2250     echo html_writer::start_tag('tr');
2251     echo html_writer::tag('td', $title, array('colspan' => $colspan, 'class' => 'heading'));
2252     echo html_writer::end_tag('tr');
2255 /**
2256  * Get all message processors, validate corresponding plugin existance and
2257  * system configuration
2258  *
2259  * @param bool $ready only return ready-to-use processors
2260  * @return mixed $processors array of objects containing information on message processors
2261  */
2262 function get_message_processors($ready = false) {
2263     global $DB, $CFG;
2265     static $processors;
2267     if (empty($processors)) {
2268         // Get all processors, ensure the name column is the first so it will be the array key
2269         $processors = $DB->get_records('message_processors', null, 'name DESC', 'name, id, enabled');
2270         foreach ($processors as &$processor){
2271             $processorfile = $CFG->dirroot. '/message/output/'.$processor->name.'/message_output_'.$processor->name.'.php';
2272             if (is_readable($processorfile)) {
2273                 include_once($processorfile);
2274                 $processclass = 'message_output_' . $processor->name;
2275                 if (class_exists($processclass)) {
2276                     $pclass = new $processclass();
2277                     $processor->object = $pclass;
2278                     $processor->configured = 0;
2279                     if ($pclass->is_system_configured()) {
2280                         $processor->configured = 1;
2281                     }
2282                     $processor->hassettings = 0;
2283                     if (is_readable($CFG->dirroot.'/message/output/'.$processor->name.'/settings.php')) {
2284                         $processor->hassettings = 1;
2285                     }
2286                     $processor->available = 1;
2287                 } else {
2288                     print_error('errorcallingprocessor', 'message');
2289                 }
2290             } else {
2291                 $processor->available = 0;
2292             }
2293         }
2294     }
2295     if ($ready) {
2296         // Filter out enabled and system_configured processors
2297         $readyprocessors = $processors;
2298         foreach ($readyprocessors as $readyprocessor) {
2299             if (!($readyprocessor->enabled && $readyprocessor->configured)) {
2300                 unset($readyprocessors[$readyprocessor->name]);
2301             }
2302         }
2303         return $readyprocessors;
2304     }
2306     return $processors;
2309 /**
2310  * Get an instance of the message_output class for one of the output plugins.
2311  * @param string $type the message output type. E.g. 'email' or 'jabber'.
2312  * @return message_output message_output the requested class.
2313  */
2314 function get_message_processor($type) {
2315     global $CFG;
2317     // Note, we cannot use the get_message_processors function here, becaues this
2318     // code is called during install after installing each messaging plugin, and
2319     // get_message_processors caches the list of installed plugins.
2321     $processorfile = $CFG->dirroot . "/message/output/{$type}/message_output_{$type}.php";
2322     if (!is_readable($processorfile)) {
2323         throw new coding_exception('Unknown message processor type ' . $type);
2324     }
2326     include_once($processorfile);
2328     $processclass = 'message_output_' . $type;
2329     if (!class_exists($processclass)) {
2330         throw new coding_exception('Message processor ' . $type .
2331                 ' does not define the right class');
2332     }
2334     return new $processclass();
2337 /**
2338  * Get messaging outputs default (site) preferences
2339  *
2340  * @return object $processors object containing information on message processors
2341  */
2342 function get_message_output_default_preferences() {
2343     return get_config('message');
2346 /**
2347  * Translate message default settings from binary value to the array of string
2348  * representing the settings to be stored. Also validate the provided value and
2349  * use default if it is malformed.
2350  *
2351  * @param  int    $plugindefault Default setting suggested by plugin
2352  * @param  string $processorname The name of processor
2353  * @return array  $settings array of strings in the order: $permitted, $loggedin, $loggedoff.
2354  */
2355 function translate_message_default_setting($plugindefault, $processorname) {
2356     // Preset translation arrays
2357     $permittedvalues = array(
2358         0x04 => 'disallowed',
2359         0x08 => 'permitted',
2360         0x0c => 'forced',
2361     );
2363     $loggedinstatusvalues = array(
2364         0x00 => null, // use null if loggedin/loggedoff is not defined
2365         0x01 => 'loggedin',
2366         0x02 => 'loggedoff',
2367     );
2369     // define the default setting
2370     $processor = get_message_processor($processorname);
2371     $default = $processor->get_default_messaging_settings();
2373     // Validate the value. It should not exceed the maximum size
2374     if (!is_int($plugindefault) || ($plugindefault > 0x0f)) {
2375         debugging(get_string('errortranslatingdefault', 'message'));
2376         $plugindefault = $default;
2377     }
2378     // Use plugin default setting of 'permitted' is 0
2379     if (!($plugindefault & MESSAGE_PERMITTED_MASK)) {
2380         $plugindefault = $default;
2381     }
2383     $permitted = $permittedvalues[$plugindefault & MESSAGE_PERMITTED_MASK];
2384     $loggedin = $loggedoff = null;
2386     if (($plugindefault & MESSAGE_PERMITTED_MASK) == MESSAGE_PERMITTED) {
2387         $loggedin = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDIN];
2388         $loggedoff = $loggedinstatusvalues[$plugindefault & MESSAGE_DEFAULT_LOGGEDOFF];
2389     }
2391     return array($permitted, $loggedin, $loggedoff);
2394 /**
2395  * Return a list of page types
2396  * @param string $pagetype current page type
2397  * @param stdClass $parentcontext Block's parent context
2398  * @param stdClass $currentcontext Current context of block
2399  */
2400 function message_page_type_list($pagetype, $parentcontext, $currentcontext) {
2401     return array('messages-*'=>get_string('page-message-x', 'message'));