libdir.'/eventslib.php');
define ('MESSAGE_SHORTLENGTH', 300);
define ('MESSAGE_WINDOW', true); // We are in a message window (so don't pop up a new one!)
if (!isset($CFG->message_contacts_refresh)) { // Refresh the contacts list every 60 seconds
$CFG->message_contacts_refresh = 60;
}
if (!isset($CFG->message_chat_refresh)) { // Look for new comments every 5 seconds
$CFG->message_chat_refresh = 5;
}
if (!isset($CFG->message_offline_time)) {
$CFG->message_offline_time = 300;
}
function message_print_contacts() {
global $USER, $CFG, $DB, $PAGE;
$timetoshowusers = 300; //Seconds default
if (isset($CFG->block_online_users_timetosee)) {
$timetoshowusers = $CFG->block_online_users_timetosee * 60;
}
// time which a user is counting as being active since
$timefrom = time()-$timetoshowusers;
// people in our contactlist who are online
$onlinecontacts = array();
// people in our contactlist who are offline
$offlinecontacts = array();
// people who are not in our contactlist but have sent us a message
$strangers = array();
// get all in our contactlist who are not blocked in our contact list
// and count messages we have waiting from each of them
$contactsql = "SELECT u.id, u.firstname, u.lastname, u.picture,
u.imagealt, u.lastaccess, count(m.id) as messagecount
FROM {message_contacts} mc
JOIN {user} u ON u.id = mc.contactid
LEFT OUTER JOIN {message} m ON m.useridfrom = mc.contactid AND m.useridto = ?
WHERE mc.userid = ? AND mc.blocked = 0
GROUP BY u.id, u.firstname, u.lastname, u.picture,
u.imagealt, u.lastaccess
ORDER BY u.firstname ASC;";
if ($rs = $DB->get_recordset_sql($contactsql, array($USER->id, $USER->id))){
foreach($rs as $rd){
if($rd->lastaccess >= $timefrom){
// they have been active recently, so are counted online
$onlinecontacts[] = $rd;
}else{
$offlinecontacts[] = $rd;
}
}
unset($rd);
$rs->close();
}
// get messages from anyone who isn't in our contact list and count the number
// of messages we have from each of them
$strangersql = "SELECT u.id, u.firstname, u.lastname, u.picture,
u.imagealt, u.lastaccess, count(m.id) as messagecount
FROM {message} m
JOIN {user} u ON u.id = m.useridfrom
LEFT OUTER JOIN {message_contacts} mc ON mc.contactid = m.useridfrom AND mc.userid = m.useridto
WHERE mc.id IS NULL AND m.useridto = ?
GROUP BY u.id, u.firstname, u.lastname, u.picture,
u.imagealt, u.lastaccess
ORDER BY u.firstname ASC;";
if($rs = $DB->get_recordset_sql($strangersql, array($USER->id))){
foreach($rs as $rd){
$strangers[] = $rd;
}
unset($rd);
$rs->close();
}
$countonlinecontacts = count($onlinecontacts);
$countofflinecontacts = count($offlinecontacts);
$countstrangers = count($strangers);
if ($countonlinecontacts + $countofflinecontacts == 0) {
echo '
';
}
function message_print_user ($user=false, $iscontact=false, $isblocked=false) {
global $USER;
if ($user === false) {
print_user_picture($USER, SITEID, $USER->picture, 20, false, true, 'userwindow');
} else {
print_user_picture($user, SITEID, $user->picture, 20, false, true, 'userwindow');
echo ' ';
if ($iscontact) {
message_contact_link($user->id, 'remove');
} else {
message_contact_link($user->id, 'add');
}
echo ' ';
if ($isblocked) {
message_contact_link($user->id, 'unblock');
} else {
message_contact_link($user->id, 'block');
}
echo ' ';
link_to_popup_window("/message/discussion.php?id=$user->id", "message_$user->id",
fullname($user), 400, 400, get_string('sendmessageto', 'message', fullname($user)),
'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500');
}
}
/// linktype can be: add, remove, block, unblock
function message_contact_link($userid, $linktype='add', $return=false, $script="index.php?tab=contacts", $text=false) {
global $USER, $CFG;
static $str;
if (empty($str->blockcontact)) {
$str->blockcontact = get_string('blockcontact', 'message');
$str->unblockcontact = get_string('unblockcontact', 'message');
$str->removecontact = get_string('removecontact', 'message');
$str->addcontact = get_string('addcontact', 'message');
}
$command = $linktype.'contact';
$string = $str->{$command};
$alttext = $text ? '' : $string;
$text = $text ? ' '.$string : '';
switch ($linktype) {
case 'block':
$icon = 't/go';
break;
case 'unblock':
$icon = 't/stop';
break;
case 'remove':
$icon = 't/user';
break;
case 'add':
default:
$icon = 't/usernot';
}
$output = ''.
''.
''.
$text.'';
if ($return) {
return $output;
} else {
echo $output;
return true;
}
}
function message_history_link($userid1, $userid2=0, $returnstr=false, $keywords='', $position='', $linktext='') {
global $USER, $CFG, $OUTPUT;
static $strmessagehistory;
if (empty($strmessagehistory)) {
$strmessagehistory = get_string('messagehistory', 'message');
}
if (!$userid2) {
$userid2 = $USER->id;
}
if ($position) {
$position = "#$position";
}
if ($keywords) {
$keywords = "&search=".urlencode($keywords);
}
if ($linktext == 'icon') { // Icon only
$fulllink = '';
} else if ($linktext == 'both') { // Icon and standard name
$fulllink = '';
$fulllink .= ' '.$strmessagehistory;
} else if ($linktext) { // Custom name
$fulllink = $linktext;
} else { // Standard name only
$fulllink = $strmessagehistory;
}
$str = link_to_popup_window("/message/history.php?user1=$userid1&user2=$userid2$keywords$position",
"message_history_$userid1", $fulllink, 500, 500, $strmessagehistory,
'menubar=0,location=0,status,scrollbars,resizable,width=500,height=500', true);
$str = ''.$str.'';
if ($returnstr) {
return $str;
} else {
echo $str;
return true;
}
}
/**
* Search through course users
*
* If $coursid specifies the site course then this function searches
* through all undeleted and confirmed users
*
* @uses $CFG, $USER
* @uses SITEID
* @param int $courseid The course in question.
* @param string $searchtext ?
* @param string $sort ?
* @param string $exceptions ?
* @return array An array of {@link $USER} records.
* @todo Finish documenting this function
*/
function message_search_users($courseid, $searchtext, $sort='', $exceptions='') {
global $CFG, $USER, $DB;
$fullname = $DB->sql_fullname();
$LIKE = $DB->sql_ilike();
if (!empty($exceptions)) {
$except = ' AND u.id NOT IN ('. $exceptions .') ';
} else {
$except = '';
}
if (!empty($sort)) {
$order = ' ORDER BY '. $sort;
} else {
$order = '';
}
$select = 'u.deleted = \'0\' AND u.confirmed = \'1\'';
$fields = 'u.id, u.firstname, u.lastname, u.picture, u.imagealt, mc.id as contactlistid, mc.blocked';
if (!$courseid or $courseid == SITEID) {
$params = array($USER->id, "%$searchtext%");
return $DB->get_records_sql("SELECT $fields
FROM {user} u
LEFT JOIN {message_contacts} mc
ON mc.contactid = u.id AND mc.userid = ?
WHERE $select
AND ($fullname $LIKE ?)
$except
$order", $params);
} else {
$context = get_context_instance(CONTEXT_COURSE, $courseid);
$contextlists = get_related_contexts_string($context);
// everyone who has a role assignement in this course or higher
$params = array($USER->id, "%$searchtext%");
$users = $DB->get_records_sql("SELECT $fields
FROM {user} u
JOIN {role_assignments} ra ON ra.userid = u.id
LEFT JOIN {message_contacts} mc
ON mc.contactid = u.id AND mc.userid = ?
WHERE $select
AND ra.contextid $contextlists
AND ($fullname $LIKE ?)
$except
$order", $params);
return $users;
}
}
function message_search($searchterms, $fromme=true, $tome=true, $courseid='none', $userid=0) {
/// Returns a list of posts found using an array of search terms
/// eg word +word -word
///
global $CFG, $USER, $DB;
/// If no userid sent then assume current user
if ($userid == 0) $userid = $USER->id;
/// Some differences in SQL syntax
if ($DB->sql_regex_supported()) {
$REGEXP = $DB->sql_regex(true);
$NOTREGEXP = $DB->sql_regex(false);
}
$LIKE = $DB->sql_ilike();
$searchcond = array();
$params = array();
$i = 0;
foreach ($searchterms as $searchterm) {
$i++;
$NOT = ''; /// Initially we aren't going to perform NOT LIKE searches, only MSSQL and Oracle
if (strlen($searchterm) < 2) {
continue;
}
/// Under Oracle and MSSQL, trim the + and - operators and perform
/// simpler LIKE search
if (!$DB->sql_regex_supported()) {
if (substr($searchterm, 0, 1) == '-') {
$NOT = ' NOT ';
}
$searchterm = trim($searchterm, '+-');
}
if (substr($searchterm,0,1) == "+") {
$searchterm = substr($searchterm,1);
$searchterm = preg_quote($searchterm, '|');
$searchcond[] = "m.fullmessage $REGEXP :ss$i";
$params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
} else if (substr($searchterm,0,1) == "-") {
$searchterm = substr($searchterm,1);
$searchterm = preg_quote($searchterm, '|');
$searchcond[] = "m.fullmessage $NOTREGEXP :ss$i";
$params['ss'.$i] = "(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)";
} else {
$searchcond[] = "m.fullmessage $NOT $LIKE :ss$i";
$params['ss'.$i] = "%$searchterm%";
}
}
if (empty($searchcond)) {
$searchcond = " m.fullmessage $LIKE :ss1";
$params['ss1'] = "%";
} else {
$searchcond = implode(" AND ", $searchcond);
}
/// There are several possibilities
/// 1. courseid = SITEID : The admin is searching messages by all users
/// 2. courseid = ?? : A teacher is searching messages by users in
/// one of their courses - currently disabled
/// 3. courseid = none : User is searching their own messages;
/// a. Messages from user
/// b. Messages to user
/// c. Messages to and from user
if ($courseid == SITEID) { /// admin is searching all messages
$m_read = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
FROM {message_read} m
WHERE $searchcond", $params);
$m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
FROM {message} m
WHERE $searchcond", $params);
} else if ($courseid !== 'none') {
/// This has not been implemented due to security concerns
$m_read = array();
$m_unread = array();
} else {
if ($fromme and $tome) {
$searchcond .= " AND (m.useridfrom=:userid1 OR m.useridto=:userid2)";
$params['userid1'] = $userid;
$params['userid2'] = $userid;
} else if ($fromme) {
$searchcond .= " AND m.useridfrom=:userid";
$params['userid'] = $userid;
} else if ($tome) {
$searchcond .= " AND m.useridto=:userid";
$params['userid'] = $userid;
}
$m_read = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
FROM {message_read} m
WHERE $searchcond", $params);
$m_unread = $DB->get_records_sql("SELECT m.id, m.useridto, m.useridfrom, m.fullmessage, m.timecreated
FROM {message} m
WHERE $searchcond", $params);
}
/// The keys may be duplicated in $m_read and $m_unread so we can't
/// do a simple concatenation
$message = array();
foreach ($m_read as $m) {
$messages[] = $m;
}
foreach ($m_unread as $m) {
$messages[] = $m;
}
return (empty($messages)) ? false : $messages;
}
/// Borrowed with changes from mod/forum/lib.php
function message_shorten_message($message, $minlength=0) {
// Given a post object that we already know has a long message
// this function truncates the message nicely to the first
// sane place between $CFG->forum_longpost and $CFG->forum_shortpost
$i = 0;
$tag = false;
$length = strlen($message);
$count = 0;
$stopzone = false;
$truncate = 0;
if ($minlength == 0) $minlength = MESSAGE_SHORTLENGTH;
for ($i=0; $i<$length; $i++) {
$char = $message[$i];
switch ($char) {
case "<":
$tag = true;
break;
case ">":
$tag = false;
break;
default:
if (!$tag) {
if ($stopzone) {
if ($char == '.' or $char == ' ') {
$truncate = $i+1;
break 2;
}
}
$count++;
}
break;
}
if (!$stopzone) {
if ($count > $minlength) {
$stopzone = true;
}
}
}
if (!$truncate) {
$truncate = $i;
}
return substr($message, 0, $truncate);
}
/**
* Given a string and an array of keywords, this function looks
* for the first keyword in the string, and then chops out a
* small section from the text that shows that word in context.
*/
function message_get_fragment($message, $keywords) {
$fullsize = 120;
$halfsize = (int)($fullsize/2);
$message = strip_tags($message);
foreach ($keywords as $keyword) { // Just get the first one
if ($keyword !== '') {
break;
}
}
if (empty($keyword)) { // None found, so just return start of message
return message_shorten_message($message, 30);
}
$leadin = $leadout = '';
/// Find the start of the fragment
$start = 0;
$length = strlen($message);
$pos = strpos($message, $keyword);
if ($pos > $halfsize) {
$start = $pos - $halfsize;
$leadin = '...';
}
/// Find the end of the fragment
$end = $start + $fullsize;
if ($end > $length) {
$end = $length;
} else {
$leadout = '...';
}
/// Pull out the fragment and format it
$fragment = substr($message, $start, $end - $start);
$fragment = $leadin.highlight(implode(' ',$keywords), $fragment).$leadout;
return $fragment;
}
function message_get_history($user1, $user2) {
global $DB;
$messages = $DB->get_records_select('message_read', "(useridto = ? AND useridfrom = ?) OR
(useridto = ? AND useridfrom = ?)", array($user1->id, $user2->id, $user2->id, $user1->id),
'timecreated');
if ($messages_new = $DB->get_records_select('message', "(useridto = ? AND useridfrom = ?) OR
(useridto = ? AND useridfrom = ?)", array($user1->id, $user2->id, $user2->id, $user1->id),
'timecreated')) {
foreach ($messages_new as $message) {
$messages[] = $message;
}
}
return $messages;
}
function message_format_message(&$message, &$user, $format='', $keywords='', $class='other') {
static $dateformat;
if (empty($dateformat)) {
if ($format) {
$dateformat = $format;
} else {
$format = get_string('strftimedatetimeshort');
}
}
$time = userdate($message->timecreated, $dateformat);
$options = new object();
$options->para = false;
$messagetext = format_text($message->fullmessage, $message->fullmessageformat, $options);
if ($keywords) {
$messagetext = highlight($keywords, $messagetext);
}
return '
';
}
/**
* Inserts a message into the database, but also forwards it
* via other means if appropriate.
*/
function message_post_message($userfrom, $userto, $message, $format, $messagetype) {
global $CFG, $SITE, $USER, $DB;
$eventdata = new object();
$eventdata->component = 'message';
$eventdata->name = 'instantmessage';
$eventdata->userfrom = $userfrom;
$eventdata->userto = $userto;
$eventdata->subject = "IM";
$eventdata->fullmessage = $message;
$eventdata->fullmessageformat = FORMAT_PLAIN;
$eventdata->fullmessagehtml = '';
$eventdata->smallmessage = '';
$eventdata->timecreated = time();
return events_trigger('message_send', $eventdata);
}
/**
* Returns a list of all user ids who have used messaging in the site
* This was the simple way to code the SQL ... is it going to blow up
* on large datasets?
*/
function message_get_participants() {
global $CFG, $DB;
return $DB->get_records_sql("SELECT useridfrom as id,1 FROM {message}
UNION SELECT useridto as id,1 FROM {message}
UNION SELECT useridfrom as id,1 FROM {message_read}
UNION SELECT useridto as id,1 FROM {message_read}
UNION SELECT userid as id,1 FROM {message_contacts}
UNION SELECT contactid as id,1 from {message_contacts}");
}
/**
* Print a row of contactlist displaying user picture, messages waiting and
* block links etc
* @param $contact contact object containing all fields required for print_user_picture()
* @param $incontactlist is the user a contact of ours?
*/
function message_print_contactlist_user($contact, $incontactlist = true){
$fullname = fullname($contact);
$fullnamelink = $fullname;
/// are there any unread messages for this contact?
if ($contact->messagecount > 0 ){
$fullnamelink = ''.$fullnamelink.' ('.$contact->messagecount.')';
}
if($incontactlist){
$strcontact = message_contact_link($contact->id, 'remove', true);
$strblock = '';
}else{
$strcontact = message_contact_link($contact->id, 'add', true);
$strblock = ' '. message_contact_link($contact->id, 'block', true);
}
$strhistory = message_history_link($contact->id, 0, true, '', '', 'icon');
echo '
';
}
/**
* Moves unread messages from message table to message_read for a given from user
* @param object $userid User id
* @return boolean success
*/
function message_move_userfrom_unread2read($userid) {
global $DB;
// move all unread messages from message table to messasge_read
if ($messages = $DB->get_records_select('message', 'useridfrom = ?', array($userid), 'timecreated')) {
foreach ($messages as $message) {
$message->timeread = 0; //the message was never read
$messageid = $message->id;
unset($message->id);
if ($DB->insert_record('message_read', $message)) {
$DB->delete_records('message', array('id' => $messageid));
$DB->delete_records('message_working', array('unreadmessageid' => $messageid));
} else {
return false;
}
}
}
return true;
}
function message_get_popup_messages($destuserid, $fromuserid=NULL){
global $DB;
$processor = $DB->get_record('message_processors', array('name' => 'popup'));
$messagesproc = $DB->get_records('message_working', array('processorid'=>$processor->id), 'id ASC');
//for every message to process check if it's for current user and process
$messages = array();
foreach ($messagesproc as $msgp){
$query = array('id'=>$msgp->unreadmessageid, 'useridto'=>$destuserid);
if ($fromuserid){
$query['useridfrom'] = $fromuserid;
}
if ($message = $DB->get_record('message', $query)){
$messages[] = $message;
/// Move the entry to the other table
$message->timeread = time();
$messageid = $message->id;
unset($message->id);
//delete what we've processed and check if can move message
$DB->delete_records('message_working', array('id' => $msgp->id));
if ( $DB->count_records('message_working', array('unreadmessageid'=>$messageid)) == 0){
if ($DB->insert_record('message_read', $message)) {
$DB->delete_records('message', array('id' => $messageid));
}
}
}
}
return $messages;
}
?>