These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | /** |
||
3 | * Deal with importing all those nasty globals and things |
||
4 | * |
||
5 | * Copyright © 2003 Brion Vibber <[email protected]> |
||
6 | * https://www.mediawiki.org/ |
||
7 | * |
||
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. |
||
12 | * |
||
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. |
||
17 | * |
||
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 |
||
22 | * |
||
23 | * @file |
||
24 | */ |
||
25 | |||
26 | use MediaWiki\Session\SessionManager; |
||
27 | |||
28 | /** |
||
29 | * WebRequest clone which takes values from a provided array. |
||
30 | * |
||
31 | * @ingroup HTTP |
||
32 | */ |
||
33 | class FauxRequest extends WebRequest { |
||
34 | private $wasPosted = false; |
||
35 | private $requestUrl; |
||
36 | protected $cookies = []; |
||
37 | |||
38 | /** |
||
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 |
||
43 | * data array, or null |
||
44 | * @param string $protocol 'http' or 'https' |
||
45 | * @throws MWException |
||
46 | */ |
||
47 | public function __construct( $data = [], $wasPosted = false, |
||
48 | $session = null, $protocol = 'http' |
||
49 | ) { |
||
50 | $this->requestTime = microtime( true ); |
||
51 | |||
52 | if ( is_array( $data ) ) { |
||
53 | $this->data = $data; |
||
54 | } else { |
||
55 | throw new MWException( "FauxRequest() got bogus data" ); |
||
56 | } |
||
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 ); |
||
65 | } |
||
66 | } elseif ( $session !== null ) { |
||
67 | throw new MWException( "FauxRequest() got bogus session" ); |
||
68 | } |
||
69 | $this->protocol = $protocol; |
||
70 | } |
||
71 | |||
72 | /** |
||
73 | * Initialise the header list |
||
74 | */ |
||
75 | protected function initHeaders() { |
||
76 | // Nothing to init |
||
77 | } |
||
78 | |||
79 | /** |
||
80 | * @param string $name |
||
81 | * @param string $default |
||
82 | * @return string |
||
83 | */ |
||
84 | public function getText( $name, $default = '' ) { |
||
85 | # Override; don't recode since we're using internal data |
||
86 | return (string)$this->getVal( $name, $default ); |
||
87 | } |
||
88 | |||
89 | /** |
||
90 | * @return array |
||
91 | */ |
||
92 | public function getValues() { |
||
93 | return $this->data; |
||
94 | } |
||
95 | |||
96 | /** |
||
97 | * @return array |
||
98 | */ |
||
99 | public function getQueryValues() { |
||
100 | if ( $this->wasPosted ) { |
||
101 | return []; |
||
102 | } else { |
||
103 | return $this->data; |
||
104 | } |
||
105 | } |
||
106 | |||
107 | public function getMethod() { |
||
108 | return $this->wasPosted ? 'POST' : 'GET'; |
||
109 | } |
||
110 | |||
111 | /** |
||
112 | * @return bool |
||
113 | */ |
||
114 | public function wasPosted() { |
||
115 | return $this->wasPosted; |
||
116 | } |
||
117 | |||
118 | public function getCookie( $key, $prefix = null, $default = null ) { |
||
119 | if ( $prefix === null ) { |
||
120 | global $wgCookiePrefix; |
||
121 | $prefix = $wgCookiePrefix; |
||
122 | } |
||
123 | $name = $prefix . $key; |
||
124 | return isset( $this->cookies[$name] ) ? $this->cookies[$name] : $default; |
||
125 | } |
||
126 | |||
127 | /** |
||
128 | * @since 1.26 |
||
129 | * @param string $name Unprefixed name of the cookie to set |
||
0 ignored issues
–
show
|
|||
130 | * @param string|null $value Value of the cookie to set |
||
131 | * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix |
||
132 | */ |
||
133 | public function setCookie( $key, $value, $prefix = null ) { |
||
134 | $this->setCookies( [ $key => $value ], $prefix ); |
||
135 | } |
||
136 | |||
137 | /** |
||
138 | * @since 1.26 |
||
139 | * @param array $cookies |
||
140 | * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix |
||
141 | */ |
||
142 | public function setCookies( $cookies, $prefix = null ) { |
||
143 | if ( $prefix === null ) { |
||
144 | global $wgCookiePrefix; |
||
145 | $prefix = $wgCookiePrefix; |
||
146 | } |
||
147 | foreach ( $cookies as $key => $value ) { |
||
148 | $name = $prefix . $key; |
||
149 | $this->cookies[$name] = $value; |
||
150 | } |
||
151 | } |
||
152 | |||
153 | /** |
||
154 | * @since 1.25 |
||
155 | */ |
||
156 | public function setRequestURL( $url ) { |
||
157 | $this->requestUrl = $url; |
||
158 | } |
||
159 | |||
160 | /** |
||
161 | * @since 1.25 MWException( "getRequestURL not implemented" ) |
||
162 | * no longer thrown. |
||
163 | */ |
||
164 | public function getRequestURL() { |
||
165 | if ( $this->requestUrl === null ) { |
||
166 | throw new MWException( 'Request URL not set' ); |
||
167 | } |
||
168 | return $this->requestUrl; |
||
169 | } |
||
170 | |||
171 | public function getProtocol() { |
||
172 | return $this->protocol; |
||
173 | } |
||
174 | |||
175 | /** |
||
176 | * @param string $name |
||
177 | * @param string $val |
||
178 | */ |
||
179 | public function setHeader( $name, $val ) { |
||
180 | $this->setHeaders( [ $name => $val ] ); |
||
181 | } |
||
182 | |||
183 | /** |
||
184 | * @since 1.26 |
||
185 | * @param array $headers |
||
186 | */ |
||
187 | public function setHeaders( $headers ) { |
||
188 | foreach ( $headers as $name => $val ) { |
||
189 | $name = strtoupper( $name ); |
||
190 | $this->headers[$name] = $val; |
||
191 | } |
||
192 | } |
||
193 | |||
194 | /** |
||
195 | * @return array|null |
||
196 | */ |
||
197 | public function getSessionArray() { |
||
198 | if ( $this->sessionId !== null ) { |
||
199 | return iterator_to_array( $this->getSession() ); |
||
200 | } |
||
201 | return null; |
||
202 | } |
||
203 | |||
204 | /** |
||
205 | * FauxRequests shouldn't depend on raw request data (but that could be implemented here) |
||
206 | * @return string |
||
207 | */ |
||
208 | public function getRawQueryString() { |
||
209 | return ''; |
||
210 | } |
||
211 | |||
212 | /** |
||
213 | * FauxRequests shouldn't depend on raw request data (but that could be implemented here) |
||
214 | * @return string |
||
215 | */ |
||
216 | public function getRawPostString() { |
||
217 | return ''; |
||
218 | } |
||
219 | |||
220 | /** |
||
221 | * FauxRequests shouldn't depend on raw request data (but that could be implemented here) |
||
222 | * @return string |
||
223 | */ |
||
224 | public function getRawInput() { |
||
225 | return ''; |
||
226 | } |
||
227 | |||
228 | /** |
||
229 | * @codeCoverageIgnore |
||
230 | * @param array $extWhitelist |
||
231 | * @return bool |
||
232 | */ |
||
233 | public function checkUrlExtension( $extWhitelist = [] ) { |
||
234 | return true; |
||
235 | } |
||
236 | |||
237 | /** |
||
238 | * @codeCoverageIgnore |
||
239 | * @return string |
||
240 | */ |
||
241 | protected function getRawIP() { |
||
242 | return '127.0.0.1'; |
||
243 | } |
||
244 | } |
||
245 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.