MDL-15666 - change all the portfolio plugins and callers to use exceptions
[moodle.git] / mod / chat / lib.php
1 <?php  // $Id$
3 /// Library of functions and constants for module chat
4 require_once($CFG->libdir.'/pagelib.php');
6 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output
7 $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 bgcolor=\"#FFFFFF\">\n\n".padding(200);
9 // The HTML head for the message window to start with (with js scrolling)
10 $CHAT_HTMLHEAD_JS = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\"><html><head><script type=\"text/javascript\">\n//<![CDATA[\nfunction move()\n{\nif (scroll_active) window.scroll(1,400000);\nwindow.setTimeout(\"move()\",100);\n}\nscroll_active = true;\nmove();\n//]]>\n</script>\n</head>\n<body bgcolor=\"#FFFFFF\" onBlur=\"scroll_active = true\" onFocus=\"scroll_active = false\">\n\n".padding(200);
12 // The HTML code for standard empty pages (e.g. if a user was kicked out)
13 $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 bgcolor=\"#FFFFFF\"></body></html>";
15 // The HTML head for the message input page
16 $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 bgcolor=\"#FFFFFF\">";
18 // The HTML code for the message input page, with JavaScript
19 $CHAT_HTMLHEAD_MSGINPUT_JS = "<!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>\n<script type=\"text/javascript\">\n//<![CDATA[\nscroll_active = true;\nfunction empty_field_and_submit()\n{\ndocument.fdummy.arsc_message.value=document.f.arsc_message.value;\ndocument.fdummy.submit();\ndocument.f.arsc_message.focus();\ndocument.f.arsc_message.select();\nreturn false;\n}\n//]]>\n</script>\n</head><body bgcolor=\"#FFFFFF\" OnLoad=\"document.f.arsc_message.focus();document.f.arsc_message.select();\">";
21 // Dummy data that gets output to the browser as needed, in order to make it show output
22 $CHAT_DUMMY_DATA = padding(200);
24 function padding($n){
25     $str = '';
26     for($i=0; $i<$n; $i++){
27         $str.='<!-- nix -->\n';
28     }
29     return $str;
30 }
32 function chat_add_instance($chat) {
33     global $DB;
34 /// Given an object containing all the necessary data,
35 /// (defined by the form in mod_form.php) this function
36 /// will create a new instance and return the id number
37 /// of the new instance.
39     $chat->timemodified = time();
41     if ($returnid = $DB->insert_record("chat", $chat)) {
43         $event = NULL;
44         $event->name        = $chat->name;
45         $event->description = $chat->intro;
46         $event->courseid    = $chat->course;
47         $event->groupid     = 0;
48         $event->userid      = 0;
49         $event->modulename  = 'chat';
50         $event->instance    = $returnid;
51         $event->eventtype   = $chat->schedule;
52         $event->timestart   = $chat->chattime;
53         $event->timeduration = 0;
55         add_event($event);
56     }
58     return $returnid;
59 }
62 function chat_update_instance($chat) {
63     global $DB;
64 /// Given an object containing all the necessary data,
65 /// (defined by the form in mod_form.php) this function
66 /// will update an existing instance with new data.
68     $chat->timemodified = time();
69     $chat->id = $chat->instance;
72     if ($returnid = $DB->update_record("chat", $chat)) {
74         $event = new object();
76         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id))) {
78             $event->name        = $chat->name;
79             $event->description = $chat->intro;
80             $event->timestart   = $chat->chattime;
82             update_event($event);
83         }
84     }
86     return $returnid;
87 }
90 function chat_delete_instance($id) {
91     global $DB;
92 /// Given an ID of an instance of this module,
93 /// this function will permanently delete the instance
94 /// and any data that depends on it.
96     if (! $chat = $DB->get_record('chat', array('id'=>$id))) {
97         return false;
98     }
100     $result = true;
102     # Delete any dependent records here #
104     if (! $DB->delete_records('chat', array('id'=>$chat->id))) {
105         $result = false;
106     }
107     if (! $DB->delete_records('chat_messages', array('chatid'=>$chat->id))) {
108         $result = false;
109     }
110     if (! $DB->delete_records('chat_messages_current', array('chatid'=>$chat->id))) {
111         $result = false;
112     }
113     if (! $DB->delete_records('chat_users', array('chatid'=>$chat->id))) {
114         $result = false;
115     }
117     $pagetypes = page_import_types('mod/chat/');
118     foreach($pagetypes as $pagetype) {
119         if (!$DB->delete_records('block_instance', array('pageid'=>$chat->id, 'pagetype'=>$pagetype))) {
120             $result = false;
121         }
122     }
124     if (! $DB->delete_records('event', array('modulename'=>'chat', 'instance'=>$chat->id))) {
125         $result = false;
126     }
128     return $result;
131 function chat_user_outline($course, $user, $mod, $chat) {
132 /// Return a small object with summary information about what a
133 /// user has done with a given particular instance of this module
134 /// Used for user activity reports.
135 /// $return->time = the time they did it
136 /// $return->info = a short text description
137     return NULL;
140 function chat_user_complete($course, $user, $mod, $chat) {
141 /// Print a detailed representation of what a  user has done with
142 /// a given particular instance of this module, for user activity reports.
143     return true;
146 function chat_print_recent_activity($course, $viewfullnames, $timestart) {
147 /// Given a course and a date, prints a summary of all chat rooms past and present
148 /// This function is called from course/lib.php: print_recent_activity()
149     global $CFG, $USER, $DB;
151     // this is approximate only, but it is really fast ;-)
152     $timeout = $CFG->chat_old_ping * 10;
154     if (!$mcms = $DB->get_records_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
155                                          FROM {course_modules} cm
156                                          JOIN {modules} md        ON md.id = cm.module
157                                          JOIN {chat} ch           ON ch.id = cm.instance
158                                          JOIN {chat_messages} chm ON chm.chatid = ch.id
159                                         WHERE chm.timestamp > ? AND ch.course = ? AND md.name = 'chat'
160                                      GROUP BY cm.id
161                                      ORDER BY lasttime ASC", array($timestart, $course->id))) {
162          return false;
163     }
165     $past     = array();
166     $current  = array();
167     $modinfo =& get_fast_modinfo($course); // reference needed because we might load the groups
169     foreach ($mcms as $cmid=>$mcm) {
170         if (!array_key_exists($cmid, $modinfo->cms)) {
171             continue;
172         }
173         $cm = $modinfo->cms[$cmid];
174         $cm->lasttime = $mcm->lasttime;
175         if (!$modinfo->cms[$cm->id]->uservisible) {
176             continue;
177         }
179         if (groups_get_activity_groupmode($cm) != SEPARATEGROUPS
180          or has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
181             if ($timeout > time() - $cm->lasttime) {
182                 $current[] = $cm;
183             } else {
184                 $past[] = $cm;
185             }
187             continue;
188         }
190         if (is_null($modinfo->groups)) {
191             $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
192         }
194         // verify groups in separate mode
195         if (!$mygroupids = $modinfo->groups[$cm->groupingid]) {
196             continue;
197         }
199         // ok, last post was not for my group - we have to query db to get last message from one of my groups
200         // only minor problem is that the order will not be correct
201         $mygroupids = implode(',', $mygroupids);
202         $cm->mygroupids = $mygroupids;
204         if (!$mcm = $DB->get_record_sql("SELECT cm.id, MAX(chm.timestamp) AS lasttime
205                                            FROM {course_modules} cm
206                                            JOIN {chat} ch           ON ch.id = cm.instance
207                                            JOIN {chat_messages_current} chm ON chm.chatid = ch.id
208                                           WHERE chm.timestamp > ? AND cm.id = ? AND
209                                                 (chm.groupid IN ($mygroupids) OR chm.groupid = 0)
210                                        GROUP BY cm.id", array($timestart, $cm->id))) {
211              continue;
212         }
214         $cm->lasttime = $mcm->lasttime;
215         if ($timeout > time() - $cm->lasttime) {
216             $current[] = $cm;
217         } else {
218             $past[] = $cm;
219         }
220     }
222     if (!$past and !$current) {
223         return false;
224     }
226     $strftimerecent = get_string('strftimerecent');
228     if ($past) {
229         print_headline(get_string('pastchats', 'chat').':');
231         foreach ($past as $cm) {
232             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
233             $date = userdate($cm->lasttime, $strftimerecent);
234             echo '<div class="head"><div class="date">'.$date.'</div></div>';
235             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
236         }
237     }
239     if ($current) {
240         print_headline(get_string('currentchats', 'chat').':');
242         $oldest = floor((time()-$CFG->chat_old_ping)/10)*10;  // better db caching
244         $timeold    = time() - $CFG->chat_old_ping;
245         $timeold    = floor($timeold/10)*10;  // better db caching
246         $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
247         $timeoldext = floor($timeoldext/10)*10;  // better db caching
249         $params = array('timeold'=>$timeold, 'timeoldext'=>$timeoldext, 'cmid'=>$cm->id);
251         $timeout = "AND (chu.version<>'basic' AND chu.lastping>:timeold) OR (chu.version='basic' AND chu.lastping>:timeoldext)";
253         foreach ($current as $cm) {
254             //count users first
255             if (isset($cm->mygroupids)) {
256                 $groupselect = "AND (chu.groupid IN ({$cm->mygroupids}) OR chu.groupid = 0)";
257             } else {
258                 $groupselect = "";
259             }
261             if (!$users = $DB->get_records_sql("SELECT u.id, u.firstname, u.lastname, u.email, u.picture
262                                                   FROM {course_modules} cm
263                                                   JOIN {chat} ch        ON ch.id = cm.instance
264                                                   JOIN {chat_users} chu ON chu.chatid = ch.id
265                                                   JOIN {user} u         ON u.id = chu.userid
266                                                  WHERE cm.id = :cmid $timeout $groupselect
267                                               GROUP BY u.id, u.firstname, u.lastname, u.email, u.picture", $params)) {
268             }
270             $link = $CFG->wwwroot.'/mod/chat/view.php?id='.$cm->id;
271             $date = userdate($cm->lasttime, $strftimerecent);
273             echo '<div class="head"><div class="date">'.$date.'</div></div>';
274             echo '<div class="info"><a href="'.$link.'">'.format_string($cm->name,true).'</a></div>';
275             echo '<div class="userlist">';
276             if ($users) {
277                 echo '<ul>';
278                     foreach ($users as $user) {
279                         echo '<li>'.fullname($user, $viewfullnames).'</li>';
280                     }
281                 echo '</ul>';
282             }
283             echo '</div>';
284         }
285     }
287     return true;
291 function chat_cron () {
292 /// Function to be run periodically according to the moodle cron
293 /// This function searches for things that need to be done, such
294 /// as sending out mail, toggling flags etc ...
295     global $DB;
297     chat_update_chat_times();
299     chat_delete_old_users();
301     /// Delete old messages with a
302     /// single SQL query.
303     $subselect = "SELECT c.keepdays
304                     FROM {chat} c
305                    WHERE c.id = {chat_messages}.chatid";
307     $sql = "DELETE
308               FROM {chat_messages}
309              WHERE ($subselect) > 0 AND timestamp < ( ".time()." -($subselect) * 24 * 3600)";
311     $DB->execute($sql);
313     $sql = "DELETE
314               FROM {chat_messages_current}
315              WHERE timestamp < ( ".time()." - 8 * 3600)";
317     $DB->execute($sql);
319     return true;
322 function chat_get_participants($chatid, $groupid=0) {
323 //Returns the users with data in one chat
324 //(users with records in chat_messages, students)
325     global $DB;
327     $params = array('groupid'=>$groupid, 'chatid'=>$chatid);
329     if ($groupid) {
330         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
331     } else {
332         $groupselect = "";
333     }
335     //Get students
336     $students = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
337                                         FROM {user} u, {chat_messages} c
338                                        WHERE c.chatid = :chatid $groupselect
339                                              AND u.id = c.userid", $params);
341     //Return students array (it contains an array of unique users)
342     return ($students);
345 function chat_refresh_events($courseid = 0) {
346 // This standard function will check all instances of this module
347 // and make sure there are up-to-date events created for each of them.
348 // If courseid = 0, then every chat event in the site is checked, else
349 // only chat events belonging to the course specified are checked.
350 // This function is used, in its new format, by restore_refresh_events()
351     global $DB;
353     if ($courseid) {
354         if (! $chats = $DB->get_records("chat", array("course"=>$courseid))) {
355             return true;
356         }
357     } else {
358         if (! $chats = $DB->get_records("chat")) {
359             return true;
360         }
361     }
362     $moduleid = $DB->get_field('modules', 'id', array('name'=>'chat'));
364     foreach ($chats as $chat) {
365         $event = NULL;
366         $event->name        = $chat->name;
367         $event->description = $chat->intro;
368         $event->timestart   = $chat->chattime;
370         if ($event->id = $DB->get_field('event', 'id', array('modulename'=>'chat', 'instance'=>$chat->id))) {
371             update_event($event);
373         } else {
374             $event->courseid    = $chat->course;
375             $event->groupid     = 0;
376             $event->userid      = 0;
377             $event->modulename  = 'chat';
378             $event->instance    = $chat->id;
379             $event->eventtype   = $chat->schedule;
380             $event->timeduration = 0;
381             $event->visible     = $DB->get_field('course_modules', 'visible', array('module'=>$moduleid, 'instance'=>$chat->id));
383             add_event($event);
384         }
385     }
386     return true;
390 //////////////////////////////////////////////////////////////////////
391 /// Functions that require some SQL
393 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
394     global $DB;
396     $params = array('chatid'=>$chatid, 'groupid'=>$groupid, 'groupingid'=>$groupingid);
398     if ($groupid) {
399         $groupselect = " AND (c.groupid=:groupid OR c.groupid='0')";
400     } else {
401         $groupselect = "";
402     }
404     if (!empty($CFG->enablegroupings) && !(empty($groupingid))) {
405         $groupingjoin = "JOIN {groups_members} gm ON u.id = gm.userid
406                          JOIN {groupings_groups} gg ON gm.groupid = gg.groupid AND gg.groupingid = :groupingid ";
408     } else {
409         $groupingjoin = '';
410     }
412     return $DB->get_records_sql("SELECT DISTINCT u.id, u.firstname, u.lastname, u.picture, c.lastmessageping, c.firstping, u.imagealt
413                                   FROM {chat_users} c
414                                   JOIN {user} u ON u.id = c.userid
415                          $groupingjoin
416                                  WHERE c.chatid = :chatid
417                                        $groupselect
418                               ORDER BY c.firstping ASC", $params);
421 function chat_get_latest_message($chatid, $groupid=0) {
422     global $DB;
424     $params = array('chatid'=>$chatid, 'groupid'=>$groupid);
426     if ($groupid) {
427         $groupselect = "AND (groupid=:groupid OR groupid=0)";
428     } else {
429         $groupselect = "";
430     }
432     $sql = "SELECT *
433               FROM {chat_messages_current}
434              WHERE chatid = :chatid
435                    $groupselect
436           ORDER BY timestamp DESC";
438     return $DB->get_record_sql($sql, $params, true);
442 //////////////////////////////////////////////////////////////////////
443 // login if not already logged in
445 function chat_login_user($chatid, $version, $groupid, $course) {
446     global $USER, $DB;
448     if (($version != 'sockets') and $chatuser = $DB->get_record('chat_users', array('chatid'=>$chatid, 'userid'=>$USER->id, 'groupid'=>$groupid))) {
449         $chatuser->version  = $version;
450         $chatuser->ip       = $USER->lastip;
451         $chatuser->lastping = time();
452         $chatuser->lang     = current_language();
454         // Sometimes $USER->lastip is not setup properly
455         // during login. Update with current value if possible
456         // or provide a dummy value for the db
457         if (empty($chatuser->ip)) {
458             $chatuser->ip = getremoteaddr();
459             if (empty($chatuser->ip)) {
460                 $chatuser->ip = '';
461             }
462         }
464         if (($chatuser->course != $course->id)
465          or ($chatuser->userid != $USER->id)) {
466             return false;
467         }
468         if (!$DB->update_record('chat_users', $chatuser)) {
469             return false;
470         }
471     } else {
472         $chatuser = new object();
473         $chatuser->chatid   = $chatid;
474         $chatuser->userid   = $USER->id;
475         $chatuser->groupid  = $groupid;
476         $chatuser->version  = $version;
477         $chatuser->ip       = $USER->lastip;
478         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
479         $chatuser->sid      = random_string(32);
480         $chatuser->course   = $course->id; //caching - needed for current_language too
481         $chatuser->lang     = current_language(); //caching - to resource intensive to find out later
483         // Sometimes $USER->lastip is not setup properly
484         // during login. Update with current value if possible
485         // or provide a dummy value for the db
486         if (empty($chatuser->ip)) {
487             $chatuser->ip = getremoteaddr();
488             if (empty($chatuser->ip)) {
489                 $chatuser->ip = '';
490             }
491         }
494         if (!$DB->insert_record('chat_users', $chatuser)) {
495             return false;
496         }
498         if ($version == 'sockets') {
499             // do not send 'enter' message, chatd will do it
500         } else {
501             $message = new object();
502             $message->chatid    = $chatuser->chatid;
503             $message->userid    = $chatuser->userid;
504             $message->groupid   = $groupid;
505             $message->message   = 'enter';
506             $message->system    = 1;
507             $message->timestamp = time();
509             if (!$DB->insert_record('chat_messages', $message) || !$DB->insert_record('chat_messages_current', $message)) {
510                 print_error('cantinsert', 'chat');
511             }
512         }
513     }
515     return $chatuser->sid;
518 function chat_delete_old_users() {
519 // Delete the old and in the way
520     global $CFG, $DB;
522     $timeold = time() - $CFG->chat_old_ping;
523     $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
525     $query = "(version<>'basic' AND lastping<?) OR (version='basic' AND lastping<?)";
526     $params = array($timeold, $timeoldext);
528     if ($oldusers = $DB->get_records_select('chat_users', $query, $params) ) {
529         $DB->delete_records_select('chat_users', $query, $params);
530         foreach ($oldusers as $olduser) {
531             $message = new object();
532             $message->chatid    = $olduser->chatid;
533             $message->userid    = $olduser->userid;
534             $message->groupid   = $olduser->groupid;
535             $message->message   = 'exit';
536             $message->system    = 1;
537             $message->timestamp = time();
539             if (!$DB->insert_record('chat_messages', $message) || !$DB->insert_record('chat_messages_current', $message) ) {
540                 print_error('cantinsert', 'chat');
541             }
542         }
543     }
547 function chat_update_chat_times($chatid=0) {
548 /// Updates chat records so that the next chat time is correct
549     global $DB;
551     $timenow = time();
553     $params = array('timenow'=>$timenow, 'chatid'=>$chatid);
555     if ($chatid) {
556         if (!$chats[] = $DB->get_record_select("chat", "id = :chatid AND chattime <= :timenow AND schedule > 0", $params)) {
557             return;
558         }
559     } else {
560         if (!$chats = $DB->get_records_select("chat", "chattime <= :timenow AND schedule > 0", $params)) {
561             return;
562         }
563     }
565     foreach ($chats as $chat) {
566         unset($chat->name);
567         unset($chat->intro);
568         switch ($chat->schedule) {
569             case 1: // Single event - turn off schedule and disable
570                     $chat->chattime = 0;
571                     $chat->schedule = 0;
572                     break;
573             case 2: // Repeat daily
574                     while ($chat->chattime <= $timenow) {
575                         $chat->chattime += 24 * 3600;
576                     }
577                     break;
578             case 3: // Repeat weekly
579                     while ($chat->chattime <= $timenow) {
580                         $chat->chattime += 7 * 24 * 3600;
581                     }
582                     break;
583         }
584         $DB->update_record("chat", $chat);
586         $event = new object();           // Update calendar too
588         $cond = "modulename='chat' AND instance = :chatid AND timestart <> :chattime";
589         $params = array('chattime'=>$chat->chattime, 'chatid'=>$chatid);
591         if ($event->id = $DB->get_field_select('event', 'id', $cond, $params)) {
592             $event->timestart   = $chat->chattime;
593             update_event($event);
594         }
595     }
599 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
600     global $CFG, $USER;
602     $output = new object();
603     $output->beep = false;       // by default
604     $output->refreshusers = false; // by default
606     // Use get_user_timezone() to find the correct timezone for displaying this message:
607     // It's either the current user's timezone or else decided by some Moodle config setting
608     // First, "reset" $USER->timezone (which could have been set by a previous call to here)
609     // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
610     $USER->timezone = 99;
611     $tz = get_user_timezone($currentuser->timezone);
613     // Before formatting the message time string, set $USER->timezone to the above.
614     // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
615     // message times appear off because DST is not taken into account when it should be.
616     $USER->timezone = $tz;
617     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
619     $message->picture = print_user_picture($sender->id, 0, $sender->picture, false, true, false);
620     if ($courseid) {
621         $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>";
622     }
624     //Calculate the row class
625     if ($chat_lastrow !== NULL) {
626         $rowclass = ' class="r'.$chat_lastrow.'" ';
627     } else {
628         $rowclass = '';
629     }
631     // Start processing the message
633     if(!empty($message->system)) {
634         // System event
635         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
636         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td><td class="text">';
637         $output->html .= '<span class="event">'.$output->text.'</span></td></tr></table>';
638         $output->basic = '<dl><dt class="event">'.$message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender)).'</dt></dl>';
640         if($message->message == 'exit' or $message->message == 'enter') {
641             $output->refreshusers = true; //force user panel refresh ASAP
642         }
643         return $output;
644     }
646     // It's not a system event
648     $text = $message->message;
650     /// Parse the text to clean and filter it
652     $options = new object();
653     $options->para = false;
654     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
656     // And now check for special cases
657     $special = false;
659     if (substr($text, 0, 5) == 'beep ') {
660         /// It's a beep!
661         $special = true;
662         $beepwho = trim(substr($text, 5));
664         if ($beepwho == 'all') {   // everyone
665             $outinfo = $message->strtime.': '.get_string('messagebeepseveryone', 'chat', fullname($sender));
666             $outmain = '';
667             $output->beep = true;  // (eventually this should be set to
668                                    //  to a filename uploaded by the user)
670         } else if ($beepwho == $currentuser->id) {  // current user
671             $outinfo = $message->strtime.': '.get_string('messagebeepsyou', 'chat', fullname($sender));
672             $outmain = '';
673             $output->beep = true;
675         } else {  //something is not caught?
676             return false;
677         }
678     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
679         if (trim(substr($text, 0, 4)) == '/me') {
680             $special = true;
681             $outinfo = $message->strtime;
682             $outmain = $sender->firstname.' '.substr($text, 4);
683         }
684     }
686     if(!$special) {
687         $outinfo = $message->strtime.' '.$sender->firstname;
688         $outmain = $text;
689     }
691     /// Format the message as a small table
693     $output->text  = strip_tags($outinfo.': '.$outmain);
695     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
696     $output->html .= "<span class=\"title\">$outinfo</span>";
697     if ($outmain) {
698         $output->html .= ": $outmain";
699         $output->basic = '<dl><dt class="title">'.$outinfo.':</dt><dd class="text">'.$outmain.'</dd></dl>';
700     } else {
701         $output->basic = '<dl><dt class="title">'.$outinfo.'</dt></dl>';
702     }
703     $output->html .= "</td></tr></table>";
704     return $output;
707 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
708 /// Given a message object full of information, this function
709 /// formats it appropriately into text and html, then
710 /// returns the formatted data.
711     global $DB;
713     static $users;     // Cache user lookups
715     if (isset($users[$message->userid])) {
716         $user = $users[$message->userid];
717     } else if ($user = $DB->get_record('user', array('id'=>$message->userid), 'id,picture,firstname,lastname')) {
718         $users[$message->userid] = $user;
719     } else {
720         return NULL;
721     }
722     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
725 function chat_get_view_actions() {
726     return array('view','view all','report');
729 function chat_get_post_actions() {
730     return array('talk');
733 function chat_print_overview($courses, &$htmlarray) {
734     global $USER, $CFG;
736     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
737         return array();
738     }
740     if (!$chats = get_all_instances_in_courses('chat',$courses)) {
741         return;
742     }
744     $strchat = get_string('modulename', 'chat');
745     $strnextsession  = get_string('nextsession', 'chat');
747     foreach ($chats as $chat) {
748         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled
749             $str = '<div class="chat overview"><div class="name">'.
750                    $strchat.': <a '.($chat->visible?'':' class="dimmed"').
751                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
752                    $chat->name.'</a></div>';
753             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
755             if (empty($htmlarray[$chat->course]['chat'])) {
756                 $htmlarray[$chat->course]['chat'] = $str;
757             } else {
758                 $htmlarray[$chat->course]['chat'] .= $str;
759             }
760         }
761     }
765 /**
766  * Implementation of the function for printing the form elements that control
767  * whether the course reset functionality affects the chat.
768  * @param $mform form passed by reference
769  */
770 function chat_reset_course_form_definition(&$mform) {
771     $mform->addElement('header', 'chatheader', get_string('modulenameplural', 'chat'));
772     $mform->addElement('advcheckbox', 'reset_chat', get_string('removemessages','chat'));
775 /**
776  * Course reset form defaults.
777  */
778 function chat_reset_course_form_defaults($course) {
779     return array('reset_chat'=>1);
782 /**
783  * Actual implementation of the rest coures functionality, delete all the
784  * chat messages for course $data->courseid.
785  * @param $data the data submitted from the reset course.
786  * @return array status array
787  */
788 function chat_reset_userdata($data) {
789     global $CFG, $DB;
791     $componentstr = get_string('modulenameplural', 'chat');
792     $status = array();
794     if (!empty($data->reset_chat)) {
795         $chatessql = "SELECT ch.id
796                         FROM {chat} ch
797                        WHERE ch.course=?";
798         $params = array($data->courseid);
800         $DB->delete_records_select('chat_messages', "chatid IN ($chatessql)", $params);
801         $DB->delete_records_select('chat_messages_current', "chatid IN ($chatessql)", $params);
802         $DB->delete_records_select('chat_users', "chatid IN ($chatessql)", $params);
803         $status[] = array('component'=>$componentstr, 'item'=>get_string('removemessages', 'chat'), 'error'=>false);
804     }
806     /// updating dates - shift may be negative too
807     if ($data->timeshift) {
808         shift_course_mod_dates('chat', array('chattime'), $data->timeshift, $data->courseid);
809         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
810     }
812     return $status;
815 /**
816  * Returns all other caps used in module
817  */
818 function chat_get_extra_capabilities() {
819     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames');
822 require_once($CFG->libdir . '/portfoliolib.php');
823 class chat_portfolio_caller extends portfolio_module_caller_base {
825     private $chat;
826     protected $start;
827     protected $end;
829     public static function expected_callbackargs() {
830         return array(
831             'id'    => true,
832             'start' => false,
833             'end'   => false,
834         );
835     }
837     public function load_data() {
838         global $DB;
840         if (!$this->cm = get_coursemodule_from_id('chat', $this->id)) {
841             throw new portfolio_caller_exception('invalidid', 'chat');
842         }
843         $this->chat = $DB->get_record('chat', array('id' => $this->cm->instance));
844         $select = 'chatid = ?';
845         $params = array($this->chat->id);
846         if ($this->start && $this->end) {
847             $select .= ' AND timestamp >= ? AND timestamp <= ?';
848             $params[] = $this->start;
849             $params[] = $this->end;
850         }
851         $this->messages = $DB->get_records_select(
852                 'chat_messages',
853                 $select,
854                 $params,
855                 'timestamp ASC'
856             );
857         $select .= ' AND userid = ?';
858         $params[] = $this->user->id;
859         $this->participated = $DB->record_exists_select(
860             'chat_messages',
861             $select,
862             $params
863         );
864     }
866     public static function supported_formats($caller) {
867         return array(PORTFOLIO_FORMAT_HTML);
868     }
870     public function expected_time() {
871         return portfolio_expected_time_db(count($this->messages));
872     }
874     public function get_sha1() {
875         $str = '';
876         ksort($this->messages);
877         foreach ($this->messages as $m) {
878             $str .= implode('', (array)$m);
879         }
880         return sha1($str);
881     }
883     public function check_permissions() {
884         $context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
885         return has_capability('mod/chat:exportsession', $context)
886             || ($this->participated
887                 && has_capability('mod/chat:exportparticipatedsession', $context));
888     }
890     public function prepare_package() {
891         $content = '';
892         foreach ($this->messages as $message) {  // We are walking FORWARDS through messages
893             $m = clone $message; // grrrrrr
894             $formatmessage = chat_format_message($m, null, $this->user);
895             if (!isset($formatmessage->html)) {
896                 continue;
897             }
898             $content .= $formatmessage->html;
899         }
900         $content = preg_replace('/\<img[^>]*\>/', '', $content);
902         $this->exporter->write_new_file($content, clean_filename($this->cm->name . '-session.html'));
903     }
905     public static function display_name() {
906         return get_string('modulename', 'chat');
907     }
909     public function get_return_url() {
910         global $CFG;
912         return $CFG->wwwroot . '/mod/chat/report.php?id='
913             . $this->cm->id . ((isset($this->start))
914                 ? '&start=' . $this->start . '&end=' . $this->end
915                 : '');
916     }
919 ?>