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'] ) && $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          * @param array &$arr
 104          * @param string $name
 105          * @param mixed $default
 106          * @return mixed
 107          * @private
 108          */
 109         function getGPCVal( &$arr, $name, $default ) {
 110                 if( isset( $arr[$name] ) ) {
 111                         global $wgUseLatin1, $wgServer, $wgContLang;
 112                         $data = $arr[$name];
 113                         if( isset( $_GET[$name] ) &&
 114                                 !is_array( $data ) &&
 115                                 ( empty( $_SERVER['HTTP_REFERER'] ) ||
 116                                 strncmp($wgServer, $_SERVER['HTTP_REFERER'], strlen( $wgServer ) ) ) ) {
 117                                 # For links that came from outside, check for alternate/legacy
 118                                 # character encoding.
 119                                 if( isset( $wgContLang ) ) {
 120                                         $data = $wgContLang->checkTitleEncoding( $data );
 121                                 }
 122                         }
 123                         if( !$wgUseLatin1 ) {
 124                                 require_once( 'normal/UtfNormal.php' );
 125                                 $data = $this->normalizeUnicode( $data );
 126                         }
 127                         return $data;
 128                 } else {
 129                         return $default;
 130                 }
 131         }
 132
 133         /**
 134          * Fetch a scalar from the input or return $default if it's not set.
 135          * Returns a string. Arrays are discarded.
 136          *
 137          * @param string $name
 138          * @param string $default optional default (or NULL)
 139          * @return string
 140          */
 141         function getVal( $name, $default = NULL ) {
 142                 $val = $this->getGPCVal( $_REQUEST, $name, $default );
 143                 if( is_array( $val ) ) {
 144                         $val = $default;
 145                 }
 146                 if( is_null( $val ) ) {
 147                         return null;
 148                 } else {
 149                         return (string)$val;
 150                 }
 151         }
 152
 153         /**
 154          * Fetch an array from the input or return $default if it's not set.
 155          * If source was scalar, will return an array with a single element.
 156          * If no source and no default, returns NULL.
 157          *
 158          * @param string $name
 159          * @param array $default optional default (or NULL)
 160          * @return array
 161          */
 162         function getArray( $name, $default = NULL ) {
 163                 $val = $this->getGPCVal( $_REQUEST, $name, $default );
 164                 if( is_null( $val ) ) {
 165                         return null;
 166                 } else {
 167                         return (array)$val;
 168                 }
 169         }
 170
 171         /**
 172          * Fetch an integer value from the input or return $default if not set.
 173          * Guaranteed to return an integer; non-numeric input will typically
 174          * return 0.
 175          * @param string $name
 176          * @param int $default
 177          * @return int
 178          */
 179         function getInt( $name, $default = 0 ) {
 180                 return IntVal( $this->getVal( $name, $default ) );
 181         }
 182
 183         /**
 184          * Fetch a boolean value from the input or return $default if not set.
 185          * Guaranteed to return true or false, with normal PHP semantics for
 186          * boolean interpretation of strings.
 187          * @param string $name
 188          * @param bool $default
 189          * @return bool
 190          */
 191         function getBool( $name, $default = false ) {
 192                 return $this->getVal( $name, $default ) ? true : false;
 193         }
 194
 195         /**
 196          * Return true if the named value is set in the input, whatever that
 197          * value is (even "0"). Return false if the named value is not set.
 198          * Example use is checking for the presence of check boxes in forms.
 199          * @param string $name
 200          * @return bool
 201          */
 202         function getCheck( $name ) {
 203                 # Checkboxes and buttons are only present when clicked
 204                 # Presence connotes truth, abscense false
 205                 $val = $this->getVal( $name, NULL );
 206                 return isset( $val );
 207         }
 208
 209         /**
 210          * Fetch a text string from the given array or return $default if it's not
 211          * set. \r is stripped from the text, and with some language modules there
 212          * is an input transliteration applied. This should generally be used for
 213          * form <textarea> and <input> fields.
 214          *
 215          * @param string $name
 216          * @param string $default optional
 217          * @return string
 218          */
 219         function getText( $name, $default = '' ) {
 220                 global $wgContLang;
 221                 $val = $this->getVal( $name, $default );
 222                 return str_replace( "\r\n", "\n",
 223                         $wgContLang->recodeInput( $val ) );
 224         }
 225
 226         /**
 227          * Extracts the given named values into an array.
 228          * If no arguments are given, returns all input values.
 229          * No transformation is performed on the values.
 230          */
 231         function getValues() {
 232                 $names = func_get_args();
 233                 if ( count( $names ) == 0 ) {
 234                         $names = array_keys( $_REQUEST );
 235                 }
 236
 237                 $retVal = array();
 238                 foreach ( $names as $name ) {
 239                         $value = $this->getVal( $name );
 240                         if ( !is_null( $value ) ) {
 241                                 $retVal[$name] = $value;
 242                         }
 243                 }
 244                 return $retVal;
 245         }
 246
 247         /**
 248          * Returns true if the present request was reached by a POST operation,
 249          * false otherwise (GET, HEAD, or command-line).
 250          *
 251          * Note that values retrieved by the object may come from the
 252          * GET URL etc even on a POST request.
 253          *
 254          * @return bool
 255          */
 256         function wasPosted() {
 257                 return $_SERVER['REQUEST_METHOD'] == 'POST';
 258         }
 259
 260         /**
 261          * Returns true if there is a session cookie set.
 262          * This does not necessarily mean that the user is logged in!
 263          *
 264          * @return bool
 265          */
 266         function checkSessionCookie() {
 267                 return isset( $_COOKIE[ini_get('session.name')] );
 268         }
 269
 270         /**
 271          * Return the path portion of the request URI.
 272          * @return string
 273          */
 274         function getRequestURL() {
 275                 return $_SERVER['REQUEST_URI'];
 276         }
 277
 278         /**
 279          * Return the request URI with the canonical service and hostname.
 280          * @return string
 281          */
 282         function getFullRequestURL() {
 283                 global $wgServer;
 284                 return $wgServer . $this->getRequestURL();
 285         }
 286
 287         /**
 288          * Take an arbitrary query and rewrite the present URL to include it
 289          * @param string $query Query string fragment; do not include initial '?'
 290          * @return string
 291          */
 292         function appendQuery( $query ) {
 293                 global $wgTitle;
 294                 $basequery = '';
 295                 foreach( $_GET as $var => $val ) {
 296                         if( $var == 'title' ) continue;
 297                         $basequery .= '&' . urlencode( $var ) . '=' . urlencode( $val );
 298                 }
 299                 $basequery .= '&' . $query;
 300
 301                 # Trim the extra &
 302                 $basequery = substr( $basequery, 1 );
 303                 return $wgTitle->getLocalURL( $basequery );
 304         }
 305
 306         /**
 307          * HTML-safe version of appendQuery().
 308          * @param string $query Query string fragment; do not include initial '?'
 309          * @return string
 310          */
 311         function escapeAppendQuery( $query ) {
 312                 return htmlspecialchars( $this->appendQuery( $query ) );
 313         }
 314
 315         /**
 316          * Check for limit and offset parameters on the input, and return sensible
 317          * defaults if not given. The limit must be positive and is capped at 5000.
 318          * Offset must be positive but is not capped.
 319          *
 320          * @param int $deflimit Limit to use if no input and the user hasn't set the option.
 321          * @param string $optionname To specify an option other than rclimit to pull from.
 322          * @return array first element is limit, second is offset
 323          */
 324         function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
 325                 global $wgUser;
 326
 327                 $limit = $this->getInt( 'limit', 0 );
 328                 if( $limit < 0 ) $limit = 0;
 329                 if( ( $limit == 0 ) && ( $optionname != '' ) ) {
 330                         $limit = (int)$wgUser->getOption( $optionname );
 331                 }
 332                 if( $limit <= 0 ) $limit = $deflimit;
 333                 if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
 334
 335                 $offset = $this->getInt( 'offset', 0 );
 336                 if( $offset < 0 ) $offset = 0;
 337
 338                 return array( $limit, $offset );
 339         }
 340
 341         /**
 342          * Return the path to the temporary file where PHP has stored the upload.
 343          * @param string $key
 344          * @return string or NULL if no such file.
 345          */
 346         function getFileTempname( $key ) {
 347                 if( !isset( $_FILES[$key] ) ) {
 348                         return NULL;
 349                 }
 350                 return $_FILES[$key]['tmp_name'];
 351         }
 352
 353         /**
 354          * Return the size of the upload, or 0.
 355          * @param string $key
 356          * @return integer
 357          */
 358         function getFileSize( $key ) {
 359                 if( !isset( $_FILES[$key] ) ) {
 360                         return 0;
 361                 }
 362                 return $_FILES[$key]['size'];
 363         }
 364
 365         /**
 366          * Return the original filename of the uploaded file, as reported by
 367          * the submitting user agent. HTML-style character entities are
 368          * interpreted and normalized to Unicode normalization form C, in part
 369          * to deal with weird input from Safari with non-ASCII filenames.
 370          *
 371          * Other than this the name is not verified for being a safe filename.
 372          *
 373          * @param string $key
 374          * @return string or NULL if no such file.
 375          */
 376         function getFileName( $key ) {
 377                 if( !isset( $_FILES[$key] ) ) {
 378                         return NULL;
 379                 }
 380                 $name = $_FILES[$key]['name'];
 381
 382                 # Safari sends filenames in HTML-encoded Unicode form D...
 383                 # Horrid and evil! Let's try to make some kind of sense of it.
 384                 global $wgUseLatin1;
 385                 if( $wgUseLatin1 ) {
 386                         $name = utf8_encode( $name );
 387                 }
 388                 $name = wfMungeToUtf8( $name );
 389                 $name = UtfNormal::cleanUp( $name );
 390                 if( $wgUseLatin1 ) {
 391                         $name = utf8_decode( $name );
 392                 }
 393                 wfDebug( "WebRequest::getFileName() '" . $_FILES[$key]['name'] . "' normalized to '$name'\n" );
 394                 return $name;
 395         }
 396 }
 397
 398 /**
 399  * WebRequest clone which takes values from a provided array.
 400  *
 401  * @package MediaWiki
 402  */
 403 class FauxRequest extends WebRequest {
 404         var $data = null;
 405         var $wasPosted = false;
 406
 407         function FauxRequest( $data, $wasPosted = false ) {
 408                 if( is_array( $data ) ) {
 409                         $this->data = $data;
 410                 } else {
 411                         wfDebugDieBacktrace( "FauxRequest() got bogus data" );
 412                 }
 413                 $this->wasPosted = $wasPosted;
 414         }
 415
 416         function getVal( $name, $default = NULL ) {
 417                 return $this->getGPCVal( $this->data, $name, $default );
 418         }
 419
 420         function getText( $name, $default = '' ) {
 421                 # Override; don't recode since we're using internal data
 422                 return $this->getVal( $name, $default );
 423         }
 424
 425         function getValues() {
 426                 return $this->data;
 427         }
 428
 429         function wasPosted() {
 430                 return $this->wasPosted;
 431         }
 432
 433         function checkSessionCookie() {
 434                 return false;
 435         }
 436
 437         function getRequestURL() {
 438                 wfDebugDieBacktrace( 'FauxRequest::getRequestURL() not implemented' );
 439         }
 440
 441         function appendQuery( $query ) {
 442                 wfDebugDieBacktrace( 'FauxRequest::appendQuery() not implemented' );
 443         }
 444
 445 }
 446
 447 ?>