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() {
412 * Return the list of user fields that should be selected from user table
415 public static function selectUserFields() {
416 return array( 'user_name' );
422 * @param $row Mixed: either a database row or an array
425 function __construct( $row ) {
426 if( is_object( $row ) ) {
427 $this->mId
= intval( $row->rev_id
);
428 $this->mPage
= intval( $row->rev_page
);
429 $this->mTextId
= intval( $row->rev_text_id
);
430 $this->mComment
= $row->rev_comment
;
431 $this->mUser
= intval( $row->rev_user
);
432 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
433 $this->mTimestamp
= $row->rev_timestamp
;
434 $this->mDeleted
= intval( $row->rev_deleted
);
436 if( !isset( $row->rev_parent_id
) ) {
437 $this->mParentId
= is_null( $row->rev_parent_id
) ?
null : 0;
439 $this->mParentId
= intval( $row->rev_parent_id
);
442 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) ) {
445 $this->mSize
= intval( $row->rev_len
);
448 if ( !isset( $row->rev_sha1
) ) {
451 $this->mSha1
= $row->rev_sha1
;
454 if( isset( $row->page_latest
) ) {
455 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
456 $this->mTitle
= Title
::newFromRow( $row );
458 $this->mCurrent
= false;
459 $this->mTitle
= null;
462 if( !isset( $row->rev_content_model
) ||
is_null( $row->rev_content_model
) ) {
463 $this->mContentModel
= null; # determine on demand if needed
465 $this->mContentModel
= intval( $row->rev_content_model
);
468 if( !isset( $row->rev_content_format
) ||
is_null( $row->rev_content_format
) ) {
469 $this->mContentFormat
= null; # determine on demand if needed
471 $this->mContentFormat
= intval( $row->rev_content_format
);
474 // Lazy extraction...
476 if( isset( $row->old_text
) ) {
477 $this->mTextRow
= $row;
479 // 'text' table row entry will be lazy-loaded
480 $this->mTextRow
= null;
483 // Use user_name for users and rev_user_text for IPs...
484 $this->mUserText
= null; // lazy load if left null
485 if ( $this->mUser
== 0 ) {
486 $this->mUserText
= $row->rev_user_text
; // IP user
487 } elseif ( isset( $row->user_name
) ) {
488 $this->mUserText
= $row->user_name
; // logged-in user
490 $this->mOrigUserText
= $row->rev_user_text
;
491 } elseif( is_array( $row ) ) {
492 // Build a new revision to be saved...
493 global $wgUser; // ugh
496 # if we have a content object, use it to set the model and type
497 if ( !empty( $row['content'] ) ) {
498 if ( !empty( $row['text_id'] ) ) { #FIXME: when is that set? test with external store setup! check out insertOn()
499 throw new MWException( "Text already stored in external store (id {$row['text_id']}), can't serialize content object" );
502 $row['content_model'] = $row['content']->getModel();
503 # note: mContentFormat is initializes later accordingly
504 # note: content is serialized later in this method!
505 # also set text to null?
508 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
509 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
510 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
511 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
512 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
513 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
514 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
515 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
516 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
517 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
518 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
520 $this->mContentModel
= isset( $row['content_model'] ) ?
intval( $row['content_model'] ) : null;
521 $this->mContentFormat
= isset( $row['content_format'] ) ?
intval( $row['content_format'] ) : null;
523 // Enforce spacing trimming on supplied text
524 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
525 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
526 $this->mTextRow
= null;
528 # if we have a content object, override mText and mContentModel
529 if ( !empty( $row['content'] ) ) {
530 $handler = $this->getContentHandler();
531 $this->mContent
= $row['content'];
533 $this->mContentModel
= $this->mContent
->getModel();
534 $this->mContentHandler
= null;
536 $this->mText
= $handler->serializeContent( $row['content'], $this->getContentFormat() );
537 } elseif ( !is_null( $this->mText
) ) {
538 $handler = $this->getContentHandler();
539 $this->mContent
= $handler->unserializeContent( $this->mText
);
542 $this->mTitle
= null; # Load on demand if needed
543 $this->mCurrent
= false; #XXX: really? we are about to create a revision. it will usually then be the current one.
545 # If we still have no length, see it we have the text to figure it out
546 if ( !$this->mSize
) {
547 if ( !is_null( $this->mContent
) ) {
548 $this->mSize
= $this->mContent
->getSize();
550 #XXX: my be inconsistent with the notion of "size" use for the present content model
551 #NOTE: should never happen if we have either text or content object!
552 $this->mSize
= is_null( $this->mText
) ?
null : strlen( $this->mText
);
557 if ( $this->mSha1
=== null ) {
558 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
561 $this->getContentModel(); # force lazy init
562 $this->getContentFormat(); # force lazy init
564 throw new MWException( 'Revision constructor passed invalid row format.' );
566 $this->mUnpatrolled
= null;
568 // @TODO: add support for ar_content_format, ar_content_model, rev_content_format, rev_content_model to API
569 // @TODO: get rid of $mText
577 public function getId() {
582 * Set the revision ID
587 public function setId( $id ) {
596 public function getTextId() {
597 return $this->mTextId
;
601 * Get parent revision ID (the original previous page revision)
603 * @return Integer|null
605 public function getParentId() {
606 return $this->mParentId
;
610 * Returns the length of the text in this revision, or null if unknown.
614 public function getSize() {
619 * Returns the base36 sha1 of the text in this revision, or null if unknown.
623 public function getSha1() {
628 * Returns the title of the page associated with this entry.
632 public function getTitle() {
633 if( isset( $this->mTitle
) ) {
634 return $this->mTitle
;
636 $dbr = wfGetDB( DB_SLAVE
);
637 $row = $dbr->selectRow(
638 array( 'page', 'revision' ),
639 self
::selectPageFields(),
640 array( 'page_id=rev_page',
641 'rev_id' => $this->mId
),
644 $this->mTitle
= Title
::newFromRow( $row );
646 return $this->mTitle
;
650 * Set the title of the revision
652 * @param $title Title
654 public function setTitle( $title ) {
655 $this->mTitle
= $title;
663 public function getPage() {
668 * Fetch revision's user id if it's available to the specified audience.
669 * If the specified audience does not have access to it, zero will be
672 * @param $audience Integer: one of:
673 * Revision::FOR_PUBLIC to be displayed to all users
674 * Revision::FOR_THIS_USER to be displayed to $wgUser
675 * Revision::RAW get the ID regardless of permissions
676 * @param $user User object to check for, only if FOR_THIS_USER is passed
677 * to the $audience parameter
680 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
681 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
683 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
691 * Fetch revision's user id without regard for the current user's permissions
695 public function getRawUser() {
700 * Fetch revision's username if it's available to the specified audience.
701 * If the specified audience does not have access to the username, an
702 * empty string will be returned.
704 * @param $audience Integer: one of:
705 * Revision::FOR_PUBLIC to be displayed to all users
706 * Revision::FOR_THIS_USER to be displayed to $wgUser
707 * Revision::RAW get the text regardless of permissions
708 * @param $user User object to check for, only if FOR_THIS_USER is passed
709 * to the $audience parameter
712 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
713 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
715 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
718 return $this->getRawUserText();
723 * Fetch revision's username without regard for view restrictions
727 public function getRawUserText() {
728 if ( $this->mUserText
=== null ) {
729 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
730 if ( $this->mUserText
=== false ) {
731 # This shouldn't happen, but it can if the wiki was recovered
732 # via importing revs and there is no user table entry yet.
733 $this->mUserText
= $this->mOrigUserText
;
736 return $this->mUserText
;
740 * Fetch revision comment if it's available to the specified audience.
741 * If the specified audience does not have access to the comment, an
742 * empty string will be returned.
744 * @param $audience Integer: one of:
745 * Revision::FOR_PUBLIC to be displayed to all users
746 * Revision::FOR_THIS_USER to be displayed to $wgUser
747 * Revision::RAW get the text regardless of permissions
748 * @param $user User object to check for, only if FOR_THIS_USER is passed
749 * to the $audience parameter
752 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
753 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
755 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
758 return $this->mComment
;
763 * Fetch revision comment without regard for the current user's permissions
767 public function getRawComment() {
768 return $this->mComment
;
774 public function isMinor() {
775 return (bool)$this->mMinorEdit
;
779 * @return Integer rcid of the unpatrolled row, zero if there isn't one
781 public function isUnpatrolled() {
782 if( $this->mUnpatrolled
!== null ) {
783 return $this->mUnpatrolled
;
785 $dbr = wfGetDB( DB_SLAVE
);
786 $this->mUnpatrolled
= $dbr->selectField( 'recentchanges',
788 array( // Add redundant user,timestamp condition so we can use the existing index
789 'rc_user_text' => $this->getRawUserText(),
790 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
791 'rc_this_oldid' => $this->getId(),
796 return (int)$this->mUnpatrolled
;
800 * @param $field int one of DELETED_* bitfield constants
804 public function isDeleted( $field ) {
805 return ( $this->mDeleted
& $field ) == $field;
809 * Get the deletion bitfield of the revision
813 public function getVisibility() {
814 return (int)$this->mDeleted
;
818 * Fetch revision text if it's available to the specified audience.
819 * If the specified audience does not have the ability to view this
820 * revision, an empty string will be returned.
822 * @param $audience Integer: one of:
823 * Revision::FOR_PUBLIC to be displayed to all users
824 * Revision::FOR_THIS_USER to be displayed to $wgUser
825 * Revision::RAW get the text regardless of permissions
826 * @param $user User object to check for, only if FOR_THIS_USER is passed
827 * to the $audience parameter
829 * @deprecated in 1.WD, use getContent() instead
831 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) { #FIXME: deprecated, replace usage! #FIXME: used a LOT!
832 wfDeprecated( __METHOD__
, '1.WD' );
834 $content = $this->getContent();
835 return ContentHandler
::getContentText( $content ); # returns the raw content text, if applicable
839 * Fetch revision content if it's available to the specified audience.
840 * If the specified audience does not have the ability to view this
841 * revision, null will be returned.
843 * @param $audience Integer: one of:
844 * Revision::FOR_PUBLIC to be displayed to all users
845 * Revision::FOR_THIS_USER to be displayed to $wgUser
846 * Revision::RAW get the text regardless of permissions
847 * @param $user User object to check for, only if FOR_THIS_USER is passed
848 * to the $audience parameter
853 public function getContent( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
854 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
856 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
859 return $this->getContentInternal();
864 * Alias for getText(Revision::FOR_THIS_USER)
866 * @deprecated since 1.17
869 public function revText() {
870 wfDeprecated( __METHOD__
, '1.17' );
871 return $this->getText( self
::FOR_THIS_USER
);
875 * Fetch revision text without regard for view restrictions
879 public function getRawText() { #FIXME: deprecated, replace usage!
880 return $this->getText( self
::RAW
);
883 protected function getContentInternal() {
884 if( is_null( $this->mContent
) ) {
885 // Revision is immutable. Load on demand:
887 $handler = $this->getContentHandler();
888 $format = $this->getContentFormat();
889 $title = $this->getTitle();
891 if( is_null( $this->mText
) ) {
892 // Load text on demand:
893 $this->mText
= $this->loadText();
896 $this->mContent
= is_null( $this->mText
) ?
null : $handler->unserializeContent( $this->mText
, $format );
899 return $this->mContent
;
903 * Returns the content model for this revision.
905 * If no content model was stored in the database, $this->getTitle()->getContentModel() is
906 * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
907 * is used as a last resort.
909 * @return int the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
911 public function getContentModel() {
912 if ( !$this->mContentModel
) {
913 $title = $this->getTitle();
914 $this->mContentModel
= ( $title ?
$title->getContentModel() : CONTENT_MODEL_WIKITEXT
);
916 assert( !empty( $this->mContentModel
) );
919 return $this->mContentModel
;
923 * Returns the content format for this revision.
925 * If no content format was stored in the database, the default format for this
926 * revision's content model is returned.
928 * @return int the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
930 public function getContentFormat() {
931 if ( !$this->mContentFormat
) {
932 $handler = $this->getContentHandler();
933 $this->mContentFormat
= $handler->getDefaultFormat();
935 assert( !empty( $this->mContentFormat
) );
938 return $this->mContentFormat
;
942 * Returns the content handler appropriate for this revision's content model.
944 * @return ContentHandler
946 public function getContentHandler() {
947 if ( !$this->mContentHandler
) {
948 $model = $this->getContentModel();
949 $this->mContentHandler
= ContentHandler
::getForModelID( $model );
951 assert( $this->mContentHandler
->isSupportedFormat( $this->getContentFormat() ) );
954 return $this->mContentHandler
;
960 public function getTimestamp() {
961 return wfTimestamp( TS_MW
, $this->mTimestamp
);
967 public function isCurrent() {
968 return $this->mCurrent
;
972 * Get previous revision for this title
974 * @return Revision or null
976 public function getPrevious() {
977 if( $this->getTitle() ) {
978 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
980 return Revision
::newFromTitle( $this->getTitle(), $prev );
987 * Get next revision for this title
989 * @return Revision or null
991 public function getNext() {
992 if( $this->getTitle() ) {
993 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
995 return Revision
::newFromTitle( $this->getTitle(), $next );
1002 * Get previous revision Id for this page_id
1003 * This is used to populate rev_parent_id on save
1005 * @param $db DatabaseBase
1008 private function getPreviousRevisionId( $db ) {
1009 if( is_null( $this->mPage
) ) {
1012 # Use page_latest if ID is not given
1014 $prevId = $db->selectField( 'page', 'page_latest',
1015 array( 'page_id' => $this->mPage
),
1018 $prevId = $db->selectField( 'revision', 'rev_id',
1019 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
1021 array( 'ORDER BY' => 'rev_id DESC' ) );
1023 return intval( $prevId );
1027 * Get revision text associated with an old or archive row
1028 * $row is usually an object from wfFetchRow(), both the flags and the text
1029 * field must be included
1031 * @param $row Object: the text data
1032 * @param $prefix String: table prefix (default 'old_')
1033 * @return String: text the text requested or false on failure
1035 public static function getRevisionText( $row, $prefix = 'old_' ) {
1036 wfProfileIn( __METHOD__
);
1039 $textField = $prefix . 'text';
1040 $flagsField = $prefix . 'flags';
1042 if( isset( $row->$flagsField ) ) {
1043 $flags = explode( ',', $row->$flagsField );
1048 if( isset( $row->$textField ) ) {
1049 $text = $row->$textField;
1051 wfProfileOut( __METHOD__
);
1055 # Use external methods for external objects, text in table is URL-only then
1056 if ( in_array( 'external', $flags ) ) {
1058 $parts = explode( '://', $url, 2 );
1059 if( count( $parts ) == 1 ||
$parts[1] == '' ) {
1060 wfProfileOut( __METHOD__
);
1063 $text = ExternalStore
::fetchFromURL( $url );
1066 // If the text was fetched without an error, convert it
1067 if ( $text !== false ) {
1068 if( in_array( 'gzip', $flags ) ) {
1069 # Deal with optional compression of archived pages.
1070 # This can be done periodically via maintenance/compressOld.php, and
1071 # as pages are saved if $wgCompressRevisions is set.
1072 $text = gzinflate( $text );
1075 if( in_array( 'object', $flags ) ) {
1076 # Generic compressed storage
1077 $obj = unserialize( $text );
1078 if ( !is_object( $obj ) ) {
1080 wfProfileOut( __METHOD__
);
1083 $text = $obj->getText();
1086 global $wgLegacyEncoding;
1087 if( $text !== false && $wgLegacyEncoding
1088 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
1090 # Old revisions kept around in a legacy encoding?
1091 # Upconvert on demand.
1092 # ("utf8" checked for compatibility with some broken
1093 # conversion scripts 2008-12-30)
1095 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
1098 wfProfileOut( __METHOD__
);
1103 * If $wgCompressRevisions is enabled, we will compress data.
1104 * The input string is modified in place.
1105 * Return value is the flags field: contains 'gzip' if the
1106 * data is compressed, and 'utf-8' if we're saving in UTF-8
1109 * @param $text Mixed: reference to a text
1112 public static function compressRevisionText( &$text ) {
1113 global $wgCompressRevisions;
1116 # Revisions not marked this way will be converted
1117 # on load if $wgLegacyCharset is set in the future.
1120 if( $wgCompressRevisions ) {
1121 if( function_exists( 'gzdeflate' ) ) {
1122 $text = gzdeflate( $text );
1125 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
1128 return implode( ',', $flags );
1132 * Insert a new revision into the database, returning the new revision ID
1133 * number on success and dies horribly on failure.
1135 * @param $dbw DatabaseBase: (master connection)
1138 public function insertOn( $dbw ) {
1139 global $wgDefaultExternalStore, $wgContentHandlerUseDB;
1141 wfProfileIn( __METHOD__
);
1143 $data = $this->mText
;
1144 $flags = Revision
::compressRevisionText( $data );
1146 # Write to external storage if required
1147 if( $wgDefaultExternalStore ) {
1148 // Store and get the URL
1149 $data = ExternalStore
::insertToDefault( $data );
1151 throw new MWException( "Unable to store text to external storage" );
1156 $flags .= 'external';
1159 # Record the text (or external storage URL) to the text table
1160 if( !isset( $this->mTextId
) ) {
1161 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1162 $dbw->insert( 'text',
1164 'old_id' => $old_id,
1165 'old_text' => $data,
1166 'old_flags' => $flags,
1169 $this->mTextId
= $dbw->insertId();
1172 if ( $this->mComment
=== null ) $this->mComment
= "";
1174 # Record the edit in revisions
1175 $rev_id = isset( $this->mId
)
1177 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1180 'rev_id' => $rev_id,
1181 'rev_page' => $this->mPage
,
1182 'rev_text_id' => $this->mTextId
,
1183 'rev_comment' => $this->mComment
,
1184 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1185 'rev_user' => $this->mUser
,
1186 'rev_user_text' => $this->mUserText
,
1187 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1188 'rev_deleted' => $this->mDeleted
,
1189 'rev_len' => $this->mSize
,
1190 'rev_parent_id' => is_null( $this->mParentId
)
1191 ?
$this->getPreviousRevisionId( $dbw )
1193 'rev_sha1' => is_null( $this->mSha1
)
1194 ? Revision
::base36Sha1( $this->mText
)
1198 if ( $wgContentHandlerUseDB ) {
1199 $row[ 'rev_content_model' ] = $this->getContentModel();
1200 $row[ 'rev_content_format' ] = $this->getContentFormat();
1203 $dbw->insert( 'revision', $row, __METHOD__
);
1205 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1207 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1209 wfProfileOut( __METHOD__
);
1214 * Get the base 36 SHA-1 value for a string of text
1215 * @param $text String
1218 public static function base36Sha1( $text ) {
1219 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1223 * Lazy-load the revision's text.
1224 * Currently hardcoded to the 'text' table storage engine.
1228 protected function loadText() {
1229 wfProfileIn( __METHOD__
);
1231 // Caching may be beneficial for massive use of external storage
1232 global $wgRevisionCacheExpiry, $wgMemc;
1233 $textId = $this->getTextId();
1234 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1235 if( $wgRevisionCacheExpiry ) {
1236 $text = $wgMemc->get( $key );
1237 if( is_string( $text ) ) {
1238 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1239 wfProfileOut( __METHOD__
);
1244 // If we kept data for lazy extraction, use it now...
1245 if ( isset( $this->mTextRow
) ) {
1246 $row = $this->mTextRow
;
1247 $this->mTextRow
= null;
1253 // Text data is immutable; check slaves first.
1254 $dbr = wfGetDB( DB_SLAVE
);
1255 $row = $dbr->selectRow( 'text',
1256 array( 'old_text', 'old_flags' ),
1257 array( 'old_id' => $this->getTextId() ),
1261 if( !$row && wfGetLB()->getServerCount() > 1 ) {
1262 // Possible slave lag!
1263 $dbw = wfGetDB( DB_MASTER
);
1264 $row = $dbw->selectRow( 'text',
1265 array( 'old_text', 'old_flags' ),
1266 array( 'old_id' => $this->getTextId() ),
1270 $text = self
::getRevisionText( $row );
1272 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1273 if( $wgRevisionCacheExpiry && $text !== false ) {
1274 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1277 wfProfileOut( __METHOD__
);
1283 * Create a new null-revision for insertion into a page's
1284 * history. This will not re-save the text, but simply refer
1285 * to the text from the previous version.
1287 * Such revisions can for instance identify page rename
1288 * operations and other such meta-modifications.
1290 * @param $dbw DatabaseBase
1291 * @param $pageId Integer: ID number of the page to read from
1292 * @param $summary String: revision's summary
1293 * @param $minor Boolean: whether the revision should be considered as minor
1294 * @return Revision|null on error
1296 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1297 global $wgContentHandlerUseDB;
1299 wfProfileIn( __METHOD__
);
1301 $fields = array( 'page_latest', 'page_namespace', 'page_title',
1302 'rev_text_id', 'rev_len', 'rev_sha1' );
1304 if ( $wgContentHandlerUseDB ) {
1305 $fields[] = 'rev_content_model';
1306 $fields[] = 'rev_content_format';
1309 $current = $dbw->selectRow(
1310 array( 'page', 'revision' ),
1313 'page_id' => $pageId,
1314 'page_latest=rev_id',
1321 'comment' => $summary,
1322 'minor_edit' => $minor,
1323 'text_id' => $current->rev_text_id
,
1324 'parent_id' => $current->page_latest
,
1325 'len' => $current->rev_len
,
1326 'sha1' => $current->rev_sha1
1329 if ( $wgContentHandlerUseDB ) {
1330 $row[ 'content_model' ] = $current->rev_content_model
;
1331 $row[ 'content_format' ] = $current->rev_content_format
;
1334 $revision = new Revision( $row );
1335 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1340 wfProfileOut( __METHOD__
);
1345 * Determine if the current user is allowed to view a particular
1346 * field of this revision, if it's marked as deleted.
1348 * @param $field Integer:one of self::DELETED_TEXT,
1349 * self::DELETED_COMMENT,
1350 * self::DELETED_USER
1351 * @param $user User object to check, or null to use $wgUser
1354 public function userCan( $field, User
$user = null ) {
1355 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1359 * Determine if the current user is allowed to view a particular
1360 * field of this revision, if it's marked as deleted. This is used
1361 * by various classes to avoid duplication.
1363 * @param $bitfield Integer: current field
1364 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1365 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1366 * self::DELETED_USER = File::DELETED_USER
1367 * @param $user User object to check, or null to use $wgUser
1370 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1371 if( $bitfield & $field ) { // aspect is deleted
1372 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1373 $permission = 'suppressrevision';
1374 } elseif ( $field & self
::DELETED_TEXT
) {
1375 $permission = 'deletedtext';
1377 $permission = 'deletedhistory';
1379 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1380 if ( $user === null ) {
1384 return $user->isAllowed( $permission );
1391 * Get rev_timestamp from rev_id, without loading the rest of the row
1393 * @param $title Title
1394 * @param $id Integer
1397 static function getTimestampFromId( $title, $id ) {
1398 $dbr = wfGetDB( DB_SLAVE
);
1399 // Casting fix for DB2
1403 $conds = array( 'rev_id' => $id );
1404 $conds['rev_page'] = $title->getArticleID();
1405 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1406 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1407 # Not in slave, try master
1408 $dbw = wfGetDB( DB_MASTER
);
1409 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1411 return wfTimestamp( TS_MW
, $timestamp );
1415 * Get count of revisions per page...not very efficient
1417 * @param $db DatabaseBase
1418 * @param $id Integer: page id
1421 static function countByPageId( $db, $id ) {
1422 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
1423 array( 'rev_page' => $id ), __METHOD__
);
1425 return $row->revCount
;
1431 * Get count of revisions per page...not very efficient
1433 * @param $db DatabaseBase
1434 * @param $title Title
1437 static function countByTitle( $db, $title ) {
1438 $id = $title->getArticleID();
1440 return Revision
::countByPageId( $db, $id );