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 // Revision deletion constants
49 const DELETED_TEXT
= 1;
50 const DELETED_COMMENT
= 2;
51 const DELETED_USER
= 4;
52 const DELETED_RESTRICTED
= 8;
53 const SUPPRESSED_USER
= 12; // convenience
55 // Audience options for accessors
57 const FOR_THIS_USER
= 2;
61 * Load a page revision from a given revision ID number.
62 * Returns null if no such revision can be found.
65 * Revision::READ_LATEST : Select the data from the master
66 * Revision::READ_LOCKING : Select & lock the data from the master
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 * Revision::READ_LATEST : Select the data from the master
83 * Revision::READ_LOCKING : Select & lock the data from the master
86 * @param $id Integer (optional)
87 * @param $flags Integer Bitfield (optional)
88 * @return Revision or null
90 public static function newFromTitle( $title, $id = 0, $flags = null ) {
92 'page_namespace' => $title->getNamespace(),
93 'page_title' => $title->getDBkey()
96 // Use the specified ID
97 $conds['rev_id'] = $id;
99 // Use a join to get the latest revision
100 $conds[] = 'rev_id=page_latest';
101 // Callers assume this will be up-to-date
102 $flags = is_int( $flags ) ?
$flags : self
::READ_LATEST
; // b/c
104 return self
::newFromConds( $conds, (int)$flags );
108 * Load either the current, or a specified, revision
109 * that's attached to a given page ID.
110 * Returns null if no such revision can be found.
113 * Revision::READ_LATEST : Select the data from the master
114 * Revision::READ_LOCKING : Select & lock the data from the master
116 * @param $revId Integer
117 * @param $pageId Integer (optional)
118 * @param $flags Integer Bitfield (optional)
119 * @return Revision or null
121 public static function newFromPageId( $pageId, $revId = 0, $flags = null ) {
122 $conds = array( 'page_id' => $pageId );
124 $conds['rev_id'] = $revId;
126 // Use a join to get the latest revision
127 $conds[] = 'rev_id = page_latest';
128 // Callers assume this will be up-to-date
129 $flags = is_int( $flags ) ?
$flags : self
::READ_LATEST
; // b/c
131 return self
::newFromConds( $conds, (int)$flags );
135 * Make a fake revision object from an archive table row. This is queried
136 * for permissions or even inserted (as in Special:Undelete)
137 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
140 * @param $overrides array
144 public static function newFromArchiveRow( $row, $overrides = array() ) {
145 global $wgContentHandlerUseDB;
147 $attribs = $overrides +
array(
148 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
149 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
150 'comment' => $row->ar_comment
,
151 'user' => $row->ar_user
,
152 'user_text' => $row->ar_user_text
,
153 'timestamp' => $row->ar_timestamp
,
154 'minor_edit' => $row->ar_minor_edit
,
155 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
156 'deleted' => $row->ar_deleted
,
157 'len' => $row->ar_len
,
158 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
159 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
160 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
163 if ( !$wgContentHandlerUseDB ) {
164 unset( $attribs['content_model'] );
165 unset( $attribs['content_format'] );
168 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
169 // Pre-1.5 ar_text row
170 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
171 if ( $attribs['text'] === false ) {
172 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
175 return new self( $attribs );
184 public static function newFromRow( $row ) {
185 return new self( $row );
189 * Load a page revision from a given revision ID number.
190 * Returns null if no such revision can be found.
192 * @param $db DatabaseBase
194 * @return Revision or null
196 public static function loadFromId( $db, $id ) {
197 return self
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
201 * Load either the current, or a specified, revision
202 * that's attached to a given page. If not attached
203 * to that page, will return null.
205 * @param $db DatabaseBase
206 * @param $pageid Integer
208 * @return Revision or null
210 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
211 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
213 $conds['rev_id'] = intval( $id );
215 $conds[] = 'rev_id=page_latest';
217 return self
::loadFromConds( $db, $conds );
221 * Load either the current, or a specified, revision
222 * that's attached to a given page. If not attached
223 * to that page, will return null.
225 * @param $db DatabaseBase
226 * @param $title Title
228 * @return Revision or null
230 public static function loadFromTitle( $db, $title, $id = 0 ) {
232 $matchId = intval( $id );
234 $matchId = 'page_latest';
236 return self
::loadFromConds( $db,
237 array( "rev_id=$matchId",
238 'page_namespace' => $title->getNamespace(),
239 'page_title' => $title->getDBkey() )
244 * Load the revision for the given title with the given timestamp.
245 * WARNING: Timestamps may in some circumstances not be unique,
246 * so this isn't the best key to use.
248 * @param $db DatabaseBase
249 * @param $title Title
250 * @param $timestamp String
251 * @return Revision or null
253 public static function loadFromTimestamp( $db, $title, $timestamp ) {
254 return self
::loadFromConds( $db,
255 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
256 'page_namespace' => $title->getNamespace(),
257 'page_title' => $title->getDBkey() )
262 * Given a set of conditions, fetch a revision.
264 * @param $conditions Array
265 * @param $flags integer (optional)
266 * @return Revision or null
268 private static function newFromConds( $conditions, $flags = 0 ) {
269 $db = wfGetDB( ( $flags & self
::READ_LATEST
) ? DB_MASTER
: DB_SLAVE
);
270 $rev = self
::loadFromConds( $db, $conditions, $flags );
271 if ( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
272 if ( !( $flags & self
::READ_LATEST
) ) {
273 $dbw = wfGetDB( DB_MASTER
);
274 $rev = self
::loadFromConds( $dbw, $conditions, $flags );
281 * Given a set of conditions, fetch a revision from
282 * the given database connection.
284 * @param $db DatabaseBase
285 * @param $conditions Array
286 * @param $flags integer (optional)
287 * @return Revision or null
289 private static function loadFromConds( $db, $conditions, $flags = 0 ) {
290 $res = self
::fetchFromConds( $db, $conditions, $flags );
292 $row = $res->fetchObject();
294 $ret = new Revision( $row );
303 * Return a wrapper for a series of database rows to
304 * fetch all of a given page's revisions in turn.
305 * Each row can be fed to the constructor to get objects.
307 * @param $title Title
308 * @return ResultWrapper
310 public static function fetchRevision( $title ) {
311 return self
::fetchFromConds(
313 array( 'rev_id=page_latest',
314 'page_namespace' => $title->getNamespace(),
315 'page_title' => $title->getDBkey() )
320 * Given a set of conditions, return a ResultWrapper
321 * which will return matching database rows with the
322 * fields necessary to build Revision objects.
324 * @param $db DatabaseBase
325 * @param $conditions Array
326 * @param $flags integer (optional)
327 * @return ResultWrapper
329 private static function fetchFromConds( $db, $conditions, $flags = 0 ) {
330 $fields = array_merge(
331 self
::selectFields(),
332 self
::selectPageFields(),
333 self
::selectUserFields()
335 $options = array( 'LIMIT' => 1 );
336 if ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
) {
337 $options[] = 'FOR UPDATE';
340 array( 'revision', 'page', 'user' ),
345 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
350 * Return the value of a select() JOIN conds array for the user table.
351 * This will get user table rows for logged-in users.
355 public static function userJoinCond() {
356 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
360 * Return the value of a select() page conds array for the paeg table.
361 * This will assure that the revision(s) are not orphaned from live pages.
365 public static function pageJoinCond() {
366 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
370 * Return the list of revision fields that should be selected to create
374 public static function selectFields() {
375 global $wgContentHandlerUseDB;
392 if ( $wgContentHandlerUseDB ) {
393 $fields[] = 'rev_content_format';
394 $fields[] = 'rev_content_model';
401 * Return the list of text fields that should be selected to read the
405 public static function selectTextFields() {
413 * Return the list of page fields that should be selected from page table
416 public static function selectPageFields() {
428 * Return the list of user fields that should be selected from user table
431 public static function selectUserFields() {
432 return array( 'user_name' );
436 * Do a batched query to get the parent revision lengths
437 * @param $db DatabaseBase
438 * @param $revIds Array
441 public static function getParentLengths( $db, array $revIds ) {
444 return $revLens; // empty
446 wfProfileIn( __METHOD__
);
447 $res = $db->select( 'revision',
448 array( 'rev_id', 'rev_len' ),
449 array( 'rev_id' => $revIds ),
451 foreach ( $res as $row ) {
452 $revLens[$row->rev_id
] = $row->rev_len
;
454 wfProfileOut( __METHOD__
);
461 * @param $row Mixed: either a database row or an array
464 function __construct( $row ) {
465 if( is_object( $row ) ) {
466 $this->mId
= intval( $row->rev_id
);
467 $this->mPage
= intval( $row->rev_page
);
468 $this->mTextId
= intval( $row->rev_text_id
);
469 $this->mComment
= $row->rev_comment
;
470 $this->mUser
= intval( $row->rev_user
);
471 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
472 $this->mTimestamp
= $row->rev_timestamp
;
473 $this->mDeleted
= intval( $row->rev_deleted
);
475 if( !isset( $row->rev_parent_id
) ) {
476 $this->mParentId
= is_null( $row->rev_parent_id
) ?
null : 0;
478 $this->mParentId
= intval( $row->rev_parent_id
);
481 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) ) {
484 $this->mSize
= intval( $row->rev_len
);
487 if ( !isset( $row->rev_sha1
) ) {
490 $this->mSha1
= $row->rev_sha1
;
493 if( isset( $row->page_latest
) ) {
494 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
495 $this->mTitle
= Title
::newFromRow( $row );
497 $this->mCurrent
= false;
498 $this->mTitle
= null;
501 if( !isset( $row->rev_content_model
) ||
is_null( $row->rev_content_model
) ) {
502 $this->mContentModel
= null; # determine on demand if needed
504 $this->mContentModel
= strval( $row->rev_content_model
);
507 if( !isset( $row->rev_content_format
) ||
is_null( $row->rev_content_format
) ) {
508 $this->mContentFormat
= null; # determine on demand if needed
510 $this->mContentFormat
= strval( $row->rev_content_format
);
513 // Lazy extraction...
515 if( isset( $row->old_text
) ) {
516 $this->mTextRow
= $row;
518 // 'text' table row entry will be lazy-loaded
519 $this->mTextRow
= null;
522 // Use user_name for users and rev_user_text for IPs...
523 $this->mUserText
= null; // lazy load if left null
524 if ( $this->mUser
== 0 ) {
525 $this->mUserText
= $row->rev_user_text
; // IP user
526 } elseif ( isset( $row->user_name
) ) {
527 $this->mUserText
= $row->user_name
; // logged-in user
529 $this->mOrigUserText
= $row->rev_user_text
;
530 } elseif( is_array( $row ) ) {
531 // Build a new revision to be saved...
532 global $wgUser; // ugh
535 # if we have a content object, use it to set the model and type
536 if ( !empty( $row['content'] ) ) {
537 //@todo: when is that set? test with external store setup! check out insertOn() [dk]
538 if ( !empty( $row['text_id'] ) ) {
539 throw new MWException( "Text already stored in external store (id {$row['text_id']}), "
540 . "can't serialize content object" );
543 $row['content_model'] = $row['content']->getModel();
544 # note: mContentFormat is initializes later accordingly
545 # note: content is serialized later in this method!
546 # also set text to null?
549 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
550 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
551 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
552 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
553 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
554 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
555 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
556 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
557 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
558 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
559 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
561 $this->mContentModel
= isset( $row['content_model'] ) ?
strval( $row['content_model'] ) : null;
562 $this->mContentFormat
= isset( $row['content_format'] ) ?
strval( $row['content_format'] ) : null;
564 // Enforce spacing trimming on supplied text
565 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
566 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
567 $this->mTextRow
= null;
569 $this->mTitle
= isset( $row['title'] ) ?
$row['title'] : null;
571 // if we have a Content object, override mText and mContentModel
572 if ( !empty( $row['content'] ) ) {
573 if ( !( $row['content'] instanceof Content
) ) {
574 throw new MWException( '`content` field must contain a Content object.' );
577 $handler = $this->getContentHandler();
578 $this->mContent
= $row['content'];
580 $this->mContentModel
= $this->mContent
->getModel();
581 $this->mContentHandler
= null;
583 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
584 } elseif ( !is_null( $this->mText
) ) {
585 $handler = $this->getContentHandler();
586 $this->mContent
= $handler->unserializeContent( $this->mText
);
589 // if we have a Title object, override mPage. Useful for testing and convenience.
590 if ( isset( $row['title'] ) ) {
591 $this->mTitle
= $row['title'];
592 $this->mPage
= $this->mTitle
->getArticleID();
594 $this->mTitle
= null; // Load on demand if needed
597 // @todo: XXX: really? we are about to create a revision. it will usually then be the current one.
598 $this->mCurrent
= false;
600 // If we still have no length, see it we have the text to figure it out
601 if ( !$this->mSize
) {
602 if ( !is_null( $this->mContent
) ) {
603 $this->mSize
= $this->mContent
->getSize();
605 #NOTE: this should never happen if we have either text or content object!
611 if ( $this->mSha1
=== null ) {
612 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
616 $this->getContentModel();
617 $this->getContentFormat();
619 throw new MWException( 'Revision constructor passed invalid row format.' );
621 $this->mUnpatrolled
= null;
627 * @return Integer|null
629 public function getId() {
634 * Set the revision ID
639 public function setId( $id ) {
646 * @return Integer|null
648 public function getTextId() {
649 return $this->mTextId
;
653 * Get parent revision ID (the original previous page revision)
655 * @return Integer|null
657 public function getParentId() {
658 return $this->mParentId
;
662 * Returns the length of the text in this revision, or null if unknown.
664 * @return Integer|null
666 public function getSize() {
671 * Returns the base36 sha1 of the text in this revision, or null if unknown.
673 * @return String|null
675 public function getSha1() {
680 * Returns the title of the page associated with this entry or null.
682 * Will do a query, when title is not set and id is given.
686 public function getTitle() {
687 if( isset( $this->mTitle
) ) {
688 return $this->mTitle
;
690 if( !is_null( $this->mId
) ) { //rev_id is defined as NOT NULL, but this revision may not yet have been inserted.
691 $dbr = wfGetDB( DB_SLAVE
);
692 $row = $dbr->selectRow(
693 array( 'page', 'revision' ),
694 self
::selectPageFields(),
695 array( 'page_id=rev_page',
696 'rev_id' => $this->mId
),
699 $this->mTitle
= Title
::newFromRow( $row );
703 if ( !$this->mTitle
&& !is_null( $this->mPage
) && $this->mPage
> 0 ) {
704 $this->mTitle
= Title
::newFromID( $this->mPage
);
707 return $this->mTitle
;
711 * Set the title of the revision
713 * @param $title Title
715 public function setTitle( $title ) {
716 $this->mTitle
= $title;
722 * @return Integer|null
724 public function getPage() {
729 * Fetch revision's user id if it's available to the specified audience.
730 * If the specified audience does not have access to it, zero will be
733 * @param $audience Integer: one of:
734 * Revision::FOR_PUBLIC to be displayed to all users
735 * Revision::FOR_THIS_USER to be displayed to the given user
736 * Revision::RAW get the ID regardless of permissions
737 * @param $user User object to check for, only if FOR_THIS_USER is passed
738 * to the $audience parameter
741 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
742 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
744 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
752 * Fetch revision's user id without regard for the current user's permissions
756 public function getRawUser() {
761 * Fetch revision's username if it's available to the specified audience.
762 * If the specified audience does not have access to the username, an
763 * empty string will be returned.
765 * @param $audience Integer: one of:
766 * Revision::FOR_PUBLIC to be displayed to all users
767 * Revision::FOR_THIS_USER to be displayed to the given user
768 * Revision::RAW get the text regardless of permissions
769 * @param $user User object to check for, only if FOR_THIS_USER is passed
770 * to the $audience parameter
773 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
774 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
776 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
779 return $this->getRawUserText();
784 * Fetch revision's username without regard for view restrictions
788 public function getRawUserText() {
789 if ( $this->mUserText
=== null ) {
790 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
791 if ( $this->mUserText
=== false ) {
792 # This shouldn't happen, but it can if the wiki was recovered
793 # via importing revs and there is no user table entry yet.
794 $this->mUserText
= $this->mOrigUserText
;
797 return $this->mUserText
;
801 * Fetch revision comment if it's available to the specified audience.
802 * If the specified audience does not have access to the comment, 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 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
814 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
816 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
819 return $this->mComment
;
824 * Fetch revision comment without regard for the current user's permissions
828 public function getRawComment() {
829 return $this->mComment
;
835 public function isMinor() {
836 return (bool)$this->mMinorEdit
;
840 * @return Integer rcid of the unpatrolled row, zero if there isn't one
842 public function isUnpatrolled() {
843 if( $this->mUnpatrolled
!== null ) {
844 return $this->mUnpatrolled
;
846 $dbr = wfGetDB( DB_SLAVE
);
847 $this->mUnpatrolled
= $dbr->selectField( 'recentchanges',
849 array( // Add redundant user,timestamp condition so we can use the existing index
850 'rc_user_text' => $this->getRawUserText(),
851 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
852 'rc_this_oldid' => $this->getId(),
857 return (int)$this->mUnpatrolled
;
861 * @param $field int one of DELETED_* bitfield constants
865 public function isDeleted( $field ) {
866 return ( $this->mDeleted
& $field ) == $field;
870 * Get the deletion bitfield of the revision
874 public function getVisibility() {
875 return (int)$this->mDeleted
;
879 * Fetch revision text if it's available to the specified audience.
880 * If the specified audience does not have the ability to view this
881 * revision, an empty string will be returned.
883 * @param $audience Integer: one of:
884 * Revision::FOR_PUBLIC to be displayed to all users
885 * Revision::FOR_THIS_USER to be displayed to the given user
886 * Revision::RAW get the text regardless of permissions
887 * @param $user User object to check for, only if FOR_THIS_USER is passed
888 * to the $audience parameter
890 * @deprecated in 1.21, use getContent() instead
891 * @todo: replace usage in core
894 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
895 wfDeprecated( __METHOD__
, '1.21' );
897 $content = $this->getContent( $audience, $user );
898 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
902 * Fetch revision content if it's available to the specified audience.
903 * If the specified audience does not have the ability to view this
904 * revision, null will be returned.
906 * @param $audience Integer: one of:
907 * Revision::FOR_PUBLIC to be displayed to all users
908 * Revision::FOR_THIS_USER to be displayed to $wgUser
909 * Revision::RAW get the text regardless of permissions
910 * @param $user User object to check for, only if FOR_THIS_USER is passed
911 * to the $audience parameter
915 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
916 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
918 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
921 return $this->getContentInternal();
926 * Alias for getText(Revision::FOR_THIS_USER)
928 * @deprecated since 1.17
931 public function revText() {
932 wfDeprecated( __METHOD__
, '1.17' );
933 return $this->getText( self
::FOR_THIS_USER
);
937 * Fetch revision text without regard for view restrictions
941 * @deprecated since 1.21. Instead, use Revision::getContent( Revision::RAW )
942 * or Revision::getSerializedData() as appropriate.
944 public function getRawText() {
945 wfDeprecated( __METHOD__
, "1.21" );
947 return $this->getText( self
::RAW
);
951 * Fetch original serialized data without regard for view restrictions
956 public function getSerializedData() {
961 * Gets the content object for the revision
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
->copy(); // NOTE: copy() will return $this for immutable content objects
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 $title = $this->getTitle();
1295 if ( $title === null ) {
1296 throw new MWException( "Insufficient information to determine the title of the revision's page!" );
1299 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1300 $defaultFormat = ContentHandler
::getForModelID( $defaultModel )->getDefaultFormat();
1302 $row[ 'rev_content_model' ] = ( $model === $defaultModel ) ?
null : $model;
1303 $row[ 'rev_content_format' ] = ( $format === $defaultFormat ) ?
null : $format;
1306 $dbw->insert( 'revision', $row, __METHOD__
);
1308 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1310 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1312 wfProfileOut( __METHOD__
);
1316 protected function checkContentModel() {
1317 global $wgContentHandlerUseDB;
1319 $title = $this->getTitle(); //note: may return null for revisions that have not yet been inserted.
1321 $model = $this->getContentModel();
1322 $format = $this->getContentFormat();
1323 $handler = $this->getContentHandler();
1325 if ( !$handler->isSupportedFormat( $format ) ) {
1326 $t = $title->getPrefixedDBkey();
1328 throw new MWException( "Can't use format $format with content model $model on $t" );
1331 if ( !$wgContentHandlerUseDB && $title ) {
1332 // if $wgContentHandlerUseDB is not set, all revisions must use the default content model and format.
1334 $defaultModel = ContentHandler
::getDefaultModelFor( $title );
1335 $defaultHandler = ContentHandler
::getForModelID( $defaultModel );
1336 $defaultFormat = $defaultHandler->getDefaultFormat();
1338 if ( $this->getContentModel() != $defaultModel ) {
1339 $t = $title->getPrefixedDBkey();
1341 throw new MWException( "Can't save non-default content model with \$wgContentHandlerUseDB disabled: "
1342 . "model is $model , default for $t is $defaultModel" );
1345 if ( $this->getContentFormat() != $defaultFormat ) {
1346 $t = $title->getPrefixedDBkey();
1348 throw new MWException( "Can't use non-default content format with \$wgContentHandlerUseDB disabled: "
1349 . "format is $format, default for $t is $defaultFormat" );
1353 $content = $this->getContent( Revision
::RAW
);
1355 if ( !$content->isValid() ) {
1356 $t = $title->getPrefixedDBkey();
1358 throw new MWException( "Content of $t is not valid! Content model is $model" );
1363 * Get the base 36 SHA-1 value for a string of text
1364 * @param $text String
1367 public static function base36Sha1( $text ) {
1368 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1372 * Lazy-load the revision's text.
1373 * Currently hardcoded to the 'text' table storage engine.
1377 protected function loadText() {
1378 wfProfileIn( __METHOD__
);
1380 // Caching may be beneficial for massive use of external storage
1381 global $wgRevisionCacheExpiry, $wgMemc;
1382 $textId = $this->getTextId();
1383 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1384 if( $wgRevisionCacheExpiry ) {
1385 $text = $wgMemc->get( $key );
1386 if( is_string( $text ) ) {
1387 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1388 wfProfileOut( __METHOD__
);
1393 // If we kept data for lazy extraction, use it now...
1394 if ( isset( $this->mTextRow
) ) {
1395 $row = $this->mTextRow
;
1396 $this->mTextRow
= null;
1402 // Text data is immutable; check slaves first.
1403 $dbr = wfGetDB( DB_SLAVE
);
1404 $row = $dbr->selectRow( 'text',
1405 array( 'old_text', 'old_flags' ),
1406 array( 'old_id' => $this->getTextId() ),
1410 if( !$row && wfGetLB()->getServerCount() > 1 ) {
1411 // Possible slave lag!
1412 $dbw = wfGetDB( DB_MASTER
);
1413 $row = $dbw->selectRow( 'text',
1414 array( 'old_text', 'old_flags' ),
1415 array( 'old_id' => $this->getTextId() ),
1419 $text = self
::getRevisionText( $row );
1421 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1422 if( $wgRevisionCacheExpiry && $text !== false ) {
1423 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1426 wfProfileOut( __METHOD__
);
1432 * Create a new null-revision for insertion into a page's
1433 * history. This will not re-save the text, but simply refer
1434 * to the text from the previous version.
1436 * Such revisions can for instance identify page rename
1437 * operations and other such meta-modifications.
1439 * @param $dbw DatabaseBase
1440 * @param $pageId Integer: ID number of the page to read from
1441 * @param $summary String: revision's summary
1442 * @param $minor Boolean: whether the revision should be considered as minor
1443 * @return Revision|null on error
1445 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1446 global $wgContentHandlerUseDB;
1448 wfProfileIn( __METHOD__
);
1450 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1451 'rev_text_id', 'rev_len', 'rev_sha1' );
1453 if ( $wgContentHandlerUseDB ) {
1454 $fields[] = 'rev_content_model';
1455 $fields[] = 'rev_content_format';
1458 $current = $dbw->selectRow(
1459 array( 'page', 'revision' ),
1462 'page_id' => $pageId,
1463 'page_latest=rev_id',
1470 'comment' => $summary,
1471 'minor_edit' => $minor,
1472 'text_id' => $current->rev_text_id
,
1473 'parent_id' => $current->page_latest
,
1474 'len' => $current->rev_len
,
1475 'sha1' => $current->rev_sha1
1478 if ( $wgContentHandlerUseDB ) {
1479 $row[ 'content_model' ] = $current->rev_content_model
;
1480 $row[ 'content_format' ] = $current->rev_content_format
;
1483 $revision = new Revision( $row );
1484 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1489 wfProfileOut( __METHOD__
);
1494 * Determine if the current user is allowed to view a particular
1495 * field of this revision, if it's marked as deleted.
1497 * @param $field Integer:one of self::DELETED_TEXT,
1498 * self::DELETED_COMMENT,
1499 * self::DELETED_USER
1500 * @param $user User object to check, or null to use $wgUser
1503 public function userCan( $field, User
$user = null ) {
1504 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1508 * Determine if the current user is allowed to view a particular
1509 * field of this revision, if it's marked as deleted. This is used
1510 * by various classes to avoid duplication.
1512 * @param $bitfield Integer: current field
1513 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1514 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1515 * self::DELETED_USER = File::DELETED_USER
1516 * @param $user User object to check, or null to use $wgUser
1519 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1520 if( $bitfield & $field ) { // aspect is deleted
1521 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1522 $permission = 'suppressrevision';
1523 } elseif ( $field & self
::DELETED_TEXT
) {
1524 $permission = 'deletedtext';
1526 $permission = 'deletedhistory';
1528 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1529 if ( $user === null ) {
1533 return $user->isAllowed( $permission );
1540 * Get rev_timestamp from rev_id, without loading the rest of the row
1542 * @param $title Title
1543 * @param $id Integer
1546 static function getTimestampFromId( $title, $id ) {
1547 $dbr = wfGetDB( DB_SLAVE
);
1548 // Casting fix for DB2
1552 $conds = array( 'rev_id' => $id );
1553 $conds['rev_page'] = $title->getArticleID();
1554 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1555 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1556 # Not in slave, try master
1557 $dbw = wfGetDB( DB_MASTER
);
1558 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1560 return wfTimestamp( TS_MW
, $timestamp );
1564 * Get count of revisions per page...not very efficient
1566 * @param $db DatabaseBase
1567 * @param $id Integer: page id
1570 static function countByPageId( $db, $id ) {
1571 $row = $db->selectRow( 'revision', array( 'revCount' => 'COUNT(*)' ),
1572 array( 'rev_page' => $id ), __METHOD__
);
1574 return $row->revCount
;
1580 * Get count of revisions per page...not very efficient
1582 * @param $db DatabaseBase
1583 * @param $title Title
1586 static function countByTitle( $db, $title ) {
1587 $id = $title->getArticleID();
1589 return self
::countByPageId( $db, $id );
1595 * Check if no edits were made by other users since
1596 * the time a user started editing the page. Limit to
1597 * 50 revisions for the sake of performance.
1601 * @param DatabaseBase|int $db the Database to perform the check on. May be given as a Database object or
1602 * a database identifier usable with wfGetDB.
1603 * @param int $pageId the ID of the page in question
1604 * @param int $userId the ID of the user in question
1605 * @param string $since look at edits since this time
1607 * @return bool True if the given user was the only one to edit since the given timestamp
1609 public static function userWasLastToEdit( $db, $pageId, $userId, $since ) {
1610 if ( !$userId ) return false;
1612 if ( is_int( $db ) ) {
1613 $db = wfGetDB( $db );
1616 $res = $db->select( 'revision',
1619 'rev_page' => $pageId,
1620 'rev_timestamp > ' . $db->addQuotes( $db->timestamp( $since ) )
1623 array( 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => 50 ) );
1624 foreach ( $res as $row ) {
1625 if ( $row->rev_user
!= $userId ) {