3 * Deal with importing all those nasssty globals and things
7 # Copyright (C) 2003 Brion Vibber <brion@pobox.com>
8 # http://www.mediawiki.org/
10 # This program is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 2 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along
21 # with this program; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 # http://www.gnu.org/copyleft/gpl.html
26 * The WebRequest class encapsulates getting at data passed in the
27 * URL or via a POSTed form, handling remove of "magic quotes" slashes,
28 * stripping illegal input characters and normalizing Unicode sequences.
30 * Usually this is used via a global singleton, $wgRequest. You should
31 * not create a second WebRequest object; make a FauxRequest object if
32 * you want to pass arbitrary data to some function in place of the web
38 function WebRequest() {
39 $this->checkMagicQuotes();
40 global $wgUsePathInfo;
41 if( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != '') && $wgUsePathInfo ) {
43 $_GET['title'] = $_REQUEST['title'] =
44 substr( $_SERVER['PATH_INFO'], 1 );
51 * Recursively strips slashes from the given array;
52 * used for undoing the evil that is magic_quotes_gpc.
53 * @param array &$arr will be modified
54 * @return array the original array
57 function &fix_magic_quotes( &$arr ) {
58 foreach( $arr as $key => $val ) {
59 if( is_array( $val ) ) {
60 $this->fix_magic_quotes( $arr[$key] );
62 $arr[$key] = stripslashes( $val );
69 * If magic_quotes_gpc option is on, run the global arrays
70 * through fix_magic_quotes to strip out the stupid slashes.
71 * WARNING: This should only be done once! Running a second
72 * time could damage the values.
75 function checkMagicQuotes() {
76 if ( get_magic_quotes_gpc() ) {
77 $this->fix_magic_quotes( $_COOKIE );
78 $this->fix_magic_quotes( $_ENV );
79 $this->fix_magic_quotes( $_GET );
80 $this->fix_magic_quotes( $_POST );
81 $this->fix_magic_quotes( $_REQUEST );
82 $this->fix_magic_quotes( $_SERVER );
87 * Recursively normalizes UTF-8 strings in the given array.
88 * @param array $data string or array
89 * @return cleaned-up version of the given
92 function normalizeUnicode( $data ) {
93 if( is_array( $data ) ) {
94 foreach( $data as $key => $val ) {
95 $data[$key] = $this->normalizeUnicode( $val );
98 $data = UtfNormal
::cleanUp( $data );
104 * Fetch a value from the given array or return $default if it's not set.
107 * @param string $name
108 * @param mixed $default
112 function getGPCVal( $arr, $name, $default ) {
113 if( isset( $arr[$name] ) ) {
116 if( isset( $_GET[$name] ) && !is_array( $data ) ) {
117 # Check for alternate/legacy character encoding.
118 if( isset( $wgContLang ) ) {
119 $data = $wgContLang->checkTitleEncoding( $data );
122 require_once( 'normal/UtfNormal.php' );
123 $data = $this->normalizeUnicode( $data );
131 * Fetch a scalar from the input or return $default if it's not set.
132 * Returns a string. Arrays are discarded.
134 * @param string $name
135 * @param string $default optional default (or NULL)
138 function getVal( $name, $default = NULL ) {
139 $val = $this->getGPCVal( $_REQUEST, $name, $default );
140 if( is_array( $val ) ) {
143 if( is_null( $val ) ) {
151 * Fetch an array from the input or return $default if it's not set.
152 * If source was scalar, will return an array with a single element.
153 * If no source and no default, returns NULL.
155 * @param string $name
156 * @param array $default optional default (or NULL)
159 function getArray( $name, $default = NULL ) {
160 $val = $this->getGPCVal( $_REQUEST, $name, $default );
161 if( is_null( $val ) ) {
169 * Fetch an array of integers, or return $default if it's not set.
170 * If source was scalar, will return an array with a single element.
171 * If no source and no default, returns NULL.
172 * If an array is returned, contents are guaranteed to be integers.
174 * @param string $name
175 * @param array $default option default (or NULL)
176 * @return array of ints
178 function getIntArray( $name, $default = NULL ) {
179 $val = $this->getArray( $name, $default );
180 if( is_array( $val ) ) {
181 $val = array_map( 'intval', $val );
187 * Fetch an integer value from the input or return $default if not set.
188 * Guaranteed to return an integer; non-numeric input will typically
190 * @param string $name
191 * @param int $default
194 function getInt( $name, $default = 0 ) {
195 return intval( $this->getVal( $name, $default ) );
199 * Fetch an integer value from the input or return null if empty.
200 * Guaranteed to return an integer or null; non-numeric input will
201 * typically return null.
202 * @param string $name
205 function getIntOrNull( $name ) {
206 $val = $this->getVal( $name );
207 return is_numeric( $val )
213 * Fetch a boolean value from the input or return $default if not set.
214 * Guaranteed to return true or false, with normal PHP semantics for
215 * boolean interpretation of strings.
216 * @param string $name
217 * @param bool $default
220 function getBool( $name, $default = false ) {
221 return $this->getVal( $name, $default ) ?
true : false;
225 * Return true if the named value is set in the input, whatever that
226 * value is (even "0"). Return false if the named value is not set.
227 * Example use is checking for the presence of check boxes in forms.
228 * @param string $name
231 function getCheck( $name ) {
232 # Checkboxes and buttons are only present when clicked
233 # Presence connotes truth, abscense false
234 $val = $this->getVal( $name, NULL );
235 return isset( $val );
239 * Fetch a text string from the given array or return $default if it's not
240 * set. \r is stripped from the text, and with some language modules there
241 * is an input transliteration applied. This should generally be used for
242 * form <textarea> and <input> fields.
244 * @param string $name
245 * @param string $default optional
248 function getText( $name, $default = '' ) {
250 $val = $this->getVal( $name, $default );
251 return str_replace( "\r\n", "\n",
252 $wgContLang->recodeInput( $val ) );
256 * Extracts the given named values into an array.
257 * If no arguments are given, returns all input values.
258 * No transformation is performed on the values.
260 function getValues() {
261 $names = func_get_args();
262 if ( count( $names ) == 0 ) {
263 $names = array_keys( $_REQUEST );
267 foreach ( $names as $name ) {
268 $value = $this->getVal( $name );
269 if ( !is_null( $value ) ) {
270 $retVal[$name] = $value;
277 * Returns true if the present request was reached by a POST operation,
278 * false otherwise (GET, HEAD, or command-line).
280 * Note that values retrieved by the object may come from the
281 * GET URL etc even on a POST request.
285 function wasPosted() {
286 return $_SERVER['REQUEST_METHOD'] == 'POST';
290 * Returns true if there is a session cookie set.
291 * This does not necessarily mean that the user is logged in!
295 function checkSessionCookie() {
296 return isset( $_COOKIE[ini_get('session.name')] );
300 * Return the path portion of the request URI.
303 function getRequestURL() {
304 $base = $_SERVER['REQUEST_URI'];
305 if( $base{0} == '/' ) {
308 // We may get paths with a host prepended; strip it.
309 return preg_replace( '!^[^:]+://[^/]+/!', '/', $base );
314 * Return the request URI with the canonical service and hostname.
317 function getFullRequestURL() {
319 return $wgServer . $this->getRequestURL();
323 * Take an arbitrary query and rewrite the present URL to include it
324 * @param $query String: query string fragment; do not include initial '?'
327 function appendQuery( $query ) {
330 foreach( $_GET as $var => $val ) {
331 if ( $var == 'title' )
333 if ( is_array( $val ) )
334 /* This will happen given a request like
335 * http://en.wikipedia.org/w/index.php?title[]=Special:Userlogin&returnto[]=Main_Page
338 $basequery .= '&' . urlencode( $var ) . '=' . urlencode( $val );
340 $basequery .= '&' . $query;
343 $basequery = substr( $basequery, 1 );
344 return $wgTitle->getLocalURL( $basequery );
348 * HTML-safe version of appendQuery().
349 * @param $query String: query string fragment; do not include initial '?'
352 function escapeAppendQuery( $query ) {
353 return htmlspecialchars( $this->appendQuery( $query ) );
357 * Check for limit and offset parameters on the input, and return sensible
358 * defaults if not given. The limit must be positive and is capped at 5000.
359 * Offset must be positive but is not capped.
361 * @param $deflimit Integer: limit to use if no input and the user hasn't set the option.
362 * @param $optionname String: to specify an option other than rclimit to pull from.
363 * @return array first element is limit, second is offset
365 function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
368 $limit = $this->getInt( 'limit', 0 );
369 if( $limit < 0 ) $limit = 0;
370 if( ( $limit == 0 ) && ( $optionname != '' ) ) {
371 $limit = (int)$wgUser->getOption( $optionname );
373 if( $limit <= 0 ) $limit = $deflimit;
374 if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
376 $offset = $this->getInt( 'offset', 0 );
377 if( $offset < 0 ) $offset = 0;
379 return array( $limit, $offset );
383 * Return the path to the temporary file where PHP has stored the upload.
384 * @param $key String:
385 * @return string or NULL if no such file.
387 function getFileTempname( $key ) {
388 if( !isset( $_FILES[$key] ) ) {
391 return $_FILES[$key]['tmp_name'];
395 * Return the size of the upload, or 0.
396 * @param $key String:
399 function getFileSize( $key ) {
400 if( !isset( $_FILES[$key] ) ) {
403 return $_FILES[$key]['size'];
407 * Return the upload error or 0
408 * @param $key String:
411 function getUploadError( $key ) {
412 if( !isset( $_FILES[$key] ) ||
!isset( $_FILES[$key]['error'] ) ) {
413 return 0/*UPLOAD_ERR_OK*/;
415 return $_FILES[$key]['error'];
419 * Return the original filename of the uploaded file, as reported by
420 * the submitting user agent. HTML-style character entities are
421 * interpreted and normalized to Unicode normalization form C, in part
422 * to deal with weird input from Safari with non-ASCII filenames.
424 * Other than this the name is not verified for being a safe filename.
426 * @param $key String:
427 * @return string or NULL if no such file.
429 function getFileName( $key ) {
430 if( !isset( $_FILES[$key] ) ) {
433 $name = $_FILES[$key]['name'];
435 # Safari sends filenames in HTML-encoded Unicode form D...
436 # Horrid and evil! Let's try to make some kind of sense of it.
437 $name = Sanitizer
::decodeCharReferences( $name );
438 $name = UtfNormal
::cleanUp( $name );
439 wfDebug( "WebRequest::getFileName() '" . $_FILES[$key]['name'] . "' normalized to '$name'\n" );
444 * Return a handle to WebResponse style object, for setting cookies,
445 * headers and other stuff, for Request being worked on.
447 function response() {
448 /* Lazy initialization of response object for this request */
449 if (!is_object($this->_response
)) {
450 $this->_response
= new WebResponse
;
452 return $this->_response
;
458 * WebRequest clone which takes values from a provided array.
462 class FauxRequest
extends WebRequest
{
464 var $wasPosted = false;
466 function FauxRequest( $data, $wasPosted = false ) {
467 if( is_array( $data ) ) {
470 throw new MWException( "FauxRequest() got bogus data" );
472 $this->wasPosted
= $wasPosted;
475 function getVal( $name, $default = NULL ) {
476 return $this->getGPCVal( $this->data
, $name, $default );
479 function getText( $name, $default = '' ) {
480 # Override; don't recode since we're using internal data
481 return $this->getVal( $name, $default );
484 function getValues() {
488 function wasPosted() {
489 return $this->wasPosted
;
492 function checkSessionCookie() {
496 function getRequestURL() {
497 throw new MWException( 'FauxRequest::getRequestURL() not implemented' );
500 function appendQuery( $query ) {
501 throw new MWException( 'FauxRequest::appendQuery() not implemented' );