lib/Request.php

   1 <?php // -*-php-*-
   2 rcs_id('$Id: Request.php,v 1.53 2004-05-03 21:57:47 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 index.php."),
  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['_ENV'];
  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 == 'NONE')
 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 == 'NONE') {
 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         else
 366             trigger_error("Not buffering output", E_USER_NOTICE);
 367     }
 368
 369     function finish() {
 370         if (!empty($this->_is_buffering_output)) {
 371             //header(sprintf("Content-Length: %d", ob_get_length()));
 372             ob_end_flush();
 373         }
 374         exit;
 375     }
 376
 377     function getSessionVar($key) {
 378         return $this->session->get($key);
 379     }
 380     function setSessionVar($key, $val) {
 381         return $this->session->set($key, $val);
 382     }
 383     function deleteSessionVar($key) {
 384         return $this->session->delete($key);
 385     }
 386
 387     function getCookieVar($key) {
 388         return $this->cookies->get($key);
 389     }
 390     function setCookieVar($key, $val, $lifetime_in_days = false, $path = false) {
 391         return $this->cookies->set($key, $val, $lifetime_in_days, $path);
 392     }
 393     function deleteCookieVar($key) {
 394         return $this->cookies->delete($key);
 395     }
 396
 397     function getUploadedFile($key) {
 398         return Request_UploadedFile::getUploadedFile($key);
 399     }
 400
 401
 402     function _fix_magic_quotes_gpc() {
 403         $needs_fix = array('HTTP_POST_VARS',
 404                            'HTTP_GET_VARS',
 405                            'HTTP_COOKIE_VARS',
 406                            'HTTP_SERVER_VARS',
 407                            'HTTP_POST_FILES');
 408
 409         // Fix magic quotes.
 410         if (get_magic_quotes_gpc()) {
 411             foreach ($needs_fix as $vars)
 412                 $this->_stripslashes($GLOBALS[$vars]);
 413         }
 414     }
 415
 416     function _stripslashes(&$var) {
 417         if (is_array($var)) {
 418             foreach ($var as $key => $val)
 419                 $this->_stripslashes($var[$key]);
 420         }
 421         elseif (is_string($var))
 422             $var = stripslashes($var);
 423     }
 424
 425     function _fix_multipart_form_data () {
 426         if (preg_match('|^multipart/form-data|', $this->get('CONTENT_TYPE')))
 427             $this->_strip_leading_nl($GLOBALS['HTTP_POST_VARS']);
 428     }
 429
 430     function _strip_leading_nl(&$var) {
 431         if (is_array($var)) {
 432             foreach ($var as $key => $val)
 433                 $this->_strip_leading_nl($var[$key]);
 434         }
 435         elseif (is_string($var))
 436             $var = preg_replace('|^\r?\n?|', '', $var);
 437     }
 438 }
 439
 440 class Request_SessionVars {
 441     function Request_SessionVars() {
 442         // Prevent cacheing problems with IE 5
 443         session_cache_limiter('none');
 444
 445         session_start();
 446     }
 447
 448     function get($key) {
 449         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 450         if (isset($vars[$key]))
 451             return $vars[$key];
 452         return false;
 453     }
 454
 455     function set($key, $val) {
 456         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 457         if ($key == 'wiki_user') {
 458             if (DEBUG) {
 459               if (!$val) {
 460                 trigger_error("delete user session",E_USER_WARNING);
 461               } elseif (!$val->_level) {
 462                 trigger_error("lost level in session",E_USER_WARNING);
 463               }
 464             }
 465             if (is_object($val)) {
 466                 $val->page   = $GLOBALS['request']->getArg('pagename');
 467                 $val->action = $GLOBALS['request']->getArg('action');
 468                 // sessiondata may not exceed a certain size!
 469                 // otherwise it will get lost.
 470                 unset($val->_HomePagehandle);
 471                 unset($val->_auth_dbi);
 472             }
 473         }
 474         if (!function_usable('get_cfg_var') or get_cfg_var('register_globals')) {
 475             // This is funky but necessary, at least in some PHP's
 476             $GLOBALS[$key] = $val;
 477         }
 478         $vars[$key] = $val;
 479         if (isset($_SESSION))
 480             $_SESSION[$key] = $val;
 481         session_register($key);
 482     }
 483
 484     function delete($key) {
 485         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 486         if (!function_usable('ini_get') or ini_get('register_globals'))
 487             unset($GLOBALS[$key]);
 488         if (DEBUG) trigger_error("delete session $key",E_USER_WARNING);
 489         unset($vars[$key]);
 490         session_unregister($key);
 491     }
 492 }
 493
 494 class Request_CookieVars {
 495
 496     function get($key) {
 497         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 498         if (isset($vars[$key])) {
 499             @$val = unserialize(base64_decode($vars[$key]));
 500             if (!empty($val))
 501                 return $val;
 502             @$val = urldecode($vars[$key]);
 503             if (!empty($val))
 504                 return $val;
 505         }
 506         return false;
 507     }
 508
 509     function get_old($key) {
 510         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 511         if (isset($vars[$key])) {
 512             @$val = unserialize(base64_decode($vars[$key]));
 513             if (!empty($val))
 514                 return $val;
 515             @$val = unserialize($vars[$key]);
 516             if (!empty($val))
 517                 return $val;
 518             @$val = $vars[$key];
 519             if (!empty($val))
 520                 return $val;
 521         }
 522         return false;
 523     }
 524
 525     function set($key, $val, $persist_days = false, $path = false) {
 526         // if already defined, ignore
 527         if (defined('MAIN_setUser') and $key = 'WIKI_ID') return;
 528         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 529         if (is_numeric($persist_days)) {
 530             $expires = time() + (24 * 3600) * $persist_days;
 531         }
 532         else {
 533             $expires = 0;
 534         }
 535         if (is_array($val) or is_object($val))
 536             $packedval = base64_encode(serialize($val));
 537         else
 538             $packedval = urlencode($val);
 539         $vars[$key] = $packedval;
 540         if ($path)
 541             setcookie($key, $packedval, $expires, $path);
 542         else
 543             setcookie($key, $packedval, $expires);
 544     }
 545
 546     function delete($key) {
 547         static $deleted = array();
 548         if (isset($deleted[$key])) return;
 549         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 550         setcookie($key,'',0);
 551         setcookie($key,'',0,defined('COOKIE_DOMAIN') ? COOKIE_DOMAIN : '/');
 552         unset($vars[$key]);
 553         unset($GLOBALS['HTTP_COOKIE_VARS'][$key]);
 554         $deleted[$key] = 1;
 555     }
 556 }
 557
 558 /* Win32 Note:
 559    [\winnt\php.ini]
 560    You must set "upload_tmp_dir" = "/tmp/" or "C:/tmp/"
 561    Best on the same drive as apache, with forward slashes
 562    and with ending slash!
 563    Otherwise "\\" => "" and the uploaded file will not be found.
 564 */
 565 class Request_UploadedFile {
 566     function getUploadedFile($postname) {
 567         global $HTTP_POST_FILES;
 568
 569         if (!isset($HTTP_POST_FILES[$postname]))
 570             return false;
 571
 572         $fileinfo = &$HTTP_POST_FILES[$postname];
 573         if ($fileinfo['error']) {
 574             trigger_error("Upload error: #" . $fileinfo['error'],
 575                           E_USER_ERROR);
 576             return false;
 577         }
 578
 579         // With windows/php 4.2.1 is_uploaded_file() always returns false.
 580         if (!is_uploaded_file($fileinfo['tmp_name'])) {
 581             if (isWindows()) {
 582                 if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
 583                     $tmp_file = dirname(tempnam('', ''));
 584                 }
 585                 $tmp_file .= '/' . basename($fileinfo['tmp_name']);
 586                 /* but ending slash in php.ini upload_tmp_dir is required. */
 587                 if (ereg_replace('/+', '/', $tmp_file) != $fileinfo['tmp_name']) {
 588                     trigger_error(sprintf("Uploaded tmpfile illegal: %s != %s",$tmp_file, $fileinfo['tmp_name']),
 589                                   E_USER_ERROR);
 590                     return false;
 591                 } else {
 592                     trigger_error(sprintf("Workaround for PHP/Windows is_uploaded_file() problem for %s.",
 593                                           $fileinfo['tmp_name'])."\n".
 594                                   "Probably illegal TEMP environment setting.",E_USER_NOTICE);
 595                 }
 596             } else {
 597               trigger_error(sprintf("Uploaded tmpfile %s not found.",$fileinfo['tmp_name'])."\n".
 598                            " Probably illegal TEMP environment setting.",
 599                           E_USER_WARNING);
 600             }
 601         }
 602         return new Request_UploadedFile($fileinfo);
 603     }
 604
 605     function Request_UploadedFile($fileinfo) {
 606         $this->_info = $fileinfo;
 607     }
 608
 609     function getSize() {
 610         return $this->_info['size'];
 611     }
 612
 613     function getName() {
 614         return $this->_info['name'];
 615     }
 616
 617     function getType() {
 618         return $this->_info['type'];
 619     }
 620
 621     function getTmpName() {
 622         return $this->_info['tmp_name'];
 623     }
 624
 625     function open() {
 626         if ( ($fd = fopen($this->_info['tmp_name'], "rb")) ) {
 627             if ($this->getSize() < filesize($this->_info['tmp_name'])) {
 628                 // FIXME: Some PHP's (or is it some browsers?) put
 629                 //    HTTP/MIME headers in the file body, some don't.
 630                 //
 631                 // At least, I think that's the case.  I know I used
 632                 // to need this code, now I don't.
 633                 //
 634                 // This code is more-or-less untested currently.
 635                 //
 636                 // Dump HTTP headers.
 637                 while ( ($header = fgets($fd, 4096)) ) {
 638                     if (trim($header) == '') {
 639                         break;
 640                     }
 641                     else if (!preg_match('/^content-(length|type):/i', $header)) {
 642                         rewind($fd);
 643                         break;
 644                     }
 645                 }
 646             }
 647         }
 648         return $fd;
 649     }
 650
 651     function getContents() {
 652         $fd = $this->open();
 653         $data = fread($fd, $this->getSize());
 654         fclose($fd);
 655         return $data;
 656     }
 657 }
 658
 659 /**
 660  * Create NCSA "combined" log entry for current request.
 661  */
 662 class Request_AccessLogEntry
 663 {
 664     /**
 665      * Constructor.
 666      *
 667      * The log entry will be automatically appended to the log file
 668      * when the current request terminates.
 669      *
 670      * If you want to modify a Request_AccessLogEntry before it gets
 671      * written (e.g. via the setStatus and setSize methods) you should
 672      * use an '&' on the constructor, so that you're working with the
 673      * original (rather than a copy) object.
 674      *
 675      * <pre>
 676      *    $log_entry = & new Request_AccessLogEntry($req, "/tmp/wiki_access_log");
 677      *    $log_entry->setStatus(401);
 678      * </pre>
 679      *
 680      *
 681      * @param $request object  Request object for current request.
 682      * @param $logfile string  Log file name.
 683      */
 684     function Request_AccessLogEntry (&$request, $logfile) {
 685         $this->logfile = $logfile;
 686
 687         $this->host  = $request->get('REMOTE_HOST');
 688         $this->ident = $request->get('REMOTE_IDENT');
 689         if (!$this->ident)
 690             $this->ident = '-';
 691         $this->user = '-';        // FIXME: get logged-in user name
 692         $this->time = time();
 693         $this->request = join(' ', array($request->get('REQUEST_METHOD'),
 694                                          $request->get('REQUEST_URI'),
 695                                          $request->get('SERVER_PROTOCOL')));
 696         $this->status = 200;
 697         $this->size = 0;
 698         $this->referer = (string) $request->get('HTTP_REFERER');
 699         $this->user_agent = (string) $request->get('HTTP_USER_AGENT');
 700
 701         global $Request_AccessLogEntry_entries;
 702         if (!isset($Request_AccessLogEntry_entries)) {
 703             register_shutdown_function("Request_AccessLogEntry_shutdown_function");
 704         }
 705         $Request_AccessLogEntry_entries[] = &$this;
 706     }
 707
 708     /**
 709      * Set result status code.
 710      *
 711      * @param $status integer  HTTP status code.
 712      */
 713     function setStatus ($status) {
 714         $this->status = $status;
 715     }
 716
 717     /**
 718      * Set response size.
 719      *
 720      * @param $size integer
 721      */
 722     function setSize ($size) {
 723         $this->size = $size;
 724     }
 725
 726     /**
 727      * Get time zone offset.
 728      *
 729      * This is a static member function.
 730      *
 731      * @param $time integer Unix timestamp (defaults to current time).
 732      * @return string Zone offset, e.g. "-0800" for PST.
 733      */
 734     function _zone_offset ($time = false) {
 735         if (!$time)
 736             $time = time();
 737         $offset = date("Z", $time);
 738         $negoffset = "";
 739         if ($offset < 0) {
 740             $negoffset = "-";
 741             $offset = -$offset;
 742         }
 743         $offhours = floor($offset / 3600);
 744         $offmins  = $offset / 60 - $offhours * 60;
 745         return sprintf("%s%02d%02d", $negoffset, $offhours, $offmins);
 746     }
 747
 748     /**
 749      * Format time in NCSA format.
 750      *
 751      * This is a static member function.
 752      *
 753      * @param $time integer Unix timestamp (defaults to current time).
 754      * @return string Formatted date & time.
 755      */
 756     function _ncsa_time($time = false) {
 757         if (!$time)
 758             $time = time();
 759
 760         return date("d/M/Y:H:i:s", $time) .
 761             " " . $this->_zone_offset();
 762     }
 763
 764     /**
 765      * Write entry to log file.
 766      */
 767     function write() {
 768         $entry = sprintf('%s %s %s [%s] "%s" %d %d "%s" "%s"',
 769                          $this->host, $this->ident, $this->user,
 770                          $this->_ncsa_time($this->time),
 771                          $this->request, $this->status, $this->size,
 772                          $this->referer, $this->user_agent);
 773
 774         //Error log doesn't provide locking.
 775         //error_log("$entry\n", 3, $this->logfile);
 776
 777         // Alternate method
 778         if (($fp = fopen($this->logfile, "a"))) {
 779             flock($fp, LOCK_EX);
 780             fputs($fp, "$entry\n");
 781             fclose($fp);
 782         }
 783     }
 784 }
 785
 786 /**
 787  * Shutdown callback.
 788  *
 789  * @access private
 790  * @see Request_AccessLogEntry
 791  */
 792 function Request_AccessLogEntry_shutdown_function ()
 793 {
 794     global $Request_AccessLogEntry_entries;
 795
 796     foreach ($Request_AccessLogEntry_entries as $entry) {
 797         $entry->write();
 798     }
 799     unset($Request_AccessLogEntry_entries);
 800 }
 801
 802
 803 class HTTP_ETag {
 804     function HTTP_ETag($val, $is_weak=false) {
 805         $this->_val = hash($val);
 806         $this->_weak = $is_weak;
 807     }
 808
 809     /** Comparison
 810      *
 811      * Strong comparison: If either (or both) tag is weak, they
 812      *  are not equal.
 813      */
 814     function equals($that, $strong_match=false) {
 815         if ($this->_val != $that->_val)
 816             return false;
 817         if ($strong_match and ($this->_weak or $that->_weak))
 818             return false;
 819         return true;
 820     }
 821
 822
 823     function asString() {
 824         $quoted = '"' . addslashes($this->_val) . '"';
 825         return $this->_weak ? "W/$quoted" : $quoted;
 826     }
 827
 828     /** Parse tag from header.
 829      *
 830      * This is a static member function.
 831      */
 832     function parse($strval) {
 833         if (!preg_match(':^(W/)?"(.+)"$:i', trim($strval), $m))
 834             return false;       // parse failed
 835         list(,$weak,$str) = $m;
 836         return new HTTP_ETag(stripslashes($str), $weak);
 837     }
 838
 839     function matches($taglist, $strong_match=false) {
 840         $taglist = trim($taglist);
 841
 842         if ($taglist == '*') {
 843             if ($strong_match)
 844                 return ! $this->_weak;
 845             else
 846                 return true;
 847         }
 848
 849         while (preg_match('@^(W/)?"((?:\\\\.|[^"])*)"\s*,?\s*@i',
 850                           $taglist, $m)) {
 851             list($match, $weak, $str) = $m;
 852             $taglist = substr($taglist, strlen($match));
 853             $tag = new HTTP_ETag(stripslashes($str), $weak);
 854             if ($this->equals($tag, $strong_match)) {
 855                 return true;
 856             }
 857         }
 858         return false;
 859     }
 860 }
 861
 862 // Possible results from the HTTP_ValidatorSet::_check*() methods.
 863 // (Higher numerical values take precedence.)
 864 define ('_HTTP_VAL_PASS', 0);   // Test is irrelevant
 865 define ('_HTTP_VAL_NOT_MODIFIED', 1); // Test passed, content not changed
 866 define ('_HTTP_VAL_MODIFIED', 2); // Test failed, content changed
 867 define ('_HTTP_VAL_FAILED', 3); // Precondition failed.
 868
 869 class HTTP_ValidatorSet {
 870     function HTTP_ValidatorSet($validators) {
 871         $this->_mtime = $this->_weak = false;
 872         $this->_tag = array();
 873
 874         foreach ($validators as $key => $val) {
 875             if ($key == '%mtime') {
 876                 $this->_mtime = $val;
 877             }
 878             elseif ($key == '%weak') {
 879                 if ($val)
 880                     $this->_weak = true;
 881             }
 882             else {
 883                 $this->_tag[$key] = $val;
 884             }
 885         }
 886     }
 887
 888     function append($that) {
 889         if (is_array($that))
 890             $that = new HTTP_ValidatorSet($that);
 891
 892         // Pick the most recent mtime
 893         if (isset($that->_mtime))
 894             if (!isset($this->_mtime) || $that->_mtime > $this->_mtime)
 895                 $this->_mtime = $that->_mtime;
 896
 897         // If either is weak, we're weak
 898         if (!empty($that->_weak))
 899             $this->_weak = true;
 900
 901         $this->_tag = array_merge($this->_tag, $that->_tag);
 902     }
 903
 904     function getETag() {
 905         if (! $this->_tag)
 906             return false;
 907         return new HTTP_ETag($this->_tag, $this->_weak);
 908     }
 909
 910     function getModificationTime() {
 911         return $this->_mtime;
 912     }
 913
 914     function checkConditionalRequest (&$request) {
 915         $result = max($this->_checkIfUnmodifiedSince($request),
 916                       $this->_checkIfModifiedSince($request),
 917                       $this->_checkIfMatch($request),
 918                       $this->_checkIfNoneMatch($request));
 919
 920         if ($result == _HTTP_VAL_PASS || $result == _HTTP_VAL_MODIFIED)
 921             return false;       // "please proceed with normal processing"
 922         elseif ($result == _HTTP_VAL_FAILED)
 923             return 412;         // "412 Precondition Failed"
 924         elseif ($result == _HTTP_VAL_NOT_MODIFIED)
 925             return 304;         // "304 Not Modified"
 926
 927         trigger_error("Ack, shouldn't get here", E_USER_ERROR);
 928         return false;
 929     }
 930
 931     function _checkIfUnmodifiedSince(&$request) {
 932         if ($this->_mtime !== false) {
 933             $since = ParseRfc1123DateTime($request->get("HTTP_IF_UNMODIFIED_SINCE"));
 934             if ($since !== false && $this->_mtime > $since)
 935                 return _HTTP_VAL_FAILED;
 936         }
 937         return _HTTP_VAL_PASS;
 938     }
 939
 940     function _checkIfModifiedSince(&$request) {
 941         if ($this->_mtime !== false and $request->isGetOrHead()) {
 942             $since = ParseRfc1123DateTime($request->get("HTTP_IF_MODIFIED_SINCE"));
 943             if ($since !== false) {
 944                 if ($this->_mtime <= $since)
 945                     return _HTTP_VAL_NOT_MODIFIED;
 946                 return _HTTP_VAL_MODIFIED;
 947             }
 948         }
 949         return _HTTP_VAL_PASS;
 950     }
 951
 952     function _checkIfMatch(&$request) {
 953         if ($this->_tag && ($taglist = $request->get("HTTP_IF_MATCH"))) {
 954             $tag = $this->getETag();
 955             if (!$tag->matches($taglist, 'strong'))
 956                 return _HTTP_VAL_FAILED;
 957         }
 958         return _HTTP_VAL_PASS;
 959     }
 960
 961     function _checkIfNoneMatch(&$request) {
 962         if ($this->_tag && ($taglist = $request->get("HTTP_IF_NONE_MATCH"))) {
 963             $tag = $this->getETag();
 964             $strong_compare = ! $request->isGetOrHead();
 965             if ($taglist) {
 966                 if ($tag->matches($taglist, $strong_compare)) {
 967                     if ($request->isGetOrHead())
 968                         return _HTTP_VAL_NOT_MODIFIED;
 969                     else
 970                         return _HTTP_VAL_FAILED;
 971                 }
 972                 return _HTTP_VAL_MODIFIED;
 973             }
 974         }
 975         return _HTTP_VAL_PASS;
 976     }
 977 }
 978
 979
 980 // $Log: not supported by cvs2svn $
 981 // Revision 1.52  2004/05/03 13:16:47  rurban
 982 // fixed UserPreferences update, esp for boolean and int
 983 //
 984 // Revision 1.51  2004/05/02 21:26:38  rurban
 985 // limit user session data (HomePageHandle and auth_dbi have to invalidated anyway)
 986 //   because they will not survive db sessions, if too large.
 987 // extended action=upgrade
 988 // some WikiTranslation button work
 989 // revert WIKIAUTH_UNOBTAINABLE (need it for main.php)
 990 // some temp. session debug statements
 991 //
 992 // Revision 1.50  2004/04/29 19:39:44  rurban
 993 // special support for formatted plugins (one-liners)
 994 //   like <small><plugin BlaBla ></small>
 995 // iter->asArray() helper for PopularNearby
 996 // db_session for older php's (no &func() allowed)
 997 //
 998 // Revision 1.49  2004/04/26 20:44:34  rurban
 999 // locking table specific for better databases
