76c8205af74078eaaa9ab5665080d329bf851e3c
[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 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot.'/calendar/lib.php');
29 // Event types.
30 define('CHAT_EVENT_TYPE_CHATTIME', 'chattime');
32 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output.
33 global $CHAT_HTMLHEAD;
34 $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);
36 // The HTML head for the message window to start with (with js scrolling).
37 global $CHAT_HTMLHEAD_JS;
38 $CHAT_HTMLHEAD_JS = <<<EOD
39 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
40 <html><head><script type="text/javascript">
41 //<![CDATA[
42 function move() {
43     if (scroll_active)
44         window.scroll(1,400000);
45     window.setTimeout("move()",100);
46 }
47 var scroll_active = true;
48 move();
49 //]]>
50 </script>
51 </head>
52 <body onBlur="scroll_active = true" onFocus="scroll_active = false">
53 EOD;
54 global $CHAT_HTMLHEAD_JS;
55 $CHAT_HTMLHEAD_JS .= padding(200);
57 // The HTML code for standard empty pages (e.g. if a user was kicked out).
58 global $CHAT_HTMLHEAD_OUT;
59 $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>";
61 // The HTML head for the message input page.
62 global $CHAT_HTMLHEAD_MSGINPUT;
63 $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>";
65 // The HTML code for the message input page, with JavaScript.
66 global $CHAT_HTMLHEAD_MSGINPUT_JS;
67 $CHAT_HTMLHEAD_MSGINPUT_JS = <<<EOD
68 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
69 <html>
70     <head><title>Message Input</title>
71     <script type="text/javascript">
72     //<![CDATA[
73     scroll_active = true;
74     function empty_field_and_submit() {
75         document.fdummy.arsc_message.value=document.f.arsc_message.value;
76         document.fdummy.submit();
77         document.f.arsc_message.focus();
78         document.f.arsc_message.select();
79         return false;
80     }
81     //]]>
82     </script>
83     </head><body OnLoad="document.f.arsc_message.focus();document.f.arsc_message.select();">;
84 EOD;
86 // Dummy data that gets output to the browser as needed, in order to make it show output.
87 global $CHAT_DUMMY_DATA;
88 $CHAT_DUMMY_DATA = padding(200);
90 /**
91  * @param int $n
92  * @return string
93  */
94 function padding($n) {
95     $str = '';
96     for ($i = 0; $i < $n; $i++) {
97         $str .= "<!-- nix -->\n";
98     }
99     return $str;
102 /**
103  * Given an object containing all the necessary data,
104  * (defined by the form in mod_form.php) this function
105  * will create a new instance and return the id number
106  * of the new instance.
107  *
108  * @global object
109  * @param object $chat
110  * @return int
111  */
112 function chat_add_instance($chat) {
113     global $DB;
115     $chat->timemodified = time();
117     $returnid = $DB->insert_record("chat", $chat);
119     if ($chat->schedule > 0) {
120         $event = new stdClass();
121         $event->type        = CALENDAR_EVENT_TYPE_ACTION;
122         $event->name        = $chat->name;
123         $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
124         $event->courseid    = $chat->course;
125         $event->groupid     = 0;
126         $event->userid      = 0;
127         $event->modulename  = 'chat';
128         $event->instance    = $returnid;
129         $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
130         $event->timestart   = $chat->chattime;
131         $event->timesort    = $chat->chattime;
132         $event->timeduration = 0;
134         calendar_event::create($event);
135     }
136     return $returnid;
139 /**
140  * Given an object containing all the necessary data,
141  * (defined by the form in mod_form.php) this function
142  * will update an existing instance with new data.
143  *
144  * @global object
145  * @param object $chat
146  * @return bool
147  */
148 function chat_update_instance($chat) {
149     global $DB;
151     $chat->timemodified = time();
152     $chat->id = $chat->instance;
154     $DB->update_record("chat", $chat);
156     $event = new stdClass();
158     if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
160         if ($chat->schedule > 0) {
161             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
162             $event->name        = $chat->name;
163             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
164             $event->timestart   = $chat->chattime;
165             $event->timesort    = $chat->chattime;
167             $calendarevent = calendar_event::load($event->id);
168             $calendarevent->update($event);
169         } else {
170             // Do not publish this event, so delete it.
171             $calendarevent = calendar_event::load($event->id);
172             $calendarevent->delete();
173         }
174     } else {
175         // No event, do we need to create one?
176         if ($chat->schedule > 0) {
177             $event = new stdClass();
178             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
179             $event->name        = $chat->name;
180             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
181             $event->courseid    = $chat->course;
182             $event->groupid     = 0;
183             $event->userid      = 0;
184             $event->modulename  = 'chat';
185             $event->instance    = $chat->id;
186             $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
187             $event->timestart   = $chat->chattime;
188             $event->timesort    = $chat->chattime;
189             $event->timeduration = 0;
191             calendar_event::create($event);
192         }
193     }
195     return true;
198 /**
199  * Given an ID of an instance of this module,
200  * this function will permanently delete the instance
201  * and any data that depends on it.
202  *
203  * @global object
204  * @param int $id
205  * @return bool
206  */
207 function chat_delete_instance($id) {
208     global $DB;
210     if (! $chat = $DB->get_record('chat', array('id' => $id))) {
211         return false;
212     }
214     $result = true;
216     // Delete any dependent records here.
218     if (! $DB->delete_records('chat', array('id' => $chat->id))) {
219         $result = false;
220     }
221     if (! $DB->delete_records('chat_messages', array('chatid' => $chat->id))) {
222         $result = false;
223     }
224     if (! $DB->delete_records('chat_messages_current', array('chatid' => $chat->id))) {
225         $result = false;
226     }
227     if (! $DB->delete_records('chat_users', array('chatid' => $chat->id))) {
228         $result = false;
229     }
231     if (! $DB->delete_records('event', array('modulename' => 'chat', 'instance' => $chat->id))) {
232         $result = false;
233     }
235     return $result;
238 /**
239  * Given a course and a date, prints a summary of all chat rooms past and present
240  * This function is called from block_recent_activity
241  *
242  * @global object
243  * @global object
244  * @global object
245  * @param object $course
246  * @param bool $viewfullnames
247  * @param int|string $timestart Timestamp
248  * @return bool
249  */
250 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
251     global $CFG, $USER, $DB, $OUTPUT;
253     // This is approximate only, but it is really fast.
254     $timeout = $CFG->chat_old_ping * 10;
256     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
257                                          FROM {course_modules} cm
258                                          JOIN {modules} md        ON md.id = cm.module
259                                          JOIN {chat} ch           ON ch.id = cm.instance
260                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
261                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
262                                      GROUP BY cm.id
263                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
264          return false;
265     }
267     $past     = array();
268     $current  = array();
269     $modinfo = get_fast_modinfo($course); // Reference needed because we might load the groups.
271     foreach ($mcms as $cmid => $mcm) {
272         if (!array_key_exists($cmid, $modinfo->cms)) {
273             continue;
274         }
275         $cm = $modinfo->cms[$cmid];
276         if (!$modinfo->cms[$cm->id]->uservisible) {
277             continue;
278         }
280         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
281          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
282             if ($timeout > time() - $mcm->lasttime) {
283                 $current[] = $cm;
284             } else {
285                 $past[] = $cm;
286             }
288             continue;
289         }
291         // Verify groups in separate mode.
292         if (!$mygroupids = $modinfo->get_groups($cm->groupingid)) {
293             continue;
294         }
296         // Ok, last post was not for my group - we have to query db to get last message from one of my groups.
297         // The only minor problem is that the order will not be correct.
298         $mygroupids = implode(',', $mygroupids);
300         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
301                                            FROM {course_modules} cm
302                                            JOIN {chat} ch           ON ch.id = cm.instance
303                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
304                                           WHERE chm.timestamp > ? AND cm.id = ? AND
305                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
306                                        GROUP BY cm.id", array($timestart, $cm->id))) {
307              continue;
308         }
310         $mcms[$cmid]->lasttime = $mcm->lasttime;
311         if ($timeout > time() - $mcm->lasttime) {
312             $current[] = $cm;
313         } else {
314             $past[] = $cm;
315         }
316     }
318     if (!$past and !$current) {
319         return false;
320     }
322     $strftimerecent = get_string('strftimerecent');
324     if ($past) {
325         echo $OUTPUT->heading(get_string("pastchats", 'chat').':', 3);
327         foreach ($past as $cm) {
328             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
329             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
330             echo '<div class="head"><div class="date">'.$date.'</div></div>';
331             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
332         }
333     }
335     if ($current) {
336         echo $OUTPUT->heading(get_string("currentchats", 'chat').':', 3);
338         $oldest = floor((time() - $CFG->chat_old_ping) / 10) * 10;  // Better db caching.
340         $timeold    = time() - $CFG->chat_old_ping;
341         $timeold    = floor($timeold / 10) * 10;  // Better db caching.
342         $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
343         $timeoldext = floor($timeoldext / 10) * 10;  // Better db caching.
345         $params = array('timeold' => $timeold, 'timeoldext' => $timeoldext, 'cmid' => $cm->id);
347         $timeout = "AND ((chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext))";
349         foreach ($current as $cm) {
350             // Count users first.
351             $mygroupids = $modinfo->groups[$cm->groupingid];
352             if (!empty($mygroupids)) {
353                 list($subquery, $subparams) = $DB->get_in_or_equal($mygroupids, SQL_PARAMS_NAMED, 'gid');
354                 $params += $subparams;
355                 $groupselect = "AND (chu.groupid $subquery OR chu.groupid = 0)";
356             } else {
357                 $groupselect = "";
358             }
360             $userfields = user_picture::fields('u');
361             if (!$users = $DB->get_records_sql("SELECT $userfields
362                                                   FROM {course_modules} cm
363                                                   JOIN {chat} ch        ON ch.id = cm.instance
364                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
365                                                   JOIN {user} u         ON u.id = chu.userid
366                                                  WHERE cm.id = :cmid $timeout $groupselect
367                                               GROUP BY $userfields", $params)) {
368             }
370             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
371             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
373             echo '<div class="head"><div class="date">'.$date.'</div></div>';
374             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
375             echo '<div class="userlist">';
376             if ($users) {
377                 echo '<ul>';
378                 foreach ($users as $user) {
379                     echo '<li>'.fullname($user, $viewfullnames).'</li>';
380                 }
381                 echo '</ul>';
382             }
383             echo '</div>';
384         }
385     }
387     return true;
390 /**
391  * Function to be run periodically according to the moodle cron
392  * This function searches for things that need to be done, such
393  * as sending out mail, toggling flags etc ...
394  *
395  * @global object
396  * @return bool
397  */
398 function chat_cron () {
399     global $DB;
401     chat_update_chat_times();
403     chat_delete_old_users();
405     // Delete old messages with a single SQL query.
406     $subselect = "SELECT c.keepdays
407                     FROM {chat} c
408                    WHERE c.id = {chat_messages}.chatid";
410     $sql = "DELETE
411               FROM {chat_messages}
412              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
414     $DB->execute($sql);
416     $sql = "DELETE
417               FROM {chat_messages_current}
418              WHERE timestamp < ( ".time()." - 8 * 3600)";
420     $DB->execute($sql);
422     return true;
425 /**
426  * This standard function will check all instances of this module
427  * and make sure there are up-to-date events created for each of them.
428  * If courseid = 0, then every chat event in the site is checked, else
429  * only chat events belonging to the course specified are checked.
430  * This function is used, in its new format, by restore_refresh_events()
431  *
432  * @global object
433  * @param int $courseid
434  * @return bool
435  */
436 function chat_refresh_events($courseid = 0) {
437     global $DB;
439     if ($courseid) {
440         if (! $chats = $DB->get_records("chat", array("course" => $courseid))) {
441             return true;
442         }
443     } else {
444         if (! $chats = $DB->get_records("chat")) {
445             return true;
446         }
447     }
448     $moduleid = $DB->get_field('modules', 'id', array('name' => 'chat'));
450     foreach ($chats as $chat) {
451         $cm = get_coursemodule_from_instance('chat', $chat->id, $chat->course);
452         $event = new stdClass();
453         $event->name        = $chat->name;
454         $event->type        = CALENDAR_EVENT_TYPE_ACTION;
455         $event->description = format_module_intro('chat', $chat, $cm->id);
456         $event->timestart   = $chat->chattime;
457         $event->timesort    = $chat->chattime;
459         if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
460             $calendarevent = calendar_event::load($event->id);
461             $calendarevent->update($event);
462         } else if ($chat->schedule > 0) {
463             // The chat is scheduled and the event should be published.
464             $event->courseid    = $chat->course;
465             $event->groupid     = 0;
466             $event->userid      = 0;
467             $event->modulename  = 'chat';
468             $event->instance    = $chat->id;
469             $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
470             $event->timeduration = 0;
471             $event->visible = $DB->get_field('course_modules', 'visible', array('module' => $moduleid, 'instance' => $chat->id));
473             calendar_event::create($event);
474         }
475     }
476     return true;
479 // Functions that require some SQL.
481 /**
482  * @global object
483  * @param int $chatid
484  * @param int $groupid
485  * @param int $groupingid
486  * @return array
487  */
488 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
489     global $DB;
491     $params = array('chatid' => $chatid, 'groupid' => $groupid, 'groupingid' => $groupingid);
493     if ($groupid) {
494         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
495     } else {
496         $groupselect = "";
497     }
499     if (!empty($groupingid)) {
500         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
501                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
503     } else {
504         $groupingjoin = '';
505     }
507     $ufields = user_picture::fields('u');
508     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
509                                    FROM {chat_users} c
510                                    JOIN {user} u ON u.id = c.userid $groupingjoin
511                                   WHERE c.chatid = :chatid $groupselect
512                                ORDER BY c.firstping ASC", $params);
515 /**
516  * @global object
517  * @param int $chatid
518  * @param int $groupid
519  * @return array
520  */
521 function chat_get_latest_message($chatid, $groupid=0) {
522     global $DB;
524     $params = array('chatid' => $chatid, 'groupid' => $groupid);
526     if ($groupid) {
527         $groupselect = "AND (groupid=:groupid OR groupid=0)";
528     } else {
529         $groupselect = "";
530     }
532     $sql = "SELECT *
533         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
534         ORDER BY timestamp DESC";
536     // Return the lastest one message.
537     return $DB->get_record_sql($sql, $params, true);
540 /**
541  * login if not already logged in
542  *
543  * @global object
544  * @global object
545  * @param int $chatid
546  * @param string $version
547  * @param int $groupid
548  * @param object $course
549  * @return bool|int Returns the chat users sid or false
550  */
551 function chat_login_user($chatid, $version, $groupid, $course) {
552     global $USER, $DB;
554     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid' => $chatid,
555                                                                                     'userid' => $USER->id,
556                                                                                     'groupid' => $groupid))) {
557         // This will update logged user information.
558         $chatuser->version  = $version;
559         $chatuser->ip       = $USER->lastip;
560         $chatuser->lastping = time();
561         $chatuser->lang     = current_language();
563         // Sometimes $USER->lastip is not setup properly during login.
564         // Update with current value if possible or provide a dummy value for the db.
565         if (empty($chatuser->ip)) {
566             $chatuser->ip = getremoteaddr();
567         }
569         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
570             return false;
571         }
572         $DB->update_record('chat_users', $chatuser);
574     } else {
575         $chatuser = new stdClass();
576         $chatuser->chatid   = $chatid;
577         $chatuser->userid   = $USER->id;
578         $chatuser->groupid  = $groupid;
579         $chatuser->version  = $version;
580         $chatuser->ip       = $USER->lastip;
581         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
582         $chatuser->sid      = random_string(32);
583         $chatuser->course   = $course->id; // Caching - needed for current_language too.
584         $chatuser->lang     = current_language(); // Caching - to resource intensive to find out later.
586         // Sometimes $USER->lastip is not setup properly during login.
587         // Update with current value if possible or provide a dummy value for the db.
588         if (empty($chatuser->ip)) {
589             $chatuser->ip = getremoteaddr();
590         }
592         $DB->insert_record('chat_users', $chatuser);
594         if ($version == 'sockets') {
595             // Do not send 'enter' message, chatd will do it.
596         } else {
597             chat_send_chatmessage($chatuser, 'enter', true);
598         }
599     }
601     return $chatuser->sid;
604 /**
605  * Delete the old and in the way
606  *
607  * @global object
608  * @global object
609  */
610 function chat_delete_old_users() {
611     // Delete the old and in the way.
612     global $CFG, $DB;
614     $timeold = time() - $CFG->chat_old_ping;
615     $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
617     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
618     $params = array($timeold, $timeoldext);
620     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
621         $DB->delete_records_select('chat_users', $query, $params);
622         foreach ($oldusers as $olduser) {
623             chat_send_chatmessage($olduser, 'exit', true);
624         }
625     }
628 /**
629  * Updates chat records so that the next chat time is correct
630  *
631  * @global object
632  * @param int $chatid
633  * @return void
634  */
635 function chat_update_chat_times($chatid=0) {
636     // Updates chat records so that the next chat time is correct.
637     global $DB;
639     $timenow = time();
641     $params = array('timenow' => $timenow, 'chatid' => $chatid);
643     if ($chatid) {
644         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
645             return;
646         }
647     } else {
648         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
649             return;
650         }
651     }
653     foreach ($chats as $chat) {
654         switch ($chat->schedule) {
655             case 1: // Single event - turn off schedule and disable.
656                 $chat->chattime = 0;
657                 $chat->schedule = 0;
658                 break;
659             case 2: // Repeat daily.
660                 while ($chat->chattime <= $timenow) {
661                     $chat->chattime += 24 * 3600;
662                 }
663                 break;
664             case 3: // Repeat weekly.
665                 while ($chat->chattime <= $timenow) {
666                     $chat->chattime += 7 * 24 * 3600;
667                 }
668                 break;
669         }
670         $DB->update_record("chat", $chat);
672         $event = new stdClass(); // Update calendar too.
674         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
675         $params = array('chattime' => $chat->chattime, 'chatid' => $chat->id);
677         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
678             $event->timestart = $chat->chattime;
679             $event->timesort = $chat->chattime;
680             $calendarevent = calendar_event::load($event->id);
681             $calendarevent->update($event, false);
682         }
683     }
686 /**
687  * Send a message on the chat.
688  *
689  * @param object $chatuser The chat user record.
690  * @param string $messagetext The message to be sent.
691  * @param bool $system False for non-system messages, true for system messages.
692  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
693  * @return int The message ID.
694  * @since Moodle 2.6
695  */
696 function chat_send_chatmessage($chatuser, $messagetext, $system = false, $cm = null) {
697     global $DB;
699     $message = new stdClass();
700     $message->chatid    = $chatuser->chatid;
701     $message->userid    = $chatuser->userid;
702     $message->groupid   = $chatuser->groupid;
703     $message->message   = $messagetext;
704     $message->system    = $system ? 1 : 0;
705     $message->timestamp = time();
707     $messageid = $DB->insert_record('chat_messages', $message);
708     $DB->insert_record('chat_messages_current', $message);
709     $message->id = $messageid;
711     if (!$system) {
713         if (empty($cm)) {
714             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
715         }
717         $params = array(
718             'context' => context_module::instance($cm->id),
719             'objectid' => $message->id,
720             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
721             'relateduserid' => $chatuser->userid
722         );
723         $event = \mod_chat\event\message_sent::create($params);
724         $event->add_record_snapshot('chat_messages', $message);
725         $event->trigger();
726     }
728     return $message->id;
731 /**
732  * @global object
733  * @global object
734  * @param object $message
735  * @param int $courseid
736  * @param object $sender
737  * @param object $currentuser
738  * @param string $chatlastrow
739  * @return bool|string Returns HTML or false
740  */
741 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chatlastrow = null) {
742     global $CFG, $USER, $OUTPUT;
744     $output = new stdClass();
745     $output->beep = false;       // By default.
746     $output->refreshusers = false; // By default.
748     // Find the correct timezone for displaying this message.
749     $tz = core_date::get_user_timezone($currentuser);
751     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
753     $message->picture = $OUTPUT->user_picture($sender, array('size' => false, 'courseid' => $courseid, 'link' => false));
755     if ($courseid) {
756         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\"".
757                             " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
758     }
760     // Calculate the row class.
761     if ($chatlastrow !== null) {
762         $rowclass = ' class="r'.$chatlastrow.'" ';
763     } else {
764         $rowclass = '';
765     }
767     // Start processing the message.
769     if (!empty($message->system)) {
770         // System event.
771         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
772         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td>';
773         $output->html .= '<td class="text"><span class="event">'.$output->text.'</span></td></tr></table>';
774         $output->basic = '<tr class="r1">
775                             <th scope="row" class="cell c1 title"></th>
776                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
777                             <td class="cell c3">' . $message->strtime . '</td>
778                           </tr>';
779         if ($message->message == 'exit' or $message->message == 'enter') {
780             $output->refreshusers = true; // Force user panel refresh ASAP.
781         }
782         return $output;
783     }
785     // It's not a system event.
786     $rawtext = trim($message->message);
788     // Options for format_text, when we get to it...
789     // format_text call will parse the text to clean and filter it.
790     // It cannot be called here as HTML-isation interferes with special case
791     // recognition, but *must* be called on any user-sourced text to be inserted
792     // into $outmain.
793     $options = new stdClass();
794     $options->para = false;
795     $options->blanktarget = true;
797     // And now check for special cases.
798     $patternto = '#^\s*To\s([^:]+):(.*)#';
799     $special = false;
801     if (substr($rawtext, 0, 5) == 'beep ') {
802         // It's a beep!
803         $special = true;
804         $beepwho = trim(substr($rawtext, 5));
806         if ($beepwho == 'all') {   // Everyone.
807             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
808             $outinfo = $message->strtime . ': ' . $outinfobasic;
809             $outmain = '';
811             $output->beep = true;  // Eventually this should be set to a filename uploaded by the user.
813         } else if ($beepwho == $currentuser->id) {  // Current user.
814             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
815             $outinfo = $message->strtime . ': ' . $outinfobasic;
816             $outmain = '';
817             $output->beep = true;
819         } else {  // Something is not caught?
820             return false;
821         }
822     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
823         $special = true;
824         $pattern = '#(^\/)(\w+).*#';
825         preg_match($pattern, $rawtext, $matches);
826         $command = isset($matches[2]) ? $matches[2] : false;
827         // Support some IRC commands.
828         switch ($command) {
829             case 'me':
830                 $outinfo = $message->strtime;
831                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
832                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
833                 break;
834             default:
835                 // Error, we set special back to false to use the classic message output.
836                 $special = false;
837                 break;
838         }
839     } else if (preg_match($patternto, $rawtext)) {
840         $special = true;
841         $matches = array();
842         preg_match($patternto, $rawtext, $matches);
843         if (isset($matches[1]) && isset($matches[2])) {
844             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
845             $outinfo = $message->strtime;
846             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$text;
847         } else {
848             // Error, we set special back to false to use the classic message output.
849             $special = false;
850         }
851     }
853     if (!$special) {
854         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
855         $outinfo = $message->strtime.' '.$sender->firstname;
856         $outmain = $text;
857     }
859     // Format the message as a small table.
861     $output->text  = strip_tags($outinfo.': '.$outmain);
863     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td>";
864     $output->html .= "<td class=\"text\"><span class=\"title\">$outinfo</span>";
865     if ($outmain) {
866         $output->html .= ": $outmain";
867         $output->basic = '<tr class="r0">
868                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
869                             <td class="cell c2 text">' . $outmain . '</td>
870                             <td class="cell c3">' . $message->strtime . '</td>
871                           </tr>';
872     } else {
873         $output->basic = '<tr class="r1">
874                             <th scope="row" class="cell c1 title"></th>
875                             <td class="cell c2 text">' . $outinfobasic . '</td>
876                             <td class="cell c3">' . $message->strtime . '</td>
877                           </tr>';
878     }
879     $output->html .= "</td></tr></table>";
880     return $output;
883 /**
884  * Given a message object this function formats it appropriately into text and html then returns the formatted data
885  * @global object
886  * @param object $message
887  * @param int $courseid
888  * @param object $currentuser
889  * @param string $chatlastrow
890  * @return bool|string Returns HTML or false
891  */
892 function chat_format_message($message, $courseid, $currentuser, $chatlastrow=null) {
893     global $DB;
895     static $users;     // Cache user lookups.
897     if (isset($users[$message->userid])) {
898         $user = $users[$message->userid];
899     } else if ($user = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
900         $users[$message->userid] = $user;
901     } else {
902         return null;
903     }
904     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chatlastrow);
907 /**
908  * @global object
909  * @param object $message message to be displayed.
910  * @param mixed $chatuser user chat data
911  * @param object $currentuser current user for whom the message should be displayed.
912  * @param int $groupingid course module grouping id
913  * @param string $theme name of the chat theme.
914  * @return bool|string Returns HTML or false
915  */
916 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
917     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
918     require_once($CFG->dirroot.'/mod/chat/locallib.php');
920     static $users;     // Cache user lookups.
922     $result = new stdClass();
924     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
925         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
926     }
928     if (isset($users[$message->userid])) {
929         $sender = $users[$message->userid];
930     } else if ($sender = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
931         $users[$message->userid] = $sender;
932     } else {
933         return null;
934     }
936     // Find the correct timezone for displaying this message.
937     $tz = core_date::get_user_timezone($currentuser);
939     if (empty($chatuser->course)) {
940         $courseid = $COURSE->id;
941     } else {
942         $courseid = $chatuser->course;
943     }
945     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
946     $message->picture = $OUTPUT->user_picture($sender, array('courseid' => $courseid));
948     $message->picture = "<a target='_blank'".
949                         " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
951     // Start processing the message.
952     if (!empty($message->system)) {
953         $result->type = 'system';
955         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
956         $event = get_string('message'.$message->message, 'chat', fullname($sender));
957         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
959         $output = $PAGE->get_renderer('mod_chat');
960         $result->html = $output->render($eventmessage);
962         return $result;
963     }
965     // It's not a system event.
966     $rawtext = trim($message->message);
968     // Options for format_text, when we get to it...
969     // format_text call will parse the text to clean and filter it.
970     // It cannot be called here as HTML-isation interferes with special case
971     // recognition, but *must* be called on any user-sourced text to be inserted
972     // into $outmain.
973     $options = new stdClass();
974     $options->para = false;
975     $options->blanktarget = true;
977     // And now check for special cases.
978     $special = false;
979     $outtime = $message->strtime;
981     // Initialise variables.
982     $outmain = '';
983     $patternto = '#^\s*To\s([^:]+):(.*)#';
985     if (substr($rawtext, 0, 5) == 'beep ') {
986         $special = true;
987         // It's a beep!
988         $result->type = 'beep';
989         $beepwho = trim(substr($rawtext, 5));
991         if ($beepwho == 'all') {   // Everyone.
992             $outmain = get_string('messagebeepseveryone', 'chat', fullname($sender));
993         } else if ($beepwho == $currentuser->id) {  // Current user.
994             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
995         } else if ($sender->id == $currentuser->id) {  // Something is not caught?
996             // Allow beep for a active chat user only, else user can beep anyone and get fullname.
997             if (!empty($chatuser) && is_numeric($beepwho)) {
998                 $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
999                 if (array_key_exists($beepwho, $chatusers)) {
1000                     $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
1001                 } else {
1002                     $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1003                 }
1004             } else {
1005                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1006             }
1007         }
1008     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
1009         $special = true;
1010         $result->type = 'command';
1011         $pattern = '#(^\/)(\w+).*#';
1012         preg_match($pattern, $rawtext, $matches);
1013         $command = isset($matches[2]) ? $matches[2] : false;
1014         // Support some IRC commands.
1015         switch ($command) {
1016             case 'me':
1017                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
1018                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
1019                 break;
1020             default:
1021                 // Error, we set special back to false to use the classic message output.
1022                 $special = false;
1023                 break;
1024         }
1025     } else if (preg_match($patternto, $rawtext)) {
1026         $special = true;
1027         $result->type = 'dialogue';
1028         $matches = array();
1029         preg_match($patternto, $rawtext, $matches);
1030         if (isset($matches[1]) && isset($matches[2])) {
1031             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
1032             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$text;
1033         } else {
1034             // Error, we set special back to false to use the classic message output.
1035             $special = false;
1036         }
1037     }
1039     if (!$special) {
1040         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
1041         $outmain = $text;
1042     }
1044     $result->text = strip_tags($outtime.': '.$outmain);
1046     $mymessageclass = '';
1047     if ($sender->id == $USER->id) {
1048         $mymessageclass = 'chat-message-mymessage';
1049     }
1051     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1052     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture,
1053                                     $mymessageclass, $outtime, $outmain, $theme);
1055     $output = $PAGE->get_renderer('mod_chat');
1056     $result->html = $output->render($usermessage);
1058     // When user beeps other user, then don't show any timestamp to other users in chat.
1059     if (('' === $outmain) && $special) {
1060         return false;
1061     } else {
1062         return $result;
1063     }
1066 /**
1067  * @global object $DB
1068  * @global object $CFG
1069  * @global object $COURSE
1070  * @global object $OUTPUT
1071  * @param object $users
1072  * @param object $course
1073  * @return array return formatted user list
1074  */
1075 function chat_format_userlist($users, $course) {
1076     global $CFG, $DB, $COURSE, $OUTPUT;
1077     $result = array();
1078     foreach ($users as $user) {
1079         $item = array();
1080         $item['name'] = fullname($user);
1081         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1082         $item['picture'] = $OUTPUT->user_picture($user);
1083         $item['id'] = $user->id;
1084         $result[] = $item;
1085     }
1086     return $result;
1089 /**
1090  * Print json format error
1091  * @param string $level
1092  * @param string $msg
1093  */
1094 function chat_print_error($level, $msg) {
1095     header('Content-Length: ' . ob_get_length() );
1096     $error = new stdClass();
1097     $error->level = $level;
1098     $error->msg   = $msg;
1099     $response['error'] = $error;
1100     echo json_encode($response);
1101     ob_end_flush();
1102     exit;
1105 /**
1106  * List the actions that correspond to a view of this module.
1107  * This is used by the participation report.
1108  *
1109  * Note: This is not used by new logging system. Event with
1110  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1111  *       be considered as view action.
1112  *
1113  * @return array
1114  */
1115 function chat_get_view_actions() {
1116     return array('view', 'view all', 'report');
1119 /**
1120  * List the actions that correspond to a post of this module.
1121  * This is used by the participation report.
1122  *
1123  * Note: This is not used by new logging system. Event with
1124  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1125  *       will be considered as post action.
1126  *
1127  * @return array
1128  */
1129 function chat_get_post_actions() {
1130     return array('talk');
1133 /**
1134  * @deprecated since 3.3
1135  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1136  * @global object
1137  * @global object
1138  * @param array $courses
1139  * @param array $htmlarray Passed by reference
1140  */
1141 function chat_print_overview($courses, &$htmlarray) {
1142     global $USER, $CFG;
1144     debugging('The function chat_print_overview() is now deprecated.', DEBUG_DEVELOPER);
1146     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1147         return array();
1148     }
1150     if (!$chats = get_all_instances_in_courses('chat', $courses)) {
1151         return;
1152     }
1154     $strchat = get_string('modulename', 'chat');
1155     $strnextsession  = get_string('nextsession', 'chat');
1157     foreach ($chats as $chat) {
1158         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled.
1159             $str = '<div class="chat overview"><div class="name">'.
1160                    $strchat.': <a '.($chat->visible ? '' : ' class="dimmed"').
1161                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1162                    $chat->name.'</a></div>';
1163             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1165             if (empty($htmlarray[$chat->course]['chat'])) {
1166                 $htmlarray[$chat->course]['chat'] = $str;
1167             } else {
1168                 $htmlarray[$chat->course]['chat'] .= $str;
1169             }
1170         }
1171     }
1175 /**
1176  * Implementation of the function for printing the form elements that control
1177  * whether the course reset functionality affects the chat.
1178  *
1179  * @param object $mform form passed by reference
1180  */
1181 function chat_reset_course_form_definition(&$mform) {
1182     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1183     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages', 'chat'));
1186 /**
1187  * Course reset form defaults.
1188  *
1189  * @param object $course
1190  * @return array
1191  */
1192 function chat_reset_course_form_defaults($course) {
1193     return array('reset_chat' => 1);
1196 /**
1197  * Actual implementation of the reset course functionality, delete all the
1198  * chat messages for course $data->courseid.
1199  *
1200  * @global object
1201  * @global object
1202  * @param object $data the data submitted from the reset course.
1203  * @return array status array
1204  */
1205 function chat_reset_userdata($data) {
1206     global $CFG, $DB;
1208     $componentstr = get_string('modulenameplural', 'chat');
1209     $status = array();
1211     if (!empty($data->reset_chat)) {
1212         $chatessql = "SELECT ch.id
1213                         FROM {chat} ch
1214                        WHERE ch.course=?";
1215         $params = array($data->courseid);
1217         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1218         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1219         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1220         $status[] = array('component' => $componentstr, 'item' => get_string('removemessages', 'chat'), 'error' => false);
1221     }
1223     // Updating dates - shift may be negative too.
1224     if ($data->timeshift) {
1225         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1226         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => false);
1227     }
1229     return $status;
1232 /**
1233  * Returns all other caps used in module
1234  *
1235  * @return array
1236  */
1237 function chat_get_extra_capabilities() {
1238     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1242 /**
1243  * @param string $feature FEATURE_xx constant for requested feature
1244  * @return mixed True if module supports feature, null if doesn't know
1245  */
1246 function chat_supports($feature) {
1247     switch($feature) {
1248         case FEATURE_GROUPS:
1249             return true;
1250         case FEATURE_GROUPINGS:
1251             return true;
1252         case FEATURE_MOD_INTRO:
1253             return true;
1254         case FEATURE_BACKUP_MOODLE2:
1255             return true;
1256         case FEATURE_COMPLETION_TRACKS_VIEWS:
1257             return true;
1258         case FEATURE_GRADE_HAS_GRADE:
1259             return false;
1260         case FEATURE_GRADE_OUTCOMES:
1261             return true;
1262         case FEATURE_SHOW_DESCRIPTION:
1263             return true;
1264         default:
1265             return null;
1266     }
1269 function chat_extend_navigation($navigation, $course, $module, $cm) {
1270     global $CFG;
1272     $currentgroup = groups_get_activity_group($cm, true);
1274     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1275         $strenterchat    = get_string('enterchat', 'chat');
1277         $target = $CFG->wwwroot.'/mod/chat/';
1278         $params = array('id' => $cm->instance);
1280         if ($currentgroup) {
1281             $params['groupid'] = $currentgroup;
1282         }
1284         $links = array();
1286         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1287         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1288                                    array('height' => 500, 'width' => 700));
1289         $links[] = new action_link($url, $strenterchat, $action);
1291         $url = new moodle_url($target.'gui_basic/index.php', $params);
1292         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1293                                    array('height' => 500, 'width' => 700));
1294         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1296         foreach ($links as $link) {
1297             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null , null, new pix_icon('i/group' , ''));
1298         }
1299     }
1301     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1302     if (is_array($chatusers) && count($chatusers) > 0) {
1303         $users = $navigation->add(get_string('currentusers', 'chat'));
1304         foreach ($chatusers as $chatuser) {
1305             $userlink = new moodle_url('/user/view.php', array('id' => $chatuser->id, 'course' => $course->id));
1306             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping),
1307                         $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1308         }
1309     }
1312 /**
1313  * Adds module specific settings to the settings block
1314  *
1315  * @param settings_navigation $settings The settings navigation object
1316  * @param navigation_node $chatnode The node to add module settings to
1317  */
1318 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1319     global $DB, $PAGE, $USER;
1320     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1322     if ($chat->chattime && $chat->schedule) {
1323         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').
1324                                           ': '.userdate($chat->chattime).
1325                                           ' ('.usertimezone($USER->timezone).')');
1326         $nextsessionnode->add_class('note');
1327     }
1329     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1330     if ($currentgroup) {
1331         $groupselect = " AND groupid = '$currentgroup'";
1332     } else {
1333         $groupselect = '';
1334     }
1336     if ($chat->studentlogs || has_capability('mod/chat:readlog', $PAGE->cm->context)) {
1337         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1338             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id' => $PAGE->cm->id)));
1339         }
1340     }
1343 /**
1344  * user logout event handler
1345  *
1346  * @param \core\event\user_loggedout $event The event.
1347  * @return void
1348  */
1349 function chat_user_logout(\core\event\user_loggedout $event) {
1350     global $DB;
1351     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1354 /**
1355  * Return a list of page types
1356  * @param string $pagetype current page type
1357  * @param stdClass $parentcontext Block's parent context
1358  * @param stdClass $currentcontext Current context of block
1359  */
1360 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1361     $modulepagetype = array('mod-chat-*' => get_string('page-mod-chat-x', 'chat'));
1362     return $modulepagetype;
1365 /**
1366  * Return a list of the latest messages in the given chat session.
1367  *
1368  * @param  stdClass $chatuser     chat user session data
1369  * @param  int      $chatlasttime last time messages were retrieved
1370  * @return array    list of messages
1371  * @since  Moodle 3.0
1372  */
1373 function chat_get_latest_messages($chatuser, $chatlasttime) {
1374     global $DB;
1376     $params = array('groupid' => $chatuser->groupid, 'chatid' => $chatuser->chatid, 'lasttime' => $chatlasttime);
1378     $groupselect = $chatuser->groupid ? " AND (groupid=" . $chatuser->groupid . " OR groupid=0) " : "";
1380     return $DB->get_records_select('chat_messages_current', 'chatid = :chatid AND timestamp > :lasttime ' . $groupselect,
1381                                     $params, 'timestamp ASC');
1384 /**
1385  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1386  *
1387  * @param  stdClass $chat       chat object
1388  * @param  stdClass $course     course object
1389  * @param  stdClass $cm         course module object
1390  * @param  stdClass $context    context object
1391  * @since Moodle 3.0
1392  */
1393 function chat_view($chat, $course, $cm, $context) {
1395     // Trigger course_module_viewed event.
1396     $params = array(
1397         'context' => $context,
1398         'objectid' => $chat->id
1399     );
1401     $event = \mod_chat\event\course_module_viewed::create($params);
1402     $event->add_record_snapshot('course_modules', $cm);
1403     $event->add_record_snapshot('course', $course);
1404     $event->add_record_snapshot('chat', $chat);
1405     $event->trigger();
1407     // Completion.
1408     $completion = new completion_info($course);
1409     $completion->set_module_viewed($cm);
1412 /**
1413  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1414  *
1415  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1416  * is not displayed on the block.
1417  *
1418  * @param calendar_event $event
1419  * @param \core_calendar\action_factory $factory
1420  * @return \core_calendar\local\event\entities\action_interface|null
1421  */
1422 function mod_chat_core_calendar_provide_event_action(calendar_event $event,
1423                                                      \core_calendar\action_factory $factory) {
1424     global $DB;
1426     $cm = get_fast_modinfo($event->courseid)->instances['chat'][$event->instance];
1427     $chattime = $DB->get_field('chat', 'chattime', array('id' => $event->instance));
1428     $chattimemidnight = usergetmidnight($chattime);
1429     $todaymidnight = usergetmidnight(time());
1431     if ($chattime < $todaymidnight) {
1432         // The chat is before today. Do not show at all.
1433         return null;
1434     } else {
1435         // The chat is actionable if it is at some point today.
1436         $actionable = $chattimemidnight == $todaymidnight;
1438         return $factory->create_instance(
1439             get_string('enterchat', 'chat'),
1440             new \moodle_url('/mod/chat/view.php', array('id' => $cm->id)),
1441             1,
1442             $actionable
1443         );
1444     }