Merge branch 'w05_MDL-26182_20_nginx' 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('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
61 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
63 define('MESSAGE_CONTACTS_PER_PAGE',10);
65 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
66     $CFG->message_contacts_refresh = 60;
67 }
68 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
69     $CFG->message_chat_refresh = 5;
70 }
71 if (!isset($CFG->message_offline_time)) {
72     $CFG->message_offline_time = 300;
73 }
75 function message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
76     global $PAGE;
78     echo html_writer::start_tag('div', array('class'=>'contactselector mdl-align'));
80         //if 0 unread messages and they've requested unread messages then show contacts
81         if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES) {
82             $usergroup = VIEW_CONTACTS;
83         }
85         //if they have no blocked users and they've requested blocked users switch them over to contacts
86         if (count($blockedusers)==0 && $usergroup==VIEW_BLOCKED) {
87             $usergroup = VIEW_CONTACTS;
88         }
90         $onlyactivecourses = true;
91         $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
92         $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
94         $strunreadmessages = null;
95         if ($countunreadtotal>0) { //if there are unread messages
96             $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
97         }
99         message_print_usergroup_selector($usergroup, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
101         $refreshpage = false;
103         if ($usergroup==VIEW_UNREAD_MESSAGES) {
104             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
105         } else if ($usergroup==VIEW_CONTACTS || $usergroup==VIEW_SEARCH) {
106             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
107         } else if ($usergroup==VIEW_BLOCKED) {
108             message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
109         } else if (substr($usergroup, 0, 7)==VIEW_COURSE) {
110             $courseidtoshow = intval(substr($usergroup, 7));
112             if (!empty($courseidtoshow)
113                 && array_key_exists($courseidtoshow, $coursecontexts)
114                 && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
116                 message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
117             } else {
118                 //shouldn't get here. User trying to access a course they're not in perhaps.
119                 add_to_log(SITEID, 'message', 'view', 'index.php', $usergroup);
120             }
121         }
123         echo html_writer::start_tag('form', array('action'=>'index.php','method'=>'GET'));
124             echo html_writer::start_tag('fieldset');
125                 $managebuttonclass = 'visible';
126                 if ($usergroup==VIEW_SEARCH) {
127                     $managebuttonclass = 'hiddenelement';
128                 }
129                 $strmanagecontacts = get_string('search','message');
130                 echo html_writer::empty_tag('input', array('type'=>'hidden','name'=>'usergroup','value'=>VIEW_SEARCH));
131                 echo html_writer::empty_tag('input', array('type'=>'submit','value'=>$strmanagecontacts,'class'=>$managebuttonclass));
132             echo html_writer::end_tag('fieldset');
133         echo html_writer::end_tag('form');
135     echo html_writer::end_tag('div');
138 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
139     global $DB, $USER, $PAGE, $OUTPUT;
141     $countparticipants = count_enrolled_users($context);
142     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
144     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
145     echo $OUTPUT->render($pagingbar);
147     echo '<table id="message_participants" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
149     if (!empty($titletodisplay)) {
150         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
151     }
153     if (empty($titletodisplay)) {
154         echo '<tr><td colspan="3" class="heading">';
155         echo get_string('participants');
156         echo '</td></tr>';
157     }
159     //todo these need to come from somewhere if the course participants list is to show users with unread messages
160     $iscontact = true;
161     $isblocked = false;
162     foreach ($participants as $participant) {
163         if ($participant->id != $USER->id) {
164             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
165             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
166         }
167     }
168     //$participants->close();
170     echo '</table>';
173 function message_get_blocked_users($user1=null, &$user2=null) {
174     global $DB, $USER;
176     if (empty($user1)) {
177         $user1 = $USER;
178     }
180     if (!empty($user2)) {
181         $user2->isblocked = false;
182     }
184     $userfields = user_picture::fields('u', array('lastaccess'));
185     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
186                           FROM {message_contacts} mc
187                           JOIN {user} u ON u.id = mc.contactid
188                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
189                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
190                       GROUP BY $userfields
191                       ORDER BY u.firstname ASC";
192     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1'=>$user1->id, 'user1id2'=>$user1->id));
194     $blockedusers = array();
195     if (!empty($rs)) {
196         foreach($rs as $rd) {
197             $blockedusers[] = $rd;
199             if (!empty($user2) && $user2->id==$rd->id) {
200                 $user2->isblocked = true;
201             }
202         }
203         unset($rd);
204         $rs->close();
205     }
207     return $blockedusers;
210 function message_print_blocked_users(&$blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
211     global $DB, $USER;
213     $countblocked = count($blockedusers);
215     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
217     if (!empty($titletodisplay)) {
218         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
219     }
221     if ($countblocked) {
222         echo '<tr><td colspan="3" class="heading">';
223         echo get_string('blockedusers', 'message', $countblocked);
224         echo '</td></tr>';
226         foreach ($blockedusers as $blockeduser) {
227             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
228         }
229     }
231     echo '</table>';
234 function message_get_contacts($user1=null, &$user2=null) {
235     global $DB, $CFG, $USER;
237     if (empty($user1)) {
238         $user1 = $USER;
239     }
241     if (!empty($user2)) {
242         $user2->iscontact = false;
243     }
245     $timetoshowusers = 300; //Seconds default
246     if (isset($CFG->block_online_users_timetosee)) {
247         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
248     }
250     // time which a user is counting as being active since
251     $timefrom = time()-$timetoshowusers;
253     // people in our contactlist who are online
254     $onlinecontacts  = array();
255     // people in our contactlist who are offline
256     $offlinecontacts = array();
257     // people who are not in our contactlist but have sent us a message
258     $strangers       = array();
260     $userfields = user_picture::fields('u', array('lastaccess'));
262     // get all in our contactlist who are not blocked in our contact list
263     // and count messages we have waiting from each of them
264     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
265                      FROM {message_contacts} mc
266                      JOIN {user} u ON u.id = mc.contactid
267                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
268                     WHERE mc.userid = ? AND mc.blocked = 0
269                  GROUP BY $userfields
270                  ORDER BY u.firstname ASC";
272     if ($rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id))){
273         foreach($rs as $rd){
275             if($rd->lastaccess >= $timefrom){
276                 // they have been active recently, so are counted online
277                 $onlinecontacts[] = $rd;
279             }else{
280                 $offlinecontacts[] = $rd;
281             }
283             if (!empty($user2) && $user2->id==$rd->id) {
284                 $user2->iscontact = true;
285             }
286         }
287         unset($rd);
288         $rs->close();
289     }
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     if($rs = $DB->get_recordset_sql($strangersql, array($USER->id))){
302         foreach($rs as $rd){
303             $strangers[] = $rd;
304         }
305         unset($rd);
306         $rs->close();
307     }
309     return array($onlinecontacts, $offlinecontacts, $strangers);
312 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refresh=true, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
313     global $CFG, $PAGE, $OUTPUT;
315     $countonlinecontacts  = count($onlinecontacts);
316     $countofflinecontacts = count($offlinecontacts);
317     $countstrangers       = count($strangers);
319     if ($countonlinecontacts + $countofflinecontacts == 0) {
320         echo '<div class="heading">';
321         print_string('contactlistempty', 'message');
322         echo '</div>';
323         //echo '<div class="note">';
324         //print_string('addsomecontacts', 'message', message_remove_url_params($PAGE->url).'?tab=search');
325         //echo '</div>';
326     }
328     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
330     if (!empty($titletodisplay)) {
331         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
332     }
334     if($countonlinecontacts) {
335         /// print out list of online contacts
337         if (empty($titletodisplay)) {
338             echo '<tr><td colspan="3" class="heading">';
339             echo get_string('onlinecontacts', 'message', $countonlinecontacts);
340             echo '</td></tr>';
341         }
343         foreach ($onlinecontacts as $contact) {
344             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
345                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
346             }
347         }
348     }
350     if ($countofflinecontacts) {
351         /// print out list of offline contacts
353         if (empty($titletodisplay)) {
354             echo '<tr><td colspan="3" class="heading">';
355             echo get_string('offlinecontacts', 'message', $countofflinecontacts);
356             echo '</td></tr>';
357         }
359         foreach ($offlinecontacts as $contact) {
360             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
361                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
362             }
363         }
364         echo '<tr><td colspan="3">&nbsp;</td></tr>';
365     }
367     /// print out list of incoming contacts
368     if ($countstrangers) {
369         echo '<tr><td colspan="3" class="heading">';
370         echo get_string('incomingcontacts', 'message', $countstrangers);
371         echo '</td></tr>';
373         foreach ($strangers as $stranger) {
374             if ($minmessages==0 || $stranger->messagecount>=$minmessages) {
375                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
376             }
377         }
378     }
380     echo '</table>';
382     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
383         echo '<div class="note">(';
384         print_string('addsomecontactsincoming', 'message');
385         echo ')</div>';
386     }
388     echo '<br />';
390     if ($refresh) {
391         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
393         echo $OUTPUT->container_start('messagejsautorefresh note center');
394         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
395         echo $OUTPUT->container_end();
397         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
398         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
399         echo $OUTPUT->container_end();
400     }
403 function message_print_usergroup_selector($usergroup, &$courses, &$coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
404     $strblockedusers = null;
405     $options = array();
407     if ($countunreadtotal>0) { //if there are unread messages
408         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
409     }
411     $strcontacts = get_string('mycontacts', 'message');
412     $options[VIEW_CONTACTS] = $strcontacts;
414     if (!empty($courses)) {
415         $courses_options = array();
417         foreach($courses as $course) {
418             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
419                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
420             }
421         }
423         if (!empty($courses_options)) {
424             $options[] = array(get_string('courses')=>$courses_options);
425         }
426     }
428     if ($countblocked>0) {
429         $strblockedusers = get_string('blockedusers','message', $countblocked);
430         $options[VIEW_BLOCKED] = $strblockedusers;
431     }
433     echo html_writer::start_tag('form', array('id'=>'usergroupform','method'=>'get','action'=>''));
434         echo html_writer::start_tag('fieldset');
435             echo html_writer::select($options, 'usergroup', $usergroup, false, array('id'=>'usergroup','onchange'=>'this.form.submit()'));
436         echo html_writer::end_tag('fieldset');
437     echo html_writer::end_tag('form');
440 function message_get_course_contexts(&$courses) {
441     $coursecontexts = array();
443     foreach($courses as $course) {
444         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
445     }
447     return $coursecontexts;
450 /**
451  * strip off action parameters like 'removecontact'
452  */
453 function message_remove_url_params($moodleurl) {
454     $newurl = new moodle_url($moodleurl);
455     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
456     return $newurl->out();
460 /// $messagearray is an array of objects
461 /// $field is a valid property of object
462 /// $value is the value $field should equal to be counted
463 /// if $field is empty then return count of the whole array
464 /// if $field is non-existent then return 0;
465 function message_count_messages($messagearray, $field='', $value='') {
466     if (!is_array($messagearray)) return 0;
467     if ($field == '' or empty($messagearray)) return count($messagearray);
469     $count = 0;
470     foreach ($messagearray as $message) {
471         $count += ($message->$field == $value) ? 1 : 0;
472     }
473     return $count;
476 /**
477  * Returns the count of unread messages for user. Either from a specific user or from all users.
478  * @global <type> $USER
479  * @global <type> $DB
480  * @param object $user1 the first user. Defaults to $USER
481  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
482  * @return int the count of $user1's unread messages
483  */
484 function message_count_unread_messages($user1=null, $user2=null) {
485     global $USER, $DB;
487     if (empty($user1)) {
488         $user1 = $USER;
489     }
491     if (!empty($user2)) {
492         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
493             array($user1->id, $user2->id), "COUNT('id')");
494     } else {
495         return $DB->count_records_select('message', "useridto = ?",
496             array($user1->id), "COUNT('id')");
497     }
500 function message_count_blocked_users($user1=null) {
501     global $USER, $DB;
503     if (empty($user1)) {
504         $user1 = $USER;
505     }
507     $sql = "SELECT count(mc.id)
508             FROM {message_contacts} mc
509             WHERE mc.userid = :userid AND mc.blocked = 1";
510     $params = array('userid'=>$user1->id);
512     return $DB->count_records_sql($sql, $params);
515 /**
516  *
517  * @global <type> $USER
518  * @global <type> $PAGE
519  * @global <type> $OUTPUT
520  * @param  boolean advancedsearch show basic or advanced search form
521  * @return boolean was a search performed?
522  */
523 function message_print_search($advancedsearch = false, $user1=null) {
524     global $USER, $PAGE, $OUTPUT;
526     $frm = data_submitted();
528     $doingsearch = false;
529     if ($frm) {
530         if (confirm_sesskey()) {
531             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
532         } else {
533             $frm = false;
534         }
535     }
537     if (!empty($frm->combinedsearch)) {
538         $combinedsearchstring = $frm->combinedsearch;
539     } else {
540         //$combinedsearchstring = get_string('searchcombined','message').'...';
541         $combinedsearchstring = '';
542     }
544     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
546     if ($doingsearch) {
547         if ($advancedsearch) {
549             $messagesearch = '';
550             if (!empty($frm->keywords)) {
551                 $messagesearch = $frm->keywords;
552             }
553             $personsearch = '';
554             if (!empty($frm->name)) {
555                 $personsearch = $frm->name;
556             }
557             include('search_advanced.html');
558         } else {
559             include('search.html');
560         }
562         $showicontext = false;
563         message_print_search_results($frm, $showicontext, $user1);
565         return true;
566     } else {
567 /*
568 /// unfinished buggy code disabled in search.html anyway
569         // find all courses this use has readallmessages capabilities in
570         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
571             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
572             $cs = '<select name="courseselect">';
573             foreach ($teachers as $tcourse) {
574                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
575             }
576             $cs .= '</select>';
577         }
578 */
580         if ($advancedsearch) {
581             $personsearch = $messagesearch = '';
582             include('search_advanced.html');
583         } else {
584             include('search.html');
585         }
586         return false;
587     }
590 function message_print_settings() {
591     global $USER, $OUTPUT, $PAGE;
593     if ($frm = data_submitted() and confirm_sesskey()) {
595         $pref = array();
596         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
597         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
599         set_user_preferences($pref);
601         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
602     }
604     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
605     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
607     include('settings.html');
612 function message_add_contact($contactid, $blocked=0) {
613     global $USER, $DB;
615     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
616         return false;
617     }
619     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
620     /// record already exists - we may be changing blocking status
622         if ($contact->blocked !== $blocked) {
623         /// change to blocking status
624             $contact->blocked = $blocked;
625             return $DB->update_record('message_contacts', $contact);
626         } else {
627         /// no changes to blocking status
628             return true;
629         }
631     } else {
632     /// new contact record
633         unset($contact);
634         $contact->userid = $USER->id;
635         $contact->contactid = $contactid;
636         $contact->blocked = $blocked;
637         return $DB->insert_record('message_contacts', $contact, false);
638     }
641 function message_remove_contact($contactid) {
642     global $USER, $DB;
643     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
646 function message_unblock_contact($contactid) {
647     global $USER, $DB;
648     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
651 function message_block_contact($contactid) {
652     return message_add_contact($contactid, 1);
655 function message_get_contact($contactid) {
656     global $USER, $DB;
657     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
662 function message_print_search_results($frm, $showicontext=false, $user1=null) {
663     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
665     if (empty($user1)) {
666         $user1 = $USER;
667     }
669     echo '<div class="mdl-left">';
671     $personsearch = false;
672     $personsearchstring = null;
673     if (!empty($frm->personsubmit) and !empty($frm->name)) {
674         $personsearch = true;
675         $personsearchstring = $frm->name;
676     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
677         $personsearch = true;
678         $personsearchstring = $frm->combinedsearch;
679     }
681     /// search for person
682     if ($personsearch) {
683         if (optional_param('mycourses', 0, PARAM_BOOL)) {
684             $users = array();
685             $mycourses = enrol_get_my_courses();
686             foreach ($mycourses as $mycourse) {
687                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
688                     foreach ($susers as $suser) $users[$suser->id] = $suser;
689                 }
690             }
691         } else {
692             $users = message_search_users(SITEID, $personsearchstring);
693         }
695         if (!empty($users)) {
696             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
697             echo get_string('userssearchresults', 'message', count($users));
698             echo html_writer::end_tag('p');
700             echo '<table class="messagesearchresults">';
701             foreach ($users as $user) {
703                 if ( $user->contactlistid )  {
704                     if ($user->blocked == 0) { /// not blocked
705                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
706                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
707                     } else { // blocked
708                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
709                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
710                     }
711                 } else {
712                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
713                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
714                 }
716                 //should we show just the icon or icon and text?
717                 $histicontext = 'icon';
718                 if ($showicontext) {
719                     $histicontext = 'both';
720                 }
721                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
723                 echo '<tr><td class="pix">';
724                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
725                 echo '</td>';
726                 echo '<td class="contact">';
727                 $popupoptions = array(
728                         'height' => MESSAGE_DISCUSSION_HEIGHT,
729                         'width' => MESSAGE_DISCUSSION_WIDTH,
730                         'menubar' => false,
731                         'location' => false,
732                         'status' => true,
733                         'scrollbars' => true,
734                         'resizable' => true);
736                 $link = new moodle_url("/message/index.php?id=$user->id");
737                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
738                 $action = null;
739                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
741                 echo '</td>';
743                 echo '<td class="link">'.$strcontact.'</td>';
744                 echo '<td class="link">'.$strblock.'</td>';
745                 echo '<td class="link">'.$strhistory.'</td>';
746                 echo '</tr>';
747             }
748             echo '</table>';
750         } else {
751             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
752             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
753             echo html_writer::end_tag('p');
754         }
755     }
757     // search messages for keywords
758     $messagesearch = false;
759     $messagesearchstring = null;
760     if (!empty($frm->keywords)) {
761         $messagesearch = true;
762         $messagesearchstring = clean_text(trim($frm->keywords));
763     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
764         $messagesearch = true;
765         $messagesearchstring = clean_text(trim($frm->combinedsearch));
766     }
768     if ($messagesearch) {
769         if ($messagesearchstring) {
770             $keywords = explode(' ', $messagesearchstring);
771         } else {
772             $keywords = array();
773         }
774         $tome     = false;
775         $fromme   = false;
776         $courseid = 'none';
778         if (empty($frm->keywordsoption)) {
779             $frm->keywordsoption = 'allmine';
780         }
782         switch ($frm->keywordsoption) {
783             case 'tome':
784                 $tome   = true;
785                 break;
786             case 'fromme':
787                 $fromme = true;
788                 break;
789             case 'allmine':
790                 $tome   = true;
791                 $fromme = true;
792                 break;
793             case 'allusers':
794                 $courseid = SITEID;
795                 break;
796             case 'courseusers':
797                 $courseid = $frm->courseid;
798                 break;
799             default:
800                 $tome   = true;
801                 $fromme = true;
802         }
804         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
806         /// get a list of contacts
807             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
808                 $contacts = array();
809             }
811         /// print heading with number of results
812             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
813             $countresults = count($messages);
814             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
815                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
816             } else {
817                 echo get_string('keywordssearchresults', 'message', $countresults);
818             }
819             echo html_writer::end_tag('p');
821         /// print table headings
822             echo '<table class="messagesearchresults" cellspacing="0">';
824             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
825             $headertdend   = html_writer::end_tag('td');
826             echo '<tr>';
827             echo $headertdstart.get_string('from').$headertdend;
828             echo $headertdstart.get_string('to').$headertdend;
829             echo $headertdstart.get_string('message', 'message').$headertdend;
830             echo $headertdstart.get_string('timesent', 'message').$headertdend;
831             echo "</tr>\n";
833             $blockedcount = 0;
834             $dateformat = get_string('strftimedatetimeshort');
835             $strcontext = get_string('context', 'message');
836             foreach ($messages as $message) {
838             /// ignore messages to and from blocked users unless $frm->includeblocked is set
839                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
840                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
841                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
842                                                 )
843                    ) {
844                     $blockedcount ++;
845                     continue;
846                 }
848             /// load up user to record
849                 if ($message->useridto !== $USER->id) {
850                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
851                     $tocontact = (array_key_exists($message->useridto, $contacts) and
852                                     ($contacts[$message->useridto]->blocked == 0) );
853                     $toblocked = (array_key_exists($message->useridto, $contacts) and
854                                     ($contacts[$message->useridto]->blocked == 1) );
855                 } else {
856                     $userto = false;
857                     $tocontact = false;
858                     $toblocked = false;
859                 }
861             /// load up user from record
862                 if ($message->useridfrom !== $USER->id) {
863                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
864                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
865                                     ($contacts[$message->useridfrom]->blocked == 0) );
866                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
867                                     ($contacts[$message->useridfrom]->blocked == 1) );
868                 } else {
869                     $userfrom = false;
870                     $fromcontact = false;
871                     $fromblocked = false;
872                 }
874             /// find date string for this message
875                 $date = usergetdate($message->timecreated);
876                 $datestring = $date['year'].$date['mon'].$date['mday'];
878             /// print out message row
879                 echo '<tr valign="top">';
880                 echo '<td class="contact">';
881                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
882                 echo '</td>';
883                 echo '<td class="contact">';
884                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
885                 echo '</td>';
886                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
887                 echo '<br /><div class="link">';
889                 //find the user involved that isn't the current user
890                 $user2id = null;
891                 if ($user1->id == $message->useridto) {
892                     $user2id = $message->useridfrom;
893                 } else {
894                     $user2id = $message->useridto;
895                 }
896                 message_history_link($user1->id, $user2id, false,
897                                      $messagesearchstring, 'm'.$message->id, $strcontext);
898                 echo '</div>';
899                 echo '</td>';
900                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
901                 echo "</tr>\n";
902             }
905             if ($blockedcount > 0) {
906                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
907             }
908             echo '</table>';
910         } else {
911             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
912         }
913     }
915     if (!$personsearch && !$messagesearch) {
916         //they didn't enter any search terms
917         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
918     }
920     //echo '<br />';
921     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
923     echo '</div>';
927 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
928     global $USER, $OUTPUT;
930     if ($user === false) {
931         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
932     } else {
933         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
934         echo '&nbsp;';
936         $return = false;
937         $script = null;
938         if ($iscontact) {
939             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
940         } else {
941             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
942         }
943         echo '&nbsp;';
944         if ($isblocked) {
945             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
946         } else {
947             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
948         }
949         echo '<br />';
951         $popupoptions = array(
952                 'height' => MESSAGE_DISCUSSION_HEIGHT,
953                 'width' => MESSAGE_DISCUSSION_WIDTH,
954                 'menubar' => false,
955                 'location' => false,
956                 'status' => true,
957                 'scrollbars' => true,
958                 'resizable' => true);
960         $link = new moodle_url("/message/index.php?id=$user->id");
961         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
962         $action = null;
963         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
965     }
969 /// linktype can be: add, remove, block, unblock
970 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
971     global $USER, $CFG, $OUTPUT, $PAGE;
973     //hold onto the strings as we're probably creating a bunch of links
974     static $str;
976     if (empty($script)) {
977         //strip off previous action params like 'removecontact'
978         $script = message_remove_url_params($PAGE->url);
979     }
981     if (empty($str->blockcontact)) {
982        $str->blockcontact   =  get_string('blockcontact', 'message');
983        $str->unblockcontact =  get_string('unblockcontact', 'message');
984        $str->removecontact  =  get_string('removecontact', 'message');
985        $str->addcontact     =  get_string('addcontact', 'message');
986     }
988     $command = $linktype.'contact';
989     $string  = $str->{$command};
991     $safealttext = s($string);
993     $safestring = '';
994     if (!empty($text)) {
995         $safestring = $safealttext;
996     }
998     $img = '';
999     if ($icon) {
1000         $iconpath = null;
1001         switch ($linktype) {
1002             case 'block':
1003                 $iconpath = 't/block';
1004                 break;
1005             case 'unblock':
1006                 $iconpath = 't/userblue';
1007                 break;
1008             case 'remove':
1009                 $iconpath = 'i/cross_red_big';
1010                 break;
1011             case 'add':
1012             default:
1013                 $iconpath = 't/addgreen';
1014         }
1016         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1017     }
1019     $output = '<span class="'.$linktype.'contact">'.
1020               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1021               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1022               $img.
1023               $safestring.'</a></span>';
1025     if ($return) {
1026         return $output;
1027     } else {
1028         echo $output;
1029         return true;
1030     }
1033 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1034     global $USER, $CFG, $OUTPUT;
1036     static $strmessagehistory;
1038     if (empty($strmessagehistory)) {
1039         $strmessagehistory = get_string('messagehistory', 'message');
1040     }
1042     if ($position) {
1043         $position = "#$position";
1044     }
1045     if ($keywords) {
1046         $keywords = "&search=".urlencode($keywords);
1047     }
1049     if ($linktext == 'icon') {  // Icon only
1050         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1051     } else if ($linktext == 'both') {  // Icon and standard name
1052         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1053         $fulllink .= '&nbsp;'.$strmessagehistory;
1054     } else if ($linktext) {    // Custom name
1055         $fulllink = $linktext;
1056     } else {                   // Standard name only
1057         $fulllink = $strmessagehistory;
1058     }
1060     $popupoptions = array(
1061             'height' => 500,
1062             'width' => 500,
1063             'menubar' => false,
1064             'location' => false,
1065             'status' => true,
1066             'scrollbars' => true,
1067             'resizable' => true);
1069     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1070     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1071     $action = null;
1072     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1074     $str = '<span class="history">'.$str.'</span>';
1076     if ($returnstr) {
1077         return $str;
1078     } else {
1079         echo $str;
1080         return true;
1081     }
1085 /**
1086  * Search through course users
1087  *
1088  * If $coursid specifies the site course then this function searches
1089  * through all undeleted and confirmed users
1090  *
1091  * @uses $CFG, $USER
1092  * @uses SITEID
1093  * @param int $courseid The course in question.
1094  * @param string $searchtext ?
1095  * @param string $sort ?
1096  * @param string $exceptions ?
1097  * @return array  An array of {@link $USER} records.
1098  * @todo Finish documenting this function
1099  */
1100 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1101     global $CFG, $USER, $DB;
1103     $fullname = $DB->sql_fullname();
1105     if (!empty($exceptions)) {
1106         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1107     } else {
1108         $except = '';
1109     }
1111     if (!empty($sort)) {
1112         $order = ' ORDER BY '. $sort;
1113     } else {
1114         $order = '';
1115     }
1117     $ufields = user_picture::fields('u');
1118     if (!$courseid or $courseid == SITEID) {
1119         $params = array($USER->id, "%$searchtext%");
1120         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1121                                        FROM {user} u
1122                                        LEFT JOIN {message_contacts} mc
1123                                             ON mc.contactid = u.id AND mc.userid = ?
1124                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1125                                             AND (".$DB->sql_like($fullname, '?', false).")
1126                                             $except
1127                                      $order", $params);
1128     } else {
1129 //TODO: add enabled enrolment join here (skodak)
1130         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1131         $contextlists = get_related_contexts_string($context);
1133         // everyone who has a role assignment in this course or higher
1134         $params = array($USER->id, "%$searchtext%");
1135         $users = $DB->get_records_sql("SELECT $ufields,
1136                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1137                                          JOIN {role_assignments} ra ON ra.userid = u.id
1138                                          LEFT JOIN {message_contacts} mc
1139                                               ON mc.contactid = u.id AND mc.userid = ?
1140                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1141                                               AND ra.contextid $contextlists
1142                                               AND (".$DB->sql_like($fullname, '?', false).")
1143                                               $except
1144                                        $order", $params);
1146         return $users;
1147     }
1153 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1154 /// Returns a list of posts found using an array of search terms
1155 /// eg   word  +word -word
1156 ///
1157     global $CFG, $USER, $DB;
1159     /// If no userid sent then assume current user
1160     if ($userid == 0) $userid = $USER->id;
1162     /// Some differences in SQL syntax
1163     if ($DB->sql_regex_supported()) {
1164         $REGEXP    = $DB->sql_regex(true);
1165         $NOTREGEXP = $DB->sql_regex(false);
1166     }
1168     $searchcond = array();
1169     $params = array();
1170     $i = 0;
1172     //preprocess search terms to check whether we have at least 1 eligible search term
1173     //if we do we can drop words around it like 'a'
1174     $dropshortwords = false;
1175     foreach ($searchterms as $searchterm) {
1176         if (strlen($searchterm) >= 2) {
1177             $dropshortwords = true;
1178         }
1179     }
1181     foreach ($searchterms as $searchterm) {
1182         $i++;
1184         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1186         if ($dropshortwords && strlen($searchterm) < 2) {
1187             continue;
1188         }
1189     /// Under Oracle and MSSQL, trim the + and - operators and perform
1190     /// simpler LIKE search
1191         if (!$DB->sql_regex_supported()) {
1192             if (substr($searchterm, 0, 1) == '-') {
1193                 $NOT = true;
1194             }
1195             $searchterm = trim($searchterm, '+-');
1196         }
1198         if (substr($searchterm,0,1) == "+") {
1199             $searchterm = substr($searchterm,1);
1200             $searchterm = preg_quote($searchterm, '|');
1201             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1202             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1204         } else if (substr($searchterm,0,1) == "-") {
1205             $searchterm = substr($searchterm,1);
1206             $searchterm = preg_quote($searchterm, '|');
1207             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1208             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1210         } else {
1211             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1212             $params['ss'.$i] = "%$searchterm%";
1213         }
1214     }
1216     if (empty($searchcond)) {
1217         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1218         $params['ss1'] = "%";
1219     } else {
1220         $searchcond = implode(" AND ", $searchcond);
1221     }
1223     /// There are several possibilities
1224     /// 1. courseid = SITEID : The admin is searching messages by all users
1225     /// 2. courseid = ??     : A teacher is searching messages by users in
1226     ///                        one of their courses - currently disabled
1227     /// 3. courseid = none   : User is searching their own messages;
1228     ///    a.  Messages from user
1229     ///    b.  Messages to user
1230     ///    c.  Messages to and from user
1232     if ($courseid == SITEID) { /// admin is searching all messages
1233         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1234                                             FROM {message_read} m
1235                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1236         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1237                                             FROM {message} m
1238                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1240     } else if ($courseid !== 'none') {
1241         /// This has not been implemented due to security concerns
1242         $m_read   = array();
1243         $m_unread = array();
1245     } else {
1247         if ($fromme and $tome) {
1248             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1249             $params['userid1'] = $userid;
1250             $params['userid2'] = $userid;
1252         } else if ($fromme) {
1253             $searchcond .= " AND m.useridfrom=:userid";
1254             $params['userid'] = $userid;
1256         } else if ($tome) {
1257             $searchcond .= " AND m.useridto=:userid";
1258             $params['userid'] = $userid;
1259         }
1261         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1262                                             FROM {message_read} m
1263                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1264         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1265                                             FROM {message} m
1266                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1268     }
1270     /// The keys may be duplicated in $m_read and $m_unread so we can't
1271     /// do a simple concatenation
1272     $message = array();
1273     foreach ($m_read as $m) {
1274         $messages[] = $m;
1275     }
1276     foreach ($m_unread as $m) {
1277         $messages[] = $m;
1278     }
1280     return (empty($messages)) ? false : $messages;
1285 /// Borrowed with changes from mod/forum/lib.php
1286 function message_shorten_message($message, $minlength=0) {
1287 // Given a post object that we already know has a long message
1288 // this function truncates the message nicely to the first
1289 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1291     $i = 0;
1292     $tag = false;
1293     $length = strlen($message);
1294     $count = 0;
1295     $stopzone = false;
1296     $truncate = 0;
1297     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1300     for ($i=0; $i<$length; $i++) {
1301         $char = $message[$i];
1303         switch ($char) {
1304             case "<":
1305                 $tag = true;
1306                 break;
1307             case ">":
1308                 $tag = false;
1309                 break;
1310             default:
1311                 if (!$tag) {
1312                     if ($stopzone) {
1313                         if ($char == '.' or $char == ' ') {
1314                             $truncate = $i+1;
1315                             break 2;
1316                         }
1317                     }
1318                     $count++;
1319                 }
1320                 break;
1321         }
1322         if (!$stopzone) {
1323             if ($count > $minlength) {
1324                 $stopzone = true;
1325             }
1326         }
1327     }
1329     if (!$truncate) {
1330         $truncate = $i;
1331     }
1333     return substr($message, 0, $truncate);
1337 /**
1338  * Given a string and an array of keywords, this function looks
1339  * for the first keyword in the string, and then chops out a
1340  * small section from the text that shows that word in context.
1341  */
1342 function message_get_fragment($message, $keywords) {
1344     $fullsize = 160;
1345     $halfsize = (int)($fullsize/2);
1347     $message = strip_tags($message);
1349     foreach ($keywords as $keyword) {  // Just get the first one
1350         if ($keyword !== '') {
1351             break;
1352         }
1353     }
1354     if (empty($keyword)) {   // None found, so just return start of message
1355         return message_shorten_message($message, 30);
1356     }
1358     $leadin = $leadout = '';
1360 /// Find the start of the fragment
1361     $start = 0;
1362     $length = strlen($message);
1364     $pos = strpos($message, $keyword);
1365     if ($pos > $halfsize) {
1366         $start = $pos - $halfsize;
1367         $leadin = '...';
1368     }
1369 /// Find the end of the fragment
1370     $end = $start + $fullsize;
1371     if ($end > $length) {
1372         $end = $length;
1373     } else {
1374         $leadout = '...';
1375     }
1377 /// Pull out the fragment and format it
1379     $fragment = substr($message, $start, $end - $start);
1380     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1381     return $fragment;
1384 //retrieve the messages between two users
1385 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1386     global $DB, $CFG;
1388     $messages = array();
1390     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1391     //desc to get the last $limitnum messages then flip the order in php
1392     $sort = 'asc';
1393     if ($limitnum>0) {
1394         $sort = 'desc';
1395     }
1397     $notificationswhere = null;
1398     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1399     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1400         $notificationswhere = 'AND notification=0';
1401     }
1403     //prevent notifications of your own actions appearing in your own message history
1404     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1406     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1407                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1408                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1409                                                     "timecreated $sort", '*', 0, $limitnum)) {
1410         foreach ($messages_read as $message) {
1411             $messages[$message->timecreated] = $message;
1412         }
1413     }
1414     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1415                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1416                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1417                                                     "timecreated $sort", '*', 0, $limitnum)) {
1418         foreach ($messages_new as $message) {
1419             $messages[$message->timecreated] = $message;
1420         }
1421     }
1423     //if we only want the last $limitnum messages
1424     ksort($messages);
1425     $messagecount = count($messages);
1426     if ($limitnum>0 && $messagecount>$limitnum) {
1427         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1428     }
1430     return $messages;
1433 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1434     global $CFG, $OUTPUT;
1436     echo $OUTPUT->box_start('center');
1437     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1438     echo '<td align="center" id="user1">';
1439     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1440     echo '<div class="heading">'.fullname($user1).'</div>';
1441     echo '</td>';
1442     echo '<td align="center">';
1443     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1444     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1445     echo '</td>';
1446     echo '<td align="center" id="user2">';
1447     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1448     echo '<div class="heading">'.fullname($user2).'</div>';
1450     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1451         $incontactlist = $user2->iscontact;
1452         $isblocked = $user2->isblocked;
1454         $script = null;
1455         $text = true;
1456         $icon = false;
1458         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1459         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1460         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1462         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1463     }
1465     echo '</td>';
1466     echo '</tr></table>';
1467     echo $OUTPUT->box_end();
1469     if (!empty($messagehistorylink)) {
1470         echo $messagehistorylink;
1471     }
1473     /// Get all the messages and print them
1474     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1475         $tablecontents = '';
1477         $current = new stdClass();
1478         $current->mday = '';
1479         $current->month = '';
1480         $current->year = '';
1481         $messagedate = get_string('strftimetime');
1482         $blockdate   = get_string('strftimedaydate');
1483         foreach ($messages as $message) {
1484             if ($message->notification) {
1485                 $notificationclass = ' notification';
1486             } else {
1487                 $notificationclass = null;
1488             }
1489             $date = usergetdate($message->timecreated);
1490             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1491                 $current->mday = $date['mday'];
1492                 $current->month = $date['month'];
1493                 $current->year = $date['year'];
1495                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1496                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1497             }
1498             if ($message->useridfrom == $user1->id) {
1499                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1500             } else {
1501                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1502             }
1503         }
1505         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1506     } else {
1507         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1508     }
1511 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1513     static $dateformat;
1515     if (empty($dateformat)) {
1516         if ($format) {
1517             $dateformat = $format;
1518         } else {
1519             $format = get_string('strftimedatetimeshort');
1520         }
1521     }
1522     $time = userdate($message->timecreated, $dateformat);
1523     $options = new stdClass();
1524     $options->para = false;
1526     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1527     if (!empty($message->smallmessage)) {
1528         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1529     } else {
1530         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1531     }
1533     if (!empty($message->contexturl)) {
1534         $displaytext = null;
1535         if (!empty($message->contexturlname)) {
1536             $displaytext= $message->contexturlname;
1537         } else {
1538             $displaytext= $message->contexturl;
1539         }
1540         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1541             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1542         $messagetext .= html_writer::end_tag('div');
1543     }
1545     if ($keywords) {
1546         $messagetext = highlight($keywords, $messagetext);
1547     }
1549     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1552 /**
1553  * Inserts a message into the database, but also forwards it
1554  * via other means if appropriate.
1555  */
1556 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1557     global $SITE, $CFG, $USER;
1559     $eventdata = new stdClass();
1560     $eventdata->component        = 'moodle';
1561     $eventdata->name             = 'instantmessage';
1562     $eventdata->userfrom         = $userfrom;
1563     $eventdata->userto           = $userto;
1565     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1566     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1568     if ($format==FORMAT_HTML) {
1569         $eventdata->fullmessage      = '';
1570         $eventdata->fullmessagehtml  = $message;
1571     } else {
1572         $eventdata->fullmessage      = $message;
1573         $eventdata->fullmessagehtml  = '';
1574     }
1576     $eventdata->fullmessageformat = $format;
1577     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1579     $s = new stdClass();
1580     $s->sitename = $SITE->shortname;
1581     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1583     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1584     if (!empty($eventdata->fullmessage)) {
1585         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1586     }
1587     if (!empty($eventdata->fullmessagehtml)) {
1588         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1589     }
1591     $eventdata->timecreated     = time();
1592     return message_send($eventdata);
1596 /**
1597  * Returns a list of all user ids who have used messaging in the site
1598  * This was the simple way to code the SQL ... is it going to blow up
1599  * on large datasets?
1600  */
1601 function message_get_participants() {
1602     global $CFG, $DB;
1604         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1605                                UNION SELECT useridto as id,1 FROM {message}
1606                                UNION SELECT useridfrom as id,1 FROM {message_read}
1607                                UNION SELECT useridto as id,1 FROM {message_read}
1608                                UNION SELECT userid as id,1 FROM {message_contacts}
1609                                UNION SELECT contactid as id,1 from {message_contacts}");
1612 /**
1613  * Print a row of contactlist displaying user picture, messages waiting and
1614  * block links etc
1615  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1616  * @param $incontactlist is the user a contact of ours?
1617  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1618  */
1619 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1620     global $OUTPUT, $USER;
1621     $fullname  = fullname($contact);
1622     $fullnamelink  = $fullname;
1624     $linkclass = '';
1625     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1626         $linkclass = 'messageselecteduser';
1627     }
1629     /// are there any unread messages for this contact?
1630     if ($contact->messagecount > 0 ){
1631         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1632     }
1634     $strcontact = $strblock = $strhistory = null;
1636     if ($showactionlinks) {
1637         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1638         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1639         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1640     }
1642     echo '<tr><td class="pix">';
1643     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1644     echo '</td>';
1645     echo '<td class="contact">';
1647     $popupoptions = array(
1648             'height' => MESSAGE_DISCUSSION_HEIGHT,
1649             'width' => MESSAGE_DISCUSSION_WIDTH,
1650             'menubar' => false,
1651             'location' => false,
1652             'status' => true,
1653             'scrollbars' => true,
1654             'resizable' => true);
1656     $link = $action = null;
1657     if (!empty($selectcontacturl)) {
1658         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1659     } else {
1660         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1661         $link = new moodle_url("/message/index.php?id=$contact->id");
1662         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1663     }
1664     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1666     echo '</td>';
1667     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1668     echo '</tr>';
1671 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1672     $strcontact = '';
1674     if($incontactlist){
1675         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1676     } else if ($isblocked) {
1677         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1678     } else{
1679         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1680     }
1682     return $strcontact;
1685 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1686     $strblock   = '';
1688     //commented out to allow the user to block a contact without having to remove them first
1689     /*if ($incontactlist) {
1690         //$strblock = '';
1691     } else*/
1692     if ($isblocked) {
1693         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1694     } else{
1695         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1696     }
1698     return $strblock;
1701  /**
1702   * Moves unread messages from message table to message_read for a given from user
1703   * @param object $userid       User id
1704   * @return boolean success
1705   */
1706 function message_move_userfrom_unread2read($userid) {
1708     global $DB;
1710     // move all unread messages from message table to message_read
1711     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1712         foreach ($messages as $message) {
1713             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1714         }
1715     }
1716     return true;
1719 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1720     global $DB;
1722     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1724     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1726     //for every message to process check if it's for current user and process
1727     $messages = array();
1728     foreach ($messagesproc as $msgp){
1729         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1730         if ($fromuserid){
1731             $query['useridfrom'] = $fromuserid;
1732         }
1733         if ($message = $DB->get_record('message', $query)){
1734             $messages[] = $message;
1735             /// Move the entry to the other table
1736             $message->timeread = time();
1737             $messageid = $message->id;
1738             unset($message->id);
1740             //delete what we've processed and check if can move message
1741             $DB->delete_records('message_working', array('id' => $msgp->id));
1742             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1743                 message_mark_message_read($message, time(), true);
1744             }
1745         }
1746     }
1747     return $messages;
1750 /**
1751 * marks ALL messages being sent from $fromuserid to $touserid as read
1752 * @param int $touserid the id of the message recipient
1753 * @param int $fromuserid the id of the message sender
1754 * @return void
1755 */
1756 function message_mark_messages_read($touserid, $fromuserid){
1757     global $DB;
1759     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1760     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1762     foreach ($messages as $message) {
1763         message_mark_message_read($message, time());
1764     }
1767 /**
1768 * Mark a single message as read
1769 * @param message an object with an object property ie $message->id which is an id in the message table
1770 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1771 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1772 * @return void
1773 */
1774 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1775     global $DB;
1777     $message->timeread = $timeread;
1779     $messageid = $message->id;
1780     unset($message->id);//unset because it will get a new id on insert into message_read
1782     //If any processors have pending actions abort them
1783     if (!$messageworkingempty) {
1784         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1785     }
1786     $DB->insert_record('message_read', $message);
1787     $DB->delete_records('message', array('id' => $messageid));