3 * Service for looking up page revisions.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * Attribution notice: when this file was created, much of its content was taken
21 * from the Revision.php file as present in release 1.30. Refer to the history
22 * of that file for original authorship.
27 namespace MediaWiki\Storage
;
31 use CommentStoreComment
;
34 use DBAccessObjectUtils
;
37 use InvalidArgumentException
;
40 use MediaWiki\Linker\LinkTarget
;
41 use MediaWiki\User\UserIdentity
;
42 use MediaWiki\User\UserIdentityValue
;
45 use MWUnknownContentModelException
;
46 use Psr\Log\LoggerAwareInterface
;
47 use Psr\Log\LoggerInterface
;
48 use Psr\Log\NullLogger
;
54 use Wikimedia\Assert\Assert
;
55 use Wikimedia\Rdbms\Database
;
56 use Wikimedia\Rdbms\DBConnRef
;
57 use Wikimedia\Rdbms\IDatabase
;
58 use Wikimedia\Rdbms\LoadBalancer
;
61 * Service for looking up page revisions.
65 * @note This was written to act as a drop-in replacement for the corresponding
66 * static methods in Revision.
69 implements IDBAccessObject
, RevisionFactory
, RevisionLookup
, LoggerAwareInterface
{
84 private $contentHandlerUseDB = true;
89 private $loadBalancer;
99 private $commentStore;
102 * @var ActorMigration
104 private $actorMigration;
107 * @var LoggerInterface
112 * @todo $blobStore should be allowed to be any BlobStore!
114 * @param LoadBalancer $loadBalancer
115 * @param SqlBlobStore $blobStore
116 * @param WANObjectCache $cache
117 * @param CommentStore $commentStore
118 * @param ActorMigration $actorMigration
119 * @param bool|string $wikiId
121 public function __construct(
122 LoadBalancer
$loadBalancer,
123 SqlBlobStore
$blobStore,
124 WANObjectCache
$cache,
125 CommentStore
$commentStore,
126 ActorMigration
$actorMigration,
129 Assert
::parameterType( 'string|boolean', $wikiId, '$wikiId' );
131 $this->loadBalancer
= $loadBalancer;
132 $this->blobStore
= $blobStore;
133 $this->cache
= $cache;
134 $this->commentStore
= $commentStore;
135 $this->actorMigration
= $actorMigration;
136 $this->wikiId
= $wikiId;
137 $this->logger
= new NullLogger();
140 public function setLogger( LoggerInterface
$logger ) {
141 $this->logger
= $logger;
145 * @return bool Whether the store is read-only
147 public function isReadOnly() {
148 return $this->blobStore
->isReadOnly();
154 public function getContentHandlerUseDB() {
155 return $this->contentHandlerUseDB
;
159 * @param bool $contentHandlerUseDB
161 public function setContentHandlerUseDB( $contentHandlerUseDB ) {
162 $this->contentHandlerUseDB
= $contentHandlerUseDB;
166 * @return LoadBalancer
168 private function getDBLoadBalancer() {
169 return $this->loadBalancer
;
173 * @param int $mode DB_MASTER or DB_REPLICA
177 private function getDBConnection( $mode ) {
178 $lb = $this->getDBLoadBalancer();
179 return $lb->getConnection( $mode, [], $this->wikiId
);
183 * @param IDatabase $connection
185 private function releaseDBConnection( IDatabase
$connection ) {
186 $lb = $this->getDBLoadBalancer();
187 $lb->reuseConnection( $connection );
191 * @param int $mode DB_MASTER or DB_REPLICA
195 private function getDBConnectionRef( $mode ) {
196 $lb = $this->getDBLoadBalancer();
197 return $lb->getConnectionRef( $mode, [], $this->wikiId
);
201 * Determines the page Title based on the available information.
203 * MCR migration note: this corresponds to Revision::getTitle
205 * @note this method should be private, external use should be avoided!
207 * @param int|null $pageId
208 * @param int|null $revId
209 * @param int $queryFlags
212 * @throws RevisionAccessException
214 public function getTitle( $pageId, $revId, $queryFlags = self
::READ_NORMAL
) {
215 if ( !$pageId && !$revId ) {
216 throw new InvalidArgumentException( '$pageId and $revId cannot both be 0 or null' );
219 // This method recalls itself with READ_LATEST if READ_NORMAL doesn't get us a Title
220 // So ignore READ_LATEST_IMMUTABLE flags and handle the fallback logic in this method
221 if ( DBAccessObjectUtils
::hasFlags( $queryFlags, self
::READ_LATEST_IMMUTABLE
) ) {
222 $queryFlags = self
::READ_NORMAL
;
225 $canUseTitleNewFromId = ( $pageId !== null && $pageId > 0 && $this->wikiId
=== false );
226 list( $dbMode, $dbOptions ) = DBAccessObjectUtils
::getDBOptions( $queryFlags );
227 $titleFlags = ( $dbMode == DB_MASTER ? Title
::GAID_FOR_UPDATE
: 0 );
229 // Loading by ID is best, but Title::newFromID does not support that for foreign IDs.
230 if ( $canUseTitleNewFromId ) {
231 // TODO: better foreign title handling (introduce TitleFactory)
232 $title = Title
::newFromID( $pageId, $titleFlags );
238 // rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
239 $canUseRevId = ( $revId !== null && $revId > 0 );
241 if ( $canUseRevId ) {
242 $dbr = $this->getDBConnectionRef( $dbMode );
243 // @todo: Title::getSelectFields(), or Title::getQueryInfo(), or something like that
244 $row = $dbr->selectRow(
245 [ 'revision', 'page' ],
254 [ 'rev_id' => $revId ],
257 [ 'page' => [ 'JOIN', 'page_id=rev_page' ] ]
260 // TODO: better foreign title handling (introduce TitleFactory)
261 return Title
::newFromRow( $row );
265 // If we still don't have a title, fallback to master if that wasn't already happening.
266 if ( $dbMode !== DB_MASTER
) {
267 $title = $this->getTitle( $pageId, $revId, self
::READ_LATEST
);
270 __METHOD__
. ' fell back to READ_LATEST and got a Title.',
271 [ 'trace' => wfBacktrace() ]
277 throw new RevisionAccessException(
278 "Could not determine title for page ID $pageId and revision ID $revId"
283 * @param mixed $value
284 * @param string $name
286 * @throw IncompleteRevisionException if $value is null
287 * @return mixed $value, if $value is not null
289 private function failOnNull( $value, $name ) {
290 if ( $value === null ) {
291 throw new IncompleteRevisionException(
292 "$name must not be " . var_export( $value, true ) . "!"
300 * @param mixed $value
301 * @param string $name
303 * @throw IncompleteRevisionException if $value is empty
304 * @return mixed $value, if $value is not null
306 private function failOnEmpty( $value, $name ) {
307 if ( $value === null ||
$value === 0 ||
$value === '' ) {
308 throw new IncompleteRevisionException(
309 "$name must not be " . var_export( $value, true ) . "!"
317 * Insert a new revision into the database, returning the new revision record
318 * on success and dies horribly on failure.
320 * MCR migration note: this replaces Revision::insertOn
322 * @param RevisionRecord $rev
323 * @param IDatabase $dbw (master connection)
325 * @throws InvalidArgumentException
326 * @return RevisionRecord the new revision record.
328 public function insertRevisionOn( RevisionRecord
$rev, IDatabase
$dbw ) {
329 // TODO: pass in a DBTransactionContext instead of a database connection.
330 $this->checkDatabaseWikiId( $dbw );
332 if ( !$rev->getSlotRoles() ) {
333 throw new InvalidArgumentException( 'At least one slot needs to be defined!' );
336 if ( $rev->getSlotRoles() !== [ 'main' ] ) {
337 throw new InvalidArgumentException( 'Only the main slot is supported for now!' );
340 // TODO: we shouldn't need an actual Title here.
341 $title = Title
::newFromLinkTarget( $rev->getPageAsLinkTarget() );
342 $pageId = $this->failOnEmpty( $rev->getPageId(), 'rev_page field' ); // check this early
344 $parentId = $rev->getParentId() === null
345 ?
$this->getPreviousRevisionId( $dbw, $rev )
346 : $rev->getParentId();
348 // Record the text (or external storage URL) to the blob store
349 $slot = $rev->getSlot( 'main', RevisionRecord
::RAW
);
351 $size = $this->failOnNull( $rev->getSize(), 'size field' );
352 $sha1 = $this->failOnEmpty( $rev->getSha1(), 'sha1 field' );
354 if ( !$slot->hasAddress() ) {
355 $content = $slot->getContent();
356 $format = $content->getDefaultFormat();
357 $model = $content->getModel();
359 $this->checkContentModel( $content, $title );
361 $data = $content->serialize( $format );
363 // Hints allow the blob store to optimize by "leaking" application level information to it.
364 // TODO: with the new MCR storage schema, we rev_id have this before storing the blobs.
365 // When we have it, add rev_id as a hint. Can be used with rev_parent_id for
366 // differential storage or compression of subsequent revisions.
368 BlobStore
::DESIGNATION_HINT
=> 'page-content', // BlobStore may be used for other things too.
369 BlobStore
::PAGE_HINT
=> $pageId,
370 BlobStore
::ROLE_HINT
=> $slot->getRole(),
371 BlobStore
::PARENT_HINT
=> $parentId,
372 BlobStore
::SHA1_HINT
=> $slot->getSha1(),
373 BlobStore
::MODEL_HINT
=> $model,
374 BlobStore
::FORMAT_HINT
=> $format,
377 $blobAddress = $this->blobStore
->storeBlob( $data, $blobHints );
379 $blobAddress = $slot->getAddress();
380 $model = $slot->getModel();
381 $format = $slot->getFormat();
384 $textId = $this->blobStore
->getTextIdFromAddress( $blobAddress );
387 throw new LogicException(
388 'Blob address not supported in 1.29 database schema: ' . $blobAddress
392 // getTextIdFromAddress() is free to insert something into the text table, so $textId
393 // may be a new value, not anything already contained in $blobAddress.
394 $blobAddress = SqlBlobStore
::makeAddressFromTextId( $textId );
396 $comment = $this->failOnNull( $rev->getComment( RevisionRecord
::RAW
), 'comment' );
397 $user = $this->failOnNull( $rev->getUser( RevisionRecord
::RAW
), 'user' );
398 $timestamp = $this->failOnEmpty( $rev->getTimestamp(), 'timestamp field' );
401 $this->failOnNull( $user->getId(), 'user field' );
402 $this->failOnEmpty( $user->getName(), 'user_text field' );
404 # Record the edit in revisions
406 'rev_page' => $pageId,
407 'rev_parent_id' => $parentId,
408 'rev_text_id' => $textId,
409 'rev_minor_edit' => $rev->isMinor() ?
1 : 0,
410 'rev_timestamp' => $dbw->timestamp( $timestamp ),
411 'rev_deleted' => $rev->getVisibility(),
416 if ( $rev->getId() !== null ) {
417 // Needed to restore revisions with their original ID
418 $row['rev_id'] = $rev->getId();
421 list( $commentFields, $commentCallback ) =
422 $this->commentStore
->insertWithTempTable( $dbw, 'rev_comment', $comment );
423 $row +
= $commentFields;
425 list( $actorFields, $actorCallback ) =
426 $this->actorMigration
->getInsertValuesWithTempTable( $dbw, 'rev_user', $user );
427 $row +
= $actorFields;
429 if ( $this->contentHandlerUseDB
) {
430 // MCR migration note: rev_content_model and rev_content_format will go away
432 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
433 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
435 $row['rev_content_model'] = ( $model === $defaultModel ) ?
null : $model;
436 $row['rev_content_format'] = ( $format === $defaultFormat ) ?
null : $format;
439 $dbw->insert( 'revision', $row, __METHOD__
);
441 if ( !isset( $row['rev_id'] ) ) {
442 // only if auto-increment was used
443 $row['rev_id'] = intval( $dbw->insertId() );
445 $commentCallback( $row['rev_id'] );
446 $actorCallback( $row['rev_id'], $row );
448 // Insert IP revision into ip_changes for use when querying for a range.
449 if ( $user->getId() === 0 && IP
::isValid( $user->getName() ) ) {
451 'ipc_rev_id' => $row['rev_id'],
452 'ipc_rev_timestamp' => $row['rev_timestamp'],
453 'ipc_hex' => IP
::toHex( $user->getName() ),
455 $dbw->insert( 'ip_changes', $ipcRow, __METHOD__
);
458 $newSlot = SlotRecord
::newSaved( $row['rev_id'], $textId, $blobAddress, $slot );
459 $slots = new RevisionSlots( [ 'main' => $newSlot ] );
461 $rev = new RevisionStoreRecord(
470 $newSlot = $rev->getSlot( 'main', RevisionRecord
::RAW
);
473 Assert
::postcondition( $rev->getId() > 0, 'revision must have an ID' );
474 Assert
::postcondition( $rev->getPageId() > 0, 'revision must have a page ID' );
475 Assert
::postcondition(
476 $rev->getComment( RevisionRecord
::RAW
) !== null,
477 'revision must have a comment'
479 Assert
::postcondition(
480 $rev->getUser( RevisionRecord
::RAW
) !== null,
481 'revision must have a user'
484 Assert
::postcondition( $newSlot !== null, 'revision must have a main slot' );
485 Assert
::postcondition(
486 $newSlot->getAddress() !== null,
487 'main slot must have an addess'
490 Hooks
::run( 'RevisionRecordInserted', [ $rev ] );
496 * MCR migration note: this corresponds to Revision::checkContentModel
498 * @param Content $content
499 * @param Title $title
501 * @throws MWException
502 * @throws MWUnknownContentModelException
504 private function checkContentModel( Content
$content, Title
$title ) {
505 // Note: may return null for revisions that have not yet been inserted
507 $model = $content->getModel();
508 $format = $content->getDefaultFormat();
509 $handler = $content->getContentHandler();
513 if ( !$handler->isSupportedFormat( $format ) ) {
514 throw new MWException( "Can't use format $format with content model $model on $name" );
517 if ( !$this->contentHandlerUseDB
) {
518 // if $wgContentHandlerUseDB is not set,
519 // all revisions must use the default content model and format.
521 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
522 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
523 $defaultFormat = $defaultHandler->getDefaultFormat();
525 if ( $model != $defaultModel ) {
526 throw new MWException( "Can't save non-default content model with "
527 . "\$wgContentHandlerUseDB disabled: model is $model, "
528 . "default for $name is $defaultModel"
532 if ( $format != $defaultFormat ) {
533 throw new MWException( "Can't use non-default content format with "
534 . "\$wgContentHandlerUseDB disabled: format is $format, "
535 . "default for $name is $defaultFormat"
540 if ( !$content->isValid() ) {
541 throw new MWException(
542 "New content for $name is not valid! Content model is $model"
548 * Create a new null-revision for insertion into a page's
549 * history. This will not re-save the text, but simply refer
550 * to the text from the previous version.
552 * Such revisions can for instance identify page rename
553 * operations and other such meta-modifications.
555 * MCR migration note: this replaces Revision::newNullRevision
557 * @todo Introduce newFromParentRevision(). newNullRevision can then be based on that
560 * @param IDatabase $dbw
561 * @param Title $title Title of the page to read from
562 * @param CommentStoreComment $comment RevisionRecord's summary
563 * @param bool $minor Whether the revision should be considered as minor
564 * @param User $user The user to attribute the revision to
565 * @return RevisionRecord|null RevisionRecord or null on error
567 public function newNullRevision(
570 CommentStoreComment
$comment,
574 $this->checkDatabaseWikiId( $dbw );
576 $fields = [ 'page_latest', 'page_namespace', 'page_title',
577 'rev_id', 'rev_text_id', 'rev_len', 'rev_sha1' ];
579 if ( $this->contentHandlerUseDB
) {
580 $fields[] = 'rev_content_model';
581 $fields[] = 'rev_content_format';
584 $current = $dbw->selectRow(
585 [ 'page', 'revision' ],
588 'page_id' => $title->getArticleID(),
589 'page_latest=rev_id',
592 [ 'FOR UPDATE' ] // T51581
597 'page' => $title->getArticleID(),
598 'user_text' => $user->getName(),
599 'user' => $user->getId(),
600 'actor' => $user->getActorId(),
601 'comment' => $comment,
602 'minor_edit' => $minor,
603 'text_id' => $current->rev_text_id
,
604 'parent_id' => $current->page_latest
,
605 'slot_origin' => $current->page_latest
,
606 'len' => $current->rev_len
,
607 'sha1' => $current->rev_sha1
610 if ( $this->contentHandlerUseDB
) {
611 $fields['content_model'] = $current->rev_content_model
;
612 $fields['content_format'] = $current->rev_content_format
;
615 $fields['title'] = Title
::makeTitle( $current->page_namespace
, $current->page_title
);
617 $mainSlot = $this->emulateMainSlot_1_29( $fields, self
::READ_LATEST
, $title );
618 $revision = new MutableRevisionRecord( $title, $this->wikiId
);
619 $this->initializeMutableRevisionFromArray( $revision, $fields );
620 $revision->setSlot( $mainSlot );
629 * MCR migration note: this replaces Revision::isUnpatrolled
631 * @todo This is overly specific, so move or kill this method.
633 * @param RevisionRecord $rev
635 * @return int Rcid of the unpatrolled row, zero if there isn't one
637 public function getRcIdIfUnpatrolled( RevisionRecord
$rev ) {
638 $rc = $this->getRecentChange( $rev );
639 if ( $rc && $rc->getAttribute( 'rc_patrolled' ) == RecentChange
::PRC_UNPATROLLED
) {
640 return $rc->getAttribute( 'rc_id' );
647 * Get the RC object belonging to the current revision, if there's one
649 * MCR migration note: this replaces Revision::getRecentChange
651 * @todo move this somewhere else?
653 * @param RevisionRecord $rev
654 * @param int $flags (optional) $flags include:
655 * IDBAccessObject::READ_LATEST: Select the data from the master
657 * @return null|RecentChange
659 public function getRecentChange( RevisionRecord
$rev, $flags = 0 ) {
660 $dbr = $this->getDBConnection( DB_REPLICA
);
662 list( $dbType, ) = DBAccessObjectUtils
::getDBOptions( $flags );
664 $userIdentity = $rev->getUser( RevisionRecord
::RAW
);
666 if ( !$userIdentity ) {
667 // If the revision has no user identity, chances are it never went
668 // into the database, and doesn't have an RC entry.
672 // TODO: Select by rc_this_oldid alone - but as of Nov 2017, there is no index on that!
673 $actorWhere = $this->actorMigration
->getWhere( $dbr, 'rc_user', $rev->getUser(), false );
674 $rc = RecentChange
::newFromConds(
676 $actorWhere['conds'],
677 'rc_timestamp' => $dbr->timestamp( $rev->getTimestamp() ),
678 'rc_this_oldid' => $rev->getId()
684 $this->releaseDBConnection( $dbr );
686 // XXX: cache this locally? Glue it to the RevisionRecord?
691 * Maps fields of the archive row to corresponding revision rows.
693 * @param object $archiveRow
695 * @return object a revision row object, corresponding to $archiveRow.
697 private static function mapArchiveFields( $archiveRow ) {
699 // keep with ar prefix:
702 // not the same suffix:
703 'ar_page_id' => 'rev_page',
704 'ar_rev_id' => 'rev_id',
707 'ar_text_id' => 'rev_text_id',
708 'ar_timestamp' => 'rev_timestamp',
709 'ar_user_text' => 'rev_user_text',
710 'ar_user' => 'rev_user',
711 'ar_actor' => 'rev_actor',
712 'ar_minor_edit' => 'rev_minor_edit',
713 'ar_deleted' => 'rev_deleted',
714 'ar_len' => 'rev_len',
715 'ar_parent_id' => 'rev_parent_id',
716 'ar_sha1' => 'rev_sha1',
717 'ar_comment' => 'rev_comment',
718 'ar_comment_cid' => 'rev_comment_cid',
719 'ar_comment_id' => 'rev_comment_id',
720 'ar_comment_text' => 'rev_comment_text',
721 'ar_comment_data' => 'rev_comment_data',
722 'ar_comment_old' => 'rev_comment_old',
723 'ar_content_format' => 'rev_content_format',
724 'ar_content_model' => 'rev_content_model',
727 if ( empty( $archiveRow->ar_text_id
) ) {
728 $fieldMap['ar_text'] = 'old_text';
729 $fieldMap['ar_flags'] = 'old_flags';
732 $revRow = new stdClass();
733 foreach ( $fieldMap as $arKey => $revKey ) {
734 if ( property_exists( $archiveRow, $arKey ) ) {
735 $revRow->$revKey = $archiveRow->$arKey;
743 * Constructs a RevisionRecord for the revisions main slot, based on the MW1.29 schema.
745 * @param object|array $row Either a database row or an array
746 * @param int $queryFlags for callbacks
747 * @param Title $title
749 * @return SlotRecord The main slot, extracted from the MW 1.29 style row.
750 * @throws MWException
752 private function emulateMainSlot_1_29( $row, $queryFlags, Title
$title ) {
753 $mainSlotRow = new stdClass();
754 $mainSlotRow->role_name
= 'main';
755 $mainSlotRow->model_name
= null;
756 $mainSlotRow->slot_revision_id
= null;
757 $mainSlotRow->content_address
= null;
758 $mainSlotRow->slot_content_id
= null;
764 if ( is_object( $row ) ) {
766 if ( !isset( $row->rev_id
) && ( isset( $row->ar_user
) ||
isset( $row->ar_actor
) ) ) {
767 $row = $this->mapArchiveFields( $row );
770 if ( isset( $row->rev_text_id
) && $row->rev_text_id
> 0 ) {
771 $mainSlotRow->slot_content_id
= $row->rev_text_id
;
772 $mainSlotRow->content_address
= SqlBlobStore
::makeAddressFromTextId(
777 // This is used by null-revisions
778 $mainSlotRow->slot_origin
= isset( $row->slot_origin
)
779 ?
intval( $row->slot_origin
)
782 if ( isset( $row->old_text
) ) {
783 // this happens when the text-table gets joined directly, in the pre-1.30 schema
784 $blobData = isset( $row->old_text
) ?
strval( $row->old_text
) : null;
785 // Check against selects that might have not included old_flags
786 if ( !property_exists( $row, 'old_flags' ) ) {
787 throw new InvalidArgumentException( 'old_flags was not set in $row' );
789 $blobFlags = ( $row->old_flags
=== null ) ?
'' : $row->old_flags
;
792 $mainSlotRow->slot_revision_id
= intval( $row->rev_id
);
794 $mainSlotRow->content_size
= isset( $row->rev_len
) ?
intval( $row->rev_len
) : null;
795 $mainSlotRow->content_sha1
= isset( $row->rev_sha1
) ?
strval( $row->rev_sha1
) : null;
796 $mainSlotRow->model_name
= isset( $row->rev_content_model
)
797 ?
strval( $row->rev_content_model
)
799 // XXX: in the future, we'll probably always use the default format, and drop content_format
800 $mainSlotRow->format_name
= isset( $row->rev_content_format
)
801 ?
strval( $row->rev_content_format
)
803 } elseif ( is_array( $row ) ) {
804 $mainSlotRow->slot_revision_id
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
806 $mainSlotRow->slot_content_id
= isset( $row['text_id'] )
807 ?
intval( $row['text_id'] )
809 $mainSlotRow->slot_origin
= isset( $row['slot_origin'] )
810 ?
intval( $row['slot_origin'] )
812 $mainSlotRow->content_address
= isset( $row['text_id'] )
813 ? SqlBlobStore
::makeAddressFromTextId( intval( $row['text_id'] ) )
815 $mainSlotRow->content_size
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
816 $mainSlotRow->content_sha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
818 $mainSlotRow->model_name
= isset( $row['content_model'] )
819 ?
strval( $row['content_model'] ) : null; // XXX: must be a string!
820 // XXX: in the future, we'll probably always use the default format, and drop content_format
821 $mainSlotRow->format_name
= isset( $row['content_format'] )
822 ?
strval( $row['content_format'] ) : null;
823 $blobData = isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
824 // XXX: If the flags field is not set then $blobFlags should be null so that no
825 // decoding will happen. An empty string will result in default decodings.
826 $blobFlags = isset( $row['flags'] ) ?
trim( strval( $row['flags'] ) ) : null;
828 // if we have a Content object, override mText and mContentModel
829 if ( !empty( $row['content'] ) ) {
830 if ( !( $row['content'] instanceof Content
) ) {
831 throw new MWException( 'content field must contain a Content object.' );
834 /** @var Content $content */
835 $content = $row['content'];
836 $handler = $content->getContentHandler();
838 $mainSlotRow->model_name
= $content->getModel();
840 // XXX: in the future, we'll probably always use the default format.
841 if ( $mainSlotRow->format_name
=== null ) {
842 $mainSlotRow->format_name
= $handler->getDefaultFormat();
846 throw new MWException( 'Revision constructor passed invalid row format.' );
849 // With the old schema, the content changes with every revision,
850 // except for null-revisions.
851 if ( !isset( $mainSlotRow->slot_origin
) ) {
852 $mainSlotRow->slot_origin
= $mainSlotRow->slot_revision_id
;
855 if ( $mainSlotRow->model_name
=== null ) {
856 $mainSlotRow->model_name
= function ( SlotRecord
$slot ) use ( $title ) {
857 // TODO: MCR: consider slot role in getDefaultModelFor()! Use LinkTarget!
858 // TODO: MCR: deprecate $title->getModel().
859 return ContentHandler
::getDefaultModelFor( $title );
864 $content = function ( SlotRecord
$slot )
865 use ( $blobData, $blobFlags, $queryFlags, $mainSlotRow )
867 return $this->loadSlotContent(
871 $mainSlotRow->format_name
,
877 $mainSlotRow->slot_id
= $mainSlotRow->slot_revision_id
;
878 return new SlotRecord( $mainSlotRow, $content );
882 * Loads a Content object based on a slot row.
884 * This method does not call $slot->getContent(), and may be used as a callback
885 * called by $slot->getContent().
887 * MCR migration note: this roughly corresponds to Revision::getContentInternal
889 * @param SlotRecord $slot The SlotRecord to load content for
890 * @param string|null $blobData The content blob, in the form indicated by $blobFlags
891 * @param string|null $blobFlags Flags indicating how $blobData needs to be processed.
892 * Use null if no processing should happen. That is in constrast to the empty string,
893 * which causes the blob to be decoded according to the configured legacy encoding.
894 * @param string|null $blobFormat MIME type indicating how $dataBlob is encoded
895 * @param int $queryFlags
897 * @throw RevisionAccessException
900 private function loadSlotContent(
907 if ( $blobData !== null ) {
908 Assert
::parameterType( 'string', $blobData, '$blobData' );
909 Assert
::parameterType( 'string|null', $blobFlags, '$blobFlags' );
911 $cacheKey = $slot->hasAddress() ?
$slot->getAddress() : null;
913 if ( $blobFlags === null ) {
914 // No blob flags, so use the blob verbatim.
917 $data = $this->blobStore
->expandBlob( $blobData, $blobFlags, $cacheKey );
918 if ( $data === false ) {
919 throw new RevisionAccessException(
920 "Failed to expand blob data using flags $blobFlags (key: $cacheKey)"
926 $address = $slot->getAddress();
928 $data = $this->blobStore
->getBlob( $address, $queryFlags );
929 } catch ( BlobAccessException
$e ) {
930 throw new RevisionAccessException(
931 "Failed to load data blob from $address: " . $e->getMessage(), 0, $e
936 // Unserialize content
937 $handler = ContentHandler
::getForModelID( $slot->getModel() );
939 $content = $handler->unserializeContent( $data, $blobFormat );
944 * Load a page revision from a given revision ID number.
945 * Returns null if no such revision can be found.
947 * MCR migration note: this replaces Revision::newFromId
950 * IDBAccessObject::READ_LATEST: Select the data from the master
951 * IDBAccessObject::READ_LOCKING : Select & lock the data from the master
954 * @param int $flags (optional)
955 * @return RevisionRecord|null
957 public function getRevisionById( $id, $flags = 0 ) {
958 return $this->newRevisionFromConds( [ 'rev_id' => intval( $id ) ], $flags );
962 * Load either the current, or a specified, revision
963 * that's attached to a given link target. If not attached
964 * to that link target, will return null.
966 * MCR migration note: this replaces Revision::newFromTitle
969 * IDBAccessObject::READ_LATEST: Select the data from the master
970 * IDBAccessObject::READ_LOCKING : Select & lock the data from the master
972 * @param LinkTarget $linkTarget
973 * @param int $revId (optional)
974 * @param int $flags Bitfield (optional)
975 * @return RevisionRecord|null
977 public function getRevisionByTitle( LinkTarget
$linkTarget, $revId = 0, $flags = 0 ) {
979 'page_namespace' => $linkTarget->getNamespace(),
980 'page_title' => $linkTarget->getDBkey()
983 // Use the specified revision ID.
984 // Note that we use newRevisionFromConds here because we want to retry
985 // and fall back to master if the page is not found on a replica.
986 // Since the caller supplied a revision ID, we are pretty sure the revision is
987 // supposed to exist, so we should try hard to find it.
988 $conds['rev_id'] = $revId;
989 return $this->newRevisionFromConds( $conds, $flags );
991 // Use a join to get the latest revision.
992 // Note that we don't use newRevisionFromConds here because we don't want to retry
993 // and fall back to master. The assumption is that we only want to force the fallback
994 // if we are quite sure the revision exists because the caller supplied a revision ID.
995 // If the page isn't found at all on a replica, it probably simply does not exist.
996 $db = $this->getDBConnection( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
998 $conds[] = 'rev_id=page_latest';
999 $rev = $this->loadRevisionFromConds( $db, $conds, $flags );
1001 $this->releaseDBConnection( $db );
1007 * Load either the current, or a specified, revision
1008 * that's attached to a given page ID.
1009 * Returns null if no such revision can be found.
1011 * MCR migration note: this replaces Revision::newFromPageId
1014 * IDBAccessObject::READ_LATEST: Select the data from the master (since 1.20)
1015 * IDBAccessObject::READ_LOCKING : Select & lock the data from the master
1017 * @param int $pageId
1018 * @param int $revId (optional)
1019 * @param int $flags Bitfield (optional)
1020 * @return RevisionRecord|null
1022 public function getRevisionByPageId( $pageId, $revId = 0, $flags = 0 ) {
1023 $conds = [ 'page_id' => $pageId ];
1025 // Use the specified revision ID.
1026 // Note that we use newRevisionFromConds here because we want to retry
1027 // and fall back to master if the page is not found on a replica.
1028 // Since the caller supplied a revision ID, we are pretty sure the revision is
1029 // supposed to exist, so we should try hard to find it.
1030 $conds['rev_id'] = $revId;
1031 return $this->newRevisionFromConds( $conds, $flags );
1033 // Use a join to get the latest revision.
1034 // Note that we don't use newRevisionFromConds here because we don't want to retry
1035 // and fall back to master. The assumption is that we only want to force the fallback
1036 // if we are quite sure the revision exists because the caller supplied a revision ID.
1037 // If the page isn't found at all on a replica, it probably simply does not exist.
1038 $db = $this->getDBConnection( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
1040 $conds[] = 'rev_id=page_latest';
1041 $rev = $this->loadRevisionFromConds( $db, $conds, $flags );
1043 $this->releaseDBConnection( $db );
1049 * Load the revision for the given title with the given timestamp.
1050 * WARNING: Timestamps may in some circumstances not be unique,
1051 * so this isn't the best key to use.
1053 * MCR migration note: this replaces Revision::loadFromTimestamp
1055 * @param Title $title
1056 * @param string $timestamp
1057 * @return RevisionRecord|null
1059 public function getRevisionByTimestamp( $title, $timestamp ) {
1060 $db = $this->getDBConnection( DB_REPLICA
);
1061 return $this->newRevisionFromConds(
1063 'rev_timestamp' => $db->timestamp( $timestamp ),
1064 'page_namespace' => $title->getNamespace(),
1065 'page_title' => $title->getDBkey()
1073 * Make a fake revision object from an archive table row. This is queried
1074 * for permissions or even inserted (as in Special:Undelete)
1076 * MCR migration note: this replaces Revision::newFromArchiveRow
1078 * @param object $row
1079 * @param int $queryFlags
1080 * @param Title|null $title
1081 * @param array $overrides associative array with fields of $row to override. This may be
1082 * used e.g. to force the parent revision ID or page ID. Keys in the array are fields
1083 * names from the archive table without the 'ar_' prefix, i.e. use 'parent_id' to
1084 * override ar_parent_id.
1086 * @return RevisionRecord
1087 * @throws MWException
1089 public function newRevisionFromArchiveRow(
1092 Title
$title = null,
1093 array $overrides = []
1095 Assert
::parameterType( 'object', $row, '$row' );
1097 // check second argument, since Revision::newFromArchiveRow had $overrides in that spot.
1098 Assert
::parameterType( 'integer', $queryFlags, '$queryFlags' );
1100 if ( !$title && isset( $overrides['title'] ) ) {
1101 if ( !( $overrides['title'] instanceof Title
) ) {
1102 throw new MWException( 'title field override must contain a Title object.' );
1105 $title = $overrides['title'];
1108 if ( !isset( $title ) ) {
1109 if ( isset( $row->ar_namespace
) && isset( $row->ar_title
) ) {
1110 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
1112 throw new InvalidArgumentException(
1113 'A Title or ar_namespace and ar_title must be given'
1118 foreach ( $overrides as $key => $value ) {
1120 $row->$field = $value;
1124 $user = User
::newFromAnyId(
1125 isset( $row->ar_user
) ?
$row->ar_user
: null,
1126 isset( $row->ar_user_text
) ?
$row->ar_user_text
: null,
1127 isset( $row->ar_actor
) ?
$row->ar_actor
: null
1129 } catch ( InvalidArgumentException
$ex ) {
1130 wfWarn( __METHOD__
. ': ' . $ex->getMessage() );
1131 $user = new UserIdentityValue( 0, '', 0 );
1134 $comment = $this->commentStore
1135 // Legacy because $row may have come from self::selectFields()
1136 ->getCommentLegacy( $this->getDBConnection( DB_REPLICA
), 'ar_comment', $row, true );
1138 $mainSlot = $this->emulateMainSlot_1_29( $row, $queryFlags, $title );
1139 $slots = new RevisionSlots( [ 'main' => $mainSlot ] );
1141 return new RevisionArchiveRecord( $title, $user, $comment, $row, $slots, $this->wikiId
);
1145 * @see RevisionFactory::newRevisionFromRow_1_29
1147 * MCR migration note: this replaces Revision::newFromRow
1149 * @param object $row
1150 * @param int $queryFlags
1151 * @param Title|null $title
1153 * @return RevisionRecord
1154 * @throws MWException
1155 * @throws RevisionAccessException
1157 private function newRevisionFromRow_1_29( $row, $queryFlags = 0, Title
$title = null ) {
1158 Assert
::parameterType( 'object', $row, '$row' );
1161 $pageId = isset( $row->rev_page
) ?
$row->rev_page
: 0; // XXX: also check page_id?
1162 $revId = isset( $row->rev_id
) ?
$row->rev_id
: 0;
1164 $title = $this->getTitle( $pageId, $revId, $queryFlags );
1167 if ( !isset( $row->page_latest
) ) {
1168 $row->page_latest
= $title->getLatestRevID();
1169 if ( $row->page_latest
=== 0 && $title->exists() ) {
1170 wfWarn( 'Encountered title object in limbo: ID ' . $title->getArticleID() );
1175 $user = User
::newFromAnyId(
1176 isset( $row->rev_user
) ?
$row->rev_user
: null,
1177 isset( $row->rev_user_text
) ?
$row->rev_user_text
: null,
1178 isset( $row->rev_actor
) ?
$row->rev_actor
: null
1180 } catch ( InvalidArgumentException
$ex ) {
1181 wfWarn( __METHOD__
. ': ' . $ex->getMessage() );
1182 $user = new UserIdentityValue( 0, '', 0 );
1185 $comment = $this->commentStore
1186 // Legacy because $row may have come from self::selectFields()
1187 ->getCommentLegacy( $this->getDBConnection( DB_REPLICA
), 'rev_comment', $row, true );
1189 $mainSlot = $this->emulateMainSlot_1_29( $row, $queryFlags, $title );
1190 $slots = new RevisionSlots( [ 'main' => $mainSlot ] );
1192 return new RevisionStoreRecord( $title, $user, $comment, $row, $slots, $this->wikiId
);
1196 * @see RevisionFactory::newRevisionFromRow
1198 * MCR migration note: this replaces Revision::newFromRow
1200 * @param object $row
1201 * @param int $queryFlags
1202 * @param Title|null $title
1204 * @return RevisionRecord
1206 public function newRevisionFromRow( $row, $queryFlags = 0, Title
$title = null ) {
1207 return $this->newRevisionFromRow_1_29( $row, $queryFlags, $title );
1211 * Constructs a new MutableRevisionRecord based on the given associative array following
1212 * the MW1.29 convention for the Revision constructor.
1214 * MCR migration note: this replaces Revision::newFromRow
1216 * @param array $fields
1217 * @param int $queryFlags
1218 * @param Title|null $title
1220 * @return MutableRevisionRecord
1221 * @throws MWException
1222 * @throws RevisionAccessException
1224 public function newMutableRevisionFromArray(
1229 if ( !$title && isset( $fields['title'] ) ) {
1230 if ( !( $fields['title'] instanceof Title
) ) {
1231 throw new MWException( 'title field must contain a Title object.' );
1234 $title = $fields['title'];
1238 $pageId = isset( $fields['page'] ) ?
$fields['page'] : 0;
1239 $revId = isset( $fields['id'] ) ?
$fields['id'] : 0;
1241 $title = $this->getTitle( $pageId, $revId, $queryFlags );
1244 if ( !isset( $fields['page'] ) ) {
1245 $fields['page'] = $title->getArticleID( $queryFlags );
1248 // if we have a content object, use it to set the model and type
1249 if ( !empty( $fields['content'] ) ) {
1250 if ( !( $fields['content'] instanceof Content
) ) {
1251 throw new MWException( 'content field must contain a Content object.' );
1254 if ( !empty( $fields['text_id'] ) ) {
1255 throw new MWException(
1256 "Text already stored in external store (id {$fields['text_id']}), " .
1257 "can't serialize content object"
1263 isset( $fields['comment'] )
1264 && !( $fields['comment'] instanceof CommentStoreComment
)
1266 $commentData = isset( $fields['comment_data'] ) ?
$fields['comment_data'] : null;
1268 if ( $fields['comment'] instanceof Message
) {
1269 $fields['comment'] = CommentStoreComment
::newUnsavedComment(
1274 $commentText = trim( strval( $fields['comment'] ) );
1275 $fields['comment'] = CommentStoreComment
::newUnsavedComment(
1282 $mainSlot = $this->emulateMainSlot_1_29( $fields, $queryFlags, $title );
1284 $revision = new MutableRevisionRecord( $title, $this->wikiId
);
1285 $this->initializeMutableRevisionFromArray( $revision, $fields );
1286 $revision->setSlot( $mainSlot );
1292 * @param MutableRevisionRecord $record
1293 * @param array $fields
1295 private function initializeMutableRevisionFromArray(
1296 MutableRevisionRecord
$record,
1299 /** @var UserIdentity $user */
1302 if ( isset( $fields['user'] ) && ( $fields['user'] instanceof UserIdentity
) ) {
1303 $user = $fields['user'];
1306 $user = User
::newFromAnyId(
1307 isset( $fields['user'] ) ?
$fields['user'] : null,
1308 isset( $fields['user_text'] ) ?
$fields['user_text'] : null,
1309 isset( $fields['actor'] ) ?
$fields['actor'] : null
1311 } catch ( InvalidArgumentException
$ex ) {
1317 $record->setUser( $user );
1320 $timestamp = isset( $fields['timestamp'] )
1321 ?
strval( $fields['timestamp'] )
1322 : wfTimestampNow(); // TODO: use a callback, so we can override it for testing.
1324 $record->setTimestamp( $timestamp );
1326 if ( isset( $fields['page'] ) ) {
1327 $record->setPageId( intval( $fields['page'] ) );
1330 if ( isset( $fields['id'] ) ) {
1331 $record->setId( intval( $fields['id'] ) );
1333 if ( isset( $fields['parent_id'] ) ) {
1334 $record->setParentId( intval( $fields['parent_id'] ) );
1337 if ( isset( $fields['sha1'] ) ) {
1338 $record->setSha1( $fields['sha1'] );
1340 if ( isset( $fields['size'] ) ) {
1341 $record->setSize( intval( $fields['size'] ) );
1344 if ( isset( $fields['minor_edit'] ) ) {
1345 $record->setMinorEdit( intval( $fields['minor_edit'] ) !== 0 );
1347 if ( isset( $fields['deleted'] ) ) {
1348 $record->setVisibility( intval( $fields['deleted'] ) );
1351 if ( isset( $fields['comment'] ) ) {
1352 Assert
::parameterType(
1353 CommentStoreComment
::class,
1357 $record->setComment( $fields['comment'] );
1362 * Load a page revision from a given revision ID number.
1363 * Returns null if no such revision can be found.
1365 * MCR migration note: this corresponds to Revision::loadFromId
1367 * @note direct use is deprecated!
1368 * @todo remove when unused! there seem to be no callers of Revision::loadFromId
1370 * @param IDatabase $db
1373 * @return RevisionRecord|null
1375 public function loadRevisionFromId( IDatabase
$db, $id ) {
1376 return $this->loadRevisionFromConds( $db, [ 'rev_id' => intval( $id ) ] );
1380 * Load either the current, or a specified, revision
1381 * that's attached to a given page. If not attached
1382 * to that page, will return null.
1384 * MCR migration note: this replaces Revision::loadFromPageId
1386 * @note direct use is deprecated!
1387 * @todo remove when unused!
1389 * @param IDatabase $db
1390 * @param int $pageid
1392 * @return RevisionRecord|null
1394 public function loadRevisionFromPageId( IDatabase
$db, $pageid, $id = 0 ) {
1395 $conds = [ 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) ];
1397 $conds['rev_id'] = intval( $id );
1399 $conds[] = 'rev_id=page_latest';
1401 return $this->loadRevisionFromConds( $db, $conds );
1405 * Load either the current, or a specified, revision
1406 * that's attached to a given page. If not attached
1407 * to that page, will return null.
1409 * MCR migration note: this replaces Revision::loadFromTitle
1411 * @note direct use is deprecated!
1412 * @todo remove when unused!
1414 * @param IDatabase $db
1415 * @param Title $title
1418 * @return RevisionRecord|null
1420 public function loadRevisionFromTitle( IDatabase
$db, $title, $id = 0 ) {
1422 $matchId = intval( $id );
1424 $matchId = 'page_latest';
1427 return $this->loadRevisionFromConds(
1431 'page_namespace' => $title->getNamespace(),
1432 'page_title' => $title->getDBkey()
1440 * Load the revision for the given title with the given timestamp.
1441 * WARNING: Timestamps may in some circumstances not be unique,
1442 * so this isn't the best key to use.
1444 * MCR migration note: this replaces Revision::loadFromTimestamp
1446 * @note direct use is deprecated! Use getRevisionFromTimestamp instead!
1447 * @todo remove when unused!
1449 * @param IDatabase $db
1450 * @param Title $title
1451 * @param string $timestamp
1452 * @return RevisionRecord|null
1454 public function loadRevisionFromTimestamp( IDatabase
$db, $title, $timestamp ) {
1455 return $this->loadRevisionFromConds( $db,
1457 'rev_timestamp' => $db->timestamp( $timestamp ),
1458 'page_namespace' => $title->getNamespace(),
1459 'page_title' => $title->getDBkey()
1467 * Given a set of conditions, fetch a revision
1469 * This method should be used if we are pretty sure the revision exists.
1470 * Unless $flags has READ_LATEST set, this method will first try to find the revision
1471 * on a replica before hitting the master database.
1473 * MCR migration note: this corresponds to Revision::newFromConds
1475 * @param array $conditions
1476 * @param int $flags (optional)
1477 * @param Title $title
1479 * @return RevisionRecord|null
1481 private function newRevisionFromConds( $conditions, $flags = 0, Title
$title = null ) {
1482 $db = $this->getDBConnection( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
1483 $rev = $this->loadRevisionFromConds( $db, $conditions, $flags, $title );
1484 $this->releaseDBConnection( $db );
1486 $lb = $this->getDBLoadBalancer();
1488 // Make sure new pending/committed revision are visibile later on
1489 // within web requests to certain avoid bugs like T93866 and T94407.
1491 && !( $flags & self
::READ_LATEST
)
1492 && $lb->getServerCount() > 1
1493 && $lb->hasOrMadeRecentMasterChanges()
1495 $flags = self
::READ_LATEST
;
1496 $db = $this->getDBConnection( DB_MASTER
);
1497 $rev = $this->loadRevisionFromConds( $db, $conditions, $flags, $title );
1498 $this->releaseDBConnection( $db );
1505 * Given a set of conditions, fetch a revision from
1506 * the given database connection.
1508 * MCR migration note: this corresponds to Revision::loadFromConds
1510 * @param IDatabase $db
1511 * @param array $conditions
1512 * @param int $flags (optional)
1513 * @param Title $title
1515 * @return RevisionRecord|null
1517 private function loadRevisionFromConds(
1523 $row = $this->fetchRevisionRowFromConds( $db, $conditions, $flags );
1525 $rev = $this->newRevisionFromRow( $row, $flags, $title );
1534 * Throws an exception if the given database connection does not belong to the wiki this
1535 * RevisionStore is bound to.
1537 * @param IDatabase $db
1538 * @throws MWException
1540 private function checkDatabaseWikiId( IDatabase
$db ) {
1541 $storeWiki = $this->wikiId
;
1542 $dbWiki = $db->getDomainID();
1544 if ( $dbWiki === $storeWiki ) {
1548 // XXX: we really want the default database ID...
1549 $storeWiki = $storeWiki ?
: wfWikiID();
1550 $dbWiki = $dbWiki ?
: wfWikiID();
1552 if ( $dbWiki === $storeWiki ) {
1556 // HACK: counteract encoding imposed by DatabaseDomain
1557 $storeWiki = str_replace( '?h', '-', $storeWiki );
1558 $dbWiki = str_replace( '?h', '-', $dbWiki );
1560 if ( $dbWiki === $storeWiki ) {
1564 throw new MWException( "RevisionStore for $storeWiki "
1565 . "cannot be used with a DB connection for $dbWiki" );
1569 * Given a set of conditions, return a row with the
1570 * fields necessary to build RevisionRecord objects.
1572 * MCR migration note: this corresponds to Revision::fetchFromConds
1574 * @param IDatabase $db
1575 * @param array $conditions
1576 * @param int $flags (optional)
1578 * @return object|false data row as a raw object
1580 private function fetchRevisionRowFromConds( IDatabase
$db, $conditions, $flags = 0 ) {
1581 $this->checkDatabaseWikiId( $db );
1583 $revQuery = self
::getQueryInfo( [ 'page', 'user' ] );
1585 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
1586 $options[] = 'FOR UPDATE';
1588 return $db->selectRow(
1589 $revQuery['tables'],
1590 $revQuery['fields'],
1599 * Return the tables, fields, and join conditions to be selected to create
1600 * a new revision object.
1602 * MCR migration note: this replaces Revision::getQueryInfo
1606 * @param array $options Any combination of the following strings
1607 * - 'page': Join with the page table, and select fields to identify the page
1608 * - 'user': Join with the user table, and select the user name
1609 * - 'text': Join with the text table, and select fields to load page text
1611 * @return array With three keys:
1612 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
1613 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
1614 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
1616 public function getQueryInfo( $options = [] ) {
1623 $ret['tables'][] = 'revision';
1624 $ret['fields'] = array_merge( $ret['fields'], [
1636 $commentQuery = $this->commentStore
->getJoin( 'rev_comment' );
1637 $ret['tables'] = array_merge( $ret['tables'], $commentQuery['tables'] );
1638 $ret['fields'] = array_merge( $ret['fields'], $commentQuery['fields'] );
1639 $ret['joins'] = array_merge( $ret['joins'], $commentQuery['joins'] );
1641 $actorQuery = $this->actorMigration
->getJoin( 'rev_user' );
1642 $ret['tables'] = array_merge( $ret['tables'], $actorQuery['tables'] );
1643 $ret['fields'] = array_merge( $ret['fields'], $actorQuery['fields'] );
1644 $ret['joins'] = array_merge( $ret['joins'], $actorQuery['joins'] );
1646 if ( $this->contentHandlerUseDB
) {
1647 $ret['fields'][] = 'rev_content_format';
1648 $ret['fields'][] = 'rev_content_model';
1651 if ( in_array( 'page', $options, true ) ) {
1652 $ret['tables'][] = 'page';
1653 $ret['fields'] = array_merge( $ret['fields'], [
1661 $ret['joins']['page'] = [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
1664 if ( in_array( 'user', $options, true ) ) {
1665 $ret['tables'][] = 'user';
1666 $ret['fields'] = array_merge( $ret['fields'], [
1669 $u = $actorQuery['fields']['rev_user'];
1670 $ret['joins']['user'] = [ 'LEFT JOIN', [ "$u != 0", "user_id = $u" ] ];
1673 if ( in_array( 'text', $options, true ) ) {
1674 $ret['tables'][] = 'text';
1675 $ret['fields'] = array_merge( $ret['fields'], [
1679 $ret['joins']['text'] = [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ];
1686 * Return the tables, fields, and join conditions to be selected to create
1687 * a new archived revision object.
1689 * MCR migration note: this replaces Revision::getArchiveQueryInfo
1693 * @return array With three keys:
1694 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
1695 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
1696 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
1698 public function getArchiveQueryInfo() {
1699 $commentQuery = $this->commentStore
->getJoin( 'ar_comment' );
1700 $actorQuery = $this->actorMigration
->getJoin( 'ar_user' );
1702 'tables' => [ 'archive' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
1717 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
1718 'joins' => $commentQuery['joins'] +
$actorQuery['joins'],
1721 if ( $this->contentHandlerUseDB
) {
1722 $ret['fields'][] = 'ar_content_format';
1723 $ret['fields'][] = 'ar_content_model';
1730 * Do a batched query for the sizes of a set of revisions.
1732 * MCR migration note: this replaces Revision::getParentLengths
1734 * @param int[] $revIds
1735 * @return int[] associative array mapping revision IDs from $revIds to the nominal size
1736 * of the corresponding revision.
1738 public function getRevisionSizes( array $revIds ) {
1739 return $this->listRevisionSizes( $this->getDBConnection( DB_REPLICA
), $revIds );
1743 * Do a batched query for the sizes of a set of revisions.
1745 * MCR migration note: this replaces Revision::getParentLengths
1747 * @deprecated use RevisionStore::getRevisionSizes instead.
1749 * @param IDatabase $db
1750 * @param int[] $revIds
1751 * @return int[] associative array mapping revision IDs from $revIds to the nominal size
1752 * of the corresponding revision.
1754 public function listRevisionSizes( IDatabase
$db, array $revIds ) {
1755 $this->checkDatabaseWikiId( $db );
1759 return $revLens; // empty
1764 [ 'rev_id', 'rev_len' ],
1765 [ 'rev_id' => $revIds ],
1769 foreach ( $res as $row ) {
1770 $revLens[$row->rev_id
] = intval( $row->rev_len
);
1777 * Get previous revision for this title
1779 * MCR migration note: this replaces Revision::getPrevious
1781 * @param RevisionRecord $rev
1782 * @param Title $title if known (optional)
1784 * @return RevisionRecord|null
1786 public function getPreviousRevision( RevisionRecord
$rev, Title
$title = null ) {
1787 if ( $title === null ) {
1788 $title = $this->getTitle( $rev->getPageId(), $rev->getId() );
1790 $prev = $title->getPreviousRevisionID( $rev->getId() );
1792 return $this->getRevisionByTitle( $title, $prev );
1798 * Get next revision for this title
1800 * MCR migration note: this replaces Revision::getNext
1802 * @param RevisionRecord $rev
1803 * @param Title $title if known (optional)
1805 * @return RevisionRecord|null
1807 public function getNextRevision( RevisionRecord
$rev, Title
$title = null ) {
1808 if ( $title === null ) {
1809 $title = $this->getTitle( $rev->getPageId(), $rev->getId() );
1811 $next = $title->getNextRevisionID( $rev->getId() );
1813 return $this->getRevisionByTitle( $title, $next );
1819 * Get previous revision Id for this page_id
1820 * This is used to populate rev_parent_id on save
1822 * MCR migration note: this corresponds to Revision::getPreviousRevisionId
1824 * @param IDatabase $db
1825 * @param RevisionRecord $rev
1829 private function getPreviousRevisionId( IDatabase
$db, RevisionRecord
$rev ) {
1830 $this->checkDatabaseWikiId( $db );
1832 if ( $rev->getPageId() === null ) {
1835 # Use page_latest if ID is not given
1836 if ( !$rev->getId() ) {
1837 $prevId = $db->selectField(
1838 'page', 'page_latest',
1839 [ 'page_id' => $rev->getPageId() ],
1843 $prevId = $db->selectField(
1844 'revision', 'rev_id',
1845 [ 'rev_page' => $rev->getPageId(), 'rev_id < ' . $rev->getId() ],
1847 [ 'ORDER BY' => 'rev_id DESC' ]
1850 return intval( $prevId );
1854 * Get rev_timestamp from rev_id, without loading the rest of the row
1856 * MCR migration note: this replaces Revision::getTimestampFromId
1858 * @param Title $title
1861 * @return string|bool False if not found
1863 public function getTimestampFromId( $title, $id, $flags = 0 ) {
1864 $db = $this->getDBConnection(
1865 ( $flags & IDBAccessObject
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
1868 $conds = [ 'rev_id' => $id ];
1869 $conds['rev_page'] = $title->getArticleID();
1870 $timestamp = $db->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1872 $this->releaseDBConnection( $db );
1873 return ( $timestamp !== false ) ?
wfTimestamp( TS_MW
, $timestamp ) : false;
1877 * Get count of revisions per page...not very efficient
1879 * MCR migration note: this replaces Revision::countByPageId
1881 * @param IDatabase $db
1882 * @param int $id Page id
1885 public function countRevisionsByPageId( IDatabase
$db, $id ) {
1886 $this->checkDatabaseWikiId( $db );
1888 $row = $db->selectRow( 'revision',
1889 [ 'revCount' => 'COUNT(*)' ],
1890 [ 'rev_page' => $id ],
1894 return intval( $row->revCount
);
1900 * Get count of revisions per page...not very efficient
1902 * MCR migration note: this replaces Revision::countByTitle
1904 * @param IDatabase $db
1905 * @param Title $title
1908 public function countRevisionsByTitle( IDatabase
$db, $title ) {
1909 $id = $title->getArticleID();
1911 return $this->countRevisionsByPageId( $db, $id );
1917 * Check if no edits were made by other users since
1918 * the time a user started editing the page. Limit to
1919 * 50 revisions for the sake of performance.
1921 * MCR migration note: this replaces Revision::userWasLastToEdit
1923 * @deprecated since 1.31; Can possibly be removed, since the self-conflict suppression
1924 * logic in EditPage that uses this seems conceptually dubious. Revision::userWasLastToEdit
1925 * has been deprecated since 1.24.
1927 * @param IDatabase $db The Database to perform the check on.
1928 * @param int $pageId The ID of the page in question
1929 * @param int $userId The ID of the user in question
1930 * @param string $since Look at edits since this time
1932 * @return bool True if the given user was the only one to edit since the given timestamp
1934 public function userWasLastToEdit( IDatabase
$db, $pageId, $userId, $since ) {
1935 $this->checkDatabaseWikiId( $db );
1941 $revQuery = self
::getQueryInfo();
1943 $revQuery['tables'],
1945 'rev_user' => $revQuery['fields']['rev_user'],
1948 'rev_page' => $pageId,
1949 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1952 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ],
1955 foreach ( $res as $row ) {
1956 if ( $row->rev_user
!= $userId ) {
1964 * Load a revision based on a known page ID and current revision ID from the DB
1966 * This method allows for the use of caching, though accessing anything that normally
1967 * requires permission checks (aside from the text) will trigger a small DB lookup.
1969 * MCR migration note: this replaces Revision::newKnownCurrent
1971 * @param Title $title the associated page title
1972 * @param int $revId current revision of this page. Defaults to $title->getLatestRevID().
1974 * @return RevisionRecord|bool Returns false if missing
1976 public function getKnownCurrentRevision( Title
$title, $revId ) {
1977 $db = $this->getDBConnectionRef( DB_REPLICA
);
1979 $pageId = $title->getArticleID();
1986 $revId = $title->getLatestRevID();
1991 'No latest revision known for page ' . $title->getPrefixedDBkey()
1992 . ' even though it exists with page ID ' . $pageId
1997 $row = $this->cache
->getWithSetCallback(
1998 // Page/rev IDs passed in from DB to reflect history merges
1999 $this->cache
->makeGlobalKey( 'revision-row-1.29', $db->getDomainID(), $pageId, $revId ),
2000 WANObjectCache
::TTL_WEEK
,
2001 function ( $curValue, &$ttl, array &$setOpts ) use ( $db, $pageId, $revId ) {
2002 $setOpts +
= Database
::getCacheSetOptions( $db );
2005 'rev_page' => intval( $pageId ),
2006 'page_id' => intval( $pageId ),
2007 'rev_id' => intval( $revId ),
2010 $row = $this->fetchRevisionRowFromConds( $db, $conds );
2011 return $row ?
: false; // don't cache negatives
2015 // Reflect revision deletion and user renames
2017 return $this->newRevisionFromRow( $row, 0, $title );
2023 // TODO: move relevant methods from Title here, e.g. getFirstRevision, isBigDeletion, etc.