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\SessionManager
;
29 * WebRequest clone which takes values from a provided array.
33 class FauxRequest
extends WebRequest
{
34 private $wasPosted = false;
36 protected $cookies = [];
39 * @param array $data Array of *non*-urlencoded key => value pairs, the
40 * fake GET/POST values
41 * @param bool $wasPosted Whether to treat the data as POST
42 * @param MediaWiki\Session\Session|array|null $session Session, session
44 * @param string $protocol 'http' or 'https'
47 public function __construct( $data = [], $wasPosted = false,
48 $session = null, $protocol = 'http'
50 $this->requestTime
= microtime( true );
52 if ( is_array( $data ) ) {
55 throw new MWException( "FauxRequest() got bogus data" );
57 $this->wasPosted
= $wasPosted;
58 if ( $session instanceof MediaWiki\Session\Session
) {
59 $this->sessionId
= $session->getSessionId();
60 } elseif ( is_array( $session ) ) {
61 $mwsession = SessionManager
::singleton()->getEmptySession( $this );
62 $this->sessionId
= $mwsession->getSessionId();
63 foreach ( $session as $key => $value ) {
64 $mwsession->set( $key, $value );
66 } elseif ( $session !== null ) {
67 throw new MWException( "FauxRequest() got bogus session" );
69 $this->protocol
= $protocol;
73 * Initialise the header list
75 protected function initHeaders() {
81 * @param string $default
84 public function getText( $name, $default = '' ) {
85 # Override; don't recode since we're using internal data
86 return (string)$this->getVal( $name, $default );
91 * @suppress PhanParamSignatureMismatch
93 public function getValues() {
100 public function getQueryValues() {
101 if ( $this->wasPosted
) {
108 public function getMethod() {
109 return $this->wasPosted ?
'POST' : 'GET';
115 public function wasPosted() {
116 return $this->wasPosted
;
119 public function getCookie( $key, $prefix = null, $default = null ) {
120 if ( $prefix === null ) {
121 global $wgCookiePrefix;
122 $prefix = $wgCookiePrefix;
124 $name = $prefix . $key;
125 return $this->cookies
[$name] ??
$default;
130 * @param string $key Unprefixed name of the cookie to set
131 * @param string|null $value Value of the cookie to set
132 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
134 public function setCookie( $key, $value, $prefix = null ) {
135 $this->setCookies( [ $key => $value ], $prefix );
140 * @param array $cookies
141 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
143 public function setCookies( $cookies, $prefix = null ) {
144 if ( $prefix === null ) {
145 global $wgCookiePrefix;
146 $prefix = $wgCookiePrefix;
148 foreach ( $cookies as $key => $value ) {
149 $name = $prefix . $key;
150 $this->cookies
[$name] = $value;
158 public function setRequestURL( $url ) {
159 $this->requestUrl
= $url;
163 * @since 1.25 MWException( "getRequestURL not implemented" )
167 public function getRequestURL() {
168 if ( $this->requestUrl
=== null ) {
169 throw new MWException( 'Request URL not set' );
171 return $this->requestUrl
;
174 public function getProtocol() {
175 return $this->protocol
;
179 * @param string $name
182 public function setHeader( $name, $val ) {
183 $this->setHeaders( [ $name => $val ] );
188 * @param array $headers
190 public function setHeaders( $headers ) {
191 foreach ( $headers as $name => $val ) {
192 $name = strtoupper( $name );
193 $this->headers
[$name] = $val;
200 public function getSessionArray() {
201 if ( $this->sessionId
!== null ) {
202 return iterator_to_array( $this->getSession() );
208 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
211 public function getRawQueryString() {
216 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
219 public function getRawPostString() {
224 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
227 public function getRawInput() {
232 * @codeCoverageIgnore
233 * @param array $extWhitelist
236 public function checkUrlExtension( $extWhitelist = [] ) {
241 * @codeCoverageIgnore
244 protected function getRawIP() {