3 namespace MediaWiki\Tests\Revision
;
5 use CommentStoreComment
;
9 use InvalidArgumentException
;
11 use MediaWiki\Linker\LinkTarget
;
12 use MediaWiki\MediaWikiServices
;
13 use MediaWiki\Revision\IncompleteRevisionException
;
14 use MediaWiki\Revision\MutableRevisionRecord
;
15 use MediaWiki\Revision\RevisionArchiveRecord
;
16 use MediaWiki\Revision\RevisionRecord
;
17 use MediaWiki\Revision\RevisionStoreRecord
;
18 use MediaWiki\Revision\RevisionSlots
;
19 use MediaWiki\Revision\RevisionStore
;
20 use MediaWiki\Revision\SlotRecord
;
21 use MediaWiki\Storage\BlobStoreFactory
;
22 use MediaWiki\Storage\SqlBlobStore
;
23 use MediaWiki\User\UserIdentityValue
;
24 use MediaWikiTestCase
;
25 use PHPUnit_Framework_MockObject_MockObject
;
30 use Wikimedia\Rdbms\Database
;
31 use Wikimedia\Rdbms\DatabaseDomain
;
32 use Wikimedia\Rdbms\DatabaseSqlite
;
33 use Wikimedia\Rdbms\FakeResultWrapper
;
34 use Wikimedia\Rdbms\LoadBalancer
;
35 use Wikimedia\Rdbms\TransactionProfiler
;
41 * @group RevisionStore
43 abstract class RevisionStoreDbTestBase
extends MediaWikiTestCase
{
48 private $testPageTitle;
58 abstract protected function getMcrMigrationStage();
63 protected function getContentHandlerUseDB() {
70 abstract protected function getMcrTablesToReset();
72 public function setUp() {
74 $this->tablesUsed
[] = 'archive';
75 $this->tablesUsed
[] = 'page';
76 $this->tablesUsed
[] = 'revision';
77 $this->tablesUsed
[] = 'comment';
79 $this->tablesUsed +
= $this->getMcrTablesToReset();
81 $this->setMwGlobals( [
82 'wgMultiContentRevisionSchemaMigrationStage' => $this->getMcrMigrationStage(),
83 'wgContentHandlerUseDB' => $this->getContentHandlerUseDB(),
87 protected function addCoreDBData() {
88 // Blank out. This would fail with a modified schema, and we don't need it.
94 protected function getTestPageTitle() {
95 if ( $this->testPageTitle
) {
96 return $this->testPageTitle
;
99 $this->testPageTitle
= Title
::newFromText( 'UTPage-' . __CLASS__
);
100 return $this->testPageTitle
;
104 * @param string|null $pageTitle whether to force-create a new page
107 protected function getTestPage( $pageTitle = null ) {
108 if ( !is_null( $pageTitle ) && $this->testPage
) {
109 return $this->testPage
;
112 $title = is_null( $pageTitle ) ?
$this->getTestPageTitle() : Title
::newFromText( $pageTitle );
113 $page = WikiPage
::factory( $title );
115 if ( !$page->exists() ) {
116 // Make sure we don't write to the live db.
117 $this->ensureMockDatabaseConnection( wfGetDB( DB_MASTER
) );
119 $user = static::getTestSysop()->getUser();
121 $page->doEditContent(
122 new WikitextContent( 'UTContent-' . __CLASS__
),
123 'UTPageSummary-' . __CLASS__
,
124 EDIT_NEW | EDIT_SUPPRESS_RC
,
130 if ( is_null( $pageTitle ) ) {
131 $this->testPage
= $page;
137 * @return LoadBalancer|PHPUnit_Framework_MockObject_MockObject
139 private function getLoadBalancerMock( array $server ) {
140 $domain = new DatabaseDomain( $server['dbname'], null, $server['tablePrefix'] );
142 $lb = $this->getMockBuilder( LoadBalancer
::class )
143 ->setMethods( [ 'reallyOpenConnection' ] )
144 ->setConstructorArgs( [
145 [ 'servers' => [ $server ], 'localDomain' => $domain ]
149 $lb->method( 'reallyOpenConnection' )->willReturnCallback(
150 function ( array $server, $dbNameOverride ) {
151 return $this->getDatabaseMock( $server );
159 * @return Database|PHPUnit_Framework_MockObject_MockObject
161 private function getDatabaseMock( array $params ) {
162 $db = $this->getMockBuilder( DatabaseSqlite
::class )
163 ->setMethods( [ 'select', 'doQuery', 'open', 'closeConnection', 'isOpen' ] )
164 ->setConstructorArgs( [ $params ] )
167 $db->method( 'select' )->willReturn( new FakeResultWrapper( [] ) );
168 $db->method( 'isOpen' )->willReturn( true );
173 public function provideDomainCheck() {
174 yield
[ false, 'test', '' ];
175 yield
[ 'test', 'test', '' ];
177 yield
[ false, 'test', 'foo_' ];
178 yield
[ 'test-foo_', 'test', 'foo_' ];
180 yield
[ false, 'dash-test', '' ];
181 yield
[ 'dash-test', 'dash-test', '' ];
183 yield
[ false, 'underscore_test', 'foo_' ];
184 yield
[ 'underscore_test-foo_', 'underscore_test', 'foo_' ];
188 * @dataProvider provideDomainCheck
189 * @covers \MediaWiki\Revision\RevisionStore::checkDatabaseDomain
191 public function testDomainCheck( $wikiId, $dbName, $dbPrefix ) {
194 'wgDBname' => $dbName,
195 'wgDBprefix' => $dbPrefix,
199 $loadBalancer = $this->getLoadBalancerMock(
202 'dbDirectory' => '*dummy*',
204 'password' => 'test',
212 'trxProfiler' => new TransactionProfiler(),
213 'connLogger' => new \Psr\Log\
NullLogger(),
214 'queryLogger' => new \Psr\Log\
NullLogger(),
215 'errorLogger' => function () {
217 'deprecationLogger' => function () {
221 'tablePrefix' => $dbPrefix,
224 $db = $loadBalancer->getConnection( DB_REPLICA
);
226 /** @var SqlBlobStore $blobStore */
227 $blobStore = $this->getMockBuilder( SqlBlobStore
::class )
228 ->disableOriginalConstructor()
231 $store = new RevisionStore(
234 new WANObjectCache( [ 'cache' => new HashBagOStuff() ] ),
235 MediaWikiServices
::getInstance()->getCommentStore(),
236 MediaWikiServices
::getInstance()->getContentModelStore(),
237 MediaWikiServices
::getInstance()->getSlotRoleStore(),
238 MediaWikiServices
::getInstance()->getSlotRoleRegistry(),
239 $this->getMcrMigrationStage(),
240 MediaWikiServices
::getInstance()->getActorMigration(),
244 $count = $store->countRevisionsByPageId( $db, 0 );
246 // Dummy check to make PhpUnit happy. We are really only interested in
247 // countRevisionsByPageId not failing due to the DB domain check.
248 $this->assertSame( 0, $count );
251 protected function assertLinkTargetsEqual( LinkTarget
$l1, LinkTarget
$l2 ) {
252 $this->assertEquals( $l1->getDBkey(), $l2->getDBkey() );
253 $this->assertEquals( $l1->getNamespace(), $l2->getNamespace() );
254 $this->assertEquals( $l1->getFragment(), $l2->getFragment() );
255 $this->assertEquals( $l1->getInterwiki(), $l2->getInterwiki() );
258 protected function assertRevisionRecordsEqual( RevisionRecord
$r1, RevisionRecord
$r2 ) {
260 $r1->getPageAsLinkTarget()->getNamespace(),
261 $r2->getPageAsLinkTarget()->getNamespace()
265 $r1->getPageAsLinkTarget()->getText(),
266 $r2->getPageAsLinkTarget()->getText()
269 if ( $r1->getParentId() ) {
270 $this->assertEquals( $r1->getParentId(), $r2->getParentId() );
273 $this->assertEquals( $r1->getUser()->getName(), $r2->getUser()->getName() );
274 $this->assertEquals( $r1->getUser()->getId(), $r2->getUser()->getId() );
275 $this->assertEquals( $r1->getComment(), $r2->getComment() );
276 $this->assertEquals( $r1->getTimestamp(), $r2->getTimestamp() );
277 $this->assertEquals( $r1->getVisibility(), $r2->getVisibility() );
278 $this->assertEquals( $r1->getSha1(), $r2->getSha1() );
279 $this->assertEquals( $r1->getSize(), $r2->getSize() );
280 $this->assertEquals( $r1->getPageId(), $r2->getPageId() );
281 $this->assertArrayEquals( $r1->getSlotRoles(), $r2->getSlotRoles() );
282 $this->assertEquals( $r1->getWikiId(), $r2->getWikiId() );
283 $this->assertEquals( $r1->isMinor(), $r2->isMinor() );
284 foreach ( $r1->getSlotRoles() as $role ) {
285 $this->assertSlotRecordsEqual( $r1->getSlot( $role ), $r2->getSlot( $role ) );
286 $this->assertTrue( $r1->getContent( $role )->equals( $r2->getContent( $role ) ) );
289 RevisionRecord
::DELETED_TEXT
,
290 RevisionRecord
::DELETED_COMMENT
,
291 RevisionRecord
::DELETED_USER
,
292 RevisionRecord
::DELETED_RESTRICTED
,
294 $this->assertEquals( $r1->isDeleted( $field ), $r2->isDeleted( $field ) );
298 protected function assertSlotRecordsEqual( SlotRecord
$s1, SlotRecord
$s2 ) {
299 $this->assertSame( $s1->getRole(), $s2->getRole() );
300 $this->assertSame( $s1->getModel(), $s2->getModel() );
301 $this->assertSame( $s1->getFormat(), $s2->getFormat() );
302 $this->assertSame( $s1->getSha1(), $s2->getSha1() );
303 $this->assertSame( $s1->getSize(), $s2->getSize() );
304 $this->assertTrue( $s1->getContent()->equals( $s2->getContent() ) );
306 $s1->hasRevision() ?
$this->assertSame( $s1->getRevision(), $s2->getRevision() ) : null;
307 $s1->hasAddress() ?
$this->assertSame( $s1->hasAddress(), $s2->hasAddress() ) : null;
310 protected function assertRevisionCompleteness( RevisionRecord
$r ) {
311 $this->assertTrue( $r->hasSlot( SlotRecord
::MAIN
) );
312 $this->assertInstanceOf( SlotRecord
::class, $r->getSlot( SlotRecord
::MAIN
) );
313 $this->assertInstanceOf( Content
::class, $r->getContent( SlotRecord
::MAIN
) );
315 foreach ( $r->getSlotRoles() as $role ) {
316 $this->assertSlotCompleteness( $r, $r->getSlot( $role ) );
320 protected function assertSlotCompleteness( RevisionRecord
$r, SlotRecord
$slot ) {
321 $this->assertTrue( $slot->hasAddress() );
322 $this->assertSame( $r->getId(), $slot->getRevision() );
324 $this->assertInstanceOf( Content
::class, $slot->getContent() );
328 * @param mixed[] $details
330 * @return RevisionRecord
332 private function getRevisionRecordFromDetailsArray( $details = [] ) {
333 // Convert some values that can't be provided by dataProviders
334 if ( isset( $details['user'] ) && $details['user'] === true ) {
335 $details['user'] = $this->getTestUser()->getUser();
337 if ( isset( $details['page'] ) && $details['page'] === true ) {
338 $details['page'] = $this->getTestPage()->getId();
340 if ( isset( $details['parent'] ) && $details['parent'] === true ) {
341 $details['parent'] = $this->getTestPage()->getLatest();
344 // Create the RevisionRecord with any available data
345 $rev = new MutableRevisionRecord( $this->getTestPageTitle() );
346 isset( $details['slot'] ) ?
$rev->setSlot( $details['slot'] ) : null;
347 isset( $details['parent'] ) ?
$rev->setParentId( $details['parent'] ) : null;
348 isset( $details['page'] ) ?
$rev->setPageId( $details['page'] ) : null;
349 isset( $details['size'] ) ?
$rev->setSize( $details['size'] ) : null;
350 isset( $details['sha1'] ) ?
$rev->setSha1( $details['sha1'] ) : null;
351 isset( $details['comment'] ) ?
$rev->setComment( $details['comment'] ) : null;
352 isset( $details['timestamp'] ) ?
$rev->setTimestamp( $details['timestamp'] ) : null;
353 isset( $details['minor'] ) ?
$rev->setMinorEdit( $details['minor'] ) : null;
354 isset( $details['user'] ) ?
$rev->setUser( $details['user'] ) : null;
355 isset( $details['visibility'] ) ?
$rev->setVisibility( $details['visibility'] ) : null;
356 isset( $details['id'] ) ?
$rev->setId( $details['id'] ) : null;
358 if ( isset( $details['content'] ) ) {
359 foreach ( $details['content'] as $role => $content ) {
360 $rev->setContent( $role, $content );
367 public function provideInsertRevisionOn_successes() {
368 yield
'Bare minimum revision insertion' => [
370 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
372 'comment' => $this->getRandomCommentStoreComment(),
373 'timestamp' => '20171117010101',
377 yield
'Detailed revision insertion' => [
379 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
382 'comment' => $this->getRandomCommentStoreComment(),
383 'timestamp' => '20171117010101',
386 'visibility' => RevisionRecord
::DELETED_RESTRICTED
,
391 protected function getRandomCommentStoreComment() {
392 return CommentStoreComment
::newUnsavedComment( __METHOD__
. '.' . rand( 0, 1000 ) );
396 * @dataProvider provideInsertRevisionOn_successes
397 * @covers \MediaWiki\Revision\RevisionStore::insertRevisionOn
398 * @covers \MediaWiki\Revision\RevisionStore::insertSlotRowOn
399 * @covers \MediaWiki\Revision\RevisionStore::insertContentRowOn
401 public function testInsertRevisionOn_successes(
402 array $revDetails = []
404 $title = $this->getTestPageTitle();
405 $rev = $this->getRevisionRecordFromDetailsArray( $revDetails );
407 $store = MediaWikiServices
::getInstance()->getRevisionStore();
408 $return = $store->insertRevisionOn( $rev, wfGetDB( DB_MASTER
) );
410 // is the new revision correct?
411 $this->assertRevisionCompleteness( $return );
412 $this->assertLinkTargetsEqual( $title, $return->getPageAsLinkTarget() );
413 $this->assertRevisionRecordsEqual( $rev, $return );
415 // can we load it from the store?
416 $loaded = $store->getRevisionById( $return->getId() );
417 $this->assertRevisionCompleteness( $loaded );
418 $this->assertRevisionRecordsEqual( $return, $loaded );
420 // can we find it directly in the database?
421 $this->assertRevisionExistsInDatabase( $return );
424 protected function assertRevisionExistsInDatabase( RevisionRecord
$rev ) {
425 $row = $this->revisionToRow( new Revision( $rev ), [] );
427 // unset nulled fields
428 unset( $row->rev_content_model
);
429 unset( $row->rev_content_format
);
432 unset( $row->rev_comment_text
);
433 unset( $row->rev_comment_data
);
434 unset( $row->rev_comment_cid
);
435 unset( $row->rev_comment_id
);
437 $store = MediaWikiServices
::getInstance()->getRevisionStore();
438 $queryInfo = $store->getQueryInfo( [ 'user' ] );
440 $row = get_object_vars( $row );
442 // Use aliased fields from $queryInfo, e.g. rev_user
443 $keys = array_keys( $row );
444 $keys = array_combine( $keys, $keys );
445 $fields = array_intersect_key( $queryInfo['fields'], $keys ) +
$keys;
447 // assertSelect() fails unless the orders match.
452 $queryInfo['tables'],
454 [ 'rev_id' => $rev->getId() ],
455 [ array_values( $row ) ],
462 * @param SlotRecord $a
463 * @param SlotRecord $b
465 protected function assertSameSlotContent( SlotRecord
$a, SlotRecord
$b ) {
466 // Assert that the same blob address has been used.
467 $this->assertSame( $a->getAddress(), $b->getAddress() );
471 * @covers \MediaWiki\Revision\RevisionStore::insertRevisionOn
473 public function testInsertRevisionOn_blobAddressExists() {
474 $title = $this->getTestPageTitle();
476 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
478 'comment' => $this->getRandomCommentStoreComment(),
479 'timestamp' => '20171117010101',
483 $store = MediaWikiServices
::getInstance()->getRevisionStore();
485 // Insert the first revision
486 $revOne = $this->getRevisionRecordFromDetailsArray( $revDetails );
487 $firstReturn = $store->insertRevisionOn( $revOne, wfGetDB( DB_MASTER
) );
488 $this->assertLinkTargetsEqual( $title, $firstReturn->getPageAsLinkTarget() );
489 $this->assertRevisionRecordsEqual( $revOne, $firstReturn );
491 // Insert a second revision inheriting the same blob address
492 $revDetails['slot'] = SlotRecord
::newInherited( $firstReturn->getSlot( SlotRecord
::MAIN
) );
493 $revTwo = $this->getRevisionRecordFromDetailsArray( $revDetails );
494 $secondReturn = $store->insertRevisionOn( $revTwo, wfGetDB( DB_MASTER
) );
495 $this->assertLinkTargetsEqual( $title, $secondReturn->getPageAsLinkTarget() );
496 $this->assertRevisionRecordsEqual( $revTwo, $secondReturn );
498 $firstMainSlot = $firstReturn->getSlot( SlotRecord
::MAIN
);
499 $secondMainSlot = $secondReturn->getSlot( SlotRecord
::MAIN
);
501 $this->assertSameSlotContent( $firstMainSlot, $secondMainSlot );
503 // And that different revisions have been created.
504 $this->assertNotSame( $firstReturn->getId(), $secondReturn->getId() );
506 // Make sure the slot rows reference the correct revision
507 $this->assertSame( $firstReturn->getId(), $firstMainSlot->getRevision() );
508 $this->assertSame( $secondReturn->getId(), $secondMainSlot->getRevision() );
511 public function provideInsertRevisionOn_failures() {
514 'comment' => $this->getRandomCommentStoreComment(),
515 'timestamp' => '20171117010101',
518 new InvalidArgumentException( 'main slot must be provided' )
520 yield
'no main slot' => [
522 'slot' => SlotRecord
::newUnsaved( 'aux', new WikitextContent( 'Turkey' ) ),
523 'comment' => $this->getRandomCommentStoreComment(),
524 'timestamp' => '20171117010101',
527 new InvalidArgumentException( 'main slot must be provided' )
529 yield
'no timestamp' => [
531 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
532 'comment' => $this->getRandomCommentStoreComment(),
535 new IncompleteRevisionException( 'timestamp field must not be NULL!' )
537 yield
'no comment' => [
539 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
540 'timestamp' => '20171117010101',
543 new IncompleteRevisionException( 'comment must not be NULL!' )
547 'slot' => SlotRecord
::newUnsaved( SlotRecord
::MAIN
, new WikitextContent( 'Chicken' ) ),
548 'comment' => $this->getRandomCommentStoreComment(),
549 'timestamp' => '20171117010101',
551 new IncompleteRevisionException( 'user must not be NULL!' )
556 * @dataProvider provideInsertRevisionOn_failures
557 * @covers \MediaWiki\Revision\RevisionStore::insertRevisionOn
559 public function testInsertRevisionOn_failures(
560 array $revDetails = [],
563 $rev = $this->getRevisionRecordFromDetailsArray( $revDetails );
565 $store = MediaWikiServices
::getInstance()->getRevisionStore();
567 $this->setExpectedException(
568 get_class( $exception ),
569 $exception->getMessage(),
570 $exception->getCode()
572 $store->insertRevisionOn( $rev, wfGetDB( DB_MASTER
) );
575 public function provideNewNullRevision() {
577 Title
::newFromText( 'UTPage_notAutoCreated' ),
578 [ 'content' => [ 'main' => new WikitextContent( 'Flubber1' ) ] ],
579 CommentStoreComment
::newUnsavedComment( __METHOD__
. ' comment1' ),
583 Title
::newFromText( 'UTPage_notAutoCreated' ),
584 [ 'content' => [ 'main' => new WikitextContent( 'Flubber2' ) ] ],
585 CommentStoreComment
::newUnsavedComment( __METHOD__
. ' comment2', [ 'a' => 1 ] ),
591 * @dataProvider provideNewNullRevision
592 * @covers \MediaWiki\Revision\RevisionStore::newNullRevision
593 * @covers \MediaWiki\Revision\RevisionStore::findSlotContentId
595 public function testNewNullRevision( Title
$title, $revDetails, $comment, $minor = false ) {
596 $user = TestUserRegistry
::getMutableTestUser( __METHOD__
)->getUser();
597 $page = WikiPage
::factory( $title );
599 if ( !$page->exists() ) {
600 $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
, EDIT_NEW
);
603 $revDetails['page'] = $page->getId();
604 $revDetails['timestamp'] = wfTimestampNow();
605 $revDetails['comment'] = CommentStoreComment
::newUnsavedComment( 'Base' );
606 $revDetails['user'] = $user;
608 $baseRev = $this->getRevisionRecordFromDetailsArray( $revDetails );
609 $store = MediaWikiServices
::getInstance()->getRevisionStore();
611 $dbw = wfGetDB( DB_MASTER
);
612 $baseRev = $store->insertRevisionOn( $baseRev, $dbw );
613 $page->updateRevisionOn( $dbw, new Revision( $baseRev ), $page->getLatest() );
615 $record = $store->newNullRevision(
616 wfGetDB( DB_MASTER
),
623 $this->assertEquals( $title->getNamespace(), $record->getPageAsLinkTarget()->getNamespace() );
624 $this->assertEquals( $title->getDBkey(), $record->getPageAsLinkTarget()->getDBkey() );
625 $this->assertEquals( $comment, $record->getComment() );
626 $this->assertEquals( $minor, $record->isMinor() );
627 $this->assertEquals( $user->getName(), $record->getUser()->getName() );
628 $this->assertEquals( $baseRev->getId(), $record->getParentId() );
630 $this->assertArrayEquals(
631 $baseRev->getSlotRoles(),
632 $record->getSlotRoles()
635 foreach ( $baseRev->getSlotRoles() as $role ) {
636 $parentSlot = $baseRev->getSlot( $role );
637 $slot = $record->getSlot( $role );
639 $this->assertTrue( $slot->isInherited(), 'isInherited' );
640 $this->assertSame( $parentSlot->getOrigin(), $slot->getOrigin(), 'getOrigin' );
641 $this->assertSameSlotContent( $parentSlot, $slot );
646 * @covers \MediaWiki\Revision\RevisionStore::newNullRevision
648 public function testNewNullRevision_nonExistingTitle() {
649 $store = MediaWikiServices
::getInstance()->getRevisionStore();
650 $record = $store->newNullRevision(
651 wfGetDB( DB_MASTER
),
652 Title
::newFromText( __METHOD__
. '.iDontExist!' ),
653 CommentStoreComment
::newUnsavedComment( __METHOD__
. ' comment' ),
655 TestUserRegistry
::getMutableTestUser( __METHOD__
)->getUser()
657 $this->assertNull( $record );
661 * @covers \MediaWiki\Revision\RevisionStore::getRcIdIfUnpatrolled
663 public function testGetRcIdIfUnpatrolled_returnsRecentChangesId() {
664 $page = $this->getTestPage();
665 $status = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
666 /** @var Revision $rev */
667 $rev = $status->value
['revision'];
669 $store = MediaWikiServices
::getInstance()->getRevisionStore();
670 $revisionRecord = $store->getRevisionById( $rev->getId() );
671 $result = $store->getRcIdIfUnpatrolled( $revisionRecord );
673 $this->assertGreaterThan( 0, $result );
675 $store->getRecentChange( $revisionRecord )->getAttribute( 'rc_id' ),
681 * @covers \MediaWiki\Revision\RevisionStore::getRcIdIfUnpatrolled
683 public function testGetRcIdIfUnpatrolled_returnsZeroIfPatrolled() {
684 // This assumes that sysops are auto patrolled
685 $sysop = $this->getTestSysop()->getUser();
686 $page = $this->getTestPage();
687 $status = $page->doEditContent(
688 new WikitextContent( __METHOD__
),
694 /** @var Revision $rev */
695 $rev = $status->value
['revision'];
697 $store = MediaWikiServices
::getInstance()->getRevisionStore();
698 $revisionRecord = $store->getRevisionById( $rev->getId() );
699 $result = $store->getRcIdIfUnpatrolled( $revisionRecord );
701 $this->assertSame( 0, $result );
705 * @covers \MediaWiki\Revision\RevisionStore::getRecentChange
707 public function testGetRecentChange() {
708 $page = $this->getTestPage();
709 $content = new WikitextContent( __METHOD__
);
710 $status = $page->doEditContent( $content, __METHOD__
);
711 /** @var Revision $rev */
712 $rev = $status->value
['revision'];
714 $store = MediaWikiServices
::getInstance()->getRevisionStore();
715 $revRecord = $store->getRevisionById( $rev->getId() );
716 $recentChange = $store->getRecentChange( $revRecord );
718 $this->assertEquals( $rev->getId(), $recentChange->getAttribute( 'rc_this_oldid' ) );
719 $this->assertEquals( $rev->getRecentChange(), $recentChange );
723 * @covers \MediaWiki\Revision\RevisionStore::getRevisionById
725 public function testGetRevisionById() {
726 $page = $this->getTestPage();
727 $content = new WikitextContent( __METHOD__
);
728 $status = $page->doEditContent( $content, __METHOD__
);
729 /** @var Revision $rev */
730 $rev = $status->value
['revision'];
732 $store = MediaWikiServices
::getInstance()->getRevisionStore();
733 $revRecord = $store->getRevisionById( $rev->getId() );
735 $this->assertSame( $rev->getId(), $revRecord->getId() );
736 $this->assertTrue( $revRecord->getSlot( SlotRecord
::MAIN
)->getContent()->equals( $content ) );
737 $this->assertSame( __METHOD__
, $revRecord->getComment()->text
);
741 * @covers \MediaWiki\Revision\RevisionStore::getRevisionByTitle
743 public function testGetRevisionByTitle() {
744 $page = $this->getTestPage();
745 $content = new WikitextContent( __METHOD__
);
746 $status = $page->doEditContent( $content, __METHOD__
);
747 /** @var Revision $rev */
748 $rev = $status->value
['revision'];
750 $store = MediaWikiServices
::getInstance()->getRevisionStore();
751 $revRecord = $store->getRevisionByTitle( $page->getTitle() );
753 $this->assertSame( $rev->getId(), $revRecord->getId() );
754 $this->assertTrue( $revRecord->getSlot( SlotRecord
::MAIN
)->getContent()->equals( $content ) );
755 $this->assertSame( __METHOD__
, $revRecord->getComment()->text
);
759 * @covers \MediaWiki\Revision\RevisionStore::getRevisionByPageId
761 public function testGetRevisionByPageId() {
762 $page = $this->getTestPage();
763 $content = new WikitextContent( __METHOD__
);
764 $status = $page->doEditContent( $content, __METHOD__
);
765 /** @var Revision $rev */
766 $rev = $status->value
['revision'];
768 $store = MediaWikiServices
::getInstance()->getRevisionStore();
769 $revRecord = $store->getRevisionByPageId( $page->getId() );
771 $this->assertSame( $rev->getId(), $revRecord->getId() );
772 $this->assertTrue( $revRecord->getSlot( SlotRecord
::MAIN
)->getContent()->equals( $content ) );
773 $this->assertSame( __METHOD__
, $revRecord->getComment()->text
);
777 * @covers \MediaWiki\Revision\RevisionStore::getRevisionByTimestamp
779 public function testGetRevisionByTimestamp() {
780 // Make sure there is 1 second between the last revision and the rev we create...
781 // Otherwise we might not get the correct revision and the test may fail...
783 $page = $this->getTestPage();
785 $content = new WikitextContent( __METHOD__
);
786 $status = $page->doEditContent( $content, __METHOD__
);
787 /** @var Revision $rev */
788 $rev = $status->value
['revision'];
790 $store = MediaWikiServices
::getInstance()->getRevisionStore();
791 $revRecord = $store->getRevisionByTimestamp(
796 $this->assertSame( $rev->getId(), $revRecord->getId() );
797 $this->assertTrue( $revRecord->getSlot( SlotRecord
::MAIN
)->getContent()->equals( $content ) );
798 $this->assertSame( __METHOD__
, $revRecord->getComment()->text
);
801 protected function revisionToRow( Revision
$rev, $options = [ 'page', 'user', 'comment' ] ) {
802 // XXX: the WikiPage object loads another RevisionRecord from the database. Not great.
803 $page = WikiPage
::factory( $rev->getTitle() );
806 'rev_id' => (string)$rev->getId(),
807 'rev_page' => (string)$rev->getPage(),
808 'rev_timestamp' => $this->db
->timestamp( $rev->getTimestamp() ),
809 'rev_user_text' => (string)$rev->getUserText(),
810 'rev_user' => (string)$rev->getUser() ?
: null,
811 'rev_minor_edit' => $rev->isMinor() ?
'1' : '0',
812 'rev_deleted' => (string)$rev->getVisibility(),
813 'rev_len' => (string)$rev->getSize(),
814 'rev_parent_id' => (string)$rev->getParentId(),
815 'rev_sha1' => (string)$rev->getSha1(),
818 if ( in_array( 'page', $options ) ) {
820 'page_namespace' => (string)$page->getTitle()->getNamespace(),
821 'page_title' => $page->getTitle()->getDBkey(),
822 'page_id' => (string)$page->getId(),
823 'page_latest' => (string)$page->getLatest(),
824 'page_is_redirect' => $page->isRedirect() ?
'1' : '0',
825 'page_len' => (string)$page->getContent()->getSize(),
829 if ( in_array( 'user', $options ) ) {
831 'user_name' => (string)$rev->getUserText(),
835 if ( in_array( 'comment', $options ) ) {
837 'rev_comment_text' => $rev->getComment(),
838 'rev_comment_data' => null,
839 'rev_comment_cid' => null,
843 if ( $rev->getId() ) {
845 'rev_id' => (string)$rev->getId(),
849 return (object)$fields;
852 protected function assertRevisionRecordMatchesRevision(
854 RevisionRecord
$record
856 $this->assertSame( $rev->getId(), $record->getId() );
857 $this->assertSame( $rev->getPage(), $record->getPageId() );
858 $this->assertSame( $rev->getTimestamp(), $record->getTimestamp() );
859 $this->assertSame( $rev->getUserText(), $record->getUser()->getName() );
860 $this->assertSame( $rev->getUser(), $record->getUser()->getId() );
861 $this->assertSame( $rev->isMinor(), $record->isMinor() );
862 $this->assertSame( $rev->getVisibility(), $record->getVisibility() );
863 $this->assertSame( $rev->getSize(), $record->getSize() );
865 * @note As of MW 1.31, the database schema allows the parent ID to be
866 * NULL to indicate that it is unknown.
868 $expectedParent = $rev->getParentId();
869 if ( $expectedParent === null ) {
872 $this->assertSame( $expectedParent, $record->getParentId() );
873 $this->assertSame( $rev->getSha1(), $record->getSha1() );
874 $this->assertSame( $rev->getComment(), $record->getComment()->text
);
875 $this->assertSame( $rev->getContentFormat(),
876 $record->getContent( SlotRecord
::MAIN
)->getDefaultFormat() );
877 $this->assertSame( $rev->getContentModel(), $record->getContent( SlotRecord
::MAIN
)->getModel() );
878 $this->assertLinkTargetsEqual( $rev->getTitle(), $record->getPageAsLinkTarget() );
880 $revRec = $rev->getRevisionRecord();
881 $revMain = $revRec->getSlot( SlotRecord
::MAIN
);
882 $recMain = $record->getSlot( SlotRecord
::MAIN
);
884 $this->assertSame( $revMain->hasOrigin(), $recMain->hasOrigin(), 'hasOrigin' );
885 $this->assertSame( $revMain->hasAddress(), $recMain->hasAddress(), 'hasAddress' );
886 $this->assertSame( $revMain->hasContentId(), $recMain->hasContentId(), 'hasContentId' );
888 if ( $revMain->hasOrigin() ) {
889 $this->assertSame( $revMain->getOrigin(), $recMain->getOrigin(), 'getOrigin' );
892 if ( $revMain->hasAddress() ) {
893 $this->assertSame( $revMain->getAddress(), $recMain->getAddress(), 'getAddress' );
896 if ( $revMain->hasContentId() ) {
897 // XXX: the content ID value is ill-defined when SCHEMA_COMPAT_WRITE_BOTH and
898 // SCHEMA_COMPAT_READ_OLD is set, since revision insertion will report the
899 // content ID used with the new schema, while loading the revision from the
900 // old schema will report an emulated ID.
901 if ( $this->getMcrMigrationStage() & SCHEMA_COMPAT_READ_NEW
) {
902 $this->assertSame( $revMain->getContentId(), $recMain->getContentId(), 'getContentId' );
908 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
909 * @covers \MediaWiki\Revision\RevisionStore::getQueryInfo
911 public function testNewRevisionFromRowAndSlot_getQueryInfo() {
912 $page = $this->getTestPage();
913 $text = __METHOD__
. 'o-รถ';
914 /** @var Revision $rev */
915 $rev = $page->doEditContent(
916 new WikitextContent( $text ),
918 )->value
['revision'];
920 $store = MediaWikiServices
::getInstance()->getRevisionStore();
921 $info = $store->getQueryInfo();
922 $row = $this->db
->selectRow(
925 [ 'rev_id' => $rev->getId() ],
931 $info = $store->getSlotsQueryInfo( [ 'content' ] );
932 $slotRows = $this->db
->select(
935 $this->getSlotRevisionConditions( $rev->getId() ),
941 $record = $store->newRevisionFromRowAndSlots(
943 iterator_to_array( $slotRows ),
947 $this->assertRevisionRecordMatchesRevision( $rev, $record );
948 $this->assertSame( $text, $rev->getContent()->serialize() );
952 * Conditions to use together with getSlotsQueryInfo() when selecting slot rows for a given
957 abstract protected function getSlotRevisionConditions( $revId );
960 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
961 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
962 * @covers \MediaWiki\Revision\RevisionStore::getQueryInfo
964 public function testNewRevisionFromRow_getQueryInfo() {
965 $page = $this->getTestPage();
966 $text = __METHOD__
. 'a-รค';
967 /** @var Revision $rev */
968 $rev = $page->doEditContent(
969 new WikitextContent( $text ),
971 )->value
['revision'];
973 $store = MediaWikiServices
::getInstance()->getRevisionStore();
974 $info = $store->getQueryInfo();
975 $row = $this->db
->selectRow(
978 [ 'rev_id' => $rev->getId() ],
983 $record = $store->newRevisionFromRow(
988 $this->assertRevisionRecordMatchesRevision( $rev, $record );
989 $this->assertSame( $text, $rev->getContent()->serialize() );
993 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
994 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
996 public function testNewRevisionFromRow_anonEdit() {
997 $page = $this->getTestPage();
998 $text = __METHOD__
. 'a-รค';
999 /** @var Revision $rev */
1000 $rev = $page->doEditContent(
1001 new WikitextContent( $text ),
1003 )->value
['revision'];
1005 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1006 $record = $store->newRevisionFromRow(
1007 $this->revisionToRow( $rev ),
1011 $this->assertRevisionRecordMatchesRevision( $rev, $record );
1012 $this->assertSame( $text, $rev->getContent()->serialize() );
1016 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
1017 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
1019 public function testNewRevisionFromRow_anonEdit_legacyEncoding() {
1020 $this->setMwGlobals( 'wgLegacyEncoding', 'windows-1252' );
1021 $page = $this->getTestPage();
1022 $text = __METHOD__
. 'a-รค';
1023 /** @var Revision $rev */
1024 $rev = $page->doEditContent(
1025 new WikitextContent( $text ),
1027 )->value
['revision'];
1029 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1030 $record = $store->newRevisionFromRow(
1031 $this->revisionToRow( $rev ),
1035 $this->assertRevisionRecordMatchesRevision( $rev, $record );
1036 $this->assertSame( $text, $rev->getContent()->serialize() );
1040 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
1041 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
1043 public function testNewRevisionFromRow_userEdit() {
1044 $page = $this->getTestPage();
1045 $text = __METHOD__
. 'b-รค';
1046 /** @var Revision $rev */
1047 $rev = $page->doEditContent(
1048 new WikitextContent( $text ),
1052 $this->getTestUser()->getUser()
1053 )->value
['revision'];
1055 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1056 $record = $store->newRevisionFromRow(
1057 $this->revisionToRow( $rev ),
1061 $this->assertRevisionRecordMatchesRevision( $rev, $record );
1062 $this->assertSame( $text, $rev->getContent()->serialize() );
1066 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromArchiveRow
1067 * @covers \MediaWiki\Revision\RevisionStore::getArchiveQueryInfo
1069 public function testNewRevisionFromArchiveRow_getArchiveQueryInfo() {
1070 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1071 $title = Title
::newFromText( __METHOD__
);
1072 $text = __METHOD__
. '-bรค';
1073 $page = WikiPage
::factory( $title );
1074 /** @var Revision $orig */
1075 $orig = $page->doEditContent( new WikitextContent( $text ), __METHOD__
)
1076 ->value
['revision'];
1077 $page->doDeleteArticle( __METHOD__
);
1079 $db = wfGetDB( DB_MASTER
);
1080 $arQuery = $store->getArchiveQueryInfo();
1082 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
1083 __METHOD__
, [], $arQuery['joins']
1085 $this->assertTrue( is_object( $res ), 'query failed' );
1087 $row = $res->fetchObject();
1089 $record = $store->newRevisionFromArchiveRow( $row );
1091 $this->assertRevisionRecordMatchesRevision( $orig, $record );
1092 $this->assertSame( $text, $record->getContent( SlotRecord
::MAIN
)->serialize() );
1096 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromArchiveRow
1098 public function testNewRevisionFromArchiveRow_legacyEncoding() {
1099 $this->setMwGlobals( 'wgLegacyEncoding', 'windows-1252' );
1100 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1101 $title = Title
::newFromText( __METHOD__
);
1102 $text = __METHOD__
. '-bรค';
1103 $page = WikiPage
::factory( $title );
1104 /** @var Revision $orig */
1105 $orig = $page->doEditContent( new WikitextContent( $text ), __METHOD__
)
1106 ->value
['revision'];
1107 $page->doDeleteArticle( __METHOD__
);
1109 $db = wfGetDB( DB_MASTER
);
1110 $arQuery = $store->getArchiveQueryInfo();
1112 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
1113 __METHOD__
, [], $arQuery['joins']
1115 $this->assertTrue( is_object( $res ), 'query failed' );
1117 $row = $res->fetchObject();
1119 $record = $store->newRevisionFromArchiveRow( $row );
1121 $this->assertRevisionRecordMatchesRevision( $orig, $record );
1122 $this->assertSame( $text, $record->getContent( SlotRecord
::MAIN
)->serialize() );
1126 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromArchiveRow
1128 public function testNewRevisionFromArchiveRow_no_user() {
1129 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1133 'ar_page_id' => '2',
1134 'ar_namespace' => '0',
1135 'ar_title' => 'Something',
1137 'ar_text_id' => '47',
1138 'ar_timestamp' => '20180528192356',
1139 'ar_minor_edit' => '0',
1140 'ar_deleted' => '0',
1142 'ar_parent_id' => '0',
1143 'ar_sha1' => 'deadbeef',
1144 'ar_comment_text' => 'whatever',
1145 'ar_comment_data' => null,
1146 'ar_comment_cid' => null,
1148 'ar_user_text' => '', // this is the important bit
1150 'ar_content_format' => null,
1151 'ar_content_model' => null,
1154 \Wikimedia\
suppressWarnings();
1155 $record = $store->newRevisionFromArchiveRow( $row );
1156 \Wikimedia\
suppressWarnings( true );
1158 $this->assertInstanceOf( RevisionRecord
::class, $record );
1159 $this->assertInstanceOf( UserIdentityValue
::class, $record->getUser() );
1160 $this->assertSame( 'Unknown user', $record->getUser()->getName() );
1164 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
1165 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRowAndSlots
1167 public function testNewRevisionFromRow_no_user() {
1168 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1169 $title = Title
::newFromText( __METHOD__
);
1174 'page_namespace' => '0',
1175 'page_title' => $title->getText(),
1176 'rev_text_id' => '47',
1177 'rev_timestamp' => '20180528192356',
1178 'rev_minor_edit' => '0',
1179 'rev_deleted' => '0',
1181 'rev_parent_id' => '0',
1182 'rev_sha1' => 'deadbeef',
1183 'rev_comment_text' => 'whatever',
1184 'rev_comment_data' => null,
1185 'rev_comment_cid' => null,
1187 'rev_user_text' => '', // this is the important bit
1188 'rev_actor' => null,
1189 'rev_content_format' => null,
1190 'rev_content_model' => null,
1193 \Wikimedia\
suppressWarnings();
1194 $record = $store->newRevisionFromRow( $row, 0, $title );
1195 \Wikimedia\
suppressWarnings( true );
1197 $this->assertNotNull( $record );
1198 $this->assertNotNull( $record->getUser() );
1199 $this->assertNotEmpty( $record->getUser()->getName() );
1203 * @covers \MediaWiki\Revision\RevisionStore::insertRevisionOn
1205 public function testInsertRevisionOn_archive() {
1206 // This is a round trip test for deletion and undeletion of a
1207 // revision row via the archive table.
1209 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1210 $title = Title
::newFromText( __METHOD__
);
1212 $page = WikiPage
::factory( $title );
1213 /** @var Revision $origRev */
1214 $page->doEditContent( new WikitextContent( "First" ), __METHOD__
. '-first' );
1215 $origRev = $page->doEditContent( new WikitextContent( "Foo" ), __METHOD__
)
1216 ->value
['revision'];
1217 $orig = $origRev->getRevisionRecord();
1218 $page->doDeleteArticle( __METHOD__
);
1220 // re-create page, so we can later load revisions for it
1221 $page->doEditContent( new WikitextContent( 'Two' ), __METHOD__
);
1223 $db = wfGetDB( DB_MASTER
);
1224 $arQuery = $store->getArchiveQueryInfo();
1225 $row = $db->selectRow(
1226 $arQuery['tables'], $arQuery['fields'], [ 'ar_rev_id' => $orig->getId() ],
1227 __METHOD__
, [], $arQuery['joins']
1230 $this->assertNotFalse( $row, 'query failed' );
1232 $record = $store->newRevisionFromArchiveRow(
1236 [ 'page_id' => $title->getArticleID() ]
1239 $restored = $store->insertRevisionOn( $record, $db );
1241 // is the new revision correct?
1242 $this->assertRevisionCompleteness( $restored );
1243 $this->assertRevisionRecordsEqual( $record, $restored );
1245 // does the new revision use the original slot?
1246 $recMain = $record->getSlot( SlotRecord
::MAIN
);
1247 $restMain = $restored->getSlot( SlotRecord
::MAIN
);
1248 $this->assertSame( $recMain->getAddress(), $restMain->getAddress() );
1249 $this->assertSame( $recMain->getContentId(), $restMain->getContentId() );
1250 $this->assertSame( $recMain->getOrigin(), $restMain->getOrigin() );
1251 $this->assertSame( 'Foo', $restMain->getContent()->serialize() );
1253 // can we load it from the store?
1254 $loaded = $store->getRevisionById( $restored->getId() );
1255 $this->assertNotNull( $loaded );
1256 $this->assertRevisionCompleteness( $loaded );
1257 $this->assertRevisionRecordsEqual( $restored, $loaded );
1259 // can we find it directly in the database?
1260 $this->assertRevisionExistsInDatabase( $restored );
1264 * @covers \MediaWiki\Revision\RevisionStore::loadRevisionFromId
1266 public function testLoadRevisionFromId() {
1267 $title = Title
::newFromText( __METHOD__
);
1268 $page = WikiPage
::factory( $title );
1269 /** @var Revision $rev */
1270 $rev = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1271 ->value
['revision'];
1273 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1274 $result = $store->loadRevisionFromId( wfGetDB( DB_MASTER
), $rev->getId() );
1275 $this->assertRevisionRecordMatchesRevision( $rev, $result );
1279 * @covers \MediaWiki\Revision\RevisionStore::loadRevisionFromPageId
1281 public function testLoadRevisionFromPageId() {
1282 $title = Title
::newFromText( __METHOD__
);
1283 $page = WikiPage
::factory( $title );
1284 /** @var Revision $rev */
1285 $rev = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1286 ->value
['revision'];
1288 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1289 $result = $store->loadRevisionFromPageId( wfGetDB( DB_MASTER
), $page->getId() );
1290 $this->assertRevisionRecordMatchesRevision( $rev, $result );
1294 * @covers \MediaWiki\Revision\RevisionStore::loadRevisionFromTitle
1296 public function testLoadRevisionFromTitle() {
1297 $title = Title
::newFromText( __METHOD__
);
1298 $page = WikiPage
::factory( $title );
1299 /** @var Revision $rev */
1300 $rev = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1301 ->value
['revision'];
1303 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1304 $result = $store->loadRevisionFromTitle( wfGetDB( DB_MASTER
), $title );
1305 $this->assertRevisionRecordMatchesRevision( $rev, $result );
1309 * @covers \MediaWiki\Revision\RevisionStore::loadRevisionFromTimestamp
1311 public function testLoadRevisionFromTimestamp() {
1312 $title = Title
::newFromText( __METHOD__
);
1313 $page = WikiPage
::factory( $title );
1314 /** @var Revision $revOne */
1315 $revOne = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1316 ->value
['revision'];
1317 // Sleep to ensure different timestamps... )(evil)
1319 /** @var Revision $revTwo */
1320 $revTwo = $page->doEditContent( new WikitextContent( __METHOD__
. 'a' ), '' )
1321 ->value
['revision'];
1323 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1325 $store->loadRevisionFromTimestamp( wfGetDB( DB_MASTER
), $title, '20150101010101' )
1329 $store->loadRevisionFromTimestamp(
1330 wfGetDB( DB_MASTER
),
1332 $revOne->getTimestamp()
1337 $store->loadRevisionFromTimestamp(
1338 wfGetDB( DB_MASTER
),
1340 $revTwo->getTimestamp()
1346 * @covers \MediaWiki\Revision\RevisionStore::listRevisionSizes
1348 public function testGetParentLengths() {
1349 $page = WikiPage
::factory( Title
::newFromText( __METHOD__
) );
1350 /** @var Revision $revOne */
1351 $revOne = $page->doEditContent(
1352 new WikitextContent( __METHOD__
), __METHOD__
1353 )->value
['revision'];
1354 /** @var Revision $revTwo */
1355 $revTwo = $page->doEditContent(
1356 new WikitextContent( __METHOD__
. '2' ), __METHOD__
1357 )->value
['revision'];
1359 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1362 $revOne->getId() => strlen( __METHOD__
),
1364 $store->listRevisionSizes(
1365 wfGetDB( DB_MASTER
),
1366 [ $revOne->getId() ]
1371 $revOne->getId() => strlen( __METHOD__
),
1372 $revTwo->getId() => strlen( __METHOD__
) +
1,
1374 $store->listRevisionSizes(
1375 wfGetDB( DB_MASTER
),
1376 [ $revOne->getId(), $revTwo->getId() ]
1382 * @covers \MediaWiki\Revision\RevisionStore::getPreviousRevision
1384 public function testGetPreviousRevision() {
1385 $page = WikiPage
::factory( Title
::newFromText( __METHOD__
) );
1386 /** @var Revision $revOne */
1387 $revOne = $page->doEditContent(
1388 new WikitextContent( __METHOD__
), __METHOD__
1389 )->value
['revision'];
1390 /** @var Revision $revTwo */
1391 $revTwo = $page->doEditContent(
1392 new WikitextContent( __METHOD__
. '2' ), __METHOD__
1393 )->value
['revision'];
1395 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1397 $store->getPreviousRevision( $store->getRevisionById( $revOne->getId() ) )
1401 $store->getPreviousRevision( $store->getRevisionById( $revTwo->getId() ) )->getId()
1406 * @covers \MediaWiki\Revision\RevisionStore::getNextRevision
1408 public function testGetNextRevision() {
1409 $page = WikiPage
::factory( Title
::newFromText( __METHOD__
) );
1410 /** @var Revision $revOne */
1411 $revOne = $page->doEditContent(
1412 new WikitextContent( __METHOD__
), __METHOD__
1413 )->value
['revision'];
1414 /** @var Revision $revTwo */
1415 $revTwo = $page->doEditContent(
1416 new WikitextContent( __METHOD__
. '2' ), __METHOD__
1417 )->value
['revision'];
1419 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1422 $store->getNextRevision( $store->getRevisionById( $revOne->getId() ) )->getId()
1425 $store->getNextRevision( $store->getRevisionById( $revTwo->getId() ) )
1429 public function provideNonHistoryRevision() {
1430 $title = Title
::newFromText( __METHOD__
);
1431 $rev = new MutableRevisionRecord( $title );
1434 $user = new UserIdentityValue( 7, 'Frank', 0 );
1435 $comment = CommentStoreComment
::newUnsavedComment( 'Test' );
1438 'ar_rev_id' => 34567,
1441 'ar_minor_edit' => 0,
1442 'ar_timestamp' => '20180101020202',
1444 $slots = new RevisionSlots( [] );
1445 $rev = new RevisionArchiveRecord( $title, $user, $comment, $row, $slots );
1450 * @dataProvider provideNonHistoryRevision
1451 * @covers \MediaWiki\Revision\RevisionStore::getPreviousRevision
1453 public function testGetPreviousRevision_bad( RevisionRecord
$rev ) {
1454 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1455 $this->assertNull( $store->getPreviousRevision( $rev ) );
1459 * @dataProvider provideNonHistoryRevision
1460 * @covers \MediaWiki\Revision\RevisionStore::getNextRevision
1462 public function testGetNextRevision_bad( RevisionRecord
$rev ) {
1463 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1464 $this->assertNull( $store->getNextRevision( $rev ) );
1468 * @covers \MediaWiki\Revision\RevisionStore::getTimestampFromId
1470 public function testGetTimestampFromId_found() {
1471 $page = $this->getTestPage();
1472 /** @var Revision $rev */
1473 $rev = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1474 ->value
['revision'];
1476 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1477 $result = $store->getTimestampFromId( $rev->getId() );
1479 $this->assertSame( $rev->getTimestamp(), $result );
1483 * @covers \MediaWiki\Revision\RevisionStore::getTimestampFromId
1485 public function testGetTimestampFromId_notFound() {
1486 $page = $this->getTestPage();
1487 /** @var Revision $rev */
1488 $rev = $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
)
1489 ->value
['revision'];
1491 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1492 $result = $store->getTimestampFromId( $rev->getId() +
1 );
1494 $this->assertFalse( $result );
1498 * @covers \MediaWiki\Revision\RevisionStore::countRevisionsByPageId
1500 public function testCountRevisionsByPageId() {
1501 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1502 $page = WikiPage
::factory( Title
::newFromText( __METHOD__
) );
1506 $store->countRevisionsByPageId( wfGetDB( DB_MASTER
), $page->getId() )
1508 $page->doEditContent( new WikitextContent( 'a' ), 'a' );
1511 $store->countRevisionsByPageId( wfGetDB( DB_MASTER
), $page->getId() )
1513 $page->doEditContent( new WikitextContent( 'b' ), 'b' );
1516 $store->countRevisionsByPageId( wfGetDB( DB_MASTER
), $page->getId() )
1521 * @covers \MediaWiki\Revision\RevisionStore::countRevisionsByTitle
1523 public function testCountRevisionsByTitle() {
1524 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1525 $page = WikiPage
::factory( Title
::newFromText( __METHOD__
) );
1529 $store->countRevisionsByTitle( wfGetDB( DB_MASTER
), $page->getTitle() )
1531 $page->doEditContent( new WikitextContent( 'a' ), 'a' );
1534 $store->countRevisionsByTitle( wfGetDB( DB_MASTER
), $page->getTitle() )
1536 $page->doEditContent( new WikitextContent( 'b' ), 'b' );
1539 $store->countRevisionsByTitle( wfGetDB( DB_MASTER
), $page->getTitle() )
1544 * @covers \MediaWiki\Revision\RevisionStore::userWasLastToEdit
1546 public function testUserWasLastToEdit_false() {
1547 $sysop = $this->getTestSysop()->getUser();
1548 $page = $this->getTestPage();
1549 $page->doEditContent( new WikitextContent( __METHOD__
), __METHOD__
);
1551 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1552 $result = $store->userWasLastToEdit(
1553 wfGetDB( DB_MASTER
),
1558 $this->assertFalse( $result );
1562 * @covers \MediaWiki\Revision\RevisionStore::userWasLastToEdit
1564 public function testUserWasLastToEdit_true() {
1565 $startTime = wfTimestampNow();
1566 $sysop = $this->getTestSysop()->getUser();
1567 $page = $this->getTestPage();
1568 $page->doEditContent(
1569 new WikitextContent( __METHOD__
),
1576 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1577 $result = $store->userWasLastToEdit(
1578 wfGetDB( DB_MASTER
),
1583 $this->assertTrue( $result );
1587 * @covers \MediaWiki\Revision\RevisionStore::getKnownCurrentRevision
1589 public function testGetKnownCurrentRevision() {
1590 $page = $this->getTestPage();
1591 /** @var Revision $rev */
1592 $rev = $page->doEditContent(
1593 new WikitextContent( __METHOD__
. 'b' ),
1597 $this->getTestUser()->getUser()
1598 )->value
['revision'];
1600 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1601 $record = $store->getKnownCurrentRevision(
1606 $this->assertRevisionRecordMatchesRevision( $rev, $record );
1609 public function provideNewMutableRevisionFromArray() {
1610 yield
'Basic array, content object' => [
1614 'timestamp' => '20171017114835',
1615 'user_text' => '111.0.1.2',
1617 'minor_edit' => false,
1621 'sha1' => 'rdqbbzs3pkhihgbs8qf2q9jsvheag5z',
1622 'comment' => 'Goat Comment!',
1623 'content' => new WikitextContent( 'Some Content' ),
1626 yield
'Basic array, serialized text' => [
1630 'timestamp' => '20171017114835',
1631 'user_text' => '111.0.1.2',
1633 'minor_edit' => false,
1637 'sha1' => 'rdqbbzs3pkhihgbs8qf2q9jsvheag5z',
1638 'comment' => 'Goat Comment!',
1639 'text' => ( new WikitextContent( 'Sรถme Content' ) )->serialize(),
1642 yield
'Basic array, serialized text, utf-8 flags' => [
1646 'timestamp' => '20171017114835',
1647 'user_text' => '111.0.1.2',
1649 'minor_edit' => false,
1653 'sha1' => 'rdqbbzs3pkhihgbs8qf2q9jsvheag5z',
1654 'comment' => 'Goat Comment!',
1655 'text' => ( new WikitextContent( 'Sรถme Content' ) )->serialize(),
1659 yield
'Basic array, with title' => [
1661 'title' => Title
::newFromText( 'SomeText' ),
1662 'timestamp' => '20171017114835',
1663 'user_text' => '111.0.1.2',
1665 'minor_edit' => false,
1669 'sha1' => 'rdqbbzs3pkhihgbs8qf2q9jsvheag5z',
1670 'comment' => 'Goat Comment!',
1671 'content' => new WikitextContent( 'Some Content' ),
1674 yield
'Basic array, no user field' => [
1678 'timestamp' => '20171017114835',
1679 'user_text' => '111.0.1.3',
1680 'minor_edit' => false,
1684 'sha1' => 'rdqbbzs3pkhihgbs8qf2q9jsvheag5z',
1685 'comment' => 'Goat Comment!',
1686 'content' => new WikitextContent( 'Some Content' ),
1692 * @dataProvider provideNewMutableRevisionFromArray
1693 * @covers \MediaWiki\Revision\RevisionStore::newMutableRevisionFromArray
1695 public function testNewMutableRevisionFromArray( array $array ) {
1696 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1698 // HACK: if $array['page'] is given, make sure that the page exists
1699 if ( isset( $array['page'] ) ) {
1700 $t = Title
::newFromID( $array['page'] );
1701 if ( !$t ||
!$t->exists() ) {
1702 $t = Title
::makeTitle( NS_MAIN
, __METHOD__
);
1703 $info = $this->insertPage( $t );
1704 $array['page'] = $info['id'];
1708 $result = $store->newMutableRevisionFromArray( $array );
1710 if ( isset( $array['id'] ) ) {
1711 $this->assertSame( $array['id'], $result->getId() );
1713 if ( isset( $array['page'] ) ) {
1714 $this->assertSame( $array['page'], $result->getPageId() );
1716 $this->assertSame( $array['timestamp'], $result->getTimestamp() );
1717 $this->assertSame( $array['user_text'], $result->getUser()->getName() );
1718 if ( isset( $array['user'] ) ) {
1719 $this->assertSame( $array['user'], $result->getUser()->getId() );
1721 $this->assertSame( (bool)$array['minor_edit'], $result->isMinor() );
1722 $this->assertSame( $array['deleted'], $result->getVisibility() );
1723 $this->assertSame( $array['len'], $result->getSize() );
1724 $this->assertSame( $array['parent_id'], $result->getParentId() );
1725 $this->assertSame( $array['sha1'], $result->getSha1() );
1726 $this->assertSame( $array['comment'], $result->getComment()->text
);
1727 if ( isset( $array['content'] ) ) {
1728 foreach ( $array['content'] as $role => $content ) {
1730 $result->getContent( $role )->equals( $content )
1733 } elseif ( isset( $array['text'] ) ) {
1734 $this->assertSame( $array['text'],
1735 $result->getSlot( SlotRecord
::MAIN
)->getContent()->serialize() );
1736 } elseif ( isset( $array['content_format'] ) ) {
1738 $array['content_format'],
1739 $result->getSlot( SlotRecord
::MAIN
)->getContent()->getDefaultFormat()
1741 $this->assertSame( $array['content_model'], $result->getSlot( SlotRecord
::MAIN
)->getModel() );
1746 * @dataProvider provideNewMutableRevisionFromArray
1747 * @covers \MediaWiki\Revision\RevisionStore::newMutableRevisionFromArray
1749 public function testNewMutableRevisionFromArray_legacyEncoding( array $array ) {
1750 $cache = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
1751 $services = MediaWikiServices
::getInstance();
1752 $lb = $services->getDBLoadBalancer();
1753 $access = $services->getExternalStoreAccess();
1754 $blobStore = new SqlBlobStore( $lb, $access, $cache );
1755 $blobStore->setLegacyEncoding( 'windows-1252', Language
::factory( 'en' ) );
1757 $factory = $this->getMockBuilder( BlobStoreFactory
::class )
1758 ->setMethods( [ 'newBlobStore', 'newSqlBlobStore' ] )
1759 ->disableOriginalConstructor()
1761 $factory->expects( $this->any() )
1762 ->method( 'newBlobStore' )
1763 ->willReturn( $blobStore );
1764 $factory->expects( $this->any() )
1765 ->method( 'newSqlBlobStore' )
1766 ->willReturn( $blobStore );
1768 $this->setService( 'BlobStoreFactory', $factory );
1770 $this->testNewMutableRevisionFromArray( $array );
1774 * Creates a new revision for testing caching behavior
1776 * @param WikiPage $page the page for the new revision
1777 * @param RevisionStore $store store object to use for creating the revision
1778 * @return bool|RevisionStoreRecord the revision created, or false if missing
1780 private function createRevisionStoreCacheRecord( $page, $store ) {
1781 $user = MediaWikiTestCase
::getMutableTestUser()->getUser();
1782 $updater = $page->newPageUpdater( $user );
1783 $updater->setContent( SlotRecord
::MAIN
, new WikitextContent( __METHOD__
) );
1784 $summary = CommentStoreComment
::newUnsavedComment( __METHOD__
);
1785 $rev = $updater->saveRevision( $summary, EDIT_NEW
);
1786 return $store->getKnownCurrentRevision( $page->getTitle(), $rev->getId() );
1790 * @covers \MediaWiki\Revision\RevisionStore::getKnownCurrentRevision
1792 public function testGetKnownCurrentRevision_userNameChange() {
1793 $cache = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
1794 $this->setService( 'MainWANObjectCache', $cache );
1796 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1797 $page = $this->getNonexistingTestPage();
1798 $rev = $this->createRevisionStoreCacheRecord( $page, $store );
1800 // Grab the user name
1801 $userNameBefore = $rev->getUser()->getName();
1803 // Change the user name in the database, "behind the back" of the cache
1804 $newUserName = "Renamed $userNameBefore";
1805 $this->db
->update( 'revision',
1806 [ 'rev_user_text' => $newUserName ],
1807 [ 'rev_id' => $rev->getId() ] );
1808 $this->db
->update( 'user',
1809 [ 'user_name' => $newUserName ],
1810 [ 'user_id' => $rev->getUser()->getId() ] );
1811 $this->db
->update( 'actor',
1812 [ 'actor_name' => $newUserName ],
1813 [ 'actor_user' => $rev->getUser()->getId() ] );
1815 // Reload the revision and regrab the user name.
1816 $revAfter = $store->getKnownCurrentRevision( $page->getTitle(), $rev->getId() );
1817 $userNameAfter = $revAfter->getUser()->getName();
1819 // The two user names should be different.
1820 // If they are the same, we are seeing a cached value, which is bad.
1821 $this->assertNotSame( $userNameBefore, $userNameAfter );
1823 // This is implied by the above assertion, but explicitly check it, for completeness
1824 $this->assertSame( $newUserName, $userNameAfter );
1828 * @covers \MediaWiki\Revision\RevisionStore::getKnownCurrentRevision
1830 public function testGetKnownCurrentRevision_revDelete() {
1831 $cache = new WANObjectCache( [ 'cache' => new HashBagOStuff() ] );
1832 $this->setService( 'MainWANObjectCache', $cache );
1834 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1835 $page = $this->getNonexistingTestPage();
1836 $rev = $this->createRevisionStoreCacheRecord( $page, $store );
1838 // Grab the deleted bitmask
1839 $deletedBefore = $rev->getVisibility();
1841 // Change the deleted bitmask in the database, "behind the back" of the cache
1842 $this->db
->update( 'revision',
1843 [ 'rev_deleted' => RevisionRecord
::DELETED_TEXT
],
1844 [ 'rev_id' => $rev->getId() ] );
1846 // Reload the revision and regrab the visibility flag.
1847 $revAfter = $store->getKnownCurrentRevision( $page->getTitle(), $rev->getId() );
1848 $deletedAfter = $revAfter->getVisibility();
1850 // The two deleted flags should be different.
1851 // If they are the same, we are seeing a cached value, which is bad.
1852 $this->assertNotSame( $deletedBefore, $deletedAfter );
1854 // This is implied by the above assertion, but explicitly check it, for completeness
1855 $this->assertSame( RevisionRecord
::DELETED_TEXT
, $deletedAfter );
1859 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
1861 public function testNewRevisionFromRow_userNameChange() {
1862 $page = $this->getTestPage();
1864 /** @var Revision $rev */
1865 $rev = $page->doEditContent(
1866 new WikitextContent( $text ),
1870 $this->getMutableTestUser()->getUser()
1871 )->value
['revision'];
1873 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1874 $record = $store->newRevisionFromRow(
1875 $this->revisionToRow( $rev ),
1880 // Grab the user name
1881 $userNameBefore = $record->getUser()->getName();
1883 // Change the user name in the database
1884 $newUserName = "Renamed $userNameBefore";
1885 $this->db
->update( 'revision',
1886 [ 'rev_user_text' => $newUserName ],
1887 [ 'rev_id' => $record->getId() ] );
1888 $this->db
->update( 'user',
1889 [ 'user_name' => $newUserName ],
1890 [ 'user_id' => $record->getUser()->getId() ] );
1891 $this->db
->update( 'actor',
1892 [ 'actor_name' => $newUserName ],
1893 [ 'actor_user' => $record->getUser()->getId() ] );
1895 // Reload the record, passing $fromCache as true to force fresh info from the db,
1896 // and regrab the user name
1897 $recordAfter = $store->newRevisionFromRow(
1898 $this->revisionToRow( $rev ),
1903 $userNameAfter = $recordAfter->getUser()->getName();
1905 // The two user names should be different.
1906 // If they are the same, we are seeing a cached value, which is bad.
1907 $this->assertNotSame( $userNameBefore, $userNameAfter );
1909 // This is implied by the above assertion, but explicitly check it, for completeness
1910 $this->assertSame( $newUserName, $userNameAfter );
1914 * @covers \MediaWiki\Revision\RevisionStore::newRevisionFromRow
1916 public function testNewRevisionFromRow_revDelete() {
1917 $page = $this->getTestPage();
1919 /** @var Revision $rev */
1920 $rev = $page->doEditContent(
1921 new WikitextContent( $text ),
1923 )->value
['revision'];
1925 $store = MediaWikiServices
::getInstance()->getRevisionStore();
1926 $record = $store->newRevisionFromRow(
1927 $this->revisionToRow( $rev ),
1932 // Grab the deleted bitmask
1933 $deletedBefore = $record->getVisibility();
1935 // Change the deleted bitmask in the database
1936 $this->db
->update( 'revision',
1937 [ 'rev_deleted' => RevisionRecord
::DELETED_TEXT
],
1938 [ 'rev_id' => $record->getId() ] );
1940 // Reload the record, passing $fromCache as true to force fresh info from the db,
1941 // and regrab the deleted bitmask
1942 $recordAfter = $store->newRevisionFromRow(
1943 $this->revisionToRow( $rev ),
1948 $deletedAfter = $recordAfter->getVisibility();
1950 // The two deleted flags should be different, because we modified the database.
1951 $this->assertNotSame( $deletedBefore, $deletedAfter );
1953 // This is implied by the above assertion, but explicitly check it, for completeness
1954 $this->assertSame( RevisionRecord
::DELETED_TEXT
, $deletedAfter );
1957 public function provideNewRevisionsFromBatchOptions() {
1958 yield
'No preload slots or content, single page' => [
1962 yield
'Preload slots and content, single page' => [
1965 'slots' => [ SlotRecord
::MAIN
],
1969 yield
'No preload slots or content, multiple pages' => [
1973 yield
'Preload slots and content, multiple pages' => [
1976 'slots' => [ SlotRecord
::MAIN
],
1983 * @dataProvider provideNewRevisionsFromBatchOptions
1984 * @covers \MediaWiki\Revision\RevisionStore::newRevisionsFromBatch
1985 * @param string|null $otherPageTitle
1986 * @param array|null $options
1987 * @throws \MWException
1989 public function testNewRevisionsFromBatch_preloadContent(
1990 $otherPageTitle = null,
1993 $page1 = $this->getTestPage();
1994 $text = __METHOD__
. 'b-รค';
1995 /** @var Revision $rev1 */
1996 $rev1 = $page1->doEditContent(
1997 new WikitextContent( $text . '1' ),
2001 $this->getTestUser()->getUser()
2002 )->value
['revision'];
2003 $page2 = $this->getTestPage( $otherPageTitle );
2004 /** @var Revision $rev2 */
2005 $rev2 = $page2->doEditContent(
2006 new WikitextContent( $text . '2' ),
2010 $this->getTestUser()->getUser()
2011 )->value
['revision'];
2012 $store = MediaWikiServices
::getInstance()->getRevisionStore();
2013 $result = $store->newRevisionsFromBatch(
2014 [ $this->revisionToRow( $rev1 ), $this->revisionToRow( $rev2 ) ],
2017 $this->assertTrue( $result->isGood() );
2018 $this->assertEmpty( $result->getErrors() );
2019 $records = $result->getValue();
2020 $this->assertRevisionRecordMatchesRevision( $rev1, $records[$rev1->getId()] );
2021 $this->assertRevisionRecordMatchesRevision( $rev2, $records[$rev2->getId()] );
2023 $this->assertSame( $text . '1',
2024 $records[$rev1->getId()]->getContent( SlotRecord
::MAIN
)->serialize() );
2025 $this->assertSame( $text . '2',
2026 $records[$rev2->getId()]->getContent( SlotRecord
::MAIN
)->serialize() );
2027 $this->assertEquals( $page1->getTitle()->getDBkey(),
2028 $records[$rev1->getId()]->getPageAsLinkTarget()->getDBkey() );
2029 $this->assertEquals( $page2->getTitle()->getDBkey(),
2030 $records[$rev2->getId()]->getPageAsLinkTarget()->getDBkey() );
2034 * @covers \MediaWiki\Revision\RevisionStore::newRevisionsFromBatch
2036 public function testNewRevisionsFromBatch_emptyBatch() {
2037 $result = MediaWikiServices
::getInstance()->getRevisionStore()
2038 ->newRevisionsFromBatch(
2041 'slots' => [ SlotRecord
::MAIN
],
2045 $this->assertTrue( $result->isGood() );
2046 $this->assertEmpty( $result->getValue() );
2047 $this->assertEmpty( $result->getErrors() );