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 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 );
49 * Recursively strips slashes from the given array;
50 * used for undoing the evil that is magic_quotes_gpc.
51 * @param array &$arr will be modified
52 * @return array the original array
55 function &fix_magic_quotes( &$arr ) {
56 foreach( $arr as $key => $val ) {
57 if( is_array( $val ) ) {
58 $this->fix_magic_quotes( $arr[$key] );
60 $arr[$key] = stripslashes( $val );
67 * If magic_quotes_gpc option is on, run the global arrays
68 * through fix_magic_quotes to strip out the stupid slashes.
69 * WARNING: This should only be done once! Running a second
70 * time could damage the values.
73 function checkMagicQuotes() {
74 if ( get_magic_quotes_gpc() ) {
75 $this->fix_magic_quotes( $_COOKIE );
76 $this->fix_magic_quotes( $_ENV );
77 $this->fix_magic_quotes( $_GET );
78 $this->fix_magic_quotes( $_POST );
79 $this->fix_magic_quotes( $_REQUEST );
80 $this->fix_magic_quotes( $_SERVER );
85 * Recursively normalizes UTF-8 strings in the given array.
86 * @param array $data string or array
87 * @return cleaned-up version of the given
90 function normalizeUnicode( $data ) {
91 if( is_array( $data ) ) {
92 foreach( $data as $key => $val ) {
93 $data[$key] = $this->normalizeUnicode( $val );
96 $data = UtfNormal
::cleanUp( $data );
102 * Fetch a value from the given array or return $default if it's not set.
105 * @param string $name
106 * @param mixed $default
110 function getGPCVal( $arr, $name, $default ) {
111 if( isset( $arr[$name] ) ) {
114 if( isset( $_GET[$name] ) && !is_array( $data ) ) {
115 # Check for alternate/legacy character encoding.
116 if( isset( $wgContLang ) ) {
117 $data = $wgContLang->checkTitleEncoding( $data );
120 require_once( 'normal/UtfNormal.php' );
121 $data = $this->normalizeUnicode( $data );
129 * Fetch a scalar from the input or return $default if it's not set.
130 * Returns a string. Arrays are discarded.
132 * @param string $name
133 * @param string $default optional default (or NULL)
136 function getVal( $name, $default = NULL ) {
137 $val = $this->getGPCVal( $_REQUEST, $name, $default );
138 if( is_array( $val ) ) {
141 if( is_null( $val ) ) {
149 * Fetch an array from the input or return $default if it's not set.
150 * If source was scalar, will return an array with a single element.
151 * If no source and no default, returns NULL.
153 * @param string $name
154 * @param array $default optional default (or NULL)
157 function getArray( $name, $default = NULL ) {
158 $val = $this->getGPCVal( $_REQUEST, $name, $default );
159 if( is_null( $val ) ) {
167 * Fetch an array of integers, or return $default if it's not set.
168 * If source was scalar, will return an array with a single element.
169 * If no source and no default, returns NULL.
170 * If an array is returned, contents are guaranteed to be integers.
172 * @param string $name
173 * @param array $default option default (or NULL)
174 * @return array of ints
176 function getIntArray( $name, $default = NULL ) {
177 $val = $this->getArray( $name, $default );
178 if( is_array( $val ) ) {
179 $val = array_map( 'intval', $val );
185 * Fetch an integer value from the input or return $default if not set.
186 * Guaranteed to return an integer; non-numeric input will typically
188 * @param string $name
189 * @param int $default
192 function getInt( $name, $default = 0 ) {
193 return intval( $this->getVal( $name, $default ) );
197 * Fetch an integer value from the input or return null if empty.
198 * Guaranteed to return an integer or null; non-numeric input will
199 * typically return null.
200 * @param string $name
203 function getIntOrNull( $name ) {
204 $val = $this->getVal( $name );
205 return is_numeric( $val )
211 * Fetch a boolean value from the input or return $default if not set.
212 * Guaranteed to return true or false, with normal PHP semantics for
213 * boolean interpretation of strings.
214 * @param string $name
215 * @param bool $default
218 function getBool( $name, $default = false ) {
219 return $this->getVal( $name, $default ) ?
true : false;
223 * Return true if the named value is set in the input, whatever that
224 * value is (even "0"). Return false if the named value is not set.
225 * Example use is checking for the presence of check boxes in forms.
226 * @param string $name
229 function getCheck( $name ) {
230 # Checkboxes and buttons are only present when clicked
231 # Presence connotes truth, abscense false
232 $val = $this->getVal( $name, NULL );
233 return isset( $val );
237 * Fetch a text string from the given array or return $default if it's not
238 * set. \r is stripped from the text, and with some language modules there
239 * is an input transliteration applied. This should generally be used for
240 * form <textarea> and <input> fields.
242 * @param string $name
243 * @param string $default optional
246 function getText( $name, $default = '' ) {
248 $val = $this->getVal( $name, $default );
249 return str_replace( "\r\n", "\n",
250 $wgContLang->recodeInput( $val ) );
254 * Extracts the given named values into an array.
255 * If no arguments are given, returns all input values.
256 * No transformation is performed on the values.
258 function getValues() {
259 $names = func_get_args();
260 if ( count( $names ) == 0 ) {
261 $names = array_keys( $_REQUEST );
265 foreach ( $names as $name ) {
266 $value = $this->getVal( $name );
267 if ( !is_null( $value ) ) {
268 $retVal[$name] = $value;
275 * Returns true if the present request was reached by a POST operation,
276 * false otherwise (GET, HEAD, or command-line).
278 * Note that values retrieved by the object may come from the
279 * GET URL etc even on a POST request.
283 function wasPosted() {
284 return $_SERVER['REQUEST_METHOD'] == 'POST';
288 * Returns true if there is a session cookie set.
289 * This does not necessarily mean that the user is logged in!
293 function checkSessionCookie() {
294 return isset( $_COOKIE[ini_get('session.name')] );
298 * Return the path portion of the request URI.
301 function getRequestURL() {
302 $base = $_SERVER['REQUEST_URI'];
303 if( $base{0} == '/' ) {
306 // We may get paths with a host prepended; strip it.
307 return preg_replace( '!^[^:]+://[^/]+/!', '/', $base );
312 * Return the request URI with the canonical service and hostname.
315 function getFullRequestURL() {
317 return $wgServer . $this->getRequestURL();
321 * Take an arbitrary query and rewrite the present URL to include it
322 * @param string $query Query string fragment; do not include initial '?'
325 function appendQuery( $query ) {
328 foreach( $_GET as $var => $val ) {
329 if( $var == 'title' ) continue;
330 $basequery .= '&' . urlencode( $var ) . '=' . urlencode( $val );
332 $basequery .= '&' . $query;
335 $basequery = substr( $basequery, 1 );
336 return $wgTitle->getLocalURL( $basequery );
340 * HTML-safe version of appendQuery().
341 * @param string $query Query string fragment; do not include initial '?'
344 function escapeAppendQuery( $query ) {
345 return htmlspecialchars( $this->appendQuery( $query ) );
349 * Check for limit and offset parameters on the input, and return sensible
350 * defaults if not given. The limit must be positive and is capped at 5000.
351 * Offset must be positive but is not capped.
353 * @param int $deflimit Limit to use if no input and the user hasn't set the option.
354 * @param string $optionname To specify an option other than rclimit to pull from.
355 * @return array first element is limit, second is offset
357 function getLimitOffset( $deflimit = 50, $optionname = 'rclimit' ) {
360 $limit = $this->getInt( 'limit', 0 );
361 if( $limit < 0 ) $limit = 0;
362 if( ( $limit == 0 ) && ( $optionname != '' ) ) {
363 $limit = (int)$wgUser->getOption( $optionname );
365 if( $limit <= 0 ) $limit = $deflimit;
366 if( $limit > 5000 ) $limit = 5000; # We have *some* limits...
368 $offset = $this->getInt( 'offset', 0 );
369 if( $offset < 0 ) $offset = 0;
371 return array( $limit, $offset );
375 * Return the path to the temporary file where PHP has stored the upload.
377 * @return string or NULL if no such file.
379 function getFileTempname( $key ) {
380 if( !isset( $_FILES[$key] ) ) {
383 return $_FILES[$key]['tmp_name'];
387 * Return the size of the upload, or 0.
391 function getFileSize( $key ) {
392 if( !isset( $_FILES[$key] ) ) {
395 return $_FILES[$key]['size'];
399 * Return the upload error or 0
403 function getUploadError( $key ) {
404 if( !isset( $_FILES[$key] ) ||
!isset( $_FILES[$key]['error'] ) ) {
405 return 0/*UPLOAD_ERR_OK*/;
407 return $_FILES[$key]['error'];
411 * Return the original filename of the uploaded file, as reported by
412 * the submitting user agent. HTML-style character entities are
413 * interpreted and normalized to Unicode normalization form C, in part
414 * to deal with weird input from Safari with non-ASCII filenames.
416 * Other than this the name is not verified for being a safe filename.
419 * @return string or NULL if no such file.
421 function getFileName( $key ) {
422 if( !isset( $_FILES[$key] ) ) {
425 $name = $_FILES[$key]['name'];
427 # Safari sends filenames in HTML-encoded Unicode form D...
428 # Horrid and evil! Let's try to make some kind of sense of it.
429 $name = Sanitizer
::decodeCharReferences( $name );
430 $name = UtfNormal
::cleanUp( $name );
431 wfDebug( "WebRequest::getFileName() '" . $_FILES[$key]['name'] . "' normalized to '$name'\n" );
437 * WebRequest clone which takes values from a provided array.
441 class FauxRequest
extends WebRequest
{
443 var $wasPosted = false;
445 function FauxRequest( $data, $wasPosted = false ) {
446 if( is_array( $data ) ) {
449 wfDebugDieBacktrace( "FauxRequest() got bogus data" );
451 $this->wasPosted
= $wasPosted;
454 function getVal( $name, $default = NULL ) {
455 return $this->getGPCVal( $this->data
, $name, $default );
458 function getText( $name, $default = '' ) {
459 # Override; don't recode since we're using internal data
460 return $this->getVal( $name, $default );
463 function getValues() {
467 function wasPosted() {
468 return $this->wasPosted
;
471 function checkSessionCookie() {
475 function getRequestURL() {
476 wfDebugDieBacktrace( 'FauxRequest::getRequestURL() not implemented' );
479 function appendQuery( $query ) {
480 wfDebugDieBacktrace( 'FauxRequest::appendQuery() not implemented' );