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
26 class Revision
implements IDBAccessObject
{
34 protected $mOrigUserText;
36 protected $mMinorEdit;
37 protected $mTimestamp;
56 protected $mContentModel;
57 protected $mContentFormat;
60 * @var Content|null|bool
65 * @var null|ContentHandler
67 protected $mContentHandler;
72 protected $mQueryFlags = 0;
74 // Revision deletion constants
75 const DELETED_TEXT
= 1;
76 const DELETED_COMMENT
= 2;
77 const DELETED_USER
= 4;
78 const DELETED_RESTRICTED
= 8;
79 const SUPPRESSED_USER
= 12; // convenience
81 // Audience options for accessors
83 const FOR_THIS_USER
= 2;
87 * Load a page revision from a given revision ID number.
88 * Returns null if no such revision can be found.
91 * Revision::READ_LATEST : Select the data from the master
92 * Revision::READ_LOCKING : Select & lock the data from the master
95 * @param int $flags (optional)
96 * @return Revision|null
98 public static function newFromId( $id, $flags = 0 ) {
99 return self
::newFromConds( array( 'rev_id' => intval( $id ) ), $flags );
103 * Load either the current, or a specified, revision
104 * that's attached to a given title. If not attached
105 * to that title, will return null.
108 * Revision::READ_LATEST : Select the data from the master
109 * Revision::READ_LOCKING : Select & lock the data from the master
111 * @param Title $title
112 * @param int $id (optional)
113 * @param int $flags Bitfield (optional)
114 * @return Revision|null
116 public static function newFromTitle( $title, $id = 0, $flags = 0 ) {
118 'page_namespace' => $title->getNamespace(),
119 'page_title' => $title->getDBkey()
122 // Use the specified ID
123 $conds['rev_id'] = $id;
124 return self
::newFromConds( $conds, $flags );
126 // Use a join to get the latest revision
127 $conds[] = 'rev_id=page_latest';
128 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
129 return self
::loadFromConds( $db, $conds, $flags );
134 * Load either the current, or a specified, revision
135 * that's attached to a given page ID.
136 * Returns null if no such revision can be found.
139 * Revision::READ_LATEST : Select the data from the master (since 1.20)
140 * Revision::READ_LOCKING : Select & lock the data from the master
143 * @param int $revId (optional)
144 * @param int $flags Bitfield (optional)
145 * @return Revision|null
147 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
148 $conds = array( 'page_id' => $pageId );
150 $conds['rev_id'] = $revId;
151 return self
::newFromConds( $conds, $flags );
153 // Use a join to get the latest revision
154 $conds[] = 'rev_id = page_latest';
155 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
156 return self
::loadFromConds( $db, $conds, $flags );
161 * Make a fake revision object from an archive table row. This is queried
162 * for permissions or even inserted (as in Special:Undelete)
163 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
166 * @param array $overrides
168 * @throws MWException
171 public static function newFromArchiveRow( $row, $overrides = array() ) {
172 global $wgContentHandlerUseDB;
174 $attribs = $overrides +
array(
175 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
176 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
177 'comment' => $row->ar_comment
,
178 'user' => $row->ar_user
,
179 'user_text' => $row->ar_user_text
,
180 'timestamp' => $row->ar_timestamp
,
181 'minor_edit' => $row->ar_minor_edit
,
182 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
183 'deleted' => $row->ar_deleted
,
184 'len' => $row->ar_len
,
185 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
186 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
187 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
190 if ( !$wgContentHandlerUseDB ) {
191 unset( $attribs['content_model'] );
192 unset( $attribs['content_format'] );
195 if ( !isset( $attribs['title'] )
196 && isset( $row->ar_namespace
)
197 && isset( $row->ar_title
) ) {
199 $attribs['title'] = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
202 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
203 // Pre-1.5 ar_text row
204 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
205 if ( $attribs['text'] === false ) {
206 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
209 return new self( $attribs );
218 public static function newFromRow( $row ) {
219 return new self( $row );
223 * Load a page revision from a given revision ID number.
224 * Returns null if no such revision can be found.
226 * @param DatabaseBase $db
228 * @return Revision|null
230 public static function loadFromId( $db, $id ) {
231 return self
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
235 * Load either the current, or a specified, revision
236 * that's attached to a given page. If not attached
237 * to that page, will return null.
239 * @param DatabaseBase $db
242 * @return Revision|null
244 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
245 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
247 $conds['rev_id'] = intval( $id );
249 $conds[] = 'rev_id=page_latest';
251 return self
::loadFromConds( $db, $conds );
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 DatabaseBase $db
260 * @param Title $title
262 * @return Revision|null
264 public static function loadFromTitle( $db, $title, $id = 0 ) {
266 $matchId = intval( $id );
268 $matchId = 'page_latest';
270 return self
::loadFromConds( $db,
273 'page_namespace' => $title->getNamespace(),
274 'page_title' => $title->getDBkey()
280 * Load the revision for the given title with the given timestamp.
281 * WARNING: Timestamps may in some circumstances not be unique,
282 * so this isn't the best key to use.
284 * @param DatabaseBase $db
285 * @param Title $title
286 * @param string $timestamp
287 * @return Revision|null
289 public static function loadFromTimestamp( $db, $title, $timestamp ) {
290 return self
::loadFromConds( $db,
292 'rev_timestamp' => $db->timestamp( $timestamp ),
293 'page_namespace' => $title->getNamespace(),
294 'page_title' => $title->getDBkey()
300 * Given a set of conditions, fetch a revision.
302 * @param array $conditions
303 * @param int $flags (optional)
304 * @return Revision|null
306 private static function newFromConds( $conditions, $flags = 0 ) {
307 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
308 $rev = self
::loadFromConds( $db, $conditions, $flags );
310 $rev->mQueryFlags
= $flags;
316 * Given a set of conditions, fetch a revision from
317 * the given database connection.
319 * @param DatabaseBase $db
320 * @param array $conditions
321 * @param int $flags (optional)
322 * @return Revision|null
324 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
325 $res = self
::fetchFromConds( $db, $conditions, $flags );
327 $row = $res->fetchObject();
329 $ret = new Revision( $row );
338 * Return a wrapper for a series of database rows to
339 * fetch all of a given page's revisions in turn.
340 * Each row can be fed to the constructor to get objects.
342 * @param Title $title
343 * @return ResultWrapper
345 public static function fetchRevision( $title ) {
346 return self
::fetchFromConds(
349 'rev_id=page_latest',
350 'page_namespace' => $title->getNamespace(),
351 'page_title' => $title->getDBkey()
357 * Given a set of conditions, return a ResultWrapper
358 * which will return matching database rows with the
359 * fields necessary to build Revision objects.
361 * @param DatabaseBase $db
362 * @param array $conditions
363 * @param int $flags (optional)
364 * @return ResultWrapper
366 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
367 $fields = array_merge(
368 self
::selectFields(),
369 self
::selectPageFields(),
370 self
::selectUserFields()
372 $options = array( 'LIMIT' => 1 );
373 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
374 $options[] = 'FOR UPDATE';
377 array( 'revision', 'page', 'user' ),
382 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
387 * Return the value of a select() JOIN conds array for the user table.
388 * This will get user table rows for logged-in users.
392 public static function userJoinCond() {
393 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
397 * Return the value of a select() page conds array for the page table.
398 * This will assure that the revision(s) are not orphaned from live pages.
402 public static function pageJoinCond() {
403 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
407 * Return the list of revision fields that should be selected to create
411 public static function selectFields() {
412 global $wgContentHandlerUseDB;
429 if ( $wgContentHandlerUseDB ) {
430 $fields[] = 'rev_content_format';
431 $fields[] = 'rev_content_model';
438 * Return the list of revision fields that should be selected to create
439 * a new revision from an archive row.
442 public static function selectArchiveFields() {
443 global $wgContentHandlerUseDB;
461 if ( $wgContentHandlerUseDB ) {
462 $fields[] = 'ar_content_format';
463 $fields[] = 'ar_content_model';
469 * Return the list of text fields that should be selected to read the
473 public static function selectTextFields() {
481 * Return the list of page fields that should be selected from page table
484 public static function selectPageFields() {
496 * Return the list of user fields that should be selected from user table
499 public static function selectUserFields() {
500 return array( 'user_name' );
504 * Do a batched query to get the parent revision lengths
505 * @param DatabaseBase $db
506 * @param array $revIds
509 public static function getParentLengths( $db, array $revIds ) {
512 return $revLens; // empty
514 $res = $db->select( 'revision',
515 array( 'rev_id', 'rev_len' ),
516 array( 'rev_id' => $revIds ),
518 foreach ( $res as $row ) {
519 $revLens[$row->rev_id
] = $row->rev_len
;
527 * @param object|array $row Either a database row or an array
528 * @throws MWException
531 function __construct( $row ) {
532 if ( is_object( $row ) ) {
533 $this->mId
= intval( $row->rev_id
);
534 $this->mPage
= intval( $row->rev_page
);
535 $this->mTextId
= intval( $row->rev_text_id
);
536 $this->mComment
= $row->rev_comment
;
537 $this->mUser
= intval( $row->rev_user
);
538 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
539 $this->mTimestamp
= $row->rev_timestamp
;
540 $this->mDeleted
= intval( $row->rev_deleted
);
542 if ( !isset( $row->rev_parent_id
) ) {
543 $this->mParentId
= null;
545 $this->mParentId
= intval( $row->rev_parent_id
);
548 if ( !isset( $row->rev_len
) ) {
551 $this->mSize
= intval( $row->rev_len
);
554 if ( !isset( $row->rev_sha1
) ) {
557 $this->mSha1
= $row->rev_sha1
;
560 if ( isset( $row->page_latest
) ) {
561 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
562 $this->mTitle
= Title
::newFromRow( $row );
564 $this->mCurrent
= false;
565 $this->mTitle
= null;
568 if ( !isset( $row->rev_content_model
) ) {
569 $this->mContentModel
= null; # determine on demand if needed
571 $this->mContentModel
= strval( $row->rev_content_model
);
574 if ( !isset( $row->rev_content_format
) ) {
575 $this->mContentFormat
= null; # determine on demand if needed
577 $this->mContentFormat
= strval( $row->rev_content_format
);
580 // Lazy extraction...
582 if ( isset( $row->old_text
) ) {
583 $this->mTextRow
= $row;
585 // 'text' table row entry will be lazy-loaded
586 $this->mTextRow
= null;
589 // Use user_name for users and rev_user_text for IPs...
590 $this->mUserText
= null; // lazy load if left null
591 if ( $this->mUser
== 0 ) {
592 $this->mUserText
= $row->rev_user_text
; // IP user
593 } elseif ( isset( $row->user_name
) ) {
594 $this->mUserText
= $row->user_name
; // logged-in user
596 $this->mOrigUserText
= $row->rev_user_text
;
597 } elseif ( is_array( $row ) ) {
598 // Build a new revision to be saved...
599 global $wgUser; // ugh
601 # if we have a content object, use it to set the model and type
602 if ( !empty( $row['content'] ) ) {
603 // @todo when is that set? test with external store setup! check out insertOn() [dk]
604 if ( !empty( $row['text_id'] ) ) {
605 throw new MWException( "Text already stored in external store (id {$row['text_id']}), " .
606 "can't serialize content object" );
609 $row['content_model'] = $row['content']->getModel();
610 # note: mContentFormat is initializes later accordingly
611 # note: content is serialized later in this method!
612 # also set text to null?
615 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
616 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
617 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
618 $this->mUserText
= isset( $row['user_text'] )
619 ?
strval( $row['user_text'] ) : $wgUser->getName();
620 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
621 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
622 $this->mTimestamp
= isset( $row['timestamp'] )
623 ?
strval( $row['timestamp'] ) : wfTimestampNow();
624 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
625 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
626 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
627 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
629 $this->mContentModel
= isset( $row['content_model'] )
630 ?
strval( $row['content_model'] ) : null;
631 $this->mContentFormat
= isset( $row['content_format'] )
632 ?
strval( $row['content_format'] ) : null;
634 // Enforce spacing trimming on supplied text
635 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
636 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
637 $this->mTextRow
= null;
639 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
641 // if we have a Content object, override mText and mContentModel
642 if ( !empty( $row['content'] ) ) {
643 if ( !( $row['content'] instanceof Content
) ) {
644 throw new MWException( '`content` field must contain a Content object.' );
647 $handler = $this->getContentHandler();
648 $this->mContent
= $row['content'];
650 $this->mContentModel
= $this->mContent
->getModel();
651 $this->mContentHandler
= null;
653 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
654 } elseif ( $this->mText
!== null ) {
655 $handler = $this->getContentHandler();
656 $this->mContent
= $handler->unserializeContent( $this->mText
);
659 // If we have a Title object, make sure it is consistent with mPage.
660 if ( $this->mTitle
&& $this->mTitle
->exists() ) {
661 if ( $this->mPage
=== null ) {
662 // if the page ID wasn't known, set it now
663 $this->mPage
= $this->mTitle
->getArticleID();
664 } elseif ( $this->mTitle
->getArticleID() !== $this->mPage
) {
665 // Got different page IDs. This may be legit (e.g. during undeletion),
666 // but it seems worth mentioning it in the log.
667 wfDebug( "Page ID " . $this->mPage
. " mismatches the ID " .
668 $this->mTitle
->getArticleID() . " provided by the Title object." );
672 $this->mCurrent
= false;
674 // If we still have no length, see it we have the text to figure it out
675 if ( !$this->mSize
&& $this->mContent
!== null ) {
676 $this->mSize
= $this->mContent
->getSize();
680 if ( $this->mSha1
=== null ) {
681 $this->mSha1
= $this->mText
=== null ?
null : self
::base36Sha1( $this->mText
);
685 $this->getContentModel();
686 $this->getContentFormat();
688 throw new MWException( 'Revision constructor passed invalid row format.' );
690 $this->mUnpatrolled
= null;
698 public function getId() {
703 * Set the revision ID
708 public function setId( $id ) {
717 public function getTextId() {
718 return $this->mTextId
;
722 * Get parent revision ID (the original previous page revision)
726 public function getParentId() {
727 return $this->mParentId
;
731 * Returns the length of the text in this revision, or null if unknown.
735 public function getSize() {
740 * Returns the base36 sha1 of the text in this revision, or null if unknown.
742 * @return string|null
744 public function getSha1() {
749 * Returns the title of the page associated with this entry or null.
751 * Will do a query, when title is not set and id is given.
755 public function getTitle() {
756 if ( $this->mTitle
!== null ) {
757 return $this->mTitle
;
759 //rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
760 if ( $this->mId
!== null ) {
761 $dbr = wfGetDB( DB_SLAVE
);
762 $row = $dbr->selectRow(
763 array( 'page', 'revision' ),
764 self
::selectPageFields(),
765 array( 'page_id=rev_page',
766 'rev_id' => $this->mId
),
769 $this->mTitle
= Title
::newFromRow( $row );
773 if ( !$this->mTitle
&& $this->mPage
!== null && $this->mPage
> 0 ) {
774 $this->mTitle
= Title
::newFromID( $this->mPage
);
777 return $this->mTitle
;
781 * Set the title of the revision
783 * @param Title $title
785 public function setTitle( $title ) {
786 $this->mTitle
= $title;
794 public function getPage() {
799 * Fetch revision's user id if it's available to the specified audience.
800 * If the specified audience does not have access to it, zero will be
803 * @param int $audience One of:
804 * Revision::FOR_PUBLIC to be displayed to all users
805 * Revision::FOR_THIS_USER to be displayed to the given user
806 * Revision::RAW get the ID regardless of permissions
807 * @param User $user User object to check for, only if FOR_THIS_USER is passed
808 * to the $audience parameter
811 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
812 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
814 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
822 * Fetch revision's user id without regard for the current user's permissions
825 * @deprecated since 1.25, use getUser( Revision::RAW )
827 public function getRawUser() {
828 wfDeprecated( __METHOD__
, '1.25' );
829 return $this->getUser( self
::RAW
);
833 * Fetch revision's username if it's available to the specified audience.
834 * If the specified audience does not have access to the username, an
835 * empty string will be returned.
837 * @param int $audience One of:
838 * Revision::FOR_PUBLIC to be displayed to all users
839 * Revision::FOR_THIS_USER to be displayed to the given user
840 * Revision::RAW get the text regardless of permissions
841 * @param User $user User object to check for, only if FOR_THIS_USER is passed
842 * to the $audience parameter
845 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
846 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
848 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
851 if ( $this->mUserText
=== null ) {
852 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
853 if ( $this->mUserText
=== false ) {
854 # This shouldn't happen, but it can if the wiki was recovered
855 # via importing revs and there is no user table entry yet.
856 $this->mUserText
= $this->mOrigUserText
;
859 return $this->mUserText
;
864 * Fetch revision's username without regard for view restrictions
867 * @deprecated since 1.25, use getUserText( Revision::RAW )
869 public function getRawUserText() {
870 wfDeprecated( __METHOD__
, '1.25' );
871 return $this->getUserText( self
::RAW
);
875 * Fetch revision comment if it's available to the specified audience.
876 * If the specified audience does not have access to the comment, an
877 * empty string will be returned.
879 * @param int $audience One of:
880 * Revision::FOR_PUBLIC to be displayed to all users
881 * Revision::FOR_THIS_USER to be displayed to the given user
882 * Revision::RAW get the text regardless of permissions
883 * @param User $user User object to check for, only if FOR_THIS_USER is passed
884 * to the $audience parameter
887 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
888 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
890 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
893 return $this->mComment
;
898 * Fetch revision comment without regard for the current user's permissions
901 * @deprecated since 1.25, use getComment( Revision::RAW )
903 public function getRawComment() {
904 wfDeprecated( __METHOD__
, '1.25' );
905 return $this->getComment( self
::RAW
);
911 public function isMinor() {
912 return (bool)$this->mMinorEdit
;
916 * @return int Rcid of the unpatrolled row, zero if there isn't one
918 public function isUnpatrolled() {
919 if ( $this->mUnpatrolled
!== null ) {
920 return $this->mUnpatrolled
;
922 $rc = $this->getRecentChange();
923 if ( $rc && $rc->getAttribute( 'rc_patrolled' ) == 0 ) {
924 $this->mUnpatrolled
= $rc->getAttribute( 'rc_id' );
926 $this->mUnpatrolled
= 0;
928 return $this->mUnpatrolled
;
932 * Get the RC object belonging to the current revision, if there's one
935 * @return RecentChange|null
937 public function getRecentChange() {
938 $dbr = wfGetDB( DB_SLAVE
);
939 return RecentChange
::newFromConds(
941 'rc_user_text' => $this->getUserText( Revision
::RAW
),
942 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
943 'rc_this_oldid' => $this->getId()
950 * @param int $field One of DELETED_* bitfield constants
954 public function isDeleted( $field ) {
955 return ( $this->mDeleted
& $field ) == $field;
959 * Get the deletion bitfield of the revision
963 public function getVisibility() {
964 return (int)$this->mDeleted
;
968 * Fetch revision text if it's available to the specified audience.
969 * If the specified audience does not have the ability to view this
970 * revision, an empty string will be returned.
972 * @param int $audience One of:
973 * Revision::FOR_PUBLIC to be displayed to all users
974 * Revision::FOR_THIS_USER to be displayed to the given user
975 * Revision::RAW get the text regardless of permissions
976 * @param User $user User object to check for, only if FOR_THIS_USER is passed
977 * to the $audience parameter
979 * @deprecated since 1.21, use getContent() instead
980 * @todo Replace usage in core
983 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
984 ContentHandler
::deprecated( __METHOD__
, '1.21' );
986 $content = $this->getContent( $audience, $user );
987 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
991 * Fetch revision content if it's available to the specified audience.
992 * If the specified audience does not have the ability to view this
993 * revision, null will be returned.
995 * @param int $audience One of:
996 * Revision::FOR_PUBLIC to be displayed to all users
997 * Revision::FOR_THIS_USER to be displayed to $wgUser
998 * Revision::RAW get the text regardless of permissions
999 * @param User $user User object to check for, only if FOR_THIS_USER is passed
1000 * to the $audience parameter
1002 * @return Content|null
1004 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1005 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
1007 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
1010 return $this->getContentInternal();
1015 * Fetch revision text without regard for view restrictions
1019 * @deprecated since 1.21. Instead, use Revision::getContent( Revision::RAW )
1020 * or Revision::getSerializedData() as appropriate.
1022 public function getRawText() {
1023 ContentHandler
::deprecated( __METHOD__
, "1.21" );
1024 return $this->getText( self
::RAW
);
1028 * Fetch original serialized data without regard for view restrictions
1033 public function getSerializedData() {
1034 if ( $this->mText
=== null ) {
1035 $this->mText
= $this->loadText();
1038 return $this->mText
;
1042 * Gets the content object for the revision (or null on failure).
1044 * Note that for mutable Content objects, each call to this method will return a
1048 * @return Content|null The Revision's content, or null on failure.
1050 protected function getContentInternal() {
1051 if ( $this->mContent
=== null ) {
1052 // Revision is immutable. Load on demand:
1053 if ( $this->mText
=== null ) {
1054 $this->mText
= $this->loadText();
1057 if ( $this->mText
!== null && $this->mText
!== false ) {
1058 // Unserialize content
1059 $handler = $this->getContentHandler();
1060 $format = $this->getContentFormat();
1062 $this->mContent
= $handler->unserializeContent( $this->mText
, $format );
1066 // NOTE: copy() will return $this for immutable content objects
1067 return $this->mContent ?
$this->mContent
->copy() : null;
1071 * Returns the content model for this revision.
1073 * If no content model was stored in the database, $this->getTitle()->getContentModel() is
1074 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
1075 * is used as a last resort.
1077 * @return string The content model id associated with this revision,
1078 * see the CONTENT_MODEL_XXX constants.
1080 public function getContentModel() {
1081 if ( !$this->mContentModel
) {
1082 $title = $this->getTitle();
1083 $this->mContentModel
= ( $title ?
$title->getContentModel() : CONTENT_MODEL_WIKITEXT
);
1085 assert( !empty( $this->mContentModel
) );
1088 return $this->mContentModel
;
1092 * Returns the content format for this revision.
1094 * If no content format was stored in the database, the default format for this
1095 * revision's content model is returned.
1097 * @return string The content format id associated with this revision,
1098 * see the CONTENT_FORMAT_XXX constants.
1100 public function getContentFormat() {
1101 if ( !$this->mContentFormat
) {
1102 $handler = $this->getContentHandler();
1103 $this->mContentFormat
= $handler->getDefaultFormat();
1105 assert( !empty( $this->mContentFormat
) );
1108 return $this->mContentFormat
;
1112 * Returns the content handler appropriate for this revision's content model.
1114 * @throws MWException
1115 * @return ContentHandler
1117 public function getContentHandler() {
1118 if ( !$this->mContentHandler
) {
1119 $model = $this->getContentModel();
1120 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
1122 $format = $this->getContentFormat();
1124 if ( !$this->mContentHandler
->isSupportedFormat( $format ) ) {
1125 throw new MWException( "Oops, the content format $format is not supported for "
1126 . "this content model, $model" );
1130 return $this->mContentHandler
;
1136 public function getTimestamp() {
1137 return wfTimestamp( TS_MW
, $this->mTimestamp
);
1143 public function isCurrent() {
1144 return $this->mCurrent
;
1148 * Get previous revision for this title
1150 * @return Revision|null
1152 public function getPrevious() {
1153 if ( $this->getTitle() ) {
1154 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
1156 return self
::newFromTitle( $this->getTitle(), $prev );
1163 * Get next revision for this title
1165 * @return Revision|null
1167 public function getNext() {
1168 if ( $this->getTitle() ) {
1169 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
1171 return self
::newFromTitle( $this->getTitle(), $next );
1178 * Get previous revision Id for this page_id
1179 * This is used to populate rev_parent_id on save
1181 * @param DatabaseBase $db
1184 private function getPreviousRevisionId( $db ) {
1185 if ( $this->mPage
=== null ) {
1188 # Use page_latest if ID is not given
1189 if ( !$this->mId
) {
1190 $prevId = $db->selectField( 'page', 'page_latest',
1191 array( 'page_id' => $this->mPage
),
1194 $prevId = $db->selectField( 'revision', 'rev_id',
1195 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
1197 array( 'ORDER BY' => 'rev_id DESC' ) );
1199 return intval( $prevId );
1203 * Get revision text associated with an old or archive row
1204 * $row is usually an object from wfFetchRow(), both the flags and the text
1205 * field must be included.
1207 * @param stdClass $row The text data
1208 * @param string $prefix Table prefix (default 'old_')
1209 * @param string|bool $wiki The name of the wiki to load the revision text from
1210 * (same as the the wiki $row was loaded from) or false to indicate the local
1211 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1212 * identifier as understood by the LoadBalancer class.
1213 * @return string Text the text requested or false on failure
1215 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1218 $textField = $prefix . 'text';
1219 $flagsField = $prefix . 'flags';
1221 if ( isset( $row->$flagsField ) ) {
1222 $flags = explode( ',', $row->$flagsField );
1227 if ( isset( $row->$textField ) ) {
1228 $text = $row->$textField;
1233 # Use external methods for external objects, text in table is URL-only then
1234 if ( in_array( 'external', $flags ) ) {
1236 $parts = explode( '://', $url, 2 );
1237 if ( count( $parts ) == 1 ||
$parts[1] == '' ) {
1240 $text = ExternalStore
::fetchFromURL( $url, array( 'wiki' => $wiki ) );
1243 // If the text was fetched without an error, convert it
1244 if ( $text !== false ) {
1245 $text = self
::decompressRevisionText( $text, $flags );
1251 * If $wgCompressRevisions is enabled, we will compress data.
1252 * The input string is modified in place.
1253 * Return value is the flags field: contains 'gzip' if the
1254 * data is compressed, and 'utf-8' if we're saving in UTF-8
1257 * @param mixed $text Reference to a text
1260 public static function compressRevisionText( &$text ) {
1261 global $wgCompressRevisions;
1264 # Revisions not marked this way will be converted
1265 # on load if $wgLegacyCharset is set in the future.
1268 if ( $wgCompressRevisions ) {
1269 if ( function_exists( 'gzdeflate' ) ) {
1270 $text = gzdeflate( $text );
1273 wfDebug( __METHOD__
. " -- no zlib support, not compressing\n" );
1276 return implode( ',', $flags );
1280 * Re-converts revision text according to it's flags.
1282 * @param mixed $text Reference to a text
1283 * @param array $flags Compression flags
1284 * @return string|bool Decompressed text, or false on failure
1286 public static function decompressRevisionText( $text, $flags ) {
1287 if ( in_array( 'gzip', $flags ) ) {
1288 # Deal with optional compression of archived pages.
1289 # This can be done periodically via maintenance/compressOld.php, and
1290 # as pages are saved if $wgCompressRevisions is set.
1291 $text = gzinflate( $text );
1294 if ( in_array( 'object', $flags ) ) {
1295 # Generic compressed storage
1296 $obj = unserialize( $text );
1297 if ( !is_object( $obj ) ) {
1301 $text = $obj->getText();
1304 global $wgLegacyEncoding;
1305 if ( $text !== false && $wgLegacyEncoding
1306 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags )
1308 # Old revisions kept around in a legacy encoding?
1309 # Upconvert on demand.
1310 # ("utf8" checked for compatibility with some broken
1311 # conversion scripts 2008-12-30)
1313 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1320 * Insert a new revision into the database, returning the new revision ID
1321 * number on success and dies horribly on failure.
1323 * @param DatabaseBase $dbw (master connection)
1324 * @throws MWException
1327 public function insertOn( $dbw ) {
1328 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1330 $this->checkContentModel();
1332 $data = $this->mText
;
1333 $flags = self
::compressRevisionText( $data );
1335 # Write to external storage if required
1336 if ( $wgDefaultExternalStore ) {
1337 // Store and get the URL
1338 $data = ExternalStore
::insertToDefault( $data );
1340 throw new MWException( "Unable to store text to external storage" );
1345 $flags .= 'external';
1348 # Record the text (or external storage URL) to the text table
1349 if ( $this->mTextId
=== null ) {
1350 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1351 $dbw->insert( 'text',
1353 'old_id' => $old_id,
1354 'old_text' => $data,
1355 'old_flags' => $flags,
1358 $this->mTextId
= $dbw->insertId();
1361 if ( $this->mComment
=== null ) {
1362 $this->mComment
= "";
1365 # Record the edit in revisions
1366 $rev_id = $this->mId
!== null
1368 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1370 'rev_id' => $rev_id,
1371 'rev_page' => $this->mPage
,
1372 'rev_text_id' => $this->mTextId
,
1373 'rev_comment' => $this->mComment
,
1374 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1375 'rev_user' => $this->mUser
,
1376 'rev_user_text' => $this->mUserText
,
1377 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1378 'rev_deleted' => $this->mDeleted
,
1379 'rev_len' => $this->mSize
,
1380 'rev_parent_id' => $this->mParentId
=== null
1381 ?
$this->getPreviousRevisionId( $dbw )
1383 'rev_sha1' => $this->mSha1
=== null
1384 ? Revision
::base36Sha1( $this->mText
)
1388 if ( $wgContentHandlerUseDB ) {
1389 //NOTE: Store null for the default model and format, to save space.
1390 //XXX: Makes the DB sensitive to changed defaults.
1391 // Make this behavior optional? Only in miser mode?
1393 $model = $this->getContentModel();
1394 $format = $this->getContentFormat();
1396 $title = $this->getTitle();
1398 if ( $title === null ) {
1399 throw new MWException( "Insufficient information to determine the title of the "
1400 . "revision's page!" );
1403 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1404 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1406 $row['rev_content_model'] = ( $model === $defaultModel ) ?
null : $model;
1407 $row['rev_content_format'] = ( $format === $defaultFormat ) ?
null : $format;
1410 $dbw->insert( 'revision', $row, __METHOD__
);
1412 $this->mId
= $rev_id !== null ?
$rev_id : $dbw->insertId();
1414 Hooks
::run( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1419 protected function checkContentModel() {
1420 global $wgContentHandlerUseDB;
1422 $title = $this->getTitle(); //note: may return null for revisions that have not yet been inserted.
1424 $model = $this->getContentModel();
1425 $format = $this->getContentFormat();
1426 $handler = $this->getContentHandler();
1428 if ( !$handler->isSupportedFormat( $format ) ) {
1429 $t = $title->getPrefixedDBkey();
1431 throw new MWException( "Can't use format $format with content model $model on $t" );
1434 if ( !$wgContentHandlerUseDB && $title ) {
1435 // if $wgContentHandlerUseDB is not set,
1436 // all revisions must use the default content model and format.
1438 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1439 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1440 $defaultFormat = $defaultHandler->getDefaultFormat();
1442 if ( $this->getContentModel() != $defaultModel ) {
1443 $t = $title->getPrefixedDBkey();
1445 throw new MWException( "Can't save non-default content model with "
1446 . "\$wgContentHandlerUseDB disabled: model is $model, "
1447 . "default for $t is $defaultModel" );
1450 if ( $this->getContentFormat() != $defaultFormat ) {
1451 $t = $title->getPrefixedDBkey();
1453 throw new MWException( "Can't use non-default content format with "
1454 . "\$wgContentHandlerUseDB disabled: format is $format, "
1455 . "default for $t is $defaultFormat" );
1459 $content = $this->getContent( Revision
::RAW
);
1461 if ( !$content ||
!$content->isValid() ) {
1462 $t = $title->getPrefixedDBkey();
1464 throw new MWException( "Content of $t is not valid! Content model is $model" );
1469 * Get the base 36 SHA-1 value for a string of text
1470 * @param string $text
1473 public static function base36Sha1( $text ) {
1474 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1478 * Lazy-load the revision's text.
1479 * Currently hardcoded to the 'text' table storage engine.
1481 * @return string|bool The revision's text, or false on failure
1483 protected function loadText() {
1485 // Caching may be beneficial for massive use of external storage
1486 global $wgRevisionCacheExpiry, $wgMemc;
1487 $textId = $this->getTextId();
1488 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1489 if ( $wgRevisionCacheExpiry ) {
1490 $text = $wgMemc->get( $key );
1491 if ( is_string( $text ) ) {
1492 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1497 // If we kept data for lazy extraction, use it now...
1498 if ( $this->mTextRow
!== null ) {
1499 $row = $this->mTextRow
;
1500 $this->mTextRow
= null;
1506 // Text data is immutable; check slaves first.
1507 $dbr = wfGetDB( DB_SLAVE
);
1508 $row = $dbr->selectRow( 'text',
1509 array( 'old_text', 'old_flags' ),
1510 array( 'old_id' => $textId ),
1514 // Fallback to the master in case of slave lag. Also use FOR UPDATE if it was
1515 // used to fetch this revision to avoid missing the row due to REPEATABLE-READ.
1516 $forUpdate = ( $this->mQueryFlags
& self
::READ_LOCKING
== self
::READ_LOCKING
);
1517 if ( !$row && ( $forUpdate ||
wfGetLB()->getServerCount() > 1 ) ) {
1518 $dbw = wfGetDB( DB_MASTER
);
1519 $row = $dbw->selectRow( 'text',
1520 array( 'old_text', 'old_flags' ),
1521 array( 'old_id' => $textId ),
1523 $forUpdate ?
array( 'FOR UPDATE' ) : array() );
1527 wfDebugLog( 'Revision', "No text row with ID '$textId' (revision {$this->getId()})." );
1530 $text = self
::getRevisionText( $row );
1531 if ( $row && $text === false ) {
1532 wfDebugLog( 'Revision', "No blob for text row '$textId' (revision {$this->getId()})." );
1535 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1536 if ( $wgRevisionCacheExpiry && $text !== false ) {
1537 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1544 * Create a new null-revision for insertion into a page's
1545 * history. This will not re-save the text, but simply refer
1546 * to the text from the previous version.
1548 * Such revisions can for instance identify page rename
1549 * operations and other such meta-modifications.
1551 * @param DatabaseBase $dbw
1552 * @param int $pageId ID number of the page to read from
1553 * @param string $summary Revision's summary
1554 * @param bool $minor Whether the revision should be considered as minor
1555 * @param User|null $user User object to use or null for $wgUser
1556 * @return Revision|null Revision or null on error
1558 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1559 global $wgContentHandlerUseDB;
1561 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1562 'rev_text_id', 'rev_len', 'rev_sha1' );
1564 if ( $wgContentHandlerUseDB ) {
1565 $fields[] = 'rev_content_model';
1566 $fields[] = 'rev_content_format';
1569 $current = $dbw->selectRow(
1570 array( 'page', 'revision' ),
1573 'page_id' => $pageId,
1574 'page_latest=rev_id',
1586 'user_text' => $user->getName(),
1587 'user' => $user->getId(),
1588 'comment' => $summary,
1589 'minor_edit' => $minor,
1590 'text_id' => $current->rev_text_id
,
1591 'parent_id' => $current->page_latest
,
1592 'len' => $current->rev_len
,
1593 'sha1' => $current->rev_sha1
1596 if ( $wgContentHandlerUseDB ) {
1597 $row['content_model'] = $current->rev_content_model
;
1598 $row['content_format'] = $current->rev_content_format
;
1601 $revision = new Revision( $row );
1602 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1611 * Determine if the current user is allowed to view a particular
1612 * field of this revision, if it's marked as deleted.
1614 * @param int $field One of self::DELETED_TEXT,
1615 * self::DELETED_COMMENT,
1616 * self::DELETED_USER
1617 * @param User|null $user User object to check, or null to use $wgUser
1620 public function userCan( $field, User
$user = null ) {
1621 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1625 * Determine if the current user is allowed to view a particular
1626 * field of this revision, if it's marked as deleted. This is used
1627 * by various classes to avoid duplication.
1629 * @param int $bitfield Current field
1630 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1631 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1632 * self::DELETED_USER = File::DELETED_USER
1633 * @param User|null $user User object to check, or null to use $wgUser
1634 * @param Title|null $title A Title object to check for per-page restrictions on,
1635 * instead of just plain userrights
1638 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1641 if ( $bitfield & $field ) { // aspect is deleted
1642 if ( $user === null ) {
1646 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1647 $permissions = array( 'suppressrevision', 'viewsuppressed' );
1648 } elseif ( $field & self
::DELETED_TEXT
) {
1649 $permissions = array( 'deletedtext' );
1651 $permissions = array( 'deletedhistory' );
1653 $permissionlist = implode( ', ', $permissions );
1654 if ( $title === null ) {
1655 wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
1656 return call_user_func_array( array( $user, 'isAllowedAny' ), $permissions );
1658 $text = $title->getPrefixedText();
1659 wfDebug( "Checking for $permissionlist on $text due to $field match on $bitfield\n" );
1660 foreach ( $permissions as $perm ) {
1661 if ( $title->userCan( $perm, $user ) ) {
1673 * Get rev_timestamp from rev_id, without loading the rest of the row
1675 * @param Title $title
1677 * @return string|bool False if not found
1679 static function getTimestampFromId( $title, $id, $flags = 0 ) {
1680 $db = ( $flags & self
::READ_LATEST
)
1681 ?
wfGetDB( DB_MASTER
)
1682 : wfGetDB( DB_SLAVE
);
1683 // Casting fix for databases that can't take '' for rev_id
1687 $conds = array( 'rev_id' => $id );
1688 $conds['rev_page'] = $title->getArticleID();
1689 $timestamp = $db->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1691 return ( $timestamp !== false ) ?
wfTimestamp( TS_MW
, $timestamp ) : false;
1695 * Get count of revisions per page...not very efficient
1697 * @param DatabaseBase $db
1698 * @param int $id Page id
1701 static function countByPageId( $db, $id ) {
1702 $row = $db->selectRow( 'revision', array( 'revCount' => 'COUNT(*)' ),
1703 array( 'rev_page' => $id ), __METHOD__
);
1705 return $row->revCount
;
1711 * Get count of revisions per page...not very efficient
1713 * @param DatabaseBase $db
1714 * @param Title $title
1717 static function countByTitle( $db, $title ) {
1718 $id = $title->getArticleID();
1720 return self
::countByPageId( $db, $id );
1726 * Check if no edits were made by other users since
1727 * the time a user started editing the page. Limit to
1728 * 50 revisions for the sake of performance.
1731 * @deprecated since 1.24
1733 * @param DatabaseBase|int $db The Database to perform the check on. May be given as a
1734 * Database object or a database identifier usable with wfGetDB.
1735 * @param int $pageId The ID of the page in question
1736 * @param int $userId The ID of the user in question
1737 * @param string $since Look at edits since this time
1739 * @return bool True if the given user was the only one to edit since the given timestamp
1741 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1746 if ( is_int( $db ) ) {
1747 $db = wfGetDB( $db );
1750 $res = $db->select( 'revision',
1753 'rev_page' => $pageId,
1754 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1757 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
1758 foreach ( $res as $row ) {
1759 if ( $row->rev_user
!= $userId ) {