3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * Library of functions and constants for module chat
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 require_once($CFG->dirroot
.'/calendar/lib.php');
28 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output
29 global $CHAT_HTMLHEAD;
30 $CHAT_HTMLHEAD = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head></head>\n<body>\n\n".padding(200);
32 // The HTML head for the message window to start with (with js scrolling)
33 global $CHAT_HTMLHEAD_JS;
34 $CHAT_HTMLHEAD_JS = <<<EOD
35 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
36 <html><head><script type="text/javascript">
40 window.scroll(1,400000);
41 window.setTimeout("move()",100);
43 var scroll_active = true;
48 <body onBlur="scroll_active = true" onFocus="scroll_active = false">
50 global $CHAT_HTMLHEAD_JS;
51 $CHAT_HTMLHEAD_JS .= padding(200);
53 // The HTML code for standard empty pages (e.g. if a user was kicked out)
54 global $CHAT_HTMLHEAD_OUT;
55 $CHAT_HTMLHEAD_OUT = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head><title>You are out!</title></head><body></body></html>";
57 // The HTML head for the message input page
58 global $CHAT_HTMLHEAD_MSGINPUT;
59 $CHAT_HTMLHEAD_MSGINPUT = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head><title>Message Input</title></head><body>";
61 // The HTML code for the message input page, with JavaScript
62 global $CHAT_HTMLHEAD_MSGINPUT_JS;
63 $CHAT_HTMLHEAD_MSGINPUT_JS = <<<EOD
64 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
66 <head><title>Message Input</title>
67 <script type="text/javascript">
70 function empty_field_and_submit(){
71 document.fdummy.arsc_message.value=document.f.arsc_message.value;
72 document.fdummy.submit();
73 document.f.arsc_message.focus();
74 document.f.arsc_message.select();
79 </head><body OnLoad="document.f.arsc_message.focus();document.f.arsc_message.select();">;
82 // Dummy data that gets output to the browser as needed, in order to make it show output
83 global $CHAT_DUMMY_DATA;
84 $CHAT_DUMMY_DATA = padding(200);
92 for($i=0; $i<$n; $i++
){
93 $str.="<!-- nix -->\n";
99 * Given an object containing all the necessary data,
100 * (defined by the form in mod_form.php) this function
101 * will create a new instance and return the id number
102 * of the new instance.
105 * @param object $chat
108 function chat_add_instance($chat) {
111 $chat->timemodified
= time();
113 $returnid = $DB->insert_record("chat", $chat);
115 $event = new stdClass();
116 $event->name
= $chat->name
;
117 $event->description
= format_module_intro('chat', $chat, $chat->coursemodule
);
118 $event->courseid
= $chat->course
;
121 $event->modulename
= 'chat';
122 $event->instance
= $returnid;
123 $event->eventtype
= 'chattime';
124 $event->timestart
= $chat->chattime
;
125 $event->timeduration
= 0;
127 calendar_event
::create($event);
133 * Given an object containing all the necessary data,
134 * (defined by the form in mod_form.php) this function
135 * will update an existing instance with new data.
138 * @param object $chat
141 function chat_update_instance($chat) {
144 $chat->timemodified
= time();
145 $chat->id
= $chat->instance
;
148 $DB->update_record("chat", $chat);
150 $event = new stdClass();
152 if ($event->id
= $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id
))) {
154 $event->name
= $chat->name
;
155 $event->description
= format_module_intro('chat', $chat, $chat->coursemodule
);
156 $event->timestart
= $chat->chattime
;
158 $calendarevent = calendar_event
::load($event->id
);
159 $calendarevent->update($event);
166 * Given an ID of an instance of this module,
167 * this function will permanently delete the instance
168 * and any data that depends on it.
174 function chat_delete_instance($id) {
178 if (! $chat = $DB->get_record('chat', array('id'=>$id))) {
184 // Delete any dependent records here
186 if (! $DB->delete_records('chat', array('id'=>$chat->id
))) {
189 if (! $DB->delete_records('chat_messages', array('chatid'=>$chat->id
))) {
192 if (! $DB->delete_records('chat_messages_current', array('chatid'=>$chat->id
))) {
195 if (! $DB->delete_records('chat_users', array('chatid'=>$chat->id
))) {
199 if (! $DB->delete_records('event', array('modulename'=>'chat', 'instance'=>$chat->id
))) {
207 * Return a small object with summary information about what a
208 * user has done with a given particular instance of this module
209 * Used for user activity reports.
211 * $return->time = the time they did it
212 * $return->info = a short text description
215 * @param object $course
216 * @param object $user
218 * @param object $chat
221 function chat_user_outline($course, $user, $mod, $chat) {
226 * Print a detailed representation of what a user has done with
227 * a given particular instance of this module, for user activity reports.
229 * @param object $course
230 * @param object $user
232 * @param object $chat
235 function chat_user_complete($course, $user, $mod, $chat) {
240 * Given a course and a date, prints a summary of all chat rooms past and present
241 * This function is called from course/lib.php: print_recent_activity()
246 * @param object $course
247 * @param bool $viewfullnames
248 * @param int|string $timestart Timestamp
251 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
252 global $CFG, $USER, $DB, $OUTPUT;
254 // this is approximate only, but it is really fast ;-)
255 $timeout = $CFG->chat_old_ping
* 10;
257 if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
258 FROM {course_modules} cm
259 JOIN {modules} md ON md.id = cm.module
260 JOIN {chat} ch ON ch.id = cm.instance
261 JOIN {chat_messages} chm ON chm.chatid = ch.id
262 WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
264 ORDER BY lasttime ASC", array($timestart, $course->id
))) {
270 $modinfo = get_fast_modinfo($course); // reference needed because we might load the groups
272 foreach ($mcms as $cmid=>$mcm) {
273 if (!array_key_exists($cmid, $modinfo->cms
)) {
276 $cm = $modinfo->cms
[$cmid];
277 $cm->lasttime
= $mcm->lasttime
;
278 if (!$modinfo->cms
[$cm->id
]->uservisible
) {
282 if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
283 or has_capability('moodle/site:accessallgroups', context_module
::instance($cm->id
))) {
284 if ($timeout > time() - $cm->lasttime
) {
293 if (is_null($modinfo->groups
)) {
294 $modinfo->groups
= groups_get_user_groups($course->id
); // load all my groups and cache it in modinfo
297 // verify groups in separate mode
298 if (!$mygroupids = $modinfo->groups
[$cm->groupingid
]) {
302 // ok, last post was not for my group - we have to query db to get last message from one of my groups
303 // only minor problem is that the order will not be correct
304 $mygroupids = implode(',', $mygroupids);
305 $cm->mygroupids
= $mygroupids;
307 if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
308 FROM {course_modules} cm
309 JOIN {chat} ch ON ch.id = cm.instance
310 JOIN {chat_messages_current} chm ON chm.chatid = ch.id
311 WHERE chm.timestamp > ? AND cm.id = ? AND
312 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
313 GROUP BY cm.id", array($timestart, $cm->id
))) {
317 $cm->lasttime
= $mcm->lasttime
;
318 if ($timeout > time() - $cm->lasttime
) {
325 if (!$past and !$current) {
329 $strftimerecent = get_string('strftimerecent');
332 echo $OUTPUT->heading(get_string("pastchats", 'chat').':');
334 foreach ($past as $cm) {
335 $link = $CFG->wwwroot
.'/mod/chat/view.php?id='.$cm->id
;
336 $date = userdate($cm->lasttime
, $strftimerecent);
337 echo '<div class="head"><div class="date">'.$date.'</div></div>';
338 echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name
,true).'</a></div>';
343 echo $OUTPUT->heading(get_string("currentchats", 'chat').':');
345 $oldest = floor((time()-$CFG->chat_old_ping
)/10)*10; // better db caching
347 $timeold = time() - $CFG->chat_old_ping
;
348 $timeold = floor($timeold/10)*10; // better db caching
349 $timeoldext = time() - ($CFG->chat_old_ping
*10); // JSless gui_basic needs much longer timeouts
350 $timeoldext = floor($timeoldext/10)*10; // better db caching
352 $params = array('timeold'=>$timeold, 'timeoldext'=>$timeoldext, 'cmid'=>$cm->id
);
354 $timeout = "AND (chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext)";
356 foreach ($current as $cm) {
358 if (isset($cm->mygroupids
)) {
359 $groupselect = "AND (chu.groupid IN ({$cm->mygroupids}) OR chu.groupid = 0)";
364 if (!$users = $DB->get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email, u.picture
365 FROM {course_modules} cm
366 JOIN {chat} ch ON ch.id = cm.instance
367 JOIN {chat_users} chu ON chu.chatid = ch.id
368 JOIN {user} u ON u.id = chu.userid
369 WHERE cm.id = :cmid $timeout $groupselect
370 GROUP BY u.id, u.firstname, u.lastname, u.email, u.picture", $params)) {
373 $link = $CFG->wwwroot
.'/mod/chat/view.php?id='.$cm->id
;
374 $date = userdate($cm->lasttime
, $strftimerecent);
376 echo '<div class="head"><div class="date">'.$date.'</div></div>';
377 echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name
,true).'</a></div>';
378 echo '<div class="userlist">';
381 foreach ($users as $user) {
382 echo '<li>'.fullname($user, $viewfullnames).'</li>';
394 * Function to be run periodically according to the moodle cron
395 * This function searches for things that need to be done, such
396 * as sending out mail, toggling flags etc ...
401 function chat_cron () {
404 chat_update_chat_times();
406 chat_delete_old_users();
408 /// Delete old messages with a
409 /// single SQL query.
410 $subselect = "SELECT c.keepdays
412 WHERE c.id = {chat_messages}.chatid";
416 WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
421 FROM {chat_messages_current}
422 WHERE timestamp < ( ".time()." - 8 * 3600)";
430 * This standard function will check all instances of this module
431 * and make sure there are up-to-date events created for each of them.
432 * If courseid = 0, then every chat event in the site is checked, else
433 * only chat events belonging to the course specified are checked.
434 * This function is used, in its new format, by restore_refresh_events()
437 * @param int $courseid
440 function chat_refresh_events($courseid = 0) {
444 if (! $chats = $DB->get_records("chat", array("course"=>$courseid))) {
448 if (! $chats = $DB->get_records("chat")) {
452 $moduleid = $DB->get_field('modules', 'id', array('name'=>'chat'));
454 foreach ($chats as $chat) {
455 $cm = get_coursemodule_from_id('chat', $chat->id
);
456 $event = new stdClass();
457 $event->name
= $chat->name
;
458 $event->description
= format_module_intro('chat', $chat, $cm->id
);
459 $event->timestart
= $chat->chattime
;
461 if ($event->id
= $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id
))) {
462 $calendarevent = calendar_event
::load($event->id
);
463 $calendarevent->update($event);
465 $event->courseid
= $chat->course
;
468 $event->modulename
= 'chat';
469 $event->instance
= $chat->id
;
470 $event->eventtype
= 'chattime';
471 $event->timeduration
= 0;
472 $event->visible
= $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$chat->id
));
474 calendar_event
::create($event);
481 //////////////////////////////////////////////////////////////////////
482 /// Functions that require some SQL
487 * @param int $groupid
488 * @param int $groupingid
491 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
494 $params = array('chatid'=>$chatid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
497 $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
502 if (!empty($groupingid)) {
503 $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
504 JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
510 $ufields = user_picture
::fields('u');
511 return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
513 JOIN {user} u ON u.id = c.userid $groupingjoin
514 WHERE c.chatid = :chatid $groupselect
515 ORDER BY c.firstping ASC", $params);
521 * @param int $groupid
524 function chat_get_latest_message($chatid, $groupid=0) {
527 $params = array('chatid'=>$chatid, 'groupid'=>$groupid);
530 $groupselect = "AND (groupid=:groupid OR groupid=0)";
536 FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
537 ORDER BY timestamp DESC";
539 // return the lastest one message
540 return $DB->get_record_sql($sql, $params, true);
544 //////////////////////////////////////////////////////////////////////
545 // login if not already logged in
548 * login if not already logged in
553 * @param string $version
554 * @param int $groupid
555 * @param object $course
556 * @return bool|int Returns the chat users sid or false
558 function chat_login_user($chatid, $version, $groupid, $course) {
561 if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid'=>$chatid, 'userid'=>$USER->id
, 'groupid'=>$groupid))) {
562 // this will update logged user information
563 $chatuser->version
= $version;
564 $chatuser->ip
= $USER->lastip
;
565 $chatuser->lastping
= time();
566 $chatuser->lang
= current_language();
568 // Sometimes $USER->lastip is not setup properly
569 // during login. Update with current value if possible
570 // or provide a dummy value for the db
571 if (empty($chatuser->ip
)) {
572 $chatuser->ip
= getremoteaddr();
575 if (($chatuser->course
!= $course->id
) or ($chatuser->userid
!= $USER->id
)) {
578 $DB->update_record('chat_users', $chatuser);
581 $chatuser = new stdClass();
582 $chatuser->chatid
= $chatid;
583 $chatuser->userid
= $USER->id
;
584 $chatuser->groupid
= $groupid;
585 $chatuser->version
= $version;
586 $chatuser->ip
= $USER->lastip
;
587 $chatuser->lastping
= $chatuser->firstping
= $chatuser->lastmessageping
= time();
588 $chatuser->sid
= random_string(32);
589 $chatuser->course
= $course->id
; //caching - needed for current_language too
590 $chatuser->lang
= current_language(); //caching - to resource intensive to find out later
592 // Sometimes $USER->lastip is not setup properly
593 // during login. Update with current value if possible
594 // or provide a dummy value for the db
595 if (empty($chatuser->ip
)) {
596 $chatuser->ip
= getremoteaddr();
600 $DB->insert_record('chat_users', $chatuser);
602 if ($version == 'sockets') {
603 // do not send 'enter' message, chatd will do it
605 $message = new stdClass();
606 $message->chatid
= $chatuser->chatid
;
607 $message->userid
= $chatuser->userid
;
608 $message->groupid
= $groupid;
609 $message->message
= 'enter';
610 $message->system
= 1;
611 $message->timestamp
= time();
613 $DB->insert_record('chat_messages', $message);
614 $DB->insert_record('chat_messages_current', $message);
618 return $chatuser->sid
;
622 * Delete the old and in the way
627 function chat_delete_old_users() {
628 // Delete the old and in the way
631 $timeold = time() - $CFG->chat_old_ping
;
632 $timeoldext = time() - ($CFG->chat_old_ping
*10); // JSless gui_basic needs much longer timeouts
634 $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
635 $params = array($timeold, $timeoldext);
637 if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
638 $DB->delete_records_select('chat_users', $query, $params);
639 foreach ($oldusers as $olduser) {
640 $message = new stdClass();
641 $message->chatid
= $olduser->chatid
;
642 $message->userid
= $olduser->userid
;
643 $message->groupid
= $olduser->groupid
;
644 $message->message
= 'exit';
645 $message->system
= 1;
646 $message->timestamp
= time();
648 $DB->insert_record('chat_messages', $message);
649 $DB->insert_record('chat_messages_current', $message);
655 * Updates chat records so that the next chat time is correct
661 function chat_update_chat_times($chatid=0) {
662 /// Updates chat records so that the next chat time is correct
667 $params = array('timenow'=>$timenow, 'chatid'=>$chatid);
670 if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
674 if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
679 foreach ($chats as $chat) {
680 switch ($chat->schedule
) {
681 case 1: // Single event - turn off schedule and disable
685 case 2: // Repeat daily
686 while ($chat->chattime
<= $timenow) {
687 $chat->chattime +
= 24 * 3600;
690 case 3: // Repeat weekly
691 while ($chat->chattime
<= $timenow) {
692 $chat->chattime +
= 7 * 24 * 3600;
696 $DB->update_record("chat", $chat);
698 $event = new stdClass(); // Update calendar too
700 $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
701 $params = array('chattime'=>$chat->chattime
, 'chatid'=>$chatid);
703 if ($event->id
= $DB->get_field_select('event', 'id', $cond, $params)) {
704 $event->timestart
= $chat->chattime
;
705 $calendarevent = calendar_event
::load($event->id
);
706 $calendarevent->update($event, false);
714 * @param object $message
715 * @param int $courseid
716 * @param object $sender
717 * @param object $currentuser
718 * @param string $chat_lastrow
719 * @return bool|string Returns HTML or false
721 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
722 global $CFG, $USER, $OUTPUT;
724 $output = new stdClass();
725 $output->beep
= false; // by default
726 $output->refreshusers
= false; // by default
728 // Use get_user_timezone() to find the correct timezone for displaying this message:
729 // It's either the current user's timezone or else decided by some Moodle config setting
730 // First, "reset" $USER->timezone (which could have been set by a previous call to here)
731 // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
732 $USER->timezone
= 99;
733 $tz = get_user_timezone($currentuser->timezone
);
735 // Before formatting the message time string, set $USER->timezone to the above.
736 // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
737 // message times appear off because DST is not taken into account when it should be.
738 $USER->timezone
= $tz;
739 $message->strtime
= userdate($message->timestamp
, get_string('strftimemessage', 'chat'), $tz);
741 $message->picture
= $OUTPUT->user_picture($sender, array('size'=>false, 'courseid'=>$courseid, 'link'=>false));
744 $message->picture
= "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&course=$courseid')\" href=\"$CFG->wwwroot/user/view.php?id=$sender->id&course=$courseid\">$message->picture</a>";
747 //Calculate the row class
748 if ($chat_lastrow !== NULL) {
749 $rowclass = ' class="r'.$chat_lastrow.'" ';
754 // Start processing the message
756 if(!empty($message->system
)) {
758 $output->text
= $message->strtime
.': '.get_string('message'.$message->message
, 'chat', fullname($sender));
759 $output->html
= '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture
.'</td><td class="text">';
760 $output->html
.= '<span class="event">'.$output->text
.'</span></td></tr></table>';
761 $output->basic
= '<dl><dt class="event">'.$message->strtime
.': '.get_string('message'.$message->message
, 'chat', fullname($sender)).'</dt></dl>';
763 if($message->message
== 'exit' or $message->message
== 'enter') {
764 $output->refreshusers
= true; //force user panel refresh ASAP
769 // It's not a system event
770 $text = trim($message->message
);
772 /// Parse the text to clean and filter it
773 $options = new stdClass();
774 $options->para
= false;
775 $text = format_text($text, FORMAT_MOODLE
, $options, $courseid);
777 // And now check for special cases
778 $patternTo = '#^\s*To\s([^:]+):(.*)#';
781 if (substr($text, 0, 5) == 'beep ') {
784 $beepwho = trim(substr($text, 5));
786 if ($beepwho == 'all') { // everyone
787 $outinfo = $message->strtime
.': '.get_string('messagebeepseveryone', 'chat', fullname($sender));
789 $output->beep
= true; // (eventually this should be set to
790 // to a filename uploaded by the user)
792 } else if ($beepwho == $currentuser->id
) { // current user
793 $outinfo = $message->strtime
.': '.get_string('messagebeepsyou', 'chat', fullname($sender));
795 $output->beep
= true;
797 } else { //something is not caught?
800 } else if (substr($text, 0, 1) == '/') { /// It's a user command
802 $pattern = '#(^\/)(\w+).*#';
803 preg_match($pattern, $text, $matches);
804 $command = isset($matches[2]) ?
$matches[2] : false;
805 // Support some IRC commands.
808 $outinfo = $message->strtime
;
809 $outmain = '*** <b>'.$sender->firstname
.' '.substr($text, 4).'</b>';
812 // Error, we set special back to false to use the classic message output.
816 } else if (preg_match($patternTo, $text)) {
819 preg_match($patternTo, $text, $matches);
820 if (isset($matches[1]) && isset($matches[2])) {
821 $outinfo = $message->strtime
;
822 $outmain = $sender->firstname
.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$matches[2];
824 // Error, we set special back to false to use the classic message output.
830 $outinfo = $message->strtime
.' '.$sender->firstname
;
834 /// Format the message as a small table
836 $output->text
= strip_tags($outinfo.': '.$outmain);
838 $output->html
= "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
839 $output->html
.= "<span class=\"title\">$outinfo</span>";
841 $output->html
.= ": $outmain";
842 $output->basic
= '<dl><dt class="title">'.$outinfo.':</dt><dd class="text">'.$outmain.'</dd></dl>';
844 $output->basic
= '<dl><dt class="title">'.$outinfo.'</dt></dl>';
846 $output->html
.= "</td></tr></table>";
852 * @param object $message
853 * @param int $courseid
854 * @param object $currentuser
855 * @param string $chat_lastrow
856 * @return bool|string Returns HTML or false
858 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
859 /// Given a message object full of information, this function
860 /// formats it appropriately into text and html, then
861 /// returns the formatted data.
864 static $users; // Cache user lookups
866 if (isset($users[$message->userid
])) {
867 $user = $users[$message->userid
];
868 } else if ($user = $DB->get_record('user', array('id'=>$message->userid
), user_picture
::fields())) {
869 $users[$message->userid
] = $user;
873 return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
878 * @param object $message message to be displayed.
879 * @param mixed $chatuser user chat data
880 * @param object $currentuser current user for whom the message should be displayed.
881 * @param int $groupingid course module grouping id
882 * @param string $theme name of the chat theme.
883 * @return bool|string Returns HTML or false
885 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
886 global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
887 require_once($CFG->dirroot
.'/mod/chat/locallib.php');
889 static $users; // Cache user lookups
891 $result = new stdClass();
893 if (file_exists($CFG->dirroot
. '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
894 include($CFG->dirroot
. '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
897 if (isset($users[$message->userid
])) {
898 $sender = $users[$message->userid
];
899 } else if ($sender = $DB->get_record('user', array('id'=>$message->userid
), user_picture
::fields())) {
900 $users[$message->userid
] = $sender;
905 $USER->timezone
= 99;
906 $tz = get_user_timezone($currentuser->timezone
);
907 $USER->timezone
= $tz;
909 if (empty($chatuser->course
)) {
910 $courseid = $COURSE->id
;
912 $courseid = $chatuser->course
;
915 $message->strtime
= userdate($message->timestamp
, get_string('strftimemessage', 'chat'), $tz);
916 $message->picture
= $OUTPUT->user_picture($sender, array('courseid'=>$courseid));
918 $message->picture
= "<a target='_blank' href=\"$CFG->wwwroot/user/view.php?id=$sender->id&course=$courseid\">$message->picture</a>";
920 // Start processing the message
921 if(!empty($message->system
)) {
922 $result->type
= 'system';
924 $senderprofile = $CFG->wwwroot
.'/user/view.php?id='.$sender->id
.'&course='.$courseid;
925 $event = get_string('message'.$message->message
, 'chat', fullname($sender));
926 $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime
, $event, $theme);
928 $output = $PAGE->get_renderer('mod_chat');
929 $result->html
= $output->render($eventmessage);
934 // It's not a system event
935 $text = trim($message->message
);
937 /// Parse the text to clean and filter it
938 $options = new stdClass();
939 $options->para
= false;
940 $text = format_text($text, FORMAT_MOODLE
, $options, $courseid);
942 // And now check for special cases
944 $outtime = $message->strtime
;
946 // Initialise variables.
948 $patternTo = '#^\s*To\s([^:]+):(.*)#';
950 if (substr($text, 0, 5) == 'beep ') {
953 $result->type
= 'beep';
954 $beepwho = trim(substr($text, 5));
956 if ($beepwho == 'all') { // everyone
957 $outmain = get_string('messagebeepseveryone', 'chat', fullname($sender));
958 } else if ($beepwho == $currentuser->id
) { // current user
959 $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
960 } else if ($sender->id
== $currentuser->id
) { //something is not caught?
961 //allow beep for a active chat user only, else user can beep anyone and get fullname
962 if (!empty($chatuser) && is_numeric($beepwho)) {
963 $chatusers = chat_get_users($chatuser->chatid
, $chatuser->groupid
, $groupingid);
964 if (array_key_exists($beepwho, $chatusers)) {
965 $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
967 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
970 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
973 } else if (substr($text, 0, 1) == '/') { /// It's a user command
975 $result->type
= 'command';
976 $pattern = '#(^\/)(\w+).*#';
977 preg_match($pattern, $text, $matches);
978 $command = isset($matches[2]) ?
$matches[2] : false;
979 // Support some IRC commands.
982 $outmain = '*** <b>'.$sender->firstname
.' '.substr($text, 4).'</b>';
985 // Error, we set special back to false to use the classic message output.
989 } else if (preg_match($patternTo, $text)) {
991 $result->type
= 'dialogue';
993 preg_match($patternTo, $text, $matches);
994 if (isset($matches[1]) && isset($matches[2])) {
995 $outmain = $sender->firstname
.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$matches[2];
997 // Error, we set special back to false to use the classic message output.
1006 $result->text
= strip_tags($outtime.': '.$outmain);
1008 $mymessageclass = '';
1009 if ($sender->id
== $USER->id
) {
1010 $mymessageclass = 'chat-message-mymessage';
1013 $senderprofile = $CFG->wwwroot
.'/user/view.php?id='.$sender->id
.'&course='.$courseid;
1014 $usermessage = new user_message($senderprofile, fullname($sender), $message->picture
, $mymessageclass, $outtime, $outmain, $theme);
1016 $output = $PAGE->get_renderer('mod_chat');
1017 $result->html
= $output->render($usermessage);
1019 //When user beeps other user, then don't show any timestamp to other users in chat.
1020 if (('' === $outmain) && $special) {
1028 * @global object $DB
1029 * @global object $CFG
1030 * @global object $COURSE
1031 * @global object $OUTPUT
1032 * @param object $users
1033 * @param object $course
1034 * @return array return formatted user list
1036 function chat_format_userlist($users, $course) {
1037 global $CFG, $DB, $COURSE, $OUTPUT;
1039 foreach($users as $user){
1041 $item['name'] = fullname($user);
1042 $item['url'] = $CFG->wwwroot
.'/user/view.php?id='.$user->id
.'&course='.$course->id
;
1043 $item['picture'] = $OUTPUT->user_picture($user);
1044 $item['id'] = $user->id
;
1051 * Print json format error
1052 * @param string $level
1053 * @param string $msg
1055 function chat_print_error($level, $msg) {
1056 header('Content-Length: ' . ob_get_length() );
1057 $error = new stdClass();
1058 $error->level
= $level;
1060 $response['error'] = $error;
1061 echo json_encode($response);
1069 function chat_get_view_actions() {
1070 return array('view','view all','report');
1076 function chat_get_post_actions() {
1077 return array('talk');
1083 * @param array $courses
1084 * @param array $htmlarray Passed by reference
1086 function chat_print_overview($courses, &$htmlarray) {
1089 if (empty($courses) ||
!is_array($courses) ||
count($courses) == 0) {
1093 if (!$chats = get_all_instances_in_courses('chat',$courses)) {
1097 $strchat = get_string('modulename', 'chat');
1098 $strnextsession = get_string('nextsession', 'chat');
1100 foreach ($chats as $chat) {
1101 if ($chat->chattime
and $chat->schedule
) { // A chat is scheduled
1102 $str = '<div class="chat overview"><div class="name">'.
1103 $strchat.': <a '.($chat->visible?
'':' class="dimmed"').
1104 ' href="'.$CFG->wwwroot
.'/mod/chat/view.php?id='.$chat->coursemodule
.'">'.
1105 $chat->name
.'</a></div>';
1106 $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime
).'</div></div>';
1108 if (empty($htmlarray[$chat->course
]['chat'])) {
1109 $htmlarray[$chat->course
]['chat'] = $str;
1111 $htmlarray[$chat->course
]['chat'] .= $str;
1119 * Implementation of the function for printing the form elements that control
1120 * whether the course reset functionality affects the chat.
1122 * @param object $mform form passed by reference
1124 function chat_reset_course_form_definition(&$mform) {
1125 $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1126 $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages','chat'));
1130 * Course reset form defaults.
1132 * @param object $course
1135 function chat_reset_course_form_defaults($course) {
1136 return array('reset_chat'=>1);
1140 * Actual implementation of the reset course functionality, delete all the
1141 * chat messages for course $data->courseid.
1145 * @param object $data the data submitted from the reset course.
1146 * @return array status array
1148 function chat_reset_userdata($data) {
1151 $componentstr = get_string('modulenameplural', 'chat');
1154 if (!empty($data->reset_chat
)) {
1155 $chatessql = "SELECT ch.id
1158 $params = array($data->courseid
);
1160 $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1161 $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1162 $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1163 $status[] = array('component'=>$componentstr, 'item'=>get_string('removemessages', 'chat'), 'error'=>false);
1166 /// updating dates - shift may be negative too
1167 if ($data->timeshift
) {
1168 shift_course_mod_dates('chat', array('chattime'), $data->timeshift
, $data->courseid
);
1169 $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
1176 * Returns all other caps used in module
1180 function chat_get_extra_capabilities() {
1181 return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1186 * @param string $feature FEATURE_xx constant for requested feature
1187 * @return mixed True if module supports feature, null if doesn't know
1189 function chat_supports($feature) {
1191 case FEATURE_GROUPS
: return true;
1192 case FEATURE_GROUPINGS
: return true;
1193 case FEATURE_GROUPMEMBERSONLY
: return true;
1194 case FEATURE_MOD_INTRO
: return true;
1195 case FEATURE_BACKUP_MOODLE2
: return true;
1196 case FEATURE_COMPLETION_TRACKS_VIEWS
: return true;
1197 case FEATURE_GRADE_HAS_GRADE
: return false;
1198 case FEATURE_GRADE_OUTCOMES
: return true;
1199 case FEATURE_SHOW_DESCRIPTION
: return true;
1201 default: return null;
1205 function chat_extend_navigation($navigation, $course, $module, $cm) {
1208 $currentgroup = groups_get_activity_group($cm, true);
1210 if (has_capability('mod/chat:chat', context_module
::instance($cm->id
))) {
1211 $strenterchat = get_string('enterchat', 'chat');
1213 $target = $CFG->wwwroot
.'/mod/chat/';
1214 $params = array('id'=>$cm->instance
);
1216 if ($currentgroup) {
1217 $params['groupid'] = $currentgroup;
1222 $url = new moodle_url($target.'gui_'.$CFG->chat_method
.'/index.php', $params);
1223 $action = new popup_action('click', $url, 'chat'.$course->id
.$cm->instance
.$currentgroup, array('height' => 500, 'width' => 700));
1224 $links[] = new action_link($url, $strenterchat, $action);
1226 $url = new moodle_url($target.'gui_basic/index.php', $params);
1227 $action = new popup_action('click', $url, 'chat'.$course->id
.$cm->instance
.$currentgroup, array('height' => 500, 'width' => 700));
1228 $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1230 foreach ($links as $link) {
1231 $navigation->add($link->text
, $link, navigation_node
::TYPE_SETTING
, null ,null, new pix_icon('i/group' , ''));
1235 $chatusers = chat_get_users($cm->instance
, $currentgroup, $cm->groupingid
);
1236 if (is_array($chatusers) && count($chatusers)>0) {
1237 $users = $navigation->add(get_string('currentusers', 'chat'));
1238 foreach ($chatusers as $chatuser) {
1239 $userlink = new moodle_url('/user/view.php', array('id'=>$chatuser->id
,'course'=>$course->id
));
1240 $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping
), $userlink, navigation_node
::TYPE_USER
, null, null, new pix_icon('i/user', ''));
1246 * Adds module specific settings to the settings block
1248 * @param settings_navigation $settings The settings navigation object
1249 * @param navigation_node $chatnode The node to add module settings to
1251 function chat_extend_settings_navigation(settings_navigation
$settings, navigation_node
$chatnode) {
1252 global $DB, $PAGE, $USER;
1253 $chat = $DB->get_record("chat", array("id" => $PAGE->cm
->instance
));
1255 if ($chat->chattime
&& $chat->schedule
) {
1256 $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').': '.userdate($chat->chattime
).' ('.usertimezone($USER->timezone
));
1257 $nextsessionnode->add_class('note');
1260 $currentgroup = groups_get_activity_group($PAGE->cm
, true);
1261 if ($currentgroup) {
1262 $groupselect = " AND groupid = '$currentgroup'";
1267 if ($chat->studentlogs ||
has_capability('mod/chat:readlog',$PAGE->cm
->context
)) {
1268 if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id
))) {
1269 $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id'=>$PAGE->cm
->id
)));
1275 * user logout event handler
1277 * @param object $user full $USER object
1279 function chat_user_logout($user) {
1281 $DB->delete_records('chat_users', array('userid'=>$user->id
));
1285 * Return a list of page types
1286 * @param string $pagetype current page type
1287 * @param stdClass $parentcontext Block's parent context
1288 * @param stdClass $currentcontext Current context of block
1290 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1291 $module_pagetype = array('mod-chat-*'=>get_string('page-mod-chat-x', 'chat'));
1292 return $module_pagetype;