tests/phpunit/includes/content/ContentHandlerTest.php

   1 <?php
   2
   3 /**
   4  * @group ContentHandler
   5  * @group Database
   6  *
   7  * @note Declare that we are using the database, because otherwise we'll fail in
   8  * the "databaseless" test run. This is because the LinkHolderArray used by the
   9  * parser needs database access.
  10  */
  11 class ContentHandlerTest extends MediaWikiTestCase {
  12
  13         protected function setUp() {
  14                 global $wgContLang;
  15                 parent::setUp();
  16
  17                 $this->setMwGlobals( array(
  18                         'wgExtraNamespaces' => array(
  19                                 12312 => 'Dummy',
  20                                 12313 => 'Dummy_talk',
  21                         ),
  22                         // The below tests assume that namespaces not mentioned here (Help, User, MediaWiki, ..)
  23                         // default to CONTENT_MODEL_WIKITEXT.
  24                         'wgNamespaceContentModels' => array(
  25                                 12312 => 'testing',
  26                         ),
  27                         'wgContentHandlers' => array(
  28                                 CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
  29                                 CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
  30                                 CONTENT_MODEL_CSS => 'CssContentHandler',
  31                                 CONTENT_MODEL_TEXT => 'TextContentHandler',
  32                                 'testing' => 'DummyContentHandlerForTesting',
  33                         ),
  34                 ) );
  35
  36                 // Reset namespace cache
  37                 MWNamespace::getCanonicalNamespaces( true );
  38                 $wgContLang->resetNamespaces();
  39         }
  40
  41         protected function tearDown() {
  42                 global $wgContLang;
  43
  44                 // Reset namespace cache
  45                 MWNamespace::getCanonicalNamespaces( true );
  46                 $wgContLang->resetNamespaces();
  47
  48                 parent::tearDown();
  49         }
  50
  51         public static function dataGetDefaultModelFor() {
  52                 return array(
  53                         array( 'Help:Foo', CONTENT_MODEL_WIKITEXT ),
  54                         array( 'Help:Foo.js', CONTENT_MODEL_WIKITEXT ),
  55                         array( 'Help:Foo/bar.js', CONTENT_MODEL_WIKITEXT ),
  56                         array( 'User:Foo', CONTENT_MODEL_WIKITEXT ),
  57                         array( 'User:Foo.js', CONTENT_MODEL_WIKITEXT ),
  58                         array( 'User:Foo/bar.js', CONTENT_MODEL_JAVASCRIPT ),
  59                         array( 'User:Foo/bar.css', CONTENT_MODEL_CSS ),
  60                         array( 'User talk:Foo/bar.css', CONTENT_MODEL_WIKITEXT ),
  61                         array( 'User:Foo/bar.js.xxx', CONTENT_MODEL_WIKITEXT ),
  62                         array( 'User:Foo/bar.xxx', CONTENT_MODEL_WIKITEXT ),
  63                         array( 'MediaWiki:Foo.js', CONTENT_MODEL_JAVASCRIPT ),
  64                         array( 'MediaWiki:Foo.css', CONTENT_MODEL_CSS ),
  65                         array( 'MediaWiki:Foo.JS', CONTENT_MODEL_WIKITEXT ),
  66                         array( 'MediaWiki:Foo.CSS', CONTENT_MODEL_WIKITEXT ),
  67                         array( 'MediaWiki:Foo.css.xxx', CONTENT_MODEL_WIKITEXT ),
  68                 );
  69         }
  70
  71         /**
  72          * @dataProvider dataGetDefaultModelFor
  73          * @covers ContentHandler::getDefaultModelFor
  74          */
  75         public function testGetDefaultModelFor( $title, $expectedModelId ) {
  76                 $title = Title::newFromText( $title );
  77                 $this->assertEquals( $expectedModelId, ContentHandler::getDefaultModelFor( $title ) );
  78         }
  79
  80         /**
  81          * @dataProvider dataGetDefaultModelFor
  82          * @covers ContentHandler::getForTitle
  83          */
  84         public function testGetForTitle( $title, $expectedContentModel ) {
  85                 $title = Title::newFromText( $title );
  86                 $handler = ContentHandler::getForTitle( $title );
  87                 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
  88         }
  89
  90         public static function dataGetLocalizedName() {
  91                 return array(
  92                         array( null, null ),
  93                         array( "xyzzy", null ),
  94
  95                         // XXX: depends on content language
  96                         array( CONTENT_MODEL_JAVASCRIPT, '/javascript/i' ),
  97                 );
  98         }
  99
 100         /**
 101          * @dataProvider dataGetLocalizedName
 102          * @covers ContentHandler::getLocalizedName
 103          */
 104         public function testGetLocalizedName( $id, $expected ) {
 105                 $name = ContentHandler::getLocalizedName( $id );
 106
 107                 if ( $expected ) {
 108                         $this->assertNotNull( $name, "no name found for content model $id" );
 109                         $this->assertTrue( preg_match( $expected, $name ) > 0,
 110                                 "content model name for #$id did not match pattern $expected"
 111                         );
 112                 } else {
 113                         $this->assertEquals( $id, $name, "localization of unknown model $id should have "
 114                                 . "fallen back to use the model id directly."
 115                         );
 116                 }
 117         }
 118
 119         public static function dataGetPageLanguage() {
 120                 global $wgLanguageCode;
 121
 122                 return array(
 123                         array( "Main", $wgLanguageCode ),
 124                         array( "Dummy:Foo", $wgLanguageCode ),
 125                         array( "MediaWiki:common.js", 'en' ),
 126                         array( "User:Foo/common.js", 'en' ),
 127                         array( "MediaWiki:common.css", 'en' ),
 128                         array( "User:Foo/common.css", 'en' ),
 129                         array( "User:Foo", $wgLanguageCode ),
 130
 131                         array( CONTENT_MODEL_JAVASCRIPT, 'javascript' ),
 132                 );
 133         }
 134
 135         /**
 136          * @dataProvider dataGetPageLanguage
 137          * @covers ContentHandler::getPageLanguage
 138          */
 139         public function testGetPageLanguage( $title, $expected ) {
 140                 if ( is_string( $title ) ) {
 141                         $title = Title::newFromText( $title );
 142                 }
 143
 144                 $expected = wfGetLangObj( $expected );
 145
 146                 $handler = ContentHandler::getForTitle( $title );
 147                 $lang = $handler->getPageLanguage( $title );
 148
 149                 $this->assertEquals( $expected->getCode(), $lang->getCode() );
 150         }
 151
 152         public static function dataGetContentText_Null() {
 153                 return array(
 154                         array( 'fail' ),
 155                         array( 'serialize' ),
 156                         array( 'ignore' ),
 157                 );
 158         }
 159
 160         /**
 161          * @dataProvider dataGetContentText_Null
 162          * @covers ContentHandler::getContentText
 163          */
 164         public function testGetContentText_Null( $contentHandlerTextFallback ) {
 165                 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
 166
 167                 $content = null;
 168
 169                 $text = ContentHandler::getContentText( $content );
 170                 $this->assertEquals( '', $text );
 171         }
 172
 173         public static function dataGetContentText_TextContent() {
 174                 return array(
 175                         array( 'fail' ),
 176                         array( 'serialize' ),
 177                         array( 'ignore' ),
 178                 );
 179         }
 180
 181         /**
 182          * @dataProvider dataGetContentText_TextContent
 183          * @covers ContentHandler::getContentText
 184          */
 185         public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
 186                 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
 187
 188                 $content = new WikitextContent( "hello world" );
 189
 190                 $text = ContentHandler::getContentText( $content );
 191                 $this->assertEquals( $content->getNativeData(), $text );
 192         }
 193
 194         /**
 195          * ContentHandler::getContentText should have thrown an exception for non-text Content object
 196          * @expectedException MWException
 197          * @covers ContentHandler::getContentText
 198          */
 199         public function testGetContentText_NonTextContent_fail() {
 200                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
 201
 202                 $content = new DummyContentForTesting( "hello world" );
 203
 204                 ContentHandler::getContentText( $content );
 205         }
 206
 207         /**
 208          * @covers ContentHandler::getContentText
 209          */
 210         public function testGetContentText_NonTextContent_serialize() {
 211                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
 212
 213                 $content = new DummyContentForTesting( "hello world" );
 214
 215                 $text = ContentHandler::getContentText( $content );
 216                 $this->assertEquals( $content->serialize(), $text );
 217         }
 218
 219         /**
 220          * @covers ContentHandler::getContentText
 221          */
 222         public function testGetContentText_NonTextContent_ignore() {
 223                 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
 224
 225                 $content = new DummyContentForTesting( "hello world" );
 226
 227                 $text = ContentHandler::getContentText( $content );
 228                 $this->assertNull( $text );
 229         }
 230
 231         /*
 232         public static function makeContent( $text, Title $title, $modelId = null, $format = null ) {}
 233         */
 234
 235         public static function dataMakeContent() {
 236                 return array(
 237                         array( 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT, 'hallo', false ),
 238                         array( 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT, 'hallo', false ),
 239                         array( serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", 'hallo', false ),
 240
 241                         array(
 242                                 'hallo',
 243                                 'Help:Test',
 244                                 null,
 245                                 CONTENT_FORMAT_WIKITEXT,
 246                                 CONTENT_MODEL_WIKITEXT,
 247                                 'hallo',
 248                                 false
 249                         ),
 250                         array(
 251                                 'hallo',
 252                                 'MediaWiki:Test.js',
 253                                 null,
 254                                 CONTENT_FORMAT_JAVASCRIPT,
 255                                 CONTENT_MODEL_JAVASCRIPT,
 256                                 'hallo',
 257                                 false
 258                         ),
 259                         array( serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", 'hallo', false ),
 260
 261                         array( 'hallo', 'Help:Test', CONTENT_MODEL_CSS, null, CONTENT_MODEL_CSS, 'hallo', false ),
 262                         array(
 263                                 'hallo',
 264                                 'MediaWiki:Test.js',
 265                                 CONTENT_MODEL_CSS,
 266                                 null,
 267                                 CONTENT_MODEL_CSS,
 268                                 'hallo',
 269                                 false
 270                         ),
 271                         array(
 272                                 serialize( 'hallo' ),
 273                                 'Dummy:Test',
 274                                 CONTENT_MODEL_CSS,
 275                                 null,
 276                                 CONTENT_MODEL_CSS,
 277                                 serialize( 'hallo' ),
 278                                 false
 279                         ),
 280
 281                         array( 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT, "testing", null, null, true ),
 282                         array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS, "testing", null, null, true ),
 283                         array( 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT, "testing", null, null, true ),
 284                 );
 285         }
 286
 287         /**
 288          * @dataProvider dataMakeContent
 289          * @covers ContentHandler::makeContent
 290          */
 291         public function testMakeContent( $data, $title, $modelId, $format,
 292                 $expectedModelId, $expectedNativeData, $shouldFail
 293         ) {
 294                 $title = Title::newFromText( $title );
 295
 296                 try {
 297                         $content = ContentHandler::makeContent( $data, $title, $modelId, $format );
 298
 299                         if ( $shouldFail ) {
 300                                 $this->fail( "ContentHandler::makeContent should have failed!" );
 301                         }
 302
 303                         $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
 304                         $this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
 305                 } catch ( MWException $ex ) {
 306                         if ( !$shouldFail ) {
 307                                 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
 308                         } else {
 309                                 // dummy, so we don't get the "test did not perform any assertions" message.
 310                                 $this->assertTrue( true );
 311                         }
 312                 }
 313         }
 314
 315         /*
 316         public function testSupportsSections() {
 317                 $this->markTestIncomplete( "not yet implemented" );
 318         }
 319         */
 320
 321         /**
 322          * @covers ContentHandler::runLegacyHooks
 323          */
 324         public function testRunLegacyHooks() {
 325                 Hooks::register( 'testRunLegacyHooks', __CLASS__ . '::dummyHookHandler' );
 326
 327                 $content = new WikitextContent( 'test text' );
 328                 $ok = ContentHandler::runLegacyHooks(
 329                         'testRunLegacyHooks',
 330                         array( 'foo', &$content, 'bar' ),
 331                         false
 332                 );
 333
 334                 $this->assertTrue( $ok, "runLegacyHooks should have returned true" );
 335                 $this->assertEquals( "TEST TEXT", $content->getNativeData() );
 336         }
 337
 338         public static function dummyHookHandler( $foo, &$text, $bar ) {
 339                 if ( $text === null || $text === false ) {
 340                         return false;
 341                 }
 342
 343                 $text = strtoupper( $text );
 344
 345                 return true;
 346         }
 347 }
 348
 349 class DummyContentHandlerForTesting extends ContentHandler {
 350
 351         public function __construct( $dataModel ) {
 352                 parent::__construct( $dataModel, array( "testing" ) );
 353         }
 354
 355         /**
 356          * @see ContentHandler::serializeContent
 357          *
 358          * @param Content $content
 359          * @param string $format
 360          *
 361          * @return string
 362          */
 363         public function serializeContent( Content $content, $format = null ) {
 364                 return $content->serialize();
 365         }
 366
 367         /**
 368          * @see ContentHandler::unserializeContent
 369          *
 370          * @param string $blob
 371          * @param string $format Unused.
 372          *
 373          * @return Content
 374          */
 375         public function unserializeContent( $blob, $format = null ) {
 376                 $d = unserialize( $blob );
 377
 378                 return new DummyContentForTesting( $d );
 379         }
 380
 381         /**
 382          * Creates an empty Content object of the type supported by this ContentHandler.
 383          *
 384          */
 385         public function makeEmptyContent() {
 386                 return new DummyContentForTesting( '' );
 387         }
 388 }
 389
 390 class DummyContentForTesting extends AbstractContent {
 391
 392         public function __construct( $data ) {
 393                 parent::__construct( "testing" );
 394
 395                 $this->data = $data;
 396         }
 397
 398         public function serialize( $format = null ) {
 399                 return serialize( $this->data );
 400         }
 401
 402         /**
 403          * @return string A string representing the content in a way useful for
 404          *   building a full text search index. If no useful representation exists,
 405          *   this method returns an empty string.
 406          */
 407         public function getTextForSearchIndex() {
 408                 return '';
 409         }
 410
 411         /**
 412          * @return string|bool The wikitext to include when another page includes this  content,
 413          *  or false if the content is not includable in a wikitext page.
 414          */
 415         public function getWikitextForTransclusion() {
 416                 return false;
 417         }
 418
 419         /**
 420          * Returns a textual representation of the content suitable for use in edit
 421          * summaries and log messages.
 422          *
 423          * @param int $maxlength Maximum length of the summary text.
 424          * @return string The summary text.
 425          */
 426         public function getTextForSummary( $maxlength = 250 ) {
 427                 return '';
 428         }
 429
 430         /**
 431          * Returns native represenation of the data. Interpretation depends on the data model used,
 432          * as given by getDataModel().
 433          *
 434          * @return mixed the native representation of the content. Could be a string, a nested array
 435          *  structure, an object, a binary blob... anything, really.
 436          */
 437         public function getNativeData() {
 438                 return $this->data;
 439         }
 440
 441         /**
 442          * returns the content's nominal size in bogo-bytes.
 443          *
 444          * @return int
 445          */
 446         public function getSize() {
 447                 return strlen( $this->data );
 448         }
 449
 450         /**
 451          * Return a copy of this Content object. The following must be true for the object returned
 452          * if $copy = $original->copy()
 453          *
 454          * * get_class($original) === get_class($copy)
 455          * * $original->getModel() === $copy->getModel()
 456          * * $original->equals( $copy )
 457          *
 458          * If and only if the Content object is imutable, the copy() method can and should
 459          * return $this. That is,  $copy === $original may be true, but only for imutable content
 460          * objects.
 461          *
 462          * @return Content. A copy of this object.
 463          */
 464         public function copy() {
 465                 return $this;
 466         }
 467
 468         /**
 469          * Returns true if this content is countable as a "real" wiki page, provided
 470          * that it's also in a countable location (e.g. a current revision in the main namespace).
 471          *
 472          * @param bool $hasLinks if it is known whether this content contains links,
 473          * provide this information here, to avoid redundant parsing to find out.
 474          * @return bool
 475          */
 476         public function isCountable( $hasLinks = null ) {
 477                 return false;
 478         }
 479
 480         /**
 481          * @param Title $title
 482          * @param int $revId Unused.
 483          * @param null|ParserOptions $options
 484          * @param bool $generateHtml whether to generate Html (default: true). If false, the result
 485          *  of calling getText() on the ParserOutput object returned by this method is undefined.
 486          *
 487          * @return ParserOutput
 488          */
 489         public function getParserOutput( Title $title, $revId = null,
 490                 ParserOptions $options = null, $generateHtml = true
 491         ) {
 492                 return new ParserOutput( $this->getNativeData() );
 493         }
 494
 495         /**
 496          * @see AbstractContent::fillParserOutput()
 497          *
 498          * @param Title $title Context title for parsing
 499          * @param int|null $revId Revision ID (for {{REVISIONID}})
 500          * @param ParserOptions|null $options Parser options
 501          * @param bool $generateHtml Whether or not to generate HTML
 502          * @param ParserOutput &$output The output object to fill (reference).
 503          */
 504         protected function fillParserOutput( Title $title, $revId,
 505                         ParserOptions $options, $generateHtml, ParserOutput &$output ) {
 506                 $output = new ParserOutput( $this->getNativeData() );
 507         }
 508 }