diff --git a/lang/en_utf8/chat.php b/lang/en_utf8/chat.php index 7eba9371b79..2c8e39c94bb 100644 --- a/lang/en_utf8/chat.php +++ b/lang/en_utf8/chat.php @@ -6,8 +6,9 @@ $string['chatname'] = 'Name of this chat room'; $string['chatreport'] = 'Chat sessions'; $string['chattime'] = 'Next chat time'; $string['configmethod'] = 'The normal chat method involves the clients regularly contacting the server for updates. It requires no configuration and works everywhere, but it can create a large load on the server with many chatters. Using a server daemon requires shell access to Unix, but it results in a fast scalable chat environment.'; +$string['confignormalupdatemode'] = 'Chatroom updates are normally served efficiently using the Keep-Alive feature of HTTP 1.1, but this is still quite heavy on the server. A more advanced method is to use the Stream strategy to feed updates to the users. Using Stream scales much better (similar to the chatd method) but may not be supported by your server.'; $string['configoldping'] = 'What is the maximum time that may pass before we detect that a user has disconnected (in seconds)? This is just an upper limit, as usually disconnects are detected very quickly. Lower values will be more demanding on your server. If you are using the normal method, never set this lower than 2 * chat_refresh_room.'; -$string['configrefreshroom'] = 'How often should the chat room itself be refreshed? (in seconds). Setting this low will make the chat room seem quicker, but it may place a higher load on your web server when many people are chatting'; +$string['configrefreshroom'] = 'How often should the chat room itself be refreshed? (in seconds). Setting this low will make the chat room seem quicker, but it may place a higher load on your web server when many people are chatting. If you are using Stream updates, you can select higher refresh frequencies -- try with 2.'; $string['configrefreshuserlist'] = 'How often should the list of users be refreshed? (in seconds)'; $string['configserverhost'] = 'The hostname of the computer where the server daemon is'; $string['configserverip'] = 'The numerical IP address that matches the above hostname'; @@ -39,6 +40,8 @@ $string['neverdeletemessages'] = 'Never delete messages'; $string['nextsession'] = 'Next scheduled session'; $string['noguests'] = 'The chat is not open to guests'; $string['nomessages'] = 'No messages yet'; +$string['normalstream'] = 'Stream'; +$string['normalkeepalive'] = 'KeepAlive'; $string['noscheduledsession'] = 'No scheduled session'; $string['repeatdaily'] = 'At the same time every day'; $string['repeatnone'] = 'No repeats - publish the specified time only'; diff --git a/mod/chat/config.html b/mod/chat/config.html index 8baa10b1853..8d262c10f76 100644 --- a/mod/chat/config.html +++ b/mod/chat/config.html @@ -61,6 +61,21 @@ + + chat_normal_updatemode: + +chat_normal_updatemode, "", "", ""); +?> + + + + + +
diff --git a/mod/chat/gui_header_js/index.php b/mod/chat/gui_header_js/index.php index f59e0d93450..6e0227acefa 100644 --- a/mod/chat/gui_header_js/index.php +++ b/mod/chat/gui_header_js/index.php @@ -52,6 +52,11 @@ $params = "chat_sid=$chat_sid"; + // fallback to the old jsupdate, but allow other update modes + $updatemode = 'jsupdate'; + if (!empty($CFG->chat_normal_updatemode)) { + $updatemode = $CFG->chat_normal_updatemode; + } ?> @@ -65,7 +70,7 @@ - + diff --git a/mod/chat/gui_header_js/jsupdated.php b/mod/chat/gui_header_js/jsupdated.php new file mode 100644 index 00000000000..0558cf43788 --- /dev/null +++ b/mod/chat/gui_header_js/jsupdated.php @@ -0,0 +1,223 @@ + + ** + ** This is an alternative version of jsupdate.php that acts + ** as a long-running daemon. It will feed/stall/feed JS updates + ** to the client. From the module configuration select "Stream" + ** updates. + ** + ** The client connection is not forever though. Once we reach + ** CHAT_MAX_CLIENT_UPDATES, it will force the client to re-fetch it. + ** + ** This buys us all the benefits that chatd has, minus the setup, + ** as we are using apache to do the daemon handling. + ** + **/ + + + define('CHAT_MAX_CLIENT_UPDATES', 1000); + $nomoodlecookie = true; // Session not needed! + + require('../../../config.php'); + require('../lib.php'); + + // we are going to run for a long time + // avoid being terminated by php + @set_time_limit(0); + + $chat_sid = required_param('chat_sid', PARAM_ALPHANUM); + $chat_lasttime = optional_param('chat_lasttime', 0, PARAM_INT); + $chat_lastrow = optional_param('chat_lastrow', 1, PARAM_INT); + $chat_lastid = optional_param('chat_lastid', 0, PARAM_INT); + + if (!$chatuser = get_record('chat_users', 'sid', $chat_sid)) { + error('Not logged in!'); + } + + //Get the course theme + $course = get_record('course','id',$chatuser->course,'','','','','id,theme'); + //Set the course theme if necessary + if (!empty($course->theme)) { + if (!empty($CFG->allowcoursethemes)) { + $CFG->coursetheme = $course->theme; + } + } + //Get the user theme and enough info to be used in chat_format_message() which passes it along to + // chat_format_message_manually() -- and only id and timezone are used. + if (!$USER = get_record('user','id',$chatuser->userid,'','','','','id, theme, username, timezone')) { + error('User does not exist!'); + } + $USER->description = ''; + + //Adjust the prefered theme (main, course, user) + theme_setup(); + + chat_force_language($chatuser->lang); + + // force deleting of timed out users if there is a silence in room or just entering + if ((time() - $chat_lasttime) > $CFG->chat_old_ping) { + // must be done before chat_get_latest_message!!! + chat_delete_old_users(); + } + + // + // Time to send headers, and lay out the basic JS updater page + // + header('Expires: Sun, 28 Dec 1997 09:32:45 GMT'); + header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT'); + header('Cache-Control: no-cache, must-revalidate'); + header('Pragma: no-cache'); + header('Content-Type: text/html'); + + /// required stylesheets + $stylesheetshtml = ''; + foreach ($CFG->stylesheets as $stylesheet) { + $stylesheetshtml .= ''; + } + +?> + + + + + + + + +lastping = time(); + set_field('chat_users', 'lastping', $chatuser->lastping, 'id', $chatuser->id ); + + if ($message = chat_get_latest_message($chatuser->chatid, $chatuser->groupid)) { + $chat_newlasttime = $message->timestamp; + $chat_newlastid = $message->id; + } else { + $chat_newlasttime = 0; + $chat_newlastid = 0; + print " \n"; + print $CHAT_DUMMY_DATA; + @ob_end_flush(); + sleep($CFG->chat_refresh_room); + continue; + } + + $timenow = time(); + + + $groupselect = $chatuser->groupid ? " AND (groupid='".$chatuser->groupid."' OR groupid='0') " : ""; + + $newcriteria = ''; + if ($chat_lastid > 0) { + $newcriteria = "id > $chat_lastid"; + } else { + if ($chat_lasttime == 0) { //display some previous messages + $chat_lasttime = $timenow - $CFG->chat_old_ping; //TO DO - any better value?? + } + $newcriteria = "timestamp > $chat_lasttime"; + } + + $messages = get_records_select("chat_messages", + "chatid = '$chatuser->chatid' AND $newcriteria $groupselect", + "timestamp ASC"); + + if ($messages) { + $num = count($messages); + } else { + print " \n"; + print $CHAT_DUMMY_DATA; + @ob_end_flush(); + sleep($CFG->chat_refresh_room); + continue; + $num = 0; + } + + print '' . "\n\n"; + if ($beep) { + print ''; + } + print $CHAT_DUMMY_DATA; + @ob_end_flush(); + sleep($CFG->chat_refresh_room); + } // here ends the for() loop + + // here & should be written & :-D + $refreshurl = "{$CFG->wwwroot}/mod/chat/gui_header_js/jsupdated.php?chat_sid=$chat_sid&chat_lasttime=$chat_lasttime&chat_lastrow=$chat_newrow&chat_lastid=$chat_lastid"; + print '' . "\n\n"; + +?> + + + diff --git a/mod/chat/lib.php b/mod/chat/lib.php index 12c4c5a51b9..dad87133a0b 100644 --- a/mod/chat/lib.php +++ b/mod/chat/lib.php @@ -16,6 +16,9 @@ if (!isset($CFG->chat_old_ping)) { if (!isset($CFG->chat_method)) { set_config("chat_method", "header_js"); } +if (!isset($CFG->chat_normal_updatemode)) { + set_config("chat_normal_updatemode", 'jsupdate'); +} if (!isset($CFG->chat_serverhost)) { set_config("chat_serverhost", $_SERVER['HTTP_HOST']); }