2 use MediaWiki\MediaWikiServices
;
3 use Wikimedia\TestingAccessWrapper
;
6 * @group ContentHandler
9 class ContentHandlerTest
extends MediaWikiTestCase
{
11 protected function setUp() {
14 $this->setMwGlobals( [
15 'wgExtraNamespaces' => [
17 12313 => 'Dummy_talk',
19 // The below tests assume that namespaces not mentioned here (Help, User, MediaWiki, ..)
20 // default to CONTENT_MODEL_WIKITEXT.
21 'wgNamespaceContentModels' => [
24 'wgContentHandlers' => [
25 CONTENT_MODEL_WIKITEXT
=> WikitextContentHandler
::class,
26 CONTENT_MODEL_JAVASCRIPT
=> JavaScriptContentHandler
::class,
27 CONTENT_MODEL_JSON
=> JsonContentHandler
::class,
28 CONTENT_MODEL_CSS
=> CssContentHandler
::class,
29 CONTENT_MODEL_TEXT
=> TextContentHandler
::class,
30 'testing' => DummyContentHandlerForTesting
::class,
31 'testing-callbacks' => function ( $modelId ) {
32 return new DummyContentHandlerForTesting( $modelId );
38 MediaWikiServices
::getInstance()->resetServiceForTesting( 'LinkCache' );
41 protected function tearDown() {
43 MediaWikiServices
::getInstance()->resetServiceForTesting( 'LinkCache' );
48 public function addDBDataOnce() {
49 $this->insertPage( 'Not_Main_Page', 'This is not a main page' );
50 $this->insertPage( 'Smithee', 'A smithee is one who smiths. See also [[Alan Smithee]]' );
53 public static function dataGetDefaultModelFor() {
55 [ 'Help:Foo', CONTENT_MODEL_WIKITEXT
],
56 [ 'Help:Foo.js', CONTENT_MODEL_WIKITEXT
],
57 [ 'Help:Foo.css', CONTENT_MODEL_WIKITEXT
],
58 [ 'Help:Foo.json', CONTENT_MODEL_WIKITEXT
],
59 [ 'Help:Foo/bar.js', CONTENT_MODEL_WIKITEXT
],
60 [ 'User:Foo', CONTENT_MODEL_WIKITEXT
],
61 [ 'User:Foo.js', CONTENT_MODEL_WIKITEXT
],
62 [ 'User:Foo.css', CONTENT_MODEL_WIKITEXT
],
63 [ 'User:Foo.json', CONTENT_MODEL_WIKITEXT
],
64 [ 'User:Foo/bar.js', CONTENT_MODEL_JAVASCRIPT
],
65 [ 'User:Foo/bar.css', CONTENT_MODEL_CSS
],
66 [ 'User:Foo/bar.json', CONTENT_MODEL_JSON
],
67 [ 'User:Foo/bar.json.nope', CONTENT_MODEL_WIKITEXT
],
68 [ 'User talk:Foo/bar.css', CONTENT_MODEL_WIKITEXT
],
69 [ 'User:Foo/bar.js.xxx', CONTENT_MODEL_WIKITEXT
],
70 [ 'User:Foo/bar.xxx', CONTENT_MODEL_WIKITEXT
],
71 [ 'MediaWiki:Foo.js', CONTENT_MODEL_JAVASCRIPT
],
72 [ 'MediaWiki:Foo.JS', CONTENT_MODEL_WIKITEXT
],
73 [ 'MediaWiki:Foo.css', CONTENT_MODEL_CSS
],
74 [ 'MediaWiki:Foo.css.xxx', CONTENT_MODEL_WIKITEXT
],
75 [ 'MediaWiki:Foo.CSS', CONTENT_MODEL_WIKITEXT
],
76 [ 'MediaWiki:Foo.json', CONTENT_MODEL_JSON
],
77 [ 'MediaWiki:Foo.JSON', CONTENT_MODEL_WIKITEXT
],
82 * @dataProvider dataGetDefaultModelFor
83 * @covers ContentHandler::getDefaultModelFor
85 public function testGetDefaultModelFor( $title, $expectedModelId ) {
86 $title = Title
::newFromText( $title );
87 $this->assertEquals( $expectedModelId, ContentHandler
::getDefaultModelFor( $title ) );
91 * @dataProvider dataGetDefaultModelFor
92 * @covers ContentHandler::getForTitle
94 public function testGetForTitle( $title, $expectedContentModel ) {
95 $title = Title
::newFromText( $title );
96 MediaWikiServices
::getInstance()->getLinkCache()->addBadLinkObj( $title );
97 $handler = ContentHandler
::getForTitle( $title );
98 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
101 public static function dataGetLocalizedName() {
106 // XXX: depends on content language
107 [ CONTENT_MODEL_JAVASCRIPT
, '/javascript/i' ],
112 * @dataProvider dataGetLocalizedName
113 * @covers ContentHandler::getLocalizedName
115 public function testGetLocalizedName( $id, $expected ) {
116 $name = ContentHandler
::getLocalizedName( $id );
119 $this->assertNotNull( $name, "no name found for content model $id" );
120 $this->assertTrue( preg_match( $expected, $name ) > 0,
121 "content model name for #$id did not match pattern $expected"
124 $this->assertEquals( $id, $name, "localization of unknown model $id should have "
125 . "fallen back to use the model id directly."
130 public static function dataGetPageLanguage() {
131 global $wgLanguageCode;
134 [ "Main", $wgLanguageCode ],
135 [ "Dummy:Foo", $wgLanguageCode ],
136 [ "MediaWiki:common.js", 'en' ],
137 [ "User:Foo/common.js", 'en' ],
138 [ "MediaWiki:common.css", 'en' ],
139 [ "User:Foo/common.css", 'en' ],
140 [ "User:Foo", $wgLanguageCode ],
142 [ CONTENT_MODEL_JAVASCRIPT
, 'javascript' ],
147 * @dataProvider dataGetPageLanguage
148 * @covers ContentHandler::getPageLanguage
150 public function testGetPageLanguage( $title, $expected ) {
151 if ( is_string( $title ) ) {
152 $title = Title
::newFromText( $title );
153 MediaWikiServices
::getInstance()->getLinkCache()->addBadLinkObj( $title );
156 $expected = wfGetLangObj( $expected );
158 $handler = ContentHandler
::getForTitle( $title );
159 $lang = $handler->getPageLanguage( $title );
161 $this->assertInstanceOf( Language
::class, $lang );
162 $this->assertEquals( $expected->getCode(), $lang->getCode() );
165 public static function dataGetContentText_Null() {
174 * @dataProvider dataGetContentText_Null
175 * @covers ContentHandler::getContentText
177 public function testGetContentText_Null( $contentHandlerTextFallback ) {
178 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
182 $text = ContentHandler
::getContentText( $content );
183 $this->assertEquals( '', $text );
186 public static function dataGetContentText_TextContent() {
195 * @dataProvider dataGetContentText_TextContent
196 * @covers ContentHandler::getContentText
198 public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
199 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
201 $content = new WikitextContent( "hello world" );
203 $text = ContentHandler
::getContentText( $content );
204 $this->assertEquals( $content->getText(), $text );
208 * ContentHandler::getContentText should have thrown an exception for non-text Content object
209 * @expectedException MWException
210 * @covers ContentHandler::getContentText
212 public function testGetContentText_NonTextContent_fail() {
213 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
215 $content = new DummyContentForTesting( "hello world" );
217 ContentHandler
::getContentText( $content );
221 * @covers ContentHandler::getContentText
223 public function testGetContentText_NonTextContent_serialize() {
224 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
226 $content = new DummyContentForTesting( "hello world" );
228 $text = ContentHandler
::getContentText( $content );
229 $this->assertEquals( $content->serialize(), $text );
233 * @covers ContentHandler::getContentText
235 public function testGetContentText_NonTextContent_ignore() {
236 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
238 $content = new DummyContentForTesting( "hello world" );
240 $text = ContentHandler
::getContentText( $content );
241 $this->assertNull( $text );
244 public static function dataMakeContent() {
246 [ 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT
, false ],
247 [ 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT
, false ],
248 [ serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", false ],
254 CONTENT_FORMAT_WIKITEXT
,
255 CONTENT_MODEL_WIKITEXT
,
262 CONTENT_FORMAT_JAVASCRIPT
,
263 CONTENT_MODEL_JAVASCRIPT
,
266 [ serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", false ],
268 [ 'hallo', 'Help:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, false ],
278 serialize( 'hallo' ),
286 [ 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT
, "testing", null, true ],
287 [ 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, "testing", null, true ],
288 [ 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT
, "testing", null, true ],
293 * @dataProvider dataMakeContent
294 * @covers ContentHandler::makeContent
296 public function testMakeContent( $data, $title, $modelId, $format,
297 $expectedModelId, $shouldFail
299 $title = Title
::newFromText( $title );
300 MediaWikiServices
::getInstance()->getLinkCache()->addBadLinkObj( $title );
302 $content = ContentHandler
::makeContent( $data, $title, $modelId, $format );
305 $this->fail( "ContentHandler::makeContent should have failed!" );
308 $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
309 $this->assertEquals( $data, $content->serialize(), 'bad serialized data' );
310 } catch ( MWException
$ex ) {
311 if ( !$shouldFail ) {
312 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
314 // dummy, so we don't get the "test did not perform any assertions" message.
315 $this->assertTrue( true );
321 * @covers ContentHandler::getAutosummary
323 * Test if we become a "Created blank page" summary from getAutoSummary if no Content added to
326 public function testGetAutosummary() {
327 $this->setContentLang( 'en' );
329 $content = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
330 $title = Title
::newFromText( 'Help:Test' );
331 // Create a new content object with no content
332 $newContent = ContentHandler
::makeContent( '', $title, CONTENT_MODEL_WIKITEXT
, null );
333 // first check, if we become a blank page created summary with the right bitmask
334 $autoSummary = $content->getAutosummary( null, $newContent, 97 );
335 $this->assertEquals( $autoSummary,
336 wfMessage( 'autosumm-newblank' )->inContentLanguage()->text() );
337 // now check, what we become with another bitmask
338 $autoSummary = $content->getAutosummary( null, $newContent, 92 );
339 $this->assertEquals( $autoSummary, '' );
343 * Test software tag that is added when content model of the page changes
344 * @covers ContentHandler::getChangeTag
346 public function testGetChangeTag() {
347 $this->setMwGlobals( 'wgSoftwareTags', [ 'mw-contentmodelchange' => true ] );
348 $wikitextContentHandler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
349 // Create old content object with javascript content model
350 $oldContent = ContentHandler
::makeContent( '', null, CONTENT_MODEL_JAVASCRIPT
, null );
351 // Create new content object with wikitext content model
352 $newContent = ContentHandler
::makeContent( '', null, CONTENT_MODEL_WIKITEXT
, null );
353 // Get the tag for this edit
354 $tag = $wikitextContentHandler->getChangeTag( $oldContent, $newContent, EDIT_UPDATE
);
355 $this->assertSame( $tag, 'mw-contentmodelchange' );
359 * @covers ContentHandler::supportsCategories
361 public function testSupportsCategories() {
362 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
363 $this->assertTrue( $handler->supportsCategories(), 'content model supports categories' );
367 * @covers ContentHandler::supportsDirectEditing
369 public function testSupportsDirectEditing() {
370 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_JSON
);
371 $this->assertFalse( $handler->supportsDirectEditing(), 'direct editing is not supported' );
374 public static function dummyHookHandler( $foo, &$text, $bar ) {
375 if ( $text === null ||
$text === false ) {
379 $text = strtoupper( $text );
384 public function provideGetModelForID() {
386 [ CONTENT_MODEL_WIKITEXT
, WikitextContentHandler
::class ],
387 [ CONTENT_MODEL_JAVASCRIPT
, JavaScriptContentHandler
::class ],
388 [ CONTENT_MODEL_JSON
, JsonContentHandler
::class ],
389 [ CONTENT_MODEL_CSS
, CssContentHandler
::class ],
390 [ CONTENT_MODEL_TEXT
, TextContentHandler
::class ],
391 [ 'testing', DummyContentHandlerForTesting
::class ],
392 [ 'testing-callbacks', DummyContentHandlerForTesting
::class ],
397 * @covers ContentHandler::getForModelID
398 * @dataProvider provideGetModelForID
400 public function testGetModelForID( $modelId, $handlerClass ) {
401 $handler = ContentHandler
::getForModelID( $modelId );
403 $this->assertInstanceOf( $handlerClass, $handler );
407 * @covers ContentHandler::getFieldsForSearchIndex
409 public function testGetFieldsForSearchIndex() {
410 $searchEngine = $this->newSearchEngine();
412 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
414 $fields = $handler->getFieldsForSearchIndex( $searchEngine );
416 $this->assertArrayHasKey( 'category', $fields );
417 $this->assertArrayHasKey( 'external_link', $fields );
418 $this->assertArrayHasKey( 'outgoing_link', $fields );
419 $this->assertArrayHasKey( 'template', $fields );
420 $this->assertArrayHasKey( 'content_model', $fields );
423 private function newSearchEngine() {
424 $searchEngine = $this->getMockBuilder( SearchEngine
::class )
427 $searchEngine->expects( $this->any() )
428 ->method( 'makeSearchFieldMapping' )
429 ->will( $this->returnCallback( function ( $name, $type ) {
430 return new DummySearchIndexFieldDefinition( $name, $type );
433 return $searchEngine;
437 * @covers ContentHandler::getDataForSearchIndex
439 public function testDataIndexFields() {
440 $mockEngine = $this->createMock( SearchEngine
::class );
441 $title = Title
::newFromText( 'Not_Main_Page', NS_MAIN
);
442 $page = new WikiPage( $title );
444 $this->setTemporaryHook( 'SearchDataForIndex',
447 ContentHandler
$handler,
449 ParserOutput
$output,
452 $fields['testDataField'] = 'test content';
455 $output = $page->getContent()->getParserOutput( $title );
456 $data = $page->getContentHandler()->getDataForSearchIndex( $page, $output, $mockEngine );
457 $this->assertArrayHasKey( 'text', $data );
458 $this->assertArrayHasKey( 'text_bytes', $data );
459 $this->assertArrayHasKey( 'language', $data );
460 $this->assertArrayHasKey( 'testDataField', $data );
461 $this->assertEquals( 'test content', $data['testDataField'] );
462 $this->assertEquals( 'wikitext', $data['content_model'] );
466 * @covers ContentHandler::getParserOutputForIndexing
468 public function testParserOutputForIndexing() {
469 $title = Title
::newFromText( 'Smithee', NS_MAIN
);
470 $page = new WikiPage( $title );
472 $out = $page->getContentHandler()->getParserOutputForIndexing( $page );
473 $this->assertInstanceOf( ParserOutput
::class, $out );
474 $this->assertContains( 'one who smiths', $out->getRawText() );
478 * @covers ContentHandler::getContentModels
480 public function testGetContentModelsHook() {
481 $this->setTemporaryHook( 'GetContentModels', function ( &$models ) {
482 $models[] = 'Ferrari';
484 $this->assertContains( 'Ferrari', ContentHandler
::getContentModels() );
488 * @covers ContentHandler::getSlotDiffRenderer
490 public function testGetSlotDiffRenderer_default() {
491 $this->mergeMwGlobalArrayValue( 'wgHooks', [
492 'GetSlotDiffRenderer' => [],
495 // test default renderer
496 $contentHandler = new WikitextContentHandler( CONTENT_MODEL_WIKITEXT
);
497 $slotDiffRenderer = $contentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
498 $this->assertInstanceOf( TextSlotDiffRenderer
::class, $slotDiffRenderer );
502 * @covers ContentHandler::getSlotDiffRenderer
504 public function testGetSlotDiffRenderer_bc() {
505 $this->mergeMwGlobalArrayValue( 'wgHooks', [
506 'GetSlotDiffRenderer' => [],
510 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
511 ->disableOriginalConstructor()
513 // hack to track object identity across cloning
514 $customDifferenceEngine->objectId
= 12345;
515 $customContentHandler = $this->getMockBuilder( ContentHandler
::class )
516 ->setConstructorArgs( [ 'foo', [] ] )
517 ->setMethods( [ 'createDifferenceEngine' ] )
518 ->getMockForAbstractClass();
519 $customContentHandler->expects( $this->any() )
520 ->method( 'createDifferenceEngine' )
521 ->willReturn( $customDifferenceEngine );
522 /** @var $customContentHandler ContentHandler */
523 $slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
524 $this->assertInstanceOf( DifferenceEngineSlotDiffRenderer
::class, $slotDiffRenderer );
526 $customDifferenceEngine->objectId
,
527 TestingAccessWrapper
::newFromObject( $slotDiffRenderer )->differenceEngine
->objectId
532 * @covers ContentHandler::getSlotDiffRenderer
534 public function testGetSlotDiffRenderer_nobc() {
535 $this->mergeMwGlobalArrayValue( 'wgHooks', [
536 'GetSlotDiffRenderer' => [],
539 // test that B/C renderer does not get used when getSlotDiffRendererInternal is overridden
540 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
541 ->disableOriginalConstructor()
543 $customSlotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer
::class )
544 ->disableOriginalConstructor()
545 ->getMockForAbstractClass();
546 $customContentHandler2 = $this->getMockBuilder( ContentHandler
::class )
547 ->setConstructorArgs( [ 'bar', [] ] )
548 ->setMethods( [ 'createDifferenceEngine', 'getSlotDiffRendererInternal' ] )
549 ->getMockForAbstractClass();
550 $customContentHandler2->expects( $this->any() )
551 ->method( 'createDifferenceEngine' )
552 ->willReturn( $customDifferenceEngine );
553 $customContentHandler2->expects( $this->any() )
554 ->method( 'getSlotDiffRendererInternal' )
555 ->willReturn( $customSlotDiffRenderer );
556 /** @var $customContentHandler2 ContentHandler */
557 $slotDiffRenderer = $customContentHandler2->getSlotDiffRenderer( RequestContext
::getMain() );
558 $this->assertSame( $customSlotDiffRenderer, $slotDiffRenderer );
562 * @covers ContentHandler::getSlotDiffRenderer
564 public function testGetSlotDiffRenderer_hook() {
565 $this->mergeMwGlobalArrayValue( 'wgHooks', [
566 'GetSlotDiffRenderer' => [],
569 // test that the hook handler takes precedence
570 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
571 ->disableOriginalConstructor()
573 $customContentHandler = $this->getMockBuilder( ContentHandler
::class )
574 ->setConstructorArgs( [ 'foo', [] ] )
575 ->setMethods( [ 'createDifferenceEngine' ] )
576 ->getMockForAbstractClass();
577 $customContentHandler->expects( $this->any() )
578 ->method( 'createDifferenceEngine' )
579 ->willReturn( $customDifferenceEngine );
580 /** @var $customContentHandler ContentHandler */
582 $customSlotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer
::class )
583 ->disableOriginalConstructor()
584 ->getMockForAbstractClass();
585 $customContentHandler2 = $this->getMockBuilder( ContentHandler
::class )
586 ->setConstructorArgs( [ 'bar', [] ] )
587 ->setMethods( [ 'createDifferenceEngine', 'getSlotDiffRendererInternal' ] )
588 ->getMockForAbstractClass();
589 $customContentHandler2->expects( $this->any() )
590 ->method( 'createDifferenceEngine' )
591 ->willReturn( $customDifferenceEngine );
592 $customContentHandler2->expects( $this->any() )
593 ->method( 'getSlotDiffRendererInternal' )
594 ->willReturn( $customSlotDiffRenderer );
595 /** @var $customContentHandler2 ContentHandler */
597 $customSlotDiffRenderer2 = $this->getMockBuilder( SlotDiffRenderer
::class )
598 ->disableOriginalConstructor()
599 ->getMockForAbstractClass();
600 $this->setTemporaryHook( 'GetSlotDiffRenderer',
601 function ( $handler, &$slotDiffRenderer ) use ( $customSlotDiffRenderer2 ) {
602 $slotDiffRenderer = $customSlotDiffRenderer2;
605 $slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
606 $this->assertSame( $customSlotDiffRenderer2, $slotDiffRenderer );
607 $slotDiffRenderer = $customContentHandler2->getSlotDiffRenderer( RequestContext
::getMain() );
608 $this->assertSame( $customSlotDiffRenderer2, $slotDiffRenderer );