4 * @group ContentHandler
7 * @note Declare that we are using the database, because otherwise we'll fail in the "databaseless" test run.
8 * This is because the LinkHolderArray used by the parser needs database access.
11 class ContentHandlerTest
extends MediaWikiTestCase
{
13 public function setUp() {
17 $this->setMwGlobals( array(
18 'wgExtraNamespaces' => array(
20 12313 => 'Dummy_talk',
22 // The below tests assume that namespaces not mentioned here (Help, User, MediaWiki, ..)
23 // default to CONTENT_MODEL_WIKITEXT.
24 'wgNamespaceContentModels' => array(
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',
36 // Reset namespace cache
37 MWNamespace
::getCanonicalNamespaces( true );
38 $wgContLang->resetNamespaces();
41 public function tearDown() {
44 // Reset namespace cache
45 MWNamespace
::getCanonicalNamespaces( true );
46 $wgContLang->resetNamespaces();
51 public static function dataGetDefaultModelFor() {
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
),
72 * @dataProvider dataGetDefaultModelFor
73 * @covers ContentHandler::getDefaultModelFor
75 public function testGetDefaultModelFor( $title, $expectedModelId ) {
76 $title = Title
::newFromText( $title );
77 $this->assertEquals( $expectedModelId, ContentHandler
::getDefaultModelFor( $title ) );
81 * @dataProvider dataGetDefaultModelFor
82 * @covers ContentHandler::getForTitle
84 public function testGetForTitle( $title, $expectedContentModel ) {
85 $title = Title
::newFromText( $title );
86 $handler = ContentHandler
::getForTitle( $title );
87 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
90 public static function dataGetLocalizedName() {
93 array( "xyzzy", null ),
95 // XXX: depends on content language
96 array( CONTENT_MODEL_JAVASCRIPT
, '/javascript/i' ),
101 * @dataProvider dataGetLocalizedName
102 * @covers ContentHandler::getLocalizedName
104 public function testGetLocalizedName( $id, $expected ) {
105 $name = ContentHandler
::getLocalizedName( $id );
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"
113 $this->assertEquals( $id, $name, "localization of unknown model $id should have "
114 . "fallen back to use the model id directly."
119 public static function dataGetPageLanguage() {
120 global $wgLanguageCode;
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 ),
131 array( CONTENT_MODEL_JAVASCRIPT
, 'javascript' ),
136 * @dataProvider dataGetPageLanguage
137 * @covers ContentHandler::getPageLanguage
139 public function testGetPageLanguage( $title, $expected ) {
140 if ( is_string( $title ) ) {
141 $title = Title
::newFromText( $title );
144 $expected = wfGetLangObj( $expected );
146 $handler = ContentHandler
::getForTitle( $title );
147 $lang = $handler->getPageLanguage( $title );
149 $this->assertEquals( $expected->getCode(), $lang->getCode() );
152 public static function dataGetContentText_Null() {
155 array( 'serialize' ),
161 * @dataProvider dataGetContentText_Null
162 * @covers ContentHandler::getContentText
164 public function testGetContentText_Null( $contentHandlerTextFallback ) {
165 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
169 $text = ContentHandler
::getContentText( $content );
170 $this->assertEquals( '', $text );
173 public static function dataGetContentText_TextContent() {
176 array( 'serialize' ),
182 * @dataProvider dataGetContentText_TextContent
183 * @covers ContentHandler::getContentText
185 public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
186 $this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
188 $content = new WikitextContent( "hello world" );
190 $text = ContentHandler
::getContentText( $content );
191 $this->assertEquals( $content->getNativeData(), $text );
195 * ContentHandler::getContentText should have thrown an exception for non-text Content object
196 * @expectedException MWException
197 * @covers ContentHandler::getContentText
199 public function testGetContentText_NonTextContent_fail() {
200 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
202 $content = new DummyContentForTesting( "hello world" );
204 ContentHandler
::getContentText( $content );
208 * @covers ContentHandler::getContentText
210 public function testGetContentText_NonTextContent_serialize() {
211 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
213 $content = new DummyContentForTesting( "hello world" );
215 $text = ContentHandler
::getContentText( $content );
216 $this->assertEquals( $content->serialize(), $text );
220 * @covers ContentHandler::getContentText
222 public function testGetContentText_NonTextContent_ignore() {
223 $this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
225 $content = new DummyContentForTesting( "hello world" );
227 $text = ContentHandler
::getContentText( $content );
228 $this->assertNull( $text );
232 public static function makeContent( $text, Title $title, $modelId = null, $format = null ) {}
235 public static function dataMakeContent() {
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 ),
241 array( 'hallo', 'Help:Test', null, CONTENT_FORMAT_WIKITEXT
, CONTENT_MODEL_WIKITEXT
, 'hallo', false ),
242 array( 'hallo', 'MediaWiki:Test.js', null, CONTENT_FORMAT_JAVASCRIPT
, CONTENT_MODEL_JAVASCRIPT
, 'hallo', false ),
243 array( serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", 'hallo', false ),
245 array( 'hallo', 'Help:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
246 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
247 array( serialize( 'hallo' ), 'Dummy:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, serialize( 'hallo' ), false ),
249 array( 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT
, "testing", null, null, true ),
250 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, "testing", null, null, true ),
251 array( 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT
, "testing", null, null, true ),
256 * @dataProvider dataMakeContent
257 * @covers ContentHandler::makeContent
259 public function testMakeContent( $data, $title, $modelId, $format, $expectedModelId, $expectedNativeData, $shouldFail ) {
260 $title = Title
::newFromText( $title );
263 $content = ContentHandler
::makeContent( $data, $title, $modelId, $format );
266 $this->fail( "ContentHandler::makeContent should have failed!" );
269 $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
270 $this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
271 } catch ( MWException
$ex ) {
272 if ( !$shouldFail ) {
273 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
275 // dummy, so we don't get the "test did not perform any assertions" message.
276 $this->assertTrue( true );
282 public function testSupportsSections() {
283 $this->markTestIncomplete( "not yet implemented" );
288 * @covers ContentHandler::runLegacyHooks
290 public function testRunLegacyHooks() {
291 Hooks
::register( 'testRunLegacyHooks', __CLASS__
. '::dummyHookHandler' );
293 $content = new WikitextContent( 'test text' );
294 $ok = ContentHandler
::runLegacyHooks( 'testRunLegacyHooks', array( 'foo', &$content, 'bar' ), false );
296 $this->assertTrue( $ok, "runLegacyHooks should have returned true" );
297 $this->assertEquals( "TEST TEXT", $content->getNativeData() );
300 public static function dummyHookHandler( $foo, &$text, $bar ) {
301 if ( $text === null ||
$text === false ) {
305 $text = strtoupper( $text );
311 class DummyContentHandlerForTesting
extends ContentHandler
{
313 public function __construct( $dataModel ) {
314 parent
::__construct( $dataModel, array( "testing" ) );
318 * Serializes Content object of the type supported by this ContentHandler.
320 * @param Content $content the Content object to serialize
321 * @param null $format the desired serialization format
322 * @return String serialized form of the content
324 public function serializeContent( Content
$content, $format = null ) {
325 return $content->serialize();
329 * Unserializes a Content object of the type supported by this ContentHandler.
331 * @param $blob String serialized form of the content
332 * @param null $format the format used for serialization
333 * @return Content the Content object created by deserializing $blob
335 public function unserializeContent( $blob, $format = null ) {
336 $d = unserialize( $blob );
338 return new DummyContentForTesting( $d );
342 * Creates an empty Content object of the type supported by this ContentHandler.
345 public function makeEmptyContent() {
346 return new DummyContentForTesting( '' );
350 class DummyContentForTesting
extends AbstractContent
{
352 public function __construct( $data ) {
353 parent
::__construct( "testing" );
358 public function serialize( $format = null ) {
359 return serialize( $this->data
);
363 * @return String a string representing the content in a way useful for building a full text search index.
364 * If no useful representation exists, this method returns an empty string.
366 public function getTextForSearchIndex() {
371 * @return String the wikitext to include when another page includes this content, or false if the content is not
372 * includable in a wikitext page.
374 public function getWikitextForTransclusion() {
379 * Returns a textual representation of the content suitable for use in edit summaries and log messages.
381 * @param int $maxlength Maximum length of the summary text.
382 * @return string The summary text.
384 public function getTextForSummary( $maxlength = 250 ) {
389 * Returns native represenation of the data. Interpretation depends on the data model used,
390 * as given by getDataModel().
392 * @return mixed the native representation of the content. Could be a string, a nested array
393 * structure, an object, a binary blob... anything, really.
395 public function getNativeData() {
400 * returns the content's nominal size in bogo-bytes.
404 public function getSize() {
405 return strlen( $this->data
);
409 * Return a copy of this Content object. The following must be true for the object returned
410 * if $copy = $original->copy()
412 * * get_class($original) === get_class($copy)
413 * * $original->getModel() === $copy->getModel()
414 * * $original->equals( $copy )
416 * If and only if the Content object is imutable, the copy() method can and should
417 * return $this. That is, $copy === $original may be true, but only for imutable content
420 * @return Content. A copy of this object.
422 public function copy() {
427 * Returns true if this content is countable as a "real" wiki page, provided
428 * that it's also in a countable location (e.g. a current revision in the main namespace).
430 * @param boolean $hasLinks if it is known whether this content contains links, provide this information here,
431 * to avoid redundant parsing to find out.
434 public function isCountable( $hasLinks = null ) {
439 * @param Title $title
441 * @param null|ParserOptions $options
442 * @param boolean $generateHtml whether to generate Html (default: true). If false,
443 * the result of calling getText() on the ParserOutput object returned by
444 * this method is undefined.
446 * @return ParserOutput
448 public function getParserOutput( Title
$title, $revId = null, ParserOptions
$options = null, $generateHtml = true ) {
449 return new ParserOutput( $this->getNativeData() );