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, (int)$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;
152 // Use a join to get the latest revision
153 $conds[] = 'rev_id = page_latest';
155 return self
::newFromConds( $conds, (int)$flags );
159 * Make a fake revision object from an archive table row. This is queried
160 * for permissions or even inserted (as in Special:Undelete)
161 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
164 * @param array $overrides
166 * @throws MWException
169 public static function newFromArchiveRow( $row, $overrides = array() ) {
170 global $wgContentHandlerUseDB;
172 $attribs = $overrides +
array(
173 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
174 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
175 'comment' => $row->ar_comment
,
176 'user' => $row->ar_user
,
177 'user_text' => $row->ar_user_text
,
178 'timestamp' => $row->ar_timestamp
,
179 'minor_edit' => $row->ar_minor_edit
,
180 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
181 'deleted' => $row->ar_deleted
,
182 'len' => $row->ar_len
,
183 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
184 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
185 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
188 if ( !$wgContentHandlerUseDB ) {
189 unset( $attribs['content_model'] );
190 unset( $attribs['content_format'] );
193 if ( !isset( $attribs['title'] )
194 && isset( $row->ar_namespace
)
195 && isset( $row->ar_title
) ) {
197 $attribs['title'] = Title
::makeTitle( $row->ar_namespace
, $row->ar_title
);
200 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
201 // Pre-1.5 ar_text row
202 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
203 if ( $attribs['text'] === false ) {
204 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
207 return new self( $attribs );
216 public static function newFromRow( $row ) {
217 return new self( $row );
221 * Load a page revision from a given revision ID number.
222 * Returns null if no such revision can be found.
224 * @param DatabaseBase $db
226 * @return Revision|null
228 public static function loadFromId( $db, $id ) {
229 return self
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
233 * Load either the current, or a specified, revision
234 * that's attached to a given page. If not attached
235 * to that page, will return null.
237 * @param DatabaseBase $db
240 * @return Revision|null
242 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
243 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
245 $conds['rev_id'] = intval( $id );
247 $conds[] = 'rev_id=page_latest';
249 return self
::loadFromConds( $db, $conds );
253 * Load either the current, or a specified, revision
254 * that's attached to a given page. If not attached
255 * to that page, will return null.
257 * @param DatabaseBase $db
258 * @param Title $title
260 * @return Revision|null
262 public static function loadFromTitle( $db, $title, $id = 0 ) {
264 $matchId = intval( $id );
266 $matchId = 'page_latest';
268 return self
::loadFromConds( $db,
271 'page_namespace' => $title->getNamespace(),
272 'page_title' => $title->getDBkey()
278 * Load the revision for the given title with the given timestamp.
279 * WARNING: Timestamps may in some circumstances not be unique,
280 * so this isn't the best key to use.
282 * @param DatabaseBase $db
283 * @param Title $title
284 * @param string $timestamp
285 * @return Revision|null
287 public static function loadFromTimestamp( $db, $title, $timestamp ) {
288 return self
::loadFromConds( $db,
290 'rev_timestamp' => $db->timestamp( $timestamp ),
291 'page_namespace' => $title->getNamespace(),
292 'page_title' => $title->getDBkey()
298 * Given a set of conditions, fetch a revision.
300 * @param array $conditions
301 * @param int $flags (optional)
302 * @return Revision|null
304 private static function newFromConds( $conditions, $flags = 0 ) {
305 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
306 $rev = self
::loadFromConds( $db, $conditions, $flags );
307 if ( $rev === null && wfGetLB()->getServerCount() > 1 ) {
308 if ( !( $flags & self
::READ_LATEST
) ) {
309 $dbw = wfGetDB( DB_MASTER
);
310 $rev = self
::loadFromConds( $dbw, $conditions, $flags );
314 $rev->mQueryFlags
= $flags;
320 * Given a set of conditions, fetch a revision from
321 * the given database connection.
323 * @param DatabaseBase $db
324 * @param array $conditions
325 * @param int $flags (optional)
326 * @return Revision|null
328 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
329 $res = self
::fetchFromConds( $db, $conditions, $flags );
331 $row = $res->fetchObject();
333 $ret = new Revision( $row );
342 * Return a wrapper for a series of database rows to
343 * fetch all of a given page's revisions in turn.
344 * Each row can be fed to the constructor to get objects.
346 * @param Title $title
347 * @return ResultWrapper
349 public static function fetchRevision( $title ) {
350 return self
::fetchFromConds(
353 'rev_id=page_latest',
354 'page_namespace' => $title->getNamespace(),
355 'page_title' => $title->getDBkey()
361 * Given a set of conditions, return a ResultWrapper
362 * which will return matching database rows with the
363 * fields necessary to build Revision objects.
365 * @param DatabaseBase $db
366 * @param array $conditions
367 * @param int $flags (optional)
368 * @return ResultWrapper
370 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
371 $fields = array_merge(
372 self
::selectFields(),
373 self
::selectPageFields(),
374 self
::selectUserFields()
376 $options = array( 'LIMIT' => 1 );
377 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
378 $options[] = 'FOR UPDATE';
381 array( 'revision', 'page', 'user' ),
386 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
391 * Return the value of a select() JOIN conds array for the user table.
392 * This will get user table rows for logged-in users.
396 public static function userJoinCond() {
397 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
401 * Return the value of a select() page conds array for the page table.
402 * This will assure that the revision(s) are not orphaned from live pages.
406 public static function pageJoinCond() {
407 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
411 * Return the list of revision fields that should be selected to create
415 public static function selectFields() {
416 global $wgContentHandlerUseDB;
433 if ( $wgContentHandlerUseDB ) {
434 $fields[] = 'rev_content_format';
435 $fields[] = 'rev_content_model';
442 * Return the list of revision fields that should be selected to create
443 * a new revision from an archive row.
446 public static function selectArchiveFields() {
447 global $wgContentHandlerUseDB;
465 if ( $wgContentHandlerUseDB ) {
466 $fields[] = 'ar_content_format';
467 $fields[] = 'ar_content_model';
473 * Return the list of text fields that should be selected to read the
477 public static function selectTextFields() {
485 * Return the list of page fields that should be selected from page table
488 public static function selectPageFields() {
500 * Return the list of user fields that should be selected from user table
503 public static function selectUserFields() {
504 return array( 'user_name' );
508 * Do a batched query to get the parent revision lengths
509 * @param DatabaseBase $db
510 * @param array $revIds
513 public static function getParentLengths( $db, array $revIds ) {
516 return $revLens; // empty
518 wfProfileIn( __METHOD__
);
519 $res = $db->select( 'revision',
520 array( 'rev_id', 'rev_len' ),
521 array( 'rev_id' => $revIds ),
523 foreach ( $res as $row ) {
524 $revLens[$row->rev_id
] = $row->rev_len
;
526 wfProfileOut( __METHOD__
);
533 * @param object|array $row Either a database row or an array
534 * @throws MWException
537 function __construct( $row ) {
538 if ( is_object( $row ) ) {
539 $this->mId
= intval( $row->rev_id
);
540 $this->mPage
= intval( $row->rev_page
);
541 $this->mTextId
= intval( $row->rev_text_id
);
542 $this->mComment
= $row->rev_comment
;
543 $this->mUser
= intval( $row->rev_user
);
544 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
545 $this->mTimestamp
= $row->rev_timestamp
;
546 $this->mDeleted
= intval( $row->rev_deleted
);
548 if ( !isset( $row->rev_parent_id
) ) {
549 $this->mParentId
= null;
551 $this->mParentId
= intval( $row->rev_parent_id
);
554 if ( !isset( $row->rev_len
) ) {
557 $this->mSize
= intval( $row->rev_len
);
560 if ( !isset( $row->rev_sha1
) ) {
563 $this->mSha1
= $row->rev_sha1
;
566 if ( isset( $row->page_latest
) ) {
567 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
568 $this->mTitle
= Title
::newFromRow( $row );
570 $this->mCurrent
= false;
571 $this->mTitle
= null;
574 if ( !isset( $row->rev_content_model
) ) {
575 $this->mContentModel
= null; # determine on demand if needed
577 $this->mContentModel
= strval( $row->rev_content_model
);
580 if ( !isset( $row->rev_content_format
) ) {
581 $this->mContentFormat
= null; # determine on demand if needed
583 $this->mContentFormat
= strval( $row->rev_content_format
);
586 // Lazy extraction...
588 if ( isset( $row->old_text
) ) {
589 $this->mTextRow
= $row;
591 // 'text' table row entry will be lazy-loaded
592 $this->mTextRow
= null;
595 // Use user_name for users and rev_user_text for IPs...
596 $this->mUserText
= null; // lazy load if left null
597 if ( $this->mUser
== 0 ) {
598 $this->mUserText
= $row->rev_user_text
; // IP user
599 } elseif ( isset( $row->user_name
) ) {
600 $this->mUserText
= $row->user_name
; // logged-in user
602 $this->mOrigUserText
= $row->rev_user_text
;
603 } elseif ( is_array( $row ) ) {
604 // Build a new revision to be saved...
605 global $wgUser; // ugh
607 # if we have a content object, use it to set the model and type
608 if ( !empty( $row['content'] ) ) {
609 // @todo when is that set? test with external store setup! check out insertOn() [dk]
610 if ( !empty( $row['text_id'] ) ) {
611 throw new MWException( "Text already stored in external store (id {$row['text_id']}), " .
612 "can't serialize content object" );
615 $row['content_model'] = $row['content']->getModel();
616 # note: mContentFormat is initializes later accordingly
617 # note: content is serialized later in this method!
618 # also set text to null?
621 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
622 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
623 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
624 $this->mUserText
= isset( $row['user_text'] )
625 ?
strval( $row['user_text'] ) : $wgUser->getName();
626 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
627 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
628 $this->mTimestamp
= isset( $row['timestamp'] )
629 ?
strval( $row['timestamp'] ) : wfTimestampNow();
630 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
631 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
632 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
633 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
635 $this->mContentModel
= isset( $row['content_model'] )
636 ?
strval( $row['content_model'] ) : null;
637 $this->mContentFormat
= isset( $row['content_format'] )
638 ?
strval( $row['content_format'] ) : null;
640 // Enforce spacing trimming on supplied text
641 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
642 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
643 $this->mTextRow
= null;
645 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
647 // if we have a Content object, override mText and mContentModel
648 if ( !empty( $row['content'] ) ) {
649 if ( !( $row['content'] instanceof Content
) ) {
650 throw new MWException( '`content` field must contain a Content object.' );
653 $handler = $this->getContentHandler();
654 $this->mContent
= $row['content'];
656 $this->mContentModel
= $this->mContent
->getModel();
657 $this->mContentHandler
= null;
659 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
660 } elseif ( $this->mText
!== null ) {
661 $handler = $this->getContentHandler();
662 $this->mContent
= $handler->unserializeContent( $this->mText
);
665 // If we have a Title object, make sure it is consistent with mPage.
666 if ( $this->mTitle
&& $this->mTitle
->exists() ) {
667 if ( $this->mPage
=== null ) {
668 // if the page ID wasn't known, set it now
669 $this->mPage
= $this->mTitle
->getArticleID();
670 } elseif ( $this->mTitle
->getArticleID() !== $this->mPage
) {
671 // Got different page IDs. This may be legit (e.g. during undeletion),
672 // but it seems worth mentioning it in the log.
673 wfDebug( "Page ID " . $this->mPage
. " mismatches the ID " .
674 $this->mTitle
->getArticleID() . " provided by the Title object." );
678 $this->mCurrent
= false;
680 // If we still have no length, see it we have the text to figure it out
681 if ( !$this->mSize
&& $this->mContent
!== null ) {
682 $this->mSize
= $this->mContent
->getSize();
686 if ( $this->mSha1
=== null ) {
687 $this->mSha1
= $this->mText
=== null ?
null : self
::base36Sha1( $this->mText
);
691 $this->getContentModel();
692 $this->getContentFormat();
694 throw new MWException( 'Revision constructor passed invalid row format.' );
696 $this->mUnpatrolled
= null;
704 public function getId() {
709 * Set the revision ID
714 public function setId( $id ) {
723 public function getTextId() {
724 return $this->mTextId
;
728 * Get parent revision ID (the original previous page revision)
732 public function getParentId() {
733 return $this->mParentId
;
737 * Returns the length of the text in this revision, or null if unknown.
741 public function getSize() {
746 * Returns the base36 sha1 of the text in this revision, or null if unknown.
748 * @return string|null
750 public function getSha1() {
755 * Returns the title of the page associated with this entry or null.
757 * Will do a query, when title is not set and id is given.
761 public function getTitle() {
762 if ( $this->mTitle
!== null ) {
763 return $this->mTitle
;
765 //rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
766 if ( $this->mId
!== null ) {
767 $dbr = wfGetDB( DB_SLAVE
);
768 $row = $dbr->selectRow(
769 array( 'page', 'revision' ),
770 self
::selectPageFields(),
771 array( 'page_id=rev_page',
772 'rev_id' => $this->mId
),
775 $this->mTitle
= Title
::newFromRow( $row );
779 if ( !$this->mTitle
&& $this->mPage
!== null && $this->mPage
> 0 ) {
780 $this->mTitle
= Title
::newFromID( $this->mPage
);
783 return $this->mTitle
;
787 * Set the title of the revision
789 * @param Title $title
791 public function setTitle( $title ) {
792 $this->mTitle
= $title;
800 public function getPage() {
805 * Fetch revision's user id if it's available to the specified audience.
806 * If the specified audience does not have access to it, zero will be
809 * @param int $audience One of:
810 * Revision::FOR_PUBLIC to be displayed to all users
811 * Revision::FOR_THIS_USER to be displayed to the given user
812 * Revision::RAW get the ID regardless of permissions
813 * @param User $user User object to check for, only if FOR_THIS_USER is passed
814 * to the $audience parameter
817 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
818 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
820 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
828 * Fetch revision's user id without regard for the current user's permissions
832 public function getRawUser() {
837 * Fetch revision's username if it's available to the specified audience.
838 * If the specified audience does not have access to the username, an
839 * empty string will be returned.
841 * @param int $audience One of:
842 * Revision::FOR_PUBLIC to be displayed to all users
843 * Revision::FOR_THIS_USER to be displayed to the given user
844 * Revision::RAW get the text regardless of permissions
845 * @param User $user User object to check for, only if FOR_THIS_USER is passed
846 * to the $audience parameter
849 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
850 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
852 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
855 return $this->getRawUserText();
860 * Fetch revision's username without regard for view restrictions
864 public function getRawUserText() {
865 if ( $this->mUserText
=== null ) {
866 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
867 if ( $this->mUserText
=== false ) {
868 # This shouldn't happen, but it can if the wiki was recovered
869 # via importing revs and there is no user table entry yet.
870 $this->mUserText
= $this->mOrigUserText
;
873 return $this->mUserText
;
877 * Fetch revision comment if it's available to the specified audience.
878 * If the specified audience does not have access to the comment, an
879 * empty string will be returned.
881 * @param int $audience One of:
882 * Revision::FOR_PUBLIC to be displayed to all users
883 * Revision::FOR_THIS_USER to be displayed to the given user
884 * Revision::RAW get the text regardless of permissions
885 * @param User $user User object to check for, only if FOR_THIS_USER is passed
886 * to the $audience parameter
889 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
890 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
892 } elseif ( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
895 return $this->mComment
;
900 * Fetch revision comment without regard for the current user's permissions
904 public function getRawComment() {
905 return $this->mComment
;
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->getRawUserText(),
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 ) {
1216 wfProfileIn( __METHOD__
);
1219 $textField = $prefix . 'text';
1220 $flagsField = $prefix . 'flags';
1222 if ( isset( $row->$flagsField ) ) {
1223 $flags = explode( ',', $row->$flagsField );
1228 if ( isset( $row->$textField ) ) {
1229 $text = $row->$textField;
1231 wfProfileOut( __METHOD__
);
1235 # Use external methods for external objects, text in table is URL-only then
1236 if ( in_array( 'external', $flags ) ) {
1238 $parts = explode( '://', $url, 2 );
1239 if ( count( $parts ) == 1 ||
$parts[1] == '' ) {
1240 wfProfileOut( __METHOD__
);
1243 $text = ExternalStore
::fetchFromURL( $url, array( 'wiki' => $wiki ) );
1246 // If the text was fetched without an error, convert it
1247 if ( $text !== false ) {
1248 $text = self
::decompressRevisionText( $text, $flags );
1250 wfProfileOut( __METHOD__
);
1255 * If $wgCompressRevisions is enabled, we will compress data.
1256 * The input string is modified in place.
1257 * Return value is the flags field: contains 'gzip' if the
1258 * data is compressed, and 'utf-8' if we're saving in UTF-8
1261 * @param mixed $text Reference to a text
1264 public static function compressRevisionText( &$text ) {
1265 global $wgCompressRevisions;
1268 # Revisions not marked this way will be converted
1269 # on load if $wgLegacyCharset is set in the future.
1272 if ( $wgCompressRevisions ) {
1273 if ( function_exists( 'gzdeflate' ) ) {
1274 $text = gzdeflate( $text );
1277 wfDebug( __METHOD__
. " -- no zlib support, not compressing\n" );
1280 return implode( ',', $flags );
1284 * Re-converts revision text according to it's flags.
1286 * @param mixed $text Reference to a text
1287 * @param array $flags Compression flags
1288 * @return string|bool Decompressed text, or false on failure
1290 public static function decompressRevisionText( $text, $flags ) {
1291 if ( in_array( 'gzip', $flags ) ) {
1292 # Deal with optional compression of archived pages.
1293 # This can be done periodically via maintenance/compressOld.php, and
1294 # as pages are saved if $wgCompressRevisions is set.
1295 $text = gzinflate( $text );
1298 if ( in_array( 'object', $flags ) ) {
1299 # Generic compressed storage
1300 $obj = unserialize( $text );
1301 if ( !is_object( $obj ) ) {
1305 $text = $obj->getText();
1308 global $wgLegacyEncoding;
1309 if ( $text !== false && $wgLegacyEncoding
1310 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags )
1312 # Old revisions kept around in a legacy encoding?
1313 # Upconvert on demand.
1314 # ("utf8" checked for compatibility with some broken
1315 # conversion scripts 2008-12-30)
1317 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1324 * Insert a new revision into the database, returning the new revision ID
1325 * number on success and dies horribly on failure.
1327 * @param DatabaseBase $dbw (master connection)
1328 * @throws MWException
1331 public function insertOn( $dbw ) {
1332 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1334 wfProfileIn( __METHOD__
);
1336 $this->checkContentModel();
1338 $data = $this->mText
;
1339 $flags = self
::compressRevisionText( $data );
1341 # Write to external storage if required
1342 if ( $wgDefaultExternalStore ) {
1343 // Store and get the URL
1344 $data = ExternalStore
::insertToDefault( $data );
1346 wfProfileOut( __METHOD__
);
1347 throw new MWException( "Unable to store text to external storage" );
1352 $flags .= 'external';
1355 # Record the text (or external storage URL) to the text table
1356 if ( $this->mTextId
=== null ) {
1357 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1358 $dbw->insert( 'text',
1360 'old_id' => $old_id,
1361 'old_text' => $data,
1362 'old_flags' => $flags,
1365 $this->mTextId
= $dbw->insertId();
1368 if ( $this->mComment
=== null ) {
1369 $this->mComment
= "";
1372 # Record the edit in revisions
1373 $rev_id = $this->mId
!== null
1375 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1377 'rev_id' => $rev_id,
1378 'rev_page' => $this->mPage
,
1379 'rev_text_id' => $this->mTextId
,
1380 'rev_comment' => $this->mComment
,
1381 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1382 'rev_user' => $this->mUser
,
1383 'rev_user_text' => $this->mUserText
,
1384 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1385 'rev_deleted' => $this->mDeleted
,
1386 'rev_len' => $this->mSize
,
1387 'rev_parent_id' => $this->mParentId
=== null
1388 ?
$this->getPreviousRevisionId( $dbw )
1390 'rev_sha1' => $this->mSha1
=== null
1391 ? Revision
::base36Sha1( $this->mText
)
1395 if ( $wgContentHandlerUseDB ) {
1396 //NOTE: Store null for the default model and format, to save space.
1397 //XXX: Makes the DB sensitive to changed defaults.
1398 // Make this behavior optional? Only in miser mode?
1400 $model = $this->getContentModel();
1401 $format = $this->getContentFormat();
1403 $title = $this->getTitle();
1405 if ( $title === null ) {
1406 wfProfileOut( __METHOD__
);
1407 throw new MWException( "Insufficient information to determine the title of the "
1408 . "revision's page!" );
1411 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1412 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1414 $row['rev_content_model'] = ( $model === $defaultModel ) ?
null : $model;
1415 $row['rev_content_format'] = ( $format === $defaultFormat ) ?
null : $format;
1418 $dbw->insert( 'revision', $row, __METHOD__
);
1420 $this->mId
= $rev_id !== null ?
$rev_id : $dbw->insertId();
1422 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1424 wfProfileOut( __METHOD__
);
1428 protected function checkContentModel() {
1429 global $wgContentHandlerUseDB;
1431 $title = $this->getTitle(); //note: may return null for revisions that have not yet been inserted.
1433 $model = $this->getContentModel();
1434 $format = $this->getContentFormat();
1435 $handler = $this->getContentHandler();
1437 if ( !$handler->isSupportedFormat( $format ) ) {
1438 $t = $title->getPrefixedDBkey();
1440 throw new MWException( "Can't use format $format with content model $model on $t" );
1443 if ( !$wgContentHandlerUseDB && $title ) {
1444 // if $wgContentHandlerUseDB is not set,
1445 // all revisions must use the default content model and format.
1447 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1448 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1449 $defaultFormat = $defaultHandler->getDefaultFormat();
1451 if ( $this->getContentModel() != $defaultModel ) {
1452 $t = $title->getPrefixedDBkey();
1454 throw new MWException( "Can't save non-default content model with "
1455 . "\$wgContentHandlerUseDB disabled: model is $model, "
1456 . "default for $t is $defaultModel" );
1459 if ( $this->getContentFormat() != $defaultFormat ) {
1460 $t = $title->getPrefixedDBkey();
1462 throw new MWException( "Can't use non-default content format with "
1463 . "\$wgContentHandlerUseDB disabled: format is $format, "
1464 . "default for $t is $defaultFormat" );
1468 $content = $this->getContent( Revision
::RAW
);
1470 if ( !$content ||
!$content->isValid() ) {
1471 $t = $title->getPrefixedDBkey();
1473 throw new MWException( "Content of $t is not valid! Content model is $model" );
1478 * Get the base 36 SHA-1 value for a string of text
1479 * @param string $text
1482 public static function base36Sha1( $text ) {
1483 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1487 * Lazy-load the revision's text.
1488 * Currently hardcoded to the 'text' table storage engine.
1490 * @return string|bool The revision's text, or false on failure
1492 protected function loadText() {
1493 wfProfileIn( __METHOD__
);
1495 // Caching may be beneficial for massive use of external storage
1496 global $wgRevisionCacheExpiry, $wgMemc;
1497 $textId = $this->getTextId();
1498 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1499 if ( $wgRevisionCacheExpiry ) {
1500 $text = $wgMemc->get( $key );
1501 if ( is_string( $text ) ) {
1502 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1503 wfProfileOut( __METHOD__
);
1508 // If we kept data for lazy extraction, use it now...
1509 if ( $this->mTextRow
!== null ) {
1510 $row = $this->mTextRow
;
1511 $this->mTextRow
= null;
1517 // Text data is immutable; check slaves first.
1518 $dbr = wfGetDB( DB_SLAVE
);
1519 $row = $dbr->selectRow( 'text',
1520 array( 'old_text', 'old_flags' ),
1521 array( 'old_id' => $textId ),
1525 // Fallback to the master in case of slave lag. Also use FOR UPDATE if it was
1526 // used to fetch this revision to avoid missing the row due to REPEATABLE-READ.
1527 $forUpdate = ( $this->mQueryFlags
& self
::READ_LOCKING
== self
::READ_LOCKING
);
1528 if ( !$row && ( $forUpdate ||
wfGetLB()->getServerCount() > 1 ) ) {
1529 $dbw = wfGetDB( DB_MASTER
);
1530 $row = $dbw->selectRow( 'text',
1531 array( 'old_text', 'old_flags' ),
1532 array( 'old_id' => $textId ),
1534 $forUpdate ?
array( 'FOR UPDATE' ) : array() );
1538 wfDebugLog( 'Revision', "No text row with ID '$textId' (revision {$this->getId()})." );
1541 $text = self
::getRevisionText( $row );
1542 if ( $row && $text === false ) {
1543 wfDebugLog( 'Revision', "No blob for text row '$textId' (revision {$this->getId()})." );
1546 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1547 if ( $wgRevisionCacheExpiry && $text !== false ) {
1548 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1551 wfProfileOut( __METHOD__
);
1557 * Create a new null-revision for insertion into a page's
1558 * history. This will not re-save the text, but simply refer
1559 * to the text from the previous version.
1561 * Such revisions can for instance identify page rename
1562 * operations and other such meta-modifications.
1564 * @param DatabaseBase $dbw
1565 * @param int $pageId ID number of the page to read from
1566 * @param string $summary Revision's summary
1567 * @param bool $minor Whether the revision should be considered as minor
1568 * @param User|null $user User object to use or null for $wgUser
1569 * @return Revision|null Revision or null on error
1571 public static function newNullRevision( $dbw, $pageId, $summary, $minor, $user = null ) {
1572 global $wgContentHandlerUseDB;
1574 wfProfileIn( __METHOD__
);
1576 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1577 'rev_text_id', 'rev_len', 'rev_sha1' );
1579 if ( $wgContentHandlerUseDB ) {
1580 $fields[] = 'rev_content_model';
1581 $fields[] = 'rev_content_format';
1584 $current = $dbw->selectRow(
1585 array( 'page', 'revision' ),
1588 'page_id' => $pageId,
1589 'page_latest=rev_id',
1601 'user_text' => $user->getName(),
1602 'user' => $user->getId(),
1603 'comment' => $summary,
1604 'minor_edit' => $minor,
1605 'text_id' => $current->rev_text_id
,
1606 'parent_id' => $current->page_latest
,
1607 'len' => $current->rev_len
,
1608 'sha1' => $current->rev_sha1
1611 if ( $wgContentHandlerUseDB ) {
1612 $row['content_model'] = $current->rev_content_model
;
1613 $row['content_format'] = $current->rev_content_format
;
1616 $revision = new Revision( $row );
1617 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1622 wfProfileOut( __METHOD__
);
1627 * Determine if the current user is allowed to view a particular
1628 * field of this revision, if it's marked as deleted.
1630 * @param int $field One of self::DELETED_TEXT,
1631 * self::DELETED_COMMENT,
1632 * self::DELETED_USER
1633 * @param User|null $user User object to check, or null to use $wgUser
1636 public function userCan( $field, User
$user = null ) {
1637 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1641 * Determine if the current user is allowed to view a particular
1642 * field of this revision, if it's marked as deleted. This is used
1643 * by various classes to avoid duplication.
1645 * @param int $bitfield Current field
1646 * @param int $field One of self::DELETED_TEXT = File::DELETED_FILE,
1647 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1648 * self::DELETED_USER = File::DELETED_USER
1649 * @param User|null $user User object to check, or null to use $wgUser
1650 * @param Title|null $title A Title object to check for per-page restrictions on,
1651 * instead of just plain userrights
1654 public static function userCanBitfield( $bitfield, $field, User
$user = null,
1657 if ( $bitfield & $field ) { // aspect is deleted
1658 if ( $user === null ) {
1662 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1663 $permissions = array( 'suppressrevision', 'viewsuppressed' );
1664 } elseif ( $field & self
::DELETED_TEXT
) {
1665 $permissions = array( 'deletedtext' );
1667 $permissions = array( 'deletedhistory' );
1669 $permissionlist = implode( ', ', $permissions );
1670 if ( $title === null ) {
1671 wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
1672 return call_user_func_array( array( $user, 'isAllowedAny' ), $permissions );
1674 $text = $title->getPrefixedText();
1675 wfDebug( "Checking for $permissionlist on $text due to $field match on $bitfield\n" );
1676 foreach ( $permissions as $perm ) {
1677 if ( $title->userCan( $perm, $user ) ) {
1689 * Get rev_timestamp from rev_id, without loading the rest of the row
1691 * @param Title $title
1695 static function getTimestampFromId( $title, $id ) {
1696 $dbr = wfGetDB( DB_SLAVE
);
1697 // Casting fix for databases that can't take '' for rev_id
1701 $conds = array( 'rev_id' => $id );
1702 $conds['rev_page'] = $title->getArticleID();
1703 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1704 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1705 # Not in slave, try master
1706 $dbw = wfGetDB( DB_MASTER
);
1707 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1709 return wfTimestamp( TS_MW
, $timestamp );
1713 * Get count of revisions per page...not very efficient
1715 * @param DatabaseBase $db
1716 * @param int $id Page id
1719 static function countByPageId( $db, $id ) {
1720 $row = $db->selectRow( 'revision', array( 'revCount' => 'COUNT(*)' ),
1721 array( 'rev_page' => $id ), __METHOD__
);
1723 return $row->revCount
;
1729 * Get count of revisions per page...not very efficient
1731 * @param DatabaseBase $db
1732 * @param Title $title
1735 static function countByTitle( $db, $title ) {
1736 $id = $title->getArticleID();
1738 return self
::countByPageId( $db, $id );
1744 * Check if no edits were made by other users since
1745 * the time a user started editing the page. Limit to
1746 * 50 revisions for the sake of performance.
1749 * @deprecated since 1.24
1751 * @param DatabaseBase|int $db The Database to perform the check on. May be given as a
1752 * Database object or a database identifier usable with wfGetDB.
1753 * @param int $pageId The ID of the page in question
1754 * @param int $userId The ID of the user in question
1755 * @param string $since Look at edits since this time
1757 * @return bool True if the given user was the only one to edit since the given timestamp
1759 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1764 if ( is_int( $db ) ) {
1765 $db = wfGetDB( $db );
1768 $res = $db->select( 'revision',
1771 'rev_page' => $pageId,
1772 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1775 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
1776 foreach ( $res as $row ) {
1777 if ( $row->rev_user
!= $userId ) {