2 /// library functions for messaging
5 define ('MESSAGE_SHORTLENGTH', 300);
6 define ('MESSAGE_WINDOW', true); // We are in a message window (so don't pop up a new one!)
8 if (!isset($CFG->message_contacts_refresh
)) { // Refresh the contacts list every 60 seconds
9 $CFG->message_contacts_refresh
= 60;
11 if (!isset($CFG->message_chat_refresh
)) { // Look for new comments every 5 seconds
12 $CFG->message_chat_refresh
= 5;
14 if (!isset($CFG->message_offline_time
)) {
15 $CFG->message_offline_time
= 300;
19 function message_print_contacts() {
22 $timetoshowusers = 300; //Seconds default
23 if (isset($CFG->block_online_users_timetosee
)) {
24 $timetoshowusers = $CFG->block_online_users_timetosee
* 60;
27 // time which a user is counting as being active since
28 $timefrom = time()-$timetoshowusers;
30 // people in our contactlist who are online
31 $onlinecontacts = array();
32 // people in our contactlist who are offline
33 $offlinecontacts = array();
34 // people who are not in our contactlist but have sent us a message
38 // get all in our contactlist who are not blocked in our contact list
39 // and count messages we have waiting from each of them
40 $contactsql = "SELECT u.id, u.firstname, u.lastname, u.picture,
41 u.imagealt, u.lastaccess, count(m.id) as messagecount
42 FROM {$CFG->prefix}message_contacts mc
43 JOIN {$CFG->prefix}user u
44 ON u.id = mc.contactid
45 LEFT OUTER JOIN {$CFG->prefix}message m
46 ON m.useridfrom = mc.contactid
47 AND m.useridto = {$USER->id}
48 WHERE mc.userid = {$USER->id}
50 GROUP BY u.id, u.firstname, u.lastname, u.picture,
51 u.imagealt, u.lastaccess
52 ORDER BY u.firstname ASC";
54 if($rs = get_recordset_sql($contactsql)){
55 while($rd = rs_fetch_next_record($rs)){
57 if($rd->lastaccess
>= $timefrom){
58 // they have been active recently, so are counted online
59 $onlinecontacts[] = $rd;
61 $offlinecontacts[] = $rd;
69 // get messages from anyone who isn't in our contact list and count the number
70 // of messages we have from each of them
71 $strangersql = "SELECT u.id, u.firstname, u.lastname, u.picture,
72 u.imagealt, u.lastaccess, count(m.id) as messagecount
73 FROM {$CFG->prefix}message m
74 JOIN {$CFG->prefix}user u
75 ON u.id = m.useridfrom
76 LEFT OUTER JOIN {$CFG->prefix}message_contacts mc
77 ON mc.contactid = m.useridfrom AND
78 mc.userid = m.useridto
79 WHERE mc.id IS NULL AND m.useridto = {$USER->id}
80 GROUP BY u.id, u.firstname, u.lastname, u.picture,
81 u.imagealt, u.lastaccess
82 ORDER BY u.firstname ASC";
84 if($rs = get_recordset_sql($strangersql)){
85 while($rd= rs_fetch_next_record($rs)){
92 $countonlinecontacts = count($onlinecontacts);
93 $countofflinecontacts = count($offlinecontacts);
94 $countstrangers = count($strangers);
96 if ($countonlinecontacts +
$countofflinecontacts == 0) {
97 echo '<div class="heading">';
98 print_string('contactlistempty', 'message');
100 echo '<div class="note">';
101 print_string('addsomecontacts', 'message', $CFG->wwwroot
.'/message/index.php?tab=search');
105 echo '<table id="message_contacts" class="boxaligncenter" cellspacing="2" cellpadding="0" border="0">';
107 if($countonlinecontacts) {
108 /// print out list of online contacts
110 echo '<tr><td colspan="3" class="heading">';
111 echo get_string('onlinecontacts', 'message', $countonlinecontacts);
114 foreach ($onlinecontacts as $contact) {
115 message_print_contactlist_user($contact);
118 echo '<tr><td colspan="3"> </td></tr>';
120 if ($countofflinecontacts) {
121 /// print out list of offline contacts
123 echo '<tr><td colspan="3" class="heading">';
124 echo get_string('offlinecontacts', 'message', $countofflinecontacts);
127 foreach ($offlinecontacts as $contact) {
128 message_print_contactlist_user($contact);
130 echo '<tr><td colspan="3"> </td></tr>';
133 /// print out list of incoming contacts
134 if ($countstrangers) {
135 echo '<tr><td colspan="3" class="heading">';
136 echo get_string('incomingcontacts', 'message', $countstrangers);
139 foreach ($strangers as $stranger) {
140 message_print_contactlist_user($stranger, false);
146 if ($countstrangers && ($countonlinecontacts +
$countofflinecontacts == 0)) { // Extra help
147 echo '<div class="note">(';
148 print_string('addsomecontactsincoming', 'message');
154 $autorefresh = '<p align="center" class="note">'.get_string('pagerefreshes', 'message', $CFG->message_contacts_refresh
).'</p>';
155 $autorefresh = addslashes_js($autorefresh); // js escaping
157 // gracefully degrade JS autorefresh
158 echo '<script type="text/javascript">
160 document.write("'.$autorefresh.'")
163 echo '<noscript><div class="button aligncenter">';
164 echo print_single_button('index.php', false, get_string('refresh'));
165 echo '</div></noscript>';
169 /// $messagearray is an array of objects
170 /// $field is a valid property of object
171 /// $value is the value $field should equal to be counted
172 /// if $field is empty then return count of the whole array
173 /// if $field is non-existent then return 0;
174 function message_count_messages($messagearray, $field='', $value='') {
175 if (!is_array($messagearray)) return 0;
176 if ($field == '' or empty($messagearray)) return count($messagearray);
179 foreach ($messagearray as $message) {
180 $count +
= ($message->$field == $value) ?
1 : 0;
186 function message_print_search() {
189 if ($frm = data_submitted()) {
191 message_print_search_results($frm);
195 /// unfinished buggy code disabled in search.html anyway
196 // find all courses this use has readallmessages capabilities in
197 if ($teachers = get_user_capability_course('moodle/site:readallmessages')) {
198 $courses = get_courses('all', 'c.sortorder ASC', 'c.id, c.shortname');
199 $cs = '<select name="courseselect">';
200 foreach ($teachers as $tcourse) {
201 $cs .= "<option value=\"$tcourse->course\">".$courses[$tcourse->id]->shortname."</option>\n";
206 include('search.html');
210 function message_print_settings() {
213 if ($frm = data_submitted() and confirm_sesskey()) {
216 $pref['message_showmessagewindow'] = (isset($frm->showmessagewindow
)) ?
'1' : '0';
217 $pref['message_beepnewmessage'] = (isset($frm->beepnewmessage
)) ?
'1' : '0';
218 $pref['message_blocknoncontacts'] = (isset($frm->blocknoncontacts
)) ?
'1' : '0';
219 $pref['message_usehtmleditor'] = (isset($frm->usehtmleditor
)) ?
'1' : '0';
220 $pref['message_noframesjs'] = (isset($frm->noframesjs
)) ?
'1' : '0';
221 $pref['message_emailmessages'] = (isset($frm->emailmessages
)) ?
'1' : '0';
222 $pref['message_emailtimenosee'] = ((int)$frm->emailtimenosee
> 0) ?
(int)$frm->emailtimenosee
: '10';
223 $pref['message_emailaddress'] = (!empty($frm->emailaddress
)) ?
$frm->emailaddress
: $USER->email
;
224 $pref['message_emailformat'] = (isset($frm->emailformat
)) ?
$frm->emailformat
: FORMAT_PLAIN
;
226 set_user_preferences($pref);
228 redirect('index.php', get_string('settingssaved', 'message'), 1);
231 $cbshowmessagewindow = (get_user_preferences('message_showmessagewindow', 1) == '1') ?
'checked="checked"' : '';
232 $cbbeepnewmessage = (get_user_preferences('message_beepnewmessage', 0) == '1') ?
'checked="checked"' : '';
233 $cbblocknoncontacts = (get_user_preferences('message_blocknoncontacts', 0) == '1') ?
'checked="checked"' : '';
234 $cbusehtmleditor = (get_user_preferences('message_usehtmleditor', 0) == '1') ?
'checked="checked"' : '';
235 $cbnoframesjs = (get_user_preferences('message_noframesjs', 0) == '1') ?
'checked="checked"' : '';
236 $cbemailmessages = (get_user_preferences('message_emailmessages', 1) == '1') ?
'checked="checked"' : '';
237 $txemailaddress = get_user_preferences('message_emailaddress', $USER->email
);
238 $txemailtimenosee = get_user_preferences('message_emailtimenosee', 10);
239 $format_select = choose_from_menu( array(FORMAT_PLAIN
=> get_string('formatplain'),
240 FORMAT_HTML
=> get_string('formathtml')),
242 get_user_preferences('message_emailformat', FORMAT_PLAIN
),
243 false, '', '0', true );
245 include('settings.html');
250 function message_add_contact($contactid, $blocked=0) {
253 if (!record_exists('user', 'id', $contactid)) { // invalid userid
257 if (($contact = get_record('message_contacts', 'userid', $USER->id
, 'contactid', $contactid)) !== false) {
258 /// record already exists - we may be changing blocking status
260 if ($contact->blocked
!== $blocked) {
261 /// change to blocking status
262 $contact->blocked
= $blocked;
263 return update_record('message_contacts', $contact);
265 /// no changes to blocking status
270 /// new contact record
272 $contact->userid
= $USER->id
;
273 $contact->contactid
= $contactid;
274 $contact->blocked
= $blocked;
275 return insert_record('message_contacts', $contact, false);
279 function message_remove_contact($contactid) {
281 return delete_records('message_contacts', 'userid', $USER->id
, 'contactid', $contactid);
284 function message_unblock_contact($contactid) {
286 return delete_records('message_contacts', 'userid', $USER->id
, 'contactid', $contactid);
289 function message_block_contact($contactid) {
290 return message_add_contact($contactid, 1);
293 function message_get_contact($contactid) {
295 return get_record('message_contacts', 'userid', $USER->id
, 'contactid', $contactid);
300 function message_print_search_results($frm) {
303 echo '<div class="mdl-align">';
305 /// search for person
306 if (!empty($frm->personsubmit
) and !empty($frm->name
)) {
308 if (optional_param('mycourses', 0, PARAM_BOOL
)) {
310 $mycourses = get_my_courses($USER->id
);
311 foreach ($mycourses as $mycourse) {
312 if (is_array($susers = message_search_users($mycourse->id
, $frm->name
))) {
313 foreach ($susers as $suser) $users[$suser->id
] = $suser;
317 $users = message_search_users(SITEID
, $frm->name
);
320 if (!empty($users)) {
321 echo '<strong>'.get_string('userssearchresults', 'message', count($users)).'</strong>';
322 echo '<table class="message_users">';
323 foreach ($users as $user) {
325 if ( $user->contactlistid
) {
326 if ($user->blocked
== 0) { /// not blocked
327 $strcontact = message_contact_link($user->id
, 'remove', true);
328 $strblock = message_contact_link($user->id
, 'block', true);
330 $strcontact = message_contact_link($user->id
, 'add', true);
331 $strblock = message_contact_link($user->id
, 'unblock', true);
334 $strcontact = message_contact_link($user->id
, 'add', true);
335 $strblock = message_contact_link($user->id
, 'block', true);
337 $strhistory = message_history_link($user->id
, 0, true, '', '', 'icon');
339 echo '<tr><td class="pix">';
340 print_user_picture($user, SITEID
, $user->picture
, 20, false, true, 'userwindow');
342 echo '<td class="contact">';
343 link_to_popup_window("/message/discussion.php?id=$user->id", "message_$user->id", fullname($user),
344 500, 500, get_string('sendmessageto', 'message', fullname($user)),
345 'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500');
349 echo '<td class="link">'.$strcontact.'</td>';
350 echo '<td class="link">'.$strblock.'</td>';
351 echo '<td class="link">'.$strhistory.'</td>';
357 notify(get_string('nosearchresults', 'message'));
361 /// search messages for keywords
362 } else if (!empty($frm->keywordssubmit
) and !empty($frm->keywords
)) {
363 $keywordstring = clean_text(trim($frm->keywords
));
364 $keywords = explode(' ', $keywordstring);
369 switch ($frm->keywordsoption
) {
384 $courseid = $frm->courseid
;
391 if (($messages = message_search($keywords, $fromme, $tome, $courseid)) !== false) {
393 /// get a list of contacts
394 if (($contacts = get_records('message_contacts', 'userid', $USER->id
, '', 'contactid, blocked') ) === false) {
398 /// print heading with number of results
399 echo '<p class="heading">'.get_string('keywordssearchresults', 'message', count($messages)).' ("'.s($keywordstring).'")</p>';
401 /// print table headings
402 echo '<table class="searchresults" cellspacing="0">';
404 echo '<td><strong>'.get_string('from').'</strong></td>';
405 echo '<td><strong>'.get_string('to').'</strong></td>';
406 echo '<td><strong>'.get_string('message', 'message').'</strong></td>';
407 echo '<td><strong>'.get_string('timesent', 'message').'</strong></td>';
411 $dateformat = get_string('strftimedatetimeshort');
412 $strcontext = get_string('context', 'message');
413 foreach ($messages as $message) {
415 /// ignore messages to and from blocked users unless $frm->includeblocked is set
416 if (!optional_param('includeblocked', 0, PARAM_BOOL
) and (
417 ( isset($contacts[$message->useridfrom
]) and ($contacts[$message->useridfrom
]->blocked
== 1)) or
418 ( isset($contacts[$message->useridto
] ) and ($contacts[$message->useridto
]->blocked
== 1))
425 /// load up user to record
426 if ($message->useridto
!== $USER->id
) {
427 $userto = get_record('user', 'id', $message->useridto
);
428 $tocontact = (array_key_exists($message->useridto
, $contacts) and
429 ($contacts[$message->useridto
]->blocked
== 0) );
430 $toblocked = (array_key_exists($message->useridto
, $contacts) and
431 ($contacts[$message->useridto
]->blocked
== 1) );
438 /// load up user from record
439 if ($message->useridfrom
!== $USER->id
) {
440 $userfrom = get_record('user', 'id', $message->useridfrom
);
441 $fromcontact = (array_key_exists($message->useridfrom
, $contacts) and
442 ($contacts[$message->useridfrom
]->blocked
== 0) );
443 $fromblocked = (array_key_exists($message->useridfrom
, $contacts) and
444 ($contacts[$message->useridfrom
]->blocked
== 1) );
447 $fromcontact = false;
448 $fromblocked = false;
451 /// find date string for this message
452 $date = usergetdate($message->timecreated
);
453 $datestring = $date['year'].$date['mon'].$date['mday'];
455 /// print out message row
456 echo '<tr valign="top">';
457 echo '<td class="contact">';
458 message_print_user($userfrom, $fromcontact, $fromblocked);
460 echo '<td class="contact">';
461 message_print_user($userto, $tocontact, $toblocked);
463 echo '<td class="summary">'.message_get_fragment($message->message
, $keywords);
464 echo '<br /><div class="link">';
465 if ($message->useridfrom
== $USER->id
) {
466 message_history_link($message->useridto
, $message->useridfrom
, false,
467 $keywordstring, 'm'.$message->id
, $strcontext);
469 message_history_link($message->useridfrom
, $message->useridto
, false,
470 $keywordstring, 'm'.$message->id
, $strcontext);
474 echo '<td class="date">'.userdate($message->timecreated
, $dateformat).'</td>';
479 if ($blockedcount > 0) {
480 echo '<tr><td colspan="4" align="center">'.get_string('blockedmessages', 'message', $blockedcount).'</td></tr>';
485 notify(get_string('nosearchresults', 'message'));
489 /// what the ????, probably an empty search string, duh!
491 notify(get_string('emptysearchstring', 'message'));
495 print_single_button('index.php', array( 'tab' => 'search'), get_string('newsearch', 'message') );
501 function message_print_user ($user=false, $iscontact=false, $isblocked=false) {
503 if ($user === false) {
504 print_user_picture($USER, SITEID
, $USER->picture
, 20, false, true, 'userwindow');
506 print_user_picture($user, SITEID
, $user->picture
, 20, false, true, 'userwindow');
509 message_contact_link($user->id
, 'remove');
511 message_contact_link($user->id
, 'add');
515 message_contact_link($user->id
, 'unblock');
517 message_contact_link($user->id
, 'block');
521 link_to_popup_window("/message/discussion.php?id=$user->id", "message_$user->id",
522 fullname($user), 400, 400, get_string('sendmessageto', 'message', fullname($user)),
523 'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500');
528 /// linktype can be: add, remove, block, unblock
529 function message_contact_link($userid, $linktype='add', $return=false, $script="index.php?tab=contacts", $text=false) {
534 if (empty($str->blockcontact
)) {
535 $str->blockcontact
= get_string('blockcontact', 'message');
536 $str->unblockcontact
= get_string('unblockcontact', 'message');
537 $str->removecontact
= get_string('removecontact', 'message');
538 $str->addcontact
= get_string('addcontact', 'message');
541 $command = $linktype.'contact';
542 $string = $str->{$command};
543 $alttext = $text ?
'' : $string;
544 $text = $text ?
' '.$string : '';
551 $icon = '/t/stop.gif';
554 $icon = '/t/user.gif';
558 $icon = '/t/usernot.gif';
561 $output = '<span class="'.$linktype.'">'.
562 '<a href="'.$script.'&'.$command.'='.$userid.
563 '&sesskey='.sesskey().'" title="'.s($string).'">'.
564 '<img src="'.$CFG->pixpath
.$icon.'" class="iconsmall" alt="'.s($alttext).'" />'.
575 function message_history_link($userid1, $userid2=0, $returnstr=false, $keywords='', $position='', $linktext='') {
578 static $strmessagehistory;
580 if (empty($strmessagehistory)) {
581 $strmessagehistory = get_string('messagehistory', 'message');
585 $userid2 = $USER->id
;
588 $position = "#$position";
591 $keywords = "&search=".urlencode($keywords);
594 if ($linktext == 'icon') { // Icon only
595 $fulllink = '<img src="'.$CFG->pixpath
.'/t/log.gif" class="iconsmall" alt="'.$strmessagehistory.'" />';
596 } else if ($linktext == 'both') { // Icon and standard name
597 $fulllink = '<img src="'.$CFG->pixpath
.'/t/log.gif" class="iconsmall" alt="" />';
598 $fulllink .= ' '.$strmessagehistory;
599 } else if ($linktext) { // Custom name
600 $fulllink = $linktext;
601 } else { // Standard name only
602 $fulllink = $strmessagehistory;
605 $str = link_to_popup_window("/message/history.php?user1=$userid1&user2=$userid2$keywords$position",
606 "message_history_$userid1", $fulllink, 500, 500, $strmessagehistory,
607 'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500', true);
609 $str = '<span class="history">'.$str.'</span>';
621 * Search through course users
623 * If $coursid specifies the site course then this function searches
624 * through all undeleted and confirmed users
628 * @param int $courseid The course in question.
629 * @param string $searchtext ?
630 * @param string $sort ?
631 * @param string $exceptions ?
632 * @return array An array of {@link $USER} records.
633 * @todo Finish documenting this function
635 function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
638 $fullname = sql_fullname();
641 if (!empty($exceptions)) {
642 $except = ' AND u.id NOT IN ('. $exceptions .') ';
648 $order = ' ORDER BY '. $sort;
653 $select = 'u.deleted = \'0\' AND u.confirmed = \'1\'';
654 $fields = 'u.id, u.firstname, u.lastname, u.picture, u.imagealt, mc.id as contactlistid, mc.blocked';
656 if (!$courseid or $courseid == SITEID
) {
657 return get_records_sql("SELECT $fields
658 FROM {$CFG->prefix}user u
659 LEFT OUTER JOIN {$CFG->prefix}message_contacts mc
660 ON mc.contactid = u.id AND mc.userid = {$USER->id}
662 AND ($fullname $LIKE '%$searchtext%')
666 $context = get_context_instance(CONTEXT_COURSE
, $courseid);
667 $contextlists = get_related_contexts_string($context);
669 // everyone who has a role assignement in this course or higher
670 $users = get_records_sql("SELECT $fields
671 FROM {$CFG->prefix}user u
672 JOIN {$CFG->prefix}role_assignments ra
674 LEFT OUTER JOIN {$CFG->prefix}message_contacts mc
675 ON mc.contactid = u.id AND mc.userid = {$USER->id}
677 AND ra.contextid $contextlists
678 AND ($fullname $LIKE '%$searchtext%')
688 function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
689 /// Returns a list of posts found using an array of search terms
690 /// eg word +word -word
695 /// If no userid sent then assume current user
696 if ($userid == 0) $userid = $USER->id
;
698 /// Some differences in SQL syntax
700 $NOTLIKE = 'NOT ' . $LIKE;
701 if ($CFG->dbfamily
== "postgres") {
706 $NOTREGEXP = "NOT REGEXP";
711 foreach ($searchterms as $searchterm) {
712 if (strlen($searchterm) < 2) {
715 /// Under Oracle and MSSQL, trim the + and - operators and perform
716 /// simpler LIKE search
717 if ($CFG->dbfamily
== 'oracle' ||
$CFG->dbfamily
== 'mssql') {
718 $searchterm = trim($searchterm, '+-');
721 if ($messagesearch) {
722 $messagesearch .= " AND ";
725 if (substr($searchterm,0,1) == "+") {
726 $searchterm = substr($searchterm,1);
727 $messagesearch .= " m.message $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
728 } else if (substr($searchterm,0,1) == "-") {
729 $searchterm = substr($searchterm,1);
730 $messagesearch .= " m.message $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
732 $messagesearch .= " m.message $LIKE '%$searchterm%' ";
736 if ($messagesearch == '') { // if only 1 letter words searched
740 $messagesearch = "($messagesearch) ";
743 /// There are several possibilities
744 /// 1. courseid = SITEID : The admin is searching messages by all users
745 /// 2. courseid = ?? : A teacher is searching messages by users in
746 /// one of their courses - currently disabled
747 /// 3. courseid = none : User is searching their own messages;
748 /// a. Messages from user
749 /// b. Messages to user
750 /// c. Messages to and from user
752 if ($courseid == SITEID
) { /// admin is searching all messages
753 $m_read = get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.message, m.timecreated
754 FROM {$CFG->prefix}message_read m
755 WHERE $messagesearch");
756 $m_unread = get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.message, m.timecreated
757 FROM {$CFG->prefix}message m
758 WHERE $messagesearch");
760 if ($m_read === false) $m_read = array();
761 if ($m_unread === false) $m_unread = array();
763 } elseif ($courseid !== 'none') {
764 /// This has not been implemented due to security concerns
768 if ($fromme and $tome) $messagesearch .= "AND (m.useridfrom='$userid' OR m.useridto='$userid') ";
769 elseif ($fromme) $messagesearch .= "AND m.useridfrom='$userid' ";
770 elseif ($tome) $messagesearch .= "AND m.useridto='$userid' ";
772 $m_read = get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.message, m.timecreated
773 FROM {$CFG->prefix}message_read m
774 WHERE $messagesearch");
775 $m_unread = get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.message, m.timecreated
776 FROM {$CFG->prefix}message m
777 WHERE $messagesearch");
779 if ($m_read === false) $m_read = array();
780 if ($m_unread === false) $m_unread = array();
784 /// The keys may be duplicated in $m_read and $m_unread so we can't
785 /// do a simple concatenation
787 foreach ($m_read as $m) $messages[] = $m;
788 foreach ($m_unread as $m) $messages[] = $m;
791 return (empty($messages)) ?
false : $messages;
796 /// Borrowed with changes from mod/forum/lib.php
797 function message_shorten_message($message, $minlength=0) {
798 // Given a post object that we already know has a long message
799 // this function truncates the message nicely to the first
800 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
804 $length = strlen($message);
808 if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH
;
811 for ($i=0; $i<$length; $i++
) {
812 $char = $message[$i];
824 if ($char == '.' or $char == ' ') {
834 if ($count > $minlength) {
844 return substr($message, 0, $truncate);
849 * Given a string and an array of keywords, this function looks
850 * for the first keyword in the string, and then chops out a
851 * small section from the text that shows that word in context.
853 function message_get_fragment($message, $keywords) {
856 $halfsize = (int)($fullsize/2);
858 $message = strip_tags($message);
860 foreach ($keywords as $keyword) { // Just get the first one
861 if ($keyword !== '') {
865 if (empty($keyword)) { // None found, so just return start of message
866 return message_shorten_message($message, 30);
869 $leadin = $leadout = '';
871 /// Find the start of the fragment
873 $length = strlen($message);
875 $pos = strpos($message, $keyword);
876 if ($pos > $halfsize) {
877 $start = $pos - $halfsize;
880 /// Find the end of the fragment
881 $end = $start +
$fullsize;
882 if ($end > $length) {
888 /// Pull out the fragment and format it
890 $fragment = substr($message, $start, $end - $start);
891 $fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
896 function message_get_history($user1, $user2) {
897 $messages = get_records_select('message_read', "(useridto = '$user1->id' AND useridfrom = '$user2->id') OR
898 (useridto = '$user2->id' AND useridfrom = '$user1->id')",
900 if ($messages_new = get_records_select('message', "(useridto = '$user1->id' AND useridfrom = '$user2->id') OR
901 (useridto = '$user2->id' AND useridfrom = '$user1->id')",
903 foreach ($messages_new as $message) {
904 $messages[] = $message;
910 function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
914 if (empty($dateformat)) {
916 $dateformat = $format;
918 $format = get_string('strftimedatetimeshort');
921 $time = userdate($message->timecreated
, $dateformat);
922 $options->para
= false;
923 $messagetext = format_text($message->message
, $message->format
, $options);
925 $messagetext = highlight($keywords, $messagetext);
927 return '<div class="message '.$class.'"><a name="m'.$message->id
.'"></a><span class="author">'.s(fullname($user)).'</span> <span class="time">['.$time.']</span>: <span class="content">'.$messagetext.'</span></div>';
931 * Inserts a message into the database, but also forwards it
932 * via other means if appropriate.
934 function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
936 global $CFG, $SITE, $USER;
938 /// Set up current language to suit the receiver of the message
939 $savelang = $USER->lang
;
941 if (!empty($userto->lang
)) {
942 $USER->lang
= $userto->lang
;
945 /// Save the new message in the database
948 $savemessage->useridfrom
= $userfrom->id
;
949 $savemessage->useridto
= $userto->id
;
950 $savemessage->message
= $message;
951 $savemessage->format
= $format;
952 $savemessage->timecreated
= time();
953 $savemessage->messagetype
= 'direct';
955 if ($CFG->messaging
) {
956 if (!$savemessage->id
= insert_record('message', $savemessage)) {
959 $emailforced = false;
960 } else { // $CFG->messaging is not on, we need to force sending of emails
962 $savemessage->id
= true;
965 /// Check to see if anything else needs to be done with it
967 $preference = (object)get_user_preferences(NULL, NULL, $userto->id
);
969 if ($emailforced ||
(!isset($preference->message_emailmessages
) ||
$preference->message_emailmessages
)) { // Receiver wants mail forwarding
970 if (!isset($preference->message_emailtimenosee
)) {
971 $preference->message_emailtimenosee
= 10;
973 if (!isset($preference->message_emailformat
)) {
974 $preference->message_emailformat
= FORMAT_HTML
;
976 if ($emailforced ||
(time() - $userto->lastaccess
) > ((int)$preference->message_emailtimenosee
* 60)) { // Long enough
978 $message = stripslashes_safe($message);
979 $tagline = get_string('emailtagline', 'message', $SITE->shortname
);
981 $messagesubject = preg_replace('/\s+/', ' ', strip_tags($message)); // make sure it's all on one line
982 //convert things like " back to regular characters then strip out tags like <b> <p> etc
983 $messagesubject = strip_tags(html_entity_decode($messagesubject));
984 $messagesubject = message_shorten_message($messagesubject, 30).'...';
986 $messagetext = format_text_email($message, $format).
987 "\n\n--\n".$tagline."\n"."$CFG->wwwroot/message/index.php?popup=1";
989 if (isset($preference->message_emailformat
) and $preference->message_emailformat
== FORMAT_HTML
) {
990 $messagehtml = format_text($message, $format);
991 // MDL-10294, do not print link if messaging is disabled
992 if ($CFG->messaging
) {
993 $messagehtml .= '<hr /><p><a href="'.$CFG->wwwroot
.'/message/index.php?popup=1">'.$tagline.'</a></p>';
999 if (!empty($preference->message_emailaddress
)) {
1000 $userto->email
= $preference->message_emailaddress
; // Use custom messaging address
1003 if (email_to_user($userto, $userfrom, $messagesubject, $messagetext, $messagehtml)) {
1004 $CFG->messagewasjustemailed
= true;
1009 $USER->lang
= $savelang; // restore original language
1011 return $savemessage->id
;
1016 * Returns a list of all user ids who have used messaging in the site
1017 * This was the simple way to code the SQL ... is it going to blow up
1018 * on large datasets?
1020 function message_get_participants() {
1024 return get_records_sql("SELECT useridfrom as id,1 FROM {$CFG->prefix}message
1025 UNION SELECT useridto as id,1 FROM {$CFG->prefix}message
1026 UNION SELECT useridfrom as id,1 FROM {$CFG->prefix}message_read
1027 UNION SELECT useridto as id,1 FROM {$CFG->prefix}message_read
1028 UNION SELECT userid as id,1 FROM {$CFG->prefix}message_contacts
1029 UNION SELECT contactid as id,1 from {$CFG->prefix}message_contacts");
1033 * Print a row of contactlist displaying user picture, messages waiting and
1035 * @param $contact contact object containing all fields required for print_user_picture()
1036 * @param $incontactlist is the user a contact of ours?
1038 function message_print_contactlist_user($contact, $incontactlist = true){
1039 $fullname = fullname($contact);
1040 $fullnamelink = $fullname;
1042 /// are there any unread messages for this contact?
1043 if ($contact->messagecount
> 0 ){
1044 $fullnamelink = '<strong>'.$fullnamelink.' ('.$contact->messagecount
.')</strong>';
1049 $strcontact = message_contact_link($contact->id
, 'remove', true);
1052 $strcontact = message_contact_link($contact->id
, 'add', true);
1053 $strblock = ' '. message_contact_link($contact->id
, 'block', true);
1056 $strhistory = message_history_link($contact->id
, 0, true, '', '', 'icon');
1058 echo '<tr><td class="pix">';
1059 print_user_picture($contact, SITEID
, $contact->picture
, 20, false, true, 'userwindow');
1061 echo '<td class="contact">';
1063 link_to_popup_window("/message/discussion.php?id=$contact->id", "message_$contact->id",
1064 $fullnamelink, 500, 500, get_string('sendmessageto', 'message', $fullname),
1065 'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500');
1068 echo '<td class="link"> '.$strcontact.$strblock.' '.$strhistory.'</td>';
1073 * Moves unread messages from message table to message_read for a given from user
1074 * @param object $userid User id
1075 * @return boolean success
1077 function message_move_userfrom_unread2read($userid) {
1079 // move all unread messages from message table to messasge_read
1080 if ($messages = get_records_select('message', "useridfrom = $userid", 'timecreated')) {
1081 foreach ($messages as $message) {
1082 $message->timeread
= 0; //the message was never read
1083 $message = addslashes_object($message);
1084 $messageid = $message->id
;
1085 unset($message->id
);
1086 if (insert_record('message_read', $message)) {
1087 delete_records('message', 'id', $messageid);