16f68a3408e3462cdd4c64be4cb8a9d130b6aa3c
[moodle.git] / mod / chat / 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 of functions and constants for module chat
20  *
21  * @package   mod-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
24  */
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">
37 //<![CDATA[
38 function move(){
39     if (scroll_active)
40         window.scroll(1,400000);
41     window.setTimeout("move()",100);
42 }
43 var scroll_active = true;
44 move();
45 //]]>
46 </script>
47 </head>
48 <body onBlur="scroll_active = true" onFocus="scroll_active = false">
49 EOD;
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">
65 <html>
66     <head><title>Message Input</title>
67     <script type="text/javascript">
68     //<![CDATA[
69     scroll_active = true;
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();
75         return false;
76     }
77     //]]>
78     </script>
79     </head><body OnLoad="document.f.arsc_message.focus();document.f.arsc_message.select();">;
80 EOD;
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);
86 /**
87  * @param int $n
88  * @return string
89  */
90 function padding($n){
91     $str = '';
92     for($i=0; $i<$n; $i++){
93         $str.="<!-- nix -->\n";
94     }
95     return $str;
96 }
98 /**
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.
103  *
104  * @global object
105  * @param object $chat
106  * @return int
107  */
108 function chat_add_instance($chat) {
109     global $DB;
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;
119     $event->groupid     = 0;
120     $event->userid      = 0;
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);
129     return $returnid;
132 /**
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.
136  *
137  * @global object
138  * @param object $chat
139  * @return bool
140  */
141 function chat_update_instance($chat) {
142     global $DB;
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);
160     }
162     return true;
165 /**
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.
169  *
170  * @global object
171  * @param int $id
172  * @return bool
173  */
174 function chat_delete_instance($id) {
175     global $DB;
178     if (! $chat = $DB->get_record('chat', array('id'=>$id))) {
179         return false;
180     }
182     $result = true;
184     // Delete any dependent records here
186     if (! $DB->delete_records('chat', array('id'=>$chat->id))) {
187         $result = false;
188     }
189     if (! $DB->delete_records('chat_messages', array('chatid'=>$chat->id))) {
190         $result = false;
191     }
192     if (! $DB->delete_records('chat_messages_current', array('chatid'=>$chat->id))) {
193         $result = false;
194     }
195     if (! $DB->delete_records('chat_users', array('chatid'=>$chat->id))) {
196         $result = false;
197     }
199     if (! $DB->delete_records('event', array('modulename'=>'chat', 'instance'=>$chat->id))) {
200         $result = false;
201     }
203     return $result;
206 /**
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.
210  * <code>
211  * $return->time = the time they did it
212  * $return->info = a short text description
213  * </code>
214  *
215  * @param object $course
216  * @param object $user
217  * @param object $mod
218  * @param object $chat
219  * @return void
220  */
221 function chat_user_outline($course, $user, $mod, $chat) {
222     return NULL;
225 /**
226  * Print a detailed representation of what a  user has done with
227  * a given particular instance of this module, for user activity reports.
228  *
229  * @param object $course
230  * @param object $user
231  * @param object $mod
232  * @param object $chat
233  * @return bool
234  */
235 function chat_user_complete($course, $user, $mod, $chat) {
236     return true;
239 /**
240  * Given a course and a date, prints a summary of all chat rooms past and present
241  * This function is called from block_recent_activity
242  *
243  * @global object
244  * @global object
245  * @global object
246  * @param object $course
247  * @param bool $viewfullnames
248  * @param int|string $timestart Timestamp
249  * @return bool
250  */
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'
263                                      GROUP BY cm.id
264                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
265          return false;
266     }
268     $past     = array();
269     $current  = array();
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)) {
274             continue;
275         }
276         $cm = $modinfo->cms[$cmid];
277         if (!$modinfo->cms[$cm->id]->uservisible) {
278             continue;
279         }
281         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
282          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
283             if ($timeout > time() - $mcm->lasttime) {
284                 $current[] = $cm;
285             } else {
286                 $past[] = $cm;
287             }
289             continue;
290         }
292         if (is_null($modinfo->groups)) {
293             $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
294         }
296         // verify groups in separate mode
297         if (!$mygroupids = $modinfo->groups[$cm->groupingid]) {
298             continue;
299         }
301         // ok, last post was not for my group - we have to query db to get last message from one of my groups
302         // only minor problem is that the order will not be correct
303         $mygroupids = implode(',', $mygroupids);
305         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
306                                            FROM {course_modules} cm
307                                            JOIN {chat} ch           ON ch.id = cm.instance
308                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
309                                           WHERE chm.timestamp > ? AND cm.id = ? AND
310                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
311                                        GROUP BY cm.id", array($timestart, $cm->id))) {
312              continue;
313         }
315         $mcms[$cmid]->lasttime = $mcm->lasttime;
316         if ($timeout > time() - $mcm->lasttime) {
317             $current[] = $cm;
318         } else {
319             $past[] = $cm;
320         }
321     }
323     if (!$past and !$current) {
324         return false;
325     }
327     $strftimerecent = get_string('strftimerecent');
329     if ($past) {
330         echo $OUTPUT->heading(get_string("pastchats", 'chat').':');
332         foreach ($past as $cm) {
333             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
334             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
335             echo '<div class="head"><div class="date">'.$date.'</div></div>';
336             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
337         }
338     }
340     if ($current) {
341         echo $OUTPUT->heading(get_string("currentchats", 'chat').':');
343         $oldest = floor((time()-$CFG->chat_old_ping)/10)*10;  // better db caching
345         $timeold    = time() - $CFG->chat_old_ping;
346         $timeold    = floor($timeold/10)*10;  // better db caching
347         $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
348         $timeoldext = floor($timeoldext/10)*10;  // better db caching
350         $params = array('timeold'=>$timeold, 'timeoldext'=>$timeoldext, 'cmid'=>$cm->id);
352         $timeout = "AND (chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext)";
354         foreach ($current as $cm) {
355             //count users first
356             $mygroupids = $modinfo->groups[$cm->groupingid];
357             if (!empty($mygroupids)) {
358                 list($subquery, $subparams) = $DB->get_in_or_equal($mygroupids, SQL_PARAMS_NAMED, 'gid');
359                 $params += $subparams;
360                 $groupselect = "AND (chu.groupid $subquery OR chu.groupid = 0)";
361             } else {
362                 $groupselect = "";
363             }
365             $userfields = user_picture::fields('u');
366             if (!$users = $DB->get_records_sql("SELECT $userfields
367                                                   FROM {course_modules} cm
368                                                   JOIN {chat} ch        ON ch.id = cm.instance
369                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
370                                                   JOIN {user} u         ON u.id = chu.userid
371                                                  WHERE cm.id = :cmid $timeout $groupselect
372                                               GROUP BY $userfields", $params)) {
373             }
375             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
376             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
378             echo '<div class="head"><div class="date">'.$date.'</div></div>';
379             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
380             echo '<div class="userlist">';
381             if ($users) {
382                 echo '<ul>';
383                     foreach ($users as $user) {
384                         echo '<li>'.fullname($user, $viewfullnames).'</li>';
385                     }
386                 echo '</ul>';
387             }
388             echo '</div>';
389         }
390     }
392     return true;
395 /**
396  * Function to be run periodically according to the moodle cron
397  * This function searches for things that need to be done, such
398  * as sending out mail, toggling flags etc ...
399  *
400  * @global object
401  * @return bool
402  */
403 function chat_cron () {
404     global $DB;
406     chat_update_chat_times();
408     chat_delete_old_users();
410     /// Delete old messages with a
411     /// single SQL query.
412     $subselect = "SELECT c.keepdays
413                     FROM {chat} c
414                    WHERE c.id = {chat_messages}.chatid";
416     $sql = "DELETE
417               FROM {chat_messages}
418              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
420     $DB->execute($sql);
422     $sql = "DELETE
423               FROM {chat_messages_current}
424              WHERE timestamp < ( ".time()." - 8 * 3600)";
426     $DB->execute($sql);
428     return true;
431 /**
432  * This standard function will check all instances of this module
433  * and make sure there are up-to-date events created for each of them.
434  * If courseid = 0, then every chat event in the site is checked, else
435  * only chat events belonging to the course specified are checked.
436  * This function is used, in its new format, by restore_refresh_events()
437  *
438  * @global object
439  * @param int $courseid
440  * @return bool
441  */
442 function chat_refresh_events($courseid = 0) {
443     global $DB;
445     if ($courseid) {
446         if (! $chats = $DB->get_records("chat", array("course"=>$courseid))) {
447             return true;
448         }
449     } else {
450         if (! $chats = $DB->get_records("chat")) {
451             return true;
452         }
453     }
454     $moduleid = $DB->get_field('modules', 'id', array('name'=>'chat'));
456     foreach ($chats as $chat) {
457         $cm = get_coursemodule_from_id('chat', $chat->id);
458         $event = new stdClass();
459         $event->name        = $chat->name;
460         $event->description = format_module_intro('chat', $chat, $cm->id);
461         $event->timestart   = $chat->chattime;
463         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id))) {
464             $calendarevent = calendar_event::load($event->id);
465             $calendarevent->update($event);
466         } else {
467             $event->courseid    = $chat->course;
468             $event->groupid     = 0;
469             $event->userid      = 0;
470             $event->modulename  = 'chat';
471             $event->instance    = $chat->id;
472             $event->eventtype   = 'chattime';
473             $event->timeduration = 0;
474             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$chat->id));
476             calendar_event::create($event);
477         }
478     }
479     return true;
483 //////////////////////////////////////////////////////////////////////
484 /// Functions that require some SQL
486 /**
487  * @global object
488  * @param int $chatid
489  * @param int $groupid
490  * @param int $groupingid
491  * @return array
492  */
493 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
494     global $DB;
496     $params = array('chatid'=>$chatid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
498     if ($groupid) {
499         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
500     } else {
501         $groupselect = "";
502     }
504     if (!empty($groupingid)) {
505         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
506                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
508     } else {
509         $groupingjoin = '';
510     }
512     $ufields = user_picture::fields('u');
513     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
514                                    FROM {chat_users} c
515                                    JOIN {user} u ON u.id = c.userid $groupingjoin
516                                   WHERE c.chatid = :chatid $groupselect
517                                ORDER BY c.firstping ASC", $params);
520 /**
521  * @global object
522  * @param int $chatid
523  * @param int $groupid
524  * @return array
525  */
526 function chat_get_latest_message($chatid, $groupid=0) {
527     global $DB;
529     $params = array('chatid'=>$chatid, 'groupid'=>$groupid);
531     if ($groupid) {
532         $groupselect = "AND (groupid=:groupid OR groupid=0)";
533     } else {
534         $groupselect = "";
535     }
537     $sql = "SELECT *
538         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
539         ORDER BY timestamp DESC";
541     // return the lastest one message
542     return $DB->get_record_sql($sql, $params, true);
546 //////////////////////////////////////////////////////////////////////
547 // login if not already logged in
549 /**
550  * login if not already logged in
551  *
552  * @global object
553  * @global object
554  * @param int $chatid
555  * @param string $version
556  * @param int $groupid
557  * @param object $course
558  * @return bool|int Returns the chat users sid or false
559  */
560 function chat_login_user($chatid, $version, $groupid, $course) {
561     global $USER, $DB;
563     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid'=>$chatid, 'userid'=>$USER->id, 'groupid'=>$groupid))) {
564         // this will update logged user information
565         $chatuser->version  = $version;
566         $chatuser->ip       = $USER->lastip;
567         $chatuser->lastping = time();
568         $chatuser->lang     = current_language();
570         // Sometimes $USER->lastip is not setup properly
571         // during login. Update with current value if possible
572         // or provide a dummy value for the db
573         if (empty($chatuser->ip)) {
574             $chatuser->ip = getremoteaddr();
575         }
577         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
578             return false;
579         }
580         $DB->update_record('chat_users', $chatuser);
582     } else {
583         $chatuser = new stdClass();
584         $chatuser->chatid   = $chatid;
585         $chatuser->userid   = $USER->id;
586         $chatuser->groupid  = $groupid;
587         $chatuser->version  = $version;
588         $chatuser->ip       = $USER->lastip;
589         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
590         $chatuser->sid      = random_string(32);
591         $chatuser->course   = $course->id; //caching - needed for current_language too
592         $chatuser->lang     = current_language(); //caching - to resource intensive to find out later
594         // Sometimes $USER->lastip is not setup properly
595         // during login. Update with current value if possible
596         // or provide a dummy value for the db
597         if (empty($chatuser->ip)) {
598             $chatuser->ip = getremoteaddr();
599         }
602         $DB->insert_record('chat_users', $chatuser);
604         if ($version == 'sockets') {
605             // do not send 'enter' message, chatd will do it
606         } else {
607             chat_send_chatmessage($chatuser, 'enter', true);
608         }
609     }
611     return $chatuser->sid;
614 /**
615  * Delete the old and in the way
616  *
617  * @global object
618  * @global object
619  */
620 function chat_delete_old_users() {
621 // Delete the old and in the way
622     global $CFG, $DB;
624     $timeold = time() - $CFG->chat_old_ping;
625     $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
627     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
628     $params = array($timeold, $timeoldext);
630     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
631         $DB->delete_records_select('chat_users', $query, $params);
632         foreach ($oldusers as $olduser) {
633             chat_send_chatmessage($olduser, 'exit', true);
634         }
635     }
638 /**
639  * Updates chat records so that the next chat time is correct
640  *
641  * @global object
642  * @param int $chatid
643  * @return void
644  */
645 function chat_update_chat_times($chatid=0) {
646 /// Updates chat records so that the next chat time is correct
647     global $DB;
649     $timenow = time();
651     $params = array('timenow'=>$timenow, 'chatid'=>$chatid);
653     if ($chatid) {
654         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
655             return;
656         }
657     } else {
658         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
659             return;
660         }
661     }
663     foreach ($chats as $chat) {
664         switch ($chat->schedule) {
665             case 1: // Single event - turn off schedule and disable
666                     $chat->chattime = 0;
667                     $chat->schedule = 0;
668                     break;
669             case 2: // Repeat daily
670                     while ($chat->chattime <= $timenow) {
671                         $chat->chattime += 24 * 3600;
672                     }
673                     break;
674             case 3: // Repeat weekly
675                     while ($chat->chattime <= $timenow) {
676                         $chat->chattime += 7 * 24 * 3600;
677                     }
678                     break;
679         }
680         $DB->update_record("chat", $chat);
682         $event = new stdClass();           // Update calendar too
684         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
685         $params = array('chattime'=>$chat->chattime, 'chatid'=>$chatid);
687         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
688             $event->timestart   = $chat->chattime;
689             $calendarevent = calendar_event::load($event->id);
690             $calendarevent->update($event, false);
691         }
692     }
695 /**
696  * Send a message on the chat.
697  *
698  * @param object $chatuser The chat user record.
699  * @param string $messagetext The message to be sent.
700  * @param bool $system False for non-system messages, true for system messages.
701  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
702  * @return int The message ID.
703  * @since 2.6
704  */
705 function chat_send_chatmessage($chatuser, $messagetext, $system = false, $cm = null) {
706     global $DB;
708     $message = new stdClass();
709     $message->chatid    = $chatuser->chatid;
710     $message->userid    = $chatuser->userid;
711     $message->groupid   = $chatuser->groupid;
712     $message->message   = $messagetext;
713     $message->system    = $system ? 1 : 0;
714     $message->timestamp = time();
716     $messageid = $DB->insert_record('chat_messages', $message);
717     $DB->insert_record('chat_messages_current', $message);
718     $message->id = $messageid;
720     if (!$system) {
722         if (empty($cm)) {
723             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
724         }
726         $params = array(
727             'context' => context_module::instance($cm->id),
728             'objectid' => $message->id,
729             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
730             'relateduserid' => $chatuser->userid
731         );
732         $event = \mod_chat\event\message_sent::create($params);
733         $event->add_record_snapshot('chat_messages', $message);
734         $event->trigger();
735     }
737     return $message->id;
740 /**
741  * @global object
742  * @global object
743  * @param object $message
744  * @param int $courseid
745  * @param object $sender
746  * @param object $currentuser
747  * @param string $chat_lastrow
748  * @return bool|string Returns HTML or false
749  */
750 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
751     global $CFG, $USER, $OUTPUT;
753     $output = new stdClass();
754     $output->beep = false;       // by default
755     $output->refreshusers = false; // by default
757     // Use get_user_timezone() to find the correct timezone for displaying this message:
758     // It's either the current user's timezone or else decided by some Moodle config setting
759     // First, "reset" $USER->timezone (which could have been set by a previous call to here)
760     // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
761     $USER->timezone = 99;
762     $tz = get_user_timezone($currentuser->timezone);
764     // Before formatting the message time string, set $USER->timezone to the above.
765     // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
766     // message times appear off because DST is not taken into account when it should be.
767     $USER->timezone = $tz;
768     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
770     $message->picture = $OUTPUT->user_picture($sender, array('size'=>false, 'courseid'=>$courseid, 'link'=>false));
772     if ($courseid) {
773         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\" href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
774     }
776     //Calculate the row class
777     if ($chat_lastrow !== NULL) {
778         $rowclass = ' class="r'.$chat_lastrow.'" ';
779     } else {
780         $rowclass = '';
781     }
783     // Start processing the message
785     if(!empty($message->system)) {
786         // System event
787         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
788         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td><td class="text">';
789         $output->html .= '<span class="event">'.$output->text.'</span></td></tr></table>';
790         $output->basic = '<tr class="r1">
791                             <th scope="row" class="cell c1 title"></th>
792                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
793                             <td class="cell c3">' . $message->strtime . '</td>
794                           </tr>';
795         if($message->message == 'exit' or $message->message == 'enter') {
796             $output->refreshusers = true; //force user panel refresh ASAP
797         }
798         return $output;
799     }
801     // It's not a system event
802     $text = trim($message->message);
804     /// Parse the text to clean and filter it
805     $options = new stdClass();
806     $options->para = false;
807     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
809     // And now check for special cases
810     $patternTo = '#^\s*To\s([^:]+):(.*)#';
811     $special = false;
813     if (substr($text, 0, 5) == 'beep ') {
814         /// It's a beep!
815         $special = true;
816         $beepwho = trim(substr($text, 5));
818         if ($beepwho == 'all') {   // everyone
819             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
820             $outinfo = $message->strtime . ': ' . $outinfobasic;
821             $outmain = '';
823             $output->beep = true;  // (eventually this should be set to
824                                    //  to a filename uploaded by the user)
826         } else if ($beepwho == $currentuser->id) {  // current user
827             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
828             $outinfo = $message->strtime . ': ' . $outinfobasic;
829             $outmain = '';
830             $output->beep = true;
832         } else {  //something is not caught?
833             return false;
834         }
835     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
836         $special = true;
837         $pattern = '#(^\/)(\w+).*#';
838         preg_match($pattern, $text, $matches);
839         $command = isset($matches[2]) ? $matches[2] : false;
840         // Support some IRC commands.
841         switch ($command){
842             case 'me':
843                 $outinfo = $message->strtime;
844                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
845                 break;
846             default:
847                 // Error, we set special back to false to use the classic message output.
848                 $special = false;
849                 break;
850         }
851     } else if (preg_match($patternTo, $text)) {
852         $special = true;
853         $matches = array();
854         preg_match($patternTo, $text, $matches);
855         if (isset($matches[1]) && isset($matches[2])) {
856             $outinfo = $message->strtime;
857             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$matches[2];
858         } else {
859             // Error, we set special back to false to use the classic message output.
860             $special = false;
861         }
862     }
864     if(!$special) {
865         $outinfo = $message->strtime.' '.$sender->firstname;
866         $outmain = $text;
867     }
869     /// Format the message as a small table
871     $output->text  = strip_tags($outinfo.': '.$outmain);
873     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
874     $output->html .= "<span class=\"title\">$outinfo</span>";
875     if ($outmain) {
876         $output->html .= ": $outmain";
877         $output->basic = '<tr class="r0">
878                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
879                             <td class="cell c2 text">' . $outmain . '</td>
880                             <td class="cell c3">' . $message->strtime . '</td>
881                           </tr>';
882     } else {
883         $output->basic = '<tr class="r1">
884                             <th scope="row" class="cell c1 title"></th>
885                             <td class="cell c2 text">' . $outinfobasic . '</td>
886                             <td class="cell c3">' . $message->strtime . '</td>
887                           </tr>';
888     }
889     $output->html .= "</td></tr></table>";
890     return $output;
893 /**
894  * @global object
895  * @param object $message
896  * @param int $courseid
897  * @param object $currentuser
898  * @param string $chat_lastrow
899  * @return bool|string Returns HTML or false
900  */
901 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
902 /// Given a message object full of information, this function
903 /// formats it appropriately into text and html, then
904 /// returns the formatted data.
905     global $DB;
907     static $users;     // Cache user lookups
909     if (isset($users[$message->userid])) {
910         $user = $users[$message->userid];
911     } else if ($user = $DB->get_record('user', array('id'=>$message->userid), user_picture::fields())) {
912         $users[$message->userid] = $user;
913     } else {
914         return NULL;
915     }
916     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
919 /**
920  * @global object
921  * @param object $message message to be displayed.
922  * @param mixed $chatuser user chat data
923  * @param object $currentuser current user for whom the message should be displayed.
924  * @param int $groupingid course module grouping id
925  * @param string $theme name of the chat theme.
926  * @return bool|string Returns HTML or false
927  */
928 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
929     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
930     require_once($CFG->dirroot.'/mod/chat/locallib.php');
932     static $users;     // Cache user lookups
934     $result = new stdClass();
936     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
937         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
938     }
940     if (isset($users[$message->userid])) {
941         $sender = $users[$message->userid];
942     } else if ($sender = $DB->get_record('user', array('id'=>$message->userid), user_picture::fields())) {
943         $users[$message->userid] = $sender;
944     } else {
945         return NULL;
946     }
948     $USER->timezone = 99;
949     $tz = get_user_timezone($currentuser->timezone);
950     $USER->timezone = $tz;
952     if (empty($chatuser->course)) {
953         $courseid = $COURSE->id;
954     } else {
955         $courseid = $chatuser->course;
956     }
958     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
959     $message->picture = $OUTPUT->user_picture($sender, array('courseid'=>$courseid));
961     $message->picture = "<a target='_blank' href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
963     // Start processing the message
964     if(!empty($message->system)) {
965         $result->type = 'system';
967         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
968         $event = get_string('message'.$message->message, 'chat', fullname($sender));
969         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
971         $output = $PAGE->get_renderer('mod_chat');
972         $result->html = $output->render($eventmessage);
974         return $result;
975     }
977     // It's not a system event
978     $text = trim($message->message);
980     /// Parse the text to clean and filter it
981     $options = new stdClass();
982     $options->para = false;
983     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
985     // And now check for special cases
986     $special = false;
987     $outtime = $message->strtime;
989     // Initialise variables.
990     $outmain = '';
991     $patternTo = '#^\s*To\s([^:]+):(.*)#';
993     if (substr($text, 0, 5) == 'beep ') {
994         $special = true;
995         /// It's a beep!
996         $result->type = 'beep';
997         $beepwho = trim(substr($text, 5));
999         if ($beepwho == 'all') {   // everyone
1000             $outmain =  get_string('messagebeepseveryone', 'chat', fullname($sender));
1001         } else if ($beepwho == $currentuser->id) {  // current user
1002             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
1003         } else if ($sender->id == $currentuser->id) {  //something is not caught?
1004             //allow beep for a active chat user only, else user can beep anyone and get fullname
1005             if (!empty($chatuser) && is_numeric($beepwho)) {
1006                $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
1007                if (array_key_exists($beepwho, $chatusers)) {
1008                    $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
1009                } else {
1010                    $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1011                }
1012             } else {
1013                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1014             }
1015         }
1016     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
1017         $special = true;
1018         $result->type = 'command';
1019         $pattern = '#(^\/)(\w+).*#';
1020         preg_match($pattern, $text, $matches);
1021         $command = isset($matches[2]) ? $matches[2] : false;
1022         // Support some IRC commands.
1023         switch ($command){
1024             case 'me':
1025                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
1026                 break;
1027             default:
1028                 // Error, we set special back to false to use the classic message output.
1029                 $special = false;
1030                 break;
1031         }
1032     } else if (preg_match($patternTo, $text)) {
1033         $special = true;
1034         $result->type = 'dialogue';
1035         $matches = array();
1036         preg_match($patternTo, $text, $matches);
1037         if (isset($matches[1]) && isset($matches[2])) {
1038             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$matches[2];
1039         } else {
1040             // Error, we set special back to false to use the classic message output.
1041             $special = false;
1042         }
1043     }
1045     if (!$special) {
1046         $outmain = $text;
1047     }
1049     $result->text = strip_tags($outtime.': '.$outmain);
1051     $mymessageclass = '';
1052     if ($sender->id == $USER->id) {
1053         $mymessageclass = 'chat-message-mymessage';
1054     }
1056     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1057     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture, $mymessageclass, $outtime, $outmain, $theme);
1059     $output = $PAGE->get_renderer('mod_chat');
1060     $result->html = $output->render($usermessage);
1062     //When user beeps other user, then don't show any timestamp to other users in chat.
1063     if (('' === $outmain) && $special) {
1064         return false;
1065     } else {
1066         return $result;
1067     }
1070 /**
1071  * @global object $DB
1072  * @global object $CFG
1073  * @global object $COURSE
1074  * @global object $OUTPUT
1075  * @param object $users
1076  * @param object $course
1077  * @return array return formatted user list
1078  */
1079 function chat_format_userlist($users, $course) {
1080     global $CFG, $DB, $COURSE, $OUTPUT;
1081     $result = array();
1082     foreach($users as $user){
1083         $item = array();
1084         $item['name'] = fullname($user);
1085         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1086         $item['picture'] = $OUTPUT->user_picture($user);
1087         $item['id'] = $user->id;
1088         $result[] = $item;
1089     }
1090     return $result;
1093 /**
1094  * Print json format error
1095  * @param string $level
1096  * @param string $msg
1097  */
1098 function chat_print_error($level, $msg) {
1099     header('Content-Length: ' . ob_get_length() );
1100     $error = new stdClass();
1101     $error->level = $level;
1102     $error->msg   = $msg;
1103     $response['error'] = $error;
1104     echo json_encode($response);
1105     ob_end_flush();
1106     exit;
1109 /**
1110  * @return array
1111  */
1112 function chat_get_view_actions() {
1113     return array('view','view all','report');
1116 /**
1117  * @return array
1118  */
1119 function chat_get_post_actions() {
1120     return array('talk');
1123 /**
1124  * @global object
1125  * @global object
1126  * @param array $courses
1127  * @param array $htmlarray Passed by reference
1128  */
1129 function chat_print_overview($courses, &$htmlarray) {
1130     global $USER, $CFG;
1132     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1133         return array();
1134     }
1136     if (!$chats = get_all_instances_in_courses('chat',$courses)) {
1137         return;
1138     }
1140     $strchat = get_string('modulename', 'chat');
1141     $strnextsession  = get_string('nextsession', 'chat');
1143     foreach ($chats as $chat) {
1144         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled
1145             $str = '<div class="chat overview"><div class="name">'.
1146                    $strchat.': <a '.($chat->visible?'':' class="dimmed"').
1147                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1148                    $chat->name.'</a></div>';
1149             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1151             if (empty($htmlarray[$chat->course]['chat'])) {
1152                 $htmlarray[$chat->course]['chat'] = $str;
1153             } else {
1154                 $htmlarray[$chat->course]['chat'] .= $str;
1155             }
1156         }
1157     }
1161 /**
1162  * Implementation of the function for printing the form elements that control
1163  * whether the course reset functionality affects the chat.
1164  *
1165  * @param object $mform form passed by reference
1166  */
1167 function chat_reset_course_form_definition(&$mform) {
1168     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1169     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages','chat'));
1172 /**
1173  * Course reset form defaults.
1174  *
1175  * @param object $course
1176  * @return array
1177  */
1178 function chat_reset_course_form_defaults($course) {
1179     return array('reset_chat'=>1);
1182 /**
1183  * Actual implementation of the reset course functionality, delete all the
1184  * chat messages for course $data->courseid.
1185  *
1186  * @global object
1187  * @global object
1188  * @param object $data the data submitted from the reset course.
1189  * @return array status array
1190  */
1191 function chat_reset_userdata($data) {
1192     global $CFG, $DB;
1194     $componentstr = get_string('modulenameplural', 'chat');
1195     $status = array();
1197     if (!empty($data->reset_chat)) {
1198         $chatessql = "SELECT ch.id
1199                         FROM {chat} ch
1200                        WHERE ch.course=?";
1201         $params = array($data->courseid);
1203         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1204         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1205         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1206         $status[] = array('component'=>$componentstr, 'item'=>get_string('removemessages', 'chat'), 'error'=>false);
1207     }
1209     /// updating dates - shift may be negative too
1210     if ($data->timeshift) {
1211         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1212         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
1213     }
1215     return $status;
1218 /**
1219  * Returns all other caps used in module
1220  *
1221  * @return array
1222  */
1223 function chat_get_extra_capabilities() {
1224     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1228 /**
1229  * @param string $feature FEATURE_xx constant for requested feature
1230  * @return mixed True if module supports feature, null if doesn't know
1231  */
1232 function chat_supports($feature) {
1233     switch($feature) {
1234         case FEATURE_GROUPS:                  return true;
1235         case FEATURE_GROUPINGS:               return true;
1236         case FEATURE_GROUPMEMBERSONLY:        return true;
1237         case FEATURE_MOD_INTRO:               return true;
1238         case FEATURE_BACKUP_MOODLE2:          return true;
1239         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
1240         case FEATURE_GRADE_HAS_GRADE:         return false;
1241         case FEATURE_GRADE_OUTCOMES:          return true;
1242         case FEATURE_SHOW_DESCRIPTION:        return true;
1244         default: return null;
1245     }
1248 function chat_extend_navigation($navigation, $course, $module, $cm) {
1249     global $CFG;
1251     $currentgroup = groups_get_activity_group($cm, true);
1253     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1254         $strenterchat    = get_string('enterchat', 'chat');
1256         $target = $CFG->wwwroot.'/mod/chat/';
1257         $params = array('id'=>$cm->instance);
1259         if ($currentgroup) {
1260             $params['groupid'] = $currentgroup;
1261         }
1263         $links = array();
1265         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1266         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup, array('height' => 500, 'width' => 700));
1267         $links[] = new action_link($url, $strenterchat, $action);
1269         $url = new moodle_url($target.'gui_basic/index.php', $params);
1270         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup, array('height' => 500, 'width' => 700));
1271         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1273         foreach ($links as $link) {
1274             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null ,null, new pix_icon('i/group' , ''));
1275         }
1276     }
1278     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1279     if (is_array($chatusers) && count($chatusers)>0) {
1280         $users = $navigation->add(get_string('currentusers', 'chat'));
1281         foreach ($chatusers as $chatuser) {
1282             $userlink = new moodle_url('/user/view.php', array('id'=>$chatuser->id,'course'=>$course->id));
1283             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping), $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1284         }
1285     }
1288 /**
1289  * Adds module specific settings to the settings block
1290  *
1291  * @param settings_navigation $settings The settings navigation object
1292  * @param navigation_node $chatnode The node to add module settings to
1293  */
1294 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1295     global $DB, $PAGE, $USER;
1296     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1298     if ($chat->chattime && $chat->schedule) {
1299         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').': '.userdate($chat->chattime).' ('.usertimezone($USER->timezone));
1300         $nextsessionnode->add_class('note');
1301     }
1303     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1304     if ($currentgroup) {
1305         $groupselect = " AND groupid = '$currentgroup'";
1306     } else {
1307         $groupselect = '';
1308     }
1310     if ($chat->studentlogs || has_capability('mod/chat:readlog',$PAGE->cm->context)) {
1311         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1312             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id'=>$PAGE->cm->id)));
1313         }
1314     }
1317 /**
1318  * user logout event handler
1319  *
1320  * @param \core\event\user_loggedout $event The event.
1321  * @return void
1322  */
1323 function chat_user_logout(\core\event\user_loggedout $event) {
1324     global $DB;
1325     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1328 /**
1329  * Return a list of page types
1330  * @param string $pagetype current page type
1331  * @param stdClass $parentcontext Block's parent context
1332  * @param stdClass $currentcontext Current context of block
1333  */
1334 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1335     $module_pagetype = array('mod-chat-*'=>get_string('page-mod-chat-x', 'chat'));
1336     return $module_pagetype;