lib/Request.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: Request.php,v 1.62 2004-06-27 10:26:02 rurban Exp $');
   3 /*
   4  Copyright (C) 2002,2004 $ThePhpWikiProgrammingTeam
   5
   6  This file is part of PhpWiki.
   7
   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.
  12
  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.
  17
  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
  21  */
  22
  23 // backward compatibility for PHP < 4.2.0
  24 if (!function_exists('ob_clean')) {
  25     function ob_clean() {
  26         ob_end_clean();
  27         ob_start();
  28     }
  29 }
  30
  31
  32 class Request {
  33
  34     function Request() {
  35         $this->_fix_magic_quotes_gpc();
  36         $this->_fix_multipart_form_data();
  37
  38         switch($this->get('REQUEST_METHOD')) {
  39         case 'GET':
  40         case 'HEAD':
  41             $this->args = &$GLOBALS['HTTP_GET_VARS'];
  42             break;
  43         case 'POST':
  44             $this->args = &$GLOBALS['HTTP_POST_VARS'];
  45             break;
  46         default:
  47             $this->args = array();
  48             break;
  49         }
  50
  51         $this->session = new Request_SessionVars;
  52         $this->cookies = new Request_CookieVars;
  53
  54         if (ACCESS_LOG) {
  55             if (! is_writeable(ACCESS_LOG)) {
  56                 trigger_error
  57                     (sprintf(_("%s is not writable."), _("The PhpWiki access log file"))
  58                     . "\n"
  59                     . sprintf(_("Please ensure that %s is writable, or redefine %s in config/config.ini."),
  60                             sprintf(_("the file '%s'"), ACCESS_LOG),
  61                             'ACCESS_LOG')
  62                     , E_USER_NOTICE);
  63             }
  64             else
  65                 $this->_log_entry = & new Request_AccessLogEntry($this,
  66                                                                 ACCESS_LOG);
  67         }
  68
  69         $GLOBALS['request'] = $this;
  70     }
  71
  72     function get($key) {
  73         if (!empty($GLOBALS['HTTP_SERVER_VARS']))
  74             $vars = &$GLOBALS['HTTP_SERVER_VARS'];
  75         else // cgi or other servers than Apache
  76             $vars = &$GLOBALS['HTTP_ENV_VARS'];
  77
  78         if (isset($vars[$key]))
  79             return $vars[$key];
  80
  81         switch ($key) {
  82         case 'REMOTE_HOST':
  83             $addr = $vars['REMOTE_ADDR'];
  84             if (defined('ENABLE_REVERSE_DNS') && ENABLE_REVERSE_DNS)
  85                 return $vars[$key] = gethostbyaddr($addr);
  86             else
  87                 return $addr;
  88         default:
  89             return false;
  90         }
  91     }
  92
  93     function getArg($key) {
  94         if (isset($this->args[$key]))
  95             return $this->args[$key];
  96         return false;
  97     }
  98
  99     function getArgs () {
 100         return $this->args;
 101     }
 102
 103     function setArg($key, $val) {
 104         if ($val === false)
 105             unset($this->args[$key]);
 106         else
 107             $this->args[$key] = $val;
 108     }
 109
 110     // Well oh well. Do we really want to pass POST params back as GET?
 111     function getURLtoSelf($args = false, $exclude = array()) {
 112         $get_args = $this->args;
 113         if ($args)
 114             $get_args = array_merge($get_args, $args);
 115
 116         // Err... good point...
 117         // sortby buttons
 118         if ($this->isPost()) {
 119             $exclude = array_merge($exclude, array('action','auth'));
 120             //$get_args = $args; // or only the provided
 121             /*
 122             trigger_error("Request::getURLtoSelf() should probably not be from POST",
 123                           E_USER_NOTICE);
 124             */
 125         }
 126
 127         foreach ($exclude as $ex) {
 128             if (!empty($get_args[$ex])) unset($get_args[$ex]);
 129         }
 130
 131         $pagename = $get_args['pagename'];
 132         unset ($get_args['pagename']);
 133         if (!empty($get_args['action']) and $get_args['action'] == 'browse')
 134             unset($get_args['action']);
 135
 136         return WikiURL($pagename, $get_args);
 137     }
 138
 139     function isPost () {
 140         return $this->get("REQUEST_METHOD") == "POST";
 141     }
 142
 143     function isGetOrHead () {
 144         return in_array($this->get('REQUEST_METHOD'),
 145                         array('GET', 'HEAD'));
 146     }
 147
 148     function httpVersion() {
 149         if (!preg_match('@HTTP\s*/\s*(\d+.\d+)@', $this->get('SERVER_PROTOCOL'), $m))
 150             return false;
 151         return (float) $m[1];
 152     }
 153
 154     function redirect($url, $noreturn=true) {
 155         $bogus = defined('DISABLE_HTTP_REDIRECT') and DISABLE_HTTP_REDIRECT;
 156
 157         if (!$bogus) {
 158             header("Location: $url");
 159             /*
 160              * "302 Found" is not really meant to be sent in response
 161              * to a POST.  Worse still, according to (both HTTP 1.0
 162              * and 1.1) spec, the user, if it is sent, the user agent
 163              * is supposed to use the same method to fetch the
 164              * redirected URI as the original.
 165              *
 166              * That means if we redirect from a POST, the user-agent
 167              * supposed to generate another POST.  Not what we want.
 168              * (We do this after a page save after all.)
 169              *
 170              * Fortunately, most/all browsers don't do that.
 171              *
 172              * "303 See Other" is what we really want.  But it only
 173              * exists in HTTP/1.1
 174              *
 175              * FIXME: this is still not spec compliant for HTTP
 176              * version < 1.1.
 177              */
 178             $status = $this->httpVersion() >= 1.1 ? 303 : 302;
 179
 180             $this->setStatus($status);
 181         }
 182
 183         if ($noreturn) {
 184             include_once('lib/Template.php');
 185             $this->discardOutput();
 186             $tmpl = new Template('redirect', $this, array('REDIRECT_URL' => $url));
 187             $tmpl->printXML();
 188             $this->finish();
 189         }
 190         else if ($bogus) {
 191             return JavaScript("
 192               function redirect(url) {
 193                 if (typeof location.replace == 'function')
 194                   location.replace(url);
 195                 else if (typeof location.assign == 'function')
 196                   location.assign(url);
 197                 else
 198                   window.location = url;
 199               }
 200               redirect('" . addslashes($url) . "')");
 201         }
 202     }
 203
 204     /** Set validators for this response.
 205      *
 206      * This sets a (possibly incomplete) set of validators
 207      * for this response.
 208      *
 209      * The validator set can be extended using appendValidators().
 210      *
 211      * When you're all done setting and appending validators, you
 212      * must call checkValidators() to check them and set the
 213      * appropriate headers in the HTTP response.
 214      *
 215      * Example Usage:
 216      *  ...
 217      *  $request->setValidators(array('pagename' => $pagename,
 218      *                                '%mtime' => $rev->get('mtime')));
 219      *  ...
 220      *  // Wups... response content depends on $otherpage, too...
 221      *  $request->appendValidators(array('otherpage' => $otherpagerev->getPageName(),
 222      *                                   '%mtime' => $otherpagerev->get('mtime')));
 223      *  ...
 224      *  // After all validators have been set:
 225      *  $request->checkValidators();
 226      */
 227     function setValidators($validator_set) {
 228         if (is_array($validator_set))
 229             $validator_set = new HTTP_ValidatorSet($validator_set);
 230         $this->_validators = $validator_set;
 231     }
 232
 233     /** Append more validators for this response.
 234      *  i.e dependencies on other pages mtimes
 235      *  now it may be called in init also to simplify client code.
 236      */
 237     function appendValidators($validator_set) {
 238         if (!isset($this->_validators)) {
 239             $this->setValidators($validator_set);
 240             return;
 241         }
 242         $this->_validators->append($validator_set);
 243     }
 244
 245     /** Check validators and set headers in HTTP response
 246      *
 247      * This sets the appropriate "Last-Modified" and "ETag"
 248      * headers in the HTTP response.
 249      *
 250      * Additionally, if the validators match any(all) conditional
 251      * headers in the HTTP request, this method will not return, but
 252      * instead will send "304 Not Modified" or "412 Precondition
 253      * Failed" (as appropriate) back to the client.
 254      */
 255     function checkValidators() {
 256         $validators = &$this->_validators;
 257
 258         // Set validator headers
 259         if (($etag = $validators->getETag()) !== false)
 260             header("ETag: " . $etag->asString());
 261         if (($mtime = $validators->getModificationTime()) !== false)
 262             header("Last-Modified: " . Rfc1123DateTime($mtime));
 263
 264         // Set cache control headers
 265         $this->cacheControl();
 266
 267         if (CACHE_CONTROL == 'NO_CACHE')
 268             return;             // don't check conditionals...
 269
 270         // Check conditional headers in request
 271         $status = $validators->checkConditionalRequest($this);
 272         if ($status) {
 273             // Return short response due to failed conditionals
 274             $this->setStatus($status);
 275             print "\n\n";
 276             $this->discardOutput();
 277             $this->finish();
 278             exit();
 279         }
 280     }
 281
 282     /** Set the cache control headers in the HTTP response.
 283      */
 284     function cacheControl($strategy=CACHE_CONTROL, $max_age=CACHE_CONTROL_MAX_AGE) {
 285         if ($strategy == 'NO_CACHE') {
 286             $cache_control = "no-cache";
 287             $max_age = -20;
 288         }
 289         elseif ($strategy == 'ALLOW_STALE' && $max_age > 0) {
 290             $cache_control = sprintf("max-age=%d", $max_age);
 291         }
 292         else {
 293             $cache_control = "must-revalidate";
 294             $max_age = -20;
 295         }
 296         header("Cache-Control: $cache_control");
 297         header("Expires: " . Rfc1123DateTime(time() + $max_age));
 298         header("Vary: Cookie"); // FIXME: add more here?
 299     }
 300
 301     function setStatus($status) {
 302         if (preg_match('|^HTTP/.*?\s(\d+)|i', $status, $m)) {
 303             header($status);
 304             $status = $m[1];
 305         }
 306         else {
 307             $status = (integer) $status;
 308             $reason = array('200' => 'OK',
 309                             '302' => 'Found',
 310                             '303' => 'See Other',
 311                             '304' => 'Not Modified',
 312                             '400' => 'Bad Request',
 313                             '401' => 'Unauthorized',
 314                             '403' => 'Forbidden',
 315                             '404' => 'Not Found',
 316                             '412' => 'Precondition Failed');
 317             // FIXME: is it always okay to send HTTP/1.1 here, even for older clients?
 318             header(sprintf("HTTP/1.1 %d %s", $status, $reason[$status]));
 319         }
 320
 321         if (isset($this->_log_entry))
 322             $this->_log_entry->setStatus($status);
 323     }
 324
 325     function buffer_output($compress = true) {
 326         if (defined('COMPRESS_OUTPUT')) {
 327             if (!COMPRESS_OUTPUT)
 328                 $compress = false;
 329         }
 330         elseif (!function_exists('version_compare')
 331                 || version_compare(phpversion(), '4.2.3', "<")) {
 332             $compress = false;
 333         }
 334
 335         // Should we compress even when apache_note is not available?
 336         // sf.net bug #933183 and http://bugs.php.net/17557
 337         if (!function_exists('ob_gzhandler') or !function_exists('apache_note'))
 338             $compress = false;
 339
 340         if ($compress) {
 341             ob_start('ob_gzhandler');
 342             /*
 343              * Attempt to prevent Apache from doing the dreaded double-gzip.
 344              *
 345              * It would be better if we could detect when apache was going
 346              * to zip for us, and then let it ... but I have yet to figure
 347              * out how to do that.
 348              */
 349             if (function_exists('apache_note'))
 350                 @apache_note('no-gzip', 1);
 351         }
 352         else {
 353             // Now we alway buffer output.
 354             // This is so we can set HTTP headers (e.g. for redirect)
 355             // at any point.
 356             // FIXME: change the name of this method.
 357             ob_start();
 358         }
 359         $this->_is_buffering_output = true;
 360     }
 361
 362     function discardOutput() {
 363         if (!empty($this->_is_buffering_output)) {
 364             ob_clean();
 365             $this->_is_buffering_output = false;
 366         } else {
 367             trigger_error("Not buffering output", E_USER_NOTICE);
 368         }
 369     }
 370
 371     function finish() {
 372         session_write_close();
 373         if (!empty($this->_is_buffering_output)) {
 374             //header(sprintf("Content-Length: %d", ob_get_length()));
 375             ob_end_flush();
 376             $this->_is_buffering_output = false;
 377         }
 378         exit;
 379     }
 380
 381     function getSessionVar($key) {
 382         return $this->session->get($key);
 383     }
 384     function setSessionVar($key, $val) {
 385         return $this->session->set($key, $val);
 386     }
 387     function deleteSessionVar($key) {
 388         return $this->session->delete($key);
 389     }
 390
 391     function getCookieVar($key) {
 392         return $this->cookies->get($key);
 393     }
 394     function setCookieVar($key, $val, $lifetime_in_days = false, $path = false) {
 395         return $this->cookies->set($key, $val, $lifetime_in_days, $path);
 396     }
 397     function deleteCookieVar($key) {
 398         return $this->cookies->delete($key);
 399     }
 400
 401     function getUploadedFile($key) {
 402         return Request_UploadedFile::getUploadedFile($key);
 403     }
 404
 405
 406     function _fix_magic_quotes_gpc() {
 407         $needs_fix = array('HTTP_POST_VARS',
 408                            'HTTP_GET_VARS',
 409                            'HTTP_COOKIE_VARS',
 410                            'HTTP_SERVER_VARS',
 411                            'HTTP_POST_FILES');
 412
 413         // Fix magic quotes.
 414         if (get_magic_quotes_gpc()) {
 415             foreach ($needs_fix as $vars)
 416                 $this->_stripslashes($GLOBALS[$vars]);
 417         }
 418     }
 419
 420     function _stripslashes(&$var) {
 421         if (is_array($var)) {
 422             foreach ($var as $key => $val)
 423                 $this->_stripslashes($var[$key]);
 424         }
 425         elseif (is_string($var))
 426             $var = stripslashes($var);
 427     }
 428
 429     function _fix_multipart_form_data () {
 430         if (preg_match('|^multipart/form-data|', $this->get('CONTENT_TYPE')))
 431             $this->_strip_leading_nl($GLOBALS['HTTP_POST_VARS']);
 432     }
 433
 434     function _strip_leading_nl(&$var) {
 435         if (is_array($var)) {
 436             foreach ($var as $key => $val)
 437                 $this->_strip_leading_nl($var[$key]);
 438         }
 439         elseif (is_string($var))
 440             $var = preg_replace('|^\r?\n?|', '', $var);
 441     }
 442 }
 443
 444 class Request_SessionVars {
 445     function Request_SessionVars() {
 446         // Prevent cacheing problems with IE 5
 447         session_cache_limiter('none');
 448
 449         session_start();
 450     }
 451
 452     function get($key) {
 453         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 454         if (isset($vars[$key]))
 455             return $vars[$key];
 456         return false;
 457     }
 458
 459     function set($key, $val) {
 460         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 461         if ($key == 'wiki_user') {
 462             if (DEBUG) {
 463               if (!$val) {
 464                 trigger_error("delete user session", E_USER_WARNING);
 465               } elseif (!isset($val->_level)) {
 466                   trigger_error("lost level in session", E_USER_WARNING);
 467               }
 468             }
 469             if (is_object($val)) {
 470                 $val->page   = $GLOBALS['request']->getArg('pagename');
 471                 $val->action = $GLOBALS['request']->getArg('action');
 472                 // sessiondata may not exceed a certain size!
 473                 // otherwise it will get lost.
 474                 unset($val->_HomePagehandle);
 475                 unset($val->_auth_dbi);
 476                 if (isset($val->_group)) {
 477                     unset($val->_group->_request);
 478                     unset($val->_group->_user);
 479                 }
 480             }
 481         }
 482         if (!function_usable('get_cfg_var') or get_cfg_var('register_globals')) {
 483             // This is funky but necessary, at least in some PHP's
 484             $GLOBALS[$key] = $val;
 485         }
 486         $vars[$key] = $val;
 487         if (isset($_SESSION))
 488             $_SESSION[$key] = $val;
 489         session_register($key);
 490     }
 491
 492     function delete($key) {
 493         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 494         if (!function_usable('ini_get') or ini_get('register_globals'))
 495             unset($GLOBALS[$key]);
 496         if (DEBUG) trigger_error("delete session $key",E_USER_WARNING);
 497         unset($vars[$key]);
 498         session_unregister($key);
 499     }
 500 }
 501
 502 class Request_CookieVars {
 503
 504     function get($key) {
 505         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 506         if (isset($vars[$key])) {
 507             @$val = unserialize(base64_decode($vars[$key]));
 508             if (!empty($val))
 509                 return $val;
 510             @$val = urldecode($vars[$key]);
 511             if (!empty($val))
 512                 return $val;
 513         }
 514         return false;
 515     }
 516
 517     function get_old($key) {
 518         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 519         if (isset($vars[$key])) {
 520             @$val = unserialize(base64_decode($vars[$key]));
 521             if (!empty($val))
 522                 return $val;
 523             @$val = unserialize($vars[$key]);
 524             if (!empty($val))
 525                 return $val;
 526             @$val = $vars[$key];
 527             if (!empty($val))
 528                 return $val;
 529         }
 530         return false;
 531     }
 532
 533     function set($key, $val, $persist_days = false, $path = false) {
 534         // if already defined, ignore
 535         if (defined('MAIN_setUser') and $key = 'WIKI_ID') return;
 536         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 537         if (is_numeric($persist_days)) {
 538             $expires = time() + (24 * 3600) * $persist_days;
 539         }
 540         else {
 541             $expires = 0;
 542         }
 543         if (is_array($val) or is_object($val))
 544             $packedval = base64_encode(serialize($val));
 545         else
 546             $packedval = urlencode($val);
 547         $vars[$key] = $packedval;
 548         if ($path)
 549             @setcookie($key, $packedval, $expires, $path);
 550         else
 551             @setcookie($key, $packedval, $expires);
 552     }
 553
 554     function delete($key) {
 555         static $deleted = array();
 556         if (isset($deleted[$key])) return;
 557         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 558         @setcookie($key,'',0);
 559         @setcookie($key,'',0,defined('COOKIE_DOMAIN') ? COOKIE_DOMAIN : '/');
 560         unset($vars[$key]);
 561         unset($GLOBALS['HTTP_COOKIE_VARS'][$key]);
 562         $deleted[$key] = 1;
 563     }
 564 }
 565
 566 /* Win32 Note:
 567    [\winnt\php.ini]
 568    You must set "upload_tmp_dir" = "/tmp/" or "C:/tmp/"
 569    Best on the same drive as apache, with forward slashes
 570    and with ending slash!
 571    Otherwise "\\" => "" and the uploaded file will not be found.
 572 */
 573 class Request_UploadedFile {
 574     function getUploadedFile($postname) {
 575         global $HTTP_POST_FILES;
 576
 577         if (!isset($HTTP_POST_FILES[$postname]))
 578             return false;
 579
 580         $fileinfo = &$HTTP_POST_FILES[$postname];
 581         if ($fileinfo['error']) {
 582             trigger_error("Upload error: #" . $fileinfo['error'],
 583                           E_USER_ERROR);
 584             return false;
 585         }
 586
 587         // With windows/php 4.2.1 is_uploaded_file() always returns false.
 588         // Be sure that upload_tmp_dir ends with a slash!
 589         if (!is_uploaded_file($fileinfo['tmp_name'])) {
 590             if (isWindows()) {
 591                 if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
 592                     $tmp_file = dirname(tempnam('', ''));
 593                 }
 594                 $tmp_file .= '/' . basename($fileinfo['tmp_name']);
 595                 /* but ending slash in php.ini upload_tmp_dir is required. */
 596                 if (ereg_replace('/+', '/', $tmp_file) != $fileinfo['tmp_name']) {
 597                     trigger_error(sprintf("Uploaded tmpfile illegal: %s != %s.",$tmp_file, $fileinfo['tmp_name']).
 598                                   "\n".
 599                                   "Probably illegal TEMP environment or upload_tmp_dir setting.",
 600                                   E_USER_ERROR);
 601                     return false;
 602                 } else {
 603                     /*
 604                     trigger_error(sprintf("Workaround for PHP/Windows is_uploaded_file() problem for %s.",
 605                                           $fileinfo['tmp_name'])."\n".
 606                                   "Probably illegal TEMP environment or upload_tmp_dir setting.",
 607                                   E_USER_NOTICE);
 608                     */
 609                     ;
 610                 }
 611             } else {
 612               trigger_error(sprintf("Uploaded tmpfile %s not found.",$fileinfo['tmp_name'])."\n".
 613                            " Probably illegal TEMP environment or upload_tmp_dir setting.",
 614                           E_USER_WARNING);
 615             }
 616         }
 617         return new Request_UploadedFile($fileinfo);
 618     }
 619
 620     function Request_UploadedFile($fileinfo) {
 621         $this->_info = $fileinfo;
 622     }
 623
 624     function getSize() {
 625         return $this->_info['size'];
 626     }
 627
 628     function getName() {
 629         return $this->_info['name'];
 630     }
 631
 632     function getType() {
 633         return $this->_info['type'];
 634     }
 635
 636     function getTmpName() {
 637         return $this->_info['tmp_name'];
 638     }
 639
 640     function open() {
 641         if ( ($fd = fopen($this->_info['tmp_name'], "rb")) ) {
 642             if ($this->getSize() < filesize($this->_info['tmp_name'])) {
 643                 // FIXME: Some PHP's (or is it some browsers?) put
 644                 //    HTTP/MIME headers in the file body, some don't.
 645                 //
 646                 // At least, I think that's the case.  I know I used
 647                 // to need this code, now I don't.
 648                 //
 649                 // This code is more-or-less untested currently.
 650                 //
 651                 // Dump HTTP headers.
 652                 while ( ($header = fgets($fd, 4096)) ) {
 653                     if (trim($header) == '') {
 654                         break;
 655                     }
 656                     else if (!preg_match('/^content-(length|type):/i', $header)) {
 657                         rewind($fd);
 658                         break;
 659                     }
 660                 }
 661             }
 662         }
 663         return $fd;
 664     }
 665
 666     function getContents() {
 667         $fd = $this->open();
 668         $data = fread($fd, $this->getSize());
 669         fclose($fd);
 670         return $data;
 671     }
 672 }
 673
 674 /**
 675  * Create NCSA "combined" log entry for current request.
 676  */
 677 class Request_AccessLogEntry
 678 {
 679     /**
 680      * Constructor.
 681      *
 682      * The log entry will be automatically appended to the log file
 683      * when the current request terminates.
 684      *
 685      * If you want to modify a Request_AccessLogEntry before it gets
 686      * written (e.g. via the setStatus and setSize methods) you should
 687      * use an '&' on the constructor, so that you're working with the
 688      * original (rather than a copy) object.
 689      *
 690      * <pre>
 691      *    $log_entry = & new Request_AccessLogEntry($req, "/tmp/wiki_access_log");
 692      *    $log_entry->setStatus(401);
 693      * </pre>
 694      *
 695      *
 696      * @param $request object  Request object for current request.
 697      * @param $logfile string  Log file name.
 698      */
 699     function Request_AccessLogEntry (&$request, $logfile) {
 700         $this->logfile = $logfile;
 701
 702         $this->host  = $request->get('REMOTE_HOST');
 703         $this->ident = $request->get('REMOTE_IDENT');
 704         if (!$this->ident)
 705             $this->ident = '-';
 706         $this->user = '-';        // FIXME: get logged-in user name
 707         $this->time = time();
 708         $this->request = join(' ', array($request->get('REQUEST_METHOD'),
 709                                          $request->get('REQUEST_URI'),
 710                                          $request->get('SERVER_PROTOCOL')));
 711         $this->status = 200;
 712         $this->size = 0;
 713         $this->referer = (string) $request->get('HTTP_REFERER');
 714         $this->user_agent = (string) $request->get('HTTP_USER_AGENT');
 715
 716         global $Request_AccessLogEntry_entries;
 717         if (!isset($Request_AccessLogEntry_entries)) {
 718             register_shutdown_function("Request_AccessLogEntry_shutdown_function");
 719         }
 720         $Request_AccessLogEntry_entries[] = &$this;
 721     }
 722
 723     /**
 724      * Set result status code.
 725      *
 726      * @param $status integer  HTTP status code.
 727      */
 728     function setStatus ($status) {
 729         $this->status = $status;
 730     }
 731
 732     /**
 733      * Set response size.
 734      *
 735      * @param $size integer
 736      */
 737     function setSize ($size) {
 738         $this->size = $size;
 739     }
 740
 741     /**
 742      * Get time zone offset.
 743      *
 744      * This is a static member function.
 745      *
 746      * @param $time integer Unix timestamp (defaults to current time).
 747      * @return string Zone offset, e.g. "-0800" for PST.
 748      */
 749     function _zone_offset ($time = false) {
 750         if (!$time)
 751             $time = time();
 752         $offset = date("Z", $time);
 753         $negoffset = "";
 754         if ($offset < 0) {
 755             $negoffset = "-";
 756             $offset = -$offset;
 757         }
 758         $offhours = floor($offset / 3600);
 759         $offmins  = $offset / 60 - $offhours * 60;
 760         return sprintf("%s%02d%02d", $negoffset, $offhours, $offmins);
 761     }
 762
 763     /**
 764      * Format time in NCSA format.
 765      *
 766      * This is a static member function.
 767      *
 768      * @param $time integer Unix timestamp (defaults to current time).
 769      * @return string Formatted date & time.
 770      */
 771     function _ncsa_time($time = false) {
 772         if (!$time)
 773             $time = time();
 774
 775         return date("d/M/Y:H:i:s", $time) .
 776             " " . $this->_zone_offset();
 777     }
 778
 779     /**
 780      * Write entry to log file.
 781      */
 782     function write() {
 783         $entry = sprintf('%s %s %s [%s] "%s" %d %d "%s" "%s"',
 784                          $this->host, $this->ident, $this->user,
 785                          $this->_ncsa_time($this->time),
 786                          $this->request, $this->status, $this->size,
 787                          $this->referer, $this->user_agent);
 788
 789         //Error log doesn't provide locking.
 790         //error_log("$entry\n", 3, $this->logfile);
 791
 792         // Alternate method
 793         if (($fp = fopen($this->logfile, "a"))) {
 794             flock($fp, LOCK_EX);
 795             fputs($fp, "$entry\n");
 796             fclose($fp);
 797         }
 798     }
 799 }
 800
 801 /**
 802  * Shutdown callback.
 803  *
 804  * @access private
 805  * @see Request_AccessLogEntry
 806  */
 807 function Request_AccessLogEntry_shutdown_function ()
 808 {
 809     global $Request_AccessLogEntry_entries;
 810
 811     foreach ($Request_AccessLogEntry_entries as $entry) {
 812         $entry->write();
 813     }
 814     unset($Request_AccessLogEntry_entries);
 815 }
 816
 817
 818 class HTTP_ETag {
 819     function HTTP_ETag($val, $is_weak=false) {
 820         $this->_val = hash($val);
 821         $this->_weak = $is_weak;
 822     }
 823
 824     /** Comparison
 825      *
 826      * Strong comparison: If either (or both) tag is weak, they
 827      *  are not equal.
 828      */
 829     function equals($that, $strong_match=false) {
 830         if ($this->_val != $that->_val)
 831             return false;
 832         if ($strong_match and ($this->_weak or $that->_weak))
 833             return false;
 834         return true;
 835     }
 836
 837
 838     function asString() {
 839         $quoted = '"' . addslashes($this->_val) . '"';
 840         return $this->_weak ? "W/$quoted" : $quoted;
 841     }
 842
 843     /** Parse tag from header.
 844      *
 845      * This is a static member function.
 846      */
 847     function parse($strval) {
 848         if (!preg_match(':^(W/)?"(.+)"$:i', trim($strval), $m))
 849             return false;       // parse failed
 850         list(,$weak,$str) = $m;
 851         return new HTTP_ETag(stripslashes($str), $weak);
 852     }
 853
 854     function matches($taglist, $strong_match=false) {
 855         $taglist = trim($taglist);
 856
 857         if ($taglist == '*') {
 858             if ($strong_match)
 859                 return ! $this->_weak;
 860             else
 861                 return true;
 862         }
 863
 864         while (preg_match('@^(W/)?"((?:\\\\.|[^"])*)"\s*,?\s*@i',
 865                           $taglist, $m)) {
 866             list($match, $weak, $str) = $m;
 867             $taglist = substr($taglist, strlen($match));
 868             $tag = new HTTP_ETag(stripslashes($str), $weak);
 869             if ($this->equals($tag, $strong_match)) {
 870                 return true;
 871             }
 872         }
 873         return false;
 874     }
 875 }
 876
 877 // Possible results from the HTTP_ValidatorSet::_check*() methods.
 878 // (Higher numerical values take precedence.)
 879 define ('_HTTP_VAL_PASS', 0);           // Test is irrelevant
 880 define ('_HTTP_VAL_NOT_MODIFIED', 1);   // Test passed, content not changed
 881 define ('_HTTP_VAL_MODIFIED', 2);       // Test failed, content changed
 882 define ('_HTTP_VAL_FAILED', 3);         // Precondition failed.
 883
 884 class HTTP_ValidatorSet {
 885     function HTTP_ValidatorSet($validators) {
 886         $this->_mtime = $this->_weak = false;
 887         $this->_tag = array();
 888
 889         foreach ($validators as $key => $val) {
 890             if ($key == '%mtime') {
 891                 $this->_mtime = $val;
 892             }
 893             elseif ($key == '%weak') {
 894                 if ($val)
 895                     $this->_weak = true;
 896             }
 897             else {
 898                 $this->_tag[$key] = $val;
 899             }
 900         }
 901     }
 902
 903     function append($that) {
 904         if (is_array($that))
 905             $that = new HTTP_ValidatorSet($that);
 906
 907         // Pick the most recent mtime
 908         if (isset($that->_mtime))
 909             if (!isset($this->_mtime) || $that->_mtime > $this->_mtime)
 910                 $this->_mtime = $that->_mtime;
 911
 912         // If either is weak, we're weak
 913         if (!empty($that->_weak))
 914             $this->_weak = true;
 915
 916         $this->_tag = array_merge($this->_tag, $that->_tag);
 917     }
 918
 919     function getETag() {
 920         if (! $this->_tag)
 921             return false;
 922         return new HTTP_ETag($this->_tag, $this->_weak);
 923     }
 924
 925     function getModificationTime() {
 926         return $this->_mtime;
 927     }
 928
 929     function checkConditionalRequest (&$request) {
 930         $result = max($this->_checkIfUnmodifiedSince($request),
 931                       $this->_checkIfModifiedSince($request),
 932                       $this->_checkIfMatch($request),
 933                       $this->_checkIfNoneMatch($request));
 934
 935         if ($result == _HTTP_VAL_PASS || $result == _HTTP_VAL_MODIFIED)
 936             return false;       // "please proceed with normal processing"
 937         elseif ($result == _HTTP_VAL_FAILED)
 938             return 412;         // "412 Precondition Failed"
 939         elseif ($result == _HTTP_VAL_NOT_MODIFIED)
 940             return 304;         // "304 Not Modified"
 941
 942         trigger_error("Ack, shouldn't get here", E_USER_ERROR);
 943         return false;
 944     }
 945
 946     function _checkIfUnmodifiedSince(&$request) {
 947         if ($this->_mtime !== false) {
 948             $since = ParseRfc1123DateTime($request->get("HTTP_IF_UNMODIFIED_SINCE"));
 949             if ($since !== false && $this->_mtime > $since)
 950                 return _HTTP_VAL_FAILED;
 951         }
 952         return _HTTP_VAL_PASS;
 953     }
 954
 955     function _checkIfModifiedSince(&$request) {
 956         if ($this->_mtime !== false and $request->isGetOrHead()) {
 957             $since = ParseRfc1123DateTime($request->get("HTTP_IF_MODIFIED_SINCE"));
 958             if ($since !== false) {
 959                 if ($this->_mtime <= $since)
 960                     return _HTTP_VAL_NOT_MODIFIED;
 961                 return _HTTP_VAL_MODIFIED;
 962             }
 963         }
 964         return _HTTP_VAL_PASS;
 965     }
 966
 967     function _checkIfMatch(&$request) {
 968         if ($this->_tag && ($taglist = $request->get("HTTP_IF_MATCH"))) {
 969             $tag = $this->getETag();
 970             if (!$tag->matches($taglist, 'strong'))
 971                 return _HTTP_VAL_FAILED;
 972         }
 973         return _HTTP_VAL_PASS;
 974     }
 975
 976     function _checkIfNoneMatch(&$request) {
 977         if ($this->_tag && ($taglist = $request->get("HTTP_IF_NONE_MATCH"))) {
 978             $tag = $this->getETag();
 979             $strong_compare = ! $request->isGetOrHead();
 980             if ($taglist) {
 981                 if ($tag->matches($taglist, $strong_compare)) {
 982                     if ($request->isGetOrHead())
 983                         return _HTTP_VAL_NOT_MODIFIED;
 984                     else
 985                         return _HTTP_VAL_FAILED;
 986                 }
 987                 return _HTTP_VAL_MODIFIED;
 988             }
 989         }
 990         return _HTTP_VAL_PASS;
 991     }
 992 }
 993
 994
 995 // $Log: not supported by cvs2svn $
 996 // Revision 1.61  2004/06/25 14:29:17  rurban
 997 // WikiGroup refactoring:
 998 //   global group attached to user, code for not_current user.
 999 //   improved helpers for special groups (avoid double invocations)
