3c5d57a37f859371d9fca7d7ec561f74bd408404
[moodle.git] / mod / chat / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library of functions and constants for module chat
19  *
20  * @package   mod_chat
21  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot.'/calendar/lib.php');
27 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output.
28 global $CHAT_HTMLHEAD;
29 $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);
31 // The HTML head for the message window to start with (with js scrolling).
32 global $CHAT_HTMLHEAD_JS;
33 $CHAT_HTMLHEAD_JS = <<<EOD
34 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
35 <html><head><script type="text/javascript">
36 //<![CDATA[
37 function move() {
38     if (scroll_active)
39         window.scroll(1,400000);
40     window.setTimeout("move()",100);
41 }
42 var scroll_active = true;
43 move();
44 //]]>
45 </script>
46 </head>
47 <body onBlur="scroll_active = true" onFocus="scroll_active = false">
48 EOD;
49 global $CHAT_HTMLHEAD_JS;
50 $CHAT_HTMLHEAD_JS .= padding(200);
52 // The HTML code for standard empty pages (e.g. if a user was kicked out).
53 global $CHAT_HTMLHEAD_OUT;
54 $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>";
56 // The HTML head for the message input page.
57 global $CHAT_HTMLHEAD_MSGINPUT;
58 $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>";
60 // The HTML code for the message input page, with JavaScript.
61 global $CHAT_HTMLHEAD_MSGINPUT_JS;
62 $CHAT_HTMLHEAD_MSGINPUT_JS = <<<EOD
63 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
64 <html>
65     <head><title>Message Input</title>
66     <script type="text/javascript">
67     //<![CDATA[
68     scroll_active = true;
69     function empty_field_and_submit() {
70         document.fdummy.arsc_message.value=document.f.arsc_message.value;
71         document.fdummy.submit();
72         document.f.arsc_message.focus();
73         document.f.arsc_message.select();
74         return false;
75     }
76     //]]>
77     </script>
78     </head><body OnLoad="document.f.arsc_message.focus();document.f.arsc_message.select();">;
79 EOD;
81 // Dummy data that gets output to the browser as needed, in order to make it show output.
82 global $CHAT_DUMMY_DATA;
83 $CHAT_DUMMY_DATA = padding(200);
85 /**
86  * @param int $n
87  * @return string
88  */
89 function padding($n) {
90     $str = '';
91     for ($i = 0; $i < $n; $i++) {
92         $str .= "<!-- nix -->\n";
93     }
94     return $str;
95 }
97 /**
98  * Given an object containing all the necessary data,
99  * (defined by the form in mod_form.php) this function
100  * will create a new instance and return the id number
101  * of the new instance.
102  *
103  * @global object
104  * @param object $chat
105  * @return int
106  */
107 function chat_add_instance($chat) {
108     global $DB;
110     $chat->timemodified = time();
112     $returnid = $DB->insert_record("chat", $chat);
114     $event = new stdClass();
115     $event->name        = $chat->name;
116     $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
117     $event->courseid    = $chat->course;
118     $event->groupid     = 0;
119     $event->userid      = 0;
120     $event->modulename  = 'chat';
121     $event->instance    = $returnid;
122     $event->eventtype   = 'chattime';
123     $event->timestart   = $chat->chattime;
124     $event->timeduration = 0;
126     calendar_event::create($event);
128     return $returnid;
131 /**
132  * Given an object containing all the necessary data,
133  * (defined by the form in mod_form.php) this function
134  * will update an existing instance with new data.
135  *
136  * @global object
137  * @param object $chat
138  * @return bool
139  */
140 function chat_update_instance($chat) {
141     global $DB;
143     $chat->timemodified = time();
144     $chat->id = $chat->instance;
146     $DB->update_record("chat", $chat);
148     $event = new stdClass();
150     if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
152         $event->name        = $chat->name;
153         $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
154         $event->timestart   = $chat->chattime;
156         $calendarevent = calendar_event::load($event->id);
157         $calendarevent->update($event);
158     }
160     return true;
163 /**
164  * Given an ID of an instance of this module,
165  * this function will permanently delete the instance
166  * and any data that depends on it.
167  *
168  * @global object
169  * @param int $id
170  * @return bool
171  */
172 function chat_delete_instance($id) {
173     global $DB;
175     if (! $chat = $DB->get_record('chat', array('id' => $id))) {
176         return false;
177     }
179     $result = true;
181     // Delete any dependent records here.
183     if (! $DB->delete_records('chat', array('id' => $chat->id))) {
184         $result = false;
185     }
186     if (! $DB->delete_records('chat_messages', array('chatid' => $chat->id))) {
187         $result = false;
188     }
189     if (! $DB->delete_records('chat_messages_current', array('chatid' => $chat->id))) {
190         $result = false;
191     }
192     if (! $DB->delete_records('chat_users', array('chatid' => $chat->id))) {
193         $result = false;
194     }
196     if (! $DB->delete_records('event', array('modulename' => 'chat', 'instance' => $chat->id))) {
197         $result = false;
198     }
200     return $result;
203 /**
204  * Given a course and a date, prints a summary of all chat rooms past and present
205  * This function is called from block_recent_activity
206  *
207  * @global object
208  * @global object
209  * @global object
210  * @param object $course
211  * @param bool $viewfullnames
212  * @param int|string $timestart Timestamp
213  * @return bool
214  */
215 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
216     global $CFG, $USER, $DB, $OUTPUT;
218     // This is approximate only, but it is really fast.
219     $timeout = $CFG->chat_old_ping * 10;
221     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
222                                          FROM {course_modules} cm
223                                          JOIN {modules} md        ON md.id = cm.module
224                                          JOIN {chat} ch           ON ch.id = cm.instance
225                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
226                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
227                                      GROUP BY cm.id
228                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
229          return false;
230     }
232     $past     = array();
233     $current  = array();
234     $modinfo = get_fast_modinfo($course); // Reference needed because we might load the groups.
236     foreach ($mcms as $cmid => $mcm) {
237         if (!array_key_exists($cmid, $modinfo->cms)) {
238             continue;
239         }
240         $cm = $modinfo->cms[$cmid];
241         if (!$modinfo->cms[$cm->id]->uservisible) {
242             continue;
243         }
245         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
246          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
247             if ($timeout > time() - $mcm->lasttime) {
248                 $current[] = $cm;
249             } else {
250                 $past[] = $cm;
251             }
253             continue;
254         }
256         // Verify groups in separate mode.
257         if (!$mygroupids = $modinfo->get_groups($cm->groupingid)) {
258             continue;
259         }
261         // Ok, last post was not for my group - we have to query db to get last message from one of my groups.
262         // The only minor problem is that the order will not be correct.
263         $mygroupids = implode(',', $mygroupids);
265         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
266                                            FROM {course_modules} cm
267                                            JOIN {chat} ch           ON ch.id = cm.instance
268                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
269                                           WHERE chm.timestamp > ? AND cm.id = ? AND
270                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
271                                        GROUP BY cm.id", array($timestart, $cm->id))) {
272              continue;
273         }
275         $mcms[$cmid]->lasttime = $mcm->lasttime;
276         if ($timeout > time() - $mcm->lasttime) {
277             $current[] = $cm;
278         } else {
279             $past[] = $cm;
280         }
281     }
283     if (!$past and !$current) {
284         return false;
285     }
287     $strftimerecent = get_string('strftimerecent');
289     if ($past) {
290         echo $OUTPUT->heading(get_string("pastchats", 'chat').':', 3);
292         foreach ($past as $cm) {
293             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
294             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
295             echo '<div class="head"><div class="date">'.$date.'</div></div>';
296             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
297         }
298     }
300     if ($current) {
301         echo $OUTPUT->heading(get_string("currentchats", 'chat').':', 3);
303         $oldest = floor((time() - $CFG->chat_old_ping) / 10) * 10;  // Better db caching.
305         $timeold    = time() - $CFG->chat_old_ping;
306         $timeold    = floor($timeold / 10) * 10;  // Better db caching.
307         $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
308         $timeoldext = floor($timeoldext / 10) * 10;  // Better db caching.
310         $params = array('timeold' => $timeold, 'timeoldext' => $timeoldext, 'cmid' => $cm->id);
312         $timeout = "AND ((chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext))";
314         foreach ($current as $cm) {
315             // Count users first.
316             $mygroupids = $modinfo->groups[$cm->groupingid];
317             if (!empty($mygroupids)) {
318                 list($subquery, $subparams) = $DB->get_in_or_equal($mygroupids, SQL_PARAMS_NAMED, 'gid');
319                 $params += $subparams;
320                 $groupselect = "AND (chu.groupid $subquery OR chu.groupid = 0)";
321             } else {
322                 $groupselect = "";
323             }
325             $userfields = user_picture::fields('u');
326             if (!$users = $DB->get_records_sql("SELECT $userfields
327                                                   FROM {course_modules} cm
328                                                   JOIN {chat} ch        ON ch.id = cm.instance
329                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
330                                                   JOIN {user} u         ON u.id = chu.userid
331                                                  WHERE cm.id = :cmid $timeout $groupselect
332                                               GROUP BY $userfields", $params)) {
333             }
335             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
336             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
338             echo '<div class="head"><div class="date">'.$date.'</div></div>';
339             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
340             echo '<div class="userlist">';
341             if ($users) {
342                 echo '<ul>';
343                 foreach ($users as $user) {
344                     echo '<li>'.fullname($user, $viewfullnames).'</li>';
345                 }
346                 echo '</ul>';
347             }
348             echo '</div>';
349         }
350     }
352     return true;
355 /**
356  * Function to be run periodically according to the moodle cron
357  * This function searches for things that need to be done, such
358  * as sending out mail, toggling flags etc ...
359  *
360  * @global object
361  * @return bool
362  */
363 function chat_cron () {
364     global $DB;
366     chat_update_chat_times();
368     chat_delete_old_users();
370     // Delete old messages with a single SQL query.
371     $subselect = "SELECT c.keepdays
372                     FROM {chat} c
373                    WHERE c.id = {chat_messages}.chatid";
375     $sql = "DELETE
376               FROM {chat_messages}
377              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
379     $DB->execute($sql);
381     $sql = "DELETE
382               FROM {chat_messages_current}
383              WHERE timestamp < ( ".time()." - 8 * 3600)";
385     $DB->execute($sql);
387     return true;
390 /**
391  * This standard function will check all instances of this module
392  * and make sure there are up-to-date events created for each of them.
393  * If courseid = 0, then every chat event in the site is checked, else
394  * only chat events belonging to the course specified are checked.
395  * This function is used, in its new format, by restore_refresh_events()
396  *
397  * @global object
398  * @param int $courseid
399  * @return bool
400  */
401 function chat_refresh_events($courseid = 0) {
402     global $DB;
404     if ($courseid) {
405         if (! $chats = $DB->get_records("chat", array("course" => $courseid))) {
406             return true;
407         }
408     } else {
409         if (! $chats = $DB->get_records("chat")) {
410             return true;
411         }
412     }
413     $moduleid = $DB->get_field('modules', 'id', array('name' => 'chat'));
415     foreach ($chats as $chat) {
416         $cm = get_coursemodule_from_instance('chat', $chat->id, $chat->course);
417         $event = new stdClass();
418         $event->name        = $chat->name;
419         $event->description = format_module_intro('chat', $chat, $cm->id);
420         $event->timestart   = $chat->chattime;
422         if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
423             $calendarevent = calendar_event::load($event->id);
424             $calendarevent->update($event);
425         } else {
426             $event->courseid    = $chat->course;
427             $event->groupid     = 0;
428             $event->userid      = 0;
429             $event->modulename  = 'chat';
430             $event->instance    = $chat->id;
431             $event->eventtype   = 'chattime';
432             $event->timeduration = 0;
433             $event->visible = $DB->get_field('course_modules', 'visible', array('module' => $moduleid, 'instance' => $chat->id));
435             calendar_event::create($event);
436         }
437     }
438     return true;
441 // Functions that require some SQL.
443 /**
444  * @global object
445  * @param int $chatid
446  * @param int $groupid
447  * @param int $groupingid
448  * @return array
449  */
450 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
451     global $DB;
453     $params = array('chatid' => $chatid, 'groupid' => $groupid, 'groupingid' => $groupingid);
455     if ($groupid) {
456         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
457     } else {
458         $groupselect = "";
459     }
461     if (!empty($groupingid)) {
462         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
463                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
465     } else {
466         $groupingjoin = '';
467     }
469     $ufields = user_picture::fields('u');
470     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
471                                    FROM {chat_users} c
472                                    JOIN {user} u ON u.id = c.userid $groupingjoin
473                                   WHERE c.chatid = :chatid $groupselect
474                                ORDER BY c.firstping ASC", $params);
477 /**
478  * @global object
479  * @param int $chatid
480  * @param int $groupid
481  * @return array
482  */
483 function chat_get_latest_message($chatid, $groupid=0) {
484     global $DB;
486     $params = array('chatid' => $chatid, 'groupid' => $groupid);
488     if ($groupid) {
489         $groupselect = "AND (groupid=:groupid OR groupid=0)";
490     } else {
491         $groupselect = "";
492     }
494     $sql = "SELECT *
495         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
496         ORDER BY timestamp DESC";
498     // Return the lastest one message.
499     return $DB->get_record_sql($sql, $params, true);
502 /**
503  * login if not already logged in
504  *
505  * @global object
506  * @global object
507  * @param int $chatid
508  * @param string $version
509  * @param int $groupid
510  * @param object $course
511  * @return bool|int Returns the chat users sid or false
512  */
513 function chat_login_user($chatid, $version, $groupid, $course) {
514     global $USER, $DB;
516     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid' => $chatid,
517                                                                                     'userid' => $USER->id,
518                                                                                     'groupid' => $groupid))) {
519         // This will update logged user information.
520         $chatuser->version  = $version;
521         $chatuser->ip       = $USER->lastip;
522         $chatuser->lastping = time();
523         $chatuser->lang     = current_language();
525         // Sometimes $USER->lastip is not setup properly during login.
526         // Update with current value if possible or provide a dummy value for the db.
527         if (empty($chatuser->ip)) {
528             $chatuser->ip = getremoteaddr();
529         }
531         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
532             return false;
533         }
534         $DB->update_record('chat_users', $chatuser);
536     } else {
537         $chatuser = new stdClass();
538         $chatuser->chatid   = $chatid;
539         $chatuser->userid   = $USER->id;
540         $chatuser->groupid  = $groupid;
541         $chatuser->version  = $version;
542         $chatuser->ip       = $USER->lastip;
543         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
544         $chatuser->sid      = random_string(32);
545         $chatuser->course   = $course->id; // Caching - needed for current_language too.
546         $chatuser->lang     = current_language(); // Caching - to resource intensive to find out later.
548         // Sometimes $USER->lastip is not setup properly during login.
549         // Update with current value if possible or provide a dummy value for the db.
550         if (empty($chatuser->ip)) {
551             $chatuser->ip = getremoteaddr();
552         }
554         $DB->insert_record('chat_users', $chatuser);
556         if ($version == 'sockets') {
557             // Do not send 'enter' message, chatd will do it.
558         } else {
559             chat_send_chatmessage($chatuser, 'enter', true);
560         }
561     }
563     return $chatuser->sid;
566 /**
567  * Delete the old and in the way
568  *
569  * @global object
570  * @global object
571  */
572 function chat_delete_old_users() {
573     // Delete the old and in the way.
574     global $CFG, $DB;
576     $timeold = time() - $CFG->chat_old_ping;
577     $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
579     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
580     $params = array($timeold, $timeoldext);
582     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
583         $DB->delete_records_select('chat_users', $query, $params);
584         foreach ($oldusers as $olduser) {
585             chat_send_chatmessage($olduser, 'exit', true);
586         }
587     }
590 /**
591  * Updates chat records so that the next chat time is correct
592  *
593  * @global object
594  * @param int $chatid
595  * @return void
596  */
597 function chat_update_chat_times($chatid=0) {
598     // Updates chat records so that the next chat time is correct.
599     global $DB;
601     $timenow = time();
603     $params = array('timenow' => $timenow, 'chatid' => $chatid);
605     if ($chatid) {
606         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
607             return;
608         }
609     } else {
610         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
611             return;
612         }
613     }
615     foreach ($chats as $chat) {
616         switch ($chat->schedule) {
617             case 1: // Single event - turn off schedule and disable.
618                 $chat->chattime = 0;
619                 $chat->schedule = 0;
620                 break;
621             case 2: // Repeat daily.
622                 while ($chat->chattime <= $timenow) {
623                     $chat->chattime += 24 * 3600;
624                 }
625                 break;
626             case 3: // Repeat weekly.
627                 while ($chat->chattime <= $timenow) {
628                     $chat->chattime += 7 * 24 * 3600;
629                 }
630                 break;
631         }
632         $DB->update_record("chat", $chat);
634         $event = new stdClass(); // Update calendar too.
636         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
637         $params = array('chattime' => $chat->chattime, 'chatid' => $chat->id);
639         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
640             $event->timestart   = $chat->chattime;
641             $calendarevent = calendar_event::load($event->id);
642             $calendarevent->update($event, false);
643         }
644     }
647 /**
648  * Send a message on the chat.
649  *
650  * @param object $chatuser The chat user record.
651  * @param string $messagetext The message to be sent.
652  * @param bool $system False for non-system messages, true for system messages.
653  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
654  * @return int The message ID.
655  * @since Moodle 2.6
656  */
657 function chat_send_chatmessage($chatuser, $messagetext, $system = false, $cm = null) {
658     global $DB;
660     $message = new stdClass();
661     $message->chatid    = $chatuser->chatid;
662     $message->userid    = $chatuser->userid;
663     $message->groupid   = $chatuser->groupid;
664     $message->message   = $messagetext;
665     $message->system    = $system ? 1 : 0;
666     $message->timestamp = time();
668     $messageid = $DB->insert_record('chat_messages', $message);
669     $DB->insert_record('chat_messages_current', $message);
670     $message->id = $messageid;
672     if (!$system) {
674         if (empty($cm)) {
675             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
676         }
678         $params = array(
679             'context' => context_module::instance($cm->id),
680             'objectid' => $message->id,
681             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
682             'relateduserid' => $chatuser->userid
683         );
684         $event = \mod_chat\event\message_sent::create($params);
685         $event->add_record_snapshot('chat_messages', $message);
686         $event->trigger();
687     }
689     return $message->id;
692 /**
693  * @global object
694  * @global object
695  * @param object $message
696  * @param int $courseid
697  * @param object $sender
698  * @param object $currentuser
699  * @param string $chatlastrow
700  * @return bool|string Returns HTML or false
701  */
702 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chatlastrow = null) {
703     global $CFG, $USER, $OUTPUT;
705     $output = new stdClass();
706     $output->beep = false;       // By default.
707     $output->refreshusers = false; // By default.
709     // Find the correct timezone for displaying this message.
710     $tz = core_date::get_user_timezone($currentuser);
712     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
714     $message->picture = $OUTPUT->user_picture($sender, array('size' => false, 'courseid' => $courseid, 'link' => false));
716     if ($courseid) {
717         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\"".
718                             " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
719     }
721     // Calculate the row class.
722     if ($chatlastrow !== null) {
723         $rowclass = ' class="r'.$chatlastrow.'" ';
724     } else {
725         $rowclass = '';
726     }
728     // Start processing the message.
730     if (!empty($message->system)) {
731         // System event.
732         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
733         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td>';
734         $output->html .= '<td class="text"><span class="event">'.$output->text.'</span></td></tr></table>';
735         $output->basic = '<tr class="r1">
736                             <th scope="row" class="cell c1 title"></th>
737                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
738                             <td class="cell c3">' . $message->strtime . '</td>
739                           </tr>';
740         if ($message->message == 'exit' or $message->message == 'enter') {
741             $output->refreshusers = true; // Force user panel refresh ASAP.
742         }
743         return $output;
744     }
746     // It's not a system event.
747     $text = trim($message->message);
749     // Parse the text to clean and filter it.
750     $options = new stdClass();
751     $options->para = false;
752     $options->blanktarget = true;
753     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
755     // And now check for special cases.
756     $patternto = '#^\s*To\s([^:]+):(.*)#';
757     $special = false;
759     if (substr($text, 0, 5) == 'beep ') {
760         // It's a beep!
761         $special = true;
762         $beepwho = trim(substr($text, 5));
764         if ($beepwho == 'all') {   // Everyone.
765             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
766             $outinfo = $message->strtime . ': ' . $outinfobasic;
767             $outmain = '';
769             $output->beep = true;  // Eventually this should be set to a filename uploaded by the user.
771         } else if ($beepwho == $currentuser->id) {  // Current user.
772             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
773             $outinfo = $message->strtime . ': ' . $outinfobasic;
774             $outmain = '';
775             $output->beep = true;
777         } else {  // Something is not caught?
778             return false;
779         }
780     } else if (substr($text, 0, 1) == '/') {     // It's a user command.
781         $special = true;
782         $pattern = '#(^\/)(\w+).*#';
783         preg_match($pattern, $text, $matches);
784         $command = isset($matches[2]) ? $matches[2] : false;
785         // Support some IRC commands.
786         switch ($command) {
787             case 'me':
788                 $outinfo = $message->strtime;
789                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
790                 break;
791             default:
792                 // Error, we set special back to false to use the classic message output.
793                 $special = false;
794                 break;
795         }
796     } else if (preg_match($patternto, $text)) {
797         $special = true;
798         $matches = array();
799         preg_match($patternto, $text, $matches);
800         if (isset($matches[1]) && isset($matches[2])) {
801             $outinfo = $message->strtime;
802             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$matches[2];
803         } else {
804             // Error, we set special back to false to use the classic message output.
805             $special = false;
806         }
807     }
809     if (!$special) {
810         $outinfo = $message->strtime.' '.$sender->firstname;
811         $outmain = $text;
812     }
814     // Format the message as a small table.
816     $output->text  = strip_tags($outinfo.': '.$outmain);
818     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td>";
819     $output->html .= "<td class=\"text\"><span class=\"title\">$outinfo</span>";
820     if ($outmain) {
821         $output->html .= ": $outmain";
822         $output->basic = '<tr class="r0">
823                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
824                             <td class="cell c2 text">' . $outmain . '</td>
825                             <td class="cell c3">' . $message->strtime . '</td>
826                           </tr>';
827     } else {
828         $output->basic = '<tr class="r1">
829                             <th scope="row" class="cell c1 title"></th>
830                             <td class="cell c2 text">' . $outinfobasic . '</td>
831                             <td class="cell c3">' . $message->strtime . '</td>
832                           </tr>';
833     }
834     $output->html .= "</td></tr></table>";
835     return $output;
838 /**
839  * Given a message object this function formats it appropriately into text and html then returns the formatted data
840  * @global object
841  * @param object $message
842  * @param int $courseid
843  * @param object $currentuser
844  * @param string $chatlastrow
845  * @return bool|string Returns HTML or false
846  */
847 function chat_format_message($message, $courseid, $currentuser, $chatlastrow=null) {
848     global $DB;
850     static $users;     // Cache user lookups.
852     if (isset($users[$message->userid])) {
853         $user = $users[$message->userid];
854     } else if ($user = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
855         $users[$message->userid] = $user;
856     } else {
857         return null;
858     }
859     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chatlastrow);
862 /**
863  * @global object
864  * @param object $message message to be displayed.
865  * @param mixed $chatuser user chat data
866  * @param object $currentuser current user for whom the message should be displayed.
867  * @param int $groupingid course module grouping id
868  * @param string $theme name of the chat theme.
869  * @return bool|string Returns HTML or false
870  */
871 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
872     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
873     require_once($CFG->dirroot.'/mod/chat/locallib.php');
875     static $users;     // Cache user lookups.
877     $result = new stdClass();
879     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
880         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
881     }
883     if (isset($users[$message->userid])) {
884         $sender = $users[$message->userid];
885     } else if ($sender = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
886         $users[$message->userid] = $sender;
887     } else {
888         return null;
889     }
891     // Find the correct timezone for displaying this message.
892     $tz = core_date::get_user_timezone($currentuser);
894     if (empty($chatuser->course)) {
895         $courseid = $COURSE->id;
896     } else {
897         $courseid = $chatuser->course;
898     }
900     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
901     $message->picture = $OUTPUT->user_picture($sender, array('courseid' => $courseid));
903     $message->picture = "<a target='_blank'".
904                         " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
906     // Start processing the message.
907     if (!empty($message->system)) {
908         $result->type = 'system';
910         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
911         $event = get_string('message'.$message->message, 'chat', fullname($sender));
912         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
914         $output = $PAGE->get_renderer('mod_chat');
915         $result->html = $output->render($eventmessage);
917         return $result;
918     }
920     // It's not a system event.
921     $text = trim($message->message);
923     // Parse the text to clean and filter it.
924     $options = new stdClass();
925     $options->para = false;
926     $options->blanktarget = true;
927     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
929     // And now check for special cases.
930     $special = false;
931     $outtime = $message->strtime;
933     // Initialise variables.
934     $outmain = '';
935     $patternto = '#^\s*To\s([^:]+):(.*)#';
937     if (substr($text, 0, 5) == 'beep ') {
938         $special = true;
939         // It's a beep!
940         $result->type = 'beep';
941         $beepwho = trim(substr($text, 5));
943         if ($beepwho == 'all') {   // Everyone.
944             $outmain = get_string('messagebeepseveryone', 'chat', fullname($sender));
945         } else if ($beepwho == $currentuser->id) {  // Current user.
946             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
947         } else if ($sender->id == $currentuser->id) {  // Something is not caught?
948             // Allow beep for a active chat user only, else user can beep anyone and get fullname.
949             if (!empty($chatuser) && is_numeric($beepwho)) {
950                 $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
951                 if (array_key_exists($beepwho, $chatusers)) {
952                     $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
953                 } else {
954                     $outmain = get_string('messageyoubeep', 'chat', $beepwho);
955                 }
956             } else {
957                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
958             }
959         }
960     } else if (substr($text, 0, 1) == '/') {     // It's a user command.
961         $special = true;
962         $result->type = 'command';
963         $pattern = '#(^\/)(\w+).*#';
964         preg_match($pattern, $text, $matches);
965         $command = isset($matches[2]) ? $matches[2] : false;
966         // Support some IRC commands.
967         switch ($command) {
968             case 'me':
969                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
970                 break;
971             default:
972                 // Error, we set special back to false to use the classic message output.
973                 $special = false;
974                 break;
975         }
976     } else if (preg_match($patternto, $text)) {
977         $special = true;
978         $result->type = 'dialogue';
979         $matches = array();
980         preg_match($patternto, $text, $matches);
981         if (isset($matches[1]) && isset($matches[2])) {
982             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$matches[2];
983         } else {
984             // Error, we set special back to false to use the classic message output.
985             $special = false;
986         }
987     }
989     if (!$special) {
990         $outmain = $text;
991     }
993     $result->text = strip_tags($outtime.': '.$outmain);
995     $mymessageclass = '';
996     if ($sender->id == $USER->id) {
997         $mymessageclass = 'chat-message-mymessage';
998     }
1000     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1001     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture,
1002                                     $mymessageclass, $outtime, $outmain, $theme);
1004     $output = $PAGE->get_renderer('mod_chat');
1005     $result->html = $output->render($usermessage);
1007     // When user beeps other user, then don't show any timestamp to other users in chat.
1008     if (('' === $outmain) && $special) {
1009         return false;
1010     } else {
1011         return $result;
1012     }
1015 /**
1016  * @global object $DB
1017  * @global object $CFG
1018  * @global object $COURSE
1019  * @global object $OUTPUT
1020  * @param object $users
1021  * @param object $course
1022  * @return array return formatted user list
1023  */
1024 function chat_format_userlist($users, $course) {
1025     global $CFG, $DB, $COURSE, $OUTPUT;
1026     $result = array();
1027     foreach ($users as $user) {
1028         $item = array();
1029         $item['name'] = fullname($user);
1030         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1031         $item['picture'] = $OUTPUT->user_picture($user);
1032         $item['id'] = $user->id;
1033         $result[] = $item;
1034     }
1035     return $result;
1038 /**
1039  * Print json format error
1040  * @param string $level
1041  * @param string $msg
1042  */
1043 function chat_print_error($level, $msg) {
1044     header('Content-Length: ' . ob_get_length() );
1045     $error = new stdClass();
1046     $error->level = $level;
1047     $error->msg   = $msg;
1048     $response['error'] = $error;
1049     echo json_encode($response);
1050     ob_end_flush();
1051     exit;
1054 /**
1055  * List the actions that correspond to a view of this module.
1056  * This is used by the participation report.
1057  *
1058  * Note: This is not used by new logging system. Event with
1059  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1060  *       be considered as view action.
1061  *
1062  * @return array
1063  */
1064 function chat_get_view_actions() {
1065     return array('view', 'view all', 'report');
1068 /**
1069  * List the actions that correspond to a post of this module.
1070  * This is used by the participation report.
1071  *
1072  * Note: This is not used by new logging system. Event with
1073  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1074  *       will be considered as post action.
1075  *
1076  * @return array
1077  */
1078 function chat_get_post_actions() {
1079     return array('talk');
1082 /**
1083  * @global object
1084  * @global object
1085  * @param array $courses
1086  * @param array $htmlarray Passed by reference
1087  */
1088 function chat_print_overview($courses, &$htmlarray) {
1089     global $USER, $CFG;
1091     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1092         return array();
1093     }
1095     if (!$chats = get_all_instances_in_courses('chat', $courses)) {
1096         return;
1097     }
1099     $strchat = get_string('modulename', 'chat');
1100     $strnextsession  = get_string('nextsession', 'chat');
1102     foreach ($chats as $chat) {
1103         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled.
1104             $str = '<div class="chat overview"><div class="name">'.
1105                    $strchat.': <a '.($chat->visible ? '' : ' class="dimmed"').
1106                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1107                    $chat->name.'</a></div>';
1108             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1110             if (empty($htmlarray[$chat->course]['chat'])) {
1111                 $htmlarray[$chat->course]['chat'] = $str;
1112             } else {
1113                 $htmlarray[$chat->course]['chat'] .= $str;
1114             }
1115         }
1116     }
1120 /**
1121  * Implementation of the function for printing the form elements that control
1122  * whether the course reset functionality affects the chat.
1123  *
1124  * @param object $mform form passed by reference
1125  */
1126 function chat_reset_course_form_definition(&$mform) {
1127     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1128     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages', 'chat'));
1131 /**
1132  * Course reset form defaults.
1133  *
1134  * @param object $course
1135  * @return array
1136  */
1137 function chat_reset_course_form_defaults($course) {
1138     return array('reset_chat' => 1);
1141 /**
1142  * Actual implementation of the reset course functionality, delete all the
1143  * chat messages for course $data->courseid.
1144  *
1145  * @global object
1146  * @global object
1147  * @param object $data the data submitted from the reset course.
1148  * @return array status array
1149  */
1150 function chat_reset_userdata($data) {
1151     global $CFG, $DB;
1153     $componentstr = get_string('modulenameplural', 'chat');
1154     $status = array();
1156     if (!empty($data->reset_chat)) {
1157         $chatessql = "SELECT ch.id
1158                         FROM {chat} ch
1159                        WHERE ch.course=?";
1160         $params = array($data->courseid);
1162         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1163         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1164         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1165         $status[] = array('component' => $componentstr, 'item' => get_string('removemessages', 'chat'), 'error' => false);
1166     }
1168     // Updating dates - shift may be negative too.
1169     if ($data->timeshift) {
1170         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1171         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => false);
1172     }
1174     return $status;
1177 /**
1178  * Returns all other caps used in module
1179  *
1180  * @return array
1181  */
1182 function chat_get_extra_capabilities() {
1183     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1187 /**
1188  * @param string $feature FEATURE_xx constant for requested feature
1189  * @return mixed True if module supports feature, null if doesn't know
1190  */
1191 function chat_supports($feature) {
1192     switch($feature) {
1193         case FEATURE_GROUPS:
1194             return true;
1195         case FEATURE_GROUPINGS:
1196             return true;
1197         case FEATURE_MOD_INTRO:
1198             return true;
1199         case FEATURE_BACKUP_MOODLE2:
1200             return true;
1201         case FEATURE_COMPLETION_TRACKS_VIEWS:
1202             return true;
1203         case FEATURE_GRADE_HAS_GRADE:
1204             return false;
1205         case FEATURE_GRADE_OUTCOMES:
1206             return true;
1207         case FEATURE_SHOW_DESCRIPTION:
1208             return true;
1209         default:
1210             return null;
1211     }
1214 function chat_extend_navigation($navigation, $course, $module, $cm) {
1215     global $CFG;
1217     $currentgroup = groups_get_activity_group($cm, true);
1219     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1220         $strenterchat    = get_string('enterchat', 'chat');
1222         $target = $CFG->wwwroot.'/mod/chat/';
1223         $params = array('id' => $cm->instance);
1225         if ($currentgroup) {
1226             $params['groupid'] = $currentgroup;
1227         }
1229         $links = array();
1231         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1232         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1233                                    array('height' => 500, 'width' => 700));
1234         $links[] = new action_link($url, $strenterchat, $action);
1236         $url = new moodle_url($target.'gui_basic/index.php', $params);
1237         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1238                                    array('height' => 500, 'width' => 700));
1239         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1241         foreach ($links as $link) {
1242             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null , null, new pix_icon('i/group' , ''));
1243         }
1244     }
1246     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1247     if (is_array($chatusers) && count($chatusers) > 0) {
1248         $users = $navigation->add(get_string('currentusers', 'chat'));
1249         foreach ($chatusers as $chatuser) {
1250             $userlink = new moodle_url('/user/view.php', array('id' => $chatuser->id, 'course' => $course->id));
1251             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping),
1252                         $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1253         }
1254     }
1257 /**
1258  * Adds module specific settings to the settings block
1259  *
1260  * @param settings_navigation $settings The settings navigation object
1261  * @param navigation_node $chatnode The node to add module settings to
1262  */
1263 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1264     global $DB, $PAGE, $USER;
1265     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1267     if ($chat->chattime && $chat->schedule) {
1268         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').
1269                                           ': '.userdate($chat->chattime).
1270                                           ' ('.usertimezone($USER->timezone).')');
1271         $nextsessionnode->add_class('note');
1272     }
1274     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1275     if ($currentgroup) {
1276         $groupselect = " AND groupid = '$currentgroup'";
1277     } else {
1278         $groupselect = '';
1279     }
1281     if ($chat->studentlogs || has_capability('mod/chat:readlog', $PAGE->cm->context)) {
1282         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1283             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id' => $PAGE->cm->id)));
1284         }
1285     }
1288 /**
1289  * user logout event handler
1290  *
1291  * @param \core\event\user_loggedout $event The event.
1292  * @return void
1293  */
1294 function chat_user_logout(\core\event\user_loggedout $event) {
1295     global $DB;
1296     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1299 /**
1300  * Return a list of page types
1301  * @param string $pagetype current page type
1302  * @param stdClass $parentcontext Block's parent context
1303  * @param stdClass $currentcontext Current context of block
1304  */
1305 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1306     $modulepagetype = array('mod-chat-*' => get_string('page-mod-chat-x', 'chat'));
1307     return $modulepagetype;
1310 /**
1311  * Return a list of the latest messages in the given chat session.
1312  *
1313  * @param  stdClass $chatuser     chat user session data
1314  * @param  int      $chatlasttime last time messages were retrieved
1315  * @return array    list of messages
1316  * @since  Moodle 3.0
1317  */
1318 function chat_get_latest_messages($chatuser, $chatlasttime) {
1319     global $DB;
1321     $params = array('groupid' => $chatuser->groupid, 'chatid' => $chatuser->chatid, 'lasttime' => $chatlasttime);
1323     $groupselect = $chatuser->groupid ? " AND (groupid=" . $chatuser->groupid . " OR groupid=0) " : "";
1325     return $DB->get_records_select('chat_messages_current', 'chatid = :chatid AND timestamp > :lasttime ' . $groupselect,
1326                                     $params, 'timestamp ASC');
1329 /**
1330  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1331  *
1332  * @param  stdClass $chat       chat object
1333  * @param  stdClass $course     course object
1334  * @param  stdClass $cm         course module object
1335  * @param  stdClass $context    context object
1336  * @since Moodle 3.0
1337  */
1338 function chat_view($chat, $course, $cm, $context) {
1340     // Trigger course_module_viewed event.
1341     $params = array(
1342         'context' => $context,
1343         'objectid' => $chat->id
1344     );
1346     $event = \mod_chat\event\course_module_viewed::create($params);
1347     $event->add_record_snapshot('course_modules', $cm);
1348     $event->add_record_snapshot('course', $course);
1349     $event->add_record_snapshot('chat', $chat);
1350     $event->trigger();
1352     // Completion.
1353     $completion = new completion_info($course);
1354     $completion->set_module_viewed($cm);