mod/chat/lib.php

   1 <?php  // $Id$
   2
   3 /// Library of functions and constants for module chat
   4
   5 require_once($CFG->libdir.'/pagelib.php');
   6
   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 }
  34
  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)
  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";
  40
  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>";
  43
  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\">";
  46
  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();\">";
  49
  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";
  52
  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.
  58
  59     $chat->timemodified = time();
  60
  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;
  79 }
  80
  81
  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.
  86
  87     $chat->timemodified = time();
  88     $chat->id = $chat->instance;
  89
  90
  91     if ($returnid = update_record("chat", $chat)) {
  92
  93         $event = new object();
  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;
 106 }
 107
 108
 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.
 113
 114     if (! $chat = get_record('chat', 'id', $id)) {
 115         return false;
 116     }
 117
 118     $result = true;
 119
 120     # Delete any dependent records here #
 121
 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     }
 131
 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
 139     if (! delete_records('event', 'modulename', 'chat', 'instance', $chat->id)) {
 140         $result = false;
 141     }
 142
 143     return $result;
 144 }
 145
 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
 152
 153     $return = NULL;
 154     return $return;
 155 }
 156
 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.
 160
 161     return true;
 162 }
 163
 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()
 168
 169     global $CFG;
 170
 171     $timeold = time() - $CFG->chat_old_ping;
 172
 173     $lastpingsearch = ($CFG->chat_method == 'sockets') ? '': 'AND cu.lastping > \''.$timeold.'\'';
 174
 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     }
 185
 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)) {
 195
 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);
 199
 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     }
 215
 216     if ($current) {
 217         echo '</ul></div>';  // room
 218     }
 219
 220     return true;
 221 }
 222
 223
 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 ...
 228
 229     global $CFG;
 230
 231     chat_update_chat_times();
 232
 233     chat_delete_old_users();
 234
 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
 245     return true;
 246 }
 247
 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)
 251
 252     global $CFG;
 253
 254     if ($groupid) {
 255         $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
 256     } else {
 257         $groupselect = "";
 258     }
 259
 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");
 266
 267     //Return students array (it contains an array of unique users)
 268     return ($students);
 269 }
 270
 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()
 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     }
 287     $moduleid = get_field('modules', 'id', 'name', 'chat');
 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;
 306             $event->visible     = get_field('course_modules', 'visible', 'module', $moduleid, 'instance', $chat->id);
 307
 308             add_event($event);
 309         }
 310     }
 311     return true;
 312 }
 313
 314
 315 //////////////////////////////////////////////////////////////////////
 316 /// Functions that require some SQL
 317
 318 function chat_get_users($chatid, $groupid=0, $groupingid=0) {
 319
 320     global $CFG;
 321
 322     if ($groupid) {
 323         $groupselect = " AND (c.groupid='$groupid' OR c.groupid='0')";
 324     } else {
 325         $groupselect = "";
 326     }
 327
 328     if (!empty($CFG->enablegroupings) && !(empty($groupingid))) {
 329         $groupingjoin = "INNER JOIN {$CFG->prefix}groups_members gm ON u.id = gm.userid
 330                          INNER JOIN {$CFG->prefix}groupings_groups gg ON gm.groupid = gg.groupid AND gg.groupingid = $groupingid ";
 331
 332     } else {
 333         $groupingjoin = '';
 334     }
 335
 336     return get_records_sql("SELECT DISTINCT u.id, u.firstname, u.lastname, u.picture, c.lastmessageping, c.firstping
 337                               FROM {$CFG->prefix}chat_users c
 338                                 INNER JOIN {$CFG->prefix}user u ON u.id = c.userid
 339                                 $groupingjoin
 340                              WHERE c.chatid = '$chatid'
 341                                 $groupselect
 342                              ORDER BY c.firstping ASC");
 343 }
 344
 345 function chat_get_latest_message($chatid, $groupid=0) {
 346 /// Efficient way to extract just the latest message
 347 /// Uses ADOdb directly instead of get_record_sql()
 348 /// because the LIMIT command causes problems with
 349 /// the developer debugging in there.
 350
 351     global $db, $CFG;
 352
 353     if ($groupid) {
 354         $groupselect = " AND (groupid='$groupid' OR groupid='0')";
 355     } else {
 356         $groupselect = "";
 357     }
 358
 359     if (!$rs = $db->SelectLimit("SELECT *
 360                                  FROM {$CFG->prefix}chat_messages
 361                                  WHERE chatid = '$chatid' $groupselect
 362                                  ORDER BY timestamp DESC", 1)) {
 363         return false;
 364     }
 365     if ($rs->RecordCount() == 1) {
 366         return rs_fetch_record($rs);
 367     } else {
 368         return false;                 // Found no records
 369     }
 370 }
 371
 372
 373 //////////////////////////////////////////////////////////////////////
 374 // login if not already logged in
 375
 376 function chat_login_user($chatid, $version, $groupid, $course) {
 377     global $USER;
 378     if (($version != 'sockets') and $chatuser = get_record_select('chat_users', "chatid='$chatid' AND userid='$USER->id' AND groupid='$groupid'")) {
 379         $chatuser->version  = $version;
 380         $chatuser->ip       = $USER->lastip;
 381         $chatuser->lastping = time();
 382         $chatuser->lang     = current_language();
 383
 384         // Sometimes $USER->lastip is not setup properly
 385         // during login. Update with current value if possible
 386         // or provide a dummy value for the db
 387         if (empty($chatuser->ip)) {
 388             $chatuser->ip = getremoteaddr();
 389             if (empty($chatuser->ip)) {
 390                 $chatuser->ip = '';
 391             }
 392         }
 393
 394         if (($chatuser->course != $course->id)
 395          or ($chatuser->userid != $USER->id)) {
 396             return false;
 397         }
 398         if (!update_record('chat_users', $chatuser)) {
 399             return false;
 400         }
 401     } else {
 402         $chatuser = new object();
 403         $chatuser->chatid   = $chatid;
 404         $chatuser->userid   = $USER->id;
 405         $chatuser->groupid  = $groupid;
 406         $chatuser->version  = $version;
 407         $chatuser->ip       = $USER->lastip;
 408         $chatuser->lastping = $chatuser->firstping = $chatuser->lastmessageping = time();
 409         $chatuser->sid      = random_string(32);
 410         $chatuser->course   = $course->id; //caching - needed for current_language too
 411         $chatuser->lang     = current_language(); //caching - to resource intensive to find out later
 412
 413         // Sometimes $USER->lastip is not setup properly
 414         // during login. Update with current value if possible
 415         // or provide a dummy value for the db
 416         if (empty($chatuser->ip)) {
 417             $chatuser->ip = getremoteaddr();
 418             if (empty($chatuser->ip)) {
 419                 $chatuser->ip = '';
 420             }
 421         }
 422
 423
 424         if (!insert_record('chat_users', $chatuser)) {
 425             return false;
 426         }
 427
 428         if ($version == 'sockets') {
 429             // do not send 'enter' message, chatd will do it
 430         } else {
 431             $message = new object();
 432             $message->chatid    = $chatuser->chatid;
 433             $message->userid    = $chatuser->userid;
 434             $message->groupid   = $groupid;
 435             $message->message   = 'enter';
 436             $message->system    = 1;
 437             $message->timestamp = time();
 438
 439             if (!insert_record('chat_messages', $message)) {
 440                 error('Could not insert a chat message!');
 441             }
 442         }
 443     }
 444
 445     return $chatuser->sid;
 446 }
 447
 448 function chat_delete_old_users() {
 449 // Delete the old and in the way
 450
 451     global $CFG;
 452
 453     $timeold = time() - $CFG->chat_old_ping;
 454     $timeoldext = time() - ($CFG->chat_old_ping*10); // JSless gui_basic needs much longer timeouts
 455
 456     $query = "(version<>'basic' AND lastping<'$timeold') OR (version='basic' AND lastping<'$timeoldext')";
 457
 458     if ($oldusers = get_records_select('chat_users', $query) ) {
 459         delete_records_select('chat_users', $query);
 460         foreach ($oldusers as $olduser) {
 461             $message = new object();
 462             $message->chatid    = $olduser->chatid;
 463             $message->userid    = $olduser->userid;
 464             $message->groupid   = $olduser->groupid;
 465             $message->message   = 'exit';
 466             $message->system    = 1;
 467             $message->timestamp = time();
 468
 469             if (!insert_record('chat_messages', $message)) {
 470                 error('Could not insert a chat message!');
 471             }
 472         }
 473     }
 474 }
 475
 476
 477 function chat_update_chat_times($chatid=0) {
 478 /// Updates chat records so that the next chat time is correct
 479
 480     $timenow = time();
 481     if ($chatid) {
 482         if (!$chats[] = get_record_select("chat", "id = '$chatid' AND chattime <= '$timenow' AND schedule > '0'")) {
 483             return;
 484         }
 485     } else {
 486         if (!$chats = get_records_select("chat", "chattime <= '$timenow' AND schedule > '0'")) {
 487             return;
 488         }
 489     }
 490
 491     foreach ($chats as $chat) {
 492         unset($chat->name);
 493         unset($chat->intro);
 494         switch ($chat->schedule) {
 495             case 1: // Single event - turn off schedule and disable
 496                     $chat->chattime = 0;
 497                     $chat->schedule = 0;
 498                     break;
 499             case 2: // Repeat daily
 500                     $chat->chattime += 24 * 3600;
 501                     break;
 502             case 3: // Repeat weekly
 503                     $chat->chattime += 7 * 24 * 3600;
 504                     break;
 505         }
 506         update_record("chat", $chat);
 507
 508         $event = NULL;           // Update calendar too
 509         if ($event->id = get_field('event', 'id', 'modulename', 'chat', 'instance', $chat->id)) {
 510             $event->timestart   = $chat->chattime;
 511             update_event($event);
 512         }
 513     }
 514 }
 515
 516
 517 function chat_format_message_manually($message, $courseid, $sender, $currentuser, $chat_lastrow=NULL) {
 518     global $CFG, $USER;
 519
 520     $output = new object();
 521     $output->beep = false;       // by default
 522     $output->refreshusers = false; // by default
 523
 524     // Use get_user_timezone() to find the correct timezone for displaying this message:
 525     // It's either the current user's timezone or else decided by some Moodle config setting
 526     // First, "reset" $USER->timezone (which could have been set by a previous call to here)
 527     // because otherwise the value for the previous $currentuser will take precedence over $CFG->timezone
 528     $USER->timezone = 99;
 529     $tz = get_user_timezone($currentuser->timezone);
 530
 531     // Before formatting the message time string, set $USER->timezone to the above.
 532     // This will allow dst_offset_on (called by userdate) to work correctly, otherwise the
 533     // message times appear off because DST is not taken into account when it should be.
 534     $USER->timezone = $tz;
 535     $message->strtime = userdate($message->timestamp, get_string('strftimemessage', 'chat'), $tz);
 536
 537     $message->picture = print_user_picture($sender->id, 0, $sender->picture, false, true, false);
 538     if ($courseid) {
 539         $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>";
 540     }
 541
 542     //Calculate the row class
 543     if ($chat_lastrow !== NULL) {
 544         $rowclass = ' class="r'.$chat_lastrow.'" ';
 545     } else {
 546         $rowclass = '';
 547     }
 548
 549     // Start processing the message
 550
 551     if(!empty($message->system)) {
 552         // System event
 553         $output->text = $message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender));
 554         $output->html  = '<table class="chat-event"><tr'.$rowclass.'><td class="picture">'.$message->picture.'</td><td class="text">';
 555         $output->html .= '<span class="event">'.$output->text.'</span></td></tr></table>';
 556         $output->basic = '<dl><dt class="event">'.$message->strtime.': '.get_string('message'.$message->message, 'chat', fullname($sender)).'</dt></dl>';
 557
 558         if($message->message == 'exit' or $message->message == 'enter') {
 559             $output->refreshusers = true; //force user panel refresh ASAP
 560         }
 561         return $output;
 562     }
 563
 564     // It's not a system event
 565
 566     $text = $message->message;
 567
 568     /// Parse the text to clean and filter it
 569
 570     $options = new object();
 571     $options->para = false;
 572     $text = format_text($text, FORMAT_MOODLE, $options, $courseid);
 573
 574     // And now check for special cases
 575     $special = false;
 576
 577     if (substr($text, 0, 5) == 'beep ') {
 578         /// It's a beep!
 579         $special = true;
 580         $beepwho = trim(substr($text, 5));
 581
 582         if ($beepwho == 'all') {   // everyone
 583             $outinfo = $message->strtime.': '.get_string('messagebeepseveryone', 'chat', fullname($sender));
 584             $outmain = '';
 585             $output->beep = true;  // (eventually this should be set to
 586                                    //  to a filename uploaded by the user)
 587
 588         } else if ($beepwho == $currentuser->id) {  // current user
 589             $outinfo = $message->strtime.': '.get_string('messagebeepsyou', 'chat', fullname($sender));
 590             $outmain = '';
 591             $output->beep = true;
 592
 593         } else {  //something is not caught?
 594             return false;
 595         }
 596     } else if (substr($text, 0, 1) == '/') {     /// It's a user command
 597         if (trim(substr($text, 0, 4)) == '/me') {
 598             $special = true;
 599             $outinfo = $message->strtime;
 600             $outmain = $sender->firstname.' '.substr($text, 4);
 601         }
 602     }
 603
 604     if(!$special) {
 605         $outinfo = $message->strtime.' '.$sender->firstname;
 606         $outmain = $text;
 607     }
 608
 609     /// Format the message as a small table
 610
 611     $output->text  = strip_tags($outinfo.': '.$outmain);
 612
 613     $output->html  = "<table class=\"chat-message\"><tr$rowclass><td class=\"picture\" valign=\"top\">$message->picture</td><td class=\"text\">";
 614     $output->html .= "<span class=\"title\">$outinfo</span>";
 615     if ($outmain) {
 616         $output->html .= ": $outmain";
 617         $output->basic = '<dl><dt class="title">'.$outinfo.':</dt><dd class="text">'.$outmain.'</dd></dl>';
 618     } else {
 619         $output->basic = '<dl><dt class="title">'.$outinfo.'</dt></dl>';
 620     }
 621     $output->html .= "</td></tr></table>";
 622     return $output;
 623 }
 624
 625 function chat_format_message($message, $courseid, $currentuser, $chat_lastrow=NULL) {
 626 /// Given a message object full of information, this function
 627 /// formats it appropriately into text and html, then
 628 /// returns the formatted data.
 629
 630     static $users;     // Cache user lookups
 631
 632     if (isset($users[$message->userid])) {
 633         $user = $users[$message->userid];
 634     } else if ($user = get_record('user', 'id', $message->userid, '','','','','id,picture,firstname,lastname')) {
 635         $users[$message->userid] = $user;
 636     } else {
 637         return NULL;
 638     }
 639     return chat_format_message_manually($message, $courseid, $user, $currentuser, $chat_lastrow);
 640 }
 641
 642 function chat_get_view_actions() {
 643     return array('view','view all','report');
 644 }
 645
 646 function chat_get_post_actions() {
 647     return array('talk');
 648 }
 649
 650 function chat_print_overview($courses, &$htmlarray) {
 651     global $USER, $CFG;
 652
 653     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
 654         return array();
 655     }
 656
 657     if (!$chats = get_all_instances_in_courses('chat',$courses)) {
 658         return;
 659     }
 660
 661     $strchat = get_string('modulename', 'chat');
 662     $strnextsession  = get_string('nextsession', 'chat');
 663
 664     foreach ($chats as $chat) {
 665         if ($chat->chattime and $chat->schedule) {  // A chat is scheduled
 666             $str = '<div class="chat overview"><div class="name">'.
 667                    $strchat.': <a '.($chat->visible?'':' class="dimmed"').
 668                    ' href="'.$CFG->wwwroot.'/mod/chat/view.php?id='.$chat->coursemodule.'">'.
 669                    $chat->name.'</a></div>';
 670             $str .= '<div class="info">'.$strnextsession.': '.userdate($chat->chattime).'</div></div>';
 671
 672             if (empty($htmlarray[$chat->course]['chat'])) {
 673                 $htmlarray[$chat->course]['chat'] = $str;
 674             } else {
 675                 $htmlarray[$chat->course]['chat'] .= $str;
 676             }
 677         }
 678     }
 679 }
 680
 681 ?>