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\Revision\MutableRevisionRecord
;
24 use MediaWiki\Revision\RevisionAccessException
;
25 use MediaWiki\Revision\RevisionFactory
;
26 use MediaWiki\Revision\RevisionLookup
;
27 use MediaWiki\Revision\RevisionRecord
;
28 use MediaWiki\Revision\RevisionStore
;
29 use MediaWiki\Revision\RevisionStoreRecord
;
30 use MediaWiki\Revision\SlotRecord
;
31 use MediaWiki\Storage\SqlBlobStore
;
32 use Wikimedia\Assert\Assert
;
33 use Wikimedia\Rdbms\IDatabase
;
34 use MediaWiki\Linker\LinkTarget
;
35 use MediaWiki\MediaWikiServices
;
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( $wiki = false ) {
65 return MediaWikiServices
::getInstance()->getRevisionStoreFactory()
66 ->getRevisionStore( $wiki );
68 return MediaWikiServices
::getInstance()->getRevisionStore();
73 * @return RevisionLookup
75 protected static function getRevisionLookup() {
76 return MediaWikiServices
::getInstance()->getRevisionLookup();
80 * @return RevisionFactory
82 protected static function getRevisionFactory() {
83 return MediaWikiServices
::getInstance()->getRevisionFactory();
87 * @param bool|string $wiki The ID of the target wiki database. Use false for the local wiki.
89 * @return SqlBlobStore
91 protected static function getBlobStore( $wiki = false ) {
92 $store = MediaWikiServices
::getInstance()
93 ->getBlobStoreFactory()
94 ->newSqlBlobStore( $wiki );
96 if ( !$store instanceof SqlBlobStore
) {
97 throw new RuntimeException(
98 'The backwards compatibility code in Revision currently requires the BlobStore '
99 . 'service to be an SqlBlobStore instance, but it is a ' . get_class( $store )
107 * Load a page revision from a given revision ID number.
108 * Returns null if no such revision can be found.
111 * Revision::READ_LATEST : Select the data from the master
112 * Revision::READ_LOCKING : Select & lock the data from the master
115 * @param int $flags (optional)
116 * @return Revision|null
118 public static function newFromId( $id, $flags = 0 ) {
119 $rec = self
::getRevisionLookup()->getRevisionById( $id, $flags );
120 return $rec ?
new Revision( $rec, $flags ) : null;
124 * Load either the current, or a specified, revision
125 * that's attached to a given link target. If not attached
126 * to that link target, will return null.
129 * Revision::READ_LATEST : Select the data from the master
130 * Revision::READ_LOCKING : Select & lock the data from the master
132 * @param LinkTarget $linkTarget
133 * @param int $id (optional)
134 * @param int $flags Bitfield (optional)
135 * @return Revision|null
137 public static function newFromTitle( LinkTarget
$linkTarget, $id = 0, $flags = 0 ) {
138 $rec = self
::getRevisionLookup()->getRevisionByTitle( $linkTarget, $id, $flags );
139 return $rec ?
new Revision( $rec, $flags ) : null;
143 * Load either the current, or a specified, revision
144 * that's attached to a given page ID.
145 * Returns null if no such revision can be found.
148 * Revision::READ_LATEST : Select the data from the master (since 1.20)
149 * Revision::READ_LOCKING : Select & lock the data from the master
152 * @param int $revId (optional)
153 * @param int $flags Bitfield (optional)
154 * @return Revision|null
156 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
157 $rec = self
::getRevisionLookup()->getRevisionByPageId( $pageId, $revId, $flags );
158 return $rec ?
new Revision( $rec, $flags ) : null;
162 * Make a fake revision object from an archive table row. This is queried
163 * for permissions or even inserted (as in Special:Undelete)
166 * @param array $overrides
168 * @throws MWException
171 public static function newFromArchiveRow( $row, $overrides = [] ) {
173 * MCR Migration: https://phabricator.wikimedia.org/T183564
174 * This method used to overwrite attributes, then passed to Revision::__construct
175 * RevisionStore::newRevisionFromArchiveRow instead overrides row field names
176 * So do a conversion here.
178 if ( array_key_exists( 'page', $overrides ) ) {
179 $overrides['page_id'] = $overrides['page'];
180 unset( $overrides['page'] );
184 * We require a Title for both the Revision object and the RevisionRecord.
185 * Below is duplicated logic from RevisionStore::newRevisionFromArchiveRow
186 * to fetch a title in order pass it into the Revision object.
189 if ( isset( $overrides['title'] ) ) {
190 if ( !( $overrides['title'] instanceof Title
) ) {
191 throw new MWException( 'title field override must contain a Title object.' );
194 $title = $overrides['title'];
196 if ( $title !== null ) {
197 if ( isset( $row->ar_namespace
) && isset( $row->ar_title
) ) {
198 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
200 throw new InvalidArgumentException(
201 'A Title or ar_namespace and ar_title must be given'
206 $rec = self
::getRevisionFactory()->newRevisionFromArchiveRow( $row, 0, $title, $overrides );
207 return new Revision( $rec, self
::READ_NORMAL
, $title );
213 * MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that
214 * newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead,
215 * a MutableRevisionRecord should be constructed directly.
216 * RevisionStore::newMutableRevisionFromArray() can be used as a temporary replacement,
217 * but should be avoided.
219 * @param object|array $row
222 public static function newFromRow( $row ) {
223 if ( is_array( $row ) ) {
224 $rec = self
::getRevisionFactory()->newMutableRevisionFromArray( $row );
226 $rec = self
::getRevisionFactory()->newRevisionFromRow( $row );
229 return new Revision( $rec );
233 * Load a page revision from a given revision ID number.
234 * Returns null if no such revision can be found.
236 * @deprecated since 1.31, use RevisionStore::getRevisionById() instead.
238 * @param IDatabase $db
240 * @return Revision|null
242 public static function loadFromId( $db, $id ) {
243 wfDeprecated( __METHOD__
, '1.31' ); // no known callers
244 $rec = self
::getRevisionStore()->loadRevisionFromId( $db, $id );
245 return $rec ?
new Revision( $rec ) : null;
249 * Load either the current, or a specified, revision
250 * that's attached to a given page. If not attached
251 * to that page, will return null.
253 * @deprecated since 1.31, use RevisionStore::getRevisionByPageId() instead.
255 * @param IDatabase $db
258 * @return Revision|null
260 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
261 $rec = self
::getRevisionStore()->loadRevisionFromPageId( $db, $pageid, $id );
262 return $rec ?
new Revision( $rec ) : null;
266 * Load either the current, or a specified, revision
267 * that's attached to a given page. If not attached
268 * to that page, will return null.
270 * @deprecated since 1.31, use RevisionStore::getRevisionByTitle() instead.
272 * @param IDatabase $db
273 * @param Title $title
275 * @return Revision|null
277 public static function loadFromTitle( $db, $title, $id = 0 ) {
278 $rec = self
::getRevisionStore()->loadRevisionFromTitle( $db, $title, $id );
279 return $rec ?
new Revision( $rec ) : null;
283 * Load the revision for the given title with the given timestamp.
284 * WARNING: Timestamps may in some circumstances not be unique,
285 * so this isn't the best key to use.
287 * @deprecated since 1.31, use RevisionStore::getRevisionByTimestamp()
288 * or RevisionStore::loadRevisionFromTimestamp() instead.
290 * @param IDatabase $db
291 * @param Title $title
292 * @param string $timestamp
293 * @return Revision|null
295 public static function loadFromTimestamp( $db, $title, $timestamp ) {
296 $rec = self
::getRevisionStore()->loadRevisionFromTimestamp( $db, $title, $timestamp );
297 return $rec ?
new Revision( $rec ) : null;
301 * Return the value of a select() JOIN conds array for the user table.
302 * This will get user table rows for logged-in users.
304 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
307 public static function userJoinCond() {
308 global $wgActorTableSchemaMigrationStage;
310 wfDeprecated( __METHOD__
, '1.31' );
311 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
312 // If code is using this instead of self::getQueryInfo(), there's
313 // no way the join it's trying to do can work once the old fields
314 // aren't being used anymore.
315 throw new BadMethodCallException(
316 'Cannot use ' . __METHOD__
317 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
321 return [ 'LEFT JOIN', [ 'rev_user != 0', 'user_id = rev_user' ] ];
325 * Return the value of a select() page conds array for the page table.
326 * This will assure that the revision(s) are not orphaned from live pages.
328 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
331 public static function pageJoinCond() {
332 wfDeprecated( __METHOD__
, '1.31' );
333 return [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
337 * Return the list of revision fields that should be selected to create
339 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
342 public static function selectFields() {
343 global $wgContentHandlerUseDB, $wgActorTableSchemaMigrationStage;
344 global $wgMultiContentRevisionSchemaMigrationStage;
346 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
347 // If code is using this instead of self::getQueryInfo(), there's a
348 // decent chance it's going to try to directly access
349 // $row->rev_user or $row->rev_user_text and we can't give it
350 // useful values here once those aren't being used anymore.
351 throw new BadMethodCallException(
352 'Cannot use ' . __METHOD__
353 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
357 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
358 // If code is using this instead of self::getQueryInfo(), there's a
359 // decent chance it's going to try to directly access
360 // $row->rev_text_id or $row->rev_content_model and we can't give it
361 // useful values here once those aren't being written anymore,
362 // and may not exist at all.
363 throw new BadMethodCallException(
364 'Cannot use ' . __METHOD__
. ' when $wgMultiContentRevisionSchemaMigrationStage '
365 . 'does not have SCHEMA_COMPAT_WRITE_OLD set.'
369 wfDeprecated( __METHOD__
, '1.31' );
378 'rev_actor' => 'NULL',
386 $fields +
= CommentStore
::getStore()->getFields( 'rev_comment' );
388 if ( $wgContentHandlerUseDB ) {
389 $fields[] = 'rev_content_format';
390 $fields[] = 'rev_content_model';
397 * Return the list of revision fields that should be selected to create
398 * a new revision from an archive row.
399 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
402 public static function selectArchiveFields() {
403 global $wgContentHandlerUseDB, $wgActorTableSchemaMigrationStage;
404 global $wgMultiContentRevisionSchemaMigrationStage;
406 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
407 // If code is using this instead of self::getQueryInfo(), there's a
408 // decent chance it's going to try to directly access
409 // $row->ar_user or $row->ar_user_text and we can't give it
410 // useful values here once those aren't being used anymore.
411 throw new BadMethodCallException(
412 'Cannot use ' . __METHOD__
413 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
417 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
418 // If code is using this instead of self::getQueryInfo(), there's a
419 // decent chance it's going to try to directly access
420 // $row->ar_text_id or $row->ar_content_model and we can't give it
421 // useful values here once those aren't being written anymore,
422 // and may not exist at all.
423 throw new BadMethodCallException(
424 'Cannot use ' . __METHOD__
. ' when $wgMultiContentRevisionSchemaMigrationStage '
425 . 'does not have SCHEMA_COMPAT_WRITE_OLD set.'
429 wfDeprecated( __METHOD__
, '1.31' );
439 'ar_actor' => 'NULL',
447 $fields +
= CommentStore
::getStore()->getFields( 'ar_comment' );
449 if ( $wgContentHandlerUseDB ) {
450 $fields[] = 'ar_content_format';
451 $fields[] = 'ar_content_model';
457 * Return the list of text fields that should be selected to read the
459 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.
462 public static function selectTextFields() {
463 wfDeprecated( __METHOD__
, '1.31' );
471 * Return the list of page fields that should be selected from page table
472 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
475 public static function selectPageFields() {
476 wfDeprecated( __METHOD__
, '1.31' );
488 * Return the list of user fields that should be selected from user table
489 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
492 public static function selectUserFields() {
493 wfDeprecated( __METHOD__
, '1.31' );
494 return [ 'user_name' ];
498 * Return the tables, fields, and join conditions to be selected to create
499 * a new revision object.
501 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
502 * @param array $options Any combination of the following strings
503 * - 'page': Join with the page table, and select fields to identify the page
504 * - 'user': Join with the user table, and select the user name
505 * - 'text': Join with the text table, and select fields to load page text
506 * @return array With three keys:
507 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
508 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
509 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
511 public static function getQueryInfo( $options = [] ) {
512 return self
::getRevisionStore()->getQueryInfo( $options );
516 * Return the tables, fields, and join conditions to be selected to create
517 * a new archived revision object.
519 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
520 * @return array With three keys:
521 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
522 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
523 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
525 public static function getArchiveQueryInfo() {
526 return self
::getRevisionStore()->getArchiveQueryInfo();
530 * Do a batched query to get the parent revision lengths
532 * @deprecated in 1.31, use RevisionStore::getRevisionSizes instead.
534 * @param IDatabase $db
535 * @param array $revIds
538 public static function getParentLengths( $db, array $revIds ) {
539 return self
::getRevisionStore()->listRevisionSizes( $db, $revIds );
543 * @param object|array|RevisionRecord $row Either a database row or an array
544 * @param int $queryFlags
545 * @param Title|null $title
549 function __construct( $row, $queryFlags = 0, Title
$title = null ) {
552 if ( $row instanceof RevisionRecord
) {
553 $this->mRecord
= $row;
554 } elseif ( is_array( $row ) ) {
555 // If no user is specified, fall back to using the global user object, to stay
556 // compatible with pre-1.31 behavior.
557 if ( !isset( $row['user'] ) && !isset( $row['user_text'] ) ) {
558 $row['user'] = $wgUser;
561 $this->mRecord
= self
::getRevisionFactory()->newMutableRevisionFromArray(
564 $this->ensureTitle( $row, $queryFlags, $title )
566 } elseif ( is_object( $row ) ) {
567 $this->mRecord
= self
::getRevisionFactory()->newRevisionFromRow(
570 $this->ensureTitle( $row, $queryFlags, $title )
573 throw new InvalidArgumentException(
574 '$row must be a row object, an associative array, or a RevisionRecord'
578 Assert
::postcondition( $this->mRecord
!== null, 'Failed to construct a RevisionRecord' );
582 * Make sure we have *some* Title object for use by the constructor.
583 * For B/C, the constructor shouldn't fail even for a bad page ID or bad revision ID.
585 * @param array|object $row
586 * @param int $queryFlags
587 * @param Title|null $title
589 * @return Title $title if not null, or a Title constructed from information in $row.
591 private function ensureTitle( $row, $queryFlags, $title = null ) {
596 if ( is_array( $row ) ) {
597 if ( isset( $row['title'] ) ) {
598 if ( !( $row['title'] instanceof Title
) ) {
599 throw new MWException( 'title field must contain a Title object.' );
602 return $row['title'];
605 $pageId = $row['page'] ??
0;
606 $revId = $row['id'] ??
0;
608 $pageId = $row->rev_page ??
0;
609 $revId = $row->rev_id ??
0;
613 $title = self
::getRevisionStore()->getTitle( $pageId, $revId, $queryFlags );
614 } catch ( RevisionAccessException
$ex ) {
615 // construct a dummy title!
616 wfLogWarning( __METHOD__
. ': ' . $ex->getMessage() );
618 // NOTE: this Title will only be used inside RevisionRecord
619 $title = Title
::makeTitleSafe( NS_SPECIAL
, "Badtitle/ID=$pageId" );
620 $title->resetArticleID( $pageId );
627 * @return RevisionRecord
629 public function getRevisionRecord() {
630 return $this->mRecord
;
638 public function getId() {
639 return $this->mRecord
->getId();
643 * Set the revision ID
645 * This should only be used for proposed revisions that turn out to be null edits.
647 * @note Only supported on Revisions that were constructed based on associative arrays,
648 * since they are mutable.
651 * @param int|string $id
652 * @throws MWException
654 public function setId( $id ) {
655 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
656 $this->mRecord
->setId( intval( $id ) );
658 throw new MWException( __METHOD__
. ' is not supported on this instance' );
663 * Set the user ID/name
665 * This should only be used for proposed revisions that turn out to be null edits
667 * @note Only supported on Revisions that were constructed based on associative arrays,
668 * since they are mutable.
671 * @deprecated since 1.31, please reuse old Revision object
672 * @param int $id User ID
673 * @param string $name User name
674 * @throws MWException
676 public function setUserIdAndName( $id, $name ) {
677 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
678 $user = User
::newFromAnyId( intval( $id ), $name, null );
679 $this->mRecord
->setUser( $user );
681 throw new MWException( __METHOD__
. ' is not supported on this instance' );
688 private function getMainSlotRaw() {
689 return $this->mRecord
->getSlot( SlotRecord
::MAIN
, RevisionRecord
::RAW
);
693 * Get the ID of the row of the text table that contains the content of the
694 * revision's main slot, if that content is stored in the text table.
696 * If the content is stored elsewhere, this returns null.
698 * @deprecated since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to
699 * get that actual address that can be used with BlobStore::getBlob(); or use
700 * RevisionRecord::hasSameContent() to check if two revisions have the same content.
704 public function getTextId() {
705 $slot = $this->getMainSlotRaw();
706 return $slot->hasAddress()
707 ? self
::getBlobStore()->getTextIdFromAddress( $slot->getAddress() )
712 * Get parent revision ID (the original previous page revision)
714 * @return int|null The ID of the parent revision. 0 indicates that there is no
715 * parent revision. Null indicates that the parent revision is not known.
717 public function getParentId() {
718 return $this->mRecord
->getParentId();
722 * Returns the length of the text in this revision, or null if unknown.
726 public function getSize() {
728 return $this->mRecord
->getSize();
729 } catch ( RevisionAccessException
$ex ) {
735 * Returns the base36 sha1 of the content in this revision, or null if unknown.
737 * @return string|null
739 public function getSha1() {
741 return $this->mRecord
->getSha1();
742 } catch ( RevisionAccessException
$ex ) {
748 * Returns the title of the page associated with this entry.
749 * Since 1.31, this will never return null.
751 * Will do a query, when title is not set and id is given.
755 public function getTitle() {
756 $linkTarget = $this->mRecord
->getPageAsLinkTarget();
757 return Title
::newFromLinkTarget( $linkTarget );
761 * Set the title of the revision
763 * @deprecated since 1.31, this is now a noop. Pass the Title to the constructor instead.
765 * @param Title $title
767 public function setTitle( $title ) {
768 if ( !$title->equals( $this->getTitle() ) ) {
769 throw new InvalidArgumentException(
770 $title->getPrefixedText()
771 . ' is not the same as '
772 . $this->mRecord
->getPageAsLinkTarget()->__toString()
782 public function getPage() {
783 return $this->mRecord
->getPageId();
787 * Fetch revision's user id if it's available to the specified audience.
788 * If the specified audience does not have access to it, zero will be
791 * @param int $audience One of:
792 * Revision::FOR_PUBLIC to be displayed to all users
793 * Revision::FOR_THIS_USER to be displayed to the given user
794 * Revision::RAW get the ID regardless of permissions
795 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
796 * to the $audience parameter
799 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
802 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
806 $user = $this->mRecord
->getUser( $audience, $user );
807 return $user ?
$user->getId() : 0;
811 * Fetch revision's username if it's available to the specified audience.
812 * If the specified audience does not have access to the username, an
813 * empty string 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 the given user
818 * Revision::RAW get the text regardless of permissions
819 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
820 * to the $audience parameter
823 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
826 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
830 $user = $this->mRecord
->getUser( $audience, $user );
831 return $user ?
$user->getName() : '';
835 * @param int $audience One of:
836 * Revision::FOR_PUBLIC to be displayed to all users
837 * Revision::FOR_THIS_USER to be displayed to the given user
838 * Revision::RAW get the text regardless of permissions
839 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
840 * to the $audience parameter
842 * @return string|null Returns null if the specified audience does not have access to the
845 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
848 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
852 $comment = $this->mRecord
->getComment( $audience, $user );
853 return $comment === null ?
null : $comment->text
;
859 public function isMinor() {
860 return $this->mRecord
->isMinor();
864 * @return int Rcid of the unpatrolled row, zero if there isn't one
866 public function isUnpatrolled() {
867 return self
::getRevisionStore()->getRcIdIfUnpatrolled( $this->mRecord
);
871 * Get the RC object belonging to the current revision, if there's one
873 * @param int $flags (optional) $flags include:
874 * Revision::READ_LATEST : Select the data from the master
877 * @return RecentChange|null
879 public function getRecentChange( $flags = 0 ) {
880 return self
::getRevisionStore()->getRecentChange( $this->mRecord
, $flags );
884 * @param int $field One of DELETED_* bitfield constants
888 public function isDeleted( $field ) {
889 return $this->mRecord
->isDeleted( $field );
893 * Get the deletion bitfield of the revision
897 public function getVisibility() {
898 return $this->mRecord
->getVisibility();
902 * Fetch revision content if it's available to the specified audience.
903 * If the specified audience does not have the ability to view this
904 * revision, or the content could not be loaded, null will be returned.
906 * @param int $audience One of:
907 * Revision::FOR_PUBLIC to be displayed to all users
908 * Revision::FOR_THIS_USER to be displayed to $user
909 * Revision::RAW get the text regardless of permissions
910 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
911 * to the $audience parameter
913 * @return Content|null
915 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
918 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
923 return $this->mRecord
->getContent( SlotRecord
::MAIN
, $audience, $user );
925 catch ( RevisionAccessException
$e ) {
931 * Get original serialized data (without checking view restrictions)
934 * @deprecated since 1.31, use BlobStore::getBlob instead.
938 public function getSerializedData() {
939 $slot = $this->getMainSlotRaw();
940 return $slot->getContent()->serialize();
944 * Returns the content model for the main slot of this revision.
946 * If no content model was stored in the database, the default content model for the title is
947 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
948 * is used as a last resort.
950 * @todo drop this, with MCR, there no longer is a single model associated with a revision.
952 * @return string The content model id associated with this revision,
953 * see the CONTENT_MODEL_XXX constants.
955 public function getContentModel() {
956 return $this->getMainSlotRaw()->getModel();
960 * Returns the content format for the main slot of this revision.
962 * If no content format was stored in the database, the default format for this
963 * revision's content model is returned.
965 * @todo drop this, the format is irrelevant to the revision!
967 * @return string The content format id associated with this revision,
968 * see the CONTENT_FORMAT_XXX constants.
970 public function getContentFormat() {
971 $format = $this->getMainSlotRaw()->getFormat();
973 if ( $format === null ) {
974 // if no format was stored along with the blob, fall back to default format
975 $format = $this->getContentHandler()->getDefaultFormat();
982 * Returns the content handler appropriate for this revision's content model.
984 * @throws MWException
985 * @return ContentHandler
987 public function getContentHandler() {
988 return ContentHandler
::getForModelID( $this->getContentModel() );
994 public function getTimestamp() {
995 return $this->mRecord
->getTimestamp();
1001 public function isCurrent() {
1002 return ( $this->mRecord
instanceof RevisionStoreRecord
) && $this->mRecord
->isCurrent();
1006 * Get previous revision for this title
1008 * @return Revision|null
1010 public function getPrevious() {
1011 $title = $this->getTitle();
1012 $rec = self
::getRevisionLookup()->getPreviousRevision( $this->mRecord
, $title );
1013 return $rec ?
new Revision( $rec, self
::READ_NORMAL
, $title ) : null;
1017 * Get next revision for this title
1019 * @return Revision|null
1021 public function getNext() {
1022 $title = $this->getTitle();
1023 $rec = self
::getRevisionLookup()->getNextRevision( $this->mRecord
, $title );
1024 return $rec ?
new Revision( $rec, self
::READ_NORMAL
, $title ) : null;
1028 * Get revision text associated with an old or archive row
1030 * If the text field is not included, this uses RevisionStore to load the appropriate slot
1031 * and return its serialized content. This is the default backwards-compatibility behavior
1032 * when reading from the MCR aware database schema is enabled. For this to work, either
1033 * the revision ID or the page ID must be included in the row.
1035 * When using the old text field, the flags field must also be set. Including the old_id
1036 * field will activate cache usage as long as the $wiki parameter is not set.
1038 * @deprecated since 1.32, use RevisionStore::newRevisionFromRow instead.
1040 * @param stdClass $row The text data. If a falsy value is passed instead, false is returned.
1041 * @param string $prefix Table prefix (default 'old_')
1042 * @param string|bool $wiki The name of the wiki to load the revision text from
1043 * (same as the wiki $row was loaded from) or false to indicate the local
1044 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1045 * identifier as understood by the LoadBalancer class.
1046 * @return string|false Text the text requested or false on failure
1048 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1049 global $wgMultiContentRevisionSchemaMigrationStage;
1055 $textField = $prefix . 'text';
1056 $flagsField = $prefix . 'flags';
1058 if ( isset( $row->$textField ) ) {
1059 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
1060 // The text field was read, but it's no longer being populated!
1061 // We could gloss over this by using the text when it's there and loading
1062 // if when it's not, but it seems preferable to complain loudly about a
1063 // query that is no longer guaranteed to work reliably.
1064 throw new LogicException(
1065 'Cannot use ' . __METHOD__
. ' with the ' . $textField . ' field when'
1066 . ' $wgMultiContentRevisionSchemaMigrationStage does not include'
1067 . ' SCHEMA_COMPAT_WRITE_OLD. The field may not be populated for all revisions!'
1071 $text = $row->$textField;
1073 // Missing text field, we are probably looking at the MCR-enabled DB schema.
1075 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
1076 // This method should no longer be used with the new schema. Ideally, we
1077 // would already trigger a deprecation warning when SCHEMA_COMPAT_READ_NEW is set.
1078 wfDeprecated( __METHOD__
. ' (MCR without SCHEMA_COMPAT_WRITE_OLD)', '1.32' );
1081 $store = self
::getRevisionStore( $wiki );
1082 $rev = $prefix === 'ar_'
1083 ?
$store->newRevisionFromArchiveRow( $row )
1084 : $store->newRevisionFromRow( $row );
1086 $content = $rev->getContent( SlotRecord
::MAIN
);
1087 return $content ?
$content->serialize() : false;
1090 if ( isset( $row->$flagsField ) ) {
1091 $flags = explode( ',', $row->$flagsField );
1096 $cacheKey = isset( $row->old_id
)
1097 ? SqlBlobStore
::makeAddressFromTextId( $row->old_id
)
1100 $revisionText = self
::getBlobStore( $wiki )->expandBlob( $text, $flags, $cacheKey );
1102 if ( $revisionText === false ) {
1103 if ( isset( $row->old_id
) ) {
1104 wfLogWarning( __METHOD__
. ": Bad data in text row {$row->old_id}! " );
1106 wfLogWarning( __METHOD__
. ": Bad data in text row! " );
1111 return $revisionText;
1115 * If $wgCompressRevisions is enabled, we will compress data.
1116 * The input string is modified in place.
1117 * Return value is the flags field: contains 'gzip' if the
1118 * data is compressed, and 'utf-8' if we're saving in UTF-8
1121 * @param mixed &$text Reference to a text
1124 public static function compressRevisionText( &$text ) {
1125 return self
::getBlobStore()->compressData( $text );
1129 * Re-converts revision text according to it's flags.
1131 * @param mixed $text Reference to a text
1132 * @param array $flags Compression flags
1133 * @return string|bool Decompressed text, or false on failure
1135 public static function decompressRevisionText( $text, $flags ) {
1136 if ( $text === false ) {
1137 // Text failed to be fetched; nothing to do
1141 return self
::getBlobStore()->decompressData( $text, $flags );
1145 * Insert a new revision into the database, returning the new revision ID
1146 * number on success and dies horribly on failure.
1148 * @param IDatabase $dbw (master connection)
1149 * @throws MWException
1150 * @return int The revision ID
1152 public function insertOn( $dbw ) {
1155 // Note that $this->mRecord->getId() will typically return null here, but not always,
1156 // e.g. not when restoring a revision.
1158 if ( $this->mRecord
->getUser( RevisionRecord
::RAW
) === null ) {
1159 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
1160 $this->mRecord
->setUser( $wgUser );
1162 throw new MWException( 'Cannot insert revision with no associated user.' );
1166 $rec = self
::getRevisionStore()->insertRevisionOn( $this->mRecord
, $dbw );
1168 $this->mRecord
= $rec;
1169 Assert
::postcondition( $this->mRecord
!== null, 'Failed to acquire a RevisionRecord' );
1171 return $rec->getId();
1175 * Get the base 36 SHA-1 value for a string of text
1176 * @param string $text
1179 public static function base36Sha1( $text ) {
1180 return SlotRecord
::base36Sha1( $text );
1184 * Create a new null-revision for insertion into a page's
1185 * history. This will not re-save the text, but simply refer
1186 * to the text from the previous version.
1188 * Such revisions can for instance identify page rename
1189 * operations and other such meta-modifications.
1191 * @param IDatabase $dbw
1192 * @param int $pageId ID number of the page to read from
1193 * @param string $summary Revision's summary
1194 * @param bool $minor Whether the revision should be considered as minor
1195 * @param User|null $user User object to use or null for $wgUser
1196 * @return Revision|null Revision or null on error
1198 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1204 $comment = CommentStoreComment
::newUnsavedComment( $summary, null );
1206 $title = Title
::newFromID( $pageId, Title
::GAID_FOR_UPDATE
);
1207 if ( $title === null ) {
1211 $rec = self
::getRevisionStore()->newNullRevision( $dbw, $title, $comment, $minor, $user );
1213 return $rec ?
new Revision( $rec ) : null;
1217 * Determine if the current user is allowed to view a particular
1218 * field of this revision, if it's marked as deleted.
1220 * @param int $field One of self::DELETED_TEXT,
1221 * self::DELETED_COMMENT,
1222 * self::DELETED_USER
1223 * @param User|null $user User object to check, or null to use $wgUser
1226 public function userCan( $field, User
$user = null ) {
1227 return self
::userCanBitfield( $this->getVisibility(), $field, $user );
1231 * Determine if the current user is allowed to view a particular
1232 * field of this revision, if it's marked as deleted. This is used
1233 * by various classes to avoid duplication.
1235 * @param int $bitfield Current field
1236 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1237 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1238 * self::DELETED_USER = File::DELETED_USER
1239 * @param User|null $user User object to check, or null to use $wgUser
1240 * @param Title|null $title A Title object to check for per-page restrictions on,
1241 * instead of just plain userrights
1244 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1253 return RevisionRecord
::userCanBitfield( $bitfield, $field, $user, $title );
1257 * Get rev_timestamp from rev_id, without loading the rest of the row
1259 * @param Title $title
1262 * @return string|bool False if not found
1264 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1265 return self
::getRevisionStore()->getTimestampFromId( $title, $id, $flags );
1269 * Get count of revisions per page...not very efficient
1271 * @param IDatabase $db
1272 * @param int $id Page id
1275 static function countByPageId( $db, $id ) {
1276 return self
::getRevisionStore()->countRevisionsByPageId( $db, $id );
1280 * Get count of revisions per page...not very efficient
1282 * @param IDatabase $db
1283 * @param Title $title
1286 static function countByTitle( $db, $title ) {
1287 return self
::getRevisionStore()->countRevisionsByTitle( $db, $title );
1291 * Check if no edits were made by other users since
1292 * the time a user started editing the page. Limit to
1293 * 50 revisions for the sake of performance.
1296 * @deprecated since 1.24
1298 * @param IDatabase|int $db The Database to perform the check on. May be given as a
1299 * Database object or a database identifier usable with wfGetDB.
1300 * @param int $pageId The ID of the page in question
1301 * @param int $userId The ID of the user in question
1302 * @param string $since Look at edits since this time
1304 * @return bool True if the given user was the only one to edit since the given timestamp
1306 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1307 if ( is_int( $db ) ) {
1308 $db = wfGetDB( $db );
1311 return self
::getRevisionStore()->userWasLastToEdit( $db, $pageId, $userId, $since );
1315 * Load a revision based on a known page ID and current revision ID from the DB
1317 * This method allows for the use of caching, though accessing anything that normally
1318 * requires permission checks (aside from the text) will trigger a small DB lookup.
1319 * The title will also be loaded if $pageIdOrTitle is an integer ID.
1321 * @param IDatabase $db ignored!
1322 * @param int|Title $pageIdOrTitle Page ID or Title object
1323 * @param int $revId Known current revision of this page. Determined automatically if not given.
1324 * @return Revision|bool Returns false if missing
1327 public static function newKnownCurrent( IDatabase
$db, $pageIdOrTitle, $revId = 0 ) {
1328 $title = $pageIdOrTitle instanceof Title
1330 : Title
::newFromID( $pageIdOrTitle );
1336 $record = self
::getRevisionLookup()->getKnownCurrentRevision( $title, $revId );
1337 return $record ?
new Revision( $record ) : false;