includes/WebRequest.php

   1 <?php
   2 /**
   3  * Deal with importing all those nasty globals and things
   4  *
   5  * Copyright © 2003 Brion Vibber <brion@pobox.com>
   6  * http://www.mediawiki.org/
   7  *
   8  * This program 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  * This program 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 along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * The WebRequest class encapsulates getting at data passed in the
  28  * URL or via a POSTed form, handling remove of "magic quotes" slashes,
  29  * stripping illegal input characters and normalizing Unicode sequences.
  30  *
  31  * Usually this is used via a global singleton, $wgRequest. You should
  32  * not create a second WebRequest object; make a FauxRequest object if
  33  * you want to pass arbitrary data to some function in place of the web
  34  * input.
  35  *
  36  * @ingroup HTTP
  37  */
  38 class WebRequest {
  39         protected $data, $headers = array();
  40
  41         /**
  42          * Lazy-init response object
  43          * @var WebResponse
  44          */
  45         private $response;
  46
  47         /**
  48          * Cached client IP address
  49          * @var String
  50          */
  51         private $ip;
  52
  53         /**
  54          * Cached URL protocol
  55          * @var string
  56          */
  57         protected $protocol;
  58
  59         public function __construct() {
  60                 /// @todo FIXME: This preemptive de-quoting can interfere with other web libraries
  61                 ///        and increases our memory footprint. It would be cleaner to do on
  62                 ///        demand; but currently we have no wrapper for $_SERVER etc.
  63                 $this->checkMagicQuotes();
  64
  65                 // POST overrides GET data
  66                 // We don't use $_REQUEST here to avoid interference from cookies...
  67                 $this->data = $_POST + $_GET;
  68         }
  69
  70         /**
  71          * Extract relevant query arguments from the http request uri's path
  72          * to be merged with the normal php provided query arguments.
  73          * Tries to use the REQUEST_URI data if available and parses it
  74          * according to the wiki's configuration looking for any known pattern.
  75          *
  76          * If the REQUEST_URI is not provided we'll fall back on the PATH_INFO
  77          * provided by the server if any and use that to set a 'title' parameter.
  78          *
  79          * @param string $want If this is not 'all', then the function
  80          * will return an empty array if it determines that the URL is
  81          * inside a rewrite path.
  82          *
  83          * @return Array: Any query arguments found in path matches.
  84          */
  85         public static function getPathInfo( $want = 'all' ) {
  86                 global $wgUsePathInfo;
  87                 // PATH_INFO is mangled due to http://bugs.php.net/bug.php?id=31892
  88                 // And also by Apache 2.x, double slashes are converted to single slashes.
  89                 // So we will use REQUEST_URI if possible.
  90                 $matches = array();
  91                 if ( !empty( $_SERVER['REQUEST_URI'] ) ) {
  92                         // Slurp out the path portion to examine...
  93                         $url = $_SERVER['REQUEST_URI'];
  94                         if ( !preg_match( '!^https?://!', $url ) ) {
  95                                 $url = 'http://unused' . $url;
  96                         }
  97                         wfSuppressWarnings();
  98                         $a = parse_url( $url );
  99                         wfRestoreWarnings();
 100                         if ( $a ) {
 101                                 $path = isset( $a['path'] ) ? $a['path'] : '';
 102
 103                                 global $wgScript;
 104                                 if ( $path == $wgScript && $want !== 'all' ) {
 105                                         // Script inside a rewrite path?
 106                                         // Abort to keep from breaking...
 107                                         return $matches;
 108                                 }
 109
 110                                 $router = new PathRouter;
 111
 112                                 // Raw PATH_INFO style
 113                                 $router->add( "$wgScript/$1" );
 114
 115                                 if ( isset( $_SERVER['SCRIPT_NAME'] )
 116                                         && preg_match( '/\.php5?/', $_SERVER['SCRIPT_NAME'] )
 117                                 ) {
 118                                         # Check for SCRIPT_NAME, we handle index.php explicitly
 119                                         # But we do have some other .php files such as img_auth.php
 120                                         # Don't let root article paths clober the parsing for them
 121                                         $router->add( $_SERVER['SCRIPT_NAME'] . "/$1" );
 122                                 }
 123
 124                                 global $wgArticlePath;
 125                                 if ( $wgArticlePath ) {
 126                                         $router->add( $wgArticlePath );
 127                                 }
 128
 129                                 global $wgActionPaths;
 130                                 if ( $wgActionPaths ) {
 131                                         $router->add( $wgActionPaths, array( 'action' => '$key' ) );
 132                                 }
 133
 134                                 global $wgVariantArticlePath, $wgContLang;
 135                                 if ( $wgVariantArticlePath ) {
 136                                         $router->add( $wgVariantArticlePath,
 137                                                 array( 'variant' => '$2' ),
 138                                                 array( '$2' => $wgContLang->getVariants() )
 139                                         );
 140                                 }
 141
 142                                 wfRunHooks( 'WebRequestPathInfoRouter', array( $router ) );
 143
 144                                 $matches = $router->parse( $path );
 145                         }
 146                 } elseif ( $wgUsePathInfo ) {
 147                         if ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_PATH_INFO'] != '' ) {
 148                                 // Mangled PATH_INFO
 149                                 // http://bugs.php.net/bug.php?id=31892
 150                                 // Also reported when ini_get('cgi.fix_pathinfo')==false
 151                                 $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
 152
 153                         } elseif ( isset( $_SERVER['PATH_INFO'] ) && $_SERVER['PATH_INFO'] != '' ) {
 154                                 // Regular old PATH_INFO yay
 155                                 $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
 156                         }
 157                 }
 158
 159                 return $matches;
 160         }
 161
 162         /**
 163          * Work out an appropriate URL prefix containing scheme and host, based on
 164          * information detected from $_SERVER
 165          *
 166          * @return string
 167          */
 168         public static function detectServer() {
 169                 $proto = self::detectProtocol();
 170                 $stdPort = $proto === 'https' ? 443 : 80;
 171
 172                 $varNames = array( 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' );
 173                 $host = 'localhost';
 174                 $port = $stdPort;
 175                 foreach ( $varNames as $varName ) {
 176                         if ( !isset( $_SERVER[$varName] ) ) {
 177                                 continue;
 178                         }
 179                         $parts = IP::splitHostAndPort( $_SERVER[$varName] );
 180                         if ( !$parts ) {
 181                                 // Invalid, do not use
 182                                 continue;
 183                         }
 184                         $host = $parts[0];
 185                         if ( $parts[1] === false ) {
 186                                 if ( isset( $_SERVER['SERVER_PORT'] ) ) {
 187                                         $port = $_SERVER['SERVER_PORT'];
 188                                 } // else leave it as $stdPort
 189                         } else {
 190                                 $port = $parts[1];
 191                         }
 192                         break;
 193                 }
 194
 195                 return $proto . '://' . IP::combineHostAndPort( $host, $port, $stdPort );
 196         }
 197
 198         /**
 199          * Detect the protocol from $_SERVER.
 200          * This is for use prior to Setup.php, when no WebRequest object is available.
 201          * At other times, use the non-static function getProtocol().
 202          *
 203          * @return array
 204          */
 205         public static function detectProtocol() {
 206                 if ( ( isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] == 'on' ) ||
 207                         ( isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
 208                         $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' ) ) {
 209                         return 'https';
 210                 } else {
 211                         return 'http';
 212                 }
 213         }
 214
 215         /**
 216          * Get the current URL protocol (http or https)
 217          * @return string
 218          */
 219         public function getProtocol() {
 220                 if ( $this->protocol === null ) {
 221                         $this->protocol = self::detectProtocol();
 222                 }
 223                 return $this->protocol;
 224         }
 225
 226         /**
 227          * Check for title, action, and/or variant data in the URL
 228          * and interpolate it into the GET variables.
 229          * This should only be run after $wgContLang is available,
 230          * as we may need the list of language variants to determine
 231          * available variant URLs.
 232          */
 233         public function interpolateTitle() {
 234                 // bug 16019: title interpolation on API queries is useless and sometimes harmful
 235                 if ( defined( 'MW_API' ) ) {
 236                         return;
 237                 }
 238
 239                 $matches = self::getPathInfo( 'title' );
 240                 foreach ( $matches as $key => $val ) {
 241                         $this->data[$key] = $_GET[$key] = $_REQUEST[$key] = $val;
 242                 }
 243         }
 244
 245         /**
 246          * URL rewriting function; tries to extract page title and,
 247          * optionally, one other fixed parameter value from a URL path.
 248          *
 249          * @param string $path the URL path given from the client
 250          * @param array $bases one or more URLs, optionally with $1 at the end
 251          * @param string $key if provided, the matching key in $bases will be
 252          *             passed on as the value of this URL parameter
 253          * @return array of URL variables to interpolate; empty if no match
 254          */
 255         static function extractTitle( $path, $bases, $key = false ) {
 256                 foreach ( (array)$bases as $keyValue => $base ) {
 257                         // Find the part after $wgArticlePath
 258                         $base = str_replace( '$1', '', $base );
 259                         $baseLen = strlen( $base );
 260                         if ( substr( $path, 0, $baseLen ) == $base ) {
 261                                 $raw = substr( $path, $baseLen );
 262                                 if ( $raw !== '' ) {
 263                                         $matches = array( 'title' => rawurldecode( $raw ) );
 264                                         if ( $key ) {
 265                                                 $matches[$key] = $keyValue;
 266                                         }
 267                                         return $matches;
 268                                 }
 269                         }
 270                 }
 271                 return array();
 272         }
 273
 274         /**
 275          * Recursively strips slashes from the given array;
 276          * used for undoing the evil that is magic_quotes_gpc.
 277          *
 278          * @param array $arr will be modified
 279          * @param bool $topLevel Specifies if the array passed is from the top
 280          * level of the source. In PHP5 magic_quotes only escapes the first level
 281          * of keys that belong to an array.
 282          * @return array the original array
 283          * @see http://www.php.net/manual/en/function.get-magic-quotes-gpc.php#49612
 284          */
 285         private function &fix_magic_quotes( &$arr, $topLevel = true ) {
 286                 $clean = array();
 287                 foreach ( $arr as $key => $val ) {
 288                         if ( is_array( $val ) ) {
 289                                 $cleanKey = $topLevel ? stripslashes( $key ) : $key;
 290                                 $clean[$cleanKey] = $this->fix_magic_quotes( $arr[$key], false );
 291                         } else {
 292                                 $cleanKey = stripslashes( $key );
 293                                 $clean[$cleanKey] = stripslashes( $val );
 294                         }
 295                 }
 296                 $arr = $clean;
 297                 return $arr;
 298         }
 299
 300         /**
 301          * If magic_quotes_gpc option is on, run the global arrays
 302          * through fix_magic_quotes to strip out the stupid slashes.
 303          * WARNING: This should only be done once! Running a second
 304          * time could damage the values.
 305          */
 306         private function checkMagicQuotes() {
 307                 $mustFixQuotes = function_exists( 'get_magic_quotes_gpc' )
 308                         && get_magic_quotes_gpc();
 309                 if ( $mustFixQuotes ) {
 310                         $this->fix_magic_quotes( $_COOKIE );
 311                         $this->fix_magic_quotes( $_ENV );
 312                         $this->fix_magic_quotes( $_GET );
 313                         $this->fix_magic_quotes( $_POST );
 314                         $this->fix_magic_quotes( $_REQUEST );
 315                         $this->fix_magic_quotes( $_SERVER );
 316                 }
 317         }
 318
 319         /**
 320          * Recursively normalizes UTF-8 strings in the given array.
 321          *
 322          * @param $data string|array
 323          * @return array|string cleaned-up version of the given
 324          * @private
 325          */
 326         function normalizeUnicode( $data ) {
 327                 if ( is_array( $data ) ) {
 328                         foreach ( $data as $key => $val ) {
 329                                 $data[$key] = $this->normalizeUnicode( $val );
 330                         }
 331                 } else {
 332                         global $wgContLang;
 333                         $data = isset( $wgContLang ) ? $wgContLang->normalize( $data ) : UtfNormal::cleanUp( $data );
 334                 }
 335                 return $data;
 336         }
 337
 338         /**
 339          * Fetch a value from the given array or return $default if it's not set.
 340          *
 341          * @param $arr Array
 342          * @param $name String
 343          * @param $default Mixed
 344          * @return mixed
 345          */
 346         private function getGPCVal( $arr, $name, $default ) {
 347                 # PHP is so nice to not touch input data, except sometimes:
 348                 # http://us2.php.net/variables.external#language.variables.external.dot-in-names
 349                 # Work around PHP *feature* to avoid *bugs* elsewhere.
 350                 $name = strtr( $name, '.', '_' );
 351                 if ( isset( $arr[$name] ) ) {
 352                         global $wgContLang;
 353                         $data = $arr[$name];
 354                         if ( isset( $_GET[$name] ) && !is_array( $data ) ) {
 355                                 # Check for alternate/legacy character encoding.
 356                                 if ( isset( $wgContLang ) ) {
 357                                         $data = $wgContLang->checkTitleEncoding( $data );
 358                                 }
 359                         }
 360                         $data = $this->normalizeUnicode( $data );
 361                         return $data;
 362                 } else {
 363                         return $default;
 364                 }
 365         }
 366
 367         /**
 368          * Fetch a scalar from the input or return $default if it's not set.
 369          * Returns a string. Arrays are discarded. Useful for
 370          * non-freeform text inputs (e.g. predefined internal text keys
 371          * selected by a drop-down menu). For freeform input, see getText().
 372          *
 373          * @param $name String
 374          * @param string $default optional default (or NULL)
 375          * @return String
 376          */
 377         public function getVal( $name, $default = null ) {
 378                 $val = $this->getGPCVal( $this->data, $name, $default );
 379                 if ( is_array( $val ) ) {
 380                         $val = $default;
 381                 }
 382                 if ( is_null( $val ) ) {
 383                         return $val;
 384                 } else {
 385                         return (string)$val;
 386                 }
 387         }
 388
 389         /**
 390          * Set an arbitrary value into our get/post data.
 391          *
 392          * @param string $key key name to use
 393          * @param $value Mixed: value to set
 394          * @return Mixed: old value if one was present, null otherwise
 395          */
 396         public function setVal( $key, $value ) {
 397                 $ret = isset( $this->data[$key] ) ? $this->data[$key] : null;
 398                 $this->data[$key] = $value;
 399                 return $ret;
 400         }
 401
 402         /**
 403          * Unset an arbitrary value from our get/post data.
 404          *
 405          * @param string $key key name to use
 406          * @return Mixed: old value if one was present, null otherwise
 407          */
 408         public function unsetVal( $key ) {
 409                 if ( !isset( $this->data[$key] ) ) {
 410                         $ret = null;
 411                 } else {
 412                         $ret = $this->data[$key];
 413                         unset( $this->data[$key] );
 414                 }
 415                 return $ret;
 416         }
 417
 418         /**
 419          * Fetch an array from the input or return $default if it's not set.
 420          * If source was scalar, will return an array with a single element.
 421          * If no source and no default, returns NULL.
 422          *
 423          * @param $name String
 424          * @param array $default optional default (or NULL)
 425          * @return Array
 426          */
 427         public function getArray( $name, $default = null ) {
 428                 $val = $this->getGPCVal( $this->data, $name, $default );
 429                 if ( is_null( $val ) ) {
 430                         return null;
 431                 } else {
 432                         return (array)$val;
 433                 }
 434         }
 435
 436         /**
 437          * Fetch an array of integers, or return $default if it's not set.
 438          * If source was scalar, will return an array with a single element.
 439          * If no source and no default, returns NULL.
 440          * If an array is returned, contents are guaranteed to be integers.
 441          *
 442          * @param $name String
 443          * @param array $default option default (or NULL)
 444          * @return Array of ints
 445          */
 446         public function getIntArray( $name, $default = null ) {
 447                 $val = $this->getArray( $name, $default );
 448                 if ( is_array( $val ) ) {
 449                         $val = array_map( 'intval', $val );
 450                 }
 451                 return $val;
 452         }
 453
 454         /**
 455          * Fetch an integer value from the input or return $default if not set.
 456          * Guaranteed to return an integer; non-numeric input will typically
 457          * return 0.
 458          *
 459          * @param $name String
 460          * @param $default Integer
 461          * @return Integer
 462          */
 463         public function getInt( $name, $default = 0 ) {
 464                 return intval( $this->getVal( $name, $default ) );
 465         }
 466
 467         /**
 468          * Fetch an integer value from the input or return null if empty.
 469          * Guaranteed to return an integer or null; non-numeric input will
 470          * typically return null.
 471          *
 472          * @param $name String
 473          * @return Integer
 474          */
 475         public function getIntOrNull( $name ) {
 476                 $val = $this->getVal( $name );
 477                 return is_numeric( $val )
 478                         ? intval( $val )
 479                         : null;
 480         }
 481
 482         /**
 483          * Fetch a floating point value from the input or return $default if not set.
 484          * Guaranteed to return a float; non-numeric input will typically
 485          * return 0.
 486          *
 487          * @since 1.23
 488          * @param $name String
 489          * @param $default Float
 490          * @return Float
 491          */
 492         public function getFloat( $name, $default = 0 ) {
 493                 return floatval( $this->getVal( $name, $default ) );
 494         }
 495
 496         /**
 497          * Fetch a boolean value from the input or return $default if not set.
 498          * Guaranteed to return true or false, with normal PHP semantics for
 499          * boolean interpretation of strings.
 500          *
 501          * @param $name String
 502          * @param $default Boolean
 503          * @return Boolean
 504          */
 505         public function getBool( $name, $default = false ) {
 506                 return (bool)$this->getVal( $name, $default );
 507         }
 508
 509         /**
 510          * Fetch a boolean value from the input or return $default if not set.
 511          * Unlike getBool, the string "false" will result in boolean false, which is
 512          * useful when interpreting information sent from JavaScript.
 513          *
 514          * @param $name String
 515          * @param $default Boolean
 516          * @return Boolean
 517          */
 518         public function getFuzzyBool( $name, $default = false ) {
 519                 return $this->getBool( $name, $default ) && strcasecmp( $this->getVal( $name ), 'false' ) !== 0;
 520         }
 521
 522         /**
 523          * Return true if the named value is set in the input, whatever that
 524          * value is (even "0"). Return false if the named value is not set.
 525          * Example use is checking for the presence of check boxes in forms.
 526          *
 527          * @param $name String
 528          * @return Boolean
 529          */
 530         public function getCheck( $name ) {
 531                 # Checkboxes and buttons are only present when clicked
 532                 # Presence connotes truth, absence false
 533                 return $this->getVal( $name, null ) !== null;
 534         }
 535
 536         /**
 537          * Fetch a text string from the given array or return $default if it's not
 538          * set. Carriage returns are stripped from the text, and with some language
 539          * modules there is an input transliteration applied. This should generally
 540          * be used for form "<textarea>" and "<input>" fields. Used for
 541          * user-supplied freeform text input (for which input transformations may
 542          * be required - e.g.  Esperanto x-coding).
 543          *
 544          * @param $name String
 545          * @param string $default optional
 546          * @return String
 547          */
 548         public function getText( $name, $default = '' ) {
 549                 global $wgContLang;
 550                 $val = $this->getVal( $name, $default );
 551                 return str_replace( "\r\n", "\n",
 552                         $wgContLang->recodeInput( $val ) );
 553         }
 554
 555         /**
 556          * Extracts the given named values into an array.
 557          * If no arguments are given, returns all input values.
 558          * No transformation is performed on the values.
 559          *
 560          * @return array
 561          */
 562         public function getValues() {
 563                 $names = func_get_args();
 564                 if ( count( $names ) == 0 ) {
 565                         $names = array_keys( $this->data );
 566                 }
 567
 568                 $retVal = array();
 569                 foreach ( $names as $name ) {
 570                         $value = $this->getGPCVal( $this->data, $name, null );
 571                         if ( !is_null( $value ) ) {
 572                                 $retVal[$name] = $value;
 573                         }
 574                 }
 575                 return $retVal;
 576         }
 577
 578         /**
 579          * Returns the names of all input values excluding those in $exclude.
 580          *
 581          * @param $exclude Array
 582          * @return array
 583          */
 584         public function getValueNames( $exclude = array() ) {
 585                 return array_diff( array_keys( $this->getValues() ), $exclude );
 586         }
 587
 588         /**
 589          * Get the values passed in the query string.
 590          * No transformation is performed on the values.
 591          *
 592          * @return Array
 593          */
 594         public function getQueryValues() {
 595                 return $_GET;
 596         }
 597
 598         /**
 599          * Return the contents of the Query with no decoding. Use when you need to
 600          * know exactly what was sent, e.g. for an OAuth signature over the elements.
 601          *
 602          * @return String
 603          */
 604         public function getRawQueryString() {
 605                 return $_SERVER['QUERY_STRING'];
 606         }
 607
 608         /**
 609          * Return the contents of the POST with no decoding. Use when you need to
 610          * know exactly what was sent, e.g. for an OAuth signature over the elements.
 611          *
 612          * @return String
 613          */
 614         public function getRawPostString() {
 615                 if ( !$this->wasPosted() ) {
 616                         return '';
 617                 }
 618                 return $this->getRawInput();
 619         }
 620
 621         /**
 622          * Return the raw request body, with no processing. Cached since some methods
 623          * disallow reading the stream more than once. As stated in the php docs, this
 624          * does not work with enctype="multipart/form-data".
 625          *
 626          * @return String
 627          */
 628         public function getRawInput() {
 629                 static $input = false;
 630                 if ( $input === false ) {
 631                         $input = file_get_contents( 'php://input' );
 632                 }
 633                 return $input;
 634         }
 635
 636         /**
 637          * Get the HTTP method used for this request.
 638          *
 639          * @return String
 640          */
 641         public function getMethod() {
 642                 return isset( $_SERVER['REQUEST_METHOD'] ) ? $_SERVER['REQUEST_METHOD'] : 'GET';
 643         }
 644
 645         /**
 646          * Returns true if the present request was reached by a POST operation,
 647          * false otherwise (GET, HEAD, or command-line).
 648          *
 649          * Note that values retrieved by the object may come from the
 650          * GET URL etc even on a POST request.
 651          *
 652          * @return Boolean
 653          */
 654         public function wasPosted() {
 655                 return $this->getMethod() == 'POST';
 656         }
 657
 658         /**
 659          * Returns true if there is a session cookie set.
 660          * This does not necessarily mean that the user is logged in!
 661          *
 662          * If you want to check for an open session, use session_id()
 663          * instead; that will also tell you if the session was opened
 664          * during the current request (in which case the cookie will
 665          * be sent back to the client at the end of the script run).
 666          *
 667          * @return Boolean
 668          */
 669         public function checkSessionCookie() {
 670                 return isset( $_COOKIE[session_name()] );
 671         }
 672
 673         /**
 674          * Get a cookie from the $_COOKIE jar
 675          *
 676          * @param string $key the name of the cookie
 677          * @param string $prefix a prefix to use for the cookie name, if not $wgCookiePrefix
 678          * @param $default Mixed: what to return if the value isn't found
 679          * @return Mixed: cookie value or $default if the cookie not set
 680          */
 681         public function getCookie( $key, $prefix = null, $default = null ) {
 682                 if ( $prefix === null ) {
 683                         global $wgCookiePrefix;
 684                         $prefix = $wgCookiePrefix;
 685                 }
 686                 return $this->getGPCVal( $_COOKIE, $prefix . $key, $default );
 687         }
 688
 689         /**
 690          * Return the path and query string portion of the request URI.
 691          * This will be suitable for use as a relative link in HTML output.
 692          *
 693          * @throws MWException
 694          * @return String
 695          */
 696         public function getRequestURL() {
 697                 if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
 698                         $base = $_SERVER['REQUEST_URI'];
 699                 } elseif ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) && strlen( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
 700                         // Probably IIS; doesn't set REQUEST_URI
 701                         $base = $_SERVER['HTTP_X_ORIGINAL_URL'];
 702                 } elseif ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
 703                         $base = $_SERVER['SCRIPT_NAME'];
 704                         if ( isset( $_SERVER['QUERY_STRING'] ) && $_SERVER['QUERY_STRING'] != '' ) {
 705                                 $base .= '?' . $_SERVER['QUERY_STRING'];
 706                         }
 707                 } else {
 708                         // This shouldn't happen!
 709                         throw new MWException( "Web server doesn't provide either " .
 710                                 "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
 711                                 "of your web server configuration to http://bugzilla.wikimedia.org/" );
 712                 }
 713                 // User-agents should not send a fragment with the URI, but
 714                 // if they do, and the web server passes it on to us, we
 715                 // need to strip it or we get false-positive redirect loops
 716                 // or weird output URLs
 717                 $hash = strpos( $base, '#' );
 718                 if ( $hash !== false ) {
 719                         $base = substr( $base, 0, $hash );
 720                 }
 721
 722                 if ( $base[0] == '/' ) {
 723                         // More than one slash will look like it is protocol relative
 724                         return preg_replace( '!^/+!', '/', $base );
 725                 } else {
 726                         // We may get paths with a host prepended; strip it.
 727                         return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
 728                 }
 729         }
 730
 731         /**
 732          * Return the request URI with the canonical service and hostname, path,
 733          * and query string. This will be suitable for use as an absolute link
 734          * in HTML or other output.
 735          *
 736          * If $wgServer is protocol-relative, this will return a fully
 737          * qualified URL with the protocol that was used for this request.
 738          *
 739          * @return String
 740          */
 741         public function getFullRequestURL() {
 742                 return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT );
 743         }
 744
 745         /**
 746          * Take an arbitrary query and rewrite the present URL to include it
 747          * @param string $query query string fragment; do not include initial '?'
 748          *
 749          * @return String
 750          */
 751         public function appendQuery( $query ) {
 752                 return $this->appendQueryArray( wfCgiToArray( $query ) );
 753         }
 754
 755         /**
 756          * HTML-safe version of appendQuery().
 757          * @deprecated: Deprecated in 1.20, warnings in 1.21, remove in 1.22.
 758          *
 759          * @param string $query query string fragment; do not include initial '?'
 760          * @return String
 761          */
 762         public function escapeAppendQuery( $query ) {
 763                 return htmlspecialchars( $this->appendQuery( $query ) );
 764         }
 765
 766         /**
 767          * @param $key
 768          * @param $value
 769          * @param $onlyquery bool
 770          * @return String
 771          */
 772         public function appendQueryValue( $key, $value, $onlyquery = false ) {
 773                 return $this->appendQueryArray( array( $key => $value ), $onlyquery );
 774         }
 775
 776         /**
 777          * Appends or replaces value of query variables.
 778          *
 779          * @param array $array of values to replace/add to query
 780          * @param bool $onlyquery whether to only return the query string and not
 781          *                   the complete URL
 782          * @return String
 783          */
 784         public function appendQueryArray( $array, $onlyquery = false ) {
 785                 global $wgTitle;
 786                 $newquery = $this->getQueryValues();
 787                 unset( $newquery['title'] );
 788                 $newquery = array_merge( $newquery, $array );
 789                 $query = wfArrayToCgi( $newquery );
 790                 return $onlyquery ? $query : $wgTitle->getLocalURL( $query );
 791         }
 792
 793         /**
 794          * Check for limit and offset parameters on the input, and return sensible
 795          * defaults if not given. The limit must be positive and is capped at 5000.
 796          * Offset must be positive but is not capped.
 797          *
 798          * @param int $deflimit limit to use if no input and the user hasn't set the option.
 799          * @param string $optionname to specify an option other than rclimit to pull from.
 800          * @param int $hardlimit the maximum upper limit to allow, usually 5000
 801          * @return array first element is limit, second is offset
 802          */
 803         public function getLimitOffset( $deflimit = 50, $optionname = 'rclimit', $hardlimit = 5000 ) {
 804                 global $wgUser;
 805
 806                 $limit = $this->getInt( 'limit', 0 );
 807                 if ( $limit < 0 ) {
 808                         $limit = 0;
 809                 }
 810                 if ( ( $limit == 0 ) && ( $optionname != '' ) ) {
 811                         $limit = $wgUser->getIntOption( $optionname );
 812                 }
 813                 if ( $limit <= 0 ) {
 814                         $limit = $deflimit;
 815                 }
 816                 if ( $limit > $hardlimit ) {
 817                         $limit = $hardlimit; # We have *some* limits...
 818                 }
 819
 820                 $offset = $this->getInt( 'offset', 0 );
 821                 if ( $offset < 0 ) {
 822                         $offset = 0;
 823                 }
 824
 825                 return array( $limit, $offset );
 826         }
 827
 828         /**
 829          * Return the path to the temporary file where PHP has stored the upload.
 830          *
 831          * @param $key String:
 832          * @return string or NULL if no such file.
 833          */
 834         public function getFileTempname( $key ) {
 835                 $file = new WebRequestUpload( $this, $key );
 836                 return $file->getTempName();
 837         }
 838
 839         /**
 840          * Return the size of the upload, or 0.
 841          *
 842          * @deprecated since 1.17
 843          * @param $key String:
 844          * @return integer
 845          */
 846         public function getFileSize( $key ) {
 847                 wfDeprecated( __METHOD__, '1.17' );
 848                 $file = new WebRequestUpload( $this, $key );
 849                 return $file->getSize();
 850         }
 851
 852         /**
 853          * Return the upload error or 0
 854          *
 855          * @param $key String:
 856          * @return integer
 857          */
 858         public function getUploadError( $key ) {
 859                 $file = new WebRequestUpload( $this, $key );
 860                 return $file->getError();
 861         }
 862
 863         /**
 864          * Return the original filename of the uploaded file, as reported by
 865          * the submitting user agent. HTML-style character entities are
 866          * interpreted and normalized to Unicode normalization form C, in part
 867          * to deal with weird input from Safari with non-ASCII filenames.
 868          *
 869          * Other than this the name is not verified for being a safe filename.
 870          *
 871          * @param $key String:
 872          * @return string or NULL if no such file.
 873          */
 874         public function getFileName( $key ) {
 875                 $file = new WebRequestUpload( $this, $key );
 876                 return $file->getName();
 877         }
 878
 879         /**
 880          * Return a WebRequestUpload object corresponding to the key
 881          *
 882          * @param $key string
 883          * @return WebRequestUpload
 884          */
 885         public function getUpload( $key ) {
 886                 return new WebRequestUpload( $this, $key );
 887         }
 888
 889         /**
 890          * Return a handle to WebResponse style object, for setting cookies,
 891          * headers and other stuff, for Request being worked on.
 892          *
 893          * @return WebResponse
 894          */
 895         public function response() {
 896                 /* Lazy initialization of response object for this request */
 897                 if ( !is_object( $this->response ) ) {
 898                         $class = ( $this instanceof FauxRequest ) ? 'FauxResponse' : 'WebResponse';
 899                         $this->response = new $class();
 900                 }
 901                 return $this->response;
 902         }
 903
 904         /**
 905          * Initialise the header list
 906          */
 907         private function initHeaders() {
 908                 if ( count( $this->headers ) ) {
 909                         return;
 910                 }
 911
 912                 $apacheHeaders = function_exists( 'apache_request_headers' ) ? apache_request_headers() : false;
 913                 if ( $apacheHeaders ) {
 914                         foreach ( $apacheHeaders as $tempName => $tempValue ) {
 915                                 $this->headers[strtoupper( $tempName )] = $tempValue;
 916                         }
 917                 } else {
 918                         foreach ( $_SERVER as $name => $value ) {
 919                                 if ( substr( $name, 0, 5 ) === 'HTTP_' ) {
 920                                         $name = str_replace( '_', '-', substr( $name, 5 ) );
 921                                         $this->headers[$name] = $value;
 922                                 } elseif ( $name === 'CONTENT_LENGTH' ) {
 923                                         $this->headers['CONTENT-LENGTH'] = $value;
 924                                 }
 925                         }
 926                 }
 927         }
 928
 929         /**
 930          * Get an array containing all request headers
 931          *
 932          * @return Array mapping header name to its value
 933          */
 934         public function getAllHeaders() {
 935                 $this->initHeaders();
 936                 return $this->headers;
 937         }
 938
 939         /**
 940          * Get a request header, or false if it isn't set
 941          * @param string $name case-insensitive header name
 942          *
 943          * @return string|bool False on failure
 944          */
 945         public function getHeader( $name ) {
 946                 $this->initHeaders();
 947                 $name = strtoupper( $name );
 948                 if ( isset( $this->headers[$name] ) ) {
 949                         return $this->headers[$name];
 950                 } else {
 951                         return false;
 952                 }
 953         }
 954
 955         /**
 956          * Get data from $_SESSION
 957          *
 958          * @param string $key name of key in $_SESSION
 959          * @return Mixed
 960          */
 961         public function getSessionData( $key ) {
 962                 if ( !isset( $_SESSION[$key] ) ) {
 963                         return null;
 964                 }
 965                 return $_SESSION[$key];
 966         }
 967
 968         /**
 969          * Set session data
 970          *
 971          * @param string $key name of key in $_SESSION
 972          * @param $data Mixed
 973          */
 974         public function setSessionData( $key, $data ) {
 975                 $_SESSION[$key] = $data;
 976         }
 977
 978         /**
 979          * Check if Internet Explorer will detect an incorrect cache extension in
 980          * PATH_INFO or QUERY_STRING. If the request can't be allowed, show an error
 981          * message or redirect to a safer URL. Returns true if the URL is OK, and
 982          * false if an error message has been shown and the request should be aborted.
 983          *
 984          * @param $extWhitelist array
 985          * @throws HttpError
 986          * @return bool
 987          */
 988         public function checkUrlExtension( $extWhitelist = array() ) {
 989                 global $wgScriptExtension;
 990                 $extWhitelist[] = ltrim( $wgScriptExtension, '.' );
 991                 if ( IEUrlExtension::areServerVarsBad( $_SERVER, $extWhitelist ) ) {
 992                         if ( !$this->wasPosted() ) {
 993                                 $newUrl = IEUrlExtension::fixUrlForIE6(
 994                                         $this->getFullRequestURL(), $extWhitelist );
 995                                 if ( $newUrl !== false ) {
 996                                         $this->doSecurityRedirect( $newUrl );
 997                                         return false;
 998                                 }
 999                         }
1000                         throw new HttpError( 403,
1001                                 'Invalid file extension found in the path info or query string.' );
1002                 }
1003                 return true;
1004         }
1005
1006         /**
1007          * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
1008          * IE 6. Returns true if it was successful, false otherwise.
1009          *
1010          * @param $url string
1011          * @return bool
1012          */
1013         protected function doSecurityRedirect( $url ) {
1014                 header( 'Location: ' . $url );
1015                 header( 'Content-Type: text/html' );
1016                 $encUrl = htmlspecialchars( $url );
1017                 echo <<<HTML
1018 <html>
1019 <head>
1020 <title>Security redirect</title>
1021 </head>
1022 <body>
1023 <h1>Security redirect</h1>
1024 <p>
1025 We can't serve non-HTML content from the URL you have requested, because
1026 Internet Explorer would interpret it as an incorrect and potentially dangerous
1027 content type.</p>
1028 <p>Instead, please use <a href="$encUrl">this URL</a>, which is the same as the URL you have requested, except that
1029 "&amp;*" is appended. This prevents Internet Explorer from seeing a bogus file
1030 extension.
1031 </p>
1032 </body>
1033 </html>
1034 HTML;
1035                 echo "\n";
1036                 return true;
1037         }
1038
1039         /**
1040          * Returns true if the PATH_INFO ends with an extension other than a script
1041          * extension. This could confuse IE for scripts that send arbitrary data which
1042          * is not HTML but may be detected as such.
1043          *
1044          * Various past attempts to use the URL to make this check have generally
1045          * run up against the fact that CGI does not provide a standard method to
1046          * determine the URL. PATH_INFO may be mangled (e.g. if cgi.fix_pathinfo=0),
1047          * but only by prefixing it with the script name and maybe some other stuff,
1048          * the extension is not mangled. So this should be a reasonably portable
1049          * way to perform this security check.
1050          *
1051          * Also checks for anything that looks like a file extension at the end of
1052          * QUERY_STRING, since IE 6 and earlier will use this to get the file type
1053          * if there was no dot before the question mark (bug 28235).
1054          *
1055          * @deprecated Use checkUrlExtension().
1056          *
1057          * @param $extWhitelist array
1058          *
1059          * @return bool
1060          */
1061         public function isPathInfoBad( $extWhitelist = array() ) {
1062                 wfDeprecated( __METHOD__, '1.17' );
1063                 global $wgScriptExtension;
1064                 $extWhitelist[] = ltrim( $wgScriptExtension, '.' );
1065                 return IEUrlExtension::areServerVarsBad( $_SERVER, $extWhitelist );
1066         }
1067
1068         /**
1069          * Parse the Accept-Language header sent by the client into an array
1070          * @return array array( languageCode => q-value ) sorted by q-value in descending order then
1071          *                                                appearing time in the header in ascending order.
1072          * May contain the "language" '*', which applies to languages other than those explicitly listed.
1073          * This is aligned with rfc2616 section 14.4
1074          * Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.
1075          */
1076         public function getAcceptLang() {
1077                 // Modified version of code found at http://www.thefutureoftheweb.com/blog/use-accept-language-header
1078                 $acceptLang = $this->getHeader( 'Accept-Language' );
1079                 if ( !$acceptLang ) {
1080                         return array();
1081                 }
1082
1083                 // Return the language codes in lower case
1084                 $acceptLang = strtolower( $acceptLang );
1085
1086                 // Break up string into pieces (languages and q factors)
1087                 $lang_parse = null;
1088                 preg_match_all( '/([a-z]{1,8}(-[a-z]{1,8})*|\*)\s*(;\s*q\s*=\s*(1(\.0{0,3})?|0(\.[0-9]{0,3})?)?)?/',
1089                         $acceptLang, $lang_parse );
1090
1091                 if ( !count( $lang_parse[1] ) ) {
1092                         return array();
1093                 }
1094
1095                 $langcodes = $lang_parse[1];
1096                 $qvalues = $lang_parse[4];
1097                 $indices = range( 0, count( $lang_parse[1] ) - 1 );
1098
1099                 // Set default q factor to 1
1100                 foreach ( $indices as $index ) {
1101                         if ( $qvalues[$index] === '' ) {
1102                                 $qvalues[$index] = 1;
1103                         } elseif ( $qvalues[$index] == 0 ) {
1104                                 unset( $langcodes[$index], $qvalues[$index], $indices[$index] );
1105                         }
1106                 }
1107
1108                 // Sort list. First by $qvalues, then by order. Reorder $langcodes the same way
1109                 array_multisort( $qvalues, SORT_DESC, SORT_NUMERIC, $indices, $langcodes );
1110
1111                 // Create a list like "en" => 0.8
1112                 $langs = array_combine( $langcodes, $qvalues );
1113
1114                 return $langs;
1115         }
1116
1117         /**
1118          * Fetch the raw IP from the request
1119          *
1120          * @since 1.19
1121          *
1122          * @throws MWException
1123          * @return String
1124          */
1125         protected function getRawIP() {
1126                 if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
1127                         return null;
1128                 }
1129
1130                 if ( is_array( $_SERVER['REMOTE_ADDR'] ) || strpos( $_SERVER['REMOTE_ADDR'], ',' ) !== false ) {
1131                         throw new MWException( __METHOD__ . " : Could not determine the remote IP address due to multiple values." );
1132                 } else {
1133                         $ipchain = $_SERVER['REMOTE_ADDR'];
1134                 }
1135
1136                 return IP::canonicalize( $ipchain );
1137         }
1138
1139         /**
1140          * Work out the IP address based on various globals
1141          * For trusted proxies, use the XFF client IP (first of the chain)
1142          *
1143          * @since 1.19
1144          *
1145          * @throws MWException
1146          * @return string
1147          */
1148         public function getIP() {
1149                 global $wgUsePrivateIPs;
1150
1151                 # Return cached result
1152                 if ( $this->ip !== null ) {
1153                         return $this->ip;
1154                 }
1155
1156                 # collect the originating ips
1157                 $ip = $this->getRawIP();
1158
1159                 # Append XFF
1160                 $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
1161                 if ( $forwardedFor !== false ) {
1162                         $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
1163                         $ipchain = array_reverse( $ipchain );
1164                         if ( $ip ) {
1165                                 array_unshift( $ipchain, $ip );
1166                         }
1167
1168                         # Step through XFF list and find the last address in the list which is a
1169                         # trusted server. Set $ip to the IP address given by that trusted server,
1170                         # unless the address is not sensible (e.g. private). However, prefer private
1171                         # IP addresses over proxy servers controlled by this site (more sensible).
1172                         foreach ( $ipchain as $i => $curIP ) {
1173                                 $curIP = IP::sanitizeIP( IP::canonicalize( $curIP ) );
1174                                 if ( wfIsTrustedProxy( $curIP ) && isset( $ipchain[$i + 1] ) ) {
1175                                         if ( wfIsConfiguredProxy( $curIP ) || // bug 48919; treat IP as sane
1176                                                 IP::isPublic( $ipchain[$i + 1] ) ||
1177                                                 $wgUsePrivateIPs
1178                                         ) {
1179                                                 $nextIP = IP::canonicalize( $ipchain[$i + 1] );
1180                                                 if ( !$nextIP && wfIsConfiguredProxy( $ip ) ) {
1181                                                         // We have not yet made it past CDN/proxy servers of this site,
1182                                                         // so either they are misconfigured or there is some IP spoofing.
1183                                                         throw new MWException( "Invalid IP given in XFF '$forwardedFor'." );
1184                                                 }
1185                                                 $ip = $nextIP;
1186                                                 continue;
1187                                         }
1188                                 }
1189                                 break;
1190                         }
1191                 }
1192
1193                 # Allow extensions to improve our guess
1194                 wfRunHooks( 'GetIP', array( &$ip ) );
1195
1196                 if ( !$ip ) {
1197                         throw new MWException( "Unable to determine IP." );
1198                 }
1199
1200                 wfDebug( "IP: $ip\n" );
1201                 $this->ip = $ip;
1202                 return $ip;
1203         }
1204
1205         /**
1206          * @param string $ip
1207          * @return void
1208          * @since 1.21
1209          */
1210         public function setIP( $ip ) {
1211                 $this->ip = $ip;
1212         }
1213 }
1214
1215 /**
1216  * Object to access the $_FILES array
1217  */
1218 class WebRequestUpload {
1219         protected $request;
1220         protected $doesExist;
1221         protected $fileInfo;
1222
1223         /**
1224          * Constructor. Should only be called by WebRequest
1225          *
1226          * @param $request WebRequest The associated request
1227          * @param string $key Key in $_FILES array (name of form field)
1228          */
1229         public function __construct( $request, $key ) {
1230                 $this->request = $request;
1231                 $this->doesExist = isset( $_FILES[$key] );
1232                 if ( $this->doesExist ) {
1233                         $this->fileInfo = $_FILES[$key];
1234                 }
1235         }
1236
1237         /**
1238          * Return whether a file with this name was uploaded.
1239          *
1240          * @return bool
1241          */
1242         public function exists() {
1243                 return $this->doesExist;
1244         }
1245
1246         /**
1247          * Return the original filename of the uploaded file
1248          *
1249          * @return mixed Filename or null if non-existent
1250          */
1251         public function getName() {
1252                 if ( !$this->exists() ) {
1253                         return null;
1254                 }
1255
1256                 global $wgContLang;
1257                 $name = $this->fileInfo['name'];
1258
1259                 # Safari sends filenames in HTML-encoded Unicode form D...
1260                 # Horrid and evil! Let's try to make some kind of sense of it.
1261                 $name = Sanitizer::decodeCharReferences( $name );
1262                 $name = $wgContLang->normalize( $name );
1263                 wfDebug( __METHOD__ . ": {$this->fileInfo['name']} normalized to '$name'\n" );
1264                 return $name;
1265         }
1266
1267         /**
1268          * Return the file size of the uploaded file
1269          *
1270          * @return int File size or zero if non-existent
1271          */
1272         public function getSize() {
1273                 if ( !$this->exists() ) {
1274                         return 0;
1275                 }
1276
1277                 return $this->fileInfo['size'];
1278         }
1279
1280         /**
1281          * Return the path to the temporary file
1282          *
1283          * @return mixed Path or null if non-existent
1284          */
1285         public function getTempName() {
1286                 if ( !$this->exists() ) {
1287                         return null;
1288                 }
1289
1290                 return $this->fileInfo['tmp_name'];
1291         }
1292
1293         /**
1294          * Return the upload error. See link for explanation
1295          * http://www.php.net/manual/en/features.file-upload.errors.php
1296          *
1297          * @return int One of the UPLOAD_ constants, 0 if non-existent
1298          */
1299         public function getError() {
1300                 if ( !$this->exists() ) {
1301                         return 0; # UPLOAD_ERR_OK
1302                 }
1303
1304                 return $this->fileInfo['error'];
1305         }
1306
1307         /**
1308          * Returns whether this upload failed because of overflow of a maximum set
1309          * in php.ini
1310          *
1311          * @return bool
1312          */
1313         public function isIniSizeOverflow() {
1314                 if ( $this->getError() == UPLOAD_ERR_INI_SIZE ) {
1315                         # PHP indicated that upload_max_filesize is exceeded
1316                         return true;
1317                 }
1318
1319                 $contentLength = $this->request->getHeader( 'CONTENT_LENGTH' );
1320                 if ( $contentLength > wfShorthandToInteger( ini_get( 'post_max_size' ) ) ) {
1321                         # post_max_size is exceeded
1322                         return true;
1323                 }
1324
1325                 return false;
1326         }
1327 }
1328
1329 /**
1330  * WebRequest clone which takes values from a provided array.
1331  *
1332  * @ingroup HTTP
1333  */
1334 class FauxRequest extends WebRequest {
1335         private $wasPosted = false;
1336         private $session = array();
1337
1338         /**
1339          * @param array $data of *non*-urlencoded key => value pairs, the
1340          *   fake GET/POST values
1341          * @param bool $wasPosted whether to treat the data as POST
1342          * @param $session Mixed: session array or null
1343          * @param string $protocol 'http' or 'https'
1344          * @throws MWException
1345          */
1346         public function __construct( $data = array(), $wasPosted = false, $session = null, $protocol = 'http' ) {
1347                 if ( is_array( $data ) ) {
1348                         $this->data = $data;
1349                 } else {
1350                         throw new MWException( "FauxRequest() got bogus data" );
1351                 }
1352                 $this->wasPosted = $wasPosted;
1353                 if ( $session ) {
1354                         $this->session = $session;
1355                 }
1356                 $this->protocol = $protocol;
1357         }
1358
1359         /**
1360          * @param $method string
1361          * @throws MWException
1362          */
1363         private function notImplemented( $method ) {
1364                 throw new MWException( "{$method}() not implemented" );
1365         }
1366
1367         /**
1368          * @param $name string
1369          * @param $default string
1370          * @return string
1371          */
1372         public function getText( $name, $default = '' ) {
1373                 # Override; don't recode since we're using internal data
1374                 return (string)$this->getVal( $name, $default );
1375         }
1376
1377         /**
1378          * @return Array
1379          */
1380         public function getValues() {
1381                 return $this->data;
1382         }
1383
1384         /**
1385          * @return array
1386          */
1387         public function getQueryValues() {
1388                 if ( $this->wasPosted ) {
1389                         return array();
1390                 } else {
1391                         return $this->data;
1392                 }
1393         }
1394
1395         public function getMethod() {
1396                 return $this->wasPosted ? 'POST' : 'GET';
1397         }
1398
1399         /**
1400          * @return bool
1401          */
1402         public function wasPosted() {
1403                 return $this->wasPosted;
1404         }
1405
1406         public function getCookie( $key, $prefix = null, $default = null ) {
1407                 return $default;
1408         }
1409
1410         public function checkSessionCookie() {
1411                 return false;
1412         }
1413
1414         public function getRequestURL() {
1415                 $this->notImplemented( __METHOD__ );
1416         }
1417
1418         public function getProtocol() {
1419                 return $this->protocol;
1420         }
1421
1422         /**
1423          * @param string $name The name of the header to get (case insensitive).
1424          * @return bool|string
1425          */
1426         public function getHeader( $name ) {
1427                 $name = strtoupper( $name );
1428                 return isset( $this->headers[$name] ) ? $this->headers[$name] : false;
1429         }
1430
1431         /**
1432          * @param $name string
1433          * @param $val string
1434          */
1435         public function setHeader( $name, $val ) {
1436                 $name = strtoupper( $name );
1437                 $this->headers[$name] = $val;
1438         }
1439
1440         /**
1441          * @param $key
1442          * @return mixed
1443          */
1444         public function getSessionData( $key ) {
1445                 if ( isset( $this->session[$key] ) ) {
1446                         return $this->session[$key];
1447                 }
1448                 return null;
1449         }
1450
1451         /**
1452          * @param $key
1453          * @param $data
1454          */
1455         public function setSessionData( $key, $data ) {
1456                 $this->session[$key] = $data;
1457         }
1458
1459         /**
1460          * @return array|Mixed|null
1461          */
1462         public function getSessionArray() {
1463                 return $this->session;
1464         }
1465
1466         /**
1467          * @param array $extWhitelist
1468          * @return bool
1469          */
1470         public function isPathInfoBad( $extWhitelist = array() ) {
1471                 return false;
1472         }
1473
1474         /**
1475          * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1476          * @return String
1477          */
1478         public function getRawQueryString() {
1479                 return '';
1480         }
1481
1482         /**
1483          * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1484          * @return String
1485          */
1486         public function getRawPostString() {
1487                 return '';
1488         }
1489
1490         /**
1491          * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1492          * @return String
1493          */
1494         public function getRawInput() {
1495                 return '';
1496         }
1497
1498         /**
1499          * @param array $extWhitelist
1500          * @return bool
1501          */
1502         public function checkUrlExtension( $extWhitelist = array() ) {
1503                 return true;
1504         }
1505
1506         /**
1507          * @return string
1508          */
1509         protected function getRawIP() {
1510                 return '127.0.0.1';
1511         }
1512 }
1513
1514 /**
1515  * Similar to FauxRequest, but only fakes URL parameters and method
1516  * (POST or GET) and use the base request for the remaining stuff
1517  * (cookies, session and headers).
1518  *
1519  * @ingroup HTTP
1520  * @since 1.19
1521  */
1522 class DerivativeRequest extends FauxRequest {
1523         private $base;
1524
1525         /**
1526          * @param WebRequest $base
1527          * @param array $data Array of *non*-urlencoded key => value pairs, the
1528          *   fake GET/POST values
1529          * @param bool $wasPosted Whether to treat the data as POST
1530          */
1531         public function __construct( WebRequest $base, $data, $wasPosted = false ) {
1532                 $this->base = $base;
1533                 parent::__construct( $data, $wasPosted );
1534         }
1535
1536         public function getCookie( $key, $prefix = null, $default = null ) {
1537                 return $this->base->getCookie( $key, $prefix, $default );
1538         }
1539
1540         public function checkSessionCookie() {
1541                 return $this->base->checkSessionCookie();
1542         }
1543
1544         public function getHeader( $name ) {
1545                 return $this->base->getHeader( $name );
1546         }
1547
1548         public function getAllHeaders() {
1549                 return $this->base->getAllHeaders();
1550         }
1551
1552         public function getSessionData( $key ) {
1553                 return $this->base->getSessionData( $key );
1554         }
1555
1556         public function setSessionData( $key, $data ) {
1557                 $this->base->setSessionData( $key, $data );
1558         }
1559
1560         public function getAcceptLang() {
1561                 return $this->base->getAcceptLang();
1562         }
1563
1564         public function getIP() {
1565                 return $this->base->getIP();
1566         }
1567
1568         public function getProtocol() {
1569                 return $this->base->getProtocol();
1570         }
1571 }