20d6de059362f749b497fa748a7b03d2ad1f1aa6
[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',
164         'instance' => $chat->id, 'eventtype' => CHAT_EVENT_TYPE_CHATTIME))) {
166         if ($chat->schedule > 0) {
167             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
168             $event->name        = $chat->name;
169             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
170             $event->timestart   = $chat->chattime;
171             $event->timesort    = $chat->chattime;
173             $calendarevent = calendar_event::load($event->id);
174             $calendarevent->update($event);
175         } else {
176             // Do not publish this event, so delete it.
177             $calendarevent = calendar_event::load($event->id);
178             $calendarevent->delete();
179         }
180     } else {
181         // No event, do we need to create one?
182         if ($chat->schedule > 0) {
183             $event = new stdClass();
184             $event->type        = CALENDAR_EVENT_TYPE_ACTION;
185             $event->name        = $chat->name;
186             $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
187             $event->courseid    = $chat->course;
188             $event->groupid     = 0;
189             $event->userid      = 0;
190             $event->modulename  = 'chat';
191             $event->instance    = $chat->id;
192             $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
193             $event->timestart   = $chat->chattime;
194             $event->timesort    = $chat->chattime;
195             $event->timeduration = 0;
197             calendar_event::create($event);
198         }
199     }
201     $completionexpected = (!empty($chat->completionexpected)) ? $chat->completionexpected : null;
202     \core_completion\api::update_completion_date_event($chat->coursemodule, 'chat', $chat->id, $completionexpected);
204     return true;
207 /**
208  * Given an ID of an instance of this module,
209  * this function will permanently delete the instance
210  * and any data that depends on it.
211  *
212  * @global object
213  * @param int $id
214  * @return bool
215  */
216 function chat_delete_instance($id) {
217     global $DB;
219     if (! $chat = $DB->get_record('chat', array('id' => $id))) {
220         return false;
221     }
223     $result = true;
225     // Delete any dependent records here.
227     if (! $DB->delete_records('chat', array('id' => $chat->id))) {
228         $result = false;
229     }
230     if (! $DB->delete_records('chat_messages', array('chatid' => $chat->id))) {
231         $result = false;
232     }
233     if (! $DB->delete_records('chat_messages_current', array('chatid' => $chat->id))) {
234         $result = false;
235     }
236     if (! $DB->delete_records('chat_users', array('chatid' => $chat->id))) {
237         $result = false;
238     }
240     if (! $DB->delete_records('event', array('modulename' => 'chat', 'instance' => $chat->id))) {
241         $result = false;
242     }
244     return $result;
247 /**
248  * Given a course and a date, prints a summary of all chat rooms past and present
249  * This function is called from block_recent_activity
250  *
251  * @global object
252  * @global object
253  * @global object
254  * @param object $course
255  * @param bool $viewfullnames
256  * @param int|string $timestart Timestamp
257  * @return bool
258  */
259 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
260     global $CFG, $USER, $DB, $OUTPUT;
262     // This is approximate only, but it is really fast.
263     $timeout = $CFG->chat_old_ping * 10;
265     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
266                                          FROM {course_modules} cm
267                                          JOIN {modules} md        ON md.id = cm.module
268                                          JOIN {chat} ch           ON ch.id = cm.instance
269                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
270                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
271                                      GROUP BY cm.id
272                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
273          return false;
274     }
276     $past     = array();
277     $current  = array();
278     $modinfo = get_fast_modinfo($course); // Reference needed because we might load the groups.
280     foreach ($mcms as $cmid => $mcm) {
281         if (!array_key_exists($cmid, $modinfo->cms)) {
282             continue;
283         }
284         $cm = $modinfo->cms[$cmid];
285         if (!$modinfo->cms[$cm->id]->uservisible) {
286             continue;
287         }
289         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
290          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
291             if ($timeout > time() - $mcm->lasttime) {
292                 $current[] = $cm;
293             } else {
294                 $past[] = $cm;
295             }
297             continue;
298         }
300         // Verify groups in separate mode.
301         if (!$mygroupids = $modinfo->get_groups($cm->groupingid)) {
302             continue;
303         }
305         // Ok, last post was not for my group - we have to query db to get last message from one of my groups.
306         // The only minor problem is that the order will not be correct.
307         $mygroupids = implode(',', $mygroupids);
309         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
310                                            FROM {course_modules} cm
311                                            JOIN {chat} ch           ON ch.id = cm.instance
312                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
313                                           WHERE chm.timestamp > ? AND cm.id = ? AND
314                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
315                                        GROUP BY cm.id", array($timestart, $cm->id))) {
316              continue;
317         }
319         $mcms[$cmid]->lasttime = $mcm->lasttime;
320         if ($timeout > time() - $mcm->lasttime) {
321             $current[] = $cm;
322         } else {
323             $past[] = $cm;
324         }
325     }
327     if (!$past and !$current) {
328         return false;
329     }
331     $strftimerecent = get_string('strftimerecent');
333     if ($past) {
334         echo $OUTPUT->heading(get_string("pastchats", 'chat').':', 3);
336         foreach ($past as $cm) {
337             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
338             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
339             echo '<div class="head"><div class="date">'.$date.'</div></div>';
340             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
341         }
342     }
344     if ($current) {
345         echo $OUTPUT->heading(get_string("currentchats", 'chat').':', 3);
347         $oldest = floor((time() - $CFG->chat_old_ping) / 10) * 10;  // Better db caching.
349         $timeold    = time() - $CFG->chat_old_ping;
350         $timeold    = floor($timeold / 10) * 10;  // Better db caching.
351         $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
352         $timeoldext = floor($timeoldext / 10) * 10;  // Better db caching.
354         $params = array('timeold' => $timeold, 'timeoldext' => $timeoldext, 'cmid' => $cm->id);
356         $timeout = "AND ((chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext))";
358         foreach ($current as $cm) {
359             // Count users first.
360             $mygroupids = $modinfo->groups[$cm->groupingid];
361             if (!empty($mygroupids)) {
362                 list($subquery, $subparams) = $DB->get_in_or_equal($mygroupids, SQL_PARAMS_NAMED, 'gid');
363                 $params += $subparams;
364                 $groupselect = "AND (chu.groupid $subquery OR chu.groupid = 0)";
365             } else {
366                 $groupselect = "";
367             }
369             $userfields = user_picture::fields('u');
370             if (!$users = $DB->get_records_sql("SELECT $userfields
371                                                   FROM {course_modules} cm
372                                                   JOIN {chat} ch        ON ch.id = cm.instance
373                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
374                                                   JOIN {user} u         ON u.id = chu.userid
375                                                  WHERE cm.id = :cmid $timeout $groupselect
376                                               GROUP BY $userfields", $params)) {
377             }
379             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
380             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
382             echo '<div class="head"><div class="date">'.$date.'</div></div>';
383             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name, true).'</a></div>';
384             echo '<div class="userlist">';
385             if ($users) {
386                 echo '<ul>';
387                 foreach ($users as $user) {
388                     echo '<li>'.fullname($user, $viewfullnames).'</li>';
389                 }
390                 echo '</ul>';
391             }
392             echo '</div>';
393         }
394     }
396     return true;
399 /**
400  * Function to be run periodically according to the moodle cron
401  * This function searches for things that need to be done, such
402  * as sending out mail, toggling flags etc ...
403  *
404  * @global object
405  * @return bool
406  */
407 function chat_cron () {
408     global $DB;
410     chat_update_chat_times();
412     chat_delete_old_users();
414     // Delete old messages with a single SQL query.
415     $subselect = "SELECT c.keepdays
416                     FROM {chat} c
417                    WHERE c.id = {chat_messages}.chatid";
419     $sql = "DELETE
420               FROM {chat_messages}
421              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
423     $DB->execute($sql);
425     $sql = "DELETE
426               FROM {chat_messages_current}
427              WHERE timestamp < ( ".time()." - 8 * 3600)";
429     $DB->execute($sql);
431     return true;
434 /**
435  * This standard function will check all instances of this module
436  * and make sure there are up-to-date events created for each of them.
437  * If courseid = 0, then every chat event in the site is checked, else
438  * only chat events belonging to the course specified are checked.
439  * This function is used, in its new format, by restore_refresh_events()
440  *
441  * @global object
442  * @param int $courseid
443  * @param int|stdClass $instance Chat module instance or ID.
444  * @param int|stdClass $cm Course module object or ID.
445  * @return bool
446  */
447 function chat_refresh_events($courseid = 0, $instance = null, $cm = null) {
448     global $DB;
450     // If we have instance information then we can just update the one event instead of updating all events.
451     if (isset($instance)) {
452         if (!is_object($instance)) {
453             $instance = $DB->get_record('chat', array('id' => $instance), '*', MUST_EXIST);
454         }
455         if (isset($cm)) {
456             if (!is_object($cm)) {
457                 chat_prepare_update_events($instance);
458                 return true;
459             } else {
460                 chat_prepare_update_events($instance, $cm);
461                 return true;
462             }
463         }
464     }
466     if ($courseid) {
467         if (! $chats = $DB->get_records("chat", array("course" => $courseid))) {
468             return true;
469         }
470     } else {
471         if (! $chats = $DB->get_records("chat")) {
472             return true;
473         }
474     }
475     foreach ($chats as $chat) {
476         chat_prepare_update_events($chat);
477     }
478     return true;
481 /**
482  * Updates both the normal and completion calendar events for chat.
483  *
484  * @param  stdClass $chat The chat object (from the DB)
485  * @param  stdClass $cm The course module object.
486  */
487 function chat_prepare_update_events($chat, $cm = null) {
488     global $DB;
489     if (!isset($cm)) {
490         $cm = get_coursemodule_from_instance('chat', $chat->id, $chat->course);
491     }
492     $event = new stdClass();
493     $event->name        = $chat->name;
494     $event->type        = CALENDAR_EVENT_TYPE_ACTION;
495     $event->description = format_module_intro('chat', $chat, $cm->id);
496     $event->timestart   = $chat->chattime;
497     $event->timesort    = $chat->chattime;
498     if ($event->id = $DB->get_field('event', 'id', array('modulename' => 'chat', 'instance' => $chat->id,
499             'eventtype' => CHAT_EVENT_TYPE_CHATTIME))) {
500         $calendarevent = calendar_event::load($event->id);
501         $calendarevent->update($event);
502     } else if ($chat->schedule > 0) {
503         // The chat is scheduled and the event should be published.
504         $event->courseid    = $chat->course;
505         $event->groupid     = 0;
506         $event->userid      = 0;
507         $event->modulename  = 'chat';
508         $event->instance    = $chat->id;
509         $event->eventtype   = CHAT_EVENT_TYPE_CHATTIME;
510         $event->timeduration = 0;
511         $event->visible = $cm->visible;
512         calendar_event::create($event);
513     }
516 // Functions that require some SQL.
518 /**
519  * @global object
520  * @param int $chatid
521  * @param int $groupid
522  * @param int $groupingid
523  * @return array
524  */
525 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
526     global $DB;
528     $params = array('chatid' => $chatid, 'groupid' => $groupid, 'groupingid' => $groupingid);
530     if ($groupid) {
531         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
532     } else {
533         $groupselect = "";
534     }
536     if (!empty($groupingid)) {
537         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
538                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
540     } else {
541         $groupingjoin = '';
542     }
544     $ufields = user_picture::fields('u');
545     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
546                                    FROM {chat_users} c
547                                    JOIN {user} u ON u.id = c.userid $groupingjoin
548                                   WHERE c.chatid = :chatid $groupselect
549                                ORDER BY c.firstping ASC", $params);
552 /**
553  * @global object
554  * @param int $chatid
555  * @param int $groupid
556  * @return array
557  */
558 function chat_get_latest_message($chatid, $groupid=0) {
559     global $DB;
561     $params = array('chatid' => $chatid, 'groupid' => $groupid);
563     if ($groupid) {
564         $groupselect = "AND (groupid=:groupid OR groupid=0)";
565     } else {
566         $groupselect = "";
567     }
569     $sql = "SELECT *
570         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
571         ORDER BY timestamp DESC, id DESC";
573     // Return the lastest one message.
574     return $DB->get_record_sql($sql, $params, true);
577 /**
578  * login if not already logged in
579  *
580  * @global object
581  * @global object
582  * @param int $chatid
583  * @param string $version
584  * @param int $groupid
585  * @param object $course
586  * @return bool|int Returns the chat users sid or false
587  */
588 function chat_login_user($chatid, $version, $groupid, $course) {
589     global $USER, $DB;
591     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid' => $chatid,
592                                                                                     'userid' => $USER->id,
593                                                                                     'groupid' => $groupid))) {
594         // This will update logged user information.
595         $chatuser->version  = $version;
596         $chatuser->ip       = $USER->lastip;
597         $chatuser->lastping = time();
598         $chatuser->lang     = current_language();
600         // Sometimes $USER->lastip is not setup properly during login.
601         // Update with current value if possible or provide a dummy value for the db.
602         if (empty($chatuser->ip)) {
603             $chatuser->ip = getremoteaddr();
604         }
606         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
607             return false;
608         }
609         $DB->update_record('chat_users', $chatuser);
611     } else {
612         $chatuser = new stdClass();
613         $chatuser->chatid   = $chatid;
614         $chatuser->userid   = $USER->id;
615         $chatuser->groupid  = $groupid;
616         $chatuser->version  = $version;
617         $chatuser->ip       = $USER->lastip;
618         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
619         $chatuser->sid      = random_string(32);
620         $chatuser->course   = $course->id; // Caching - needed for current_language too.
621         $chatuser->lang     = current_language(); // Caching - to resource intensive to find out later.
623         // Sometimes $USER->lastip is not setup properly during login.
624         // Update with current value if possible or provide a dummy value for the db.
625         if (empty($chatuser->ip)) {
626             $chatuser->ip = getremoteaddr();
627         }
629         $DB->insert_record('chat_users', $chatuser);
631         if ($version == 'sockets') {
632             // Do not send 'enter' message, chatd will do it.
633         } else {
634             chat_send_chatmessage($chatuser, 'enter', true);
635         }
636     }
638     return $chatuser->sid;
641 /**
642  * Delete the old and in the way
643  *
644  * @global object
645  * @global object
646  */
647 function chat_delete_old_users() {
648     // Delete the old and in the way.
649     global $CFG, $DB;
651     $timeold = time() - $CFG->chat_old_ping;
652     $timeoldext = time() - ($CFG->chat_old_ping * 10); // JSless gui_basic needs much longer timeouts.
654     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
655     $params = array($timeold, $timeoldext);
657     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
658         $DB->delete_records_select('chat_users', $query, $params);
659         foreach ($oldusers as $olduser) {
660             chat_send_chatmessage($olduser, 'exit', true);
661         }
662     }
665 /**
666  * Updates chat records so that the next chat time is correct
667  *
668  * @global object
669  * @param int $chatid
670  * @return void
671  */
672 function chat_update_chat_times($chatid=0) {
673     // Updates chat records so that the next chat time is correct.
674     global $DB;
676     $timenow = time();
678     $params = array('timenow' => $timenow, 'chatid' => $chatid);
680     if ($chatid) {
681         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
682             return;
683         }
684     } else {
685         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
686             return;
687         }
688     }
690     foreach ($chats as $chat) {
691         switch ($chat->schedule) {
692             case 1: // Single event - turn off schedule and disable.
693                 $chat->chattime = 0;
694                 $chat->schedule = 0;
695                 break;
696             case 2: // Repeat daily.
697                 while ($chat->chattime <= $timenow) {
698                     $chat->chattime += 24 * 3600;
699                 }
700                 break;
701             case 3: // Repeat weekly.
702                 while ($chat->chattime <= $timenow) {
703                     $chat->chattime += 7 * 24 * 3600;
704                 }
705                 break;
706         }
707         $DB->update_record("chat", $chat);
709         $event = new stdClass(); // Update calendar too.
711         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
712         $params = array('chattime' => $chat->chattime, 'chatid' => $chat->id);
714         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
715             $event->timestart = $chat->chattime;
716             $event->timesort = $chat->chattime;
717             $calendarevent = calendar_event::load($event->id);
718             $calendarevent->update($event, false);
719         }
720     }
723 /**
724  * Send a message on the chat.
725  *
726  * @param object $chatuser The chat user record.
727  * @param string $messagetext The message to be sent.
728  * @param bool $issystem False for non-system messages, true for system messages.
729  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
730  * @return int The message ID.
731  * @since Moodle 2.6
732  */
733 function chat_send_chatmessage($chatuser, $messagetext, $issystem = false, $cm = null) {
734     global $DB;
736     $message = new stdClass();
737     $message->chatid    = $chatuser->chatid;
738     $message->userid    = $chatuser->userid;
739     $message->groupid   = $chatuser->groupid;
740     $message->message   = $messagetext;
741     $message->issystem  = $issystem ? 1 : 0;
742     $message->timestamp = time();
744     $messageid = $DB->insert_record('chat_messages', $message);
745     $DB->insert_record('chat_messages_current', $message);
746     $message->id = $messageid;
748     if (!$issystem) {
750         if (empty($cm)) {
751             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
752         }
754         $params = array(
755             'context' => context_module::instance($cm->id),
756             'objectid' => $message->id,
757             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
758             'relateduserid' => $chatuser->userid
759         );
760         $event = \mod_chat\event\message_sent::create($params);
761         $event->add_record_snapshot('chat_messages', $message);
762         $event->trigger();
763     }
765     return $message->id;
768 /**
769  * @global object
770  * @global object
771  * @param object $message
772  * @param int $courseid
773  * @param object $sender
774  * @param object $currentuser
775  * @param string $chatlastrow
776  * @return bool|string Returns HTML or false
777  */
778 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chatlastrow = null) {
779     global $CFG, $USER, $OUTPUT;
781     $output = new stdClass();
782     $output->beep = false;       // By default.
783     $output->refreshusers = false; // By default.
785     // Find the correct timezone for displaying this message.
786     $tz = core_date::get_user_timezone($currentuser);
788     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
790     $message->picture = $OUTPUT->user_picture($sender, array('size' => false, 'courseid' => $courseid, 'link' => false));
792     if ($courseid) {
793         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\"".
794                             " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
795     }
797     // Calculate the row class.
798     if ($chatlastrow !== null) {
799         $rowclass = ' class="r'.$chatlastrow.'" ';
800     } else {
801         $rowclass = '';
802     }
804     // Start processing the message.
806     if (!empty($message->issystem)) {
807         // System event.
808         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
809         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td>';
810         $output->html .= '<td class="text"><span class="event">'.$output->text.'</span></td></tr></table>';
811         $output->basic = '<tr class="r1">
812                             <th scope="row" class="cell c1 title"></th>
813                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
814                             <td class="cell c3">' . $message->strtime . '</td>
815                           </tr>';
816         if ($message->message == 'exit' or $message->message == 'enter') {
817             $output->refreshusers = true; // Force user panel refresh ASAP.
818         }
819         return $output;
820     }
822     // It's not a system event.
823     $rawtext = trim($message->message);
825     // Options for format_text, when we get to it...
826     // format_text call will parse the text to clean and filter it.
827     // It cannot be called here as HTML-isation interferes with special case
828     // recognition, but *must* be called on any user-sourced text to be inserted
829     // into $outmain.
830     $options = new stdClass();
831     $options->para = false;
832     $options->blanktarget = true;
834     // And now check for special cases.
835     $patternto = '#^\s*To\s([^:]+):(.*)#';
836     $special = false;
838     if (substr($rawtext, 0, 5) == 'beep ') {
839         // It's a beep!
840         $special = true;
841         $beepwho = trim(substr($rawtext, 5));
843         if ($beepwho == 'all') {   // Everyone.
844             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
845             $outinfo = $message->strtime . ': ' . $outinfobasic;
846             $outmain = '';
848             $output->beep = true;  // Eventually this should be set to a filename uploaded by the user.
850         } else if ($beepwho == $currentuser->id) {  // Current user.
851             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
852             $outinfo = $message->strtime . ': ' . $outinfobasic;
853             $outmain = '';
854             $output->beep = true;
856         } else {  // Something is not caught?
857             return false;
858         }
859     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
860         $special = true;
861         $pattern = '#(^\/)(\w+).*#';
862         preg_match($pattern, $rawtext, $matches);
863         $command = isset($matches[2]) ? $matches[2] : false;
864         // Support some IRC commands.
865         switch ($command) {
866             case 'me':
867                 $outinfo = $message->strtime;
868                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
869                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
870                 break;
871             default:
872                 // Error, we set special back to false to use the classic message output.
873                 $special = false;
874                 break;
875         }
876     } else if (preg_match($patternto, $rawtext)) {
877         $special = true;
878         $matches = array();
879         preg_match($patternto, $rawtext, $matches);
880         if (isset($matches[1]) && isset($matches[2])) {
881             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
882             $outinfo = $message->strtime;
883             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$text;
884         } else {
885             // Error, we set special back to false to use the classic message output.
886             $special = false;
887         }
888     }
890     if (!$special) {
891         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
892         $outinfo = $message->strtime.' '.$sender->firstname;
893         $outmain = $text;
894     }
896     // Format the message as a small table.
898     $output->text  = strip_tags($outinfo.': '.$outmain);
900     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td>";
901     $output->html .= "<td class=\"text\"><span class=\"title\">$outinfo</span>";
902     if ($outmain) {
903         $output->html .= ": $outmain";
904         $output->basic = '<tr class="r0">
905                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
906                             <td class="cell c2 text">' . $outmain . '</td>
907                             <td class="cell c3">' . $message->strtime . '</td>
908                           </tr>';
909     } else {
910         $output->basic = '<tr class="r1">
911                             <th scope="row" class="cell c1 title"></th>
912                             <td class="cell c2 text">' . $outinfobasic . '</td>
913                             <td class="cell c3">' . $message->strtime . '</td>
914                           </tr>';
915     }
916     $output->html .= "</td></tr></table>";
917     return $output;
920 /**
921  * Given a message object this function formats it appropriately into text and html then returns the formatted data
922  * @global object
923  * @param object $message
924  * @param int $courseid
925  * @param object $currentuser
926  * @param string $chatlastrow
927  * @return bool|string Returns HTML or false
928  */
929 function chat_format_message($message, $courseid, $currentuser, $chatlastrow=null) {
930     global $DB;
932     static $users;     // Cache user lookups.
934     if (isset($users[$message->userid])) {
935         $user = $users[$message->userid];
936     } else if ($user = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
937         $users[$message->userid] = $user;
938     } else {
939         return null;
940     }
941     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chatlastrow);
944 /**
945  * @global object
946  * @param object $message message to be displayed.
947  * @param mixed $chatuser user chat data
948  * @param object $currentuser current user for whom the message should be displayed.
949  * @param int $groupingid course module grouping id
950  * @param string $theme name of the chat theme.
951  * @return bool|string Returns HTML or false
952  */
953 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
954     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
955     require_once($CFG->dirroot.'/mod/chat/locallib.php');
957     static $users;     // Cache user lookups.
959     $result = new stdClass();
961     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
962         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
963     }
965     if (isset($users[$message->userid])) {
966         $sender = $users[$message->userid];
967     } else if ($sender = $DB->get_record('user', array('id' => $message->userid), user_picture::fields())) {
968         $users[$message->userid] = $sender;
969     } else {
970         return null;
971     }
973     // Find the correct timezone for displaying this message.
974     $tz = core_date::get_user_timezone($currentuser);
976     if (empty($chatuser->course)) {
977         $courseid = $COURSE->id;
978     } else {
979         $courseid = $chatuser->course;
980     }
982     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
983     $message->picture = $OUTPUT->user_picture($sender, array('courseid' => $courseid));
985     $message->picture = "<a target='_blank'".
986                         " href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
988     // Start processing the message.
989     if (!empty($message->issystem)) {
990         $result->type = 'system';
992         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
993         $event = get_string('message'.$message->message, 'chat', fullname($sender));
994         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
996         $output = $PAGE->get_renderer('mod_chat');
997         $result->html = $output->render($eventmessage);
999         return $result;
1000     }
1002     // It's not a system event.
1003     $rawtext = trim($message->message);
1005     // Options for format_text, when we get to it...
1006     // format_text call will parse the text to clean and filter it.
1007     // It cannot be called here as HTML-isation interferes with special case
1008     // recognition, but *must* be called on any user-sourced text to be inserted
1009     // into $outmain.
1010     $options = new stdClass();
1011     $options->para = false;
1012     $options->blanktarget = true;
1014     // And now check for special cases.
1015     $special = false;
1016     $outtime = $message->strtime;
1018     // Initialise variables.
1019     $outmain = '';
1020     $patternto = '#^\s*To\s([^:]+):(.*)#';
1022     if (substr($rawtext, 0, 5) == 'beep ') {
1023         $special = true;
1024         // It's a beep!
1025         $result->type = 'beep';
1026         $beepwho = trim(substr($rawtext, 5));
1028         if ($beepwho == 'all') {   // Everyone.
1029             $outmain = get_string('messagebeepseveryone', 'chat', fullname($sender));
1030         } else if ($beepwho == $currentuser->id) {  // Current user.
1031             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
1032         } else if ($sender->id == $currentuser->id) {  // Something is not caught?
1033             // Allow beep for a active chat user only, else user can beep anyone and get fullname.
1034             if (!empty($chatuser) && is_numeric($beepwho)) {
1035                 $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
1036                 if (array_key_exists($beepwho, $chatusers)) {
1037                     $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
1038                 } else {
1039                     $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1040                 }
1041             } else {
1042                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1043             }
1044         }
1045     } else if (substr($rawtext, 0, 1) == '/') {     // It's a user command.
1046         $special = true;
1047         $result->type = 'command';
1048         $pattern = '#(^\/)(\w+).*#';
1049         preg_match($pattern, $rawtext, $matches);
1050         $command = isset($matches[2]) ? $matches[2] : false;
1051         // Support some IRC commands.
1052         switch ($command) {
1053             case 'me':
1054                 $text = '*** <b>'.$sender->firstname.' '.substr($rawtext, 4).'</b>';
1055                 $outmain = format_text($text, FORMAT_MOODLE, $options, $courseid);
1056                 break;
1057             default:
1058                 // Error, we set special back to false to use the classic message output.
1059                 $special = false;
1060                 break;
1061         }
1062     } else if (preg_match($patternto, $rawtext)) {
1063         $special = true;
1064         $result->type = 'dialogue';
1065         $matches = array();
1066         preg_match($patternto, $rawtext, $matches);
1067         if (isset($matches[1]) && isset($matches[2])) {
1068             $text = format_text($matches[2], FORMAT_MOODLE, $options, $courseid);
1069             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$text;
1070         } else {
1071             // Error, we set special back to false to use the classic message output.
1072             $special = false;
1073         }
1074     }
1076     if (!$special) {
1077         $text = format_text($rawtext, FORMAT_MOODLE, $options, $courseid);
1078         $outmain = $text;
1079     }
1081     $result->text = strip_tags($outtime.': '.$outmain);
1083     $mymessageclass = '';
1084     if ($sender->id == $USER->id) {
1085         $mymessageclass = 'chat-message-mymessage';
1086     }
1088     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1089     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture,
1090                                     $mymessageclass, $outtime, $outmain, $theme);
1092     $output = $PAGE->get_renderer('mod_chat');
1093     $result->html = $output->render($usermessage);
1095     // When user beeps other user, then don't show any timestamp to other users in chat.
1096     if (('' === $outmain) && $special) {
1097         return false;
1098     } else {
1099         return $result;
1100     }
1103 /**
1104  * @global object $DB
1105  * @global object $CFG
1106  * @global object $COURSE
1107  * @global object $OUTPUT
1108  * @param object $users
1109  * @param object $course
1110  * @return array return formatted user list
1111  */
1112 function chat_format_userlist($users, $course) {
1113     global $CFG, $DB, $COURSE, $OUTPUT;
1114     $result = array();
1115     foreach ($users as $user) {
1116         $item = array();
1117         $item['name'] = fullname($user);
1118         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1119         $item['picture'] = $OUTPUT->user_picture($user);
1120         $item['id'] = $user->id;
1121         $result[] = $item;
1122     }
1123     return $result;
1126 /**
1127  * Print json format error
1128  * @param string $level
1129  * @param string $msg
1130  */
1131 function chat_print_error($level, $msg) {
1132     header('Content-Length: ' . ob_get_length() );
1133     $error = new stdClass();
1134     $error->level = $level;
1135     $error->msg   = $msg;
1136     $response['error'] = $error;
1137     echo json_encode($response);
1138     ob_end_flush();
1139     exit;
1142 /**
1143  * List the actions that correspond to a view of this module.
1144  * This is used by the participation report.
1145  *
1146  * Note: This is not used by new logging system. Event with
1147  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
1148  *       be considered as view action.
1149  *
1150  * @return array
1151  */
1152 function chat_get_view_actions() {
1153     return array('view', 'view all', 'report');
1156 /**
1157  * List the actions that correspond to a post of this module.
1158  * This is used by the participation report.
1159  *
1160  * Note: This is not used by new logging system. Event with
1161  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
1162  *       will be considered as post action.
1163  *
1164  * @return array
1165  */
1166 function chat_get_post_actions() {
1167     return array('talk');
1170 /**
1171  * @deprecated since 3.3
1172  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1173  * @global object
1174  * @global object
1175  * @param array $courses
1176  * @param array $htmlarray Passed by reference
1177  */
1178 function chat_print_overview($courses, &$htmlarray) {
1179     global $USER, $CFG;
1181     debugging('The function chat_print_overview() is now deprecated.', DEBUG_DEVELOPER);
1183     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1184         return array();
1185     }
1187     if (!$chats = get_all_instances_in_courses('chat', $courses)) {
1188         return;
1189     }
1191     $strchat = get_string('modulename', 'chat');
1192     $strnextsession  = get_string('nextsession', 'chat');
1194     foreach ($chats as $chat) {
1195         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled.
1196             $str = '<div class="chat overview"><div class="name">'.
1197                    $strchat.': <a '.($chat->visible ? '' : ' class="dimmed"').
1198                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1199                    $chat->name.'</a></div>';
1200             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1202             if (empty($htmlarray[$chat->course]['chat'])) {
1203                 $htmlarray[$chat->course]['chat'] = $str;
1204             } else {
1205                 $htmlarray[$chat->course]['chat'] .= $str;
1206             }
1207         }
1208     }
1212 /**
1213  * Implementation of the function for printing the form elements that control
1214  * whether the course reset functionality affects the chat.
1215  *
1216  * @param object $mform form passed by reference
1217  */
1218 function chat_reset_course_form_definition(&$mform) {
1219     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1220     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages', 'chat'));
1223 /**
1224  * Course reset form defaults.
1225  *
1226  * @param object $course
1227  * @return array
1228  */
1229 function chat_reset_course_form_defaults($course) {
1230     return array('reset_chat' => 1);
1233 /**
1234  * Actual implementation of the reset course functionality, delete all the
1235  * chat messages for course $data->courseid.
1236  *
1237  * @global object
1238  * @global object
1239  * @param object $data the data submitted from the reset course.
1240  * @return array status array
1241  */
1242 function chat_reset_userdata($data) {
1243     global $CFG, $DB;
1245     $componentstr = get_string('modulenameplural', 'chat');
1246     $status = array();
1248     if (!empty($data->reset_chat)) {
1249         $chatessql = "SELECT ch.id
1250                         FROM {chat} ch
1251                        WHERE ch.course=?";
1252         $params = array($data->courseid);
1254         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1255         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1256         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1257         $status[] = array('component' => $componentstr, 'item' => get_string('removemessages', 'chat'), 'error' => false);
1258     }
1260     // Updating dates - shift may be negative too.
1261     if ($data->timeshift) {
1262         // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
1263         // See MDL-9367.
1264         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1265         $status[] = array('component' => $componentstr, 'item' => get_string('datechanged'), 'error' => false);
1266     }
1268     return $status;
1271 /**
1272  * Returns all other caps used in module
1273  *
1274  * @return array
1275  */
1276 function chat_get_extra_capabilities() {
1277     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1281 /**
1282  * @param string $feature FEATURE_xx constant for requested feature
1283  * @return mixed True if module supports feature, null if doesn't know
1284  */
1285 function chat_supports($feature) {
1286     switch($feature) {
1287         case FEATURE_GROUPS:
1288             return true;
1289         case FEATURE_GROUPINGS:
1290             return true;
1291         case FEATURE_MOD_INTRO:
1292             return true;
1293         case FEATURE_BACKUP_MOODLE2:
1294             return true;
1295         case FEATURE_COMPLETION_TRACKS_VIEWS:
1296             return true;
1297         case FEATURE_GRADE_HAS_GRADE:
1298             return false;
1299         case FEATURE_GRADE_OUTCOMES:
1300             return true;
1301         case FEATURE_SHOW_DESCRIPTION:
1302             return true;
1303         default:
1304             return null;
1305     }
1308 function chat_extend_navigation($navigation, $course, $module, $cm) {
1309     global $CFG;
1311     $currentgroup = groups_get_activity_group($cm, true);
1313     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1314         $strenterchat    = get_string('enterchat', 'chat');
1316         $target = $CFG->wwwroot.'/mod/chat/';
1317         $params = array('id' => $cm->instance);
1319         if ($currentgroup) {
1320             $params['groupid'] = $currentgroup;
1321         }
1323         $links = array();
1325         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1326         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1327                                    array('height' => 500, 'width' => 700));
1328         $links[] = new action_link($url, $strenterchat, $action);
1330         $url = new moodle_url($target.'gui_basic/index.php', $params);
1331         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup,
1332                                    array('height' => 500, 'width' => 700));
1333         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1335         foreach ($links as $link) {
1336             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null , null, new pix_icon('i/group' , ''));
1337         }
1338     }
1340     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1341     if (is_array($chatusers) && count($chatusers) > 0) {
1342         $users = $navigation->add(get_string('currentusers', 'chat'));
1343         foreach ($chatusers as $chatuser) {
1344             $userlink = new moodle_url('/user/view.php', array('id' => $chatuser->id, 'course' => $course->id));
1345             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping),
1346                         $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1347         }
1348     }
1351 /**
1352  * Adds module specific settings to the settings block
1353  *
1354  * @param settings_navigation $settings The settings navigation object
1355  * @param navigation_node $chatnode The node to add module settings to
1356  */
1357 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1358     global $DB, $PAGE, $USER;
1359     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1361     if ($chat->chattime && $chat->schedule) {
1362         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').
1363                                           ': '.userdate($chat->chattime).
1364                                           ' ('.usertimezone($USER->timezone).')');
1365         $nextsessionnode->add_class('note');
1366     }
1368     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1369     if ($currentgroup) {
1370         $groupselect = " AND groupid = '$currentgroup'";
1371     } else {
1372         $groupselect = '';
1373     }
1375     if ($chat->studentlogs || has_capability('mod/chat:readlog', $PAGE->cm->context)) {
1376         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1377             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id' => $PAGE->cm->id)));
1378         }
1379     }
1382 /**
1383  * user logout event handler
1384  *
1385  * @param \core\event\user_loggedout $event The event.
1386  * @return void
1387  */
1388 function chat_user_logout(\core\event\user_loggedout $event) {
1389     global $DB;
1390     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1393 /**
1394  * Return a list of page types
1395  * @param string $pagetype current page type
1396  * @param stdClass $parentcontext Block's parent context
1397  * @param stdClass $currentcontext Current context of block
1398  */
1399 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1400     $modulepagetype = array('mod-chat-*' => get_string('page-mod-chat-x', 'chat'));
1401     return $modulepagetype;
1404 /**
1405  * Return a list of the latest messages in the given chat session.
1406  *
1407  * @param  stdClass $chatuser     chat user session data
1408  * @param  int      $chatlasttime last time messages were retrieved
1409  * @return array    list of messages
1410  * @since  Moodle 3.0
1411  */
1412 function chat_get_latest_messages($chatuser, $chatlasttime) {
1413     global $DB;
1415     $params = array('groupid' => $chatuser->groupid, 'chatid' => $chatuser->chatid, 'lasttime' => $chatlasttime);
1417     $groupselect = $chatuser->groupid ? " AND (groupid=" . $chatuser->groupid . " OR groupid=0) " : "";
1419     return $DB->get_records_select('chat_messages_current', 'chatid = :chatid AND timestamp > :lasttime ' . $groupselect,
1420                                     $params, 'timestamp ASC');
1423 /**
1424  * Mark the activity completed (if required) and trigger the course_module_viewed event.
1425  *
1426  * @param  stdClass $chat       chat object
1427  * @param  stdClass $course     course object
1428  * @param  stdClass $cm         course module object
1429  * @param  stdClass $context    context object
1430  * @since Moodle 3.0
1431  */
1432 function chat_view($chat, $course, $cm, $context) {
1434     // Trigger course_module_viewed event.
1435     $params = array(
1436         'context' => $context,
1437         'objectid' => $chat->id
1438     );
1440     $event = \mod_chat\event\course_module_viewed::create($params);
1441     $event->add_record_snapshot('course_modules', $cm);
1442     $event->add_record_snapshot('course', $course);
1443     $event->add_record_snapshot('chat', $chat);
1444     $event->trigger();
1446     // Completion.
1447     $completion = new completion_info($course);
1448     $completion->set_module_viewed($cm);
1451 /**
1452  * This function receives a calendar event and returns the action associated with it, or null if there is none.
1453  *
1454  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
1455  * is not displayed on the block.
1456  *
1457  * @param calendar_event $event
1458  * @param \core_calendar\action_factory $factory
1459  * @return \core_calendar\local\event\entities\action_interface|null
1460  */
1461 function mod_chat_core_calendar_provide_event_action(calendar_event $event,
1462                                                      \core_calendar\action_factory $factory) {
1463     global $DB;
1465     $cm = get_fast_modinfo($event->courseid)->instances['chat'][$event->instance];
1466     $chattime = $DB->get_field('chat', 'chattime', array('id' => $event->instance));
1467     $chattimemidnight = usergetmidnight($chattime);
1468     $todaymidnight = usergetmidnight(time());
1470     if ($chattime < $todaymidnight) {
1471         // The chat is before today. Do not show at all.
1472         return null;
1473     } else {
1474         // The chat is actionable if it is at some point today.
1475         $actionable = $chattimemidnight == $todaymidnight;
1477         return $factory->create_instance(
1478             get_string('enterchat', 'chat'),
1479             new \moodle_url('/mod/chat/view.php', array('id' => $cm->id)),
1480             1,
1481             $actionable
1482         );
1483     }
1486 /**
1487  * Given a set of messages for a chat, return the completed chat sessions (including optionally not completed ones).
1488  *
1489  * @param  array $messages list of messages from a chat
1490  * @param  bool $showall   whether to include incomplete sessions or not
1491  * @return array           the list of sessions
1492  * @since  Moodle 3.4
1493  */
1494 function chat_get_sessions($messages, $showall = false) {
1495     $sessions     = array();
1496     $sessiongap   = 5 * 60;    // 5 minutes silence means a new session.
1497     $sessionend   = 0;
1498     $sessionstart = 0;
1499     $sessionusers = array();
1500     $lasttime     = 0;
1502     $messagesleft = count($messages);
1504     foreach ($messages as $message) {  // We are walking BACKWARDS through the messages.
1506         $messagesleft --;              // Countdown.
1508         if (!$lasttime) {
1509             $lasttime = $message->timestamp;
1510         }
1511         if (!$sessionend) {
1512             $sessionend = $message->timestamp;
1513         }
1514         if ((($lasttime - $message->timestamp) < $sessiongap) and $messagesleft) {  // Same session.
1515             if ($message->userid and !$message->issystem) {       // Remember user and count messages.
1516                 if (empty($sessionusers[$message->userid])) {
1517                     $sessionusers[$message->userid] = 1;
1518                 } else {
1519                     $sessionusers[$message->userid] ++;
1520                 }
1521             }
1522         } else {
1523             $sessionstart = $lasttime;
1525             $iscomplete = ($sessionend - $sessionstart > 60 and count($sessionusers) > 1);
1526             if ($showall or $iscomplete) {
1527                 $sessions[] = (object) array(
1528                     'sessionstart' => $sessionstart,
1529                     'sessionend' => $sessionend,
1530                     'sessionusers' => $sessionusers,
1531                     'iscomplete' => $iscomplete,
1532                 );
1533             }
1535             $sessionend = $message->timestamp;
1536             $sessionusers = array();
1537             $sessionusers[$message->userid] = 1;
1538         }
1539         $lasttime = $message->timestamp;
1540     }
1541     return $sessions;
1544 /**
1545  * Return the messages of the given chat session.
1546  *
1547  * @param  int $chatid      the chat id
1548  * @param  mixed $group     false if groups not used, int if groups used, 0 means all groups
1549  * @param  int $start       the session start timestamp (0 to not filter by time)
1550  * @param  int $end         the session end timestamp (0 to not filter by time)
1551  * @param  string $sort     an order to sort the results in (optional, a valid SQL ORDER BY parameter)
1552  * @return array session messages
1553  * @since  Moodle 3.4
1554  */
1555 function chat_get_session_messages($chatid, $group = false, $start = 0, $end = 0, $sort = '') {
1556     global $DB;
1558     $params = array('chatid' => $chatid);
1560     // If the user is allocated to a group, only show messages from people in the same group, or no group.
1561     if ($group) {
1562         $groupselect = " AND (groupid = :currentgroup OR groupid = 0)";
1563         $params['currentgroup'] = $group;
1564     } else {
1565         $groupselect = "";
1566     }
1568     $select = "chatid = :chatid $groupselect";
1569     if (!empty($start)) {
1570         $select .= ' AND timestamp >= :start';
1571         $params['start'] = $start;
1572     }
1573     if (!empty($end)) {
1574         $select .= ' AND timestamp <= :end';
1575         $params['end'] = $end;
1576     }
1578     return $DB->get_records_select('chat_messages', $select, $params, $sort);