3 namespace MediaWiki\Tests\Revision
;
5 use CommentStoreComment
;
9 use MediaWiki\Revision\RevisionRenderer
;
10 use MediaWiki\Storage\MutableRevisionRecord
;
11 use MediaWiki\Storage\RevisionRecord
;
12 use MediaWiki\User\UserIdentityValue
;
13 use MediaWikiTestCase
;
16 use PHPUnit\Framework\MockObject\MockObject
;
19 use Wikimedia\Rdbms\IDatabase
;
20 use Wikimedia\Rdbms\ILoadBalancer
;
24 * @covers \MediaWiki\Revision\RevisionRenderer
26 class RevisionRendererTest
extends MediaWikiTestCase
{
33 private function getMockTitle( $articleId, $revisionId ) {
34 /** @var Title|MockObject $mock */
35 $mock = $this->getMockBuilder( Title
::class )
36 ->disableOriginalConstructor()
38 $mock->expects( $this->any() )
39 ->method( 'getNamespace' )
40 ->will( $this->returnValue( NS_MAIN
) );
41 $mock->expects( $this->any() )
43 ->will( $this->returnValue( __CLASS__
) );
44 $mock->expects( $this->any() )
45 ->method( 'getPrefixedText' )
46 ->will( $this->returnValue( __CLASS__
) );
47 $mock->expects( $this->any() )
48 ->method( 'getDBkey' )
49 ->will( $this->returnValue( __CLASS__
) );
50 $mock->expects( $this->any() )
51 ->method( 'getArticleID' )
52 ->will( $this->returnValue( $articleId ) );
53 $mock->expects( $this->any() )
54 ->method( 'getLatestRevId' )
55 ->will( $this->returnValue( $revisionId ) );
56 $mock->expects( $this->any() )
57 ->method( 'getContentModel' )
58 ->will( $this->returnValue( CONTENT_MODEL_WIKITEXT
) );
59 $mock->expects( $this->any() )
60 ->method( 'getPageLanguage' )
61 ->will( $this->returnValue( Language
::factory( 'en' ) ) );
62 $mock->expects( $this->any() )
63 ->method( 'isContentPage' )
64 ->will( $this->returnValue( true ) );
65 $mock->expects( $this->any() )
68 function ( Title
$other ) use ( $mock ) {
69 return $mock->getArticleID() === $other->getArticleID();
72 $mock->expects( $this->any() )
75 function ( $perm, User
$user ) use ( $mock ) {
76 return $user->isAllowed( $perm );
85 * @param int $linkCount
89 private function getMockDatabaseConnection( $maxRev = 100, $linkCount = 0 ) {
90 /** @var IDatabase|MockObject $db */
91 $db = $this->getMock( IDatabase
::class );
92 $db->method( 'selectField' )
94 function ( $table, $fields, $cond ) use ( $maxRev, $linkCount ) {
95 return $this->selectFieldCallback(
109 * @return RevisionRenderer
111 private function newRevisionRenderer( $maxRev = 100, $useMaster = false ) {
112 $dbIndex = $useMaster ? DB_MASTER
: DB_REPLICA
;
114 $db = $this->getMockDatabaseConnection( $maxRev );
116 /** @var ILoadBalancer|MockObject $lb */
117 $lb = $this->getMock( ILoadBalancer
::class );
118 $lb->method( 'getConnection' )
121 $lb->method( 'getConnectionRef' )
124 $lb->method( 'getLazyConnectionRef' )
128 return new RevisionRenderer( $lb );
131 private function selectFieldCallback( $table, $fields, $cond, $maxRev ) {
132 if ( [ $table, $fields, $cond ] === [ 'revision', 'MAX(rev_id)', [] ] ) {
136 $this->fail( 'Unexpected call to selectField' );
137 throw new LogicException( 'Ooops' ); // Can't happen, make analyzer happy
140 public function testGetRenderedRevision_new() {
141 $renderer = $this->newRevisionRenderer( 100 );
142 $title = $this->getMockTitle( 7, 21 );
144 $rev = new MutableRevisionRecord( $title );
145 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
146 $rev->setTimestamp( '20180101000003' );
147 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
150 $text .= "* page:{{PAGENAME}}\n";
151 $text .= "* rev:{{REVISIONID}}\n";
152 $text .= "* user:{{REVISIONUSER}}\n";
153 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
154 $text .= "* [[Link It]]\n";
156 $rev->setContent( 'main', new WikitextContent( $text ) );
158 $options = ParserOptions
::newCanonical( 'canonical' );
159 $rr = $renderer->getRenderedRevision( $rev, $options );
161 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
163 $this->assertSame( $rev, $rr->getRevision() );
164 $this->assertSame( $options, $rr->getOptions() );
166 $html = $rr->getRevisionParserOutput()->getText();
168 $this->assertContains( 'page:' . __CLASS__
, $html );
169 $this->assertContains( 'rev:101', $html ); // from speculativeRevIdCallback
170 $this->assertContains( 'user:Frank', $html );
171 $this->assertContains( 'time:20180101000003', $html );
173 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
176 public function testGetRenderedRevision_current() {
177 $renderer = $this->newRevisionRenderer( 100 );
178 $title = $this->getMockTitle( 7, 21 );
180 $rev = new MutableRevisionRecord( $title );
181 $rev->setId( 21 ); // current!
182 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
183 $rev->setTimestamp( '20180101000003' );
184 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
187 $text .= "* page:{{PAGENAME}}\n";
188 $text .= "* rev:{{REVISIONID}}\n";
189 $text .= "* user:{{REVISIONUSER}}\n";
190 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
192 $rev->setContent( 'main', new WikitextContent( $text ) );
194 $options = ParserOptions
::newCanonical( 'canonical' );
195 $rr = $renderer->getRenderedRevision( $rev, $options );
197 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
199 $this->assertSame( $rev, $rr->getRevision() );
200 $this->assertSame( $options, $rr->getOptions() );
202 $html = $rr->getRevisionParserOutput()->getText();
204 $this->assertContains( 'page:' . __CLASS__
, $html );
205 $this->assertContains( 'rev:21', $html );
206 $this->assertContains( 'user:Frank', $html );
207 $this->assertContains( 'time:20180101000003', $html );
209 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
212 public function testGetRenderedRevision_master() {
213 $renderer = $this->newRevisionRenderer( 100, true ); // use master
214 $title = $this->getMockTitle( 7, 21 );
216 $rev = new MutableRevisionRecord( $title );
217 $rev->setId( 21 ); // current!
218 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
219 $rev->setTimestamp( '20180101000003' );
220 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
223 $text .= "* page:{{PAGENAME}}\n";
224 $text .= "* rev:{{REVISIONID}}\n";
225 $text .= "* user:{{REVISIONUSER}}\n";
226 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
228 $rev->setContent( 'main', new WikitextContent( $text ) );
230 $options = ParserOptions
::newCanonical( 'canonical' );
231 $rr = $renderer->getRenderedRevision( $rev, $options, null, [ 'use-master' => true ] );
233 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
235 $html = $rr->getRevisionParserOutput()->getText();
237 $this->assertContains( 'rev:21', $html );
239 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
242 public function testGetRenderedRevision_old() {
243 $renderer = $this->newRevisionRenderer( 100 );
244 $title = $this->getMockTitle( 7, 21 );
246 $rev = new MutableRevisionRecord( $title );
247 $rev->setId( 11 ); // old!
248 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
249 $rev->setTimestamp( '20180101000003' );
250 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
253 $text .= "* page:{{PAGENAME}}\n";
254 $text .= "* rev:{{REVISIONID}}\n";
255 $text .= "* user:{{REVISIONUSER}}\n";
256 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
258 $rev->setContent( 'main', new WikitextContent( $text ) );
260 $options = ParserOptions
::newCanonical( 'canonical' );
261 $rr = $renderer->getRenderedRevision( $rev, $options );
263 $this->assertFalse( $rr->isContentDeleted(), 'isContentDeleted' );
265 $this->assertSame( $rev, $rr->getRevision() );
266 $this->assertSame( $options, $rr->getOptions() );
268 $html = $rr->getRevisionParserOutput()->getText();
270 $this->assertContains( 'page:' . __CLASS__
, $html );
271 $this->assertContains( 'rev:11', $html );
272 $this->assertContains( 'user:Frank', $html );
273 $this->assertContains( 'time:20180101000003', $html );
275 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
278 public function testGetRenderedRevision_suppressed() {
279 $renderer = $this->newRevisionRenderer( 100 );
280 $title = $this->getMockTitle( 7, 21 );
282 $rev = new MutableRevisionRecord( $title );
283 $rev->setId( 11 ); // old!
284 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
285 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
286 $rev->setTimestamp( '20180101000003' );
287 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
290 $text .= "* page:{{PAGENAME}}\n";
291 $text .= "* rev:{{REVISIONID}}\n";
292 $text .= "* user:{{REVISIONUSER}}\n";
293 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
295 $rev->setContent( 'main', new WikitextContent( $text ) );
297 $options = ParserOptions
::newCanonical( 'canonical' );
298 $rr = $renderer->getRenderedRevision( $rev, $options );
300 $this->assertNull( $rr, 'getRenderedRevision' );
303 public function testGetRenderedRevision_privileged() {
304 $renderer = $this->newRevisionRenderer( 100 );
305 $title = $this->getMockTitle( 7, 21 );
307 $rev = new MutableRevisionRecord( $title );
308 $rev->setId( 11 ); // old!
309 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
310 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
311 $rev->setTimestamp( '20180101000003' );
312 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
315 $text .= "* page:{{PAGENAME}}\n";
316 $text .= "* rev:{{REVISIONID}}\n";
317 $text .= "* user:{{REVISIONUSER}}\n";
318 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
320 $rev->setContent( 'main', new WikitextContent( $text ) );
322 $options = ParserOptions
::newCanonical( 'canonical' );
323 $sysop = $this->getTestUser( [ 'sysop' ] )->getUser(); // privileged!
324 $rr = $renderer->getRenderedRevision( $rev, $options, $sysop );
326 $this->assertTrue( $rr->isContentDeleted(), 'isContentDeleted' );
328 $this->assertSame( $rev, $rr->getRevision() );
329 $this->assertSame( $options, $rr->getOptions() );
331 $html = $rr->getRevisionParserOutput()->getText();
333 // Suppressed content should be visible for sysops
334 $this->assertContains( 'page:' . __CLASS__
, $html );
335 $this->assertContains( 'rev:11', $html );
336 $this->assertContains( 'user:Frank', $html );
337 $this->assertContains( 'time:20180101000003', $html );
339 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
342 public function testGetRenderedRevision_raw() {
343 $renderer = $this->newRevisionRenderer( 100 );
344 $title = $this->getMockTitle( 7, 21 );
346 $rev = new MutableRevisionRecord( $title );
347 $rev->setId( 11 ); // old!
348 $rev->setVisibility( RevisionRecord
::DELETED_TEXT
); // suppressed!
349 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
350 $rev->setTimestamp( '20180101000003' );
351 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
354 $text .= "* page:{{PAGENAME}}\n";
355 $text .= "* rev:{{REVISIONID}}\n";
356 $text .= "* user:{{REVISIONUSER}}\n";
357 $text .= "* time:{{REVISIONTIMESTAMP}}\n";
359 $rev->setContent( 'main', new WikitextContent( $text ) );
361 $options = ParserOptions
::newCanonical( 'canonical' );
362 $rr = $renderer->getRenderedRevision(
366 [ 'audience' => RevisionRecord
::RAW
]
369 $this->assertTrue( $rr->isContentDeleted(), 'isContentDeleted' );
371 $this->assertSame( $rev, $rr->getRevision() );
372 $this->assertSame( $options, $rr->getOptions() );
374 $html = $rr->getRevisionParserOutput()->getText();
376 // Suppressed content should be visible in raw mode
377 $this->assertContains( 'page:' . __CLASS__
, $html );
378 $this->assertContains( 'rev:11', $html );
379 $this->assertContains( 'user:Frank', $html );
380 $this->assertContains( 'time:20180101000003', $html );
382 $this->assertSame( $html, $rr->getSlotParserOutput( 'main' )->getText() );
385 public function testGetRenderedRevision_multi() {
386 $renderer = $this->newRevisionRenderer();
387 $title = $this->getMockTitle( 7, 21 );
389 $rev = new MutableRevisionRecord( $title );
390 $rev->setUser( new UserIdentityValue( 9, 'Frank', 0 ) );
391 $rev->setTimestamp( '20180101000003' );
392 $rev->setComment( CommentStoreComment
::newUnsavedComment( '' ) );
394 $rev->setContent( 'main', new WikitextContent( '[[Kittens]]' ) );
395 $rev->setContent( 'aux', new WikitextContent( '[[Goats]]' ) );
397 $rr = $renderer->getRenderedRevision( $rev );
399 $combinedOutput = $rr->getRevisionParserOutput();
400 $mainOutput = $rr->getSlotParserOutput( 'main' );
401 $auxOutput = $rr->getSlotParserOutput( 'aux' );
403 $combinedHtml = $combinedOutput->getText();
404 $mainHtml = $mainOutput->getText();
405 $auxHtml = $auxOutput->getText();
407 $this->assertContains( 'Kittens', $mainHtml );
408 $this->assertContains( 'Goats', $auxHtml );
409 $this->assertNotContains( 'Goats', $mainHtml );
410 $this->assertNotContains( 'Kittens', $auxHtml );
411 $this->assertContains( 'Kittens', $combinedHtml );
412 $this->assertContains( 'Goats', $combinedHtml );
413 $this->assertContains( '>aux<', $combinedHtml, 'slot header' );
414 $this->assertNotContains( '<mw:slotheader', $combinedHtml, 'slot header placeholder' );
416 // make sure output wrapping works right
417 $this->assertContains( 'class="mw-parser-output"', $mainHtml );
418 $this->assertContains( 'class="mw-parser-output"', $auxHtml );
419 $this->assertContains( 'class="mw-parser-output"', $combinedHtml );
421 // there should be only one wrapper div
422 $this->assertSame( 1, preg_match_all( '#class="mw-parser-output"#', $combinedHtml ) );
423 $this->assertNotContains( 'class="mw-parser-output"', $combinedOutput->getRawText() );
425 $combinedLinks = $combinedOutput->getLinks();
426 $mainLinks = $mainOutput->getLinks();
427 $auxLinks = $auxOutput->getLinks();
428 $this->assertTrue( isset( $combinedLinks[NS_MAIN
]['Kittens'] ), 'links from main slot' );
429 $this->assertTrue( isset( $combinedLinks[NS_MAIN
]['Goats'] ), 'links from aux slot' );
430 $this->assertFalse( isset( $mainLinks[NS_MAIN
]['Goats'] ), 'no aux links in main' );
431 $this->assertFalse( isset( $auxLinks[NS_MAIN
]['Kittens'] ), 'no main links in aux' );
434 public function testGetRenderedRevision_noHtml() {
435 /** @var MockObject|Content $mockContent */
436 $mockContent = $this->getMockBuilder( WikitextContent
::class )
437 ->setMethods( [ 'getParserOutput' ] )
438 ->setConstructorArgs( [ 'Whatever' ] )
440 $mockContent->method( 'getParserOutput' )
441 ->willReturnCallback( function ( Title
$title, $revId = null,
442 ParserOptions
$options = null, $generateHtml = true
444 if ( !$generateHtml ) {
445 return new ParserOutput( null );
447 $this->fail( 'Should not be called with $generateHtml == true' );
448 return null; // never happens, make analyzer happy
452 $renderer = $this->newRevisionRenderer();
453 $title = $this->getMockTitle( 7, 21 );
455 $rev = new MutableRevisionRecord( $title );
456 $rev->setContent( 'main', $mockContent );
457 $rev->setContent( 'aux', $mockContent );
459 // NOTE: we are testing the private combineSlotOutput() callback here.
460 $rr = $renderer->getRenderedRevision( $rev );
462 $output = $rr->getSlotParserOutput( 'main', [ 'generate-html' => false ] );
463 $this->assertFalse( $output->hasText(), 'hasText' );
465 $output = $rr->getRevisionParserOutput( [ 'generate-html' => false ] );
466 $this->assertFalse( $output->hasText(), 'hasText' );