bbb4a934942a39817a601b1abb682eff9bbf93f2
[moodle.git] / message / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library functions for messaging
20  *
21  * @copyright Luis Rodrigues
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  * @package message
24  */
26 require_once($CFG->libdir.'/eventslib.php');
29 define ('MESSAGE_SHORTLENGTH', 300);
31 //$PAGE isnt set if we're being loaded by cron which doesnt display popups anyway
32 if (isset($PAGE)) {
33     $PAGE->set_popup_notification_allowed(false); // We are in a message window (so don't pop up a new one)
34 }
36 define ('MESSAGE_DISCUSSION_WIDTH',600);
37 define ('MESSAGE_DISCUSSION_HEIGHT',500);
39 define ('MESSAGE_SHORTVIEW_LIMIT', 8);//the maximum number of messages to show on the short message history
41 define ('CONTACT_ID','id');
43 define('MESSAGE_HISTORY_SHORT',0);
44 define('MESSAGE_HISTORY_ALL',1);
46 //some constants used as function arguments. Just to make function calls a bit more understandable
47 define('IS_CONTACT',true);
48 define('IS_NOT_CONTACT',false);
50 define('IS_BLOCKED',true);
51 define('IS_NOT_BLOCKED',false);
53 define('VIEW_UNREAD_MESSAGES','unread');
54 define('VIEW_CONTACTS','contacts');
55 define('VIEW_BLOCKED','blockedusers');
56 define('VIEW_COURSE','course_');
57 define('VIEW_SEARCH','search');
59 define('SHOW_ACTION_LINKS_IN_CONTACT_LIST', true);
61 define('MESSAGE_SEARCH_MAX_RESULTS', 200);
63 define('MESSAGE_CONTACTS_PER_PAGE',10);
65 if (!isset($CFG->message_contacts_refresh)) {  // Refresh the contacts list every 60 seconds
66     $CFG->message_contacts_refresh = 60;
67 }
68 if (!isset($CFG->message_chat_refresh)) {      // Look for new comments every 5 seconds
69     $CFG->message_chat_refresh = 5;
70 }
71 if (!isset($CFG->message_offline_time)) {
72     $CFG->message_offline_time = 300;
73 }
75 function message_print_contact_selector($countunreadtotal, $usergroup, $user1, $user2, $blockedusers, $onlinecontacts, $offlinecontacts, $strangers, $showcontactactionlinks, $page=0) {
76     global $PAGE;
78     echo html_writer::start_tag('div', array('class'=>'contactselector mdl-align'));
80         //if 0 unread messages and they've requested unread messages then show contacts
81         if ($countunreadtotal==0 && $usergroup==VIEW_UNREAD_MESSAGES) {
82             $usergroup = VIEW_CONTACTS;
83         }
85         //if they have no blocked users and they've requested blocked users switch them over to contacts
86         if (count($blockedusers)==0 && $usergroup==VIEW_BLOCKED) {
87             $usergroup = VIEW_CONTACTS;
88         }
90         $onlyactivecourses = true;
91         $courses = enrol_get_users_courses($user1->id, $onlyactivecourses);
92         $coursecontexts = message_get_course_contexts($courses);//we need one of these again so holding on to them
94         $strunreadmessages = null;
95         if ($countunreadtotal>0) { //if there are unread messages
96             $strunreadmessages = get_string('unreadmessages','message', $countunreadtotal);
97         }
99         message_print_usergroup_selector($usergroup, $courses, $coursecontexts, $countunreadtotal, count($blockedusers), $strunreadmessages);
101         $refreshpage = false;
103         if ($usergroup==VIEW_UNREAD_MESSAGES) {
104             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 1, $showcontactactionlinks,$strunreadmessages, $user2);
105         } else if ($usergroup==VIEW_CONTACTS || $usergroup==VIEW_SEARCH) {
106             message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refreshpage, $PAGE->url, 0, $showcontactactionlinks, $strunreadmessages, $user2);
107         } else if ($usergroup==VIEW_BLOCKED) {
108             message_print_blocked_users($blockedusers, $PAGE->url, $showcontactactionlinks, null, $user2);
109         } else if (substr($usergroup, 0, 7)==VIEW_COURSE) {
110             $courseidtoshow = intval(substr($usergroup, 7));
112             if (!empty($courseidtoshow)
113                 && array_key_exists($courseidtoshow, $coursecontexts)
114                 && has_capability('moodle/course:viewparticipants', $coursecontexts[$courseidtoshow])) {
116                 message_print_participants($coursecontexts[$courseidtoshow], $courseidtoshow, $PAGE->url, $showcontactactionlinks, null, $page, $user2);
117             } else {
118                 //shouldn't get here. User trying to access a course they're not in perhaps.
119                 add_to_log(SITEID, 'message', 'view', 'index.php', $usergroup);
120             }
121         }
123         echo html_writer::start_tag('form', array('action'=>'index.php','method'=>'GET'));
124             echo html_writer::start_tag('fieldset');
125                 $managebuttonclass = 'visible';
126                 if ($usergroup==VIEW_SEARCH) {
127                     $managebuttonclass = 'hiddenelement';
128                 }
129                 $strmanagecontacts = get_string('search','message');
130                 echo html_writer::empty_tag('input', array('type'=>'hidden','name'=>'usergroup','value'=>VIEW_SEARCH));
131                 echo html_writer::empty_tag('input', array('type'=>'submit','value'=>$strmanagecontacts,'class'=>$managebuttonclass));
132             echo html_writer::end_tag('fieldset');
133         echo html_writer::end_tag('form');
135     echo html_writer::end_tag('div');
138 function message_print_participants($context, $courseid, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $page=0, $user2=null) {
139     global $DB, $USER, $PAGE, $OUTPUT;
141     $countparticipants = count_enrolled_users($context);
142     $participants = get_enrolled_users($context, '', 0, 'u.*', '', $page*MESSAGE_CONTACTS_PER_PAGE, MESSAGE_CONTACTS_PER_PAGE);
144     $pagingbar = new paging_bar($countparticipants, $page, MESSAGE_CONTACTS_PER_PAGE, $PAGE->url, 'page');
145     echo $OUTPUT->render($pagingbar);
147     echo '<table id="message_participants" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
149     if (!empty($titletodisplay)) {
150         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
151     }
153     if (empty($titletodisplay)) {
154         echo '<tr><td colspan="3" class="heading">';
155         echo get_string('participants');
156         echo '</td></tr>';
157     }
159     //todo these need to come from somewhere if the course participants list is to show users with unread messages
160     $iscontact = true;
161     $isblocked = false;
162     foreach ($participants as $participant) {
163         if ($participant->id != $USER->id) {
164             $participant->messagecount = 0;//todo it would be nice if the course participant could report new messages
165             message_print_contactlist_user($participant, $iscontact, $isblocked, $contactselecturl, $showactionlinks, $user2);
166         }
167     }
168     //$participants->close();
170     echo '</table>';
173 function message_get_blocked_users($user1=null, &$user2=null) {
174     global $DB, $USER;
176     if (empty($user1)) {
177         $user1 = $USER;
178     }
180     if (!empty($user2)) {
181         $user2->isblocked = false;
182     }
184     $userfields = user_picture::fields('u', array('lastaccess'));
185     $blockeduserssql = "SELECT $userfields, COUNT(m.id) AS messagecount
186                           FROM {message_contacts} mc
187                           JOIN {user} u ON u.id = mc.contactid
188                           LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = :user1id1
189                          WHERE mc.userid = :user1id2 AND mc.blocked = 1
190                       GROUP BY $userfields
191                       ORDER BY u.firstname ASC";
192     $rs =  $DB->get_recordset_sql($blockeduserssql, array('user1id1'=>$user1->id, 'user1id2'=>$user1->id));
194     $blockedusers = array();
195     if (!empty($rs)) {
196         foreach($rs as $rd) {
197             $blockedusers[] = $rd;
199             if (!empty($user2) && $user2->id==$rd->id) {
200                 $user2->isblocked = true;
201             }
202         }
203         unset($rd);
204         $rs->close();
205     }
207     return $blockedusers;
210 function message_print_blocked_users(&$blockedusers, $contactselecturl=null, $showactionlinks=true, $titletodisplay=null, $user2=null) {
211     global $DB, $USER;
213     $countblocked = count($blockedusers);
215     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
217     if (!empty($titletodisplay)) {
218         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
219     }
221     if ($countblocked) {
222         echo '<tr><td colspan="3" class="heading">';
223         echo get_string('blockedusers', 'message', $countblocked);
224         echo '</td></tr>';
226         foreach ($blockedusers as $blockeduser) {
227             message_print_contactlist_user($blockeduser, IS_NOT_CONTACT, IS_BLOCKED, $contactselecturl, $showactionlinks, $user2);
228         }
229     }
231     echo '</table>';
234 function message_get_contacts($user1=null, &$user2=null) {
235     global $DB, $CFG, $USER;
237     if (empty($user1)) {
238         $user1 = $USER;
239     }
241     if (!empty($user2)) {
242         $user2->iscontact = false;
243     }
245     $timetoshowusers = 300; //Seconds default
246     if (isset($CFG->block_online_users_timetosee)) {
247         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
248     }
250     // time which a user is counting as being active since
251     $timefrom = time()-$timetoshowusers;
253     // people in our contactlist who are online
254     $onlinecontacts  = array();
255     // people in our contactlist who are offline
256     $offlinecontacts = array();
257     // people who are not in our contactlist but have sent us a message
258     $strangers       = array();
260     $userfields = user_picture::fields('u', array('lastaccess'));
262     // get all in our contactlist who are not blocked in our contact list
263     // and count messages we have waiting from each of them
264     $contactsql = "SELECT $userfields, COUNT(m.id) AS messagecount
265                      FROM {message_contacts} mc
266                      JOIN {user} u ON u.id = mc.contactid
267                      LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
268                     WHERE mc.userid = ? AND mc.blocked = 0
269                  GROUP BY $userfields
270                  ORDER BY u.firstname ASC";
272     $rs = $DB->get_recordset_sql($contactsql, array($user1->id, $user1->id));
273     foreach ($rs as $rd) {
274         if ($rd->lastaccess >= $timefrom) {
275             // they have been active recently, so are counted online
276             $onlinecontacts[] = $rd;
278         } else {
279             $offlinecontacts[] = $rd;
280         }
282         if (!empty($user2) && $user2->id==$rd->id) {
283             $user2->iscontact = true;
284         }
285     }
286     $rs->close();
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     $rs = $DB->get_recordset_sql($strangersql, array($USER->id));
299     foreach ($rs as $rd) {
300         $strangers[] = $rd;
301     }
302     $rs->close();
304     return array($onlinecontacts, $offlinecontacts, $strangers);
307 function message_print_contacts($onlinecontacts, $offlinecontacts, $strangers, $refresh=true, $contactselecturl=null, $minmessages=0, $showactionlinks=true, $titletodisplay=null, $user2=null) {
308     global $CFG, $PAGE, $OUTPUT;
310     $countonlinecontacts  = count($onlinecontacts);
311     $countofflinecontacts = count($offlinecontacts);
312     $countstrangers       = count($strangers);
314     if ($countonlinecontacts + $countofflinecontacts == 0) {
315         echo '<div class="heading">';
316         print_string('contactlistempty', 'message');
317         echo '</div>';
318         //echo '<div class="note">';
319         //print_string('addsomecontacts', 'message', message_remove_url_params($PAGE->url).'?tab=search');
320         //echo '</div>';
321     }
323     echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
325     if (!empty($titletodisplay)) {
326         echo "<tr><td colspan='3' class='heading'>$titletodisplay</td></tr>";
327     }
329     if($countonlinecontacts) {
330         /// print out list of online contacts
332         if (empty($titletodisplay)) {
333             echo '<tr><td colspan="3" class="heading">';
334             echo get_string('onlinecontacts', 'message', $countonlinecontacts);
335             echo '</td></tr>';
336         }
338         foreach ($onlinecontacts as $contact) {
339             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
340                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
341             }
342         }
343     }
345     if ($countofflinecontacts) {
346         /// print out list of offline contacts
348         if (empty($titletodisplay)) {
349             echo '<tr><td colspan="3" class="heading">';
350             echo get_string('offlinecontacts', 'message', $countofflinecontacts);
351             echo '</td></tr>';
352         }
354         foreach ($offlinecontacts as $contact) {
355             if ($minmessages==0 || $contact->messagecount>=$minmessages) {
356                 message_print_contactlist_user($contact, IS_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
357             }
358         }
359         echo '<tr><td colspan="3">&nbsp;</td></tr>';
360     }
362     /// print out list of incoming contacts
363     if ($countstrangers) {
364         echo '<tr><td colspan="3" class="heading">';
365         echo get_string('incomingcontacts', 'message', $countstrangers);
366         echo '</td></tr>';
368         foreach ($strangers as $stranger) {
369             if ($minmessages==0 || $stranger->messagecount>=$minmessages) {
370                 message_print_contactlist_user($stranger, IS_NOT_CONTACT, IS_NOT_BLOCKED, $contactselecturl, $showactionlinks, $user2);
371             }
372         }
373     }
375     echo '</table>';
377     if ($countstrangers && ($countonlinecontacts + $countofflinecontacts == 0)) {  // Extra help
378         echo '<div class="note">(';
379         print_string('addsomecontactsincoming', 'message');
380         echo ')</div>';
381     }
383     echo '<br />';
385     if ($refresh) {
386         $PAGE->requires->js_init_call('M.core_message.init_refresh_page', array(60*1000, $PAGE->url->out(false)));
388         echo $OUTPUT->container_start('messagejsautorefresh note center');
389         echo get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh);
390         echo $OUTPUT->container_end();
392         echo $OUTPUT->container_start('messagejsmanualrefresh aligncenter');
393         echo $OUTPUT->single_button(message_remove_url_params($PAGE->url), get_string('refresh'));
394         echo $OUTPUT->container_end();
395     }
398 function message_print_usergroup_selector($usergroup, &$courses, &$coursecontexts, $countunreadtotal, $countblocked, $strunreadmessages) {
399     $strblockedusers = null;
400     $options = array();
402     if ($countunreadtotal>0) { //if there are unread messages
403         $options[VIEW_UNREAD_MESSAGES] = $strunreadmessages;
404     }
406     $strcontacts = get_string('mycontacts', 'message');
407     $options[VIEW_CONTACTS] = $strcontacts;
409     if (!empty($courses)) {
410         $courses_options = array();
412         foreach($courses as $course) {
413             if (has_capability('moodle/course:viewparticipants', $coursecontexts[$course->id])) {
414                 $courses_options[VIEW_COURSE.$course->id] = $course->shortname;
415             }
416         }
418         if (!empty($courses_options)) {
419             $options[] = array(get_string('courses')=>$courses_options);
420         }
421     }
423     if ($countblocked>0) {
424         $strblockedusers = get_string('blockedusers','message', $countblocked);
425         $options[VIEW_BLOCKED] = $strblockedusers;
426     }
428     echo html_writer::start_tag('form', array('id'=>'usergroupform','method'=>'get','action'=>''));
429         echo html_writer::start_tag('fieldset');
430             echo html_writer::select($options, 'usergroup', $usergroup, false, array('id'=>'usergroup','onchange'=>'this.form.submit()'));
431         echo html_writer::end_tag('fieldset');
432     echo html_writer::end_tag('form');
435 function message_get_course_contexts(&$courses) {
436     $coursecontexts = array();
438     foreach($courses as $course) {
439         $coursecontexts[$course->id] = get_context_instance(CONTEXT_COURSE, $course->id);
440     }
442     return $coursecontexts;
445 /**
446  * strip off action parameters like 'removecontact'
447  */
448 function message_remove_url_params($moodleurl) {
449     $newurl = new moodle_url($moodleurl);
450     $newurl->remove_params('addcontact','removecontact','blockcontact','unblockcontact');
451     return $newurl->out();
455 /// $messagearray is an array of objects
456 /// $field is a valid property of object
457 /// $value is the value $field should equal to be counted
458 /// if $field is empty then return count of the whole array
459 /// if $field is non-existent then return 0;
460 function message_count_messages($messagearray, $field='', $value='') {
461     if (!is_array($messagearray)) return 0;
462     if ($field == '' or empty($messagearray)) return count($messagearray);
464     $count = 0;
465     foreach ($messagearray as $message) {
466         $count += ($message->$field == $value) ? 1 : 0;
467     }
468     return $count;
471 /**
472  * Returns the count of unread messages for user. Either from a specific user or from all users.
473  * @global <type> $USER
474  * @global <type> $DB
475  * @param object $user1 the first user. Defaults to $USER
476  * @param object $user2 the second user. If null this function will count all of user 1's unread messages.
477  * @return int the count of $user1's unread messages
478  */
479 function message_count_unread_messages($user1=null, $user2=null) {
480     global $USER, $DB;
482     if (empty($user1)) {
483         $user1 = $USER;
484     }
486     if (!empty($user2)) {
487         return $DB->count_records_select('message', "useridto = ? AND useridfrom = ?",
488             array($user1->id, $user2->id), "COUNT('id')");
489     } else {
490         return $DB->count_records_select('message', "useridto = ?",
491             array($user1->id), "COUNT('id')");
492     }
495 function message_count_blocked_users($user1=null) {
496     global $USER, $DB;
498     if (empty($user1)) {
499         $user1 = $USER;
500     }
502     $sql = "SELECT count(mc.id)
503             FROM {message_contacts} mc
504             WHERE mc.userid = :userid AND mc.blocked = 1";
505     $params = array('userid'=>$user1->id);
507     return $DB->count_records_sql($sql, $params);
510 /**
511  *
512  * @global <type> $USER
513  * @global <type> $PAGE
514  * @global <type> $OUTPUT
515  * @param  boolean advancedsearch show basic or advanced search form
516  * @return boolean was a search performed?
517  */
518 function message_print_search($advancedsearch = false, $user1=null) {
519     global $USER, $PAGE, $OUTPUT;
521     $frm = data_submitted();
523     $doingsearch = false;
524     if ($frm) {
525         if (confirm_sesskey()) {
526             $doingsearch = !empty($frm->combinedsubmit) || !empty($frm->keywords) || (!empty($frm->personsubmit) and !empty($frm->name));
527         } else {
528             $frm = false;
529         }
530     }
532     if (!empty($frm->combinedsearch)) {
533         $combinedsearchstring = $frm->combinedsearch;
534     } else {
535         //$combinedsearchstring = get_string('searchcombined','message').'...';
536         $combinedsearchstring = '';
537     }
539     //$PAGE->requires->js_init_call('M.core_message.init_search_page', array($combinedsearchstring));
541     if ($doingsearch) {
542         if ($advancedsearch) {
544             $messagesearch = '';
545             if (!empty($frm->keywords)) {
546                 $messagesearch = $frm->keywords;
547             }
548             $personsearch = '';
549             if (!empty($frm->name)) {
550                 $personsearch = $frm->name;
551             }
552             include('search_advanced.html');
553         } else {
554             include('search.html');
555         }
557         $showicontext = false;
558         message_print_search_results($frm, $showicontext, $user1);
560         return true;
561     } else {
562 /*
563 /// unfinished buggy code disabled in search.html anyway
564         // find all courses this use has readallmessages capabilities in
565         if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
566             $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
567             $cs = '<select name="courseselect">';
568             foreach ($teachers as $tcourse) {
569                 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
570             }
571             $cs .= '</select>';
572         }
573 */
575         if ($advancedsearch) {
576             $personsearch = $messagesearch = '';
577             include('search_advanced.html');
578         } else {
579             include('search.html');
580         }
581         return false;
582     }
585 function message_print_settings() {
586     global $USER, $OUTPUT, $PAGE;
588     if ($frm = data_submitted() and confirm_sesskey()) {
590         $pref = array();
591         $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage)) ? '1' : '0';
592         $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts)) ? '1' : '0';
594         set_user_preferences($pref);
596         redirect(message_remove_url_params($PAGE->url), get_string('settingssaved', 'message'), 1);
597     }
599     $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ? 'checked="checked"' : '';
600     $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ? 'checked="checked"' : '';
602     include('settings.html');
607 function message_add_contact($contactid, $blocked=0) {
608     global $USER, $DB;
610     if (!$DB->record_exists('user', array('id'=>$contactid))) { // invalid userid
611         return false;
612     }
614     if (($contact = $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid))) !== false) {
615     /// record already exists - we may be changing blocking status
617         if ($contact->blocked !== $blocked) {
618         /// change to blocking status
619             $contact->blocked = $blocked;
620             return $DB->update_record('message_contacts', $contact);
621         } else {
622         /// no changes to blocking status
623             return true;
624         }
626     } else {
627     /// new contact record
628         unset($contact);
629         $contact->userid = $USER->id;
630         $contact->contactid = $contactid;
631         $contact->blocked = $blocked;
632         return $DB->insert_record('message_contacts', $contact, false);
633     }
636 function message_remove_contact($contactid) {
637     global $USER, $DB;
638     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
641 function message_unblock_contact($contactid) {
642     global $USER, $DB;
643     return $DB->delete_records('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
646 function message_block_contact($contactid) {
647     return message_add_contact($contactid, 1);
650 function message_get_contact($contactid) {
651     global $USER, $DB;
652     return $DB->get_record('message_contacts', array('userid'=>$USER->id, 'contactid'=>$contactid));
657 function message_print_search_results($frm, $showicontext=false, $user1=null) {
658     global $USER, $CFG, $DB, $OUTPUT, $PAGE;
660     if (empty($user1)) {
661         $user1 = $USER;
662     }
664     echo '<div class="mdl-left">';
666     $personsearch = false;
667     $personsearchstring = null;
668     if (!empty($frm->personsubmit) and !empty($frm->name)) {
669         $personsearch = true;
670         $personsearchstring = $frm->name;
671     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
672         $personsearch = true;
673         $personsearchstring = $frm->combinedsearch;
674     }
676     /// search for person
677     if ($personsearch) {
678         if (optional_param('mycourses', 0, PARAM_BOOL)) {
679             $users = array();
680             $mycourses = enrol_get_my_courses();
681             foreach ($mycourses as $mycourse) {
682                 if (is_array($susers = message_search_users($mycourse->id, $personsearchstring))) {
683                     foreach ($susers as $suser) $users[$suser->id] = $suser;
684                 }
685             }
686         } else {
687             $users = message_search_users(SITEID, $personsearchstring);
688         }
690         if (!empty($users)) {
691             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
692             echo get_string('userssearchresults', 'message', count($users));
693             echo html_writer::end_tag('p');
695             echo '<table class="messagesearchresults">';
696             foreach ($users as $user) {
698                 if ( $user->contactlistid )  {
699                     if ($user->blocked == 0) { /// not blocked
700                         $strcontact = message_contact_link($user->id, 'remove', true, null, $showicontext);
701                         $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
702                     } else { // blocked
703                         $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
704                         $strblock   = message_contact_link($user->id, 'unblock', true, null, $showicontext);
705                     }
706                 } else {
707                     $strcontact = message_contact_link($user->id, 'add', true, null, $showicontext);
708                     $strblock   = message_contact_link($user->id, 'block', true, null, $showicontext);
709                 }
711                 //should we show just the icon or icon and text?
712                 $histicontext = 'icon';
713                 if ($showicontext) {
714                     $histicontext = 'both';
715                 }
716                 $strhistory = message_history_link($USER->id, $user->id, true, '', '', $histicontext);
718                 echo '<tr><td class="pix">';
719                 echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
720                 echo '</td>';
721                 echo '<td class="contact">';
722                 $popupoptions = array(
723                         'height' => MESSAGE_DISCUSSION_HEIGHT,
724                         'width' => MESSAGE_DISCUSSION_WIDTH,
725                         'menubar' => false,
726                         'location' => false,
727                         'status' => true,
728                         'scrollbars' => true,
729                         'resizable' => true);
731                 $link = new moodle_url("/message/index.php?id=$user->id");
732                 //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
733                 $action = null;
734                 echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
736                 echo '</td>';
738                 echo '<td class="link">'.$strcontact.'</td>';
739                 echo '<td class="link">'.$strblock.'</td>';
740                 echo '<td class="link">'.$strhistory.'</td>';
741                 echo '</tr>';
742             }
743             echo '</table>';
745         } else {
746             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
747             echo get_string('userssearchresults', 'message', 0).'<br /><br />';
748             echo html_writer::end_tag('p');
749         }
750     }
752     // search messages for keywords
753     $messagesearch = false;
754     $messagesearchstring = null;
755     if (!empty($frm->keywords)) {
756         $messagesearch = true;
757         $messagesearchstring = clean_text(trim($frm->keywords));
758     } else if (!empty($frm->combinedsubmit) and !empty($frm->combinedsearch)) {
759         $messagesearch = true;
760         $messagesearchstring = clean_text(trim($frm->combinedsearch));
761     }
763     if ($messagesearch) {
764         if ($messagesearchstring) {
765             $keywords = explode(' ', $messagesearchstring);
766         } else {
767             $keywords = array();
768         }
769         $tome     = false;
770         $fromme   = false;
771         $courseid = 'none';
773         if (empty($frm->keywordsoption)) {
774             $frm->keywordsoption = 'allmine';
775         }
777         switch ($frm->keywordsoption) {
778             case 'tome':
779                 $tome   = true;
780                 break;
781             case 'fromme':
782                 $fromme = true;
783                 break;
784             case 'allmine':
785                 $tome   = true;
786                 $fromme = true;
787                 break;
788             case 'allusers':
789                 $courseid = SITEID;
790                 break;
791             case 'courseusers':
792                 $courseid = $frm->courseid;
793                 break;
794             default:
795                 $tome   = true;
796                 $fromme = true;
797         }
799         if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
801         /// get a list of contacts
802             if (($contacts = $DB->get_records('message_contacts', array('userid'=>$USER->id), '', 'contactid, blocked') ) === false) {
803                 $contacts = array();
804             }
806         /// print heading with number of results
807             echo html_writer::start_tag('p', array('class'=>'heading searchresultcount'));
808             $countresults = count($messages);
809             if ($countresults==MESSAGE_SEARCH_MAX_RESULTS) {
810                 echo get_string('keywordssearchresultstoomany', 'message', $countresults).' ("'.s($messagesearchstring).'")';
811             } else {
812                 echo get_string('keywordssearchresults', 'message', $countresults);
813             }
814             echo html_writer::end_tag('p');
816         /// print table headings
817             echo '<table class="messagesearchresults" cellspacing="0">';
819             $headertdstart = html_writer::start_tag('td', array('class'=>'messagesearchresultscol'));
820             $headertdend   = html_writer::end_tag('td');
821             echo '<tr>';
822             echo $headertdstart.get_string('from').$headertdend;
823             echo $headertdstart.get_string('to').$headertdend;
824             echo $headertdstart.get_string('message', 'message').$headertdend;
825             echo $headertdstart.get_string('timesent', 'message').$headertdend;
826             echo "</tr>\n";
828             $blockedcount = 0;
829             $dateformat = get_string('strftimedatetimeshort');
830             $strcontext = get_string('context', 'message');
831             foreach ($messages as $message) {
833             /// ignore messages to and from blocked users unless $frm->includeblocked is set
834                 if (!optional_param('includeblocked', 0, PARAM_BOOL) and (
835                       ( isset($contacts[$message->useridfrom]) and ($contacts[$message->useridfrom]->blocked == 1)) or
836                       ( isset($contacts[$message->useridto]  ) and ($contacts[$message->useridto]->blocked   == 1))
837                                                 )
838                    ) {
839                     $blockedcount ++;
840                     continue;
841                 }
843             /// load up user to record
844                 if ($message->useridto !== $USER->id) {
845                     $userto = $DB->get_record('user', array('id'=>$message->useridto));
846                     $tocontact = (array_key_exists($message->useridto, $contacts) and
847                                     ($contacts[$message->useridto]->blocked == 0) );
848                     $toblocked = (array_key_exists($message->useridto, $contacts) and
849                                     ($contacts[$message->useridto]->blocked == 1) );
850                 } else {
851                     $userto = false;
852                     $tocontact = false;
853                     $toblocked = false;
854                 }
856             /// load up user from record
857                 if ($message->useridfrom !== $USER->id) {
858                     $userfrom = $DB->get_record('user', array('id'=>$message->useridfrom));
859                     $fromcontact = (array_key_exists($message->useridfrom, $contacts) and
860                                     ($contacts[$message->useridfrom]->blocked == 0) );
861                     $fromblocked = (array_key_exists($message->useridfrom, $contacts) and
862                                     ($contacts[$message->useridfrom]->blocked == 1) );
863                 } else {
864                     $userfrom = false;
865                     $fromcontact = false;
866                     $fromblocked = false;
867                 }
869             /// find date string for this message
870                 $date = usergetdate($message->timecreated);
871                 $datestring = $date['year'].$date['mon'].$date['mday'];
873             /// print out message row
874                 echo '<tr valign="top">';
875                 echo '<td class="contact">';
876                 message_print_user($userfrom, $fromcontact, $fromblocked, $showicontext);
877                 echo '</td>';
878                 echo '<td class="contact">';
879                 message_print_user($userto, $tocontact, $toblocked, $showicontext);
880                 echo '</td>';
881                 echo '<td class="summary">'.message_get_fragment($message->fullmessage, $keywords);
882                 echo '<br /><div class="link">';
884                 //find the user involved that isn't the current user
885                 $user2id = null;
886                 if ($user1->id == $message->useridto) {
887                     $user2id = $message->useridfrom;
888                 } else {
889                     $user2id = $message->useridto;
890                 }
891                 message_history_link($user1->id, $user2id, false,
892                                      $messagesearchstring, 'm'.$message->id, $strcontext);
893                 echo '</div>';
894                 echo '</td>';
895                 echo '<td class="date">'.userdate($message->timecreated, $dateformat).'</td>';
896                 echo "</tr>\n";
897             }
900             if ($blockedcount > 0) {
901                 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
902             }
903             echo '</table>';
905         } else {
906             echo '<p class="heading">'.get_string('keywordssearchresults', 'message', 0).'</p>';
907         }
908     }
910     if (!$personsearch && !$messagesearch) {
911         //they didn't enter any search terms
912         echo $OUTPUT->notification(get_string('emptysearchstring', 'message'));
913     }
915     //echo '<br />';
916     //echo $OUTPUT->single_button(new moodle_url($PAGE->url, array('tab' => 'search')), get_string('newsearch', 'message'));
918     echo '</div>';
922 function message_print_user ($user=false, $iscontact=false, $isblocked=false, $includeicontext=false) {
923     global $USER, $OUTPUT;
925     if ($user === false) {
926         echo $OUTPUT->user_picture($USER, array('size'=>20, 'courseid'=>SITEID));
927     } else {
928         echo $OUTPUT->user_picture($user, array('size'=>20, 'courseid'=>SITEID));
929         echo '&nbsp;';
931         $return = false;
932         $script = null;
933         if ($iscontact) {
934             message_contact_link($user->id, 'remove', $return, $script, $includeicontext);
935         } else {
936             message_contact_link($user->id, 'add', $return, $script, $includeicontext);
937         }
938         echo '&nbsp;';
939         if ($isblocked) {
940             message_contact_link($user->id, 'unblock', $return, $script, $includeicontext);
941         } else {
942             message_contact_link($user->id, 'block', $return, $script, $includeicontext);
943         }
944         echo '<br />';
946         $popupoptions = array(
947                 'height' => MESSAGE_DISCUSSION_HEIGHT,
948                 'width' => MESSAGE_DISCUSSION_WIDTH,
949                 'menubar' => false,
950                 'location' => false,
951                 'status' => true,
952                 'scrollbars' => true,
953                 'resizable' => true);
955         $link = new moodle_url("/message/index.php?id=$user->id");
956         //$action = new popup_action('click', $link, "message_$user->id", $popupoptions);
957         $action = null;
958         echo $OUTPUT->action_link($link, fullname($user), $action, array('title'=>get_string('sendmessageto', 'message', fullname($user))));
960     }
964 /// linktype can be: add, remove, block, unblock
965 function message_contact_link($userid, $linktype='add', $return=false, $script=null, $text=false, $icon=true) {
966     global $USER, $CFG, $OUTPUT, $PAGE;
968     //hold onto the strings as we're probably creating a bunch of links
969     static $str;
971     if (empty($script)) {
972         //strip off previous action params like 'removecontact'
973         $script = message_remove_url_params($PAGE->url);
974     }
976     if (empty($str->blockcontact)) {
977        $str->blockcontact   =  get_string('blockcontact', 'message');
978        $str->unblockcontact =  get_string('unblockcontact', 'message');
979        $str->removecontact  =  get_string('removecontact', 'message');
980        $str->addcontact     =  get_string('addcontact', 'message');
981     }
983     $command = $linktype.'contact';
984     $string  = $str->{$command};
986     $safealttext = s($string);
988     $safestring = '';
989     if (!empty($text)) {
990         $safestring = $safealttext;
991     }
993     $img = '';
994     if ($icon) {
995         $iconpath = null;
996         switch ($linktype) {
997             case 'block':
998                 $iconpath = 't/block';
999                 break;
1000             case 'unblock':
1001                 $iconpath = 't/userblue';
1002                 break;
1003             case 'remove':
1004                 $iconpath = 'i/cross_red_big';
1005                 break;
1006             case 'add':
1007             default:
1008                 $iconpath = 't/addgreen';
1009         }
1011         $img = '<img src="'.$OUTPUT->pix_url($iconpath).'" class="iconsmall" alt="'.$safealttext.'" />';
1012     }
1014     $output = '<span class="'.$linktype.'contact">'.
1015               '<a href="'.$script.'&amp;'.$command.'='.$userid.
1016               '&amp;sesskey='.sesskey().'" title="'.$safealttext.'">'.
1017               $img.
1018               $safestring.'</a></span>';
1020     if ($return) {
1021         return $output;
1022     } else {
1023         echo $output;
1024         return true;
1025     }
1028 function message_history_link($userid1, $userid2, $returnstr=false, $keywords='', $position='', $linktext='') {
1029     global $USER, $CFG, $OUTPUT;
1031     static $strmessagehistory;
1033     if (empty($strmessagehistory)) {
1034         $strmessagehistory = get_string('messagehistory', 'message');
1035     }
1037     if ($position) {
1038         $position = "#$position";
1039     }
1040     if ($keywords) {
1041         $keywords = "&search=".urlencode($keywords);
1042     }
1044     if ($linktext == 'icon') {  // Icon only
1045         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="'.$strmessagehistory.'" />';
1046     } else if ($linktext == 'both') {  // Icon and standard name
1047         $fulllink = '<img src="'.$OUTPUT->pix_url('t/log') . '" class="iconsmall" alt="" />';
1048         $fulllink .= '&nbsp;'.$strmessagehistory;
1049     } else if ($linktext) {    // Custom name
1050         $fulllink = $linktext;
1051     } else {                   // Standard name only
1052         $fulllink = $strmessagehistory;
1053     }
1055     $popupoptions = array(
1056             'height' => 500,
1057             'width' => 500,
1058             'menubar' => false,
1059             'location' => false,
1060             'status' => true,
1061             'scrollbars' => true,
1062             'resizable' => true);
1064     $link = new moodle_url('/message/index.php?history='.MESSAGE_HISTORY_ALL."&user=$userid1&id=$userid2$keywords$position");
1065     //$action = new popup_action('click', $link, "message_history_$userid1", $popupoptions);
1066     $action = null;
1067     $str = $OUTPUT->action_link($link, $fulllink, $action, array('title'=>$strmessagehistory));
1069     $str = '<span class="history">'.$str.'</span>';
1071     if ($returnstr) {
1072         return $str;
1073     } else {
1074         echo $str;
1075         return true;
1076     }
1080 /**
1081  * Search through course users
1082  *
1083  * If $coursid specifies the site course then this function searches
1084  * through all undeleted and confirmed users
1085  *
1086  * @uses $CFG, $USER
1087  * @uses SITEID
1088  * @param int $courseid The course in question.
1089  * @param string $searchtext ?
1090  * @param string $sort ?
1091  * @param string $exceptions ?
1092  * @return array  An array of {@link $USER} records.
1093  * @todo Finish documenting this function
1094  */
1095 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
1096     global $CFG, $USER, $DB;
1098     $fullname = $DB->sql_fullname();
1100     if (!empty($exceptions)) {
1101         $except = ' AND u.id NOT IN ('. $exceptions .') ';
1102     } else {
1103         $except = '';
1104     }
1106     if (!empty($sort)) {
1107         $order = ' ORDER BY '. $sort;
1108     } else {
1109         $order = '';
1110     }
1112     $ufields = user_picture::fields('u');
1113     if (!$courseid or $courseid == SITEID) {
1114         $params = array($USER->id, "%$searchtext%");
1115         return $DB->get_records_sql("SELECT $ufields, mc.id as contactlistid, mc.blocked
1116                                        FROM {user} u
1117                                        LEFT JOIN {message_contacts} mc
1118                                             ON mc.contactid = u.id AND mc.userid = ?
1119                                       WHERE u.deleted = '0' AND u.confirmed = '1'
1120                                             AND (".$DB->sql_like($fullname, '?', false).")
1121                                             $except
1122                                      $order", $params);
1123     } else {
1124 //TODO: add enabled enrolment join here (skodak)
1125         $context = get_context_instance(CONTEXT_COURSE, $courseid);
1126         $contextlists = get_related_contexts_string($context);
1128         // everyone who has a role assignment in this course or higher
1129         $params = array($USER->id, "%$searchtext%");
1130         $users = $DB->get_records_sql("SELECT $ufields,
1131                                          FROM {user} u, mc.id as contactlistid, mc.blocked
1132                                          JOIN {role_assignments} ra ON ra.userid = u.id
1133                                          LEFT JOIN {message_contacts} mc
1134                                               ON mc.contactid = u.id AND mc.userid = ?
1135                                         WHERE u.deleted = '0' AND u.confirmed = '1'
1136                                               AND ra.contextid $contextlists
1137                                               AND (".$DB->sql_like($fullname, '?', false).")
1138                                               $except
1139                                        $order", $params);
1141         return $users;
1142     }
1148 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
1149 /// Returns a list of posts found using an array of search terms
1150 /// eg   word  +word -word
1151 ///
1152     global $CFG, $USER, $DB;
1154     /// If no userid sent then assume current user
1155     if ($userid == 0) $userid = $USER->id;
1157     /// Some differences in SQL syntax
1158     if ($DB->sql_regex_supported()) {
1159         $REGEXP    = $DB->sql_regex(true);
1160         $NOTREGEXP = $DB->sql_regex(false);
1161     }
1163     $searchcond = array();
1164     $params = array();
1165     $i = 0;
1167     //preprocess search terms to check whether we have at least 1 eligible search term
1168     //if we do we can drop words around it like 'a'
1169     $dropshortwords = false;
1170     foreach ($searchterms as $searchterm) {
1171         if (strlen($searchterm) >= 2) {
1172             $dropshortwords = true;
1173         }
1174     }
1176     foreach ($searchterms as $searchterm) {
1177         $i++;
1179         $NOT = false; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
1181         if ($dropshortwords && strlen($searchterm) < 2) {
1182             continue;
1183         }
1184     /// Under Oracle and MSSQL, trim the + and - operators and perform
1185     /// simpler LIKE search
1186         if (!$DB->sql_regex_supported()) {
1187             if (substr($searchterm, 0, 1) == '-') {
1188                 $NOT = true;
1189             }
1190             $searchterm = trim($searchterm, '+-');
1191         }
1193         if (substr($searchterm,0,1) == "+") {
1194             $searchterm = substr($searchterm,1);
1195             $searchterm = preg_quote($searchterm, '|');
1196             $searchcond[] = "m.fullmessage $REGEXP :ss$i";
1197             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1199         } else if (substr($searchterm,0,1) == "-") {
1200             $searchterm = substr($searchterm,1);
1201             $searchterm = preg_quote($searchterm, '|');
1202             $searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
1203             $params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
1205         } else {
1206             $searchcond[] = $DB->sql_like("m.fullmessage", ":ss$i", false, true, $NOT);
1207             $params['ss'.$i] = "%$searchterm%";
1208         }
1209     }
1211     if (empty($searchcond)) {
1212         $searchcond = " ".$DB->sql_like('m.fullmessage', ':ss1', false);
1213         $params['ss1'] = "%";
1214     } else {
1215         $searchcond = implode(" AND ", $searchcond);
1216     }
1218     /// There are several possibilities
1219     /// 1. courseid = SITEID : The admin is searching messages by all users
1220     /// 2. courseid = ??     : A teacher is searching messages by users in
1221     ///                        one of their courses - currently disabled
1222     /// 3. courseid = none   : User is searching their own messages;
1223     ///    a.  Messages from user
1224     ///    b.  Messages to user
1225     ///    c.  Messages to and from user
1227     if ($courseid == SITEID) { /// admin is searching all messages
1228         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1229                                             FROM {message_read} m
1230                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1231         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1232                                             FROM {message} m
1233                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1235     } else if ($courseid !== 'none') {
1236         /// This has not been implemented due to security concerns
1237         $m_read   = array();
1238         $m_unread = array();
1240     } else {
1242         if ($fromme and $tome) {
1243             $searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
1244             $params['userid1'] = $userid;
1245             $params['userid2'] = $userid;
1247         } else if ($fromme) {
1248             $searchcond .= " AND m.useridfrom=:userid";
1249             $params['userid'] = $userid;
1251         } else if ($tome) {
1252             $searchcond .= " AND m.useridto=:userid";
1253             $params['userid'] = $userid;
1254         }
1256         $m_read   = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1257                                             FROM {message_read} m
1258                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1259         $m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
1260                                             FROM {message} m
1261                                            WHERE $searchcond", $params, 0, MESSAGE_SEARCH_MAX_RESULTS);
1263     }
1265     /// The keys may be duplicated in $m_read and $m_unread so we can't
1266     /// do a simple concatenation
1267     $message = array();
1268     foreach ($m_read as $m) {
1269         $messages[] = $m;
1270     }
1271     foreach ($m_unread as $m) {
1272         $messages[] = $m;
1273     }
1275     return (empty($messages)) ? false : $messages;
1280 /// Borrowed with changes from mod/forum/lib.php
1281 function message_shorten_message($message, $minlength=0) {
1282 // Given a post object that we already know has a long message
1283 // this function truncates the message nicely to the first
1284 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1286     $i = 0;
1287     $tag = false;
1288     $length = strlen($message);
1289     $count = 0;
1290     $stopzone = false;
1291     $truncate = 0;
1292     if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
1295     for ($i=0; $i<$length; $i++) {
1296         $char = $message[$i];
1298         switch ($char) {
1299             case "<":
1300                 $tag = true;
1301                 break;
1302             case ">":
1303                 $tag = false;
1304                 break;
1305             default:
1306                 if (!$tag) {
1307                     if ($stopzone) {
1308                         if ($char == '.' or $char == ' ') {
1309                             $truncate = $i+1;
1310                             break 2;
1311                         }
1312                     }
1313                     $count++;
1314                 }
1315                 break;
1316         }
1317         if (!$stopzone) {
1318             if ($count > $minlength) {
1319                 $stopzone = true;
1320             }
1321         }
1322     }
1324     if (!$truncate) {
1325         $truncate = $i;
1326     }
1328     return substr($message, 0, $truncate);
1332 /**
1333  * Given a string and an array of keywords, this function looks
1334  * for the first keyword in the string, and then chops out a
1335  * small section from the text that shows that word in context.
1336  */
1337 function message_get_fragment($message, $keywords) {
1339     $fullsize = 160;
1340     $halfsize = (int)($fullsize/2);
1342     $message = strip_tags($message);
1344     foreach ($keywords as $keyword) {  // Just get the first one
1345         if ($keyword !== '') {
1346             break;
1347         }
1348     }
1349     if (empty($keyword)) {   // None found, so just return start of message
1350         return message_shorten_message($message, 30);
1351     }
1353     $leadin = $leadout = '';
1355 /// Find the start of the fragment
1356     $start = 0;
1357     $length = strlen($message);
1359     $pos = strpos($message, $keyword);
1360     if ($pos > $halfsize) {
1361         $start = $pos - $halfsize;
1362         $leadin = '...';
1363     }
1364 /// Find the end of the fragment
1365     $end = $start + $fullsize;
1366     if ($end > $length) {
1367         $end = $length;
1368     } else {
1369         $leadout = '...';
1370     }
1372 /// Pull out the fragment and format it
1374     $fragment = substr($message, $start, $end - $start);
1375     $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
1376     return $fragment;
1379 //retrieve the messages between two users
1380 function message_get_history($user1, $user2, $limitnum=0, $viewingnewmessages=false) {
1381     global $DB, $CFG;
1383     $messages = array();
1385     //we want messages sorted oldest to newest but if getting a subset of messages we need to sort
1386     //desc to get the last $limitnum messages then flip the order in php
1387     $sort = 'asc';
1388     if ($limitnum>0) {
1389         $sort = 'desc';
1390     }
1392     $notificationswhere = null;
1393     //we have just moved new messages to read. If theyre here to see new messages dont hide notifications
1394     if (!$viewingnewmessages && $CFG->messaginghidereadnotifications) {
1395         $notificationswhere = 'AND notification=0';
1396     }
1398     //prevent notifications of your own actions appearing in your own message history
1399     $ownnotificationwhere = ' AND NOT (useridfrom=? AND notification=1)';
1401     if ($messages_read = $DB->get_records_select('message_read', "((useridto = ? AND useridfrom = ?) OR
1402                                                     (useridto = ? AND useridfrom = ?)) $notificationswhere $ownnotificationwhere",
1403                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1404                                                     "timecreated $sort", '*', 0, $limitnum)) {
1405         foreach ($messages_read as $message) {
1406             $messages[$message->timecreated] = $message;
1407         }
1408     }
1409     if ($messages_new =  $DB->get_records_select('message', "((useridto = ? AND useridfrom = ?) OR
1410                                                     (useridto = ? AND useridfrom = ?)) $ownnotificationwhere",
1411                                                     array($user1->id, $user2->id, $user2->id, $user1->id, $user1->id),
1412                                                     "timecreated $sort", '*', 0, $limitnum)) {
1413         foreach ($messages_new as $message) {
1414             $messages[$message->timecreated] = $message;
1415         }
1416     }
1418     //if we only want the last $limitnum messages
1419     ksort($messages);
1420     $messagecount = count($messages);
1421     if ($limitnum>0 && $messagecount>$limitnum) {
1422         $messages = array_slice($messages, $messagecount-$limitnum, $limitnum, true);
1423     }
1425     return $messages;
1428 function message_print_message_history($user1,$user2,$search='',$messagelimit=0, $messagehistorylink=false, $viewingnewmessages=false) {
1429     global $CFG, $OUTPUT;
1431     echo $OUTPUT->box_start('center');
1432     echo '<table cellpadding="10" class="message_user_pictures"><tr>';
1433     echo '<td align="center" id="user1">';
1434     echo $OUTPUT->user_picture($user1, array('size'=>100, 'courseid'=>SITEID));
1435     echo '<div class="heading">'.fullname($user1).'</div>';
1436     echo '</td>';
1437     echo '<td align="center">';
1438     echo '<img src="'.$OUTPUT->pix_url('t/left').'" alt="'.get_string('from').'" />';
1439     echo '<img src="'.$OUTPUT->pix_url('t/right').'" alt="'.get_string('to').'" />';
1440     echo '</td>';
1441     echo '<td align="center" id="user2">';
1442     echo $OUTPUT->user_picture($user2, array('size'=>100, 'courseid'=>SITEID));
1443     echo '<div class="heading">'.fullname($user2).'</div>';
1445     if (isset($user2->iscontact) && isset($user2->isblocked)) {
1446         $incontactlist = $user2->iscontact;
1447         $isblocked = $user2->isblocked;
1449         $script = null;
1450         $text = true;
1451         $icon = false;
1453         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1454         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $user2, $script, $text, $icon);
1455         $useractionlinks = $strcontact.'&nbsp;|'.$strblock;
1457         echo html_writer::tag('div', $useractionlinks, array('class'=>'useractionlinks'));
1458     }
1460     echo '</td>';
1461     echo '</tr></table>';
1462     echo $OUTPUT->box_end();
1464     if (!empty($messagehistorylink)) {
1465         echo $messagehistorylink;
1466     }
1468     /// Get all the messages and print them
1469     if ($messages = message_get_history($user1, $user2, $messagelimit, $viewingnewmessages)) {
1470         $tablecontents = '';
1472         $current = new stdClass();
1473         $current->mday = '';
1474         $current->month = '';
1475         $current->year = '';
1476         $messagedate = get_string('strftimetime');
1477         $blockdate   = get_string('strftimedaydate');
1478         foreach ($messages as $message) {
1479             if ($message->notification) {
1480                 $notificationclass = ' notification';
1481             } else {
1482                 $notificationclass = null;
1483             }
1484             $date = usergetdate($message->timecreated);
1485             if ($current->mday != $date['mday'] | $current->month != $date['month'] | $current->year != $date['year']) {
1486                 $current->mday = $date['mday'];
1487                 $current->month = $date['month'];
1488                 $current->year = $date['year'];
1490                 $tablecontents .= '<div class="mdl-align heading"><a name="'.$date['year'].$date['mon'].$date['mday'].'"></a>';
1491                 $tablecontents .= $OUTPUT->heading(userdate($message->timecreated, $blockdate), 4, 'center').'</div>';
1492             }
1493             if ($message->useridfrom == $user1->id) {
1494                 $tablecontents .= "<div class='mdl-left left $notificationclass'>".message_format_message($message, $user1, $messagedate, $search, 'me').'</div><br />';
1495             } else {
1496                 $tablecontents .= "<div class='mdl-left right $notificationclass'>".message_format_message($message, $user2, $messagedate, $search, 'other').'</div><br />';
1497             }
1498         }
1500         echo html_writer::nonempty_tag('div', $tablecontents, array('class'=>'mdl-left messagehistory'));
1501     } else {
1502         echo html_writer::nonempty_tag('div', '('.get_string('nomessagesfound', 'message').')', array('class'=>'mdl-align messagehistory'));
1503     }
1506 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
1508     static $dateformat;
1510     if (empty($dateformat)) {
1511         if ($format) {
1512             $dateformat = $format;
1513         } else {
1514             $format = get_string('strftimedatetimeshort');
1515         }
1516     }
1517     $time = userdate($message->timecreated, $dateformat);
1518     $options = new stdClass();
1519     $options->para = false;
1521     //if supplied display small messages as fullmessage may contain boilerplate text that shouldnt appear in the messaging UI
1522     if (!empty($message->smallmessage)) {
1523         $messagetext = format_text($message->smallmessage, FORMAT_MOODLE, $options);
1524     } else {
1525         $messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
1526     }
1528     if (!empty($message->contexturl)) {
1529         $displaytext = null;
1530         if (!empty($message->contexturlname)) {
1531             $displaytext= $message->contexturlname;
1532         } else {
1533             $displaytext= $message->contexturl;
1534         }
1535         $messagetext .= html_writer::start_tag('div',array('class'=>'messagecontext'));
1536             $messagetext .= get_string('view').': '.html_writer::tag('a', $displaytext, array('href' => $message->contexturl));
1537         $messagetext .= html_writer::end_tag('div');
1538     }
1540     if ($keywords) {
1541         $messagetext = highlight($keywords, $messagetext);
1542     }
1544     return '<div class="message '.$class.'"><a name="m'.$message->id.'"></a> <span class="time">'.$time.'</span>: <span class="content">'.$messagetext.'</span></div>';
1547 /**
1548  * Inserts a message into the database, but also forwards it
1549  * via other means if appropriate.
1550  */
1551 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
1552     global $SITE, $CFG, $USER;
1554     $eventdata = new stdClass();
1555     $eventdata->component        = 'moodle';
1556     $eventdata->name             = 'instantmessage';
1557     $eventdata->userfrom         = $userfrom;
1558     $eventdata->userto           = $userto;
1560     //using string manager directly so that strings in the message will be in the message recipients language rather than the senders
1561     $eventdata->subject          = get_string_manager()->get_string('unreadnewmessage', 'message', fullname($userfrom), $userto->lang);
1563     if ($format==FORMAT_HTML) {
1564         $eventdata->fullmessage      = '';
1565         $eventdata->fullmessagehtml  = $message;
1566     } else {
1567         $eventdata->fullmessage      = $message;
1568         $eventdata->fullmessagehtml  = '';
1569     }
1571     $eventdata->fullmessageformat = $format;
1572     $eventdata->smallmessage     = strip_tags($message);//strip just in case there are is any html that would break the popup notification
1574     $s = new stdClass();
1575     $s->sitename = $SITE->shortname;
1576     $s->url = $CFG->wwwroot.'/message/index.php?user='.$userto->id.'&id='.$userfrom->id;
1578     $emailtagline = get_string_manager()->get_string('emailtagline', 'message', $s, $userto->lang);
1579     if (!empty($eventdata->fullmessage)) {
1580         $eventdata->fullmessage .= "\n\n---------------------------------------------------------------------\n".$emailtagline;
1581     }
1582     if (!empty($eventdata->fullmessagehtml)) {
1583         $eventdata->fullmessagehtml .= "<br /><br />---------------------------------------------------------------------<br />".$emailtagline;
1584     }
1586     $eventdata->timecreated     = time();
1587     return message_send($eventdata);
1591 /**
1592  * Returns a list of all user ids who have used messaging in the site
1593  * This was the simple way to code the SQL ... is it going to blow up
1594  * on large datasets?
1595  */
1596 function message_get_participants() {
1597     global $CFG, $DB;
1599         return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
1600                                UNION SELECT useridto as id,1 FROM {message}
1601                                UNION SELECT useridfrom as id,1 FROM {message_read}
1602                                UNION SELECT useridto as id,1 FROM {message_read}
1603                                UNION SELECT userid as id,1 FROM {message_contacts}
1604                                UNION SELECT contactid as id,1 from {message_contacts}");
1607 /**
1608  * Print a row of contactlist displaying user picture, messages waiting and
1609  * block links etc
1610  * @param $contact contact object containing all fields required for $OUTPUT->user_picture()
1611  * @param $incontactlist is the user a contact of ours?
1612  * @param $selectcontacturl string the url to send the user to when a contact's name is clicked
1613  */
1614 function message_print_contactlist_user($contact, $incontactlist = true, $isblocked = false, $selectcontacturl = null, $showactionlinks = true, $selecteduser=null) {
1615     global $OUTPUT, $USER;
1616     $fullname  = fullname($contact);
1617     $fullnamelink  = $fullname;
1619     $linkclass = '';
1620     if (!empty($selecteduser) && $contact->id==$selecteduser->id) {
1621         $linkclass = 'messageselecteduser';
1622     }
1624     /// are there any unread messages for this contact?
1625     if ($contact->messagecount > 0 ){
1626         $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount.')</strong>';
1627     }
1629     $strcontact = $strblock = $strhistory = null;
1631     if ($showactionlinks) {
1632         $strcontact = message_get_contact_add_remove_link($incontactlist, $isblocked, $contact);
1633         $strblock   = message_get_contact_block_link($incontactlist, $isblocked, $contact);
1634         $strhistory = message_history_link($USER->id, $contact->id, true, '', '', 'icon');
1635     }
1637     echo '<tr><td class="pix">';
1638     echo $OUTPUT->user_picture($contact, array('size'=>20, 'courseid'=>SITEID));
1639     echo '</td>';
1640     echo '<td class="contact">';
1642     $popupoptions = array(
1643             'height' => MESSAGE_DISCUSSION_HEIGHT,
1644             'width' => MESSAGE_DISCUSSION_WIDTH,
1645             'menubar' => false,
1646             'location' => false,
1647             'status' => true,
1648             'scrollbars' => true,
1649             'resizable' => true);
1651     $link = $action = null;
1652     if (!empty($selectcontacturl)) {
1653         $link = new moodle_url($selectcontacturl.'&'.CONTACT_ID.'='.$contact->id);
1654     } else {
1655         //can $selectcontacturl be removed and maybe the be removed and hardcoded?
1656         $link = new moodle_url("/message/index.php?id=$contact->id");
1657         $action = new popup_action('click', $link, "message_$contact->id", $popupoptions);
1658     }
1659     echo $OUTPUT->action_link($link, $fullnamelink, $action, array('class'=>$linkclass,'title'=>get_string('sendmessageto', 'message', $fullname)));
1661     echo '</td>';
1662     echo '<td class="link">&nbsp;'.$strcontact.$strblock.'&nbsp;'.$strhistory.'</td>';
1663     echo '</tr>';
1666 function message_get_contact_add_remove_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1667     $strcontact = '';
1669     if($incontactlist){
1670         $strcontact = message_contact_link($contact->id, 'remove', true, $script, $text, $icon);
1671     } else if ($isblocked) {
1672         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1673     } else{
1674         $strcontact = message_contact_link($contact->id, 'add', true, $script, $text, $icon);
1675     }
1677     return $strcontact;
1680 function message_get_contact_block_link($incontactlist, $isblocked, $contact, $script=null, $text=false, $icon=true) {
1681     $strblock   = '';
1683     //commented out to allow the user to block a contact without having to remove them first
1684     /*if ($incontactlist) {
1685         //$strblock = '';
1686     } else*/
1687     if ($isblocked) {
1688         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'unblock', true, $script, $text, $icon);
1689     } else{
1690         $strblock   = '&nbsp;'.message_contact_link($contact->id, 'block', true, $script, $text, $icon);
1691     }
1693     return $strblock;
1696  /**
1697   * Moves unread messages from message table to message_read for a given from user
1698   * @param object $userid       User id
1699   * @return boolean success
1700   */
1701 function message_move_userfrom_unread2read($userid) {
1703     global $DB;
1705     // move all unread messages from message table to message_read
1706     if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
1707         foreach ($messages as $message) {
1708             message_mark_message_read($message, 0); //set timeread to 0 as the message was never read
1709         }
1710     }
1711     return true;
1714 function message_get_popup_messages($destuserid, $fromuserid=NULL){
1715     global $DB;
1717     $processor = $DB->get_record('message_processors', array('name' => 'popup'));
1719     $messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
1721     //for every message to process check if it's for current user and process
1722     $messages = array();
1723     foreach ($messagesproc as $msgp){
1724         $query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
1725         if ($fromuserid){
1726             $query['useridfrom'] = $fromuserid;
1727         }
1728         if ($message = $DB->get_record('message', $query)){
1729             $messages[] = $message;
1730             /// Move the entry to the other table
1731             $message->timeread = time();
1732             $messageid = $message->id;
1733             unset($message->id);
1735             //delete what we've processed and check if can move message
1736             $DB->delete_records('message_working', array('id' => $msgp->id));
1737             if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
1738                 message_mark_message_read($message, time(), true);
1739             }
1740         }
1741     }
1742     return $messages;
1745 /**
1746 * marks ALL messages being sent from $fromuserid to $touserid as read
1747 * @param int $touserid the id of the message recipient
1748 * @param int $fromuserid the id of the message sender
1749 * @return void
1750 */
1751 function message_mark_messages_read($touserid, $fromuserid){
1752     global $DB;
1754     $sql = 'SELECT m.* FROM {message} m WHERE m.useridto=:useridto AND m.useridfrom=:useridfrom';
1755     $messages = $DB->get_recordset_sql($sql, array('useridto'=>$touserid,'useridfrom'=>$fromuserid));
1757     foreach ($messages as $message) {
1758         message_mark_message_read($message, time());
1759     }
1762 /**
1763 * Mark a single message as read
1764 * @param message an object with an object property ie $message->id which is an id in the message table
1765 * @param int $timeread the timestamp for when the message should be marked read. Usually time().
1766 * @param bool $messageworkingempty Is the message_working table already confirmed empty for this message?
1767 * @return void
1768 */
1769 function message_mark_message_read($message, $timeread, $messageworkingempty=false) {
1770     global $DB;
1772     $message->timeread = $timeread;
1774     $messageid = $message->id;
1775     unset($message->id);//unset because it will get a new id on insert into message_read
1777     //If any processors have pending actions abort them
1778     if (!$messageworkingempty) {
1779         $DB->delete_records('message_working', array('unreadmessageid' => $messageid));
1780     }
1781     $DB->insert_record('message_read', $message);
1782     $DB->delete_records('message', array('id' => $messageid));