11 const DELETED_TEXT
= 1;
12 const DELETED_COMMENT
= 2;
13 const DELETED_USER
= 4;
14 const DELETED_RESTRICTED
= 8;
17 * Load a page revision from a given revision ID number.
18 * Returns null if no such revision can be found.
24 public static function newFromId( $id ) {
25 return Revision
::newFromConds(
26 array( 'page_id=rev_page',
27 'rev_id' => intval( $id ) ) );
31 * Load either the current, or a specified, revision
32 * that's attached to a given title. If not attached
33 * to that title, will return null.
39 public static function newFromTitle( $title, $id = 0 ) {
41 $matchId = intval( $id );
43 $matchId = 'page_latest';
45 return Revision
::newFromConds(
46 array( "rev_id=$matchId",
48 'page_namespace' => $title->getNamespace(),
49 'page_title' => $title->getDBkey() ) );
53 * Load a page revision from a given revision ID number.
54 * Returns null if no such revision can be found.
61 public static function loadFromId( $db, $id ) {
62 return Revision
::loadFromConds( $db,
63 array( 'page_id=rev_page',
64 'rev_id' => intval( $id ) ) );
68 * Load either the current, or a specified, revision
69 * that's attached to a given page. If not attached
70 * to that page, will return null.
79 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
80 $conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
82 $conds['rev_id']=intval($id);
84 $conds[]='rev_id=page_latest';
86 return Revision
::loadFromConds( $db, $conds );
90 * Load either the current, or a specified, revision
91 * that's attached to a given page. If not attached
92 * to that page, will return null.
101 public static function loadFromTitle( $db, $title, $id = 0 ) {
103 $matchId = intval( $id );
105 $matchId = 'page_latest';
107 return Revision
::loadFromConds(
109 array( "rev_id=$matchId",
111 'page_namespace' => $title->getNamespace(),
112 'page_title' => $title->getDBkey() ) );
116 * Load the revision for the given title with the given timestamp.
117 * WARNING: Timestamps may in some circumstances not be unique,
118 * so this isn't the best key to use.
120 * @param Database $db
121 * @param Title $title
122 * @param string $timestamp
127 public static function loadFromTimestamp( $db, $title, $timestamp ) {
128 return Revision
::loadFromConds(
130 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
132 'page_namespace' => $title->getNamespace(),
133 'page_title' => $title->getDBkey() ) );
137 * Given a set of conditions, fetch a revision.
139 * @param array $conditions
144 private static function newFromConds( $conditions ) {
145 $db = wfGetDB( DB_SLAVE
);
146 $row = Revision
::loadFromConds( $db, $conditions );
147 if( is_null( $row ) ) {
148 $dbw = wfGetDB( DB_MASTER
);
149 $row = Revision
::loadFromConds( $dbw, $conditions );
155 * Given a set of conditions, fetch a revision from
156 * the given database connection.
158 * @param Database $db
159 * @param array $conditions
164 private static function loadFromConds( $db, $conditions ) {
165 $res = Revision
::fetchFromConds( $db, $conditions );
167 $row = $res->fetchObject();
170 $ret = new Revision( $row );
179 * Return a wrapper for a series of database rows to
180 * fetch all of a given page's revisions in turn.
181 * Each row can be fed to the constructor to get objects.
183 * @param Title $title
184 * @return ResultWrapper
188 public static function fetchAllRevisions( $title ) {
189 return Revision
::fetchFromConds(
191 array( 'page_namespace' => $title->getNamespace(),
192 'page_title' => $title->getDBkey(),
193 'page_id=rev_page' ) );
197 * Return a wrapper for a series of database rows to
198 * fetch all of a given page's revisions in turn.
199 * Each row can be fed to the constructor to get objects.
201 * @param Title $title
202 * @return ResultWrapper
206 public static function fetchRevision( $title ) {
207 return Revision
::fetchFromConds(
209 array( 'rev_id=page_latest',
210 'page_namespace' => $title->getNamespace(),
211 'page_title' => $title->getDBkey(),
212 'page_id=rev_page' ) );
216 * Given a set of conditions, return a ResultWrapper
217 * which will return matching database rows with the
218 * fields necessary to build Revision objects.
220 * @param Database $db
221 * @param array $conditions
222 * @return ResultWrapper
226 private static function fetchFromConds( $db, $conditions ) {
227 $fields = self
::selectFields();
228 $fields[] = 'page_namespace';
229 $fields[] = 'page_title';
230 $fields[] = 'page_latest';
232 array( 'page', 'revision' ),
235 'Revision::fetchRow',
236 array( 'LIMIT' => 1 ) );
237 $ret = $db->resultObject( $res );
242 * Return the list of revision fields that should be selected to create
245 static function selectFields() {
262 * Return the list of text fields that should be selected to read the
265 static function selectTextFields() {
272 * Return the list of page fields that should be selected from page table
274 static function selectPageFields() {
286 function Revision( $row ) {
287 if( is_object( $row ) ) {
288 $this->mId
= intval( $row->rev_id
);
289 $this->mPage
= intval( $row->rev_page
);
290 $this->mTextId
= intval( $row->rev_text_id
);
291 $this->mComment
= $row->rev_comment
;
292 $this->mUserText
= $row->rev_user_text
;
293 $this->mUser
= intval( $row->rev_user
);
294 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
295 $this->mTimestamp
= $row->rev_timestamp
;
296 $this->mDeleted
= intval( $row->rev_deleted
);
298 if( !isset( $row->rev_parent_id
) )
299 $this->mParentId
= is_null($row->rev_parent_id
) ?
null : 0;
301 $this->mParentId
= intval( $row->rev_parent_id
);
303 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) )
306 $this->mSize
= intval( $row->rev_len
);
308 if( isset( $row->page_latest
) ) {
309 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
310 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
313 $this->mCurrent
= false;
314 $this->mTitle
= null;
317 // Lazy extraction...
319 if( isset( $row->old_text
) ) {
320 $this->mTextRow
= $row;
322 // 'text' table row entry will be lazy-loaded
323 $this->mTextRow
= null;
325 } elseif( is_array( $row ) ) {
326 // Build a new revision to be saved...
329 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
330 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
331 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
332 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
333 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
334 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
335 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestamp( TS_MW
);
336 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
337 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
338 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
340 // Enforce spacing trimming on supplied text
341 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
342 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
343 $this->mTextRow
= null;
345 $this->mTitle
= null; # Load on demand if needed
346 $this->mCurrent
= false;
347 # If we still have no len_size, see it we have the text to figure it out
349 $this->mSize
= is_null($this->mText
) ?
null : strlen($this->mText
);
351 throw new MWException( 'Revision constructor passed invalid row format.' );
363 public function getId() {
371 public function getTextId() {
372 return $this->mTextId
;
376 * Get parent revision ID (the original previous page revision)
379 public function getParentId() {
380 return $this->mParentId
;
384 * Returns the length of the text in this revision, or null if unknown.
387 public function getSize() {
392 * Returns the title of the page associated with this entry.
395 public function getTitle() {
396 if( isset( $this->mTitle
) ) {
397 return $this->mTitle
;
399 $dbr = wfGetDB( DB_SLAVE
);
400 $row = $dbr->selectRow(
401 array( 'page', 'revision' ),
402 array( 'page_namespace', 'page_title' ),
403 array( 'page_id=rev_page',
404 'rev_id' => $this->mId
),
405 'Revision::getTitle' );
407 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
410 return $this->mTitle
;
414 * Set the title of the revision
415 * @param Title $title
417 public function setTitle( $title ) {
418 $this->mTitle
= $title;
425 public function getPage() {
430 * Fetch revision's user id if it's available to all users
433 public function getUser() {
434 if( $this->isDeleted( self
::DELETED_USER
) ) {
442 * Fetch revision's user id without regard for the current user's permissions
445 public function getRawUser() {
450 * Fetch revision's username if it's available to all users
453 public function getUserText() {
454 if( $this->isDeleted( self
::DELETED_USER
) ) {
457 return $this->mUserText
;
462 * Fetch revision's username without regard for view restrictions
465 public function getRawUserText() {
466 return $this->mUserText
;
470 * Fetch revision comment if it's available to all users
473 function getComment() {
474 if( $this->isDeleted( self
::DELETED_COMMENT
) ) {
477 return $this->mComment
;
482 * Fetch revision comment without regard for the current user's permissions
485 public function getRawComment() {
486 return $this->mComment
;
492 public function isMinor() {
493 return (bool)$this->mMinorEdit
;
497 * int $field one of DELETED_* bitfield constants
500 public function isDeleted( $field ) {
501 return ($this->mDeleted
& $field) == $field;
505 * Fetch revision text if it's available to all users
508 public function getText() {
509 if( $this->isDeleted( self
::DELETED_TEXT
) ) {
512 return $this->getRawText();
517 * Fetch revision text without regard for view restrictions
520 public function getRawText() {
521 if( is_null( $this->mText
) ) {
522 // Revision text is immutable. Load on demand:
523 $this->mText
= $this->loadText();
529 * Fetch revision text if it's available to THIS user
532 public function revText() {
533 if( !$this->userCan( self
::DELETED_TEXT
) ) {
536 return $this->getRawText();
543 public function getTimestamp() {
544 return wfTimestamp(TS_MW
, $this->mTimestamp
);
550 public function isCurrent() {
551 return $this->mCurrent
;
555 * Get previous revision for this title
558 public function getPrevious() {
559 if( $this->getTitle() ) {
560 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
562 return Revision
::newFromTitle( $this->getTitle(), $prev );
571 public function getNext() {
572 if( $this->getTitle() ) {
573 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
575 return Revision
::newFromTitle( $this->getTitle(), $next );
582 * Get previous revision Id for this page_id
583 * This is used to populate rev_parent_id on save
584 * @param Database $db
587 private function getPreviousRevisionId( $db ) {
588 if( is_null($this->mPage
) ) {
591 # Use page_latest if ID is not given
593 $prevId = $db->selectField( 'page', 'page_latest',
594 array( 'page_id' => $this->mPage
),
597 $prevId = $db->selectField( 'revision', 'rev_id',
598 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
600 array( 'ORDER BY' => 'rev_id DESC' ) );
602 return intval($prevId);
606 * Get revision text associated with an old or archive row
607 * $row is usually an object from wfFetchRow(), both the flags and the text
608 * field must be included
610 * @param integer $row Id of a row
611 * @param string $prefix table prefix (default 'old_')
612 * @return string $text|false the text requested
614 public static function getRevisionText( $row, $prefix = 'old_' ) {
615 wfProfileIn( __METHOD__
);
618 $textField = $prefix . 'text';
619 $flagsField = $prefix . 'flags';
621 if( isset( $row->$flagsField ) ) {
622 $flags = explode( ',', $row->$flagsField );
627 if( isset( $row->$textField ) ) {
628 $text = $row->$textField;
630 wfProfileOut( __METHOD__
);
634 # Use external methods for external objects, text in table is URL-only then
635 if ( in_array( 'external', $flags ) ) {
637 @list
(/* $proto */,$path)=explode('://',$url,2);
639 wfProfileOut( __METHOD__
);
642 $text=ExternalStore
::fetchFromURL($url);
645 // If the text was fetched without an error, convert it
646 if ( $text !== false ) {
647 if( in_array( 'gzip', $flags ) ) {
648 # Deal with optional compression of archived pages.
649 # This can be done periodically via maintenance/compressOld.php, and
650 # as pages are saved if $wgCompressRevisions is set.
651 $text = gzinflate( $text );
654 if( in_array( 'object', $flags ) ) {
655 # Generic compressed storage
656 $obj = unserialize( $text );
657 if ( !is_object( $obj ) ) {
659 wfProfileOut( __METHOD__
);
662 $text = $obj->getText();
665 global $wgLegacyEncoding;
666 if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
667 # Old revisions kept around in a legacy encoding?
668 # Upconvert on demand.
669 global $wgInputEncoding, $wgContLang;
670 $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
673 wfProfileOut( __METHOD__
);
678 * If $wgCompressRevisions is enabled, we will compress data.
679 * The input string is modified in place.
680 * Return value is the flags field: contains 'gzip' if the
681 * data is compressed, and 'utf-8' if we're saving in UTF-8
684 * @param mixed $text reference to a text
687 public static function compressRevisionText( &$text ) {
688 global $wgCompressRevisions;
691 # Revisions not marked this way will be converted
692 # on load if $wgLegacyCharset is set in the future.
695 if( $wgCompressRevisions ) {
696 if( function_exists( 'gzdeflate' ) ) {
697 $text = gzdeflate( $text );
700 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
703 return implode( ',', $flags );
707 * Insert a new revision into the database, returning the new revision ID
708 * number on success and dies horribly on failure.
710 * @param Database $dbw
713 public function insertOn( $dbw ) {
714 global $wgDefaultExternalStore;
716 wfProfileIn( __METHOD__
);
718 $data = $this->mText
;
719 $flags = Revision
::compressRevisionText( $data );
721 # Write to external storage if required
722 if ( $wgDefaultExternalStore ) {
723 if ( is_array( $wgDefaultExternalStore ) ) {
724 // Distribute storage across multiple clusters
725 $store = $wgDefaultExternalStore[mt_rand(0, count( $wgDefaultExternalStore ) - 1)];
727 $store = $wgDefaultExternalStore;
729 // Store and get the URL
730 $data = ExternalStore
::insert( $store, $data );
732 # This should only happen in the case of a configuration error, where the external store is not valid
733 throw new MWException( "Unable to store text to external storage $store" );
738 $flags .= 'external';
741 # Record the text (or external storage URL) to the text table
742 if( !isset( $this->mTextId
) ) {
743 $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
744 $dbw->insert( 'text',
748 'old_flags' => $flags,
751 $this->mTextId
= $dbw->insertId();
754 # Record the edit in revisions
755 $rev_id = isset( $this->mId
)
757 : $dbw->nextSequenceValue( 'rev_rev_id_val' );
758 $dbw->insert( 'revision',
761 'rev_page' => $this->mPage
,
762 'rev_text_id' => $this->mTextId
,
763 'rev_comment' => $this->mComment
,
764 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
765 'rev_user' => $this->mUser
,
766 'rev_user_text' => $this->mUserText
,
767 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
768 'rev_deleted' => $this->mDeleted
,
769 'rev_len' => $this->mSize
,
770 'rev_parent_id' => $this->mParentId ?
$this->mParentId
: $this->getPreviousRevisionId( $dbw )
774 $this->mId
= !is_null($rev_id) ?
$rev_id : $dbw->insertId();
776 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
778 wfProfileOut( __METHOD__
);
783 * Lazy-load the revision's text.
784 * Currently hardcoded to the 'text' table storage engine.
788 private function loadText() {
789 wfProfileIn( __METHOD__
);
791 // Caching may be beneficial for massive use of external storage
792 global $wgRevisionCacheExpiry, $wgMemc;
793 $key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
794 if( $wgRevisionCacheExpiry ) {
795 $text = $wgMemc->get( $key );
796 if( is_string( $text ) ) {
797 wfProfileOut( __METHOD__
);
802 // If we kept data for lazy extraction, use it now...
803 if ( isset( $this->mTextRow
) ) {
804 $row = $this->mTextRow
;
805 $this->mTextRow
= null;
811 // Text data is immutable; check slaves first.
812 $dbr = wfGetDB( DB_SLAVE
);
813 $row = $dbr->selectRow( 'text',
814 array( 'old_text', 'old_flags' ),
815 array( 'old_id' => $this->getTextId() ),
820 // Possible slave lag!
821 $dbw = wfGetDB( DB_MASTER
);
822 $row = $dbw->selectRow( 'text',
823 array( 'old_text', 'old_flags' ),
824 array( 'old_id' => $this->getTextId() ),
828 $text = self
::getRevisionText( $row );
830 if( $wgRevisionCacheExpiry ) {
831 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
834 wfProfileOut( __METHOD__
);
840 * Create a new null-revision for insertion into a page's
841 * history. This will not re-save the text, but simply refer
842 * to the text from the previous version.
844 * Such revisions can for instance identify page rename
845 * operations and other such meta-modifications.
847 * @param Database $dbw
848 * @param int $pageId ID number of the page to read from
849 * @param string $summary
853 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
854 wfProfileIn( __METHOD__
);
856 $current = $dbw->selectRow(
857 array( 'page', 'revision' ),
858 array( 'page_latest', 'rev_text_id' ),
860 'page_id' => $pageId,
861 'page_latest=rev_id',
866 $revision = new Revision( array(
868 'comment' => $summary,
869 'minor_edit' => $minor,
870 'text_id' => $current->rev_text_id
,
871 'parent_id' => $current->page_latest
877 wfProfileOut( __METHOD__
);
882 * Determine if the current user is allowed to view a particular
883 * field of this revision, if it's marked as deleted.
884 * @param int $field one of self::DELETED_TEXT,
885 * self::DELETED_COMMENT,
889 public function userCan( $field ) {
890 if( ( $this->mDeleted
& $field ) == $field ) {
892 $permission = ( $this->mDeleted
& self
::DELETED_RESTRICTED
) == self
::DELETED_RESTRICTED
895 wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
896 return $wgUser->isAllowed( $permission );
904 * Get rev_timestamp from rev_id, without loading the rest of the row
906 * @param integer $pageid, optional
908 static function getTimestampFromId( $id, $pageId = 0 ) {
909 $dbr = wfGetDB( DB_SLAVE
);
910 $conds = array( 'rev_id' => $id );
912 $conds['rev_page'] = $pageId;
914 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
915 if ( $timestamp === false ) {
916 # Not in slave, try master
917 $dbw = wfGetDB( DB_MASTER
);
918 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
920 return wfTimestamp( TS_MW
, $timestamp );
924 * Get count of revisions per page...not very efficient
925 * @param Database $db
926 * @param int $id, page id
928 static function countByPageId( $db, $id ) {
929 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
930 array( 'rev_page' => $id ), __METHOD__
);
932 return $row->revCount
;
938 * Get count of revisions per page...not very efficient
939 * @param Database $db
940 * @param Title $title
942 static function countByTitle( $db, $title ) {
943 $id = $title->getArticleId();
945 return Revision
::countByPageId( $db, $id );
952 * Aliases for backwards compatibility with 1.6
954 define( 'MW_REV_DELETED_TEXT', Revision
::DELETED_TEXT
);
955 define( 'MW_REV_DELETED_COMMENT', Revision
::DELETED_COMMENT
);
956 define( 'MW_REV_DELETED_USER', Revision
::DELETED_USER
);
957 define( 'MW_REV_DELETED_RESTRICTED', Revision
::DELETED_RESTRICTED
);