MDL-26069 detect missing file postprocessing
[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);
143     
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         $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
531     }
533     if (!empty($frm->combinedsearch)) {
534         $combinedsearchstring = $frm->combinedsearch;
535     } else {
536         //$combinedsearchstring = get_string('searchcombined','message').'...';
537         $combinedsearchstring = '';
538     }
540     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
542     if ($doingsearch) {
543         if ($advancedsearch) {
545             $messagesearch = '';
546             if (!empty($frm->keywords)) {
547                 $messagesearch = $frm->keywords;
548             }
549             $personsearch = '';
550             if (!empty($frm->name)) {
551                 $personsearch = $frm->name;
552             }
553             include('search_advanced.html');
554         } else {
555             include('search.html');
556         }
558         $showicontext = false;
559         message_print_search_results($frm, $showicontext, $user1);
561         return true;
562     } else {
563 /*
564 /// unfinished buggy code disabled in search.html anyway
565         // find all courses this use has readallmessages capabilities in
566         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
567             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
568             $cs = '<select name="courseselect">';
569             foreach ($teachers as $tcourse) {
570                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
571             }
572             $cs .= '</select>';
573         }
574 */
576         if ($advancedsearch) {
577             $personsearch = $messagesearch = '';
578             include('search_advanced.html');
579         } else {
580             include('search.html');
581         }
582         return false;
583     }
586 function message_print_settings() {
587     global $USER, $OUTPUT, $PAGE;
589     if ($frm = data_submitted() and confirm_sesskey()) {
591         $pref = array();
592         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
593         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
595         set_user_preferences($pref);
597         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
598     }
600     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
601     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
603     include('settings.html');
608 function message_add_contact($contactid, $blocked=0) {
609     global $USER, $DB;
611     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
612         return false;
613     }
615     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
616     /// record already exists - we may be changing blocking status
618         if ($contact->blocked !== $blocked) {
619         /// change to blocking status
620             $contact->blocked = $blocked;
621             return $DB->update_record('message_contacts', $contact);
622         } else {
623         /// no changes to blocking status
624             return true;
625         }
627     } else {
628     /// new contact record
629         unset($contact);
630         $contact->userid = $USER->id;
631         $contact->contactid = $contactid;
632         $contact->blocked = $blocked;
633         return $DB->insert_record('message_contacts', $contact, false);
634     }
637 function message_remove_contact($contactid) {
638     global $USER, $DB;
639     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
642 function message_unblock_contact($contactid) {
643     global $USER, $DB;
644     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
647 function message_block_contact($contactid) {
648     return message_add_contact($contactid, 1);
651 function message_get_contact($contactid) {
652     global $USER, $DB;
653     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
658 function message_print_search_results($frm, $showicontext=false, $user1=null) {
659     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
661     if (empty($user1)) {
662         $user1 = $USER;
663     }
665     echo '<div class="mdl-left">';
667     $personsearch = false;
668     $personsearchstring = null;
669     if (!empty($frm->personsubmit) and !empty($frm->name)) {
670         $personsearch = true;
671         $personsearchstring = $frm->name;
672     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
673         $personsearch = true;
674         $personsearchstring = $frm->combinedsearch;
675     }
677     /// search for person
678     if ($personsearch) {
679         if (optional_param('mycourses', 0, PARAM_BOOL)) {
680             $users = array();
681             $mycourses = enrol_get_my_courses();
682             foreach ($mycourses as $mycourse) {
683                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
684                     foreach ($susers as $suser) $users[$suser->id] = $suser;
685                 }
686             }
687         } else {
688             $users = message_search_users(SITEID, $personsearchstring);
689         }
691         if (!empty($users)) {
692             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
693             echo get_string('userssearchresults', 'message', count($users));
694             echo html_writer::end_tag('p');
696             echo '<table class="messagesearchresults">';
697             foreach ($users as $user) {
699                 if ( $user->contactlistid )  {
700                     if ($user->blocked == 0) { /// not blocked
701                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
702                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
703                     } else { // blocked
704                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
705                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
706                     }
707                 } else {
708                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
709                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
710                 }
712                 //should we show just the icon or icon and text?
713                 $histicontext = 'icon';
714                 if ($showicontext) {
715                     $histicontext = 'both';
716                 }
717                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
719                 echo '<tr><td class="pix">';
720                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
721                 echo '</td>';
722                 echo '<td class="contact">';
723                 $popupoptions = array(
724                         'height' => MESSAGE_DISCUSSION_HEIGHT,
725                         'width' => MESSAGE_DISCUSSION_WIDTH,
726                         'menubar' => false,
727                         'location' => false,
728                         'status' => true,
729                         'scrollbars' => true,
730                         'resizable' => true);
732                 $link = new moodle_url("/message/index.php?id=$user->id");
733                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
734                 $action = null;
735                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
737                 echo '</td>';
739                 echo '<td class="link">'.$strcontact.'</td>';
740                 echo '<td class="link">'.$strblock.'</td>';
741                 echo '<td class="link">'.$strhistory.'</td>';
742                 echo '</tr>';
743             }
744             echo '</table>';
746         } else {
747             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
748             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
749             echo html_writer::end_tag('p');
750         }
751     }
753     // search messages for keywords
754     $messagesearch = false;
755     $messagesearchstring = null;
756     if (!empty($frm->keywords)) {
757         $messagesearch = true;
758         $messagesearchstring = clean_text(trim($frm->keywords));
759     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
760         $messagesearch = true;
761         $messagesearchstring = clean_text(trim($frm->combinedsearch));
762     }
764     if ($messagesearch) {
765         if ($messagesearchstring) {
766             $keywords = explode(' ', $messagesearchstring);
767         } else {
768             $keywords = array();
769         }
770         $tome     = false;
771         $fromme   = false;
772         $courseid = 'none';
774         if (empty($frm->keywordsoption)) {
775             $frm->keywordsoption = 'allmine';
776         }
778         switch ($frm->keywordsoption) {
779             case 'tome':
780                 $tome   = true;
781                 break;
782             case 'fromme':
783                 $fromme = true;
784                 break;
785             case 'allmine':
786                 $tome   = true;
787                 $fromme = true;
788                 break;
789             case 'allusers':
790                 $courseid = SITEID;
791                 break;
792             case 'courseusers':
793                 $courseid = $frm->courseid;
794                 break;
795             default:
796                 $tome   = true;
797                 $fromme = true;
798         }
800         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
802         /// get a list of contacts
803             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
804                 $contacts = array();
805             }
807         /// print heading with number of results
808             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
809             $countresults = count($messages);
810             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
811                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
812             } else {
813                 echo get_string('keywordssearchresults', 'message', $countresults);
814             }
815             echo html_writer::end_tag('p');
817         /// print table headings
818             echo '<table class="messagesearchresults" cellspacing="0">';
820             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
821             $headertdend   = html_writer::end_tag('td');
822             echo '<tr>';
823             echo $headertdstart.get_string('from').$headertdend;
824             echo $headertdstart.get_string('to').$headertdend;
825             echo $headertdstart.get_string('message', 'message').$headertdend;
826             echo $headertdstart.get_string('timesent', 'message').$headertdend;
827             echo "</tr>\n";
829             $blockedcount = 0;
830             $dateformat = get_string('strftimedatetimeshort');
831             $strcontext = get_string('context', 'message');
832             foreach ($messages as $message) {
834             /// ignore messages to and from blocked users unless $frm->includeblocked is set
835                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
836                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
837                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
838                                                 )
839                    ) {
840                     $blockedcount ++;
841                     continue;
842                 }
844             /// load up user to record
845                 if ($message->useridto !== $USER->id) {
846                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
847                     $tocontact = (array_key_exists($message->useridto, $contacts) and
848                                     ($contacts[$message->useridto]->blocked == 0) );
849                     $toblocked = (array_key_exists($message->useridto, $contacts) and
850                                     ($contacts[$message->useridto]->blocked == 1) );
851                 } else {
852                     $userto = false;
853                     $tocontact = false;
854                     $toblocked = false;
855                 }
857             /// load up user from record
858                 if ($message->useridfrom !== $USER->id) {
859                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
860                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
861                                     ($contacts[$message->useridfrom]->blocked == 0) );
862                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
863                                     ($contacts[$message->useridfrom]->blocked == 1) );
864                 } else {
865                     $userfrom = false;
866                     $fromcontact = false;
867                     $fromblocked = false;
868                 }
870             /// find date string for this message
871                 $date = usergetdate($message->timecreated);
872                 $datestring = $date['year'].$date['mon'].$date['mday'];
874             /// print out message row
875                 echo '<tr valign="top">';
876                 echo '<td class="contact">';
877                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
878                 echo '</td>';
879                 echo '<td class="contact">';
880                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
881                 echo '</td>';
882                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
883                 echo '<br /><div class="link">';
885                 //find the user involved that isn't the current user
886                 $user2id = null;
887                 if ($user1->id == $message->useridto) {
888                     $user2id = $message->useridfrom;
889                 } else {
890                     $user2id = $message->useridto;
891                 }
892                 message_history_link($user1->id, $user2id, false,
893                                      $messagesearchstring, 'm'.$message->id, $strcontext);
894                 echo '</div>';
895                 echo '</td>';
896                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
897                 echo "</tr>\n";
898             }
901             if ($blockedcount > 0) {
902                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
903             }
904             echo '</table>';
906         } else {
907             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
908         }
909     }
911     if (!$personsearch && !$messagesearch) {
912         //they didn't enter any search terms
913         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
914     }
916     //echo '<br />';
917     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
919     echo '</div>';
923 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
924     global $USER, $OUTPUT;
926     if ($user === false) {
927         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
928     } else {
929         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
930         echo '&nbsp;';
932         $return = false;
933         $script = null;
934         if ($iscontact) {
935             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
936         } else {
937             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
938         }
939         echo '&nbsp;';
940         if ($isblocked) {
941             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
942         } else {
943             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
944         }
945         echo '<br />';
947         $popupoptions = array(
948                 'height' => MESSAGE_DISCUSSION_HEIGHT,
949                 'width' => MESSAGE_DISCUSSION_WIDTH,
950                 'menubar' => false,
951                 'location' => false,
952                 'status' => true,
953                 'scrollbars' => true,
954                 'resizable' => true);
956         $link = new moodle_url("/message/index.php?id=$user->id");
957         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
958         $action = null;
959         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
961     }
965 /// linktype can be: add, remove, block, unblock
966 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
967     global $USER, $CFG, $OUTPUT, $PAGE;
969     //hold onto the strings as we're probably creating a bunch of links
970     static $str;
972     if (empty($script)) {
973         //strip off previous action params like 'removecontact'
974         $script = message_remove_url_params($PAGE->url);
975     }
977     if (empty($str->blockcontact)) {
978        $str->blockcontact   =  get_string('blockcontact', 'message');
979        $str->unblockcontact =  get_string('unblockcontact', 'message');
980        $str->removecontact  =  get_string('removecontact', 'message');
981        $str->addcontact     =  get_string('addcontact', 'message');
982     }
984     $command = $linktype.'contact';
985     $string  = $str->{$command};
987     $safealttext = s($string);
989     $safestring = '';
990     if (!empty($text)) {
991         $safestring = $safealttext;
992     }
994     $img = '';
995     if ($icon) {
996         $iconpath = null;
997         switch ($linktype) {
998             case 'block':
999                 $iconpath = 't/block';
1000                 break;
1001             case 'unblock':
1002                 $iconpath = 't/userblue';
1003                 break;
1004             case 'remove':
1005                 $iconpath = 'i/cross_red_big';
1006                 break;
1007             case 'add':
1008             default:
1009                 $iconpath = 't/addgreen';
1010         }
1012         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1013     }
1015     $output = '<span class="'.$linktype.'contact">'.
1016               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1017               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1018               $img.
1019               $safestring.'</a></span>';
1021     if ($return) {
1022         return $output;
1023     } else {
1024         echo $output;
1025         return true;
1026     }
1029 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1030     global $USER, $CFG, $OUTPUT;
1032     static $strmessagehistory;
1034     if (empty($strmessagehistory)) {
1035         $strmessagehistory = get_string('messagehistory', 'message');
1036     }
1038     if ($position) {
1039         $position = "#$position";
1040     }
1041     if ($keywords) {
1042         $keywords = "&search=".urlencode($keywords);
1043     }
1045     if ($linktext == 'icon') {  // Icon only
1046         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1047     } else if ($linktext == 'both') {  // Icon and standard name
1048         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1049         $fulllink .= '&nbsp;'.$strmessagehistory;
1050     } else if ($linktext) {    // Custom name
1051         $fulllink = $linktext;
1052     } else {                   // Standard name only
1053         $fulllink = $strmessagehistory;
1054     }
1056     $popupoptions = array(
1057             'height' => 500,
1058             'width' => 500,
1059             'menubar' => false,
1060             'location' => false,
1061             'status' => true,
1062             'scrollbars' => true,
1063             'resizable' => true);
1065     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1066     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1067     $action = null;
1068     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1070     $str = '<span class="history">'.$str.'</span>';
1072     if ($returnstr) {
1073         return $str;
1074     } else {
1075         echo $str;
1076         return true;
1077     }
1081 /**
1082  * Search through course users
1083  *
1084  * If $coursid specifies the site course then this function searches
1085  * through all undeleted and confirmed users
1086  *
1087  * @uses $CFG, $USER
1088  * @uses SITEID
1089  * @param int $courseid The course in question.
1090  * @param string $searchtext ?
1091  * @param string $sort ?
1092  * @param string $exceptions ?
1093  * @return array  An array of {@link $USER} records.
1094  * @todo Finish documenting this function
1095  */
1096 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1097     global $CFG, $USER, $DB;
1099     $fullname = $DB->sql_fullname();
1101     if (!empty($exceptions)) {
1102         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1103     } else {
1104         $except = '';
1105     }
1107     if (!empty($sort)) {
1108         $order = ' ORDER BY '. $sort;
1109     } else {
1110         $order = '';
1111     }
1113     $ufields = user_picture::fields('u');
1114     if (!$courseid or $courseid == SITEID) {
1115         $params = array($USER->id, "%$searchtext%");
1116         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1117                                        FROM {user} u
1118                                        LEFT JOIN {message_contacts} mc
1119                                             ON mc.contactid = u.id AND mc.userid = ?
1120                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1121                                             AND (".$DB->sql_like($fullname, '?', false).")
1122                                             $except
1123                                      $order", $params);
1124     } else {
1125 //TODO: add enabled enrolment join here (skodak)
1126         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1127         $contextlists = get_related_contexts_string($context);
1129         // everyone who has a role assignment in this course or higher
1130         $params = array($USER->id, "%$searchtext%");
1131         $users = $DB->get_records_sql("SELECT $ufields,
1132                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1133                                          JOIN {role_assignments} ra ON ra.userid = u.id
1134                                          LEFT JOIN {message_contacts} mc
1135                                               ON mc.contactid = u.id AND mc.userid = ?
1136                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1137                                               AND ra.contextid $contextlists
1138                                               AND (".$DB->sql_like($fullname, '?', false).")
1139                                               $except
1140                                        $order", $params);
1142         return $users;
1143     }
1149 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1150 /// Returns a list of posts found using an array of search terms
1151 /// eg   word  +word -word
1152 ///
1153     global $CFG, $USER, $DB;
1155     /// If no userid sent then assume current user
1156     if ($userid == 0) $userid = $USER->id;
1158     /// Some differences in SQL syntax
1159     if ($DB->sql_regex_supported()) {
1160         $REGEXP    = $DB->sql_regex(true);
1161         $NOTREGEXP = $DB->sql_regex(false);
1162     }
1164     $searchcond = array();
1165     $params = array();
1166     $i = 0;
1168     //preprocess search terms to check whether we have at least 1 eligible search term
1169     //if we do we can drop words around it like 'a'
1170     $dropshortwords = false;
1171     foreach ($searchterms as $searchterm) {
1172         if (strlen($searchterm) >= 2) {
1173             $dropshortwords = true;
1174         }
1175     }
1177     foreach ($searchterms as $searchterm) {
1178         $i++;
1180         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1182         if ($dropshortwords && strlen($searchterm) < 2) {
1183             continue;
1184         }
1185     /// Under Oracle and MSSQL, trim the + and - operators and perform
1186     /// simpler LIKE search
1187         if (!$DB->sql_regex_supported()) {
1188             if (substr($searchterm, 0, 1) == '-') {
1189                 $NOT = true;
1190             }
1191             $searchterm = trim($searchterm, '+-');
1192         }
1194         if (substr($searchterm,0,1) == "+") {
1195             $searchterm = substr($searchterm,1);
1196             $searchterm = preg_quote($searchterm, '|');
1197             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1198             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1200         } else if (substr($searchterm,0,1) == "-") {
1201             $searchterm = substr($searchterm,1);
1202             $searchterm = preg_quote($searchterm, '|');
1203             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1204             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1206         } else {
1207             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1208             $params['ss'.$i] = "%$searchterm%";
1209         }
1210     }
1212     if (empty($searchcond)) {
1213         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1214         $params['ss1'] = "%";
1215     } else {
1216         $searchcond = implode(" AND ", $searchcond);
1217     }
1219     /// There are several possibilities
1220     /// 1. courseid = SITEID : The admin is searching messages by all users
1221     /// 2. courseid = ??     : A teacher is searching messages by users in
1222     ///                        one of their courses - currently disabled
1223     /// 3. courseid = none   : User is searching their own messages;
1224     ///    a.  Messages from user
1225     ///    b.  Messages to user
1226     ///    c.  Messages to and from user
1228     if ($courseid == SITEID) { /// admin is searching all messages
1229         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1230                                             FROM {message_read} m
1231                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1232         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1233                                             FROM {message} m
1234                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1236     } else if ($courseid !== 'none') {
1237         /// This has not been implemented due to security concerns
1238         $m_read   = array();
1239         $m_unread = array();
1241     } else {
1243         if ($fromme and $tome) {
1244             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1245             $params['userid1'] = $userid;
1246             $params['userid2'] = $userid;
1248         } else if ($fromme) {
1249             $searchcond .= " AND m.useridfrom=:userid";
1250             $params['userid'] = $userid;
1252         } else if ($tome) {
1253             $searchcond .= " AND m.useridto=:userid";
1254             $params['userid'] = $userid;
1255         }
1257         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1258                                             FROM {message_read} m
1259                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1260         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1261                                             FROM {message} m
1262                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1264     }
1266     /// The keys may be duplicated in $m_read and $m_unread so we can't
1267     /// do a simple concatenation
1268     $message = array();
1269     foreach ($m_read as $m) {
1270         $messages[] = $m;
1271     }
1272     foreach ($m_unread as $m) {
1273         $messages[] = $m;
1274     }
1276     return (empty($messages)) ? false : $messages;
1281 /// Borrowed with changes from mod/forum/lib.php
1282 function message_shorten_message($message, $minlength=0) {
1283 // Given a post object that we already know has a long message
1284 // this function truncates the message nicely to the first
1285 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1287     $i = 0;
1288     $tag = false;
1289     $length = strlen($message);
1290     $count = 0;
1291     $stopzone = false;
1292     $truncate = 0;
1293     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1296     for ($i=0; $i<$length; $i++) {
1297         $char = $message[$i];
1299         switch ($char) {
1300             case "<":
1301                 $tag = true;
1302                 break;
1303             case ">":
1304                 $tag = false;
1305                 break;
1306             default:
1307                 if (!$tag) {
1308                     if ($stopzone) {
1309                         if ($char == '.' or $char == ' ') {
1310                             $truncate = $i+1;
1311                             break 2;
1312                         }
1313                     }
1314                     $count++;
1315                 }
1316                 break;
1317         }
1318         if (!$stopzone) {
1319             if ($count > $minlength) {
1320                 $stopzone = true;
1321             }
1322         }
1323     }
1325     if (!$truncate) {
1326         $truncate = $i;
1327     }
1329     return substr($message, 0, $truncate);
1333 /**
1334  * Given a string and an array of keywords, this function looks
1335  * for the first keyword in the string, and then chops out a
1336  * small section from the text that shows that word in context.
1337  */
1338 function message_get_fragment($message, $keywords) {
1340     $fullsize = 160;
1341     $halfsize = (int)($fullsize/2);
1343     $message = strip_tags($message);
1345     foreach ($keywords as $keyword) {  // Just get the first one
1346         if ($keyword !== '') {
1347             break;
1348         }
1349     }
1350     if (empty($keyword)) {   // None found, so just return start of message
1351         return message_shorten_message($message, 30);
1352     }
1354     $leadin = $leadout = '';
1356 /// Find the start of the fragment
1357     $start = 0;
1358     $length = strlen($message);
1360     $pos = strpos($message, $keyword);
1361     if ($pos > $halfsize) {
1362         $start = $pos - $halfsize;
1363         $leadin = '...';
1364     }
1365 /// Find the end of the fragment
1366     $end = $start + $fullsize;
1367     if ($end > $length) {
1368         $end = $length;
1369     } else {
1370         $leadout = '...';
1371     }
1373 /// Pull out the fragment and format it
1375     $fragment = substr($message, $start, $end - $start);
1376     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1377     return $fragment;
1380 //retrieve the messages between two users
1381 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1382     global $DB, $CFG;
1384     $messages = array();
1386     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1387     //desc to get the last $limitnum messages then flip the order in php
1388     $sort = 'asc';
1389     if ($limitnum>0) {
1390         $sort = 'desc';
1391     }
1393     $notificationswhere = null;
1394     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1395     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1396         $notificationswhere = 'AND notification=0';
1397     }
1399     //prevent notifications of your own actions appearing in your own message history
1400     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1402     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1403                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1404                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1405                                                     "timecreated $sort", '*', 0, $limitnum)) {
1406         foreach ($messages_read as $message) {
1407             $messages[$message->timecreated] = $message;
1408         }
1409     }
1410     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1411                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1412                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1413                                                     "timecreated $sort", '*', 0, $limitnum)) {
1414         foreach ($messages_new as $message) {
1415             $messages[$message->timecreated] = $message;
1416         }
1417     }
1419     //if we only want the last $limitnum messages
1420     ksort($messages);
1421     $messagecount = count($messages);
1422     if ($limitnum>0 && $messagecount>$limitnum) {
1423         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1424     }
1426     return $messages;
1429 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1430     global $CFG, $OUTPUT;
1432     echo $OUTPUT->box_start('center');
1433     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1434     echo '<td align="center" id="user1">';
1435     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1436     echo '<div class="heading">'.fullname($user1).'</div>';
1437     echo '</td>';
1438     echo '<td align="center">';
1439     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1440     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1441     echo '</td>';
1442     echo '<td align="center" id="user2">';
1443     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1444     echo '<div class="heading">'.fullname($user2).'</div>';
1446     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1447         $incontactlist = $user2->iscontact;
1448         $isblocked = $user2->isblocked;
1450         $script = null;
1451         $text = true;
1452         $icon = false;
1454         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1455         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1456         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1458         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1459     }
1461     echo '</td>';
1462     echo '</tr></table>';
1463     echo $OUTPUT->box_end();
1465     if (!empty($messagehistorylink)) {
1466         echo $messagehistorylink;
1467     }
1469     /// Get all the messages and print them
1470     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1471         $tablecontents = '';
1473         $current = new stdClass();
1474         $current->mday = '';
1475         $current->month = '';
1476         $current->year = '';
1477         $messagedate = get_string('strftimetime');
1478         $blockdate   = get_string('strftimedaydate');
1479         foreach ($messages as $message) {
1480             if ($message->notification) {
1481                 $notificationclass = ' notification';
1482             } else {
1483                 $notificationclass = null;
1484             }
1485             $date = usergetdate($message->timecreated);
1486             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1487                 $current->mday = $date['mday'];
1488                 $current->month = $date['month'];
1489                 $current->year = $date['year'];
1491                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1492                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1493             }
1494             if ($message->useridfrom == $user1->id) {
1495                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1496             } else {
1497                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1498             }
1499         }
1501         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1502     } else {
1503         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1504     }
1507 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1509     static $dateformat;
1511     if (empty($dateformat)) {
1512         if ($format) {
1513             $dateformat = $format;
1514         } else {
1515             $format = get_string('strftimedatetimeshort');
1516         }
1517     }
1518     $time = userdate($message->timecreated, $dateformat);
1519     $options = new stdClass();
1520     $options->para = false;
1522     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1523     if (!empty($message->smallmessage)) {
1524         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1525     } else {
1526         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1527     }
1529     if (!empty($message->contexturl)) {
1530         $displaytext = null;
1531         if (!empty($message->contexturlname)) {
1532             $displaytext= $message->contexturlname;
1533         } else {
1534             $displaytext= $message->contexturl;
1535         }
1536         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1537             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1538         $messagetext .= html_writer::end_tag('div');
1539     }
1541     if ($keywords) {
1542         $messagetext = highlight($keywords, $messagetext);
1543     }
1545     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1548 /**
1549  * Inserts a message into the database, but also forwards it
1550  * via other means if appropriate.
1551  */
1552 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1553     global $SITE, $CFG, $USER;
1555     $eventdata = new stdClass();
1556     $eventdata->component        = 'moodle';
1557     $eventdata->name             = 'instantmessage';
1558     $eventdata->userfrom         = $userfrom;
1559     $eventdata->userto           = $userto;
1561     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1562     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1564     if ($format==FORMAT_HTML) {
1565         $eventdata->fullmessage      = '';
1566         $eventdata->fullmessagehtml  = $message;
1567     } else {
1568         $eventdata->fullmessage      = $message;
1569         $eventdata->fullmessagehtml  = '';
1570     }
1571     
1572     $eventdata->fullmessageformat = $format;
1573     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1575     $s = new stdClass();
1576     $s->sitename = $SITE->shortname;
1577     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1579     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1580     if (!empty($eventdata->fullmessage)) {
1581         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1582     }
1583     if (!empty($eventdata->fullmessagehtml)) {
1584         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1585     }
1586     
1587     $eventdata->timecreated     = time();
1588     return message_send($eventdata);
1592 /**
1593  * Returns a list of all user ids who have used messaging in the site
1594  * This was the simple way to code the SQL ... is it going to blow up
1595  * on large datasets?
1596  */
1597 function message_get_participants() {
1598     global $CFG, $DB;
1600         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1601                                UNION SELECT useridto as id,1 FROM {message}
1602                                UNION SELECT useridfrom as id,1 FROM {message_read}
1603                                UNION SELECT useridto as id,1 FROM {message_read}
1604                                UNION SELECT userid as id,1 FROM {message_contacts}
1605                                UNION SELECT contactid as id,1 from {message_contacts}");
1608 /**
1609  * Print a row of contactlist displaying user picture, messages waiting and
1610  * block links etc
1611  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1612  * @param $incontactlist is the user a contact of ours?
1613  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1614  */
1615 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1616     global $OUTPUT, $USER;
1617     $fullname  = fullname($contact);
1618     $fullnamelink  = $fullname;
1620     $linkclass = '';
1621     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1622         $linkclass = 'messageselecteduser';
1623     }
1625     /// are there any unread messages for this contact?
1626     if ($contact->messagecount > 0 ){
1627         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1628     }
1630     $strcontact = $strblock = $strhistory = null;
1632     if ($showactionlinks) {
1633         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1634         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1635         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1636     }
1638     echo '<tr><td class="pix">';
1639     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1640     echo '</td>';
1641     echo '<td class="contact">';
1643     $popupoptions = array(
1644             'height' => MESSAGE_DISCUSSION_HEIGHT,
1645             'width' => MESSAGE_DISCUSSION_WIDTH,
1646             'menubar' => false,
1647             'location' => false,
1648             'status' => true,
1649             'scrollbars' => true,
1650             'resizable' => true);
1652     $link = $action = null;
1653     if (!empty($selectcontacturl)) {
1654         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1655     } else {
1656         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1657         $link = new moodle_url("/message/index.php?id=$contact->id");
1658         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1659     }
1660     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1662     echo '</td>';
1663     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1664     echo '</tr>';
1667 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1668     $strcontact = '';
1670     if($incontactlist){
1671         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1672     } else if ($isblocked) {
1673         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1674     } else{
1675         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1676     }
1678     return $strcontact;
1681 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1682     $strblock   = '';
1684     //commented out to allow the user to block a contact without having to remove them first
1685     /*if ($incontactlist) {
1686         //$strblock = '';
1687     } else*/
1688     if ($isblocked) {
1689         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1690     } else{
1691         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1692     }
1694     return $strblock;
1697  /**
1698   * Moves unread messages from message table to message_read for a given from user
1699   * @param object $userid       User id
1700   * @return boolean success
1701   */
1702 function message_move_userfrom_unread2read($userid) {
1704     global $DB;
1706     // move all unread messages from message table to message_read
1707     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1708         foreach ($messages as $message) {
1709             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1710         }
1711     }
1712     return true;
1715 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1716     global $DB;
1718     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1720     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1722     //for every message to process check if it's for current user and process
1723     $messages = array();
1724     foreach ($messagesproc as $msgp){
1725         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1726         if ($fromuserid){
1727             $query['useridfrom'] = $fromuserid;
1728         }
1729         if ($message = $DB->get_record('message', $query)){
1730             $messages[] = $message;
1731             /// Move the entry to the other table
1732             $message->timeread = time();
1733             $messageid = $message->id;
1734             unset($message->id);
1736             //delete what we've processed and check if can move message
1737             $DB->delete_records('message_working', array('id' => $msgp->id));
1738             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1739                 message_mark_message_read($message, time(), true);
1740             }
1741         }
1742     }
1743     return $messages;
1746 /**
1747 * marks ALL messages being sent from $fromuserid to $touserid as read
1748 * @param int $touserid the id of the message recipient
1749 * @param int $fromuserid the id of the message sender
1750 * @return void
1751 */
1752 function message_mark_messages_read($touserid, $fromuserid){
1753     global $DB;
1755     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1756     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1758     foreach ($messages as $message) {
1759         message_mark_message_read($message, time());
1760     }
1763 /**
1764 * Mark a single message as read
1765 * @param message an object with an object property ie $message->id which is an id in the message table
1766 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1767 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1768 * @return void
1769 */
1770 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1771     global $DB;
1772     
1773     $message->timeread = $timeread;
1775     $messageid = $message->id;
1776     unset($message->id);//unset because it will get a new id on insert into message_read
1778     //If any processors have pending actions abort them
1779     if (!$messageworkingempty) {
1780         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1781     }
1782     $DB->insert_record('message_read', $message);
1783     $DB->delete_records('message', array('id' => $messageid));