MDL-8323 finished full conversion to proper $COURSE global - no more $CFG->coursethem...
[moodle.git] / mod / chat / lib.php
1 <?php  // $Id$
3 /// Library of functions and constants for module chat
5 require_once($CFG->libdir.'/pagelib.php');
7 if (!isset($CFG->chat_refresh_room)) {
8     set_config("chat_refresh_room", 5);
9 }
10 if (!isset($CFG->chat_refresh_userlist)) {
11     set_config("chat_refresh_userlist", 10);
12 }
13 if (!isset($CFG->chat_old_ping)) {
14     set_config("chat_old_ping", 35);
15 }
16 if (!isset($CFG->chat_method)) {
17     set_config("chat_method", "header_js");
18 }
19 if (!isset($CFG->chat_normal_updatemode)) {
20     set_config("chat_normal_updatemode", 'jsupdate');
21 }
22 if (!isset($CFG->chat_serverhost)) {
23     set_config("chat_serverhost", $_SERVER['HTTP_HOST']);
24 }
25 if (!isset($CFG->chat_serverip)) {
26     set_config("chat_serverip", '127.0.0.1');
27 }
28 if (!isset($CFG->chat_serverport)) {
29     set_config("chat_serverport", 9111);
30 }
31 if (!isset($CFG->chat_servermax)) {
32     set_config("chat_servermax", 100);
33 }
35 // The HTML head for the message window to start with (<!-- nix --> is used to get some browsers starting with output
36 $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<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n";
38 // The HTML head for the message window to start with (with js scrolling)
39 $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<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n";
41 // The HTML code for standard empty pages (e.g. if a user was kicked out)
42 $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>";
44 // The HTML head for the message input page
45 $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\">";
47 // The HTML code for the message input page, with JavaScript
48 $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();\">";
50 // Dummy data that gets output to the browser as needed, in order to make it show output
51 $CHAT_DUMMY_DATA = "<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n<!-- nix -->\n";
53 function chat_add_instance($chat) {
54 /// Given an object containing all the necessary data,
55 /// (defined by the form in mod.html) this function
56 /// will create a new instance and return the id number
57 /// of the new instance.
59     $chat->timemodified = time();
61     if ($returnid = insert_record("chat", $chat)) {
63         $event = NULL;
64         $event->name        = $chat->name;
65         $event->description = $chat->intro;
66         $event->courseid    = $chat->course;
67         $event->groupid     = 0;
68         $event->userid      = 0;
69         $event->modulename  = 'chat';
70         $event->instance    = $returnid;
71         $event->eventtype   = $chat->schedule;
72         $event->timestart   = $chat->chattime;
73         $event->timeduration = 0;
75         add_event($event);
76     }
78     return $returnid;
79 }
82 function chat_update_instance($chat) {
83 /// Given an object containing all the necessary data,
84 /// (defined by the form in mod.html) this function
85 /// will update an existing instance with new data.
87     $chat->timemodified = time();
88     $chat->id = $chat->instance;
91     if ($returnid = update_record("chat", $chat)) {
93         $event = new object();
95         if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
97             $event->name        = $chat->name;
98             $event->description = $chat->intro;
99             $event->timestart   = $chat->chattime;
101             update_event($event);
102         }
103     }
105     return $returnid;
109 function chat_delete_instance($id) {
110 /// Given an ID of an instance of this module,
111 /// this function will permanently delete the instance
112 /// and any data that depends on it.
114     if (! $chat = get_record('chat', 'id', $id)) {
115         return false;
116     }
118     $result = true;
120     # Delete any dependent records here #
122     if (! delete_records('chat', 'id', $chat->id)) {
123         $result = false;
124     }
125     if (! delete_records('chat_messages', 'chatid', $chat->id)) {
126         $result = false;
127     }
128     if (! delete_records('chat_users', 'chatid', $chat->id)) {
129         $result = false;
130     }
132     $pagetypes = page_import_types('mod/chat/');
133     foreach($pagetypes as $pagetype) {
134         if(!delete_records('block_instance', 'pageid', $chat->id, 'pagetype', $pagetype)) {
135             $result = false;
136         }
137     }
139     if (! delete_records('event', 'modulename', 'chat', 'instance', $chat->id)) {
140         $result = false;
141     }
143     return $result;
146 function chat_user_outline($course, $user, $mod, $chat) {
147 /// Return a small object with summary information about what a
148 /// user has done with a given particular instance of this module
149 /// Used for user activity reports.
150 /// $return->time = the time they did it
151 /// $return->info = a short text description
153     $return = NULL;
154     return $return;
157 function chat_user_complete($course, $user, $mod, $chat) {
158 /// Print a detailed representation of what a  user has done with
159 /// a given particular instance of this module, for user activity reports.
161     return true;
164 function chat_print_recent_activity($course, $isteacher, $timestart) {
165 /// Given a course and a date, prints a summary of all chat rooms
166 /// that currently have people in them.
167 /// This function is called from course/lib.php: print_recent_activity()
169     global $CFG;
171     $timeold = time() - $CFG->chat_old_ping;
173     $lastpingsearch = ($CFG->chat_method == 'sockets') ? '': 'AND cu.lastping > \''.$timeold.'\'';
175     if (!$chatusers = get_records_sql("SELECT u.id, cu.chatid, u.firstname, u.lastname
176                                         FROM {$CFG->prefix}chat_users cu,
177                                              {$CFG->prefix}chat ch,
178                                              {$CFG->prefix}user u
179                                        WHERE cu.userid = u.id
180                                          AND cu.chatid = ch.id $lastpingsearch
181                                          AND ch.course = '$course->id'
182                                        ORDER BY cu.chatid ASC") ) {
183         return false;
184     }
186     $outputstarted = false;
187     $current = 0;
188     foreach ($chatusers as $chatuser) {
189         if ($current != $chatuser->chatid) {
190             if ($current) {
191                 echo '</ul></div>';  // room
192                 $current = 0;
193             }
194             if ($chat = get_record('chat', 'id', $chatuser->chatid)) {
196                 // we find the course module id
197                 $cm = get_coursemodule_from_instance('chat', $chat->id, $course->id);
198                 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
200                 // needs to be fixed
201                 if (!(has_capability('mod/chat:readlog', $context) or instance_is_visible('chat', $chat))) {  // Chat hidden to students
202                     continue;
203                 }
204                 if (!$outputstarted) {
205                     print_headline(get_string('currentchats', 'chat').':');
206                     $outputstarted = true;
207                 }
208                 echo '<div class="room"><p class="head"><a href="'.$CFG->wwwroot.'/mod/chat/view.php?c='.$chat->id.'">'.format_string($chat->name,true).'</a></p><ul>';
209             }
210             $current = $chatuser->chatid;
211         }
212         $fullname = fullname($chatuser, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
213         echo '<li class="info name">'.$fullname.'</li>';
214     }
216     if ($current) {
217         echo '</ul></div>';  // room
218     }
220     return true;
224 function chat_cron () {
225 /// Function to be run periodically according to the moodle cron
226 /// This function searches for things that need to be done, such
227 /// as sending out mail, toggling flags etc ...
229     global $CFG;
231     chat_update_chat_times();
233     chat_delete_old_users();
235     /// Delete old messages
236     if ($chats = get_records("chat")) {
237         foreach ($chats as $chat) {
238             if ($chat->keepdays) {
239                 $timeold = time() - ($chat->keepdays * 24 * 3600);
240                 delete_records_select("chat_messages", "chatid = '$chat->id' AND timestamp < '$timeold'");
241             }
242         }
243     }
245     return true;
248 function chat_get_participants($chatid, $groupid=0) {
249 //Returns the users with data in one chat
250 //(users with records in chat_messages, students)
252     global $CFG;
254     if ($groupid) {
255         $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
256     } else {
257         $groupselect = "";
258     }
260     //Get students
261     $students = get_records_sql("SELECT DISTINCT u.id, u.id
262                                  FROM {$CFG->prefix}user u,
263                                       {$CFG->prefix}chat_messages c
264                                  WHERE c.chatid = '$chatid' $groupselect
265                                    AND u.id = c.userid");
267     //Return students array (it contains an array of unique users)
268     return ($students);
271 function chat_refresh_events($courseid = 0) {
272 // This standard function will check all instances of this module
273 // and make sure there are up-to-date events created for each of them.
274 // If courseid = 0, then every chat event in the site is checked, else
275 // only chat events belonging to the course specified are checked.
276 // This function is used, in its new format, by restore_refresh_events()
278     if ($courseid) {
279         if (! $chats = get_records("chat", "course", $courseid)) {
280             return true;
281         }
282     } else {
283         if (! $chats = get_records("chat")) {
284             return true;
285         }
286     }
287     $moduleid = get_field('modules', 'id', 'name', 'chat');
289     foreach ($chats as $chat) {
290         $event = NULL;
291         $event->name        = addslashes($chat->name);
292         $event->description = addslashes($chat->intro);
293         $event->timestart   = $chat->chattime;
295         if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
296             update_event($event);
298         } else {
299             $event->courseid    = $chat->course;
300             $event->groupid     = 0;
301             $event->userid      = 0;
302             $event->modulename  = 'chat';
303             $event->instance    = $chat->id;
304             $event->eventtype   = $chat->schedule;
305             $event->timeduration = 0;
306             $event->visible     = get_field('course_modules', 'visible', 'module', $moduleid, 'instance', $chat->id);
308             add_event($event);
309         }
310     }
311     return true;
315 //////////////////////////////////////////////////////////////////////
316 /// Functions that require some SQL
318 function chat_get_users($chatid, $groupid=0) {
320     global $CFG;
322     if ($groupid) {
323         $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
324     } else {
325         $groupselect = "";
326     }
328     return get_records_sql("SELECT DISTINCT u.id, u.firstname, u.lastname, u.picture, c.lastmessageping, c.firstping
329                               FROM {$CFG->prefix}chat_users c,
330                                    {$CFG->prefix}user u
331                              WHERE c.chatid = '$chatid'
332                                AND u.id = c.userid $groupselect
333                              ORDER BY c.firstping ASC");
336 function chat_get_latest_message($chatid, $groupid=0) {
337 /// Efficient way to extract just the latest message
338 /// Uses ADOdb directly instead of get_record_sql()
339 /// because the LIMIT command causes problems with
340 /// the developer debugging in there.
342     global $db, $CFG;
344     if ($groupid) {
345         $groupselect = " AND (groupid='$groupid' OR groupid='0')";
346     } else {
347         $groupselect = "";
348     }
350     if (!$rs = $db->SelectLimit("SELECT *
351                                  FROM {$CFG->prefix}chat_messages
352                                  WHERE chatid = '$chatid' $groupselect
353                                  ORDER BY timestamp DESC", 1)) {
354         return false;
355     }
356     if ($rs->RecordCount() == 1) {
357         return (object)$rs->fields;
358     } else {
359         return false;                 // Found no records
360     }
364 //////////////////////////////////////////////////////////////////////
365 // login if not already logged in
367 function chat_login_user($chatid, $version, $groupid, $course) {
368     global $USER;
369     if (($version != 'sockets') and $chatuser = get_record_select('chat_users', "chatid='$chatid' AND userid='$USER->id' AND groupid='$groupid'")) {
370         $chatuser->version  = $version;
371         $chatuser->ip       = $USER->lastip;
372         $chatuser->lastping = time();
373         $chatuser->lang     = current_language();
375         // Sometimes $USER->lastip is not setup properly
376         // during login. Update with current value if possible
377         // or provide a dummy value for the db
378         if (empty($chatuser->ip)) {
379             $chatuser->ip = getremoteaddr();
380             if (empty($chatuser->ip)) {
381                 $chatuser->ip = '';
382             }
383         }
385         if (($chatuser->course != $course->id)
386          or ($chatuser->userid != $USER->id)) {
387             return false;
388         }
389         if (!update_record('chat_users', $chatuser)) {
390             return false;
391         }
392     } else {
393         $chatuser = new object();
394         $chatuser->chatid   = $chatid;
395         $chatuser->userid   = $USER->id;
396         $chatuser->groupid  = $groupid;
397         $chatuser->version  = $version;
398         $chatuser->ip       = $USER->lastip;
399         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
400         $chatuser->sid      = random_string(32);
401         $chatuser->course   = $course->id; //caching - needed for current_language too
402         $chatuser->lang     = current_language(); //caching - to resource intensive to find out later
404         // Sometimes $USER->lastip is not setup properly
405         // during login. Update with current value if possible
406         // or provide a dummy value for the db
407         if (empty($chatuser->ip)) {
408             $chatuser->ip = getremoteaddr();
409             if (empty($chatuser->ip)) {
410                 $chatuser->ip = '';
411             }
412         }
415         if (!insert_record('chat_users', $chatuser)) {
416             return false;
417         }
419         if ($version == 'sockets') {
420             // do not send 'enter' message, chatd will do it
421         } else {
422             $message = new object();
423             $message->chatid    = $chatuser->chatid;
424             $message->userid    = $chatuser->userid;
425             $message->groupid   = $groupid;
426             $message->message   = 'enter';
427             $message->system    = 1;
428             $message->timestamp = time();
430             if (!insert_record('chat_messages', $message)) {
431                 error('Could not insert a chat message!');
432             }
433         }
434     }
436     return $chatuser->sid;
439 function chat_delete_old_users() {
440 // Delete the old and in the way
442     global $CFG;
444     $timeold = time() - $CFG->chat_old_ping;
445     $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
447     $query = "(version<>'basic' AND lastping<'$timeold') OR (version='basic' AND lastping<'$timeoldext')";
449     if ($oldusers = get_records_select('chat_users', $query) ) {
450         delete_records_select('chat_users', $query);
451         foreach ($oldusers as $olduser) {
452             $message = new object();
453             $message->chatid    = $olduser->chatid;
454             $message->userid    = $olduser->userid;
455             $message->groupid   = $olduser->groupid;
456             $message->message   = 'exit';
457             $message->system    = 1;
458             $message->timestamp = time();
460             if (!insert_record('chat_messages', $message)) {
461                 error('Could not insert a chat message!');
462             }
463         }
464     }
468 function chat_update_chat_times($chatid=0) {
469 /// Updates chat records so that the next chat time is correct
471     $timenow = time();
472     if ($chatid) {
473         if (!$chats[] = get_record_select("chat", "id = '$chatid' AND chattime <= '$timenow' AND schedule > '0'")) {
474             return;
475         }
476     } else {
477         if (!$chats = get_records_select("chat", "chattime <= '$timenow' AND schedule > '0'")) {
478             return;
479         }
480     }
482     foreach ($chats as $chat) {
483         unset($chat->name);
484         unset($chat->intro);
485         switch ($chat->schedule) {
486             case 1: // Single event - turn off schedule and disable
487                     $chat->chattime = 0;
488                     $chat->schedule = 0;
489                     break;
490             case 2: // Repeat daily
491                     $chat->chattime += 24 * 3600;
492                     break;
493             case 3: // Repeat weekly
494                     $chat->chattime += 7 * 24 * 3600;
495                     break;
496         }
497         update_record("chat", $chat);
499         $event = NULL;           // Update calendar too
500         if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
501             $event->timestart   = $chat->chattime;
502             update_event($event);
503         }
504     }
508 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
509     global $CFG, $USER;
511     $output = new object();
512     $output->beep = false;       // by default
513     $output->refreshusers = false; // by default
515     // Use get_user_timezone() to find the correct timezone for displaying this message:
516     // It's either the current user's timezone or else decided by some Moodle config setting
517     // First, "reset" $USER->timezone (which could have been set by a previous call to here)
518     // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
519     $USER->timezone = 99;
520     $tz = get_user_timezone($currentuser->timezone);
522     // Before formatting the message time string, set $USER->timezone to the above.
523     // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
524     // message times appear off because DST is not taken into account when it should be.
525     $USER->timezone = $tz;
526     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
528     $message->picture = print_user_picture($sender->id, 0, $sender->picture, false, true, false);
529     if ($courseid) {
530         $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>";
531     }
533     //Calculate the row class
534     if ($chat_lastrow !== NULL) {
535         $rowclass = ' class="r'.$chat_lastrow.'" ';
536     } else {
537         $rowclass = '';
538     }
540     // Start processing the message
542     if(!empty($message->system)) {
543         // System event
544         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
545         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td><td class="text">';
546         $output->html .= '<span class="event">'.$output->text.'</span></td></tr></table>';
547         $output->basic = '<dl><dt class="event">'.$message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender)).'</dt></dl>'; 
549         if($message->message == 'exit' or $message->message == 'enter') {
550             $output->refreshusers = true; //force user panel refresh ASAP
551         }
552         return $output;
553     }
555     // It's not a system event
557     $text = $message->message;
559     /// Parse the text to clean and filter it
561     $options = new object();
562     $options->para = false;
563     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
564     // And now check for special cases
565     if (substr($text, 0, 5) == 'beep ') {
566         /// It's a beep!
567         $beepwho = trim(substr($text, 5));
569         if ($beepwho == 'all') {   // everyone
570             $outinfo = $message->strtime.': '.get_string('messagebeepseveryone', 'chat', fullname($sender));
571             $outmain = '';
572             $output->beep = true;  // (eventually this should be set to
573                                    //  to a filename uploaded by the user)
575         } else if ($beepwho == $currentuser->id) {  // current user
576             $outinfo = $message->strtime.': '.get_string('messagebeepsyou', 'chat', fullname($sender));
577             $outmain = '';
578             $output->beep = true;
580         } else {  //something is not caught?
581             return false;
582         }
583     } else if (substr($text, 0, 1) == ':') {              /// It's an MOO emote
584         $outinfo = $message->strtime;
585         $outmain = $sender->firstname.' '.substr($text, 1);
587     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
589         if (substr($text, 0, 4) == "/me ") {
590             $outinfo = $message->strtime;
591             $outmain = $sender->firstname.' '.substr($text, 4);
592         } else {
593             $outinfo = $message->strtime;
594             $outmain = $text;
595         }
597     } else {                                          /// It's a normal message
598         $outinfo = $message->strtime.' '.$sender->firstname;
599         $outmain = $text;
600     }
602     /// Format the message as a small table
604     $output->text  = strip_tags($outinfo.': '.$outmain);
606     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
607     $output->html .= "<span class=\"title\">$outinfo</span>";
608     if ($outmain) {
609         $output->html .= ": $outmain";
610         $output->basic = '<dl><dt class="title">'.$outinfo.':</dt><dd class="text">'.$outmain.'</dd></dl>'; 
611     } else {
612         $output->basic = '<dl><dt class="title">'.$outinfo.'</dt></dl>'; 
613     }
614     $output->html .= "</td></tr></table>";
615     return $output;
618 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
619 /// Given a message object full of information, this function
620 /// formats it appropriately into text and html, then
621 /// returns the formatted data.
623     static $users;     // Cache user lookups
625     if (isset($users[$message->userid])) {
626         $user = $users[$message->userid];
627     } else if ($user = get_record('user', 'id', $message->userid, '','','','','id,picture,firstname,lastname')) {
628         $users[$message->userid] = $user;
629     } else {
630         return NULL;
631     }
632     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
635 function chat_get_view_actions() {
636     return array('view','view all','report');
639 function chat_get_post_actions() {
640     return array('talk');
643 function chat_print_overview($courses, &$htmlarray) {
644     global $USER, $CFG;
646     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
647         return array();
648     }
650     if (!$chats = get_all_instances_in_courses('chat',$courses)) {
651         return;
652     }
654     $strchat = get_string('modulename', 'chat');
655     $strnextsession  = get_string('nextsession', 'chat');
657     foreach ($chats as $chat) {
658         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled
659             $str = '<div class="chat overview"><div class="name">'.
660                    $strchat.': <a '.($chat->visible?'':' class="dimmed"').
661                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
662                    $chat->name.'</a></div>';
663             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
665             if (empty($htmlarray[$chat->course]['chat'])) {
666                 $htmlarray[$chat->course]['chat'] = $str;
667             } else {
668                 $htmlarray[$chat->course]['chat'] .= $str;
669             }
670         }
671     }
674 ?>