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 Wikimedia\Rdbms\Database
;
24 use Wikimedia\Rdbms\IDatabase
;
25 use MediaWiki\Linker\LinkTarget
;
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\Rdbms\ResultWrapper
;
28 use Wikimedia\Rdbms\FakeResultWrapper
;
33 class Revision
implements IDBAccessObject
{
41 protected $mOrigUserText;
45 protected $mMinorEdit;
47 protected $mTimestamp;
63 protected $mUnpatrolled;
65 /** @var stdClass|null */
68 /** @var null|Title */
73 protected $mContentModel;
75 protected $mContentFormat;
77 /** @var Content|null|bool */
79 /** @var null|ContentHandler */
80 protected $mContentHandler;
83 protected $mQueryFlags = 0;
84 /** @var bool Used for cached values to reload user text and rev_deleted */
85 protected $mRefreshMutableFields = false;
86 /** @var string Wiki ID; false means the current wiki */
87 protected $mWiki = false;
89 // Revision deletion constants
90 const DELETED_TEXT
= 1;
91 const DELETED_COMMENT
= 2;
92 const DELETED_USER
= 4;
93 const DELETED_RESTRICTED
= 8;
94 const SUPPRESSED_USER
= 12; // convenience
95 const SUPPRESSED_ALL
= 15; // convenience
97 // Audience options for accessors
99 const FOR_THIS_USER
= 2;
102 const TEXT_CACHE_GROUP
= 'revisiontext:10'; // process cache name and max key count
105 * Load a page revision from a given revision ID number.
106 * Returns null if no such revision can be found.
109 * Revision::READ_LATEST : Select the data from the master
110 * Revision::READ_LOCKING : Select & lock the data from the master
113 * @param int $flags (optional)
114 * @return Revision|null
116 public static function newFromId( $id, $flags = 0 ) {
117 return self
::newFromConds( [ 'rev_id' => intval( $id ) ], $flags );
121 * Load either the current, or a specified, revision
122 * that's attached to a given link target. If not attached
123 * to that link target, will return null.
126 * Revision::READ_LATEST : Select the data from the master
127 * Revision::READ_LOCKING : Select & lock the data from the master
129 * @param LinkTarget $linkTarget
130 * @param int $id (optional)
131 * @param int $flags Bitfield (optional)
132 * @return Revision|null
134 public static function newFromTitle( LinkTarget
$linkTarget, $id = 0, $flags = 0 ) {
136 'page_namespace' => $linkTarget->getNamespace(),
137 'page_title' => $linkTarget->getDBkey()
140 // Use the specified ID
141 $conds['rev_id'] = $id;
142 return self
::newFromConds( $conds, $flags );
144 // Use a join to get the latest revision
145 $conds[] = 'rev_id=page_latest';
146 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
147 return self
::loadFromConds( $db, $conds, $flags );
152 * Load either the current, or a specified, revision
153 * that's attached to a given page ID.
154 * Returns null if no such revision can be found.
157 * Revision::READ_LATEST : Select the data from the master (since 1.20)
158 * Revision::READ_LOCKING : Select & lock the data from the master
161 * @param int $revId (optional)
162 * @param int $flags Bitfield (optional)
163 * @return Revision|null
165 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
166 $conds = [ 'page_id' => $pageId ];
168 $conds['rev_id'] = $revId;
169 return self
::newFromConds( $conds, $flags );
171 // Use a join to get the latest revision
172 $conds[] = 'rev_id = page_latest';
173 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
174 return self
::loadFromConds( $db, $conds, $flags );
179 * Make a fake revision object from an archive table row. This is queried
180 * for permissions or even inserted (as in Special:Undelete)
181 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
184 * @param array $overrides
186 * @throws MWException
189 public static function newFromArchiveRow( $row, $overrides = [] ) {
190 global $wgContentHandlerUseDB;
192 $attribs = $overrides +
[
193 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
194 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
195 'comment' => CommentStore
::newKey( 'ar_comment' )
196 // Legacy because $row probably came from self::selectArchiveFields()
197 ->getCommentLegacy( wfGetDB( DB_REPLICA
), $row, true )->text
,
198 'user' => $row->ar_user
,
199 'user_text' => $row->ar_user_text
,
200 'timestamp' => $row->ar_timestamp
,
201 'minor_edit' => $row->ar_minor_edit
,
202 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
203 'deleted' => $row->ar_deleted
,
204 'len' => $row->ar_len
,
205 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
206 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
207 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
210 if ( !$wgContentHandlerUseDB ) {
211 unset( $attribs['content_model'] );
212 unset( $attribs['content_format'] );
215 if ( !isset( $attribs['title'] )
216 && isset( $row->ar_namespace
)
217 && isset( $row->ar_title
)
219 $attribs['title'] = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
222 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
223 // Pre-1.5 ar_text row
224 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
225 if ( $attribs['text'] === false ) {
226 throw new MWException( 'Unable to load text from archive row (possibly T24624)' );
229 return new self( $attribs );
238 public static function newFromRow( $row ) {
239 return new self( $row );
243 * Load a page revision from a given revision ID number.
244 * Returns null if no such revision can be found.
246 * @param IDatabase $db
248 * @return Revision|null
250 public static function loadFromId( $db, $id ) {
251 return self
::loadFromConds( $db, [ 'rev_id' => intval( $id ) ] );
255 * Load either the current, or a specified, revision
256 * that's attached to a given page. If not attached
257 * to that page, will return null.
259 * @param IDatabase $db
262 * @return Revision|null
264 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
265 $conds = [ 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) ];
267 $conds['rev_id'] = intval( $id );
269 $conds[] = 'rev_id=page_latest';
271 return self
::loadFromConds( $db, $conds );
275 * Load either the current, or a specified, revision
276 * that's attached to a given page. If not attached
277 * to that page, will return null.
279 * @param IDatabase $db
280 * @param Title $title
282 * @return Revision|null
284 public static function loadFromTitle( $db, $title, $id = 0 ) {
286 $matchId = intval( $id );
288 $matchId = 'page_latest';
290 return self
::loadFromConds( $db,
293 'page_namespace' => $title->getNamespace(),
294 'page_title' => $title->getDBkey()
300 * Load the revision for the given title with the given timestamp.
301 * WARNING: Timestamps may in some circumstances not be unique,
302 * so this isn't the best key to use.
304 * @param IDatabase $db
305 * @param Title $title
306 * @param string $timestamp
307 * @return Revision|null
309 public static function loadFromTimestamp( $db, $title, $timestamp ) {
310 return self
::loadFromConds( $db,
312 'rev_timestamp' => $db->timestamp( $timestamp ),
313 'page_namespace' => $title->getNamespace(),
314 'page_title' => $title->getDBkey()
320 * Given a set of conditions, fetch a revision
322 * This method is used then a revision ID is qualified and
323 * will incorporate some basic replica DB/master fallback logic
325 * @param array $conditions
326 * @param int $flags (optional)
327 * @return Revision|null
329 private static function newFromConds( $conditions, $flags = 0 ) {
330 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_REPLICA
);
332 $rev = self
::loadFromConds( $db, $conditions, $flags );
333 // Make sure new pending/committed revision are visibile later on
334 // within web requests to certain avoid bugs like T93866 and T94407.
336 && !( $flags & self
::READ_LATEST
)
337 && wfGetLB()->getServerCount() > 1
338 && wfGetLB()->hasOrMadeRecentMasterChanges()
340 $flags = self
::READ_LATEST
;
341 $db = wfGetDB( DB_MASTER
);
342 $rev = self
::loadFromConds( $db, $conditions, $flags );
346 $rev->mQueryFlags
= $flags;
353 * Given a set of conditions, fetch a revision from
354 * the given database connection.
356 * @param IDatabase $db
357 * @param array $conditions
358 * @param int $flags (optional)
359 * @return Revision|null
361 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
362 $row = self
::fetchFromConds( $db, $conditions, $flags );
364 $rev = new Revision( $row );
365 $rev->mWiki
= $db->getWikiID();
374 * Return a wrapper for a series of database rows to
375 * fetch all of a given page's revisions in turn.
376 * Each row can be fed to the constructor to get objects.
378 * @param LinkTarget $title
379 * @return ResultWrapper
380 * @deprecated Since 1.28
382 public static function fetchRevision( LinkTarget
$title ) {
383 $row = self
::fetchFromConds(
384 wfGetDB( DB_REPLICA
),
386 'rev_id=page_latest',
387 'page_namespace' => $title->getNamespace(),
388 'page_title' => $title->getDBkey()
392 return new FakeResultWrapper( $row ?
[ $row ] : [] );
396 * Given a set of conditions, return a ResultWrapper
397 * which will return matching database rows with the
398 * fields necessary to build Revision objects.
400 * @param IDatabase $db
401 * @param array $conditions
402 * @param int $flags (optional)
405 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
406 $fields = array_merge(
407 self
::selectFields(),
408 self
::selectPageFields(),
409 self
::selectUserFields()
412 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
413 $options[] = 'FOR UPDATE';
415 return $db->selectRow(
416 [ 'revision', 'page', 'user' ],
421 [ 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() ]
426 * Return the value of a select() JOIN conds array for the user table.
427 * This will get user table rows for logged-in users.
431 public static function userJoinCond() {
432 return [ 'LEFT JOIN', [ 'rev_user != 0', 'user_id = rev_user' ] ];
436 * Return the value of a select() page conds array for the page table.
437 * This will assure that the revision(s) are not orphaned from live pages.
441 public static function pageJoinCond() {
442 return [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
446 * Return the list of revision fields that should be selected to create
448 * @todo Deprecate this in favor of a method that returns tables and joins
449 * as well, and use CommentStore::getJoin().
452 public static function selectFields() {
453 global $wgContentHandlerUseDB;
469 $fields +
= CommentStore
::newKey( 'rev_comment' )->getFields();
471 if ( $wgContentHandlerUseDB ) {
472 $fields[] = 'rev_content_format';
473 $fields[] = 'rev_content_model';
480 * Return the list of revision fields that should be selected to create
481 * a new revision from an archive row.
482 * @todo Deprecate this in favor of a method that returns tables and joins
483 * as well, and use CommentStore::getJoin().
486 public static function selectArchiveFields() {
487 global $wgContentHandlerUseDB;
504 $fields +
= CommentStore
::newKey( 'ar_comment' )->getFields();
506 if ( $wgContentHandlerUseDB ) {
507 $fields[] = 'ar_content_format';
508 $fields[] = 'ar_content_model';
514 * Return the list of text fields that should be selected to read the
518 public static function selectTextFields() {
526 * Return the list of page fields that should be selected from page table
529 public static function selectPageFields() {
541 * Return the list of user fields that should be selected from user table
544 public static function selectUserFields() {
545 return [ 'user_name' ];
549 * Do a batched query to get the parent revision lengths
550 * @param IDatabase $db
551 * @param array $revIds
554 public static function getParentLengths( $db, array $revIds ) {
557 return $revLens; // empty
559 $res = $db->select( 'revision',
560 [ 'rev_id', 'rev_len' ],
561 [ 'rev_id' => $revIds ],
563 foreach ( $res as $row ) {
564 $revLens[$row->rev_id
] = $row->rev_len
;
570 * @param object|array $row Either a database row or an array
571 * @throws MWException
574 function __construct( $row ) {
575 if ( is_object( $row ) ) {
576 $this->mId
= intval( $row->rev_id
);
577 $this->mPage
= intval( $row->rev_page
);
578 $this->mTextId
= intval( $row->rev_text_id
);
579 $this->mComment
= CommentStore
::newKey( 'rev_comment' )
580 // Legacy because $row probably came from self::selectFields()
581 ->getCommentLegacy( wfGetDB( DB_REPLICA
), $row, true )->text
;
582 $this->mUser
= intval( $row->rev_user
);
583 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
584 $this->mTimestamp
= $row->rev_timestamp
;
585 $this->mDeleted
= intval( $row->rev_deleted
);
587 if ( !isset( $row->rev_parent_id
) ) {
588 $this->mParentId
= null;
590 $this->mParentId
= intval( $row->rev_parent_id
);
593 if ( !isset( $row->rev_len
) ) {
596 $this->mSize
= intval( $row->rev_len
);
599 if ( !isset( $row->rev_sha1
) ) {
602 $this->mSha1
= $row->rev_sha1
;
605 if ( isset( $row->page_latest
) ) {
606 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
607 $this->mTitle
= Title
::newFromRow( $row );
609 $this->mCurrent
= false;
610 $this->mTitle
= null;
613 if ( !isset( $row->rev_content_model
) ) {
614 $this->mContentModel
= null; # determine on demand if needed
616 $this->mContentModel
= strval( $row->rev_content_model
);
619 if ( !isset( $row->rev_content_format
) ) {
620 $this->mContentFormat
= null; # determine on demand if needed
622 $this->mContentFormat
= strval( $row->rev_content_format
);
625 // Lazy extraction...
627 if ( isset( $row->old_text
) ) {
628 $this->mTextRow
= $row;
630 // 'text' table row entry will be lazy-loaded
631 $this->mTextRow
= null;
634 // Use user_name for users and rev_user_text for IPs...
635 $this->mUserText
= null; // lazy load if left null
636 if ( $this->mUser
== 0 ) {
637 $this->mUserText
= $row->rev_user_text
; // IP user
638 } elseif ( isset( $row->user_name
) ) {
639 $this->mUserText
= $row->user_name
; // logged-in user
641 $this->mOrigUserText
= $row->rev_user_text
;
642 } elseif ( is_array( $row ) ) {
643 // Build a new revision to be saved...
644 global $wgUser; // ugh
646 # if we have a content object, use it to set the model and type
647 if ( !empty( $row['content'] ) ) {
648 // @todo when is that set? test with external store setup! check out insertOn() [dk]
649 if ( !empty( $row['text_id'] ) ) {
650 throw new MWException( "Text already stored in external store (id {$row['text_id']}), " .
651 "can't serialize content object" );
654 $row['content_model'] = $row['content']->getModel();
655 # note: mContentFormat is initializes later accordingly
656 # note: content is serialized later in this method!
657 # also set text to null?
660 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
661 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
662 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
663 $this->mUserText
= isset( $row['user_text'] )
664 ?
strval( $row['user_text'] ) : $wgUser->getName();
665 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
666 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
667 $this->mTimestamp
= isset( $row['timestamp'] )
668 ?
strval( $row['timestamp'] ) : wfTimestampNow();
669 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
670 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
671 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
672 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
674 $this->mContentModel
= isset( $row['content_model'] )
675 ?
strval( $row['content_model'] ) : null;
676 $this->mContentFormat
= isset( $row['content_format'] )
677 ?
strval( $row['content_format'] ) : null;
679 // Enforce spacing trimming on supplied text
680 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
681 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
682 $this->mTextRow
= null;
684 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
686 // if we have a Content object, override mText and mContentModel
687 if ( !empty( $row['content'] ) ) {
688 if ( !( $row['content'] instanceof Content
) ) {
689 throw new MWException( '`content` field must contain a Content object.' );
692 $handler = $this->getContentHandler();
693 $this->mContent
= $row['content'];
695 $this->mContentModel
= $this->mContent
->getModel();
696 $this->mContentHandler
= null;
698 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
699 } elseif ( $this->mText
!== null ) {
700 $handler = $this->getContentHandler();
701 $this->mContent
= $handler->unserializeContent( $this->mText
);
704 // If we have a Title object, make sure it is consistent with mPage.
705 if ( $this->mTitle
&& $this->mTitle
->exists() ) {
706 if ( $this->mPage
=== null ) {
707 // if the page ID wasn't known, set it now
708 $this->mPage
= $this->mTitle
->getArticleID();
709 } elseif ( $this->mTitle
->getArticleID() !== $this->mPage
) {
710 // Got different page IDs. This may be legit (e.g. during undeletion),
711 // but it seems worth mentioning it in the log.
712 wfDebug( "Page ID " . $this->mPage
. " mismatches the ID " .
713 $this->mTitle
->getArticleID() . " provided by the Title object." );
717 $this->mCurrent
= false;
719 // If we still have no length, see it we have the text to figure it out
720 if ( !$this->mSize
&& $this->mContent
!== null ) {
721 $this->mSize
= $this->mContent
->getSize();
725 if ( $this->mSha1
=== null ) {
726 $this->mSha1
= $this->mText
=== null ?
null : self
::base36Sha1( $this->mText
);
730 $this->getContentModel();
731 $this->getContentFormat();
733 throw new MWException( 'Revision constructor passed invalid row format.' );
735 $this->mUnpatrolled
= null;
743 public function getId() {
748 * Set the revision ID
750 * This should only be used for proposed revisions that turn out to be null edits
755 public function setId( $id ) {
756 $this->mId
= (int)$id;
760 * Set the user ID/name
762 * This should only be used for proposed revisions that turn out to be null edits
765 * @param int $id User ID
766 * @param string $name User name
768 public function setUserIdAndName( $id, $name ) {
769 $this->mUser
= (int)$id;
770 $this->mUserText
= $name;
771 $this->mOrigUserText
= $name;
779 public function getTextId() {
780 return $this->mTextId
;
784 * Get parent revision ID (the original previous page revision)
788 public function getParentId() {
789 return $this->mParentId
;
793 * Returns the length of the text in this revision, or null if unknown.
797 public function getSize() {
802 * Returns the base36 sha1 of the text in this revision, or null if unknown.
804 * @return string|null
806 public function getSha1() {
811 * Returns the title of the page associated with this entry or null.
813 * Will do a query, when title is not set and id is given.
817 public function getTitle() {
818 if ( $this->mTitle
!== null ) {
819 return $this->mTitle
;
821 // rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
822 if ( $this->mId
!== null ) {
823 $dbr = wfGetLB( $this->mWiki
)->getConnectionRef( DB_REPLICA
, [], $this->mWiki
);
824 $row = $dbr->selectRow(
825 [ 'page', 'revision' ],
826 self
::selectPageFields(),
827 [ 'page_id=rev_page', 'rev_id' => $this->mId
],
831 // @TODO: better foreign title handling
832 $this->mTitle
= Title
::newFromRow( $row );
836 if ( $this->mWiki
=== false ||
$this->mWiki
=== wfWikiID() ) {
837 // Loading by ID is best, though not possible for foreign titles
838 if ( !$this->mTitle
&& $this->mPage
!== null && $this->mPage
> 0 ) {
839 $this->mTitle
= Title
::newFromID( $this->mPage
);
843 return $this->mTitle
;
847 * Set the title of the revision
849 * @param Title $title
851 public function setTitle( $title ) {
852 $this->mTitle
= $title;
860 public function getPage() {
865 * Fetch revision's user id if it's available to the specified audience.
866 * If the specified audience does not have access to it, zero will be
869 * @param int $audience One of:
870 * Revision::FOR_PUBLIC to be displayed to all users
871 * Revision::FOR_THIS_USER to be displayed to the given user
872 * Revision::RAW get the ID regardless of permissions
873 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
874 * to the $audience parameter
877 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
878 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
880 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
888 * Fetch revision's user id without regard for the current user's permissions
891 * @deprecated since 1.25, use getUser( Revision::RAW )
893 public function getRawUser() {
894 wfDeprecated( __METHOD__
, '1.25' );
895 return $this->getUser( self
::RAW
);
899 * Fetch revision's username if it's available to the specified audience.
900 * If the specified audience does not have access to the username, an
901 * empty string will be returned.
903 * @param int $audience One of:
904 * Revision::FOR_PUBLIC to be displayed to all users
905 * Revision::FOR_THIS_USER to be displayed to the given user
906 * Revision::RAW get the text regardless of permissions
907 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
908 * to the $audience parameter
911 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
912 $this->loadMutableFields();
914 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
916 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
919 if ( $this->mUserText
=== null ) {
920 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
921 if ( $this->mUserText
=== false ) {
922 # This shouldn't happen, but it can if the wiki was recovered
923 # via importing revs and there is no user table entry yet.
924 $this->mUserText
= $this->mOrigUserText
;
927 return $this->mUserText
;
932 * Fetch revision's username without regard for view restrictions
935 * @deprecated since 1.25, use getUserText( Revision::RAW )
937 public function getRawUserText() {
938 wfDeprecated( __METHOD__
, '1.25' );
939 return $this->getUserText( self
::RAW
);
943 * Fetch revision comment if it's available to the specified audience.
944 * If the specified audience does not have access to the comment, an
945 * empty string will be returned.
947 * @param int $audience One of:
948 * Revision::FOR_PUBLIC to be displayed to all users
949 * Revision::FOR_THIS_USER to be displayed to the given user
950 * Revision::RAW get the text regardless of permissions
951 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
952 * to the $audience parameter
955 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
956 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
958 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
961 return $this->mComment
;
966 * Fetch revision comment without regard for the current user's permissions
969 * @deprecated since 1.25, use getComment( Revision::RAW )
971 public function getRawComment() {
972 wfDeprecated( __METHOD__
, '1.25' );
973 return $this->getComment( self
::RAW
);
979 public function isMinor() {
980 return (bool)$this->mMinorEdit
;
984 * @return int Rcid of the unpatrolled row, zero if there isn't one
986 public function isUnpatrolled() {
987 if ( $this->mUnpatrolled
!== null ) {
988 return $this->mUnpatrolled
;
990 $rc = $this->getRecentChange();
991 if ( $rc && $rc->getAttribute( 'rc_patrolled' ) == 0 ) {
992 $this->mUnpatrolled
= $rc->getAttribute( 'rc_id' );
994 $this->mUnpatrolled
= 0;
996 return $this->mUnpatrolled
;
1000 * Get the RC object belonging to the current revision, if there's one
1002 * @param int $flags (optional) $flags include:
1003 * Revision::READ_LATEST : Select the data from the master
1006 * @return RecentChange|null
1008 public function getRecentChange( $flags = 0 ) {
1009 $dbr = wfGetDB( DB_REPLICA
);
1011 list( $dbType, ) = DBAccessObjectUtils
::getDBOptions( $flags );
1013 return RecentChange
::newFromConds(
1015 'rc_user_text' => $this->getUserText( self
::RAW
),
1016 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
1017 'rc_this_oldid' => $this->getId()
1025 * @param int $field One of DELETED_* bitfield constants
1029 public function isDeleted( $field ) {
1030 if ( $this->isCurrent() && $field === self
::DELETED_TEXT
) {
1031 // Current revisions of pages cannot have the content hidden. Skipping this
1032 // check is very useful for Parser as it fetches templates using newKnownCurrent().
1033 // Calling getVisibility() in that case triggers a verification database query.
1034 return false; // no need to check
1037 return ( $this->getVisibility() & $field ) == $field;
1041 * Get the deletion bitfield of the revision
1045 public function getVisibility() {
1046 $this->loadMutableFields();
1048 return (int)$this->mDeleted
;
1052 * Fetch revision content if it's available to the specified audience.
1053 * If the specified audience does not have the ability to view this
1054 * revision, null will be returned.
1056 * @param int $audience One of:
1057 * Revision::FOR_PUBLIC to be displayed to all users
1058 * Revision::FOR_THIS_USER to be displayed to $wgUser
1059 * Revision::RAW get the text regardless of permissions
1060 * @param User $user User object to check for, only if FOR_THIS_USER is passed
1061 * to the $audience parameter
1063 * @return Content|null
1065 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1066 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
1068 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
1071 return $this->getContentInternal();
1076 * Get original serialized data (without checking view restrictions)
1081 public function getSerializedData() {
1082 if ( $this->mText
=== null ) {
1083 // Revision is immutable. Load on demand.
1084 $this->mText
= $this->loadText();
1087 return $this->mText
;
1091 * Gets the content object for the revision (or null on failure).
1093 * Note that for mutable Content objects, each call to this method will return a
1097 * @return Content|null The Revision's content, or null on failure.
1099 protected function getContentInternal() {
1100 if ( $this->mContent
=== null ) {
1101 $text = $this->getSerializedData();
1103 if ( $text !== null && $text !== false ) {
1104 // Unserialize content
1105 $handler = $this->getContentHandler();
1106 $format = $this->getContentFormat();
1108 $this->mContent
= $handler->unserializeContent( $text, $format );
1112 // NOTE: copy() will return $this for immutable content objects
1113 return $this->mContent ?
$this->mContent
->copy() : null;
1117 * Returns the content model for this revision.
1119 * If no content model was stored in the database, the default content model for the title is
1120 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
1121 * is used as a last resort.
1123 * @return string The content model id associated with this revision,
1124 * see the CONTENT_MODEL_XXX constants.
1126 public function getContentModel() {
1127 if ( !$this->mContentModel
) {
1128 $title = $this->getTitle();
1130 $this->mContentModel
= ContentHandler
::getDefaultModelFor( $title );
1132 $this->mContentModel
= CONTENT_MODEL_WIKITEXT
;
1135 assert( !empty( $this->mContentModel
) );
1138 return $this->mContentModel
;
1142 * Returns the content format for this revision.
1144 * If no content format was stored in the database, the default format for this
1145 * revision's content model is returned.
1147 * @return string The content format id associated with this revision,
1148 * see the CONTENT_FORMAT_XXX constants.
1150 public function getContentFormat() {
1151 if ( !$this->mContentFormat
) {
1152 $handler = $this->getContentHandler();
1153 $this->mContentFormat
= $handler->getDefaultFormat();
1155 assert( !empty( $this->mContentFormat
) );
1158 return $this->mContentFormat
;
1162 * Returns the content handler appropriate for this revision's content model.
1164 * @throws MWException
1165 * @return ContentHandler
1167 public function getContentHandler() {
1168 if ( !$this->mContentHandler
) {
1169 $model = $this->getContentModel();
1170 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
1172 $format = $this->getContentFormat();
1174 if ( !$this->mContentHandler
->isSupportedFormat( $format ) ) {
1175 throw new MWException( "Oops, the content format $format is not supported for "
1176 . "this content model, $model" );
1180 return $this->mContentHandler
;
1186 public function getTimestamp() {
1187 return wfTimestamp( TS_MW
, $this->mTimestamp
);
1193 public function isCurrent() {
1194 return $this->mCurrent
;
1198 * Get previous revision for this title
1200 * @return Revision|null
1202 public function getPrevious() {
1203 if ( $this->getTitle() ) {
1204 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
1206 return self
::newFromTitle( $this->getTitle(), $prev );
1213 * Get next revision for this title
1215 * @return Revision|null
1217 public function getNext() {
1218 if ( $this->getTitle() ) {
1219 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
1221 return self
::newFromTitle( $this->getTitle(), $next );
1228 * Get previous revision Id for this page_id
1229 * This is used to populate rev_parent_id on save
1231 * @param IDatabase $db
1234 private function getPreviousRevisionId( $db ) {
1235 if ( $this->mPage
=== null ) {
1238 # Use page_latest if ID is not given
1239 if ( !$this->mId
) {
1240 $prevId = $db->selectField( 'page', 'page_latest',
1241 [ 'page_id' => $this->mPage
],
1244 $prevId = $db->selectField( 'revision', 'rev_id',
1245 [ 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
],
1247 [ 'ORDER BY' => 'rev_id DESC' ] );
1249 return intval( $prevId );
1253 * Get revision text associated with an old or archive row
1255 * Both the flags and the text field must be included. Including the old_id
1256 * field will activate cache usage as long as the $wiki parameter is not set.
1258 * @param stdClass $row The text data
1259 * @param string $prefix Table prefix (default 'old_')
1260 * @param string|bool $wiki The name of the wiki to load the revision text from
1261 * (same as the the wiki $row was loaded from) or false to indicate the local
1262 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1263 * identifier as understood by the LoadBalancer class.
1264 * @return string|false Text the text requested or false on failure
1266 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1267 $textField = $prefix . 'text';
1268 $flagsField = $prefix . 'flags';
1270 if ( isset( $row->$flagsField ) ) {
1271 $flags = explode( ',', $row->$flagsField );
1276 if ( isset( $row->$textField ) ) {
1277 $text = $row->$textField;
1282 // Use external methods for external objects, text in table is URL-only then
1283 if ( in_array( 'external', $flags ) ) {
1285 $parts = explode( '://', $url, 2 );
1286 if ( count( $parts ) == 1 ||
$parts[1] == '' ) {
1290 if ( isset( $row->old_id
) && $wiki === false ) {
1291 // Make use of the wiki-local revision text cache
1292 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1293 // The cached value should be decompressed, so handle that and return here
1294 return $cache->getWithSetCallback(
1295 $cache->makeKey( 'revisiontext', 'textid', $row->old_id
),
1296 self
::getCacheTTL( $cache ),
1297 function () use ( $url, $wiki, $flags ) {
1298 // No negative caching per Revision::loadText()
1299 $text = ExternalStore
::fetchFromURL( $url, [ 'wiki' => $wiki ] );
1301 return self
::decompressRevisionText( $text, $flags );
1303 [ 'pcGroup' => self
::TEXT_CACHE_GROUP
, 'pcTTL' => $cache::TTL_PROC_LONG
]
1306 $text = ExternalStore
::fetchFromURL( $url, [ 'wiki' => $wiki ] );
1310 return self
::decompressRevisionText( $text, $flags );
1314 * If $wgCompressRevisions is enabled, we will compress data.
1315 * The input string is modified in place.
1316 * Return value is the flags field: contains 'gzip' if the
1317 * data is compressed, and 'utf-8' if we're saving in UTF-8
1320 * @param mixed &$text Reference to a text
1323 public static function compressRevisionText( &$text ) {
1324 global $wgCompressRevisions;
1327 # Revisions not marked this way will be converted
1328 # on load if $wgLegacyCharset is set in the future.
1331 if ( $wgCompressRevisions ) {
1332 if ( function_exists( 'gzdeflate' ) ) {
1333 $deflated = gzdeflate( $text );
1335 if ( $deflated === false ) {
1336 wfLogWarning( __METHOD__
. ': gzdeflate() failed' );
1342 wfDebug( __METHOD__
. " -- no zlib support, not compressing\n" );
1345 return implode( ',', $flags );
1349 * Re-converts revision text according to it's flags.
1351 * @param mixed $text Reference to a text
1352 * @param array $flags Compression flags
1353 * @return string|bool Decompressed text, or false on failure
1355 public static function decompressRevisionText( $text, $flags ) {
1356 global $wgLegacyEncoding, $wgContLang;
1358 if ( $text === false ) {
1359 // Text failed to be fetched; nothing to do
1363 if ( in_array( 'gzip', $flags ) ) {
1364 # Deal with optional compression of archived pages.
1365 # This can be done periodically via maintenance/compressOld.php, and
1366 # as pages are saved if $wgCompressRevisions is set.
1367 $text = gzinflate( $text );
1369 if ( $text === false ) {
1370 wfLogWarning( __METHOD__
. ': gzinflate() failed' );
1375 if ( in_array( 'object', $flags ) ) {
1376 # Generic compressed storage
1377 $obj = unserialize( $text );
1378 if ( !is_object( $obj ) ) {
1382 $text = $obj->getText();
1385 if ( $text !== false && $wgLegacyEncoding
1386 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags )
1388 # Old revisions kept around in a legacy encoding?
1389 # Upconvert on demand.
1390 # ("utf8" checked for compatibility with some broken
1391 # conversion scripts 2008-12-30)
1392 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1399 * Insert a new revision into the database, returning the new revision ID
1400 * number on success and dies horribly on failure.
1402 * @param IDatabase $dbw (master connection)
1403 * @throws MWException
1406 public function insertOn( $dbw ) {
1407 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1409 // We're inserting a new revision, so we have to use master anyway.
1410 // If it's a null revision, it may have references to rows that
1411 // are not in the replica yet (the text row).
1412 $this->mQueryFlags |
= self
::READ_LATEST
;
1414 // Not allowed to have rev_page equal to 0, false, etc.
1415 if ( !$this->mPage
) {
1416 $title = $this->getTitle();
1417 if ( $title instanceof Title
) {
1418 $titleText = ' for page ' . $title->getPrefixedText();
1422 throw new MWException( "Cannot insert revision$titleText: page ID must be nonzero" );
1425 $this->checkContentModel();
1427 $data = $this->mText
;
1428 $flags = self
::compressRevisionText( $data );
1430 # Write to external storage if required
1431 if ( $wgDefaultExternalStore ) {
1432 // Store and get the URL
1433 $data = ExternalStore
::insertToDefault( $data );
1435 throw new MWException( "Unable to store text to external storage" );
1440 $flags .= 'external';
1443 # Record the text (or external storage URL) to the text table
1444 if ( $this->mTextId
=== null ) {
1445 $dbw->insert( 'text',
1447 'old_text' => $data,
1448 'old_flags' => $flags,
1451 $this->mTextId
= $dbw->insertId();
1454 if ( $this->mComment
=== null ) {
1455 $this->mComment
= "";
1458 # Record the edit in revisions
1460 'rev_page' => $this->mPage
,
1461 'rev_text_id' => $this->mTextId
,
1462 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1463 'rev_user' => $this->mUser
,
1464 'rev_user_text' => $this->mUserText
,
1465 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1466 'rev_deleted' => $this->mDeleted
,
1467 'rev_len' => $this->mSize
,
1468 'rev_parent_id' => $this->mParentId
=== null
1469 ?
$this->getPreviousRevisionId( $dbw )
1471 'rev_sha1' => $this->mSha1
=== null
1472 ? self
::base36Sha1( $this->mText
)
1475 if ( $this->mId
!== null ) {
1476 $row['rev_id'] = $this->mId
;
1479 list( $commentFields, $commentCallback ) =
1480 CommentStore
::newKey( 'rev_comment' )->insertWithTempTable( $dbw, $this->mComment
);
1481 $row +
= $commentFields;
1483 if ( $wgContentHandlerUseDB ) {
1484 // NOTE: Store null for the default model and format, to save space.
1485 // XXX: Makes the DB sensitive to changed defaults.
1486 // Make this behavior optional? Only in miser mode?
1488 $model = $this->getContentModel();
1489 $format = $this->getContentFormat();
1491 $title = $this->getTitle();
1493 if ( $title === null ) {
1494 throw new MWException( "Insufficient information to determine the title of the "
1495 . "revision's page!" );
1498 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1499 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1501 $row['rev_content_model'] = ( $model === $defaultModel ) ?
null : $model;
1502 $row['rev_content_format'] = ( $format === $defaultFormat ) ?
null : $format;
1505 $dbw->insert( 'revision', $row, __METHOD__
);
1507 if ( $this->mId
=== null ) {
1508 // Only if auto-increment was used
1509 $this->mId
= $dbw->insertId();
1511 $commentCallback( $this->mId
);
1513 // Assertion to try to catch T92046
1514 if ( (int)$this->mId
=== 0 ) {
1515 throw new UnexpectedValueException(
1516 'After insert, Revision mId is ' . var_export( $this->mId
, 1 ) . ': ' .
1517 var_export( $row, 1 )
1521 // Avoid PHP 7.1 warning of passing $this by reference
1523 Hooks
::run( 'RevisionInsertComplete', [ &$revision, $data, $flags ] );
1528 protected function checkContentModel() {
1529 global $wgContentHandlerUseDB;
1531 // Note: may return null for revisions that have not yet been inserted
1532 $title = $this->getTitle();
1534 $model = $this->getContentModel();
1535 $format = $this->getContentFormat();
1536 $handler = $this->getContentHandler();
1538 if ( !$handler->isSupportedFormat( $format ) ) {
1539 $t = $title->getPrefixedDBkey();
1541 throw new MWException( "Can't use format $format with content model $model on $t" );
1544 if ( !$wgContentHandlerUseDB && $title ) {
1545 // if $wgContentHandlerUseDB is not set,
1546 // all revisions must use the default content model and format.
1548 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1549 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1550 $defaultFormat = $defaultHandler->getDefaultFormat();
1552 if ( $this->getContentModel() != $defaultModel ) {
1553 $t = $title->getPrefixedDBkey();
1555 throw new MWException( "Can't save non-default content model with "
1556 . "\$wgContentHandlerUseDB disabled: model is $model, "
1557 . "default for $t is $defaultModel" );
1560 if ( $this->getContentFormat() != $defaultFormat ) {
1561 $t = $title->getPrefixedDBkey();
1563 throw new MWException( "Can't use non-default content format with "
1564 . "\$wgContentHandlerUseDB disabled: format is $format, "
1565 . "default for $t is $defaultFormat" );
1569 $content = $this->getContent( self
::RAW
);
1570 $prefixedDBkey = $title->getPrefixedDBkey();
1571 $revId = $this->mId
;
1574 throw new MWException(
1575 "Content of revision $revId ($prefixedDBkey) could not be loaded for validation!"
1578 if ( !$content->isValid() ) {
1579 throw new MWException(
1580 "Content of revision $revId ($prefixedDBkey) is not valid! Content model is $model"
1586 * Get the base 36 SHA-1 value for a string of text
1587 * @param string $text
1590 public static function base36Sha1( $text ) {
1591 return Wikimedia\base_convert
( sha1( $text ), 16, 36, 31 );
1595 * Get the text cache TTL
1597 * @param WANObjectCache $cache
1600 private static function getCacheTTL( WANObjectCache
$cache ) {
1601 global $wgRevisionCacheExpiry;
1603 if ( $cache->getQoS( $cache::ATTR_EMULATION
) <= $cache::QOS_EMULATION_SQL
) {
1604 // Do not cache RDBMs blobs in...the RDBMs store
1605 $ttl = $cache::TTL_UNCACHEABLE
;
1607 $ttl = $wgRevisionCacheExpiry ?
: $cache::TTL_UNCACHEABLE
;
1614 * Lazy-load the revision's text.
1615 * Currently hardcoded to the 'text' table storage engine.
1617 * @return string|bool The revision's text, or false on failure
1619 private function loadText() {
1620 $cache = ObjectCache
::getMainWANInstance();
1622 // No negative caching; negative hits on text rows may be due to corrupted replica DBs
1623 return $cache->getWithSetCallback(
1624 $cache->makeKey( 'revisiontext', 'textid', $this->getTextId() ),
1625 self
::getCacheTTL( $cache ),
1627 return $this->fetchText();
1629 [ 'pcGroup' => self
::TEXT_CACHE_GROUP
, 'pcTTL' => $cache::TTL_PROC_LONG
]
1633 private function fetchText() {
1634 $textId = $this->getTextId();
1636 // If we kept data for lazy extraction, use it now...
1637 if ( $this->mTextRow
!== null ) {
1638 $row = $this->mTextRow
;
1639 $this->mTextRow
= null;
1644 // Callers doing updates will pass in READ_LATEST as usual. Since the text/blob tables
1645 // do not normally get rows changed around, set READ_LATEST_IMMUTABLE in those cases.
1646 $flags = $this->mQueryFlags
;
1647 $flags |
= DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
)
1648 ? self
::READ_LATEST_IMMUTABLE
1651 list( $index, $options, $fallbackIndex, $fallbackOptions ) =
1652 DBAccessObjectUtils
::getDBOptions( $flags );
1655 // Text data is immutable; check replica DBs first.
1656 $row = wfGetDB( $index )->selectRow(
1658 [ 'old_text', 'old_flags' ],
1659 [ 'old_id' => $textId ],
1665 // Fallback to DB_MASTER in some cases if the row was not found
1666 if ( !$row && $fallbackIndex !== null ) {
1667 // Use FOR UPDATE if it was used to fetch this revision. This avoids missing the row
1668 // due to REPEATABLE-READ. Also fallback to the master if READ_LATEST is provided.
1669 $row = wfGetDB( $fallbackIndex )->selectRow(
1671 [ 'old_text', 'old_flags' ],
1672 [ 'old_id' => $textId ],
1679 wfDebugLog( 'Revision', "No text row with ID '$textId' (revision {$this->getId()})." );
1682 $text = self
::getRevisionText( $row );
1683 if ( $row && $text === false ) {
1684 wfDebugLog( 'Revision', "No blob for text row '$textId' (revision {$this->getId()})." );
1687 return is_string( $text ) ?
$text : false;
1691 * Create a new null-revision for insertion into a page's
1692 * history. This will not re-save the text, but simply refer
1693 * to the text from the previous version.
1695 * Such revisions can for instance identify page rename
1696 * operations and other such meta-modifications.
1698 * @param IDatabase $dbw
1699 * @param int $pageId ID number of the page to read from
1700 * @param string $summary Revision's summary
1701 * @param bool $minor Whether the revision should be considered as minor
1702 * @param User|null $user User object to use or null for $wgUser
1703 * @return Revision|null Revision or null on error
1705 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1706 global $wgContentHandlerUseDB;
1708 $fields = [ 'page_latest', 'page_namespace', 'page_title',
1709 'rev_text_id', 'rev_len', 'rev_sha1' ];
1711 if ( $wgContentHandlerUseDB ) {
1712 $fields[] = 'rev_content_model';
1713 $fields[] = 'rev_content_format';
1716 $current = $dbw->selectRow(
1717 [ 'page', 'revision' ],
1720 'page_id' => $pageId,
1721 'page_latest=rev_id',
1724 [ 'FOR UPDATE' ] // T51581
1735 'user_text' => $user->getName(),
1736 'user' => $user->getId(),
1737 'comment' => $summary,
1738 'minor_edit' => $minor,
1739 'text_id' => $current->rev_text_id
,
1740 'parent_id' => $current->page_latest
,
1741 'len' => $current->rev_len
,
1742 'sha1' => $current->rev_sha1
1745 if ( $wgContentHandlerUseDB ) {
1746 $row['content_model'] = $current->rev_content_model
;
1747 $row['content_format'] = $current->rev_content_format
;
1750 $row['title'] = Title
::makeTitle( $current->page_namespace
, $current->page_title
);
1752 $revision = new Revision( $row );
1761 * Determine if the current user is allowed to view a particular
1762 * field of this revision, if it's marked as deleted.
1764 * @param int $field One of self::DELETED_TEXT,
1765 * self::DELETED_COMMENT,
1766 * self::DELETED_USER
1767 * @param User|null $user User object to check, or null to use $wgUser
1770 public function userCan( $field, User
$user = null ) {
1771 return self
::userCanBitfield( $this->getVisibility(), $field, $user );
1775 * Determine if the current user is allowed to view a particular
1776 * field of this revision, if it's marked as deleted. This is used
1777 * by various classes to avoid duplication.
1779 * @param int $bitfield Current field
1780 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1781 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1782 * self::DELETED_USER = File::DELETED_USER
1783 * @param User|null $user User object to check, or null to use $wgUser
1784 * @param Title|null $title A Title object to check for per-page restrictions on,
1785 * instead of just plain userrights
1788 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1791 if ( $bitfield & $field ) { // aspect is deleted
1792 if ( $user === null ) {
1796 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1797 $permissions = [ 'suppressrevision', 'viewsuppressed' ];
1798 } elseif ( $field & self
::DELETED_TEXT
) {
1799 $permissions = [ 'deletedtext' ];
1801 $permissions = [ 'deletedhistory' ];
1803 $permissionlist = implode( ', ', $permissions );
1804 if ( $title === null ) {
1805 wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
1806 return call_user_func_array( [ $user, 'isAllowedAny' ], $permissions );
1808 $text = $title->getPrefixedText();
1809 wfDebug( "Checking for $permissionlist on $text due to $field match on $bitfield\n" );
1810 foreach ( $permissions as $perm ) {
1811 if ( $title->userCan( $perm, $user ) ) {
1823 * Get rev_timestamp from rev_id, without loading the rest of the row
1825 * @param Title $title
1828 * @return string|bool False if not found
1830 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1831 $db = ( $flags & self
::READ_LATEST
)
1832 ?
wfGetDB( DB_MASTER
)
1833 : wfGetDB( DB_REPLICA
);
1834 // Casting fix for databases that can't take '' for rev_id
1838 $conds = [ 'rev_id' => $id ];
1839 $conds['rev_page'] = $title->getArticleID();
1840 $timestamp = $db->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1842 return ( $timestamp !== false ) ?
wfTimestamp( TS_MW
, $timestamp ) : false;
1846 * Get count of revisions per page...not very efficient
1848 * @param IDatabase $db
1849 * @param int $id Page id
1852 static function countByPageId( $db, $id ) {
1853 $row = $db->selectRow( 'revision', [ 'revCount' => 'COUNT(*)' ],
1854 [ 'rev_page' => $id ], __METHOD__
);
1856 return $row->revCount
;
1862 * Get count of revisions per page...not very efficient
1864 * @param IDatabase $db
1865 * @param Title $title
1868 static function countByTitle( $db, $title ) {
1869 $id = $title->getArticleID();
1871 return self
::countByPageId( $db, $id );
1877 * Check if no edits were made by other users since
1878 * the time a user started editing the page. Limit to
1879 * 50 revisions for the sake of performance.
1882 * @deprecated since 1.24
1884 * @param IDatabase|int $db The Database to perform the check on. May be given as a
1885 * Database object or a database identifier usable with wfGetDB.
1886 * @param int $pageId The ID of the page in question
1887 * @param int $userId The ID of the user in question
1888 * @param string $since Look at edits since this time
1890 * @return bool True if the given user was the only one to edit since the given timestamp
1892 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1897 if ( is_int( $db ) ) {
1898 $db = wfGetDB( $db );
1901 $res = $db->select( 'revision',
1904 'rev_page' => $pageId,
1905 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1908 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ] );
1909 foreach ( $res as $row ) {
1910 if ( $row->rev_user
!= $userId ) {
1918 * Load a revision based on a known page ID and current revision ID from the DB
1920 * This method allows for the use of caching, though accessing anything that normally
1921 * requires permission checks (aside from the text) will trigger a small DB lookup.
1922 * The title will also be lazy loaded, though setTitle() can be used to preload it.
1924 * @param IDatabase $db
1925 * @param int $pageId Page ID
1926 * @param int $revId Known current revision of this page
1927 * @return Revision|bool Returns false if missing
1930 public static function newKnownCurrent( IDatabase
$db, $pageId, $revId ) {
1931 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
1932 return $cache->getWithSetCallback(
1933 // Page/rev IDs passed in from DB to reflect history merges
1934 $cache->makeGlobalKey( 'revision', $db->getWikiID(), $pageId, $revId ),
1936 function ( $curValue, &$ttl, array &$setOpts ) use ( $db, $pageId, $revId ) {
1937 $setOpts +
= Database
::getCacheSetOptions( $db );
1939 $rev = Revision
::loadFromPageId( $db, $pageId, $revId );
1940 // Reflect revision deletion and user renames
1942 $rev->mTitle
= null; // mutable; lazy-load
1943 $rev->mRefreshMutableFields
= true;
1946 return $rev ?
: false; // don't cache negatives
1952 * For cached revisions, make sure the user name and rev_deleted is up-to-date
1954 private function loadMutableFields() {
1955 if ( !$this->mRefreshMutableFields
) {
1956 return; // not needed
1959 $this->mRefreshMutableFields
= false;
1960 $dbr = wfGetLB( $this->mWiki
)->getConnectionRef( DB_REPLICA
, [], $this->mWiki
);
1961 $row = $dbr->selectRow(
1962 [ 'revision', 'user' ],
1963 [ 'rev_deleted', 'user_name' ],
1964 [ 'rev_id' => $this->mId
, 'user_id = rev_user' ],
1967 if ( $row ) { // update values
1968 $this->mDeleted
= (int)$row->rev_deleted
;
1969 $this->mUserText
= $row->user_name
;