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 or return $default if it's not set.
399 * Returns a string. Arrays are discarded. Useful for
400 * non-freeform text inputs (e.g. predefined internal text keys
401 * selected by a drop-down menu). For freeform input, see getText().
403 * @param string $name
404 * @param string $default Optional default (or null)
407 public function getVal( $name, $default = null ) {
408 $val = $this->getGPCVal( $this->data
, $name, $default );
409 if ( is_array( $val ) ) {
412 if ( is_null( $val ) ) {
420 * Set an arbitrary value into our get/post data.
422 * @param string $key Key name to use
423 * @param mixed $value Value to set
424 * @return mixed Old value if one was present, null otherwise
426 public function setVal( $key, $value ) {
427 $ret = isset( $this->data
[$key] ) ?
$this->data
[$key] : null;
428 $this->data
[$key] = $value;
433 * Unset an arbitrary value from our get/post data.
435 * @param string $key Key name to use
436 * @return mixed Old value if one was present, null otherwise
438 public function unsetVal( $key ) {
439 if ( !isset( $this->data
[$key] ) ) {
442 $ret = $this->data
[$key];
443 unset( $this->data
[$key] );
449 * Fetch an array from the input or return $default if it's not set.
450 * If source was scalar, will return an array with a single element.
451 * If no source and no default, returns null.
453 * @param string $name
454 * @param array $default Optional default (or null)
457 public function getArray( $name, $default = null ) {
458 $val = $this->getGPCVal( $this->data
, $name, $default );
459 if ( is_null( $val ) ) {
467 * Fetch an array of integers, or return $default if it's not set.
468 * If source was scalar, will return an array with a single element.
469 * If no source and no default, returns null.
470 * If an array is returned, contents are guaranteed to be integers.
472 * @param string $name
473 * @param array $default Option default (or null)
474 * @return array Array of ints
476 public function getIntArray( $name, $default = null ) {
477 $val = $this->getArray( $name, $default );
478 if ( is_array( $val ) ) {
479 $val = array_map( 'intval', $val );
485 * Fetch an integer value from the input or return $default if not set.
486 * Guaranteed to return an integer; non-numeric input will typically
489 * @param string $name
490 * @param int $default
493 public function getInt( $name, $default = 0 ) {
494 return intval( $this->getVal( $name, $default ) );
498 * Fetch an integer value from the input or return null if empty.
499 * Guaranteed to return an integer or null; non-numeric input will
500 * typically return null.
502 * @param string $name
505 public function getIntOrNull( $name ) {
506 $val = $this->getVal( $name );
507 return is_numeric( $val )
513 * Fetch a floating point value from the input or return $default if not set.
514 * Guaranteed to return a float; non-numeric input will typically
518 * @param string $name
519 * @param float $default
522 public function getFloat( $name, $default = 0.0 ) {
523 return floatval( $this->getVal( $name, $default ) );
527 * Fetch a boolean value from the input or return $default if not set.
528 * Guaranteed to return true or false, with normal PHP semantics for
529 * boolean interpretation of strings.
531 * @param string $name
532 * @param bool $default
535 public function getBool( $name, $default = false ) {
536 return (bool)$this->getVal( $name, $default );
540 * Fetch a boolean value from the input or return $default if not set.
541 * Unlike getBool, the string "false" will result in boolean false, which is
542 * useful when interpreting information sent from JavaScript.
544 * @param string $name
545 * @param bool $default
548 public function getFuzzyBool( $name, $default = false ) {
549 return $this->getBool( $name, $default ) && strcasecmp( $this->getVal( $name ), 'false' ) !== 0;
553 * Return true if the named value is set in the input, whatever that
554 * value is (even "0"). Return false if the named value is not set.
555 * Example use is checking for the presence of check boxes in forms.
557 * @param string $name
560 public function getCheck( $name ) {
561 # Checkboxes and buttons are only present when clicked
562 # Presence connotes truth, absence false
563 return $this->getVal( $name, null ) !== null;
567 * Fetch a text string from the given array or return $default if it's not
568 * set. Carriage returns are stripped from the text, and with some language
569 * modules there is an input transliteration applied. This should generally
570 * be used for form "<textarea>" and "<input>" fields, and for
571 * user-supplied freeform text input.
573 * @param string $name
574 * @param string $default Optional
577 public function getText( $name, $default = '' ) {
578 $val = $this->getVal( $name, $default );
579 return str_replace( "\r\n", "\n", $val );
583 * Extracts the given named values into an array.
584 * If no arguments are given, returns all input values.
585 * No transformation is performed on the values.
589 public function getValues() {
590 $names = func_get_args();
591 if ( count( $names ) == 0 ) {
592 $names = array_keys( $this->data
);
596 foreach ( $names as $name ) {
597 $value = $this->getGPCVal( $this->data
, $name, null );
598 if ( !is_null( $value ) ) {
599 $retVal[$name] = $value;
606 * Returns the names of all input values excluding those in $exclude.
608 * @param array $exclude
611 public function getValueNames( $exclude = [] ) {
612 return array_diff( array_keys( $this->getValues() ), $exclude );
616 * Get the values passed in the query string.
617 * No transformation is performed on the values.
621 public function getQueryValues() {
626 * Return the contents of the Query with no decoding. Use when you need to
627 * know exactly what was sent, e.g. for an OAuth signature over the elements.
631 public function getRawQueryString() {
632 return $_SERVER['QUERY_STRING'];
636 * Return the contents of the POST with no decoding. Use when you need to
637 * know exactly what was sent, e.g. for an OAuth signature over the elements.
641 public function getRawPostString() {
642 if ( !$this->wasPosted() ) {
645 return $this->getRawInput();
649 * Return the raw request body, with no processing. Cached since some methods
650 * disallow reading the stream more than once. As stated in the php docs, this
651 * does not work with enctype="multipart/form-data".
655 public function getRawInput() {
656 static $input = null;
657 if ( $input === null ) {
658 $input = file_get_contents( 'php://input' );
664 * Get the HTTP method used for this request.
668 public function getMethod() {
669 return isset( $_SERVER['REQUEST_METHOD'] ) ?
$_SERVER['REQUEST_METHOD'] : 'GET';
673 * Returns true if the present request was reached by a POST operation,
674 * false otherwise (GET, HEAD, or command-line).
676 * Note that values retrieved by the object may come from the
677 * GET URL etc even on a POST request.
681 public function wasPosted() {
682 return $this->getMethod() == 'POST';
686 * Return the session for this request
688 * @note For performance, keep the session locally if you will be making
689 * much use of it instead of calling this method repeatedly.
692 public function getSession() {
693 if ( $this->sessionId
!== null ) {
694 $session = SessionManager
::singleton()->getSessionById( (string)$this->sessionId
, true, $this );
700 $session = SessionManager
::singleton()->getSessionForRequest( $this );
701 $this->sessionId
= $session->getSessionId();
706 * Set the session for this request
708 * @private For use by MediaWiki\Session classes only
709 * @param SessionId $sessionId
711 public function setSessionId( SessionId
$sessionId ) {
712 $this->sessionId
= $sessionId;
716 * Get the session id for this request, if any
718 * @private For use by MediaWiki\Session classes only
719 * @return SessionId|null
721 public function getSessionId() {
722 return $this->sessionId
;
726 * Returns true if the request has a persistent session.
727 * This does not necessarily mean that the user is logged in!
729 * @deprecated since 1.27, use
730 * \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId()
734 public function checkSessionCookie() {
735 global $wgInitialSessionId;
736 wfDeprecated( __METHOD__
, '1.27' );
737 return $wgInitialSessionId !== null &&
738 $this->getSession()->getId() === (string)$wgInitialSessionId;
742 * Get a cookie from the $_COOKIE jar
744 * @param string $key The name of the cookie
745 * @param string $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
746 * @param mixed $default What to return if the value isn't found
747 * @return mixed Cookie value or $default if the cookie not set
749 public function getCookie( $key, $prefix = null, $default = null ) {
750 if ( $prefix === null ) {
751 global $wgCookiePrefix;
752 $prefix = $wgCookiePrefix;
754 return $this->getGPCVal( $_COOKIE, $prefix . $key, $default );
758 * Return the path and query string portion of the main request URI.
759 * This will be suitable for use as a relative link in HTML output.
761 * @throws MWException
764 public static function getGlobalRequestURL() {
765 if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
766 $base = $_SERVER['REQUEST_URI'];
767 } elseif ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] )
768 && strlen( $_SERVER['HTTP_X_ORIGINAL_URL'] )
770 // Probably IIS; doesn't set REQUEST_URI
771 $base = $_SERVER['HTTP_X_ORIGINAL_URL'];
772 } elseif ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
773 $base = $_SERVER['SCRIPT_NAME'];
774 if ( isset( $_SERVER['QUERY_STRING'] ) && $_SERVER['QUERY_STRING'] != '' ) {
775 $base .= '?' . $_SERVER['QUERY_STRING'];
778 // This shouldn't happen!
779 throw new MWException( "Web server doesn't provide either " .
780 "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
781 "of your web server configuration to https://phabricator.wikimedia.org/" );
783 // User-agents should not send a fragment with the URI, but
784 // if they do, and the web server passes it on to us, we
785 // need to strip it or we get false-positive redirect loops
786 // or weird output URLs
787 $hash = strpos( $base, '#' );
788 if ( $hash !== false ) {
789 $base = substr( $base, 0, $hash );
792 if ( $base[0] == '/' ) {
793 // More than one slash will look like it is protocol relative
794 return preg_replace( '!^/+!', '/', $base );
796 // We may get paths with a host prepended; strip it.
797 return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
802 * Return the path and query string portion of the request URI.
803 * This will be suitable for use as a relative link in HTML output.
805 * @throws MWException
808 public function getRequestURL() {
809 return self
::getGlobalRequestURL();
813 * Return the request URI with the canonical service and hostname, path,
814 * and query string. This will be suitable for use as an absolute link
815 * in HTML or other output.
817 * If $wgServer is protocol-relative, this will return a fully
818 * qualified URL with the protocol that was used for this request.
822 public function getFullRequestURL() {
823 return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT
);
828 * @param string $value
831 public function appendQueryValue( $key, $value ) {
832 return $this->appendQueryArray( [ $key => $value ] );
836 * Appends or replaces value of query variables.
838 * @param array $array Array of values to replace/add to query
841 public function appendQueryArray( $array ) {
842 $newquery = $this->getQueryValues();
843 unset( $newquery['title'] );
844 $newquery = array_merge( $newquery, $array );
846 return wfArrayToCgi( $newquery );
850 * Check for limit and offset parameters on the input, and return sensible
851 * defaults if not given. The limit must be positive and is capped at 5000.
852 * Offset must be positive but is not capped.
854 * @param int $deflimit Limit to use if no input and the user hasn't set the option.
855 * @param string $optionname To specify an option other than rclimit to pull from.
856 * @return int[] First element is limit, second is offset
858 public function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
861 $limit = $this->getInt( 'limit', 0 );
865 if ( ( $limit == 0 ) && ( $optionname != '' ) ) {
866 $limit = $wgUser->getIntOption( $optionname );
871 if ( $limit > 5000 ) {
872 $limit = 5000; # We have *some* limits...
875 $offset = $this->getInt( 'offset', 0 );
880 return [ $limit, $offset ];
884 * Return the path to the temporary file where PHP has stored the upload.
887 * @return string|null String or null if no such file.
889 public function getFileTempname( $key ) {
890 $file = new WebRequestUpload( $this, $key );
891 return $file->getTempName();
895 * Return the upload error or 0
900 public function getUploadError( $key ) {
901 $file = new WebRequestUpload( $this, $key );
902 return $file->getError();
906 * Return the original filename of the uploaded file, as reported by
907 * the submitting user agent. HTML-style character entities are
908 * interpreted and normalized to Unicode normalization form C, in part
909 * to deal with weird input from Safari with non-ASCII filenames.
911 * Other than this the name is not verified for being a safe filename.
914 * @return string|null String or null if no such file.
916 public function getFileName( $key ) {
917 $file = new WebRequestUpload( $this, $key );
918 return $file->getName();
922 * Return a WebRequestUpload object corresponding to the key
925 * @return WebRequestUpload
927 public function getUpload( $key ) {
928 return new WebRequestUpload( $this, $key );
932 * Return a handle to WebResponse style object, for setting cookies,
933 * headers and other stuff, for Request being worked on.
935 * @return WebResponse
937 public function response() {
938 /* Lazy initialization of response object for this request */
939 if ( !is_object( $this->response
) ) {
940 $class = ( $this instanceof FauxRequest
) ?
'FauxResponse' : 'WebResponse';
941 $this->response
= new $class();
943 return $this->response
;
947 * Initialise the header list
949 protected function initHeaders() {
950 if ( count( $this->headers
) ) {
954 $apacheHeaders = function_exists( 'apache_request_headers' ) ?
apache_request_headers() : false;
955 if ( $apacheHeaders ) {
956 foreach ( $apacheHeaders as $tempName => $tempValue ) {
957 $this->headers
[strtoupper( $tempName )] = $tempValue;
960 foreach ( $_SERVER as $name => $value ) {
961 if ( substr( $name, 0, 5 ) === 'HTTP_' ) {
962 $name = str_replace( '_', '-', substr( $name, 5 ) );
963 $this->headers
[$name] = $value;
964 } elseif ( $name === 'CONTENT_LENGTH' ) {
965 $this->headers
['CONTENT-LENGTH'] = $value;
972 * Get an array containing all request headers
974 * @return array Mapping header name to its value
976 public function getAllHeaders() {
977 $this->initHeaders();
978 return $this->headers
;
982 * Get a request header, or false if it isn't set.
984 * @param string $name Case-insensitive header name
985 * @param int $flags Bitwise combination of:
986 * WebRequest::GETHEADER_LIST Treat the header as a comma-separated list
987 * of values, as described in RFC 2616 § 4.2.
989 * @return string|array|bool False if header is unset; otherwise the
990 * header value(s) as either a string (the default) or an array, if
991 * WebRequest::GETHEADER_LIST flag was set.
993 public function getHeader( $name, $flags = 0 ) {
994 $this->initHeaders();
995 $name = strtoupper( $name );
996 if ( !isset( $this->headers
[$name] ) ) {
999 $value = $this->headers
[$name];
1000 if ( $flags & self
::GETHEADER_LIST
) {
1001 $value = array_map( 'trim', explode( ',', $value ) );
1007 * Get data from the session
1009 * @note Prefer $this->getSession() instead if making multiple calls.
1010 * @param string $key Name of key in the session
1013 public function getSessionData( $key ) {
1014 return $this->getSession()->get( $key );
1020 * @note Prefer $this->getSession() instead if making multiple calls.
1021 * @param string $key Name of key in the session
1022 * @param mixed $data
1024 public function setSessionData( $key, $data ) {
1025 $this->getSession()->set( $key, $data );
1029 * Check if Internet Explorer will detect an incorrect cache extension in
1030 * PATH_INFO or QUERY_STRING. If the request can't be allowed, show an error
1031 * message or redirect to a safer URL. Returns true if the URL is OK, and
1032 * false if an error message has been shown and the request should be aborted.
1034 * @param array $extWhitelist
1038 public function checkUrlExtension( $extWhitelist = [] ) {
1039 $extWhitelist[] = 'php';
1040 if ( IEUrlExtension
::areServerVarsBad( $_SERVER, $extWhitelist ) ) {
1041 if ( !$this->wasPosted() ) {
1042 $newUrl = IEUrlExtension
::fixUrlForIE6(
1043 $this->getFullRequestURL(), $extWhitelist );
1044 if ( $newUrl !== false ) {
1045 $this->doSecurityRedirect( $newUrl );
1049 throw new HttpError( 403,
1050 'Invalid file extension found in the path info or query string.' );
1056 * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
1057 * IE 6. Returns true if it was successful, false otherwise.
1059 * @param string $url
1062 protected function doSecurityRedirect( $url ) {
1063 header( 'Location: ' . $url );
1064 header( 'Content-Type: text/html' );
1065 $encUrl = htmlspecialchars( $url );
1069 <title>Security redirect</title>
1072 <h1>Security redirect</h1>
1074 We can't serve non-HTML content from the URL you have requested
, because
1075 Internet Explorer would interpret it
as an incorrect
and potentially dangerous
1077 <p
>Instead
, please
use <a href
="$encUrl">this URL
</a
>, which is the same
as the
1078 URL you have requested
, except that
"&*" is appended
. This prevents Internet
1079 Explorer from seeing a bogus file extension
.
1089 * Parse the Accept-Language header sent by the client into an array
1091 * @return array Array( languageCode => q-value ) sorted by q-value in
1092 * descending order then appearing time in the header in ascending order.
1093 * May contain the "language" '*', which applies to languages other than those explicitly listed.
1094 * This is aligned with rfc2616 section 14.4
1095 * Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.
1097 public function getAcceptLang() {
1098 // Modified version of code found at
1099 // http://www.thefutureoftheweb.com/blog/use-accept-language-header
1100 $acceptLang = $this->getHeader( 'Accept-Language' );
1101 if ( !$acceptLang ) {
1105 // Return the language codes in lower case
1106 $acceptLang = strtolower( $acceptLang );
1108 // Break up string into pieces (languages and q factors)
1111 '/([a-z]{1,8}(-[a-z]{1,8})*|\*)\s*(;\s*q\s*=\s*(1(\.0{0,3})?|0(\.[0-9]{0,3})?)?)?/',
1116 if ( !count( $lang_parse[1] ) ) {
1120 $langcodes = $lang_parse[1];
1121 $qvalues = $lang_parse[4];
1122 $indices = range( 0, count( $lang_parse[1] ) - 1 );
1124 // Set default q factor to 1
1125 foreach ( $indices as $index ) {
1126 if ( $qvalues[$index] === '' ) {
1127 $qvalues[$index] = 1;
1128 } elseif ( $qvalues[$index] == 0 ) {
1129 unset( $langcodes[$index], $qvalues[$index], $indices[$index] );
1133 // Sort list. First by $qvalues, then by order. Reorder $langcodes the same way
1134 array_multisort( $qvalues, SORT_DESC
, SORT_NUMERIC
, $indices, $langcodes );
1136 // Create a list like "en" => 0.8
1137 $langs = array_combine( $langcodes, $qvalues );
1143 * Fetch the raw IP from the request
1147 * @throws MWException
1150 protected function getRawIP() {
1151 if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
1155 if ( is_array( $_SERVER['REMOTE_ADDR'] ) ||
strpos( $_SERVER['REMOTE_ADDR'], ',' ) !== false ) {
1156 throw new MWException( __METHOD__
1157 . " : Could not determine the remote IP address due to multiple values." );
1159 $ipchain = $_SERVER['REMOTE_ADDR'];
1162 return IP
::canonicalize( $ipchain );
1166 * Work out the IP address based on various globals
1167 * For trusted proxies, use the XFF client IP (first of the chain)
1171 * @throws MWException
1174 public function getIP() {
1175 global $wgUsePrivateIPs;
1177 # Return cached result
1178 if ( $this->ip
!== null ) {
1182 # collect the originating ips
1183 $ip = $this->getRawIP();
1185 throw new MWException( 'Unable to determine IP.' );
1189 $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
1190 if ( $forwardedFor !== false ) {
1191 $isConfigured = IP
::isConfiguredProxy( $ip );
1192 $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
1193 $ipchain = array_reverse( $ipchain );
1194 array_unshift( $ipchain, $ip );
1196 # Step through XFF list and find the last address in the list which is a
1197 # trusted server. Set $ip to the IP address given by that trusted server,
1198 # unless the address is not sensible (e.g. private). However, prefer private
1199 # IP addresses over proxy servers controlled by this site (more sensible).
1200 # Note that some XFF values might be "unknown" with Squid/Varnish.
1201 foreach ( $ipchain as $i => $curIP ) {
1202 $curIP = IP
::sanitizeIP( IP
::canonicalize( $curIP ) );
1203 if ( !$curIP ||
!isset( $ipchain[$i +
1] ) ||
$ipchain[$i +
1] === 'unknown'
1204 ||
!IP
::isTrustedProxy( $curIP )
1206 break; // IP is not valid/trusted or does not point to anything
1209 IP
::isPublic( $ipchain[$i +
1] ) ||
1211 IP
::isConfiguredProxy( $curIP ) // bug 48919; treat IP as sane
1213 // Follow the next IP according to the proxy
1214 $nextIP = IP
::canonicalize( $ipchain[$i +
1] );
1215 if ( !$nextIP && $isConfigured ) {
1216 // We have not yet made it past CDN/proxy servers of this site,
1217 // so either they are misconfigured or there is some IP spoofing.
1218 throw new MWException( "Invalid IP given in XFF '$forwardedFor'." );
1221 // keep traversing the chain
1228 # Allow extensions to improve our guess
1229 Hooks
::run( 'GetIP', [ &$ip ] );
1232 throw new MWException( "Unable to determine IP." );
1235 wfDebug( "IP: $ip\n" );
1245 public function setIP( $ip ) {
1250 * Check if this request uses a "safe" HTTP method
1252 * Safe methods are verbs (e.g. GET/HEAD/OPTIONS) used for obtaining content. Such requests
1253 * are not expected to mutate content, especially in ways attributable to the client. Verbs
1254 * like POST and PUT are typical of non-safe requests which often change content.
1257 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1258 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1261 public function hasSafeMethod() {
1262 if ( !isset( $_SERVER['REQUEST_METHOD'] ) ) {
1263 return false; // CLI mode
1266 return in_array( $_SERVER['REQUEST_METHOD'], [ 'GET', 'HEAD', 'OPTIONS', 'TRACE' ] );
1270 * Whether this request should be identified as being "safe"
1272 * This means that the client is not requesting any state changes and that database writes
1273 * are not inherently required. Ideally, no visible updates would happen at all. If they
1274 * must, then they should not be publically attributed to the end user.
1277 * - Cache populations and refreshes MAY occur.
1278 * - Private user session updates and private server logging MAY occur.
1279 * - Updates to private viewing activity data MAY occur via DeferredUpdates.
1280 * - Other updates SHOULD NOT occur (e.g. modifying content assets).
1283 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1284 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1287 public function isSafeRequest() {
1288 if ( $this->markedAsSafe
&& $this->wasPosted() ) {
1289 return true; // marked as a "safe" POST
1292 return $this->hasSafeMethod();
1296 * Mark this request as identified as being nullipotent even if it is a POST request
1298 * POST requests are often used due to the need for a client payload, even if the request
1299 * is otherwise equivalent to a "safe method" request.
1301 * @see https://tools.ietf.org/html/rfc7231#section-4.2.1
1302 * @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
1305 public function markAsSafeRequest() {
1306 $this->markedAsSafe
= true;