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\Rdbms\IDatabase
;
33 use MediaWiki\Linker\LinkTarget
;
34 use MediaWiki\MediaWikiServices
;
35 use Wikimedia\Rdbms\ResultWrapper
;
36 use Wikimedia\Rdbms\FakeResultWrapper
;
39 * @deprecated since 1.31, use RevisionRecord, RevisionStore, and BlobStore instead.
41 class Revision
implements IDBAccessObject
{
43 /** @var RevisionRecord */
46 // Revision deletion constants
47 const DELETED_TEXT
= RevisionRecord
::DELETED_TEXT
;
48 const DELETED_COMMENT
= RevisionRecord
::DELETED_COMMENT
;
49 const DELETED_USER
= RevisionRecord
::DELETED_USER
;
50 const DELETED_RESTRICTED
= RevisionRecord
::DELETED_RESTRICTED
;
51 const SUPPRESSED_USER
= RevisionRecord
::SUPPRESSED_USER
;
52 const SUPPRESSED_ALL
= RevisionRecord
::SUPPRESSED_ALL
;
54 // Audience options for accessors
55 const FOR_PUBLIC
= RevisionRecord
::FOR_PUBLIC
;
56 const FOR_THIS_USER
= RevisionRecord
::FOR_THIS_USER
;
57 const RAW
= RevisionRecord
::RAW
;
59 const TEXT_CACHE_GROUP
= SqlBlobStore
::TEXT_CACHE_GROUP
;
62 * @return RevisionStore
64 protected static function getRevisionStore() {
65 return MediaWikiServices
::getInstance()->getRevisionStore();
69 * @return RevisionLookup
71 protected static function getRevisionLookup() {
72 return MediaWikiServices
::getInstance()->getRevisionLookup();
76 * @return RevisionFactory
78 protected static function getRevisionFactory() {
79 return MediaWikiServices
::getInstance()->getRevisionFactory();
83 * @param bool|string $wiki The ID of the target wiki database. Use false for the local wiki.
85 * @return SqlBlobStore
87 protected static function getBlobStore( $wiki = false ) {
88 $store = MediaWikiServices
::getInstance()
89 ->getBlobStoreFactory()
90 ->newSqlBlobStore( $wiki );
92 if ( !$store instanceof SqlBlobStore
) {
93 throw new RuntimeException(
94 'The backwards compatibility code in Revision currently requires the BlobStore '
95 . 'service to be an SqlBlobStore instance, but it is a ' . get_class( $store )
103 * Load a page revision from a given revision ID number.
104 * Returns null if no such revision can be found.
107 * Revision::READ_LATEST : Select the data from the master
108 * Revision::READ_LOCKING : Select & lock the data from the master
111 * @param int $flags (optional)
112 * @return Revision|null
114 public static function newFromId( $id, $flags = 0 ) {
115 $rec = self
::getRevisionLookup()->getRevisionById( $id, $flags );
116 return $rec === null ?
null : new Revision( $rec, $flags );
120 * Load either the current, or a specified, revision
121 * that's attached to a given link target. If not attached
122 * to that link target, will return null.
125 * Revision::READ_LATEST : Select the data from the master
126 * Revision::READ_LOCKING : Select & lock the data from the master
128 * @param LinkTarget $linkTarget
129 * @param int $id (optional)
130 * @param int $flags Bitfield (optional)
131 * @return Revision|null
133 public static function newFromTitle( LinkTarget
$linkTarget, $id = 0, $flags = 0 ) {
134 $rec = self
::getRevisionLookup()->getRevisionByTitle( $linkTarget, $id, $flags );
135 return $rec === null ?
null : new Revision( $rec, $flags );
139 * Load either the current, or a specified, revision
140 * that's attached to a given page ID.
141 * Returns null if no such revision can be found.
144 * Revision::READ_LATEST : Select the data from the master (since 1.20)
145 * Revision::READ_LOCKING : Select & lock the data from the master
148 * @param int $revId (optional)
149 * @param int $flags Bitfield (optional)
150 * @return Revision|null
152 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
153 $rec = self
::getRevisionLookup()->getRevisionByPageId( $pageId, $revId, $flags );
154 return $rec === null ?
null : new Revision( $rec, $flags );
158 * Make a fake revision object from an archive table row. This is queried
159 * for permissions or even inserted (as in Special:Undelete)
162 * @param array $overrides
164 * @throws MWException
167 public static function newFromArchiveRow( $row, $overrides = [] ) {
169 * MCR Migration: https://phabricator.wikimedia.org/T183564
170 * This method used to overwrite attributes, then passed to Revision::__construct
171 * RevisionStore::newRevisionFromArchiveRow instead overrides row field names
172 * So do a conversion here.
174 if ( array_key_exists( 'page', $overrides ) ) {
175 $overrides['page_id'] = $overrides['page'];
176 unset( $overrides['page'] );
180 * We require a Title for both the Revision object and the RevisionRecord.
181 * Below is duplicated logic from RevisionStore::newRevisionFromArchiveRow
182 * to fetch a title in order pass it into the Revision object.
185 if ( isset( $overrides['title'] ) ) {
186 if ( !( $overrides['title'] instanceof Title
) ) {
187 throw new MWException( 'title field override must contain a Title object.' );
190 $title = $overrides['title'];
192 if ( $title !== null ) {
193 if ( isset( $row->ar_namespace
) && isset( $row->ar_title
) ) {
194 $title = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
196 throw new InvalidArgumentException(
197 'A Title or ar_namespace and ar_title must be given'
202 $rec = self
::getRevisionFactory()->newRevisionFromArchiveRow( $row, 0, $title, $overrides );
203 return new Revision( $rec, self
::READ_NORMAL
, $title );
209 * MCR migration note: replaced by RevisionStore::newRevisionFromRow(). Note that
210 * newFromRow() also accepts arrays, while newRevisionFromRow() does not. Instead,
211 * a MutableRevisionRecord should be constructed directly.
212 * RevisionStore::newMutableRevisionFromArray() can be used as a temporary replacement,
213 * but should be avoided.
215 * @param object|array $row
218 public static function newFromRow( $row ) {
219 if ( is_array( $row ) ) {
220 $rec = self
::getRevisionFactory()->newMutableRevisionFromArray( $row );
222 $rec = self
::getRevisionFactory()->newRevisionFromRow( $row );
225 return new Revision( $rec );
229 * Load a page revision from a given revision ID number.
230 * Returns null if no such revision can be found.
232 * @deprecated since 1.31, use RevisionStore::getRevisionById() instead.
234 * @param IDatabase $db
236 * @return Revision|null
238 public static function loadFromId( $db, $id ) {
239 wfDeprecated( __METHOD__
, '1.31' ); // no known callers
240 $rec = self
::getRevisionStore()->loadRevisionFromId( $db, $id );
241 return $rec === null ?
null : new Revision( $rec );
245 * Load either the current, or a specified, revision
246 * that's attached to a given page. If not attached
247 * to that page, will return null.
249 * @deprecated since 1.31, use RevisionStore::getRevisionByPageId() instead.
251 * @param IDatabase $db
254 * @return Revision|null
256 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
257 $rec = self
::getRevisionStore()->loadRevisionFromPageId( $db, $pageid, $id );
258 return $rec === null ?
null : new Revision( $rec );
262 * Load either the current, or a specified, revision
263 * that's attached to a given page. If not attached
264 * to that page, will return null.
266 * @deprecated since 1.31, use RevisionStore::getRevisionByTitle() instead.
268 * @param IDatabase $db
269 * @param Title $title
271 * @return Revision|null
273 public static function loadFromTitle( $db, $title, $id = 0 ) {
274 $rec = self
::getRevisionStore()->loadRevisionFromTitle( $db, $title, $id );
275 return $rec === null ?
null : new Revision( $rec );
279 * Load the revision for the given title with the given timestamp.
280 * WARNING: Timestamps may in some circumstances not be unique,
281 * so this isn't the best key to use.
283 * @deprecated since 1.31, use RevisionStore::getRevisionByTimestamp()
284 * or RevisionStore::loadRevisionFromTimestamp() instead.
286 * @param IDatabase $db
287 * @param Title $title
288 * @param string $timestamp
289 * @return Revision|null
291 public static function loadFromTimestamp( $db, $title, $timestamp ) {
292 $rec = self
::getRevisionStore()->loadRevisionFromTimestamp( $db, $title, $timestamp );
293 return $rec === null ?
null : new Revision( $rec );
297 * Return a wrapper for a series of database rows to
298 * fetch all of a given page's revisions in turn.
299 * Each row can be fed to the constructor to get objects.
301 * @param LinkTarget $title
302 * @return ResultWrapper
303 * @deprecated Since 1.28, no callers in core nor in known extensions. No-op since 1.31.
305 public static function fetchRevision( LinkTarget
$title ) {
306 wfDeprecated( __METHOD__
, '1.31' );
307 return new FakeResultWrapper( [] );
311 * Return the value of a select() JOIN conds array for the user table.
312 * This will get user table rows for logged-in users.
314 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
317 public static function userJoinCond() {
318 global $wgActorTableSchemaMigrationStage;
320 wfDeprecated( __METHOD__
, '1.31' );
321 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
322 // If code is using this instead of self::getQueryInfo(), there's
323 // no way the join it's trying to do can work once the old fields
324 // aren't being used anymore.
325 throw new BadMethodCallException(
326 'Cannot use ' . __METHOD__
327 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
331 return [ 'LEFT JOIN', [ 'rev_user != 0', 'user_id = rev_user' ] ];
335 * Return the value of a select() page conds array for the page table.
336 * This will assure that the revision(s) are not orphaned from live pages.
338 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
341 public static function pageJoinCond() {
342 wfDeprecated( __METHOD__
, '1.31' );
343 return [ 'INNER JOIN', [ 'page_id = rev_page' ] ];
347 * Return the list of revision fields that should be selected to create
349 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
352 public static function selectFields() {
353 global $wgContentHandlerUseDB, $wgActorTableSchemaMigrationStage;
354 global $wgMultiContentRevisionSchemaMigrationStage;
356 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
357 // If code is using this instead of self::getQueryInfo(), there's a
358 // decent chance it's going to try to directly access
359 // $row->rev_user or $row->rev_user_text and we can't give it
360 // useful values here once those aren't being used anymore.
361 throw new BadMethodCallException(
362 'Cannot use ' . __METHOD__
363 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
367 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
368 // If code is using this instead of self::getQueryInfo(), there's a
369 // decent chance it's going to try to directly access
370 // $row->rev_text_id or $row->rev_content_model and we can't give it
371 // useful values here once those aren't being written anymore,
372 // and may not exist at all.
373 throw new BadMethodCallException(
374 'Cannot use ' . __METHOD__
. ' when $wgMultiContentRevisionSchemaMigrationStage '
375 . 'does not have SCHEMA_COMPAT_WRITE_OLD set.'
379 wfDeprecated( __METHOD__
, '1.31' );
388 'rev_actor' => 'NULL',
396 $fields +
= CommentStore
::getStore()->getFields( 'rev_comment' );
398 if ( $wgContentHandlerUseDB ) {
399 $fields[] = 'rev_content_format';
400 $fields[] = 'rev_content_model';
407 * Return the list of revision fields that should be selected to create
408 * a new revision from an archive row.
409 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
412 public static function selectArchiveFields() {
413 global $wgContentHandlerUseDB, $wgActorTableSchemaMigrationStage;
414 global $wgMultiContentRevisionSchemaMigrationStage;
416 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
417 // If code is using this instead of self::getQueryInfo(), there's a
418 // decent chance it's going to try to directly access
419 // $row->ar_user or $row->ar_user_text and we can't give it
420 // useful values here once those aren't being used anymore.
421 throw new BadMethodCallException(
422 'Cannot use ' . __METHOD__
423 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
427 if ( !( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) ) {
428 // If code is using this instead of self::getQueryInfo(), there's a
429 // decent chance it's going to try to directly access
430 // $row->ar_text_id or $row->ar_content_model and we can't give it
431 // useful values here once those aren't being written anymore,
432 // and may not exist at all.
433 throw new BadMethodCallException(
434 'Cannot use ' . __METHOD__
. ' when $wgMultiContentRevisionSchemaMigrationStage '
435 . 'does not have SCHEMA_COMPAT_WRITE_OLD set.'
439 wfDeprecated( __METHOD__
, '1.31' );
449 'ar_actor' => 'NULL',
457 $fields +
= CommentStore
::getStore()->getFields( 'ar_comment' );
459 if ( $wgContentHandlerUseDB ) {
460 $fields[] = 'ar_content_format';
461 $fields[] = 'ar_content_model';
467 * Return the list of text fields that should be selected to read the
469 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'text' ] ) instead.
472 public static function selectTextFields() {
473 wfDeprecated( __METHOD__
, '1.31' );
481 * Return the list of page fields that should be selected from page table
482 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'page' ] ) instead.
485 public static function selectPageFields() {
486 wfDeprecated( __METHOD__
, '1.31' );
498 * Return the list of user fields that should be selected from user table
499 * @deprecated since 1.31, use RevisionStore::getQueryInfo( [ 'user' ] ) instead.
502 public static function selectUserFields() {
503 wfDeprecated( __METHOD__
, '1.31' );
504 return [ 'user_name' ];
508 * Return the tables, fields, and join conditions to be selected to create
509 * a new revision object.
511 * @deprecated since 1.31, use RevisionStore::getQueryInfo() instead.
512 * @param array $options Any combination of the following strings
513 * - 'page': Join with the page table, and select fields to identify the page
514 * - 'user': Join with the user table, and select the user name
515 * - 'text': Join with the text table, and select fields to load page text
516 * @return array With three keys:
517 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
518 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
519 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
521 public static function getQueryInfo( $options = [] ) {
522 return self
::getRevisionStore()->getQueryInfo( $options );
526 * Return the tables, fields, and join conditions to be selected to create
527 * a new archived revision object.
529 * @deprecated since 1.31, use RevisionStore::getArchiveQueryInfo() instead.
530 * @return array With three keys:
531 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
532 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
533 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
535 public static function getArchiveQueryInfo() {
536 return self
::getRevisionStore()->getArchiveQueryInfo();
540 * Do a batched query to get the parent revision lengths
542 * @deprecated in 1.31, use RevisionStore::getRevisionSizes instead.
544 * @param IDatabase $db
545 * @param array $revIds
548 public static function getParentLengths( $db, array $revIds ) {
549 return self
::getRevisionStore()->listRevisionSizes( $db, $revIds );
553 * @param object|array|RevisionRecord $row Either a database row or an array
554 * @param int $queryFlags
555 * @param Title|null $title
559 function __construct( $row, $queryFlags = 0, Title
$title = null ) {
562 if ( $row instanceof RevisionRecord
) {
563 $this->mRecord
= $row;
564 } elseif ( is_array( $row ) ) {
565 // If no user is specified, fall back to using the global user object, to stay
566 // compatible with pre-1.31 behavior.
567 if ( !isset( $row['user'] ) && !isset( $row['user_text'] ) ) {
568 $row['user'] = $wgUser;
571 $this->mRecord
= self
::getRevisionFactory()->newMutableRevisionFromArray(
574 $this->ensureTitle( $row, $queryFlags, $title )
576 } elseif ( is_object( $row ) ) {
577 $this->mRecord
= self
::getRevisionFactory()->newRevisionFromRow(
580 $this->ensureTitle( $row, $queryFlags, $title )
583 throw new InvalidArgumentException(
584 '$row must be a row object, an associative array, or a RevisionRecord'
590 * Make sure we have *some* Title object for use by the constructor.
591 * For B/C, the constructor shouldn't fail even for a bad page ID or bad revision ID.
593 * @param array|object $row
594 * @param int $queryFlags
595 * @param Title|null $title
597 * @return Title $title if not null, or a Title constructed from information in $row.
599 private function ensureTitle( $row, $queryFlags, $title = null ) {
604 if ( is_array( $row ) ) {
605 if ( isset( $row['title'] ) ) {
606 if ( !( $row['title'] instanceof Title
) ) {
607 throw new MWException( 'title field must contain a Title object.' );
610 return $row['title'];
613 $pageId = $row['page'] ??
0;
614 $revId = $row['id'] ??
0;
616 $pageId = $row->rev_page ??
0;
617 $revId = $row->rev_id ??
0;
621 $title = self
::getRevisionStore()->getTitle( $pageId, $revId, $queryFlags );
622 } catch ( RevisionAccessException
$ex ) {
623 // construct a dummy title!
624 wfLogWarning( __METHOD__
. ': ' . $ex->getMessage() );
626 // NOTE: this Title will only be used inside RevisionRecord
627 $title = Title
::makeTitleSafe( NS_SPECIAL
, "Badtitle/ID=$pageId" );
628 $title->resetArticleID( $pageId );
635 * @return RevisionRecord
637 public function getRevisionRecord() {
638 return $this->mRecord
;
646 public function getId() {
647 return $this->mRecord
->getId();
651 * Set the revision ID
653 * This should only be used for proposed revisions that turn out to be null edits.
655 * @note Only supported on Revisions that were constructed based on associative arrays,
656 * since they are mutable.
659 * @param int|string $id
660 * @throws MWException
662 public function setId( $id ) {
663 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
664 $this->mRecord
->setId( intval( $id ) );
666 throw new MWException( __METHOD__
. ' is not supported on this instance' );
671 * Set the user ID/name
673 * This should only be used for proposed revisions that turn out to be null edits
675 * @note Only supported on Revisions that were constructed based on associative arrays,
676 * since they are mutable.
679 * @deprecated since 1.31, please reuse old Revision object
680 * @param int $id User ID
681 * @param string $name User name
682 * @throws MWException
684 public function setUserIdAndName( $id, $name ) {
685 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
686 $user = User
::newFromAnyId( intval( $id ), $name, null );
687 $this->mRecord
->setUser( $user );
689 throw new MWException( __METHOD__
. ' is not supported on this instance' );
696 private function getMainSlotRaw() {
697 return $this->mRecord
->getSlot( SlotRecord
::MAIN
, RevisionRecord
::RAW
);
701 * Get the ID of the row of the text table that contains the content of the
702 * revision's main slot, if that content is stored in the text table.
704 * If the content is stored elsewhere, this returns null.
706 * @deprecated since 1.31, use RevisionRecord()->getSlot()->getContentAddress() to
707 * get that actual address that can be used with BlobStore::getBlob(); or use
708 * RevisionRecord::hasSameContent() to check if two revisions have the same content.
712 public function getTextId() {
713 $slot = $this->getMainSlotRaw();
714 return $slot->hasAddress()
715 ? self
::getBlobStore()->getTextIdFromAddress( $slot->getAddress() )
720 * Get parent revision ID (the original previous page revision)
722 * @return int|null The ID of the parent revision. 0 indicates that there is no
723 * parent revision. Null indicates that the parent revision is not known.
725 public function getParentId() {
726 return $this->mRecord
->getParentId();
730 * Returns the length of the text in this revision, or null if unknown.
734 public function getSize() {
736 return $this->mRecord
->getSize();
737 } catch ( RevisionAccessException
$ex ) {
743 * Returns the base36 sha1 of the content in this revision, or null if unknown.
745 * @return string|null
747 public function getSha1() {
749 return $this->mRecord
->getSha1();
750 } catch ( RevisionAccessException
$ex ) {
756 * Returns the title of the page associated with this entry.
757 * Since 1.31, this will never return null.
759 * Will do a query, when title is not set and id is given.
763 public function getTitle() {
764 $linkTarget = $this->mRecord
->getPageAsLinkTarget();
765 return Title
::newFromLinkTarget( $linkTarget );
769 * Set the title of the revision
771 * @deprecated since 1.31, this is now a noop. Pass the Title to the constructor instead.
773 * @param Title $title
775 public function setTitle( $title ) {
776 if ( !$title->equals( $this->getTitle() ) ) {
777 throw new InvalidArgumentException(
778 $title->getPrefixedText()
779 . ' is not the same as '
780 . $this->mRecord
->getPageAsLinkTarget()->__toString()
790 public function getPage() {
791 return $this->mRecord
->getPageId();
795 * Fetch revision's user id if it's available to the specified audience.
796 * If the specified audience does not have access to it, zero will be
799 * @param int $audience One of:
800 * Revision::FOR_PUBLIC to be displayed to all users
801 * Revision::FOR_THIS_USER to be displayed to the given user
802 * Revision::RAW get the ID regardless of permissions
803 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
804 * to the $audience parameter
807 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
810 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
814 $user = $this->mRecord
->getUser( $audience, $user );
815 return $user ?
$user->getId() : 0;
819 * Fetch revision's username if it's available to the specified audience.
820 * If the specified audience does not have access to the username, an
821 * empty string will be returned.
823 * @param int $audience One of:
824 * Revision::FOR_PUBLIC to be displayed to all users
825 * Revision::FOR_THIS_USER to be displayed to the given user
826 * Revision::RAW get the text regardless of permissions
827 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
828 * to the $audience parameter
831 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
834 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
838 $user = $this->mRecord
->getUser( $audience, $user );
839 return $user ?
$user->getName() : '';
842 * Fetch revision comment if it's available to the specified audience.
843 * If the specified audience does not have access to the comment, an
844 * empty string will be returned.
846 * @param int $audience One of:
847 * Revision::FOR_PUBLIC to be displayed to all users
848 * Revision::FOR_THIS_USER to be displayed to the given user
849 * Revision::RAW get the text regardless of permissions
850 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
851 * to the $audience parameter
854 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
857 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
861 $comment = $this->mRecord
->getComment( $audience, $user );
862 return $comment === null ?
null : $comment->text
;
868 public function isMinor() {
869 return $this->mRecord
->isMinor();
873 * @return int Rcid of the unpatrolled row, zero if there isn't one
875 public function isUnpatrolled() {
876 return self
::getRevisionStore()->getRcIdIfUnpatrolled( $this->mRecord
);
880 * Get the RC object belonging to the current revision, if there's one
882 * @param int $flags (optional) $flags include:
883 * Revision::READ_LATEST : Select the data from the master
886 * @return RecentChange|null
888 public function getRecentChange( $flags = 0 ) {
889 return self
::getRevisionStore()->getRecentChange( $this->mRecord
, $flags );
893 * @param int $field One of DELETED_* bitfield constants
897 public function isDeleted( $field ) {
898 return $this->mRecord
->isDeleted( $field );
902 * Get the deletion bitfield of the revision
906 public function getVisibility() {
907 return $this->mRecord
->getVisibility();
911 * Fetch revision content if it's available to the specified audience.
912 * If the specified audience does not have the ability to view this
913 * revision, or the content could not be loaded, null will be returned.
915 * @param int $audience One of:
916 * Revision::FOR_PUBLIC to be displayed to all users
917 * Revision::FOR_THIS_USER to be displayed to $user
918 * Revision::RAW get the text regardless of permissions
919 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
920 * to the $audience parameter
922 * @return Content|null
924 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
927 if ( $audience === self
::FOR_THIS_USER
&& !$user ) {
932 return $this->mRecord
->getContent( SlotRecord
::MAIN
, $audience, $user );
934 catch ( RevisionAccessException
$e ) {
940 * Get original serialized data (without checking view restrictions)
943 * @deprecated since 1.31, use BlobStore::getBlob instead.
947 public function getSerializedData() {
948 $slot = $this->getMainSlotRaw();
949 return $slot->getContent()->serialize();
953 * Returns the content model for the main slot of this revision.
955 * If no content model was stored in the database, the default content model for the title is
956 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
957 * is used as a last resort.
959 * @todo drop this, with MCR, there no longer is a single model associated with a revision.
961 * @return string The content model id associated with this revision,
962 * see the CONTENT_MODEL_XXX constants.
964 public function getContentModel() {
965 return $this->getMainSlotRaw()->getModel();
969 * Returns the content format for the main slot of this revision.
971 * If no content format was stored in the database, the default format for this
972 * revision's content model is returned.
974 * @todo drop this, the format is irrelevant to the revision!
976 * @return string The content format id associated with this revision,
977 * see the CONTENT_FORMAT_XXX constants.
979 public function getContentFormat() {
980 $format = $this->getMainSlotRaw()->getFormat();
982 if ( $format === null ) {
983 // if no format was stored along with the blob, fall back to default format
984 $format = $this->getContentHandler()->getDefaultFormat();
991 * Returns the content handler appropriate for this revision's content model.
993 * @throws MWException
994 * @return ContentHandler
996 public function getContentHandler() {
997 return ContentHandler
::getForModelID( $this->getContentModel() );
1003 public function getTimestamp() {
1004 return $this->mRecord
->getTimestamp();
1010 public function isCurrent() {
1011 return ( $this->mRecord
instanceof RevisionStoreRecord
) && $this->mRecord
->isCurrent();
1015 * Get previous revision for this title
1017 * @return Revision|null
1019 public function getPrevious() {
1020 $title = $this->getTitle();
1021 $rec = self
::getRevisionLookup()->getPreviousRevision( $this->mRecord
, $title );
1022 return $rec === null ?
null : new Revision( $rec, self
::READ_NORMAL
, $title );
1026 * Get next revision for this title
1028 * @return Revision|null
1030 public function getNext() {
1031 $title = $this->getTitle();
1032 $rec = self
::getRevisionLookup()->getNextRevision( $this->mRecord
, $title );
1033 return $rec === null ?
null : new Revision( $rec, self
::READ_NORMAL
, $title );
1037 * Get revision text associated with an old or archive row
1039 * Both the flags and the text field must be included. Including the old_id
1040 * field will activate cache usage as long as the $wiki parameter is not set.
1042 * @param stdClass $row The text data
1043 * @param string $prefix Table prefix (default 'old_')
1044 * @param string|bool $wiki The name of the wiki to load the revision text from
1045 * (same as the wiki $row was loaded from) or false to indicate the local
1046 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1047 * identifier as understood by the LoadBalancer class.
1048 * @return string|false Text the text requested or false on failure
1050 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1051 $textField = $prefix . 'text';
1052 $flagsField = $prefix . 'flags';
1054 if ( isset( $row->$flagsField ) ) {
1055 $flags = explode( ',', $row->$flagsField );
1060 if ( isset( $row->$textField ) ) {
1061 $text = $row->$textField;
1066 $cacheKey = isset( $row->old_id
)
1067 ? SqlBlobStore
::makeAddressFromTextId( $row->old_id
)
1070 $revisionText = self
::getBlobStore( $wiki )->expandBlob( $text, $flags, $cacheKey );
1072 if ( $revisionText === false ) {
1073 if ( isset( $row->old_id
) ) {
1074 wfLogWarning( __METHOD__
. ": Bad data in text row {$row->old_id}! " );
1076 wfLogWarning( __METHOD__
. ": Bad data in text row! " );
1081 return $revisionText;
1085 * If $wgCompressRevisions is enabled, we will compress data.
1086 * The input string is modified in place.
1087 * Return value is the flags field: contains 'gzip' if the
1088 * data is compressed, and 'utf-8' if we're saving in UTF-8
1091 * @param mixed &$text Reference to a text
1094 public static function compressRevisionText( &$text ) {
1095 return self
::getBlobStore()->compressData( $text );
1099 * Re-converts revision text according to it's flags.
1101 * @param mixed $text Reference to a text
1102 * @param array $flags Compression flags
1103 * @return string|bool Decompressed text, or false on failure
1105 public static function decompressRevisionText( $text, $flags ) {
1106 if ( $text === false ) {
1107 // Text failed to be fetched; nothing to do
1111 return self
::getBlobStore()->decompressData( $text, $flags );
1115 * Insert a new revision into the database, returning the new revision ID
1116 * number on success and dies horribly on failure.
1118 * @param IDatabase $dbw (master connection)
1119 * @throws MWException
1120 * @return int The revision ID
1122 public function insertOn( $dbw ) {
1125 // Note that $this->mRecord->getId() will typically return null here, but not always,
1126 // e.g. not when restoring a revision.
1128 if ( $this->mRecord
->getUser( RevisionRecord
::RAW
) === null ) {
1129 if ( $this->mRecord
instanceof MutableRevisionRecord
) {
1130 $this->mRecord
->setUser( $wgUser );
1132 throw new MWException( 'Cannot insert revision with no associated user.' );
1136 $rec = self
::getRevisionStore()->insertRevisionOn( $this->mRecord
, $dbw );
1138 $this->mRecord
= $rec;
1140 // Avoid PHP 7.1 warning of passing $this by reference
1143 return $rec->getId();
1147 * Get the base 36 SHA-1 value for a string of text
1148 * @param string $text
1151 public static function base36Sha1( $text ) {
1152 return SlotRecord
::base36Sha1( $text );
1156 * Create a new null-revision for insertion into a page's
1157 * history. This will not re-save the text, but simply refer
1158 * to the text from the previous version.
1160 * Such revisions can for instance identify page rename
1161 * operations and other such meta-modifications.
1163 * @param IDatabase $dbw
1164 * @param int $pageId ID number of the page to read from
1165 * @param string $summary Revision's summary
1166 * @param bool $minor Whether the revision should be considered as minor
1167 * @param User|null $user User object to use or null for $wgUser
1168 * @return Revision|null Revision or null on error
1170 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1176 $comment = CommentStoreComment
::newUnsavedComment( $summary, null );
1178 $title = Title
::newFromID( $pageId, Title
::GAID_FOR_UPDATE
);
1179 if ( $title === null ) {
1183 $rec = self
::getRevisionStore()->newNullRevision( $dbw, $title, $comment, $minor, $user );
1185 return $rec ?
new Revision( $rec ) : null;
1189 * Determine if the current user is allowed to view a particular
1190 * field of this revision, if it's marked as deleted.
1192 * @param int $field One of self::DELETED_TEXT,
1193 * self::DELETED_COMMENT,
1194 * self::DELETED_USER
1195 * @param User|null $user User object to check, or null to use $wgUser
1198 public function userCan( $field, User
$user = null ) {
1199 return self
::userCanBitfield( $this->getVisibility(), $field, $user );
1203 * Determine if the current user is allowed to view a particular
1204 * field of this revision, if it's marked as deleted. This is used
1205 * by various classes to avoid duplication.
1207 * @param int $bitfield Current field
1208 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1209 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1210 * self::DELETED_USER = File::DELETED_USER
1211 * @param User|null $user User object to check, or null to use $wgUser
1212 * @param Title|null $title A Title object to check for per-page restrictions on,
1213 * instead of just plain userrights
1216 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1225 return RevisionRecord
::userCanBitfield( $bitfield, $field, $user, $title );
1229 * Get rev_timestamp from rev_id, without loading the rest of the row
1231 * @param Title $title
1234 * @return string|bool False if not found
1236 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1237 return self
::getRevisionStore()->getTimestampFromId( $title, $id, $flags );
1241 * Get count of revisions per page...not very efficient
1243 * @param IDatabase $db
1244 * @param int $id Page id
1247 static function countByPageId( $db, $id ) {
1248 return self
::getRevisionStore()->countRevisionsByPageId( $db, $id );
1252 * Get count of revisions per page...not very efficient
1254 * @param IDatabase $db
1255 * @param Title $title
1258 static function countByTitle( $db, $title ) {
1259 return self
::getRevisionStore()->countRevisionsByTitle( $db, $title );
1263 * Check if no edits were made by other users since
1264 * the time a user started editing the page. Limit to
1265 * 50 revisions for the sake of performance.
1268 * @deprecated since 1.24
1270 * @param IDatabase|int $db The Database to perform the check on. May be given as a
1271 * Database object or a database identifier usable with wfGetDB.
1272 * @param int $pageId The ID of the page in question
1273 * @param int $userId The ID of the user in question
1274 * @param string $since Look at edits since this time
1276 * @return bool True if the given user was the only one to edit since the given timestamp
1278 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1279 if ( is_int( $db ) ) {
1280 $db = wfGetDB( $db );
1283 return self
::getRevisionStore()->userWasLastToEdit( $db, $pageId, $userId, $since );
1287 * Load a revision based on a known page ID and current revision ID from the DB
1289 * This method allows for the use of caching, though accessing anything that normally
1290 * requires permission checks (aside from the text) will trigger a small DB lookup.
1291 * The title will also be loaded if $pageIdOrTitle is an integer ID.
1293 * @param IDatabase $db ignored!
1294 * @param int|Title $pageIdOrTitle Page ID or Title object
1295 * @param int $revId Known current revision of this page. Determined automatically if not given.
1296 * @return Revision|bool Returns false if missing
1299 public static function newKnownCurrent( IDatabase
$db, $pageIdOrTitle, $revId = 0 ) {
1300 $title = $pageIdOrTitle instanceof Title
1302 : Title
::newFromID( $pageIdOrTitle );
1308 $record = self
::getRevisionLookup()->getKnownCurrentRevision( $title, $revId );
1309 return $record ?
new Revision( $record ) : false;