Merge branch 'w07_MDL-26211_20_https' of git://github.com/skodak/moodle
[moodle.git] / message / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library functions for messaging
20  *
21  * @copyright Luis Rodrigues
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package message
24  */
26 require_once($CFG->libdir.'/eventslib.php');
29 define ('MESSAGE_SHORTLENGTH', 300);
31 //$PAGE isnt set if we're being loaded by cron which doesnt display popups anyway
32 if (isset($PAGE)) {
33     $PAGE->set_popup_notification_allowed(false); // We are in a message window (so don't pop up a new one)
34 }
36 define ('MESSAGE_DISCUSSION_WIDTH',600);
37 define ('MESSAGE_DISCUSSION_HEIGHT',500);
39 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
41 define ('CONTACT_ID','id');
43 define('MESSAGE_HISTORY_SHORT',0);
44 define('MESSAGE_HISTORY_ALL',1);
46 //some constants used as function arguments. Just to make function calls a bit more understandable
47 define('IS_CONTACT',true);
48 define('IS_NOT_CONTACT',false);
50 define('IS_BLOCKED',true);
51 define('IS_NOT_BLOCKED',false);
53 define('VIEW_UNREAD_MESSAGES','unread');
54 define('VIEW_CONTACTS','contacts');
55 define('VIEW_BLOCKED','blockedusers');
56 define('VIEW_COURSE','course_');
57 define('VIEW_SEARCH','search');
59 define('MESSAGE_USER1_PARAM','user1');
60 define('MESSAGE_USER2_PARAM','user2');
62 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
64 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
66 define('MESSAGE_CONTACTS_PER_PAGE',10);
68 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
69     $CFG->message_contacts_refresh = 60;
70 }
71 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
72     $CFG->message_chat_refresh = 5;
73 }
74 if (!isset($CFG->message_offline_time)) {
75     $CFG->message_offline_time = 300;
76 }
78 function message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
79     global $PAGE;
81     echo html_writer::start_tag('div', array('class'=>'contactselector mdl-align'));
83         //if 0 unread messages and they've requested unread messages then show contacts
84         if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES) {
85             $usergroup = VIEW_CONTACTS;
86         }
88         //if they have no blocked users and they've requested blocked users switch them over to contacts
89         if (count($blockedusers)==0 && $usergroup==VIEW_BLOCKED) {
90             $usergroup = VIEW_CONTACTS;
91         }
93         $onlyactivecourses = true;
94         $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
95         $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
97         $strunreadmessages = null;
98         if ($countunreadtotal>0) { //if there are unread messages
99             $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
100         }
102         message_print_usergroup_selector($usergroup, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
104         $refreshpage = false;
106         if ($usergroup==VIEW_UNREAD_MESSAGES) {
107             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
108         } else if ($usergroup==VIEW_CONTACTS || $usergroup==VIEW_SEARCH) {
109             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
110         } else if ($usergroup==VIEW_BLOCKED) {
111             message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
112         } else if (substr($usergroup, 0, 7)==VIEW_COURSE) {
113             $courseidtoshow = intval(substr($usergroup, 7));
115             if (!empty($courseidtoshow)
116                 && array_key_exists($courseidtoshow, $coursecontexts)
117                 && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
119                 message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
120             } else {
121                 //shouldn't get here. User trying to access a course they're not in perhaps.
122                 add_to_log(SITEID, 'message', 'view', 'index.php', $usergroup);
123             }
124         }
126         echo html_writer::start_tag('form', array('action'=>'index.php','method'=>'GET'));
127             echo html_writer::start_tag('fieldset');
128                 $managebuttonclass = 'visible';
129                 if ($usergroup==VIEW_SEARCH) {
130                     $managebuttonclass = 'hiddenelement';
131                 }
132                 $strmanagecontacts = get_string('search','message');
133                 echo html_writer::empty_tag('input', array('type'=>'hidden','name'=>'usergroup','value'=>VIEW_SEARCH));
134                 echo html_writer::empty_tag('input', array('type'=>'submit','value'=>$strmanagecontacts,'class'=>$managebuttonclass));
135             echo html_writer::end_tag('fieldset');
136         echo html_writer::end_tag('form');
138     echo html_writer::end_tag('div');
141 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
142     global $DB, $USER, $PAGE, $OUTPUT;
144     $countparticipants = count_enrolled_users($context);
145     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
147     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
148     echo $OUTPUT->render($pagingbar);
150     echo '<table id="message_participants" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
152     if (!empty($titletodisplay)) {
153         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
154     }
156     if (empty($titletodisplay)) {
157         echo '<tr><td colspan="3" class="heading">';
158         echo get_string('participants');
159         echo '</td></tr>';
160     }
162     //todo these need to come from somewhere if the course participants list is to show users with unread messages
163     $iscontact = true;
164     $isblocked = false;
165     foreach ($participants as $participant) {
166         if ($participant->id != $USER->id) {
167             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
168             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
169         }
170     }
171     //$participants->close();
173     echo '</table>';
176 function message_get_blocked_users($user1=null, &$user2=null) {
177     global $DB, $USER;
179     if (empty($user1)) {
180         $user1 = $USER;
181     }
183     if (!empty($user2)) {
184         $user2->isblocked = false;
185     }
187     $userfields = user_picture::fields('u', array('lastaccess'));
188     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
189                           FROM {message_contacts} mc
190                           JOIN {user} u ON u.id = mc.contactid
191                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
192                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
193                       GROUP BY $userfields
194                       ORDER BY u.firstname ASC";
195     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1'=>$user1->id, 'user1id2'=>$user1->id));
197     $blockedusers = array();
198     if (!empty($rs)) {
199         foreach($rs as $rd) {
200             $blockedusers[] = $rd;
202             if (!empty($user2) && $user2->id==$rd->id) {
203                 $user2->isblocked = true;
204             }
205         }
206         unset($rd);
207         $rs->close();
208     }
210     return $blockedusers;
213 function message_print_blocked_users(&$blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
214     global $DB, $USER;
216     $countblocked = count($blockedusers);
218     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
220     if (!empty($titletodisplay)) {
221         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
222     }
224     if ($countblocked) {
225         echo '<tr><td colspan="3" class="heading">';
226         echo get_string('blockedusers', 'message', $countblocked);
227         echo '</td></tr>';
229         foreach ($blockedusers as $blockeduser) {
230             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
231         }
232     }
234     echo '</table>';
237 function message_get_contacts($user1=null, &$user2=null) {
238     global $DB, $CFG, $USER;
240     if (empty($user1)) {
241         $user1 = $USER;
242     }
244     if (!empty($user2)) {
245         $user2->iscontact = false;
246     }
248     $timetoshowusers = 300; //Seconds default
249     if (isset($CFG->block_online_users_timetosee)) {
250         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
251     }
253     // time which a user is counting as being active since
254     $timefrom = time()-$timetoshowusers;
256     // people in our contactlist who are online
257     $onlinecontacts  = array();
258     // people in our contactlist who are offline
259     $offlinecontacts = array();
260     // people who are not in our contactlist but have sent us a message
261     $strangers       = array();
263     $userfields = user_picture::fields('u', array('lastaccess'));
265     // get all in our contactlist who are not blocked in our contact list
266     // and count messages we have waiting from each of them
267     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
268                      FROM {message_contacts} mc
269                      JOIN {user} u ON u.id = mc.contactid
270                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
271                     WHERE mc.userid = ? AND mc.blocked = 0
272                  GROUP BY $userfields
273                  ORDER BY u.firstname ASC";
275     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
276     foreach ($rs as $rd) {
277         if ($rd->lastaccess >= $timefrom) {
278             // they have been active recently, so are counted online
279             $onlinecontacts[] = $rd;
281         } else {
282             $offlinecontacts[] = $rd;
283         }
285         if (!empty($user2) && $user2->id==$rd->id) {
286             $user2->iscontact = true;
287         }
288     }
289     $rs->close();
291     // get messages from anyone who isn't in our contact list and count the number
292     // of messages we have from each of them
293     $strangersql = "SELECT $userfields, count(m.id) as messagecount
294                       FROM {message} m
295                       JOIN {user} u  ON u.id = m.useridfrom
296                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
297                      WHERE mc.id IS NULL AND m.useridto = ?
298                   GROUP BY $userfields
299                   ORDER BY u.firstname ASC";
301     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
302     foreach ($rs as $rd) {
303         $strangers[] = $rd;
304     }
305     $rs->close();
307     return array($onlinecontacts, $offlinecontacts, $strangers);
310 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refresh=true, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
311     global $CFG, $PAGE, $OUTPUT;
313     $countonlinecontacts  = count($onlinecontacts);
314     $countofflinecontacts = count($offlinecontacts);
315     $countstrangers       = count($strangers);
317     if ($countonlinecontacts + $countofflinecontacts == 0) {
318         echo '<div class="heading">';
319         print_string('contactlistempty', 'message');
320         echo '</div>';
321         //echo '<div class="note">';
322         //print_string('addsomecontacts', 'message', message_remove_url_params($PAGE->url).'?tab=search');
323         //echo '</div>';
324     }
326     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
328     if (!empty($titletodisplay)) {
329         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
330     }
332     if($countonlinecontacts) {
333         /// print out list of online contacts
335         if (empty($titletodisplay)) {
336             echo '<tr><td colspan="3" class="heading">';
337             echo get_string('onlinecontacts', 'message', $countonlinecontacts);
338             echo '</td></tr>';
339         }
341         foreach ($onlinecontacts as $contact) {
342             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
343                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
344             }
345         }
346     }
348     if ($countofflinecontacts) {
349         /// print out list of offline contacts
351         if (empty($titletodisplay)) {
352             echo '<tr><td colspan="3" class="heading">';
353             echo get_string('offlinecontacts', 'message', $countofflinecontacts);
354             echo '</td></tr>';
355         }
357         foreach ($offlinecontacts as $contact) {
358             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
359                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
360             }
361         }
362         echo '<tr><td colspan="3">&nbsp;</td></tr>';
363     }
365     /// print out list of incoming contacts
366     if ($countstrangers) {
367         echo '<tr><td colspan="3" class="heading">';
368         echo get_string('incomingcontacts', 'message', $countstrangers);
369         echo '</td></tr>';
371         foreach ($strangers as $stranger) {
372             if ($minmessages==0 || $stranger->messagecount>=$minmessages) {
373                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
374             }
375         }
376     }
378     echo '</table>';
380     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
381         echo '<div class="note">(';
382         print_string('addsomecontactsincoming', 'message');
383         echo ')</div>';
384     }
386     echo '<br />';
388     if ($refresh) {
389         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
391         echo $OUTPUT->container_start('messagejsautorefresh note center');
392         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
393         echo $OUTPUT->container_end();
395         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
396         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
397         echo $OUTPUT->container_end();
398     }
401 function message_print_usergroup_selector($usergroup, &$courses, &$coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
402     $strblockedusers = null;
403     $options = array();
405     if ($countunreadtotal>0) { //if there are unread messages
406         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
407     }
409     $strcontacts = get_string('mycontacts', 'message');
410     $options[VIEW_CONTACTS] = $strcontacts;
412     if (!empty($courses)) {
413         $courses_options = array();
415         foreach($courses as $course) {
416             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
417                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
418             }
419         }
421         if (!empty($courses_options)) {
422             $options[] = array(get_string('courses')=>$courses_options);
423         }
424     }
426     if ($countblocked>0) {
427         $strblockedusers = get_string('blockedusers','message', $countblocked);
428         $options[VIEW_BLOCKED] = $strblockedusers;
429     }
431     echo html_writer::start_tag('form', array('id'=>'usergroupform','method'=>'get','action'=>''));
432         echo html_writer::start_tag('fieldset');
433             echo html_writer::select($options, 'usergroup', $usergroup, false, array('id'=>'usergroup','onchange'=>'this.form.submit()'));
434         echo html_writer::end_tag('fieldset');
435     echo html_writer::end_tag('form');
438 function message_get_course_contexts(&$courses) {
439     $coursecontexts = array();
441     foreach($courses as $course) {
442         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
443     }
445     return $coursecontexts;
448 /**
449  * strip off action parameters like 'removecontact'
450  */
451 function message_remove_url_params($moodleurl) {
452     $newurl = new moodle_url($moodleurl);
453     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
454     return $newurl->out();
458 /// $messagearray is an array of objects
459 /// $field is a valid property of object
460 /// $value is the value $field should equal to be counted
461 /// if $field is empty then return count of the whole array
462 /// if $field is non-existent then return 0;
463 function message_count_messages($messagearray, $field='', $value='') {
464     if (!is_array($messagearray)) return 0;
465     if ($field == '' or empty($messagearray)) return count($messagearray);
467     $count = 0;
468     foreach ($messagearray as $message) {
469         $count += ($message->$field == $value) ? 1 : 0;
470     }
471     return $count;
474 /**
475  * Returns the count of unread messages for user. Either from a specific user or from all users.
476  * @global <type> $USER
477  * @global <type> $DB
478  * @param object $user1 the first user. Defaults to $USER
479  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
480  * @return int the count of $user1's unread messages
481  */
482 function message_count_unread_messages($user1=null, $user2=null) {
483     global $USER, $DB;
485     if (empty($user1)) {
486         $user1 = $USER;
487     }
489     if (!empty($user2)) {
490         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
491             array($user1->id, $user2->id), "COUNT('id')");
492     } else {
493         return $DB->count_records_select('message', "useridto = ?",
494             array($user1->id), "COUNT('id')");
495     }
498 function message_count_blocked_users($user1=null) {
499     global $USER, $DB;
501     if (empty($user1)) {
502         $user1 = $USER;
503     }
505     $sql = "SELECT count(mc.id)
506             FROM {message_contacts} mc
507             WHERE mc.userid = :userid AND mc.blocked = 1";
508     $params = array('userid'=>$user1->id);
510     return $DB->count_records_sql($sql, $params);
513 /**
514  *
515  * @global <type> $USER
516  * @global <type> $PAGE
517  * @global <type> $OUTPUT
518  * @param  boolean advancedsearch show basic or advanced search form
519  * @return boolean was a search performed?
520  */
521 function message_print_search($advancedsearch = false, $user1=null) {
522     global $USER, $PAGE, $OUTPUT;
524     $frm = data_submitted();
526     $doingsearch = false;
527     if ($frm) {
528         if (confirm_sesskey()) {
529             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
530         } else {
531             $frm = false;
532         }
533     }
535     if (!empty($frm->combinedsearch)) {
536         $combinedsearchstring = $frm->combinedsearch;
537     } else {
538         //$combinedsearchstring = get_string('searchcombined','message').'...';
539         $combinedsearchstring = '';
540     }
542     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
544     if ($doingsearch) {
545         if ($advancedsearch) {
547             $messagesearch = '';
548             if (!empty($frm->keywords)) {
549                 $messagesearch = $frm->keywords;
550             }
551             $personsearch = '';
552             if (!empty($frm->name)) {
553                 $personsearch = $frm->name;
554             }
555             include('search_advanced.html');
556         } else {
557             include('search.html');
558         }
560         $showicontext = false;
561         message_print_search_results($frm, $showicontext, $user1);
563         return true;
564     } else {
565 /*
566 /// unfinished buggy code disabled in search.html anyway
567         // find all courses this use has readallmessages capabilities in
568         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
569             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
570             $cs = '<select name="courseselect">';
571             foreach ($teachers as $tcourse) {
572                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
573             }
574             $cs .= '</select>';
575         }
576 */
578         if ($advancedsearch) {
579             $personsearch = $messagesearch = '';
580             include('search_advanced.html');
581         } else {
582             include('search.html');
583         }
584         return false;
585     }
588 function message_print_settings() {
589     global $USER, $OUTPUT, $PAGE;
591     if ($frm = data_submitted() and confirm_sesskey()) {
593         $pref = array();
594         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
595         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
597         set_user_preferences($pref);
599         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
600     }
602     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
603     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
605     include('settings.html');
610 function message_add_contact($contactid, $blocked=0) {
611     global $USER, $DB;
613     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
614         return false;
615     }
617     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
618     /// record already exists - we may be changing blocking status
620         if ($contact->blocked !== $blocked) {
621         /// change to blocking status
622             $contact->blocked = $blocked;
623             return $DB->update_record('message_contacts', $contact);
624         } else {
625         /// no changes to blocking status
626             return true;
627         }
629     } else {
630     /// new contact record
631         unset($contact);
632         $contact->userid = $USER->id;
633         $contact->contactid = $contactid;
634         $contact->blocked = $blocked;
635         return $DB->insert_record('message_contacts', $contact, false);
636     }
639 function message_remove_contact($contactid) {
640     global $USER, $DB;
641     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
644 function message_unblock_contact($contactid) {
645     global $USER, $DB;
646     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
649 function message_block_contact($contactid) {
650     return message_add_contact($contactid, 1);
653 function message_get_contact($contactid) {
654     global $USER, $DB;
655     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
660 function message_print_search_results($frm, $showicontext=false, $user1=null) {
661     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
663     if (empty($user1)) {
664         $user1 = $USER;
665     }
667     echo '<div class="mdl-left">';
669     $personsearch = false;
670     $personsearchstring = null;
671     if (!empty($frm->personsubmit) and !empty($frm->name)) {
672         $personsearch = true;
673         $personsearchstring = $frm->name;
674     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
675         $personsearch = true;
676         $personsearchstring = $frm->combinedsearch;
677     }
679     /// search for person
680     if ($personsearch) {
681         if (optional_param('mycourses', 0, PARAM_BOOL)) {
682             $users = array();
683             $mycourses = enrol_get_my_courses();
684             foreach ($mycourses as $mycourse) {
685                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
686                     foreach ($susers as $suser) $users[$suser->id] = $suser;
687                 }
688             }
689         } else {
690             $users = message_search_users(SITEID, $personsearchstring);
691         }
693         if (!empty($users)) {
694             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
695             echo get_string('userssearchresults', 'message', count($users));
696             echo html_writer::end_tag('p');
698             echo '<table class="messagesearchresults">';
699             foreach ($users as $user) {
701                 if ( $user->contactlistid )  {
702                     if ($user->blocked == 0) { /// not blocked
703                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
704                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
705                     } else { // blocked
706                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
707                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
708                     }
709                 } else {
710                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
711                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
712                 }
714                 //should we show just the icon or icon and text?
715                 $histicontext = 'icon';
716                 if ($showicontext) {
717                     $histicontext = 'both';
718                 }
719                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
721                 echo '<tr><td class="pix">';
722                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
723                 echo '</td>';
724                 echo '<td class="contact">';
725                 $popupoptions = array(
726                         'height' => MESSAGE_DISCUSSION_HEIGHT,
727                         'width' => MESSAGE_DISCUSSION_WIDTH,
728                         'menubar' => false,
729                         'location' => false,
730                         'status' => true,
731                         'scrollbars' => true,
732                         'resizable' => true);
734                 $link = new moodle_url("/message/index.php?id=$user->id");
735                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
736                 $action = null;
737                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
739                 echo '</td>';
741                 echo '<td class="link">'.$strcontact.'</td>';
742                 echo '<td class="link">'.$strblock.'</td>';
743                 echo '<td class="link">'.$strhistory.'</td>';
744                 echo '</tr>';
745             }
746             echo '</table>';
748         } else {
749             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
750             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
751             echo html_writer::end_tag('p');
752         }
753     }
755     // search messages for keywords
756     $messagesearch = false;
757     $messagesearchstring = null;
758     if (!empty($frm->keywords)) {
759         $messagesearch = true;
760         $messagesearchstring = clean_text(trim($frm->keywords));
761     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
762         $messagesearch = true;
763         $messagesearchstring = clean_text(trim($frm->combinedsearch));
764     }
766     if ($messagesearch) {
767         if ($messagesearchstring) {
768             $keywords = explode(' ', $messagesearchstring);
769         } else {
770             $keywords = array();
771         }
772         $tome     = false;
773         $fromme   = false;
774         $courseid = 'none';
776         if (empty($frm->keywordsoption)) {
777             $frm->keywordsoption = 'allmine';
778         }
780         switch ($frm->keywordsoption) {
781             case 'tome':
782                 $tome   = true;
783                 break;
784             case 'fromme':
785                 $fromme = true;
786                 break;
787             case 'allmine':
788                 $tome   = true;
789                 $fromme = true;
790                 break;
791             case 'allusers':
792                 $courseid = SITEID;
793                 break;
794             case 'courseusers':
795                 $courseid = $frm->courseid;
796                 break;
797             default:
798                 $tome   = true;
799                 $fromme = true;
800         }
802         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
804         /// get a list of contacts
805             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
806                 $contacts = array();
807             }
809         /// print heading with number of results
810             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
811             $countresults = count($messages);
812             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
813                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
814             } else {
815                 echo get_string('keywordssearchresults', 'message', $countresults);
816             }
817             echo html_writer::end_tag('p');
819         /// print table headings
820             echo '<table class="messagesearchresults" cellspacing="0">';
822             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
823             $headertdend   = html_writer::end_tag('td');
824             echo '<tr>';
825             echo $headertdstart.get_string('from').$headertdend;
826             echo $headertdstart.get_string('to').$headertdend;
827             echo $headertdstart.get_string('message', 'message').$headertdend;
828             echo $headertdstart.get_string('timesent', 'message').$headertdend;
829             echo "</tr>\n";
831             $blockedcount = 0;
832             $dateformat = get_string('strftimedatetimeshort');
833             $strcontext = get_string('context', 'message');
834             foreach ($messages as $message) {
836             /// ignore messages to and from blocked users unless $frm->includeblocked is set
837                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
838                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
839                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
840                                                 )
841                    ) {
842                     $blockedcount ++;
843                     continue;
844                 }
846             /// load up user to record
847                 if ($message->useridto !== $USER->id) {
848                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
849                     $tocontact = (array_key_exists($message->useridto, $contacts) and
850                                     ($contacts[$message->useridto]->blocked == 0) );
851                     $toblocked = (array_key_exists($message->useridto, $contacts) and
852                                     ($contacts[$message->useridto]->blocked == 1) );
853                 } else {
854                     $userto = false;
855                     $tocontact = false;
856                     $toblocked = false;
857                 }
859             /// load up user from record
860                 if ($message->useridfrom !== $USER->id) {
861                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
862                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
863                                     ($contacts[$message->useridfrom]->blocked == 0) );
864                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
865                                     ($contacts[$message->useridfrom]->blocked == 1) );
866                 } else {
867                     $userfrom = false;
868                     $fromcontact = false;
869                     $fromblocked = false;
870                 }
872             /// find date string for this message
873                 $date = usergetdate($message->timecreated);
874                 $datestring = $date['year'].$date['mon'].$date['mday'];
876             /// print out message row
877                 echo '<tr valign="top">';
878                 echo '<td class="contact">';
879                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
880                 echo '</td>';
881                 echo '<td class="contact">';
882                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
883                 echo '</td>';
884                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
885                 echo '<br /><div class="link">';
887                 //find the user involved that isn't the current user
888                 $user2id = null;
889                 if ($user1->id == $message->useridto) {
890                     $user2id = $message->useridfrom;
891                 } else {
892                     $user2id = $message->useridto;
893                 }
894                 message_history_link($user1->id, $user2id, false,
895                                      $messagesearchstring, 'm'.$message->id, $strcontext);
896                 echo '</div>';
897                 echo '</td>';
898                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
899                 echo "</tr>\n";
900             }
903             if ($blockedcount > 0) {
904                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
905             }
906             echo '</table>';
908         } else {
909             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
910         }
911     }
913     if (!$personsearch && !$messagesearch) {
914         //they didn't enter any search terms
915         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
916     }
918     //echo '<br />';
919     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
921     echo '</div>';
925 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
926     global $USER, $OUTPUT;
928     if ($user === false) {
929         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
930     } else {
931         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
932         echo '&nbsp;';
934         $return = false;
935         $script = null;
936         if ($iscontact) {
937             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
938         } else {
939             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
940         }
941         echo '&nbsp;';
942         if ($isblocked) {
943             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
944         } else {
945             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
946         }
947         echo '<br />';
949         $popupoptions = array(
950                 'height' => MESSAGE_DISCUSSION_HEIGHT,
951                 'width' => MESSAGE_DISCUSSION_WIDTH,
952                 'menubar' => false,
953                 'location' => false,
954                 'status' => true,
955                 'scrollbars' => true,
956                 'resizable' => true);
958         $link = new moodle_url("/message/index.php?id=$user->id");
959         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
960         $action = null;
961         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
963     }
967 /// linktype can be: add, remove, block, unblock
968 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
969     global $USER, $CFG, $OUTPUT, $PAGE;
971     //hold onto the strings as we're probably creating a bunch of links
972     static $str;
974     if (empty($script)) {
975         //strip off previous action params like 'removecontact'
976         $script = message_remove_url_params($PAGE->url);
977     }
979     if (empty($str->blockcontact)) {
980        $str->blockcontact   =  get_string('blockcontact', 'message');
981        $str->unblockcontact =  get_string('unblockcontact', 'message');
982        $str->removecontact  =  get_string('removecontact', 'message');
983        $str->addcontact     =  get_string('addcontact', 'message');
984     }
986     $command = $linktype.'contact';
987     $string  = $str->{$command};
989     $safealttext = s($string);
991     $safestring = '';
992     if (!empty($text)) {
993         $safestring = $safealttext;
994     }
996     $img = '';
997     if ($icon) {
998         $iconpath = null;
999         switch ($linktype) {
1000             case 'block':
1001                 $iconpath = 't/block';
1002                 break;
1003             case 'unblock':
1004                 $iconpath = 't/userblue';
1005                 break;
1006             case 'remove':
1007                 $iconpath = 'i/cross_red_big';
1008                 break;
1009             case 'add':
1010             default:
1011                 $iconpath = 't/addgreen';
1012         }
1014         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1015     }
1017     $output = '<span class="'.$linktype.'contact">'.
1018               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1019               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1020               $img.
1021               $safestring.'</a></span>';
1023     if ($return) {
1024         return $output;
1025     } else {
1026         echo $output;
1027         return true;
1028     }
1031 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1032     global $USER, $CFG, $OUTPUT;
1034     static $strmessagehistory;
1036     if (empty($strmessagehistory)) {
1037         $strmessagehistory = get_string('messagehistory', 'message');
1038     }
1040     if ($position) {
1041         $position = "#$position";
1042     }
1043     if ($keywords) {
1044         $keywords = "&search=".urlencode($keywords);
1045     }
1047     if ($linktext == 'icon') {  // Icon only
1048         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1049     } else if ($linktext == 'both') {  // Icon and standard name
1050         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1051         $fulllink .= '&nbsp;'.$strmessagehistory;
1052     } else if ($linktext) {    // Custom name
1053         $fulllink = $linktext;
1054     } else {                   // Standard name only
1055         $fulllink = $strmessagehistory;
1056     }
1058     $popupoptions = array(
1059             'height' => 500,
1060             'width' => 500,
1061             'menubar' => false,
1062             'location' => false,
1063             'status' => true,
1064             'scrollbars' => true,
1065             'resizable' => true);
1067     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1068     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1069     $action = null;
1070     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1072     $str = '<span class="history">'.$str.'</span>';
1074     if ($returnstr) {
1075         return $str;
1076     } else {
1077         echo $str;
1078         return true;
1079     }
1083 /**
1084  * Search through course users
1085  *
1086  * If $coursid specifies the site course then this function searches
1087  * through all undeleted and confirmed users
1088  *
1089  * @uses $CFG, $USER
1090  * @uses SITEID
1091  * @param int $courseid The course in question.
1092  * @param string $searchtext ?
1093  * @param string $sort ?
1094  * @param string $exceptions ?
1095  * @return array  An array of {@link $USER} records.
1096  * @todo Finish documenting this function
1097  */
1098 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1099     global $CFG, $USER, $DB;
1101     $fullname = $DB->sql_fullname();
1103     if (!empty($exceptions)) {
1104         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1105     } else {
1106         $except = '';
1107     }
1109     if (!empty($sort)) {
1110         $order = ' ORDER BY '. $sort;
1111     } else {
1112         $order = '';
1113     }
1115     $ufields = user_picture::fields('u');
1116     if (!$courseid or $courseid == SITEID) {
1117         $params = array($USER->id, "%$searchtext%");
1118         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1119                                        FROM {user} u
1120                                        LEFT JOIN {message_contacts} mc
1121                                             ON mc.contactid = u.id AND mc.userid = ?
1122                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1123                                             AND (".$DB->sql_like($fullname, '?', false).")
1124                                             $except
1125                                      $order", $params);
1126     } else {
1127 //TODO: add enabled enrolment join here (skodak)
1128         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1129         $contextlists = get_related_contexts_string($context);
1131         // everyone who has a role assignment in this course or higher
1132         $params = array($USER->id, "%$searchtext%");
1133         $users = $DB->get_records_sql("SELECT $ufields,
1134                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1135                                          JOIN {role_assignments} ra ON ra.userid = u.id
1136                                          LEFT JOIN {message_contacts} mc
1137                                               ON mc.contactid = u.id AND mc.userid = ?
1138                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1139                                               AND ra.contextid $contextlists
1140                                               AND (".$DB->sql_like($fullname, '?', false).")
1141                                               $except
1142                                        $order", $params);
1144         return $users;
1145     }
1151 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1152 /// Returns a list of posts found using an array of search terms
1153 /// eg   word  +word -word
1154 ///
1155     global $CFG, $USER, $DB;
1157     /// If no userid sent then assume current user
1158     if ($userid == 0) $userid = $USER->id;
1160     /// Some differences in SQL syntax
1161     if ($DB->sql_regex_supported()) {
1162         $REGEXP    = $DB->sql_regex(true);
1163         $NOTREGEXP = $DB->sql_regex(false);
1164     }
1166     $searchcond = array();
1167     $params = array();
1168     $i = 0;
1170     //preprocess search terms to check whether we have at least 1 eligible search term
1171     //if we do we can drop words around it like 'a'
1172     $dropshortwords = false;
1173     foreach ($searchterms as $searchterm) {
1174         if (strlen($searchterm) >= 2) {
1175             $dropshortwords = true;
1176         }
1177     }
1179     foreach ($searchterms as $searchterm) {
1180         $i++;
1182         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1184         if ($dropshortwords && strlen($searchterm) < 2) {
1185             continue;
1186         }
1187     /// Under Oracle and MSSQL, trim the + and - operators and perform
1188     /// simpler LIKE search
1189         if (!$DB->sql_regex_supported()) {
1190             if (substr($searchterm, 0, 1) == '-') {
1191                 $NOT = true;
1192             }
1193             $searchterm = trim($searchterm, '+-');
1194         }
1196         if (substr($searchterm,0,1) == "+") {
1197             $searchterm = substr($searchterm,1);
1198             $searchterm = preg_quote($searchterm, '|');
1199             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1200             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1202         } else if (substr($searchterm,0,1) == "-") {
1203             $searchterm = substr($searchterm,1);
1204             $searchterm = preg_quote($searchterm, '|');
1205             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1206             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1208         } else {
1209             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1210             $params['ss'.$i] = "%$searchterm%";
1211         }
1212     }
1214     if (empty($searchcond)) {
1215         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1216         $params['ss1'] = "%";
1217     } else {
1218         $searchcond = implode(" AND ", $searchcond);
1219     }
1221     /// There are several possibilities
1222     /// 1. courseid = SITEID : The admin is searching messages by all users
1223     /// 2. courseid = ??     : A teacher is searching messages by users in
1224     ///                        one of their courses - currently disabled
1225     /// 3. courseid = none   : User is searching their own messages;
1226     ///    a.  Messages from user
1227     ///    b.  Messages to user
1228     ///    c.  Messages to and from user
1230     if ($courseid == SITEID) { /// admin is searching all messages
1231         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1232                                             FROM {message_read} m
1233                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1234         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1235                                             FROM {message} m
1236                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1238     } else if ($courseid !== 'none') {
1239         /// This has not been implemented due to security concerns
1240         $m_read   = array();
1241         $m_unread = array();
1243     } else {
1245         if ($fromme and $tome) {
1246             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1247             $params['userid1'] = $userid;
1248             $params['userid2'] = $userid;
1250         } else if ($fromme) {
1251             $searchcond .= " AND m.useridfrom=:userid";
1252             $params['userid'] = $userid;
1254         } else if ($tome) {
1255             $searchcond .= " AND m.useridto=:userid";
1256             $params['userid'] = $userid;
1257         }
1259         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1260                                             FROM {message_read} m
1261                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1262         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1263                                             FROM {message} m
1264                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1266     }
1268     /// The keys may be duplicated in $m_read and $m_unread so we can't
1269     /// do a simple concatenation
1270     $message = array();
1271     foreach ($m_read as $m) {
1272         $messages[] = $m;
1273     }
1274     foreach ($m_unread as $m) {
1275         $messages[] = $m;
1276     }
1278     return (empty($messages)) ? false : $messages;
1283 /// Borrowed with changes from mod/forum/lib.php
1284 function message_shorten_message($message, $minlength=0) {
1285 // Given a post object that we already know has a long message
1286 // this function truncates the message nicely to the first
1287 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1289     $i = 0;
1290     $tag = false;
1291     $length = strlen($message);
1292     $count = 0;
1293     $stopzone = false;
1294     $truncate = 0;
1295     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1298     for ($i=0; $i<$length; $i++) {
1299         $char = $message[$i];
1301         switch ($char) {
1302             case "<":
1303                 $tag = true;
1304                 break;
1305             case ">":
1306                 $tag = false;
1307                 break;
1308             default:
1309                 if (!$tag) {
1310                     if ($stopzone) {
1311                         if ($char == '.' or $char == ' ') {
1312                             $truncate = $i+1;
1313                             break 2;
1314                         }
1315                     }
1316                     $count++;
1317                 }
1318                 break;
1319         }
1320         if (!$stopzone) {
1321             if ($count > $minlength) {
1322                 $stopzone = true;
1323             }
1324         }
1325     }
1327     if (!$truncate) {
1328         $truncate = $i;
1329     }
1331     return substr($message, 0, $truncate);
1335 /**
1336  * Given a string and an array of keywords, this function looks
1337  * for the first keyword in the string, and then chops out a
1338  * small section from the text that shows that word in context.
1339  */
1340 function message_get_fragment($message, $keywords) {
1342     $fullsize = 160;
1343     $halfsize = (int)($fullsize/2);
1345     $message = strip_tags($message);
1347     foreach ($keywords as $keyword) {  // Just get the first one
1348         if ($keyword !== '') {
1349             break;
1350         }
1351     }
1352     if (empty($keyword)) {   // None found, so just return start of message
1353         return message_shorten_message($message, 30);
1354     }
1356     $leadin = $leadout = '';
1358 /// Find the start of the fragment
1359     $start = 0;
1360     $length = strlen($message);
1362     $pos = strpos($message, $keyword);
1363     if ($pos > $halfsize) {
1364         $start = $pos - $halfsize;
1365         $leadin = '...';
1366     }
1367 /// Find the end of the fragment
1368     $end = $start + $fullsize;
1369     if ($end > $length) {
1370         $end = $length;
1371     } else {
1372         $leadout = '...';
1373     }
1375 /// Pull out the fragment and format it
1377     $fragment = substr($message, $start, $end - $start);
1378     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1379     return $fragment;
1382 //retrieve the messages between two users
1383 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1384     global $DB, $CFG;
1386     $messages = array();
1388     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1389     //desc to get the last $limitnum messages then flip the order in php
1390     $sort = 'asc';
1391     if ($limitnum>0) {
1392         $sort = 'desc';
1393     }
1395     $notificationswhere = null;
1396     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1397     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1398         $notificationswhere = 'AND notification=0';
1399     }
1401     //prevent notifications of your own actions appearing in your own message history
1402     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1404     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1405                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1406                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1407                                                     "timecreated $sort", '*', 0, $limitnum)) {
1408         foreach ($messages_read as $message) {
1409             $messages[$message->timecreated] = $message;
1410         }
1411     }
1412     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1413                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1414                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1415                                                     "timecreated $sort", '*', 0, $limitnum)) {
1416         foreach ($messages_new as $message) {
1417             $messages[$message->timecreated] = $message;
1418         }
1419     }
1421     //if we only want the last $limitnum messages
1422     ksort($messages);
1423     $messagecount = count($messages);
1424     if ($limitnum>0 && $messagecount>$limitnum) {
1425         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1426     }
1428     return $messages;
1431 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1432     global $CFG, $OUTPUT;
1434     echo $OUTPUT->box_start('center');
1435     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1436     echo '<td align="center" id="user1">';
1437     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1438     echo '<div class="heading">'.fullname($user1).'</div>';
1439     echo '</td>';
1440     echo '<td align="center">';
1441     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1442     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1443     echo '</td>';
1444     echo '<td align="center" id="user2">';
1445     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1446     echo '<div class="heading">'.fullname($user2).'</div>';
1448     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1449         $incontactlist = $user2->iscontact;
1450         $isblocked = $user2->isblocked;
1452         $script = null;
1453         $text = true;
1454         $icon = false;
1456         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1457         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1458         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1460         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1461     }
1463     echo '</td>';
1464     echo '</tr></table>';
1465     echo $OUTPUT->box_end();
1467     if (!empty($messagehistorylink)) {
1468         echo $messagehistorylink;
1469     }
1471     /// Get all the messages and print them
1472     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1473         $tablecontents = '';
1475         $current = new stdClass();
1476         $current->mday = '';
1477         $current->month = '';
1478         $current->year = '';
1479         $messagedate = get_string('strftimetime');
1480         $blockdate   = get_string('strftimedaydate');
1481         foreach ($messages as $message) {
1482             if ($message->notification) {
1483                 $notificationclass = ' notification';
1484             } else {
1485                 $notificationclass = null;
1486             }
1487             $date = usergetdate($message->timecreated);
1488             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1489                 $current->mday = $date['mday'];
1490                 $current->month = $date['month'];
1491                 $current->year = $date['year'];
1493                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1494                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1495             }
1496             if ($message->useridfrom == $user1->id) {
1497                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1498             } else {
1499                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1500             }
1501         }
1503         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1504     } else {
1505         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1506     }
1509 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1511     static $dateformat;
1513     if (empty($dateformat)) {
1514         if ($format) {
1515             $dateformat = $format;
1516         } else {
1517             $format = get_string('strftimedatetimeshort');
1518         }
1519     }
1520     $time = userdate($message->timecreated, $dateformat);
1521     $options = new stdClass();
1522     $options->para = false;
1524     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1525     if (!empty($message->smallmessage)) {
1526         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1527     } else {
1528         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1529     }
1531     if (!empty($message->contexturl)) {
1532         $displaytext = null;
1533         if (!empty($message->contexturlname)) {
1534             $displaytext= $message->contexturlname;
1535         } else {
1536             $displaytext= $message->contexturl;
1537         }
1538         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1539             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1540         $messagetext .= html_writer::end_tag('div');
1541     }
1543     if ($keywords) {
1544         $messagetext = highlight($keywords, $messagetext);
1545     }
1547     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1550 /**
1551  * Inserts a message into the database, but also forwards it
1552  * via other means if appropriate.
1553  * @return int|false the ID of the new message or false
1554  */
1555 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1556     global $SITE, $CFG, $USER;
1558     $eventdata = new stdClass();
1559     $eventdata->component        = 'moodle';
1560     $eventdata->name             = 'instantmessage';
1561     $eventdata->userfrom         = $userfrom;
1562     $eventdata->userto           = $userto;
1564     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1565     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1567     if ($format==FORMAT_HTML) {
1568         $eventdata->fullmessage      = '';
1569         $eventdata->fullmessagehtml  = $message;
1570     } else {
1571         $eventdata->fullmessage      = $message;
1572         $eventdata->fullmessagehtml  = '';
1573     }
1575     $eventdata->fullmessageformat = $format;
1576     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1578     $s = new stdClass();
1579     $s->sitename = $SITE->shortname;
1580     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1582     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1583     if (!empty($eventdata->fullmessage)) {
1584         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1585     }
1586     if (!empty($eventdata->fullmessagehtml)) {
1587         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1588     }
1590     $eventdata->timecreated     = time();
1591     return message_send($eventdata);
1595 /**
1596  * Returns a list of all user ids who have used messaging in the site
1597  * This was the simple way to code the SQL ... is it going to blow up
1598  * on large datasets?
1599  */
1600 function message_get_participants() {
1601     global $CFG, $DB;
1603         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1604                                UNION SELECT useridto as id,1 FROM {message}
1605                                UNION SELECT useridfrom as id,1 FROM {message_read}
1606                                UNION SELECT useridto as id,1 FROM {message_read}
1607                                UNION SELECT userid as id,1 FROM {message_contacts}
1608                                UNION SELECT contactid as id,1 from {message_contacts}");
1611 /**
1612  * Print a row of contactlist displaying user picture, messages waiting and
1613  * block links etc
1614  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1615  * @param $incontactlist is the user a contact of ours?
1616  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1617  */
1618 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1619     global $OUTPUT, $USER;
1620     $fullname  = fullname($contact);
1621     $fullnamelink  = $fullname;
1623     $linkclass = '';
1624     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1625         $linkclass = 'messageselecteduser';
1626     }
1628     /// are there any unread messages for this contact?
1629     if ($contact->messagecount > 0 ){
1630         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1631     }
1633     $strcontact = $strblock = $strhistory = null;
1635     if ($showactionlinks) {
1636         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1637         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1638         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1639     }
1641     echo '<tr><td class="pix">';
1642     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1643     echo '</td>';
1644     echo '<td class="contact">';
1646     $popupoptions = array(
1647             'height' => MESSAGE_DISCUSSION_HEIGHT,
1648             'width' => MESSAGE_DISCUSSION_WIDTH,
1649             'menubar' => false,
1650             'location' => false,
1651             'status' => true,
1652             'scrollbars' => true,
1653             'resizable' => true);
1655     $link = $action = null;
1656     if (!empty($selectcontacturl)) {
1657         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1658     } else {
1659         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1660         $link = new moodle_url("/message/index.php?id=$contact->id");
1661         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1662     }
1663     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1665     echo '</td>';
1666     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1667     echo '</tr>';
1670 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1671     $strcontact = '';
1673     if($incontactlist){
1674         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1675     } else if ($isblocked) {
1676         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1677     } else{
1678         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1679     }
1681     return $strcontact;
1684 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1685     $strblock   = '';
1687     //commented out to allow the user to block a contact without having to remove them first
1688     /*if ($incontactlist) {
1689         //$strblock = '';
1690     } else*/
1691     if ($isblocked) {
1692         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1693     } else{
1694         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1695     }
1697     return $strblock;
1700  /**
1701   * Moves unread messages from message table to message_read for a given from user
1702   * @param object $userid       User id
1703   * @return boolean success
1704   */
1705 function message_move_userfrom_unread2read($userid) {
1707     global $DB;
1709     // move all unread messages from message table to message_read
1710     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1711         foreach ($messages as $message) {
1712             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1713         }
1714     }
1715     return true;
1718 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1719     global $DB;
1721     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1723     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1725     //for every message to process check if it's for current user and process
1726     $messages = array();
1727     foreach ($messagesproc as $msgp){
1728         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1729         if ($fromuserid){
1730             $query['useridfrom'] = $fromuserid;
1731         }
1732         if ($message = $DB->get_record('message', $query)){
1733             $messages[] = $message;
1734             /// Move the entry to the other table
1735             $message->timeread = time();
1736             $messageid = $message->id;
1737             unset($message->id);
1739             //delete what we've processed and check if can move message
1740             $DB->delete_records('message_working', array('id' => $msgp->id));
1741             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1742                 message_mark_message_read($message, time(), true);
1743             }
1744         }
1745     }
1746     return $messages;
1749 /**
1750 * marks ALL messages being sent from $fromuserid to $touserid as read
1751 * @param int $touserid the id of the message recipient
1752 * @param int $fromuserid the id of the message sender
1753 * @return void
1754 */
1755 function message_mark_messages_read($touserid, $fromuserid){
1756     global $DB;
1758     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1759     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1761     foreach ($messages as $message) {
1762         message_mark_message_read($message, time());
1763     }
1766 /**
1767 * Mark a single message as read
1768 * @param message an object with an object property ie $message->id which is an id in the message table
1769 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1770 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1771 * @return int the ID of the message in the message_read table
1772 */
1773 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1774     global $DB;
1776     $message->timeread = $timeread;
1778     $messageid = $message->id;
1779     unset($message->id);//unset because it will get a new id on insert into message_read
1781     //If any processors have pending actions abort them
1782     if (!$messageworkingempty) {
1783         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1784     }
1785     $messagereadid = $DB->insert_record('message_read', $message);
1786     $DB->delete_records('message', array('id' => $messageid));
1787     return $messagereadid;