4 * Copyright (C) 2002,2004,2005,2006,2009 $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 along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 $this->_fix_magic_quotes_gpc();
29 $this->_fix_multipart_form_data();
31 switch ($this->get('REQUEST_METHOD')) {
34 $this->args = &$GLOBALS['HTTP_GET_VARS'];
37 $this->args = &$GLOBALS['HTTP_POST_VARS'];
40 $this->args = array();
44 $this->session = new Request_SessionVars;
45 $this->cookies = new Request_CookieVars;
47 if (ACCESS_LOG or ACCESS_LOG_SQL) {
48 $this->_accesslog = new Request_AccessLog(ACCESS_LOG, ACCESS_LOG_SQL);
51 $GLOBALS['request'] = $this;
56 if (!empty($GLOBALS['HTTP_SERVER_VARS']))
57 $vars = &$GLOBALS['HTTP_SERVER_VARS'];
58 elseif (!empty($GLOBALS['HTTP_ENV_VARS']))
59 $vars = &$GLOBALS['HTTP_ENV_VARS']; // cgi or other servers than Apache
61 trigger_error("Serious php configuration error!"
62 . " No HTTP_SERVER_VARS and HTTP_ENV_VARS vars available."
63 . " These should get defined in lib/prepend.php",
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);
83 if (isset($this->args[$key]))
84 return $this->args[$key];
93 function setArg($key, $val)
96 unset($this->args[$key]);
98 $this->args[$key] = $val;
101 // Well oh well. Do we really want to pass POST params back as GET?
102 function getURLtoSelf($args = false, $exclude = array())
104 $get_args = $this->args;
106 $get_args = array_merge($get_args, $args);
108 // leave out empty arg values
109 foreach ($get_args as $g => $v) {
110 if ($v === false or $v === '') unset($get_args[$g]);
113 // Err... good point...
115 if ($this->isPost()) {
116 $exclude = array_merge($exclude, array('action', 'auth'));
117 //$get_args = $args; // or only the provided
119 trigger_error("Request::getURLtoSelf() should probably not be from POST",
124 foreach ($exclude as $ex) {
125 if (!empty($get_args[$ex])) unset($get_args[$ex]);
128 $pagename = $get_args['pagename'];
129 unset ($get_args['pagename']);
130 if (!empty($get_args['action']) and $get_args['action'] == 'browse')
131 unset($get_args['action']);
133 return WikiURL($pagename, $get_args);
138 return $this->get("REQUEST_METHOD") == "POST";
141 function isGetOrHead()
143 return in_array($this->get('REQUEST_METHOD'),
144 array('GET', 'HEAD'));
147 function httpVersion()
149 if (!preg_match('@HTTP\s*/\s*(\d+.\d+)@', $this->get('SERVER_PROTOCOL'), $m))
154 /* Redirects after edit may fail if no theme signature image is defined.
155 * Set DISABLE_HTTP_REDIRECT = true then.
157 function redirect($url, $noreturn = true)
159 $bogus = defined('DISABLE_HTTP_REDIRECT') && DISABLE_HTTP_REDIRECT;
162 header("Location: $url");
164 * "302 Found" is not really meant to be sent in response
165 * to a POST. Worse still, according to (both HTTP 1.0
166 * and 1.1) spec, the user, if it is sent, the user agent
167 * is supposed to use the same method to fetch the
168 * redirected URI as the original.
170 * That means if we redirect from a POST, the user-agent
171 * supposed to generate another POST. Not what we want.
172 * (We do this after a page save after all.)
174 * Fortunately, most/all browsers don't do that.
176 * "303 See Other" is what we really want. But it only
179 * FIXME: this is still not spec compliant for HTTP
182 $status = $this->httpVersion() >= 1.1 ? 303 : 302;
183 $this->setStatus($status);
187 $this->discardOutput(); // This might print the gzip headers. Not good.
188 $this->buffer_output(false);
190 include_once 'lib/Template.php';
191 $tmpl = new Template('redirect', $this, array('REDIRECT_URL' => $url));
195 // Safari needs window.location.href = targeturl
197 function redirect(url) {
198 if (typeof location.replace == 'function')
199 location.replace(url);
200 else if (typeof location.assign == 'function')
201 location.assign(url);
202 else if (self.location.href)
203 self.location.href = url;
205 window.location = url;
207 redirect('" . addslashes($url) . "')");
211 /** Set validators for this response.
213 * This sets a (possibly incomplete) set of validators
216 * The validator set can be extended using appendValidators().
218 * When you're all done setting and appending validators, you
219 * must call checkValidators() to check them and set the
220 * appropriate headers in the HTTP response.
224 * $request->setValidators(array('pagename' => $pagename,
225 * '%mtime' => $rev->get('mtime')));
227 * // Wups... response content depends on $otherpage, too...
228 * $request->appendValidators(array('otherpage' => $otherpagerev->getPageName(),
229 * '%mtime' => $otherpagerev->get('mtime')));
231 * // After all validators have been set:
232 * $request->checkValidators();
234 function setValidators($validator_set)
236 if (is_array($validator_set))
237 $validator_set = new HTTP_ValidatorSet($validator_set);
238 $this->_validators = $validator_set;
241 /** Append more validators for this response.
242 * i.e dependencies on other pages mtimes
243 * now it may be called in init also to simplify client code.
245 function appendValidators($validator_set)
247 if (!isset($this->_validators)) {
248 $this->setValidators($validator_set);
251 $this->_validators->append($validator_set);
254 /** Check validators and set headers in HTTP response
256 * This sets the appropriate "Last-Modified" and "ETag"
257 * headers in the HTTP response.
259 * Additionally, if the validators match any(all) conditional
260 * headers in the HTTP request, this method will not return, but
261 * instead will send "304 Not Modified" or "412 Precondition
262 * Failed" (as appropriate) back to the client.
264 function checkValidators()
266 $validators = &$this->_validators;
268 // Set validator headers
269 if (!empty($this->_is_buffering_output) or !headers_sent()) {
270 if (($etag = $validators->getETag()) !== false)
271 header("ETag: " . $etag->asString());
272 if (($mtime = $validators->getModificationTime()) !== false)
273 header("Last-Modified: " . Rfc1123DateTime($mtime));
275 // Set cache control headers
276 $this->cacheControl();
279 if (CACHE_CONTROL == 'NO_CACHE')
280 return; // don't check conditionals...
282 // Check conditional headers in request
283 $status = $validators->checkConditionalRequest($this);
285 // Return short response due to failed conditionals
286 $this->setStatus($status);
288 $this->discardOutput();
294 /** Set the cache control headers in the HTTP response.
296 function cacheControl($strategy = CACHE_CONTROL, $max_age = CACHE_CONTROL_MAX_AGE)
298 if ($strategy == 'NO_CACHE') {
299 $cache_control = "no-cache"; // better set private. See Pear HTTP_Header
301 } elseif ($strategy == 'ALLOW_STALE' && $max_age > 0) {
302 $cache_control = sprintf("max-age=%d", $max_age);
304 $cache_control = "must-revalidate";
307 header("Cache-Control: $cache_control");
308 header("Expires: " . Rfc1123DateTime(time() + $max_age));
309 header("Vary: Cookie"); // FIXME: add more here?
312 function setStatus($status)
314 if (preg_match('|^HTTP/.*?\s(\d+)|i', $status, $m)) {
318 $status = (integer)$status;
319 $reason = array('200' => 'OK',
321 '303' => 'See Other',
322 '304' => 'Not Modified',
323 '400' => 'Bad Request',
324 '401' => 'Unauthorized',
325 '403' => 'Forbidden',
326 '404' => 'Not Found',
327 '412' => 'Precondition Failed');
328 // FIXME: is it always okay to send HTTP/1.1 here, even for older clients?
329 header(sprintf("HTTP/1.1 %d %s", $status, $reason[$status]));
332 if (isset($this->_log_entry))
333 $this->_log_entry->setStatus($status);
336 function buffer_output($compress = true)
338 // FIXME: disables sessions (some byte before all headers_sent())
339 /*if (defined('USECACHE') and !USECACHE) {
340 $this->_is_buffering_output = false;
343 if (defined('COMPRESS_OUTPUT')) {
344 if (!COMPRESS_OUTPUT)
346 } elseif (isCGI()) // necessary?
349 if ($this->getArg('start_debug')) $compress = false;
350 if ($this->getArg('nocache'))
353 // Should we compress even when apache_note is not available?
354 // sf.net bug #933183 and http://bugs.php.net/17557
355 // This effectively eliminates CGI, but all other servers also. hmm.
357 and (!function_exists('ob_gzhandler')
358 or !function_exists('apache_note'))
362 // "output handler 'ob_gzhandler' cannot be used twice"
363 // http://www.php.net/ob_gzhandler
364 if ($compress and ini_get("zlib.output_compression"))
367 // New: we check for the client Accept-Encoding: "gzip" presence also
368 // This should eliminate a lot or reported problems.
370 and (!$this->get("HTTP_ACCEPT_ENCODING")
371 or !strstr($this->get("HTTP_ACCEPT_ENCODING"), "gzip"))
375 // Most RSS clients are NOT(!) application/xml gzip compatible yet.
376 // Even if they are sending the accept-encoding gzip header!
377 // wget is, Mozilla, and MSIE no.
378 // Of the RSS readers only MagpieRSS 0.5.2 is. http://www.rssgov.com/rssparsers.html
379 // See also http://phpwiki.sourceforge.net/phpwiki/KnownBugs
381 and $this->getArg('format')
382 and strstr($this->getArg('format'), 'rss')
387 ob_start('phpwiki_gzhandler');
389 // TODO: dont send a length or get the gzip'ed data length.
390 $this->_is_compressing_output = true;
391 header("Content-Encoding: gzip");
393 * Attempt to prevent Apache from doing the dreaded double-gzip.
395 * It would be better if we could detect when apache was going
396 * to zip for us, and then let it ... but I have yet to figure
397 * out how to do that.
399 if (function_exists('apache_note'))
400 @apache_note('no-gzip', 1);
402 // Now we alway buffer output.
403 // This is so we can set HTTP headers (e.g. for redirect)
405 // FIXME: change the name of this method.
407 $this->_is_compressing_output = false;
409 $this->_is_buffering_output = true;
410 $this->_ob_get_length = 0;
413 function discardOutput()
415 if (!empty($this->_is_buffering_output)) {
416 if (ob_get_length()) ob_clean();
417 $this->_is_buffering_output = false;
419 trigger_error("Not buffering output", E_USER_NOTICE);
424 * Longer texts need too much memory on tiny or memory-limit=8MB systems.
425 * We might want to flush our buffer and restart again.
426 * (This would be fine if php would release its memory)
427 * Note that this must not be called inside Template expansion or other
428 * sections with ob_buffering.
430 function chunkOutput()
432 if (!empty($this->_is_buffering_output)
434 (function_exists('ob_get_level') and @ob_get_level())
436 $this->_do_chunked_output = true;
437 if (empty($this->_ob_get_length)) $this->_ob_get_length = 0;
438 $this->_ob_get_length += ob_get_length();
439 while (@ob_end_flush()) ;
447 $this->_finishing = true;
448 if (!empty($this->_accesslog)) {
449 $this->_accesslog->push($this);
450 if (empty($this->_do_chunked_output) and empty($this->_ob_get_length))
451 $this->_ob_get_length = ob_get_length();
452 $this->_accesslog->setSize($this->_ob_get_length);
454 if ($RUNTIMER) $this->_accesslog->setDuration($RUNTIMER->getTime());
455 // sql logging must be done before the db is closed.
456 if (isset($this->_accesslog->logtable))
457 $this->_accesslog->write_sql();
460 if (!empty($this->_is_buffering_output)) {
461 // if _is_compressing_output then ob_get_length() returns
462 // the uncompressed length, not the gzip'ed as required.
463 if (!headers_sent() and !$this->_is_compressing_output) {
464 // php url-rewriting miscalculates the ob length. fixes bug #1376007
465 if (ini_get('use_trans_sid') == 'off') {
466 if (empty($this->_do_chunked_output)) {
467 $this->_ob_get_length = ob_get_length();
469 header(sprintf("Content-Length: %d", $this->_ob_get_length));
472 $this->_is_buffering_output = false;
474 } elseif (function_exists('ob_get_level') and @ob_get_level()) {
477 session_write_close();
478 if (!empty($this->_dbi)) {
479 $this->_dbi->close();
486 function getSessionVar($key)
488 return $this->session->get($key);
491 function setSessionVar($key, $val)
493 if ($key == 'wiki_user') {
494 if (empty($val->page))
495 $val->page = $this->getArg('pagename');
496 if (empty($val->action))
497 $val->action = $this->getArg('action');
498 // avoid recursive objects and session resource handles
499 // avoid overlarge session data (max 4000 byte!)
500 if (isset($val->_group)) {
501 unset($val->_group->_request);
502 unset($val->_group->user);
504 if (ENABLE_USER_NEW) {
505 unset($val->_HomePagehandle);
506 unset($val->_auth_dbi);
509 unset($val->_authdbi);
510 unset($val->_homepage);
511 unset($val->_request);
514 return $this->session->set($key, $val);
517 function deleteSessionVar($key)
519 return $this->session->delete($key);
522 function getCookieVar($key)
524 return $this->cookies->get($key);
527 function setCookieVar($key, $val, $lifetime_in_days = false, $path = false)
529 return $this->cookies->set($key, $val, $lifetime_in_days, $path);
532 function deleteCookieVar($key)
534 return $this->cookies->delete($key);
537 function getUploadedFile($key)
539 return Request_UploadedFile::getUploadedFile($key);
543 function _fix_magic_quotes_gpc()
545 $needs_fix = array('HTTP_POST_VARS',
552 if (get_magic_quotes_gpc()) {
553 foreach ($needs_fix as $vars)
554 $this->_stripslashes($GLOBALS[$vars]);
558 function _stripslashes(&$var)
560 if (is_array($var)) {
561 foreach ($var as $key => $val)
562 $this->_stripslashes($var[$key]);
563 } elseif (is_string($var))
564 $var = stripslashes($var);
567 function _fix_multipart_form_data()
569 if (preg_match('|^multipart/form-data|', $this->get('CONTENT_TYPE')))
570 $this->_strip_leading_nl($GLOBALS['HTTP_POST_VARS']);
573 function _strip_leading_nl(&$var)
575 if (is_array($var)) {
576 foreach ($var as $key => $val)
577 $this->_strip_leading_nl($var[$key]);
578 } elseif (is_string($var))
579 $var = preg_replace('|^\r?\n?|', '', $var);
583 class Request_SessionVars
585 function Request_SessionVars()
587 // Prevent cacheing problems with IE 5
588 session_cache_limiter('none');
590 // Avoid to get a notice if session is already started,
591 // for example if session.auto_start is activated
598 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
599 if (isset($vars[$key]))
601 if (isset($_SESSION) and isset($_SESSION[$key])) // php-5.2
602 return $_SESSION[$key];
606 function set($key, $val)
608 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
609 if (!function_usable('get_cfg_var') or get_cfg_var('register_globals')) {
610 // This is funky but necessary, at least in some PHP's
611 $GLOBALS[$key] = $val;
614 if (isset($_SESSION)) // php-5.2
615 $_SESSION[$key] = $val;
616 if (!check_php_version(5, 3))
617 session_register($key);
620 function delete($key)
622 $vars = &$GLOBALS['HTTP_SESSION_VARS'];
623 if (!function_usable('ini_get') or ini_get('register_globals'))
624 unset($GLOBALS[$key]);
625 if (DEBUG) trigger_error("delete session $key", E_USER_WARNING);
627 if (isset($_SESSION)) // php-5.2
628 unset($_SESSION[$key]);
629 if (!check_php_version(5, 3))
630 session_unregister($key);
634 class Request_CookieVars
639 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
640 if (isset($vars[$key])) {
641 @$decode = base64_decode($vars[$key]);
642 if (strlen($decode) > 3 and substr($decode, 1, 1) == ':') {
643 @$val = unserialize($decode);
647 @$val = urldecode($vars[$key]);
654 function get_old($key)
656 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
657 if (isset($vars[$key])) {
658 @$decode = base64_decode($vars[$key]);
659 if (strlen($decode) > 3 and substr($decode, 1, 1) == ':') {
660 @$val = unserialize($decode);
664 @$val = unserialize($vars[$key]);
674 function set($key, $val, $persist_days = false, $path = false)
676 // if already defined, ignore
677 if (defined('MAIN_setUser') and $key = getCookieName()) return;
678 if (defined('WIKI_XMLRPC') and WIKI_XMLRPC) return;
680 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
681 if (is_numeric($persist_days)) {
682 $expires = time() + (24 * 3600) * $persist_days;
686 if (is_array($val) or is_object($val))
687 $packedval = base64_encode(serialize($val));
689 $packedval = urlencode($val);
690 $vars[$key] = $packedval;
691 @$_COOKIE[$key] = $packedval;
693 @setcookie($key, $packedval, $expires, $path);
695 @setcookie($key, $packedval, $expires);
698 function delete($key)
700 static $deleted = array();
701 if (isset($deleted[$key])) return;
702 if (defined('WIKI_XMLRPC') and WIKI_XMLRPC) return;
704 $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
705 if (!defined('COOKIE_DOMAIN'))
706 @setcookie($key, '', 0);
708 @setcookie($key, '', 0, COOKIE_DOMAIN);
709 unset($GLOBALS['HTTP_COOKIE_VARS'][$key]);
710 unset($_COOKIE[$key]);
717 You must set "upload_tmp_dir" = "/tmp/" or "C:/tmp/"
718 Best on the same drive as apache, with forward slashes
719 and with ending slash!
720 Otherwise "\\" => "" and the uploaded file will not be found.
722 class Request_UploadedFile
724 function getUploadedFile($postname)
726 global $HTTP_POST_FILES;
728 // Against php5 with !ini_get('register-long-arrays'). See Bug #1180115
729 if (empty($HTTP_POST_FILES) and !empty($_FILES))
730 $HTTP_POST_FILES =& $_FILES;
731 if (!isset($HTTP_POST_FILES[$postname]))
734 $fileinfo =& $HTTP_POST_FILES[$postname];
735 if ($fileinfo['error']) {
736 // See https://sourceforge.net/forum/message.php?msg_id=3093651
737 $err = (int)$fileinfo['error'];
738 // errmsgs by Shilad Sen
741 trigger_error(_("Upload error: file too big"), E_USER_WARNING);
744 trigger_error(_("Upload error: file too big"), E_USER_WARNING);
747 trigger_error(_("Upload error: file only partially received"), E_USER_WARNING);
750 trigger_error(_("Upload error: no file selected"), E_USER_WARNING);
753 trigger_error(_("Upload error: unknown error #") . $err, E_USER_WARNING);
758 // With windows/php 4.2.1 is_uploaded_file() always returns false.
759 // Be sure that upload_tmp_dir ends with a slash!
760 if (!is_uploaded_file($fileinfo['tmp_name'])) {
762 if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
763 $tmp_file = dirname(tempnam('', ''));
765 $tmp_file .= '/' . basename($fileinfo['tmp_name']);
766 /* ending slash in php.ini upload_tmp_dir is required. */
767 if (realpath(ereg_replace('/+', '/', $tmp_file)) != realpath($fileinfo['tmp_name'])) {
768 trigger_error(sprintf("Uploaded tmpfile illegal: %s != %s.", $tmp_file, $fileinfo['tmp_name']) .
770 "Probably illegal TEMP environment or upload_tmp_dir setting. " .
771 "Esp. on WINDOWS be sure to set upload_tmp_dir in php.ini to use forward slashes and " .
772 "end with a slash. upload_tmp_dir = \"C:/WINDOWS/TEMP/\" is good suggestion.",
777 trigger_error(sprintf("Workaround for PHP/Windows is_uploaded_file() problem for %s.",
778 $fileinfo['tmp_name'])."\n".
779 "Probably illegal TEMP environment or upload_tmp_dir setting.",
785 trigger_error(sprintf("Uploaded tmpfile %s not found.", $fileinfo['tmp_name']) . "\n" .
786 " Probably illegal TEMP environment or upload_tmp_dir setting.",
790 return new Request_UploadedFile($fileinfo);
793 function Request_UploadedFile($fileinfo)
795 $this->_info = $fileinfo;
800 return $this->_info['size'];
805 return $this->_info['name'];
810 return $this->_info['type'];
813 function getTmpName()
815 return $this->_info['tmp_name'];
820 if (($fd = fopen($this->_info['tmp_name'], "rb"))) {
821 if ($this->getSize() < filesize($this->_info['tmp_name'])) {
822 // FIXME: Some PHP's (or is it some browsers?) put
823 // HTTP/MIME headers in the file body, some don't.
825 // At least, I think that's the case. I know I used
826 // to need this code, now I don't.
828 // This code is more-or-less untested currently.
830 // Dump HTTP headers.
831 while (($header = fgets($fd, 4096))) {
832 if (trim($header) == '') {
834 } else if (!preg_match('/^content-(length|type):/i', $header)) {
844 function getContents()
847 $data = fread($fd, $this->getSize());
854 * Create NCSA "combined" log entry for current request.
855 * Also needed for advanced spam prevention.
856 * global object holding global state (sql or file, entries, to dump)
858 class Request_AccessLog
861 * @param $logfile string Log file name.
863 function Request_AccessLog($logfile, $do_sql = false)
865 //global $request; // request not yet initialized!
867 $this->logfile = $logfile;
868 if ($logfile and !is_writeable($logfile)) {
870 (sprintf(_("%s is not writable."), _("The PhpWiki access log file"))
872 . sprintf(_("Please ensure that %s is writable, or redefine %s in config/config.ini."),
873 sprintf(_("the file '%s'"), ACCESS_LOG),
877 //$request->_accesslog =& $this;
878 //if (empty($request->_accesslog->entries))
879 register_shutdown_function("Request_AccessLogEntry_shutdown_function");
883 if (!in_array($DBParams['dbtype'], array('SQL', 'ADODB'))) {
884 trigger_error("Unsupported database backend for ACCESS_LOG_SQL.\nNeed DATABASE_TYPE=SQL or ADODB");
886 //$this->_dbi =& $request->_dbi;
887 $this->logtable = (!empty($DBParams['prefix']) ? $DBParams['prefix'] : '') . "accesslog";
890 $this->entries = array();
891 $this->entries[] = new Request_AccessLogEntry($this);
894 function _do($cmd, &$arg)
897 for ($i = 0; $i < count($this->entries); $i++)
898 $this->entries[$i]->$cmd($arg);
901 function push(&$request)
903 $this->_do('push', $request);
906 function setSize($arg)
908 $this->_do('setSize', $arg);
911 function setStatus($arg)
913 $this->_do('setStatus', $arg);
916 function setDuration($arg)
918 $this->_do('setDuration', $arg);
922 * Read sequentially all previous entries from the beginning.
923 * while ($logentry = Request_AccessLogEntry::read()) ;
924 * For internal log analyzers: RecentReferrers, WikiAccessRestrictions
928 return $this->logtable ? $this->read_sql() : $this->read_file();
932 * Return iterator of referer items reverse sorted (latest first).
934 function get_referer($limit = 15, $external_only = false)
936 if ($external_only) { // see stdlin.php:isExternalReferrer()
938 $blen = strlen($base);
940 if (!empty($this->_dbi)) {
941 // check same hosts in referer and request and remove them
942 $ext_where = " AND LEFT(referer,$blen) <> " . $this->_dbi->quote($base)
943 . " AND LEFT(referer,$blen) <> LEFT(CONCAT(" . $this->_dbi->quote(SERVER_URL) . ",request_uri),$blen)";
944 return $this->_read_sql_query("(referer <>'' AND NOT(ISNULL(referer)))"
945 . ($external_only ? $ext_where : '')
946 . " ORDER BY time_stamp DESC"
947 . ($limit ? " LIMIT $limit" : ""));
949 $iter = new WikiDB_Array_generic_iter(0);
950 $logs =& $iter->_array;
951 while ($logentry = $this->read_file()) {
952 if (!empty($logentry->referer)
953 and (!$external_only or (substr($logentry->referer, 0, $blen) != $base))
955 $iter->_array[] = $logentry;
956 if ($limit and count($logs) > $limit)
960 $logs = array_reverse($logs);
961 $logs = array_slice($logs, 0, min($limit, count($logs)));
967 * Return iterator of matching host items reverse sorted (latest first).
969 function get_host($host, $since_minutes = 20)
971 if ($this->logtable) {
972 // mysql specific only:
973 return $this->read_sql("request_host=" . $this->_dbi->quote($host) . " AND time_stamp > " . (time() - $since_minutes * 60)
974 . " ORDER BY time_stamp DESC");
976 $iter = new WikiDB_Array_generic_iter();
977 $logs =& $iter->_array;
978 $logentry = new Request_AccessLogEntry($this);
979 while ($logentry->read_file()) {
980 if (!empty($logentry->referer)) {
981 $iter->_array[] = $logentry;
982 if ($limit and count($logs) > $limit)
984 $logentry = new Request_AccessLogEntry($this);
987 $logs = array_reverse($logs);
988 $logs = array_slice($logs, 0, min($limit, count($logs)));
994 * Read sequentially all previous entries from log file.
999 if ($this->logfile) $this->logfile = ACCESS_LOG; // support Request_AccessLog::read
1001 if (empty($this->reader)) // start at the beginning
1002 $this->reader = fopen($this->logfile, "r");
1003 if ($s = fgets($this->reader)) {
1004 $entry = new Request_AccessLogEntry($this);
1005 if (preg_match('/^(\S+)\s(\S+)\s(\S+)\s\[(.+?)\] "([^"]+)" (\d+) (\d+) "([^"]*)" "([^"]*)"$/', $s, $m)) {
1006 list(, $entry->host, $entry->ident, $entry->user, $entry->time,
1007 $entry->request, $entry->status, $entry->size,
1008 $entry->referer, $entry->user_agent) = $m;
1011 } else { // until the end
1012 fclose($this->reader);
1017 function _read_sql_query($where = '')
1019 $dbh =& $GLOBALS['request']->_dbi;
1020 $log_tbl =& $this->logtable;
1021 return $dbh->genericSqlIter("SELECT *,request_uri as request,request_time as time,remote_user as user,"
1022 . "remote_host as host,agent as user_agent"
1024 . ($where ? " WHERE $where" : ""));
1027 function read_sql($where = '')
1029 if (empty($this->sqliter))
1030 $this->sqliter = $this->_read_sql_query($where);
1031 return $this->sqliter->next();
1034 /* done in request->finish() before the db is closed */
1035 function write_sql()
1037 $dbh =& $GLOBALS['request']->_dbi;
1038 if (isset($this->entries) and $dbh and $dbh->isOpen())
1039 foreach ($this->entries as $entry) {
1040 $entry->write_sql();
1044 /* done in the shutdown callback */
1045 function write_file()
1047 if (isset($this->entries) and $this->logfile)
1048 foreach ($this->entries as $entry) {
1049 $entry->write_file();
1051 unset($this->entries);
1054 /* in an ideal world... */
1057 if ($this->logfile) $this->write_file();
1058 if ($this->logtable) $this->write_sql();
1059 unset($this->entries);
1063 class Request_AccessLogEntry
1068 * The log entry will be automatically appended to the log file or
1069 * SQL table when the current request terminates.
1071 * If you want to modify a Request_AccessLogEntry before it gets
1072 * written (e.g. via the setStatus and setSize methods) you should
1073 * use an '&' on the constructor, so that you're working with the
1074 * original (rather than a copy) object.
1077 * $log_entry = & new Request_AccessLogEntry("/tmp/wiki_access_log");
1078 * $log_entry->setStatus(401);
1079 * $log_entry->push($request);
1084 function Request_AccessLogEntry(&$accesslog)
1086 $this->_accesslog = $accesslog;
1087 $this->logfile = $accesslog->logfile;
1088 $this->time = time();
1089 $this->status = 200; // see setStatus()
1090 $this->size = 0; // see setSize()
1094 * @param $request object Request object for current request.
1096 function push(&$request)
1098 $this->host = $request->get('REMOTE_HOST');
1099 $this->ident = $request->get('REMOTE_IDENT');
1102 $user = $request->getUser();
1103 if ($user->isAuthenticated())
1104 $this->user = $user->UserName();
1107 $this->request = join(' ', array($request->get('REQUEST_METHOD'),
1108 $request->get('REQUEST_URI'),
1109 $request->get('SERVER_PROTOCOL')));
1110 $this->referer = (string)$request->get('HTTP_REFERER');
1111 $this->user_agent = (string)$request->get('HTTP_USER_AGENT');
1115 * Set result status code.
1117 * @param $status integer HTTP status code.
1119 function setStatus($status)
1121 $this->status = $status;
1125 * Set response size.
1127 * @param $size integer
1129 function setSize($size = 0)
1131 $this->size = (int)$size;
1134 function setDuration($seconds)
1136 // Pear DB does not correctly quote , in floats using ?. e.g. in european locales.
1138 $this->duration = strtr(sprintf("%f", $seconds), ",", ".");
1142 * Get time zone offset.
1144 * This is a static member function.
1146 * @param $time integer Unix timestamp (defaults to current time).
1147 * @return string Zone offset, e.g. "-0800" for PST.
1149 function _zone_offset($time = false)
1153 $offset = date("Z", $time);
1159 $offhours = floor($offset / 3600);
1160 $offmins = $offset / 60 - $offhours * 60;
1161 return sprintf("%s%02d%02d", $negoffset, $offhours, $offmins);
1165 * Format time in NCSA format.
1167 * This is a static member function.
1169 * @param $time integer Unix timestamp (defaults to current time).
1170 * @return string Formatted date & time.
1172 function _ncsa_time($time = false)
1176 return date("d/M/Y:H:i:s", $time) .
1177 " " . $this->_zone_offset();
1182 if ($this->_accesslog->logfile) $this->write_file();
1183 if ($this->_accesslog->logtable) $this->write_sql();
1187 * Write entry to log file.
1189 function write_file()
1191 $entry = sprintf('%s %s %s [%s] "%s" %d %d "%s" "%s"',
1192 $this->host, $this->ident, $this->user,
1193 $this->_ncsa_time($this->time),
1194 $this->request, $this->status, $this->size,
1195 $this->referer, $this->user_agent);
1196 if (!empty($this->_accesslog->reader)) {
1197 fclose($this->_accesslog->reader);
1198 unset($this->_accesslog->reader);
1200 //Error log doesn't provide locking.
1201 //error_log("$entry\n", 3, $this->logfile);
1203 if (($fp = fopen($this->logfile, "a"))) {
1204 flock($fp, LOCK_EX);
1205 fputs($fp, "$entry\n");
1210 /* This is better been done by apache mod_log_sql */
1211 /* If ACCESS_LOG_SQL & 2 we do write it by our own */
1212 function write_sql()
1216 $dbh =& $request->_dbi;
1217 if ($dbh and $dbh->isOpen() and $this->_accesslog->logtable) {
1218 //$log_tbl =& $this->_accesslog->logtable;
1219 if ($request->get('REQUEST_METHOD') == "POST") {
1220 // strangely HTTP_POST_VARS doesn't contain all posted vars.
1221 $args = $_POST; // copy not ref. clone not needed on hashes
1223 if (!empty($args['auth']['passwd'])) $args['auth']['passwd'] = '<not displayed>';
1224 if (!empty($args['dbadmin']['passwd'])) $args['dbadmin']['passwd'] = '<not displayed>';
1225 if (!empty($args['pref']['passwd'])) $args['pref']['passwd'] = '<not displayed>';
1226 if (!empty($args['pref']['passwd2'])) $args['pref']['passwd2'] = '<not displayed>';
1227 $this->request_args = substr(serialize($args), 0, 254); // if VARCHAR(255) is used.
1229 $this->request_args = $request->get('QUERY_STRING');
1231 $this->request_method = $request->get('REQUEST_METHOD');
1232 $this->request_uri = $request->get('REQUEST_URI');
1233 // duration problem: sprintf "%f" might use comma e.g. "100,201" in european locales
1234 $dbh->_backend->write_accesslog($this);
1240 * Shutdown callback.
1243 * @see Request_AccessLogEntry
1245 function Request_AccessLogEntry_shutdown_function()
1249 if (isset($request->_accesslog->entries) and $request->_accesslog->logfile)
1250 foreach ($request->_accesslog->entries as $entry) {
1251 $entry->write_file();
1253 unset($request->_accesslog->entries);
1259 function HTTP_ETag($val, $is_weak = false)
1261 $this->_val = wikihash($val);
1262 $this->_weak = $is_weak;
1267 * Strong comparison: If either (or both) tag is weak, they
1270 function equals($that, $strong_match = false)
1272 if ($this->_val != $that->_val)
1274 if ($strong_match and ($this->_weak or $that->_weak))
1282 $quoted = '"' . addslashes($this->_val) . '"';
1283 return $this->_weak ? "W/$quoted" : $quoted;
1286 /** Parse tag from header.
1288 * This is a static member function.
1290 function parse($strval)
1292 if (!preg_match(':^(W/)?"(.+)"$:i', trim($strval), $m))
1293 return false; // parse failed
1294 list(, $weak, $str) = $m;
1295 return new HTTP_ETag(stripslashes($str), $weak);
1298 function matches($taglist, $strong_match = false)
1300 $taglist = trim($taglist);
1302 if ($taglist == '*') {
1304 return !$this->_weak;
1309 while (preg_match('@^(W/)?"((?:\\\\.|[^"])*)"\s*,?\s*@i',
1311 list($match, $weak, $str) = $m;
1312 $taglist = substr($taglist, strlen($match));
1313 $tag = new HTTP_ETag(stripslashes($str), $weak);
1314 if ($this->equals($tag, $strong_match)) {
1322 // Possible results from the HTTP_ValidatorSet::_check*() methods.
1323 // (Higher numerical values take precedence.)
1324 define ('_HTTP_VAL_PASS', 0); // Test is irrelevant
1325 define ('_HTTP_VAL_NOT_MODIFIED', 1); // Test passed, content not changed
1326 define ('_HTTP_VAL_MODIFIED', 2); // Test failed, content changed
1327 define ('_HTTP_VAL_FAILED', 3); // Precondition failed.
1329 class HTTP_ValidatorSet
1331 function HTTP_ValidatorSet($validators)
1333 $this->_mtime = $this->_weak = false;
1334 $this->_tag = array();
1336 foreach ($validators as $key => $val) {
1337 if ($key == '%mtime') {
1338 $this->_mtime = $val;
1339 } elseif ($key == '%weak') {
1341 $this->_weak = true;
1343 $this->_tag[$key] = $val;
1348 function append($that)
1350 if (is_array($that))
1351 $that = new HTTP_ValidatorSet($that);
1353 // Pick the most recent mtime
1354 if (isset($that->_mtime))
1355 if (!isset($this->_mtime) || $that->_mtime > $this->_mtime)
1356 $this->_mtime = $that->_mtime;
1358 // If either is weak, we're weak
1359 if (!empty($that->_weak))
1360 $this->_weak = true;
1361 if (is_array($this->_tag))
1362 $this->_tag = array_merge($this->_tag, $that->_tag);
1364 $this->_tag = $that->_tag;
1371 return new HTTP_ETag($this->_tag, $this->_weak);
1374 function getModificationTime()
1376 return $this->_mtime;
1379 function checkConditionalRequest(&$request)
1381 $result = max($this->_checkIfUnmodifiedSince($request),
1382 $this->_checkIfModifiedSince($request),
1383 $this->_checkIfMatch($request),
1384 $this->_checkIfNoneMatch($request));
1386 if ($result == _HTTP_VAL_PASS || $result == _HTTP_VAL_MODIFIED)
1387 return false; // "please proceed with normal processing"
1388 elseif ($result == _HTTP_VAL_FAILED)
1389 return 412; // "412 Precondition Failed"
1390 elseif ($result == _HTTP_VAL_NOT_MODIFIED)
1391 return 304; // "304 Not Modified"
1393 trigger_error("Ack, shouldn't get here", E_USER_ERROR);
1397 function _checkIfUnmodifiedSince(&$request)
1399 if ($this->_mtime !== false) {
1400 $since = ParseRfc1123DateTime($request->get("HTTP_IF_UNMODIFIED_SINCE"));
1401 if ($since !== false && $this->_mtime > $since)
1402 return _HTTP_VAL_FAILED;
1404 return _HTTP_VAL_PASS;
1407 function _checkIfModifiedSince(&$request)
1409 if ($this->_mtime !== false and $request->isGetOrHead()) {
1410 $since = ParseRfc1123DateTime($request->get("HTTP_IF_MODIFIED_SINCE"));
1411 if ($since !== false) {
1412 if ($this->_mtime <= $since)
1413 return _HTTP_VAL_NOT_MODIFIED;
1414 return _HTTP_VAL_MODIFIED;
1417 return _HTTP_VAL_PASS;
1420 function _checkIfMatch(&$request)
1422 if ($this->_tag && ($taglist = $request->get("HTTP_IF_MATCH"))) {
1423 $tag = $this->getETag();
1424 if (!$tag->matches($taglist, 'strong'))
1425 return _HTTP_VAL_FAILED;
1427 return _HTTP_VAL_PASS;
1430 function _checkIfNoneMatch(&$request)
1432 if ($this->_tag && ($taglist = $request->get("HTTP_IF_NONE_MATCH"))) {
1433 $tag = $this->getETag();
1434 $strong_compare = !$request->isGetOrHead();
1436 if ($tag->matches($taglist, $strong_compare)) {
1437 if ($request->isGetOrHead())
1438 return _HTTP_VAL_NOT_MODIFIED;
1440 return _HTTP_VAL_FAILED;
1442 return _HTTP_VAL_MODIFIED;
1445 return _HTTP_VAL_PASS;
1452 // c-basic-offset: 4
1453 // c-hanging-comment-ender-p: nil
1454 // indent-tabs-mode: nil