MDL-8323 finished full conversion to proper $COURSE global - no more $CFG->coursethem...
[moodle.git] / mod / chat / lib.php
CommitLineData
1c61c8d6 1<?php // $Id$
1515a89e 2
3/// Library of functions and constants for module chat
4
c4d588cc 5require_once($CFG->libdir.'/pagelib.php');
6
b5012f3e 7if (!isset($CFG->chat_refresh_room)) {
8 set_config("chat_refresh_room", 5);
b5de723d 9}
b5012f3e 10if (!isset($CFG->chat_refresh_userlist)) {
11 set_config("chat_refresh_userlist", 10);
b5de723d 12}
b5012f3e 13if (!isset($CFG->chat_old_ping)) {
34308732 14 set_config("chat_old_ping", 35);
b5de723d 15}
d434b9ae 16if (!isset($CFG->chat_method)) {
17 set_config("chat_method", "header_js");
b5de723d 18}
930413b1 19if (!isset($CFG->chat_normal_updatemode)) {
20 set_config("chat_normal_updatemode", 'jsupdate');
21}
d434b9ae 22if (!isset($CFG->chat_serverhost)) {
23 set_config("chat_serverhost", $_SERVER['HTTP_HOST']);
b5de723d 24}
d434b9ae 25if (!isset($CFG->chat_serverip)) {
e2a1a0fa 26 set_config("chat_serverip", '127.0.0.1');
b5de723d 27}
d434b9ae 28if (!isset($CFG->chat_serverport)) {
29 set_config("chat_serverport", 9111);
b5de723d 30}
d434b9ae 31if (!isset($CFG->chat_servermax)) {
32 set_config("chat_servermax", 100);
b5de723d 33}
1515a89e 34
1515a89e 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";
37
38// The HTML head for the message window to start with (with js scrolling)
32f0b38a 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";
1515a89e 40
41// The HTML code for standard empty pages (e.g. if a user was kicked out)
89f688b6 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>";
1515a89e 43
44// The HTML head for the message input page
89f688b6 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\">";
1515a89e 46
47// The HTML code for the message input page, with JavaScript
32f0b38a 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();\">";
1515a89e 49
fbabbd23 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";
1515a89e 52
53function chat_add_instance($chat) {
b5de723d 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
1515a89e 57/// of the new instance.
58
59 $chat->timemodified = time();
60
8496c4af 61 if ($returnid = insert_record("chat", $chat)) {
62
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;
74
75 add_event($event);
76 }
77
78 return $returnid;
1515a89e 79}
80
81
82function chat_update_instance($chat) {
b5de723d 83/// Given an object containing all the necessary data,
84/// (defined by the form in mod.html) this function
1515a89e 85/// will update an existing instance with new data.
86
87 $chat->timemodified = time();
88 $chat->id = $chat->instance;
89
1515a89e 90
8496c4af 91 if ($returnid = update_record("chat", $chat)) {
92
264867fd 93 $event = new object();
8496c4af 94
95 if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
96
97 $event->name = $chat->name;
98 $event->description = $chat->intro;
99 $event->timestart = $chat->chattime;
100
101 update_event($event);
102 }
103 }
104
105 return $returnid;
1515a89e 106}
107
108
109function chat_delete_instance($id) {
b5de723d 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.
1515a89e 113
a71efae3 114 if (! $chat = get_record('chat', 'id', $id)) {
1515a89e 115 return false;
116 }
117
118 $result = true;
119
120 # Delete any dependent records here #
121
a71efae3 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)) {
1515a89e 129 $result = false;
130 }
131
880d8675 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 }
138
36eb856f 139 if (! delete_records('event', 'modulename', 'chat', 'instance', $chat->id)) {
140 $result = false;
141 }
142
1515a89e 143 return $result;
144}
145
146function chat_user_outline($course, $user, $mod, $chat) {
b5de723d 147/// Return a small object with summary information about what a
1515a89e 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
152
5c05d23b 153 $return = NULL;
1515a89e 154 return $return;
155}
156
157function chat_user_complete($course, $user, $mod, $chat) {
b5de723d 158/// Print a detailed representation of what a user has done with
1515a89e 159/// a given particular instance of this module, for user activity reports.
160
161 return true;
162}
163
b7602a11 164function 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.
1515a89e 167/// This function is called from course/lib.php: print_recent_activity()
168
b7602a11 169 global $CFG;
170
c5a05b95 171 $timeold = time() - $CFG->chat_old_ping;
172
8f7dc7f1 173 $lastpingsearch = ($CFG->chat_method == 'sockets') ? '': 'AND cu.lastping > \''.$timeold.'\'';
0469cccf 174
132911c8 175 if (!$chatusers = get_records_sql("SELECT u.id, cu.chatid, u.firstname, u.lastname
3d81c41e 176 FROM {$CFG->prefix}chat_users cu,
177 {$CFG->prefix}chat ch,
178 {$CFG->prefix}user u
b5de723d 179 WHERE cu.userid = u.id
0469cccf 180 AND cu.chatid = ch.id $lastpingsearch
cea57965 181 AND ch.course = '$course->id'
b7602a11 182 ORDER BY cu.chatid ASC") ) {
183 return false;
184 }
1515a89e 185
3120f6f2 186 $outputstarted = false;
b7602a11 187 $current = 0;
188 foreach ($chatusers as $chatuser) {
189 if ($current != $chatuser->chatid) {
190 if ($current) {
8f7dc7f1 191 echo '</ul></div>'; // room
192 $current = 0;
b7602a11 193 }
8f7dc7f1 194 if ($chat = get_record('chat', 'id', $chatuser->chatid)) {
264867fd 195
dabfd0ed 196 // we find the course module id
80aede31 197 $cm = get_coursemodule_from_instance('chat', $chat->id, $course->id);
dabfd0ed 198 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
264867fd 199
dabfd0ed 200 // needs to be fixed
0468976c 201 if (!(has_capability('mod/chat:readlog', $context) or instance_is_visible('chat', $chat))) { // Chat hidden to students
3120f6f2 202 continue;
203 }
204 if (!$outputstarted) {
8f7dc7f1 205 print_headline(get_string('currentchats', 'chat').':');
3120f6f2 206 $outputstarted = true;
207 }
200371e9 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>';
b7602a11 209 }
210 $current = $chatuser->chatid;
211 }
80aede31 212 $fullname = fullname($chatuser, has_capability('moodle/site:viewfullnames', get_context_instance(CONTEXT_COURSE, $course->id)));
8f7dc7f1 213 echo '<li class="info name">'.$fullname.'</li>';
214 }
215
216 if ($current) {
217 echo '</ul></div>'; // room
b7602a11 218 }
219
220 return true;
1515a89e 221}
222
8f7dc7f1 223
1515a89e 224function chat_cron () {
225/// Function to be run periodically according to the moodle cron
b5de723d 226/// This function searches for things that need to be done, such
227/// as sending out mail, toggling flags etc ...
1515a89e 228
229 global $CFG;
230
fcd3a1ee 231 chat_update_chat_times();
232
7d792369 233 chat_delete_old_users();
234
22a4491a 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 }
244
1515a89e 245 return true;
246}
247
84a2fdd7 248function chat_get_participants($chatid, $groupid=0) {
05855091 249//Returns the users with data in one chat
250//(users with records in chat_messages, students)
251
252 global $CFG;
253
84a2fdd7 254 if ($groupid) {
255 $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
256 } else {
257 $groupselect = "";
258 }
259
05855091 260 //Get students
95e72c12 261 $students = get_records_sql("SELECT DISTINCT u.id, u.id
05855091 262 FROM {$CFG->prefix}user u,
263 {$CFG->prefix}chat_messages c
84a2fdd7 264 WHERE c.chatid = '$chatid' $groupselect
265 AND u.id = c.userid");
1515a89e 266
05855091 267 //Return students array (it contains an array of unique users)
268 return ($students);
269}
1515a89e 270
8496c4af 271function 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()
277
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 }
dcd338ff 287 $moduleid = get_field('modules', 'id', 'name', 'chat');
8496c4af 288
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;
294
295 if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
296 update_event($event);
297
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;
dcd338ff 306 $event->visible = get_field('course_modules', 'visible', 'module', $moduleid, 'instance', $chat->id);
b5de723d 307
8496c4af 308 add_event($event);
309 }
310 }
311 return true;
312}
313
516121bd 314
1515a89e 315//////////////////////////////////////////////////////////////////////
316/// Functions that require some SQL
317
84a2fdd7 318function chat_get_users($chatid, $groupid=0) {
1515a89e 319
320 global $CFG;
84a2fdd7 321
322 if ($groupid) {
323 $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
324 } else {
325 $groupselect = "";
326 }
b5de723d 327
426c0437 328 return get_records_sql("SELECT DISTINCT u.id, u.firstname, u.lastname, u.picture, c.lastmessageping, c.firstping
1515a89e 329 FROM {$CFG->prefix}chat_users c,
330 {$CFG->prefix}user u
331 WHERE c.chatid = '$chatid'
84a2fdd7 332 AND u.id = c.userid $groupselect
1515a89e 333 ORDER BY c.firstping ASC");
334}
335
84a2fdd7 336function chat_get_latest_message($chatid, $groupid=0) {
5a8625e4 337/// Efficient way to extract just the latest message
338/// Uses ADOdb directly instead of get_record_sql()
b5de723d 339/// because the LIMIT command causes problems with
5a8625e4 340/// the developer debugging in there.
1515a89e 341
5a8625e4 342 global $db, $CFG;
1515a89e 343
84a2fdd7 344 if ($groupid) {
345 $groupselect = " AND (groupid='$groupid' OR groupid='0')";
346 } else {
347 $groupselect = "";
348 }
349
0217757b 350 if (!$rs = $db->SelectLimit("SELECT *
351 FROM {$CFG->prefix}chat_messages
352 WHERE chatid = '$chatid' $groupselect
353 ORDER BY timestamp DESC", 1)) {
5a8625e4 354 return false;
355 }
356 if ($rs->RecordCount() == 1) {
357 return (object)$rs->fields;
358 } else {
359 return false; // Found no records
360 }
1515a89e 361}
362
5a8625e4 363
1515a89e 364//////////////////////////////////////////////////////////////////////
516121bd 365// login if not already logged in
1515a89e 366
a32c7772 367function chat_login_user($chatid, $version, $groupid, $course) {
1515a89e 368 global $USER;
e7fbd0b3 369 if (($version != 'sockets') and $chatuser = get_record_select('chat_users', "chatid='$chatid' AND userid='$USER->id' AND groupid='$groupid'")) {
516121bd 370 $chatuser->version = $version;
d96466d2 371 $chatuser->ip = $USER->lastip;
516121bd 372 $chatuser->lastping = time();
373 $chatuser->lang = current_language();
1515a89e 374
d96466d2 375 // Sometimes $USER->lastip is not setup properly
d13ef2fb 376 // during login. Update with current value if possible
f83edcb1 377 // or provide a dummy value for the db
d13ef2fb 378 if (empty($chatuser->ip)) {
379 $chatuser->ip = getremoteaddr();
380 if (empty($chatuser->ip)) {
f83edcb1 381 $chatuser->ip = '';
d13ef2fb 382 }
383 }
384
516121bd 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 }
516121bd 392 } else {
6ee78cee 393 $chatuser = new object();
516121bd 394 $chatuser->chatid = $chatid;
395 $chatuser->userid = $USER->id;
396 $chatuser->groupid = $groupid;
397 $chatuser->version = $version;
d96466d2 398 $chatuser->ip = $USER->lastip;
516121bd 399 $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
400 $chatuser->sid = random_string(32);
3dfd307f 401 $chatuser->course = $course->id; //caching - needed for current_language too
402 $chatuser->lang = current_language(); //caching - to resource intensive to find out later
516121bd 403
d96466d2 404 // Sometimes $USER->lastip is not setup properly
274f0091 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 }
413
414
516121bd 415 if (!insert_record('chat_users', $chatuser)) {
416 return false;
417 }
418
a32c7772 419 if ($version == 'sockets') {
420 // do not send 'enter' message, chatd will do it
421 } else {
6ee78cee 422 $message = new object();
2ac0d13b 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();
429
430 if (!insert_record('chat_messages', $message)) {
431 error('Could not insert a chat message!');
432 }
516121bd 433 }
1515a89e 434 }
435
436 return $chatuser->sid;
437}
438
7d792369 439function chat_delete_old_users() {
440// Delete the old and in the way
441
b5012f3e 442 global $CFG;
443
e7fbd0b3 444 $timeold = time() - $CFG->chat_old_ping;
953eb6f3 445 $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
a32c7772 446
6ee78cee 447 $query = "(version<>'basic' AND lastping<'$timeold') OR (version='basic' AND lastping<'$timeoldext')";
7d792369 448
516121bd 449 if ($oldusers = get_records_select('chat_users', $query) ) {
450 delete_records_select('chat_users', $query);
7d792369 451 foreach ($oldusers as $olduser) {
6ee78cee 452 $message = new object();
516121bd 453 $message->chatid = $olduser->chatid;
454 $message->userid = $olduser->userid;
455 $message->groupid = $olduser->groupid;
456 $message->message = 'exit';
457 $message->system = 1;
7d792369 458 $message->timestamp = time();
b5de723d 459
516121bd 460 if (!insert_record('chat_messages', $message)) {
461 error('Could not insert a chat message!');
7d792369 462 }
463 }
464 }
465}
1515a89e 466
22a4491a 467
fcd3a1ee 468function chat_update_chat_times($chatid=0) {
469/// Updates chat records so that the next chat time is correct
470
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 }
481
482 foreach ($chats as $chat) {
7626969c 483 unset($chat->name);
484 unset($chat->intro);
fcd3a1ee 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);
8496c4af 498
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 }
fcd3a1ee 504 }
505}
506
507
aa5c32fd 508function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
72989350 509 global $CFG, $USER;
1515a89e 510
6ee78cee 511 $output = new object();
516121bd 512 $output->beep = false; // by default
513 $output->refreshusers = false; // by default
7d792369 514
72989350 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
970f144e 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;
72989350 520 $tz = get_user_timezone($currentuser->timezone);
b5de723d 521
72989350 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;
b5de723d 526 $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
527
528 $message->picture = print_user_picture($sender->id, 0, $sender->picture, false, true, false);
582de679 529 if ($courseid) {
d3981e38 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>";
582de679 531 }
1515a89e 532
aa5c32fd 533 //Calculate the row class
534 if ($chat_lastrow !== NULL) {
535 $rowclass = ' class="r'.$chat_lastrow.'" ';
536 } else {
537 $rowclass = '';
538 }
539
b5de723d 540 // Start processing the message
1515a89e 541
b5de723d 542 if(!empty($message->system)) {
543 // System event
544 $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
aa5c32fd 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>';
953eb6f3 547 $output->basic = '<dl><dt class="event">'.$message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender)).'</dt></dl>';
7d792369 548
516121bd 549 if($message->message == 'exit' or $message->message == 'enter') {
550 $output->refreshusers = true; //force user panel refresh ASAP
551 }
1515a89e 552 return $output;
553 }
554
82a524ef 555 // It's not a system event
b5de723d 556
557 $text = $message->message;
82a524ef 558
559 /// Parse the text to clean and filter it
560
6ee78cee 561 $options = new object();
82a524ef 562 $options->para = false;
563 $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
b5de723d 564 // And now check for special cases
b5de723d 565 if (substr($text, 0, 5) == 'beep ') {
264867fd 566 /// It's a beep!
7d792369 567 $beepwho = trim(substr($text, 5));
9f85bed4 568
b5de723d 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
7d792369 573 // to a filename uploaded by the user)
574
82a524ef 575 } else if ($beepwho == $currentuser->id) { // current user
b5de723d 576 $outinfo = $message->strtime.': '.get_string('messagebeepsyou', 'chat', fullname($sender));
577 $outmain = '';
7d792369 578 $output->beep = true;
264867fd 579
0eda0a46 580 } else { //something is not caught?
7d792369 581 return false;
582 }
b5de723d 583 } else if (substr($text, 0, 1) == ':') { /// It's an MOO emote
584 $outinfo = $message->strtime;
585 $outmain = $sender->firstname.' '.substr($text, 1);
7d792369 586
b5de723d 587 } else if (substr($text, 0, 1) == '/') { /// It's a user command
1515a89e 588
7d792369 589 if (substr($text, 0, 4) == "/me ") {
b5de723d 590 $outinfo = $message->strtime;
591 $outmain = $sender->firstname.' '.substr($text, 4);
9f85bed4 592 } else {
b5de723d 593 $outinfo = $message->strtime;
7d792369 594 $outmain = $text;
1515a89e 595 }
9f85bed4 596
597 } else { /// It's a normal message
b5de723d 598 $outinfo = $message->strtime.' '.$sender->firstname;
7d792369 599 $outmain = $text;
1515a89e 600 }
264867fd 601
9f85bed4 602 /// Format the message as a small table
1515a89e 603
b5de723d 604 $output->text = strip_tags($outinfo.': '.$outmain);
7d792369 605
5379d249 606 $output->html = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
aa5c32fd 607 $output->html .= "<span class=\"title\">$outinfo</span>";
7d792369 608 if ($outmain) {
609 $output->html .= ": $outmain";
953eb6f3 610 $output->basic = '<dl><dt class="title">'.$outinfo.':</dt><dd class="text">'.$outmain.'</dd></dl>';
6ee78cee 611 } else {
953eb6f3 612 $output->basic = '<dl><dt class="title">'.$outinfo.'</dt></dl>';
7d792369 613 }
aa5c32fd 614 $output->html .= "</td></tr></table>";
7d792369 615 return $output;
b5de723d 616}
617
aa5c32fd 618function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
b5de723d 619/// Given a message object full of information, this function
620/// formats it appropriately into text and html, then
621/// returns the formatted data.
622
78c98892 623 static $users; // Cache user lookups
624
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;
b5de723d 631 }
aa5c32fd 632 return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
1515a89e 633}
634
f3221af9 635function chat_get_view_actions() {
636 return array('view','view all','report');
637}
638
639function chat_get_post_actions() {
640 return array('talk');
641}
642
9ca0187e 643function chat_print_overview($courses, &$htmlarray) {
644 global $USER, $CFG;
645
646 if (empty($courses) || !is_array($courses) || count($courses) == 0) {
647 return array();
648 }
649
650 if (!$chats = get_all_instances_in_courses('chat',$courses)) {
651 return;
652 }
653
654 $strchat = get_string('modulename', 'chat');
655 $strnextsession = get_string('nextsession', 'chat');
9ca0187e 656
657 foreach ($chats as $chat) {
9ca0187e 658 if ($chat->chattime and $chat->schedule) { // A chat is scheduled
a2a37336 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>';
664
665 if (empty($htmlarray[$chat->course]['chat'])) {
666 $htmlarray[$chat->course]['chat'] = $str;
667 } else {
668 $htmlarray[$chat->course]['chat'] .= $str;
669 }
9ca0187e 670 }
9ca0187e 671 }
672}
673
1515a89e 674?>