e279a744a721e9c85d8bf831aaaf9cba5f2d1807
[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);
30 define ('MESSAGE_WINDOW', true);          // We are in a message window (so don't pop up a new one!)
32 define ('MESSAGE_DISCUSSION_WIDTH',600);
33 define ('MESSAGE_DISCUSSION_HEIGHT',500);
35 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
37 define ('CONTACT_ID','id');
39 define('MESSAGE_HISTORY_SHORT',0);
40 define('MESSAGE_HISTORY_ALL',1);
42 //some constants used as function arguments. Just to make function calls a bit more understandable
43 define('IS_CONTACT',true);
44 define('IS_NOT_CONTACT',false);
46 define('IS_BLOCKED',true);
47 define('IS_NOT_BLOCKED',false);
49 define('VIEW_UNREAD_MESSAGES','unread');
50 define('VIEW_CONTACTS','contacts');
51 define('VIEW_BLOCKED','blockedusers');
52 define('VIEW_COURSE','course_');
53 define('VIEW_SEARCH','search');
55 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
57 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
59 define('MESSAGE_CONTACTS_PER_PAGE',10);
61 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
62     $CFG->message_contacts_refresh = 60;
63 }
64 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
65     $CFG->message_chat_refresh = 5;
66 }
67 if (!isset($CFG->message_offline_time)) {
68     $CFG->message_offline_time = 300;
69 }
71 function message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
72     global $PAGE;
74     echo html_writer::start_tag('div', array('class'=>'contactselector mdl-align'));
76         //if 0 unread messages and they've requested unread messages then show contacts
77         if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES) {
78             $usergroup = VIEW_CONTACTS;
79         }
81         //if they have no blocked users and they've requested blocked users switch them over to contacts
82         if (count($blockedusers)==0 && $usergroup==VIEW_BLOCKED) {
83             $usergroup = VIEW_CONTACTS;
84         }
86         $onlyactivecourses = true;
87         $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
88         $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
90         $strunreadmessages = null;
91         if ($countunreadtotal>0) { //if there are unread messages
92             $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
93         }
95         message_print_usergroup_selector($usergroup, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
97         $refreshpage = false;
99         if ($usergroup==VIEW_UNREAD_MESSAGES) {
100             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
101         } else if ($usergroup==VIEW_CONTACTS || $usergroup==VIEW_SEARCH) {
102             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
103         } else if ($usergroup==VIEW_BLOCKED) {
104             message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
105         } else if (substr($usergroup, 0, 7)==VIEW_COURSE) {
106             $courseidtoshow = intval(substr($usergroup, 7));
108             if (!empty($courseidtoshow)
109                 && array_key_exists($courseidtoshow, $coursecontexts)
110                 && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
112                 message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
113             } else {
114                 //shouldn't get here. User trying to access a course they're not in perhaps.
115                 add_to_log(SITEID, 'message', 'view', 'index.php', $usergroup);
116             }
117         }
119         echo html_writer::start_tag('form', array('action'=>'index.php','method'=>'GET'));
120             echo html_writer::start_tag('fieldset');
121                 $managebuttonclass = 'visible';
122                 if ($usergroup==VIEW_SEARCH) {
123                     $managebuttonclass = 'hiddenelement';
124                 }
125                 $strmanagecontacts = get_string('search','message');
126                 echo html_writer::empty_tag('input', array('type'=>'hidden','name'=>'usergroup','value'=>VIEW_SEARCH));
127                 echo html_writer::empty_tag('input', array('type'=>'submit','value'=>$strmanagecontacts,'class'=>$managebuttonclass));
128             echo html_writer::end_tag('fieldset');
129         echo html_writer::end_tag('form');
131     echo html_writer::end_tag('div');
134 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
135     global $DB, $USER, $PAGE, $OUTPUT;
137     $countparticipants = count_enrolled_users($context);
138     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
139     
140     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
141     echo $OUTPUT->render($pagingbar);
143     echo '<table id="message_participants" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
145     if (!empty($titletodisplay)) {
146         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
147     }
149     if (empty($titletodisplay)) {
150         echo '<tr><td colspan="3" class="heading">';
151         echo get_string('participants');
152         echo '</td></tr>';
153     }
155     //todo these need to come from somewhere if the course participants list is to show users with unread messages
156     $iscontact = true;
157     $isblocked = false;
158     foreach ($participants as $participant) {
159         if ($participant->id != $USER->id) {
160             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
161             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
162         }
163     }
164     //$participants->close();
166     echo '</table>';
169 function message_get_blocked_users($user1=null, &$user2=null) {
170     global $DB, $USER;
172     if (empty($user1)) {
173         $user1 = $USER;
174     }
176     if (!empty($user2)) {
177         $user2->isblocked = false;
178     }
180     $userfields = user_picture::fields('u', array('lastaccess'));
181     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
182                           FROM {message_contacts} mc
183                           JOIN {user} u ON u.id = mc.contactid
184                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
185                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
186                       GROUP BY $userfields
187                       ORDER BY u.firstname ASC";
188     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1'=>$user1->id, 'user1id2'=>$user1->id));
190     $blockedusers = array();
191     if (!empty($rs)) {
192         foreach($rs as $rd) {
193             $blockedusers[] = $rd;
195             if (!empty($user2) && $user2->id==$rd->id) {
196                 $user2->isblocked = true;
197             }
198         }
199         unset($rd);
200         $rs->close();
201     }
203     return $blockedusers;
206 function message_print_blocked_users(&$blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
207     global $DB, $USER;
209     $countblocked = count($blockedusers);
211     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
213     if (!empty($titletodisplay)) {
214         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
215     }
217     if ($countblocked) {
218         echo '<tr><td colspan="3" class="heading">';
219         echo get_string('blockedusers', 'message', $countblocked);
220         echo '</td></tr>';
222         foreach ($blockedusers as $blockeduser) {
223             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
224         }
225     }
227     echo '</table>';
230 function message_get_contacts($user1=null, &$user2=null) {
231     global $DB, $CFG, $USER;
233     if (empty($user1)) {
234         $user1 = $USER;
235     }
237     if (!empty($user2)) {
238         $user2->iscontact = false;
239     }
241     $timetoshowusers = 300; //Seconds default
242     if (isset($CFG->block_online_users_timetosee)) {
243         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
244     }
246     // time which a user is counting as being active since
247     $timefrom = time()-$timetoshowusers;
249     // people in our contactlist who are online
250     $onlinecontacts  = array();
251     // people in our contactlist who are offline
252     $offlinecontacts = array();
253     // people who are not in our contactlist but have sent us a message
254     $strangers       = array();
256     $userfields = user_picture::fields('u', array('lastaccess'));
258     // get all in our contactlist who are not blocked in our contact list
259     // and count messages we have waiting from each of them
260     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
261                      FROM {message_contacts} mc
262                      JOIN {user} u ON u.id = mc.contactid
263                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
264                     WHERE mc.userid = ? AND mc.blocked = 0
265                  GROUP BY $userfields
266                  ORDER BY u.firstname ASC";
268     if ($rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id))){
269         foreach($rs as $rd){
271             if($rd->lastaccess >= $timefrom){
272                 // they have been active recently, so are counted online
273                 $onlinecontacts[] = $rd;
275             }else{
276                 $offlinecontacts[] = $rd;
277             }
279             if (!empty($user2) && $user2->id==$rd->id) {
280                 $user2->iscontact = true;
281             }
282         }
283         unset($rd);
284         $rs->close();
285     }
287     // get messages from anyone who isn't in our contact list and count the number
288     // of messages we have from each of them
289     $strangersql = "SELECT $userfields, count(m.id) as messagecount
290                       FROM {message} m
291                       JOIN {user} u  ON u.id = m.useridfrom
292                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
293                      WHERE mc.id IS NULL AND m.useridto = ?
294                   GROUP BY $userfields
295                   ORDER BY u.firstname ASC";
297     if($rs = $DB->get_recordset_sql($strangersql, array($USER->id))){
298         foreach($rs as $rd){
299             $strangers[] = $rd;
300         }
301         unset($rd);
302         $rs->close();
303     }
305     return array($onlinecontacts, $offlinecontacts, $strangers);
308 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refresh=true, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
309     global $CFG, $PAGE, $OUTPUT;
311     $countonlinecontacts  = count($onlinecontacts);
312     $countofflinecontacts = count($offlinecontacts);
313     $countstrangers       = count($strangers);
315     if ($countonlinecontacts + $countofflinecontacts == 0) {
316         echo '<div class="heading">';
317         print_string('contactlistempty', 'message');
318         echo '</div>';
319         //echo '<div class="note">';
320         //print_string('addsomecontacts', 'message', message_remove_url_params($PAGE->url).'?tab=search');
321         //echo '</div>';
322     }
324     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
326     if (!empty($titletodisplay)) {
327         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
328     }
330     if($countonlinecontacts) {
331         /// print out list of online contacts
333         if (empty($titletodisplay)) {
334             echo '<tr><td colspan="3" class="heading">';
335             echo get_string('onlinecontacts', 'message', $countonlinecontacts);
336             echo '</td></tr>';
337         }
339         foreach ($onlinecontacts as $contact) {
340             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
341                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
342             }
343         }
344     }
346     if ($countofflinecontacts) {
347         /// print out list of offline contacts
349         if (empty($titletodisplay)) {
350             echo '<tr><td colspan="3" class="heading">';
351             echo get_string('offlinecontacts', 'message', $countofflinecontacts);
352             echo '</td></tr>';
353         }
355         foreach ($offlinecontacts as $contact) {
356             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
357                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
358             }
359         }
360         echo '<tr><td colspan="3">&nbsp;</td></tr>';
361     }
363     /// print out list of incoming contacts
364     if ($countstrangers) {
365         echo '<tr><td colspan="3" class="heading">';
366         echo get_string('incomingcontacts', 'message', $countstrangers);
367         echo '</td></tr>';
369         foreach ($strangers as $stranger) {
370             if ($minmessages==0 || $stranger->messagecount>=$minmessages) {
371                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
372             }
373         }
374     }
376     echo '</table>';
378     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
379         echo '<div class="note">(';
380         print_string('addsomecontactsincoming', 'message');
381         echo ')</div>';
382     }
384     echo '<br />';
386     if ($refresh) {
387         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
389         echo $OUTPUT->container_start('messagejsautorefresh note center');
390         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
391         echo $OUTPUT->container_end();
393         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
394         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
395         echo $OUTPUT->container_end();
396     }
399 function message_print_usergroup_selector($usergroup, &$courses, &$coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
400     $strblockedusers = null;
401     $options = array();
403     if ($countunreadtotal>0) { //if there are unread messages
404         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
405     }
407     $strcontacts = get_string('mycontacts', 'message');
408     $options[VIEW_CONTACTS] = $strcontacts;
410     if (!empty($courses)) {
411         $courses_options = array();
413         foreach($courses as $course) {
414             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
415                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
416             }
417         }
419         if (!empty($courses_options)) {
420             $options[] = array(get_string('courses')=>$courses_options);
421         }
422     }
424     if ($countblocked>0) {
425         $strblockedusers = get_string('blockedusers','message', $countblocked);
426         $options[VIEW_BLOCKED] = $strblockedusers;
427     }
429     echo html_writer::start_tag('form', array('id'=>'usergroupform','method'=>'get','action'=>''));
430         echo html_writer::start_tag('fieldset');
431             echo html_writer::select($options, 'usergroup', $usergroup, false, array('id'=>'usergroup','onchange'=>'this.form.submit()'));
432         echo html_writer::end_tag('fieldset');
433     echo html_writer::end_tag('form');
436 function message_get_course_contexts(&$courses) {
437     $coursecontexts = array();
439     foreach($courses as $course) {
440         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
441     }
443     return $coursecontexts;
446 /**
447  * strip off action parameters like 'removecontact'
448  */
449 function message_remove_url_params($moodleurl) {
450     $newurl = new moodle_url($moodleurl);
451     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
452     return $newurl->out();
456 /// $messagearray is an array of objects
457 /// $field is a valid property of object
458 /// $value is the value $field should equal to be counted
459 /// if $field is empty then return count of the whole array
460 /// if $field is non-existent then return 0;
461 function message_count_messages($messagearray, $field='', $value='') {
462     if (!is_array($messagearray)) return 0;
463     if ($field == '' or empty($messagearray)) return count($messagearray);
465     $count = 0;
466     foreach ($messagearray as $message) {
467         $count += ($message->$field == $value) ? 1 : 0;
468     }
469     return $count;
472 /**
473  * Returns the count of unread messages for user. Either from a specific user or from all users.
474  * @global <type> $USER
475  * @global <type> $DB
476  * @param object $user1 the first user. Defaults to $USER
477  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
478  * @return int the count of $user1's unread messages
479  */
480 function message_count_unread_messages($user1=null, $user2=null) {
481     global $USER, $DB;
483     if (empty($user1)) {
484         $user1 = $USER;
485     }
487     if (!empty($user2)) {
488         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
489             array($user1->id, $user2->id), "COUNT('id')");
490     } else {
491         return $DB->count_records_select('message', "useridto = ?",
492             array($user1->id), "COUNT('id')");
493     }
496 function message_count_blocked_users($user1=null) {
497     global $USER, $DB;
499     if (empty($user1)) {
500         $user1 = $USER;
501     }
503     $sql = "SELECT count(mc.id)
504             FROM {message_contacts} mc
505             WHERE mc.userid = :userid AND mc.blocked = 1";
506     $params = array('userid'=>$user1->id);
508     return $DB->count_records_sql($sql, $params);
511 /**
512  *
513  * @global <type> $USER
514  * @global <type> $PAGE
515  * @global <type> $OUTPUT
516  * @param  boolean advancedsearch show basic or advanced search form
517  * @return boolean was a search performed?
518  */
519 function message_print_search($advancedsearch = false, $user1=null) {
520     global $USER, $PAGE, $OUTPUT;
522     $frm = data_submitted();
524     $doingsearch = false;
525     if ($frm) {
526         $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
527     }
529     if (!empty($frm->combinedsearch)) {
530         $combinedsearchstring = $frm->combinedsearch;
531     } else {
532         //$combinedsearchstring = get_string('searchcombined','message').'...';
533         $combinedsearchstring = '';
534     }
536     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
538     if ($doingsearch) {
539         if ($advancedsearch) {
541             $messagesearch = '';
542             if (!empty($frm->keywords)) {
543                 $messagesearch = $frm->keywords;
544             }
545             $personsearch = '';
546             if (!empty($frm->name)) {
547                 $personsearch = $frm->name;
548             }
549             include('search_advanced.html');
550         } else {
551             include('search.html');
552         }
554         $showicontext = false;
555         message_print_search_results($frm, $showicontext, $user1);
557         return true;
558     } else {
559 /*
560 /// unfinished buggy code disabled in search.html anyway
561         // find all courses this use has readallmessages capabilities in
562         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
563             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
564             $cs = '<select name="courseselect">';
565             foreach ($teachers as $tcourse) {
566                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
567             }
568             $cs .= '</select>';
569         }
570 */
572         if ($advancedsearch) {
573             $personsearch = $messagesearch = '';
574             include('search_advanced.html');
575         } else {
576             include('search.html');
577         }
578         return false;
579     }
582 function message_print_settings() {
583     global $USER, $OUTPUT, $PAGE;
585     if ($frm = data_submitted() and confirm_sesskey()) {
587         $pref = array();
588         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
589         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
591         set_user_preferences($pref);
593         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
594     }
596     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
597     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
599     include('settings.html');
604 function message_add_contact($contactid, $blocked=0) {
605     global $USER, $DB;
607     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
608         return false;
609     }
611     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
612     /// record already exists - we may be changing blocking status
614         if ($contact->blocked !== $blocked) {
615         /// change to blocking status
616             $contact->blocked = $blocked;
617             return $DB->update_record('message_contacts', $contact);
618         } else {
619         /// no changes to blocking status
620             return true;
621         }
623     } else {
624     /// new contact record
625         unset($contact);
626         $contact->userid = $USER->id;
627         $contact->contactid = $contactid;
628         $contact->blocked = $blocked;
629         return $DB->insert_record('message_contacts', $contact, false);
630     }
633 function message_remove_contact($contactid) {
634     global $USER, $DB;
635     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
638 function message_unblock_contact($contactid) {
639     global $USER, $DB;
640     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
643 function message_block_contact($contactid) {
644     return message_add_contact($contactid, 1);
647 function message_get_contact($contactid) {
648     global $USER, $DB;
649     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
654 function message_print_search_results($frm, $showicontext=false, $user1=null) {
655     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
657     if (empty($user1)) {
658         $user1 = $USER;
659     }
661     echo '<div class="mdl-left">';
663     $personsearch = false;
664     $personsearchstring = null;
665     if (!empty($frm->personsubmit) and !empty($frm->name)) {
666         $personsearch = true;
667         $personsearchstring = $frm->name;
668     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
669         $personsearch = true;
670         $personsearchstring = $frm->combinedsearch;
671     }
673     /// search for person
674     if ($personsearch) {
675         if (optional_param('mycourses', 0, PARAM_BOOL)) {
676             $users = array();
677             $mycourses = enrol_get_my_courses();
678             foreach ($mycourses as $mycourse) {
679                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
680                     foreach ($susers as $suser) $users[$suser->id] = $suser;
681                 }
682             }
683         } else {
684             $users = message_search_users(SITEID, $personsearchstring);
685         }
687         if (!empty($users)) {
688             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
689             echo get_string('userssearchresults', 'message', count($users));
690             echo html_writer::end_tag('p');
692             echo '<table class="messagesearchresults">';
693             foreach ($users as $user) {
695                 if ( $user->contactlistid )  {
696                     if ($user->blocked == 0) { /// not blocked
697                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
698                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
699                     } else { // blocked
700                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
701                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
702                     }
703                 } else {
704                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
705                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
706                 }
708                 //should we show just the icon or icon and text?
709                 $histicontext = 'icon';
710                 if ($showicontext) {
711                     $histicontext = 'both';
712                 }
713                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
715                 echo '<tr><td class="pix">';
716                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
717                 echo '</td>';
718                 echo '<td class="contact">';
719                 $popupoptions = array(
720                         'height' => MESSAGE_DISCUSSION_HEIGHT,
721                         'width' => MESSAGE_DISCUSSION_WIDTH,
722                         'menubar' => false,
723                         'location' => false,
724                         'status' => true,
725                         'scrollbars' => true,
726                         'resizable' => true);
728                 $link = new moodle_url("/message/index.php?id=$user->id");
729                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
730                 $action = null;
731                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
733                 echo '</td>';
735                 echo '<td class="link">'.$strcontact.'</td>';
736                 echo '<td class="link">'.$strblock.'</td>';
737                 echo '<td class="link">'.$strhistory.'</td>';
738                 echo '</tr>';
739             }
740             echo '</table>';
742         } else {
743             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
744             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
745             echo html_writer::end_tag('p');
746         }
747     }
749     // search messages for keywords
750     $messagesearch = false;
751     $messagesearchstring = null;
752     if (!empty($frm->keywords)) {
753         $messagesearch = true;
754         $messagesearchstring = clean_text(trim($frm->keywords));
755     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
756         $messagesearch = true;
757         $messagesearchstring = clean_text(trim($frm->combinedsearch));
758     }
760     if ($messagesearch) {
761         if ($messagesearchstring) {
762             $keywords = explode(' ', $messagesearchstring);
763         } else {
764             $keywords = array();
765         }
766         $tome     = false;
767         $fromme   = false;
768         $courseid = 'none';
770         if (empty($frm->keywordsoption)) {
771             $frm->keywordsoption = 'allmine';
772         }
774         switch ($frm->keywordsoption) {
775             case 'tome':
776                 $tome   = true;
777                 break;
778             case 'fromme':
779                 $fromme = true;
780                 break;
781             case 'allmine':
782                 $tome   = true;
783                 $fromme = true;
784                 break;
785             case 'allusers':
786                 $courseid = SITEID;
787                 break;
788             case 'courseusers':
789                 $courseid = $frm->courseid;
790                 break;
791             default:
792                 $tome   = true;
793                 $fromme = true;
794         }
796         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
798         /// get a list of contacts
799             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
800                 $contacts = array();
801             }
803         /// print heading with number of results
804             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
805             $countresults = count($messages);
806             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
807                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
808             } else {
809                 echo get_string('keywordssearchresults', 'message', $countresults);
810             }
811             echo html_writer::end_tag('p');
813         /// print table headings
814             echo '<table class="messagesearchresults" cellspacing="0">';
816             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
817             $headertdend   = html_writer::end_tag('td');
818             echo '<tr>';
819             echo $headertdstart.get_string('from').$headertdend;
820             echo $headertdstart.get_string('to').$headertdend;
821             echo $headertdstart.get_string('message', 'message').$headertdend;
822             echo $headertdstart.get_string('timesent', 'message').$headertdend;
823             echo "</tr>\n";
825             $blockedcount = 0;
826             $dateformat = get_string('strftimedatetimeshort');
827             $strcontext = get_string('context', 'message');
828             foreach ($messages as $message) {
830             /// ignore messages to and from blocked users unless $frm->includeblocked is set
831                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
832                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
833                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
834                                                 )
835                    ) {
836                     $blockedcount ++;
837                     continue;
838                 }
840             /// load up user to record
841                 if ($message->useridto !== $USER->id) {
842                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
843                     $tocontact = (array_key_exists($message->useridto, $contacts) and
844                                     ($contacts[$message->useridto]->blocked == 0) );
845                     $toblocked = (array_key_exists($message->useridto, $contacts) and
846                                     ($contacts[$message->useridto]->blocked == 1) );
847                 } else {
848                     $userto = false;
849                     $tocontact = false;
850                     $toblocked = false;
851                 }
853             /// load up user from record
854                 if ($message->useridfrom !== $USER->id) {
855                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
856                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
857                                     ($contacts[$message->useridfrom]->blocked == 0) );
858                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
859                                     ($contacts[$message->useridfrom]->blocked == 1) );
860                 } else {
861                     $userfrom = false;
862                     $fromcontact = false;
863                     $fromblocked = false;
864                 }
866             /// find date string for this message
867                 $date = usergetdate($message->timecreated);
868                 $datestring = $date['year'].$date['mon'].$date['mday'];
870             /// print out message row
871                 echo '<tr valign="top">';
872                 echo '<td class="contact">';
873                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
874                 echo '</td>';
875                 echo '<td class="contact">';
876                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
877                 echo '</td>';
878                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
879                 echo '<br /><div class="link">';
881                 //find the user involved that isn't the current user
882                 $user2id = null;
883                 if ($user1->id == $message->useridto) {
884                     $user2id = $message->useridfrom;
885                 } else {
886                     $user2id = $message->useridto;
887                 }
888                 message_history_link($user1->id, $user2id, false,
889                                      $messagesearchstring, 'm'.$message->id, $strcontext);
890                 echo '</div>';
891                 echo '</td>';
892                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
893                 echo "</tr>\n";
894             }
897             if ($blockedcount > 0) {
898                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
899             }
900             echo '</table>';
902         } else {
903             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
904         }
905     }
907     if (!$personsearch && !$messagesearch) {
908         //they didn't enter any search terms
909         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
910     }
912     //echo '<br />';
913     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
915     echo '</div>';
919 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
920     global $USER, $OUTPUT;
922     if ($user === false) {
923         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
924     } else {
925         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
926         echo '&nbsp;';
928         $return = false;
929         $script = null;
930         if ($iscontact) {
931             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
932         } else {
933             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
934         }
935         echo '&nbsp;';
936         if ($isblocked) {
937             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
938         } else {
939             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
940         }
941         echo '<br />';
943         $popupoptions = array(
944                 'height' => MESSAGE_DISCUSSION_HEIGHT,
945                 'width' => MESSAGE_DISCUSSION_WIDTH,
946                 'menubar' => false,
947                 'location' => false,
948                 'status' => true,
949                 'scrollbars' => true,
950                 'resizable' => true);
952         $link = new moodle_url("/message/index.php?id=$user->id");
953         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
954         $action = null;
955         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
957     }
961 /// linktype can be: add, remove, block, unblock
962 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
963     global $USER, $CFG, $OUTPUT, $PAGE;
965     //hold onto the strings as we're probably creating a bunch of links
966     static $str;
968     if (empty($script)) {
969         //strip off previous action params like 'removecontact'
970         $script = message_remove_url_params($PAGE->url);
971     }
973     if (empty($str->blockcontact)) {
974        $str->blockcontact   =  get_string('blockcontact', 'message');
975        $str->unblockcontact =  get_string('unblockcontact', 'message');
976        $str->removecontact  =  get_string('removecontact', 'message');
977        $str->addcontact     =  get_string('addcontact', 'message');
978     }
980     $command = $linktype.'contact';
981     $string  = $str->{$command};
983     $safealttext = s($string);
985     $safestring = '';
986     if (!empty($text)) {
987         $safestring = $safealttext;
988     }
990     $img = '';
991     if ($icon) {
992         $iconpath = null;
993         switch ($linktype) {
994             case 'block':
995                 $iconpath = 't/block';
996                 break;
997             case 'unblock':
998                 $iconpath = 't/userblue';
999                 break;
1000             case 'remove':
1001                 $iconpath = 'i/cross_red_big';
1002                 break;
1003             case 'add':
1004             default:
1005                 $iconpath = 't/addgreen';
1006         }
1008         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1009     }
1011     $output = '<span class="'.$linktype.'contact">'.
1012               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1013               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1014               $img.
1015               $safestring.'</a></span>';
1017     if ($return) {
1018         return $output;
1019     } else {
1020         echo $output;
1021         return true;
1022     }
1025 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1026     global $USER, $CFG, $OUTPUT;
1028     static $strmessagehistory;
1030     if (empty($strmessagehistory)) {
1031         $strmessagehistory = get_string('messagehistory', 'message');
1032     }
1034     if ($position) {
1035         $position = "#$position";
1036     }
1037     if ($keywords) {
1038         $keywords = "&search=".urlencode($keywords);
1039     }
1041     if ($linktext == 'icon') {  // Icon only
1042         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1043     } else if ($linktext == 'both') {  // Icon and standard name
1044         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1045         $fulllink .= '&nbsp;'.$strmessagehistory;
1046     } else if ($linktext) {    // Custom name
1047         $fulllink = $linktext;
1048     } else {                   // Standard name only
1049         $fulllink = $strmessagehistory;
1050     }
1052     $popupoptions = array(
1053             'height' => 500,
1054             'width' => 500,
1055             'menubar' => false,
1056             'location' => false,
1057             'status' => true,
1058             'scrollbars' => true,
1059             'resizable' => true);
1061     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1062     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1063     $action = null;
1064     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1066     $str = '<span class="history">'.$str.'</span>';
1068     if ($returnstr) {
1069         return $str;
1070     } else {
1071         echo $str;
1072         return true;
1073     }
1077 /**
1078  * Search through course users
1079  *
1080  * If $coursid specifies the site course then this function searches
1081  * through all undeleted and confirmed users
1082  *
1083  * @uses $CFG, $USER
1084  * @uses SITEID
1085  * @param int $courseid The course in question.
1086  * @param string $searchtext ?
1087  * @param string $sort ?
1088  * @param string $exceptions ?
1089  * @return array  An array of {@link $USER} records.
1090  * @todo Finish documenting this function
1091  */
1092 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1093     global $CFG, $USER, $DB;
1095     $fullname = $DB->sql_fullname();
1097     if (!empty($exceptions)) {
1098         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1099     } else {
1100         $except = '';
1101     }
1103     if (!empty($sort)) {
1104         $order = ' ORDER BY '. $sort;
1105     } else {
1106         $order = '';
1107     }
1109     $ufields = user_picture::fields('u');
1110     if (!$courseid or $courseid == SITEID) {
1111         $params = array($USER->id, "%$searchtext%");
1112         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1113                                        FROM {user} u
1114                                        LEFT JOIN {message_contacts} mc
1115                                             ON mc.contactid = u.id AND mc.userid = ?
1116                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1117                                             AND (".$DB->sql_like($fullname, '?', false).")
1118                                             $except
1119                                      $order", $params);
1120     } else {
1121 //TODO: add enabled enrolment join here (skodak)
1122         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1123         $contextlists = get_related_contexts_string($context);
1125         // everyone who has a role assignment in this course or higher
1126         $params = array($USER->id, "%$searchtext%");
1127         $users = $DB->get_records_sql("SELECT $ufields,
1128                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1129                                          JOIN {role_assignments} ra ON ra.userid = u.id
1130                                          LEFT JOIN {message_contacts} mc
1131                                               ON mc.contactid = u.id AND mc.userid = ?
1132                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1133                                               AND ra.contextid $contextlists
1134                                               AND (".$DB->sql_like($fullname, '?', false).")
1135                                               $except
1136                                        $order", $params);
1138         return $users;
1139     }
1145 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1146 /// Returns a list of posts found using an array of search terms
1147 /// eg   word  +word -word
1148 ///
1149     global $CFG, $USER, $DB;
1151     /// If no userid sent then assume current user
1152     if ($userid == 0) $userid = $USER->id;
1154     /// Some differences in SQL syntax
1155     if ($DB->sql_regex_supported()) {
1156         $REGEXP    = $DB->sql_regex(true);
1157         $NOTREGEXP = $DB->sql_regex(false);
1158     }
1160     $searchcond = array();
1161     $params = array();
1162     $i = 0;
1164     //preprocess search terms to check whether we have at least 1 eligible search term
1165     //if we do we can drop words around it like 'a'
1166     $dropshortwords = false;
1167     foreach ($searchterms as $searchterm) {
1168         if (strlen($searchterm) >= 2) {
1169             $dropshortwords = true;
1170         }
1171     }
1173     foreach ($searchterms as $searchterm) {
1174         $i++;
1176         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1178         if ($dropshortwords && strlen($searchterm) < 2) {
1179             continue;
1180         }
1181     /// Under Oracle and MSSQL, trim the + and - operators and perform
1182     /// simpler LIKE search
1183         if (!$DB->sql_regex_supported()) {
1184             if (substr($searchterm, 0, 1) == '-') {
1185                 $NOT = true;
1186             }
1187             $searchterm = trim($searchterm, '+-');
1188         }
1190         if (substr($searchterm,0,1) == "+") {
1191             $searchterm = substr($searchterm,1);
1192             $searchterm = preg_quote($searchterm, '|');
1193             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1194             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1196         } else if (substr($searchterm,0,1) == "-") {
1197             $searchterm = substr($searchterm,1);
1198             $searchterm = preg_quote($searchterm, '|');
1199             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1200             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1202         } else {
1203             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1204             $params['ss'.$i] = "%$searchterm%";
1205         }
1206     }
1208     if (empty($searchcond)) {
1209         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1210         $params['ss1'] = "%";
1211     } else {
1212         $searchcond = implode(" AND ", $searchcond);
1213     }
1215     /// There are several possibilities
1216     /// 1. courseid = SITEID : The admin is searching messages by all users
1217     /// 2. courseid = ??     : A teacher is searching messages by users in
1218     ///                        one of their courses - currently disabled
1219     /// 3. courseid = none   : User is searching their own messages;
1220     ///    a.  Messages from user
1221     ///    b.  Messages to user
1222     ///    c.  Messages to and from user
1224     if ($courseid == SITEID) { /// admin is searching all messages
1225         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1226                                             FROM {message_read} m
1227                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1228         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1229                                             FROM {message} m
1230                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1232     } else if ($courseid !== 'none') {
1233         /// This has not been implemented due to security concerns
1234         $m_read   = array();
1235         $m_unread = array();
1237     } else {
1239         if ($fromme and $tome) {
1240             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1241             $params['userid1'] = $userid;
1242             $params['userid2'] = $userid;
1244         } else if ($fromme) {
1245             $searchcond .= " AND m.useridfrom=:userid";
1246             $params['userid'] = $userid;
1248         } else if ($tome) {
1249             $searchcond .= " AND m.useridto=:userid";
1250             $params['userid'] = $userid;
1251         }
1253         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1254                                             FROM {message_read} m
1255                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1256         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1257                                             FROM {message} m
1258                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1260     }
1262     /// The keys may be duplicated in $m_read and $m_unread so we can't
1263     /// do a simple concatenation
1264     $message = array();
1265     foreach ($m_read as $m) {
1266         $messages[] = $m;
1267     }
1268     foreach ($m_unread as $m) {
1269         $messages[] = $m;
1270     }
1272     return (empty($messages)) ? false : $messages;
1277 /// Borrowed with changes from mod/forum/lib.php
1278 function message_shorten_message($message, $minlength=0) {
1279 // Given a post object that we already know has a long message
1280 // this function truncates the message nicely to the first
1281 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1283     $i = 0;
1284     $tag = false;
1285     $length = strlen($message);
1286     $count = 0;
1287     $stopzone = false;
1288     $truncate = 0;
1289     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1292     for ($i=0; $i<$length; $i++) {
1293         $char = $message[$i];
1295         switch ($char) {
1296             case "<":
1297                 $tag = true;
1298                 break;
1299             case ">":
1300                 $tag = false;
1301                 break;
1302             default:
1303                 if (!$tag) {
1304                     if ($stopzone) {
1305                         if ($char == '.' or $char == ' ') {
1306                             $truncate = $i+1;
1307                             break 2;
1308                         }
1309                     }
1310                     $count++;
1311                 }
1312                 break;
1313         }
1314         if (!$stopzone) {
1315             if ($count > $minlength) {
1316                 $stopzone = true;
1317             }
1318         }
1319     }
1321     if (!$truncate) {
1322         $truncate = $i;
1323     }
1325     return substr($message, 0, $truncate);
1329 /**
1330  * Given a string and an array of keywords, this function looks
1331  * for the first keyword in the string, and then chops out a
1332  * small section from the text that shows that word in context.
1333  */
1334 function message_get_fragment($message, $keywords) {
1336     $fullsize = 160;
1337     $halfsize = (int)($fullsize/2);
1339     $message = strip_tags($message);
1341     foreach ($keywords as $keyword) {  // Just get the first one
1342         if ($keyword !== '') {
1343             break;
1344         }
1345     }
1346     if (empty($keyword)) {   // None found, so just return start of message
1347         return message_shorten_message($message, 30);
1348     }
1350     $leadin = $leadout = '';
1352 /// Find the start of the fragment
1353     $start = 0;
1354     $length = strlen($message);
1356     $pos = strpos($message, $keyword);
1357     if ($pos > $halfsize) {
1358         $start = $pos - $halfsize;
1359         $leadin = '...';
1360     }
1361 /// Find the end of the fragment
1362     $end = $start + $fullsize;
1363     if ($end > $length) {
1364         $end = $length;
1365     } else {
1366         $leadout = '...';
1367     }
1369 /// Pull out the fragment and format it
1371     $fragment = substr($message, $start, $end - $start);
1372     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1373     return $fragment;
1376 //retrieve the messages between two users
1377 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1378     global $DB, $CFG;
1380     $messages = array();
1382     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1383     //desc to get the last $limitnum messages then flip the order in php
1384     $sort = 'asc';
1385     if ($limitnum>0) {
1386         $sort = 'desc';
1387     }
1389     $notificationswhere = null;
1390     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1391     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1392         $notificationswhere = 'AND notification=0';
1393     }
1395     //prevent notifications of your own actions appearing in your own message history
1396     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1398     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1399                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1400                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1401                                                     "timecreated $sort", '*', 0, $limitnum)) {
1402         foreach ($messages_read as $message) {
1403             $messages[$message->timecreated] = $message;
1404         }
1405     }
1406     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1407                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1408                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1409                                                     "timecreated $sort", '*', 0, $limitnum)) {
1410         foreach ($messages_new as $message) {
1411             $messages[$message->timecreated] = $message;
1412         }
1413     }
1415     //if we only want the last $limitnum messages
1416     if ($limitnum>0) {
1417         ksort($messages);
1418         $messages = array_slice($messages, count($messages)-$limitnum, $limitnum, true);
1419     }
1421     return $messages;
1424 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1425     global $CFG, $OUTPUT;
1427     echo $OUTPUT->box_start('center');
1428     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1429     echo '<td align="center" id="user1">';
1430     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1431     echo '<div class="heading">'.fullname($user1).'</div>';
1432     echo '</td>';
1433     echo '<td align="center">';
1434     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1435     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1436     echo '</td>';
1437     echo '<td align="center" id="user2">';
1438     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1439     echo '<div class="heading">'.fullname($user2).'</div>';
1441     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1442         $incontactlist = $user2->iscontact;
1443         $isblocked = $user2->isblocked;
1445         $script = null;
1446         $text = true;
1447         $icon = false;
1449         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1450         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1451         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1453         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1454     }
1456     echo '</td>';
1457     echo '</tr></table>';
1458     echo $OUTPUT->box_end();
1460     if (!empty($messagehistorylink)) {
1461         echo $messagehistorylink;
1462     }
1464     /// Get all the messages and print them
1465     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1466         $tablecontents = '';
1468         $current = new stdClass();
1469         $current->mday = '';
1470         $current->month = '';
1471         $current->year = '';
1472         $messagedate = get_string('strftimetime');
1473         $blockdate   = get_string('strftimedaydate');
1474         foreach ($messages as $message) {
1475             if ($message->notification) {
1476                 $notificationclass = ' notification';
1477             } else {
1478                 $notificationclass = null;
1479             }
1480             $date = usergetdate($message->timecreated);
1481             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1482                 $current->mday = $date['mday'];
1483                 $current->month = $date['month'];
1484                 $current->year = $date['year'];
1486                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1487                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1488             }
1489             if ($message->useridfrom == $user1->id) {
1490                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1491             } else {
1492                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1493             }
1494         }
1496         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1497     } else {
1498         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1499     }
1502 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1504     static $dateformat;
1506     if (empty($dateformat)) {
1507         if ($format) {
1508             $dateformat = $format;
1509         } else {
1510             $format = get_string('strftimedatetimeshort');
1511         }
1512     }
1513     $time = userdate($message->timecreated, $dateformat);
1514     $options = new stdClass();
1515     $options->para = false;
1517     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1518     if (!empty($message->smallmessage)) {
1519         $messagetext = format_text($message->smallmessage, null, $options);
1520     } else {
1521         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1522     }
1524     if (!empty($message->contexturl)) {
1525         $displaytext = null;
1526         if (!empty($message->contexturlname)) {
1527             $displaytext= $message->contexturlname;
1528         } else {
1529             $displaytext= $message->contexturl;
1530         }
1531         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1532             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1533         $messagetext .= html_writer::end_tag('div');
1534     }
1536     if ($keywords) {
1537         $messagetext = highlight($keywords, $messagetext);
1538     }
1540     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1543 /**
1544  * Inserts a message into the database, but also forwards it
1545  * via other means if appropriate.
1546  */
1547 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1548     global $SITE, $CFG, $USER;
1550     $eventdata = new stdClass();
1551     $eventdata->component        = 'moodle';
1552     $eventdata->name             = 'instantmessage';
1553     $eventdata->userfrom         = $userfrom;
1554     $eventdata->userto           = $userto;
1556     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1557     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1559     $eventdata->fullmessage      = $message;
1560     $eventdata->fullmessageformat = $format;
1561     $eventdata->fullmessagehtml  = '';
1562     $eventdata->smallmessage     = $message;
1564     $s = new stdClass();
1565     $s->sitename = $SITE->shortname;
1566     $s->url = $CFG->wwwroot.'/message/index.php?id='.$userfrom->id;//.'&user='.$userto->id;
1568     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1569     if (!empty($eventdata->fullmessage)) {
1570         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1571     }
1572     if (!empty($eventdata->fullmessagehtml)) {
1573         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1574     }
1575     
1576     $eventdata->timecreated     = time();
1577     return message_send($eventdata);
1581 /**
1582  * Returns a list of all user ids who have used messaging in the site
1583  * This was the simple way to code the SQL ... is it going to blow up
1584  * on large datasets?
1585  */
1586 function message_get_participants() {
1587     global $CFG, $DB;
1589         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1590                                UNION SELECT useridto as id,1 FROM {message}
1591                                UNION SELECT useridfrom as id,1 FROM {message_read}
1592                                UNION SELECT useridto as id,1 FROM {message_read}
1593                                UNION SELECT userid as id,1 FROM {message_contacts}
1594                                UNION SELECT contactid as id,1 from {message_contacts}");
1597 /**
1598  * Print a row of contactlist displaying user picture, messages waiting and
1599  * block links etc
1600  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1601  * @param $incontactlist is the user a contact of ours?
1602  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1603  */
1604 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1605     global $OUTPUT, $USER;
1606     $fullname  = fullname($contact);
1607     $fullnamelink  = $fullname;
1609     $linkclass = '';
1610     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1611         $linkclass = 'messageselecteduser';
1612     }
1614     /// are there any unread messages for this contact?
1615     if ($contact->messagecount > 0 ){
1616         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1617     }
1619     $strcontact = $strblock = $strhistory = null;
1621     if ($showactionlinks) {
1622         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1623         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1624         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1625     }
1627     echo '<tr><td class="pix">';
1628     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1629     echo '</td>';
1630     echo '<td class="contact">';
1632     $popupoptions = array(
1633             'height' => MESSAGE_DISCUSSION_HEIGHT,
1634             'width' => MESSAGE_DISCUSSION_WIDTH,
1635             'menubar' => false,
1636             'location' => false,
1637             'status' => true,
1638             'scrollbars' => true,
1639             'resizable' => true);
1641     $link = $action = null;
1642     if (!empty($selectcontacturl)) {
1643         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1644     } else {
1645         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1646         $link = new moodle_url("/message/index.php?id=$contact->id");
1647         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1648     }
1649     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1651     echo '</td>';
1652     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1653     echo '</tr>';
1656 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1657     $strcontact = '';
1659     if($incontactlist){
1660         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1661     } else if ($isblocked) {
1662         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1663     } else{
1664         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1665     }
1667     return $strcontact;
1670 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1671     $strblock   = '';
1673     //commented out to allow the user to block a contact without having to remove them first
1674     /*if ($incontactlist) {
1675         //$strblock = '';
1676     } else*/
1677     if ($isblocked) {
1678         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1679     } else{
1680         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1681     }
1683     return $strblock;
1686  /**
1687   * Moves unread messages from message table to message_read for a given from user
1688   * @param object $userid       User id
1689   * @return boolean success
1690   */
1691 function message_move_userfrom_unread2read($userid) {
1693     global $DB;
1695     // move all unread messages from message table to message_read
1696     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1697         foreach ($messages as $message) {
1698             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1699         }
1700     }
1701     return true;
1704 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1705     global $DB;
1707     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1709     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1711     //for every message to process check if it's for current user and process
1712     $messages = array();
1713     foreach ($messagesproc as $msgp){
1714         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1715         if ($fromuserid){
1716             $query['useridfrom'] = $fromuserid;
1717         }
1718         if ($message = $DB->get_record('message', $query)){
1719             $messages[] = $message;
1720             /// Move the entry to the other table
1721             $message->timeread = time();
1722             $messageid = $message->id;
1723             unset($message->id);
1725             //delete what we've processed and check if can move message
1726             $DB->delete_records('message_working', array('id' => $msgp->id));
1727             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1728                 message_mark_message_read($message, time(), true);
1729             }
1730         }
1731     }
1732     return $messages;
1735 /**
1736 * marks ALL messages being sent from $fromuserid to $touserid as read
1737 * @param int $touserid the id of the message recipient
1738 * @param int $fromuserid the id of the message sender
1739 * @return void
1740 */
1741 function message_mark_messages_read($touserid, $fromuserid){
1742     global $DB;
1744     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1745     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1747     foreach ($messages as $message) {
1748         message_mark_message_read($message, time());
1749     }
1752 /**
1753 * Mark a single message as read
1754 * @param message an object with an object property ie $message->id which is an id in the message table
1755 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1756 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1757 * @return void
1758 */
1759 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1760     global $DB;
1761     
1762     $message->timeread = $timeread;
1764     $messageid = $message->id;
1765     unset($message->id);//unset because it will get a new id on insert into message_read
1767     //If any processors have pending actions abort them
1768     if (!$messageworkingempty) {
1769         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1770     }
1771     $DB->insert_record('message_read', $message);
1772     $DB->delete_records('message', array('id' => $messageid));