3 * Representation of a page version.
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
23 use MediaWiki\Storage\MutableRevisionRecord
;
24 use MediaWiki\Storage\RevisionAccessException
;
25 use MediaWiki\Storage\RevisionRecord
;
26 use MediaWiki\Storage\RevisionStore
;
27 use MediaWiki\Storage\RevisionStoreRecord
;
28 use MediaWiki\Storage\SlotRecord
;
29 use MediaWiki\Storage\SqlBlobStore
;
30 use MediaWiki\User\UserIdentityValue
;
31 use Wikimedia\Rdbms\IDatabase
;
32 use MediaWiki\Linker\LinkTarget
;
33 use MediaWiki\MediaWikiServices
;
34 use Wikimedia\Rdbms\ResultWrapper
;
35 use Wikimedia\Rdbms\FakeResultWrapper
;
38 * @deprecated since 1.31, use RevisionRecord, RevisionStore, and BlobStore instead.
40 class Revision
implements IDBAccessObject
{
42 /** @var RevisionRecord */
45 // Revision deletion constants
46 const DELETED_TEXT
= RevisionRecord
::DELETED_TEXT
;
47 const DELETED_COMMENT
= RevisionRecord
::DELETED_COMMENT
;
48 const DELETED_USER
= RevisionRecord
::DELETED_USER
;
49 const DELETED_RESTRICTED
= RevisionRecord
::DELETED_RESTRICTED
;
50 const SUPPRESSED_USER
= RevisionRecord
::SUPPRESSED_USER
;
51 const SUPPRESSED_ALL
= RevisionRecord
::SUPPRESSED_ALL
;
53 // Audience options for accessors
54 const FOR_PUBLIC
= RevisionRecord
::FOR_PUBLIC
;
55 const FOR_THIS_USER
= RevisionRecord
::FOR_THIS_USER
;
56 const RAW
= RevisionRecord
::RAW
;
58 const TEXT_CACHE_GROUP
= SqlBlobStore
::TEXT_CACHE_GROUP
;
61 * @return RevisionStore
63 protected static function getRevisionStore() {
64 return MediaWikiServices
::getInstance()->getRevisionStore();
68 * @param bool|string $wikiId The ID of the target wiki database. Use false for the local wiki.
70 * @return SqlBlobStore
72 protected static function getBlobStore( $wiki = false ) {
73 $store = MediaWikiServices
::getInstance()
74 ->getBlobStoreFactory()
75 ->newSqlBlobStore( $wiki );
77 if ( !$store instanceof SqlBlobStore
) {
78 throw new RuntimeException(
79 'The backwards compatibility code in Revision currently requires the BlobStore '
80 . 'service to be an SqlBlobStore instance, but it is a ' . get_class( $store )
88 * Load a page revision from a given revision ID number.
89 * Returns null if no such revision can be found.
92 * Revision::READ_LATEST : Select the data from the master
93 * Revision::READ_LOCKING : Select & lock the data from the master
96 * @param int $flags (optional)
97 * @return Revision|null
99 public static function newFromId( $id, $flags = 0 ) {
100 $rec = self
::getRevisionStore()->getRevisionById( $id, $flags );
101 return $rec === null ?
null : new Revision( $rec, $flags );
105 * Load either the current, or a specified, revision
106 * that's attached to a given link target. If not attached
107 * to that link target, will return null.
110 * Revision::READ_LATEST : Select the data from the master
111 * Revision::READ_LOCKING : Select & lock the data from the master
113 * @param LinkTarget $linkTarget
114 * @param int $id (optional)
115 * @param int $flags Bitfield (optional)
116 * @return Revision|null
118 public static function newFromTitle( LinkTarget
$linkTarget, $id = 0, $flags = 0 ) {
119 $rec = self
::getRevisionStore()->getRevisionByTitle( $linkTarget, $id, $flags );
120 return $rec === null ?
null : new Revision( $rec, $flags );
124 * Load either the current, or a specified, revision
125 * that's attached to a given page ID.
126 * Returns null if no such revision can be found.
129 * Revision::READ_LATEST : Select the data from the master (since 1.20)
130 * Revision::READ_LOCKING : Select & lock the data from the master
133 * @param int $revId (optional)
134 * @param int $flags Bitfield (optional)
135 * @return Revision|null
137 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
138 $rec = self
::getRevisionStore()->getRevisionByPageId( $pageId, $revId, $flags );
139 return $rec === null ?
null : new Revision( $rec, $flags );
143 * Make a fake revision object from an archive table row. This is queried
144 * for permissions or even inserted (as in Special:Undelete)
147 * @param array $overrides
149 * @throws MWException
152 public static function newFromArchiveRow( $row, $overrides = [] ) {
154 * MCR Migration: https://phabricator.wikimedia.org/T183564
155 * This method used to overwrite attributes, then passed to Revision::__construct
156 * RevisionStore::newRevisionFromArchiveRow instead overrides row field names
157 * So do a conversion here.
159 if ( array_key_exists( 'page', $overrides ) ) {
160 $overrides['page_id'] = $overrides['page'];
161 unset( $overrides['page'] );
165 * We require a Title for both the Revision object and the RevisionRecord.
166 * Below is duplicated logic from RevisionStore::newRevisionFromArchiveRow
167 * to fetch a title in order pass it into the Revision object.
170 if ( isset( $overrides['title'] ) ) {
171 if ( !( $overrides['title'] instanceof Title
) ) {
172 throw new MWException( 'title field override must contain a Title object.' );
175 $title = $overrides['title'];
177 if ( $title !== null ) {
178 if ( isset( $row->ar_namespace
) && isset( $row->ar_title
) ) {
179 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
181 throw new InvalidArgumentException(
182 'A Title or ar_namespace and ar_title must be given'
187 $rec = self
::getRevisionStore()->newRevisionFromArchiveRow( $row, 0, $title, $overrides );
188 return new Revision( $rec, self
::READ_NORMAL
, $title );
194 * MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that
195 * newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead,
196 * a MutableRevisionRecord should be constructed directly. RevisionStore::newRevisionFromArray()
197 * can be used as a temporary replacement, but should be avoided.
199 * @param object|array $row
202 public static function newFromRow( $row ) {
203 if ( is_array( $row ) ) {
204 $rec = self
::getRevisionStore()->newMutableRevisionFromArray( $row );
206 $rec = self
::getRevisionStore()->newRevisionFromRow( $row );
209 return new Revision( $rec );
213 * Load a page revision from a given revision ID number.
214 * Returns null if no such revision can be found.
216 * @deprecated since 1.31, use RevisionStore::getRevisionById() instead.
218 * @param IDatabase $db
220 * @return Revision|null
222 public static function loadFromId( $db, $id ) {
223 wfDeprecated( __METHOD__
, '1.31' ); // no known callers
224 $rec = self
::getRevisionStore()->loadRevisionFromId( $db, $id );
225 return $rec === null ?
null : new Revision( $rec );
229 * Load either the current, or a specified, revision
230 * that's attached to a given page. If not attached
231 * to that page, will return null.
233 * @deprecated since 1.31, use RevisionStore::getRevisionByPageId() instead.
235 * @param IDatabase $db
238 * @return Revision|null
240 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
241 $rec = self
::getRevisionStore()->loadRevisionFromPageId( $db, $pageid, $id );
242 return $rec === null ?
null : new Revision( $rec );
246 * Load either the current, or a specified, revision
247 * that's attached to a given page. If not attached
248 * to that page, will return null.
250 * @deprecated since 1.31, use RevisionStore::getRevisionByTitle() instead.
252 * @param IDatabase $db
253 * @param Title $title
255 * @return Revision|null
257 public static function loadFromTitle( $db, $title, $id = 0 ) {
258 $rec = self
::getRevisionStore()->loadRevisionFromTitle( $db, $title, $id );
259 return $rec === null ?
null : new Revision( $rec );
263 * Load the revision for the given title with the given timestamp.
264 * WARNING: Timestamps may in some circumstances not be unique,
265 * so this isn't the best key to use.
267 * @deprecated since 1.31, use RevisionStore::loadRevisionFromTimestamp() instead.
269 * @param IDatabase $db
270 * @param Title $title
271 * @param string $timestamp
272 * @return Revision|null
274 public static function loadFromTimestamp( $db, $title, $timestamp ) {
275 // XXX: replace loadRevisionFromTimestamp by getRevisionByTimestamp?
276 $rec = self
::getRevisionStore()->loadRevisionFromTimestamp( $db, $title, $timestamp );
277 return $rec === null ?
null : new Revision( $rec );
281 * Return a wrapper for a series of database rows to
282 * fetch all of a given page's revisions in turn.
283 * Each row can be fed to the constructor to get objects.
285 * @param LinkTarget $title
286 * @return ResultWrapper
287 * @deprecated Since 1.28, no callers in core nor in known extensions. No-op since 1.31.
289 public static function fetchRevision( LinkTarget
$title ) {
290 wfDeprecated( __METHOD__
, '1.31' );
291 return new FakeResultWrapper( [] );
295 * Return the value of a select() JOIN conds array for the user table.
296 * This will get user table rows for logged-in users.
298 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
301 public static function userJoinCond() {
302 wfDeprecated( __METHOD__
, '1.31' );
303 return [ 'LEFT JOIN', [ 'rev_user != 0', 'user_id = rev_user' ] ];
307 * Return the value of a select() page conds array for the page table.
308 * This will assure that the revision(s) are not orphaned from live pages.
310 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
313 public static function pageJoinCond() {
314 wfDeprecated( __METHOD__
, '1.31' );
315 return [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
319 * Return the list of revision fields that should be selected to create
321 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
324 public static function selectFields() {
325 global $wgContentHandlerUseDB;
327 wfDeprecated( __METHOD__
, '1.31' );
343 $fields +
= CommentStore
::newKey( 'rev_comment' )->getFields();
345 if ( $wgContentHandlerUseDB ) {
346 $fields[] = 'rev_content_format';
347 $fields[] = 'rev_content_model';
354 * Return the list of revision fields that should be selected to create
355 * a new revision from an archive row.
356 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
359 public static function selectArchiveFields() {
360 global $wgContentHandlerUseDB;
362 wfDeprecated( __METHOD__
, '1.31' );
380 $fields +
= CommentStore
::newKey( 'ar_comment' )->getFields();
382 if ( $wgContentHandlerUseDB ) {
383 $fields[] = 'ar_content_format';
384 $fields[] = 'ar_content_model';
390 * Return the list of text fields that should be selected to read the
392 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.
395 public static function selectTextFields() {
396 wfDeprecated( __METHOD__
, '1.31' );
404 * Return the list of page fields that should be selected from page table
405 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
408 public static function selectPageFields() {
409 wfDeprecated( __METHOD__
, '1.31' );
421 * Return the list of user fields that should be selected from user table
422 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
425 public static function selectUserFields() {
426 wfDeprecated( __METHOD__
, '1.31' );
427 return [ 'user_name' ];
431 * Return the tables, fields, and join conditions to be selected to create
432 * a new revision object.
434 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
435 * @param array $options Any combination of the following strings
436 * - 'page': Join with the page table, and select fields to identify the page
437 * - 'user': Join with the user table, and select the user name
438 * - 'text': Join with the text table, and select fields to load page text
439 * @return array With three keys:
440 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
441 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
442 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
444 public static function getQueryInfo( $options = [] ) {
445 return self
::getRevisionStore()->getQueryInfo( $options );
449 * Return the tables, fields, and join conditions to be selected to create
450 * a new archived revision object.
452 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
453 * @return array With three keys:
454 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
455 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
456 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
458 public static function getArchiveQueryInfo() {
459 return self
::getRevisionStore()->getArchiveQueryInfo();
463 * Do a batched query to get the parent revision lengths
464 * @param IDatabase $db
465 * @param array $revIds
468 public static function getParentLengths( $db, array $revIds ) {
469 return self
::getRevisionStore()->listRevisionSizes( $db, $revIds );
473 * @param object|array|RevisionRecord $row Either a database row or an array
474 * @param int $queryFlags
475 * @param Title|null $title
479 function __construct( $row, $queryFlags = 0, Title
$title = null ) {
482 if ( $row instanceof RevisionRecord
) {
483 $this->mRecord
= $row;
484 } elseif ( is_array( $row ) ) {
485 if ( !isset( $row['user'] ) && !isset( $row['user_text'] ) ) {
486 $row['user'] = $wgUser;
489 $this->mRecord
= self
::getRevisionStore()->newMutableRevisionFromArray(
494 } elseif ( is_object( $row ) ) {
495 $this->mRecord
= self
::getRevisionStore()->newRevisionFromRow(
501 throw new InvalidArgumentException(
502 '$row must be a row object, an associative array, or a RevisionRecord'
508 * @return RevisionRecord
510 public function getRevisionRecord() {
511 return $this->mRecord
;
519 public function getId() {
520 return $this->mRecord
->getId();
524 * Set the revision ID
526 * This should only be used for proposed revisions that turn out to be null edits.
528 * @note Only supported on Revisions that were constructed based on associative arrays,
529 * since they are mutable.
532 * @param int|string $id
533 * @throws MWException
535 public function setId( $id ) {
536 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
537 $this->mRecord
->setId( intval( $id ) );
539 throw new MWException( __METHOD__
. ' is not supported on this instance' );
544 * Set the user ID/name
546 * This should only be used for proposed revisions that turn out to be null edits
548 * @note Only supported on Revisions that were constructed based on associative arrays,
549 * since they are mutable.
552 * @deprecated since 1.31, please reuse old Revision object
553 * @param int $id User ID
554 * @param string $name User name
555 * @throws MWException
557 public function setUserIdAndName( $id, $name ) {
558 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
559 $user = new UserIdentityValue( intval( $id ), $name );
560 $this->mRecord
->setUser( $user );
562 throw new MWException( __METHOD__
. ' is not supported on this instance' );
569 private function getMainSlotRaw() {
570 return $this->mRecord
->getSlot( 'main', RevisionRecord
::RAW
);
574 * Get the ID of the row of the text table that contains the content of the
575 * revision's main slot, if that content is stored in the text table.
577 * If the content is stored elsewhere, this returns null.
579 * @deprecated since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to
580 * get that actual address that can be used with BlobStore::getBlob(); or use
581 * RevisionRecord::hasSameContent() to check if two revisions have the same content.
585 public function getTextId() {
586 $slot = $this->getMainSlotRaw();
587 return $slot->hasAddress()
588 ? self
::getBlobStore()->getTextIdFromAddress( $slot->getAddress() )
593 * Get parent revision ID (the original previous page revision)
595 * @return int|null The ID of the parent revision. 0 indicates that there is no
596 * parent revision. Null indicates that the parent revision is not known.
598 public function getParentId() {
599 return $this->mRecord
->getParentId();
603 * Returns the length of the text in this revision, or null if unknown.
607 public function getSize() {
608 return $this->mRecord
->getSize();
612 * Returns the base36 sha1 of the content in this revision, or null if unknown.
616 public function getSha1() {
617 // XXX: we may want to drop all the hashing logic, it's not worth the overhead.
618 return $this->mRecord
->getSha1();
622 * Returns the title of the page associated with this entry.
623 * Since 1.31, this will never return null.
625 * Will do a query, when title is not set and id is given.
629 public function getTitle() {
630 $linkTarget = $this->mRecord
->getPageAsLinkTarget();
631 return Title
::newFromLinkTarget( $linkTarget );
635 * Set the title of the revision
637 * @deprecated: since 1.31, this is now a noop. Pass the Title to the constructor instead.
639 * @param Title $title
641 public function setTitle( $title ) {
642 if ( !$title->equals( $this->getTitle() ) ) {
643 throw new InvalidArgumentException(
644 $title->getPrefixedText()
645 . ' is not the same as '
646 . $this->mRecord
->getPageAsLinkTarget()->__toString()
656 public function getPage() {
657 return $this->mRecord
->getPageId();
661 * Fetch revision's user id if it's available to the specified audience.
662 * If the specified audience does not have access to it, zero will be
665 * @param int $audience One of:
666 * Revision::FOR_PUBLIC to be displayed to all users
667 * Revision::FOR_THIS_USER to be displayed to the given user
668 * Revision::RAW get the ID regardless of permissions
669 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
670 * to the $audience parameter
673 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
676 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
680 $user = $this->mRecord
->getUser( $audience, $user );
681 return $user ?
$user->getId() : 0;
685 * Fetch revision's user id without regard for the current user's permissions
688 * @deprecated since 1.25, use getUser( Revision::RAW )
690 public function getRawUser() {
691 wfDeprecated( __METHOD__
, '1.25' );
692 return $this->getUser( self
::RAW
);
696 * Fetch revision's username if it's available to the specified audience.
697 * If the specified audience does not have access to the username, an
698 * empty string will be returned.
700 * @param int $audience One of:
701 * Revision::FOR_PUBLIC to be displayed to all users
702 * Revision::FOR_THIS_USER to be displayed to the given user
703 * Revision::RAW get the text regardless of permissions
704 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
705 * to the $audience parameter
708 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
711 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
715 $user = $this->mRecord
->getUser( $audience, $user );
716 return $user ?
$user->getName() : '';
720 * Fetch revision's username without regard for view restrictions
723 * @deprecated since 1.25, use getUserText( Revision::RAW )
725 public function getRawUserText() {
726 wfDeprecated( __METHOD__
, '1.25' );
727 return $this->getUserText( self
::RAW
);
731 * Fetch revision comment if it's available to the specified audience.
732 * If the specified audience does not have access to the comment, an
733 * empty string will be returned.
735 * @param int $audience One of:
736 * Revision::FOR_PUBLIC to be displayed to all users
737 * Revision::FOR_THIS_USER to be displayed to the given user
738 * Revision::RAW get the text regardless of permissions
739 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
740 * to the $audience parameter
743 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
746 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
750 $comment = $this->mRecord
->getComment( $audience, $user );
751 return $comment === null ?
null : $comment->text
;
755 * Fetch revision comment without regard for the current user's permissions
758 * @deprecated since 1.25, use getComment( Revision::RAW )
760 public function getRawComment() {
761 wfDeprecated( __METHOD__
, '1.25' );
762 return $this->getComment( self
::RAW
);
768 public function isMinor() {
769 return $this->mRecord
->isMinor();
773 * @return int Rcid of the unpatrolled row, zero if there isn't one
775 public function isUnpatrolled() {
776 return self
::getRevisionStore()->isUnpatrolled( $this->mRecord
);
780 * Get the RC object belonging to the current revision, if there's one
782 * @param int $flags (optional) $flags include:
783 * Revision::READ_LATEST : Select the data from the master
786 * @return RecentChange|null
788 public function getRecentChange( $flags = 0 ) {
789 return self
::getRevisionStore()->getRecentChange( $this->mRecord
, $flags );
793 * @param int $field One of DELETED_* bitfield constants
797 public function isDeleted( $field ) {
798 return $this->mRecord
->isDeleted( $field );
802 * Get the deletion bitfield of the revision
806 public function getVisibility() {
807 return $this->mRecord
->getVisibility();
811 * Fetch revision content if it's available to the specified audience.
812 * If the specified audience does not have the ability to view this
813 * revision, or the content could not be loaded, null will be returned.
815 * @param int $audience One of:
816 * Revision::FOR_PUBLIC to be displayed to all users
817 * Revision::FOR_THIS_USER to be displayed to $user
818 * Revision::RAW get the text regardless of permissions
819 * @param User $user User object to check for, only if FOR_THIS_USER is passed
820 * to the $audience parameter
822 * @return Content|null
824 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
827 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
832 return $this->mRecord
->getContent( 'main', $audience, $user );
834 catch ( RevisionAccessException
$e ) {
840 * Get original serialized data (without checking view restrictions)
843 * @deprecated since 1.31, use BlobStore::getBlob instead.
847 public function getSerializedData() {
848 $slot = $this->getMainSlotRaw();
849 return $slot->getContent()->serialize();
853 * Returns the content model for the main slot of this revision.
855 * If no content model was stored in the database, the default content model for the title is
856 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
857 * is used as a last resort.
859 * @todo: drop this, with MCR, there no longer is a single model associated with a revision.
861 * @return string The content model id associated with this revision,
862 * see the CONTENT_MODEL_XXX constants.
864 public function getContentModel() {
865 return $this->getMainSlotRaw()->getModel();
869 * Returns the content format for the main slot of this revision.
871 * If no content format was stored in the database, the default format for this
872 * revision's content model is returned.
874 * @todo: drop this, the format is irrelevant to the revision!
876 * @return string The content format id associated with this revision,
877 * see the CONTENT_FORMAT_XXX constants.
879 public function getContentFormat() {
880 $format = $this->getMainSlotRaw()->getFormat();
882 if ( $format === null ) {
883 // if no format was stored along with the blob, fall back to default format
884 $format = $this->getContentHandler()->getDefaultFormat();
891 * Returns the content handler appropriate for this revision's content model.
893 * @throws MWException
894 * @return ContentHandler
896 public function getContentHandler() {
897 return ContentHandler
::getForModelID( $this->getContentModel() );
903 public function getTimestamp() {
904 return $this->mRecord
->getTimestamp();
910 public function isCurrent() {
911 return ( $this->mRecord
instanceof RevisionStoreRecord
) && $this->mRecord
->isCurrent();
915 * Get previous revision for this title
917 * @return Revision|null
919 public function getPrevious() {
920 $rec = self
::getRevisionStore()->getPreviousRevision( $this->mRecord
);
921 return $rec === null ?
null : new Revision( $rec );
925 * Get next revision for this title
927 * @return Revision|null
929 public function getNext() {
930 $rec = self
::getRevisionStore()->getNextRevision( $this->mRecord
);
931 return $rec === null ?
null : new Revision( $rec );
935 * Get revision text associated with an old or archive row
937 * Both the flags and the text field must be included. Including the old_id
938 * field will activate cache usage as long as the $wiki parameter is not set.
940 * @param stdClass $row The text data
941 * @param string $prefix Table prefix (default 'old_')
942 * @param string|bool $wiki The name of the wiki to load the revision text from
943 * (same as the the wiki $row was loaded from) or false to indicate the local
944 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
945 * identifier as understood by the LoadBalancer class.
946 * @return string|false Text the text requested or false on failure
948 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
949 $textField = $prefix . 'text';
950 $flagsField = $prefix . 'flags';
952 if ( isset( $row->$flagsField ) ) {
953 $flags = explode( ',', $row->$flagsField );
958 if ( isset( $row->$textField ) ) {
959 $text = $row->$textField;
964 $cacheKey = isset( $row->old_id
) ?
( 'tt:' . $row->old_id
) : null;
966 return self
::getBlobStore( $wiki )->expandBlob( $text, $flags, $cacheKey );
970 * If $wgCompressRevisions is enabled, we will compress data.
971 * The input string is modified in place.
972 * Return value is the flags field: contains 'gzip' if the
973 * data is compressed, and 'utf-8' if we're saving in UTF-8
976 * @param mixed &$text Reference to a text
979 public static function compressRevisionText( &$text ) {
980 return self
::getBlobStore()->compressData( $text );
984 * Re-converts revision text according to it's flags.
986 * @param mixed $text Reference to a text
987 * @param array $flags Compression flags
988 * @return string|bool Decompressed text, or false on failure
990 public static function decompressRevisionText( $text, $flags ) {
991 return self
::getBlobStore()->decompressData( $text, $flags );
995 * Insert a new revision into the database, returning the new revision ID
996 * number on success and dies horribly on failure.
998 * @param IDatabase $dbw (master connection)
999 * @throws MWException
1000 * @return int The revision ID
1002 public function insertOn( $dbw ) {
1005 // Note that $this->mRecord->getId() will typically return null here, but not always,
1006 // e.g. not when restoring a revision.
1008 if ( $this->mRecord
->getUser( RevisionRecord
::RAW
) === null ) {
1009 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
1010 $this->mRecord
->setUser( $wgUser );
1012 throw new MWException( 'Cannot insert revision with no associated user.' );
1016 $rec = self
::getRevisionStore()->insertRevisionOn( $this->mRecord
, $dbw );
1018 $this->mRecord
= $rec;
1020 // Avoid PHP 7.1 warning of passing $this by reference
1022 // TODO: hard-deprecate in 1.32 (or even 1.31?)
1023 Hooks
::run( 'RevisionInsertComplete', [ &$revision, null, null ] );
1025 return $rec->getId();
1029 * Get the base 36 SHA-1 value for a string of text
1030 * @param string $text
1033 public static function base36Sha1( $text ) {
1034 return SlotRecord
::base36Sha1( $text );
1038 * Create a new null-revision for insertion into a page's
1039 * history. This will not re-save the text, but simply refer
1040 * to the text from the previous version.
1042 * Such revisions can for instance identify page rename
1043 * operations and other such meta-modifications.
1045 * @param IDatabase $dbw
1046 * @param int $pageId ID number of the page to read from
1047 * @param string $summary Revision's summary
1048 * @param bool $minor Whether the revision should be considered as minor
1049 * @param User|null $user User object to use or null for $wgUser
1050 * @return Revision|null Revision or null on error
1052 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1058 $comment = CommentStoreComment
::newUnsavedComment( $summary, null );
1060 $title = Title
::newFromID( $pageId );
1061 $rec = self
::getRevisionStore()->newNullRevision( $dbw, $title, $comment, $minor, $user );
1063 return new Revision( $rec );
1067 * Determine if the current user is allowed to view a particular
1068 * field of this revision, if it's marked as deleted.
1070 * @param int $field One of self::DELETED_TEXT,
1071 * self::DELETED_COMMENT,
1072 * self::DELETED_USER
1073 * @param User|null $user User object to check, or null to use $wgUser
1076 public function userCan( $field, User
$user = null ) {
1077 return self
::userCanBitfield( $this->getVisibility(), $field, $user );
1081 * Determine if the current user is allowed to view a particular
1082 * field of this revision, if it's marked as deleted. This is used
1083 * by various classes to avoid duplication.
1085 * @param int $bitfield Current field
1086 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1087 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1088 * self::DELETED_USER = File::DELETED_USER
1089 * @param User|null $user User object to check, or null to use $wgUser
1090 * @param Title|null $title A Title object to check for per-page restrictions on,
1091 * instead of just plain userrights
1094 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1103 return RevisionRecord
::userCanBitfield( $bitfield, $field, $user, $title );
1107 * Get rev_timestamp from rev_id, without loading the rest of the row
1109 * @param Title $title
1112 * @return string|bool False if not found
1114 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1115 return self
::getRevisionStore()->getTimestampFromId( $title, $id, $flags );
1119 * Get count of revisions per page...not very efficient
1121 * @param IDatabase $db
1122 * @param int $id Page id
1125 static function countByPageId( $db, $id ) {
1126 return self
::getRevisionStore()->countRevisionsByPageId( $db, $id );
1130 * Get count of revisions per page...not very efficient
1132 * @param IDatabase $db
1133 * @param Title $title
1136 static function countByTitle( $db, $title ) {
1137 return self
::getRevisionStore()->countRevisionsByTitle( $db, $title );
1141 * Check if no edits were made by other users since
1142 * the time a user started editing the page. Limit to
1143 * 50 revisions for the sake of performance.
1146 * @deprecated since 1.24
1148 * @param IDatabase|int $db The Database to perform the check on. May be given as a
1149 * Database object or a database identifier usable with wfGetDB.
1150 * @param int $pageId The ID of the page in question
1151 * @param int $userId The ID of the user in question
1152 * @param string $since Look at edits since this time
1154 * @return bool True if the given user was the only one to edit since the given timestamp
1156 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1157 if ( is_int( $db ) ) {
1158 $db = wfGetDB( $db );
1161 return self
::getRevisionStore()->userWasLastToEdit( $db, $pageId, $userId, $since );
1165 * Load a revision based on a known page ID and current revision ID from the DB
1167 * This method allows for the use of caching, though accessing anything that normally
1168 * requires permission checks (aside from the text) will trigger a small DB lookup.
1169 * The title will also be loaded if $pageIdOrTitle is an integer ID.
1171 * @param IDatabase $db ignored!
1172 * @param int|Title $pageIdOrTitle Page ID or Title object
1173 * @param int $revId Known current revision of this page. Determined automatically if not given.
1174 * @return Revision|bool Returns false if missing
1177 public static function newKnownCurrent( IDatabase
$db, $pageIdOrTitle, $revId = 0 ) {
1178 $title = $pageIdOrTitle instanceof Title
1180 : Title
::newFromID( $pageIdOrTitle );
1186 $record = self
::getRevisionStore()->getKnownCurrentRevision( $title, $revId );
1187 return $record ?
new Revision( $record ) : false;