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;
51 protected $mContentModel;
52 protected $mContentFormat;
55 * @var Content|null|bool
60 * @var null|ContentHandler
62 protected $mContentHandler;
67 protected $mQueryFlags = 0;
69 // Revision deletion constants
70 const DELETED_TEXT
= 1;
71 const DELETED_COMMENT
= 2;
72 const DELETED_USER
= 4;
73 const DELETED_RESTRICTED
= 8;
74 const SUPPRESSED_USER
= 12; // convenience
76 // Audience options for accessors
78 const FOR_THIS_USER
= 2;
82 * Load a page revision from a given revision ID number.
83 * Returns null if no such revision can be found.
86 * Revision::READ_LATEST : Select the data from the master
87 * Revision::READ_LOCKING : Select & lock the data from the master
90 * @param $flags Integer (optional)
91 * @return Revision or null
93 public static function newFromId( $id, $flags = 0 ) {
94 return self
::newFromConds( array( 'rev_id' => intval( $id ) ), $flags );
98 * Load either the current, or a specified, revision
99 * that's attached to a given title. If not attached
100 * to that title, will return null.
103 * Revision::READ_LATEST : Select the data from the master
104 * Revision::READ_LOCKING : Select & lock the data from the master
106 * @param $title Title
107 * @param $id Integer (optional)
108 * @param $flags Integer Bitfield (optional)
109 * @return Revision or null
111 public static function newFromTitle( $title, $id = 0, $flags = 0 ) {
113 'page_namespace' => $title->getNamespace(),
114 'page_title' => $title->getDBkey()
117 // Use the specified ID
118 $conds['rev_id'] = $id;
119 return self
::newFromConds( $conds, (int)$flags );
121 // Use a join to get the latest revision
122 $conds[] = 'rev_id=page_latest';
123 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
124 return self
::loadFromConds( $db, $conds, $flags );
129 * Load either the current, or a specified, revision
130 * that's attached to a given page ID.
131 * Returns null if no such revision can be found.
134 * Revision::READ_LATEST : Select the data from the master (since 1.20)
135 * Revision::READ_LOCKING : Select & lock the data from the master
137 * @param $revId Integer
138 * @param $pageId Integer (optional)
139 * @param $flags Integer Bitfield (optional)
140 * @return Revision or null
142 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
143 $conds = array( 'page_id' => $pageId );
145 $conds['rev_id'] = $revId;
147 // Use a join to get the latest revision
148 $conds[] = 'rev_id = page_latest';
150 return self
::newFromConds( $conds, (int)$flags );
154 * Make a fake revision object from an archive table row. This is queried
155 * for permissions or even inserted (as in Special:Undelete)
156 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
159 * @param $overrides array
161 * @throws MWException
164 public static function newFromArchiveRow( $row, $overrides = array() ) {
165 global $wgContentHandlerUseDB;
167 $attribs = $overrides +
array(
168 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
169 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
170 'comment' => $row->ar_comment
,
171 'user' => $row->ar_user
,
172 'user_text' => $row->ar_user_text
,
173 'timestamp' => $row->ar_timestamp
,
174 'minor_edit' => $row->ar_minor_edit
,
175 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
176 'deleted' => $row->ar_deleted
,
177 'len' => $row->ar_len
,
178 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
179 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
180 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
183 if ( !$wgContentHandlerUseDB ) {
184 unset( $attribs['content_model'] );
185 unset( $attribs['content_format'] );
188 if ( !isset( $attribs['title'] )
189 && isset( $row->ar_namespace
)
190 && isset( $row->ar_title
) ) {
192 $attribs['title'] = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
195 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
196 // Pre-1.5 ar_text row
197 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
198 if ( $attribs['text'] === false ) {
199 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
202 return new self( $attribs );
211 public static function newFromRow( $row ) {
212 return new self( $row );
216 * Load a page revision from a given revision ID number.
217 * Returns null if no such revision can be found.
219 * @param $db DatabaseBase
221 * @return Revision or null
223 public static function loadFromId( $db, $id ) {
224 return self
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
228 * Load either the current, or a specified, revision
229 * that's attached to a given page. If not attached
230 * to that page, will return null.
232 * @param $db DatabaseBase
233 * @param $pageid Integer
235 * @return Revision or null
237 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
238 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
240 $conds['rev_id'] = intval( $id );
242 $conds[] = 'rev_id=page_latest';
244 return self
::loadFromConds( $db, $conds );
248 * Load either the current, or a specified, revision
249 * that's attached to a given page. If not attached
250 * to that page, will return null.
252 * @param $db DatabaseBase
253 * @param $title Title
255 * @return Revision or null
257 public static function loadFromTitle( $db, $title, $id = 0 ) {
259 $matchId = intval( $id );
261 $matchId = 'page_latest';
263 return self
::loadFromConds( $db,
266 'page_namespace' => $title->getNamespace(),
267 'page_title' => $title->getDBkey()
273 * Load the revision for the given title with the given timestamp.
274 * WARNING: Timestamps may in some circumstances not be unique,
275 * so this isn't the best key to use.
277 * @param $db DatabaseBase
278 * @param $title Title
279 * @param $timestamp String
280 * @return Revision or null
282 public static function loadFromTimestamp( $db, $title, $timestamp ) {
283 return self
::loadFromConds( $db,
285 'rev_timestamp' => $db->timestamp( $timestamp ),
286 'page_namespace' => $title->getNamespace(),
287 'page_title' => $title->getDBkey()
293 * Given a set of conditions, fetch a revision.
295 * @param $conditions Array
296 * @param $flags integer (optional)
297 * @return Revision or null
299 private static function newFromConds( $conditions, $flags = 0 ) {
300 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
301 $rev = self
::loadFromConds( $db, $conditions, $flags );
302 if ( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
303 if ( !( $flags & self
::READ_LATEST
) ) {
304 $dbw = wfGetDB( DB_MASTER
);
305 $rev = self
::loadFromConds( $dbw, $conditions, $flags );
309 $rev->mQueryFlags
= $flags;
315 * Given a set of conditions, fetch a revision from
316 * the given database connection.
318 * @param $db DatabaseBase
319 * @param $conditions Array
320 * @param $flags integer (optional)
321 * @return Revision or null
323 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
324 $res = self
::fetchFromConds( $db, $conditions, $flags );
326 $row = $res->fetchObject();
328 $ret = new Revision( $row );
337 * Return a wrapper for a series of database rows to
338 * fetch all of a given page's revisions in turn.
339 * Each row can be fed to the constructor to get objects.
341 * @param $title Title
342 * @return ResultWrapper
344 public static function fetchRevision( $title ) {
345 return self
::fetchFromConds(
348 'rev_id=page_latest',
349 'page_namespace' => $title->getNamespace(),
350 'page_title' => $title->getDBkey()
356 * Given a set of conditions, return a ResultWrapper
357 * which will return matching database rows with the
358 * fields necessary to build Revision objects.
360 * @param $db DatabaseBase
361 * @param $conditions Array
362 * @param $flags integer (optional)
363 * @return ResultWrapper
365 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
366 $fields = array_merge(
367 self
::selectFields(),
368 self
::selectPageFields(),
369 self
::selectUserFields()
371 $options = array( 'LIMIT' => 1 );
372 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
373 $options[] = 'FOR UPDATE';
376 array( 'revision', 'page', 'user' ),
381 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
386 * Return the value of a select() JOIN conds array for the user table.
387 * This will get user table rows for logged-in users.
391 public static function userJoinCond() {
392 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
396 * Return the value of a select() page conds array for the page table.
397 * This will assure that the revision(s) are not orphaned from live pages.
401 public static function pageJoinCond() {
402 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
406 * Return the list of revision fields that should be selected to create
410 public static function selectFields() {
411 global $wgContentHandlerUseDB;
428 if ( $wgContentHandlerUseDB ) {
429 $fields[] = 'rev_content_format';
430 $fields[] = 'rev_content_model';
437 * Return the list of text fields that should be selected to read the
441 public static function selectTextFields() {
449 * Return the list of page fields that should be selected from page table
452 public static function selectPageFields() {
464 * Return the list of user fields that should be selected from user table
467 public static function selectUserFields() {
468 return array( 'user_name' );
472 * Do a batched query to get the parent revision lengths
473 * @param $db DatabaseBase
474 * @param $revIds Array
477 public static function getParentLengths( $db, array $revIds ) {
480 return $revLens; // empty
482 wfProfileIn( __METHOD__
);
483 $res = $db->select( 'revision',
484 array( 'rev_id', 'rev_len' ),
485 array( 'rev_id' => $revIds ),
487 foreach ( $res as $row ) {
488 $revLens[$row->rev_id
] = $row->rev_len
;
490 wfProfileOut( __METHOD__
);
497 * @param $row Mixed: either a database row or an array
498 * @throws MWException
501 function __construct( $row ) {
502 if ( is_object( $row ) ) {
503 $this->mId
= intval( $row->rev_id
);
504 $this->mPage
= intval( $row->rev_page
);
505 $this->mTextId
= intval( $row->rev_text_id
);
506 $this->mComment
= $row->rev_comment
;
507 $this->mUser
= intval( $row->rev_user
);
508 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
509 $this->mTimestamp
= $row->rev_timestamp
;
510 $this->mDeleted
= intval( $row->rev_deleted
);
512 if ( !isset( $row->rev_parent_id
) ) {
513 $this->mParentId
= null;
515 $this->mParentId
= intval( $row->rev_parent_id
);
518 if ( !isset( $row->rev_len
) ) {
521 $this->mSize
= intval( $row->rev_len
);
524 if ( !isset( $row->rev_sha1
) ) {
527 $this->mSha1
= $row->rev_sha1
;
530 if ( isset( $row->page_latest
) ) {
531 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
532 $this->mTitle
= Title
::newFromRow( $row );
534 $this->mCurrent
= false;
535 $this->mTitle
= null;
538 if ( !isset( $row->rev_content_model
) ||
is_null( $row->rev_content_model
) ) {
539 $this->mContentModel
= null; # determine on demand if needed
541 $this->mContentModel
= strval( $row->rev_content_model
);
544 if ( !isset( $row->rev_content_format
) ||
is_null( $row->rev_content_format
) ) {
545 $this->mContentFormat
= null; # determine on demand if needed
547 $this->mContentFormat
= strval( $row->rev_content_format
);
550 // Lazy extraction...
552 if ( isset( $row->old_text
) ) {
553 $this->mTextRow
= $row;
555 // 'text' table row entry will be lazy-loaded
556 $this->mTextRow
= null;
559 // Use user_name for users and rev_user_text for IPs...
560 $this->mUserText
= null; // lazy load if left null
561 if ( $this->mUser
== 0 ) {
562 $this->mUserText
= $row->rev_user_text
; // IP user
563 } elseif ( isset( $row->user_name
) ) {
564 $this->mUserText
= $row->user_name
; // logged-in user
566 $this->mOrigUserText
= $row->rev_user_text
;
567 } elseif ( is_array( $row ) ) {
568 // Build a new revision to be saved...
569 global $wgUser; // ugh
571 # if we have a content object, use it to set the model and type
572 if ( !empty( $row['content'] ) ) {
573 // @todo when is that set? test with external store setup! check out insertOn() [dk]
574 if ( !empty( $row['text_id'] ) ) {
575 throw new MWException( "Text already stored in external store (id {$row['text_id']}), " .
576 "can't serialize content object" );
579 $row['content_model'] = $row['content']->getModel();
580 # note: mContentFormat is initializes later accordingly
581 # note: content is serialized later in this method!
582 # also set text to null?
585 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
586 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
587 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
588 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
589 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
590 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
591 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
592 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
593 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
594 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
595 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
597 $this->mContentModel
= isset( $row['content_model'] ) ?
strval( $row['content_model'] ) : null;
598 $this->mContentFormat
= isset( $row['content_format'] ) ?
strval( $row['content_format'] ) : null;
600 // Enforce spacing trimming on supplied text
601 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
602 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
603 $this->mTextRow
= null;
605 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
607 // if we have a Content object, override mText and mContentModel
608 if ( !empty( $row['content'] ) ) {
609 if ( !( $row['content'] instanceof Content
) ) {
610 throw new MWException( '`content` field must contain a Content object.' );
613 $handler = $this->getContentHandler();
614 $this->mContent
= $row['content'];
616 $this->mContentModel
= $this->mContent
->getModel();
617 $this->mContentHandler
= null;
619 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
620 } elseif ( !is_null( $this->mText
) ) {
621 $handler = $this->getContentHandler();
622 $this->mContent
= $handler->unserializeContent( $this->mText
);
625 // If we have a Title object, make sure it is consistent with mPage.
626 if ( $this->mTitle
&& $this->mTitle
->exists() ) {
627 if ( $this->mPage
=== null ) {
628 // if the page ID wasn't known, set it now
629 $this->mPage
= $this->mTitle
->getArticleID();
630 } elseif ( $this->mTitle
->getArticleID() !== $this->mPage
) {
631 // Got different page IDs. This may be legit (e.g. during undeletion),
632 // but it seems worth mentioning it in the log.
633 wfDebug( "Page ID " . $this->mPage
. " mismatches the ID " .
634 $this->mTitle
->getArticleID() . " provided by the Title object." );
638 $this->mCurrent
= false;
640 // If we still have no length, see it we have the text to figure it out
641 if ( !$this->mSize
) {
642 if ( !is_null( $this->mContent
) ) {
643 $this->mSize
= $this->mContent
->getSize();
645 #NOTE: this should never happen if we have either text or content object!
651 if ( $this->mSha1
=== null ) {
652 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
656 $this->getContentModel();
657 $this->getContentFormat();
659 throw new MWException( 'Revision constructor passed invalid row format.' );
661 $this->mUnpatrolled
= null;
667 * @return Integer|null
669 public function getId() {
674 * Set the revision ID
679 public function setId( $id ) {
686 * @return Integer|null
688 public function getTextId() {
689 return $this->mTextId
;
693 * Get parent revision ID (the original previous page revision)
695 * @return Integer|null
697 public function getParentId() {
698 return $this->mParentId
;
702 * Returns the length of the text in this revision, or null if unknown.
704 * @return Integer|null
706 public function getSize() {
711 * Returns the base36 sha1 of the text in this revision, or null if unknown.
713 * @return String|null
715 public function getSha1() {
720 * Returns the title of the page associated with this entry or null.
722 * Will do a query, when title is not set and id is given.
726 public function getTitle() {
727 if ( isset( $this->mTitle
) ) {
728 return $this->mTitle
;
730 if ( !is_null( $this->mId
) ) { //rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
731 $dbr = wfGetDB( DB_SLAVE
);
732 $row = $dbr->selectRow(
733 array( 'page', 'revision' ),
734 self
::selectPageFields(),
735 array( 'page_id=rev_page',
736 'rev_id' => $this->mId
),
739 $this->mTitle
= Title
::newFromRow( $row );
743 if ( !$this->mTitle
&& !is_null( $this->mPage
) && $this->mPage
> 0 ) {
744 $this->mTitle
= Title
::newFromID( $this->mPage
);
747 return $this->mTitle
;
751 * Set the title of the revision
753 * @param $title Title
755 public function setTitle( $title ) {
756 $this->mTitle
= $title;
762 * @return Integer|null
764 public function getPage() {
769 * Fetch revision's user id if it's available to the specified audience.
770 * If the specified audience does not have access to it, zero will be
773 * @param $audience Integer: one of:
774 * Revision::FOR_PUBLIC to be displayed to all users
775 * Revision::FOR_THIS_USER to be displayed to the given user
776 * Revision::RAW get the ID regardless of permissions
777 * @param $user User object to check for, only if FOR_THIS_USER is passed
778 * to the $audience parameter
781 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
782 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
784 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
792 * Fetch revision's user id without regard for the current user's permissions
796 public function getRawUser() {
801 * Fetch revision's username if it's available to the specified audience.
802 * If the specified audience does not have access to the username, an
803 * empty string will be returned.
805 * @param $audience Integer: one of:
806 * Revision::FOR_PUBLIC to be displayed to all users
807 * Revision::FOR_THIS_USER to be displayed to the given user
808 * Revision::RAW get the text regardless of permissions
809 * @param $user User object to check for, only if FOR_THIS_USER is passed
810 * to the $audience parameter
813 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
814 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
816 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
819 return $this->getRawUserText();
824 * Fetch revision's username without regard for view restrictions
828 public function getRawUserText() {
829 if ( $this->mUserText
=== null ) {
830 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
831 if ( $this->mUserText
=== false ) {
832 # This shouldn't happen, but it can if the wiki was recovered
833 # via importing revs and there is no user table entry yet.
834 $this->mUserText
= $this->mOrigUserText
;
837 return $this->mUserText
;
841 * Fetch revision comment if it's available to the specified audience.
842 * If the specified audience does not have access to the comment, an
843 * empty string will be returned.
845 * @param $audience Integer: one of:
846 * Revision::FOR_PUBLIC to be displayed to all users
847 * Revision::FOR_THIS_USER to be displayed to the given user
848 * Revision::RAW get the text regardless of permissions
849 * @param $user User object to check for, only if FOR_THIS_USER is passed
850 * to the $audience parameter
853 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
854 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
856 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
859 return $this->mComment
;
864 * Fetch revision comment without regard for the current user's permissions
868 public function getRawComment() {
869 return $this->mComment
;
875 public function isMinor() {
876 return (bool)$this->mMinorEdit
;
880 * @return integer rcid of the unpatrolled row, zero if there isn't one
882 public function isUnpatrolled() {
883 if ( $this->mUnpatrolled
!== null ) {
884 return $this->mUnpatrolled
;
886 $rc = $this->getRecentChange();
887 if ( $rc && $rc->getAttribute( 'rc_patrolled' ) == 0 ) {
888 $this->mUnpatrolled
= $rc->getAttribute( 'rc_id' );
890 $this->mUnpatrolled
= 0;
892 return $this->mUnpatrolled
;
896 * Get the RC object belonging to the current revision, if there's one
899 * @return RecentChange|null
901 public function getRecentChange() {
902 $dbr = wfGetDB( DB_SLAVE
);
903 return RecentChange
::newFromConds(
905 'rc_user_text' => $this->getRawUserText(),
906 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
907 'rc_this_oldid' => $this->getId()
914 * @param int $field one of DELETED_* bitfield constants
918 public function isDeleted( $field ) {
919 return ( $this->mDeleted
& $field ) == $field;
923 * Get the deletion bitfield of the revision
927 public function getVisibility() {
928 return (int)$this->mDeleted
;
932 * Fetch revision text if it's available to the specified audience.
933 * If the specified audience does not have the ability to view this
934 * revision, an empty string will be returned.
936 * @param $audience Integer: one of:
937 * Revision::FOR_PUBLIC to be displayed to all users
938 * Revision::FOR_THIS_USER to be displayed to the given user
939 * Revision::RAW get the text regardless of permissions
940 * @param $user User object to check for, only if FOR_THIS_USER is passed
941 * to the $audience parameter
943 * @deprecated in 1.21, use getContent() instead
944 * @todo Replace usage in core
947 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
948 ContentHandler
::deprecated( __METHOD__
, '1.21' );
950 $content = $this->getContent( $audience, $user );
951 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
955 * Fetch revision content if it's available to the specified audience.
956 * If the specified audience does not have the ability to view this
957 * revision, null will be returned.
959 * @param $audience Integer: one of:
960 * Revision::FOR_PUBLIC to be displayed to all users
961 * Revision::FOR_THIS_USER to be displayed to $wgUser
962 * Revision::RAW get the text regardless of permissions
963 * @param $user User object to check for, only if FOR_THIS_USER is passed
964 * to the $audience parameter
966 * @return Content|null
968 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
969 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
971 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
974 return $this->getContentInternal();
979 * Alias for getText(Revision::FOR_THIS_USER)
981 * @deprecated since 1.17
984 public function revText() {
985 wfDeprecated( __METHOD__
, '1.17' );
986 return $this->getText( self
::FOR_THIS_USER
);
990 * Fetch revision text without regard for view restrictions
994 * @deprecated since 1.21. Instead, use Revision::getContent( Revision::RAW )
995 * or Revision::getSerializedData() as appropriate.
997 public function getRawText() {
998 ContentHandler
::deprecated( __METHOD__
, "1.21" );
999 return $this->getText( self
::RAW
);
1003 * Fetch original serialized data without regard for view restrictions
1008 public function getSerializedData() {
1009 if ( is_null( $this->mText
) ) {
1010 $this->mText
= $this->loadText();
1013 return $this->mText
;
1017 * Gets the content object for the revision (or null on failure).
1019 * Note that for mutable Content objects, each call to this method will return a
1023 * @return Content|null the Revision's content, or null on failure.
1025 protected function getContentInternal() {
1026 if ( is_null( $this->mContent
) ) {
1027 // Revision is immutable. Load on demand:
1028 if ( is_null( $this->mText
) ) {
1029 $this->mText
= $this->loadText();
1032 if ( $this->mText
!== null && $this->mText
!== false ) {
1033 // Unserialize content
1034 $handler = $this->getContentHandler();
1035 $format = $this->getContentFormat();
1037 $this->mContent
= $handler->unserializeContent( $this->mText
, $format );
1039 $this->mContent
= false; // negative caching!
1043 // NOTE: copy() will return $this for immutable content objects
1044 return $this->mContent ?
$this->mContent
->copy() : null;
1048 * Returns the content model for this revision.
1050 * If no content model was stored in the database, $this->getTitle()->getContentModel() is
1051 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
1052 * is used as a last resort.
1054 * @return String the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
1056 public function getContentModel() {
1057 if ( !$this->mContentModel
) {
1058 $title = $this->getTitle();
1059 $this->mContentModel
= ( $title ?
$title->getContentModel() : CONTENT_MODEL_WIKITEXT
);
1061 assert( !empty( $this->mContentModel
) );
1064 return $this->mContentModel
;
1068 * Returns the content format for this revision.
1070 * If no content format was stored in the database, the default format for this
1071 * revision's content model is returned.
1073 * @return String the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
1075 public function getContentFormat() {
1076 if ( !$this->mContentFormat
) {
1077 $handler = $this->getContentHandler();
1078 $this->mContentFormat
= $handler->getDefaultFormat();
1080 assert( !empty( $this->mContentFormat
) );
1083 return $this->mContentFormat
;
1087 * Returns the content handler appropriate for this revision's content model.
1089 * @throws MWException
1090 * @return ContentHandler
1092 public function getContentHandler() {
1093 if ( !$this->mContentHandler
) {
1094 $model = $this->getContentModel();
1095 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
1097 $format = $this->getContentFormat();
1099 if ( !$this->mContentHandler
->isSupportedFormat( $format ) ) {
1100 throw new MWException( "Oops, the content format $format is not supported for this content model, $model" );
1104 return $this->mContentHandler
;
1110 public function getTimestamp() {
1111 return wfTimestamp( TS_MW
, $this->mTimestamp
);
1117 public function isCurrent() {
1118 return $this->mCurrent
;
1122 * Get previous revision for this title
1124 * @return Revision|null
1126 public function getPrevious() {
1127 if ( $this->getTitle() ) {
1128 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
1130 return self
::newFromTitle( $this->getTitle(), $prev );
1137 * Get next revision for this title
1139 * @return Revision or null
1141 public function getNext() {
1142 if ( $this->getTitle() ) {
1143 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
1145 return self
::newFromTitle( $this->getTitle(), $next );
1152 * Get previous revision Id for this page_id
1153 * This is used to populate rev_parent_id on save
1155 * @param $db DatabaseBase
1158 private function getPreviousRevisionId( $db ) {
1159 if ( is_null( $this->mPage
) ) {
1162 # Use page_latest if ID is not given
1163 if ( !$this->mId
) {
1164 $prevId = $db->selectField( 'page', 'page_latest',
1165 array( 'page_id' => $this->mPage
),
1168 $prevId = $db->selectField( 'revision', 'rev_id',
1169 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
1171 array( 'ORDER BY' => 'rev_id DESC' ) );
1173 return intval( $prevId );
1177 * Get revision text associated with an old or archive row
1178 * $row is usually an object from wfFetchRow(), both the flags and the text
1179 * field must be included
1181 * @param $row Object: the text data
1182 * @param string $prefix table prefix (default 'old_')
1183 * @param string|false $wiki the name of the wiki to load the revision text from
1184 * (same as the the wiki $row was loaded from) or false to indicate the local
1185 * wiki (this is the default). Otherwise, it must be a symbolic wiki database
1186 * identifier as understood by the LoadBalancer class.
1187 * @return String: text the text requested or false on failure
1189 public static function getRevisionText( $row, $prefix = 'old_', $wiki = false ) {
1190 wfProfileIn( __METHOD__
);
1193 $textField = $prefix . 'text';
1194 $flagsField = $prefix . 'flags';
1196 if ( isset( $row->$flagsField ) ) {
1197 $flags = explode( ',', $row->$flagsField );
1202 if ( isset( $row->$textField ) ) {
1203 $text = $row->$textField;
1205 wfProfileOut( __METHOD__
);
1209 # Use external methods for external objects, text in table is URL-only then
1210 if ( in_array( 'external', $flags ) ) {
1212 $parts = explode( '://', $url, 2 );
1213 if ( count( $parts ) == 1 ||
$parts[1] == '' ) {
1214 wfProfileOut( __METHOD__
);
1217 $text = ExternalStore
::fetchFromURL( $url, array( 'wiki' => $wiki ) );
1220 // If the text was fetched without an error, convert it
1221 if ( $text !== false ) {
1222 $text = self
::decompressRevisionText( $text, $flags );
1224 wfProfileOut( __METHOD__
);
1229 * If $wgCompressRevisions is enabled, we will compress data.
1230 * The input string is modified in place.
1231 * Return value is the flags field: contains 'gzip' if the
1232 * data is compressed, and 'utf-8' if we're saving in UTF-8
1235 * @param $text Mixed: reference to a text
1238 public static function compressRevisionText( &$text ) {
1239 global $wgCompressRevisions;
1242 # Revisions not marked this way will be converted
1243 # on load if $wgLegacyCharset is set in the future.
1246 if ( $wgCompressRevisions ) {
1247 if ( function_exists( 'gzdeflate' ) ) {
1248 $text = gzdeflate( $text );
1251 wfDebug( __METHOD__
. " -- no zlib support, not compressing\n" );
1254 return implode( ',', $flags );
1258 * Re-converts revision text according to it's flags.
1260 * @param $text Mixed: reference to a text
1261 * @param $flags array: compression flags
1262 * @return String|bool decompressed text, or false on failure
1264 public static function decompressRevisionText( $text, $flags ) {
1265 if ( in_array( 'gzip', $flags ) ) {
1266 # Deal with optional compression of archived pages.
1267 # This can be done periodically via maintenance/compressOld.php, and
1268 # as pages are saved if $wgCompressRevisions is set.
1269 $text = gzinflate( $text );
1272 if ( in_array( 'object', $flags ) ) {
1273 # Generic compressed storage
1274 $obj = unserialize( $text );
1275 if ( !is_object( $obj ) ) {
1279 $text = $obj->getText();
1282 global $wgLegacyEncoding;
1283 if ( $text !== false && $wgLegacyEncoding
1284 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
1286 # Old revisions kept around in a legacy encoding?
1287 # Upconvert on demand.
1288 # ("utf8" checked for compatibility with some broken
1289 # conversion scripts 2008-12-30)
1291 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1298 * Insert a new revision into the database, returning the new revision ID
1299 * number on success and dies horribly on failure.
1301 * @param $dbw DatabaseBase: (master connection)
1302 * @throws MWException
1305 public function insertOn( $dbw ) {
1306 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1308 wfProfileIn( __METHOD__
);
1310 $this->checkContentModel();
1312 $data = $this->mText
;
1313 $flags = self
::compressRevisionText( $data );
1315 # Write to external storage if required
1316 if ( $wgDefaultExternalStore ) {
1317 // Store and get the URL
1318 $data = ExternalStore
::insertToDefault( $data );
1320 wfProfileOut( __METHOD__
);
1321 throw new MWException( "Unable to store text to external storage" );
1326 $flags .= 'external';
1329 # Record the text (or external storage URL) to the text table
1330 if ( !isset( $this->mTextId
) ) {
1331 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1332 $dbw->insert( 'text',
1334 'old_id' => $old_id,
1335 'old_text' => $data,
1336 'old_flags' => $flags,
1339 $this->mTextId
= $dbw->insertId();
1342 if ( $this->mComment
=== null ) {
1343 $this->mComment
= "";
1346 # Record the edit in revisions
1347 $rev_id = isset( $this->mId
)
1349 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1351 'rev_id' => $rev_id,
1352 'rev_page' => $this->mPage
,
1353 'rev_text_id' => $this->mTextId
,
1354 'rev_comment' => $this->mComment
,
1355 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1356 'rev_user' => $this->mUser
,
1357 'rev_user_text' => $this->mUserText
,
1358 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1359 'rev_deleted' => $this->mDeleted
,
1360 'rev_len' => $this->mSize
,
1361 'rev_parent_id' => is_null( $this->mParentId
)
1362 ?
$this->getPreviousRevisionId( $dbw )
1364 'rev_sha1' => is_null( $this->mSha1
)
1365 ? Revision
::base36Sha1( $this->mText
)
1369 if ( $wgContentHandlerUseDB ) {
1370 //NOTE: Store null for the default model and format, to save space.
1371 //XXX: Makes the DB sensitive to changed defaults. Make this behavior optional? Only in miser mode?
1373 $model = $this->getContentModel();
1374 $format = $this->getContentFormat();
1376 $title = $this->getTitle();
1378 if ( $title === null ) {
1379 wfProfileOut( __METHOD__
);
1380 throw new MWException( "Insufficient information to determine the title of the revision's page!" );
1383 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1384 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1386 $row['rev_content_model'] = ( $model === $defaultModel ) ?
null : $model;
1387 $row['rev_content_format'] = ( $format === $defaultFormat ) ?
null : $format;
1390 $dbw->insert( 'revision', $row, __METHOD__
);
1392 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1394 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1396 wfProfileOut( __METHOD__
);
1400 protected function checkContentModel() {
1401 global $wgContentHandlerUseDB;
1403 $title = $this->getTitle(); //note: may return null for revisions that have not yet been inserted.
1405 $model = $this->getContentModel();
1406 $format = $this->getContentFormat();
1407 $handler = $this->getContentHandler();
1409 if ( !$handler->isSupportedFormat( $format ) ) {
1410 $t = $title->getPrefixedDBkey();
1412 throw new MWException( "Can't use format $format with content model $model on $t" );
1415 if ( !$wgContentHandlerUseDB && $title ) {
1416 // if $wgContentHandlerUseDB is not set, all revisions must use the default content model and format.
1418 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1419 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1420 $defaultFormat = $defaultHandler->getDefaultFormat();
1422 if ( $this->getContentModel() != $defaultModel ) {
1423 $t = $title->getPrefixedDBkey();
1425 throw new MWException( "Can't save non-default content model with \$wgContentHandlerUseDB disabled: "
1426 . "model is $model , default for $t is $defaultModel" );
1429 if ( $this->getContentFormat() != $defaultFormat ) {
1430 $t = $title->getPrefixedDBkey();
1432 throw new MWException( "Can't use non-default content format with \$wgContentHandlerUseDB disabled: "
1433 . "format is $format, default for $t is $defaultFormat" );
1437 $content = $this->getContent( Revision
::RAW
);
1439 if ( !$content ||
!$content->isValid() ) {
1440 $t = $title->getPrefixedDBkey();
1442 throw new MWException( "Content of $t is not valid! Content model is $model" );
1447 * Get the base 36 SHA-1 value for a string of text
1448 * @param $text String
1451 public static function base36Sha1( $text ) {
1452 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1456 * Lazy-load the revision's text.
1457 * Currently hardcoded to the 'text' table storage engine.
1459 * @return String|bool the revision's text, or false on failure
1461 protected function loadText() {
1462 wfProfileIn( __METHOD__
);
1464 // Caching may be beneficial for massive use of external storage
1465 global $wgRevisionCacheExpiry, $wgMemc;
1466 $textId = $this->getTextId();
1467 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1468 if ( $wgRevisionCacheExpiry ) {
1469 $text = $wgMemc->get( $key );
1470 if ( is_string( $text ) ) {
1471 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1472 wfProfileOut( __METHOD__
);
1477 // If we kept data for lazy extraction, use it now...
1478 if ( isset( $this->mTextRow
) ) {
1479 $row = $this->mTextRow
;
1480 $this->mTextRow
= null;
1486 // Text data is immutable; check slaves first.
1487 $dbr = wfGetDB( DB_SLAVE
);
1488 $row = $dbr->selectRow( 'text',
1489 array( 'old_text', 'old_flags' ),
1490 array( 'old_id' => $textId ),
1494 // Fallback to the master in case of slave lag. Also use FOR UPDATE if it was
1495 // used to fetch this revision to avoid missing the row due to REPEATABLE-READ.
1496 $forUpdate = ( $this->mQueryFlags
& self
::READ_LOCKING
== self
::READ_LOCKING
);
1497 if ( !$row && ( $forUpdate ||
wfGetLB()->getServerCount() > 1 ) ) {
1498 $dbw = wfGetDB( DB_MASTER
);
1499 $row = $dbw->selectRow( 'text',
1500 array( 'old_text', 'old_flags' ),
1501 array( 'old_id' => $textId ),
1503 $forUpdate ?
array( 'FOR UPDATE' ) : array() );
1507 wfDebugLog( 'Revision', "No text row with ID '$textId' (revision {$this->getId()})." );
1510 $text = self
::getRevisionText( $row );
1511 if ( $row && $text === false ) {
1512 wfDebugLog( 'Revision', "No blob for text row '$textId' (revision {$this->getId()})." );
1515 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1516 if ( $wgRevisionCacheExpiry && $text !== false ) {
1517 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1520 wfProfileOut( __METHOD__
);
1526 * Create a new null-revision for insertion into a page's
1527 * history. This will not re-save the text, but simply refer
1528 * to the text from the previous version.
1530 * Such revisions can for instance identify page rename
1531 * operations and other such meta-modifications.
1533 * @param $dbw DatabaseBase
1534 * @param $pageId Integer: ID number of the page to read from
1535 * @param string $summary revision's summary
1536 * @param $minor Boolean: whether the revision should be considered as minor
1537 * @return Revision|null on error
1539 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1540 global $wgContentHandlerUseDB;
1542 wfProfileIn( __METHOD__
);
1544 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1545 'rev_text_id', 'rev_len', 'rev_sha1' );
1547 if ( $wgContentHandlerUseDB ) {
1548 $fields[] = 'rev_content_model';
1549 $fields[] = 'rev_content_format';
1552 $current = $dbw->selectRow(
1553 array( 'page', 'revision' ),
1556 'page_id' => $pageId,
1557 'page_latest=rev_id',
1564 'comment' => $summary,
1565 'minor_edit' => $minor,
1566 'text_id' => $current->rev_text_id
,
1567 'parent_id' => $current->page_latest
,
1568 'len' => $current->rev_len
,
1569 'sha1' => $current->rev_sha1
1572 if ( $wgContentHandlerUseDB ) {
1573 $row['content_model'] = $current->rev_content_model
;
1574 $row['content_format'] = $current->rev_content_format
;
1577 $revision = new Revision( $row );
1578 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1583 wfProfileOut( __METHOD__
);
1588 * Determine if the current user is allowed to view a particular
1589 * field of this revision, if it's marked as deleted.
1591 * @param $field Integer:one of self::DELETED_TEXT,
1592 * self::DELETED_COMMENT,
1593 * self::DELETED_USER
1594 * @param $user User object to check, or null to use $wgUser
1597 public function userCan( $field, User
$user = null ) {
1598 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1602 * Determine if the current user is allowed to view a particular
1603 * field of this revision, if it's marked as deleted. This is used
1604 * by various classes to avoid duplication.
1606 * @param $bitfield Integer: current field
1607 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1608 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1609 * self::DELETED_USER = File::DELETED_USER
1610 * @param $user User object to check, or null to use $wgUser
1613 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1614 if ( $bitfield & $field ) { // aspect is deleted
1615 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1616 $permission = 'suppressrevision';
1617 } elseif ( $field & self
::DELETED_TEXT
) {
1618 $permission = 'deletedtext';
1620 $permission = 'deletedhistory';
1622 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1623 if ( $user === null ) {
1627 return $user->isAllowed( $permission );
1634 * Get rev_timestamp from rev_id, without loading the rest of the row
1636 * @param $title Title
1637 * @param $id Integer
1640 static function getTimestampFromId( $title, $id ) {
1641 $dbr = wfGetDB( DB_SLAVE
);
1642 // Casting fix for databases that can't take '' for rev_id
1646 $conds = array( 'rev_id' => $id );
1647 $conds['rev_page'] = $title->getArticleID();
1648 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1649 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1650 # Not in slave, try master
1651 $dbw = wfGetDB( DB_MASTER
);
1652 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1654 return wfTimestamp( TS_MW
, $timestamp );
1658 * Get count of revisions per page...not very efficient
1660 * @param $db DatabaseBase
1661 * @param $id Integer: page id
1664 static function countByPageId( $db, $id ) {
1665 $row = $db->selectRow( 'revision', array( 'revCount' => 'COUNT(*)' ),
1666 array( 'rev_page' => $id ), __METHOD__
);
1668 return $row->revCount
;
1674 * Get count of revisions per page...not very efficient
1676 * @param $db DatabaseBase
1677 * @param $title Title
1680 static function countByTitle( $db, $title ) {
1681 $id = $title->getArticleID();
1683 return self
::countByPageId( $db, $id );
1689 * Check if no edits were made by other users since
1690 * the time a user started editing the page. Limit to
1691 * 50 revisions for the sake of performance.
1695 * @param DatabaseBase|int $db the Database to perform the check on. May be given as a Database object or
1696 * a database identifier usable with wfGetDB.
1697 * @param int $pageId the ID of the page in question
1698 * @param int $userId the ID of the user in question
1699 * @param string $since look at edits since this time
1701 * @return bool True if the given user was the only one to edit since the given timestamp
1703 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1708 if ( is_int( $db ) ) {
1709 $db = wfGetDB( $db );
1712 $res = $db->select( 'revision',
1715 'rev_page' => $pageId,
1716 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1719 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
1720 foreach ( $res as $row ) {
1721 if ( $row->rev_user
!= $userId ) {