dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Tidy Message::parseAsBlock() by enabling tidy in MessageCache
[lhc/web/wiklou.git] / tests / phpunit / includes / OutputPageTest.php
1 <?php
2
3 use Wikimedia\TestingAccessWrapper;
4
5 /**
6 * @author Matthew Flaschen
7 *
8 * @group Database
9 * @group Output
10 */
11 class OutputPageTest extends MediaWikiTestCase {
12 const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
13 const SCREEN_ONLY_MEDIA_QUERY = 'only screen and (min-width: 982px)';
14
15 // Ensure that we don't affect the global ResourceLoader state.
16 protected function setUp() {
17 parent::setUp();
18 ResourceLoader::clearCache();
19 }
20 protected function tearDown() {
21 parent::tearDown();
22 ResourceLoader::clearCache();
23 }
24
25 /**
26 * @dataProvider provideRedirect
27 *
28 * @covers OutputPage::__construct
29 * @covers OutputPage::redirect
30 * @covers OutputPage::getRedirect
31 */
32 public function testRedirect( $url, $code = null ) {
33 $op = $this->newInstance();
34 if ( isset( $code ) ) {
35 $op->redirect( $url, $code );
36 } else {
37 $op->redirect( $url );
38 }
39 $expectedUrl = str_replace( "\n", '', $url );
40 $this->assertSame( $expectedUrl, $op->getRedirect() );
41 $this->assertSame( $expectedUrl, $op->mRedirect );
42 $this->assertSame( $code ?? '302', $op->mRedirectCode );
43 }
44
45 public function provideRedirect() {
46 return [
47 [ 'http://example.com' ],
48 [ 'http://example.com', '400' ],
49 [ 'http://example.com', 'squirrels!!!' ],
50 [ "a\nb" ],
51 ];
52 }
53
54 /**
55 * @covers OutputPage::setCopyrightUrl
56 * @covers OutputPage::getHeadLinksArray
57 */
58 public function testSetCopyrightUrl() {
59 $op = $this->newInstance();
60 $op->setCopyrightUrl( 'http://example.com' );
61
62 $this->assertSame(
63 Html::element( 'link', [ 'rel' => 'license', 'href' => 'http://example.com' ] ),
64 $op->getHeadLinksArray()['copyright']
65 );
66 }
67
68 // @todo How to test setStatusCode?
69
70 /**
71 * @covers OutputPage::addMeta
72 * @covers OutputPage::getMetaTags
73 * @covers OutputPage::getHeadLinksArray
74 */
75 public function testMetaTags() {
76 $op = $this->newInstance();
77 $op->addMeta( 'http:expires', '0' );
78 $op->addMeta( 'keywords', 'first' );
79 $op->addMeta( 'keywords', 'second' );
80 $op->addMeta( 'og:title', 'Ta-duh' );
81
82 $expected = [
83 [ 'http:expires', '0' ],
84 [ 'keywords', 'first' ],
85 [ 'keywords', 'second' ],
86 [ 'og:title', 'Ta-duh' ],
87 ];
88 $this->assertSame( $expected, $op->getMetaTags() );
89
90 $links = $op->getHeadLinksArray();
91 $this->assertContains( '<meta http-equiv="expires" content="0"/>', $links );
92 $this->assertContains( '<meta name="keywords" content="first"/>', $links );
93 $this->assertContains( '<meta name="keywords" content="second"/>', $links );
94 $this->assertContains( '<meta property="og:title" content="Ta-duh"/>', $links );
95 $this->assertArrayNotHasKey( 'meta-robots', $links );
96 }
97
98 /**
99 * @covers OutputPage::addLink
100 * @covers OutputPage::getLinkTags
101 * @covers OutputPage::getHeadLinksArray
102 */
103 public function testAddLink() {
104 $op = $this->newInstance();
105
106 $links = [
107 [],
108 [ 'rel' => 'foo', 'href' => 'http://example.com' ],
109 ];
110
111 foreach ( $links as $link ) {
112 $op->addLink( $link );
113 }
114
115 $this->assertSame( $links, $op->getLinkTags() );
116
117 $result = $op->getHeadLinksArray();
118
119 foreach ( $links as $link ) {
120 $this->assertContains( Html::element( 'link', $link ), $result );
121 }
122 }
123
124 /**
125 * @covers OutputPage::setCanonicalUrl
126 * @covers OutputPage::getCanonicalUrl
127 * @covers OutputPage::getHeadLinksArray
128 */
129 public function testSetCanonicalUrl() {
130 $op = $this->newInstance();
131 $op->setCanonicalUrl( 'http://example.comm' );
132 $op->setCanonicalUrl( 'http://example.com' );
133
134 $this->assertSame( 'http://example.com', $op->getCanonicalUrl() );
135
136 $headLinks = $op->getHeadLinksArray();
137
138 $this->assertContains( Html::element( 'link', [
139 'rel' => 'canonical', 'href' => 'http://example.com'
140 ] ), $headLinks );
141
142 $this->assertNotContains( Html::element( 'link', [
143 'rel' => 'canonical', 'href' => 'http://example.comm'
144 ] ), $headLinks );
145 }
146
147 /**
148 * @covers OutputPage::addScript
149 */
150 public function testAddScript() {
151 $op = $this->newInstance();
152 $op->addScript( 'some random string' );
153
154 $this->assertContains( "\nsome random string\n", "\n" . $op->getBottomScripts() . "\n" );
155 }
156
157 /**
158 * @covers OutputPage::addScriptFile
159 */
160 public function testAddScriptFile() {
161 $op = $this->newInstance();
162 $op->addScriptFile( '/somescript.js' );
163 $op->addScriptFile( '//example.com/somescript.js' );
164
165 $this->assertContains(
166 "\n" . Html::linkedScript( '/somescript.js', $op->getCSPNonce() ) .
167 Html::linkedScript( '//example.com/somescript.js', $op->getCSPNonce() ) . "\n",
168 "\n" . $op->getBottomScripts() . "\n"
169 );
170 }
171
172 /**
173 * Test that addScriptFile() throws due to deprecation.
174 *
175 * @covers OutputPage::addScriptFile
176 */
177 public function testAddDeprecatedScriptFileWarning() {
178 $this->setExpectedException( PHPUnit_Framework_Error_Deprecated::class,
179 'Use of OutputPage::addScriptFile was deprecated in MediaWiki 1.24.' );
180
181 $op = $this->newInstance();
182 $op->addScriptFile( 'ignored-script.js' );
183 }
184
185 /**
186 * Test the actual behavior of the method (in the case where it doesn't throw, e.g., in
187 * production).
188 *
189 * @covers OutputPage::addScriptFile
190 */
191 public function testAddDeprecatedScriptFileNoOp() {
192 $this->hideDeprecated( 'OutputPage::addScriptFile' );
193 $op = $this->newInstance();
194 $op->addScriptFile( 'ignored-script.js' );
195
196 $this->assertNotContains( 'ignored-script.js', '' . $op->getBottomScripts() );
197 }
198
199 /**
200 * @covers OutputPage::addInlineScript
201 */
202 public function testAddInlineScript() {
203 $op = $this->newInstance();
204 $op->addInlineScript( 'let foo = "bar";' );
205 $op->addInlineScript( 'alert( foo );' );
206
207 $this->assertContains(
208 "\n" . Html::inlineScript( "\nlet foo = \"bar\";\n", $op->getCSPNonce() ) . "\n" .
209 Html::inlineScript( "\nalert( foo );\n", $op->getCSPNonce() ) . "\n",
210 "\n" . $op->getBottomScripts() . "\n"
211 );
212 }
213
214 // @todo How to test filterModules(), warnModuleTargetFilter(), getModules(), etc.?
215
216 /**
217 * @covers OutputPage::getTarget
218 * @covers OutputPage::setTarget
219 */
220 public function testSetTarget() {
221 $op = $this->newInstance();
222 $op->setTarget( 'foo' );
223
224 $this->assertSame( 'foo', $op->getTarget() );
225 // @todo What else? Test some actual effect?
226 }
227
228 // @todo How to test addContentOverride(Callback)?
229
230 /**
231 * @covers OutputPage::getHeadItemsArray
232 * @covers OutputPage::addHeadItem
233 * @covers OutputPage::addHeadItems
234 * @covers OutputPage::hasHeadItem
235 */
236 public function testHeadItems() {
237 $op = $this->newInstance();
238 $op->addHeadItem( 'a', 'b' );
239 $op->addHeadItems( [ 'c' => '<d>&amp;', 'e' => 'f', 'a' => 'q' ] );
240 $op->addHeadItem( 'e', 'g' );
241 $op->addHeadItems( 'x' );
242
243 $this->assertSame( [ 'a' => 'q', 'c' => '<d>&amp;', 'e' => 'g', 'x' ],
244 $op->getHeadItemsArray() );
245
246 $this->assertTrue( $op->hasHeadItem( 'a' ) );
247 $this->assertTrue( $op->hasHeadItem( 'c' ) );
248 $this->assertTrue( $op->hasHeadItem( 'e' ) );
249 $this->assertTrue( $op->hasHeadItem( '0' ) );
250
251 $this->assertContains( "\nq\n<d>&amp;\ng\nx\n",
252 '' . $op->headElement( $op->getContext()->getSkin() ) );
253 }
254
255 /**
256 * @covers OutputPage::getHeadItemsArray
257 * @covers OutputPage::addParserOutputMetadata
258 * @covers OutputPage::addParserOutput
259 */
260 public function testHeadItemsParserOutput() {
261 $op = $this->newInstance();
262 $stubPO1 = $this->createParserOutputStub( 'getHeadItems', [ 'a' => 'b' ] );
263 $op->addParserOutputMetadata( $stubPO1 );
264 $stubPO2 = $this->createParserOutputStub( 'getHeadItems',
265 [ 'c' => '<d>&amp;', 'e' => 'f', 'a' => 'q' ] );
266 $op->addParserOutputMetadata( $stubPO2 );
267 $stubPO3 = $this->createParserOutputStub( 'getHeadItems', [ 'e' => 'g' ] );
268 $op->addParserOutput( $stubPO3 );
269 $stubPO4 = $this->createParserOutputStub( 'getHeadItems', [ 'x' ] );
270 $op->addParserOutputMetadata( $stubPO4 );
271
272 $this->assertSame( [ 'a' => 'q', 'c' => '<d>&amp;', 'e' => 'g', 'x' ],
273 $op->getHeadItemsArray() );
274
275 $this->assertTrue( $op->hasHeadItem( 'a' ) );
276 $this->assertTrue( $op->hasHeadItem( 'c' ) );
277 $this->assertTrue( $op->hasHeadItem( 'e' ) );
278 $this->assertTrue( $op->hasHeadItem( '0' ) );
279 $this->assertFalse( $op->hasHeadItem( 'b' ) );
280
281 $this->assertContains( "\nq\n<d>&amp;\ng\nx\n",
282 '' . $op->headElement( $op->getContext()->getSkin() ) );
283 }
284
285 /**
286 * @covers OutputPage::addBodyClasses
287 */
288 public function testAddBodyClasses() {
289 $op = $this->newInstance();
290 $op->addBodyClasses( 'a' );
291 $op->addBodyClasses( 'mediawiki' );
292 $op->addBodyClasses( 'b c' );
293 $op->addBodyClasses( [ 'd', 'e' ] );
294 $op->addBodyClasses( 'a' );
295
296 $this->assertContains( '"a mediawiki b c d e ltr',
297 '' . $op->headElement( $op->getContext()->getSkin() ) );
298 }
299
300 /**
301 * @covers OutputPage::setArticleBodyOnly
302 * @covers OutputPage::getArticleBodyOnly
303 */
304 public function testArticleBodyOnly() {
305 $op = $this->newInstance();
306 $this->assertFalse( $op->getArticleBodyOnly() );
307
308 $op->setArticleBodyOnly( true );
309 $this->assertTrue( $op->getArticleBodyOnly() );
310
311 $op->addHTML( '<b>a</b>' );
312
313 $this->assertSame( '<b>a</b>', $op->output( true ) );
314 }
315
316 /**
317 * @covers OutputPage::setProperty
318 * @covers OutputPage::getProperty
319 */
320 public function testProperties() {
321 $op = $this->newInstance();
322
323 $this->assertNull( $op->getProperty( 'foo' ) );
324
325 $op->setProperty( 'foo', 'bar' );
326 $op->setProperty( 'baz', 'quz' );
327
328 $this->assertSame( 'bar', $op->getProperty( 'foo' ) );
329 $this->assertSame( 'quz', $op->getProperty( 'baz' ) );
330 }
331
332 /**
333 * @dataProvider provideCheckLastModified
334 *
335 * @covers OutputPage::checkLastModified
336 * @covers OutputPage::getCdnCacheEpoch
337 */
338 public function testCheckLastModified(
339 $timestamp, $ifModifiedSince, $expected, $config = [], $callback = null
340 ) {
341 $request = new FauxRequest();
342 if ( $ifModifiedSince ) {
343 if ( is_numeric( $ifModifiedSince ) ) {
344 // Unix timestamp
345 $ifModifiedSince = date( 'D, d M Y H:i:s', $ifModifiedSince ) . ' GMT';
346 }
347 $request->setHeader( 'If-Modified-Since', $ifModifiedSince );
348 }
349
350 if ( !isset( $config['CacheEpoch'] ) ) {
351 // Make sure it's not too recent
352 $config['CacheEpoch'] = '20000101000000';
353 }
354
355 $op = $this->newInstance( $config, $request );
356
357 if ( $callback ) {
358 $callback( $op, $this );
359 }
360
361 // Avoid a complaint about not being able to disable compression
362 Wikimedia\suppressWarnings();
363 try {
364 $this->assertEquals( $expected, $op->checkLastModified( $timestamp ) );
365 } finally {
366 Wikimedia\restoreWarnings();
367 }
368 }
369
370 public function provideCheckLastModified() {
371 $lastModified = time() - 3600;
372 return [
373 'Timestamp 0' =>
374 [ '0', $lastModified, false ],
375 'Timestamp Unix epoch' =>
376 [ '19700101000000', $lastModified, false ],
377 'Timestamp same as If-Modified-Since' =>
378 [ $lastModified, $lastModified, true ],
379 'Timestamp one second after If-Modified-Since' =>
380 [ $lastModified + 1, $lastModified, false ],
381 'No If-Modified-Since' =>
382 [ $lastModified + 1, null, false ],
383 'Malformed If-Modified-Since' =>
384 [ $lastModified + 1, 'GIBBERING WOMBATS !!!', false ],
385 'Non-standard IE-style If-Modified-Since' =>
386 [ $lastModified, date( 'D, d M Y H:i:s', $lastModified ) . ' GMT; length=5202',
387 true ],
388 // @todo Should we fix this behavior to match the spec? Probably no reason to.
389 'If-Modified-Since not per spec but we accept it anyway because strtotime does' =>
390 [ $lastModified, "@$lastModified", true ],
391 '$wgCachePages = false' =>
392 [ $lastModified, $lastModified, false, [ 'CachePages' => false ] ],
393 '$wgCacheEpoch' =>
394 [ $lastModified, $lastModified, false,
395 [ 'CacheEpoch' => wfTimestamp( TS_MW, $lastModified + 1 ) ] ],
396 'Recently-touched user' =>
397 [ $lastModified, $lastModified, false, [],
398 function ( $op ) {
399 $op->getContext()->setUser( $this->getTestUser()->getUser() );
400 } ],
401 'After Squid expiry' =>
402 [ $lastModified, $lastModified, false,
403 [ 'UseSquid' => true, 'SquidMaxage' => 3599 ] ],
404 'Hook allows cache use' =>
405 [ $lastModified + 1, $lastModified, true, [],
406 function ( $op, $that ) {
407 $that->setTemporaryHook( 'OutputPageCheckLastModified',
408 function ( &$modifiedTimes ) {
409 $modifiedTimes = [ 1 ];
410 }
411 );
412 } ],
413 'Hooks prohibits cache use' =>
414 [ $lastModified, $lastModified, false, [],
415 function ( $op, $that ) {
416 $that->setTemporaryHook( 'OutputPageCheckLastModified',
417 function ( &$modifiedTimes ) {
418 $modifiedTimes = [ max( $modifiedTimes ) + 1 ];
419 }
420 );
421 } ],
422 ];
423 }
424
425 /**
426 * @dataProvider provideCdnCacheEpoch
427 *
428 * @covers OutputPage::getCdnCacheEpoch
429 */
430 public function testCdnCacheEpoch( $params ) {
431 $out = TestingAccessWrapper::newFromObject( $this->newInstance() );
432 $reqTime = strtotime( $params['reqTime'] );
433 $pageTime = strtotime( $params['pageTime'] );
434 $actual = max( $pageTime, $out->getCdnCacheEpoch( $reqTime, $params['maxAge'] ) );
435
436 $this->assertEquals(
437 $params['expect'],
438 gmdate( DateTime::ATOM, $actual ),
439 'cdn epoch'
440 );
441 }
442
443 public static function provideCdnCacheEpoch() {
444 $base = [
445 'pageTime' => '2011-04-01T12:00:00+00:00',
446 'maxAge' => 24 * 3600,
447 ];
448 return [
449 'after 1s' => [ $base + [
450 'reqTime' => '2011-04-01T12:00:01+00:00',
451 'expect' => '2011-04-01T12:00:00+00:00',
452 ] ],
453 'after 23h' => [ $base + [
454 'reqTime' => '2011-04-02T11:00:00+00:00',
455 'expect' => '2011-04-01T12:00:00+00:00',
456 ] ],
457 'after 24h and a bit' => [ $base + [
458 'reqTime' => '2011-04-02T12:34:56+00:00',
459 'expect' => '2011-04-01T12:34:56+00:00',
460 ] ],
461 'after a year' => [ $base + [
462 'reqTime' => '2012-05-06T00:12:07+00:00',
463 'expect' => '2012-05-05T00:12:07+00:00',
464 ] ],
465 ];
466 }
467
468 // @todo How to test setLastModified?
469
470 /**
471 * @covers OutputPage::setRobotPolicy
472 * @covers OutputPage::getHeadLinksArray
473 */
474 public function testSetRobotPolicy() {
475 $op = $this->newInstance();
476 $op->setRobotPolicy( 'noindex, nofollow' );
477
478 $links = $op->getHeadLinksArray();
479 $this->assertContains( '<meta name="robots" content="noindex,nofollow"/>', $links );
480 }
481
482 /**
483 * @covers OutputPage::setIndexPolicy
484 * @covers OutputPage::setFollowPolicy
485 * @covers OutputPage::getHeadLinksArray
486 */
487 public function testSetIndexFollowPolicies() {
488 $op = $this->newInstance();
489 $op->setIndexPolicy( 'noindex' );
490 $op->setFollowPolicy( 'nofollow' );
491
492 $links = $op->getHeadLinksArray();
493 $this->assertContains( '<meta name="robots" content="noindex,nofollow"/>', $links );
494 }
495
496 private function extractHTMLTitle( OutputPage $op ) {
497 $html = $op->headElement( $op->getContext()->getSkin() );
498
499 // OutputPage should always output the title in a nice format such that regexes will work
500 // fine. If it doesn't, we'll fail the tests.
501 preg_match_all( '!<title>(.*?)</title>!', $html, $matches );
502
503 $this->assertLessThanOrEqual( 1, count( $matches[1] ), 'More than one <title>!' );
504
505 if ( !count( $matches[1] ) ) {
506 return null;
507 }
508
509 return $matches[1][0];
510 }
511
512 /**
513 * Shorthand for getting the text of a message, in content language.
514 */
515 private static function getMsgText( $op, ...$msgParams ) {
516 return $op->msg( ...$msgParams )->inContentLanguage()->text();
517 }
518
519 /**
520 * @covers OutputPage::setHTMLTitle
521 * @covers OutputPage::getHTMLTitle
522 */
523 public function testHTMLTitle() {
524 $op = $this->newInstance();
525
526 // Default
527 $this->assertSame( '', $op->getHTMLTitle() );
528 $this->assertSame( '', $op->getPageTitle() );
529 $this->assertSame(
530 $this->getMsgText( $op, 'pagetitle', '' ),
531 $this->extractHTMLTitle( $op )
532 );
533
534 // Set to string
535 $op->setHTMLTitle( 'Potatoes will eat me' );
536
537 $this->assertSame( 'Potatoes will eat me', $op->getHTMLTitle() );
538 $this->assertSame( 'Potatoes will eat me', $this->extractHTMLTitle( $op ) );
539 // Shouldn't have changed the page title
540 $this->assertSame( '', $op->getPageTitle() );
541
542 // Set to message
543 $msg = $op->msg( 'mainpage' );
544
545 $op->setHTMLTitle( $msg );
546 $this->assertSame( $msg->text(), $op->getHTMLTitle() );
547 $this->assertSame( $msg->text(), $this->extractHTMLTitle( $op ) );
548 $this->assertSame( '', $op->getPageTitle() );
549 }
550
551 /**
552 * @covers OutputPage::setRedirectedFrom
553 */
554 public function testSetRedirectedFrom() {
555 $op = $this->newInstance();
556
557 $op->setRedirectedFrom( Title::newFromText( 'Talk:Some page' ) );
558 $this->assertSame( 'Talk:Some_page', $op->getJSVars()['wgRedirectedFrom'] );
559 }
560
561 /**
562 * @covers OutputPage::setPageTitle
563 * @covers OutputPage::getPageTitle
564 */
565 public function testPageTitle() {
566 // We don't test the actual HTML output anywhere, because that's up to the skin.
567 $op = $this->newInstance();
568
569 // Test default
570 $this->assertSame( '', $op->getPageTitle() );
571 $this->assertSame( '', $op->getHTMLTitle() );
572
573 // Test set to plain text
574 $op->setPageTitle( 'foobar' );
575
576 $this->assertSame( 'foobar', $op->getPageTitle() );
577 // HTML title should change as well
578 $this->assertSame( $this->getMsgText( $op, 'pagetitle', 'foobar' ), $op->getHTMLTitle() );
579
580 // Test set to text with good and bad HTML. We don't try to be comprehensive here, that
581 // belongs in Sanitizer tests.
582 $op->setPageTitle( '<script>a</script>&amp;<i>b</i>' );
583
584 $this->assertSame( '&lt;script&gt;a&lt;/script&gt;&amp;<i>b</i>', $op->getPageTitle() );
585 $this->assertSame(
586 $this->getMsgText( $op, 'pagetitle', '<script>a</script>&b' ),
587 $op->getHTMLTitle()
588 );
589
590 // Test set to message
591 $text = $this->getMsgText( $op, 'mainpage' );
592
593 $op->setPageTitle( $op->msg( 'mainpage' )->inContentLanguage() );
594 $this->assertSame( $text, $op->getPageTitle() );
595 $this->assertSame( $this->getMsgText( $op, 'pagetitle', $text ), $op->getHTMLTitle() );
596 }
597
598 /**
599 * @covers OutputPage::setTitle
600 */
601 public function testSetTitle() {
602 $op = $this->newInstance();
603
604 $this->assertSame( 'My test page', $op->getTitle()->getPrefixedText() );
605
606 $op->setTitle( Title::newFromText( 'Another test page' ) );
607
608 $this->assertSame( 'Another test page', $op->getTitle()->getPrefixedText() );
609 }
610
611 /**
612 * @covers OutputPage::setSubtitle
613 * @covers OutputPage::clearSubtitle
614 * @covers OutputPage::addSubtitle
615 * @covers OutputPage::getSubtitle
616 */
617 public function testSubtitle() {
618 $op = $this->newInstance();
619
620 $this->assertSame( '', $op->getSubtitle() );
621
622 $op->addSubtitle( '<b>foo</b>' );
623
624 $this->assertSame( '<b>foo</b>', $op->getSubtitle() );
625
626 $op->addSubtitle( $op->msg( 'mainpage' )->inContentLanguage() );
627
628 $this->assertSame(
629 "<b>foo</b><br />\n\t\t\t\t" . $this->getMsgText( $op, 'mainpage' ),
630 $op->getSubtitle()
631 );
632
633 $op->setSubtitle( 'There can be only one' );
634
635 $this->assertSame( 'There can be only one', $op->getSubtitle() );
636
637 $op->clearSubtitle();
638
639 $this->assertSame( '', $op->getSubtitle() );
640 }
641
642 /**
643 * @dataProvider provideBacklinkSubtitle
644 *
645 * @covers OutputPage::buildBacklinkSubtitle
646 */
647 public function testBuildBacklinkSubtitle( $titles, $queries, $contains, $notContains ) {
648 if ( count( $titles ) > 1 ) {
649 // Not applicable
650 $this->assertTrue( true );
651 return;
652 }
653
654 $title = Title::newFromText( $titles[0] );
655 $query = $queries[0];
656
657 $this->editPage( 'Page 1', '' );
658 $this->editPage( 'Page 2', '#REDIRECT [[Page 1]]' );
659
660 $str = OutputPage::buildBacklinkSubtitle( $title, $query )->text();
661
662 foreach ( $contains as $substr ) {
663 $this->assertContains( $substr, $str );
664 }
665
666 foreach ( $notContains as $substr ) {
667 $this->assertNotContains( $substr, $str );
668 }
669 }
670
671 /**
672 * @dataProvider provideBacklinkSubtitle
673 *
674 * @covers OutputPage::addBacklinkSubtitle
675 * @covers OutputPage::getSubtitle
676 */
677 public function testAddBacklinkSubtitle( $titles, $queries, $contains, $notContains ) {
678 $this->editPage( 'Page 1', '' );
679 $this->editPage( 'Page 2', '#REDIRECT [[Page 1]]' );
680
681 $op = $this->newInstance();
682 foreach ( $titles as $i => $unused ) {
683 $op->addBacklinkSubtitle( Title::newFromText( $titles[$i] ), $queries[$i] );
684 }
685
686 $str = $op->getSubtitle();
687
688 foreach ( $contains as $substr ) {
689 $this->assertContains( $substr, $str );
690 }
691
692 foreach ( $notContains as $substr ) {
693 $this->assertNotContains( $substr, $str );
694 }
695 }
696
697 public function provideBacklinkSubtitle() {
698 return [
699 [
700 [ 'Page 1' ],
701 [ [] ],
702 [ 'Page 1' ],
703 [ 'redirect', 'Page 2' ],
704 ],
705 [
706 [ 'Page 2' ],
707 [ [] ],
708 [ 'redirect=no' ],
709 [ 'Page 1' ],
710 ],
711 [
712 [ 'Page 1' ],
713 [ [ 'action' => 'edit' ] ],
714 [ 'action=edit' ],
715 [],
716 ],
717 [
718 [ 'Page 1', 'Page 2' ],
719 [ [], [] ],
720 [ 'Page 1', 'Page 2', "<br />\n\t\t\t\t" ],
721 [],
722 ],
723 // @todo Anything else to test?
724 ];
725 }
726
727 /**
728 * @covers OutputPage::setPrintable
729 * @covers OutputPage::isPrintable
730 */
731 public function testPrintable() {
732 $op = $this->newInstance();
733
734 $this->assertFalse( $op->isPrintable() );
735
736 $op->setPrintable();
737
738 $this->assertTrue( $op->isPrintable() );
739 }
740
741 /**
742 * @covers OutputPage::disable
743 * @covers OutputPage::isDisabled
744 */
745 public function testDisable() {
746 $op = $this->newInstance();
747
748 $this->assertFalse( $op->isDisabled() );
749 $this->assertNotSame( '', $op->output( true ) );
750
751 $op->disable();
752
753 $this->assertTrue( $op->isDisabled() );
754 $this->assertSame( '', $op->output( true ) );
755 }
756
757 /**
758 * @covers OutputPage::showNewSectionLink
759 * @covers OutputPage::addParserOutputMetadata
760 * @covers OutputPage::addParserOutput
761 */
762 public function testShowNewSectionLink() {
763 $op = $this->newInstance();
764
765 $this->assertFalse( $op->showNewSectionLink() );
766
767 $pOut1 = $this->createParserOutputStub( 'getNewSection', true );
768 $op->addParserOutputMetadata( $pOut1 );
769 $this->assertTrue( $op->showNewSectionLink() );
770
771 $pOut2 = $this->createParserOutputStub( 'getNewSection', false );
772 $op->addParserOutput( $pOut2 );
773 $this->assertFalse( $op->showNewSectionLink() );
774 }
775
776 /**
777 * @covers OutputPage::forceHideNewSectionLink
778 * @covers OutputPage::addParserOutputMetadata
779 * @covers OutputPage::addParserOutput
780 */
781 public function testForceHideNewSectionLink() {
782 $op = $this->newInstance();
783
784 $this->assertFalse( $op->forceHideNewSectionLink() );
785
786 $pOut1 = $this->createParserOutputStub( 'getHideNewSection', true );
787 $op->addParserOutputMetadata( $pOut1 );
788 $this->assertTrue( $op->forceHideNewSectionLink() );
789
790 $pOut2 = $this->createParserOutputStub( 'getHideNewSection', false );
791 $op->addParserOutput( $pOut2 );
792 $this->assertFalse( $op->forceHideNewSectionLink() );
793 }
794
795 /**
796 * @covers OutputPage::setSyndicated
797 * @covers OutputPage::isSyndicated
798 */
799 public function testSetSyndicated() {
800 $op = $this->newInstance();
801 $this->assertFalse( $op->isSyndicated() );
802
803 $op->setSyndicated();
804 $this->assertTrue( $op->isSyndicated() );
805
806 $op->setSyndicated( false );
807 $this->assertFalse( $op->isSyndicated() );
808 }
809
810 /**
811 * @covers OutputPage::isSyndicated
812 * @covers OutputPage::setFeedAppendQuery
813 * @covers OutputPage::addFeedLink
814 * @covers OutputPage::getSyndicationLinks()
815 */
816 public function testFeedLinks() {
817 $op = $this->newInstance();
818 $this->assertSame( [], $op->getSyndicationLinks() );
819
820 $op->addFeedLink( 'not a supported format', 'abc' );
821 $this->assertFalse( $op->isSyndicated() );
822 $this->assertSame( [], $op->getSyndicationLinks() );
823
824 $feedTypes = $op->getConfig()->get( 'AdvertisedFeedTypes' );
825
826 $op->addFeedLink( $feedTypes[0], 'def' );
827 $this->assertTrue( $op->isSyndicated() );
828 $this->assertSame( [ $feedTypes[0] => 'def' ], $op->getSyndicationLinks() );
829
830 $op->setFeedAppendQuery( false );
831 $expected = [];
832 foreach ( $feedTypes as $type ) {
833 $expected[$type] = $op->getTitle()->getLocalURL( "feed=$type" );
834 }
835 $this->assertSame( $expected, $op->getSyndicationLinks() );
836
837 $op->setFeedAppendQuery( 'apples=oranges' );
838 foreach ( $feedTypes as $type ) {
839 $expected[$type] = $op->getTitle()->getLocalURL( "feed=$type&apples=oranges" );
840 }
841 $this->assertSame( $expected, $op->getSyndicationLinks() );
842 }
843
844 /**
845 * @covers OutputPage::setArticleFlag
846 * @covers OutputPage::isArticle
847 * @covers OutputPage::setArticleRelated
848 * @covers OutputPage::isArticleRelated
849 */
850 function testArticleFlags() {
851 $op = $this->newInstance();
852 $this->assertFalse( $op->isArticle() );
853 $this->assertTrue( $op->isArticleRelated() );
854
855 $op->setArticleRelated( false );
856 $this->assertFalse( $op->isArticle() );
857 $this->assertFalse( $op->isArticleRelated() );
858
859 $op->setArticleFlag( true );
860 $this->assertTrue( $op->isArticle() );
861 $this->assertTrue( $op->isArticleRelated() );
862
863 $op->setArticleFlag( false );
864 $this->assertFalse( $op->isArticle() );
865 $this->assertTrue( $op->isArticleRelated() );
866
867 $op->setArticleFlag( true );
868 $op->setArticleRelated( false );
869 $this->assertFalse( $op->isArticle() );
870 $this->assertFalse( $op->isArticleRelated() );
871 }
872
873 /**
874 * @covers OutputPage::addLanguageLinks
875 * @covers OutputPage::setLanguageLinks
876 * @covers OutputPage::getLanguageLinks
877 * @covers OutputPage::addParserOutputMetadata
878 * @covers OutputPage::addParserOutput
879 */
880 function testLanguageLinks() {
881 $op = $this->newInstance();
882 $this->assertSame( [], $op->getLanguageLinks() );
883
884 $op->addLanguageLinks( [ 'fr:A', 'it:B' ] );
885 $this->assertSame( [ 'fr:A', 'it:B' ], $op->getLanguageLinks() );
886
887 $op->addLanguageLinks( [ 'de:C', 'es:D' ] );
888 $this->assertSame( [ 'fr:A', 'it:B', 'de:C', 'es:D' ], $op->getLanguageLinks() );
889
890 $op->setLanguageLinks( [ 'pt:E' ] );
891 $this->assertSame( [ 'pt:E' ], $op->getLanguageLinks() );
892
893 $pOut1 = $this->createParserOutputStub( 'getLanguageLinks', [ 'he:F', 'ar:G' ] );
894 $op->addParserOutputMetadata( $pOut1 );
895 $this->assertSame( [ 'pt:E', 'he:F', 'ar:G' ], $op->getLanguageLinks() );
896
897 $pOut2 = $this->createParserOutputStub( 'getLanguageLinks', [ 'pt:H' ] );
898 $op->addParserOutput( $pOut2 );
899 $this->assertSame( [ 'pt:E', 'he:F', 'ar:G', 'pt:H' ], $op->getLanguageLinks() );
900 }
901
902 // @todo Are these category links tests too abstract and complicated for what they test? Would
903 // it make sense to just write out all the tests by hand with maybe some copy-and-paste?
904
905 /**
906 * @dataProvider provideGetCategories
907 *
908 * @covers OutputPage::addCategoryLinks
909 * @covers OutputPage::getCategories
910 * @covers OutputPage::getCategoryLinks
911 *
912 * @param array $args Array of form [ category name => sort key ]
913 * @param array $fakeResults Array of form [ category name => value to return from mocked
914 * LinkBatch ]
915 * @param callback $variantLinkCallback Callback to replace findVariantLink() call
916 * @param array $expectedNormal Expected return value of getCategoryLinks['normal']
917 * @param array $expectedHidden Expected return value of getCategoryLinks['hidden']
918 */
919 public function testAddCategoryLinks(
920 array $args, array $fakeResults, callable $variantLinkCallback = null,
921 array $expectedNormal, array $expectedHidden
922 ) {
923 $expectedNormal = $this->extractExpectedCategories( $expectedNormal, 'add' );
924 $expectedHidden = $this->extractExpectedCategories( $expectedHidden, 'add' );
925
926 $op = $this->setupCategoryTests( $fakeResults, $variantLinkCallback );
927
928 $op->addCategoryLinks( $args );
929
930 $this->doCategoryAsserts( $op, $expectedNormal, $expectedHidden );
931 $this->doCategoryLinkAsserts( $op, $expectedNormal, $expectedHidden );
932 }
933
934 /**
935 * @dataProvider provideGetCategories
936 *
937 * @covers OutputPage::addCategoryLinks
938 * @covers OutputPage::getCategories
939 * @covers OutputPage::getCategoryLinks
940 */
941 public function testAddCategoryLinksOneByOne(
942 array $args, array $fakeResults, callable $variantLinkCallback = null,
943 array $expectedNormal, array $expectedHidden
944 ) {
945 if ( count( $args ) <= 1 ) {
946 // @todo Should this be skipped instead of passed?
947 $this->assertTrue( true );
948 return;
949 }
950
951 $expectedNormal = $this->extractExpectedCategories( $expectedNormal, 'onebyone' );
952 $expectedHidden = $this->extractExpectedCategories( $expectedHidden, 'onebyone' );
953
954 $op = $this->setupCategoryTests( $fakeResults, $variantLinkCallback );
955
956 foreach ( $args as $key => $val ) {
957 $op->addCategoryLinks( [ $key => $val ] );
958 }
959
960 $this->doCategoryAsserts( $op, $expectedNormal, $expectedHidden );
961 $this->doCategoryLinkAsserts( $op, $expectedNormal, $expectedHidden );
962 }
963
964 /**
965 * @dataProvider provideGetCategories
966 *
967 * @covers OutputPage::setCategoryLinks
968 * @covers OutputPage::getCategories
969 * @covers OutputPage::getCategoryLinks
970 */
971 public function testSetCategoryLinks(
972 array $args, array $fakeResults, callable $variantLinkCallback = null,
973 array $expectedNormal, array $expectedHidden
974 ) {
975 $expectedNormal = $this->extractExpectedCategories( $expectedNormal, 'set' );
976 $expectedHidden = $this->extractExpectedCategories( $expectedHidden, 'set' );
977
978 $op = $this->setupCategoryTests( $fakeResults, $variantLinkCallback );
979
980 $op->setCategoryLinks( [ 'Initial page' => 'Initial page' ] );
981 $op->setCategoryLinks( $args );
982
983 // We don't reset the categories, for some reason, only the links
984 $expectedNormalCats = array_merge( [ 'Initial page' ], $expectedNormal );
985 $expectedCats = array_merge( $expectedHidden, $expectedNormalCats );
986
987 $this->doCategoryAsserts( $op, $expectedNormalCats, $expectedHidden );
988 $this->doCategoryLinkAsserts( $op, $expectedNormal, $expectedHidden );
989 }
990
991 /**
992 * @dataProvider provideGetCategories
993 *
994 * @covers OutputPage::addParserOutputMetadata
995 * @covers OutputPage::addParserOutput
996 * @covers OutputPage::getCategories
997 * @covers OutputPage::getCategoryLinks
998 */
999 public function testParserOutputCategoryLinks(
1000 array $args, array $fakeResults, callable $variantLinkCallback = null,
1001 array $expectedNormal, array $expectedHidden
1002 ) {
1003 $expectedNormal = $this->extractExpectedCategories( $expectedNormal, 'pout' );
1004 $expectedHidden = $this->extractExpectedCategories( $expectedHidden, 'pout' );
1005
1006 $op = $this->setupCategoryTests( $fakeResults, $variantLinkCallback );
1007
1008 $stubPO = $this->createParserOutputStub( 'getCategories', $args );
1009
1010 // addParserOutput and addParserOutputMetadata should behave identically for us, so
1011 // alternate to get coverage for both without adding extra tests
1012 static $idx = 0;
1013 $idx++;
1014 $method = [ 'addParserOutputMetadata', 'addParserOutput' ][$idx % 2];
1015 $op->$method( $stubPO );
1016
1017 $this->doCategoryAsserts( $op, $expectedNormal, $expectedHidden );
1018 $this->doCategoryLinkAsserts( $op, $expectedNormal, $expectedHidden );
1019 }
1020
1021 /**
1022 * We allow different expectations for different tests as an associative array, like
1023 * [ 'set' => [ ... ], 'default' => [ ... ] ] if setCategoryLinks() will give a different
1024 * result.
1025 */
1026 private function extractExpectedCategories( array $expected, $key ) {
1027 if ( !$expected || isset( $expected[0] ) ) {
1028 return $expected;
1029 }
1030 return $expected[$key] ?? $expected['default'];
1031 }
1032
1033 private function setupCategoryTests(
1034 array $fakeResults, callable $variantLinkCallback = null
1035 ) : OutputPage {
1036 $this->setMwGlobals( 'wgUsePigLatinVariant', true );
1037
1038 $op = $this->getMockBuilder( OutputPage::class )
1039 ->setConstructorArgs( [ new RequestContext() ] )
1040 ->setMethods( [ 'addCategoryLinksToLBAndGetResult', 'getTitle' ] )
1041 ->getMock();
1042
1043 $title = Title::newFromText( 'My test page' );
1044 $op->expects( $this->any() )
1045 ->method( 'getTitle' )
1046 ->will( $this->returnValue( $title ) );
1047
1048 $op->expects( $this->any() )
1049 ->method( 'addCategoryLinksToLBAndGetResult' )
1050 ->will( $this->returnCallback( function ( array $categories ) use ( $fakeResults ) {
1051 $return = [];
1052 foreach ( $categories as $category => $unused ) {
1053 if ( isset( $fakeResults[$category] ) ) {
1054 $return[] = $fakeResults[$category];
1055 }
1056 }
1057 return new FakeResultWrapper( $return );
1058 } ) );
1059
1060 if ( $variantLinkCallback ) {
1061 $mockContLang = $this->getMockBuilder( Language::class )
1062 ->setConstructorArgs( [ 'en' ] )
1063 ->setMethods( [ 'findVariantLink' ] )
1064 ->getMock();
1065 $mockContLang->expects( $this->any() )
1066 ->method( 'findVariantLink' )
1067 ->will( $this->returnCallback( $variantLinkCallback ) );
1068 $this->setContentLang( $mockContLang );
1069 }
1070
1071 $this->assertSame( [], $op->getCategories() );
1072
1073 return $op;
1074 }
1075
1076 private function doCategoryAsserts( $op, $expectedNormal, $expectedHidden ) {
1077 $this->assertSame( array_merge( $expectedHidden, $expectedNormal ), $op->getCategories() );
1078 $this->assertSame( $expectedNormal, $op->getCategories( 'normal' ) );
1079 $this->assertSame( $expectedHidden, $op->getCategories( 'hidden' ) );
1080 }
1081
1082 private function doCategoryLinkAsserts( $op, $expectedNormal, $expectedHidden ) {
1083 $catLinks = $op->getCategoryLinks();
1084 $this->assertSame( (bool)$expectedNormal + (bool)$expectedHidden, count( $catLinks ) );
1085 if ( $expectedNormal ) {
1086 $this->assertSame( count( $expectedNormal ), count( $catLinks['normal'] ) );
1087 }
1088 if ( $expectedHidden ) {
1089 $this->assertSame( count( $expectedHidden ), count( $catLinks['hidden'] ) );
1090 }
1091
1092 foreach ( $expectedNormal as $i => $name ) {
1093 $this->assertContains( $name, $catLinks['normal'][$i] );
1094 }
1095 foreach ( $expectedHidden as $i => $name ) {
1096 $this->assertContains( $name, $catLinks['hidden'][$i] );
1097 }
1098 }
1099
1100 public function provideGetCategories() {
1101 return [
1102 'No categories' => [ [], [], null, [], [] ],
1103 'Simple test' => [
1104 [ 'Test1' => 'Some sortkey', 'Test2' => 'A different sortkey' ],
1105 [ 'Test1' => (object)[ 'pp_value' => 1, 'page_title' => 'Test1' ],
1106 'Test2' => (object)[ 'page_title' => 'Test2' ] ],
1107 null,
1108 [ 'Test2' ],
1109 [ 'Test1' ],
1110 ],
1111 'Invalid title' => [
1112 [ '[' => '[', 'Test' => 'Test' ],
1113 [ 'Test' => (object)[ 'page_title' => 'Test' ] ],
1114 null,
1115 [ 'Test' ],
1116 [],
1117 ],
1118 'Variant link' => [
1119 [ 'Test' => 'Test', 'Estay' => 'Estay' ],
1120 [ 'Test' => (object)[ 'page_title' => 'Test' ] ],
1121 function ( &$link, &$title ) {
1122 if ( $link === 'Estay' ) {
1123 $link = 'Test';
1124 $title = Title::makeTitleSafe( NS_CATEGORY, $link );
1125 }
1126 },
1127 // For adding one by one, the variant gets added as well as the original category,
1128 // but if you add them all together the second time gets skipped.
1129 [ 'onebyone' => [ 'Test', 'Test' ], 'default' => [ 'Test' ] ],
1130 [],
1131 ],
1132 ];
1133 }
1134
1135 /**
1136 * @covers OutputPage::getCategories
1137 */
1138 public function testGetCategoriesInvalid() {
1139 $this->setExpectedException( InvalidArgumentException::class,
1140 'Invalid category type given: hiddne' );
1141
1142 $op = $this->newInstance();
1143 $op->getCategories( 'hiddne' );
1144 }
1145
1146 // @todo Should we test addCategoryLinksToLBAndGetResult? If so, how? Insert some test rows in
1147 // the DB?
1148
1149 /**
1150 * @covers OutputPage::setIndicators
1151 * @covers OutputPage::getIndicators
1152 * @covers OutputPage::addParserOutputMetadata
1153 * @covers OutputPage::addParserOutput
1154 */
1155 public function testIndicators() {
1156 $op = $this->newInstance();
1157 $this->assertSame( [], $op->getIndicators() );
1158
1159 $op->setIndicators( [] );
1160 $this->assertSame( [], $op->getIndicators() );
1161
1162 // Test sorting alphabetically
1163 $op->setIndicators( [ 'b' => 'x', 'a' => 'y' ] );
1164 $this->assertSame( [ 'a' => 'y', 'b' => 'x' ], $op->getIndicators() );
1165
1166 // Test overwriting existing keys
1167 $op->setIndicators( [ 'c' => 'z', 'a' => 'w' ] );
1168 $this->assertSame( [ 'a' => 'w', 'b' => 'x', 'c' => 'z' ], $op->getIndicators() );
1169
1170 // Test with addParserOutputMetadata
1171 $pOut1 = $this->createParserOutputStub( 'getIndicators', [ 'c' => 'u', 'd' => 'v' ] );
1172 $op->addParserOutputMetadata( $pOut1 );
1173 $this->assertSame( [ 'a' => 'w', 'b' => 'x', 'c' => 'u', 'd' => 'v' ],
1174 $op->getIndicators() );
1175
1176 // Test with addParserOutput
1177 $pOut2 = $this->createParserOutputStub( 'getIndicators', [ 'a' => '!!!' ] );
1178 $op->addParserOutput( $pOut2 );
1179 $this->assertSame( [ 'a' => '!!!', 'b' => 'x', 'c' => 'u', 'd' => 'v' ],
1180 $op->getIndicators() );
1181 }
1182
1183 /**
1184 * @covers OutputPage::addHelpLink
1185 * @covers OutputPage::getIndicators
1186 */
1187 public function testAddHelpLink() {
1188 $op = $this->newInstance();
1189
1190 $op->addHelpLink( 'Manual:PHP unit testing' );
1191 $indicators = $op->getIndicators();
1192 $this->assertSame( [ 'mw-helplink' ], array_keys( $indicators ) );
1193 $this->assertContains( 'Manual:PHP_unit_testing', $indicators['mw-helplink'] );
1194
1195 $op->addHelpLink( 'https://phpunit.de', true );
1196 $indicators = $op->getIndicators();
1197 $this->assertSame( [ 'mw-helplink' ], array_keys( $indicators ) );
1198 $this->assertContains( 'https://phpunit.de', $indicators['mw-helplink'] );
1199 $this->assertNotContains( 'mediawiki', $indicators['mw-helplink'] );
1200 $this->assertNotContains( 'Manual:PHP', $indicators['mw-helplink'] );
1201 }
1202
1203 /**
1204 * @covers OutputPage::prependHTML
1205 * @covers OutputPage::addHTML
1206 * @covers OutputPage::addElement
1207 * @covers OutputPage::clearHTML
1208 * @covers OutputPage::getHTML
1209 */
1210 public function testBodyHTML() {
1211 $op = $this->newInstance();
1212 $this->assertSame( '', $op->getHTML() );
1213
1214 $op->addHTML( 'a' );
1215 $this->assertSame( 'a', $op->getHTML() );
1216
1217 $op->addHTML( 'b' );
1218 $this->assertSame( 'ab', $op->getHTML() );
1219
1220 $op->prependHTML( 'c' );
1221 $this->assertSame( 'cab', $op->getHTML() );
1222
1223 $op->addElement( 'p', [ 'id' => 'foo' ], 'd' );
1224 $this->assertSame( 'cab<p id="foo">d</p>', $op->getHTML() );
1225
1226 $op->clearHTML();
1227 $this->assertSame( '', $op->getHTML() );
1228 }
1229
1230 /**
1231 * @dataProvider provideRevisionId
1232 * @covers OutputPage::setRevisionId
1233 * @covers OutputPage::getRevisionId
1234 */
1235 public function testRevisionId( $newVal, $expected ) {
1236 $op = $this->newInstance();
1237
1238 $this->assertNull( $op->setRevisionId( $newVal ) );
1239 $this->assertSame( $expected, $op->getRevisionId() );
1240 $this->assertSame( $expected, $op->setRevisionId( null ) );
1241 $this->assertNull( $op->getRevisionId() );
1242 }
1243
1244 public function provideRevisionId() {
1245 return [
1246 [ null, null ],
1247 [ 7, 7 ],
1248 [ -1, -1 ],
1249 [ 3.2, 3 ],
1250 [ '0', 0 ],
1251 [ '32% finished', 32 ],
1252 [ false, 0 ],
1253 ];
1254 }
1255
1256 /**
1257 * @covers OutputPage::setRevisionTimestamp
1258 * @covers OutputPage::getRevisionTimestamp
1259 */
1260 public function testRevisionTimestamp() {
1261 $op = $this->newInstance();
1262 $this->assertNull( $op->getRevisionTimestamp() );
1263
1264 $this->assertNull( $op->setRevisionTimestamp( 'abc' ) );
1265 $this->assertSame( 'abc', $op->getRevisionTimestamp() );
1266 $this->assertSame( 'abc', $op->setRevisionTimestamp( null ) );
1267 $this->assertNull( $op->getRevisionTimestamp() );
1268 }
1269
1270 /**
1271 * @covers OutputPage::setFileVersion
1272 * @covers OutputPage::getFileVersion
1273 */
1274 public function testFileVersion() {
1275 $op = $this->newInstance();
1276 $this->assertNull( $op->getFileVersion() );
1277
1278 $stubFile = $this->createMock( File::class );
1279 $stubFile->method( 'exists' )->willReturn( true );
1280 $stubFile->method( 'getTimestamp' )->willReturn( '12211221123321' );
1281 $stubFile->method( 'getSha1' )->willReturn( 'bf3ffa7047dc080f5855377a4f83cd18887e3b05' );
1282
1283 $op->setFileVersion( $stubFile );
1284
1285 $this->assertEquals(
1286 [ 'time' => '12211221123321', 'sha1' => 'bf3ffa7047dc080f5855377a4f83cd18887e3b05' ],
1287 $op->getFileVersion()
1288 );
1289
1290 $stubMissingFile = $this->createMock( File::class );
1291 $stubMissingFile->method( 'exists' )->willReturn( false );
1292
1293 $op->setFileVersion( $stubMissingFile );
1294 $this->assertNull( $op->getFileVersion() );
1295
1296 $op->setFileVersion( $stubFile );
1297 $this->assertNotNull( $op->getFileVersion() );
1298
1299 $op->setFileVersion( null );
1300 $this->assertNull( $op->getFileVersion() );
1301 }
1302
1303 /**
1304 * Call either with arguments $methodName, $returnValue; or an array
1305 * [ $methodName => $returnValue, $methodName => $returnValue, ... ]
1306 */
1307 private function createParserOutputStub( ...$args ) {
1308 if ( count( $args ) === 0 ) {
1309 $retVals = [];
1310 } elseif ( count( $args ) === 1 ) {
1311 $retVals = $args[0];
1312 } elseif ( count( $args ) === 2 ) {
1313 $retVals = [ $args[0] => $args[1] ];
1314 }
1315 $pOut = $this->getMock( ParserOutput::class );
1316 foreach ( $retVals as $method => $retVal ) {
1317 $pOut->method( $method )->willReturn( $retVal );
1318 }
1319
1320 $arrayReturningMethods = [
1321 'getCategories',
1322 'getFileSearchOptions',
1323 'getHeadItems',
1324 'getIndicators',
1325 'getLanguageLinks',
1326 'getOutputHooks',
1327 'getTemplateIds',
1328 ];
1329
1330 foreach ( $arrayReturningMethods as $method ) {
1331 $pOut->method( $method )->willReturn( [] );
1332 }
1333
1334 return $pOut;
1335 }
1336
1337 /**
1338 * @covers OutputPage::getTemplateIds
1339 * @covers OutputPage::addParserOutputMetadata
1340 * @covers OutputPage::addParserOutput
1341 */
1342 public function testTemplateIds() {
1343 $op = $this->newInstance();
1344 $this->assertSame( [], $op->getTemplateIds() );
1345
1346 // Test with no template id's
1347 $stubPOEmpty = $this->createParserOutputStub();
1348 $op->addParserOutputMetadata( $stubPOEmpty );
1349 $this->assertSame( [], $op->getTemplateIds() );
1350
1351 // Test with some arbitrary template id's
1352 $ids = [
1353 NS_MAIN => [ 'A' => 3, 'B' => 17 ],
1354 NS_TALK => [ 'C' => 31 ],
1355 NS_MEDIA => [ 'D' => -1 ],
1356 ];
1357
1358 $stubPO1 = $this->createParserOutputStub( 'getTemplateIds', $ids );
1359
1360 $op->addParserOutputMetadata( $stubPO1 );
1361 $this->assertSame( $ids, $op->getTemplateIds() );
1362
1363 // Test merging with a second set of id's
1364 $stubPO2 = $this->createParserOutputStub( 'getTemplateIds', [
1365 NS_MAIN => [ 'E' => 1234 ],
1366 NS_PROJECT => [ 'F' => 5678 ],
1367 ] );
1368
1369 $finalIds = [
1370 NS_MAIN => [ 'E' => 1234, 'A' => 3, 'B' => 17 ],
1371 NS_TALK => [ 'C' => 31 ],
1372 NS_MEDIA => [ 'D' => -1 ],
1373 NS_PROJECT => [ 'F' => 5678 ],
1374 ];
1375
1376 $op->addParserOutput( $stubPO2 );
1377 $this->assertSame( $finalIds, $op->getTemplateIds() );
1378
1379 // Test merging with an empty set of id's
1380 $op->addParserOutputMetadata( $stubPOEmpty );
1381 $this->assertSame( $finalIds, $op->getTemplateIds() );
1382 }
1383
1384 /**
1385 * @covers OutputPage::getFileSearchOptions
1386 * @covers OutputPage::addParserOutputMetadata
1387 * @covers OutputPage::addParserOutput
1388 */
1389 public function testFileSearchOptions() {
1390 $op = $this->newInstance();
1391 $this->assertSame( [], $op->getFileSearchOptions() );
1392
1393 // Test with no files
1394 $stubPOEmpty = $this->createParserOutputStub();
1395
1396 $op->addParserOutputMetadata( $stubPOEmpty );
1397 $this->assertSame( [], $op->getFileSearchOptions() );
1398
1399 // Test with some arbitrary files
1400 $files1 = [
1401 'A' => [ 'time' => null, 'sha1' => '' ],
1402 'B' => [
1403 'time' => '12211221123321',
1404 'sha1' => 'bf3ffa7047dc080f5855377a4f83cd18887e3b05',
1405 ],
1406 ];
1407
1408 $stubPO1 = $this->createParserOutputStub( 'getFileSearchOptions', $files1 );
1409
1410 $op->addParserOutput( $stubPO1 );
1411 $this->assertSame( $files1, $op->getFileSearchOptions() );
1412
1413 // Test merging with a second set of files
1414 $files2 = [
1415 'C' => [ 'time' => null, 'sha1' => '' ],
1416 'B' => [ 'time' => null, 'sha1' => '' ],
1417 ];
1418
1419 $stubPO2 = $this->createParserOutputStub( 'getFileSearchOptions', $files2 );
1420
1421 $op->addParserOutputMetadata( $stubPO2 );
1422 $this->assertSame( array_merge( $files1, $files2 ), $op->getFileSearchOptions() );
1423
1424 // Test merging with an empty set of files
1425 $op->addParserOutput( $stubPOEmpty );
1426 $this->assertSame( array_merge( $files1, $files2 ), $op->getFileSearchOptions() );
1427 }
1428
1429 /**
1430 * @dataProvider provideAddWikiText
1431 * @covers OutputPage::addWikiText
1432 * @covers OutputPage::addWikiTextAsInterface
1433 * @covers OutputPage::addWikiTextAsContent
1434 * @covers OutputPage::addWikiTextWithTitle
1435 * @covers OutputPage::addWikiTextTitle
1436 * @covers OutputPage::addWikiTextTidy
1437 * @covers OutputPage::addWikiTextTitleTidy
1438 * @covers OutputPage::getHTML
1439 */
1440 public function testAddWikiText( $method, array $args, $expected ) {
1441 $op = $this->newInstance();
1442 $this->assertSame( '', $op->getHTML() );
1443
1444 $this->hideDeprecated( 'OutputPage::addWikiTextTitle' );
1445 $this->hideDeprecated( 'OutputPage::addWikiTextWithTitle' );
1446 $this->hideDeprecated( 'OutputPage::addWikiTextTidy' );
1447 $this->hideDeprecated( 'OutputPage::addWikiTextTitleTidy' );
1448 if ( in_array(
1449 $method,
1450 [ 'addWikiTextWithTitle', 'addWikiTextTitleTidy', 'addWikiTextTitle' ]
1451 ) && count( $args ) >= 2 && $args[1] === null ) {
1452 // Special placeholder because we can't get the actual title in the provider
1453 $args[1] = $op->getTitle();
1454 }
1455 if ( in_array(
1456 $method,
1457 [ 'addWikiTextAsInterface', 'addWikiTextAsContent' ]
1458 ) && count( $args ) >= 3 && $args[2] === null ) {
1459 // Special placeholder because we can't get the actual title in the provider
1460 $args[2] = $op->getTitle();
1461 }
1462
1463 $op->$method( ...$args );
1464 $this->assertSame( $expected, $op->getHTML() );
1465 }
1466
1467 public function provideAddWikiText() {
1468 $tests = [
1469 'addWikiText' => [
1470 // Not tidied; this API is deprecated.
1471 'Simple wikitext' => [
1472 [ "'''Bold'''" ],
1473 "<p><b>Bold</b>\n</p>",
1474 ], 'List at start' => [
1475 [ '* List' ],
1476 "<ul><li>List</li></ul>\n",
1477 ], 'List not at start' => [
1478 [ '* Not a list', false ],
1479 '* Not a list',
1480 ], 'Non-interface' => [
1481 [ "'''Bold'''", true, false ],
1482 "<p><b>Bold</b>\n</p>",
1483 ], 'No section edit links' => [
1484 [ '== Title ==' ],
1485 "<h2><span class=\"mw-headline\" id=\"Title\">Title</span></h2>\n",
1486 ],
1487 ],
1488 'addWikiTextWithTitle' => [
1489 // Untidied; this API is deprecated
1490 'With title at start' => [
1491 [ '* {{PAGENAME}}', Title::newFromText( 'Talk:Some page' ) ],
1492 "<ul><li>Some page</li></ul>\n",
1493 ], 'With title at start' => [
1494 [ '* {{PAGENAME}}', Title::newFromText( 'Talk:Some page' ), false ],
1495 "* Some page",
1496 ],
1497 ],
1498 'addWikiTextAsInterface' => [
1499 // Preferred interface: output is tidied
1500 'Simple wikitext' => [
1501 [ "'''Bold'''" ],
1502 "<p><b>Bold</b>\n</p>",
1503 ], 'Untidy wikitext' => [
1504 [ "<b>Bold" ],
1505 "<p><b>Bold\n</b></p>",
1506 ], 'List at start' => [
1507 [ '* List' ],
1508 "<ul><li>List</li></ul>\n",
1509 ], 'List not at start' => [
1510 [ '* Not a list', false ],
1511 '<p>* Not a list</p>',
1512 ], 'No section edit links' => [
1513 [ '== Title ==' ],
1514 "<h2><span class=\"mw-headline\" id=\"Title\">Title</span></h2>\n",
1515 ], 'With title at start' => [
1516 [ '* {{PAGENAME}}', true, Title::newFromText( 'Talk:Some page' ) ],
1517 "<ul><li>Some page</li></ul>\n",
1518 ], 'With title at start' => [
1519 [ '* {{PAGENAME}}', false, Title::newFromText( 'Talk:Some page' ), false ],
1520 "<p>* Some page</p>",
1521 ], 'Untidy input' => [
1522 [ '<b>{{PAGENAME}}', true, Title::newFromText( 'Talk:Some page' ) ],
1523 "<p><b>Some page\n</b></p>",
1524 ],
1525 ],
1526 'addWikiTextAsContent' => [
1527 // Preferred interface: output is tidied
1528 'SpecialNewimages' => [
1529 [ "<p lang='en' dir='ltr'>\nMy message" ],
1530 '<p lang="en" dir="ltr">' . "\nMy message\n</p>"
1531 ], 'List at start' => [
1532 [ '* List' ],
1533 "<ul><li>List</li></ul>\n",
1534 ], 'List not at start' => [
1535 [ '* <b>Not a list', false ],
1536 '<p>* <b>Not a list</b></p>',
1537 ], 'With title at start' => [
1538 [ '* {{PAGENAME}}', true, Title::newFromText( 'Talk:Some page' ) ],
1539 "<ul><li>Some page</li></ul>\n",
1540 ], 'With title at start' => [
1541 [ '* {{PAGENAME}}', false, Title::newFromText( 'Talk:Some page' ), false ],
1542 "<p>* Some page</p>",
1543 ], 'EditPage' => [
1544 [ "<div class='mw-editintro'>{{PAGENAME}}", true, Title::newFromText( 'Talk:Some page' ) ],
1545 '<div class="mw-editintro">' . "Some page\n</div>"
1546 ],
1547 ],
1548 ];
1549
1550 // Test all the others on addWikiTextTitle as well
1551 foreach ( $tests['addWikiText'] as $key => $val ) {
1552 $args = [ $val[0][0], null, $val[0][1] ?? true, false, $val[0][2] ?? true ];
1553 $tests['addWikiTextTitle']["$key (addWikiTextTitle)"] =
1554 array_merge( [ $args ], array_slice( $val, 1 ) );
1555 }
1556 foreach ( $tests['addWikiTextWithTitle'] as $key => $val ) {
1557 $args = [ $val[0][0], $val[0][1], $val[0][2] ?? true ];
1558 $tests['addWikiTextTitle']["$key (addWikiTextTitle)"] =
1559 array_merge( [ $args ], array_slice( $val, 1 ) );
1560 }
1561 foreach ( $tests['addWikiTextAsInterface'] as $key => $val ) {
1562 $args = [ $val[0][0], $val[0][2] ?? null, $val[0][1] ?? true, true, true ];
1563 $tests['addWikiTextTitle']["$key (addWikiTextTitle)"] =
1564 array_merge( [ $args ], array_slice( $val, 1 ) );
1565 }
1566 foreach ( $tests['addWikiTextAsContent'] as $key => $val ) {
1567 $args = [ $val[0][0], $val[0][2] ?? null, $val[0][1] ?? true, true, false ];
1568 $tests['addWikiTextTitle']["$key (addWikiTextTitle)"] =
1569 array_merge( [ $args ], array_slice( $val, 1 ) );
1570 }
1571 // addWikiTextTidy / addWikiTextTitleTidy were old aliases of
1572 // addWikiTextAsContent
1573 foreach ( $tests['addWikiTextAsContent'] as $key => $val ) {
1574 if ( count( $val[0] ) > 2 ) {
1575 $args = [ $val[0][0], $val[0][2], $val[0][1] ?? true ];
1576 $tests['addWikiTextTitleTidy']["$key (addWikiTextTitleTidy)"] =
1577 array_merge( [ $args ], array_slice( $val, 1 ) );
1578 } else {
1579 $args = [ $val[0][0], $val[0][1] ?? true ];
1580 $tests['addWikiTextTidy']["$key (addWikiTextTidy)"] =
1581 array_merge( [ $args ], array_slice( $val, 1 ) );
1582 }
1583 }
1584
1585 // We have to reformat our array to match what PHPUnit wants
1586 $ret = [];
1587 foreach ( $tests as $key => $subarray ) {
1588 foreach ( $subarray as $subkey => $val ) {
1589 $val = array_merge( [ $key ], $val );
1590 $ret[$subkey] = $val;
1591 }
1592 }
1593
1594 return $ret;
1595 }
1596
1597 /**
1598 * @covers OutputPage::addWikiText
1599 */
1600 public function testAddWikiTextNoTitle() {
1601 $this->setExpectedException( MWException::class, 'Title is null' );
1602
1603 $op = $this->newInstance( [], null, 'notitle' );
1604 $op->addWikiText( 'a' );
1605 }
1606
1607 /**
1608 * @covers OutputPage::addWikiTextAsInterface
1609 */
1610 public function testAddWikiTextAsInterfaceNoTitle() {
1611 $this->setExpectedException( MWException::class, 'Title is null' );
1612
1613 $op = $this->newInstance( [], null, 'notitle' );
1614 $op->addWikiTextAsInterface( 'a' );
1615 }
1616
1617 /**
1618 * @covers OutputPage::addWikiTextAsContent
1619 */
1620 public function testAddWikiTextAsContentNoTitle() {
1621 $this->setExpectedException( MWException::class, 'Title is null' );
1622
1623 $op = $this->newInstance( [], null, 'notitle' );
1624 $op->addWikiTextAsContent( 'a' );
1625 }
1626
1627 /**
1628 * @covers OutputPage::addWikiMsg
1629 */
1630 public function testAddWikiMsg() {
1631 $msg = wfMessage( 'parentheses' );
1632 $this->assertSame( '(a)', $msg->rawParams( 'a' )->plain() );
1633
1634 $op = $this->newInstance();
1635 $this->assertSame( '', $op->getHTML() );
1636 $op->addWikiMsg( 'parentheses', "<b>a" );
1637 // The input is bad unbalanced HTML, but the output is tidied
1638 $this->assertSame( "<p>(<b>a)\n</b></p>", $op->getHTML() );
1639 }
1640
1641 /**
1642 * @covers OutputPage::wrapWikiMsg
1643 */
1644 public function testWrapWikiMsg() {
1645 $msg = wfMessage( 'parentheses' );
1646 $this->assertSame( '(a)', $msg->rawParams( 'a' )->plain() );
1647
1648 $op = $this->newInstance();
1649 $this->assertSame( '', $op->getHTML() );
1650 $op->wrapWikiMsg( '[$1]', [ 'parentheses', "<b>a" ] );
1651 // This is known to be bad unbalanced HTML; this will be fixed
1652 // by I743f4185a03403f8d9b9db010ff1ee4e9342e062 (T198214)
1653 $this->assertSame( "<p>[(<b>a)]\n</p>", $op->getHTML() );
1654 }
1655
1656 /**
1657 * @covers OutputPage::addParserOutputMetadata
1658 * @covers OutputPage::addParserOutput
1659 */
1660 public function testNoGallery() {
1661 $op = $this->newInstance();
1662 $this->assertFalse( $op->mNoGallery );
1663
1664 $stubPO1 = $this->createParserOutputStub( 'getNoGallery', true );
1665 $op->addParserOutputMetadata( $stubPO1 );
1666 $this->assertTrue( $op->mNoGallery );
1667
1668 $stubPO2 = $this->createParserOutputStub( 'getNoGallery', false );
1669 $op->addParserOutput( $stubPO2 );
1670 $this->assertFalse( $op->mNoGallery );
1671 }
1672
1673 private static $parserOutputHookCalled;
1674
1675 /**
1676 * @covers OutputPage::addParserOutputMetadata
1677 */
1678 public function testParserOutputHooks() {
1679 $op = $this->newInstance();
1680 $pOut = $this->createParserOutputStub( 'getOutputHooks', [
1681 [ 'myhook', 'banana' ],
1682 [ 'yourhook', 'kumquat' ],
1683 [ 'theirhook', 'hippopotamus' ],
1684 ] );
1685
1686 self::$parserOutputHookCalled = [];
1687
1688 $this->setMwGlobals( 'wgParserOutputHooks', [
1689 'myhook' => function ( OutputPage $innerOp, ParserOutput $innerPOut, $data )
1690 use ( $op, $pOut ) {
1691 $this->assertSame( $op, $innerOp );
1692 $this->assertSame( $pOut, $innerPOut );
1693 $this->assertSame( 'banana', $data );
1694 self::$parserOutputHookCalled[] = 'closure';
1695 },
1696 'yourhook' => [ $this, 'parserOutputHookCallback' ],
1697 'theirhook' => [ __CLASS__, 'parserOutputHookCallbackStatic' ],
1698 'uncalled' => function () {
1699 $this->assertTrue( false );
1700 },
1701 ] );
1702
1703 $op->addParserOutputMetadata( $pOut );
1704
1705 $this->assertSame( [ 'closure', 'callback', 'static' ], self::$parserOutputHookCalled );
1706 }
1707
1708 public function parserOutputHookCallback(
1709 OutputPage $op, ParserOutput $pOut, $data
1710 ) {
1711 $this->assertSame( 'kumquat', $data );
1712
1713 self::$parserOutputHookCalled[] = 'callback';
1714 }
1715
1716 public static function parserOutputHookCallbackStatic(
1717 OutputPage $op, ParserOutput $pOut, $data
1718 ) {
1719 // All the assert methods are actually static, who knew!
1720 self::assertSame( 'hippopotamus', $data );
1721
1722 self::$parserOutputHookCalled[] = 'static';
1723 }
1724
1725 // @todo Make sure to test the following in addParserOutputMetadata() as well when we add tests
1726 // for them:
1727 // * addModules()
1728 // * addModuleScripts()
1729 // * addModuleStyles()
1730 // * addJsConfigVars()
1731 // * enableOOUI()
1732 // Otherwise those lines of addParserOutputMetadata() will be reported as covered, but we won't
1733 // be testing they actually work.
1734
1735 /**
1736 * @covers OutputPage::addParserOutputText
1737 */
1738 public function testAddParserOutputText() {
1739 $op = $this->newInstance();
1740 $this->assertSame( '', $op->getHTML() );
1741
1742 $pOut = $this->createParserOutputStub( 'getText', '<some text>' );
1743
1744 $op->addParserOutputMetadata( $pOut );
1745 $this->assertSame( '', $op->getHTML() );
1746
1747 $op->addParserOutputText( $pOut );
1748 $this->assertSame( '<some text>', $op->getHTML() );
1749 }
1750
1751 /**
1752 * @covers OutputPage::addParserOutput
1753 */
1754 public function testAddParserOutput() {
1755 $op = $this->newInstance();
1756 $this->assertSame( '', $op->getHTML() );
1757 $this->assertFalse( $op->showNewSectionLink() );
1758
1759 $pOut = $this->createParserOutputStub( [
1760 'getText' => '<some text>',
1761 'getNewSection' => true,
1762 ] );
1763
1764 $op->addParserOutput( $pOut );
1765 $this->assertSame( '<some text>', $op->getHTML() );
1766 $this->assertTrue( $op->showNewSectionLink() );
1767 }
1768
1769 /**
1770 * @covers OutputPage::addTemplate
1771 */
1772 public function testAddTemplate() {
1773 $template = $this->getMock( QuickTemplate::class );
1774 $template->method( 'getHTML' )->willReturn( '<abc>&def;' );
1775
1776 $op = $this->newInstance();
1777 $op->addTemplate( $template );
1778
1779 $this->assertSame( '<abc>&def;', $op->getHTML() );
1780 }
1781
1782 /**
1783 * @dataProvider provideParse
1784 * @covers OutputPage::parse
1785 * @param array $args To pass to parse()
1786 * @param string $expectedHTML Expected return value for parse()
1787 * @param string $expectedHTML Expected return value for parseInline(), if different
1788 */
1789 public function testParse( array $args, $expectedHTML ) {
1790 $op = $this->newInstance();
1791 $this->assertSame( $expectedHTML, $op->parse( ...$args ) );
1792 }
1793
1794 /**
1795 * @dataProvider provideParse
1796 * @covers OutputPage::parseInline
1797 */
1798 public function testParseInline( array $args, $expectedHTML, $expectedHTMLInline = null ) {
1799 if ( count( $args ) > 3 ) {
1800 // $language param not supported
1801 $this->assertTrue( true );
1802 return;
1803 }
1804 $op = $this->newInstance();
1805 $this->assertSame( $expectedHTMLInline ?? $expectedHTML, $op->parseInline( ...$args ) );
1806 }
1807
1808 public function provideParse() {
1809 return [
1810 'List at start of line' => [
1811 [ '* List' ],
1812 "<div class=\"mw-parser-output\"><ul><li>List</li></ul>\n</div>",
1813 ],
1814 'List not at start' => [
1815 [ "* ''Not'' list", false ],
1816 '<div class="mw-parser-output">* <i>Not</i> list</div>',
1817 ],
1818 'Interface' => [
1819 [ "''Italic''", true, true ],
1820 "<p><i>Italic</i>\n</p>",
1821 '<i>Italic</i>',
1822 ],
1823 'formatnum' => [
1824 [ '{{formatnum:123456.789}}' ],
1825 "<div class=\"mw-parser-output\"><p>123,456.789\n</p></div>",
1826 ],
1827 'Language' => [
1828 [ '{{formatnum:123456.789}}', true, false, Language::factory( 'is' ) ],
1829 "<div class=\"mw-parser-output\"><p>123.456,789\n</p></div>",
1830 ],
1831 'Language with interface' => [
1832 [ '{{formatnum:123456.789}}', true, true, Language::factory( 'is' ) ],
1833 "<p>123.456,789\n</p>",
1834 '123.456,789',
1835 ],
1836 'No section edit links' => [
1837 [ '== Header ==' ],
1838 '<div class="mw-parser-output"><h2><span class="mw-headline" id="Header">' .
1839 "Header</span></h2>\n</div>",
1840 ]
1841 ];
1842 }
1843
1844 /**
1845 * @covers OutputPage::parse
1846 */
1847 public function testParseNullTitle() {
1848 $this->setExpectedException( MWException::class, 'Empty $mTitle in OutputPage::parse' );
1849 $op = $this->newInstance( [], null, 'notitle' );
1850 $op->parse( '' );
1851 }
1852
1853 /**
1854 * @covers OutputPage::parse
1855 */
1856 public function testParseInlineNullTitle() {
1857 $this->setExpectedException( MWException::class, 'Empty $mTitle in OutputPage::parse' );
1858 $op = $this->newInstance( [], null, 'notitle' );
1859 $op->parseInline( '' );
1860 }
1861
1862 /**
1863 * @covers OutputPage::setCdnMaxage
1864 * @covers OutputPage::lowerCdnMaxage
1865 */
1866 public function testCdnMaxage() {
1867 $op = $this->newInstance();
1868 $wrapper = TestingAccessWrapper::newFromObject( $op );
1869 $this->assertSame( 0, $wrapper->mCdnMaxage );
1870
1871 $op->setCdnMaxage( -1 );
1872 $this->assertSame( -1, $wrapper->mCdnMaxage );
1873
1874 $op->setCdnMaxage( 120 );
1875 $this->assertSame( 120, $wrapper->mCdnMaxage );
1876
1877 $op->setCdnMaxage( 60 );
1878 $this->assertSame( 60, $wrapper->mCdnMaxage );
1879
1880 $op->setCdnMaxage( 180 );
1881 $this->assertSame( 180, $wrapper->mCdnMaxage );
1882
1883 $op->lowerCdnMaxage( 240 );
1884 $this->assertSame( 180, $wrapper->mCdnMaxage );
1885
1886 $op->setCdnMaxage( 300 );
1887 $this->assertSame( 240, $wrapper->mCdnMaxage );
1888
1889 $op->lowerCdnMaxage( 120 );
1890 $this->assertSame( 120, $wrapper->mCdnMaxage );
1891
1892 $op->setCdnMaxage( 180 );
1893 $this->assertSame( 120, $wrapper->mCdnMaxage );
1894
1895 $op->setCdnMaxage( 60 );
1896 $this->assertSame( 60, $wrapper->mCdnMaxage );
1897
1898 $op->setCdnMaxage( 240 );
1899 $this->assertSame( 120, $wrapper->mCdnMaxage );
1900 }
1901
1902 /** @var int Faked time to set for tests that need it */
1903 private static $fakeTime;
1904
1905 /**
1906 * @dataProvider provideAdaptCdnTTL
1907 * @covers OutputPage::adaptCdnTTL
1908 * @param array $args To pass to adaptCdnTTL()
1909 * @param int $expected Expected new value of mCdnMaxageLimit
1910 * @param array $options Associative array:
1911 * initialMaxage => Maxage to set before calling adaptCdnTTL() (default 86400)
1912 */
1913 public function testAdaptCdnTTL( array $args, $expected, array $options = [] ) {
1914 try {
1915 MWTimestamp::setFakeTime( self::$fakeTime );
1916
1917 $op = $this->newInstance();
1918 // Set a high maxage so that it will get reduced by adaptCdnTTL(). The default maxage
1919 // is 0, so adaptCdnTTL() won't mutate the object at all.
1920 $initial = $options['initialMaxage'] ?? 86400;
1921 $op->setCdnMaxage( $initial );
1922
1923 $op->adaptCdnTTL( ...$args );
1924 } finally {
1925 MWTimestamp::setFakeTime( false );
1926 }
1927
1928 $wrapper = TestingAccessWrapper::newFromObject( $op );
1929
1930 // Special rules for false/null
1931 if ( $args[0] === null || $args[0] === false ) {
1932 $this->assertSame( $initial, $wrapper->mCdnMaxage, 'member value' );
1933 $op->setCdnMaxage( $expected + 1 );
1934 $this->assertSame( $expected + 1, $wrapper->mCdnMaxage, 'member value after new set' );
1935 return;
1936 }
1937
1938 $this->assertSame( $expected, $wrapper->mCdnMaxageLimit, 'limit value' );
1939
1940 if ( $initial >= $expected ) {
1941 $this->assertSame( $expected, $wrapper->mCdnMaxage, 'member value' );
1942 } else {
1943 $this->assertSame( $initial, $wrapper->mCdnMaxage, 'member value' );
1944 }
1945
1946 $op->setCdnMaxage( $expected + 1 );
1947 $this->assertSame( $expected, $wrapper->mCdnMaxage, 'member value after new set' );
1948 }
1949
1950 public function provideAdaptCdnTTL() {
1951 global $wgSquidMaxage;
1952 $now = time();
1953 self::$fakeTime = $now;
1954 return [
1955 'Five minutes ago' => [ [ $now - 300 ], 270 ],
1956 'Now' => [ [ +0 ], IExpiringStore::TTL_MINUTE ],
1957 'Five minutes from now' => [ [ $now + 300 ], IExpiringStore::TTL_MINUTE ],
1958 'Five minutes ago, initial maxage four minutes' =>
1959 [ [ $now - 300 ], 270, [ 'initialMaxage' => 240 ] ],
1960 'A very long time ago' => [ [ $now - 1000000000 ], $wgSquidMaxage ],
1961 'Initial maxage zero' => [ [ $now - 300 ], 270, [ 'initialMaxage' => 0 ] ],
1962
1963 'false' => [ [ false ], IExpiringStore::TTL_MINUTE ],
1964 'null' => [ [ null ], IExpiringStore::TTL_MINUTE ],
1965 "'0'" => [ [ '0' ], IExpiringStore::TTL_MINUTE ],
1966 'Empty string' => [ [ '' ], IExpiringStore::TTL_MINUTE ],
1967 // @todo These give incorrect results due to timezones, how to test?
1968 //"'now'" => [ [ 'now' ], IExpiringStore::TTL_MINUTE ],
1969 //"'parse error'" => [ [ 'parse error' ], IExpiringStore::TTL_MINUTE ],
1970
1971 'Now, minTTL 0' => [ [ $now, 0 ], IExpiringStore::TTL_MINUTE ],
1972 'Now, minTTL 0.000001' => [ [ $now, 0.000001 ], 0 ],
1973 'A very long time ago, maxTTL even longer' =>
1974 [ [ $now - 1000000000, 0, 1000000001 ], 900000000 ],
1975 ];
1976 }
1977
1978 /**
1979 * @covers OutputPage::enableClientCache
1980 * @covers OutputPage::addParserOutputMetadata
1981 * @covers OutputPage::addParserOutput
1982 */
1983 public function testClientCache() {
1984 $op = $this->newInstance();
1985
1986 // Test initial value
1987 $this->assertSame( true, $op->enableClientCache( null ) );
1988 // Test that calling with null doesn't change the value
1989 $this->assertSame( true, $op->enableClientCache( null ) );
1990
1991 // Test setting to false
1992 $this->assertSame( true, $op->enableClientCache( false ) );
1993 $this->assertSame( false, $op->enableClientCache( null ) );
1994 // Test that calling with null doesn't change the value
1995 $this->assertSame( false, $op->enableClientCache( null ) );
1996
1997 // Test that a cacheable ParserOutput doesn't set to true
1998 $pOutCacheable = $this->createParserOutputStub( 'isCacheable', true );
1999 $op->addParserOutputMetadata( $pOutCacheable );
2000 $this->assertSame( false, $op->enableClientCache( null ) );
2001
2002 // Test setting back to true
2003 $this->assertSame( false, $op->enableClientCache( true ) );
2004 $this->assertSame( true, $op->enableClientCache( null ) );
2005
2006 // Test that an uncacheable ParserOutput does set to false
2007 $pOutUncacheable = $this->createParserOutputStub( 'isCacheable', false );
2008 $op->addParserOutput( $pOutUncacheable );
2009 $this->assertSame( false, $op->enableClientCache( null ) );
2010 }
2011
2012 /**
2013 * @covers OutputPage::getCacheVaryCookies
2014 */
2015 public function testGetCacheVaryCookies() {
2016 global $wgCookiePrefix, $wgDBname;
2017 $op = $this->newInstance();
2018 $prefix = $wgCookiePrefix !== false ? $wgCookiePrefix : $wgDBname;
2019 $expectedCookies = [
2020 "{$prefix}Token",
2021 "{$prefix}LoggedOut",
2022 "{$prefix}_session",
2023 'forceHTTPS',
2024 'cookie1',
2025 'cookie2',
2026 ];
2027
2028 // We have to reset the cookies because getCacheVaryCookies may have already been called
2029 TestingAccessWrapper::newFromClass( OutputPage::class )->cacheVaryCookies = null;
2030
2031 $this->setMwGlobals( 'wgCacheVaryCookies', [ 'cookie1' ] );
2032 $this->setTemporaryHook( 'GetCacheVaryCookies',
2033 function ( $innerOP, &$cookies ) use ( $op, $expectedCookies ) {
2034 $this->assertSame( $op, $innerOP );
2035 $cookies[] = 'cookie2';
2036 $this->assertSame( $expectedCookies, $cookies );
2037 }
2038 );
2039
2040 $this->assertSame( $expectedCookies, $op->getCacheVaryCookies() );
2041 }
2042
2043 /**
2044 * @covers OutputPage::haveCacheVaryCookies
2045 */
2046 public function testHaveCacheVaryCookies() {
2047 $request = new FauxRequest();
2048 $op = $this->newInstance( [], $request );
2049
2050 // No cookies are set.
2051 $this->assertFalse( $op->haveCacheVaryCookies() );
2052
2053 // 'Token' is present but empty, so it shouldn't count.
2054 $request->setCookie( 'Token', '' );
2055 $this->assertFalse( $op->haveCacheVaryCookies() );
2056
2057 // 'Token' present and nonempty.
2058 $request->setCookie( 'Token', '123' );
2059 $this->assertTrue( $op->haveCacheVaryCookies() );
2060 }
2061
2062 /**
2063 * @dataProvider provideVaryHeaders
2064 *
2065 * @covers OutputPage::addVaryHeader
2066 * @covers OutputPage::getVaryHeader
2067 * @covers OutputPage::getKeyHeader
2068 *
2069 * @param array[] $calls For each array, call addVaryHeader() with those arguments
2070 * @param string[] $cookies Array of cookie names to vary on
2071 * @param string $vary Text of expected Vary header (including the 'Vary: ')
2072 * @param string $key Text of expected Key header (including the 'Key: ')
2073 */
2074 public function testVaryHeaders( array $calls, array $cookies, $vary, $key ) {
2075 // Get rid of default Vary fields
2076 $op = $this->getMockBuilder( OutputPage::class )
2077 ->setConstructorArgs( [ new RequestContext() ] )
2078 ->setMethods( [ 'getCacheVaryCookies' ] )
2079 ->getMock();
2080 $op->expects( $this->any() )
2081 ->method( 'getCacheVaryCookies' )
2082 ->will( $this->returnValue( $cookies ) );
2083 TestingAccessWrapper::newFromObject( $op )->mVaryHeader = [];
2084
2085 $this->hideDeprecated( '$wgUseKeyHeader' );
2086 foreach ( $calls as $call ) {
2087 $op->addVaryHeader( ...$call );
2088 }
2089 $this->assertEquals( $vary, $op->getVaryHeader(), 'Vary:' );
2090 $this->assertEquals( $key, $op->getKeyHeader(), 'Key:' );
2091 }
2092
2093 public function provideVaryHeaders() {
2094 // note: getKeyHeader() automatically adds Vary: Cookie
2095 return [
2096 'No header' => [
2097 [],
2098 [],
2099 'Vary: ',
2100 'Key: Cookie',
2101 ],
2102 'Single header' => [
2103 [
2104 [ 'Cookie' ],
2105 ],
2106 [],
2107 'Vary: Cookie',
2108 'Key: Cookie',
2109 ],
2110 'Non-unique headers' => [
2111 [
2112 [ 'Cookie' ],
2113 [ 'Accept-Language' ],
2114 [ 'Cookie' ],
2115 ],
2116 [],
2117 'Vary: Cookie, Accept-Language',
2118 'Key: Cookie,Accept-Language',
2119 ],
2120 'Two headers with single options' => [
2121 [
2122 [ 'Cookie', [ 'param=phpsessid' ] ],
2123 [ 'Accept-Language', [ 'substr=en' ] ],
2124 ],
2125 [],
2126 'Vary: Cookie, Accept-Language',
2127 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
2128 ],
2129 'One header with multiple options' => [
2130 [
2131 [ 'Cookie', [ 'param=phpsessid', 'param=userId' ] ],
2132 ],
2133 [],
2134 'Vary: Cookie',
2135 'Key: Cookie;param=phpsessid;param=userId',
2136 ],
2137 'Duplicate option' => [
2138 [
2139 [ 'Cookie', [ 'param=phpsessid' ] ],
2140 [ 'Cookie', [ 'param=phpsessid' ] ],
2141 [ 'Accept-Language', [ 'substr=en', 'substr=en' ] ],
2142 ],
2143 [],
2144 'Vary: Cookie, Accept-Language',
2145 'Key: Cookie;param=phpsessid,Accept-Language;substr=en',
2146 ],
2147 'Same header, different options' => [
2148 [
2149 [ 'Cookie', [ 'param=phpsessid' ] ],
2150 [ 'Cookie', [ 'param=userId' ] ],
2151 ],
2152 [],
2153 'Vary: Cookie',
2154 'Key: Cookie;param=phpsessid;param=userId',
2155 ],
2156 'No header, vary cookies' => [
2157 [],
2158 [ 'cookie1', 'cookie2' ],
2159 'Vary: Cookie',
2160 'Key: Cookie;param=cookie1;param=cookie2',
2161 ],
2162 'Cookie header with option plus vary cookies' => [
2163 [
2164 [ 'Cookie', [ 'param=cookie1' ] ],
2165 ],
2166 [ 'cookie2', 'cookie3' ],
2167 'Vary: Cookie',
2168 'Key: Cookie;param=cookie1;param=cookie2;param=cookie3',
2169 ],
2170 'Non-cookie header plus vary cookies' => [
2171 [
2172 [ 'Accept-Language' ],
2173 ],
2174 [ 'cookie' ],
2175 'Vary: Accept-Language, Cookie',
2176 'Key: Accept-Language,Cookie;param=cookie',
2177 ],
2178 'Cookie and non-cookie headers plus vary cookies' => [
2179 [
2180 [ 'Cookie', [ 'param=cookie1' ] ],
2181 [ 'Accept-Language' ],
2182 ],
2183 [ 'cookie2' ],
2184 'Vary: Cookie, Accept-Language',
2185 'Key: Cookie;param=cookie1;param=cookie2,Accept-Language',
2186 ],
2187 ];
2188 }
2189
2190 /**
2191 * @covers OutputPage::getVaryHeader
2192 */
2193 public function testVaryHeaderDefault() {
2194 $op = $this->newInstance();
2195 $this->assertSame( 'Vary: Accept-Encoding, Cookie', $op->getVaryHeader() );
2196 }
2197
2198 /**
2199 * @dataProvider provideLinkHeaders
2200 *
2201 * @covers OutputPage::addLinkHeader
2202 * @covers OutputPage::getLinkHeader
2203 */
2204 public function testLinkHeaders( array $headers, $result ) {
2205 $op = $this->newInstance();
2206
2207 foreach ( $headers as $header ) {
2208 $op->addLinkHeader( $header );
2209 }
2210
2211 $this->assertEquals( $result, $op->getLinkHeader() );
2212 }
2213
2214 public function provideLinkHeaders() {
2215 return [
2216 [
2217 [],
2218 false
2219 ],
2220 [
2221 [ '<https://foo/bar.jpg>;rel=preload;as=image' ],
2222 'Link: <https://foo/bar.jpg>;rel=preload;as=image',
2223 ],
2224 [
2225 [
2226 '<https://foo/bar.jpg>;rel=preload;as=image',
2227 '<https://foo/baz.jpg>;rel=preload;as=image'
2228 ],
2229 'Link: <https://foo/bar.jpg>;rel=preload;as=image,<https://foo/baz.jpg>;' .
2230 'rel=preload;as=image',
2231 ],
2232 ];
2233 }
2234
2235 /**
2236 * @dataProvider provideAddAcceptLanguage
2237 * @covers OutputPage::addAcceptLanguage
2238 * @covers OutputPage::getKeyHeader
2239 */
2240 public function testAddAcceptLanguage(
2241 $code, array $variants, array $expected, array $options = []
2242 ) {
2243 $req = new FauxRequest( in_array( 'varianturl', $options ) ? [ 'variant' => 'x' ] : [] );
2244 $op = $this->newInstance( [], $req, in_array( 'notitle', $options ) ? 'notitle' : null );
2245
2246 if ( !in_array( 'notitle', $options ) ) {
2247 $mockLang = $this->getMock( Language::class );
2248
2249 if ( in_array( 'varianturl', $options ) ) {
2250 $mockLang->expects( $this->never() )->method( $this->anything() );
2251 } else {
2252 $mockLang->method( 'hasVariants' )->willReturn( count( $variants ) > 1 );
2253 $mockLang->method( 'getVariants' )->willReturn( $variants );
2254 $mockLang->method( 'getCode' )->willReturn( $code );
2255 }
2256
2257 $mockTitle = $this->getMock( Title::class );
2258 $mockTitle->method( 'getPageLanguage' )->willReturn( $mockLang );
2259
2260 $op->setTitle( $mockTitle );
2261 }
2262
2263 // This will run addAcceptLanguage()
2264 $op->sendCacheControl();
2265
2266 $this->hideDeprecated( '$wgUseKeyHeader' );
2267 $keyHeader = $op->getKeyHeader();
2268
2269 if ( !$expected ) {
2270 $this->assertFalse( strpos( 'Accept-Language', $keyHeader ) );
2271 return;
2272 }
2273
2274 $keyHeader = explode( ' ', $keyHeader, 2 )[1];
2275 $keyHeader = explode( ',', $keyHeader );
2276
2277 $acceptLanguage = null;
2278 foreach ( $keyHeader as $item ) {
2279 if ( strpos( $item, 'Accept-Language;' ) === 0 ) {
2280 $acceptLanguage = $item;
2281 break;
2282 }
2283 }
2284
2285 $expectedString = 'Accept-Language;substr=' . implode( ';substr=', $expected );
2286 $this->assertSame( $expectedString, $acceptLanguage );
2287 }
2288
2289 public function provideAddAcceptLanguage() {
2290 return [
2291 'No variants' => [ 'en', [ 'en' ], [] ],
2292 'One simple variant' => [ 'en', [ 'en', 'en-x-piglatin' ], [ 'en-x-piglatin' ] ],
2293 'Multiple variants with BCP47 alternatives' => [
2294 'zh',
2295 [ 'zh', 'zh-hans', 'zh-cn', 'zh-tw' ],
2296 [ 'zh-hans', 'zh-Hans', 'zh-cn', 'zh-Hans-CN', 'zh-tw', 'zh-Hant-TW' ],
2297 ],
2298 'No title' => [ 'en', [ 'en', 'en-x-piglatin' ], [], [ 'notitle' ] ],
2299 'Variant in URL' => [ 'en', [ 'en', 'en-x-piglatin' ], [], [ 'varianturl' ] ],
2300 ];
2301 }
2302
2303 /**
2304 * @covers OutputPage::preventClickjacking
2305 * @covers OutputPage::allowClickjacking
2306 * @covers OutputPage::getPreventClickjacking
2307 * @covers OutputPage::addParserOutputMetadata
2308 * @covers OutputPage::addParserOutput
2309 */
2310 public function testClickjacking() {
2311 $op = $this->newInstance();
2312 $this->assertTrue( $op->getPreventClickjacking() );
2313
2314 $op->allowClickjacking();
2315 $this->assertFalse( $op->getPreventClickjacking() );
2316
2317 $op->preventClickjacking();
2318 $this->assertTrue( $op->getPreventClickjacking() );
2319
2320 $op->preventClickjacking( false );
2321 $this->assertFalse( $op->getPreventClickjacking() );
2322
2323 $pOut1 = $this->createParserOutputStub( 'preventClickjacking', true );
2324 $op->addParserOutputMetadata( $pOut1 );
2325 $this->assertTrue( $op->getPreventClickjacking() );
2326
2327 // The ParserOutput can't allow, only prevent
2328 $pOut2 = $this->createParserOutputStub( 'preventClickjacking', false );
2329 $op->addParserOutputMetadata( $pOut2 );
2330 $this->assertTrue( $op->getPreventClickjacking() );
2331
2332 // Reset to test with addParserOutput()
2333 $op->allowClickjacking();
2334 $this->assertFalse( $op->getPreventClickjacking() );
2335
2336 $op->addParserOutput( $pOut1 );
2337 $this->assertTrue( $op->getPreventClickjacking() );
2338
2339 $op->addParserOutput( $pOut2 );
2340 $this->assertTrue( $op->getPreventClickjacking() );
2341 }
2342
2343 /**
2344 * @dataProvider provideGetFrameOptions
2345 * @covers OutputPage::getFrameOptions
2346 * @covers OutputPage::preventClickjacking
2347 */
2348 public function testGetFrameOptions(
2349 $breakFrames, $preventClickjacking, $editPageFrameOptions, $expected
2350 ) {
2351 $op = $this->newInstance( [
2352 'BreakFrames' => $breakFrames,
2353 'EditPageFrameOptions' => $editPageFrameOptions,
2354 ] );
2355 $op->preventClickjacking( $preventClickjacking );
2356
2357 $this->assertSame( $expected, $op->getFrameOptions() );
2358 }
2359
2360 public function provideGetFrameOptions() {
2361 return [
2362 'BreakFrames true' => [ true, false, false, 'DENY' ],
2363 'Allow clickjacking locally' => [ false, false, 'DENY', false ],
2364 'Allow clickjacking globally' => [ false, true, false, false ],
2365 'DENY globally' => [ false, true, 'DENY', 'DENY' ],
2366 'SAMEORIGIN' => [ false, true, 'SAMEORIGIN', 'SAMEORIGIN' ],
2367 'BreakFrames with SAMEORIGIN' => [ true, true, 'SAMEORIGIN', 'DENY' ],
2368 ];
2369 }
2370
2371 /**
2372 * See ResourceLoaderClientHtmlTest for full coverage.
2373 *
2374 * @dataProvider provideMakeResourceLoaderLink
2375 *
2376 * @covers OutputPage::makeResourceLoaderLink
2377 */
2378 public function testMakeResourceLoaderLink( $args, $expectedHtml ) {
2379 $this->setMwGlobals( [
2380 'wgResourceLoaderDebug' => false,
2381 'wgLoadScript' => 'http://127.0.0.1:8080/w/load.php',
2382 'wgCSPReportOnlyHeader' => true,
2383 ] );
2384 $class = new ReflectionClass( OutputPage::class );
2385 $method = $class->getMethod( 'makeResourceLoaderLink' );
2386 $method->setAccessible( true );
2387 $ctx = new RequestContext();
2388 $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
2389 $ctx->setLanguage( 'en' );
2390 $out = new OutputPage( $ctx );
2391 $nonce = $class->getProperty( 'CSPNonce' );
2392 $nonce->setAccessible( true );
2393 $nonce->setValue( $out, 'secret' );
2394 $rl = $out->getResourceLoader();
2395 $rl->setMessageBlobStore( new NullMessageBlobStore() );
2396 $rl->register( [
2397 'test.foo' => new ResourceLoaderTestModule( [
2398 'script' => 'mw.test.foo( { a: true } );',
2399 'styles' => '.mw-test-foo { content: "style"; }',
2400 ] ),
2401 'test.bar' => new ResourceLoaderTestModule( [
2402 'script' => 'mw.test.bar( { a: true } );',
2403 'styles' => '.mw-test-bar { content: "style"; }',
2404 ] ),
2405 'test.baz' => new ResourceLoaderTestModule( [
2406 'script' => 'mw.test.baz( { a: true } );',
2407 'styles' => '.mw-test-baz { content: "style"; }',
2408 ] ),
2409 'test.quux' => new ResourceLoaderTestModule( [
2410 'script' => 'mw.test.baz( { token: 123 } );',
2411 'styles' => '/* pref-animate=off */ .mw-icon { transition: none; }',
2412 'group' => 'private',
2413 ] ),
2414 'test.noscript' => new ResourceLoaderTestModule( [
2415 'styles' => '.stuff { color: red; }',
2416 'group' => 'noscript',
2417 ] ),
2418 'test.group.foo' => new ResourceLoaderTestModule( [
2419 'script' => 'mw.doStuff( "foo" );',
2420 'group' => 'foo',
2421 ] ),
2422 'test.group.bar' => new ResourceLoaderTestModule( [
2423 'script' => 'mw.doStuff( "bar" );',
2424 'group' => 'bar',
2425 ] ),
2426 ] );
2427 $links = $method->invokeArgs( $out, $args );
2428 $actualHtml = strval( $links );
2429 $this->assertEquals( $expectedHtml, $actualHtml );
2430 }
2431
2432 public static function provideMakeResourceLoaderLink() {
2433 // phpcs:disable Generic.Files.LineLength
2434 return [
2435 // Single only=scripts load
2436 [
2437 [ 'test.foo', ResourceLoaderModule::TYPE_SCRIPTS ],
2438 "<script nonce=\"secret\">(window.RLQ=window.RLQ||[]).push(function(){"
2439 . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.foo\u0026only=scripts\u0026skin=fallback");'
2440 . "});</script>"
2441 ],
2442 // Multiple only=styles load
2443 [
2444 [ [ 'test.baz', 'test.foo', 'test.bar' ], ResourceLoaderModule::TYPE_STYLES ],
2445
2446 '<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"/>'
2447 ],
2448 // Private embed (only=scripts)
2449 [
2450 [ 'test.quux', ResourceLoaderModule::TYPE_SCRIPTS ],
2451 "<script nonce=\"secret\">(window.RLQ=window.RLQ||[]).push(function(){"
2452 . "mw.test.baz({token:123});\nmw.loader.state({\"test.quux\":\"ready\"});"
2453 . "});</script>"
2454 ],
2455 // Load private module (combined)
2456 [
2457 [ 'test.quux', ResourceLoaderModule::TYPE_COMBINED ],
2458 "<script nonce=\"secret\">(window.RLQ=window.RLQ||[]).push(function(){"
2459 . "mw.loader.implement(\"test.quux@1ev0ijv\",function($,jQuery,require,module){"
2460 . "mw.test.baz({token:123});},{\"css\":[\".mw-icon{transition:none}"
2461 . "\"]});});</script>"
2462 ],
2463 // Load no modules
2464 [
2465 [ [], ResourceLoaderModule::TYPE_COMBINED ],
2466 '',
2467 ],
2468 // noscript group
2469 [
2470 [ 'test.noscript', ResourceLoaderModule::TYPE_STYLES ],
2471 '<noscript><link rel="stylesheet" href="http://127.0.0.1:8080/w/load.php?debug=false&amp;lang=en&amp;modules=test.noscript&amp;only=styles&amp;skin=fallback"/></noscript>'
2472 ],
2473 // Load two modules in separate groups
2474 [
2475 [ [ 'test.group.foo', 'test.group.bar' ], ResourceLoaderModule::TYPE_COMBINED ],
2476 "<script nonce=\"secret\">(window.RLQ=window.RLQ||[]).push(function(){"
2477 . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.bar\u0026skin=fallback");'
2478 . 'mw.loader.load("http://127.0.0.1:8080/w/load.php?debug=false\u0026lang=en\u0026modules=test.group.foo\u0026skin=fallback");'
2479 . "});</script>"
2480 ],
2481 ];
2482 // phpcs:enable
2483 }
2484
2485 /**
2486 * @dataProvider provideBuildExemptModules
2487 *
2488 * @covers OutputPage::buildExemptModules
2489 */
2490 public function testBuildExemptModules( array $exemptStyleModules, $expect ) {
2491 $this->setMwGlobals( [
2492 'wgResourceLoaderDebug' => false,
2493 'wgLoadScript' => '/w/load.php',
2494 // Stub wgCacheEpoch as it influences getVersionHash used for the
2495 // urls in the expected HTML
2496 'wgCacheEpoch' => '20140101000000',
2497 ] );
2498
2499 // Set up stubs
2500 $ctx = new RequestContext();
2501 $ctx->setSkin( SkinFactory::getDefaultInstance()->makeSkin( 'fallback' ) );
2502 $ctx->setLanguage( 'en' );
2503 $op = $this->getMockBuilder( OutputPage::class )
2504 ->setConstructorArgs( [ $ctx ] )
2505 ->setMethods( [ 'buildCssLinksArray' ] )
2506 ->getMock();
2507 $op->expects( $this->any() )
2508 ->method( 'buildCssLinksArray' )
2509 ->willReturn( [] );
2510 $rl = $op->getResourceLoader();
2511 $rl->setMessageBlobStore( new NullMessageBlobStore() );
2512
2513 // Register custom modules
2514 $rl->register( [
2515 'example.site.a' => new ResourceLoaderTestModule( [ 'group' => 'site' ] ),
2516 'example.site.b' => new ResourceLoaderTestModule( [ 'group' => 'site' ] ),
2517 'example.user' => new ResourceLoaderTestModule( [ 'group' => 'user' ] ),
2518 ] );
2519
2520 $op = TestingAccessWrapper::newFromObject( $op );
2521 $op->rlExemptStyleModules = $exemptStyleModules;
2522 $this->assertEquals(
2523 $expect,
2524 strval( $op->buildExemptModules() )
2525 );
2526 }
2527
2528 public static function provideBuildExemptModules() {
2529 // phpcs:disable Generic.Files.LineLength
2530 return [
2531 'empty' => [
2532 'exemptStyleModules' => [],
2533 '<meta name="ResourceLoaderDynamicStyles" content=""/>',
2534 ],
2535 'empty sets' => [
2536 'exemptStyleModules' => [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ],
2537 '<meta name="ResourceLoaderDynamicStyles" content=""/>',
2538 ],
2539 'default logged-out' => [
2540 'exemptStyleModules' => [ 'site' => [ 'site.styles' ] ],
2541 '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
2542 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>',
2543 ],
2544 'default logged-in' => [
2545 'exemptStyleModules' => [ 'site' => [ 'site.styles' ], 'user' => [ 'user.styles' ] ],
2546 '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
2547 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>' . "\n" .
2548 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=user.styles&amp;only=styles&amp;skin=fallback&amp;version=1ai9g6t"/>',
2549 ],
2550 'custom modules' => [
2551 'exemptStyleModules' => [
2552 'site' => [ 'site.styles', 'example.site.a', 'example.site.b' ],
2553 'user' => [ 'user.styles', 'example.user' ],
2554 ],
2555 '<meta name="ResourceLoaderDynamicStyles" content=""/>' . "\n" .
2556 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=example.site.a%2Cb&amp;only=styles&amp;skin=fallback"/>' . "\n" .
2557 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=site.styles&amp;only=styles&amp;skin=fallback"/>' . "\n" .
2558 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=example.user&amp;only=styles&amp;skin=fallback&amp;version=0a56zyi"/>' . "\n" .
2559 '<link rel="stylesheet" href="/w/load.php?debug=false&amp;lang=en&amp;modules=user.styles&amp;only=styles&amp;skin=fallback&amp;version=1ai9g6t"/>',
2560 ],
2561 ];
2562 // phpcs:enable
2563 }
2564
2565 /**
2566 * @dataProvider provideTransformFilePath
2567 * @covers OutputPage::transformFilePath
2568 * @covers OutputPage::transformResourcePath
2569 */
2570 public function testTransformResourcePath( $baseDir, $basePath, $uploadDir = null,
2571 $uploadPath = null, $path = null, $expected = null
2572 ) {
2573 if ( $path === null ) {
2574 // Skip optional $uploadDir and $uploadPath
2575 $path = $uploadDir;
2576 $expected = $uploadPath;
2577 $uploadDir = "$baseDir/images";
2578 $uploadPath = "$basePath/images";
2579 }
2580 $this->setMwGlobals( 'IP', $baseDir );
2581 $conf = new HashConfig( [
2582 'ResourceBasePath' => $basePath,
2583 'UploadDirectory' => $uploadDir,
2584 'UploadPath' => $uploadPath,
2585 ] );
2586
2587 // Some of these paths don't exist and will cause warnings
2588 Wikimedia\suppressWarnings();
2589 $actual = OutputPage::transformResourcePath( $conf, $path );
2590 Wikimedia\restoreWarnings();
2591
2592 $this->assertEquals( $expected ?: $path, $actual );
2593 }
2594
2595 public static function provideTransformFilePath() {
2596 $baseDir = dirname( __DIR__ ) . '/data/media';
2597 return [
2598 // File that matches basePath, and exists. Hash found and appended.
2599 [
2600 'baseDir' => $baseDir, 'basePath' => '/w',
2601 '/w/test.jpg',
2602 '/w/test.jpg?edcf2'
2603 ],
2604 // File that matches basePath, but not found on disk. Empty query.
2605 [
2606 'baseDir' => $baseDir, 'basePath' => '/w',
2607 '/w/unknown.png',
2608 '/w/unknown.png?'
2609 ],
2610 // File not matching basePath. Ignored.
2611 [
2612 'baseDir' => $baseDir, 'basePath' => '/w',
2613 '/files/test.jpg'
2614 ],
2615 // Empty string. Ignored.
2616 [
2617 'baseDir' => $baseDir, 'basePath' => '/w',
2618 '',
2619 ''
2620 ],
2621 // Similar path, but with domain component. Ignored.
2622 [
2623 'baseDir' => $baseDir, 'basePath' => '/w',
2624 '//example.org/w/test.jpg'
2625 ],
2626 [
2627 'baseDir' => $baseDir, 'basePath' => '/w',
2628 'https://example.org/w/test.jpg'
2629 ],
2630 // Unrelated path with domain component. Ignored.
2631 [
2632 'baseDir' => $baseDir, 'basePath' => '/w',
2633 'https://example.org/files/test.jpg'
2634 ],
2635 [
2636 'baseDir' => $baseDir, 'basePath' => '/w',
2637 '//example.org/files/test.jpg'
2638 ],
2639 // Unrelated path with domain, and empty base path (root mw install). Ignored.
2640 [
2641 'baseDir' => $baseDir, 'basePath' => '',
2642 'https://example.org/files/test.jpg'
2643 ],
2644 [
2645 'baseDir' => $baseDir, 'basePath' => '',
2646 // T155310
2647 '//example.org/files/test.jpg'
2648 ],
2649 // Check UploadPath before ResourceBasePath (T155146)
2650 [
2651 'baseDir' => dirname( $baseDir ), 'basePath' => '',
2652 'uploadDir' => $baseDir, 'uploadPath' => '/images',
2653 '/images/test.jpg',
2654 '/images/test.jpg?edcf2'
2655 ],
2656 ];
2657 }
2658
2659 /**
2660 * Tests a particular case of transformCssMedia, using the given input, globals,
2661 * expected return, and message
2662 *
2663 * Asserts that $expectedReturn is returned.
2664 *
2665 * options['printableQuery'] - value of query string for printable, or omitted for none
2666 * options['handheldQuery'] - value of query string for handheld, or omitted for none
2667 * options['media'] - passed into the method under the same name
2668 * options['expectedReturn'] - expected return value
2669 * options['message'] - PHPUnit message for assertion
2670 *
2671 * @param array $args Key-value array of arguments as shown above
2672 */
2673 protected function assertTransformCssMediaCase( $args ) {
2674 $queryData = [];
2675 if ( isset( $args['printableQuery'] ) ) {
2676 $queryData['printable'] = $args['printableQuery'];
2677 }
2678
2679 if ( isset( $args['handheldQuery'] ) ) {
2680 $queryData['handheld'] = $args['handheldQuery'];
2681 }
2682
2683 $fauxRequest = new FauxRequest( $queryData, false );
2684 $this->setMwGlobals( [
2685 'wgRequest' => $fauxRequest,
2686 ] );
2687
2688 $actualReturn = OutputPage::transformCssMedia( $args['media'] );
2689 $this->assertSame( $args['expectedReturn'], $actualReturn, $args['message'] );
2690 }
2691
2692 /**
2693 * Tests print requests
2694 *
2695 * @covers OutputPage::transformCssMedia
2696 */
2697 public function testPrintRequests() {
2698 $this->assertTransformCssMediaCase( [
2699 'printableQuery' => '1',
2700 'media' => 'screen',
2701 'expectedReturn' => null,
2702 'message' => 'On printable request, screen returns null'
2703 ] );
2704
2705 $this->assertTransformCssMediaCase( [
2706 'printableQuery' => '1',
2707 'media' => self::SCREEN_MEDIA_QUERY,
2708 'expectedReturn' => null,
2709 'message' => 'On printable request, screen media query returns null'
2710 ] );
2711
2712 $this->assertTransformCssMediaCase( [
2713 'printableQuery' => '1',
2714 'media' => self::SCREEN_ONLY_MEDIA_QUERY,
2715 'expectedReturn' => null,
2716 'message' => 'On printable request, screen media query with only returns null'
2717 ] );
2718
2719 $this->assertTransformCssMediaCase( [
2720 'printableQuery' => '1',
2721 'media' => 'print',
2722 'expectedReturn' => '',
2723 'message' => 'On printable request, media print returns empty string'
2724 ] );
2725 }
2726
2727 /**
2728 * Tests screen requests, without either query parameter set
2729 *
2730 * @covers OutputPage::transformCssMedia
2731 */
2732 public function testScreenRequests() {
2733 $this->assertTransformCssMediaCase( [
2734 'media' => 'screen',
2735 'expectedReturn' => 'screen',
2736 'message' => 'On screen request, screen media type is preserved'
2737 ] );
2738
2739 $this->assertTransformCssMediaCase( [
2740 'media' => 'handheld',
2741 'expectedReturn' => 'handheld',
2742 'message' => 'On screen request, handheld media type is preserved'
2743 ] );
2744
2745 $this->assertTransformCssMediaCase( [
2746 'media' => self::SCREEN_MEDIA_QUERY,
2747 'expectedReturn' => self::SCREEN_MEDIA_QUERY,
2748 'message' => 'On screen request, screen media query is preserved.'
2749 ] );
2750
2751 $this->assertTransformCssMediaCase( [
2752 'media' => self::SCREEN_ONLY_MEDIA_QUERY,
2753 'expectedReturn' => self::SCREEN_ONLY_MEDIA_QUERY,
2754 'message' => 'On screen request, screen media query with only is preserved.'
2755 ] );
2756
2757 $this->assertTransformCssMediaCase( [
2758 'media' => 'print',
2759 'expectedReturn' => 'print',
2760 'message' => 'On screen request, print media type is preserved'
2761 ] );
2762 }
2763
2764 /**
2765 * Tests handheld behavior
2766 *
2767 * @covers OutputPage::transformCssMedia
2768 */
2769 public function testHandheld() {
2770 $this->assertTransformCssMediaCase( [
2771 'handheldQuery' => '1',
2772 'media' => 'handheld',
2773 'expectedReturn' => '',
2774 'message' => 'On request with handheld querystring and media is handheld, returns empty string'
2775 ] );
2776
2777 $this->assertTransformCssMediaCase( [
2778 'handheldQuery' => '1',
2779 'media' => 'screen',
2780 'expectedReturn' => null,
2781 'message' => 'On request with handheld querystring and media is screen, returns null'
2782 ] );
2783 }
2784
2785 /**
2786 * @covers OutputPage::isTOCEnabled
2787 * @covers OutputPage::addParserOutputMetadata
2788 * @covers OutputPage::addParserOutput
2789 */
2790 public function testIsTOCEnabled() {
2791 $op = $this->newInstance();
2792 $this->assertFalse( $op->isTOCEnabled() );
2793
2794 $pOut1 = $this->createParserOutputStub( 'getTOCHTML', false );
2795 $op->addParserOutputMetadata( $pOut1 );
2796 $this->assertFalse( $op->isTOCEnabled() );
2797
2798 $pOut2 = $this->createParserOutputStub( 'getTOCHTML', true );
2799 $op->addParserOutput( $pOut2 );
2800 $this->assertTrue( $op->isTOCEnabled() );
2801
2802 // The parser output doesn't disable the TOC after it was enabled
2803 $op->addParserOutputMetadata( $pOut1 );
2804 $this->assertTrue( $op->isTOCEnabled() );
2805 }
2806
2807 /**
2808 * @dataProvider providePreloadLinkHeaders
2809 * @covers ResourceLoaderSkinModule::getPreloadLinks
2810 * @covers ResourceLoaderSkinModule::getLogoPreloadlinks
2811 */
2812 public function testPreloadLinkHeaders( $config, $result ) {
2813 $this->setMwGlobals( $config );
2814 $ctx = $this->getMockBuilder( ResourceLoaderContext::class )
2815 ->disableOriginalConstructor()->getMock();
2816 $module = new ResourceLoaderSkinModule();
2817
2818 $this->assertEquals( [ $result ], $module->getHeaders( $ctx ) );
2819 }
2820
2821 public function providePreloadLinkHeaders() {
2822 return [
2823 [
2824 [
2825 'wgResourceBasePath' => '/w',
2826 'wgLogo' => '/img/default.png',
2827 'wgLogoHD' => [
2828 '1.5x' => '/img/one-point-five.png',
2829 '2x' => '/img/two-x.png',
2830 ],
2831 ],
2832 'Link: </img/default.png>;rel=preload;as=image;media=' .
2833 'not all and (min-resolution: 1.5dppx),' .
2834 '</img/one-point-five.png>;rel=preload;as=image;media=' .
2835 '(min-resolution: 1.5dppx) and (max-resolution: 1.999999dppx),' .
2836 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
2837 ],
2838 [
2839 [
2840 'wgResourceBasePath' => '/w',
2841 'wgLogo' => '/img/default.png',
2842 'wgLogoHD' => false,
2843 ],
2844 'Link: </img/default.png>;rel=preload;as=image'
2845 ],
2846 [
2847 [
2848 'wgResourceBasePath' => '/w',
2849 'wgLogo' => '/img/default.png',
2850 'wgLogoHD' => [
2851 '2x' => '/img/two-x.png',
2852 ],
2853 ],
2854 'Link: </img/default.png>;rel=preload;as=image;media=' .
2855 'not all and (min-resolution: 2dppx),' .
2856 '</img/two-x.png>;rel=preload;as=image;media=(min-resolution: 2dppx)'
2857 ],
2858 [
2859 [
2860 'wgResourceBasePath' => '/w',
2861 'wgLogo' => '/img/default.png',
2862 'wgLogoHD' => [
2863 'svg' => '/img/vector.svg',
2864 ],
2865 ],
2866 'Link: </img/vector.svg>;rel=preload;as=image'
2867
2868 ],
2869 [
2870 [
2871 'wgResourceBasePath' => '/w',
2872 'wgLogo' => '/w/test.jpg',
2873 'wgLogoHD' => false,
2874 'wgUploadPath' => '/w/images',
2875 'IP' => dirname( __DIR__ ) . '/data/media',
2876 ],
2877 'Link: </w/test.jpg?edcf2>;rel=preload;as=image',
2878 ],
2879 ];
2880 }
2881
2882 /**
2883 * @return OutputPage
2884 */
2885 private function newInstance( $config = [], WebRequest $request = null, $options = [] ) {
2886 $context = new RequestContext();
2887
2888 $context->setConfig( new MultiConfig( [
2889 new HashConfig( $config + [
2890 'AppleTouchIcon' => false,
2891 'DisableLangConversion' => true,
2892 'EnableCanonicalServerLink' => false,
2893 'Favicon' => false,
2894 'Feed' => false,
2895 'LanguageCode' => false,
2896 'ReferrerPolicy' => false,
2897 'RightsPage' => false,
2898 'RightsUrl' => false,
2899 'UniversalEditButton' => false,
2900 ] ),
2901 $context->getConfig()
2902 ] ) );
2903
2904 if ( !in_array( 'notitle', (array)$options ) ) {
2905 $context->setTitle( Title::newFromText( 'My test page' ) );
2906 }
2907
2908 if ( $request ) {
2909 $context->setRequest( $request );
2910 }
2911
2912 return new OutputPage( $context );
2913 }
2914 }
2915
2916 /**
2917 * MessageBlobStore that doesn't do anything
2918 */
2919 class NullMessageBlobStore extends MessageBlobStore {
2920 public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
2921 return [];
2922 }
2923
2924 public function updateModule( $name, ResourceLoaderModule $module, $lang ) {
2925 }
2926
2927 public function updateMessage( $key ) {
2928 }
2929
2930 public function clear() {
2931 }
2932 }
Wiklou, le Wiki du Wiklou