Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Revision::getContent must return clone if mutable

Browse source 
Revision::getContent must return a cloned instance of the Content object
if the Content object is mutable to avoid confusion.

Content::copy is used to achieve this, which is specified to return $this
for immutable Content.

Change-Id: Iace17b6ae8aa85a3500624441b69bc067c1ade00
This commit is contained in:
daniel 2012-08-21 12:48:29 +02:00
parent 0139923580
commit 266b66c899
3 changed files with 84 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
includes/AutoLoader.php
View file

@ -293,6 +293,7 @@ $wgAutoloadLocalClasses = array(
'AbstractContent' => 'includes/Content.php',
'ContentHandler' => 'includes/ContentHandler.php',
'CssContent' => 'includes/Content.php',
'TextContentHandler' => 'includes/ContentHandler.php',
'CssContentHandler' => 'includes/ContentHandler.php',
'JavaScriptContent' => 'includes/Content.php',
'JavaScriptContentHandler' => 'includes/ContentHandler.php',

2
includes/Revision.php
View file

@ -970,7 +970,7 @@ class Revision implements IDBAccessObject {
$this->mContent = is_null( $this->mText ) ? null : $handler->unserializeContent( $this->mText, $format );
}
return $this->mContent;
return $this->mContent->copy(); // NOTE: copy() will return $this for immutable content objects
}
/**

82
tests/phpunit/includes/RevisionTest.php
View file

@ -31,6 +31,7 @@ class RevisionTest extends MediaWikiTestCase {
$wgNamespaceContentModels[ 12312 ] = "testing";
$wgContentHandlers[ "testing" ] = 'DummyContentHandlerForTesting';
$wgContentHandlers[ "RevisionTestModifyableContent" ] = 'RevisionTestModifyableContentHandler';
MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
$wgContLang->resetNamespaces(); # reset namespace cache
@ -346,6 +347,87 @@ class RevisionTest extends MediaWikiTestCase {
$this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
}
/**
* Tests whether $rev->getContent() returns a clone when needed.
*
* @group Database
*/
function testGetContentClone( ) {
$content = new RevisionTestModifyableContent( "foo" );
$rev = new Revision(
array(
'id' => 42,
'page' => 23,
'title' => Title::newFromText( "testGetContentClone_dummy" ),
'content' => $content,
'length' => $content->getSize(),
'comment' => "testing",
'minor_edit' => false,
)
);
$content = $rev->getContent( Revision::RAW );
$content->setText( "bar" );
$content2 = $rev->getContent( Revision::RAW );
$this->assertNotSame( $content, $content2, "expected a clone" ); // content is mutable, expect clone
$this->assertEquals( "foo", $content2->getText() ); // clone should contain the original text
$content2->setText( "bla bla" );
$this->assertEquals( "bar", $content->getText() ); // clones should be independent
}
/**
* Tests whether $rev->getContent() returns the same object repeatedly if appropriate.
*
* @group Database
*/
function testGetContentUncloned() {
$rev = $this->newTestRevision( "hello", "testGetContentUncloned_dummy", CONTENT_MODEL_WIKITEXT );
$content = $rev->getContent( Revision::RAW );
$content2 = $rev->getContent( Revision::RAW );
// for immutable content like wikitext, this should be the same object
$this->assertSame( $content, $content2 );
}
}
class RevisionTestModifyableContent extends TextContent {
public function __construct( $text ) {
parent::__construct( $text, "RevisionTestModifyableContent" );
}
public function copy( ) {
return new RevisionTestModifyableContent( $this->mText );
}
public function getText() {
return $this->mText;
}
public function setText( $text ) {
$this->mText = $text;
}
}
class RevisionTestModifyableContentHandler extends TextContentHandler {
public function __construct( ) {
parent::__construct( "RevisionTestModifyableContent", array( CONTENT_FORMAT_TEXT ) );
}
public function unserializeContent( $text, $format = null ) {
$this->checkFormat( $format );
return new RevisionTestModifyableContent( $text );
}
public function makeEmptyContent() {
return new RevisionTestModifyableContent( '' );
}
}