1000 // new experimental config option ENABLE_XHTML_XML (fails with IE, and document.write())
1001 // fixed a XHTML validation error on userprefs.tmpl
1002 //
1003 // Revision 1.60  2004/06/19 11:51:13  rurban
1004 // CACHE_CONTROL: NONE => NO_CACHE
1005 //
1006 // Revision 1.59  2004/06/13 11:34:22  rurban
1007 // fixed bug #969532 (space in uploaded filenames)
1008 // improved upload error messages
1009 //
1010 // Revision 1.58  2004/06/04 20:32:53  rurban
1011 // Several locale related improvements suggested by Pierrick Meignen
1012 // LDAP fix by John Cole
1013 // reanable admin check without ENABLE_PAGEPERM in the admin plugins
1014 //
1015 // Revision 1.57  2004/06/03 18:54:25  rurban
1016 // fixed "lost level in session" warning, now that signout sets level = 0 (before -1)
1017 //
1018 // Revision 1.56  2004/05/17 17:43:29  rurban
1019 // CGI: no PATH_INFO fix
1020 //
1021 // Revision 1.55  2004/05/15 18:31:00  rurban
1022 // some action=pdf Request fixes: With MSIE it works now. Now the work with the page formatting begins.
1023 //
1024 // Revision 1.54  2004/05/04 22:34:25  rurban
1025 // more pdf support
1026 //
1027 // Revision 1.53  2004/05/03 21:57:47  rurban
1028 // locale updates: we previously lost some words because of wrong strings in
1029 //   PhotoAlbum, german rewording.
1030 // fixed $_SESSION registering (lost session vars, esp. prefs)
1031 // fixed ending slash in listAvailableLanguages/Themes
1032 //
1033 // Revision 1.52  2004/05/03 13:16:47  rurban
1034 // fixed UserPreferences update, esp for boolean and int
1035 //
1036 // Revision 1.51  2004/05/02 21:26:38  rurban
1037 // limit user session data (HomePageHandle and auth_dbi have to invalidated anyway)
1038 //   because they will not survive db sessions, if too large.
1039 // extended action=upgrade
1040 // some WikiTranslation button work
1041 // revert WIKIAUTH_UNOBTAINABLE (need it for main.php)
1042 // some temp. session debug statements
1043 //
1044 // Revision 1.50  2004/04/29 19:39:44  rurban
1045 // special support for formatted plugins (one-liners)
1046 //   like <small><plugin BlaBla ></small>
1047 // iter->asArray() helper for PopularNearby
1048 // db_session for older php's (no &func() allowed)
1049 //
1050 // Revision 1.49  2004/04/26 20:44:34  rurban
1051 // locking table specific for better databases
1052 //
1053 // Revision 1.48  2004/04/13 09:13:50  rurban
1054 // sf.net bug #933183 and http://bugs.php.net/17557
1055 // disable ob_gzhandler if apache_note cannot be used.
1056 //   (conservative until we find why)
1057 //
1058 // Revision 1.47  2004/04/02 15:06:55  rurban
1059 // fixed a nasty ADODB_mysql session update bug
1060 // improved UserPreferences layout (tabled hints)
1061 // fixed UserPreferences auth handling
1062 // improved auth stability
1063 // improved old cookie handling: fixed deletion of old cookies with paths
1064 //
1065 // Revision 1.46  2004/03/30 02:14:03  rurban
1066 // fixed yet another Prefs bug
1067 // added generic PearDb_iter
1068 // $request->appendValidators no so strict as before
1069 // added some box plugin methods
1070 // PageList commalist for condensed output
1071 //
1072 // Revision 1.45  2004/03/24 19:39:02  rurban
1073 // php5 workaround code (plus some interim debugging code in XmlElement)
1074 //   php5 doesn't work yet with the current XmlElement class constructors,
1075 //   WikiUserNew does work better than php4.
1076 // rewrote WikiUserNew user upgrading to ease php5 update
1077 // fixed pref handling in WikiUserNew
1078 // added Email Notification
1079 // added simple Email verification
1080 // removed emailVerify userpref subclass: just a email property
1081 // changed pref binary storage layout: numarray => hash of non default values
1082 // print optimize message only if really done.
1083 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
1084 //   prefs should be stored in db or homepage, besides the current session.
1085 //
1086 // Revision 1.44  2004/03/14 16:26:22  rurban
1087 // copyright line
1088 //
1089 // Revision 1.43  2004/03/12 20:59:17  rurban
1090 // important cookie fix by Konstantin Zadorozhny
1091 // new editpage feature: JS_SEARCHREPLACE
1092 //
1093 // Revision 1.42  2004/03/10 15:38:48  rurban
1094 // store current user->page and ->action in session for WhoIsOnline
1095 // better WhoIsOnline icon
1096 // fixed WhoIsOnline warnings
1097 //
1098 // Revision 1.41  2004/02/27 01:25:14  rurban
1099 // Workarounds for upload handling
1100 //
1101 // Revision 1.40  2004/02/26 01:39:51  rurban
1102 // safer code
1103 //
1104 // Revision 1.39  2004/02/24 15:14:57  rurban
1105 // fixed action=upload problems on Win32, and remove Merge Edit buttons: file does not exist anymore
1106 //
1107 // Revision 1.38  2004/01/25 10:26:02  rurban
1108 // fixed bug [ 541193 ] HTTP_SERVER_VARS are Apache specific
1109 // http://sourceforge.net/tracker/index.php?func=detail&aid=541193&group_id=6121&atid=106121
1110 // CGI and other servers than apache populate _ENV and not _SERVER
1111 //
1112 // Revision 1.37  2003/12/26 06:41:16  carstenklapp
1113 // Bugfix: Try to defer OS errors about session.save_path and ACCESS_LOG,
1114 // so they don't prevent IE from partially (or not at all) rendering the
1115 // page. This should help a little for the IE user who encounters trouble
1116 // when setting up a new PhpWiki for the first time.
1117 //
1118
1119 // Local Variables:
1120 // mode: php
1121 // tab-width: 8
1122 // c-basic-offset: 4
1123 // c-hanging-comment-ender-p: nil
1124 // indent-tabs-mode: nil
1125 // End:
1126 ?>