Switch to librarized version of TestingAccessWrapper
[lhc/web/wiklou.git] / tests / phpunit / includes / OutputPageTest.php
1 <?php
2
3 use Wikimedia\TestingAccessWrapper;
4
5 /**
6 *
7 * @author Matthew Flaschen
8 *
9 * @group Database
10 * @group Output
11 *
12 * @todo factor tests in this class into providers and test methods
13 */
14 class OutputPageTest extends MediaWikiTestCase {
15 const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
16 const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
17
18 /**
19 * @covers OutputPage::addMeta
20 * @covers OutputPage::getMetaTags
21 * @covers OutputPage::getHeadLinksArray
22 */
23 public function testMetaTags() {
24 $outputPage = $this->newInstance();
25 $outputPage->addMeta( 'http:expires', '0' );
26 $outputPage->addMeta( 'keywords', 'first' );
27 $outputPage->addMeta( 'keywords', 'second' );
28 $outputPage->addMeta( 'og:title', 'Ta-duh' );
29
30 $expected = [
31 [ 'http:expires', '0' ],
32 [ 'keywords', 'first' ],
33 [ 'keywords', 'second' ],
34 [ 'og:title', 'Ta-duh' ],
35 ];
36 $this->assertSame( $expected, $outputPage->getMetaTags() );
37
38 $links = $outputPage->getHeadLinksArray();
39 $this->assertContains( '<meta http-equiv="expires" content="0"/>', $links );
40 $this->assertContains( '<meta name="keywords" content="first"/>', $links );
41 $this->assertContains( '<meta name="keywords" content="second"/>', $links );
42 $this->assertContains( '<meta property="og:title" content="Ta-duh"/>', $links );
43 $this->assertArrayNotHasKey( 'meta-robots', $links );
44 }
45
46 /**
47 * @covers OutputPage::setIndexPolicy
48 * @covers OutputPage::setFollowPolicy
49 * @covers OutputPage::getHeadLinksArray
50 */
51 public function testRobotsPolicies() {
52 $outputPage = $this->newInstance();
53 $outputPage->setIndexPolicy( 'noindex' );
54 $outputPage->setFollowPolicy( 'nofollow' );
55
56 $links = $outputPage->getHeadLinksArray();
57 $this->assertContains( '<meta name="robots" content="noindex,nofollow"/>', $links );
58 }
59
60 /**
61 * Tests a particular case of transformCssMedia, using the given input, globals,
62 * expected return, and message
63 *
64 * Asserts that $expectedReturn is returned.
65 *
66 * options['printableQuery'] - value of query string for printable, or omitted for none
67 * options['handheldQuery'] - value of query string for handheld, or omitted for none
68 * options['media'] - passed into the method under the same name
69 * options['expectedReturn'] - expected return value
70 * options['message'] - PHPUnit message for assertion
71 *
72 * @param array $args Key-value array of arguments as shown above
73 */
74 protected function assertTransformCssMediaCase( $args ) {
75 $queryData = [];
76 if ( isset( $args['printableQuery'] ) ) {
77 $queryData['printable'] = $args['printableQuery'];
78 }
79
80 if ( isset( $args['handheldQuery'] ) ) {
81 $queryData['handheld'] = $args['handheldQuery'];
82 }
83
84 $fauxRequest = new FauxRequest( $queryData, false );
85 $this->setMwGlobals( [
86 'wgRequest' => $fauxRequest,
87 ] );
88
89 $actualReturn = OutputPage::transformCssMedia( $args['media'] );
90 $this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
91 }
92
93 /**
94 * Tests print requests
95 * @covers OutputPage::transformCssMedia
96 */
97 public function testPrintRequests() {
98 $this->assertTransformCssMediaCase( [
99 'printableQuery' => '1',
100 'media' => 'screen',
101 'expectedReturn' => null,
102 'message' => 'On printable request, screen returns null'
103 ] );
104
105 $this->assertTransformCssMediaCase( [
106 'printableQuery' => '1',
107 'media' => self::SCREEN_MEDIA_QUERY,
108 'expectedReturn' => null,
109 'message' => 'On printable request, screen media query returns null'
110 ] );
111
112 $this->assertTransformCssMediaCase( [
113 'printableQuery' => '1',
114 'media' => self::SCREEN_ONLY_MEDIA_QUERY,
115 'expectedReturn' => null,
116 'message' => 'On printable request, screen media query with only returns null'
117 ] );
118
119 $this->assertTransformCssMediaCase( [
120 'printableQuery' => '1',
121 'media' => 'print',
122 'expectedReturn' => '',
123 'message' => 'On printable request, media print returns empty string'
124 ] );
125 }
126
127 /**
128 * Tests screen requests, without either query parameter set
129 * @covers OutputPage::transformCssMedia
130 */
131 public function testScreenRequests() {
132 $this->assertTransformCssMediaCase( [
133 'media' => 'screen',
134 'expectedReturn' => 'screen',
135 'message' => 'On screen request, screen media type is preserved'
136 ] );
137
138 $this->assertTransformCssMediaCase( [
139 'media' => 'handheld',
140 'expectedReturn' => 'handheld',
141 'message' => 'On screen request, handheld media type is preserved'
142 ] );
143
144 $this->assertTransformCssMediaCase( [
145 'media' => self::SCREEN_MEDIA_QUERY,
146 'expectedReturn' => self::SCREEN_MEDIA_QUERY,
147 'message' => 'On screen request, screen media query is preserved.'
148 ] );
149
150 $this->assertTransformCssMediaCase( [
151 'media' => self::SCREEN_ONLY_MEDIA_QUERY,
152 'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
153 'message' => 'On screen request, screen media query with only is preserved.'
154 ] );
155
156 $this->assertTransformCssMediaCase( [
157 'media' => 'print',
158 'expectedReturn' => 'print',
159 'message' => 'On screen request, print media type is preserved'
160 ] );
161 }
162
163 /**
164 * Tests handheld behavior
165 * @covers OutputPage::transformCssMedia
166 */
167 public function testHandheld() {
168 $this->assertTransformCssMediaCase( [
169 'handheldQuery' => '1',
170 'media' => 'handheld',
171 'expectedReturn' => '',
172 'message' => 'On request with handheld querystring and media is handheld, returns empty string'
173 ] );
174
175 $this->assertTransformCssMediaCase( [
176 'handheldQuery' => '1',
177 'media' => 'screen',
178 'expectedReturn' => null,
179 'message' => 'On request with handheld querystring and media is screen, returns null'
180 ] );
181 }
182
183 public static function provideTransformFilePath() {
184 $baseDir = dirname( __DIR__ ) . '/data/media';
185 return [
186 // File that matches basePath, and exists. Hash found and appended.
187 [
188 'baseDir' => $baseDir, 'basePath' => '/w',
189 '/w/test.jpg',
190 '/w/test.jpg?edcf2'
191 ],
192 // File that matches basePath, but not found on disk. Empty query.
193 [
194 'baseDir' => $baseDir, 'basePath' => '/w',
195 '/w/unknown.png',
196 '/w/unknown.png?'
197 ],
198 // File not matching basePath. Ignored.
199 [
200 'baseDir' => $baseDir, 'basePath' => '/w',
201 '/files/test.jpg'
202 ],
203 // Empty string. Ignored.
204 [
205 'baseDir' => $baseDir, 'basePath' => '/w',
206 '',
207 ''
208 ],
209 // Similar path, but with domain component. Ignored.
210 [
211 'baseDir' => $baseDir, 'basePath' => '/w',
212 '//example.org/w/test.jpg'
213 ],
214 [
215 'baseDir' => $baseDir, 'basePath' => '/w',
216 'https://example.org/w/test.jpg'
217 ],
218 // Unrelated path with domain component. Ignored.
219 [
220 'baseDir' => $baseDir, 'basePath' => '/w',
221 'https://example.org/files/test.jpg'
222 ],
223 [
224 'baseDir' => $baseDir, 'basePath' => '/w',
225 '//example.org/files/test.jpg'
226 ],
227 // Unrelated path with domain, and empty base path (root mw install). Ignored.
228 [
229 'baseDir' => $baseDir, 'basePath' => '',
230 'https://example.org/files/test.jpg'
231 ],
232 [
233 'baseDir' => $baseDir, 'basePath' => '',
234 // T155310
235 '//example.org/files/test.jpg'
236 ],
237 // Check UploadPath before ResourceBasePath (T155146)
238 [
239 'baseDir' => dirname( $baseDir ), 'basePath' => '',
240 'uploadDir' => $baseDir, 'uploadPath' => '/images',
241 '/images/test.jpg',
242 '/images/test.jpg?edcf2'
243 ],
244 ];
245 }
246
247 /**
248 * @dataProvider provideTransformFilePath
249 * @covers OutputPage::transformFilePath
250 * @covers OutputPage::transformResourcePath
251 */
252 public function testTransformResourcePath( $baseDir, $basePath, $uploadDir = null,
253 $uploadPath = null, $path = null, $expected = null
254 ) {
255 if ( $path === null ) {
256 // Skip optional $uploadDir and $uploadPath
257 $path = $uploadDir;
258 $expected = $uploadPath;
259 $uploadDir = "$baseDir/images";
260 $uploadPath = "$basePath/images";
261 }
262 $this->setMwGlobals( 'IP', $baseDir );
263 $conf = new HashConfig( [
264 'ResourceBasePath' => $basePath,
265 'UploadDirectory' => $uploadDir,
266 'UploadPath' => $uploadPath,
267 ] );
268
269 MediaWiki\suppressWarnings();
270 $actual = OutputPage::transformResourcePath( $conf, $path );
271 MediaWiki\restoreWarnings();
272
273 $this->assertEquals( $expected ?: $path, $actual );
274 }
275
276 public static function provideMakeResourceLoaderLink() {
277 // @codingStandardsIgnoreStart Generic.Files.LineLength
278 return [
279 // Single only=scripts load
280 [
281 [ 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ],
282 "<script>(window.RLQ=window.RLQ||[]).push(function(){"
283 . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.foo\u0026only=scripts\u0026skin=fallback");'
284 . "});</script>"
285 ],
286 // Multiple only=styles load
287 [
288 [ [ 'test.baz', 'test.foo', 'test.bar' ], ResourceLoaderModule::TYPE_STYLES ],
289
290 '<link rel="stylesheet" href="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.bar%2Cbaz%2Cfoo&amp;only=styles&amp;skin=fallback"/>'
291 ],
292 // Private embed (only=scripts)
293 [
294 [ 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ],
295 "<script>(window.RLQ=window.RLQ||[]).push(function(){"
296 . "mw.test.baz({token:123});mw.loader.state({\"test.quux\":\"ready\"});"
297 . "});</script>"
298 ],
299 ];
300 // @codingStandardsIgnoreEnd
301 }
302
303 /**
304 * See ResourceLoaderClientHtmlTest for full coverage.
305 *
306 * @dataProvider provideMakeResourceLoaderLink
307 * @covers OutputPage::makeResourceLoaderLink
308 */
309 public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
310 $this->setMwGlobals( [
311 'wgResourceLoaderDebug' => false,
312 'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
313 ] );
314 $class = new ReflectionClass( 'OutputPage' );
315 $method = $class->getMethod( 'makeResourceLoaderLink' );
316 $method->setAccessible( true );
317 $ctx = new RequestContext();
318 $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
319 $ctx->setLanguage( 'en' );
320 $out = new OutputPage( $ctx );
321 $rl = $out->getResourceLoader();
322 $rl->setMessageBlobStore( new NullMessageBlobStore() );
323 $rl->register( [
324 'test.foo' => new ResourceLoaderTestModule( [
325 'script' => 'mw.test.foo( { a: true } );',
326 'styles' => '.mw-test-foo { content: "style"; }',
327 ] ),
328 'test.bar' => new ResourceLoaderTestModule( [
329 'script' => 'mw.test.bar( { a: true } );',
330 'styles' => '.mw-test-bar { content: "style"; }',
331 ] ),
332 'test.baz' => new ResourceLoaderTestModule( [
333 'script' => 'mw.test.baz( { a: true } );',
334 'styles' => '.mw-test-baz { content: "style"; }',
335 ] ),
336 'test.quux' => new ResourceLoaderTestModule( [
337 'script' => 'mw.test.baz( { token: 123 } );',
338 'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
339 'group' => 'private',
340 ] ),
341 ] );
342 $links = $method->invokeArgs( $out, $args );
343 $actualHtml = strval( $links );
344 $this->assertEquals( $expectedHtml, $actualHtml );
345 }
346
347 /**
348 * @dataProvider provideVaryHeaders
349 * @covers OutputPage::addVaryHeader
350 * @covers OutputPage::getVaryHeader
351 * @covers OutputPage::getKeyHeader
352 */
353 public function testVaryHeaders( $calls, $vary, $key ) {
354 // get rid of default Vary fields
355 $outputPage = $this->getMockBuilder( 'OutputPage' )
356 ->setConstructorArgs( [ new RequestContext() ] )
357 ->setMethods( [ 'getCacheVaryCookies' ] )
358 ->getMock();
359 $outputPage->expects( $this->any() )
360 ->method( 'getCacheVaryCookies' )
361 ->will( $this->returnValue( [] ) );
362 TestingAccessWrapper::newFromObject( $outputPage )->mVaryHeader = [];
363
364 foreach ( $calls as $call ) {
365 call_user_func_array( [ $outputPage, 'addVaryHeader' ], $call );
366 }
367 $this->assertEquals( $vary, $outputPage->getVaryHeader(), 'Vary:' );
368 $this->assertEquals( $key, $outputPage->getKeyHeader(), 'Key:' );
369 }
370
371 public function provideVaryHeaders() {
372 // note: getKeyHeader() automatically adds Vary: Cookie
373 return [
374 [ // single header
375 [
376 [ 'Cookie' ],
377 ],
378 'Vary: Cookie',
379 'Key: Cookie',
380 ],
381 [ // non-unique headers
382 [
383 [ 'Cookie' ],
384 [ 'Accept-Language' ],
385 [ 'Cookie' ],
386 ],
387 'Vary: Cookie, Accept-Language',
388 'Key: Cookie,Accept-Language',
389 ],
390 [ // two headers with single options
391 [
392 [ 'Cookie', [ 'param=phpsessid' ] ],
393 [ 'Accept-Language', [ 'substr=en' ] ],
394 ],
395 'Vary: Cookie, Accept-Language',
396 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
397 ],
398 [ // one header with multiple options
399 [
400 [ 'Cookie', [ 'param=phpsessid', 'param=userId' ] ],
401 ],
402 'Vary: Cookie',
403 'Key: Cookie;param=phpsessid;param=userId',
404 ],
405 [ // Duplicate option
406 [
407 [ 'Cookie', [ 'param=phpsessid' ] ],
408 [ 'Cookie', [ 'param=phpsessid' ] ],
409 [ 'Accept-Language', [ 'substr=en', 'substr=en' ] ],
410 ],
411 'Vary: Cookie, Accept-Language',
412 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
413 ],
414 [ // Same header, different options
415 [
416 [ 'Cookie', [ 'param=phpsessid' ] ],
417 [ 'Cookie', [ 'param=userId' ] ],
418 ],
419 'Vary: Cookie',
420 'Key: Cookie;param=phpsessid;param=userId',
421 ],
422 ];
423 }
424
425 /**
426 * @covers OutputPage::haveCacheVaryCookies
427 */
428 public function testHaveCacheVaryCookies() {
429 $request = new FauxRequest();
430 $context = new RequestContext();
431 $context->setRequest( $request );
432 $outputPage = new OutputPage( $context );
433
434 // No cookies are set.
435 $this->assertFalse( $outputPage->haveCacheVaryCookies() );
436
437 // 'Token' is present but empty, so it shouldn't count.
438 $request->setCookie( 'Token', '' );
439 $this->assertFalse( $outputPage->haveCacheVaryCookies() );
440
441 // 'Token' present and nonempty.
442 $request->setCookie( 'Token', '123' );
443 $this->assertTrue( $outputPage->haveCacheVaryCookies() );
444 }
445
446 /*
447 * @covers OutputPage::addCategoryLinks
448 * @covers OutputPage::getCategories
449 */
450 public function testGetCategories() {
451 $fakeResultWrapper = new FakeResultWrapper( [
452 (object) [
453 'pp_value' => 1,
454 'page_title' => 'Test'
455 ],
456 (object) [
457 'page_title' => 'Test2'
458 ]
459 ] );
460 $outputPage = $this->getMockBuilder( 'OutputPage' )
461 ->setConstructorArgs( [ new RequestContext() ] )
462 ->setMethods( [ 'addCategoryLinksToLBAndGetResult' ] )
463 ->getMock();
464 $outputPage->expects( $this->any() )
465 ->method( 'addCategoryLinksToLBAndGetResult' )
466 ->will( $this->returnValue( $fakeResultWrapper ) );
467
468 $outputPage->addCategoryLinks( [
469 'Test' => 'Test',
470 'Test2' => 'Test2',
471 ] );
472 $this->assertEquals( [ 0 => 'Test', '1' => 'Test2' ], $outputPage->getCategories() );
473 $this->assertEquals( [ 0 => 'Test2' ], $outputPage->getCategories( 'normal' ) );
474 $this->assertEquals( [ 0 => 'Test' ], $outputPage->getCategories( 'hidden' ) );
475 }
476
477 /**
478 * @dataProvider provideLinkHeaders
479 * @covers OutputPage::addLinkHeader
480 * @covers OutputPage::getLinkHeader
481 */
482 public function testLinkHeaders( $headers, $result ) {
483 $outputPage = $this->newInstance();
484
485 foreach ( $headers as $header ) {
486 $outputPage->addLinkHeader( $header );
487 }
488
489 $this->assertEquals( $result, $outputPage->getLinkHeader() );
490 }
491
492 public function provideLinkHeaders() {
493 return [
494 [
495 [],
496 false
497 ],
498 [
499 [ '<https://foo/bar.jpg>;rel=preload;as=image' ],
500 'Link: <https://foo/bar.jpg>;rel=preload;as=image',
501 ],
502 [
503 [ '<https://foo/bar.jpg>;rel=preload;as=image','<https://foo/baz.jpg>;rel=preload;as=image' ],
504 'Link: <https://foo/bar.jpg>;rel=preload;as=image,<https://foo/baz.jpg>;rel=preload;as=image',
505 ],
506 ];
507 }
508
509 /**
510 * @dataProvider providePreloadLinkHeaders
511 * @covers OutputPage::addLogoPreloadLinkHeaders
512 * @covers ResourceLoaderSkinModule::getLogo
513 */
514 public function testPreloadLinkHeaders( $config, $result, $baseDir = null ) {
515 if ( $baseDir ) {
516 $this->setMwGlobals( 'IP', $baseDir );
517 }
518 $out = TestingAccessWrapper::newFromObject( $this->newInstance( $config ) );
519 $out->addLogoPreloadLinkHeaders();
520
521 $this->assertEquals( $result, $out->getLinkHeader() );
522 }
523
524 public function providePreloadLinkHeaders() {
525 return [
526 [
527 [
528 'ResourceBasePath' => '/w',
529 'Logo' => '/img/default.png',
530 'LogoHD' => [
531 '1.5x' => '/img/one-point-five.png',
532 '2x' => '/img/two-x.png',
533 ],
534 ],
535 'Link: </img/default.png>;rel=preload;as=image;media=' .
536 'not all and (min-resolution: 1.5dppx),' .
537 '</img/one-point-five.png>;rel=preload;as=image;media=' .
538 '(min-resolution: 1.5dppx) and (max-resolution: 1.999999dppx),' .
539 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
540 ],
541 [
542 [
543 'ResourceBasePath' => '/w',
544 'Logo' => '/img/default.png',
545 'LogoHD' => false,
546 ],
547 'Link: </img/default.png>;rel=preload;as=image'
548 ],
549 [
550 [
551 'ResourceBasePath' => '/w',
552 'Logo' => '/img/default.png',
553 'LogoHD' => [
554 '2x' => '/img/two-x.png',
555 ],
556 ],
557 'Link: </img/default.png>;rel=preload;as=image;media=' .
558 'not all and (min-resolution: 2dppx),' .
559 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
560 ],
561 [
562 [
563 'ResourceBasePath' => '/w',
564 'Logo' => '/w/test.jpg',
565 'LogoHD' => false,
566 'UploadPath' => '/w/images',
567 ],
568 'Link: </w/test.jpg?edcf2>;rel=preload;as=image',
569 'baseDir' => dirname( __DIR__ ) . '/data/media',
570 ],
571 ];
572 }
573
574 /**
575 * @return OutputPage
576 */
577 private function newInstance( $config = [] ) {
578 $context = new RequestContext();
579
580 $context->setConfig( new HashConfig( $config + [
581 'AppleTouchIcon' => false,
582 'DisableLangConversion' => true,
583 'EnableAPI' => false,
584 'EnableCanonicalServerLink' => false,
585 'Favicon' => false,
586 'Feed' => false,
587 'LanguageCode' => false,
588 'ReferrerPolicy' => false,
589 'RightsPage' => false,
590 'RightsUrl' => false,
591 'UniversalEditButton' => false,
592 ] ) );
593
594 return new OutputPage( $context );
595 }
596 }
597
598 /**
599 * MessageBlobStore that doesn't do anything
600 */
601 class NullMessageBlobStore extends MessageBlobStore {
602 public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
603 return [];
604 }
605
606 public function insertMessageBlob( $name, ResourceLoaderModule $module, $lang ) {
607 return false;
608 }
609
610 public function updateModule( $name, ResourceLoaderModule $module, $lang ) {
611 }
612
613 public function updateMessage( $key ) {
614 }
615
616 public function clear() {
617 }
618 }