3 * Deal with importing all those nasty globals and things
5 * Copyright © 2003 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
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.
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.
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
26 use MediaWiki\Session\Session
;
27 use MediaWiki\Session\SessionId
;
28 use MediaWiki\Session\SessionManager
;
31 * The WebRequest class encapsulates getting at data passed in the
32 * URL or via a POSTed form stripping illegal input characters and
33 * normalizing Unicode sequences.
38 protected $data, $headers = [];
41 * Flag to make WebRequest::getHeader return an array of values.
44 const GETHEADER_LIST
= 1;
47 * The unique request ID.
50 private static $reqId;
53 * Lazy-init response object
59 * Cached client IP address
65 * The timestamp of the start of the request, with microsecond precision.
68 protected $requestTime;
77 * @var SessionId|null Session ID to use for this
78 * request. We can't save the session directly due to reference cycles not
79 * working too well (slow GC in Zend and never collected in HHVM).
81 protected $sessionId = null;
83 /** @var bool Whether this HTTP request is "safe" (even if it is an HTTP post) */
84 protected $markedAsSafe = false;
86 public function __construct() {
87 $this->requestTime
= isset( $_SERVER['REQUEST_TIME_FLOAT'] )
88 ?
$_SERVER['REQUEST_TIME_FLOAT'] : microtime( true );
90 // POST overrides GET data
91 // We don't use $_REQUEST here to avoid interference from cookies...
92 $this->data
= $_POST +
$_GET;
96 * Extract relevant query arguments from the http request uri's path
97 * to be merged with the normal php provided query arguments.
98 * Tries to use the REQUEST_URI data if available and parses it
99 * according to the wiki's configuration looking for any known pattern.
101 * If the REQUEST_URI is not provided we'll fall back on the PATH_INFO
102 * provided by the server if any and use that to set a 'title' parameter.
104 * @param string $want If this is not 'all', then the function
105 * will return an empty array if it determines that the URL is
106 * inside a rewrite path.
108 * @return array Any query arguments found in path matches.
110 public static function getPathInfo( $want = 'all' ) {
111 global $wgUsePathInfo;
112 // PATH_INFO is mangled due to http://bugs.php.net/bug.php?id=31892
113 // And also by Apache 2.x, double slashes are converted to single slashes.
114 // So we will use REQUEST_URI if possible.
116 if ( !empty( $_SERVER['REQUEST_URI'] ) ) {
117 // Slurp out the path portion to examine...
118 $url = $_SERVER['REQUEST_URI'];
119 if ( !preg_match( '!^https?://!', $url ) ) {
120 $url = 'http://unused' . $url;
122 MediaWiki\
suppressWarnings();
123 $a = parse_url( $url );
124 MediaWiki\restoreWarnings
();
126 $path = isset( $a['path'] ) ?
$a['path'] : '';
129 if ( $path == $wgScript && $want !== 'all' ) {
130 // Script inside a rewrite path?
131 // Abort to keep from breaking...
135 $router = new PathRouter
;
137 // Raw PATH_INFO style
138 $router->add( "$wgScript/$1" );
140 if ( isset( $_SERVER['SCRIPT_NAME'] )
141 && preg_match( '/\.php5?/', $_SERVER['SCRIPT_NAME'] )
143 # Check for SCRIPT_NAME, we handle index.php explicitly
144 # But we do have some other .php files such as img_auth.php
145 # Don't let root article paths clober the parsing for them
146 $router->add( $_SERVER['SCRIPT_NAME'] . "/$1" );
149 global $wgArticlePath;
150 if ( $wgArticlePath ) {
151 $router->add( $wgArticlePath );
154 global $wgActionPaths;
155 if ( $wgActionPaths ) {
156 $router->add( $wgActionPaths, [ 'action' => '$key' ] );
159 global $wgVariantArticlePath, $wgContLang;
160 if ( $wgVariantArticlePath ) {
161 $router->add( $wgVariantArticlePath,
162 [ 'variant' => '$2' ],
163 [ '$2' => $wgContLang->getVariants() ]
167 Hooks
::run( 'WebRequestPathInfoRouter', [ $router ] );
169 $matches = $router->parse( $path );
171 } elseif ( $wgUsePathInfo ) {
172 if ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_PATH_INFO'] != '' ) {
174 // http://bugs.php.net/bug.php?id=31892
175 // Also reported when ini_get('cgi.fix_pathinfo')==false
176 $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
178 } elseif ( isset( $_SERVER['PATH_INFO'] ) && $_SERVER['PATH_INFO'] != '' ) {
179 // Regular old PATH_INFO yay
180 $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
188 * Work out an appropriate URL prefix containing scheme and host, based on
189 * information detected from $_SERVER
193 public static function detectServer() {
194 global $wgAssumeProxiesUseDefaultProtocolPorts;
196 $proto = self
::detectProtocol();
197 $stdPort = $proto === 'https' ?
443 : 80;
199 $varNames = [ 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' ];
202 foreach ( $varNames as $varName ) {
203 if ( !isset( $_SERVER[$varName] ) ) {
207 $parts = IP
::splitHostAndPort( $_SERVER[$varName] );
209 // Invalid, do not use
214 if ( $wgAssumeProxiesUseDefaultProtocolPorts && isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) ) {
215 // Bug 70021: Assume that upstream proxy is running on the default
216 // port based on the protocol. We have no reliable way to determine
217 // the actual port in use upstream.
219 } elseif ( $parts[1] === false ) {
220 if ( isset( $_SERVER['SERVER_PORT'] ) ) {
221 $port = $_SERVER['SERVER_PORT'];
222 } // else leave it as $stdPort
229 return $proto . '://' . IP
::combineHostAndPort( $host, $port, $stdPort );
233 * Detect the protocol from $_SERVER.
234 * This is for use prior to Setup.php, when no WebRequest object is available.
235 * At other times, use the non-static function getProtocol().
239 public static function detectProtocol() {
240 if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
241 ( isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
242 $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https' ) ) {
250 * Get the number of seconds to have elapsed since request start,
251 * in fractional seconds, with microsecond resolution.
256 public function getElapsedTime() {
257 return microtime( true ) - $this->requestTime
;
261 * Get the unique request ID.
262 * This is either the value of the UNIQUE_ID envvar (if present) or a
263 * randomly-generated 24-character string.
268 public static function getRequestId() {
269 if ( !self
::$reqId ) {
270 self
::$reqId = isset( $_SERVER['UNIQUE_ID'] )
271 ?
$_SERVER['UNIQUE_ID'] : wfRandomString( 24 );
278 * Override the unique request ID. This is for sub-requests, such as jobs,
279 * that wish to use the same id but are not part of the same execution context.
284 public static function overrideRequestId( $id ) {
289 * Get the current URL protocol (http or https)
292 public function getProtocol() {
293 if ( $this->protocol
=== null ) {
294 $this->protocol
= self
::detectProtocol();
296 return $this->protocol
;
300 * Check for title, action, and/or variant data in the URL
301 * and interpolate it into the GET variables.
302 * This should only be run after $wgContLang is available,
303 * as we may need the list of language variants to determine
304 * available variant URLs.
306 public function interpolateTitle() {
307 // bug 16019: title interpolation on API queries is useless and sometimes harmful
308 if ( defined( 'MW_API' ) ) {
312 $matches = self
::getPathInfo( 'title' );
313 foreach ( $matches as $key => $val ) {
314 $this->data
[$key] = $_GET[$key] = $_REQUEST[$key] = $val;
319 * URL rewriting function; tries to extract page title and,
320 * optionally, one other fixed parameter value from a URL path.
322 * @param string $path The URL path given from the client
323 * @param array $bases One or more URLs, optionally with $1 at the end
324 * @param string|bool $key If provided, the matching key in $bases will be
325 * passed on as the value of this URL parameter
326 * @return array Array of URL variables to interpolate; empty if no match
328 static function extractTitle( $path, $bases, $key = false ) {
329 foreach ( (array)$bases as $keyValue => $base ) {
330 // Find the part after $wgArticlePath
331 $base = str_replace( '$1', '', $base );
332 $baseLen = strlen( $base );
333 if ( substr( $path, 0, $baseLen ) == $base ) {
334 $raw = substr( $path, $baseLen );
336 $matches = [ 'title' => rawurldecode( $raw ) ];
338 $matches[$key] = $keyValue;
348 * Recursively normalizes UTF-8 strings in the given array.
350 * @param string|array $data
351 * @return array|string Cleaned-up version of the given
354 function normalizeUnicode( $data ) {
355 if ( is_array( $data ) ) {
356 foreach ( $data as $key => $val ) {
357 $data[$key] = $this->normalizeUnicode( $val );
361 $data = isset( $wgContLang ) ?
362 $wgContLang->normalize( $data ) :
363 UtfNormal\Validator
::cleanUp( $data );
369 * Fetch a value from the given array or return $default if it's not set.
372 * @param string $name
373 * @param mixed $default
376 private function getGPCVal( $arr, $name, $default ) {
377 # PHP is so nice to not touch input data, except sometimes:
378 # http://us2.php.net/variables.external#language.variables.external.dot-in-names
379 # Work around PHP *feature* to avoid *bugs* elsewhere.
380 $name = strtr( $name, '.', '_' );
381 if ( isset( $arr[$name] ) ) {
384 if ( isset( $_GET[$name] ) && !is_array( $data ) ) {
385 # Check for alternate/legacy character encoding.
386 if ( isset( $wgContLang ) ) {
387 $data = $wgContLang->checkTitleEncoding( $data );
390 $data = $this->normalizeUnicode( $data );
398 * Fetch a scalar from the input without normalization, or return $default
401 * Unlike self::getVal(), this does not perform any normalization on the
405 * @param string $name
406 * @param string|null $default Optional default
409 public function getRawVal( $name, $default = null ) {
410 $name = strtr( $name, '.', '_' ); // See comment in self::getGPCVal()
411 if ( isset( $this->data
[$name] ) && !is_array( $this->data
[$name] ) ) {
412 $val = $this->data
[$name];
416 if ( is_null( $val ) ) {
424 * Fetch a scalar from the input or return $default if it's not set.
425 * Returns a string. Arrays are discarded. Useful for
426 * non-freeform text inputs (e.g. predefined internal text keys
427 * selected by a drop-down menu). For freeform input, see getText().
429 * @param string $name
430 * @param string $default Optional default (or null)
433 public function getVal( $name, $default = null ) {
434 $val = $this->getGPCVal( $this->data
, $name, $default );
435 if ( is_array( $val ) ) {
438 if ( is_null( $val ) ) {
446 * Set an arbitrary value into our get/post data.
448 * @param string $key Key name to use
449 * @param mixed $value Value to set
450 * @return mixed Old value if one was present, null otherwise
452 public function setVal( $key, $value ) {
453 $ret = isset( $this->data
[$key] ) ?
$this->data
[$key] : null;
454 $this->data
[$key] = $value;
459 * Unset an arbitrary value from our get/post data.
461 * @param string $key Key name to use
462 * @return mixed Old value if one was present, null otherwise
464 public function unsetVal( $key ) {
465 if ( !isset( $this->data
[$key] ) ) {
468 $ret = $this->data
[$key];
469 unset( $this->data
[$key] );
475 * Fetch an array from the input or return $default if it's not set.
476 * If source was scalar, will return an array with a single element.
477 * If no source and no default, returns null.
479 * @param string $name
480 * @param array $default Optional default (or null)
483 public function getArray( $name, $default = null ) {
484 $val = $this->getGPCVal( $this->data
, $name, $default );
485 if ( is_null( $val ) ) {
493 * Fetch an array of integers, or return $default if it's not set.
494 * If source was scalar, will return an array with a single element.
495 * If no source and no default, returns null.
496 * If an array is returned, contents are guaranteed to be integers.
498 * @param string $name
499 * @param array $default Option default (or null)
500 * @return array Array of ints
502 public function getIntArray( $name, $default = null ) {
503 $val = $this->getArray( $name, $default );
504 if ( is_array( $val ) ) {
505 $val = array_map( 'intval', $val );
511 * Fetch an integer value from the input or return $default if not set.
512 * Guaranteed to return an integer; non-numeric input will typically
515 * @param string $name
516 * @param int $default
519 public function getInt( $name, $default = 0 ) {
520 return intval( $this->getVal( $name, $default ) );
524 * Fetch an integer value from the input or return null if empty.
525 * Guaranteed to return an integer or null; non-numeric input will
526 * typically return null.
528 * @param string $name
531 public function getIntOrNull( $name ) {
532 $val = $this->getVal( $name );
533 return is_numeric( $val )
539 * Fetch a floating point value from the input or return $default if not set.
540 * Guaranteed to return a float; non-numeric input will typically
544 * @param string $name
545 * @param float $default
548 public function getFloat( $name, $default = 0.0 ) {
549 return floatval( $this->getVal( $name, $default ) );
553 * Fetch a boolean value from the input or return $default if not set.
554 * Guaranteed to return true or false, with normal PHP semantics for
555 * boolean interpretation of strings.
557 * @param string $name
558 * @param bool $default
561 public function getBool( $name, $default = false ) {
562 return (bool)$this->getVal( $name, $default );
566 * Fetch a boolean value from the input or return $default if not set.
567 * Unlike getBool, the string "false" will result in boolean false, which is
568 * useful when interpreting information sent from JavaScript.
570 * @param string $name
571 * @param bool $default
574 public function getFuzzyBool( $name, $default = false ) {
575 return $this->getBool( $name, $default ) && strcasecmp( $this->getVal( $name ), 'false' ) !== 0;
579 * Return true if the named value is set in the input, whatever that
580 * value is (even "0"). Return false if the named value is not set.
581 * Example use is checking for the presence of check boxes in forms.
583 * @param string $name
586 public function getCheck( $name ) {
587 # Checkboxes and buttons are only present when clicked
588 # Presence connotes truth, absence false
589 return $this->getVal( $name, null ) !== null;
593 * Fetch a text string from the given array or return $default if it's not
594 * set. Carriage returns are stripped from the text. This should generally
595 * be used for form "<textarea>" and "<input>" fields, and for
596 * user-supplied freeform text input.
598 * @param string $name
599 * @param string $default Optional
602 public function getText( $name, $default = '' ) {
603 $val = $this->getVal( $name, $default );
604 return str_replace( "\r\n", "\n", $val );
608 * Extracts the given named values into an array.
609 * If no arguments are given, returns all input values.
610 * No transformation is performed on the values.
614 public function getValues() {
615 $names = func_get_args();
616 if ( count( $names ) == 0 ) {
617 $names = array_keys( $this->data
);
621 foreach ( $names as $name ) {
622 $value = $this->getGPCVal( $this->data
, $name, null );
623 if ( !is_null( $value ) ) {
624 $retVal[$name] = $value;
631 * Returns the names of all input values excluding those in $exclude.
633 * @param array $exclude
636 public function getValueNames( $exclude = [] ) {
637 return array_diff( array_keys( $this->getValues() ), $exclude );
641 * Get the values passed in the query string.
642 * No transformation is performed on the values.
646 public function getQueryValues() {
651 * Return the contents of the Query with no decoding. Use when you need to
652 * know exactly what was sent, e.g. for an OAuth signature over the elements.
656 public function getRawQueryString() {
657 return $_SERVER['QUERY_STRING'];
661 * Return the contents of the POST with no decoding. Use when you need to
662 * know exactly what was sent, e.g. for an OAuth signature over the elements.
666 public function getRawPostString() {
667 if ( !$this->wasPosted() ) {
670 return $this->getRawInput();
674 * Return the raw request body, with no processing. Cached since some methods
675 * disallow reading the stream more than once. As stated in the php docs, this
676 * does not work with enctype="multipart/form-data".
680 public function getRawInput() {
681 static $input = null;
682 if ( $input === null ) {
683 $input = file_get_contents( 'php://input' );
689 * Get the HTTP method used for this request.
693 public function getMethod() {
694 return isset( $_SERVER['REQUEST_METHOD'] ) ?
$_SERVER['REQUEST_METHOD'] : 'GET';
698 * Returns true if the present request was reached by a POST operation,
699 * false otherwise (GET, HEAD, or command-line).
701 * Note that values retrieved by the object may come from the
702 * GET URL etc even on a POST request.
706 public function wasPosted() {
707 return $this->getMethod() == 'POST';
711 * Return the session for this request
713 * @note For performance, keep the session locally if you will be making
714 * much use of it instead of calling this method repeatedly.
717 public function getSession() {
718 if ( $this->sessionId
!== null ) {
719 $session = SessionManager
::singleton()->getSessionById( (string)$this->sessionId
, true, $this );
725 $session = SessionManager
::singleton()->getSessionForRequest( $this );
726 $this->sessionId
= $session->getSessionId();
731 * Set the session for this request
733 * @private For use by MediaWiki\Session classes only
734 * @param SessionId $sessionId
736 public function setSessionId( SessionId
$sessionId ) {
737 $this->sessionId
= $sessionId;
741 * Get the session id for this request, if any
743 * @private For use by MediaWiki\Session classes only
744 * @return SessionId|null
746 public function getSessionId() {
747 return $this->sessionId
;
751 * Returns true if the request has a persistent session.
752 * This does not necessarily mean that the user is logged in!
754 * @deprecated since 1.27, use
755 * \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId()
759 public function checkSessionCookie() {
760 global $wgInitialSessionId;
761 wfDeprecated( __METHOD__
, '1.27' );
762 return $wgInitialSessionId !== null &&
763 $this->getSession()->getId() === (string)$wgInitialSessionId;
767 * Get a cookie from the $_COOKIE jar
769 * @param string $key The name of the cookie
770 * @param string $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
771 * @param mixed $default What to return if the value isn't found
772 * @return mixed Cookie value or $default if the cookie not set
774 public function getCookie( $key, $prefix = null, $default = null ) {
775 if ( $prefix === null ) {
776 global $wgCookiePrefix;
777 $prefix = $wgCookiePrefix;
779 return $this->getGPCVal( $_COOKIE, $prefix . $key, $default );
783 * Return the path and query string portion of the main request URI.
784 * This will be suitable for use as a relative link in HTML output.
786 * @throws MWException
789 public static function getGlobalRequestURL() {
790 if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
791 $base = $_SERVER['REQUEST_URI'];
792 } elseif ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] )
793 && strlen( $_SERVER['HTTP_X_ORIGINAL_URL'] )
795 // Probably IIS; doesn't set REQUEST_URI
796 $base = $_SERVER['HTTP_X_ORIGINAL_URL'];
797 } elseif ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
798 $base = $_SERVER['SCRIPT_NAME'];
799 if ( isset( $_SERVER['QUERY_STRING'] ) && $_SERVER['QUERY_STRING'] != '' ) {
800 $base .= '?' . $_SERVER['QUERY_STRING'];
803 // This shouldn't happen!
804 throw new MWException( "Web server doesn't provide either " .
805 "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
806 "of your web server configuration to https://phabricator.wikimedia.org/" );
808 // User-agents should not send a fragment with the URI, but
809 // if they do, and the web server passes it on to us, we
810 // need to strip it or we get false-positive redirect loops
811 // or weird output URLs
812 $hash = strpos( $base, '#' );
813 if ( $hash !== false ) {
814 $base = substr( $base, 0, $hash );
817 if ( $base[0] == '/' ) {
818 // More than one slash will look like it is protocol relative
819 return preg_replace( '!^/+!', '/', $base );
821 // We may get paths with a host prepended; strip it.
822 return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
827 * Return the path and query string portion of the request URI.
828 * This will be suitable for use as a relative link in HTML output.
830 * @throws MWException
833 public function getRequestURL() {
834 return self
::getGlobalRequestURL();
838 * Return the request URI with the canonical service and hostname, path,
839 * and query string. This will be suitable for use as an absolute link
840 * in HTML or other output.
842 * If $wgServer is protocol-relative, this will return a fully
843 * qualified URL with the protocol that was used for this request.
847 public function getFullRequestURL() {
848 return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT
);
853 * @param string $value
856 public function appendQueryValue( $key, $value ) {
857 return $this->appendQueryArray( [ $key => $value ] );
861 * Appends or replaces value of query variables.
863 * @param array $array Array of values to replace/add to query
866 public function appendQueryArray( $array ) {
867 $newquery = $this->getQueryValues();
868 unset( $newquery['title'] );
869 $newquery = array_merge( $newquery, $array );
871 return wfArrayToCgi( $newquery );
875 * Check for limit and offset parameters on the input, and return sensible
876 * defaults if not given. The limit must be positive and is capped at 5000.
877 * Offset must be positive but is not capped.
879 * @param int $deflimit Limit to use if no input and the user hasn't set the option.
880 * @param string $optionname To specify an option other than rclimit to pull from.
881 * @return int[] First element is limit, second is offset
883 public function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
886 $limit = $this->getInt( 'limit', 0 );
890 if ( ( $limit == 0 ) && ( $optionname != '' ) ) {
891 $limit = $wgUser->getIntOption( $optionname );
896 if ( $limit > 5000 ) {
897 $limit = 5000; # We have *some* limits...
900 $offset = $this->getInt( 'offset', 0 );
905 return [ $limit, $offset ];
909 * Return the path to the temporary file where PHP has stored the upload.
912 * @return string|null String or null if no such file.
914 public function getFileTempname( $key ) {
915 $file = new WebRequestUpload( $this, $key );
916 return $file->getTempName();
920 * Return the upload error or 0
925 public function getUploadError( $key ) {
926 $file = new WebRequestUpload( $this, $key );
927 return $file->getError();
931 * Return the original filename of the uploaded file, as reported by
932 * the submitting user agent. HTML-style character entities are
933 * interpreted and normalized to Unicode normalization form C, in part
934 * to deal with weird input from Safari with non-ASCII filenames.
936 * Other than this the name is not verified for being a safe filename.
939 * @return string|null String or null if no such file.
941 public function getFileName( $key ) {
942 $file = new WebRequestUpload( $this, $key );
943 return $file->getName();
947 * Return a WebRequestUpload object corresponding to the key
950 * @return WebRequestUpload
952 public function getUpload( $key ) {
953 return new WebRequestUpload( $this, $key );
957 * Return a handle to WebResponse style object, for setting cookies,
958 * headers and other stuff, for Request being worked on.
960 * @return WebResponse
962 public function response() {
963 /* Lazy initialization of response object for this request */
964 if ( !is_object( $this->response
) ) {
965 $class = ( $this instanceof FauxRequest
) ?
'FauxResponse' : 'WebResponse';
966 $this->response
= new $class();
968 return $this->response
;
972 * Initialise the header list
974 protected function initHeaders() {
975 if ( count( $this->headers
) ) {
979 $apacheHeaders = function_exists( 'apache_request_headers' ) ?
apache_request_headers() : false;
980 if ( $apacheHeaders ) {
981 foreach ( $apacheHeaders as $tempName => $tempValue ) {
982 $this->headers
[strtoupper( $tempName )] = $tempValue;
985 foreach ( $_SERVER as $name => $value ) {
986 if ( substr( $name, 0, 5 ) === 'HTTP_' ) {
987 $name = str_replace( '_', '-', substr( $name, 5 ) );
988 $this->headers
[$name] = $value;
989 } elseif ( $name === 'CONTENT_LENGTH' ) {
990 $this->headers
['CONTENT-LENGTH'] = $value;
997 * Get an array containing all request headers
999 * @return array Mapping header name to its value
1001 public function getAllHeaders() {
1002 $this->initHeaders();
1003 return $this->headers
;
1007 * Get a request header, or false if it isn't set.
1009 * @param string $name Case-insensitive header name
1010 * @param int $flags Bitwise combination of:
1011 * WebRequest::GETHEADER_LIST Treat the header as a comma-separated list
1012 * of values, as described in RFC 2616 § 4.2.
1014 * @return string|array|bool False if header is unset; otherwise the
1015 * header value(s) as either a string (the default) or an array, if
1016 * WebRequest::GETHEADER_LIST flag was set.
1018 public function getHeader( $name, $flags = 0 ) {
1019 $this->initHeaders();
1020 $name = strtoupper( $name );
1021 if ( !isset( $this->headers
[$name] ) ) {
1024 $value = $this->headers
[$name];
1025 if ( $flags & self
::GETHEADER_LIST
) {
1026 $value = array_map( 'trim', explode( ',', $value ) );
1032 * Get data from the session
1034 * @note Prefer $this->getSession() instead if making multiple calls.
1035 * @param string $key Name of key in the session
1038 public function getSessionData( $key ) {
1039 return $this->getSession()->get( $key );
1045 * @note Prefer $this->getSession() instead if making multiple calls.
1046 * @param string $key Name of key in the session
1047 * @param mixed $data
1049 public function setSessionData( $key, $data ) {
1050 $this->getSession()->set( $key, $data );
1054 * Check if Internet Explorer will detect an incorrect cache extension in
1055 * PATH_INFO or QUERY_STRING. If the request can't be allowed, show an error
1056 * message or redirect to a safer URL. Returns true if the URL is OK, and
1057 * false if an error message has been shown and the request should be aborted.
1059 * @param array $extWhitelist
1063 public function checkUrlExtension( $extWhitelist = [] ) {
1064 $extWhitelist[] = 'php';
1065 if ( IEUrlExtension
::areServerVarsBad( $_SERVER, $extWhitelist ) ) {
1066 if ( !$this->wasPosted() ) {
1067 $newUrl = IEUrlExtension
::fixUrlForIE6(
1068 $this->getFullRequestURL(), $extWhitelist );
1069 if ( $newUrl !== false ) {
1070 $this->doSecurityRedirect( $newUrl );
1074 throw new HttpError( 403,
1075 'Invalid file extension found in the path info or query string.' );
1081 * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
1082 * IE 6. Returns true if it was successful, false otherwise.
1084 * @param string $url
1087 protected function doSecurityRedirect( $url ) {
1088 header( 'Location: ' . $url );
1089 header( 'Content-Type: text/html' );
1090 $encUrl = htmlspecialchars( $url );
1094 <title>Security redirect</title>
1097 <h1>Security redirect</h1>
1099 We can't serve non-HTML content from the URL you have requested
, because
1100 Internet Explorer would interpret it
as an incorrect
and potentially dangerous
1102 <p
>Instead
, please
use <a href
="$encUrl">this URL
</a
>, which is the same
as the
1103 URL you have requested
, except that
"&*" is appended
. This prevents Internet
1104 Explorer from seeing a bogus file extension
.
1114 * Parse the Accept-Language header sent by the client into an array
1116 * @return array Array( languageCode => q-value ) sorted by q-value in
1117 * descending order then appearing time in the header in ascending order.
1118 * May contain the "language" '*', which applies to languages other than those explicitly listed.
1119 * This is aligned with rfc2616 section 14.4
1120 * Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.
1122 public function getAcceptLang() {
1123 // Modified version of code found at
1124 // http://www.thefutureoftheweb.com/blog/use-accept-language-header
1125 $acceptLang = $this->getHeader( 'Accept-Language' );
1126 if ( !$acceptLang ) {
1130 // Return the language codes in lower case
1131 $acceptLang = strtolower( $acceptLang );
1133 // Break up string into pieces (languages and q factors)
1136 '/([a-z]{1,8}(-[a-z]{1,8})*|\*)\s*(;\s*q\s*=\s*(1(\.0{0,3})?|0(\.[0-9]{0,3})?)?)?/',
1141 if ( !count( $lang_parse[1] ) ) {
1145 $langcodes = $lang_parse[1];
1146 $qvalues = $lang_parse[4];
1147 $indices = range( 0, count( $lang_parse[1] ) - 1 );
1149 // Set default q factor to 1
1150 foreach ( $indices as $index ) {
1151 if ( $qvalues[$index] === '' ) {
1152 $qvalues[$index] = 1;
1153 } elseif ( $qvalues[$index] == 0 ) {
1154 unset( $langcodes[$index], $qvalues[$index], $indices[$index] );
1158 // Sort list. First by $qvalues, then by order. Reorder $langcodes the same way
1159 array_multisort( $qvalues, SORT_DESC
, SORT_NUMERIC
, $indices, $langcodes );
1161 // Create a list like "en" => 0.8
1162 $langs = array_combine( $langcodes, $qvalues );
1168 * Fetch the raw IP from the request
1172 * @throws MWException
1175 protected function getRawIP() {
1176 if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
1180 if ( is_array( $_SERVER['REMOTE_ADDR'] ) ||
strpos( $_SERVER['REMOTE_ADDR'], ',' ) !== false ) {
1181 throw new MWException( __METHOD__
1182 . " : Could not determine the remote IP address due to multiple values." );
1184 $ipchain = $_SERVER['REMOTE_ADDR'];
1187 return IP
::canonicalize( $ipchain );
1191 * Work out the IP address based on various globals
1192 * For trusted proxies, use the XFF client IP (first of the chain)
1196 * @throws MWException
1199 public function getIP() {
1200 global $wgUsePrivateIPs;
1202 # Return cached result
1203 if ( $this->ip
!== null ) {
1207 # collect the originating ips
1208 $ip = $this->getRawIP();
1210 throw new MWException( 'Unable to determine IP.' );
1214 $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
1215 if ( $forwardedFor !== false ) {
1216 $isConfigured = IP
::isConfiguredProxy( $ip );
1217 $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
1218 $ipchain = array_reverse( $ipchain );
1219 array_unshift( $ipchain, $ip );
1221 # Step through XFF list and find the last address in the list which is a
1222 # trusted server. Set $ip to the IP address given by that trusted server,
1223 # unless the address is not sensible (e.g. private). However, prefer private
1224 # IP addresses over proxy servers controlled by this site (more sensible).
1225 # Note that some XFF values might be "unknown" with Squid/Varnish.
1226 foreach ( $ipchain as $i => $curIP ) {
1227 $curIP = IP
::sanitizeIP( IP
::canonicalize( $curIP ) );
1228 if ( !$curIP ||
!isset( $ipchain[$i +
1] ) ||
$ipchain[$i +
1] === 'unknown'
1229 ||
!IP
::isTrustedProxy( $curIP )
1231 break; // IP is not valid/trusted or does not point to anything
1234 IP
::isPublic( $ipchain[$i +
1] ) ||
1236 IP
::isConfiguredProxy( $curIP ) // bug 48919; treat IP as sane
1238 // Follow the next IP according to the proxy
1239 $nextIP = IP
::canonicalize( $ipchain[$i +
1] );
1240 if ( !$nextIP && $isConfigured ) {
1241 // We have not yet made it past CDN/proxy servers of this site,
1242 // so either they are misconfigured or there is some IP spoofing.
1243 throw new MWException( "Invalid IP given in XFF '$forwardedFor'." );
1246 // keep traversing the chain
1253 # Allow extensions to improve our guess
1254 Hooks
::run( 'GetIP', [ &$ip ] );
1257 throw new MWException( "Unable to determine IP." );
1260 wfDebug( "IP: $ip\n" );
1270 public function setIP( $ip ) {
1275 * Check if this request uses a "safe" HTTP method
1277 * Safe methods are verbs (e.g. GET/HEAD/OPTIONS) used for obtaining content. Such requests
1278 * are not expected to mutate content, especially in ways attributable to the client. Verbs
1279 * like POST and PUT are typical of non-safe requests which often change content.
1282 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1283 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1286 public function hasSafeMethod() {
1287 if ( !isset( $_SERVER['REQUEST_METHOD'] ) ) {
1288 return false; // CLI mode
1291 return in_array( $_SERVER['REQUEST_METHOD'], [ 'GET', 'HEAD', 'OPTIONS', 'TRACE' ] );
1295 * Whether this request should be identified as being "safe"
1297 * This means that the client is not requesting any state changes and that database writes
1298 * are not inherently required. Ideally, no visible updates would happen at all. If they
1299 * must, then they should not be publically attributed to the end user.
1302 * - Cache populations and refreshes MAY occur.
1303 * - Private user session updates and private server logging MAY occur.
1304 * - Updates to private viewing activity data MAY occur via DeferredUpdates.
1305 * - Other updates SHOULD NOT occur (e.g. modifying content assets).
1308 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1309 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1312 public function isSafeRequest() {
1313 if ( $this->markedAsSafe
&& $this->wasPosted() ) {
1314 return true; // marked as a "safe" POST
1317 return $this->hasSafeMethod();
1321 * Mark this request as identified as being nullipotent even if it is a POST request
1323 * POST requests are often used due to the need for a client payload, even if the request
1324 * is otherwise equivalent to a "safe method" request.
1326 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1327 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1330 public function markAsSafeRequest() {
1331 $this->markedAsSafe
= true;