lib/Request.php

   1 <?php rcs_id('$Id: Request.php,v 1.10 2002-01-28 20:02:14 dairiki Exp $');
   2
   3 // FIXME: write log entry.
   4
   5 class Request {
   6
   7     function Request() {
   8         $this->_fix_magic_quotes_gpc();
   9         $this->_fix_multipart_form_data();
  10
  11         switch($this->get('REQUEST_METHOD')) {
  12         case 'GET':
  13         case 'HEAD':
  14             $this->args = &$GLOBALS['HTTP_GET_VARS'];
  15             break;
  16         case 'POST':
  17             $this->args = &$GLOBALS['HTTP_POST_VARS'];
  18             break;
  19         default:
  20             $this->args = array();
  21             break;
  22         }
  23
  24         $this->session = new Request_SessionVars;
  25         $this->cookies = new Request_CookieVars;
  26
  27         if (ACCESS_LOG)
  28             $this->_log_entry = & new Request_AccessLogEntry($this,
  29                                                              ACCESS_LOG);
  30
  31         $TheRequest = $this;
  32     }
  33
  34     function get($key) {
  35         $vars = &$GLOBALS['HTTP_SERVER_VARS'];
  36
  37         if (isset($vars[$key]))
  38             return $vars[$key];
  39
  40         switch ($key) {
  41         case 'REMOTE_HOST':
  42             $addr = $vars['REMOTE_ADDR'];
  43             if (defined('ENABLE_REVERSE_DNS') && ENABLE_REVERSE_DNS)
  44                 return $vars[$key] = gethostbyaddr($addr);
  45             else
  46                 return $addr;
  47         default:
  48             return false;
  49         }
  50     }
  51
  52     function getArg($key) {
  53         if (isset($this->args[$key]))
  54             return $this->args[$key];
  55         return false;
  56     }
  57
  58     function getArgs () {
  59         return $this->args;
  60     }
  61
  62     function setArg($key, $val) {
  63         if ($val === false)
  64             unset($this->args[$key]);
  65         else
  66             $this->args[$key] = $val;
  67     }
  68
  69
  70     function getURLtoSelf($args = false) {
  71         $get_args = $this->args;
  72         if ($args)
  73             $get_args = array_merge($get_args, $args);
  74
  75         $pagename = $get_args['pagename'];
  76         unset ($get_args['pagename']);
  77         if ($get_args['action'] == 'browse')
  78             unset($get_args['action']);
  79
  80         return WikiURL($pagename, $get_args);
  81     }
  82
  83
  84     function isPost () {
  85         return $this->get("REQUEST_METHOD") == "POST";
  86     }
  87
  88     function redirect($url) {
  89         header("Location: $url");
  90         if (isset($this->_log_entry))
  91             $this->_log_entry->setStatus(302);
  92     }
  93
  94     function setStatus($status) {
  95         if (preg_match('|^HTTP/.*?\s(\d+)|i', $status, $m)) {
  96             header($status);
  97             $status = $m[1];
  98         }
  99         else {
 100             $status = (integer) $status;
 101             $reasons = array('200' => 'OK',
 102                              '302' => 'Found',
 103                              '400' => 'Bad Request',
 104                              '401' => 'Unauthorized',
 105                              '403' => 'Forbidden',
 106                              '404' => 'Not Found');
 107             header(sprintf("HTTP/1.0 %d %s", $status, $reason[$status]));
 108         }
 109
 110         if (isset($this->_log_entry))
 111             $this->_log_entry->setStatus($status);
 112     }
 113
 114     function compress_output() {
 115         if (function_exists('ob_gzhandler')) {
 116             ob_start('ob_gzhandler');
 117             $this->_is_compressing_output = true;
 118         }
 119     }
 120
 121     function finish() {
 122         if (!empty($this->_is_compressing_output))
 123             ob_end_flush();
 124     }
 125
 126
 127     function getSessionVar($key) {
 128         return $this->session->get($key);
 129     }
 130     function setSessionVar($key, $val) {
 131         return $this->session->set($key, $val);
 132     }
 133     function deleteSessionVar($key) {
 134         return $this->session->delete($key);
 135     }
 136
 137     function getCookieVar($key) {
 138         return $this->cookies->get($key);
 139     }
 140     function setCookieVar($key, $val, $lifetime_in_days = false) {
 141         return $this->cookies->set($key, $val, $lifetime_in_days);
 142     }
 143     function deleteCookieVar($key) {
 144         return $this->cookies->delete($key);
 145     }
 146
 147     function getUploadedFile($key) {
 148         return Request_UploadedFile::getUploadedFile($key);
 149     }
 150
 151
 152     function _fix_magic_quotes_gpc() {
 153         $needs_fix = array('HTTP_POST_VARS',
 154                            'HTTP_GET_VARS',
 155                            'HTTP_COOKIE_VARS',
 156                            'HTTP_SERVER_VARS',
 157                            'HTTP_POST_FILES');
 158
 159         // Fix magic quotes.
 160         if (get_magic_quotes_gpc()) {
 161             foreach ($needs_fix as $vars)
 162                 $this->_stripslashes($GLOBALS[$vars]);
 163         }
 164     }
 165
 166
 167     function _stripslashes(&$var) {
 168         if (is_array($var)) {
 169             foreach ($var as $key => $val)
 170                 $this->_stripslashes($var[$key]);
 171         }
 172         elseif (is_string($var))
 173             $var = stripslashes($var);
 174     }
 175
 176     function _fix_multipart_form_data () {
 177         if (preg_match('|^multipart/form-data|', $this->get('CONTENT_TYPE')))
 178             $this->_strip_leading_nl($GLOBALS['HTTP_POST_VARS']);
 179     }
 180
 181     function _strip_leading_nl(&$var) {
 182         if (is_array($var)) {
 183             foreach ($var as $key => $val)
 184                 $this->_strip_leading_nl($var[$key]);
 185         }
 186         elseif (is_string($var))
 187             $var = preg_replace('|^\r?\n?|', '', $var);
 188     }
 189 }
 190
 191 class Request_SessionVars {
 192     function Request_SessionVars() {
 193         session_start();
 194     }
 195
 196     function get($key) {
 197         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 198         if (isset($vars[$key]))
 199             return $vars[$key];
 200         return false;
 201     }
 202
 203     function set($key, $val) {
 204         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 205         if (ini_get('register_globals')) {
 206             // This is funky but necessary, at least in some PHP's
 207             $GLOBALS[$key] = $val;
 208         }
 209         $vars[$key] = $val;
 210         session_register($key);
 211     }
 212
 213     function delete($key) {
 214         $vars = &$GLOBALS['HTTP_SESSION_VARS'];
 215         if (ini_get('register_globals'))
 216             unset($GLOBALS[$key]);
 217         unset($vars[$key]);
 218         session_unregister($key);
 219     }
 220 }
 221
 222 class Request_CookieVars {
 223
 224     function get($key) {
 225         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 226         if (isset($vars[$key])) {
 227             @$val = unserialize($vars[$key]);
 228             if (!empty($val))
 229                 return $val;
 230         }
 231         return false;
 232     }
 233
 234     function set($key, $val, $persist_days = false) {
 235         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 236
 237         if (is_numeric($persist_days)) {
 238             $expires = time() + (24 * 3600) * $persist_days;
 239         }
 240         else {
 241             $expires = 0;
 242         }
 243
 244         $packedval = serialize($val);
 245         $vars[$key] = $packedval;
 246         setcookie($key, $packedval, $expires, '/');
 247     }
 248
 249     function delete($key) {
 250         $vars = &$GLOBALS['HTTP_COOKIE_VARS'];
 251         setcookie($key);
 252         unset($vars[$key]);
 253     }
 254 }
 255
 256 class Request_UploadedFile {
 257     function getUploadedFile($postname) {
 258         global $HTTP_POST_FILES;
 259
 260         if (!isset($HTTP_POST_FILES[$postname]))
 261             return false;
 262
 263         $fileinfo = &$HTTP_POST_FILES[$postname];
 264         if (!is_uploaded_file($fileinfo['tmp_name']))
 265             return false;       // possible malicious attack.
 266
 267         return new Request_UploadedFile($fileinfo);
 268     }
 269
 270     function Request_UploadedFile($fileinfo) {
 271         $this->_info = $fileinfo;
 272     }
 273
 274     function getSize() {
 275         return $this->_info['size'];
 276     }
 277
 278     function getName() {
 279         return $this->_info['name'];
 280     }
 281
 282     function getType() {
 283         return $this->_info['type'];
 284     }
 285
 286     function open() {
 287         if ( ($fd = fopen($this->_info['tmp_name'], "rb")) ) {
 288             if ($this->getSize() < filesize($this->_info['tmp_name'])) {
 289                 // FIXME: Some PHP's (or is it some browsers?) put
 290                 //    HTTP/MIME headers in the file body, some don't.
 291                 //
 292                 // At least, I think that's the case.  I know I used
 293                 // to need this code, now I don't.
 294                 //
 295                 // This code is more-or-less untested currently.
 296                 //
 297                 // Dump HTTP headers.
 298                 while ( ($header = fgets($fd, 4096)) ) {
 299                     if (trim($header) == '') {
 300                         break;
 301                     }
 302                     else if (!preg_match('/^content-(length|type):/i', $header)) {
 303                         rewind($fd);
 304                         break;
 305                     }
 306                 }
 307             }
 308         }
 309         return $fd;
 310     }
 311
 312     function getContents() {
 313         $fd = $this->open();
 314         $data = fread($fd, $this->getSize());
 315         fclose($fd);
 316         return $data;
 317     }
 318 }
 319
 320 /**
 321  * Create NCSA "combined" log entry for current request.
 322  */
 323 class Request_AccessLogEntry
 324 {
 325     /**
 326      * Constructor.
 327      *
 328      * The log entry will be automatically appended to the log file
 329      * when the current request terminates.
 330      *
 331      * If you want to modify a Request_AccessLogEntry before it gets
 332      * written (e.g. via the setStatus and setSize methods) you should
 333      * use an '&' on the constructor, so that you're working with the
 334      * original (rather than a copy) object.
 335      *
 336      * <pre>
 337      *    $log_entry = & new Request_AccessLogEntry($req, "/tmp/wiki_access_log");
 338      *    $log_entry->setStatus(401);
 339      * </pre>
 340      *
 341      *
 342      * @param $request object  Request object for current request.
 343      * @param $logfile string  Log file name.
 344      */
 345     function Request_AccessLogEntry (&$request, $logfile) {
 346         $this->logfile = $logfile;
 347
 348         $this->host  = $request->get('REMOTE_HOST');
 349         $this->ident = $request->get('REMOTE_IDENT');
 350         if (!$this->ident)
 351             $this->ident = '-';
 352         $this->user = '-';        // FIXME: get logged-in user name
 353         $this->time = time();
 354         $this->request = join(' ', array($request->get('REQUEST_METHOD'),
 355                                          $request->get('REQUEST_URI'),
 356                                          $request->get('SERVER_PROTOCOL')));
 357         $this->status = 200;
 358         $this->size = 0;
 359         $this->referer = (string) $request->get('HTTP_REFERER');
 360         $this->user_agent = (string) $request->get('HTTP_USER_AGENT');
 361
 362         global $Request_AccessLogEntry_entries;
 363         if (!isset($Request_AccessLogEntry_entries)) {
 364             register_shutdown_function("Request_AccessLogEntry_shutdown_function");
 365         }
 366         $Request_AccessLogEntry_entries[] = &$this;
 367     }
 368
 369     /**
 370      * Set result status code.
 371      *
 372      * @param $status integer  HTTP status code.
 373      */
 374     function setStatus ($status) {
 375         $this->status = $status;
 376     }
 377
 378     /**
 379      * Set response size.
 380      *
 381      * @param $size integer
 382      */
 383     function setSize ($size) {
 384         $this->size = $size;
 385     }
 386
 387     /**
 388      * Get time zone offset.
 389      *
 390      * This is a static member function.
 391      *
 392      * @param $time integer Unix timestamp (defaults to current time).
 393      * @return string Zone offset, e.g. "-0800" for PST.
 394      */
 395     function _zone_offset ($time = false) {
 396         if (!$time)
 397             $time = time();
 398         $offset = date("Z", $time);
 399         if ($offset < 0) {
 400             $negoffset = "-";
 401             $offset = -$offset;
 402         }
 403         $offhours = floor($offset / 3600);
 404         $offmins  = $offset / 60 - $offhours * 60;
 405         return sprintf("%s%02d%02d", $negoffset, $offhours, $offmins);
 406     }
 407
 408     /**
 409      * Format time in NCSA format.
 410      *
 411      * This is a static member function.
 412      *
 413      * @param $time integer Unix timestamp (defaults to current time).
 414      * @return string Formatted date & time.
 415      */
 416     function _ncsa_time($time = false) {
 417         if (!$time)
 418             $time = time();
 419
 420         return date("d/M/Y:H:i:s", $time) .
 421             " " . $this->_zone_offset();
 422     }
 423
 424     /**
 425      * Write entry to log file.
 426      */
 427     function write() {
 428         $entry = sprintf('%s %s %s [%s] "%s" %d %d "%s" "%s"',
 429                          $this->host, $this->ident, $this->user,
 430                          $this->_ncsa_time($this->time),
 431                          $this->request, $this->status, $this->size,
 432                          $this->referer, $this->user_agent);
 433
 434         //Error log doesn't provide locking.
 435         //error_log("$entry\n", 3, $this->logfile);
 436
 437         // Alternate method
 438         if (($fp = fopen($this->logfile, "a"))) {
 439             flock($fp, LOCK_EX);
 440             fputs($fp, "$entry\n");
 441             fclose($fp);
 442         }
 443     }
 444 }
 445
 446 /**
 447  * Shutdown callback.
 448  *
 449  * @access private
 450  * @see Request_AccessLogEntry
 451  */
 452 function Request_AccessLogEntry_shutdown_function ()
 453 {
 454     global $Request_AccessLogEntry_entries;
 455
 456     foreach ($Request_AccessLogEntry_entries as $entry) {
 457         $entry->write();
 458     }
 459     unset($Request_AccessLogEntry_entries);
 460 }
 461
 462 // Local Variables:
 463 // mode: php
 464 // tab-width: 8
 465 // c-basic-offset: 4
 466 // c-hanging-comment-ender-p: nil
 467 // indent-tabs-mode: nil
 468 // End:
 469 ?>