message MDL-25148 using method on $PAGE to allow or disallow popup notifications
[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->set_popup_notification_allowed(false); // We are in a message window (so don't pop up a new one)
33 define ('MESSAGE_DISCUSSION_WIDTH',600);
34 define ('MESSAGE_DISCUSSION_HEIGHT',500);
36 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
38 define ('CONTACT_ID','id');
40 define('MESSAGE_HISTORY_SHORT',0);
41 define('MESSAGE_HISTORY_ALL',1);
43 //some constants used as function arguments. Just to make function calls a bit more understandable
44 define('IS_CONTACT',true);
45 define('IS_NOT_CONTACT',false);
47 define('IS_BLOCKED',true);
48 define('IS_NOT_BLOCKED',false);
50 define('VIEW_UNREAD_MESSAGES','unread');
51 define('VIEW_CONTACTS','contacts');
52 define('VIEW_BLOCKED','blockedusers');
53 define('VIEW_COURSE','course_');
54 define('VIEW_SEARCH','search');
56 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
58 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
60 define('MESSAGE_CONTACTS_PER_PAGE',10);
62 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
63     $CFG->message_contacts_refresh = 60;
64 }
65 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
66     $CFG->message_chat_refresh = 5;
67 }
68 if (!isset($CFG->message_offline_time)) {
69     $CFG->message_offline_time = 300;
70 }
72 function message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
73     global $PAGE;
75     echo html_writer::start_tag('div', array('class'=>'contactselector mdl-align'));
77         //if 0 unread messages and they've requested unread messages then show contacts
78         if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES) {
79             $usergroup = VIEW_CONTACTS;
80         }
82         //if they have no blocked users and they've requested blocked users switch them over to contacts
83         if (count($blockedusers)==0 && $usergroup==VIEW_BLOCKED) {
84             $usergroup = VIEW_CONTACTS;
85         }
87         $onlyactivecourses = true;
88         $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
89         $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
91         $strunreadmessages = null;
92         if ($countunreadtotal>0) { //if there are unread messages
93             $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
94         }
96         message_print_usergroup_selector($usergroup, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
98         $refreshpage = false;
100         if ($usergroup==VIEW_UNREAD_MESSAGES) {
101             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
102         } else if ($usergroup==VIEW_CONTACTS || $usergroup==VIEW_SEARCH) {
103             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
104         } else if ($usergroup==VIEW_BLOCKED) {
105             message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
106         } else if (substr($usergroup, 0, 7)==VIEW_COURSE) {
107             $courseidtoshow = intval(substr($usergroup, 7));
109             if (!empty($courseidtoshow)
110                 && array_key_exists($courseidtoshow, $coursecontexts)
111                 && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
113                 message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
114             } else {
115                 //shouldn't get here. User trying to access a course they're not in perhaps.
116                 add_to_log(SITEID, 'message', 'view', 'index.php', $usergroup);
117             }
118         }
120         echo html_writer::start_tag('form', array('action'=>'index.php','method'=>'GET'));
121             echo html_writer::start_tag('fieldset');
122                 $managebuttonclass = 'visible';
123                 if ($usergroup==VIEW_SEARCH) {
124                     $managebuttonclass = 'hiddenelement';
125                 }
126                 $strmanagecontacts = get_string('search','message');
127                 echo html_writer::empty_tag('input', array('type'=>'hidden','name'=>'usergroup','value'=>VIEW_SEARCH));
128                 echo html_writer::empty_tag('input', array('type'=>'submit','value'=>$strmanagecontacts,'class'=>$managebuttonclass));
129             echo html_writer::end_tag('fieldset');
130         echo html_writer::end_tag('form');
132     echo html_writer::end_tag('div');
135 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
136     global $DB, $USER, $PAGE, $OUTPUT;
138     $countparticipants = count_enrolled_users($context);
139     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
140     
141     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
142     echo $OUTPUT->render($pagingbar);
144     echo '<table id="message_participants" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
146     if (!empty($titletodisplay)) {
147         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
148     }
150     if (empty($titletodisplay)) {
151         echo '<tr><td colspan="3" class="heading">';
152         echo get_string('participants');
153         echo '</td></tr>';
154     }
156     //todo these need to come from somewhere if the course participants list is to show users with unread messages
157     $iscontact = true;
158     $isblocked = false;
159     foreach ($participants as $participant) {
160         if ($participant->id != $USER->id) {
161             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
162             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
163         }
164     }
165     //$participants->close();
167     echo '</table>';
170 function message_get_blocked_users($user1=null, &$user2=null) {
171     global $DB, $USER;
173     if (empty($user1)) {
174         $user1 = $USER;
175     }
177     if (!empty($user2)) {
178         $user2->isblocked = false;
179     }
181     $userfields = user_picture::fields('u', array('lastaccess'));
182     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
183                           FROM {message_contacts} mc
184                           JOIN {user} u ON u.id = mc.contactid
185                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
186                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
187                       GROUP BY $userfields
188                       ORDER BY u.firstname ASC";
189     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1'=>$user1->id, 'user1id2'=>$user1->id));
191     $blockedusers = array();
192     if (!empty($rs)) {
193         foreach($rs as $rd) {
194             $blockedusers[] = $rd;
196             if (!empty($user2) && $user2->id==$rd->id) {
197                 $user2->isblocked = true;
198             }
199         }
200         unset($rd);
201         $rs->close();
202     }
204     return $blockedusers;
207 function message_print_blocked_users(&$blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
208     global $DB, $USER;
210     $countblocked = count($blockedusers);
212     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
214     if (!empty($titletodisplay)) {
215         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
216     }
218     if ($countblocked) {
219         echo '<tr><td colspan="3" class="heading">';
220         echo get_string('blockedusers', 'message', $countblocked);
221         echo '</td></tr>';
223         foreach ($blockedusers as $blockeduser) {
224             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
225         }
226     }
228     echo '</table>';
231 function message_get_contacts($user1=null, &$user2=null) {
232     global $DB, $CFG, $USER;
234     if (empty($user1)) {
235         $user1 = $USER;
236     }
238     if (!empty($user2)) {
239         $user2->iscontact = false;
240     }
242     $timetoshowusers = 300; //Seconds default
243     if (isset($CFG->block_online_users_timetosee)) {
244         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
245     }
247     // time which a user is counting as being active since
248     $timefrom = time()-$timetoshowusers;
250     // people in our contactlist who are online
251     $onlinecontacts  = array();
252     // people in our contactlist who are offline
253     $offlinecontacts = array();
254     // people who are not in our contactlist but have sent us a message
255     $strangers       = array();
257     $userfields = user_picture::fields('u', array('lastaccess'));
259     // get all in our contactlist who are not blocked in our contact list
260     // and count messages we have waiting from each of them
261     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
262                      FROM {message_contacts} mc
263                      JOIN {user} u ON u.id = mc.contactid
264                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
265                     WHERE mc.userid = ? AND mc.blocked = 0
266                  GROUP BY $userfields
267                  ORDER BY u.firstname ASC";
269     if ($rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id))){
270         foreach($rs as $rd){
272             if($rd->lastaccess >= $timefrom){
273                 // they have been active recently, so are counted online
274                 $onlinecontacts[] = $rd;
276             }else{
277                 $offlinecontacts[] = $rd;
278             }
280             if (!empty($user2) && $user2->id==$rd->id) {
281                 $user2->iscontact = true;
282             }
283         }
284         unset($rd);
285         $rs->close();
286     }
288     // get messages from anyone who isn't in our contact list and count the number
289     // of messages we have from each of them
290     $strangersql = "SELECT $userfields, count(m.id) as messagecount
291                       FROM {message} m
292                       JOIN {user} u  ON u.id = m.useridfrom
293                       LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
294                      WHERE mc.id IS NULL AND m.useridto = ?
295                   GROUP BY $userfields
296                   ORDER BY u.firstname ASC";
298     if($rs = $DB->get_recordset_sql($strangersql, array($USER->id))){
299         foreach($rs as $rd){
300             $strangers[] = $rd;
301         }
302         unset($rd);
303         $rs->close();
304     }
306     return array($onlinecontacts, $offlinecontacts, $strangers);
309 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refresh=true, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
310     global $CFG, $PAGE, $OUTPUT;
312     $countonlinecontacts  = count($onlinecontacts);
313     $countofflinecontacts = count($offlinecontacts);
314     $countstrangers       = count($strangers);
316     if ($countonlinecontacts + $countofflinecontacts == 0) {
317         echo '<div class="heading">';
318         print_string('contactlistempty', 'message');
319         echo '</div>';
320         //echo '<div class="note">';
321         //print_string('addsomecontacts', 'message', message_remove_url_params($PAGE->url).'?tab=search');
322         //echo '</div>';
323     }
325     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
327     if (!empty($titletodisplay)) {
328         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
329     }
331     if($countonlinecontacts) {
332         /// print out list of online contacts
334         if (empty($titletodisplay)) {
335             echo '<tr><td colspan="3" class="heading">';
336             echo get_string('onlinecontacts', 'message', $countonlinecontacts);
337             echo '</td></tr>';
338         }
340         foreach ($onlinecontacts as $contact) {
341             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
342                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
343             }
344         }
345     }
347     if ($countofflinecontacts) {
348         /// print out list of offline contacts
350         if (empty($titletodisplay)) {
351             echo '<tr><td colspan="3" class="heading">';
352             echo get_string('offlinecontacts', 'message', $countofflinecontacts);
353             echo '</td></tr>';
354         }
356         foreach ($offlinecontacts as $contact) {
357             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
358                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
359             }
360         }
361         echo '<tr><td colspan="3">&nbsp;</td></tr>';
362     }
364     /// print out list of incoming contacts
365     if ($countstrangers) {
366         echo '<tr><td colspan="3" class="heading">';
367         echo get_string('incomingcontacts', 'message', $countstrangers);
368         echo '</td></tr>';
370         foreach ($strangers as $stranger) {
371             if ($minmessages==0 || $stranger->messagecount>=$minmessages) {
372                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
373             }
374         }
375     }
377     echo '</table>';
379     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
380         echo '<div class="note">(';
381         print_string('addsomecontactsincoming', 'message');
382         echo ')</div>';
383     }
385     echo '<br />';
387     if ($refresh) {
388         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
390         echo $OUTPUT->container_start('messagejsautorefresh note center');
391         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
392         echo $OUTPUT->container_end();
394         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
395         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
396         echo $OUTPUT->container_end();
397     }
400 function message_print_usergroup_selector($usergroup, &$courses, &$coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
401     $strblockedusers = null;
402     $options = array();
404     if ($countunreadtotal>0) { //if there are unread messages
405         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
406     }
408     $strcontacts = get_string('mycontacts', 'message');
409     $options[VIEW_CONTACTS] = $strcontacts;
411     if (!empty($courses)) {
412         $courses_options = array();
414         foreach($courses as $course) {
415             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
416                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
417             }
418         }
420         if (!empty($courses_options)) {
421             $options[] = array(get_string('courses')=>$courses_options);
422         }
423     }
425     if ($countblocked>0) {
426         $strblockedusers = get_string('blockedusers','message', $countblocked);
427         $options[VIEW_BLOCKED] = $strblockedusers;
428     }
430     echo html_writer::start_tag('form', array('id'=>'usergroupform','method'=>'get','action'=>''));
431         echo html_writer::start_tag('fieldset');
432             echo html_writer::select($options, 'usergroup', $usergroup, false, array('id'=>'usergroup','onchange'=>'this.form.submit()'));
433         echo html_writer::end_tag('fieldset');
434     echo html_writer::end_tag('form');
437 function message_get_course_contexts(&$courses) {
438     $coursecontexts = array();
440     foreach($courses as $course) {
441         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
442     }
444     return $coursecontexts;
447 /**
448  * strip off action parameters like 'removecontact'
449  */
450 function message_remove_url_params($moodleurl) {
451     $newurl = new moodle_url($moodleurl);
452     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
453     return $newurl->out();
457 /// $messagearray is an array of objects
458 /// $field is a valid property of object
459 /// $value is the value $field should equal to be counted
460 /// if $field is empty then return count of the whole array
461 /// if $field is non-existent then return 0;
462 function message_count_messages($messagearray, $field='', $value='') {
463     if (!is_array($messagearray)) return 0;
464     if ($field == '' or empty($messagearray)) return count($messagearray);
466     $count = 0;
467     foreach ($messagearray as $message) {
468         $count += ($message->$field == $value) ? 1 : 0;
469     }
470     return $count;
473 /**
474  * Returns the count of unread messages for user. Either from a specific user or from all users.
475  * @global <type> $USER
476  * @global <type> $DB
477  * @param object $user1 the first user. Defaults to $USER
478  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
479  * @return int the count of $user1's unread messages
480  */
481 function message_count_unread_messages($user1=null, $user2=null) {
482     global $USER, $DB;
484     if (empty($user1)) {
485         $user1 = $USER;
486     }
488     if (!empty($user2)) {
489         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
490             array($user1->id, $user2->id), "COUNT('id')");
491     } else {
492         return $DB->count_records_select('message', "useridto = ?",
493             array($user1->id), "COUNT('id')");
494     }
497 function message_count_blocked_users($user1=null) {
498     global $USER, $DB;
500     if (empty($user1)) {
501         $user1 = $USER;
502     }
504     $sql = "SELECT count(mc.id)
505             FROM {message_contacts} mc
506             WHERE mc.userid = :userid AND mc.blocked = 1";
507     $params = array('userid'=>$user1->id);
509     return $DB->count_records_sql($sql, $params);
512 /**
513  *
514  * @global <type> $USER
515  * @global <type> $PAGE
516  * @global <type> $OUTPUT
517  * @param  boolean advancedsearch show basic or advanced search form
518  * @return boolean was a search performed?
519  */
520 function message_print_search($advancedsearch = false, $user1=null) {
521     global $USER, $PAGE, $OUTPUT;
523     $frm = data_submitted();
525     $doingsearch = false;
526     if ($frm) {
527         $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
528     }
530     if (!empty($frm->combinedsearch)) {
531         $combinedsearchstring = $frm->combinedsearch;
532     } else {
533         //$combinedsearchstring = get_string('searchcombined','message').'...';
534         $combinedsearchstring = '';
535     }
537     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
539     if ($doingsearch) {
540         if ($advancedsearch) {
542             $messagesearch = '';
543             if (!empty($frm->keywords)) {
544                 $messagesearch = $frm->keywords;
545             }
546             $personsearch = '';
547             if (!empty($frm->name)) {
548                 $personsearch = $frm->name;
549             }
550             include('search_advanced.html');
551         } else {
552             include('search.html');
553         }
555         $showicontext = false;
556         message_print_search_results($frm, $showicontext, $user1);
558         return true;
559     } else {
560 /*
561 /// unfinished buggy code disabled in search.html anyway
562         // find all courses this use has readallmessages capabilities in
563         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
564             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
565             $cs = '<select name="courseselect">';
566             foreach ($teachers as $tcourse) {
567                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
568             }
569             $cs .= '</select>';
570         }
571 */
573         if ($advancedsearch) {
574             $personsearch = $messagesearch = '';
575             include('search_advanced.html');
576         } else {
577             include('search.html');
578         }
579         return false;
580     }
583 function message_print_settings() {
584     global $USER, $OUTPUT, $PAGE;
586     if ($frm = data_submitted() and confirm_sesskey()) {
588         $pref = array();
589         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
590         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
592         set_user_preferences($pref);
594         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
595     }
597     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
598     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
600     include('settings.html');
605 function message_add_contact($contactid, $blocked=0) {
606     global $USER, $DB;
608     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
609         return false;
610     }
612     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
613     /// record already exists - we may be changing blocking status
615         if ($contact->blocked !== $blocked) {
616         /// change to blocking status
617             $contact->blocked = $blocked;
618             return $DB->update_record('message_contacts', $contact);
619         } else {
620         /// no changes to blocking status
621             return true;
622         }
624     } else {
625     /// new contact record
626         unset($contact);
627         $contact->userid = $USER->id;
628         $contact->contactid = $contactid;
629         $contact->blocked = $blocked;
630         return $DB->insert_record('message_contacts', $contact, false);
631     }
634 function message_remove_contact($contactid) {
635     global $USER, $DB;
636     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
639 function message_unblock_contact($contactid) {
640     global $USER, $DB;
641     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
644 function message_block_contact($contactid) {
645     return message_add_contact($contactid, 1);
648 function message_get_contact($contactid) {
649     global $USER, $DB;
650     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
655 function message_print_search_results($frm, $showicontext=false, $user1=null) {
656     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
658     if (empty($user1)) {
659         $user1 = $USER;
660     }
662     echo '<div class="mdl-left">';
664     $personsearch = false;
665     $personsearchstring = null;
666     if (!empty($frm->personsubmit) and !empty($frm->name)) {
667         $personsearch = true;
668         $personsearchstring = $frm->name;
669     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
670         $personsearch = true;
671         $personsearchstring = $frm->combinedsearch;
672     }
674     /// search for person
675     if ($personsearch) {
676         if (optional_param('mycourses', 0, PARAM_BOOL)) {
677             $users = array();
678             $mycourses = enrol_get_my_courses();
679             foreach ($mycourses as $mycourse) {
680                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
681                     foreach ($susers as $suser) $users[$suser->id] = $suser;
682                 }
683             }
684         } else {
685             $users = message_search_users(SITEID, $personsearchstring);
686         }
688         if (!empty($users)) {
689             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
690             echo get_string('userssearchresults', 'message', count($users));
691             echo html_writer::end_tag('p');
693             echo '<table class="messagesearchresults">';
694             foreach ($users as $user) {
696                 if ( $user->contactlistid )  {
697                     if ($user->blocked == 0) { /// not blocked
698                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
699                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
700                     } else { // blocked
701                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
702                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
703                     }
704                 } else {
705                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
706                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
707                 }
709                 //should we show just the icon or icon and text?
710                 $histicontext = 'icon';
711                 if ($showicontext) {
712                     $histicontext = 'both';
713                 }
714                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
716                 echo '<tr><td class="pix">';
717                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
718                 echo '</td>';
719                 echo '<td class="contact">';
720                 $popupoptions = array(
721                         'height' => MESSAGE_DISCUSSION_HEIGHT,
722                         'width' => MESSAGE_DISCUSSION_WIDTH,
723                         'menubar' => false,
724                         'location' => false,
725                         'status' => true,
726                         'scrollbars' => true,
727                         'resizable' => true);
729                 $link = new moodle_url("/message/index.php?id=$user->id");
730                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
731                 $action = null;
732                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
734                 echo '</td>';
736                 echo '<td class="link">'.$strcontact.'</td>';
737                 echo '<td class="link">'.$strblock.'</td>';
738                 echo '<td class="link">'.$strhistory.'</td>';
739                 echo '</tr>';
740             }
741             echo '</table>';
743         } else {
744             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
745             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
746             echo html_writer::end_tag('p');
747         }
748     }
750     // search messages for keywords
751     $messagesearch = false;
752     $messagesearchstring = null;
753     if (!empty($frm->keywords)) {
754         $messagesearch = true;
755         $messagesearchstring = clean_text(trim($frm->keywords));
756     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
757         $messagesearch = true;
758         $messagesearchstring = clean_text(trim($frm->combinedsearch));
759     }
761     if ($messagesearch) {
762         if ($messagesearchstring) {
763             $keywords = explode(' ', $messagesearchstring);
764         } else {
765             $keywords = array();
766         }
767         $tome     = false;
768         $fromme   = false;
769         $courseid = 'none';
771         if (empty($frm->keywordsoption)) {
772             $frm->keywordsoption = 'allmine';
773         }
775         switch ($frm->keywordsoption) {
776             case 'tome':
777                 $tome   = true;
778                 break;
779             case 'fromme':
780                 $fromme = true;
781                 break;
782             case 'allmine':
783                 $tome   = true;
784                 $fromme = true;
785                 break;
786             case 'allusers':
787                 $courseid = SITEID;
788                 break;
789             case 'courseusers':
790                 $courseid = $frm->courseid;
791                 break;
792             default:
793                 $tome   = true;
794                 $fromme = true;
795         }
797         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
799         /// get a list of contacts
800             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
801                 $contacts = array();
802             }
804         /// print heading with number of results
805             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
806             $countresults = count($messages);
807             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
808                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
809             } else {
810                 echo get_string('keywordssearchresults', 'message', $countresults);
811             }
812             echo html_writer::end_tag('p');
814         /// print table headings
815             echo '<table class="messagesearchresults" cellspacing="0">';
817             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
818             $headertdend   = html_writer::end_tag('td');
819             echo '<tr>';
820             echo $headertdstart.get_string('from').$headertdend;
821             echo $headertdstart.get_string('to').$headertdend;
822             echo $headertdstart.get_string('message', 'message').$headertdend;
823             echo $headertdstart.get_string('timesent', 'message').$headertdend;
824             echo "</tr>\n";
826             $blockedcount = 0;
827             $dateformat = get_string('strftimedatetimeshort');
828             $strcontext = get_string('context', 'message');
829             foreach ($messages as $message) {
831             /// ignore messages to and from blocked users unless $frm->includeblocked is set
832                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
833                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
834                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
835                                                 )
836                    ) {
837                     $blockedcount ++;
838                     continue;
839                 }
841             /// load up user to record
842                 if ($message->useridto !== $USER->id) {
843                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
844                     $tocontact = (array_key_exists($message->useridto, $contacts) and
845                                     ($contacts[$message->useridto]->blocked == 0) );
846                     $toblocked = (array_key_exists($message->useridto, $contacts) and
847                                     ($contacts[$message->useridto]->blocked == 1) );
848                 } else {
849                     $userto = false;
850                     $tocontact = false;
851                     $toblocked = false;
852                 }
854             /// load up user from record
855                 if ($message->useridfrom !== $USER->id) {
856                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
857                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
858                                     ($contacts[$message->useridfrom]->blocked == 0) );
859                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
860                                     ($contacts[$message->useridfrom]->blocked == 1) );
861                 } else {
862                     $userfrom = false;
863                     $fromcontact = false;
864                     $fromblocked = false;
865                 }
867             /// find date string for this message
868                 $date = usergetdate($message->timecreated);
869                 $datestring = $date['year'].$date['mon'].$date['mday'];
871             /// print out message row
872                 echo '<tr valign="top">';
873                 echo '<td class="contact">';
874                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
875                 echo '</td>';
876                 echo '<td class="contact">';
877                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
878                 echo '</td>';
879                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
880                 echo '<br /><div class="link">';
882                 //find the user involved that isn't the current user
883                 $user2id = null;
884                 if ($user1->id == $message->useridto) {
885                     $user2id = $message->useridfrom;
886                 } else {
887                     $user2id = $message->useridto;
888                 }
889                 message_history_link($user1->id, $user2id, false,
890                                      $messagesearchstring, 'm'.$message->id, $strcontext);
891                 echo '</div>';
892                 echo '</td>';
893                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
894                 echo "</tr>\n";
895             }
898             if ($blockedcount > 0) {
899                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
900             }
901             echo '</table>';
903         } else {
904             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
905         }
906     }
908     if (!$personsearch && !$messagesearch) {
909         //they didn't enter any search terms
910         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
911     }
913     //echo '<br />';
914     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
916     echo '</div>';
920 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
921     global $USER, $OUTPUT;
923     if ($user === false) {
924         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
925     } else {
926         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
927         echo '&nbsp;';
929         $return = false;
930         $script = null;
931         if ($iscontact) {
932             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
933         } else {
934             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
935         }
936         echo '&nbsp;';
937         if ($isblocked) {
938             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
939         } else {
940             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
941         }
942         echo '<br />';
944         $popupoptions = array(
945                 'height' => MESSAGE_DISCUSSION_HEIGHT,
946                 'width' => MESSAGE_DISCUSSION_WIDTH,
947                 'menubar' => false,
948                 'location' => false,
949                 'status' => true,
950                 'scrollbars' => true,
951                 'resizable' => true);
953         $link = new moodle_url("/message/index.php?id=$user->id");
954         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
955         $action = null;
956         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
958     }
962 /// linktype can be: add, remove, block, unblock
963 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
964     global $USER, $CFG, $OUTPUT, $PAGE;
966     //hold onto the strings as we're probably creating a bunch of links
967     static $str;
969     if (empty($script)) {
970         //strip off previous action params like 'removecontact'
971         $script = message_remove_url_params($PAGE->url);
972     }
974     if (empty($str->blockcontact)) {
975        $str->blockcontact   =  get_string('blockcontact', 'message');
976        $str->unblockcontact =  get_string('unblockcontact', 'message');
977        $str->removecontact  =  get_string('removecontact', 'message');
978        $str->addcontact     =  get_string('addcontact', 'message');
979     }
981     $command = $linktype.'contact';
982     $string  = $str->{$command};
984     $safealttext = s($string);
986     $safestring = '';
987     if (!empty($text)) {
988         $safestring = $safealttext;
989     }
991     $img = '';
992     if ($icon) {
993         $iconpath = null;
994         switch ($linktype) {
995             case 'block':
996                 $iconpath = 't/block';
997                 break;
998             case 'unblock':
999                 $iconpath = 't/userblue';
1000                 break;
1001             case 'remove':
1002                 $iconpath = 'i/cross_red_big';
1003                 break;
1004             case 'add':
1005             default:
1006                 $iconpath = 't/addgreen';
1007         }
1009         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1010     }
1012     $output = '<span class="'.$linktype.'contact">'.
1013               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1014               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1015               $img.
1016               $safestring.'</a></span>';
1018     if ($return) {
1019         return $output;
1020     } else {
1021         echo $output;
1022         return true;
1023     }
1026 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1027     global $USER, $CFG, $OUTPUT;
1029     static $strmessagehistory;
1031     if (empty($strmessagehistory)) {
1032         $strmessagehistory = get_string('messagehistory', 'message');
1033     }
1035     if ($position) {
1036         $position = "#$position";
1037     }
1038     if ($keywords) {
1039         $keywords = "&search=".urlencode($keywords);
1040     }
1042     if ($linktext == 'icon') {  // Icon only
1043         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1044     } else if ($linktext == 'both') {  // Icon and standard name
1045         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1046         $fulllink .= '&nbsp;'.$strmessagehistory;
1047     } else if ($linktext) {    // Custom name
1048         $fulllink = $linktext;
1049     } else {                   // Standard name only
1050         $fulllink = $strmessagehistory;
1051     }
1053     $popupoptions = array(
1054             'height' => 500,
1055             'width' => 500,
1056             'menubar' => false,
1057             'location' => false,
1058             'status' => true,
1059             'scrollbars' => true,
1060             'resizable' => true);
1062     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1063     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1064     $action = null;
1065     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1067     $str = '<span class="history">'.$str.'</span>';
1069     if ($returnstr) {
1070         return $str;
1071     } else {
1072         echo $str;
1073         return true;
1074     }
1078 /**
1079  * Search through course users
1080  *
1081  * If $coursid specifies the site course then this function searches
1082  * through all undeleted and confirmed users
1083  *
1084  * @uses $CFG, $USER
1085  * @uses SITEID
1086  * @param int $courseid The course in question.
1087  * @param string $searchtext ?
1088  * @param string $sort ?
1089  * @param string $exceptions ?
1090  * @return array  An array of {@link $USER} records.
1091  * @todo Finish documenting this function
1092  */
1093 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1094     global $CFG, $USER, $DB;
1096     $fullname = $DB->sql_fullname();
1098     if (!empty($exceptions)) {
1099         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1100     } else {
1101         $except = '';
1102     }
1104     if (!empty($sort)) {
1105         $order = ' ORDER BY '. $sort;
1106     } else {
1107         $order = '';
1108     }
1110     $ufields = user_picture::fields('u');
1111     if (!$courseid or $courseid == SITEID) {
1112         $params = array($USER->id, "%$searchtext%");
1113         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1114                                        FROM {user} u
1115                                        LEFT JOIN {message_contacts} mc
1116                                             ON mc.contactid = u.id AND mc.userid = ?
1117                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1118                                             AND (".$DB->sql_like($fullname, '?', false).")
1119                                             $except
1120                                      $order", $params);
1121     } else {
1122 //TODO: add enabled enrolment join here (skodak)
1123         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1124         $contextlists = get_related_contexts_string($context);
1126         // everyone who has a role assignment in this course or higher
1127         $params = array($USER->id, "%$searchtext%");
1128         $users = $DB->get_records_sql("SELECT $ufields,
1129                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1130                                          JOIN {role_assignments} ra ON ra.userid = u.id
1131                                          LEFT JOIN {message_contacts} mc
1132                                               ON mc.contactid = u.id AND mc.userid = ?
1133                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1134                                               AND ra.contextid $contextlists
1135                                               AND (".$DB->sql_like($fullname, '?', false).")
1136                                               $except
1137                                        $order", $params);
1139         return $users;
1140     }
1146 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1147 /// Returns a list of posts found using an array of search terms
1148 /// eg   word  +word -word
1149 ///
1150     global $CFG, $USER, $DB;
1152     /// If no userid sent then assume current user
1153     if ($userid == 0) $userid = $USER->id;
1155     /// Some differences in SQL syntax
1156     if ($DB->sql_regex_supported()) {
1157         $REGEXP    = $DB->sql_regex(true);
1158         $NOTREGEXP = $DB->sql_regex(false);
1159     }
1161     $searchcond = array();
1162     $params = array();
1163     $i = 0;
1165     //preprocess search terms to check whether we have at least 1 eligible search term
1166     //if we do we can drop words around it like 'a'
1167     $dropshortwords = false;
1168     foreach ($searchterms as $searchterm) {
1169         if (strlen($searchterm) >= 2) {
1170             $dropshortwords = true;
1171         }
1172     }
1174     foreach ($searchterms as $searchterm) {
1175         $i++;
1177         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1179         if ($dropshortwords && strlen($searchterm) < 2) {
1180             continue;
1181         }
1182     /// Under Oracle and MSSQL, trim the + and - operators and perform
1183     /// simpler LIKE search
1184         if (!$DB->sql_regex_supported()) {
1185             if (substr($searchterm, 0, 1) == '-') {
1186                 $NOT = true;
1187             }
1188             $searchterm = trim($searchterm, '+-');
1189         }
1191         if (substr($searchterm,0,1) == "+") {
1192             $searchterm = substr($searchterm,1);
1193             $searchterm = preg_quote($searchterm, '|');
1194             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1195             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1197         } else if (substr($searchterm,0,1) == "-") {
1198             $searchterm = substr($searchterm,1);
1199             $searchterm = preg_quote($searchterm, '|');
1200             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1201             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1203         } else {
1204             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1205             $params['ss'.$i] = "%$searchterm%";
1206         }
1207     }
1209     if (empty($searchcond)) {
1210         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1211         $params['ss1'] = "%";
1212     } else {
1213         $searchcond = implode(" AND ", $searchcond);
1214     }
1216     /// There are several possibilities
1217     /// 1. courseid = SITEID : The admin is searching messages by all users
1218     /// 2. courseid = ??     : A teacher is searching messages by users in
1219     ///                        one of their courses - currently disabled
1220     /// 3. courseid = none   : User is searching their own messages;
1221     ///    a.  Messages from user
1222     ///    b.  Messages to user
1223     ///    c.  Messages to and from user
1225     if ($courseid == SITEID) { /// admin is searching all messages
1226         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1227                                             FROM {message_read} m
1228                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1229         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1230                                             FROM {message} m
1231                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1233     } else if ($courseid !== 'none') {
1234         /// This has not been implemented due to security concerns
1235         $m_read   = array();
1236         $m_unread = array();
1238     } else {
1240         if ($fromme and $tome) {
1241             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1242             $params['userid1'] = $userid;
1243             $params['userid2'] = $userid;
1245         } else if ($fromme) {
1246             $searchcond .= " AND m.useridfrom=:userid";
1247             $params['userid'] = $userid;
1249         } else if ($tome) {
1250             $searchcond .= " AND m.useridto=:userid";
1251             $params['userid'] = $userid;
1252         }
1254         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1255                                             FROM {message_read} m
1256                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1257         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1258                                             FROM {message} m
1259                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1261     }
1263     /// The keys may be duplicated in $m_read and $m_unread so we can't
1264     /// do a simple concatenation
1265     $message = array();
1266     foreach ($m_read as $m) {
1267         $messages[] = $m;
1268     }
1269     foreach ($m_unread as $m) {
1270         $messages[] = $m;
1271     }
1273     return (empty($messages)) ? false : $messages;
1278 /// Borrowed with changes from mod/forum/lib.php
1279 function message_shorten_message($message, $minlength=0) {
1280 // Given a post object that we already know has a long message
1281 // this function truncates the message nicely to the first
1282 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1284     $i = 0;
1285     $tag = false;
1286     $length = strlen($message);
1287     $count = 0;
1288     $stopzone = false;
1289     $truncate = 0;
1290     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1293     for ($i=0; $i<$length; $i++) {
1294         $char = $message[$i];
1296         switch ($char) {
1297             case "<":
1298                 $tag = true;
1299                 break;
1300             case ">":
1301                 $tag = false;
1302                 break;
1303             default:
1304                 if (!$tag) {
1305                     if ($stopzone) {
1306                         if ($char == '.' or $char == ' ') {
1307                             $truncate = $i+1;
1308                             break 2;
1309                         }
1310                     }
1311                     $count++;
1312                 }
1313                 break;
1314         }
1315         if (!$stopzone) {
1316             if ($count > $minlength) {
1317                 $stopzone = true;
1318             }
1319         }
1320     }
1322     if (!$truncate) {
1323         $truncate = $i;
1324     }
1326     return substr($message, 0, $truncate);
1330 /**
1331  * Given a string and an array of keywords, this function looks
1332  * for the first keyword in the string, and then chops out a
1333  * small section from the text that shows that word in context.
1334  */
1335 function message_get_fragment($message, $keywords) {
1337     $fullsize = 160;
1338     $halfsize = (int)($fullsize/2);
1340     $message = strip_tags($message);
1342     foreach ($keywords as $keyword) {  // Just get the first one
1343         if ($keyword !== '') {
1344             break;
1345         }
1346     }
1347     if (empty($keyword)) {   // None found, so just return start of message
1348         return message_shorten_message($message, 30);
1349     }
1351     $leadin = $leadout = '';
1353 /// Find the start of the fragment
1354     $start = 0;
1355     $length = strlen($message);
1357     $pos = strpos($message, $keyword);
1358     if ($pos > $halfsize) {
1359         $start = $pos - $halfsize;
1360         $leadin = '...';
1361     }
1362 /// Find the end of the fragment
1363     $end = $start + $fullsize;
1364     if ($end > $length) {
1365         $end = $length;
1366     } else {
1367         $leadout = '...';
1368     }
1370 /// Pull out the fragment and format it
1372     $fragment = substr($message, $start, $end - $start);
1373     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1374     return $fragment;
1377 //retrieve the messages between two users
1378 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1379     global $DB, $CFG;
1381     $messages = array();
1383     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1384     //desc to get the last $limitnum messages then flip the order in php
1385     $sort = 'asc';
1386     if ($limitnum>0) {
1387         $sort = 'desc';
1388     }
1390     $notificationswhere = null;
1391     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1392     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1393         $notificationswhere = 'AND notification=0';
1394     }
1396     //prevent notifications of your own actions appearing in your own message history
1397     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1399     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1400                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1401                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1402                                                     "timecreated $sort", '*', 0, $limitnum)) {
1403         foreach ($messages_read as $message) {
1404             $messages[$message->timecreated] = $message;
1405         }
1406     }
1407     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1408                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1409                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1410                                                     "timecreated $sort", '*', 0, $limitnum)) {
1411         foreach ($messages_new as $message) {
1412             $messages[$message->timecreated] = $message;
1413         }
1414     }
1416     //if we only want the last $limitnum messages
1417     if ($limitnum>0) {
1418         ksort($messages);
1419         $messages = array_slice($messages, count($messages)-$limitnum, $limitnum, true);
1420     }
1422     return $messages;
1425 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1426     global $CFG, $OUTPUT;
1428     echo $OUTPUT->box_start('center');
1429     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1430     echo '<td align="center" id="user1">';
1431     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1432     echo '<div class="heading">'.fullname($user1).'</div>';
1433     echo '</td>';
1434     echo '<td align="center">';
1435     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1436     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1437     echo '</td>';
1438     echo '<td align="center" id="user2">';
1439     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1440     echo '<div class="heading">'.fullname($user2).'</div>';
1442     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1443         $incontactlist = $user2->iscontact;
1444         $isblocked = $user2->isblocked;
1446         $script = null;
1447         $text = true;
1448         $icon = false;
1450         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1451         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1452         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1454         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1455     }
1457     echo '</td>';
1458     echo '</tr></table>';
1459     echo $OUTPUT->box_end();
1461     if (!empty($messagehistorylink)) {
1462         echo $messagehistorylink;
1463     }
1465     /// Get all the messages and print them
1466     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1467         $tablecontents = '';
1469         $current = new stdClass();
1470         $current->mday = '';
1471         $current->month = '';
1472         $current->year = '';
1473         $messagedate = get_string('strftimetime');
1474         $blockdate   = get_string('strftimedaydate');
1475         foreach ($messages as $message) {
1476             if ($message->notification) {
1477                 $notificationclass = ' notification';
1478             } else {
1479                 $notificationclass = null;
1480             }
1481             $date = usergetdate($message->timecreated);
1482             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1483                 $current->mday = $date['mday'];
1484                 $current->month = $date['month'];
1485                 $current->year = $date['year'];
1487                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1488                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1489             }
1490             if ($message->useridfrom == $user1->id) {
1491                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1492             } else {
1493                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1494             }
1495         }
1497         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1498     } else {
1499         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1500     }
1503 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1505     static $dateformat;
1507     if (empty($dateformat)) {
1508         if ($format) {
1509             $dateformat = $format;
1510         } else {
1511             $format = get_string('strftimedatetimeshort');
1512         }
1513     }
1514     $time = userdate($message->timecreated, $dateformat);
1515     $options = new stdClass();
1516     $options->para = false;
1518     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1519     if (!empty($message->smallmessage)) {
1520         $messagetext = format_text($message->smallmessage, null, $options);
1521     } else {
1522         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1523     }
1525     if (!empty($message->contexturl)) {
1526         $displaytext = null;
1527         if (!empty($message->contexturlname)) {
1528             $displaytext= $message->contexturlname;
1529         } else {
1530             $displaytext= $message->contexturl;
1531         }
1532         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1533             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1534         $messagetext .= html_writer::end_tag('div');
1535     }
1537     if ($keywords) {
1538         $messagetext = highlight($keywords, $messagetext);
1539     }
1541     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1544 /**
1545  * Inserts a message into the database, but also forwards it
1546  * via other means if appropriate.
1547  */
1548 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1549     global $SITE, $CFG, $USER;
1551     $eventdata = new stdClass();
1552     $eventdata->component        = 'moodle';
1553     $eventdata->name             = 'instantmessage';
1554     $eventdata->userfrom         = $userfrom;
1555     $eventdata->userto           = $userto;
1557     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1558     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1560     $eventdata->fullmessage      = $message;
1561     $eventdata->fullmessageformat = $format;
1562     $eventdata->fullmessagehtml  = '';
1563     $eventdata->smallmessage     = $message;
1565     $s = new stdClass();
1566     $s->sitename = $SITE->shortname;
1567     $s->url = $CFG->wwwroot.'/message/index.php?id='.$userfrom->id;//.'&user='.$userto->id;
1569     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1570     if (!empty($eventdata->fullmessage)) {
1571         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1572     }
1573     if (!empty($eventdata->fullmessagehtml)) {
1574         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1575     }
1576     
1577     $eventdata->timecreated     = time();
1578     return message_send($eventdata);
1582 /**
1583  * Returns a list of all user ids who have used messaging in the site
1584  * This was the simple way to code the SQL ... is it going to blow up
1585  * on large datasets?
1586  */
1587 function message_get_participants() {
1588     global $CFG, $DB;
1590         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1591                                UNION SELECT useridto as id,1 FROM {message}
1592                                UNION SELECT useridfrom as id,1 FROM {message_read}
1593                                UNION SELECT useridto as id,1 FROM {message_read}
1594                                UNION SELECT userid as id,1 FROM {message_contacts}
1595                                UNION SELECT contactid as id,1 from {message_contacts}");
1598 /**
1599  * Print a row of contactlist displaying user picture, messages waiting and
1600  * block links etc
1601  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1602  * @param $incontactlist is the user a contact of ours?
1603  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1604  */
1605 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1606     global $OUTPUT, $USER;
1607     $fullname  = fullname($contact);
1608     $fullnamelink  = $fullname;
1610     $linkclass = '';
1611     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1612         $linkclass = 'messageselecteduser';
1613     }
1615     /// are there any unread messages for this contact?
1616     if ($contact->messagecount > 0 ){
1617         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1618     }
1620     $strcontact = $strblock = $strhistory = null;
1622     if ($showactionlinks) {
1623         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1624         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1625         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1626     }
1628     echo '<tr><td class="pix">';
1629     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1630     echo '</td>';
1631     echo '<td class="contact">';
1633     $popupoptions = array(
1634             'height' => MESSAGE_DISCUSSION_HEIGHT,
1635             'width' => MESSAGE_DISCUSSION_WIDTH,
1636             'menubar' => false,
1637             'location' => false,
1638             'status' => true,
1639             'scrollbars' => true,
1640             'resizable' => true);
1642     $link = $action = null;
1643     if (!empty($selectcontacturl)) {
1644         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1645     } else {
1646         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1647         $link = new moodle_url("/message/index.php?id=$contact->id");
1648         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1649     }
1650     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1652     echo '</td>';
1653     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1654     echo '</tr>';
1657 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1658     $strcontact = '';
1660     if($incontactlist){
1661         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1662     } else if ($isblocked) {
1663         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1664     } else{
1665         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1666     }
1668     return $strcontact;
1671 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1672     $strblock   = '';
1674     //commented out to allow the user to block a contact without having to remove them first
1675     /*if ($incontactlist) {
1676         //$strblock = '';
1677     } else*/
1678     if ($isblocked) {
1679         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1680     } else{
1681         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1682     }
1684     return $strblock;
1687  /**
1688   * Moves unread messages from message table to message_read for a given from user
1689   * @param object $userid       User id
1690   * @return boolean success
1691   */
1692 function message_move_userfrom_unread2read($userid) {
1694     global $DB;
1696     // move all unread messages from message table to message_read
1697     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1698         foreach ($messages as $message) {
1699             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1700         }
1701     }
1702     return true;
1705 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1706     global $DB;
1708     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1710     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1712     //for every message to process check if it's for current user and process
1713     $messages = array();
1714     foreach ($messagesproc as $msgp){
1715         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1716         if ($fromuserid){
1717             $query['useridfrom'] = $fromuserid;
1718         }
1719         if ($message = $DB->get_record('message', $query)){
1720             $messages[] = $message;
1721             /// Move the entry to the other table
1722             $message->timeread = time();
1723             $messageid = $message->id;
1724             unset($message->id);
1726             //delete what we've processed and check if can move message
1727             $DB->delete_records('message_working', array('id' => $msgp->id));
1728             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1729                 message_mark_message_read($message, time(), true);
1730             }
1731         }
1732     }
1733     return $messages;
1736 /**
1737 * marks ALL messages being sent from $fromuserid to $touserid as read
1738 * @param int $touserid the id of the message recipient
1739 * @param int $fromuserid the id of the message sender
1740 * @return void
1741 */
1742 function message_mark_messages_read($touserid, $fromuserid){
1743     global $DB;
1745     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1746     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1748     foreach ($messages as $message) {
1749         message_mark_message_read($message, time());
1750     }
1753 /**
1754 * Mark a single message as read
1755 * @param message an object with an object property ie $message->id which is an id in the message table
1756 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1757 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1758 * @return void
1759 */
1760 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1761     global $DB;
1762     
1763     $message->timeread = $timeread;
1765     $messageid = $message->id;
1766     unset($message->id);//unset because it will get a new id on insert into message_read
1768     //If any processors have pending actions abort them
1769     if (!$messageworkingempty) {
1770         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1771     }
1772     $DB->insert_record('message_read', $message);
1773     $DB->delete_records('message', array('id' => $messageid));