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
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.
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
39 protected $data, $headers = array();
42 * Lazy-init response object
48 * Cached client IP address
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();
65 // POST overrides GET data
66 // We don't use $_REQUEST here to avoid interference from cookies...
67 $this->data
= $_POST +
$_GET;
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.
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.
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.
83 * @return Array: Any query arguments found in path matches.
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.
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;
98 $a = parse_url( $url );
101 $path = isset( $a['path'] ) ?
$a['path'] : '';
104 if ( $path == $wgScript && $want !== 'all' ) {
105 // Script inside a rewrite path?
106 // Abort to keep from breaking...
110 $router = new PathRouter
;
112 // Raw PATH_INFO style
113 $router->add( "$wgScript/$1" );
115 if ( isset( $_SERVER['SCRIPT_NAME'] )
116 && preg_match( '/\.php5?/', $_SERVER['SCRIPT_NAME'] )
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" );
124 global $wgArticlePath;
125 if ( $wgArticlePath ) {
126 $router->add( $wgArticlePath );
129 global $wgActionPaths;
130 if ( $wgActionPaths ) {
131 $router->add( $wgActionPaths, array( 'action' => '$key' ) );
134 global $wgVariantArticlePath, $wgContLang;
135 if ( $wgVariantArticlePath ) {
136 $router->add( $wgVariantArticlePath,
137 array( 'variant' => '$2' ),
138 array( '$2' => $wgContLang->getVariants() )
142 wfRunHooks( 'WebRequestPathInfoRouter', array( $router ) );
144 $matches = $router->parse( $path );
146 } elseif ( $wgUsePathInfo ) {
147 if ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_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 );
153 } elseif ( isset( $_SERVER['PATH_INFO'] ) && $_SERVER['PATH_INFO'] != '' ) {
154 // Regular old PATH_INFO yay
155 $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
163 * Work out an appropriate URL prefix containing scheme and host, based on
164 * information detected from $_SERVER
168 public static function detectServer() {
169 $proto = self
::detectProtocol();
170 $stdPort = $proto === 'https' ?
443 : 80;
172 $varNames = array( 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' );
175 foreach ( $varNames as $varName ) {
176 if ( !isset( $_SERVER[$varName] ) ) {
179 $parts = IP
::splitHostAndPort( $_SERVER[$varName] );
181 // Invalid, do not use
185 if ( $parts[1] === false ) {
186 if ( isset( $_SERVER['SERVER_PORT'] ) ) {
187 $port = $_SERVER['SERVER_PORT'];
188 } // else leave it as $stdPort
195 return $proto . '://' . IP
::combineHostAndPort( $host, $port, $stdPort );
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().
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' ) ) {
216 * Get the current URL protocol (http or https)
219 public function getProtocol() {
220 if ( $this->protocol
=== null ) {
221 $this->protocol
= self
::detectProtocol();
223 return $this->protocol
;
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.
233 public function interpolateTitle() {
234 // bug 16019: title interpolation on API queries is useless and sometimes harmful
235 if ( defined( 'MW_API' ) ) {
239 $matches = self
::getPathInfo( 'title' );
240 foreach ( $matches as $key => $val ) {
241 $this->data
[$key] = $_GET[$key] = $_REQUEST[$key] = $val;
246 * URL rewriting function; tries to extract page title and,
247 * optionally, one other fixed parameter value from a URL path.
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
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 );
263 $matches = array( 'title' => rawurldecode( $raw ) );
265 $matches[$key] = $keyValue;
275 * Recursively strips slashes from the given array;
276 * used for undoing the evil that is magic_quotes_gpc.
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
285 private function &fix_magic_quotes( &$arr, $topLevel = true ) {
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 );
292 $cleanKey = stripslashes( $key );
293 $clean[$cleanKey] = stripslashes( $val );
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.
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 );
320 * Recursively normalizes UTF-8 strings in the given array.
322 * @param $data string|array
323 * @return array|string cleaned-up version of the given
326 function normalizeUnicode( $data ) {
327 if ( is_array( $data ) ) {
328 foreach ( $data as $key => $val ) {
329 $data[$key] = $this->normalizeUnicode( $val );
333 $data = isset( $wgContLang ) ?
$wgContLang->normalize( $data ) : UtfNormal
::cleanUp( $data );
339 * Fetch a value from the given array or return $default if it's not set.
342 * @param $name String
343 * @param $default Mixed
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] ) ) {
354 if ( isset( $_GET[$name] ) && !is_array( $data ) ) {
355 # Check for alternate/legacy character encoding.
356 if ( isset( $wgContLang ) ) {
357 $data = $wgContLang->checkTitleEncoding( $data );
360 $data = $this->normalizeUnicode( $data );
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().
373 * @param $name String
374 * @param string $default optional default (or NULL)
377 public function getVal( $name, $default = null ) {
378 $val = $this->getGPCVal( $this->data
, $name, $default );
379 if ( is_array( $val ) ) {
382 if ( is_null( $val ) ) {
390 * Set an arbitrary value into our get/post data.
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
396 public function setVal( $key, $value ) {
397 $ret = isset( $this->data
[$key] ) ?
$this->data
[$key] : null;
398 $this->data
[$key] = $value;
403 * Unset an arbitrary value from our get/post data.
405 * @param string $key key name to use
406 * @return Mixed: old value if one was present, null otherwise
408 public function unsetVal( $key ) {
409 if ( !isset( $this->data
[$key] ) ) {
412 $ret = $this->data
[$key];
413 unset( $this->data
[$key] );
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.
423 * @param $name String
424 * @param array $default optional default (or NULL)
427 public function getArray( $name, $default = null ) {
428 $val = $this->getGPCVal( $this->data
, $name, $default );
429 if ( is_null( $val ) ) {
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.
442 * @param $name String
443 * @param array $default option default (or NULL)
444 * @return Array of ints
446 public function getIntArray( $name, $default = null ) {
447 $val = $this->getArray( $name, $default );
448 if ( is_array( $val ) ) {
449 $val = array_map( 'intval', $val );
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
459 * @param $name String
460 * @param $default Integer
463 public function getInt( $name, $default = 0 ) {
464 return intval( $this->getVal( $name, $default ) );
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.
472 * @param $name String
475 public function getIntOrNull( $name ) {
476 $val = $this->getVal( $name );
477 return is_numeric( $val )
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
488 * @param $name String
489 * @param $default Float
492 public function getFloat( $name, $default = 0 ) {
493 return floatval( $this->getVal( $name, $default ) );
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.
501 * @param $name String
502 * @param $default Boolean
505 public function getBool( $name, $default = false ) {
506 return (bool)$this->getVal( $name, $default );
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.
514 * @param $name String
515 * @param $default Boolean
518 public function getFuzzyBool( $name, $default = false ) {
519 return $this->getBool( $name, $default ) && strcasecmp( $this->getVal( $name ), 'false' ) !== 0;
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.
527 * @param $name String
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;
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).
544 * @param $name String
545 * @param string $default optional
548 public function getText( $name, $default = '' ) {
550 $val = $this->getVal( $name, $default );
551 return str_replace( "\r\n", "\n",
552 $wgContLang->recodeInput( $val ) );
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.
562 public function getValues() {
563 $names = func_get_args();
564 if ( count( $names ) == 0 ) {
565 $names = array_keys( $this->data
);
569 foreach ( $names as $name ) {
570 $value = $this->getGPCVal( $this->data
, $name, null );
571 if ( !is_null( $value ) ) {
572 $retVal[$name] = $value;
579 * Returns the names of all input values excluding those in $exclude.
581 * @param $exclude Array
584 public function getValueNames( $exclude = array() ) {
585 return array_diff( array_keys( $this->getValues() ), $exclude );
589 * Get the values passed in the query string.
590 * No transformation is performed on the values.
594 public function getQueryValues() {
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.
604 public function getRawQueryString() {
605 return $_SERVER['QUERY_STRING'];
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.
614 public function getRawPostString() {
615 if ( !$this->wasPosted() ) {
618 return $this->getRawInput();
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".
628 public function getRawInput() {
629 static $input = false;
630 if ( $input === false ) {
631 $input = file_get_contents( 'php://input' );
637 * Get the HTTP method used for this request.
641 public function getMethod() {
642 return isset( $_SERVER['REQUEST_METHOD'] ) ?
$_SERVER['REQUEST_METHOD'] : 'GET';
646 * Returns true if the present request was reached by a POST operation,
647 * false otherwise (GET, HEAD, or command-line).
649 * Note that values retrieved by the object may come from the
650 * GET URL etc even on a POST request.
654 public function wasPosted() {
655 return $this->getMethod() == 'POST';
659 * Returns true if there is a session cookie set.
660 * This does not necessarily mean that the user is logged in!
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).
669 public function checkSessionCookie() {
670 return isset( $_COOKIE[session_name()] );
674 * Get a cookie from the $_COOKIE jar
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
681 public function getCookie( $key, $prefix = null, $default = null ) {
682 if ( $prefix === null ) {
683 global $wgCookiePrefix;
684 $prefix = $wgCookiePrefix;
686 return $this->getGPCVal( $_COOKIE, $prefix . $key, $default );
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.
693 * @throws MWException
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'];
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/" );
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 );
722 if ( $base[0] == '/' ) {
723 // More than one slash will look like it is protocol relative
724 return preg_replace( '!^/+!', '/', $base );
726 // We may get paths with a host prepended; strip it.
727 return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
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.
736 * If $wgServer is protocol-relative, this will return a fully
737 * qualified URL with the protocol that was used for this request.
741 public function getFullRequestURL() {
742 return wfExpandUrl( $this->getRequestURL(), PROTO_CURRENT
);
746 * Take an arbitrary query and rewrite the present URL to include it
747 * @param string $query query string fragment; do not include initial '?'
751 public function appendQuery( $query ) {
752 return $this->appendQueryArray( wfCgiToArray( $query ) );
756 * HTML-safe version of appendQuery().
757 * @deprecated: Deprecated in 1.20, warnings in 1.21, remove in 1.22.
759 * @param string $query query string fragment; do not include initial '?'
762 public function escapeAppendQuery( $query ) {
763 return htmlspecialchars( $this->appendQuery( $query ) );
769 * @param $onlyquery bool
772 public function appendQueryValue( $key, $value, $onlyquery = false ) {
773 return $this->appendQueryArray( array( $key => $value ), $onlyquery );
777 * Appends or replaces value of query variables.
779 * @param array $array of values to replace/add to query
780 * @param bool $onlyquery whether to only return the query string and not
784 public function appendQueryArray( $array, $onlyquery = false ) {
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 );
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.
798 * @param $deflimit Integer: 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 * @return array first element is limit, second is offset
802 public function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
805 $limit = $this->getInt( 'limit', 0 );
809 if ( ( $limit == 0 ) && ( $optionname != '' ) ) {
810 $limit = $wgUser->getIntOption( $optionname );
815 if ( $limit > 5000 ) {
816 $limit = 5000; # We have *some* limits...
819 $offset = $this->getInt( 'offset', 0 );
824 return array( $limit, $offset );
828 * Return the path to the temporary file where PHP has stored the upload.
830 * @param $key String:
831 * @return string or NULL if no such file.
833 public function getFileTempname( $key ) {
834 $file = new WebRequestUpload( $this, $key );
835 return $file->getTempName();
839 * Return the upload error or 0
841 * @param $key String:
844 public function getUploadError( $key ) {
845 $file = new WebRequestUpload( $this, $key );
846 return $file->getError();
850 * Return the original filename of the uploaded file, as reported by
851 * the submitting user agent. HTML-style character entities are
852 * interpreted and normalized to Unicode normalization form C, in part
853 * to deal with weird input from Safari with non-ASCII filenames.
855 * Other than this the name is not verified for being a safe filename.
857 * @param $key String:
858 * @return string or NULL if no such file.
860 public function getFileName( $key ) {
861 $file = new WebRequestUpload( $this, $key );
862 return $file->getName();
866 * Return a WebRequestUpload object corresponding to the key
869 * @return WebRequestUpload
871 public function getUpload( $key ) {
872 return new WebRequestUpload( $this, $key );
876 * Return a handle to WebResponse style object, for setting cookies,
877 * headers and other stuff, for Request being worked on.
879 * @return WebResponse
881 public function response() {
882 /* Lazy initialization of response object for this request */
883 if ( !is_object( $this->response
) ) {
884 $class = ( $this instanceof FauxRequest
) ?
'FauxResponse' : 'WebResponse';
885 $this->response
= new $class();
887 return $this->response
;
891 * Initialise the header list
893 private function initHeaders() {
894 if ( count( $this->headers
) ) {
898 $apacheHeaders = function_exists( 'apache_request_headers' ) ?
apache_request_headers() : false;
899 if ( $apacheHeaders ) {
900 foreach ( $apacheHeaders as $tempName => $tempValue ) {
901 $this->headers
[strtoupper( $tempName )] = $tempValue;
904 foreach ( $_SERVER as $name => $value ) {
905 if ( substr( $name, 0, 5 ) === 'HTTP_' ) {
906 $name = str_replace( '_', '-', substr( $name, 5 ) );
907 $this->headers
[$name] = $value;
908 } elseif ( $name === 'CONTENT_LENGTH' ) {
909 $this->headers
['CONTENT-LENGTH'] = $value;
916 * Get an array containing all request headers
918 * @return Array mapping header name to its value
920 public function getAllHeaders() {
921 $this->initHeaders();
922 return $this->headers
;
926 * Get a request header, or false if it isn't set
927 * @param string $name case-insensitive header name
929 * @return string|bool False on failure
931 public function getHeader( $name ) {
932 $this->initHeaders();
933 $name = strtoupper( $name );
934 if ( isset( $this->headers
[$name] ) ) {
935 return $this->headers
[$name];
942 * Get data from $_SESSION
944 * @param string $key name of key in $_SESSION
947 public function getSessionData( $key ) {
948 if ( !isset( $_SESSION[$key] ) ) {
951 return $_SESSION[$key];
957 * @param string $key name of key in $_SESSION
960 public function setSessionData( $key, $data ) {
961 $_SESSION[$key] = $data;
965 * Check if Internet Explorer will detect an incorrect cache extension in
966 * PATH_INFO or QUERY_STRING. If the request can't be allowed, show an error
967 * message or redirect to a safer URL. Returns true if the URL is OK, and
968 * false if an error message has been shown and the request should be aborted.
970 * @param $extWhitelist array
974 public function checkUrlExtension( $extWhitelist = array() ) {
975 global $wgScriptExtension;
976 $extWhitelist[] = ltrim( $wgScriptExtension, '.' );
977 if ( IEUrlExtension
::areServerVarsBad( $_SERVER, $extWhitelist ) ) {
978 if ( !$this->wasPosted() ) {
979 $newUrl = IEUrlExtension
::fixUrlForIE6(
980 $this->getFullRequestURL(), $extWhitelist );
981 if ( $newUrl !== false ) {
982 $this->doSecurityRedirect( $newUrl );
986 throw new HttpError( 403,
987 'Invalid file extension found in the path info or query string.' );
993 * Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in
994 * IE 6. Returns true if it was successful, false otherwise.
999 protected function doSecurityRedirect( $url ) {
1000 header( 'Location: ' . $url );
1001 header( 'Content-Type: text/html' );
1002 $encUrl = htmlspecialchars( $url );
1006 <title>Security redirect</title>
1009 <h1>Security redirect</h1>
1011 We can't serve non-HTML content from the URL you have requested
, because
1012 Internet Explorer would interpret it
as an incorrect
and potentially dangerous
1014 <p
>Instead
, please
use <a href
="$encUrl">this URL
</a
>, which is the same
as the URL you have requested
, except that
1015 "&*" is appended
. This prevents Internet Explorer from seeing a bogus file
1026 * Parse the Accept-Language header sent by the client into an array
1027 * @return array array( languageCode => q-value ) sorted by q-value in descending order then
1028 * appearing time in the header in ascending order.
1029 * May contain the "language" '*', which applies to languages other than those explicitly listed.
1030 * This is aligned with rfc2616 section 14.4
1031 * Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.
1033 public function getAcceptLang() {
1034 // Modified version of code found at http://www.thefutureoftheweb.com/blog/use-accept-language-header
1035 $acceptLang = $this->getHeader( 'Accept-Language' );
1036 if ( !$acceptLang ) {
1040 // Return the language codes in lower case
1041 $acceptLang = strtolower( $acceptLang );
1043 // Break up string into pieces (languages and q factors)
1045 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})?)?)?/',
1046 $acceptLang, $lang_parse );
1048 if ( !count( $lang_parse[1] ) ) {
1052 $langcodes = $lang_parse[1];
1053 $qvalues = $lang_parse[4];
1054 $indices = range( 0, count( $lang_parse[1] ) - 1 );
1056 // Set default q factor to 1
1057 foreach ( $indices as $index ) {
1058 if ( $qvalues[$index] === '' ) {
1059 $qvalues[$index] = 1;
1060 } elseif ( $qvalues[$index] == 0 ) {
1061 unset( $langcodes[$index], $qvalues[$index], $indices[$index] );
1065 // Sort list. First by $qvalues, then by order. Reorder $langcodes the same way
1066 array_multisort( $qvalues, SORT_DESC
, SORT_NUMERIC
, $indices, $langcodes );
1068 // Create a list like "en" => 0.8
1069 $langs = array_combine( $langcodes, $qvalues );
1075 * Fetch the raw IP from the request
1079 * @throws MWException
1082 protected function getRawIP() {
1083 if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
1087 if ( is_array( $_SERVER['REMOTE_ADDR'] ) ||
strpos( $_SERVER['REMOTE_ADDR'], ',' ) !== false ) {
1088 throw new MWException( __METHOD__
. " : Could not determine the remote IP address due to multiple values." );
1090 $ipchain = $_SERVER['REMOTE_ADDR'];
1093 return IP
::canonicalize( $ipchain );
1097 * Work out the IP address based on various globals
1098 * For trusted proxies, use the XFF client IP (first of the chain)
1102 * @throws MWException
1105 public function getIP() {
1106 global $wgUsePrivateIPs;
1108 # Return cached result
1109 if ( $this->ip
!== null ) {
1113 # collect the originating ips
1114 $ip = $this->getRawIP();
1117 $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
1118 if ( $forwardedFor !== false ) {
1119 $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
1120 $ipchain = array_reverse( $ipchain );
1122 array_unshift( $ipchain, $ip );
1125 # Step through XFF list and find the last address in the list which is a
1126 # trusted server. Set $ip to the IP address given by that trusted server,
1127 # unless the address is not sensible (e.g. private). However, prefer private
1128 # IP addresses over proxy servers controlled by this site (more sensible).
1129 foreach ( $ipchain as $i => $curIP ) {
1130 // ignore 'unknown' value from Squid when 'forwarded_for off' and try next
1131 if ( $curIP === 'unknown' ) {
1134 $curIP = IP
::sanitizeIP( IP
::canonicalize( $curIP ) );
1135 if ( wfIsTrustedProxy( $curIP ) && isset( $ipchain[$i +
1] ) ) {
1136 if ( wfIsConfiguredProxy( $curIP ) ||
// bug 48919; treat IP as sane
1137 IP
::isPublic( $ipchain[$i +
1] ) ||
1140 $nextIP = IP
::canonicalize( $ipchain[$i +
1] );
1141 if ( !$nextIP && wfIsConfiguredProxy( $ip ) ) {
1142 // We have not yet made it past CDN/proxy servers of this site,
1143 // so either they are misconfigured or there is some IP spoofing.
1144 throw new MWException( "Invalid IP given in XFF '$forwardedFor'." );
1154 # Allow extensions to improve our guess
1155 wfRunHooks( 'GetIP', array( &$ip ) );
1158 throw new MWException( "Unable to determine IP." );
1161 wfDebug( "IP: $ip\n" );
1171 public function setIP( $ip ) {
1177 * Object to access the $_FILES array
1179 class WebRequestUpload
{
1181 protected $doesExist;
1182 protected $fileInfo;
1185 * Constructor. Should only be called by WebRequest
1187 * @param $request WebRequest The associated request
1188 * @param string $key Key in $_FILES array (name of form field)
1190 public function __construct( $request, $key ) {
1191 $this->request
= $request;
1192 $this->doesExist
= isset( $_FILES[$key] );
1193 if ( $this->doesExist
) {
1194 $this->fileInfo
= $_FILES[$key];
1199 * Return whether a file with this name was uploaded.
1203 public function exists() {
1204 return $this->doesExist
;
1208 * Return the original filename of the uploaded file
1210 * @return mixed Filename or null if non-existent
1212 public function getName() {
1213 if ( !$this->exists() ) {
1218 $name = $this->fileInfo
['name'];
1220 # Safari sends filenames in HTML-encoded Unicode form D...
1221 # Horrid and evil! Let's try to make some kind of sense of it.
1222 $name = Sanitizer
::decodeCharReferences( $name );
1223 $name = $wgContLang->normalize( $name );
1224 wfDebug( __METHOD__
. ": {$this->fileInfo['name']} normalized to '$name'\n" );
1229 * Return the file size of the uploaded file
1231 * @return int File size or zero if non-existent
1233 public function getSize() {
1234 if ( !$this->exists() ) {
1238 return $this->fileInfo
['size'];
1242 * Return the path to the temporary file
1244 * @return mixed Path or null if non-existent
1246 public function getTempName() {
1247 if ( !$this->exists() ) {
1251 return $this->fileInfo
['tmp_name'];
1255 * Return the upload error. See link for explanation
1256 * http://www.php.net/manual/en/features.file-upload.errors.php
1258 * @return int One of the UPLOAD_ constants, 0 if non-existent
1260 public function getError() {
1261 if ( !$this->exists() ) {
1262 return 0; # UPLOAD_ERR_OK
1265 return $this->fileInfo
['error'];
1269 * Returns whether this upload failed because of overflow of a maximum set
1274 public function isIniSizeOverflow() {
1275 if ( $this->getError() == UPLOAD_ERR_INI_SIZE
) {
1276 # PHP indicated that upload_max_filesize is exceeded
1280 $contentLength = $this->request
->getHeader( 'CONTENT_LENGTH' );
1281 if ( $contentLength > wfShorthandToInteger( ini_get( 'post_max_size' ) ) ) {
1282 # post_max_size is exceeded
1291 * WebRequest clone which takes values from a provided array.
1295 class FauxRequest
extends WebRequest
{
1296 private $wasPosted = false;
1297 private $session = array();
1300 * @param array $data of *non*-urlencoded key => value pairs, the
1301 * fake GET/POST values
1302 * @param bool $wasPosted whether to treat the data as POST
1303 * @param $session Mixed: session array or null
1304 * @param string $protocol 'http' or 'https'
1305 * @throws MWException
1307 public function __construct( $data = array(), $wasPosted = false, $session = null, $protocol = 'http' ) {
1308 if ( is_array( $data ) ) {
1309 $this->data
= $data;
1311 throw new MWException( "FauxRequest() got bogus data" );
1313 $this->wasPosted
= $wasPosted;
1315 $this->session
= $session;
1317 $this->protocol
= $protocol;
1321 * @param $method string
1322 * @throws MWException
1324 private function notImplemented( $method ) {
1325 throw new MWException( "{$method}() not implemented" );
1329 * @param $name string
1330 * @param $default string
1333 public function getText( $name, $default = '' ) {
1334 # Override; don't recode since we're using internal data
1335 return (string)$this->getVal( $name, $default );
1341 public function getValues() {
1348 public function getQueryValues() {
1349 if ( $this->wasPosted
) {
1356 public function getMethod() {
1357 return $this->wasPosted ?
'POST' : 'GET';
1363 public function wasPosted() {
1364 return $this->wasPosted
;
1367 public function getCookie( $key, $prefix = null, $default = null ) {
1371 public function checkSessionCookie() {
1375 public function getRequestURL() {
1376 $this->notImplemented( __METHOD__
);
1379 public function getProtocol() {
1380 return $this->protocol
;
1384 * @param string $name The name of the header to get (case insensitive).
1385 * @return bool|string
1387 public function getHeader( $name ) {
1388 $name = strtoupper( $name );
1389 return isset( $this->headers
[$name] ) ?
$this->headers
[$name] : false;
1393 * @param $name string
1394 * @param $val string
1396 public function setHeader( $name, $val ) {
1397 $name = strtoupper( $name );
1398 $this->headers
[$name] = $val;
1405 public function getSessionData( $key ) {
1406 if ( isset( $this->session
[$key] ) ) {
1407 return $this->session
[$key];
1416 public function setSessionData( $key, $data ) {
1417 $this->session
[$key] = $data;
1421 * @return array|Mixed|null
1423 public function getSessionArray() {
1424 return $this->session
;
1428 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1431 public function getRawQueryString() {
1436 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1439 public function getRawPostString() {
1444 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
1447 public function getRawInput() {
1452 * @param array $extWhitelist
1455 public function checkUrlExtension( $extWhitelist = array() ) {
1462 protected function getRawIP() {
1468 * Similar to FauxRequest, but only fakes URL parameters and method
1469 * (POST or GET) and use the base request for the remaining stuff
1470 * (cookies, session and headers).
1475 class DerivativeRequest
extends FauxRequest
{
1479 * @param WebRequest $base
1480 * @param array $data Array of *non*-urlencoded key => value pairs, the
1481 * fake GET/POST values
1482 * @param bool $wasPosted Whether to treat the data as POST
1484 public function __construct( WebRequest
$base, $data, $wasPosted = false ) {
1485 $this->base
= $base;
1486 parent
::__construct( $data, $wasPosted );
1489 public function getCookie( $key, $prefix = null, $default = null ) {
1490 return $this->base
->getCookie( $key, $prefix, $default );
1493 public function checkSessionCookie() {
1494 return $this->base
->checkSessionCookie();
1497 public function getHeader( $name ) {
1498 return $this->base
->getHeader( $name );
1501 public function getAllHeaders() {
1502 return $this->base
->getAllHeaders();
1505 public function getSessionData( $key ) {
1506 return $this->base
->getSessionData( $key );
1509 public function setSessionData( $key, $data ) {
1510 $this->base
->setSessionData( $key, $data );
1513 public function getAcceptLang() {
1514 return $this->base
->getAcceptLang();
1517 public function getIP() {
1518 return $this->base
->getIP();
1521 public function getProtocol() {
1522 return $this->base
->getProtocol();