c51d33ee34e5b386ecd0732234e0805aa2410b09
[moodle.git] / mod / chat / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module chat
20  *
21  * @package   mod-chat
22  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once($CFG->dirroot.'/calendar/lib.php');
28 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output
29 global $CHAT_HTMLHEAD;
30 $CHAT_HTMLHEAD = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head></head>\n<body>\n\n".padding(200);
32 // The HTML head for the message window to start with (with js scrolling)
33 global $CHAT_HTMLHEAD_JS;
34 $CHAT_HTMLHEAD_JS = <<<EOD
35 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
36 <html><head><script type="text/javascript">
37 //<![CDATA[
38 function move(){
39     if (scroll_active)
40         window.scroll(1,400000);
41     window.setTimeout("move()",100);
42 }
43 var scroll_active = true;
44 move();
45 //]]>
46 </script>
47 </head>
48 <body onBlur="scroll_active = true" onFocus="scroll_active = false">
49 EOD;
50 global $CHAT_HTMLHEAD_JS;
51 $CHAT_HTMLHEAD_JS .= padding(200);
53 // The HTML code for standard empty pages (e.g. if a user was kicked out)
54 global $CHAT_HTMLHEAD_OUT;
55 $CHAT_HTMLHEAD_OUT = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head><title>You are out!</title></head><body></body></html>";
57 // The HTML head for the message input page
58 global $CHAT_HTMLHEAD_MSGINPUT;
59 $CHAT_HTMLHEAD_MSGINPUT = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head><title>Message Input</title></head><body>";
61 // The HTML code for the message input page, with JavaScript
62 global $CHAT_HTMLHEAD_MSGINPUT_JS;
63 $CHAT_HTMLHEAD_MSGINPUT_JS = <<<EOD
64 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
65 <html>
66     <head><title>Message Input</title>
67     <script type="text/javascript">
68     //<![CDATA[
69     scroll_active = true;
70     function empty_field_and_submit(){
71         document.fdummy.arsc_message.value=document.f.arsc_message.value;
72         document.fdummy.submit();
73         document.f.arsc_message.focus();
74         document.f.arsc_message.select();
75         return false;
76     }
77     //]]>
78     </script>
79     </head><body OnLoad="document.f.arsc_message.focus();document.f.arsc_message.select();">;
80 EOD;
82 // Dummy data that gets output to the browser as needed, in order to make it show output
83 global $CHAT_DUMMY_DATA;
84 $CHAT_DUMMY_DATA = padding(200);
86 /**
87  * @param int $n
88  * @return string
89  */
90 function padding($n){
91     $str = '';
92     for($i=0; $i<$n; $i++){
93         $str.="<!-- nix -->\n";
94     }
95     return $str;
96 }
98 /**
99  * Given an object containing all the necessary data,
100  * (defined by the form in mod_form.php) this function
101  * will create a new instance and return the id number
102  * of the new instance.
103  *
104  * @global object
105  * @param object $chat
106  * @return int
107  */
108 function chat_add_instance($chat) {
109     global $DB;
111     $chat->timemodified = time();
113     $returnid = $DB->insert_record("chat", $chat);
115     $event = new stdClass();
116     $event->name        = $chat->name;
117     $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
118     $event->courseid    = $chat->course;
119     $event->groupid     = 0;
120     $event->userid      = 0;
121     $event->modulename  = 'chat';
122     $event->instance    = $returnid;
123     $event->eventtype   = 'chattime';
124     $event->timestart   = $chat->chattime;
125     $event->timeduration = 0;
127     calendar_event::create($event);
129     return $returnid;
132 /**
133  * Given an object containing all the necessary data,
134  * (defined by the form in mod_form.php) this function
135  * will update an existing instance with new data.
136  *
137  * @global object
138  * @param object $chat
139  * @return bool
140  */
141 function chat_update_instance($chat) {
142     global $DB;
144     $chat->timemodified = time();
145     $chat->id = $chat->instance;
148     $DB->update_record("chat", $chat);
150     $event = new stdClass();
152     if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id))) {
154         $event->name        = $chat->name;
155         $event->description = format_module_intro('chat', $chat, $chat->coursemodule);
156         $event->timestart   = $chat->chattime;
158         $calendarevent = calendar_event::load($event->id);
159         $calendarevent->update($event);
160     }
162     return true;
165 /**
166  * Given an ID of an instance of this module,
167  * this function will permanently delete the instance
168  * and any data that depends on it.
169  *
170  * @global object
171  * @param int $id
172  * @return bool
173  */
174 function chat_delete_instance($id) {
175     global $DB;
178     if (! $chat = $DB->get_record('chat', array('id'=>$id))) {
179         return false;
180     }
182     $result = true;
184     // Delete any dependent records here
186     if (! $DB->delete_records('chat', array('id'=>$chat->id))) {
187         $result = false;
188     }
189     if (! $DB->delete_records('chat_messages', array('chatid'=>$chat->id))) {
190         $result = false;
191     }
192     if (! $DB->delete_records('chat_messages_current', array('chatid'=>$chat->id))) {
193         $result = false;
194     }
195     if (! $DB->delete_records('chat_users', array('chatid'=>$chat->id))) {
196         $result = false;
197     }
199     if (! $DB->delete_records('event', array('modulename'=>'chat', 'instance'=>$chat->id))) {
200         $result = false;
201     }
203     return $result;
206 /**
207  * Return a small object with summary information about what a
208  * user has done with a given particular instance of this module
209  * Used for user activity reports.
210  * <code>
211  * $return->time = the time they did it
212  * $return->info = a short text description
213  * </code>
214  *
215  * @param object $course
216  * @param object $user
217  * @param object $mod
218  * @param object $chat
219  * @return void
220  */
221 function chat_user_outline($course, $user, $mod, $chat) {
222     return NULL;
225 /**
226  * Print a detailed representation of what a  user has done with
227  * a given particular instance of this module, for user activity reports.
228  *
229  * @param object $course
230  * @param object $user
231  * @param object $mod
232  * @param object $chat
233  * @return bool
234  */
235 function chat_user_complete($course, $user, $mod, $chat) {
236     return true;
239 /**
240  * Given a course and a date, prints a summary of all chat rooms past and present
241  * This function is called from block_recent_activity
242  *
243  * @global object
244  * @global object
245  * @global object
246  * @param object $course
247  * @param bool $viewfullnames
248  * @param int|string $timestart Timestamp
249  * @return bool
250  */
251 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
252     global $CFG, $USER, $DB, $OUTPUT;
254     // this is approximate only, but it is really fast ;-)
255     $timeout = $CFG->chat_old_ping * 10;
257     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
258                                          FROM {course_modules} cm
259                                          JOIN {modules} md        ON md.id = cm.module
260                                          JOIN {chat} ch           ON ch.id = cm.instance
261                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
262                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
263                                      GROUP BY cm.id
264                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
265          return false;
266     }
268     $past     = array();
269     $current  = array();
270     $modinfo = get_fast_modinfo($course); // reference needed because we might load the groups
272     foreach ($mcms as $cmid=>$mcm) {
273         if (!array_key_exists($cmid, $modinfo->cms)) {
274             continue;
275         }
276         $cm = $modinfo->cms[$cmid];
277         if (!$modinfo->cms[$cm->id]->uservisible) {
278             continue;
279         }
281         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
282          or has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
283             if ($timeout > time() - $mcm->lasttime) {
284                 $current[] = $cm;
285             } else {
286                 $past[] = $cm;
287             }
289             continue;
290         }
292         if (is_null($modinfo->groups)) {
293             $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
294         }
296         // verify groups in separate mode
297         if (!$mygroupids = $modinfo->groups[$cm->groupingid]) {
298             continue;
299         }
301         // ok, last post was not for my group - we have to query db to get last message from one of my groups
302         // only minor problem is that the order will not be correct
303         $mygroupids = implode(',', $mygroupids);
304         $cm->mygroupids = $mygroupids;
306         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
307                                            FROM {course_modules} cm
308                                            JOIN {chat} ch           ON ch.id = cm.instance
309                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
310                                           WHERE chm.timestamp > ? AND cm.id = ? AND
311                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
312                                        GROUP BY cm.id", array($timestart, $cm->id))) {
313              continue;
314         }
316         $mcms[$cmid]->lasttime = $mcm->lasttime;
317         if ($timeout > time() - $mcm->lasttime) {
318             $current[] = $cm;
319         } else {
320             $past[] = $cm;
321         }
322     }
324     if (!$past and !$current) {
325         return false;
326     }
328     $strftimerecent = get_string('strftimerecent');
330     if ($past) {
331         echo $OUTPUT->heading(get_string("pastchats", 'chat').':');
333         foreach ($past as $cm) {
334             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
335             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
336             echo '<div class="head"><div class="date">'.$date.'</div></div>';
337             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
338         }
339     }
341     if ($current) {
342         echo $OUTPUT->heading(get_string("currentchats", 'chat').':');
344         $oldest = floor((time()-$CFG->chat_old_ping)/10)*10;  // better db caching
346         $timeold    = time() - $CFG->chat_old_ping;
347         $timeold    = floor($timeold/10)*10;  // better db caching
348         $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
349         $timeoldext = floor($timeoldext/10)*10;  // better db caching
351         $params = array('timeold'=>$timeold, 'timeoldext'=>$timeoldext, 'cmid'=>$cm->id);
353         $timeout = "AND (chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext)";
355         foreach ($current as $cm) {
356             //count users first
357             if (isset($cm->mygroupids)) {
358                 $groupselect = "AND (chu.groupid IN ({$cm->mygroupids}) OR chu.groupid = 0)";
359             } else {
360                 $groupselect = "";
361             }
363             if (!$users = $DB->get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email, u.picture
364                                                   FROM {course_modules} cm
365                                                   JOIN {chat} ch        ON ch.id = cm.instance
366                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
367                                                   JOIN {user} u         ON u.id = chu.userid
368                                                  WHERE cm.id = :cmid $timeout $groupselect
369                                               GROUP BY u.id, u.firstname, u.lastname, u.email, u.picture", $params)) {
370             }
372             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
373             $date = userdate($mcms[$cm->id]->lasttime, $strftimerecent);
375             echo '<div class="head"><div class="date">'.$date.'</div></div>';
376             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
377             echo '<div class="userlist">';
378             if ($users) {
379                 echo '<ul>';
380                     foreach ($users as $user) {
381                         echo '<li>'.fullname($user, $viewfullnames).'</li>';
382                     }
383                 echo '</ul>';
384             }
385             echo '</div>';
386         }
387     }
389     return true;
392 /**
393  * Function to be run periodically according to the moodle cron
394  * This function searches for things that need to be done, such
395  * as sending out mail, toggling flags etc ...
396  *
397  * @global object
398  * @return bool
399  */
400 function chat_cron () {
401     global $DB;
403     chat_update_chat_times();
405     chat_delete_old_users();
407     /// Delete old messages with a
408     /// single SQL query.
409     $subselect = "SELECT c.keepdays
410                     FROM {chat} c
411                    WHERE c.id = {chat_messages}.chatid";
413     $sql = "DELETE
414               FROM {chat_messages}
415              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
417     $DB->execute($sql);
419     $sql = "DELETE
420               FROM {chat_messages_current}
421              WHERE timestamp < ( ".time()." - 8 * 3600)";
423     $DB->execute($sql);
425     return true;
428 /**
429  * This standard function will check all instances of this module
430  * and make sure there are up-to-date events created for each of them.
431  * If courseid = 0, then every chat event in the site is checked, else
432  * only chat events belonging to the course specified are checked.
433  * This function is used, in its new format, by restore_refresh_events()
434  *
435  * @global object
436  * @param int $courseid
437  * @return bool
438  */
439 function chat_refresh_events($courseid = 0) {
440     global $DB;
442     if ($courseid) {
443         if (! $chats = $DB->get_records("chat", array("course"=>$courseid))) {
444             return true;
445         }
446     } else {
447         if (! $chats = $DB->get_records("chat")) {
448             return true;
449         }
450     }
451     $moduleid = $DB->get_field('modules', 'id', array('name'=>'chat'));
453     foreach ($chats as $chat) {
454         $cm = get_coursemodule_from_id('chat', $chat->id);
455         $event = new stdClass();
456         $event->name        = $chat->name;
457         $event->description = format_module_intro('chat', $chat, $cm->id);
458         $event->timestart   = $chat->chattime;
460         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id))) {
461             $calendarevent = calendar_event::load($event->id);
462             $calendarevent->update($event);
463         } else {
464             $event->courseid    = $chat->course;
465             $event->groupid     = 0;
466             $event->userid      = 0;
467             $event->modulename  = 'chat';
468             $event->instance    = $chat->id;
469             $event->eventtype   = 'chattime';
470             $event->timeduration = 0;
471             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$chat->id));
473             calendar_event::create($event);
474         }
475     }
476     return true;
480 //////////////////////////////////////////////////////////////////////
481 /// Functions that require some SQL
483 /**
484  * @global object
485  * @param int $chatid
486  * @param int $groupid
487  * @param int $groupingid
488  * @return array
489  */
490 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
491     global $DB;
493     $params = array('chatid'=>$chatid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
495     if ($groupid) {
496         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
497     } else {
498         $groupselect = "";
499     }
501     if (!empty($groupingid)) {
502         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
503                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
505     } else {
506         $groupingjoin = '';
507     }
509     $ufields = user_picture::fields('u');
510     return $DB->get_records_sql("SELECT DISTINCT $ufields, c.lastmessageping, c.firstping
511                                    FROM {chat_users} c
512                                    JOIN {user} u ON u.id = c.userid $groupingjoin
513                                   WHERE c.chatid = :chatid $groupselect
514                                ORDER BY c.firstping ASC", $params);
517 /**
518  * @global object
519  * @param int $chatid
520  * @param int $groupid
521  * @return array
522  */
523 function chat_get_latest_message($chatid, $groupid=0) {
524     global $DB;
526     $params = array('chatid'=>$chatid, 'groupid'=>$groupid);
528     if ($groupid) {
529         $groupselect = "AND (groupid=:groupid OR groupid=0)";
530     } else {
531         $groupselect = "";
532     }
534     $sql = "SELECT *
535         FROM {chat_messages_current} WHERE chatid = :chatid $groupselect
536         ORDER BY timestamp DESC";
538     // return the lastest one message
539     return $DB->get_record_sql($sql, $params, true);
543 //////////////////////////////////////////////////////////////////////
544 // login if not already logged in
546 /**
547  * login if not already logged in
548  *
549  * @global object
550  * @global object
551  * @param int $chatid
552  * @param string $version
553  * @param int $groupid
554  * @param object $course
555  * @return bool|int Returns the chat users sid or false
556  */
557 function chat_login_user($chatid, $version, $groupid, $course) {
558     global $USER, $DB;
560     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid'=>$chatid, 'userid'=>$USER->id, 'groupid'=>$groupid))) {
561         // this will update logged user information
562         $chatuser->version  = $version;
563         $chatuser->ip       = $USER->lastip;
564         $chatuser->lastping = time();
565         $chatuser->lang     = current_language();
567         // Sometimes $USER->lastip is not setup properly
568         // during login. Update with current value if possible
569         // or provide a dummy value for the db
570         if (empty($chatuser->ip)) {
571             $chatuser->ip = getremoteaddr();
572         }
574         if (($chatuser->course != $course->id) or ($chatuser->userid != $USER->id)) {
575             return false;
576         }
577         $DB->update_record('chat_users', $chatuser);
579     } else {
580         $chatuser = new stdClass();
581         $chatuser->chatid   = $chatid;
582         $chatuser->userid   = $USER->id;
583         $chatuser->groupid  = $groupid;
584         $chatuser->version  = $version;
585         $chatuser->ip       = $USER->lastip;
586         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
587         $chatuser->sid      = random_string(32);
588         $chatuser->course   = $course->id; //caching - needed for current_language too
589         $chatuser->lang     = current_language(); //caching - to resource intensive to find out later
591         // Sometimes $USER->lastip is not setup properly
592         // during login. Update with current value if possible
593         // or provide a dummy value for the db
594         if (empty($chatuser->ip)) {
595             $chatuser->ip = getremoteaddr();
596         }
599         $DB->insert_record('chat_users', $chatuser);
601         if ($version == 'sockets') {
602             // do not send 'enter' message, chatd will do it
603         } else {
604             chat_send_chatmessage($chatuser, 'enter', true);
605         }
606     }
608     return $chatuser->sid;
611 /**
612  * Delete the old and in the way
613  *
614  * @global object
615  * @global object
616  */
617 function chat_delete_old_users() {
618 // Delete the old and in the way
619     global $CFG, $DB;
621     $timeold = time() - $CFG->chat_old_ping;
622     $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
624     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
625     $params = array($timeold, $timeoldext);
627     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
628         $DB->delete_records_select('chat_users', $query, $params);
629         foreach ($oldusers as $olduser) {
630             chat_send_chatmessage($olduser, 'exit', true);
631         }
632     }
635 /**
636  * Updates chat records so that the next chat time is correct
637  *
638  * @global object
639  * @param int $chatid
640  * @return void
641  */
642 function chat_update_chat_times($chatid=0) {
643 /// Updates chat records so that the next chat time is correct
644     global $DB;
646     $timenow = time();
648     $params = array('timenow'=>$timenow, 'chatid'=>$chatid);
650     if ($chatid) {
651         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
652             return;
653         }
654     } else {
655         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
656             return;
657         }
658     }
660     foreach ($chats as $chat) {
661         switch ($chat->schedule) {
662             case 1: // Single event - turn off schedule and disable
663                     $chat->chattime = 0;
664                     $chat->schedule = 0;
665                     break;
666             case 2: // Repeat daily
667                     while ($chat->chattime <= $timenow) {
668                         $chat->chattime += 24 * 3600;
669                     }
670                     break;
671             case 3: // Repeat weekly
672                     while ($chat->chattime <= $timenow) {
673                         $chat->chattime += 7 * 24 * 3600;
674                     }
675                     break;
676         }
677         $DB->update_record("chat", $chat);
679         $event = new stdClass();           // Update calendar too
681         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
682         $params = array('chattime'=>$chat->chattime, 'chatid'=>$chatid);
684         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
685             $event->timestart   = $chat->chattime;
686             $calendarevent = calendar_event::load($event->id);
687             $calendarevent->update($event, false);
688         }
689     }
692 /**
693  * Send a message on the chat.
694  *
695  * @param object $chatuser The chat user record.
696  * @param string $messagetext The message to be sent.
697  * @param bool $system False for non-system messages, true for system messages.
698  * @param object $cm The course module object, pass it to save a database query when we trigger the event.
699  * @return int The message ID.
700  * @since 2.6
701  */
702 function chat_send_chatmessage($chatuser, $messagetext, $system = false, $cm = null) {
703     global $DB;
705     $message = new stdClass();
706     $message->chatid    = $chatuser->chatid;
707     $message->userid    = $chatuser->userid;
708     $message->groupid   = $chatuser->groupid;
709     $message->message   = $messagetext;
710     $message->system    = $system ? 1 : 0;
711     $message->timestamp = time();
713     $messageid = $DB->insert_record('chat_messages', $message);
714     $DB->insert_record('chat_messages_current', $message);
715     $message->id = $messageid;
717     if (!$system) {
719         if (empty($cm)) {
720             $cm = get_coursemodule_from_instance('chat', $chatuser->chatid, $chatuser->course);
721         }
723         $params = array(
724             'context' => context_module::instance($cm->id),
725             'objectid' => $message->id,
726             // We set relateduserid, because when triggered from the chat daemon, the event userid is null.
727             'relateduserid' => $chatuser->userid
728         );
729         $event = \mod_chat\event\message_sent::create($params);
730         $event->add_record_snapshot('chat_messages', $message);
731         $event->trigger();
732     }
734     return $message->id;
737 /**
738  * @global object
739  * @global object
740  * @param object $message
741  * @param int $courseid
742  * @param object $sender
743  * @param object $currentuser
744  * @param string $chat_lastrow
745  * @return bool|string Returns HTML or false
746  */
747 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
748     global $CFG, $USER, $OUTPUT;
750     $output = new stdClass();
751     $output->beep = false;       // by default
752     $output->refreshusers = false; // by default
754     // Use get_user_timezone() to find the correct timezone for displaying this message:
755     // It's either the current user's timezone or else decided by some Moodle config setting
756     // First, "reset" $USER->timezone (which could have been set by a previous call to here)
757     // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
758     $USER->timezone = 99;
759     $tz = get_user_timezone($currentuser->timezone);
761     // Before formatting the message time string, set $USER->timezone to the above.
762     // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
763     // message times appear off because DST is not taken into account when it should be.
764     $USER->timezone = $tz;
765     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
767     $message->picture = $OUTPUT->user_picture($sender, array('size'=>false, 'courseid'=>$courseid, 'link'=>false));
769     if ($courseid) {
770         $message->picture = "<a onclick=\"window.open('$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid')\" href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
771     }
773     //Calculate the row class
774     if ($chat_lastrow !== NULL) {
775         $rowclass = ' class="r'.$chat_lastrow.'" ';
776     } else {
777         $rowclass = '';
778     }
780     // Start processing the message
782     if(!empty($message->system)) {
783         // System event
784         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
785         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td><td class="text">';
786         $output->html .= '<span class="event">'.$output->text.'</span></td></tr></table>';
787         $output->basic = '<tr class="r1">
788                             <th scope="row" class="cell c1 title"></th>
789                             <td class="cell c2 text">' . get_string('message'.$message->message, 'chat', fullname($sender)) . '</td>
790                             <td class="cell c3">' . $message->strtime . '</td>
791                           </tr>';
792         if($message->message == 'exit' or $message->message == 'enter') {
793             $output->refreshusers = true; //force user panel refresh ASAP
794         }
795         return $output;
796     }
798     // It's not a system event
799     $text = trim($message->message);
801     /// Parse the text to clean and filter it
802     $options = new stdClass();
803     $options->para = false;
804     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
806     // And now check for special cases
807     $patternTo = '#^\s*To\s([^:]+):(.*)#';
808     $special = false;
810     if (substr($text, 0, 5) == 'beep ') {
811         /// It's a beep!
812         $special = true;
813         $beepwho = trim(substr($text, 5));
815         if ($beepwho == 'all') {   // everyone
816             $outinfobasic = get_string('messagebeepseveryone', 'chat', fullname($sender));
817             $outinfo = $message->strtime . ': ' . $outinfobasic;
818             $outmain = '';
820             $output->beep = true;  // (eventually this should be set to
821                                    //  to a filename uploaded by the user)
823         } else if ($beepwho == $currentuser->id) {  // current user
824             $outinfobasic = get_string('messagebeepsyou', 'chat', fullname($sender));
825             $outinfo = $message->strtime . ': ' . $outinfobasic;
826             $outmain = '';
827             $output->beep = true;
829         } else {  //something is not caught?
830             return false;
831         }
832     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
833         $special = true;
834         $pattern = '#(^\/)(\w+).*#';
835         preg_match($pattern, $text, $matches);
836         $command = isset($matches[2]) ? $matches[2] : false;
837         // Support some IRC commands.
838         switch ($command){
839             case 'me':
840                 $outinfo = $message->strtime;
841                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
842                 break;
843             default:
844                 // Error, we set special back to false to use the classic message output.
845                 $special = false;
846                 break;
847         }
848     } else if (preg_match($patternTo, $text)) {
849         $special = true;
850         $matches = array();
851         preg_match($patternTo, $text, $matches);
852         if (isset($matches[1]) && isset($matches[2])) {
853             $outinfo = $message->strtime;
854             $outmain = $sender->firstname.' '.get_string('saidto', 'chat').' <i>'.$matches[1].'</i>: '.$matches[2];
855         } else {
856             // Error, we set special back to false to use the classic message output.
857             $special = false;
858         }
859     }
861     if(!$special) {
862         $outinfo = $message->strtime.' '.$sender->firstname;
863         $outmain = $text;
864     }
866     /// Format the message as a small table
868     $output->text  = strip_tags($outinfo.': '.$outmain);
870     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
871     $output->html .= "<span class=\"title\">$outinfo</span>";
872     if ($outmain) {
873         $output->html .= ": $outmain";
874         $output->basic = '<tr class="r0">
875                             <th scope="row" class="cell c1 title">' . $sender->firstname . '</th>
876                             <td class="cell c2 text">' . $outmain . '</td>
877                             <td class="cell c3">' . $message->strtime . '</td>
878                           </tr>';
879     } else {
880         $output->basic = '<tr class="r1">
881                             <th scope="row" class="cell c1 title"></th>
882                             <td class="cell c2 text">' . $outinfobasic . '</td>
883                             <td class="cell c3">' . $message->strtime . '</td>
884                           </tr>';
885     }
886     $output->html .= "</td></tr></table>";
887     return $output;
890 /**
891  * @global object
892  * @param object $message
893  * @param int $courseid
894  * @param object $currentuser
895  * @param string $chat_lastrow
896  * @return bool|string Returns HTML or false
897  */
898 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
899 /// Given a message object full of information, this function
900 /// formats it appropriately into text and html, then
901 /// returns the formatted data.
902     global $DB;
904     static $users;     // Cache user lookups
906     if (isset($users[$message->userid])) {
907         $user = $users[$message->userid];
908     } else if ($user = $DB->get_record('user', array('id'=>$message->userid), user_picture::fields())) {
909         $users[$message->userid] = $user;
910     } else {
911         return NULL;
912     }
913     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
916 /**
917  * @global object
918  * @param object $message message to be displayed.
919  * @param mixed $chatuser user chat data
920  * @param object $currentuser current user for whom the message should be displayed.
921  * @param int $groupingid course module grouping id
922  * @param string $theme name of the chat theme.
923  * @return bool|string Returns HTML or false
924  */
925 function chat_format_message_theme ($message, $chatuser, $currentuser, $groupingid, $theme = 'bubble') {
926     global $CFG, $USER, $OUTPUT, $COURSE, $DB, $PAGE;
927     require_once($CFG->dirroot.'/mod/chat/locallib.php');
929     static $users;     // Cache user lookups
931     $result = new stdClass();
933     if (file_exists($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php')) {
934         include($CFG->dirroot . '/mod/chat/gui_ajax/theme/'.$theme.'/config.php');
935     }
937     if (isset($users[$message->userid])) {
938         $sender = $users[$message->userid];
939     } else if ($sender = $DB->get_record('user', array('id'=>$message->userid), user_picture::fields())) {
940         $users[$message->userid] = $sender;
941     } else {
942         return NULL;
943     }
945     $USER->timezone = 99;
946     $tz = get_user_timezone($currentuser->timezone);
947     $USER->timezone = $tz;
949     if (empty($chatuser->course)) {
950         $courseid = $COURSE->id;
951     } else {
952         $courseid = $chatuser->course;
953     }
955     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
956     $message->picture = $OUTPUT->user_picture($sender, array('courseid'=>$courseid));
958     $message->picture = "<a target='_blank' href=\"$CFG->wwwroot/user/view.php?id=$sender->id&amp;course=$courseid\">$message->picture</a>";
960     // Start processing the message
961     if(!empty($message->system)) {
962         $result->type = 'system';
964         $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
965         $event = get_string('message'.$message->message, 'chat', fullname($sender));
966         $eventmessage = new event_message($senderprofile, fullname($sender), $message->strtime, $event, $theme);
968         $output = $PAGE->get_renderer('mod_chat');
969         $result->html = $output->render($eventmessage);
971         return $result;
972     }
974     // It's not a system event
975     $text = trim($message->message);
977     /// Parse the text to clean and filter it
978     $options = new stdClass();
979     $options->para = false;
980     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
982     // And now check for special cases
983     $special = false;
984     $outtime = $message->strtime;
986     // Initialise variables.
987     $outmain = '';
988     $patternTo = '#^\s*To\s([^:]+):(.*)#';
990     if (substr($text, 0, 5) == 'beep ') {
991         $special = true;
992         /// It's a beep!
993         $result->type = 'beep';
994         $beepwho = trim(substr($text, 5));
996         if ($beepwho == 'all') {   // everyone
997             $outmain =  get_string('messagebeepseveryone', 'chat', fullname($sender));
998         } else if ($beepwho == $currentuser->id) {  // current user
999             $outmain = get_string('messagebeepsyou', 'chat', fullname($sender));
1000         } else if ($sender->id == $currentuser->id) {  //something is not caught?
1001             //allow beep for a active chat user only, else user can beep anyone and get fullname
1002             if (!empty($chatuser) && is_numeric($beepwho)) {
1003                $chatusers = chat_get_users($chatuser->chatid, $chatuser->groupid, $groupingid);
1004                if (array_key_exists($beepwho, $chatusers)) {
1005                    $outmain = get_string('messageyoubeep', 'chat', fullname($chatusers[$beepwho]));
1006                } else {
1007                    $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1008                }
1009             } else {
1010                 $outmain = get_string('messageyoubeep', 'chat', $beepwho);
1011             }
1012         }
1013     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
1014         $special = true;
1015         $result->type = 'command';
1016         $pattern = '#(^\/)(\w+).*#';
1017         preg_match($pattern, $text, $matches);
1018         $command = isset($matches[2]) ? $matches[2] : false;
1019         // Support some IRC commands.
1020         switch ($command){
1021             case 'me':
1022                 $outmain = '*** <b>'.$sender->firstname.' '.substr($text, 4).'</b>';
1023                 break;
1024             default:
1025                 // Error, we set special back to false to use the classic message output.
1026                 $special = false;
1027                 break;
1028         }
1029     } else if (preg_match($patternTo, $text)) {
1030         $special = true;
1031         $result->type = 'dialogue';
1032         $matches = array();
1033         preg_match($patternTo, $text, $matches);
1034         if (isset($matches[1]) && isset($matches[2])) {
1035             $outmain = $sender->firstname.' <b>'.get_string('saidto', 'chat').'</b> <i>'.$matches[1].'</i>: '.$matches[2];
1036         } else {
1037             // Error, we set special back to false to use the classic message output.
1038             $special = false;
1039         }
1040     }
1042     if (!$special) {
1043         $outmain = $text;
1044     }
1046     $result->text = strip_tags($outtime.': '.$outmain);
1048     $mymessageclass = '';
1049     if ($sender->id == $USER->id) {
1050         $mymessageclass = 'chat-message-mymessage';
1051     }
1053     $senderprofile = $CFG->wwwroot.'/user/view.php?id='.$sender->id.'&amp;course='.$courseid;
1054     $usermessage = new user_message($senderprofile, fullname($sender), $message->picture, $mymessageclass, $outtime, $outmain, $theme);
1056     $output = $PAGE->get_renderer('mod_chat');
1057     $result->html = $output->render($usermessage);
1059     //When user beeps other user, then don't show any timestamp to other users in chat.
1060     if (('' === $outmain) && $special) {
1061         return false;
1062     } else {
1063         return $result;
1064     }
1067 /**
1068  * @global object $DB
1069  * @global object $CFG
1070  * @global object $COURSE
1071  * @global object $OUTPUT
1072  * @param object $users
1073  * @param object $course
1074  * @return array return formatted user list
1075  */
1076 function chat_format_userlist($users, $course) {
1077     global $CFG, $DB, $COURSE, $OUTPUT;
1078     $result = array();
1079     foreach($users as $user){
1080         $item = array();
1081         $item['name'] = fullname($user);
1082         $item['url'] = $CFG->wwwroot.'/user/view.php?id='.$user->id.'&amp;course='.$course->id;
1083         $item['picture'] = $OUTPUT->user_picture($user);
1084         $item['id'] = $user->id;
1085         $result[] = $item;
1086     }
1087     return $result;
1090 /**
1091  * Print json format error
1092  * @param string $level
1093  * @param string $msg
1094  */
1095 function chat_print_error($level, $msg) {
1096     header('Content-Length: ' . ob_get_length() );
1097     $error = new stdClass();
1098     $error->level = $level;
1099     $error->msg   = $msg;
1100     $response['error'] = $error;
1101     echo json_encode($response);
1102     ob_end_flush();
1103     exit;
1106 /**
1107  * @return array
1108  */
1109 function chat_get_view_actions() {
1110     return array('view','view all','report');
1113 /**
1114  * @return array
1115  */
1116 function chat_get_post_actions() {
1117     return array('talk');
1120 /**
1121  * @global object
1122  * @global object
1123  * @param array $courses
1124  * @param array $htmlarray Passed by reference
1125  */
1126 function chat_print_overview($courses, &$htmlarray) {
1127     global $USER, $CFG;
1129     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1130         return array();
1131     }
1133     if (!$chats = get_all_instances_in_courses('chat',$courses)) {
1134         return;
1135     }
1137     $strchat = get_string('modulename', 'chat');
1138     $strnextsession  = get_string('nextsession', 'chat');
1140     foreach ($chats as $chat) {
1141         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled
1142             $str = '<div class="chat overview"><div class="name">'.
1143                    $strchat.': <a '.($chat->visible?'':' class="dimmed"').
1144                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
1145                    $chat->name.'</a></div>';
1146             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
1148             if (empty($htmlarray[$chat->course]['chat'])) {
1149                 $htmlarray[$chat->course]['chat'] = $str;
1150             } else {
1151                 $htmlarray[$chat->course]['chat'] .= $str;
1152             }
1153         }
1154     }
1158 /**
1159  * Implementation of the function for printing the form elements that control
1160  * whether the course reset functionality affects the chat.
1161  *
1162  * @param object $mform form passed by reference
1163  */
1164 function chat_reset_course_form_definition(&$mform) {
1165     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
1166     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages','chat'));
1169 /**
1170  * Course reset form defaults.
1171  *
1172  * @param object $course
1173  * @return array
1174  */
1175 function chat_reset_course_form_defaults($course) {
1176     return array('reset_chat'=>1);
1179 /**
1180  * Actual implementation of the reset course functionality, delete all the
1181  * chat messages for course $data->courseid.
1182  *
1183  * @global object
1184  * @global object
1185  * @param object $data the data submitted from the reset course.
1186  * @return array status array
1187  */
1188 function chat_reset_userdata($data) {
1189     global $CFG, $DB;
1191     $componentstr = get_string('modulenameplural', 'chat');
1192     $status = array();
1194     if (!empty($data->reset_chat)) {
1195         $chatessql = "SELECT ch.id
1196                         FROM {chat} ch
1197                        WHERE ch.course=?";
1198         $params = array($data->courseid);
1200         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
1201         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
1202         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
1203         $status[] = array('component'=>$componentstr, 'item'=>get_string('removemessages', 'chat'), 'error'=>false);
1204     }
1206     /// updating dates - shift may be negative too
1207     if ($data->timeshift) {
1208         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
1209         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
1210     }
1212     return $status;
1215 /**
1216  * Returns all other caps used in module
1217  *
1218  * @return array
1219  */
1220 function chat_get_extra_capabilities() {
1221     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
1225 /**
1226  * @param string $feature FEATURE_xx constant for requested feature
1227  * @return mixed True if module supports feature, null if doesn't know
1228  */
1229 function chat_supports($feature) {
1230     switch($feature) {
1231         case FEATURE_GROUPS:                  return true;
1232         case FEATURE_GROUPINGS:               return true;
1233         case FEATURE_GROUPMEMBERSONLY:        return true;
1234         case FEATURE_MOD_INTRO:               return true;
1235         case FEATURE_BACKUP_MOODLE2:          return true;
1236         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
1237         case FEATURE_GRADE_HAS_GRADE:         return false;
1238         case FEATURE_GRADE_OUTCOMES:          return true;
1239         case FEATURE_SHOW_DESCRIPTION:        return true;
1241         default: return null;
1242     }
1245 function chat_extend_navigation($navigation, $course, $module, $cm) {
1246     global $CFG;
1248     $currentgroup = groups_get_activity_group($cm, true);
1250     if (has_capability('mod/chat:chat', context_module::instance($cm->id))) {
1251         $strenterchat    = get_string('enterchat', 'chat');
1253         $target = $CFG->wwwroot.'/mod/chat/';
1254         $params = array('id'=>$cm->instance);
1256         if ($currentgroup) {
1257             $params['groupid'] = $currentgroup;
1258         }
1260         $links = array();
1262         $url = new moodle_url($target.'gui_'.$CFG->chat_method.'/index.php', $params);
1263         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup, array('height' => 500, 'width' => 700));
1264         $links[] = new action_link($url, $strenterchat, $action);
1266         $url = new moodle_url($target.'gui_basic/index.php', $params);
1267         $action = new popup_action('click', $url, 'chat'.$course->id.$cm->instance.$currentgroup, array('height' => 500, 'width' => 700));
1268         $links[] = new action_link($url, get_string('noframesjs', 'message'), $action);
1270         foreach ($links as $link) {
1271             $navigation->add($link->text, $link, navigation_node::TYPE_SETTING, null ,null, new pix_icon('i/group' , ''));
1272         }
1273     }
1275     $chatusers = chat_get_users($cm->instance, $currentgroup, $cm->groupingid);
1276     if (is_array($chatusers) && count($chatusers)>0) {
1277         $users = $navigation->add(get_string('currentusers', 'chat'));
1278         foreach ($chatusers as $chatuser) {
1279             $userlink = new moodle_url('/user/view.php', array('id'=>$chatuser->id,'course'=>$course->id));
1280             $users->add(fullname($chatuser).' '.format_time(time() - $chatuser->lastmessageping), $userlink, navigation_node::TYPE_USER, null, null, new pix_icon('i/user', ''));
1281         }
1282     }
1285 /**
1286  * Adds module specific settings to the settings block
1287  *
1288  * @param settings_navigation $settings The settings navigation object
1289  * @param navigation_node $chatnode The node to add module settings to
1290  */
1291 function chat_extend_settings_navigation(settings_navigation $settings, navigation_node $chatnode) {
1292     global $DB, $PAGE, $USER;
1293     $chat = $DB->get_record("chat", array("id" => $PAGE->cm->instance));
1295     if ($chat->chattime && $chat->schedule) {
1296         $nextsessionnode = $chatnode->add(get_string('nextsession', 'chat').': '.userdate($chat->chattime).' ('.usertimezone($USER->timezone));
1297         $nextsessionnode->add_class('note');
1298     }
1300     $currentgroup = groups_get_activity_group($PAGE->cm, true);
1301     if ($currentgroup) {
1302         $groupselect = " AND groupid = '$currentgroup'";
1303     } else {
1304         $groupselect = '';
1305     }
1307     if ($chat->studentlogs || has_capability('mod/chat:readlog',$PAGE->cm->context)) {
1308         if ($DB->get_records_select('chat_messages', "chatid = ? $groupselect", array($chat->id))) {
1309             $chatnode->add(get_string('viewreport', 'chat'), new moodle_url('/mod/chat/report.php', array('id'=>$PAGE->cm->id)));
1310         }
1311     }
1314 /**
1315  * user logout event handler
1316  *
1317  * @param \core\event\user_loggedout $event The event.
1318  * @return void
1319  */
1320 function chat_user_logout(\core\event\user_loggedout $event) {
1321     global $DB;
1322     $DB->delete_records('chat_users', array('userid' => $event->objectid));
1325 /**
1326  * Return a list of page types
1327  * @param string $pagetype current page type
1328  * @param stdClass $parentcontext Block's parent context
1329  * @param stdClass $currentcontext Current context of block
1330  */
1331 function chat_page_type_list($pagetype, $parentcontext, $currentcontext) {
1332     $module_pagetype = array('mod-chat-*'=>get_string('page-mod-chat-x', 'chat'));
1333     return $module_pagetype;