CommentStore: Hard-deprecate newKey()
[lhc/web/wiklou.git] / tests / phpunit / includes / WebRequestTest.php
1 <?php
2
3 /**
4 * @group WebRequest
5 */
6 class WebRequestTest extends MediaWikiTestCase {
7 protected $oldServer;
8
9 protected function setUp() {
10 parent::setUp();
11
12 $this->oldServer = $_SERVER;
13 }
14
15 protected function tearDown() {
16 $_SERVER = $this->oldServer;
17
18 parent::tearDown();
19 }
20
21 /**
22 * @dataProvider provideDetectServer
23 * @covers WebRequest::detectServer
24 * @covers WebRequest::detectProtocol
25 */
26 public function testDetectServer( $expected, $input, $description ) {
27 $this->setMwGlobals( 'wgAssumeProxiesUseDefaultProtocolPorts', true );
28
29 $this->setServerVars( $input );
30 $result = WebRequest::detectServer();
31 $this->assertEquals( $expected, $result, $description );
32 }
33
34 public static function provideDetectServer() {
35 return [
36 [
37 'http://x',
38 [
39 'HTTP_HOST' => 'x'
40 ],
41 'Host header'
42 ],
43 [
44 'https://x',
45 [
46 'HTTP_HOST' => 'x',
47 'HTTPS' => 'on',
48 ],
49 'Host header with secure'
50 ],
51 [
52 'http://x',
53 [
54 'HTTP_HOST' => 'x',
55 'SERVER_PORT' => 80,
56 ],
57 'Default SERVER_PORT',
58 ],
59 [
60 'http://x',
61 [
62 'HTTP_HOST' => 'x',
63 'HTTPS' => 'off',
64 ],
65 'Secure off'
66 ],
67 [
68 'https://x',
69 [
70 'HTTP_HOST' => 'x',
71 'HTTP_X_FORWARDED_PROTO' => 'https',
72 ],
73 'Forwarded HTTPS'
74 ],
75 [
76 'https://x',
77 [
78 'HTTP_HOST' => 'x',
79 'HTTPS' => 'off',
80 'SERVER_PORT' => '81',
81 'HTTP_X_FORWARDED_PROTO' => 'https',
82 ],
83 'Forwarded HTTPS'
84 ],
85 [
86 'http://y',
87 [
88 'SERVER_NAME' => 'y',
89 ],
90 'Server name'
91 ],
92 [
93 'http://x',
94 [
95 'HTTP_HOST' => 'x',
96 'SERVER_NAME' => 'y',
97 ],
98 'Host server name precedence'
99 ],
100 [
101 'http://[::1]:81',
102 [
103 'HTTP_HOST' => '[::1]',
104 'SERVER_NAME' => '::1',
105 'SERVER_PORT' => '81',
106 ],
107 'Apache bug 26005'
108 ],
109 [
110 'http://localhost',
111 [
112 'SERVER_NAME' => '[2001'
113 ],
114 'Kind of like lighttpd per commit message in MW r83847',
115 ],
116 [
117 'http://[2a01:e35:2eb4:1::2]:777',
118 [
119 'SERVER_NAME' => '[2a01:e35:2eb4:1::2]:777'
120 ],
121 'Possible lighttpd environment per bug 14977 comment 13',
122 ],
123 ];
124 }
125
126 /**
127 * @param array $data Request data
128 * @param array $config
129 * - float 'requestTime': Mock value for `$_SERVER['REQUEST_TIME_FLOAT']`.
130 * @return WebRequest
131 */
132 protected function mockWebRequest( array $data = [], array $config = [] ) {
133 // Cannot use PHPUnit getMockBuilder() as it does not support
134 // overriding protected properties afterwards
135 $reflection = new ReflectionClass( WebRequest::class );
136 $req = $reflection->newInstanceWithoutConstructor();
137
138 $prop = $reflection->getProperty( 'data' );
139 $prop->setAccessible( true );
140 $prop->setValue( $req, $data );
141
142 if ( isset( $config['requestTime'] ) ) {
143 $prop = $reflection->getProperty( 'requestTime' );
144 $prop->setAccessible( true );
145 $prop->setValue( $req, $config['requestTime'] );
146 }
147
148 return $req;
149 }
150
151 /**
152 * @covers WebRequest::getElapsedTime
153 */
154 public function testGetElapsedTime() {
155 $now = microtime( true ) - 10.0;
156 $req = $this->mockWebRequest( [], [ 'requestTime' => $now ] );
157 $this->assertGreaterThanOrEqual( 10.0, $req->getElapsedTime() );
158 // Catch common errors, but don't fail on slow hardware or VMs (T199764).
159 $this->assertEquals( 10.0, $req->getElapsedTime(), '', 60.0 );
160 }
161
162 /**
163 * @covers WebRequest::getVal
164 * @covers WebRequest::getGPCVal
165 * @covers WebRequest::normalizeUnicode
166 */
167 public function testGetValNormal() {
168 // Assert that WebRequest normalises GPC data using UtfNormal\Validator
169 $input = "a \x00 null";
170 $normal = "a \xef\xbf\xbd null";
171 $req = $this->mockWebRequest( [ 'x' => $input, 'y' => [ $input, $input ] ] );
172 $this->assertSame( $normal, $req->getVal( 'x' ) );
173 $this->assertNotSame( $input, $req->getVal( 'x' ) );
174 $this->assertSame( [ $normal, $normal ], $req->getArray( 'y' ) );
175 }
176
177 /**
178 * @covers WebRequest::getVal
179 * @covers WebRequest::getGPCVal
180 */
181 public function testGetVal() {
182 $req = $this->mockWebRequest( [ 'x' => 'Value', 'y' => [ 'a' ], 'crlf' => "A\r\nb" ] );
183 $this->assertSame( 'Value', $req->getVal( 'x' ), 'Simple value' );
184 $this->assertSame( null, $req->getVal( 'z' ), 'Not found' );
185 $this->assertSame( null, $req->getVal( 'y' ), 'Array is ignored' );
186 $this->assertSame( "A\r\nb", $req->getVal( 'crlf' ), 'CRLF' );
187 }
188
189 /**
190 * @covers WebRequest::getRawVal
191 */
192 public function testGetRawVal() {
193 $req = $this->mockWebRequest( [
194 'x' => 'Value',
195 'y' => [ 'a' ],
196 'crlf' => "A\r\nb"
197 ] );
198 $this->assertSame( 'Value', $req->getRawVal( 'x' ) );
199 $this->assertSame( null, $req->getRawVal( 'z' ), 'Not found' );
200 $this->assertSame( null, $req->getRawVal( 'y' ), 'Array is ignored' );
201 $this->assertSame( "A\r\nb", $req->getRawVal( 'crlf' ), 'CRLF' );
202 }
203
204 /**
205 * @covers WebRequest::getArray
206 */
207 public function testGetArray() {
208 $req = $this->mockWebRequest( [ 'x' => 'Value', 'y' => [ 'a', 'b' ] ] );
209 $this->assertSame( [ 'Value' ], $req->getArray( 'x' ), 'Value becomes array' );
210 $this->assertSame( null, $req->getArray( 'z' ), 'Not found' );
211 $this->assertSame( [ 'a', 'b' ], $req->getArray( 'y' ) );
212 }
213
214 /**
215 * @covers WebRequest::getIntArray
216 */
217 public function testGetIntArray() {
218 $req = $this->mockWebRequest( [ 'x' => [ 'Value' ], 'y' => [ '0', '4.2', '-2' ] ] );
219 $this->assertSame( [ 0 ], $req->getIntArray( 'x' ), 'Text becomes 0' );
220 $this->assertSame( null, $req->getIntArray( 'z' ), 'Not found' );
221 $this->assertSame( [ 0, 4, -2 ], $req->getIntArray( 'y' ) );
222 }
223
224 /**
225 * @covers WebRequest::getInt
226 */
227 public function testGetInt() {
228 $req = $this->mockWebRequest( [
229 'x' => 'Value',
230 'y' => [ 'a' ],
231 'zero' => '0',
232 'answer' => '4.2',
233 'neg' => '-2',
234 ] );
235 $this->assertSame( 0, $req->getInt( 'x' ), 'Text' );
236 $this->assertSame( 0, $req->getInt( 'y' ), 'Array' );
237 $this->assertSame( 0, $req->getInt( 'z' ), 'Not found' );
238 $this->assertSame( 0, $req->getInt( 'zero' ) );
239 $this->assertSame( 4, $req->getInt( 'answer' ) );
240 $this->assertSame( -2, $req->getInt( 'neg' ) );
241 }
242
243 /**
244 * @covers WebRequest::getIntOrNull
245 */
246 public function testGetIntOrNull() {
247 $req = $this->mockWebRequest( [
248 'x' => 'Value',
249 'y' => [ 'a' ],
250 'zero' => '0',
251 'answer' => '4.2',
252 'neg' => '-2',
253 ] );
254 $this->assertSame( null, $req->getIntOrNull( 'x' ), 'Text' );
255 $this->assertSame( null, $req->getIntOrNull( 'y' ), 'Array' );
256 $this->assertSame( null, $req->getIntOrNull( 'z' ), 'Not found' );
257 $this->assertSame( 0, $req->getIntOrNull( 'zero' ) );
258 $this->assertSame( 4, $req->getIntOrNull( 'answer' ) );
259 $this->assertSame( -2, $req->getIntOrNull( 'neg' ) );
260 }
261
262 /**
263 * @covers WebRequest::getFloat
264 */
265 public function testGetFloat() {
266 $req = $this->mockWebRequest( [
267 'x' => 'Value',
268 'y' => [ 'a' ],
269 'zero' => '0',
270 'answer' => '4.2',
271 'neg' => '-2',
272 ] );
273 $this->assertSame( 0.0, $req->getFloat( 'x' ), 'Text' );
274 $this->assertSame( 0.0, $req->getFloat( 'y' ), 'Array' );
275 $this->assertSame( 0.0, $req->getFloat( 'z' ), 'Not found' );
276 $this->assertSame( 0.0, $req->getFloat( 'zero' ) );
277 $this->assertSame( 4.2, $req->getFloat( 'answer' ) );
278 $this->assertSame( -2.0, $req->getFloat( 'neg' ) );
279 }
280
281 /**
282 * @covers WebRequest::getBool
283 */
284 public function testGetBool() {
285 $req = $this->mockWebRequest( [
286 'x' => 'Value',
287 'y' => [ 'a' ],
288 'zero' => '0',
289 'f' => 'false',
290 't' => 'true',
291 ] );
292 $this->assertSame( true, $req->getBool( 'x' ), 'Text' );
293 $this->assertSame( false, $req->getBool( 'y' ), 'Array' );
294 $this->assertSame( false, $req->getBool( 'z' ), 'Not found' );
295 $this->assertSame( false, $req->getBool( 'zero' ) );
296 $this->assertSame( true, $req->getBool( 'f' ) );
297 $this->assertSame( true, $req->getBool( 't' ) );
298 }
299
300 public static function provideFuzzyBool() {
301 return [
302 [ 'Text', true ],
303 [ '', false, '(empty string)' ],
304 [ '0', false ],
305 [ '1', true ],
306 [ 'false', false ],
307 [ 'true', true ],
308 [ 'False', false ],
309 [ 'True', true ],
310 [ 'FALSE', false ],
311 [ 'TRUE', true ],
312 ];
313 }
314
315 /**
316 * @dataProvider provideFuzzyBool
317 * @covers WebRequest::getFuzzyBool
318 */
319 public function testGetFuzzyBool( $value, $expected, $message = null ) {
320 $req = $this->mockWebRequest( [ 'x' => $value ] );
321 $this->assertSame( $expected, $req->getFuzzyBool( 'x' ), $message ?: "Value: '$value'" );
322 }
323
324 /**
325 * @covers WebRequest::getFuzzyBool
326 */
327 public function testGetFuzzyBoolDefault() {
328 $req = $this->mockWebRequest();
329 $this->assertSame( false, $req->getFuzzyBool( 'z' ), 'Not found' );
330 }
331
332 /**
333 * @covers WebRequest::getCheck
334 */
335 public function testGetCheck() {
336 $req = $this->mockWebRequest( [ 'x' => 'Value', 'zero' => '0' ] );
337 $this->assertSame( false, $req->getCheck( 'z' ), 'Not found' );
338 $this->assertSame( true, $req->getCheck( 'x' ), 'Text' );
339 $this->assertSame( true, $req->getCheck( 'zero' ) );
340 }
341
342 /**
343 * @covers WebRequest::getText
344 */
345 public function testGetText() {
346 // Avoid FauxRequest (overrides getText)
347 $req = $this->mockWebRequest( [ 'crlf' => "Va\r\nlue" ] );
348 $this->assertSame( "Va\nlue", $req->getText( 'crlf' ), 'CR stripped' );
349 }
350
351 /**
352 * @covers WebRequest::getValues
353 */
354 public function testGetValues() {
355 $values = [ 'x' => 'Value', 'y' => '' ];
356 // Avoid FauxRequest (overrides getValues)
357 $req = $this->mockWebRequest( $values );
358 $this->assertSame( $values, $req->getValues() );
359 $this->assertSame( [ 'x' => 'Value' ], $req->getValues( 'x' ), 'Specific keys' );
360 }
361
362 /**
363 * @covers WebRequest::getValueNames
364 */
365 public function testGetValueNames() {
366 $req = $this->mockWebRequest( [ 'x' => 'Value', 'y' => '' ] );
367 $this->assertSame( [ 'x', 'y' ], $req->getValueNames() );
368 $this->assertSame( [ 'x' ], $req->getValueNames( [ 'y' ] ), 'Exclude keys' );
369 }
370
371 /**
372 * @dataProvider provideGetIP
373 * @covers WebRequest::getIP
374 */
375 public function testGetIP( $expected, $input, $squid, $xffList, $private, $description ) {
376 $this->setServerVars( $input );
377 $this->setMwGlobals( [
378 'wgUsePrivateIPs' => $private,
379 'wgHooks' => [
380 'IsTrustedProxy' => [
381 function ( &$ip, &$trusted ) use ( $xffList ) {
382 $trusted = $trusted || in_array( $ip, $xffList );
383 return true;
384 }
385 ]
386 ]
387 ] );
388
389 $this->setService( 'ProxyLookup', new ProxyLookup( [], $squid ) );
390
391 $request = new WebRequest();
392 $result = $request->getIP();
393 $this->assertEquals( $expected, $result, $description );
394 }
395
396 public static function provideGetIP() {
397 return [
398 [
399 '127.0.0.1',
400 [
401 'REMOTE_ADDR' => '127.0.0.1'
402 ],
403 [],
404 [],
405 false,
406 'Simple IPv4'
407 ],
408 [
409 '::1',
410 [
411 'REMOTE_ADDR' => '::1'
412 ],
413 [],
414 [],
415 false,
416 'Simple IPv6'
417 ],
418 [
419 '12.0.0.1',
420 [
421 'REMOTE_ADDR' => 'abcd:0001:002:03:4:555:6666:7777',
422 'HTTP_X_FORWARDED_FOR' => '12.0.0.1, abcd:0001:002:03:4:555:6666:7777',
423 ],
424 [ 'ABCD:1:2:3:4:555:6666:7777' ],
425 [],
426 false,
427 'IPv6 normalisation'
428 ],
429 [
430 '12.0.0.3',
431 [
432 'REMOTE_ADDR' => '12.0.0.1',
433 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
434 ],
435 [ '12.0.0.1', '12.0.0.2' ],
436 [],
437 false,
438 'With X-Forwaded-For'
439 ],
440 [
441 '12.0.0.1',
442 [
443 'REMOTE_ADDR' => '12.0.0.1',
444 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
445 ],
446 [],
447 [],
448 false,
449 'With X-Forwaded-For and disallowed server'
450 ],
451 [
452 '12.0.0.2',
453 [
454 'REMOTE_ADDR' => '12.0.0.1',
455 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
456 ],
457 [ '12.0.0.1' ],
458 [],
459 false,
460 'With multiple X-Forwaded-For and only one allowed server'
461 ],
462 [
463 '10.0.0.3',
464 [
465 'REMOTE_ADDR' => '12.0.0.2',
466 'HTTP_X_FORWARDED_FOR' => '10.0.0.4, 10.0.0.3, 12.0.0.2'
467 ],
468 [ '12.0.0.1', '12.0.0.2' ],
469 [],
470 false,
471 'With X-Forwaded-For and private IP (from cache proxy)'
472 ],
473 [
474 '10.0.0.4',
475 [
476 'REMOTE_ADDR' => '12.0.0.2',
477 'HTTP_X_FORWARDED_FOR' => '10.0.0.4, 10.0.0.3, 12.0.0.2'
478 ],
479 [ '12.0.0.1', '12.0.0.2', '10.0.0.3' ],
480 [],
481 true,
482 'With X-Forwaded-For and private IP (allowed)'
483 ],
484 [
485 '10.0.0.4',
486 [
487 'REMOTE_ADDR' => '12.0.0.2',
488 'HTTP_X_FORWARDED_FOR' => '10.0.0.4, 10.0.0.3, 12.0.0.2'
489 ],
490 [ '12.0.0.1', '12.0.0.2' ],
491 [ '10.0.0.3' ],
492 true,
493 'With X-Forwaded-For and private IP (allowed)'
494 ],
495 [
496 '10.0.0.3',
497 [
498 'REMOTE_ADDR' => '12.0.0.2',
499 'HTTP_X_FORWARDED_FOR' => '10.0.0.4, 10.0.0.3, 12.0.0.2'
500 ],
501 [ '12.0.0.1', '12.0.0.2' ],
502 [ '10.0.0.3' ],
503 false,
504 'With X-Forwaded-For and private IP (disallowed)'
505 ],
506 [
507 '12.0.0.3',
508 [
509 'REMOTE_ADDR' => '12.0.0.1',
510 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
511 ],
512 [],
513 [ '12.0.0.1', '12.0.0.2' ],
514 false,
515 'With X-Forwaded-For'
516 ],
517 [
518 '12.0.0.2',
519 [
520 'REMOTE_ADDR' => '12.0.0.1',
521 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
522 ],
523 [],
524 [ '12.0.0.1' ],
525 false,
526 'With multiple X-Forwaded-For and only one allowed server'
527 ],
528 [
529 '12.0.0.2',
530 [
531 'REMOTE_ADDR' => '12.0.0.2',
532 'HTTP_X_FORWARDED_FOR' => '10.0.0.3, 12.0.0.2'
533 ],
534 [],
535 [ '12.0.0.2' ],
536 false,
537 'With X-Forwaded-For and private IP and hook (disallowed)'
538 ],
539 [
540 '12.0.0.1',
541 [
542 'REMOTE_ADDR' => 'abcd:0001:002:03:4:555:6666:7777',
543 'HTTP_X_FORWARDED_FOR' => '12.0.0.1, abcd:0001:002:03:4:555:6666:7777',
544 ],
545 [ 'ABCD:1:2:3::/64' ],
546 [],
547 false,
548 'IPv6 CIDR'
549 ],
550 [
551 '12.0.0.3',
552 [
553 'REMOTE_ADDR' => '12.0.0.1',
554 'HTTP_X_FORWARDED_FOR' => '12.0.0.3, 12.0.0.2'
555 ],
556 [ '12.0.0.0/24' ],
557 [],
558 false,
559 'IPv4 CIDR'
560 ],
561 ];
562 }
563
564 /**
565 * @expectedException MWException
566 * @covers WebRequest::getIP
567 */
568 public function testGetIpLackOfRemoteAddrThrowAnException() {
569 // ensure that local install state doesn't interfere with test
570 $this->setMwGlobals( [
571 'wgSquidServersNoPurge' => [],
572 'wgSquidServers' => [],
573 'wgUsePrivateIPs' => false,
574 'wgHooks' => [],
575 ] );
576 $this->setService( 'ProxyLookup', new ProxyLookup( [], [] ) );
577
578 $request = new WebRequest();
579 # Next call throw an exception about lacking an IP
580 $request->getIP();
581 }
582
583 public static function provideLanguageData() {
584 return [
585 [ '', [], 'Empty Accept-Language header' ],
586 [ 'en', [ 'en' => 1 ], 'One language' ],
587 [ 'en, ar', [ 'en' => 1, 'ar' => 1 ], 'Two languages listed in appearance order.' ],
588 [
589 'zh-cn,zh-tw',
590 [ 'zh-cn' => 1, 'zh-tw' => 1 ],
591 'Two equally prefered languages, listed in appearance order per rfc3282. Checks c9119'
592 ],
593 [
594 'es, en; q=0.5',
595 [ 'es' => 1, 'en' => '0.5' ],
596 'Spanish as first language and English and second'
597 ],
598 [ 'en; q=0.5, es', [ 'es' => 1, 'en' => '0.5' ], 'Less prefered language first' ],
599 [ 'fr, en; q=0.5, es', [ 'fr' => 1, 'es' => 1, 'en' => '0.5' ], 'Three languages' ],
600 [ 'en; q=0.5, es', [ 'es' => 1, 'en' => '0.5' ], 'Two languages' ],
601 [ 'en, zh;q=0', [ 'en' => 1 ], "It's Chinese to me" ],
602 [
603 'es; q=1, pt;q=0.7, it; q=0.6, de; q=0.1, ru;q=0',
604 [ 'es' => '1', 'pt' => '0.7', 'it' => '0.6', 'de' => '0.1' ],
605 'Preference for Romance languages'
606 ],
607 [
608 'en-gb, en-us; q=1',
609 [ 'en-gb' => 1, 'en-us' => '1' ],
610 'Two equally prefered English variants'
611 ],
612 [ '_', [], 'Invalid input' ],
613 ];
614 }
615
616 /**
617 * @dataProvider provideLanguageData
618 * @covers WebRequest::getAcceptLang
619 */
620 public function testAcceptLang( $acceptLanguageHeader, $expectedLanguages, $description ) {
621 $this->setServerVars( [ 'HTTP_ACCEPT_LANGUAGE' => $acceptLanguageHeader ] );
622 $request = new WebRequest();
623 $this->assertSame( $request->getAcceptLang(), $expectedLanguages, $description );
624 }
625
626 protected function setServerVars( $vars ) {
627 // Don't remove vars which should be available in all SAPI.
628 if ( !isset( $vars['REQUEST_TIME_FLOAT'] ) ) {
629 $vars['REQUEST_TIME_FLOAT'] = $_SERVER['REQUEST_TIME_FLOAT'];
630 }
631 if ( !isset( $vars['REQUEST_TIME'] ) ) {
632 $vars['REQUEST_TIME'] = $_SERVER['REQUEST_TIME'];
633 }
634 $_SERVER = $vars;
635 }
636 }