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
74 public function testGetDefaultModelFor( $title, $expectedModelId ) {
75 $title = Title
::newFromText( $title );
76 $this->assertEquals( $expectedModelId, ContentHandler
::getDefaultModelFor( $title ) );
80 * @dataProvider dataGetDefaultModelFor
82 public function testGetForTitle( $title, $expectedContentModel ) {
83 $title = Title
::newFromText( $title );
84 $handler = ContentHandler
::getForTitle( $title );
85 $this->assertEquals( $expectedContentModel, $handler->getModelID() );
88 public static function dataGetLocalizedName() {
91 array( "xyzzy", null ),
93 // XXX: depends on content language
94 array( CONTENT_MODEL_JAVASCRIPT
, '/javascript/i' ),
99 * @dataProvider dataGetLocalizedName
101 public function testGetLocalizedName( $id, $expected ) {
102 $name = ContentHandler
::getLocalizedName( $id );
105 $this->assertNotNull( $name, "no name found for content model $id" );
106 $this->assertTrue( preg_match( $expected, $name ) > 0,
107 "content model name for #$id did not match pattern $expected"
110 $this->assertEquals( $id, $name, "localization of unknown model $id should have "
111 . "fallen back to use the model id directly."
116 public static function dataGetPageLanguage() {
117 global $wgLanguageCode;
120 array( "Main", $wgLanguageCode ),
121 array( "Dummy:Foo", $wgLanguageCode ),
122 array( "MediaWiki:common.js", 'en' ),
123 array( "User:Foo/common.js", 'en' ),
124 array( "MediaWiki:common.css", 'en' ),
125 array( "User:Foo/common.css", 'en' ),
126 array( "User:Foo", $wgLanguageCode ),
128 array( CONTENT_MODEL_JAVASCRIPT
, 'javascript' ),
133 * @dataProvider dataGetPageLanguage
135 public function testGetPageLanguage( $title, $expected ) {
136 if ( is_string( $title ) ) {
137 $title = Title
::newFromText( $title );
140 $expected = wfGetLangObj( $expected );
142 $handler = ContentHandler
::getForTitle( $title );
143 $lang = $handler->getPageLanguage( $title );
145 $this->assertEquals( $expected->getCode(), $lang->getCode() );
148 public function testGetContentText_Null() {
149 global $wgContentHandlerTextFallback;
153 $wgContentHandlerTextFallback = 'fail';
154 $text = ContentHandler
::getContentText( $content );
155 $this->assertEquals( '', $text );
157 $wgContentHandlerTextFallback = 'serialize';
158 $text = ContentHandler
::getContentText( $content );
159 $this->assertEquals( '', $text );
161 $wgContentHandlerTextFallback = 'ignore';
162 $text = ContentHandler
::getContentText( $content );
163 $this->assertEquals( '', $text );
166 public function testGetContentText_TextContent() {
167 global $wgContentHandlerTextFallback;
169 $content = new WikitextContent( "hello world" );
171 $wgContentHandlerTextFallback = 'fail';
172 $text = ContentHandler
::getContentText( $content );
173 $this->assertEquals( $content->getNativeData(), $text );
175 $wgContentHandlerTextFallback = 'serialize';
176 $text = ContentHandler
::getContentText( $content );
177 $this->assertEquals( $content->serialize(), $text );
179 $wgContentHandlerTextFallback = 'ignore';
180 $text = ContentHandler
::getContentText( $content );
181 $this->assertEquals( $content->getNativeData(), $text );
184 public function testGetContentText_NonTextContent() {
185 global $wgContentHandlerTextFallback;
187 $content = new DummyContentForTesting( "hello world" );
189 $wgContentHandlerTextFallback = 'fail';
192 $text = ContentHandler
::getContentText( $content );
194 $this->fail( "ContentHandler::getContentText should have thrown an exception for non-text Content object" );
195 } catch ( MWException
$ex ) {
199 $wgContentHandlerTextFallback = 'serialize';
200 $text = ContentHandler
::getContentText( $content );
201 $this->assertEquals( $content->serialize(), $text );
203 $wgContentHandlerTextFallback = 'ignore';
204 $text = ContentHandler
::getContentText( $content );
205 $this->assertNull( $text );
209 public static function makeContent( $text, Title $title, $modelId = null, $format = null ) {}
212 public static function dataMakeContent() {
214 array( 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT
, 'hallo', false ),
215 array( 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT
, 'hallo', false ),
216 array( serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", 'hallo', false ),
218 array( 'hallo', 'Help:Test', null, CONTENT_FORMAT_WIKITEXT
, CONTENT_MODEL_WIKITEXT
, 'hallo', false ),
219 array( 'hallo', 'MediaWiki:Test.js', null, CONTENT_FORMAT_JAVASCRIPT
, CONTENT_MODEL_JAVASCRIPT
, 'hallo', false ),
220 array( serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", 'hallo', false ),
222 array( 'hallo', 'Help:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
223 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, 'hallo', false ),
224 array( serialize( 'hallo' ), 'Dummy:Test', CONTENT_MODEL_CSS
, null, CONTENT_MODEL_CSS
, serialize( 'hallo' ), false ),
226 array( 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT
, "testing", null, null, true ),
227 array( 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS
, "testing", null, null, true ),
228 array( 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT
, "testing", null, null, true ),
233 * @dataProvider dataMakeContent
235 public function testMakeContent( $data, $title, $modelId, $format, $expectedModelId, $expectedNativeData, $shouldFail ) {
236 $title = Title
::newFromText( $title );
239 $content = ContentHandler
::makeContent( $data, $title, $modelId, $format );
242 $this->fail( "ContentHandler::makeContent should have failed!" );
245 $this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
246 $this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
247 } catch ( MWException
$ex ) {
248 if ( !$shouldFail ) {
249 $this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
252 // dummy, so we don't get the "test did not perform any assertions" message.
253 $this->assertTrue( true );
259 public function testSupportsSections() {
260 $this->markTestIncomplete( "not yet implemented" );
264 public function testRunLegacyHooks() {
265 Hooks
::register( 'testRunLegacyHooks', __CLASS__
. '::dummyHookHandler' );
267 $content = new WikitextContent( 'test text' );
268 $ok = ContentHandler
::runLegacyHooks( 'testRunLegacyHooks', array( 'foo', &$content, 'bar' ), false );
270 $this->assertTrue( $ok, "runLegacyHooks should have returned true" );
271 $this->assertEquals( "TEST TEXT", $content->getNativeData() );
274 public static function dummyHookHandler( $foo, &$text, $bar ) {
275 if ( $text === null ||
$text === false ) {
279 $text = strtoupper( $text );
285 class DummyContentHandlerForTesting
extends ContentHandler
{
287 public function __construct( $dataModel ) {
288 parent
::__construct( $dataModel, array( "testing" ) );
292 * Serializes Content object of the type supported by this ContentHandler.
294 * @param Content $content the Content object to serialize
295 * @param null $format the desired serialization format
296 * @return String serialized form of the content
298 public function serializeContent( Content
$content, $format = null ) {
299 return $content->serialize();
303 * Unserializes a Content object of the type supported by this ContentHandler.
305 * @param $blob String serialized form of the content
306 * @param null $format the format used for serialization
307 * @return Content the Content object created by deserializing $blob
309 public function unserializeContent( $blob, $format = null ) {
310 $d = unserialize( $blob );
311 return new DummyContentForTesting( $d );
315 * Creates an empty Content object of the type supported by this ContentHandler.
318 public function makeEmptyContent() {
319 return new DummyContentForTesting( '' );
323 class DummyContentForTesting
extends AbstractContent
{
325 public function __construct( $data ) {
326 parent
::__construct( "testing" );
331 public function serialize( $format = null ) {
332 return serialize( $this->data
);
336 * @return String a string representing the content in a way useful for building a full text search index.
337 * If no useful representation exists, this method returns an empty string.
339 public function getTextForSearchIndex() {
344 * @return String the wikitext to include when another page includes this content, or false if the content is not
345 * includable in a wikitext page.
347 public function getWikitextForTransclusion() {
352 * Returns a textual representation of the content suitable for use in edit summaries and log messages.
354 * @param int $maxlength Maximum length of the summary text.
355 * @return string The summary text.
357 public function getTextForSummary( $maxlength = 250 ) {
362 * Returns native represenation of the data. Interpretation depends on the data model used,
363 * as given by getDataModel().
365 * @return mixed the native representation of the content. Could be a string, a nested array
366 * structure, an object, a binary blob... anything, really.
368 public function getNativeData() {
373 * returns the content's nominal size in bogo-bytes.
377 public function getSize() {
378 return strlen( $this->data
);
382 * Return a copy of this Content object. The following must be true for the object returned
383 * if $copy = $original->copy()
385 * * get_class($original) === get_class($copy)
386 * * $original->getModel() === $copy->getModel()
387 * * $original->equals( $copy )
389 * If and only if the Content object is imutable, the copy() method can and should
390 * return $this. That is, $copy === $original may be true, but only for imutable content
393 * @return Content. A copy of this object.
395 public function copy() {
400 * Returns true if this content is countable as a "real" wiki page, provided
401 * that it's also in a countable location (e.g. a current revision in the main namespace).
403 * @param boolean $hasLinks if it is known whether this content contains links, provide this information here,
404 * to avoid redundant parsing to find out.
407 public function isCountable( $hasLinks = null ) {
412 * @param Title $title
414 * @param null|ParserOptions $options
415 * @param boolean $generateHtml whether to generate Html (default: true). If false,
416 * the result of calling getText() on the ParserOutput object returned by
417 * this method is undefined.
419 * @return ParserOutput
421 public function getParserOutput( Title
$title, $revId = null, ParserOptions
$options = null, $generateHtml = true ) {
422 return new ParserOutput( $this->getNativeData() );