1000 //
1001 // Revision 1.48  2004/04/13 09:13:50  rurban
1002 // sf.net bug #933183 and http://bugs.php.net/17557
1003 // disable ob_gzhandler if apache_note cannot be used.
1004 //   (conservative until we find why)
1005 //
1006 // Revision 1.47  2004/04/02 15:06:55  rurban
1007 // fixed a nasty ADODB_mysql session update bug
1008 // improved UserPreferences layout (tabled hints)
1009 // fixed UserPreferences auth handling
1010 // improved auth stability
1011 // improved old cookie handling: fixed deletion of old cookies with paths
1012 //
1013 // Revision 1.46  2004/03/30 02:14:03  rurban
1014 // fixed yet another Prefs bug
1015 // added generic PearDb_iter
1016 // $request->appendValidators no so strict as before
1017 // added some box plugin methods
1018 // PageList commalist for condensed output
1019 //
1020 // Revision 1.45  2004/03/24 19:39:02  rurban
1021 // php5 workaround code (plus some interim debugging code in XmlElement)
1022 //   php5 doesn't work yet with the current XmlElement class constructors,
1023 //   WikiUserNew does work better than php4.
1024 // rewrote WikiUserNew user upgrading to ease php5 update
1025 // fixed pref handling in WikiUserNew
1026 // added Email Notification
1027 // added simple Email verification
1028 // removed emailVerify userpref subclass: just a email property
1029 // changed pref binary storage layout: numarray => hash of non default values
1030 // print optimize message only if really done.
1031 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
1032 //   prefs should be stored in db or homepage, besides the current session.
1033 //
1034 // Revision 1.44  2004/03/14 16:26:22  rurban
1035 // copyright line
1036 //
1037 // Revision 1.43  2004/03/12 20:59:17  rurban
1038 // important cookie fix by Konstantin Zadorozhny
1039 // new editpage feature: JS_SEARCHREPLACE
1040 //
1041 // Revision 1.42  2004/03/10 15:38:48  rurban
1042 // store current user->page and ->action in session for WhoIsOnline
1043 // better WhoIsOnline icon
1044 // fixed WhoIsOnline warnings
1045 //
1046 // Revision 1.41  2004/02/27 01:25:14  rurban
1047 // Workarounds for upload handling
1048 //
1049 // Revision 1.40  2004/02/26 01:39:51  rurban
1050 // safer code
1051 //
1052 // Revision 1.39  2004/02/24 15:14:57  rurban
1053 // fixed action=upload problems on Win32, and remove Merge Edit buttons: file does not exist anymore
1054 //
1055 // Revision 1.38  2004/01/25 10:26:02  rurban
1056 // fixed bug [ 541193 ] HTTP_SERVER_VARS are Apache specific
1057 // http://sourceforge.net/tracker/index.php?func=detail&aid=541193&group_id=6121&atid=106121
1058 // CGI and other servers than apache populate _ENV and not _SERVER
1059 //
1060 // Revision 1.37  2003/12/26 06:41:16  carstenklapp
1061 // Bugfix: Try to defer OS errors about session.save_path and ACCESS_LOG,
1062 // so they don't prevent IE from partially (or not at all) rendering the
1063 // page. This should help a little for the IE user who encounters trouble
1064 // when setting up a new PhpWiki for the first time.
1065 //
1066
1067 // Local Variables:
1068 // mode: php
1069 // tab-width: 8
1070 // c-basic-offset: 4
1071 // c-hanging-comment-ender-p: nil
1072 // indent-tabs-mode: nil
1073 // End:
1074 ?>