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->assertEquals( $expected->getCode(), $lang->getCode() );
164 public static function dataGetContentText_Null() {
173 * @dataProvider dataGetContentText_Null
174 * @covers ContentHandler::getContentText
176 public function testGetContentText_Null( $contentHandlerTextFallback ) {
177 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
181 $text = ContentHandler
::getContentText( $content );
182 $this->assertEquals( '', $text );
185 public static function dataGetContentText_TextContent() {
194 * @dataProvider dataGetContentText_TextContent
195 * @covers ContentHandler::getContentText
197 public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
198 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
200 $content = new WikitextContent( "hello world" );
202 $text = ContentHandler
::getContentText( $content );
203 $this->assertEquals( $content->getText(), $text );
207 * ContentHandler::getContentText should have thrown an exception for non-text Content object
208 * @expectedException MWException
209 * @covers ContentHandler::getContentText
211 public function testGetContentText_NonTextContent_fail() {
212 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
214 $content = new DummyContentForTesting( "hello world" );
216 ContentHandler
::getContentText( $content );
220 * @covers ContentHandler::getContentText
222 public function testGetContentText_NonTextContent_serialize() {
223 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
225 $content = new DummyContentForTesting( "hello world" );
227 $text = ContentHandler
::getContentText( $content );
228 $this->assertEquals( $content->serialize(), $text );
232 * @covers ContentHandler::getContentText
234 public function testGetContentText_NonTextContent_ignore() {
235 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
237 $content = new DummyContentForTesting( "hello world" );
239 $text = ContentHandler
::getContentText( $content );
240 $this->assertNull( $text );
243 public static function dataMakeContent() {
245 [ 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT
, false ],
246 [ 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT
, false ],
247 [ serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", false ],
253 CONTENT_FORMAT_WIKITEXT
,
254 CONTENT_MODEL_WIKITEXT
,
261 CONTENT_FORMAT_JAVASCRIPT
,
262 CONTENT_MODEL_JAVASCRIPT
,
265 [ serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", false ],
267 [ 'hallo', 'Help:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, false ],
277 serialize( 'hallo' ),
285 [ 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT
, "testing", null, true ],
286 [ 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, "testing", null, true ],
287 [ 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT
, "testing", null, true ],
292 * @dataProvider dataMakeContent
293 * @covers ContentHandler::makeContent
295 public function testMakeContent( $data, $title, $modelId, $format,
296 $expectedModelId, $shouldFail
298 $title = Title
::newFromText( $title );
299 MediaWikiServices
::getInstance()->getLinkCache()->addBadLinkObj( $title );
301 $content = ContentHandler
::makeContent( $data, $title, $modelId, $format );
304 $this->fail( "ContentHandler::makeContent should have failed!" );
307 $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
308 $this->assertEquals( $data, $content->serialize(), 'bad serialized data' );
309 } catch ( MWException
$ex ) {
310 if ( !$shouldFail ) {
311 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
313 // dummy, so we don't get the "test did not perform any assertions" message.
314 $this->assertTrue( true );
320 * @covers ContentHandler::getAutosummary
322 * Test if we become a "Created blank page" summary from getAutoSummary if no Content added to
325 public function testGetAutosummary() {
326 $this->setContentLang( 'en' );
328 $content = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
329 $title = Title
::newFromText( 'Help:Test' );
330 // Create a new content object with no content
331 $newContent = ContentHandler
::makeContent( '', $title, CONTENT_MODEL_WIKITEXT
, null );
332 // first check, if we become a blank page created summary with the right bitmask
333 $autoSummary = $content->getAutosummary( null, $newContent, 97 );
334 $this->assertEquals( $autoSummary,
335 wfMessage( 'autosumm-newblank' )->inContentLanguage()->text() );
336 // now check, what we become with another bitmask
337 $autoSummary = $content->getAutosummary( null, $newContent, 92 );
338 $this->assertEquals( $autoSummary, '' );
342 * Test software tag that is added when content model of the page changes
343 * @covers ContentHandler::getChangeTag
345 public function testGetChangeTag() {
346 $this->setMwGlobals( 'wgSoftwareTags', [ 'mw-contentmodelchange' => true ] );
347 $wikitextContentHandler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
348 // Create old content object with javascript content model
349 $oldContent = ContentHandler
::makeContent( '', null, CONTENT_MODEL_JAVASCRIPT
, null );
350 // Create new content object with wikitext content model
351 $newContent = ContentHandler
::makeContent( '', null, CONTENT_MODEL_WIKITEXT
, null );
352 // Get the tag for this edit
353 $tag = $wikitextContentHandler->getChangeTag( $oldContent, $newContent, EDIT_UPDATE
);
354 $this->assertSame( $tag, 'mw-contentmodelchange' );
358 * @covers ContentHandler::supportsCategories
360 public function testSupportsCategories() {
361 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT
);
362 $this->assertTrue( $handler->supportsCategories(), 'content model supports categories' );
366 * @covers ContentHandler::supportsDirectEditing
368 public function testSupportsDirectEditing() {
369 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_JSON
);
370 $this->assertFalse( $handler->supportsDirectEditing(), 'direct editing is not supported' );
373 public static function dummyHookHandler( $foo, &$text, $bar ) {
374 if ( $text === null ||
$text === false ) {
378 $text = strtoupper( $text );
383 public function provideGetModelForID() {
385 [ CONTENT_MODEL_WIKITEXT
, WikitextContentHandler
::class ],
386 [ CONTENT_MODEL_JAVASCRIPT
, JavaScriptContentHandler
::class ],
387 [ CONTENT_MODEL_JSON
, JsonContentHandler
::class ],
388 [ CONTENT_MODEL_CSS
, CssContentHandler
::class ],
389 [ CONTENT_MODEL_TEXT
, TextContentHandler
::class ],
390 [ 'testing', DummyContentHandlerForTesting
::class ],
391 [ 'testing-callbacks', DummyContentHandlerForTesting
::class ],
396 * @covers ContentHandler::getForModelID
397 * @dataProvider provideGetModelForID
399 public function testGetModelForID( $modelId, $handlerClass ) {
400 $handler = ContentHandler
::getForModelID( $modelId );
402 $this->assertInstanceOf( $handlerClass, $handler );
406 * @covers ContentHandler::getFieldsForSearchIndex
408 public function testGetFieldsForSearchIndex() {
409 $searchEngine = $this->newSearchEngine();
411 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
413 $fields = $handler->getFieldsForSearchIndex( $searchEngine );
415 $this->assertArrayHasKey( 'category', $fields );
416 $this->assertArrayHasKey( 'external_link', $fields );
417 $this->assertArrayHasKey( 'outgoing_link', $fields );
418 $this->assertArrayHasKey( 'template', $fields );
419 $this->assertArrayHasKey( 'content_model', $fields );
422 private function newSearchEngine() {
423 $searchEngine = $this->getMockBuilder( SearchEngine
::class )
426 $searchEngine->expects( $this->any() )
427 ->method( 'makeSearchFieldMapping' )
428 ->will( $this->returnCallback( function ( $name, $type ) {
429 return new DummySearchIndexFieldDefinition( $name, $type );
432 return $searchEngine;
436 * @covers ContentHandler::getDataForSearchIndex
438 public function testDataIndexFields() {
439 $mockEngine = $this->createMock( SearchEngine
::class );
440 $title = Title
::newFromText( 'Not_Main_Page', NS_MAIN
);
441 $page = new WikiPage( $title );
443 $this->setTemporaryHook( 'SearchDataForIndex',
446 ContentHandler
$handler,
448 ParserOutput
$output,
451 $fields['testDataField'] = 'test content';
454 $output = $page->getContent()->getParserOutput( $title );
455 $data = $page->getContentHandler()->getDataForSearchIndex( $page, $output, $mockEngine );
456 $this->assertArrayHasKey( 'text', $data );
457 $this->assertArrayHasKey( 'text_bytes', $data );
458 $this->assertArrayHasKey( 'language', $data );
459 $this->assertArrayHasKey( 'testDataField', $data );
460 $this->assertEquals( 'test content', $data['testDataField'] );
461 $this->assertEquals( 'wikitext', $data['content_model'] );
465 * @covers ContentHandler::getParserOutputForIndexing
467 public function testParserOutputForIndexing() {
468 $title = Title
::newFromText( 'Smithee', NS_MAIN
);
469 $page = new WikiPage( $title );
471 $out = $page->getContentHandler()->getParserOutputForIndexing( $page );
472 $this->assertInstanceOf( ParserOutput
::class, $out );
473 $this->assertContains( 'one who smiths', $out->getRawText() );
477 * @covers ContentHandler::getContentModels
479 public function testGetContentModelsHook() {
480 $this->setTemporaryHook( 'GetContentModels', function ( &$models ) {
481 $models[] = 'Ferrari';
483 $this->assertContains( 'Ferrari', ContentHandler
::getContentModels() );
487 * @covers ContentHandler::getSlotDiffRenderer
489 public function testGetSlotDiffRenderer_default() {
490 $this->mergeMwGlobalArrayValue( 'wgHooks', [
491 'GetSlotDiffRenderer' => [],
494 // test default renderer
495 $contentHandler = new WikitextContentHandler( CONTENT_MODEL_WIKITEXT
);
496 $slotDiffRenderer = $contentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
497 $this->assertInstanceOf( TextSlotDiffRenderer
::class, $slotDiffRenderer );
501 * @covers ContentHandler::getSlotDiffRenderer
503 public function testGetSlotDiffRenderer_bc() {
504 $this->mergeMwGlobalArrayValue( 'wgHooks', [
505 'GetSlotDiffRenderer' => [],
509 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
510 ->disableOriginalConstructor()
512 // hack to track object identity across cloning
513 $customDifferenceEngine->objectId
= 12345;
514 $customContentHandler = $this->getMockBuilder( ContentHandler
::class )
515 ->setConstructorArgs( [ 'foo', [] ] )
516 ->setMethods( [ 'createDifferenceEngine' ] )
517 ->getMockForAbstractClass();
518 $customContentHandler->expects( $this->any() )
519 ->method( 'createDifferenceEngine' )
520 ->willReturn( $customDifferenceEngine );
521 /** @var $customContentHandler ContentHandler */
522 $slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
523 $this->assertInstanceOf( DifferenceEngineSlotDiffRenderer
::class, $slotDiffRenderer );
525 $customDifferenceEngine->objectId
,
526 TestingAccessWrapper
::newFromObject( $slotDiffRenderer )->differenceEngine
->objectId
531 * @covers ContentHandler::getSlotDiffRenderer
533 public function testGetSlotDiffRenderer_nobc() {
534 $this->mergeMwGlobalArrayValue( 'wgHooks', [
535 'GetSlotDiffRenderer' => [],
538 // test that B/C renderer does not get used when getSlotDiffRendererInternal is overridden
539 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
540 ->disableOriginalConstructor()
542 $customSlotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer
::class )
543 ->disableOriginalConstructor()
544 ->getMockForAbstractClass();
545 $customContentHandler2 = $this->getMockBuilder( ContentHandler
::class )
546 ->setConstructorArgs( [ 'bar', [] ] )
547 ->setMethods( [ 'createDifferenceEngine', 'getSlotDiffRendererInternal' ] )
548 ->getMockForAbstractClass();
549 $customContentHandler2->expects( $this->any() )
550 ->method( 'createDifferenceEngine' )
551 ->willReturn( $customDifferenceEngine );
552 $customContentHandler2->expects( $this->any() )
553 ->method( 'getSlotDiffRendererInternal' )
554 ->willReturn( $customSlotDiffRenderer );
555 /** @var $customContentHandler2 ContentHandler */
556 $slotDiffRenderer = $customContentHandler2->getSlotDiffRenderer( RequestContext
::getMain() );
557 $this->assertSame( $customSlotDiffRenderer, $slotDiffRenderer );
561 * @covers ContentHandler::getSlotDiffRenderer
563 public function testGetSlotDiffRenderer_hook() {
564 $this->mergeMwGlobalArrayValue( 'wgHooks', [
565 'GetSlotDiffRenderer' => [],
568 // test that the hook handler takes precedence
569 $customDifferenceEngine = $this->getMockBuilder( DifferenceEngine
::class )
570 ->disableOriginalConstructor()
572 $customContentHandler = $this->getMockBuilder( ContentHandler
::class )
573 ->setConstructorArgs( [ 'foo', [] ] )
574 ->setMethods( [ 'createDifferenceEngine' ] )
575 ->getMockForAbstractClass();
576 $customContentHandler->expects( $this->any() )
577 ->method( 'createDifferenceEngine' )
578 ->willReturn( $customDifferenceEngine );
579 /** @var $customContentHandler ContentHandler */
581 $customSlotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer
::class )
582 ->disableOriginalConstructor()
583 ->getMockForAbstractClass();
584 $customContentHandler2 = $this->getMockBuilder( ContentHandler
::class )
585 ->setConstructorArgs( [ 'bar', [] ] )
586 ->setMethods( [ 'createDifferenceEngine', 'getSlotDiffRendererInternal' ] )
587 ->getMockForAbstractClass();
588 $customContentHandler2->expects( $this->any() )
589 ->method( 'createDifferenceEngine' )
590 ->willReturn( $customDifferenceEngine );
591 $customContentHandler2->expects( $this->any() )
592 ->method( 'getSlotDiffRendererInternal' )
593 ->willReturn( $customSlotDiffRenderer );
594 /** @var $customContentHandler2 ContentHandler */
596 $customSlotDiffRenderer2 = $this->getMockBuilder( SlotDiffRenderer
::class )
597 ->disableOriginalConstructor()
598 ->getMockForAbstractClass();
599 $this->setTemporaryHook( 'GetSlotDiffRenderer',
600 function ( $handler, &$slotDiffRenderer ) use ( $customSlotDiffRenderer2 ) {
601 $slotDiffRenderer = $customSlotDiffRenderer2;
604 $slotDiffRenderer = $customContentHandler->getSlotDiffRenderer( RequestContext
::getMain() );
605 $this->assertSame( $customSlotDiffRenderer2, $slotDiffRenderer );
606 $slotDiffRenderer = $customContentHandler2->getSlotDiffRenderer( RequestContext
::getMain() );
607 $this->assertSame( $customSlotDiffRenderer2, $slotDiffRenderer );