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
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 Revision::getText()
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 * @return Revision or null
66 public static function newFromId( $id ) {
67 return Revision
::newFromConds( array( 'rev_id' => intval( $id ) ) );
71 * Load either the current, or a specified, revision
72 * that's attached to a given title. If not attached
73 * to that title, will return null.
76 * @param $id Integer (optional)
77 * @return Revision or null
79 public static function newFromTitle( $title, $id = 0 ) {
81 'page_namespace' => $title->getNamespace(),
82 'page_title' => $title->getDBkey()
85 // Use the specified ID
86 $conds['rev_id'] = $id;
87 } elseif ( wfGetLB()->getServerCount() > 1 ) {
88 // Get the latest revision ID from the master
89 $dbw = wfGetDB( DB_MASTER
);
90 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
91 if ( $latest === false ) {
92 return null; // page does not exist
94 $conds['rev_id'] = $latest;
96 // Use a join to get the latest revision
97 $conds[] = 'rev_id=page_latest';
99 return Revision
::newFromConds( $conds );
103 * Load either the current, or a specified, revision
104 * that's attached to a given page ID.
105 * Returns null if no such revision can be found.
107 * @param $revId Integer
108 * @param $pageId Integer (optional)
109 * @return Revision or null
111 public static function newFromPageId( $pageId, $revId = 0 ) {
112 $conds = array( 'page_id' => $pageId );
114 $conds['rev_id'] = $revId;
115 } elseif ( wfGetLB()->getServerCount() > 1 ) {
116 // Get the latest revision ID from the master
117 $dbw = wfGetDB( DB_MASTER
);
118 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
119 if ( $latest === false ) {
120 return null; // page does not exist
122 $conds['rev_id'] = $latest;
124 $conds[] = 'rev_id = page_latest';
126 return Revision
::newFromConds( $conds );
130 * Make a fake revision object from an archive table row. This is queried
131 * for permissions or even inserted (as in Special:Undelete)
132 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
135 * @param $overrides array
139 public static function newFromArchiveRow( $row, $overrides = array() ) {
140 global $wgContentHandlerUseDB;
142 $attribs = $overrides +
array(
143 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
144 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
145 'comment' => $row->ar_comment
,
146 'user' => $row->ar_user
,
147 'user_text' => $row->ar_user_text
,
148 'timestamp' => $row->ar_timestamp
,
149 'minor_edit' => $row->ar_minor_edit
,
150 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
151 'deleted' => $row->ar_deleted
,
152 'len' => $row->ar_len
,
153 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
154 'content_model' => isset( $row->ar_content_model
) ?
$row->ar_content_model
: null,
155 'content_format' => isset( $row->ar_content_format
) ?
$row->ar_content_format
: null,
158 if ( !$wgContentHandlerUseDB ) {
159 unset( $attribs['content_model'] );
160 unset( $attribs['content_format'] );
163 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
164 // Pre-1.5 ar_text row
165 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
166 if ( $attribs['text'] === false ) {
167 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
170 return new self( $attribs );
179 public static function newFromRow( $row ) {
180 return new self( $row );
184 * Load a page revision from a given revision ID number.
185 * Returns null if no such revision can be found.
187 * @param $db DatabaseBase
189 * @return Revision or null
191 public static function loadFromId( $db, $id ) {
192 return Revision
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
196 * Load either the current, or a specified, revision
197 * that's attached to a given page. If not attached
198 * to that page, will return null.
200 * @param $db DatabaseBase
201 * @param $pageid Integer
203 * @return Revision or null
205 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
206 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
208 $conds['rev_id'] = intval( $id );
210 $conds[] = 'rev_id=page_latest';
212 return Revision
::loadFromConds( $db, $conds );
216 * Load either the current, or a specified, revision
217 * that's attached to a given page. If not attached
218 * to that page, will return null.
220 * @param $db DatabaseBase
221 * @param $title Title
223 * @return Revision or null
225 public static function loadFromTitle( $db, $title, $id = 0 ) {
227 $matchId = intval( $id );
229 $matchId = 'page_latest';
231 return Revision
::loadFromConds( $db,
232 array( "rev_id=$matchId",
233 'page_namespace' => $title->getNamespace(),
234 'page_title' => $title->getDBkey() )
239 * Load the revision for the given title with the given timestamp.
240 * WARNING: Timestamps may in some circumstances not be unique,
241 * so this isn't the best key to use.
243 * @param $db DatabaseBase
244 * @param $title Title
245 * @param $timestamp String
246 * @return Revision or null
248 public static function loadFromTimestamp( $db, $title, $timestamp ) {
249 return Revision
::loadFromConds( $db,
250 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
251 'page_namespace' => $title->getNamespace(),
252 'page_title' => $title->getDBkey() )
257 * Given a set of conditions, fetch a revision.
259 * @param $conditions Array
260 * @return Revision or null
262 public static function newFromConds( $conditions ) {
263 $db = wfGetDB( DB_SLAVE
);
264 $rev = Revision
::loadFromConds( $db, $conditions );
265 if( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
266 $dbw = wfGetDB( DB_MASTER
);
267 $rev = Revision
::loadFromConds( $dbw, $conditions );
273 * Given a set of conditions, fetch a revision from
274 * the given database connection.
276 * @param $db DatabaseBase
277 * @param $conditions Array
278 * @return Revision or null
280 private static function loadFromConds( $db, $conditions ) {
281 $res = Revision
::fetchFromConds( $db, $conditions );
283 $row = $res->fetchObject();
285 $ret = new Revision( $row );
294 * Return a wrapper for a series of database rows to
295 * fetch all of a given page's revisions in turn.
296 * Each row can be fed to the constructor to get objects.
298 * @param $title Title
299 * @return ResultWrapper
301 public static function fetchRevision( $title ) {
302 return Revision
::fetchFromConds(
304 array( 'rev_id=page_latest',
305 'page_namespace' => $title->getNamespace(),
306 'page_title' => $title->getDBkey() )
311 * Given a set of conditions, return a ResultWrapper
312 * which will return matching database rows with the
313 * fields necessary to build Revision objects.
315 * @param $db DatabaseBase
316 * @param $conditions Array
317 * @return ResultWrapper
319 private static function fetchFromConds( $db, $conditions ) {
320 $fields = array_merge(
321 self
::selectFields(),
322 self
::selectPageFields(),
323 self
::selectUserFields()
326 array( 'revision', 'page', 'user' ),
330 array( 'LIMIT' => 1 ),
331 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
336 * Return the value of a select() JOIN conds array for the user table.
337 * This will get user table rows for logged-in users.
341 public static function userJoinCond() {
342 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
346 * Return the value of a select() page conds array for the paeg table.
347 * This will assure that the revision(s) are not orphaned from live pages.
351 public static function pageJoinCond() {
352 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
356 * Return the list of revision fields that should be selected to create
360 public static function selectFields() {
361 global $wgContentHandlerUseDB;
378 if ( $wgContentHandlerUseDB ) {
379 $fields[] = 'rev_content_format';
380 $fields[] = 'rev_content_model';
387 * Return the list of text fields that should be selected to read the
391 public static function selectTextFields() {
399 * Return the list of page fields that should be selected from page table
402 public static function selectPageFields() {
414 * Return the list of user fields that should be selected from user table
417 public static function selectUserFields() {
418 return array( 'user_name' );
424 * @param $row Mixed: either a database row or an array
427 function __construct( $row ) {
428 if( is_object( $row ) ) {
429 $this->mId
= intval( $row->rev_id
);
430 $this->mPage
= intval( $row->rev_page
);
431 $this->mTextId
= intval( $row->rev_text_id
);
432 $this->mComment
= $row->rev_comment
;
433 $this->mUser
= intval( $row->rev_user
);
434 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
435 $this->mTimestamp
= $row->rev_timestamp
;
436 $this->mDeleted
= intval( $row->rev_deleted
);
438 if( !isset( $row->rev_parent_id
) ) {
439 $this->mParentId
= is_null( $row->rev_parent_id
) ?
null : 0;
441 $this->mParentId
= intval( $row->rev_parent_id
);
444 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) ) {
447 $this->mSize
= intval( $row->rev_len
);
450 if ( !isset( $row->rev_sha1
) ) {
453 $this->mSha1
= $row->rev_sha1
;
456 if( isset( $row->page_latest
) ) {
457 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
458 $this->mTitle
= Title
::newFromRow( $row );
460 $this->mCurrent
= false;
461 $this->mTitle
= null;
464 if( !isset( $row->rev_content_model
) ||
is_null( $row->rev_content_model
) ) {
465 $this->mContentModel
= null; # determine on demand if needed
467 $this->mContentModel
= intval( $row->rev_content_model
);
470 if( !isset( $row->rev_content_format
) ||
is_null( $row->rev_content_format
) ) {
471 $this->mContentFormat
= null; # determine on demand if needed
473 $this->mContentFormat
= intval( $row->rev_content_format
);
476 // Lazy extraction...
478 if( isset( $row->old_text
) ) {
479 $this->mTextRow
= $row;
481 // 'text' table row entry will be lazy-loaded
482 $this->mTextRow
= null;
485 // Use user_name for users and rev_user_text for IPs...
486 $this->mUserText
= null; // lazy load if left null
487 if ( $this->mUser
== 0 ) {
488 $this->mUserText
= $row->rev_user_text
; // IP user
489 } elseif ( isset( $row->user_name
) ) {
490 $this->mUserText
= $row->user_name
; // logged-in user
492 $this->mOrigUserText
= $row->rev_user_text
;
493 } elseif( is_array( $row ) ) {
494 // Build a new revision to be saved...
495 global $wgUser; // ugh
498 # if we have a content object, use it to set the model and type
499 if ( !empty( $row['content'] ) ) {
500 if ( !empty( $row['text_id'] ) ) { #FIXME: when is that set? test with external store setup! check out insertOn()
501 throw new MWException( "Text already stored in external store (id {$row['text_id']}), can't serialize content object" );
504 $row['content_model'] = $row['content']->getModel();
505 # note: mContentFormat is initializes later accordingly
506 # note: content is serialized later in this method!
507 # also set text to null?
510 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
511 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
512 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
513 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
514 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
515 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
516 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
517 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
518 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
519 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
520 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
522 $this->mContentModel
= isset( $row['content_model'] ) ?
intval( $row['content_model'] ) : null;
523 $this->mContentFormat
= isset( $row['content_format'] ) ?
intval( $row['content_format'] ) : null;
525 // Enforce spacing trimming on supplied text
526 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
527 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
528 $this->mTextRow
= null;
530 # if we have a content object, override mText and mContentModel
531 if ( !empty( $row['content'] ) ) {
532 $handler = $this->getContentHandler();
533 $this->mContent
= $row['content'];
535 $this->mContentModel
= $this->mContent
->getModel();
536 $this->mContentHandler
= null;
538 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
539 } elseif ( !is_null( $this->mText
) ) {
540 $handler = $this->getContentHandler();
541 $this->mContent
= $handler->unserializeContent( $this->mText
);
544 $this->mTitle
= null; # Load on demand if needed
545 $this->mCurrent
= false; #XXX: really? we are about to create a revision. it will usually then be the current one.
547 # If we still have no length, see it we have the text to figure it out
548 if ( !$this->mSize
) {
549 if ( !is_null( $this->mContent
) ) {
550 $this->mSize
= $this->mContent
->getSize();
552 #XXX: my be inconsistent with the notion of "size" use for the present content model
553 #NOTE: should never happen if we have either text or content object!
554 $this->mSize
= is_null( $this->mText
) ?
null : strlen( $this->mText
);
559 if ( $this->mSha1
=== null ) {
560 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
563 $this->getContentModel(); # force lazy init
564 $this->getContentFormat(); # force lazy init
566 throw new MWException( 'Revision constructor passed invalid row format.' );
568 $this->mUnpatrolled
= null;
570 // @TODO: add support for ar_content_format, ar_content_model, rev_content_format, rev_content_model to API
571 // @TODO: get rid of $mText
577 * @return Integer|null
579 public function getId() {
584 * Set the revision ID
589 public function setId( $id ) {
596 * @return Integer|null
598 public function getTextId() {
599 return $this->mTextId
;
603 * Get parent revision ID (the original previous page revision)
605 * @return Integer|null
607 public function getParentId() {
608 return $this->mParentId
;
612 * Returns the length of the text in this revision, or null if unknown.
614 * @return Integer|null
616 public function getSize() {
621 * Returns the base36 sha1 of the text in this revision, or null if unknown.
623 * @return String|null
625 public function getSha1() {
630 * Returns the title of the page associated with this entry or null.
632 * Will do a query, when title is not set and id is given.
636 public function getTitle() {
637 if( isset( $this->mTitle
) ) {
638 return $this->mTitle
;
640 if( !is_null( $this->mId
) ) { //rev_id is defined as NOT NULL
641 $dbr = wfGetDB( DB_SLAVE
);
642 $row = $dbr->selectRow(
643 array( 'page', 'revision' ),
644 self
::selectPageFields(),
645 array( 'page_id=rev_page',
646 'rev_id' => $this->mId
),
649 $this->mTitle
= Title
::newFromRow( $row );
652 return $this->mTitle
;
656 * Set the title of the revision
658 * @param $title Title
660 public function setTitle( $title ) {
661 $this->mTitle
= $title;
667 * @return Integer|null
669 public function getPage() {
674 * Fetch revision's user id if it's available to the specified audience.
675 * If the specified audience does not have access to it, zero will be
678 * @param $audience Integer: one of:
679 * Revision::FOR_PUBLIC to be displayed to all users
680 * Revision::FOR_THIS_USER to be displayed to the given user
681 * Revision::RAW get the ID regardless of permissions
682 * @param $user User object to check for, only if FOR_THIS_USER is passed
683 * to the $audience parameter
686 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
687 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
689 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
697 * Fetch revision's user id without regard for the current user's permissions
701 public function getRawUser() {
706 * Fetch revision's username if it's available to the specified audience.
707 * If the specified audience does not have access to the username, an
708 * empty string will be returned.
710 * @param $audience Integer: one of:
711 * Revision::FOR_PUBLIC to be displayed to all users
712 * Revision::FOR_THIS_USER to be displayed to the given user
713 * Revision::RAW get the text regardless of permissions
714 * @param $user User object to check for, only if FOR_THIS_USER is passed
715 * to the $audience parameter
718 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
719 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
721 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
724 return $this->getRawUserText();
729 * Fetch revision's username without regard for view restrictions
733 public function getRawUserText() {
734 if ( $this->mUserText
=== null ) {
735 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
736 if ( $this->mUserText
=== false ) {
737 # This shouldn't happen, but it can if the wiki was recovered
738 # via importing revs and there is no user table entry yet.
739 $this->mUserText
= $this->mOrigUserText
;
742 return $this->mUserText
;
746 * Fetch revision comment if it's available to the specified audience.
747 * If the specified audience does not have access to the comment, an
748 * empty string will be returned.
750 * @param $audience Integer: one of:
751 * Revision::FOR_PUBLIC to be displayed to all users
752 * Revision::FOR_THIS_USER to be displayed to the given user
753 * Revision::RAW get the text regardless of permissions
754 * @param $user User object to check for, only if FOR_THIS_USER is passed
755 * to the $audience parameter
758 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
759 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
761 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
764 return $this->mComment
;
769 * Fetch revision comment without regard for the current user's permissions
773 public function getRawComment() {
774 return $this->mComment
;
780 public function isMinor() {
781 return (bool)$this->mMinorEdit
;
785 * @return Integer rcid of the unpatrolled row, zero if there isn't one
787 public function isUnpatrolled() {
788 if( $this->mUnpatrolled
!== null ) {
789 return $this->mUnpatrolled
;
791 $dbr = wfGetDB( DB_SLAVE
);
792 $this->mUnpatrolled
= $dbr->selectField( 'recentchanges',
794 array( // Add redundant user,timestamp condition so we can use the existing index
795 'rc_user_text' => $this->getRawUserText(),
796 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
797 'rc_this_oldid' => $this->getId(),
802 return (int)$this->mUnpatrolled
;
806 * @param $field int one of DELETED_* bitfield constants
810 public function isDeleted( $field ) {
811 return ( $this->mDeleted
& $field ) == $field;
815 * Get the deletion bitfield of the revision
819 public function getVisibility() {
820 return (int)$this->mDeleted
;
824 * Fetch revision text if it's available to the specified audience.
825 * If the specified audience does not have the ability to view this
826 * revision, an empty string will be returned.
828 * @param $audience Integer: one of:
829 * Revision::FOR_PUBLIC to be displayed to all users
830 * Revision::FOR_THIS_USER to be displayed to the given user
831 * Revision::RAW get the text regardless of permissions
832 * @param $user User object to check for, only if FOR_THIS_USER is passed
833 * to the $audience parameter
835 * @deprecated in 1.WD, use getContent() instead
837 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) { #FIXME: deprecated, replace usage! #FIXME: used a LOT!
838 wfDeprecated( __METHOD__
, '1.WD' );
840 $content = $this->getContent();
841 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
845 * Fetch revision content if it's available to the specified audience.
846 * If the specified audience does not have the ability to view this
847 * revision, null will be returned.
849 * @param $audience Integer: one of:
850 * Revision::FOR_PUBLIC to be displayed to all users
851 * Revision::FOR_THIS_USER to be displayed to $wgUser
852 * Revision::RAW get the text regardless of permissions
853 * @param $user User object to check for, only if FOR_THIS_USER is passed
854 * to the $audience parameter
859 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
860 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
862 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
865 return $this->getContentInternal();
870 * Alias for getText(Revision::FOR_THIS_USER)
872 * @deprecated since 1.17
875 public function revText() {
876 wfDeprecated( __METHOD__
, '1.17' );
877 return $this->getText( self
::FOR_THIS_USER
);
881 * Fetch revision text without regard for view restrictions
885 public function getRawText() { #FIXME: deprecated, replace usage!
886 return $this->getText( self
::RAW
);
889 protected function getContentInternal() {
890 if( is_null( $this->mContent
) ) {
891 // Revision is immutable. Load on demand:
893 $handler = $this->getContentHandler();
894 $format = $this->getContentFormat();
895 $title = $this->getTitle();
897 if( is_null( $this->mText
) ) {
898 // Load text on demand:
899 $this->mText
= $this->loadText();
902 $this->mContent
= is_null( $this->mText
) ?
null : $handler->unserializeContent( $this->mText
, $format );
905 return $this->mContent
;
909 * Returns the content model for this revision.
911 * If no content model was stored in the database, $this->getTitle()->getContentModel() is
912 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
913 * is used as a last resort.
915 * @return int the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
917 public function getContentModel() {
918 if ( !$this->mContentModel
) {
919 $title = $this->getTitle();
920 $this->mContentModel
= ( $title ?
$title->getContentModel() : CONTENT_MODEL_WIKITEXT
);
922 assert( !empty( $this->mContentModel
) );
925 return $this->mContentModel
;
929 * Returns the content format for this revision.
931 * If no content format was stored in the database, the default format for this
932 * revision's content model is returned.
934 * @return int the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
936 public function getContentFormat() {
937 if ( !$this->mContentFormat
) {
938 $handler = $this->getContentHandler();
939 $this->mContentFormat
= $handler->getDefaultFormat();
941 assert( !empty( $this->mContentFormat
) );
944 return $this->mContentFormat
;
948 * Returns the content handler appropriate for this revision's content model.
950 * @return ContentHandler
952 public function getContentHandler() {
953 if ( !$this->mContentHandler
) {
954 $model = $this->getContentModel();
955 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
957 assert( $this->mContentHandler
->isSupportedFormat( $this->getContentFormat() ) );
960 return $this->mContentHandler
;
966 public function getTimestamp() {
967 return wfTimestamp( TS_MW
, $this->mTimestamp
);
973 public function isCurrent() {
974 return $this->mCurrent
;
978 * Get previous revision for this title
980 * @return Revision or null
982 public function getPrevious() {
983 if( $this->getTitle() ) {
984 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
986 return Revision
::newFromTitle( $this->getTitle(), $prev );
993 * Get next revision for this title
995 * @return Revision or null
997 public function getNext() {
998 if( $this->getTitle() ) {
999 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
1001 return Revision
::newFromTitle( $this->getTitle(), $next );
1008 * Get previous revision Id for this page_id
1009 * This is used to populate rev_parent_id on save
1011 * @param $db DatabaseBase
1014 private function getPreviousRevisionId( $db ) {
1015 if( is_null( $this->mPage
) ) {
1018 # Use page_latest if ID is not given
1020 $prevId = $db->selectField( 'page', 'page_latest',
1021 array( 'page_id' => $this->mPage
),
1024 $prevId = $db->selectField( 'revision', 'rev_id',
1025 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
1027 array( 'ORDER BY' => 'rev_id DESC' ) );
1029 return intval( $prevId );
1033 * Get revision text associated with an old or archive row
1034 * $row is usually an object from wfFetchRow(), both the flags and the text
1035 * field must be included
1037 * @param $row Object: the text data
1038 * @param $prefix String: table prefix (default 'old_')
1039 * @return String: text the text requested or false on failure
1041 public static function getRevisionText( $row, $prefix = 'old_' ) {
1042 wfProfileIn( __METHOD__
);
1045 $textField = $prefix . 'text';
1046 $flagsField = $prefix . 'flags';
1048 if( isset( $row->$flagsField ) ) {
1049 $flags = explode( ',', $row->$flagsField );
1054 if( isset( $row->$textField ) ) {
1055 $text = $row->$textField;
1057 wfProfileOut( __METHOD__
);
1061 # Use external methods for external objects, text in table is URL-only then
1062 if ( in_array( 'external', $flags ) ) {
1064 $parts = explode( '://', $url, 2 );
1065 if( count( $parts ) == 1 ||
$parts[1] == '' ) {
1066 wfProfileOut( __METHOD__
);
1069 $text = ExternalStore
::fetchFromURL( $url );
1072 // If the text was fetched without an error, convert it
1073 if ( $text !== false ) {
1074 if( in_array( 'gzip', $flags ) ) {
1075 # Deal with optional compression of archived pages.
1076 # This can be done periodically via maintenance/compressOld.php, and
1077 # as pages are saved if $wgCompressRevisions is set.
1078 $text = gzinflate( $text );
1081 if( in_array( 'object', $flags ) ) {
1082 # Generic compressed storage
1083 $obj = unserialize( $text );
1084 if ( !is_object( $obj ) ) {
1086 wfProfileOut( __METHOD__
);
1089 $text = $obj->getText();
1092 global $wgLegacyEncoding;
1093 if( $text !== false && $wgLegacyEncoding
1094 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
1096 # Old revisions kept around in a legacy encoding?
1097 # Upconvert on demand.
1098 # ("utf8" checked for compatibility with some broken
1099 # conversion scripts 2008-12-30)
1101 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1104 wfProfileOut( __METHOD__
);
1109 * If $wgCompressRevisions is enabled, we will compress data.
1110 * The input string is modified in place.
1111 * Return value is the flags field: contains 'gzip' if the
1112 * data is compressed, and 'utf-8' if we're saving in UTF-8
1115 * @param $text Mixed: reference to a text
1118 public static function compressRevisionText( &$text ) {
1119 global $wgCompressRevisions;
1122 # Revisions not marked this way will be converted
1123 # on load if $wgLegacyCharset is set in the future.
1126 if( $wgCompressRevisions ) {
1127 if( function_exists( 'gzdeflate' ) ) {
1128 $text = gzdeflate( $text );
1131 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
1134 return implode( ',', $flags );
1138 * Insert a new revision into the database, returning the new revision ID
1139 * number on success and dies horribly on failure.
1141 * @param $dbw DatabaseBase: (master connection)
1144 public function insertOn( $dbw ) {
1145 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1147 wfProfileIn( __METHOD__
);
1149 $data = $this->mText
;
1150 $flags = Revision
::compressRevisionText( $data );
1152 # Write to external storage if required
1153 if( $wgDefaultExternalStore ) {
1154 // Store and get the URL
1155 $data = ExternalStore
::insertToDefault( $data );
1157 throw new MWException( "Unable to store text to external storage" );
1162 $flags .= 'external';
1165 # Record the text (or external storage URL) to the text table
1166 if( !isset( $this->mTextId
) ) {
1167 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1168 $dbw->insert( 'text',
1170 'old_id' => $old_id,
1171 'old_text' => $data,
1172 'old_flags' => $flags,
1175 $this->mTextId
= $dbw->insertId();
1178 if ( $this->mComment
=== null ) $this->mComment
= "";
1180 # Record the edit in revisions
1181 $rev_id = isset( $this->mId
)
1183 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1186 'rev_id' => $rev_id,
1187 'rev_page' => $this->mPage
,
1188 'rev_text_id' => $this->mTextId
,
1189 'rev_comment' => $this->mComment
,
1190 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1191 'rev_user' => $this->mUser
,
1192 'rev_user_text' => $this->mUserText
,
1193 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1194 'rev_deleted' => $this->mDeleted
,
1195 'rev_len' => $this->mSize
,
1196 'rev_parent_id' => is_null( $this->mParentId
)
1197 ?
$this->getPreviousRevisionId( $dbw )
1199 'rev_sha1' => is_null( $this->mSha1
)
1200 ? Revision
::base36Sha1( $this->mText
)
1204 if ( $wgContentHandlerUseDB ) {
1205 $row[ 'rev_content_model' ] = $this->getContentModel();
1206 $row[ 'rev_content_format' ] = $this->getContentFormat();
1209 $dbw->insert( 'revision', $row, __METHOD__
);
1211 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1213 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1215 wfProfileOut( __METHOD__
);
1220 * Get the base 36 SHA-1 value for a string of text
1221 * @param $text String
1224 public static function base36Sha1( $text ) {
1225 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1229 * Lazy-load the revision's text.
1230 * Currently hardcoded to the 'text' table storage engine.
1234 protected function loadText() {
1235 wfProfileIn( __METHOD__
);
1237 // Caching may be beneficial for massive use of external storage
1238 global $wgRevisionCacheExpiry, $wgMemc;
1239 $textId = $this->getTextId();
1240 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1241 if( $wgRevisionCacheExpiry ) {
1242 $text = $wgMemc->get( $key );
1243 if( is_string( $text ) ) {
1244 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1245 wfProfileOut( __METHOD__
);
1250 // If we kept data for lazy extraction, use it now...
1251 if ( isset( $this->mTextRow
) ) {
1252 $row = $this->mTextRow
;
1253 $this->mTextRow
= null;
1259 // Text data is immutable; check slaves first.
1260 $dbr = wfGetDB( DB_SLAVE
);
1261 $row = $dbr->selectRow( 'text',
1262 array( 'old_text', 'old_flags' ),
1263 array( 'old_id' => $this->getTextId() ),
1267 if( !$row && wfGetLB()->getServerCount() > 1 ) {
1268 // Possible slave lag!
1269 $dbw = wfGetDB( DB_MASTER
);
1270 $row = $dbw->selectRow( 'text',
1271 array( 'old_text', 'old_flags' ),
1272 array( 'old_id' => $this->getTextId() ),
1276 $text = self
::getRevisionText( $row );
1278 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1279 if( $wgRevisionCacheExpiry && $text !== false ) {
1280 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1283 wfProfileOut( __METHOD__
);
1289 * Create a new null-revision for insertion into a page's
1290 * history. This will not re-save the text, but simply refer
1291 * to the text from the previous version.
1293 * Such revisions can for instance identify page rename
1294 * operations and other such meta-modifications.
1296 * @param $dbw DatabaseBase
1297 * @param $pageId Integer: ID number of the page to read from
1298 * @param $summary String: revision's summary
1299 * @param $minor Boolean: whether the revision should be considered as minor
1300 * @return Revision|null on error
1302 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1303 global $wgContentHandlerUseDB;
1305 wfProfileIn( __METHOD__
);
1307 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1308 'rev_text_id', 'rev_len', 'rev_sha1' );
1310 if ( $wgContentHandlerUseDB ) {
1311 $fields[] = 'rev_content_model';
1312 $fields[] = 'rev_content_format';
1315 $current = $dbw->selectRow(
1316 array( 'page', 'revision' ),
1319 'page_id' => $pageId,
1320 'page_latest=rev_id',
1327 'comment' => $summary,
1328 'minor_edit' => $minor,
1329 'text_id' => $current->rev_text_id
,
1330 'parent_id' => $current->page_latest
,
1331 'len' => $current->rev_len
,
1332 'sha1' => $current->rev_sha1
1335 if ( $wgContentHandlerUseDB ) {
1336 $row[ 'content_model' ] = $current->rev_content_model
;
1337 $row[ 'content_format' ] = $current->rev_content_format
;
1340 $revision = new Revision( $row );
1341 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1346 wfProfileOut( __METHOD__
);
1351 * Determine if the current user is allowed to view a particular
1352 * field of this revision, if it's marked as deleted.
1354 * @param $field Integer:one of self::DELETED_TEXT,
1355 * self::DELETED_COMMENT,
1356 * self::DELETED_USER
1357 * @param $user User object to check, or null to use $wgUser
1360 public function userCan( $field, User
$user = null ) {
1361 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1365 * Determine if the current user is allowed to view a particular
1366 * field of this revision, if it's marked as deleted. This is used
1367 * by various classes to avoid duplication.
1369 * @param $bitfield Integer: current field
1370 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1371 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1372 * self::DELETED_USER = File::DELETED_USER
1373 * @param $user User object to check, or null to use $wgUser
1376 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1377 if( $bitfield & $field ) { // aspect is deleted
1378 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1379 $permission = 'suppressrevision';
1380 } elseif ( $field & self
::DELETED_TEXT
) {
1381 $permission = 'deletedtext';
1383 $permission = 'deletedhistory';
1385 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1386 if ( $user === null ) {
1390 return $user->isAllowed( $permission );
1397 * Get rev_timestamp from rev_id, without loading the rest of the row
1399 * @param $title Title
1400 * @param $id Integer
1403 static function getTimestampFromId( $title, $id ) {
1404 $dbr = wfGetDB( DB_SLAVE
);
1405 // Casting fix for DB2
1409 $conds = array( 'rev_id' => $id );
1410 $conds['rev_page'] = $title->getArticleID();
1411 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1412 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1413 # Not in slave, try master
1414 $dbw = wfGetDB( DB_MASTER
);
1415 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1417 return wfTimestamp( TS_MW
, $timestamp );
1421 * Get count of revisions per page...not very efficient
1423 * @param $db DatabaseBase
1424 * @param $id Integer: page id
1427 static function countByPageId( $db, $id ) {
1428 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
1429 array( 'rev_page' => $id ), __METHOD__
);
1431 return $row->revCount
;
1437 * Get count of revisions per page...not very efficient
1439 * @param $db DatabaseBase
1440 * @param $title Title
1443 static function countByTitle( $db, $title ) {
1444 $id = $title->getArticleID();
1446 return Revision
::countByPageId( $db, $id );