MDL-59287 calendar_events: Update modules to create all events.
[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     }
137     if (!empty($chat->completionexpected)) {
138         \core_completion\api::update_completion_date_event($chat->coursemodule, 'chat', $returnid, $chat->completionexpected);
139     }
141     return $returnid;
144 /**
145  * Given an object containing all the necessary data,
146  * (defined by the form in mod_form.php) this function
147  * will update an existing instance with new data.
148  *
149  * @global object
150  * @param object $chat
151  * @return bool
152  */
153 function chat_update_instance($chat) {
154     global $DB;
156     $chat->timemodified = time();
157     $chat->id = $chat->instance;
159     $DB->update_record("chat", $chat);
161     $event = new stdClass();
163     if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
165         if ($chat->schedule > 0) {
166             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
167             $event->name        = $chat->name;
168             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
169             $event->timestart   = $chat->chattime;
170             $event->timesort    = $chat->chattime;
172             $calendarevent = calendar_event::load($event->id);
173             $calendarevent->update($event);
174         } else {
175             // Do not publish this event, so delete it.
176             $calendarevent = calendar_event::load($event->id);
177             $calendarevent->delete();
178         }
179     } else {
180         // No event, do we need to create one?
181         if ($chat->schedule > 0) {
182             $event = new stdClass();
183             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
184             $event->name        = $chat->name;
185             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
186             $event->courseid    = $chat->course;
187             $event->groupid     = 0;
188             $event->userid      = 0;
189             $event->modulename  = 'chat';
190             $event->instance    = $chat->id;
191             $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
192             $event->timestart   = $chat->chattime;
193             $event->timesort    = $chat->chattime;
194             $event->timeduration = 0;
196             calendar_event::create($event);
197         }
198     }
200     $completionexpected = (!empty($chat->completionexpected)) ? $chat->completionexpected : null;
201     \core_completion\api::update_completion_date_event($chat->coursemodule, 'chat', $chat->id, $completionexpected);
203     return true;
206 /**
207  * Given an ID of an instance of this module,
208  * this function will permanently delete the instance
209  * and any data that depends on it.
210  *
211  * @global object
212  * @param int $id
213  * @return bool
214  */
215 function chat_delete_instance($id) {
216     global $DB;
218     if (! $chat = $DB->get_record('chat', array('id' => $id))) {
219         return false;
220     }
222     $result = true;
224     // Delete any dependent records here.
226     if (! $DB->delete_records('chat', array('id' => $chat->id))) {
227         $result = false;
228     }
229     if (! $DB->delete_records('chat_messages', array('chatid' => $chat->id))) {
230         $result = false;
231     }
232     if (! $DB->delete_records('chat_messages_current', array('chatid' => $chat->id))) {
233         $result = false;
234     }
235     if (! $DB->delete_records('chat_users', array('chatid' => $chat->id))) {
236         $result = false;
237     }
239     if (! $DB->delete_records('event', array('modulename' => 'chat', 'instance' => $chat->id))) {
240         $result = false;
241     }
243     return $result;
246 /**
247  * Given a course and a date, prints a summary of all chat rooms past and present
248  * This function is called from block_recent_activity
249  *
250  * @global object
251  * @global object
252  * @global object
253  * @param object $course
254  * @param bool $viewfullnames
255  * @param int|string $timestart Timestamp
256  * @return bool
257  */
258 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
259     global $CFG, $USER, $DB, $OUTPUT;
261     // This is approximate only, but it is really fast.
262     $timeout = $CFG->chat_old_ping * 10;
264     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
265                                          FROM {course_modules} cm
266                                          JOIN {modules} md        ON md.id = cm.module
267                                          JOIN {chat} ch           ON ch.id = cm.instance
268                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
269                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
270                                      GROUP BY cm.id
271                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
272          return false;
273     }
275     $past     = array();
276     $current  = array();
277     $modinfo = get_fast_modinfo($course); // Reference needed because we might load the groups.
279     foreach ($mcms as $cmid => $mcm) {
280         if (!array_key_exists($cmid, $modinfo->cms)) {
281             continue;
282         }
283         $cm = $modinfo->cms[$cmid];
284         if (!$modinfo->cms[$cm->id]->uservisible) {
285             continue;
286         }
288         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
289          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
290             if ($timeout > time() - $mcm->lasttime) {
291                 $current[] = $cm;
292             } else {
293                 $past[] = $cm;
294             }
296             continue;
297         }
299         // Verify groups in separate mode.
300         if (!$mygroupids = $modinfo->get_groups($cm->groupingid)) {
301             continue;
302         }
304         // Ok, last post was not for my group - we have to query db to get last message from one of my groups.
305         // The only minor problem is that the order will not be correct.
306         $mygroupids = implode(',', $mygroupids);
308         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
309                                            FROM {course_modules} cm
310                                            JOIN {chat} ch           ON ch.id = cm.instance
311                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
312                                           WHERE chm.timestamp > ? AND cm.id = ? AND
313                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
314                                        GROUP BY cm.id", array($timestart, $cm->id))) {
315              continue;
316         }
318         $mcms[$cmid]->lasttime = $mcm->lasttime;
319         if ($timeout > time() - $mcm->lasttime) {
320             $current[] = $cm;
321         } else {
322             $past[] = $cm;
323         }
324     }
326     if (!$past and !$current) {
327         return false;
328     }
330     $strftimerecent = get_string('strftimerecent');
332     if ($past) {
333         echo $OUTPUT->heading(get_string("pastchats", 'chat').':', 3);
335         foreach ($past as $cm) {
336             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
337             $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         }
341     }
343     if ($current) {
344         echo $OUTPUT->heading(get_string("currentchats", 'chat').':', 3);
346         $oldest = floor((time() - $CFG->chat_old_ping) / 10) * 10;  // Better db caching.
348         $timeold    = time() - $CFG->chat_old_ping;
349         $timeold    = floor($timeold / 10) * 10;  // Better db caching.
350         $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
351         $timeoldext = floor($timeoldext / 10) * 10;  // Better db caching.
353         $params = array('timeold' => $timeold, 'timeoldext' => $timeoldext, 'cmid' => $cm->id);
355         $timeout = "AND ((chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext))";
357         foreach ($current as $cm) {
358             // Count users first.
359             $mygroupids = $modinfo->groups[$cm->groupingid];
360             if (!empty($mygroupids)) {
361                 list($subquery, $subparams) = $DB->get_in_or_equal($mygroupids, SQL_PARAMS_NAMED, 'gid');
362                 $params += $subparams;
363                 $groupselect = "AND (chu.groupid $subquery OR chu.groupid = 0)";
364             } else {
365                 $groupselect = "";
366             }
368             $userfields = user_picture::fields('u');
369             if (!$users = $DB->get_records_sql("SELECT $userfields
370                                                   FROM {course_modules} cm
371                                                   JOIN {chat} ch        ON ch.id = cm.instance
372                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
373                                                   JOIN {user} u         ON u.id = chu.userid
374                                                  WHERE cm.id = :cmid $timeout $groupselect
375                                               GROUP BY $userfields", $params)) {
376             }
378             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
379             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
381             echo '<div class="head"><div class="date">'.$date.'</div></div>';
382             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
383             echo '<div class="userlist">';
384             if ($users) {
385                 echo '<ul>';
386                 foreach ($users as $user) {
387                     echo '<li>'.fullname($user, $viewfullnames).'</li>';
388                 }
389                 echo '</ul>';
390             }
391             echo '</div>';
392         }
393     }
395     return true;
398 /**
399  * Function to be run periodically according to the moodle cron
400  * This function searches for things that need to be done, such
401  * as sending out mail, toggling flags etc ...
402  *
403  * @global object
404  * @return bool
405  */
406 function chat_cron () {
407     global $DB;
409     chat_update_chat_times();
411     chat_delete_old_users();
413     // Delete old messages with a single SQL query.
414     $subselect = "SELECT c.keepdays
415                     FROM {chat} c
416                    WHERE c.id = {chat_messages}.chatid";
418     $sql = "DELETE
419               FROM {chat_messages}
420              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
422     $DB->execute($sql);
424     $sql = "DELETE
425               FROM {chat_messages_current}
426              WHERE timestamp < ( ".time()." - 8 * 3600)";
428     $DB->execute($sql);
430     return true;
433 /**
434  * This standard function will check all instances of this module
435  * and make sure there are up-to-date events created for each of them.
436  * If courseid = 0, then every chat event in the site is checked, else
437  * only chat events belonging to the course specified are checked.
438  * This function is used, in its new format, by restore_refresh_events()
439  *
440  * @global object
441  * @param int $courseid
442  * @param int|stdClass $instance Chat module instance or ID.
443  * @param int|stdClass $cm Course module object or ID.
444  * @return bool
445  */
446 function chat_refresh_events($courseid = 0, $instance = null, $cm = null) {
447     global $DB;
449     // If we have instance information then we can just update the one event instead of updating all events.
450     if (isset($instance)) {
451         if (!is_object($instance)) {
452             $instance = $DB->get_record('chat', array('id' => $instance), '*', MUST_EXIST);
453         }
454         if (isset($cm)) {
455             if (!is_object($cm)) {
456                 chat_prepare_update_events($instance);
457                 return true;
458             } else {
459                 chat_prepare_update_events($instance, $cm);
460                 return true;
461             }
462         }
463     }
465     if ($courseid) {
466         if (! $chats = $DB->get_records("chat", array("course" => $courseid))) {
467             return true;
468         }
469     } else {
470         if (! $chats = $DB->get_records("chat")) {
471             return true;
472         }
473     }
474     foreach ($chats as $chat) {
475         chat_prepare_update_events($chat);
476     }
477     return true;
480 /**
481  * Updates both the normal and completion calendar events for chat.
482  *
483  * @param  stdClass $chat The chat object (from the DB)
484  * @param  stdClass $cm The course module object.
485  */
486 function chat_prepare_update_events($chat, $cm = null) {
487     global $DB;
488     if (!isset($cm)) {
489         $cm = get_coursemodule_from_instance('chat', $chat->id, $chat->course);
490     }
491     $event = new stdClass();
492     $event->name        = $chat->name;
493     $event->type        = CALENDAR_EVENT_TYPE_ACTION;
494     $event->description = format_module_intro('chat', $chat, $cm->id);
495     $event->timestart   = $chat->chattime;
496     $event->timesort    = $chat->chattime;
497     if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id))) {
498         $calendarevent = calendar_event::load($event->id);
499         $calendarevent->update($event);
500     } else if ($chat->schedule > 0) {
501         // The chat is scheduled and the event should be published.
502         $event->courseid    = $chat->course;
503         $event->groupid     = 0;
504         $event->userid      = 0;
505         $event->modulename  = 'chat';
506         $event->instance    = $chat->id;
507         $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
508         $event->timeduration = 0;
509         $event->visible = $cm->visible;
510         calendar_event::create($event);
511     }
514 // Functions that require some SQL.
516 /**
517  * @global object
518  * @param int $chatid
519  * @param int $groupid
520  * @param int $groupingid
521  * @return array
522  */
523 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
524     global $DB;
526     $params = array('chatid' => $chatid, 'groupid' => $groupid, 'groupingid' => $groupingid);
528     if ($groupid) {
529         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
530     } else {
531         $groupselect = "";
532     }
534     if (!empty($groupingid)) {
535         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
536                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
538     } else {
539         $groupingjoin = '';
540     }
542     $ufields = user_picture::fields('u');
543     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
544                                    FROM {chat_users} c
545                                    JOIN {user} u ON u.id = c.userid $groupingjoin
546                                   WHERE c.chatid = :chatid $groupselect
547                                ORDER BY c.firstping ASC", $params);
550 /**
551  * @global object
552  * @param int $chatid
553  * @param int $groupid
554  * @return array
555  */
556 function chat_get_latest_message($chatid, $groupid=0) {
557     global $DB;
559     $params = array('chatid' => $chatid, 'groupid' => $groupid);
561     if ($groupid) {
562         $groupselect = "AND (groupid=:groupid OR groupid=0)";
563     } else {
564         $groupselect = "";
565     }
567     $sql = "SELECT *
568         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
569         ORDER BY timestamp DESC";
571     // Return the lastest one message.
572     return $DB->get_record_sql($sql, $params, true);
575 /**
576  * login if not already logged in
577  *
578  * @global object
579  * @global object
580  * @param int $chatid
581  * @param string $version
582  * @param int $groupid
583  * @param object $course
584  * @return bool|int Returns the chat users sid or false
585  */
586 function chat_login_user($chatid, $version, $groupid, $course) {
587     global $USER, $DB;
589     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid' => $chatid,
590                                                                                     'userid' => $USER->id,
591                                                                                     'groupid' => $groupid))) {
592         // This will update logged user information.
593         $chatuser->version  = $version;
594         $chatuser->ip       = $USER->lastip;
595         $chatuser->lastping = time();
596         $chatuser->lang     = current_language();
598         // Sometimes $USER->lastip is not setup properly during login.
599         // Update with current value if possible or provide a dummy value for the db.
600         if (empty($chatuser->ip)) {
601             $chatuser->ip = getremoteaddr();
602         }
604         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
605             return false;
606         }
607         $DB->update_record('chat_users', $chatuser);
609     } else {
610         $chatuser = new stdClass();
611         $chatuser->chatid   = $chatid;
612         $chatuser->userid   = $USER->id;
613         $chatuser->groupid  = $groupid;
614         $chatuser->version  = $version;
615         $chatuser->ip       = $USER->lastip;
616         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
617         $chatuser->sid      = random_string(32);
618         $chatuser->course   = $course->id; // Caching - needed for current_language too.
619         $chatuser->lang     = current_language(); // Caching - to resource intensive to find out later.
621         // Sometimes $USER->lastip is not setup properly during login.
622         // Update with current value if possible or provide a dummy value for the db.
623         if (empty($chatuser->ip)) {
624             $chatuser->ip = getremoteaddr();
625         }
627         $DB->insert_record('chat_users', $chatuser);
629         if ($version == 'sockets') {
630             // Do not send 'enter' message, chatd will do it.
631         } else {
632             chat_send_chatmessage($chatuser, 'enter', true);
633         }
634     }
636     return $chatuser->sid;
639 /**
640  * Delete the old and in the way
641  *
642  * @global object
643  * @global object
644  */
645 function chat_delete_old_users() {
646     // Delete the old and in the way.
647     global $CFG, $DB;
649     $timeold = time() - $CFG->chat_old_ping;
650     $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
652     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
653     $params = array($timeold, $timeoldext);
655     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
656         $DB->delete_records_select('chat_users', $query, $params);
657         foreach ($oldusers as $olduser) {
658             chat_send_chatmessage($olduser, 'exit', true);
659         }
660     }
663 /**
664  * Updates chat records so that the next chat time is correct
665  *
666  * @global object
667  * @param int $chatid
668  * @return void
669  */
670 function chat_update_chat_times($chatid=0) {
671     // Updates chat records so that the next chat time is correct.
672     global $DB;
674     $timenow = time();
676     $params = array('timenow' => $timenow, 'chatid' => $chatid);
678     if ($chatid) {
679         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
680             return;
681         }
682     } else {
683         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
684             return;
685         }
686     }
688     foreach ($chats as $chat) {
689         switch ($chat->schedule) {
690             case 1: // Single event - turn off schedule and disable.
691                 $chat->chattime = 0;
692                 $chat->schedule = 0;
693                 break;
694             case 2: // Repeat daily.
695                 while ($chat->chattime <= $timenow) {
696                     $chat->chattime += 24 * 3600;
697                 }
698                 break;
699             case 3: // Repeat weekly.
700                 while ($chat->chattime <= $timenow) {
701                     $chat->chattime += 7 * 24 * 3600;
702                 }
703                 break;
704         }
705         $DB->update_record("chat", $chat);
707         $event = new stdClass(); // Update calendar too.
709         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
710         $params = array('chattime' => $chat->chattime, 'chatid' => $chat->id);
712         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
713             $event->timestart = $chat->chattime;
714             $event->timesort = $chat->chattime;
715             $calendarevent = calendar_event::load($event->id);
716             $calendarevent->update($event, false);
717         }
718     }
721 /**
722  * Send a message on the chat.
723  *
724  * @param object $chatuser The chat user record.
725  * @param string $messagetext The message to be sent.
726  * @param bool $system False for non-system messages, true for system messages.
727  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
728  * @return int The message ID.
729  * @since Moodle 2.6
730  */
731 function chat_send_chatmessage($chatuser, $messagetext, $system = false, $cm = null) {
732     global $DB;
734     $message = new stdClass();
735     $message->chatid    = $chatuser->chatid;
736     $message->userid    = $chatuser->userid;
737     $message->groupid   = $chatuser->groupid;
738     $message->message   = $messagetext;
739     $message->system    = $system ? 1 : 0;
740     $message->timestamp = time();
742     $messageid = $DB->insert_record('chat_messages', $message);
743     $DB->insert_record('chat_messages_current', $message);
744     $message->id = $messageid;
746     if (!$system) {
748         if (empty($cm)) {
749             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
750         }
752         $params = array(
753             'context' => context_module::instance($cm->id),
754             'objectid' => $message->id,
755             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
756             'relateduserid' => $chatuser->userid
757         );
758         $event = \mod_chat\event\message_sent::create($params);
759         $event->add_record_snapshot('chat_messages', $message);
760         $event->trigger();
761     }
763     return $message->id;
766 /**
767  * @global object
768  * @global object
769  * @param object $message
770  * @param int $courseid
771  * @param object $sender
772  * @param object $currentuser
773  * @param string $chatlastrow
774  * @return bool|string Returns HTML or false
775  */
776 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chatlastrow = null) {
777     global $CFG, $USER, $OUTPUT;
779     $output = new stdClass();
780     $output->beep = false;       // By default.
781     $output->refreshusers = false; // By default.
783     // Find the correct timezone for displaying this message.
784     $tz = core_date::get_user_timezone($currentuser);
786     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
788     $message->picture = $OUTPUT->user_picture($sender, array('size' => false, 'courseid' => $courseid, 'link' => false));
790     if ($courseid) {
791         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\"".
792                             " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
793     }
795     // Calculate the row class.
796     if ($chatlastrow !== null) {
797         $rowclass = ' class="r'.$chatlastrow.'" ';
798     } else {
799         $rowclass = '';
800     }
802     // Start processing the message.
804     if (!empty($message->system)) {
805         // System event.
806         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
807         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td>';
808         $output->html .= '<td class="text"><span class="event">'.$output->text.'</span></td></tr></table>';
809         $output->basic = '<tr class="r1">
810                             <th scope="row" class="cell c1 title"></th>
811                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
812                             <td class="cell c3">' . $message->strtime . '</td>
813                           </tr>';
814         if ($message->message == 'exit' or $message->message == 'enter') {
815             $output->refreshusers = true; // Force user panel refresh ASAP.
816         }
817         return $output;
818     }
820     // It's not a system event.
821     $rawtext = trim($message->message);
823     // Options for format_text, when we get to it...
824     // format_text call will parse the text to clean and filter it.
825     // It cannot be called here as HTML-isation interferes with special case
826     // recognition, but *must* be called on any user-sourced text to be inserted
827     // into $outmain.
828     $options = new stdClass();
829     $options->para = false;
830     $options->blanktarget = true;
832     // And now check for special cases.
833     $patternto = '#^\s*To\s([^:]+):(.*)#';
834     $special = false;
836     if (substr($rawtext, 0, 5) == 'beep ') {
837         // It's a beep!
838         $special = true;
839         $beepwho = trim(substr($rawtext, 5));
841         if ($beepwho == 'all') {   // Everyone.
842             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
843             $outinfo = $message->strtime . ': ' . $outinfobasic;
844             $outmain = '';
846             $output->beep = true;  // Eventually this should be set to a filename uploaded by the user.
848         } else if ($beepwho == $currentuser->id) {  // Current user.
849             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
850             $outinfo = $message->strtime . ': ' . $outinfobasic;
851             $outmain = '';
852             $output->beep = true;
854         } else {  // Something is not caught?
855             return false;
856         }
857     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
858         $special = true;
859         $pattern = '#(^\/)(\w+).*#';
860         preg_match($pattern, $rawtext, $matches);
861         $command = isset($matches[2]) ? $matches[2] : false;
862         // Support some IRC commands.
863         switch ($command) {
864             case 'me':
865                 $outinfo = $message->strtime;
866                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
867                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
868                 break;
869             default:
870                 // Error, we set special back to false to use the classic message output.
871                 $special = false;
872                 break;
873         }
874     } else if (preg_match($patternto, $rawtext)) {
875         $special = true;
876         $matches = array();
877         preg_match($patternto, $rawtext, $matches);
878         if (isset($matches[1]) && isset($matches[2])) {
879             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
880             $outinfo = $message->strtime;
881             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$text;
882         } else {
883             // Error, we set special back to false to use the classic message output.
884             $special = false;
885         }
886     }
888     if (!$special) {
889         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
890         $outinfo = $message->strtime.' '.$sender->firstname;
891         $outmain = $text;
892     }
894     // Format the message as a small table.
896     $output->text  = strip_tags($outinfo.': '.$outmain);
898     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td>";
899     $output->html .= "<td class=\"text\"><span class=\"title\">$outinfo</span>";
900     if ($outmain) {
901         $output->html .= ": $outmain";
902         $output->basic = '<tr class="r0">
903                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
904                             <td class="cell c2 text">' . $outmain . '</td>
905                             <td class="cell c3">' . $message->strtime . '</td>
906                           </tr>';
907     } else {
908         $output->basic = '<tr class="r1">
909                             <th scope="row" class="cell c1 title"></th>
910                             <td class="cell c2 text">' . $outinfobasic . '</td>
911                             <td class="cell c3">' . $message->strtime . '</td>
912                           </tr>';
913     }
914     $output->html .= "</td></tr></table>";
915     return $output;
918 /**
919  * Given a message object this function formats it appropriately into text and html then returns the formatted data
920  * @global object
921  * @param object $message
922  * @param int $courseid
923  * @param object $currentuser
924  * @param string $chatlastrow
925  * @return bool|string Returns HTML or false
926  */
927 function chat_format_message($message, $courseid, $currentuser, $chatlastrow=null) {
928     global $DB;
930     static $users;     // Cache user lookups.
932     if (isset($users[$message->userid])) {
933         $user = $users[$message->userid];
934     } else if ($user = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
935         $users[$message->userid] = $user;
936     } else {
937         return null;
938     }
939     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chatlastrow);
942 /**
943  * @global object
944  * @param object $message message to be displayed.
945  * @param mixed $chatuser user chat data
946  * @param object $currentuser current user for whom the message should be displayed.
947  * @param int $groupingid course module grouping id
948  * @param string $theme name of the chat theme.
949  * @return bool|string Returns HTML or false
950  */
951 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
952     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
953     require_once($CFG->dirroot.'/mod/chat/locallib.php');
955     static $users;     // Cache user lookups.
957     $result = new stdClass();
959     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
960         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
961     }
963     if (isset($users[$message->userid])) {
964         $sender = $users[$message->userid];
965     } else if ($sender = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
966         $users[$message->userid] = $sender;
967     } else {
968         return null;
969     }
971     // Find the correct timezone for displaying this message.
972     $tz = core_date::get_user_timezone($currentuser);
974     if (empty($chatuser->course)) {
975         $courseid = $COURSE->id;
976     } else {
977         $courseid = $chatuser->course;
978     }
980     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
981     $message->picture = $OUTPUT->user_picture($sender, array('courseid' => $courseid));
983     $message->picture = "<a target='_blank'".
984                         " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
986     // Start processing the message.
987     if (!empty($message->system)) {
988         $result->type = 'system';
990         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
991         $event = get_string('message'.$message->message, 'chat', fullname($sender));
992         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
994         $output = $PAGE->get_renderer('mod_chat');
995         $result->html = $output->render($eventmessage);
997         return $result;
998     }
1000     // It's not a system event.
1001     $rawtext = trim($message->message);
1003     // Options for format_text, when we get to it...
1004     // format_text call will parse the text to clean and filter it.
1005     // It cannot be called here as HTML-isation interferes with special case
1006     // recognition, but *must* be called on any user-sourced text to be inserted
1007     // into $outmain.
1008     $options = new stdClass();
1009     $options->para = false;
1010     $options->blanktarget = true;
1012     // And now check for special cases.
1013     $special = false;
1014     $outtime = $message->strtime;
1016     // Initialise variables.
1017     $outmain = '';
1018     $patternto = '#^\s*To\s([^:]+):(.*)#';
1020     if (substr($rawtext, 0, 5) == 'beep ') {
1021         $special = true;
1022         // It's a beep!
1023         $result->type = 'beep';
1024         $beepwho = trim(substr($rawtext, 5));
1026         if ($beepwho == 'all') {   // Everyone.
1027             $outmain = get_string('messagebeepseveryone', 'chat', fullname($sender));
1028         } else if ($beepwho == $currentuser->id) {  // Current user.
1029             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
1030         } else if ($sender->id == $currentuser->id) {  // Something is not caught?
1031             // Allow beep for a active chat user only, else user can beep anyone and get fullname.
1032             if (!empty($chatuser) && is_numeric($beepwho)) {
1033                 $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
1034                 if (array_key_exists($beepwho, $chatusers)) {
1035                     $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
1036                 } else {
1037                     $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1038                 }
1039             } else {
1040                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1041             }
1042         }
1043     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
1044         $special = true;
1045         $result->type = 'command';
1046         $pattern = '#(^\/)(\w+).*#';
1047         preg_match($pattern, $rawtext, $matches);
1048         $command = isset($matches[2]) ? $matches[2] : false;
1049         // Support some IRC commands.
1050         switch ($command) {
1051             case 'me':
1052                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
1053                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
1054                 break;
1055             default:
1056                 // Error, we set special back to false to use the classic message output.
1057                 $special = false;
1058                 break;
1059         }
1060     } else if (preg_match($patternto, $rawtext)) {
1061         $special = true;
1062         $result->type = 'dialogue';
1063         $matches = array();
1064         preg_match($patternto, $rawtext, $matches);
1065         if (isset($matches[1]) && isset($matches[2])) {
1066             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
1067             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$text;
1068         } else {
1069             // Error, we set special back to false to use the classic message output.
1070             $special = false;
1071         }
1072     }
1074     if (!$special) {
1075         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
1076         $outmain = $text;
1077     }
1079     $result->text = strip_tags($outtime.': '.$outmain);
1081     $mymessageclass = '';
1082     if ($sender->id == $USER->id) {
1083         $mymessageclass = 'chat-message-mymessage';
1084     }
1086     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1087     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture,
1088                                     $mymessageclass, $outtime, $outmain, $theme);
1090     $output = $PAGE->get_renderer('mod_chat');
1091     $result->html = $output->render($usermessage);
1093     // When user beeps other user, then don't show any timestamp to other users in chat.
1094     if (('' === $outmain) && $special) {
1095         return false;
1096     } else {
1097         return $result;
1098     }
1101 /**
1102  * @global object $DB
1103  * @global object $CFG
1104  * @global object $COURSE
1105  * @global object $OUTPUT
1106  * @param object $users
1107  * @param object $course
1108  * @return array return formatted user list
1109  */
1110 function chat_format_userlist($users, $course) {
1111     global $CFG, $DB, $COURSE, $OUTPUT;
1112     $result = array();
1113     foreach ($users as $user) {
1114         $item = array();
1115         $item['name'] = fullname($user);
1116         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1117         $item['picture'] = $OUTPUT->user_picture($user);
1118         $item['id'] = $user->id;
1119         $result[] = $item;
1120     }
1121     return $result;
1124 /**
1125  * Print json format error
1126  * @param string $level
1127  * @param string $msg
1128  */
1129 function chat_print_error($level, $msg) {
1130     header('Content-Length: ' . ob_get_length() );
1131     $error = new stdClass();
1132     $error->level = $level;
1133     $error->msg   = $msg;
1134     $response['error'] = $error;
1135     echo json_encode($response);
1136     ob_end_flush();
1137     exit;
1140 /**
1141  * List the actions that correspond to a view of this module.
1142  * This is used by the participation report.
1143  *
1144  * Note: This is not used by new logging system. Event with
1145  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1146  *       be considered as view action.
1147  *
1148  * @return array
1149  */
1150 function chat_get_view_actions() {
1151     return array('view', 'view all', 'report');
1154 /**
1155  * List the actions that correspond to a post of this module.
1156  * This is used by the participation report.
1157  *
1158  * Note: This is not used by new logging system. Event with
1159  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1160  *       will be considered as post action.
1161  *
1162  * @return array
1163  */
1164 function chat_get_post_actions() {
1165     return array('talk');
1168 /**
1169  * @deprecated since 3.3
1170  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1171  * @global object
1172  * @global object
1173  * @param array $courses
1174  * @param array $htmlarray Passed by reference
1175  */
1176 function chat_print_overview($courses, &$htmlarray) {
1177     global $USER, $CFG;
1179     debugging('The function chat_print_overview() is now deprecated.', DEBUG_DEVELOPER);
1181     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1182         return array();
1183     }
1185     if (!$chats = get_all_instances_in_courses('chat', $courses)) {
1186         return;
1187     }
1189     $strchat = get_string('modulename', 'chat');
1190     $strnextsession  = get_string('nextsession', 'chat');
1192     foreach ($chats as $chat) {
1193         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled.
1194             $str = '<div class="chat overview"><div class="name">'.
1195                    $strchat.': <a '.($chat->visible ? '' : ' class="dimmed"').
1196                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1197                    $chat->name.'</a></div>';
1198             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1200             if (empty($htmlarray[$chat->course]['chat'])) {
1201                 $htmlarray[$chat->course]['chat'] = $str;
1202             } else {
1203                 $htmlarray[$chat->course]['chat'] .= $str;
1204             }
1205         }
1206     }
1210 /**
1211  * Implementation of the function for printing the form elements that control
1212  * whether the course reset functionality affects the chat.
1213  *
1214  * @param object $mform form passed by reference
1215  */
1216 function chat_reset_course_form_definition(&$mform) {
1217     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1218     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages', 'chat'));
1221 /**
1222  * Course reset form defaults.
1223  *
1224  * @param object $course
1225  * @return array
1226  */
1227 function chat_reset_course_form_defaults($course) {
1228     return array('reset_chat' => 1);
1231 /**
1232  * Actual implementation of the reset course functionality, delete all the
1233  * chat messages for course $data->courseid.
1234  *
1235  * @global object
1236  * @global object
1237  * @param object $data the data submitted from the reset course.
1238  * @return array status array
1239  */
1240 function chat_reset_userdata($data) {
1241     global $CFG, $DB;
1243     $componentstr = get_string('modulenameplural', 'chat');
1244     $status = array();
1246     if (!empty($data->reset_chat)) {
1247         $chatessql = "SELECT ch.id
1248                         FROM {chat} ch
1249                        WHERE ch.course=?";
1250         $params = array($data->courseid);
1252         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1253         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1254         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1255         $status[] = array('component' => $componentstr, 'item' => get_string('removemessages', 'chat'), 'error' => false);
1256     }
1258     // Updating dates - shift may be negative too.
1259     if ($data->timeshift) {
1260         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1261         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => false);
1262     }
1264     return $status;
1267 /**
1268  * Returns all other caps used in module
1269  *
1270  * @return array
1271  */
1272 function chat_get_extra_capabilities() {
1273     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1277 /**
1278  * @param string $feature FEATURE_xx constant for requested feature
1279  * @return mixed True if module supports feature, null if doesn't know
1280  */
1281 function chat_supports($feature) {
1282     switch($feature) {
1283         case FEATURE_GROUPS:
1284             return true;
1285         case FEATURE_GROUPINGS:
1286             return true;
1287         case FEATURE_MOD_INTRO:
1288             return true;
1289         case FEATURE_BACKUP_MOODLE2:
1290             return true;
1291         case FEATURE_COMPLETION_TRACKS_VIEWS:
1292             return true;
1293         case FEATURE_GRADE_HAS_GRADE:
1294             return false;
1295         case FEATURE_GRADE_OUTCOMES:
1296             return true;
1297         case FEATURE_SHOW_DESCRIPTION:
1298             return true;
1299         default:
1300             return null;
1301     }
1304 function chat_extend_navigation($navigation, $course, $module, $cm) {
1305     global $CFG;
1307     $currentgroup = groups_get_activity_group($cm, true);
1309     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1310         $strenterchat    = get_string('enterchat', 'chat');
1312         $target = $CFG->wwwroot.'/mod/chat/';
1313         $params = array('id' => $cm->instance);
1315         if ($currentgroup) {
1316             $params['groupid'] = $currentgroup;
1317         }
1319         $links = array();
1321         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1322         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1323                                    array('height' => 500, 'width' => 700));
1324         $links[] = new action_link($url, $strenterchat, $action);
1326         $url = new moodle_url($target.'gui_basic/index.php', $params);
1327         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1328                                    array('height' => 500, 'width' => 700));
1329         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1331         foreach ($links as $link) {
1332             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null , null, new pix_icon('i/group' , ''));
1333         }
1334     }
1336     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1337     if (is_array($chatusers) && count($chatusers) > 0) {
1338         $users = $navigation->add(get_string('currentusers', 'chat'));
1339         foreach ($chatusers as $chatuser) {
1340             $userlink = new moodle_url('/user/view.php', array('id' => $chatuser->id, 'course' => $course->id));
1341             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping),
1342                         $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1343         }
1344     }
1347 /**
1348  * Adds module specific settings to the settings block
1349  *
1350  * @param settings_navigation $settings The settings navigation object
1351  * @param navigation_node $chatnode The node to add module settings to
1352  */
1353 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1354     global $DB, $PAGE, $USER;
1355     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1357     if ($chat->chattime && $chat->schedule) {
1358         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').
1359                                           ': '.userdate($chat->chattime).
1360                                           ' ('.usertimezone($USER->timezone).')');
1361         $nextsessionnode->add_class('note');
1362     }
1364     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1365     if ($currentgroup) {
1366         $groupselect = " AND groupid = '$currentgroup'";
1367     } else {
1368         $groupselect = '';
1369     }
1371     if ($chat->studentlogs || has_capability('mod/chat:readlog', $PAGE->cm->context)) {
1372         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1373             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id' => $PAGE->cm->id)));
1374         }
1375     }
1378 /**
1379  * user logout event handler
1380  *
1381  * @param \core\event\user_loggedout $event The event.
1382  * @return void
1383  */
1384 function chat_user_logout(\core\event\user_loggedout $event) {
1385     global $DB;
1386     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1389 /**
1390  * Return a list of page types
1391  * @param string $pagetype current page type
1392  * @param stdClass $parentcontext Block's parent context
1393  * @param stdClass $currentcontext Current context of block
1394  */
1395 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1396     $modulepagetype = array('mod-chat-*' => get_string('page-mod-chat-x', 'chat'));
1397     return $modulepagetype;
1400 /**
1401  * Return a list of the latest messages in the given chat session.
1402  *
1403  * @param  stdClass $chatuser     chat user session data
1404  * @param  int      $chatlasttime last time messages were retrieved
1405  * @return array    list of messages
1406  * @since  Moodle 3.0
1407  */
1408 function chat_get_latest_messages($chatuser, $chatlasttime) {
1409     global $DB;
1411     $params = array('groupid' => $chatuser->groupid, 'chatid' => $chatuser->chatid, 'lasttime' => $chatlasttime);
1413     $groupselect = $chatuser->groupid ? " AND (groupid=" . $chatuser->groupid . " OR groupid=0) " : "";
1415     return $DB->get_records_select('chat_messages_current', 'chatid = :chatid AND timestamp > :lasttime ' . $groupselect,
1416                                     $params, 'timestamp ASC');
1419 /**
1420  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1421  *
1422  * @param  stdClass $chat       chat object
1423  * @param  stdClass $course     course object
1424  * @param  stdClass $cm         course module object
1425  * @param  stdClass $context    context object
1426  * @since Moodle 3.0
1427  */
1428 function chat_view($chat, $course, $cm, $context) {
1430     // Trigger course_module_viewed event.
1431     $params = array(
1432         'context' => $context,
1433         'objectid' => $chat->id
1434     );
1436     $event = \mod_chat\event\course_module_viewed::create($params);
1437     $event->add_record_snapshot('course_modules', $cm);
1438     $event->add_record_snapshot('course', $course);
1439     $event->add_record_snapshot('chat', $chat);
1440     $event->trigger();
1442     // Completion.
1443     $completion = new completion_info($course);
1444     $completion->set_module_viewed($cm);
1447 /**
1448  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1449  *
1450  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1451  * is not displayed on the block.
1452  *
1453  * @param calendar_event $event
1454  * @param \core_calendar\action_factory $factory
1455  * @return \core_calendar\local\event\entities\action_interface|null
1456  */
1457 function mod_chat_core_calendar_provide_event_action(calendar_event $event,
1458                                                      \core_calendar\action_factory $factory) {
1459     global $DB;
1461     $cm = get_fast_modinfo($event->courseid)->instances['chat'][$event->instance];
1462     $chattime = $DB->get_field('chat', 'chattime', array('id' => $event->instance));
1463     $chattimemidnight = usergetmidnight($chattime);
1464     $todaymidnight = usergetmidnight(time());
1466     if ($chattime < $todaymidnight) {
1467         // The chat is before today. Do not show at all.
1468         return null;
1469     } else {
1470         // The chat is actionable if it is at some point today.
1471         $actionable = $chattimemidnight == $todaymidnight;
1473         return $factory->create_instance(
1474             get_string('enterchat', 'chat'),
1475             new \moodle_url('/mod/chat/view.php', array('id' => $cm->id)),
1476             1,
1477             $actionable
1478         );
1479     }