2 rcs_id('$Id: Request.php,v 1.83 2004-12-10 02:36:43 rurban Exp $');
4 Copyright (C) 2002,2004 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 // backward compatibility for PHP < 4.2.0
24 if (!function_exists('ob_clean')) {
34 $this->_fix_magic_quotes_gpc();
35 $this->_fix_multipart_form_data();
37 switch($this->get('REQUEST_METHOD')) {
40 $this->args = &$GLOBALS['HTTP_GET_VARS'];
43 $this->args = &$GLOBALS['HTTP_POST_VARS'];
46 $this->args = array();
50 $this->session = new Request_SessionVars;
51 $this->cookies = new Request_CookieVars;
53 if (ACCESS_LOG or ACCESS_LOG_SQL) {
54 $this->_accesslog =& new Request_AccessLog(ACCESS_LOG, ACCESS_LOG_SQL);
57 $GLOBALS['request'] = $this;
61 if (!empty($GLOBALS['HTTP_SERVER_VARS']))
62 $vars = &$GLOBALS['HTTP_SERVER_VARS'];
63 else // cgi or other servers than Apache
64 $vars = &$GLOBALS['HTTP_ENV_VARS'];
66 if (isset($vars[$key]))
71 $addr = $vars['REMOTE_ADDR'];
72 if (defined('ENABLE_REVERSE_DNS') && ENABLE_REVERSE_DNS)
73 return $vars[$key] = gethostbyaddr($addr);
81 function getArg($key) {
82 if (isset($this->args[$key]))
83 return $this->args[$key];
91 function setArg($key, $val) {
93 unset($this->args[$key]);
95 $this->args[$key] = $val;
98 // Well oh well. Do we really want to pass POST params back as GET?
99 function getURLtoSelf($args = false, $exclude = array()) {
100 $get_args = $this->args;
102 $get_args = array_merge($get_args, $args);
104 // Err... good point...
106 if ($this->isPost()) {
107 $exclude = array_merge($exclude, array('action','auth'));
108 //$get_args = $args; // or only the provided
110 trigger_error("Request::getURLtoSelf() should probably not be from POST",
115 foreach ($exclude as $ex) {
116 if (!empty($get_args[$ex])) unset($get_args[$ex]);
119 $pagename = $get_args['pagename'];
120 unset ($get_args['pagename']);
121 if (!empty($get_args['action']) and $get_args['action'] == 'browse')
122 unset($get_args['action']);
124 return WikiURL($pagename, $get_args);
128 return $this->get("REQUEST_METHOD") == "POST";
131 function isGetOrHead () {
132 return in_array($this->get('REQUEST_METHOD'),
133 array('GET', 'HEAD'));
136 function httpVersion() {
137 if (!preg_match('@HTTP\s*/\s*(\d+.\d+)@', $this->get('SERVER_PROTOCOL'), $m))
139 return (float) $m[1];
142 function redirect($url, $noreturn=true) {
143 $bogus = defined('DISABLE_HTTP_REDIRECT') and DISABLE_HTTP_REDIRECT;
146 header("Location: $url");
148 * "302 Found" is not really meant to be sent in response
149 * to a POST. Worse still, according to (both HTTP 1.0
150 * and 1.1) spec, the user, if it is sent, the user agent
151 * is supposed to use the same method to fetch the
152 * redirected URI as the original.
154 * That means if we redirect from a POST, the user-agent
155 * supposed to generate another POST. Not what we want.
156 * (We do this after a page save after all.)
158 * Fortunately, most/all browsers don't do that.
160 * "303 See Other" is what we really want. But it only
163 * FIXME: this is still not spec compliant for HTTP
166 $status = $this->httpVersion() >= 1.1 ? 303 : 302;
167 $this->setStatus($status);
171 include_once('lib/Template.php');
172 $this->discardOutput();
173 $tmpl = new Template('redirect', $this, array('REDIRECT_URL' => $url));
179 function redirect(url) {
180 if (typeof location.replace == 'function')
181 location.replace(url);
182 else if (typeof location.assign == 'function')
183 location.assign(url);
185 window.location = url;
187 redirect('" . addslashes($url) . "')");
191 /** Set validators for this response.
193 * This sets a (possibly incomplete) set of validators
196 * The validator set can be extended using appendValidators().
198 * When you're all done setting and appending validators, you
199 * must call checkValidators() to check them and set the
200 * appropriate headers in the HTTP response.
204 * $request->setValidators(array('pagename' => $pagename,
205 * '%mtime' => $rev->get('mtime')));
207 * // Wups... response content depends on $otherpage, too...
208 * $request->appendValidators(array('otherpage' => $otherpagerev->getPageName(),
209 * '%mtime' => $otherpagerev->get('mtime')));
211 * // After all validators have been set:
212 * $request->checkValidators();
214 function setValidators($validator_set) {
215 if (is_array($validator_set))
216 $validator_set = new HTTP_ValidatorSet($validator_set);
217 $this->_validators = $validator_set;
220 /** Append more validators for this response.
221 * i.e dependencies on other pages mtimes
222 * now it may be called in init also to simplify client code.
224 function appendValidators($validator_set) {
225 if (!isset($this->_validators)) {
226 $this->setValidators($validator_set);
229 $this->_validators->append($validator_set);
232 /** Check validators and set headers in HTTP response
234 * This sets the appropriate "Last-Modified" and "ETag"
235 * headers in the HTTP response.
237 * Additionally, if the validators match any(all) conditional
238 * headers in the HTTP request, this method will not return, but
239 * instead will send "304 Not Modified" or "412 Precondition
240 * Failed" (as appropriate) back to the client.
242 function checkValidators() {
243 $validators = &$this->_validators;
245 // Set validator headers
246 if ($this->_is_buffering_output or !headers_sent()) {
247 if (($etag = $validators->getETag()) !== false)
248 header("ETag: " . $etag->asString());
249 if (($mtime = $validators->getModificationTime()) !== false)
250 header("Last-Modified: " . Rfc1123DateTime($mtime));
252 // Set cache control headers
253 $this->cacheControl();
256 if (CACHE_CONTROL == 'NO_CACHE')
257 return; // don't check conditionals...
259 // Check conditional headers in request
260 $status = $validators->checkConditionalRequest($this);
262 // Return short response due to failed conditionals
263 $this->setStatus($status);
265 $this->discardOutput();
271 /** Set the cache control headers in the HTTP response.
273 function cacheControl($strategy=CACHE_CONTROL, $max_age=CACHE_CONTROL_MAX_AGE) {
274 if ($strategy == 'NO_CACHE') {
275 $cache_control = "no-cache"; // better set private. See Pear HTTP_Header
278 elseif ($strategy == 'ALLOW_STALE' && $max_age > 0) {
279 $cache_control = sprintf("max-age=%d", $max_age);
282 $cache_control = "must-revalidate";
285 header("Cache-Control: $cache_control");
286 header("Expires: " . Rfc1123DateTime(time() + $max_age));
287 header("Vary: Cookie"); // FIXME: add more here?
290 function setStatus($status) {
291 if (preg_match('|^HTTP/.*?\s(\d+)|i', $status, $m)) {
296 $status = (integer) $status;
297 $reason = array('200' => 'OK',
299 '303' => 'See Other',
300 '304' => 'Not Modified',
301 '400' => 'Bad Request',
302 '401' => 'Unauthorized',
303 '403' => 'Forbidden',
304 '404' => 'Not Found',
305 '412' => 'Precondition Failed');
306 // FIXME: is it always okay to send HTTP/1.1 here, even for older clients?
307 header(sprintf("HTTP/1.1 %d %s", $status, $reason[$status]));
310 if (isset($this->_log_entry))
311 $this->_log_entry->setStatus($status);
314 function buffer_output($compress = true) {
315 // FIXME: disables sessions (some byte before all headers_sent())
316 /*if (defined('USECACHE') and !USECACHE) {
317 $this->_is_buffering_output = false;
320 if (defined('COMPRESS_OUTPUT')) {
321 if (!COMPRESS_OUTPUT)
324 elseif (!check_php_version(4,2,3))
326 elseif (isCGI()) // necessary?
329 if ($this->getArg('start_debug'))
331 // Should we compress even when apache_note is not available?
332 // sf.net bug #933183 and http://bugs.php.net/17557
333 // This effectively eliminates CGI, but all other servers also. hmm.
335 and (!function_exists('ob_gzhandler')
336 or !function_exists('apache_note')))
338 // http://www.php.net/ob_gzhandler "output handler 'ob_gzhandler' cannot be used twice"
339 if ($compress and ini_get("zlib.output_compression"))
342 // New: we check for the client Accept-Encoding: "gzip" presence also
343 // This should eliminate a lot or reported problems.
345 and (!$this->get("HTTP_ACCEPT_ENCODING")
346 or !strstr($this->get("HTTP_ACCEPT_ENCODING"), "gzip")))
349 // Most RSS clients are NOT(!) application/xml gzip compatible yet.
350 // Even if they are sending the accept-encoding gzip header!
351 // wget is, Mozilla, and MSIE no.
352 // Of the RSS readers only MagpieRSS 0.5.2 is. http://www.rssgov.com/rssparsers.html
353 // See also http://phpwiki.sourceforge.net/phpwiki/KnownBugs
355 and $this->getArg('format')
356 and strstr($this->getArg('format'), 'rss'))
360 ob_start('ob_gzhandler');
362 * Attempt to prevent Apache from doing the dreaded double-gzip.
364 * It would be better if we could detect when apache was going
365 * to zip for us, and then let it ... but I have yet to figure
366 * out how to do that.
368 if (function_exists('apache_note'))
369 @apache_note('no-gzip', 1);
372 // Now we alway buffer output.
373 // This is so we can set HTTP headers (e.g. for redirect)
375 // FIXME: change the name of this method.
378 $this->_is_buffering_output = true;
379 $this->_ob_get_length = 0;
382 function discardOutput() {
383 if (!empty($this->_is_buffering_output)) {
385 $this->_is_buffering_output = false;
387 trigger_error("Not buffering output", E_USER_NOTICE);
392 * Longer texts need too much memory on tiny or memory-limit=8MB systems.
393 * We might want to flush our buffer and restart again.
394 * (This would be fine if php would release its memory)
395 * Note that this must not be called inside Template expansion or other
396 * sections with ob_buffering.
398 function chunkOutput() {
399 if (!empty($this->_is_buffering_output) or
400 (function_exists('ob_get_level') and @ob_get_level())) {
401 $this->_do_chunked_output = true;
402 $this->_ob_get_length += ob_get_length();
403 while (@ob_end_flush());
410 if (!empty($this->_accesslog)) {
411 $this->_accesslog->push($this);
412 if (empty($this->_do_chunked_output))
413 $this->_ob_get_length = ob_get_length();
414 $this->_accesslog->setSize($this->_ob_get_length);
416 if ($RUNTIMER) $this->_accesslog->setDuration($RUNTIMER->getTime());
417 // sql logging must be done before the db is closed.
418 $this->_accesslog->write_sql();
421 session_write_close();
422 if (!empty($this->_dbi)) {
423 $this->_dbi->close();
427 if (!empty($this->_is_buffering_output)) {
428 /* This cannot work because it might destroy xml markup */
430 if (0 and $GLOBALS['SearchHighLightQuery'] and check_php_version(4,2)) {
431 $html = str_replace($GLOBALS['SearchHighLightQuery'],
432 '<span class="search-term">'.$GLOBALS['SearchHighLightQuery'].'</span>',
435 header(sprintf("Content-Length: %d", strlen($html)));
439 if (empty($this->_do_chunked_output)) {
440 $this->_ob_get_length = ob_get_length();
442 header(sprintf("Content-Length: %d", $this->_ob_get_length));
444 while (@ob_end_flush());
445 $this->_is_buffering_output = false;
450 function getSessionVar($key) {
451 return $this->session->get($key);
453 function setSessionVar($key, $val) {
454 if ($key == 'wiki_user') {
455 if (empty($val->page))
456 $val->page = $this->getArg('pagename');
457 if (empty($val->action))
458 $val->action = $this->getArg('action');
459 // avoid recursive objects and session resource handles
460 // avoid overlarge session data (max 4000 byte!)
461 if (isset($val->_group)) {
462 unset($val->_group->_request);
463 unset($val->_group->_user);
465 if (ENABLE_USER_NEW) {
466 unset($val->_HomePagehandle);
467 unset($val->_auth_dbi);
470 unset($val->_authdbi);
471 unset($val->_homepage);
472 unset($val->_request);
475 return $this->session->set($key, $val);
477 function deleteSessionVar($key) {
478 return $this->session->delete($key);
481 function getCookieVar($key) {
482 return $this->cookies->get($key);
484 function setCookieVar($key, $val, $lifetime_in_days = false, $path = false) {
485 return $this->cookies->set($key, $val, $lifetime_in_days, $path);
487 function deleteCookieVar($key) {
488 return $this->cookies->delete($key);
491 function getUploadedFile($key) {
492 return Request_UploadedFile::getUploadedFile($key);
496 function _fix_magic_quotes_gpc() {
497 $needs_fix = array('HTTP_POST_VARS',
504 if (get_magic_quotes_gpc()) {
505 foreach ($needs_fix as $vars)
506 $this->_stripslashes($GLOBALS[$vars]);
510 function _stripslashes(&$var) {
511 if (is_array($var)) {
512 foreach ($var as $key => $val)
513 $this->_stripslashes($var[$key]);
515 elseif (is_string($var))
516 $var = stripslashes($var);
519 function _fix_multipart_form_data () {
520 if (preg_match('|^multipart/form-data|', $this->get('CONTENT_TYPE')))
521 $this->_strip_leading_nl($GLOBALS['HTTP_POST_VARS']);
524 function _strip_leading_nl(&$var) {
525 if (is_array($var)) {
526 foreach ($var as $key => $val)
527 $this->_strip_leading_nl($var[$key]);
529 elseif (is_string($var))
530 $var = preg_replace('|^\r?\n?|', '', $var);
534 class Request_SessionVars {
535 function Request_SessionVars() {
536 // Prevent cacheing problems with IE 5
537 session_cache_limiter('none');
539 // Avoid to get a notice if session is already started,
540 // for example if session.auto_start is activated
546 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
547 if (isset($vars[$key]))
552 function set($key, $val) {
553 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
554 if (!function_usable('get_cfg_var') or get_cfg_var('register_globals')) {
555 // This is funky but necessary, at least in some PHP's
556 $GLOBALS[$key] = $val;
559 if (isset($_SESSION))
560 $_SESSION[$key] = $val;
561 session_register($key);
564 function delete($key) {
565 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
566 if (!function_usable('ini_get') or ini_get('register_globals'))
567 unset($GLOBALS[$key]);
568 if (DEBUG) trigger_error("delete session $key",E_USER_WARNING);
570 session_unregister($key);
574 class Request_CookieVars {
577 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
578 if (isset($vars[$key])) {
579 @$val = unserialize(base64_decode($vars[$key]));
582 @$val = urldecode($vars[$key]);
589 function get_old($key) {
590 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
591 if (isset($vars[$key])) {
592 @$val = unserialize(base64_decode($vars[$key]));
595 @$val = unserialize($vars[$key]);
605 function set($key, $val, $persist_days = false, $path = false) {
606 // if already defined, ignore
607 if (defined('MAIN_setUser') and $key = 'WIKI_ID') return;
608 if (defined('WIKI_XMLRPC') and WIKI_XMLRPC) return;
610 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
611 if (is_numeric($persist_days)) {
612 $expires = time() + (24 * 3600) * $persist_days;
617 if (is_array($val) or is_object($val))
618 $packedval = base64_encode(serialize($val));
620 $packedval = urlencode($val);
621 $vars[$key] = $packedval;
623 @setcookie($key, $packedval, $expires, $path);
625 @setcookie($key, $packedval, $expires);
628 function delete($key) {
629 static $deleted = array();
630 if (isset($deleted[$key])) return;
631 if (defined('WIKI_XMLRPC') and WIKI_XMLRPC) return;
633 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
634 if (!defined('COOKIE_DOMAIN'))
635 @setcookie($key,'',0);
636 @setcookie($key,'',0,defined('COOKIE_DOMAIN') ? COOKIE_DOMAIN : '/');
638 unset($GLOBALS['HTTP_COOKIE_VARS'][$key]);
645 You must set "upload_tmp_dir" = "/tmp/" or "C:/tmp/"
646 Best on the same drive as apache, with forward slashes
647 and with ending slash!
648 Otherwise "\\" => "" and the uploaded file will not be found.
650 class Request_UploadedFile {
651 function getUploadedFile($postname) {
652 global $HTTP_POST_FILES;
654 if (!isset($HTTP_POST_FILES[$postname]))
657 $fileinfo = &$HTTP_POST_FILES[$postname];
658 if ($fileinfo['error']) {
659 // errmsgs by Shilad Sen
660 switch ($HTTP_POST_FILES['userfile']['error']) {
662 trigger_error(_("Upload error: file too big"), E_USER_ERROR);
665 trigger_error(_("Upload error: file too big"), E_USER_ERROR);
668 trigger_error(_("Upload error: file only partially recieved"), E_USER_ERROR);
671 trigger_error(_("Upload error: no file selected"), E_USER_ERROR);
674 trigger_error(_("Upload error: unknown error #") . $fileinfo['error'], E_USER_ERROR);
680 // With windows/php 4.2.1 is_uploaded_file() always returns false.
681 // Be sure that upload_tmp_dir ends with a slash!
682 if (!is_uploaded_file($fileinfo['tmp_name'])) {
684 if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
685 $tmp_file = dirname(tempnam('', ''));
687 $tmp_file .= '/' . basename($fileinfo['tmp_name']);
688 /* but ending slash in php.ini upload_tmp_dir is required. */
689 if (ereg_replace('/+', '/', $tmp_file) != $fileinfo['tmp_name']) {
690 trigger_error(sprintf("Uploaded tmpfile illegal: %s != %s.",$tmp_file, $fileinfo['tmp_name']).
692 "Probably illegal TEMP environment or upload_tmp_dir setting.",
697 trigger_error(sprintf("Workaround for PHP/Windows is_uploaded_file() problem for %s.",
698 $fileinfo['tmp_name'])."\n".
699 "Probably illegal TEMP environment or upload_tmp_dir setting.",
705 trigger_error(sprintf("Uploaded tmpfile %s not found.",$fileinfo['tmp_name'])."\n".
706 " Probably illegal TEMP environment or upload_tmp_dir setting.",
710 return new Request_UploadedFile($fileinfo);
713 function Request_UploadedFile($fileinfo) {
714 $this->_info = $fileinfo;
718 return $this->_info['size'];
722 return $this->_info['name'];
726 return $this->_info['type'];
729 function getTmpName() {
730 return $this->_info['tmp_name'];
734 if ( ($fd = fopen($this->_info['tmp_name'], "rb")) ) {
735 if ($this->getSize() < filesize($this->_info['tmp_name'])) {
736 // FIXME: Some PHP's (or is it some browsers?) put
737 // HTTP/MIME headers in the file body, some don't.
739 // At least, I think that's the case. I know I used
740 // to need this code, now I don't.
742 // This code is more-or-less untested currently.
744 // Dump HTTP headers.
745 while ( ($header = fgets($fd, 4096)) ) {
746 if (trim($header) == '') {
749 else if (!preg_match('/^content-(length|type):/i', $header)) {
759 function getContents() {
761 $data = fread($fd, $this->getSize());
768 * Create NCSA "combined" log entry for current request.
769 * Also needed for advanced spam prevention.
770 * global object holding global state (sql or file, entries, to dump)
772 class Request_AccessLog {
774 * @param $logfile string Log file name.
776 function Request_AccessLog ($logfile, $do_sql = false) {
777 //global $request; // request not yet initialized!
779 $this->logfile = $logfile;
780 if ($logfile and !is_writeable($logfile)) {
782 (sprintf(_("%s is not writable."), _("The PhpWiki access log file"))
784 . sprintf(_("Please ensure that %s is writable, or redefine %s in config/config.ini."),
785 sprintf(_("the file '%s'"), ACCESS_LOG),
789 //$request->_accesslog =& $this;
790 //if (empty($request->_accesslog->entries))
791 register_shutdown_function("Request_AccessLogEntry_shutdown_function");
795 if (!in_array($DBParams['dbtype'], array('SQL','ADODB'))) {
796 trigger_error("Unsupported database backend for ACCESS_LOG_SQL.\nNeed DATABASE_TYPE=SQL or ADODB");
798 //$this->_dbi =& $request->_dbi;
799 $this->logtable = (!empty($DBParams['prefix']) ? $DBParams['prefix'] : '')."accesslog";
802 $this->entries = array();
803 $this->entries[] = & new Request_AccessLogEntry($this);
806 function _do($cmd, &$arg) {
808 for ($i=0; $i < count($this->entries);$i++)
809 $this->entries[$i]->$cmd($arg);
811 function push(&$request) { $this->_do('push',$request); }
812 function setSize($arg) { $this->_do('setSize',$arg); }
813 function setStatus($arg) { $this->_do('setStatus',$arg); }
814 function setDuration($arg) { $this->_do('setDuration',$arg); }
817 * Read sequentially all previous entries from the beginning.
818 * while ($logentry = Request_AccessLogEntry::read()) ;
819 * For internal log analyzers: RecentReferrers, WikiAccessRestrictions
822 return $this->logtable ? $this->read_sql() : $this->read_file();
826 * Return iterator of referer items reverse sorted (latest first).
828 function get_referer($limit=15, $external_only=false) {
829 if ($external_only) { // see stdlin.php:isExternalReferrer()
831 $blen = strlen($base);
833 if (!empty($this->_dbi)) {
834 // check same hosts in referer and request and remove them
835 $ext_where = " AND LEFT(referer,$blen) <> ".$this->_dbi->quote($base)
836 ." AND LEFT(referer,$blen) <> LEFT(CONCAT(".$this->_dbi->quote(SERVER_URL).",request_uri),$blen)";
837 return $this->_read_sql_query("(referer <>'' AND NOT(ISNULL(referer)))"
838 .($external_only ? $ext_where : '')
839 ." ORDER BY time_stamp DESC"
840 .($limit ? " LIMIT $limit" : ""));
842 $iter = new WikiDB_Array_generic_iter(0);
843 $logs =& $iter->_array;
844 while ($logentry = $this->read_file()) {
845 if (!empty($logentry->referer)
846 and (!$external_only or (substr($logentry->referer,0,$blen) != $base)))
848 $iter->_array[] = $logentry;
849 if ($limit and count($logs) > $limit)
853 $logs = array_reverse($logs);
854 $logs = array_slice($logs,0,min($limit,count($logs)));
860 * Return iterator of matching host items reverse sorted (latest first).
862 function get_host($host, $since_minutes=20) {
863 if ($this->logtable) {
864 // mysql specific only:
865 return $this->read_sql("request_host=".$this->_dbi->quote($host)." AND time_stamp > ". (time()-$since_minutes*60)
866 ." ORDER BY time_stamp DESC");
868 $iter = new WikiDB_Array_generic_iter();
869 $logs =& $iter->_array;
870 $logentry = new Request_AccessLogEntry($this);
871 while ($logentry->read_file()) {
872 if (!empty($logentry->referer)) {
873 $iter->_array[] = $logentry;
874 if ($limit and count($logs) > $limit)
876 $logentry = new Request_AccessLogEntry($this);
879 $logs = array_reverse($logs);
880 $logs = array_slice($logs,0,min($limit,count($logs)));
886 * Read sequentially all previous entries from log file.
888 function read_file() {
890 if ($this->logfile) $this->logfile = ACCESS_LOG; // support Request_AccessLog::read
892 if (empty($this->reader)) // start at the beginning
893 $this->reader = fopen($this->logfile, "r");
894 if ($s = fgets($this->reader)) {
895 $entry = new Request_AccessLogEntry($this);
896 if (preg_match('/^(\S+)\s(\S+)\s(\S+)\s\[(.+?)\] "([^"]+)" (\d+) (\d+) "([^"]*)" "([^"]*)"$/',$s,$m)) {
897 list(,$entry->host, $entry->ident, $entry->user, $entry->time,
898 $entry->request, $entry->status, $entry->size,
899 $entry->referer, $entry->user_agent) = $m;
902 } else { // until the end
903 fclose($this->reader);
907 function _read_sql_query($where='') {
908 $dbh =& $GLOBALS['request']->_dbi;
909 $log_tbl =& $this->logtable;
910 return $dbh->genericSqlIter("SELECT *,request_uri as request,request_time as time,remote_user as user,"
911 ."remote_host as host,agent as user_agent"
913 . ($where ? " WHERE $where" : ""));
915 function read_sql($where='') {
916 if (empty($this->sqliter))
917 $this->sqliter = $this->_read_sql_query($where);
918 return $this->sqliter->next();
921 /* done in request->finish() before the db is closed */
922 function write_sql() {
923 $dbh =& $GLOBALS['request']->_dbi;
924 if (isset($this->entries) and $dbh and $dbh->isOpen())
925 foreach ($this->entries as $entry) {
929 /* done in the shutdown callback */
930 function write_file() {
931 if (isset($this->entries) and $this->logfile)
932 foreach ($this->entries as $entry) {
933 $entry->write_file();
935 unset($this->entries);
937 /* in an ideal world... */
939 if ($this->logfile) $this->write_file();
940 if ($this->logtable) $this->write_sql();
941 unset($this->entries);
945 class Request_AccessLogEntry
950 * The log entry will be automatically appended to the log file or
951 * SQL table when the current request terminates.
953 * If you want to modify a Request_AccessLogEntry before it gets
954 * written (e.g. via the setStatus and setSize methods) you should
955 * use an '&' on the constructor, so that you're working with the
956 * original (rather than a copy) object.
959 * $log_entry = & new Request_AccessLogEntry("/tmp/wiki_access_log");
960 * $log_entry->setStatus(401);
961 * $log_entry->push($request);
966 function Request_AccessLogEntry (&$accesslog) {
967 $this->_accesslog = $accesslog;
968 $this->logfile = $accesslog->logfile;
969 $this->time = time();
970 $this->status = 200; // see setStatus()
971 $this->size = 0; // see setSize()
975 * @param $request object Request object for current request.
977 function push(&$request) {
978 $this->host = $request->get('REMOTE_HOST');
979 $this->ident = $request->get('REMOTE_IDENT');
982 $user = $request->getUser();
983 if ($user->isAuthenticated())
984 $this->user = $user->UserName();
987 $this->request = join(' ', array($request->get('REQUEST_METHOD'),
988 $request->get('REQUEST_URI'),
989 $request->get('SERVER_PROTOCOL')));
990 $this->referer = (string) $request->get('HTTP_REFERER');
991 $this->user_agent = (string) $request->get('HTTP_USER_AGENT');
995 * Set result status code.
997 * @param $status integer HTTP status code.
999 function setStatus ($status) {
1000 $this->status = $status;
1004 * Set response size.
1006 * @param $size integer
1008 function setSize ($size=0) {
1009 $this->size = $size;
1011 function setDuration ($seconds) {
1012 $this->duration = $seconds;
1016 * Get time zone offset.
1018 * This is a static member function.
1020 * @param $time integer Unix timestamp (defaults to current time).
1021 * @return string Zone offset, e.g. "-0800" for PST.
1023 function _zone_offset ($time = false) {
1026 $offset = date("Z", $time);
1032 $offhours = floor($offset / 3600);
1033 $offmins = $offset / 60 - $offhours * 60;
1034 return sprintf("%s%02d%02d", $negoffset, $offhours, $offmins);
1038 * Format time in NCSA format.
1040 * This is a static member function.
1042 * @param $time integer Unix timestamp (defaults to current time).
1043 * @return string Formatted date & time.
1045 function _ncsa_time($time = false) {
1048 return date("d/M/Y:H:i:s", $time) .
1049 " " . $this->_zone_offset();
1053 if ($this->_accesslog->logfile) $this->write_file();
1054 if ($this->_accesslog->logtable) $this->write_sql();
1058 * Write entry to log file.
1060 function write_file() {
1061 $entry = sprintf('%s %s %s [%s] "%s" %d %d "%s" "%s"',
1062 $this->host, $this->ident, $this->user,
1063 $this->_ncsa_time($this->time),
1064 $this->request, $this->status, $this->size,
1065 $this->referer, $this->user_agent);
1066 if (!empty($this->_accesslog->reader)) {
1067 fclose($this->_accesslog->reader);
1068 unset($this->_accesslog->reader);
1070 //Error log doesn't provide locking.
1071 //error_log("$entry\n", 3, $this->logfile);
1073 if (($fp = fopen($this->logfile, "a"))) {
1074 flock($fp, LOCK_EX);
1075 fputs($fp, "$entry\n");
1080 /* This is better been done by apache mod_log_sql */
1081 /* If ACCESS_LOG_SQL & 2 we do write it by our own */
1082 function write_sql() {
1083 $dbh =& $GLOBALS['request']->_dbi;
1084 if ($dbh and $dbh->isOpen() and $this->_accesslog->logtable) {
1085 $log_tbl =& $this->_accesslog->logtable;
1086 if ($GLOBALS['request']->get('REQUEST_METHOD') == "POST") {
1087 if (check_php_version(4,2))
1088 // strangely HTTP_POST_VARS doesn't contain all posted vars.
1089 $this->request_args = substr(serialize($_POST),0,254); // if VARCHAR(255) is used.
1091 $this->request_args = substr(serialize($GLOBALS['HTTP_POST_VARS']),0,254);
1093 $this->request_args = $GLOBALS['request']->get('QUERY_STRING');
1095 $dbh->genericSqlQuery
1097 sprintf("INSERT DELAYED INTO $log_tbl"
1098 . " (time_stamp,remote_host,remote_user,request_method,request_line,request_uri,"
1099 . "request_args,request_time,status,bytes_sent,referer,agent,request_duration)"
1100 . " VALUES(%d,%s,%s,%s,%s,%s,%s,%s,%d,%d,%s,%s,%f)",
1102 $dbh->quote($this->host), $dbh->quote($this->user),
1103 $dbh->quote($GLOBALS['request']->get('REQUEST_METHOD')), $dbh->quote($this->request),
1104 $dbh->quote($GLOBALS['request']->get('REQUEST_URI')), $dbh->quote($this->request_args),
1105 $dbh->quote($this->_ncsa_time($this->time)), $this->status, $this->size,
1106 $dbh->quote($this->referer),
1107 $dbh->quote($this->user_agent),
1115 * Shutdown callback.
1118 * @see Request_AccessLogEntry
1120 function Request_AccessLogEntry_shutdown_function () {
1123 if (isset($request->_accesslog->entries) and $request->_accesslog->logfile)
1124 foreach ($request->_accesslog->entries as $entry) {
1125 $entry->write_file();
1127 unset($request->_accesslog->entries);
1132 function HTTP_ETag($val, $is_weak=false) {
1133 $this->_val = hash($val);
1134 $this->_weak = $is_weak;
1139 * Strong comparison: If either (or both) tag is weak, they
1142 function equals($that, $strong_match=false) {
1143 if ($this->_val != $that->_val)
1145 if ($strong_match and ($this->_weak or $that->_weak))
1151 function asString() {
1152 $quoted = '"' . addslashes($this->_val) . '"';
1153 return $this->_weak ? "W/$quoted" : $quoted;
1156 /** Parse tag from header.
1158 * This is a static member function.
1160 function parse($strval) {
1161 if (!preg_match(':^(W/)?"(.+)"$:i', trim($strval), $m))
1162 return false; // parse failed
1163 list(,$weak,$str) = $m;
1164 return new HTTP_ETag(stripslashes($str), $weak);
1167 function matches($taglist, $strong_match=false) {
1168 $taglist = trim($taglist);
1170 if ($taglist == '*') {
1172 return ! $this->_weak;
1177 while (preg_match('@^(W/)?"((?:\\\\.|[^"])*)"\s*,?\s*@i',
1179 list($match, $weak, $str) = $m;
1180 $taglist = substr($taglist, strlen($match));
1181 $tag = new HTTP_ETag(stripslashes($str), $weak);
1182 if ($this->equals($tag, $strong_match)) {
1190 // Possible results from the HTTP_ValidatorSet::_check*() methods.
1191 // (Higher numerical values take precedence.)
1192 define ('_HTTP_VAL_PASS', 0); // Test is irrelevant
1193 define ('_HTTP_VAL_NOT_MODIFIED', 1); // Test passed, content not changed
1194 define ('_HTTP_VAL_MODIFIED', 2); // Test failed, content changed
1195 define ('_HTTP_VAL_FAILED', 3); // Precondition failed.
1197 class HTTP_ValidatorSet {
1198 function HTTP_ValidatorSet($validators) {
1199 $this->_mtime = $this->_weak = false;
1200 $this->_tag = array();
1202 foreach ($validators as $key => $val) {
1203 if ($key == '%mtime') {
1204 $this->_mtime = $val;
1206 elseif ($key == '%weak') {
1208 $this->_weak = true;
1211 $this->_tag[$key] = $val;
1216 function append($that) {
1217 if (is_array($that))
1218 $that = new HTTP_ValidatorSet($that);
1220 // Pick the most recent mtime
1221 if (isset($that->_mtime))
1222 if (!isset($this->_mtime) || $that->_mtime > $this->_mtime)
1223 $this->_mtime = $that->_mtime;
1225 // If either is weak, we're weak
1226 if (!empty($that->_weak))
1227 $this->_weak = true;
1228 if (is_array($this->_tag))
1229 $this->_tag = array_merge($this->_tag, $that->_tag);
1231 $this->_tag = $that->_tag;
1234 function getETag() {
1237 return new HTTP_ETag($this->_tag, $this->_weak);
1240 function getModificationTime() {
1241 return $this->_mtime;
1244 function checkConditionalRequest (&$request) {
1245 $result = max($this->_checkIfUnmodifiedSince($request),
1246 $this->_checkIfModifiedSince($request),
1247 $this->_checkIfMatch($request),
1248 $this->_checkIfNoneMatch($request));
1250 if ($result == _HTTP_VAL_PASS || $result == _HTTP_VAL_MODIFIED)
1251 return false; // "please proceed with normal processing"
1252 elseif ($result == _HTTP_VAL_FAILED)
1253 return 412; // "412 Precondition Failed"
1254 elseif ($result == _HTTP_VAL_NOT_MODIFIED)
1255 return 304; // "304 Not Modified"
1257 trigger_error("Ack, shouldn't get here", E_USER_ERROR);
1261 function _checkIfUnmodifiedSince(&$request) {
1262 if ($this->_mtime !== false) {
1263 $since = ParseRfc1123DateTime($request->get("HTTP_IF_UNMODIFIED_SINCE"));
1264 if ($since !== false && $this->_mtime > $since)
1265 return _HTTP_VAL_FAILED;
1267 return _HTTP_VAL_PASS;
1270 function _checkIfModifiedSince(&$request) {
1271 if ($this->_mtime !== false and $request->isGetOrHead()) {
1272 $since = ParseRfc1123DateTime($request->get("HTTP_IF_MODIFIED_SINCE"));
1273 if ($since !== false) {
1274 if ($this->_mtime <= $since)
1275 return _HTTP_VAL_NOT_MODIFIED;
1276 return _HTTP_VAL_MODIFIED;
1279 return _HTTP_VAL_PASS;
1282 function _checkIfMatch(&$request) {
1283 if ($this->_tag && ($taglist = $request->get("HTTP_IF_MATCH"))) {
1284 $tag = $this->getETag();
1285 if (!$tag->matches($taglist, 'strong'))
1286 return _HTTP_VAL_FAILED;
1288 return _HTTP_VAL_PASS;
1291 function _checkIfNoneMatch(&$request) {
1292 if ($this->_tag && ($taglist = $request->get("HTTP_IF_NONE_MATCH"))) {
1293 $tag = $this->getETag();
1294 $strong_compare = ! $request->isGetOrHead();
1296 if ($tag->matches($taglist, $strong_compare)) {
1297 if ($request->isGetOrHead())
1298 return _HTTP_VAL_NOT_MODIFIED;
1300 return _HTTP_VAL_FAILED;
1302 return _HTTP_VAL_MODIFIED;
1305 return _HTTP_VAL_PASS;
1310 // $Log: not supported by cvs2svn $
1311 // Revision 1.82 2004/12/06 19:49:55 rurban
1312 // enable action=remove which is undoable and seeable in RecentChanges: ADODB ony for now.
1313 // renamed delete_page to purge_page.
1314 // enable action=edit&version=-1 to force creation of a new version.
1315 // added BABYCART_PATH config
1316 // fixed magiqc in adodb.inc.php
1317 // and some more docs
1319 // Revision 1.81 2004/11/27 14:39:04 rurban
1320 // simpified regex search architecture:
1321 // no db specific node methods anymore,
1322 // new sql() method for each node
1323 // parallel to regexp() (which returns pcre)
1324 // regex types bitmasked (op's not yet)
1326 // clarified WikiDB::quote() backend methods:
1327 // ->quote() adds surrounsing quotes
1328 // ->qstr() (new method) assumes strings and adds no quotes! (in contrast to ADODB)
1329 // pear and adodb have now unified quote methods for all generic queries.
1331 // Revision 1.80 2004/11/21 11:59:16 rurban
1332 // remove final \n to be ob_cache independent
1334 // Revision 1.79 2004/11/11 18:29:44 rurban
1335 // (write_sql) isOpen really is useless in non-SQL, do more explicit check
1337 // Revision 1.78 2004/11/10 15:29:20 rurban
1338 // * requires newer Pear_DB (as the internal one): quote() uses now escapeSimple for strings
1339 // * ACCESS_LOG_SQL: fix cause request not yet initialized
1340 // * WikiDB: moved SQL specific methods upwards
1341 // * new Pear_DB quoting: same as ADODB and as newer Pear_DB.
1342 // fixes all around: WikiGroup, WikiUserNew SQL methods, SQL logging
1344 // Revision 1.77 2004/11/09 17:11:04 rurban
1345 // * revert to the wikidb ref passing. there's no memory abuse there.
1346 // * use new wikidb->_cache->_id_cache[] instead of wikidb->_iwpcache, to effectively
1347 // store page ids with getPageLinks (GleanDescription) of all existing pages, which
1348 // are also needed at the rendering for linkExistingWikiWord().
1349 // pass options to pageiterator.
1350 // use this cache also for _get_pageid()
1351 // This saves about 8 SELECT count per page (num all pagelinks).
1352 // * fix passing of all page fields to the pageiterator.
1353 // * fix overlarge session data which got broken with the latest ACCESS_LOG_SQL changes
1355 // Revision 1.76 2004/11/09 08:15:18 rurban
1356 // fix ADODB quoting style
1358 // Revision 1.75 2004/11/07 18:34:28 rurban
1359 // more logging fixes
1361 // Revision 1.74 2004/11/07 16:02:51 rurban
1362 // new sql access log (for spam prevention), and restructured access log class
1363 // dbh->quote (generic)
1364 // pear_db: mysql specific parts seperated (using replace)
1366 // Revision 1.73 2004/11/06 04:51:25 rurban
1367 // readable ACCESS_LOG support: RecentReferrers, WikiAccessRestrictions
1369 // Revision 1.72 2004/11/01 10:43:55 rurban
1370 // seperate PassUser methods into seperate dir (memory usage)
1371 // fix WikiUser (old) overlarge data session
1372 // remove wikidb arg from various page class methods, use global ->_dbi instead
1375 // Revision 1.71 2004/10/22 09:20:36 rurban
1376 // fix for USECACHE=false
1378 // Revision 1.70 2004/10/21 19:59:18 rurban
1379 // Patch #991494 (ppo): Avoid notice in PHP >= 4.3.3 if session already started
1381 // Revision 1.69 2004/10/21 19:00:37 rurban
1382 // upload errmsgs by Shilad Sen.
1383 // chunkOutput support: flush the buffer piecewise (dumphtml, large pagelists)
1384 // doesn't gain much because ob_end_clean() doesn't release its
1385 // memory properly yet.
1387 // Revision 1.68 2004/10/12 13:13:19 rurban
1388 // php5 compatibility (5.0.1 ok)
1390 // Revision 1.67 2004/09/25 18:56:54 rurban
1391 // make start_debug logic work
1393 // Revision 1.66 2004/09/25 16:24:52 rurban
1394 // dont compress on debugging
1396 // Revision 1.65 2004/09/17 14:13:49 rurban
1397 // We check for the client Accept-Encoding: "gzip" presence also
1398 // This should eliminate a lot or reported problems.
1400 // Note that this doesn#t fix RSS ssues:
1401 // Most RSS clients are NOT(!) application/xml gzip compatible yet.
1402 // Even if they are sending the accept-encoding gzip header!
1403 // wget is, Mozilla, and MSIE no.
1404 // Of the RSS readers only MagpieRSS 0.5.2 is. http://www.rssgov.com/rssparsers.html
1406 // Revision 1.64 2004/09/17 13:32:36 rurban
1407 // Disable server-side gzip encoding for RSS (RDF encoding), even if the client says it
1408 // supports it. Mozilla has this error, wget works fine. IE not checked.
1410 // Revision 1.63 2004/07/01 09:29:40 rurban
1411 // fixed another DbSession crash: wrong WikiGroup vars
1413 // Revision 1.62 2004/06/27 10:26:02 rurban
1414 // oci8 patch by Philippe Vanhaesendonck + some ADODB notes+fixes
1416 // Revision 1.61 2004/06/25 14:29:17 rurban
1417 // WikiGroup refactoring:
1418 // global group attached to user, code for not_current user.
1419 // improved helpers for special groups (avoid double invocations)
1420 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
1421 // fixed a XHTML validation error on userprefs.tmpl
1423 // Revision 1.60 2004/06/19 11:51:13 rurban
1424 // CACHE_CONTROL: NONE => NO_CACHE
1426 // Revision 1.59 2004/06/13 11:34:22 rurban
1427 // fixed bug #969532 (space in uploaded filenames)
1428 // improved upload error messages
1430 // Revision 1.58 2004/06/04 20:32:53 rurban
1431 // Several locale related improvements suggested by Pierrick Meignen
1432 // LDAP fix by John Cole
1433 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
1435 // Revision 1.57 2004/06/03 18:54:25 rurban
1436 // fixed "lost level in session" warning, now that signout sets level = 0 (before -1)
1438 // Revision 1.56 2004/05/17 17:43:29 rurban
1439 // CGI: no PATH_INFO fix
1441 // Revision 1.55 2004/05/15 18:31:00 rurban
1442 // some action=pdf Request fixes: With MSIE it works now. Now the work with the page formatting begins.
1444 // Revision 1.54 2004/05/04 22:34:25 rurban
1447 // Revision 1.53 2004/05/03 21:57:47 rurban
1448 // locale updates: we previously lost some words because of wrong strings in
1449 // PhotoAlbum, german rewording.
1450 // fixed $_SESSION registering (lost session vars, esp. prefs)
1451 // fixed ending slash in listAvailableLanguages/Themes
1453 // Revision 1.52 2004/05/03 13:16:47 rurban
1454 // fixed UserPreferences update, esp for boolean and int
1456 // Revision 1.51 2004/05/02 21:26:38 rurban
1457 // limit user session data (HomePageHandle and auth_dbi have to invalidated anyway)
1458 // because they will not survive db sessions, if too large.
1459 // extended action=upgrade
1460 // some WikiTranslation button work
1461 // revert WIKIAUTH_UNOBTAINABLE (need it for main.php)
1462 // some temp. session debug statements
1464 // Revision 1.50 2004/04/29 19:39:44 rurban
1465 // special support for formatted plugins (one-liners)
1466 // like <small><plugin BlaBla ></small>
1467 // iter->asArray() helper for PopularNearby
1468 // db_session for older php's (no &func() allowed)
1470 // Revision 1.49 2004/04/26 20:44:34 rurban
1471 // locking table specific for better databases
1473 // Revision 1.48 2004/04/13 09:13:50 rurban
1474 // sf.net bug #933183 and http://bugs.php.net/17557
1475 // disable ob_gzhandler if apache_note cannot be used.
1476 // (conservative until we find why)
1478 // Revision 1.47 2004/04/02 15:06:55 rurban
1479 // fixed a nasty ADODB_mysql session update bug
1480 // improved UserPreferences layout (tabled hints)
1481 // fixed UserPreferences auth handling
1482 // improved auth stability
1483 // improved old cookie handling: fixed deletion of old cookies with paths
1485 // Revision 1.46 2004/03/30 02:14:03 rurban
1486 // fixed yet another Prefs bug
1487 // added generic PearDb_iter
1488 // $request->appendValidators no so strict as before
1489 // added some box plugin methods
1490 // PageList commalist for condensed output
1492 // Revision 1.45 2004/03/24 19:39:02 rurban
1493 // php5 workaround code (plus some interim debugging code in XmlElement)
1494 // php5 doesn't work yet with the current XmlElement class constructors,
1495 // WikiUserNew does work better than php4.
1496 // rewrote WikiUserNew user upgrading to ease php5 update
1497 // fixed pref handling in WikiUserNew
1498 // added Email Notification
1499 // added simple Email verification
1500 // removed emailVerify userpref subclass: just a email property
1501 // changed pref binary storage layout: numarray => hash of non default values
1502 // print optimize message only if really done.
1503 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
1504 // prefs should be stored in db or homepage, besides the current session.
1506 // Revision 1.44 2004/03/14 16:26:22 rurban
1509 // Revision 1.43 2004/03/12 20:59:17 rurban
1510 // important cookie fix by Konstantin Zadorozhny
1511 // new editpage feature: JS_SEARCHREPLACE
1513 // Revision 1.42 2004/03/10 15:38:48 rurban
1514 // store current user->page and ->action in session for WhoIsOnline
1515 // better WhoIsOnline icon
1516 // fixed WhoIsOnline warnings
1518 // Revision 1.41 2004/02/27 01:25:14 rurban
1519 // Workarounds for upload handling
1521 // Revision 1.40 2004/02/26 01:39:51 rurban
1524 // Revision 1.39 2004/02/24 15:14:57 rurban
1525 // fixed action=upload problems on Win32, and remove Merge Edit buttons: file does not exist anymore
1527 // Revision 1.38 2004/01/25 10:26:02 rurban
1528 // fixed bug [ 541193 ] HTTP_SERVER_VARS are Apache specific
1529 // http://sourceforge.net/tracker/index.php?func=detail&aid=541193&group_id=6121&atid=106121
1530 // CGI and other servers than apache populate _ENV and not _SERVER
1532 // Revision 1.37 2003/12/26 06:41:16 carstenklapp
1533 // Bugfix: Try to defer OS errors about session.save_path and ACCESS_LOG,
1534 // so they don't prevent IE from partially (or not at all) rendering the
1535 // page. This should help a little for the IE user who encounters trouble
1536 // when setting up a new PhpWiki for the first time.
1542 // c-basic-offset: 4
1543 // c-hanging-comment-ender-p: nil
1544 // indent-tabs-mode: nil