8 require_once( 'Database.php' );
15 const DELETED_TEXT
= 1;
16 const DELETED_COMMENT
= 2;
17 const DELETED_USER
= 4;
18 const DELETED_RESTRICTED
= 8;
21 * Load a page revision from a given revision ID number.
22 * Returns null if no such revision can be found.
28 public static function newFromId( $id ) {
29 return Revision
::newFromConds(
30 array( 'page_id=rev_page',
31 'rev_id' => intval( $id ) ) );
35 * Load either the current, or a specified, revision
36 * that's attached to a given title. If not attached
37 * to that title, will return null.
45 public static function newFromTitle( &$title, $id = 0 ) {
47 $matchId = intval( $id );
49 $matchId = 'page_latest';
51 return Revision
::newFromConds(
52 array( "rev_id=$matchId",
54 'page_namespace' => $title->getNamespace(),
55 'page_title' => $title->getDbkey() ) );
59 * Load either the current, or a specified, revision
60 * that's attached to a given page. If not attached
61 * to that page, will return null.
69 public static function loadFromPageId( &$db, $pageid, $id = 0 ) {
70 $conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
72 $conds['rev_id']=intval($id);
74 $conds[]='rev_id=page_latest';
76 return Revision
::loadFromConds( $db, $conds );
80 * Load either the current, or a specified, revision
81 * that's attached to a given page. If not attached
82 * to that page, will return null.
90 function loadFromTitle( &$db, $title, $id = 0 ) {
92 $matchId = intval( $id );
94 $matchId = 'page_latest';
96 return Revision
::loadFromConds(
98 array( "rev_id=$matchId",
100 'page_namespace' => $title->getNamespace(),
101 'page_title' => $title->getDbkey() ) );
105 * Load the revision for the given title with the given timestamp.
106 * WARNING: Timestamps may in some circumstances not be unique,
107 * so this isn't the best key to use.
109 * @param Database $db
110 * @param Title $title
111 * @param string $timestamp
116 function loadFromTimestamp( &$db, &$title, $timestamp ) {
117 return Revision
::loadFromConds(
119 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
121 'page_namespace' => $title->getNamespace(),
122 'page_title' => $title->getDbkey() ) );
126 * Given a set of conditions, fetch a revision.
128 * @param array $conditions
133 private static function newFromConds( $conditions ) {
134 $db =& wfGetDB( DB_SLAVE
);
135 $row = Revision
::loadFromConds( $db, $conditions );
136 if( is_null( $row ) ) {
137 $dbw =& wfGetDB( DB_MASTER
);
138 $row = Revision
::loadFromConds( $dbw, $conditions );
144 * Given a set of conditions, fetch a revision from
145 * the given database connection.
147 * @param Database $db
148 * @param array $conditions
153 private static function loadFromConds( &$db, $conditions ) {
154 $res = Revision
::fetchFromConds( $db, $conditions );
156 $row = $res->fetchObject();
159 $ret = new Revision( $row );
168 * Return a wrapper for a series of database rows to
169 * fetch all of a given page's revisions in turn.
170 * Each row can be fed to the constructor to get objects.
172 * @param Title $title
173 * @return ResultWrapper
177 function fetchAllRevisions( &$title ) {
178 return Revision
::fetchFromConds(
180 array( 'page_namespace' => $title->getNamespace(),
181 'page_title' => $title->getDbkey(),
182 'page_id=rev_page' ) );
186 * Return a wrapper for a series of database rows to
187 * fetch all of a given page's revisions in turn.
188 * Each row can be fed to the constructor to get objects.
190 * @param Title $title
191 * @return ResultWrapper
195 public static function fetchRevision( &$title ) {
196 return Revision
::fetchFromConds(
198 array( 'rev_id=page_latest',
199 'page_namespace' => $title->getNamespace(),
200 'page_title' => $title->getDbkey(),
201 'page_id=rev_page' ) );
205 * Given a set of conditions, return a ResultWrapper
206 * which will return matching database rows with the
207 * fields necessary to build Revision objects.
209 * @param Database $db
210 * @param array $conditions
211 * @return ResultWrapper
215 private static function fetchFromConds( &$db, $conditions ) {
217 array( 'page', 'revision' ),
218 array( 'page_namespace',
231 'Revision::fetchRow',
232 array( 'LIMIT' => 1 ) );
233 $ret = $db->resultObject( $res );
241 function Revision( $row ) {
242 if( is_object( $row ) ) {
243 $this->mId
= intval( $row->rev_id
);
244 $this->mPage
= intval( $row->rev_page
);
245 $this->mTextId
= intval( $row->rev_text_id
);
246 $this->mComment
= $row->rev_comment
;
247 $this->mUserText
= $row->rev_user_text
;
248 $this->mUser
= intval( $row->rev_user
);
249 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
250 $this->mTimestamp
= $row->rev_timestamp
;
251 $this->mDeleted
= intval( $row->rev_deleted
);
253 if( isset( $row->page_latest
) ) {
254 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
255 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
258 $this->mCurrent
= false;
259 $this->mTitle
= null;
262 if( isset( $row->old_text
) ) {
263 $this->mText
= $this->getRevisionText( $row );
267 } elseif( is_array( $row ) ) {
268 // Build a new revision to be saved...
271 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
272 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
273 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
274 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
275 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
276 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
277 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestamp( TS_MW
);
278 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
280 // Enforce spacing trimming on supplied text
281 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
282 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
284 $this->mTitle
= null; # Load on demand if needed
285 $this->mCurrent
= false;
287 throw new MWException( 'Revision constructor passed invalid row format.' );
305 function getTextId() {
306 return $this->mTextId
;
310 * Returns the title of the page associated with this entry.
313 function getTitle() {
314 if( isset( $this->mTitle
) ) {
315 return $this->mTitle
;
317 $dbr =& wfGetDB( DB_SLAVE
);
318 $row = $dbr->selectRow(
319 array( 'page', 'revision' ),
320 array( 'page_namespace', 'page_title' ),
321 array( 'page_id=rev_page',
322 'rev_id' => $this->mId
),
323 'Revision::getTitle' );
325 $this->mTitle
= Title
::makeTitle( $row->page_namespace
,
328 return $this->mTitle
;
332 * Set the title of the revision
333 * @param Title $title
335 function setTitle( $title ) {
336 $this->mTitle
= $title;
347 * Fetch revision's user id if it's available to all users
351 if( $this->isDeleted( self
::DELETED_USER
) ) {
359 * Fetch revision's user id without regard for the current user's permissions
362 function getRawUser() {
367 * Fetch revision's username if it's available to all users
370 function getUserText() {
371 if( $this->isDeleted( self
::DELETED_USER
) ) {
374 return $this->mUserText
;
379 * Fetch revision's username without regard for view restrictions
382 function getRawUserText() {
383 return $this->mUserText
;
387 * Fetch revision comment if it's available to all users
390 function getComment() {
391 if( $this->isDeleted( self
::DELETED_COMMENT
) ) {
394 return $this->mComment
;
399 * Fetch revision comment without regard for the current user's permissions
402 function getRawComment() {
403 return $this->mComment
;
410 return (bool)$this->mMinorEdit
;
414 * int $field one of DELETED_* bitfield constants
417 function isDeleted( $field ) {
418 return ($this->mDeleted
& $field) == $field;
422 * Fetch revision text if it's available to all users
426 if( $this->isDeleted( self
::DELETED_TEXT
) ) {
429 return $this->getRawText();
434 * Fetch revision text without regard for view restrictions
437 function getRawText() {
438 if( is_null( $this->mText
) ) {
439 // Revision text is immutable. Load on demand:
440 $this->mText
= $this->loadText();
448 function getTimestamp() {
449 return wfTimestamp(TS_MW
, $this->mTimestamp
);
455 function isCurrent() {
456 return $this->mCurrent
;
462 function getPrevious() {
463 $prev = $this->mTitle
->getPreviousRevisionID( $this->mId
);
465 return Revision
::newFromTitle( $this->mTitle
, $prev );
475 $next = $this->mTitle
->getNextRevisionID( $this->mId
);
477 return Revision
::newFromTitle( $this->mTitle
, $next );
485 * Get revision text associated with an old or archive row
486 * $row is usually an object from wfFetchRow(), both the flags and the text
487 * field must be included
489 * @param integer $row Id of a row
490 * @param string $prefix table prefix (default 'old_')
491 * @return string $text|false the text requested
493 function getRevisionText( $row, $prefix = 'old_' ) {
494 $fname = 'Revision::getRevisionText';
495 wfProfileIn( $fname );
498 $textField = $prefix . 'text';
499 $flagsField = $prefix . 'flags';
501 if( isset( $row->$flagsField ) ) {
502 $flags = explode( ',', $row->$flagsField );
507 if( isset( $row->$textField ) ) {
508 $text = $row->$textField;
510 wfProfileOut( $fname );
514 # Use external methods for external objects, text in table is URL-only then
515 if ( in_array( 'external', $flags ) ) {
517 @list
($proto,$path)=explode('://',$url,2);
519 wfProfileOut( $fname );
522 require_once('ExternalStore.php');
523 $text=ExternalStore
::fetchFromURL($url);
526 // If the text was fetched without an error, convert it
527 if ( $text !== false ) {
528 if( in_array( 'gzip', $flags ) ) {
529 # Deal with optional compression of archived pages.
530 # This can be done periodically via maintenance/compressOld.php, and
531 # as pages are saved if $wgCompressRevisions is set.
532 $text = gzinflate( $text );
535 if( in_array( 'object', $flags ) ) {
536 # Generic compressed storage
537 $obj = unserialize( $text );
538 if ( !is_object( $obj ) ) {
540 wfProfileOut( $fname );
543 $text = $obj->getText();
546 global $wgLegacyEncoding;
547 if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
548 # Old revisions kept around in a legacy encoding?
549 # Upconvert on demand.
550 global $wgInputEncoding, $wgContLang;
551 $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding . '//IGNORE', $text );
554 wfProfileOut( $fname );
559 * If $wgCompressRevisions is enabled, we will compress data.
560 * The input string is modified in place.
561 * Return value is the flags field: contains 'gzip' if the
562 * data is compressed, and 'utf-8' if we're saving in UTF-8
566 * @param mixed $text reference to a text
569 function compressRevisionText( &$text ) {
570 global $wgCompressRevisions;
573 # Revisions not marked this way will be converted
574 # on load if $wgLegacyCharset is set in the future.
577 if( $wgCompressRevisions ) {
578 if( function_exists( 'gzdeflate' ) ) {
579 $text = gzdeflate( $text );
582 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
585 return implode( ',', $flags );
589 * Insert a new revision into the database, returning the new revision ID
590 * number on success and dies horribly on failure.
592 * @param Database $dbw
595 function insertOn( &$dbw ) {
596 global $wgDefaultExternalStore;
598 $fname = 'Revision::insertOn';
599 wfProfileIn( $fname );
601 $data = $this->mText
;
602 $flags = Revision
::compressRevisionText( $data );
604 # Write to external storage if required
605 if ( $wgDefaultExternalStore ) {
606 if ( is_array( $wgDefaultExternalStore ) ) {
607 // Distribute storage across multiple clusters
608 $store = $wgDefaultExternalStore[mt_rand(0, count( $wgDefaultExternalStore ) - 1)];
610 $store = $wgDefaultExternalStore;
612 require_once('ExternalStore.php');
613 // Store and get the URL
614 $data = ExternalStore
::insert( $store, $data );
616 # This should only happen in the case of a configuration error, where the external store is not valid
617 throw new MWException( "Unable to store text to external storage $store" );
622 $flags .= 'external';
625 # Record the text (or external storage URL) to the text table
626 if( !isset( $this->mTextId
) ) {
627 $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
628 $dbw->insert( 'text',
632 'old_flags' => $flags,
635 $this->mTextId
= $dbw->insertId();
638 # Record the edit in revisions
639 $rev_id = isset( $this->mId
)
641 : $dbw->nextSequenceValue( 'rev_rev_id_val' );
642 $dbw->insert( 'revision',
645 'rev_page' => $this->mPage
,
646 'rev_text_id' => $this->mTextId
,
647 'rev_comment' => $this->mComment
,
648 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
649 'rev_user' => $this->mUser
,
650 'rev_user_text' => $this->mUserText
,
651 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
652 'rev_deleted' => $this->mDeleted
,
656 $this->mId
= !is_null($rev_id) ?
$rev_id : $dbw->insertId();
657 wfProfileOut( $fname );
662 * Lazy-load the revision's text.
663 * Currently hardcoded to the 'text' table storage engine.
668 function loadText() {
669 $fname = 'Revision::loadText';
670 wfProfileIn( $fname );
672 $dbr =& wfGetDB( DB_SLAVE
);
673 $row = $dbr->selectRow( 'text',
674 array( 'old_text', 'old_flags' ),
675 array( 'old_id' => $this->getTextId() ),
679 $dbw =& wfGetDB( DB_MASTER
);
680 $row = $dbw->selectRow( 'text',
681 array( 'old_text', 'old_flags' ),
682 array( 'old_id' => $this->getTextId() ),
686 $text = Revision
::getRevisionText( $row );
687 wfProfileOut( $fname );
693 * Create a new null-revision for insertion into a page's
694 * history. This will not re-save the text, but simply refer
695 * to the text from the previous version.
697 * Such revisions can for instance identify page rename
698 * operations and other such meta-modifications.
700 * @param Database $dbw
701 * @param int $pageId ID number of the page to read from
702 * @param string $summary
706 function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
707 $fname = 'Revision::newNullRevision';
708 wfProfileIn( $fname );
710 $current = $dbw->selectRow(
711 array( 'page', 'revision' ),
712 array( 'page_latest', 'rev_text_id' ),
714 'page_id' => $pageId,
715 'page_latest=rev_id',
720 $revision = new Revision( array(
722 'comment' => $summary,
723 'minor_edit' => $minor,
724 'text_id' => $current->rev_text_id
,
730 wfProfileOut( $fname );
735 * Determine if the current user is allowed to view a particular
736 * field of this revision, if it's marked as deleted.
737 * @param int $field one of self::DELETED_TEXT,
738 * self::DELETED_COMMENT,
742 function userCan( $field ) {
743 if( ( $this->mDeleted
& $field ) == $field ) {
745 $permission = ( $this->mDeleted
& self
::DELETED_RESTRICTED
) == self
::DELETED_RESTRICTED
748 wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
749 return $wgUser->isAllowed( $permission );
757 * Get rev_timestamp from rev_id, without loading the rest of the row
760 static function getTimestampFromID( $id ) {
761 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp',
762 array( 'rev_id' => $id ), __METHOD__
);
763 if ( $timestamp === false ) {
764 # Not in slave, try master
765 $dbw =& wfGetDB( DB_MASTER
);
766 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp',
767 array( 'rev_id' => $id ), __METHOD__
);
772 static function countByPageId( $db, $id ) {
773 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
774 array( 'rev_page' => $id ), __METHOD__
);
776 return $row->revCount
;
781 static function countByTitle( $db, $title ) {
782 $id = $title->getArticleId();
784 return Revision
::countByPageId( $db, $id );
791 * Aliases for backwards compatibility with 1.6
793 define( 'MW_REV_DELETED_TEXT', Revision
::DELETED_TEXT
);
794 define( 'MW_REV_DELETED_COMMENT', Revision
::DELETED_COMMENT
);
795 define( 'MW_REV_DELETED_USER', Revision
::DELETED_USER
);
796 define( 'MW_REV_DELETED_RESTRICTED', Revision
::DELETED_RESTRICTED
);