4 * @group ContentHandler
6 * @note: Declare that we are using the database, because otherwise we'll fail in the "databaseless" test run.
7 * This is because the LinkHolderArray used by the parser needs database access.
11 class ContentHandlerTest
extends MediaWikiTestCase
{
13 public function setUp() {
14 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
16 $wgExtraNamespaces[ 12312 ] = 'Dummy';
17 $wgExtraNamespaces[ 12313 ] = 'Dummy_talk';
19 $wgNamespaceContentModels[ 12312 ] = "testing";
20 $wgContentHandlers[ "testing" ] = 'DummyContentHandlerForTesting';
22 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
23 $wgContLang->resetNamespaces(); # reset namespace cache
26 public function tearDown() {
27 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
29 unset( $wgExtraNamespaces[ 12312 ] );
30 unset( $wgExtraNamespaces[ 12313 ] );
32 unset( $wgNamespaceContentModels[ 12312 ] );
33 unset( $wgContentHandlers[ "testing" ] );
35 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
36 $wgContLang->resetNamespaces(); # reset namespace cache
39 public function dataGetDefaultModelFor() {
41 array( 'Foo', CONTENT_MODEL_WIKITEXT
),
42 array( 'Foo.js', CONTENT_MODEL_WIKITEXT
),
43 array( 'Foo/bar.js', CONTENT_MODEL_WIKITEXT
),
44 array( 'User:Foo', CONTENT_MODEL_WIKITEXT
),
45 array( 'User:Foo.js', CONTENT_MODEL_WIKITEXT
),
46 array( 'User:Foo/bar.js', CONTENT_MODEL_JAVASCRIPT
),
47 array( 'User:Foo/bar.css', CONTENT_MODEL_CSS
),
48 array( 'User talk:Foo/bar.css', CONTENT_MODEL_WIKITEXT
),
49 array( 'User:Foo/bar.js.xxx', CONTENT_MODEL_WIKITEXT
),
50 array( 'User:Foo/bar.xxx', CONTENT_MODEL_WIKITEXT
),
51 array( 'MediaWiki:Foo.js', CONTENT_MODEL_JAVASCRIPT
),
52 array( 'MediaWiki:Foo.css', CONTENT_MODEL_CSS
),
53 array( 'MediaWiki:Foo.JS', CONTENT_MODEL_WIKITEXT
),
54 array( 'MediaWiki:Foo.CSS', CONTENT_MODEL_WIKITEXT
),
55 array( 'MediaWiki:Foo.css.xxx', CONTENT_MODEL_WIKITEXT
),
60 * @dataProvider dataGetDefaultModelFor
62 public function testGetDefaultModelFor( $title, $expectedModelId ) {
63 $title = Title
::newFromText( $title );
64 $this->assertEquals( $expectedModelId, ContentHandler
::getDefaultModelFor( $title ) );
67 * @dataProvider dataGetDefaultModelFor
69 public function testGetForTitle( $title, $expectedContentModel ) {
70 $title = Title
::newFromText( $title );
71 $handler = ContentHandler
::getForTitle( $title );
72 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
75 public function dataGetLocalizedName() {
78 array( "xyzzy", null ),
80 array( CONTENT_MODEL_JAVASCRIPT
, '/javascript/i' ), //XXX: depends on content language
85 * @dataProvider dataGetLocalizedName
87 public function testGetLocalizedName( $id, $expected ) {
88 $name = ContentHandler
::getLocalizedName( $id );
91 $this->assertNotNull( $name, "no name found for content model $id" );
92 $this->assertTrue( preg_match( $expected, $name ) > 0 ,
93 "content model name for #$id did not match pattern $expected" );
95 $this->assertEquals( $id, $name, "localization of unknown model $id should have "
96 . "fallen back to use the model id directly." );
100 public function dataGetPageLanguage() {
101 global $wgLanguageCode;
104 array( "Main", $wgLanguageCode ),
105 array( "Dummy:Foo", $wgLanguageCode ),
106 array( "MediaWiki:common.js", 'en' ),
107 array( "User:Foo/common.js", 'en' ),
108 array( "MediaWiki:common.css", 'en' ),
109 array( "User:Foo/common.css", 'en' ),
110 array( "User:Foo", $wgLanguageCode ),
112 array( CONTENT_MODEL_JAVASCRIPT
, 'javascript' ),
117 * @dataProvider dataGetPageLanguage
119 public function testGetPageLanguage( $title, $expected ) {
120 if ( is_string( $title ) ) {
121 $title = Title
::newFromText( $title );
124 $expected = wfGetLangObj( $expected );
126 $handler = ContentHandler
::getForTitle( $title );
127 $lang = $handler->getPageLanguage( $title );
129 $this->assertEquals( $expected->getCode(), $lang->getCode() );
132 public function testGetContentText_Null( ) {
133 global $wgContentHandlerTextFallback;
137 $wgContentHandlerTextFallback = 'fail';
138 $text = ContentHandler
::getContentText( $content );
139 $this->assertEquals( '', $text );
141 $wgContentHandlerTextFallback = 'serialize';
142 $text = ContentHandler
::getContentText( $content );
143 $this->assertEquals( '', $text );
145 $wgContentHandlerTextFallback = 'ignore';
146 $text = ContentHandler
::getContentText( $content );
147 $this->assertEquals( '', $text );
150 public function testGetContentText_TextContent( ) {
151 global $wgContentHandlerTextFallback;
153 $content = new WikitextContent( "hello world" );
155 $wgContentHandlerTextFallback = 'fail';
156 $text = ContentHandler
::getContentText( $content );
157 $this->assertEquals( $content->getNativeData(), $text );
159 $wgContentHandlerTextFallback = 'serialize';
160 $text = ContentHandler
::getContentText( $content );
161 $this->assertEquals( $content->serialize(), $text );
163 $wgContentHandlerTextFallback = 'ignore';
164 $text = ContentHandler
::getContentText( $content );
165 $this->assertEquals( $content->getNativeData(), $text );
168 public function testGetContentText_NonTextContent( ) {
169 global $wgContentHandlerTextFallback;
171 $content = new DummyContentForTesting( "hello world" );
173 $wgContentHandlerTextFallback = 'fail';
176 $text = ContentHandler
::getContentText( $content );
178 $this->fail( "ContentHandler::getContentText should have thrown an exception for non-text Content object" );
179 } catch (MWException
$ex) {
183 $wgContentHandlerTextFallback = 'serialize';
184 $text = ContentHandler
::getContentText( $content );
185 $this->assertEquals( $content->serialize(), $text );
187 $wgContentHandlerTextFallback = 'ignore';
188 $text = ContentHandler
::getContentText( $content );
189 $this->assertNull( $text );
192 #public static function makeContent( $text, Title $title, $modelId = null, $format = null )
194 public function dataMakeContent() {
196 array( 'hallo', 'Test', null, null, CONTENT_MODEL_WIKITEXT
, 'hallo', false ),
197 array( 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT
, 'hallo', false ),
198 array( serialize('hallo'), 'Dummy:Test', null, null, "testing", 'hallo', false ),
200 array( 'hallo', 'Test', null, CONTENT_FORMAT_WIKITEXT
, CONTENT_MODEL_WIKITEXT
, 'hallo', false ),
201 array( 'hallo', 'MediaWiki:Test.js', null, CONTENT_FORMAT_JAVASCRIPT
, CONTENT_MODEL_JAVASCRIPT
, 'hallo', false ),
202 array( serialize('hallo'), 'Dummy:Test', null, "testing", "testing", 'hallo', false ),
204 array( 'hallo', 'Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
205 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
206 array( serialize('hallo'), 'Dummy:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, serialize('hallo'), false ),
208 array( 'hallo', 'Test', CONTENT_MODEL_WIKITEXT
, "testing", null, null, true ),
209 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, "testing", null, null, true ),
210 array( 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT
, "testing", null, null, true ),
215 * @dataProvider dataMakeContent
217 public function testMakeContent( $data, $title, $modelId, $format, $expectedModelId, $expectedNativeData, $shouldFail ) {
218 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers;
220 $title = Title
::newFromText( $title );
223 $content = ContentHandler
::makeContent( $data, $title, $modelId, $format );
225 if ( $shouldFail ) $this->fail( "ContentHandler::makeContent should have failed!" );
227 $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
228 $this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
229 } catch ( MWException
$ex ) {
230 if ( !$shouldFail ) $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
231 else $this->assertTrue( true ); // dummy, so we don't get the "test did not perform any assertions" message.
236 public function testSupportsSections() {
237 $this->markTestIncomplete( "not yet implemented" );
240 public function testRunLegacyHooks() {
241 Hooks
::register( 'testRunLegacyHooks', __CLASS__
. '::dummyHookHandler' );
243 $content = new WikitextContent( 'test text' );
244 $ok = ContentHandler
::runLegacyHooks( 'testRunLegacyHooks', array( 'foo', &$content, 'bar' ) );
246 $this->assertTrue( $ok, "runLegacyHooks should have returned true" );
247 $this->assertEquals( "TEST TEXT", $content->getNativeData() );
250 public static function dummyHookHandler( $foo, &$text, $bar ) {
251 if ( $text === null ||
$text === false ) {
255 $text = strtoupper( $text );
261 class DummyContentHandlerForTesting
extends ContentHandler
{
263 public function __construct( $dataModel ) {
264 parent
::__construct( $dataModel, array( "testing" ) );
268 * Serializes Content object of the type supported by this ContentHandler.
270 * @param Content $content the Content object to serialize
271 * @param null $format the desired serialization format
272 * @return String serialized form of the content
274 public function serializeContent( Content
$content, $format = null )
276 return $content->serialize();
280 * Unserializes a Content object of the type supported by this ContentHandler.
282 * @param $blob String serialized form of the content
283 * @param null $format the format used for serialization
284 * @return Content the Content object created by deserializing $blob
286 public function unserializeContent( $blob, $format = null )
288 $d = unserialize( $blob );
289 return new DummyContentForTesting( $d );
293 * Creates an empty Content object of the type supported by this ContentHandler.
296 public function makeEmptyContent()
298 return new DummyContentForTesting( '' );
302 class DummyContentForTesting
extends AbstractContent
{
304 public function __construct( $data ) {
305 parent
::__construct( "testing" );
310 public function serialize( $format = null ) {
311 return serialize( $this->data
);
315 * @return String a string representing the content in a way useful for building a full text search index.
316 * If no useful representation exists, this method returns an empty string.
318 public function getTextForSearchIndex()
324 * @return String the wikitext to include when another page includes this content, or false if the content is not
325 * includable in a wikitext page.
327 public function getWikitextForTransclusion()
333 * Returns a textual representation of the content suitable for use in edit summaries and log messages.
335 * @param int $maxlength maximum length of the summary text
336 * @return String the summary text
338 public function getTextForSummary( $maxlength = 250 )
344 * Returns native represenation of the data. Interpretation depends on the data model used,
345 * as given by getDataModel().
347 * @return mixed the native representation of the content. Could be a string, a nested array
348 * structure, an object, a binary blob... anything, really.
350 public function getNativeData()
356 * returns the content's nominal size in bogo-bytes.
360 public function getSize()
362 return strlen( $this->data
);
366 * Return a copy of this Content object. The following must be true for the object returned
367 * if $copy = $original->copy()
369 * * get_class($original) === get_class($copy)
370 * * $original->getModel() === $copy->getModel()
371 * * $original->equals( $copy )
373 * If and only if the Content object is imutable, the copy() method can and should
374 * return $this. That is, $copy === $original may be true, but only for imutable content
377 * @return Content. A copy of this object
379 public function copy()
385 * Returns true if this content is countable as a "real" wiki page, provided
386 * that it's also in a countable location (e.g. a current revision in the main namespace).
388 * @param $hasLinks Bool: if it is known whether this content contains links, provide this information here,
389 * to avoid redundant parsing to find out.
392 public function isCountable( $hasLinks = null )
398 * @param Title $title
400 * @param null|ParserOptions $options
401 * @param Boolean $generateHtml whether to generate Html (default: true). If false,
402 * the result of calling getText() on the ParserOutput object returned by
403 * this method is undefined.
405 * @return ParserOutput
407 public function getParserOutput( Title
$title, $revId = null, ParserOptions
$options = NULL, $generateHtml = true )
409 return new ParserOutput( $this->getNativeData() );