tests/phpunit/includes/content/ContentHandlerTest.php

   1 <?php
   2
   3 /**
   4  * @group ContentHandler
   5  */
   6 class ContentHandlerTest extends MediaWikiTestCase {
   7
   8         protected function setUp() {
   9                 global $wgContLang;
  10                 parent::setUp();
  11
  12                 $this->setMwGlobals( [
  13                         'wgExtraNamespaces' => [
  14                                 12312 => 'Dummy',
  15                                 12313 => 'Dummy_talk',
  16                         ],
  17                         // The below tests assume that namespaces not mentioned here (Help, User, MediaWiki, ..)
  18                         // default to CONTENT_MODEL_WIKITEXT.
  19                         'wgNamespaceContentModels' => [
  20                                 12312 => 'testing',
  21                         ],
  22                         'wgContentHandlers' => [
  23                                 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
  24                                 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
  25                                 CONTENT_MODEL_JSON => 'JsonContentHandler',
  26                                 CONTENT_MODEL_CSS => 'CssContentHandler',
  27                                 CONTENT_MODEL_TEXT => 'TextContentHandler',
  28                                 'testing' => 'DummyContentHandlerForTesting',
  29                                 'testing-callbacks' => function( $modelId ) {
  30                                         return new DummyContentHandlerForTesting( $modelId );
  31                                 }
  32                         ],
  33                 ] );
  34
  35                 // Reset namespace cache
  36                 MWNamespace::getCanonicalNamespaces( true );
  37                 $wgContLang->resetNamespaces();
  38                 // And LinkCache
  39                 LinkCache::destroySingleton();
  40         }
  41
  42         protected function tearDown() {
  43                 global $wgContLang;
  44
  45                 // Reset namespace cache
  46                 MWNamespace::getCanonicalNamespaces( true );
  47                 $wgContLang->resetNamespaces();
  48                 // And LinkCache
  49                 LinkCache::destroySingleton();
  50
  51                 parent::tearDown();
  52         }
  53
  54         public static function dataGetDefaultModelFor() {
  55                 return [
  56                         [ 'Help:Foo', CONTENT_MODEL_WIKITEXT ],
  57                         [ 'Help:Foo.js', CONTENT_MODEL_WIKITEXT ],
  58                         [ 'Help:Foo.css', CONTENT_MODEL_WIKITEXT ],
  59                         [ 'Help:Foo.json', CONTENT_MODEL_WIKITEXT ],
  60                         [ 'Help:Foo/bar.js', CONTENT_MODEL_WIKITEXT ],
  61                         [ 'User:Foo', CONTENT_MODEL_WIKITEXT ],
  62                         [ 'User:Foo.js', CONTENT_MODEL_WIKITEXT ],
  63                         [ 'User:Foo.css', CONTENT_MODEL_WIKITEXT ],
  64                         [ 'User:Foo.json', CONTENT_MODEL_WIKITEXT ],
  65                         [ 'User:Foo/bar.js', CONTENT_MODEL_JAVASCRIPT ],
  66                         [ 'User:Foo/bar.css', CONTENT_MODEL_CSS ],
  67                         [ 'User:Foo/bar.json', CONTENT_MODEL_JSON ],
  68                         [ 'User:Foo/bar.json.nope', CONTENT_MODEL_WIKITEXT ],
  69                         [ 'User talk:Foo/bar.css', CONTENT_MODEL_WIKITEXT ],
  70                         [ 'User:Foo/bar.js.xxx', CONTENT_MODEL_WIKITEXT ],
  71                         [ 'User:Foo/bar.xxx', CONTENT_MODEL_WIKITEXT ],
  72                         [ 'MediaWiki:Foo.js', CONTENT_MODEL_JAVASCRIPT ],
  73                         [ 'MediaWiki:Foo.JS', CONTENT_MODEL_WIKITEXT ],
  74                         [ 'MediaWiki:Foo.css', CONTENT_MODEL_CSS ],
  75                         [ 'MediaWiki:Foo.css.xxx', CONTENT_MODEL_WIKITEXT ],
  76                         [ 'MediaWiki:Foo.CSS', CONTENT_MODEL_WIKITEXT ],
  77                         [ 'MediaWiki:Foo.json', CONTENT_MODEL_JSON ],
  78                         [ 'MediaWiki:Foo.JSON', CONTENT_MODEL_WIKITEXT ],
  79                 ];
  80         }
  81
  82         /**
  83          * @dataProvider dataGetDefaultModelFor
  84          * @covers ContentHandler::getDefaultModelFor
  85          */
  86         public function testGetDefaultModelFor( $title, $expectedModelId ) {
  87                 $title = Title::newFromText( $title );
  88                 $this->assertEquals( $expectedModelId, ContentHandler::getDefaultModelFor( $title ) );
  89         }
  90
  91         /**
  92          * @dataProvider dataGetDefaultModelFor
  93          * @covers ContentHandler::getForTitle
  94          */
  95         public function testGetForTitle( $title, $expectedContentModel ) {
  96                 $title = Title::newFromText( $title );
  97                 LinkCache::singleton()->addBadLinkObj( $title );
  98                 $handler = ContentHandler::getForTitle( $title );
  99                 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
 100         }
 101
 102         public static function dataGetLocalizedName() {
 103                 return [
 104                         [ null, null ],
 105                         [ "xyzzy", null ],
 106
 107                         // XXX: depends on content language
 108                         [ CONTENT_MODEL_JAVASCRIPT, '/javascript/i' ],
 109                 ];
 110         }
 111
 112         /**
 113          * @dataProvider dataGetLocalizedName
 114          * @covers ContentHandler::getLocalizedName
 115          */
 116         public function testGetLocalizedName( $id, $expected ) {
 117                 $name = ContentHandler::getLocalizedName( $id );
 118
 119                 if ( $expected ) {
 120                         $this->assertNotNull( $name, "no name found for content model $id" );
 121                         $this->assertTrue( preg_match( $expected, $name ) > 0,
 122                                 "content model name for #$id did not match pattern $expected"
 123                         );
 124                 } else {
 125                         $this->assertEquals( $id, $name, "localization of unknown model $id should have "
 126                                 . "fallen back to use the model id directly."
 127                         );
 128                 }
 129         }
 130
 131         public static function dataGetPageLanguage() {
 132                 global $wgLanguageCode;
 133
 134                 return [
 135                         [ "Main", $wgLanguageCode ],
 136                         [ "Dummy:Foo", $wgLanguageCode ],
 137                         [ "MediaWiki:common.js", 'en' ],
 138                         [ "User:Foo/common.js", 'en' ],
 139                         [ "MediaWiki:common.css", 'en' ],
 140                         [ "User:Foo/common.css", 'en' ],
 141                         [ "User:Foo", $wgLanguageCode ],
 142
 143                         [ CONTENT_MODEL_JAVASCRIPT, 'javascript' ],
 144                 ];
 145         }
 146
 147         /**
 148          * @dataProvider dataGetPageLanguage
 149          * @covers ContentHandler::getPageLanguage
 150          */
 151         public function testGetPageLanguage( $title, $expected ) {
 152                 if ( is_string( $title ) ) {
 153                         $title = Title::newFromText( $title );
 154                         LinkCache::singleton()->addBadLinkObj( $title );
 155                 }
 156
 157                 $expected = wfGetLangObj( $expected );
 158
 159                 $handler = ContentHandler::getForTitle( $title );
 160                 $lang = $handler->getPageLanguage( $title );
 161
 162                 $this->assertEquals( $expected->getCode(), $lang->getCode() );
 163         }
 164
 165         public static function dataGetContentText_Null() {
 166                 return [
 167                         [ 'fail' ],
 168                         [ 'serialize' ],
 169                         [ 'ignore' ],
 170                 ];
 171         }
 172
 173         /**
 174          * @dataProvider dataGetContentText_Null
 175          * @covers ContentHandler::getContentText
 176          */
 177         public function testGetContentText_Null( $contentHandlerTextFallback ) {
 178                 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
 179
 180                 $content = null;
 181
 182                 $text = ContentHandler::getContentText( $content );
 183                 $this->assertEquals( '', $text );
 184         }
 185
 186         public static function dataGetContentText_TextContent() {
 187                 return [
 188                         [ 'fail' ],
 189                         [ 'serialize' ],
 190                         [ 'ignore' ],
 191                 ];
 192         }
 193
 194         /**
 195          * @dataProvider dataGetContentText_TextContent
 196          * @covers ContentHandler::getContentText
 197          */
 198         public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
 199                 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
 200
 201                 $content = new WikitextContent( "hello world" );
 202
 203                 $text = ContentHandler::getContentText( $content );
 204                 $this->assertEquals( $content->getNativeData(), $text );
 205         }
 206
 207         /**
 208          * ContentHandler::getContentText should have thrown an exception for non-text Content object
 209          * @expectedException MWException
 210          * @covers ContentHandler::getContentText
 211          */
 212         public function testGetContentText_NonTextContent_fail() {
 213                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
 214
 215                 $content = new DummyContentForTesting( "hello world" );
 216
 217                 ContentHandler::getContentText( $content );
 218         }
 219
 220         /**
 221          * @covers ContentHandler::getContentText
 222          */
 223         public function testGetContentText_NonTextContent_serialize() {
 224                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
 225
 226                 $content = new DummyContentForTesting( "hello world" );
 227
 228                 $text = ContentHandler::getContentText( $content );
 229                 $this->assertEquals( $content->serialize(), $text );
 230         }
 231
 232         /**
 233          * @covers ContentHandler::getContentText
 234          */
 235         public function testGetContentText_NonTextContent_ignore() {
 236                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
 237
 238                 $content = new DummyContentForTesting( "hello world" );
 239
 240                 $text = ContentHandler::getContentText( $content );
 241                 $this->assertNull( $text );
 242         }
 243
 244         /*
 245         public static function makeContent( $text, Title $title, $modelId = null, $format = null ) {}
 246         */
 247
 248         public static function dataMakeContent() {
 249                 return [
 250                         [ 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT, 'hallo', false ],
 251                         [ 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT, 'hallo', false ],
 252                         [ serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", 'hallo', false ],
 253
 254                         [
 255                                 'hallo',
 256                                 'Help:Test',
 257                                 null,
 258                                 CONTENT_FORMAT_WIKITEXT,
 259                                 CONTENT_MODEL_WIKITEXT,
 260                                 'hallo',
 261                                 false
 262                         ],
 263                         [
 264                                 'hallo',
 265                                 'MediaWiki:Test.js',
 266                                 null,
 267                                 CONTENT_FORMAT_JAVASCRIPT,
 268                                 CONTENT_MODEL_JAVASCRIPT,
 269                                 'hallo',
 270                                 false
 271                         ],
 272                         [ serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", 'hallo', false ],
 273
 274                         [ 'hallo', 'Help:Test', CONTENT_MODEL_CSS, null, CONTENT_MODEL_CSS, 'hallo', false ],
 275                         [
 276                                 'hallo',
 277                                 'MediaWiki:Test.js',
 278                                 CONTENT_MODEL_CSS,
 279                                 null,
 280                                 CONTENT_MODEL_CSS,
 281                                 'hallo',
 282                                 false
 283                         ],
 284                         [
 285                                 serialize( 'hallo' ),
 286                                 'Dummy:Test',
 287                                 CONTENT_MODEL_CSS,
 288                                 null,
 289                                 CONTENT_MODEL_CSS,
 290                                 serialize( 'hallo' ),
 291                                 false
 292                         ],
 293
 294                         [ 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT, "testing", null, null, true ],
 295                         [ 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS, "testing", null, null, true ],
 296                         [ 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT, "testing", null, null, true ],
 297                 ];
 298         }
 299
 300         /**
 301          * @dataProvider dataMakeContent
 302          * @covers ContentHandler::makeContent
 303          */
 304         public function testMakeContent( $data, $title, $modelId, $format,
 305                 $expectedModelId, $expectedNativeData, $shouldFail
 306         ) {
 307                 $title = Title::newFromText( $title );
 308                 LinkCache::singleton()->addBadLinkObj( $title );
 309                 try {
 310                         $content = ContentHandler::makeContent( $data, $title, $modelId, $format );
 311
 312                         if ( $shouldFail ) {
 313                                 $this->fail( "ContentHandler::makeContent should have failed!" );
 314                         }
 315
 316                         $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
 317                         $this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
 318                 } catch ( MWException $ex ) {
 319                         if ( !$shouldFail ) {
 320                                 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
 321                         } else {
 322                                 // dummy, so we don't get the "test did not perform any assertions" message.
 323                                 $this->assertTrue( true );
 324                         }
 325                 }
 326         }
 327
 328         /*
 329          * Test if we become a "Created blank page" summary from getAutoSummary if no Content added to
 330          * page.
 331          */
 332         public function testGetAutosummary() {
 333                 $this->setMwGlobals( 'wgContLang', Language::factory( 'en' ) );
 334
 335                 $content = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT );
 336                 $title = Title::newFromText( 'Help:Test' );
 337                 // Create a new content object with no content
 338                 $newContent = ContentHandler::makeContent( '', $title, null, null, CONTENT_MODEL_WIKITEXT );
 339                 // first check, if we become a blank page created summary with the right bitmask
 340                 $autoSummary = $content->getAutosummary( null, $newContent, 97 );
 341                 $this->assertEquals( $autoSummary, 'Created blank page' );
 342                 // now check, what we become with another bitmask
 343                 $autoSummary = $content->getAutosummary( null, $newContent, 92 );
 344                 $this->assertEquals( $autoSummary, '' );
 345         }
 346
 347         /*
 348         public function testSupportsSections() {
 349                 $this->markTestIncomplete( "not yet implemented" );
 350         }
 351         */
 352
 353         public function testSupportsCategories() {
 354                 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT );
 355                 $this->assertTrue( $handler->supportsCategories(), 'content model supports categories' );
 356         }
 357
 358         public function testSupportsDirectEditing() {
 359                 $handler = new DummyContentHandlerForTesting( CONTENT_MODEL_JSON );
 360                 $this->assertFalse( $handler->supportsDirectEditing(), 'direct editing is not supported' );
 361         }
 362
 363         /**
 364          * @covers ContentHandler::runLegacyHooks
 365          */
 366         public function testRunLegacyHooks() {
 367                 Hooks::register( 'testRunLegacyHooks', __CLASS__ . '::dummyHookHandler' );
 368
 369                 $content = new WikitextContent( 'test text' );
 370                 $ok = ContentHandler::runLegacyHooks(
 371                         'testRunLegacyHooks',
 372                         [ 'foo', &$content, 'bar' ],
 373                         false
 374                 );
 375
 376                 $this->assertTrue( $ok, "runLegacyHooks should have returned true" );
 377                 $this->assertEquals( "TEST TEXT", $content->getNativeData() );
 378         }
 379
 380         public static function dummyHookHandler( $foo, &$text, $bar ) {
 381                 if ( $text === null || $text === false ) {
 382                         return false;
 383                 }
 384
 385                 $text = strtoupper( $text );
 386
 387                 return true;
 388         }
 389
 390         public function provideGetModelForID() {
 391                 return [
 392                         [ CONTENT_MODEL_WIKITEXT, 'WikitextContentHandler' ],
 393                         [ CONTENT_MODEL_JAVASCRIPT, 'JavaScriptContentHandler' ],
 394                         [ CONTENT_MODEL_JSON, 'JsonContentHandler' ],
 395                         [ CONTENT_MODEL_CSS, 'CssContentHandler' ],
 396                         [ CONTENT_MODEL_TEXT, 'TextContentHandler' ],
 397                         [ 'testing', 'DummyContentHandlerForTesting' ],
 398                         [ 'testing-callbacks', 'DummyContentHandlerForTesting' ],
 399                 ];
 400         }
 401
 402         /**
 403          * @dataProvider provideGetModelForID
 404          */
 405         public function testGetModelForID( $modelId, $handlerClass ) {
 406                 $handler = ContentHandler::getForModelID( $modelId );
 407
 408                 $this->assertInstanceOf( $handlerClass, $handler );
 409         }
 410
 411 }