aa0d8314d31cf5943f4df1da3f25dea6832ccf1d
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
{
30 protected $mOrigUserText;
32 protected $mMinorEdit;
33 protected $mTimestamp;
43 protected $mContentModel;
44 protected $mContentFormat;
46 protected $mContentHandler;
48 const DELETED_TEXT
= 1;
49 const DELETED_COMMENT
= 2;
50 const DELETED_USER
= 4;
51 const DELETED_RESTRICTED
= 8;
53 const SUPPRESSED_USER
= 12;
54 // Audience options for accessors
56 const FOR_THIS_USER
= 2;
60 * Load a page revision from a given revision ID number.
61 * Returns null if no such revision can be found.
64 * IDBAccessObject::LATEST_READ : Select the data from the master
65 * IDBAccessObject::LOCKING_READ : Select & lock the data from the master
66 * IDBAccessObject::AVOID_MASTER : Avoid master queries; data may be stale
69 * @param $flags Integer (optional)
70 * @return Revision or null
72 public static function newFromId( $id, $flags = 0 ) {
73 return self
::newFromConds( array( 'rev_id' => intval( $id ) ), $flags );
77 * Load either the current, or a specified, revision
78 * that's attached to a given title. If not attached
79 * to that title, will return null.
82 * IDBAccessObject::LATEST_READ : Select the data from the master
83 * IDBAccessObject::LOCKING_READ : Select & lock the data from the master
84 * IDBAccessObject::AVOID_MASTER : Avoid master queries; data may be stale
87 * @param $id Integer (optional)
88 * @param $flags Integer Bitfield (optional)
89 * @return Revision or null
91 public static function newFromTitle( $title, $id = 0, $flags = 0 ) {
93 'page_namespace' => $title->getNamespace(),
94 'page_title' => $title->getDBkey()
97 // Use the specified ID
98 $conds['rev_id'] = $id;
99 } elseif ( !( $flags & self
::AVOID_MASTER
) && wfGetLB()->getServerCount() > 1 ) {
100 // Get the latest revision ID from the master
101 $dbw = wfGetDB( DB_MASTER
);
102 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
103 if ( $latest === false ) {
104 return null; // page does not exist
106 $conds['rev_id'] = $latest;
108 // Use a join to get the latest revision
109 $conds[] = 'rev_id=page_latest';
111 return self
::newFromConds( $conds, $flags );
115 * Load either the current, or a specified, revision
116 * that's attached to a given page ID.
117 * Returns null if no such revision can be found.
120 * IDBAccessObject::LATEST_READ : Select the data from the master
121 * IDBAccessObject::LOCKING_READ : Select & lock the data from the master
122 * IDBAccessObject::AVOID_MASTER : Avoid master queries; data may be stale
124 * @param $revId Integer
125 * @param $pageId Integer (optional)
126 * @param $flags Integer Bitfield (optional)
127 * @return Revision or null
129 public static function newFromPageId( $pageId, $revId = 0, $flags = 0 ) {
130 $conds = array( 'page_id' => $pageId );
132 $conds['rev_id'] = $revId;
133 } elseif ( !( $flags & self
::AVOID_MASTER
) && wfGetLB()->getServerCount() > 1 ) {
134 // Get the latest revision ID from the master
135 $dbw = wfGetDB( DB_MASTER
);
136 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
137 if ( $latest === false ) {
138 return null; // page does not exist
140 $conds['rev_id'] = $latest;
142 $conds[] = 'rev_id = page_latest';
144 return self
::newFromConds( $conds, $flags );
148 * Make a fake revision object from an archive table row. This is queried
149 * for permissions or even inserted (as in Special:Undelete)
150 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
153 * @param $overrides array
157 public static function newFromArchiveRow( $row, $overrides = array() ) {
158 global $wgContentHandlerUseDB;
160 $attribs = $overrides +
array(
161 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
162 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
163 'comment' => $row->ar_comment
,
164 'user' => $row->ar_user
,
165 'user_text' => $row->ar_user_text
,
166 'timestamp' => $row->ar_timestamp
,
167 'minor_edit' => $row->ar_minor_edit
,
168 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
169 'deleted' => $row->ar_deleted
,
170 'len' => $row->ar_len
,
171 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
172 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
173 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
176 if ( !$wgContentHandlerUseDB ) {
177 unset( $attribs['content_model'] );
178 unset( $attribs['content_format'] );
181 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
182 // Pre-1.5 ar_text row
183 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
184 if ( $attribs['text'] === false ) {
185 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
188 return new self( $attribs );
197 public static function newFromRow( $row ) {
198 return new self( $row );
202 * Load a page revision from a given revision ID number.
203 * Returns null if no such revision can be found.
205 * @param $db DatabaseBase
207 * @return Revision or null
209 public static function loadFromId( $db, $id ) {
210 return self
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
214 * Load either the current, or a specified, revision
215 * that's attached to a given page. If not attached
216 * to that page, will return null.
218 * @param $db DatabaseBase
219 * @param $pageid Integer
221 * @return Revision or null
223 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
224 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
226 $conds['rev_id'] = intval( $id );
228 $conds[] = 'rev_id=page_latest';
230 return self
::loadFromConds( $db, $conds );
234 * Load either the current, or a specified, revision
235 * that's attached to a given page. If not attached
236 * to that page, will return null.
238 * @param $db DatabaseBase
239 * @param $title Title
241 * @return Revision or null
243 public static function loadFromTitle( $db, $title, $id = 0 ) {
245 $matchId = intval( $id );
247 $matchId = 'page_latest';
249 return self
::loadFromConds( $db,
250 array( "rev_id=$matchId",
251 'page_namespace' => $title->getNamespace(),
252 'page_title' => $title->getDBkey() )
257 * Load the revision for the given title with the given timestamp.
258 * WARNING: Timestamps may in some circumstances not be unique,
259 * so this isn't the best key to use.
261 * @param $db DatabaseBase
262 * @param $title Title
263 * @param $timestamp String
264 * @return Revision or null
266 public static function loadFromTimestamp( $db, $title, $timestamp ) {
267 return self
::loadFromConds( $db,
268 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
269 'page_namespace' => $title->getNamespace(),
270 'page_title' => $title->getDBkey() )
275 * Given a set of conditions, fetch a revision.
277 * @param $conditions Array
278 * @param $flags integer (optional)
279 * @return Revision or null
281 private static function newFromConds( $conditions, $flags = 0 ) {
282 $db = wfGetDB( ( $flags & self
::LATEST_READ
) ? DB_MASTER
: DB_SLAVE
);
283 $rev = self
::loadFromConds( $db, $conditions, $flags );
284 if ( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
285 if ( !( $flags & self
::LATEST_READ
) && !( $flags & self
::AVOID_MASTER
) ) {
286 $dbw = wfGetDB( DB_MASTER
);
287 $rev = self
::loadFromConds( $dbw, $conditions, $flags );
294 * Given a set of conditions, fetch a revision from
295 * the given database connection.
297 * @param $db DatabaseBase
298 * @param $conditions Array
299 * @param $flags integer (optional)
300 * @return Revision or null
302 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
303 $res = self
::fetchFromConds( $db, $conditions, $flags );
305 $row = $res->fetchObject();
307 $ret = new Revision( $row );
316 * Return a wrapper for a series of database rows to
317 * fetch all of a given page's revisions in turn.
318 * Each row can be fed to the constructor to get objects.
320 * @param $title Title
321 * @return ResultWrapper
323 public static function fetchRevision( $title ) {
324 return self
::fetchFromConds(
326 array( 'rev_id=page_latest',
327 'page_namespace' => $title->getNamespace(),
328 'page_title' => $title->getDBkey() )
333 * Given a set of conditions, return a ResultWrapper
334 * which will return matching database rows with the
335 * fields necessary to build Revision objects.
337 * @param $db DatabaseBase
338 * @param $conditions Array
339 * @param $flags integer (optional)
340 * @return ResultWrapper
342 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
343 $fields = array_merge(
344 self
::selectFields(),
345 self
::selectPageFields(),
346 self
::selectUserFields()
348 $options = array( 'LIMIT' => 1 );
349 if ( $flags & self
::FOR_UPDATE
) {
350 $options[] = 'FOR UPDATE';
353 array( 'revision', 'page', 'user' ),
358 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
363 * Return the value of a select() JOIN conds array for the user table.
364 * This will get user table rows for logged-in users.
368 public static function userJoinCond() {
369 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
373 * Return the value of a select() page conds array for the paeg table.
374 * This will assure that the revision(s) are not orphaned from live pages.
378 public static function pageJoinCond() {
379 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
383 * Return the list of revision fields that should be selected to create
387 public static function selectFields() {
388 global $wgContentHandlerUseDB;
405 if ( $wgContentHandlerUseDB ) {
406 $fields[] = 'rev_content_format';
407 $fields[] = 'rev_content_model';
414 * Return the list of text fields that should be selected to read the
418 public static function selectTextFields() {
426 * Return the list of page fields that should be selected from page table
429 public static function selectPageFields() {
441 * Return the list of user fields that should be selected from user table
444 public static function selectUserFields() {
445 return array( 'user_name' );
449 * Do a batched query to get the parent revision lengths
450 * @param $db DatabaseBase
451 * @param $revIds Array
454 public static function getParentLengths( $db, array $revIds ) {
457 return $revLens; // empty
459 wfProfileIn( __METHOD__
);
460 $res = $db->select( 'revision',
461 array( 'rev_id', 'rev_len' ),
462 array( 'rev_id' => $revIds ),
464 foreach ( $res as $row ) {
465 $revLens[$row->rev_id
] = $row->rev_len
;
467 wfProfileOut( __METHOD__
);
474 * @param $row Mixed: either a database row or an array
477 function __construct( $row ) {
478 if( is_object( $row ) ) {
479 $this->mId
= intval( $row->rev_id
);
480 $this->mPage
= intval( $row->rev_page
);
481 $this->mTextId
= intval( $row->rev_text_id
);
482 $this->mComment
= $row->rev_comment
;
483 $this->mUser
= intval( $row->rev_user
);
484 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
485 $this->mTimestamp
= $row->rev_timestamp
;
486 $this->mDeleted
= intval( $row->rev_deleted
);
488 if( !isset( $row->rev_parent_id
) ) {
489 $this->mParentId
= is_null( $row->rev_parent_id
) ?
null : 0;
491 $this->mParentId
= intval( $row->rev_parent_id
);
494 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) ) {
497 $this->mSize
= intval( $row->rev_len
);
500 if ( !isset( $row->rev_sha1
) ) {
503 $this->mSha1
= $row->rev_sha1
;
506 if( isset( $row->page_latest
) ) {
507 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
508 $this->mTitle
= Title
::newFromRow( $row );
510 $this->mCurrent
= false;
511 $this->mTitle
= null;
514 if( !isset( $row->rev_content_model
) ||
is_null( $row->rev_content_model
) ) {
515 $this->mContentModel
= null; # determine on demand if needed
517 $this->mContentModel
= strval( $row->rev_content_model
);
520 if( !isset( $row->rev_content_format
) ||
is_null( $row->rev_content_format
) ) {
521 $this->mContentFormat
= null; # determine on demand if needed
523 $this->mContentFormat
= strval( $row->rev_content_format
);
526 // Lazy extraction...
528 if( isset( $row->old_text
) ) {
529 $this->mTextRow
= $row;
531 // 'text' table row entry will be lazy-loaded
532 $this->mTextRow
= null;
535 // Use user_name for users and rev_user_text for IPs...
536 $this->mUserText
= null; // lazy load if left null
537 if ( $this->mUser
== 0 ) {
538 $this->mUserText
= $row->rev_user_text
; // IP user
539 } elseif ( isset( $row->user_name
) ) {
540 $this->mUserText
= $row->user_name
; // logged-in user
542 $this->mOrigUserText
= $row->rev_user_text
;
543 } elseif( is_array( $row ) ) {
544 // Build a new revision to be saved...
545 global $wgUser; // ugh
548 # if we have a content object, use it to set the model and type
549 if ( !empty( $row['content'] ) ) {
550 if ( !empty( $row['text_id'] ) ) { //@todo: when is that set? test with external store setup! check out insertOn() [dk]
551 throw new MWException( "Text already stored in external store (id {$row['text_id']}), can't serialize content object" );
554 $row['content_model'] = $row['content']->getModel();
555 # note: mContentFormat is initializes later accordingly
556 # note: content is serialized later in this method!
557 # also set text to null?
560 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
561 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
562 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
563 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
564 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
565 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
566 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
567 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
568 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
569 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
570 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
572 $this->mContentModel
= isset( $row['content_model'] ) ?
strval( $row['content_model'] ) : null;
573 $this->mContentFormat
= isset( $row['content_format'] ) ?
strval( $row['content_format'] ) : null;
575 // Enforce spacing trimming on supplied text
576 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
577 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
578 $this->mTextRow
= null;
580 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
582 // if we have a Content object, override mText and mContentModel
583 if ( !empty( $row['content'] ) ) {
584 $handler = $this->getContentHandler();
585 $this->mContent
= $row['content'];
587 $this->mContentModel
= $this->mContent
->getModel();
588 $this->mContentHandler
= null;
590 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
591 } elseif ( !is_null( $this->mText
) ) {
592 $handler = $this->getContentHandler();
593 $this->mContent
= $handler->unserializeContent( $this->mText
);
596 // if we have a Title object, override mPage. Useful for testing and convenience.
597 if ( isset( $row['title'] ) ) {
598 $this->mTitle
= $row['title'];
599 $this->mPage
= $this->mTitle
->getArticleID();
601 $this->mTitle
= null; // Load on demand if needed
604 $this->mCurrent
= false; // @todo: XXX: really? we are about to create a revision. it will usually then be the current one.
606 // If we still have no length, see it we have the text to figure it out
607 if ( !$this->mSize
) {
608 if ( !is_null( $this->mContent
) ) {
609 $this->mSize
= $this->mContent
->getSize();
611 #NOTE: this should never happen if we have either text or content object!
617 if ( $this->mSha1
=== null ) {
618 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
622 $this->getContentModel();
623 $this->getContentFormat();
625 throw new MWException( 'Revision constructor passed invalid row format.' );
627 $this->mUnpatrolled
= null;
633 * @return Integer|null
635 public function getId() {
640 * Set the revision ID
645 public function setId( $id ) {
652 * @return Integer|null
654 public function getTextId() {
655 return $this->mTextId
;
659 * Get parent revision ID (the original previous page revision)
661 * @return Integer|null
663 public function getParentId() {
664 return $this->mParentId
;
668 * Returns the length of the text in this revision, or null if unknown.
670 * @return Integer|null
672 public function getSize() {
677 * Returns the base36 sha1 of the text in this revision, or null if unknown.
679 * @return String|null
681 public function getSha1() {
686 * Returns the title of the page associated with this entry or null.
688 * Will do a query, when title is not set and id is given.
692 public function getTitle() {
693 if( isset( $this->mTitle
) ) {
694 return $this->mTitle
;
696 if( !is_null( $this->mId
) ) { //rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
697 $dbr = wfGetDB( DB_SLAVE
);
698 $row = $dbr->selectRow(
699 array( 'page', 'revision' ),
700 self
::selectPageFields(),
701 array( 'page_id=rev_page',
702 'rev_id' => $this->mId
),
705 $this->mTitle
= Title
::newFromRow( $row );
709 if ( !$this->mTitle
&& !is_null( $this->mPage
) && $this->mPage
> 0 ) {
710 $this->mTitle
= Title
::newFromID( $this->mPage
);
713 return $this->mTitle
;
717 * Set the title of the revision
719 * @param $title Title
721 public function setTitle( $title ) {
722 $this->mTitle
= $title;
728 * @return Integer|null
730 public function getPage() {
735 * Fetch revision's user id if it's available to the specified audience.
736 * If the specified audience does not have access to it, zero will be
739 * @param $audience Integer: one of:
740 * Revision::FOR_PUBLIC to be displayed to all users
741 * Revision::FOR_THIS_USER to be displayed to the given user
742 * Revision::RAW get the ID regardless of permissions
743 * @param $user User object to check for, only if FOR_THIS_USER is passed
744 * to the $audience parameter
747 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
748 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
750 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
758 * Fetch revision's user id without regard for the current user's permissions
762 public function getRawUser() {
767 * Fetch revision's username if it's available to the specified audience.
768 * If the specified audience does not have access to the username, an
769 * empty string will be returned.
771 * @param $audience Integer: one of:
772 * Revision::FOR_PUBLIC to be displayed to all users
773 * Revision::FOR_THIS_USER to be displayed to the given user
774 * Revision::RAW get the text regardless of permissions
775 * @param $user User object to check for, only if FOR_THIS_USER is passed
776 * to the $audience parameter
779 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
780 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
782 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
785 return $this->getRawUserText();
790 * Fetch revision's username without regard for view restrictions
794 public function getRawUserText() {
795 if ( $this->mUserText
=== null ) {
796 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
797 if ( $this->mUserText
=== false ) {
798 # This shouldn't happen, but it can if the wiki was recovered
799 # via importing revs and there is no user table entry yet.
800 $this->mUserText
= $this->mOrigUserText
;
803 return $this->mUserText
;
807 * Fetch revision comment if it's available to the specified audience.
808 * If the specified audience does not have access to the comment, an
809 * empty string will be returned.
811 * @param $audience Integer: one of:
812 * Revision::FOR_PUBLIC to be displayed to all users
813 * Revision::FOR_THIS_USER to be displayed to the given user
814 * Revision::RAW get the text regardless of permissions
815 * @param $user User object to check for, only if FOR_THIS_USER is passed
816 * to the $audience parameter
819 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
820 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
822 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
825 return $this->mComment
;
830 * Fetch revision comment without regard for the current user's permissions
834 public function getRawComment() {
835 return $this->mComment
;
841 public function isMinor() {
842 return (bool)$this->mMinorEdit
;
846 * @return Integer rcid of the unpatrolled row, zero if there isn't one
848 public function isUnpatrolled() {
849 if( $this->mUnpatrolled
!== null ) {
850 return $this->mUnpatrolled
;
852 $dbr = wfGetDB( DB_SLAVE
);
853 $this->mUnpatrolled
= $dbr->selectField( 'recentchanges',
855 array( // Add redundant user,timestamp condition so we can use the existing index
856 'rc_user_text' => $this->getRawUserText(),
857 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
858 'rc_this_oldid' => $this->getId(),
863 return (int)$this->mUnpatrolled
;
867 * @param $field int one of DELETED_* bitfield constants
871 public function isDeleted( $field ) {
872 return ( $this->mDeleted
& $field ) == $field;
876 * Get the deletion bitfield of the revision
880 public function getVisibility() {
881 return (int)$this->mDeleted
;
885 * Fetch revision text if it's available to the specified audience.
886 * If the specified audience does not have the ability to view this
887 * revision, an empty string will be returned.
889 * @param $audience Integer: one of:
890 * Revision::FOR_PUBLIC to be displayed to all users
891 * Revision::FOR_THIS_USER to be displayed to the given user
892 * Revision::RAW get the text regardless of permissions
893 * @param $user User object to check for, only if FOR_THIS_USER is passed
894 * to the $audience parameter
896 * @deprecated in 1.WD, use getContent() instead
897 * @todo: replace usage in core
899 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
900 wfDeprecated( __METHOD__
, '1.WD' );
902 $content = $this->getContent( $audience, $user );
903 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
907 * Fetch revision content if it's available to the specified audience.
908 * If the specified audience does not have the ability to view this
909 * revision, null will be returned.
911 * @param $audience Integer: one of:
912 * Revision::FOR_PUBLIC to be displayed to all users
913 * Revision::FOR_THIS_USER to be displayed to $wgUser
914 * Revision::RAW get the text regardless of permissions
915 * @param $user User object to check for, only if FOR_THIS_USER is passed
916 * to the $audience parameter
921 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
922 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
924 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
927 return $this->getContentInternal();
932 * Alias for getText(Revision::FOR_THIS_USER)
934 * @deprecated since 1.17
937 public function revText() {
938 wfDeprecated( __METHOD__
, '1.17' );
939 return $this->getText( self
::FOR_THIS_USER
);
943 * Fetch revision text without regard for view restrictions
947 * @deprecated since 1.WD. Instead, use Revision::getContent( Revision::RAW ) or Revision::getSerializedData() as appropriate.
949 public function getRawText() {
950 wfDeprecated( __METHOD__
, "1.WD" );
952 return $this->getText( self
::RAW
);
956 * Fetch original serialized data without regard for view restrictions
962 public function getSerializedData() {
966 protected function getContentInternal() {
967 if( is_null( $this->mContent
) ) {
968 // Revision is immutable. Load on demand:
970 $handler = $this->getContentHandler();
971 $format = $this->getContentFormat();
972 $title = $this->getTitle();
974 if( is_null( $this->mText
) ) {
975 // Load text on demand:
976 $this->mText
= $this->loadText();
979 $this->mContent
= is_null( $this->mText
) ?
null : $handler->unserializeContent( $this->mText
, $format );
982 return $this->mContent
;
986 * Returns the content model for this revision.
988 * If no content model was stored in the database, $this->getTitle()->getContentModel() is
989 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
990 * is used as a last resort.
992 * @return String the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
994 public function getContentModel() {
995 if ( !$this->mContentModel
) {
996 $title = $this->getTitle();
997 $this->mContentModel
= ( $title ?
$title->getContentModel() : CONTENT_MODEL_WIKITEXT
);
999 assert( !empty( $this->mContentModel
) );
1002 return $this->mContentModel
;
1006 * Returns the content format for this revision.
1008 * If no content format was stored in the database, the default format for this
1009 * revision's content model is returned.
1011 * @return String the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
1013 public function getContentFormat() {
1014 if ( !$this->mContentFormat
) {
1015 $handler = $this->getContentHandler();
1016 $this->mContentFormat
= $handler->getDefaultFormat();
1018 assert( !empty( $this->mContentFormat
) );
1021 return $this->mContentFormat
;
1025 * Returns the content handler appropriate for this revision's content model.
1027 * @return ContentHandler
1029 public function getContentHandler() {
1030 if ( !$this->mContentHandler
) {
1031 $model = $this->getContentModel();
1032 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
1034 $format = $this->getContentFormat();
1036 if ( !$this->mContentHandler
->isSupportedFormat( $format ) ) {
1037 throw new MWException( "Oops, the content format $format is not supported for this content model, $model" );
1041 return $this->mContentHandler
;
1047 public function getTimestamp() {
1048 return wfTimestamp( TS_MW
, $this->mTimestamp
);
1054 public function isCurrent() {
1055 return $this->mCurrent
;
1059 * Get previous revision for this title
1061 * @return Revision or null
1063 public function getPrevious() {
1064 if( $this->getTitle() ) {
1065 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
1067 return self
::newFromTitle( $this->getTitle(), $prev );
1074 * Get next revision for this title
1076 * @return Revision or null
1078 public function getNext() {
1079 if( $this->getTitle() ) {
1080 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
1082 return self
::newFromTitle( $this->getTitle(), $next );
1089 * Get previous revision Id for this page_id
1090 * This is used to populate rev_parent_id on save
1092 * @param $db DatabaseBase
1095 private function getPreviousRevisionId( $db ) {
1096 if( is_null( $this->mPage
) ) {
1099 # Use page_latest if ID is not given
1101 $prevId = $db->selectField( 'page', 'page_latest',
1102 array( 'page_id' => $this->mPage
),
1105 $prevId = $db->selectField( 'revision', 'rev_id',
1106 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
1108 array( 'ORDER BY' => 'rev_id DESC' ) );
1110 return intval( $prevId );
1114 * Get revision text associated with an old or archive row
1115 * $row is usually an object from wfFetchRow(), both the flags and the text
1116 * field must be included
1118 * @param $row Object: the text data
1119 * @param $prefix String: table prefix (default 'old_')
1120 * @return String: text the text requested or false on failure
1122 public static function getRevisionText( $row, $prefix = 'old_' ) {
1123 wfProfileIn( __METHOD__
);
1126 $textField = $prefix . 'text';
1127 $flagsField = $prefix . 'flags';
1129 if( isset( $row->$flagsField ) ) {
1130 $flags = explode( ',', $row->$flagsField );
1135 if( isset( $row->$textField ) ) {
1136 $text = $row->$textField;
1138 wfProfileOut( __METHOD__
);
1142 # Use external methods for external objects, text in table is URL-only then
1143 if ( in_array( 'external', $flags ) ) {
1145 $parts = explode( '://', $url, 2 );
1146 if( count( $parts ) == 1 ||
$parts[1] == '' ) {
1147 wfProfileOut( __METHOD__
);
1150 $text = ExternalStore
::fetchFromURL( $url );
1153 // If the text was fetched without an error, convert it
1154 if ( $text !== false ) {
1155 if( in_array( 'gzip', $flags ) ) {
1156 # Deal with optional compression of archived pages.
1157 # This can be done periodically via maintenance/compressOld.php, and
1158 # as pages are saved if $wgCompressRevisions is set.
1159 $text = gzinflate( $text );
1162 if( in_array( 'object', $flags ) ) {
1163 # Generic compressed storage
1164 $obj = unserialize( $text );
1165 if ( !is_object( $obj ) ) {
1167 wfProfileOut( __METHOD__
);
1170 $text = $obj->getText();
1173 global $wgLegacyEncoding;
1174 if( $text !== false && $wgLegacyEncoding
1175 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
1177 # Old revisions kept around in a legacy encoding?
1178 # Upconvert on demand.
1179 # ("utf8" checked for compatibility with some broken
1180 # conversion scripts 2008-12-30)
1182 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1185 wfProfileOut( __METHOD__
);
1190 * If $wgCompressRevisions is enabled, we will compress data.
1191 * The input string is modified in place.
1192 * Return value is the flags field: contains 'gzip' if the
1193 * data is compressed, and 'utf-8' if we're saving in UTF-8
1196 * @param $text Mixed: reference to a text
1199 public static function compressRevisionText( &$text ) {
1200 global $wgCompressRevisions;
1203 # Revisions not marked this way will be converted
1204 # on load if $wgLegacyCharset is set in the future.
1207 if( $wgCompressRevisions ) {
1208 if( function_exists( 'gzdeflate' ) ) {
1209 $text = gzdeflate( $text );
1212 wfDebug( __METHOD__
. " -- no zlib support, not compressing\n" );
1215 return implode( ',', $flags );
1219 * Insert a new revision into the database, returning the new revision ID
1220 * number on success and dies horribly on failure.
1222 * @param $dbw DatabaseBase: (master connection)
1225 public function insertOn( $dbw ) {
1226 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1228 wfProfileIn( __METHOD__
);
1230 $this->checkContentModel();
1232 $data = $this->mText
;
1233 $flags = self
::compressRevisionText( $data );
1235 # Write to external storage if required
1236 if( $wgDefaultExternalStore ) {
1237 // Store and get the URL
1238 $data = ExternalStore
::insertToDefault( $data );
1240 throw new MWException( "Unable to store text to external storage" );
1245 $flags .= 'external';
1248 # Record the text (or external storage URL) to the text table
1249 if( !isset( $this->mTextId
) ) {
1250 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1251 $dbw->insert( 'text',
1253 'old_id' => $old_id,
1254 'old_text' => $data,
1255 'old_flags' => $flags,
1258 $this->mTextId
= $dbw->insertId();
1261 if ( $this->mComment
=== null ) $this->mComment
= "";
1263 # Record the edit in revisions
1264 $rev_id = isset( $this->mId
)
1266 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1268 'rev_id' => $rev_id,
1269 'rev_page' => $this->mPage
,
1270 'rev_text_id' => $this->mTextId
,
1271 'rev_comment' => $this->mComment
,
1272 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1273 'rev_user' => $this->mUser
,
1274 'rev_user_text' => $this->mUserText
,
1275 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1276 'rev_deleted' => $this->mDeleted
,
1277 'rev_len' => $this->mSize
,
1278 'rev_parent_id' => is_null( $this->mParentId
)
1279 ?
$this->getPreviousRevisionId( $dbw )
1281 'rev_sha1' => is_null( $this->mSha1
)
1282 ? Revision
::base36Sha1( $this->mText
)
1286 if ( $wgContentHandlerUseDB ) {
1287 //NOTE: Store null for the default model and format, to save space.
1288 //XXX: Makes the DB sensitive to changed defaults. Make this behaviour optional? Only in miser mode?
1290 $model = $this->getContentModel();
1291 $format = $this->getContentFormat();
1293 $defaultModel = ContentHandler
::getDefaultModelFor( $this->getTitle() );
1294 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1296 $row[ 'rev_content_model' ] = ( $model === $defaultModel ) ?
null : $model;
1297 $row[ 'rev_content_format' ] = ( $format === $defaultFormat ) ?
null : $format;
1300 $dbw->insert( 'revision', $row, __METHOD__
);
1302 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1304 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1306 wfProfileOut( __METHOD__
);
1310 protected function checkContentModel() {
1311 global $wgContentHandlerUseDB;
1313 $title = $this->getTitle(); //note: may return null for revisions that have not yet been inserted.
1315 $model = $this->getContentModel();
1316 $format = $this->getContentFormat();
1317 $handler = $this->getContentHandler();
1319 if ( !$handler->isSupportedFormat( $format ) ) {
1320 $t = $title->getPrefixedDBkey();
1322 throw new MWException( "Can't use format $format with content model $model on $t" );
1325 if ( !$wgContentHandlerUseDB && $title ) {
1326 // if $wgContentHandlerUseDB is not set, all revisions must use the default content model and format.
1328 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1329 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1330 $defaultFormat = $defaultHandler->getDefaultFormat();
1332 if ( $this->getContentModel() != $defaultModel ) {
1333 $t = $title->getPrefixedDBkey();
1335 throw new MWException( "Can't save non-default content model with \$wgContentHandlerUseDB disabled: model is $model , default for $t is $defaultModel" );
1338 if ( $this->getContentFormat() != $defaultFormat ) {
1339 $t = $title->getPrefixedDBkey();
1341 throw new MWException( "Can't use non-default content format with \$wgContentHandlerUseDB disabled: format is $format, default for $t is $defaultFormat" );
1345 $content = $this->getContent( Revision
::RAW
);
1347 if ( !$content->isValid() ) {
1348 $t = $title->getPrefixedDBkey();
1350 throw new MWException( "Content of $t is not valid! Content model is $model" );
1355 * Get the base 36 SHA-1 value for a string of text
1356 * @param $text String
1359 public static function base36Sha1( $text ) {
1360 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1364 * Lazy-load the revision's text.
1365 * Currently hardcoded to the 'text' table storage engine.
1369 protected function loadText() {
1370 wfProfileIn( __METHOD__
);
1372 // Caching may be beneficial for massive use of external storage
1373 global $wgRevisionCacheExpiry, $wgMemc;
1374 $textId = $this->getTextId();
1375 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1376 if( $wgRevisionCacheExpiry ) {
1377 $text = $wgMemc->get( $key );
1378 if( is_string( $text ) ) {
1379 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1380 wfProfileOut( __METHOD__
);
1385 // If we kept data for lazy extraction, use it now...
1386 if ( isset( $this->mTextRow
) ) {
1387 $row = $this->mTextRow
;
1388 $this->mTextRow
= null;
1394 // Text data is immutable; check slaves first.
1395 $dbr = wfGetDB( DB_SLAVE
);
1396 $row = $dbr->selectRow( 'text',
1397 array( 'old_text', 'old_flags' ),
1398 array( 'old_id' => $this->getTextId() ),
1402 if( !$row && wfGetLB()->getServerCount() > 1 ) {
1403 // Possible slave lag!
1404 $dbw = wfGetDB( DB_MASTER
);
1405 $row = $dbw->selectRow( 'text',
1406 array( 'old_text', 'old_flags' ),
1407 array( 'old_id' => $this->getTextId() ),
1411 $text = self
::getRevisionText( $row );
1413 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1414 if( $wgRevisionCacheExpiry && $text !== false ) {
1415 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1418 wfProfileOut( __METHOD__
);
1424 * Create a new null-revision for insertion into a page's
1425 * history. This will not re-save the text, but simply refer
1426 * to the text from the previous version.
1428 * Such revisions can for instance identify page rename
1429 * operations and other such meta-modifications.
1431 * @param $dbw DatabaseBase
1432 * @param $pageId Integer: ID number of the page to read from
1433 * @param $summary String: revision's summary
1434 * @param $minor Boolean: whether the revision should be considered as minor
1435 * @return Revision|null on error
1437 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1438 global $wgContentHandlerUseDB;
1440 wfProfileIn( __METHOD__
);
1442 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1443 'rev_text_id', 'rev_len', 'rev_sha1' );
1445 if ( $wgContentHandlerUseDB ) {
1446 $fields[] = 'rev_content_model';
1447 $fields[] = 'rev_content_format';
1450 $current = $dbw->selectRow(
1451 array( 'page', 'revision' ),
1454 'page_id' => $pageId,
1455 'page_latest=rev_id',
1462 'comment' => $summary,
1463 'minor_edit' => $minor,
1464 'text_id' => $current->rev_text_id
,
1465 'parent_id' => $current->page_latest
,
1466 'len' => $current->rev_len
,
1467 'sha1' => $current->rev_sha1
1470 if ( $wgContentHandlerUseDB ) {
1471 $row[ 'content_model' ] = $current->rev_content_model
;
1472 $row[ 'content_format' ] = $current->rev_content_format
;
1475 $revision = new Revision( $row );
1476 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1481 wfProfileOut( __METHOD__
);
1486 * Determine if the current user is allowed to view a particular
1487 * field of this revision, if it's marked as deleted.
1489 * @param $field Integer:one of self::DELETED_TEXT,
1490 * self::DELETED_COMMENT,
1491 * self::DELETED_USER
1492 * @param $user User object to check, or null to use $wgUser
1495 public function userCan( $field, User
$user = null ) {
1496 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1500 * Determine if the current user is allowed to view a particular
1501 * field of this revision, if it's marked as deleted. This is used
1502 * by various classes to avoid duplication.
1504 * @param $bitfield Integer: current field
1505 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1506 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1507 * self::DELETED_USER = File::DELETED_USER
1508 * @param $user User object to check, or null to use $wgUser
1511 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1512 if( $bitfield & $field ) { // aspect is deleted
1513 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1514 $permission = 'suppressrevision';
1515 } elseif ( $field & self
::DELETED_TEXT
) {
1516 $permission = 'deletedtext';
1518 $permission = 'deletedhistory';
1520 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1521 if ( $user === null ) {
1525 return $user->isAllowed( $permission );
1532 * Get rev_timestamp from rev_id, without loading the rest of the row
1534 * @param $title Title
1535 * @param $id Integer
1538 static function getTimestampFromId( $title, $id ) {
1539 $dbr = wfGetDB( DB_SLAVE
);
1540 // Casting fix for DB2
1544 $conds = array( 'rev_id' => $id );
1545 $conds['rev_page'] = $title->getArticleID();
1546 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1547 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1548 # Not in slave, try master
1549 $dbw = wfGetDB( DB_MASTER
);
1550 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1552 return wfTimestamp( TS_MW
, $timestamp );
1556 * Get count of revisions per page...not very efficient
1558 * @param $db DatabaseBase
1559 * @param $id Integer: page id
1562 static function countByPageId( $db, $id ) {
1563 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
1564 array( 'rev_page' => $id ), __METHOD__
);
1566 return $row->revCount
;
1572 * Get count of revisions per page...not very efficient
1574 * @param $db DatabaseBase
1575 * @param $title Title
1578 static function countByTitle( $db, $title ) {
1579 $id = $title->getArticleID();
1581 return self
::countByPageId( $db, $id );