10 const DELETED_TEXT
= 1;
11 const DELETED_COMMENT
= 2;
12 const DELETED_USER
= 4;
13 const DELETED_RESTRICTED
= 8;
16 * Load a page revision from a given revision ID number.
17 * Returns null if no such revision can be found.
23 public static function newFromId( $id ) {
24 return Revision
::newFromConds(
25 array( 'page_id=rev_page',
26 'rev_id' => intval( $id ) ) );
30 * Load either the current, or a specified, revision
31 * that's attached to a given title. If not attached
32 * to that title, will return null.
40 public static function newFromTitle( &$title, $id = 0 ) {
42 $matchId = intval( $id );
44 $matchId = 'page_latest';
46 return Revision
::newFromConds(
47 array( "rev_id=$matchId",
49 'page_namespace' => $title->getNamespace(),
50 'page_title' => $title->getDBkey() ) );
54 * Load a page revision from a given revision ID number.
55 * Returns null if no such revision can be found.
62 public static function loadFromId( &$db, $id ) {
63 return Revision
::loadFromConds( $db,
64 array( 'page_id=rev_page',
65 'rev_id' => intval( $id ) ) );
69 * Load either the current, or a specified, revision
70 * that's attached to a given page. If not attached
71 * to that page, will return null.
80 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
81 $conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
83 $conds['rev_id']=intval($id);
85 $conds[]='rev_id=page_latest';
87 return Revision
::loadFromConds( $db, $conds );
91 * Load either the current, or a specified, revision
92 * that's attached to a given page. If not attached
93 * to that page, will return null.
102 public static function loadFromTitle( &$db, $title, $id = 0 ) {
104 $matchId = intval( $id );
106 $matchId = 'page_latest';
108 return Revision
::loadFromConds(
110 array( "rev_id=$matchId",
112 'page_namespace' => $title->getNamespace(),
113 'page_title' => $title->getDBkey() ) );
117 * Load the revision for the given title with the given timestamp.
118 * WARNING: Timestamps may in some circumstances not be unique,
119 * so this isn't the best key to use.
121 * @param Database $db
122 * @param Title $title
123 * @param string $timestamp
128 public static function loadFromTimestamp( &$db, &$title, $timestamp ) {
129 return Revision
::loadFromConds(
131 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
133 'page_namespace' => $title->getNamespace(),
134 'page_title' => $title->getDBkey() ) );
138 * Given a set of conditions, fetch a revision.
140 * @param array $conditions
145 private static function newFromConds( $conditions ) {
146 $db = wfGetDB( DB_SLAVE
);
147 $row = Revision
::loadFromConds( $db, $conditions );
148 if( is_null( $row ) ) {
149 $dbw = wfGetDB( DB_MASTER
);
150 $row = Revision
::loadFromConds( $dbw, $conditions );
156 * Given a set of conditions, fetch a revision from
157 * the given database connection.
159 * @param Database $db
160 * @param array $conditions
165 private static function loadFromConds( $db, $conditions ) {
166 $res = Revision
::fetchFromConds( $db, $conditions );
168 $row = $res->fetchObject();
171 $ret = new Revision( $row );
180 * Return a wrapper for a series of database rows to
181 * fetch all of a given page's revisions in turn.
182 * Each row can be fed to the constructor to get objects.
184 * @param Title $title
185 * @return ResultWrapper
189 public static function fetchAllRevisions( &$title ) {
190 return Revision
::fetchFromConds(
192 array( 'page_namespace' => $title->getNamespace(),
193 'page_title' => $title->getDBkey(),
194 'page_id=rev_page' ) );
198 * Return a wrapper for a series of database rows to
199 * fetch all of a given page's revisions in turn.
200 * Each row can be fed to the constructor to get objects.
202 * @param Title $title
203 * @return ResultWrapper
207 public static function fetchRevision( &$title ) {
208 return Revision
::fetchFromConds(
210 array( 'rev_id=page_latest',
211 'page_namespace' => $title->getNamespace(),
212 'page_title' => $title->getDBkey(),
213 'page_id=rev_page' ) );
217 * Given a set of conditions, return a ResultWrapper
218 * which will return matching database rows with the
219 * fields necessary to build Revision objects.
221 * @param Database $db
222 * @param array $conditions
223 * @return ResultWrapper
227 private static function fetchFromConds( $db, $conditions ) {
228 $fields = self
::selectFields();
229 $fields[] = 'page_namespace';
230 $fields[] = 'page_title';
231 $fields[] = 'page_latest';
233 array( 'page', 'revision' ),
236 'Revision::fetchRow',
237 array( 'LIMIT' => 1 ) );
238 $ret = $db->resultObject( $res );
243 * Return the list of revision fields that should be selected to create
246 static function selectFields() {
263 * Return the list of text fields that should be selected to read the
266 static function selectTextFields() {
273 * Return the list of page fields that should be selected from page table
275 static function selectPageFields() {
287 function Revision( $row ) {
288 if( is_object( $row ) ) {
289 $this->mId
= intval( $row->rev_id
);
290 $this->mPage
= intval( $row->rev_page
);
291 $this->mTextId
= intval( $row->rev_text_id
);
292 $this->mComment
= $row->rev_comment
;
293 $this->mUserText
= $row->rev_user_text
;
294 $this->mUser
= intval( $row->rev_user
);
295 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
296 $this->mTimestamp
= $row->rev_timestamp
;
297 $this->mDeleted
= intval( $row->rev_deleted
);
299 if( !isset( $row->rev_parent_id
) )
300 $this->mParentId
= is_null($row->rev_parent_id
) ?
null : 0;
302 $this->mParentId
= intval( $row->rev_parent_id
);
304 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) )
307 $this->mSize
= intval( $row->rev_len
);
309 if( isset( $row->page_latest
) ) {
310 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
311 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
314 $this->mCurrent
= false;
315 $this->mTitle
= null;
318 // Lazy extraction...
320 if( isset( $row->old_text
) ) {
321 $this->mTextRow
= $row;
323 // 'text' table row entry will be lazy-loaded
324 $this->mTextRow
= null;
326 } elseif( is_array( $row ) ) {
327 // Build a new revision to be saved...
330 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
331 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
332 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
333 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
334 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
335 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
336 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestamp( TS_MW
);
337 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
338 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
339 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
341 // Enforce spacing trimming on supplied text
342 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
343 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
344 $this->mTextRow
= null;
346 $this->mTitle
= null; # Load on demand if needed
347 $this->mCurrent
= false;
348 # If we still have no len_size, see it we have the text to figure it out
350 $this->mSize
= is_null($this->mText
) ?
null : strlen($this->mText
);
352 throw new MWException( 'Revision constructor passed invalid row format.' );
364 public function getId() {
372 public function getTextId() {
373 return $this->mTextId
;
377 * Get parent revision ID (the original previous page revision)
380 public function getParentId() {
381 return $this->mParentId
;
385 * Returns the length of the text in this revision, or null if unknown.
388 public function getSize() {
393 * Returns the title of the page associated with this entry.
396 public function getTitle() {
397 if( isset( $this->mTitle
) ) {
398 return $this->mTitle
;
400 $dbr = wfGetDB( DB_SLAVE
);
401 $row = $dbr->selectRow(
402 array( 'page', 'revision' ),
403 array( 'page_namespace', 'page_title' ),
404 array( 'page_id=rev_page',
405 'rev_id' => $this->mId
),
406 'Revision::getTitle' );
408 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
411 return $this->mTitle
;
415 * Set the title of the revision
416 * @param Title $title
418 public function setTitle( $title ) {
419 $this->mTitle
= $title;
426 public function getPage() {
431 * Fetch revision's user id if it's available to all users
434 public function getUser() {
435 if( $this->isDeleted( self
::DELETED_USER
) ) {
443 * Fetch revision's user id without regard for the current user's permissions
446 public function getRawUser() {
451 * Fetch revision's username if it's available to all users
454 public function getUserText() {
455 if( $this->isDeleted( self
::DELETED_USER
) ) {
458 return $this->mUserText
;
463 * Fetch revision's username without regard for view restrictions
466 public function getRawUserText() {
467 return $this->mUserText
;
471 * Fetch revision comment if it's available to all users
474 function getComment() {
475 if( $this->isDeleted( self
::DELETED_COMMENT
) ) {
478 return $this->mComment
;
483 * Fetch revision comment without regard for the current user's permissions
486 public function getRawComment() {
487 return $this->mComment
;
493 public function isMinor() {
494 return (bool)$this->mMinorEdit
;
498 * int $field one of DELETED_* bitfield constants
501 public function isDeleted( $field ) {
502 return ($this->mDeleted
& $field) == $field;
506 * Fetch revision text if it's available to all users
509 public function getText() {
510 if( $this->isDeleted( self
::DELETED_TEXT
) ) {
513 return $this->getRawText();
518 * Fetch revision text without regard for view restrictions
521 public function getRawText() {
522 if( is_null( $this->mText
) ) {
523 // Revision text is immutable. Load on demand:
524 $this->mText
= $this->loadText();
530 * Fetch revision text if it's available to THIS user
533 public function revText() {
534 if( !$this->userCan( self
::DELETED_TEXT
) ) {
537 return $this->getRawText();
544 public function getTimestamp() {
545 return wfTimestamp(TS_MW
, $this->mTimestamp
);
551 public function isCurrent() {
552 return $this->mCurrent
;
556 * Get previous revision for this title
559 public function getPrevious() {
560 $prev = $this->getTitle()->getPreviousRevisionID( $this->mId
);
562 return Revision
::newFromTitle( $this->mTitle
, $prev );
571 public function getNext() {
572 $next = $this->getTitle()->getNextRevisionID( $this->mId
);
574 return Revision
::newFromTitle( $this->mTitle
, $next );
581 * Get previous revision Id for this page_id
582 * This is used to populate rev_parent_id on save
583 * @param Database $db
586 private function getPreviousRevisionId( $db ) {
587 if( is_null($this->mPage
) ) {
590 # Use page_latest if ID is not given
592 $prevId = $db->selectField( 'page', 'page_latest',
593 array( 'page_id' => $this->mPage
),
596 $prevId = $db->selectField( 'revision', 'rev_id',
597 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
599 array( 'ORDER BY' => 'rev_id DESC' ) );
601 return intval($prevId);
605 * Get revision text associated with an old or archive row
606 * $row is usually an object from wfFetchRow(), both the flags and the text
607 * field must be included
609 * @param integer $row Id of a row
610 * @param string $prefix table prefix (default 'old_')
611 * @return string $text|false the text requested
613 public static function getRevisionText( $row, $prefix = 'old_' ) {
614 wfProfileIn( __METHOD__
);
617 $textField = $prefix . 'text';
618 $flagsField = $prefix . 'flags';
620 if( isset( $row->$flagsField ) ) {
621 $flags = explode( ',', $row->$flagsField );
626 if( isset( $row->$textField ) ) {
627 $text = $row->$textField;
629 wfProfileOut( __METHOD__
);
633 # Use external methods for external objects, text in table is URL-only then
634 if ( in_array( 'external', $flags ) ) {
636 @list
(/* $proto */,$path)=explode('://',$url,2);
638 wfProfileOut( __METHOD__
);
641 $text=ExternalStore
::fetchFromURL($url);
644 // If the text was fetched without an error, convert it
645 if ( $text !== false ) {
646 if( in_array( 'gzip', $flags ) ) {
647 # Deal with optional compression of archived pages.
648 # This can be done periodically via maintenance/compressOld.php, and
649 # as pages are saved if $wgCompressRevisions is set.
650 $text = gzinflate( $text );
653 if( in_array( 'object', $flags ) ) {
654 # Generic compressed storage
655 $obj = unserialize( $text );
656 if ( !is_object( $obj ) ) {
658 wfProfileOut( __METHOD__
);
661 $text = $obj->getText();
664 global $wgLegacyEncoding;
665 if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
666 # Old revisions kept around in a legacy encoding?
667 # Upconvert on demand.
668 global $wgInputEncoding, $wgContLang;
669 $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
672 wfProfileOut( __METHOD__
);
677 * If $wgCompressRevisions is enabled, we will compress data.
678 * The input string is modified in place.
679 * Return value is the flags field: contains 'gzip' if the
680 * data is compressed, and 'utf-8' if we're saving in UTF-8
683 * @param mixed $text reference to a text
686 public static function compressRevisionText( &$text ) {
687 global $wgCompressRevisions;
690 # Revisions not marked this way will be converted
691 # on load if $wgLegacyCharset is set in the future.
694 if( $wgCompressRevisions ) {
695 if( function_exists( 'gzdeflate' ) ) {
696 $text = gzdeflate( $text );
699 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
702 return implode( ',', $flags );
706 * Insert a new revision into the database, returning the new revision ID
707 * number on success and dies horribly on failure.
709 * @param Database $dbw
712 public function insertOn( &$dbw ) {
713 global $wgDefaultExternalStore;
715 wfProfileIn( __METHOD__
);
717 $data = $this->mText
;
718 $flags = Revision
::compressRevisionText( $data );
720 # Write to external storage if required
721 if ( $wgDefaultExternalStore ) {
722 if ( is_array( $wgDefaultExternalStore ) ) {
723 // Distribute storage across multiple clusters
724 $store = $wgDefaultExternalStore[mt_rand(0, count( $wgDefaultExternalStore ) - 1)];
726 $store = $wgDefaultExternalStore;
728 // Store and get the URL
729 $data = ExternalStore
::insert( $store, $data );
731 # This should only happen in the case of a configuration error, where the external store is not valid
732 throw new MWException( "Unable to store text to external storage $store" );
737 $flags .= 'external';
740 # Record the text (or external storage URL) to the text table
741 if( !isset( $this->mTextId
) ) {
742 $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
743 $dbw->insert( 'text',
747 'old_flags' => $flags,
750 $this->mTextId
= $dbw->insertId();
753 # Record the edit in revisions
754 $rev_id = isset( $this->mId
)
756 : $dbw->nextSequenceValue( 'rev_rev_id_val' );
757 $dbw->insert( 'revision',
760 'rev_page' => $this->mPage
,
761 'rev_text_id' => $this->mTextId
,
762 'rev_comment' => $this->mComment
,
763 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
764 'rev_user' => $this->mUser
,
765 'rev_user_text' => $this->mUserText
,
766 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
767 'rev_deleted' => $this->mDeleted
,
768 'rev_len' => $this->mSize
,
769 'rev_parent_id' => $this->mParentId ?
$this->mParentId
: $this->getPreviousRevisionId( $dbw )
773 $this->mId
= !is_null($rev_id) ?
$rev_id : $dbw->insertId();
775 wfRunHooks( 'RevisionInsertComplete', array( &$this ) );
777 wfProfileOut( __METHOD__
);
782 * Lazy-load the revision's text.
783 * Currently hardcoded to the 'text' table storage engine.
787 private function loadText() {
788 wfProfileIn( __METHOD__
);
790 // Caching may be beneficial for massive use of external storage
791 global $wgRevisionCacheExpiry, $wgMemc;
792 $key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
793 if( $wgRevisionCacheExpiry ) {
794 $text = $wgMemc->get( $key );
795 if( is_string( $text ) ) {
796 wfProfileOut( __METHOD__
);
801 // If we kept data for lazy extraction, use it now...
802 if ( isset( $this->mTextRow
) ) {
803 $row = $this->mTextRow
;
804 $this->mTextRow
= null;
810 // Text data is immutable; check slaves first.
811 $dbr = wfGetDB( DB_SLAVE
);
812 $row = $dbr->selectRow( 'text',
813 array( 'old_text', 'old_flags' ),
814 array( 'old_id' => $this->getTextId() ),
819 // Possible slave lag!
820 $dbw = wfGetDB( DB_MASTER
);
821 $row = $dbw->selectRow( 'text',
822 array( 'old_text', 'old_flags' ),
823 array( 'old_id' => $this->getTextId() ),
827 $text = self
::getRevisionText( $row );
829 if( $wgRevisionCacheExpiry ) {
830 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
833 wfProfileOut( __METHOD__
);
839 * Create a new null-revision for insertion into a page's
840 * history. This will not re-save the text, but simply refer
841 * to the text from the previous version.
843 * Such revisions can for instance identify page rename
844 * operations and other such meta-modifications.
846 * @param Database $dbw
847 * @param int $pageId ID number of the page to read from
848 * @param string $summary
852 public static function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
853 wfProfileIn( __METHOD__
);
855 $current = $dbw->selectRow(
856 array( 'page', 'revision' ),
857 array( 'page_latest', 'rev_text_id' ),
859 'page_id' => $pageId,
860 'page_latest=rev_id',
865 $revision = new Revision( array(
867 'comment' => $summary,
868 'minor_edit' => $minor,
869 'text_id' => $current->rev_text_id
,
870 'parent_id' => $current->page_latest
876 wfProfileOut( __METHOD__
);
881 * Determine if the current user is allowed to view a particular
882 * field of this revision, if it's marked as deleted.
883 * @param int $field one of self::DELETED_TEXT,
884 * self::DELETED_COMMENT,
888 public function userCan( $field ) {
889 if( ( $this->mDeleted
& $field ) == $field ) {
891 $permission = ( $this->mDeleted
& self
::DELETED_RESTRICTED
) == self
::DELETED_RESTRICTED
894 wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
895 return $wgUser->isAllowed( $permission );
903 * Get rev_timestamp from rev_id, without loading the rest of the row
906 static function getTimestampFromID( $id ) {
907 $dbr = wfGetDB( DB_SLAVE
);
908 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp',
909 array( 'rev_id' => $id ), __METHOD__
);
910 if ( $timestamp === false ) {
911 # Not in slave, try master
912 $dbw = wfGetDB( DB_MASTER
);
913 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp',
914 array( 'rev_id' => $id ), __METHOD__
);
920 * Get count of revisions per page...not very efficient
921 * @param Database $db
922 * @param int $id, page id
924 static function countByPageId( $db, $id ) {
925 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
926 array( 'rev_page' => $id ), __METHOD__
);
928 return $row->revCount
;
934 * Get count of revisions per page...not very efficient
935 * @param Database $db
936 * @param Title $title
938 static function countByTitle( $db, $title ) {
939 $id = $title->getArticleId();
941 return Revision
::countByPageId( $db, $id );
948 * Aliases for backwards compatibility with 1.6
950 define( 'MW_REV_DELETED_TEXT', Revision
::DELETED_TEXT
);
951 define( 'MW_REV_DELETED_COMMENT', Revision
::DELETED_COMMENT
);
952 define( 'MW_REV_DELETED_USER', Revision
::DELETED_USER
);
953 define( 'MW_REV_DELETED_RESTRICTED', Revision
::DELETED_RESTRICTED
);