includes/WebRequest.php

   1 <?php
   2 /**
   3  * Deal with importing all those nasssty globals and things
   4  * @package MediaWiki
   5  */
   6
   7 # Copyright (C) 2003 Brion Vibber <brion@pobox.com>
   8 # http://www.mediawiki.org/
   9 #
  10 # This program is free software; you can redistribute it and/or modify
  11 # it under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 2 of the License, or
  13 # (at your option) any later version.
  14 #
  15 # This program is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18 # GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License along
  21 # with this program; if not, write to the Free Software Foundation, Inc.,
  22 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23 # http://www.gnu.org/copyleft/gpl.html
  24
  25 /**
  26  * The WebRequest class encapsulates getting at data passed in the
  27  * URL or via a POSTed form, handling remove of "magic quotes" slashes,
  28  * stripping illegal input characters and normalizing Unicode sequences.
  29  *
  30  * Usually this is used via a global singleton, $wgRequest. You should
  31  * not create a second WebRequest object; make a FauxRequest object if
  32  * you want to pass arbitrary data to some function in place of the web
  33  * input.
  34  *
  35  * @package MediaWiki
  36  */
  37 class WebRequest {
  38         function WebRequest() {
  39                 $this->checkMagicQuotes();
  40                 global $wgUsePathInfo;
  41                 if( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != '') && $wgUsePathInfo ) {
  42                         # Stuff it!
  43                         $_GET['title'] = $_REQUEST['title'] =
  44                                 substr( $_SERVER['PATH_INFO'], 1 );
  45                 }
  46         }
  47
  48         /**
  49          * Recursively strips slashes from the given array;
  50          * used for undoing the evil that is magic_quotes_gpc.
  51          * @param array &$arr will be modified
  52          * @return array the original array
  53          * @private
  54          */
  55         function &fix_magic_quotes( &$arr ) {
  56                 foreach( $arr as $key => $val ) {
  57                         if( is_array( $val ) ) {
  58                                 $this->fix_magic_quotes( $arr[$key] );
  59                         } else {
  60                                 $arr[$key] = stripslashes( $val );
  61                         }
  62                 }
  63                 return $arr;
  64         }
  65
  66         /**
  67          * If magic_quotes_gpc option is on, run the global arrays
  68          * through fix_magic_quotes to strip out the stupid dlashes.
  69          * WARNING: This should only be done once! Running a second
  70          * time could damage the values.
  71          * @private
  72          */
  73         function checkMagicQuotes() {
  74                 if ( get_magic_quotes_gpc() ) {
  75                         $this->fix_magic_quotes( $_COOKIE );
  76                         $this->fix_magic_quotes( $_ENV );
  77                         $this->fix_magic_quotes( $_GET );
  78                         $this->fix_magic_quotes( $_POST );
  79                         $this->fix_magic_quotes( $_REQUEST );
  80                         $this->fix_magic_quotes( $_SERVER );
  81                 }
  82         }
  83
  84         /**
  85          * Recursively normalizes UTF-8 strings in the given array.
  86          * @param array $data string or array
  87          * @return cleaned-up version of the given
  88          * @private
  89          */
  90         function normalizeUnicode( $data ) {
  91                 if( is_array( $data ) ) {
  92                         foreach( $data as $key => $val ) {
  93                                 $data[$key] = $this->normalizeUnicode( $val );
  94                         }
  95                 } else {
  96                         $data = UtfNormal::cleanUp( $data );
  97                 }
  98                 return $data;
  99         }
 100
 101         /**
 102          * Fetch a value from the given array or return $default if it's not set.
 103          *
 104          * @param array &$arr
 105          * @param string $name
 106          * @param mixed $default
 107          * @return mixed
 108          * @private
 109          */
 110         function getGPCVal( &$arr, $name, $default ) {
 111                 if( isset( $arr[$name] ) ) {
 112                         global $wgServer, $wgContLang;
 113                         $data = $arr[$name];
 114                         if( isset( $_GET[$name] ) &&
 115                                 !is_array( $data ) &&
 116                                 ( empty( $_SERVER['HTTP_REFERER'] ) ||
 117                                 strncmp($wgServer, $_SERVER['HTTP_REFERER'], strlen( $wgServer ) ) ) ) {
 118                                 # For links that came from outside, check for alternate/legacy
 119                                 # character encoding.
 120                                 if( isset( $wgContLang ) ) {
 121                                         $data = $wgContLang->checkTitleEncoding( $data );
 122                                 }
 123                         }
 124                         require_once( 'normal/UtfNormal.php' );
 125                         $data = $this->normalizeUnicode( $data );
 126                         return $data;
 127                 } else {
 128                         return $default;
 129                 }
 130         }
 131
 132         /**
 133          * Fetch a scalar from the input or return $default if it's not set.
 134          * Returns a string. Arrays are discarded.
 135          *
 136          * @param string $name
 137          * @param string $default optional default (or NULL)
 138          * @return string
 139          */
 140         function getVal( $name, $default = NULL ) {
 141                 $val = $this->getGPCVal( $_REQUEST, $name, $default );
 142                 if( is_array( $val ) ) {
 143                         $val = $default;
 144                 }
 145                 if( is_null( $val ) ) {
 146                         return null;
 147                 } else {
 148                         return (string)$val;
 149                 }
 150         }
 151
 152         /**
 153          * Fetch an array from the input or return $default if it's not set.
 154          * If source was scalar, will return an array with a single element.
 155          * If no source and no default, returns NULL.
 156          *
 157          * @param string $name
 158          * @param array $default optional default (or NULL)
 159          * @return array
 160          */
 161         function getArray( $name, $default = NULL ) {
 162                 $val = $this->getGPCVal( $_REQUEST, $name, $default );
 163                 if( is_null( $val ) ) {
 164                         return null;
 165                 } else {
 166                         return (array)$val;
 167                 }
 168         }
 169
 170         /**
 171          * Fetch an integer value from the input or return $default if not set.
 172          * Guaranteed to return an integer; non-numeric input will typically
 173          * return 0.
 174          * @param string $name
 175          * @param int $default
 176          * @return int
 177          */
 178         function getInt( $name, $default = 0 ) {
 179                 return IntVal( $this->getVal( $name, $default ) );
 180         }
 181
 182         /**
 183          * Fetch a boolean value from the input or return $default if not set.
 184          * Guaranteed to return true or false, with normal PHP semantics for
 185          * boolean interpretation of strings.
 186          * @param string $name
 187          * @param bool $default
 188          * @return bool
 189          */
 190         function getBool( $name, $default = false ) {
 191                 return $this->getVal( $name, $default ) ? true : false;
 192         }
 193
 194         /**
 195          * Return true if the named value is set in the input, whatever that
 196          * value is (even "0"). Return false if the named value is not set.
 197          * Example use is checking for the presence of check boxes in forms.
 198          * @param string $name
 199          * @return bool
 200          */
 201         function getCheck( $name ) {
 202                 # Checkboxes and buttons are only present when clicked
 203                 # Presence connotes truth, abscense false
 204                 $val = $this->getVal( $name, NULL );
 205                 return isset( $val );
 206         }
 207
 208         /**
 209          * Fetch a text string from the given array or return $default if it's not
 210          * set. \r is stripped from the text, and with some language modules there
 211          * is an input transliteration applied. This should generally be used for
 212          * form <textarea> and <input> fields.
 213          *
 214          * @param string $name
 215          * @param string $default optional
 216          * @return string
 217          */
 218         function getText( $name, $default = '' ) {
 219                 global $wgContLang;
 220                 $val = $this->getVal( $name, $default );
 221                 return str_replace( "\r\n", "\n",
 222                         $wgContLang->recodeInput( $val ) );
 223         }
 224
 225         /**
 226          * Extracts the given named values into an array.
 227          * If no arguments are given, returns all input values.
 228          * No transformation is performed on the values.
 229          */
 230         function getValues() {
 231                 $names = func_get_args();
 232                 if ( count( $names ) == 0 ) {
 233                         $names = array_keys( $_REQUEST );
 234                 }
 235
 236                 $retVal = array();
 237                 foreach ( $names as $name ) {
 238                         $value = $this->getVal( $name );
 239                         if ( !is_null( $value ) ) {
 240                                 $retVal[$name] = $value;
 241                         }
 242                 }
 243                 return $retVal;
 244         }
 245
 246         /**
 247          * Returns true if the present request was reached by a POST operation,
 248          * false otherwise (GET, HEAD, or command-line).
 249          *
 250          * Note that values retrieved by the object may come from the
 251          * GET URL etc even on a POST request.
 252          *
 253          * @return bool
 254          */
 255         function wasPosted() {
 256                 return $_SERVER['REQUEST_METHOD'] == 'POST';
 257         }
 258
 259         /**
 260          * Returns true if there is a session cookie set.
 261          * This does not necessarily mean that the user is logged in!
 262          *
 263          * @return bool
 264          */
 265         function checkSessionCookie() {
 266                 return isset( $_COOKIE[ini_get('session.name')] );
 267         }
 268
 269         /**
 270          * Return the path portion of the request URI.
 271          * @return string
 272          */
 273         function getRequestURL() {
 274                 return $_SERVER['REQUEST_URI'];
 275         }
 276
 277         /**
 278          * Return the request URI with the canonical service and hostname.
 279          * @return string
 280          */
 281         function getFullRequestURL() {
 282                 global $wgServer;
 283                 return $wgServer . $this->getRequestURL();
 284         }
 285
 286         /**
 287          * Take an arbitrary query and rewrite the present URL to include it
 288          * @param string $query Query string fragment; do not include initial '?'
 289          * @return string
 290          */
 291         function appendQuery( $query ) {
 292                 global $wgTitle;
 293                 $basequery = '';
 294                 foreach( $_GET as $var => $val ) {
 295                         if( $var == 'title' ) continue;
 296                         $basequery .= '&' . urlencode( $var ) . '=' . urlencode( $val );
 297                 }
 298                 $basequery .= '&' . $query;
 299
 300                 # Trim the extra &
 301                 $basequery = substr( $basequery, 1 );
 302                 return $wgTitle->getLocalURL( $basequery );
 303         }
 304
 305         /**
 306          * HTML-safe version of appendQuery().
 307          * @param string $query Query string fragment; do not include initial '?'
 308          * @return string
 309          */
 310         function escapeAppendQuery( $query ) {
 311                 return htmlspecialchars( $this->appendQuery( $query ) );
 312         }
 313
 314         /**
 315          * Check for limit and offset parameters on the input, and return sensible
 316          * defaults if not given. The limit must be positive and is capped at 5000.
 317          * Offset must be positive but is not capped.
 318          *
 319          * @param int $deflimit Limit to use if no input and the user hasn't set the option.
 320          * @param string $optionname To specify an option other than rclimit to pull from.
 321          * @return array first element is limit, second is offset
 322          */
 323         function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
 324                 global $wgUser;
 325
 326                 $limit = $this->getInt( 'limit', 0 );
 327                 if( $limit < 0 ) $limit = 0;
 328                 if( ( $limit == 0 ) && ( $optionname != '' ) ) {
 329                         $limit = (int)$wgUser->getOption( $optionname );
 330                 }
 331                 if( $limit <= 0 ) $limit = $deflimit;
 332                 if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
 333
 334                 $offset = $this->getInt( 'offset', 0 );
 335                 if( $offset < 0 ) $offset = 0;
 336
 337                 return array( $limit, $offset );
 338         }
 339
 340         /**
 341          * Return the path to the temporary file where PHP has stored the upload.
 342          * @param string $key
 343          * @return string or NULL if no such file.
 344          */
 345         function getFileTempname( $key ) {
 346                 if( !isset( $_FILES[$key] ) ) {
 347                         return NULL;
 348                 }
 349                 return $_FILES[$key]['tmp_name'];
 350         }
 351
 352         /**
 353          * Return the size of the upload, or 0.
 354          * @param string $key
 355          * @return integer
 356          */
 357         function getFileSize( $key ) {
 358                 if( !isset( $_FILES[$key] ) ) {
 359                         return 0;
 360                 }
 361                 return $_FILES[$key]['size'];
 362         }
 363
 364         /**
 365          * Return the original filename of the uploaded file, as reported by
 366          * the submitting user agent. HTML-style character entities are
 367          * interpreted and normalized to Unicode normalization form C, in part
 368          * to deal with weird input from Safari with non-ASCII filenames.
 369          *
 370          * Other than this the name is not verified for being a safe filename.
 371          *
 372          * @param string $key
 373          * @return string or NULL if no such file.
 374          */
 375         function getFileName( $key ) {
 376                 if( !isset( $_FILES[$key] ) ) {
 377                         return NULL;
 378                 }
 379                 $name = $_FILES[$key]['name'];
 380
 381                 # Safari sends filenames in HTML-encoded Unicode form D...
 382                 # Horrid and evil! Let's try to make some kind of sense of it.
 383                 $name = wfMungeToUtf8( $name );
 384                 $name = UtfNormal::cleanUp( $name );
 385                 wfDebug( "WebRequest::getFileName() '" . $_FILES[$key]['name'] . "' normalized to '$name'\n" );
 386                 return $name;
 387         }
 388 }
 389
 390 /**
 391  * WebRequest clone which takes values from a provided array.
 392  *
 393  * @package MediaWiki
 394  */
 395 class FauxRequest extends WebRequest {
 396         var $data = null;
 397         var $wasPosted = false;
 398
 399         function FauxRequest( $data, $wasPosted = false ) {
 400                 if( is_array( $data ) ) {
 401                         $this->data = $data;
 402                 } else {
 403                         wfDebugDieBacktrace( "FauxRequest() got bogus data" );
 404                 }
 405                 $this->wasPosted = $wasPosted;
 406         }
 407
 408         function getVal( $name, $default = NULL ) {
 409                 return $this->getGPCVal( $this->data, $name, $default );
 410         }
 411
 412         function getText( $name, $default = '' ) {
 413                 # Override; don't recode since we're using internal data
 414                 return $this->getVal( $name, $default );
 415         }
 416
 417         function getValues() {
 418                 return $this->data;
 419         }
 420
 421         function wasPosted() {
 422                 return $this->wasPosted;
 423         }
 424
 425         function checkSessionCookie() {
 426                 return false;
 427         }
 428
 429         function getRequestURL() {
 430                 wfDebugDieBacktrace( 'FauxRequest::getRequestURL() not implemented' );
 431         }
 432
 433         function appendQuery( $query ) {
 434                 wfDebugDieBacktrace( 'FauxRequest::appendQuery() not implemented' );
 435         }
 436
 437 }
 438
 439 ?>