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