8 require_once( 'Database.php' );
15 const MW_REV_DELETED_TEXT
= 1;
16 const MW_REV_DELETED_COMMENT
= 2;
17 const MW_REV_DELETED_USER
= 4;
18 const MW_REV_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 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 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 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 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 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 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 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
;
339 * Fetch revision's user id if it's available to all users
343 if( $this->isDeleted( self
::MW_REV_DELETED_USER
) ) {
351 * Fetch revision's user id without regard for the current user's permissions
354 function getRawUser() {
359 * Fetch revision's username if it's available to all users
362 function getUserText() {
363 if( $this->isDeleted( self
::MW_REV_DELETED_USER
) ) {
366 return $this->mUserText
;
371 * Fetch revision's username without regard for view restrictions
374 function getRawUserText() {
375 return $this->mUserText
;
379 * Fetch revision comment if it's available to all users
382 function getComment() {
383 if( $this->isDeleted( self
::MW_REV_DELETED_COMMENT
) ) {
386 return $this->mComment
;
391 * Fetch revision comment without regard for the current user's permissions
394 function getRawComment() {
395 return $this->mComment
;
402 return (bool)$this->mMinorEdit
;
406 * int $field one of MW_REV_DELETED_* bitfield constants
409 function isDeleted( $field ) {
410 return ($this->mDeleted
& $field) == $field;
414 * Fetch revision text if it's available to all users
418 if( $this->isDeleted( self
::MW_REV_DELETED_TEXT
) ) {
421 return $this->getRawText();
426 * Fetch revision text without regard for view restrictions
429 function getRawText() {
430 if( is_null( $this->mText
) ) {
431 // Revision text is immutable. Load on demand:
432 $this->mText
= $this->loadText();
440 function getTimestamp() {
441 return wfTimestamp(TS_MW
, $this->mTimestamp
);
447 function isCurrent() {
448 return $this->mCurrent
;
454 function getPrevious() {
455 $prev = $this->mTitle
->getPreviousRevisionID( $this->mId
);
457 return Revision
::newFromTitle( $this->mTitle
, $prev );
467 $next = $this->mTitle
->getNextRevisionID( $this->mId
);
469 return Revision
::newFromTitle( $this->mTitle
, $next );
477 * Get revision text associated with an old or archive row
478 * $row is usually an object from wfFetchRow(), both the flags and the text
479 * field must be included
481 * @param integer $row Id of a row
482 * @param string $prefix table prefix (default 'old_')
483 * @return string $text|false the text requested
485 function getRevisionText( $row, $prefix = 'old_' ) {
486 $fname = 'Revision::getRevisionText';
487 wfProfileIn( $fname );
490 $textField = $prefix . 'text';
491 $flagsField = $prefix . 'flags';
493 if( isset( $row->$flagsField ) ) {
494 $flags = explode( ',', $row->$flagsField );
499 if( isset( $row->$textField ) ) {
500 $text = $row->$textField;
502 wfProfileOut( $fname );
506 # Use external methods for external objects, text in table is URL-only then
507 if ( in_array( 'external', $flags ) ) {
509 @list
($proto,$path)=explode('://',$url,2);
511 wfProfileOut( $fname );
514 require_once('ExternalStore.php');
515 $text=ExternalStore
::fetchFromURL($url);
518 // If the text was fetched without an error, convert it
519 if ( $text !== false ) {
520 if( in_array( 'gzip', $flags ) ) {
521 # Deal with optional compression of archived pages.
522 # This can be done periodically via maintenance/compressOld.php, and
523 # as pages are saved if $wgCompressRevisions is set.
524 $text = gzinflate( $text );
527 if( in_array( 'object', $flags ) ) {
528 # Generic compressed storage
529 $obj = unserialize( $text );
530 if ( !is_object( $obj ) ) {
532 wfProfileOut( $fname );
535 $text = $obj->getText();
538 global $wgLegacyEncoding;
539 if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) ) {
540 # Old revisions kept around in a legacy encoding?
541 # Upconvert on demand.
542 global $wgInputEncoding, $wgContLang;
543 $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding . '//IGNORE', $text );
546 wfProfileOut( $fname );
551 * If $wgCompressRevisions is enabled, we will compress data.
552 * The input string is modified in place.
553 * Return value is the flags field: contains 'gzip' if the
554 * data is compressed, and 'utf-8' if we're saving in UTF-8
558 * @param mixed $text reference to a text
561 function compressRevisionText( &$text ) {
562 global $wgCompressRevisions;
565 # Revisions not marked this way will be converted
566 # on load if $wgLegacyCharset is set in the future.
569 if( $wgCompressRevisions ) {
570 if( function_exists( 'gzdeflate' ) ) {
571 $text = gzdeflate( $text );
574 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
577 return implode( ',', $flags );
581 * Insert a new revision into the database, returning the new revision ID
582 * number on success and dies horribly on failure.
584 * @param Database $dbw
587 function insertOn( &$dbw ) {
588 global $wgDefaultExternalStore;
590 $fname = 'Revision::insertOn';
591 wfProfileIn( $fname );
593 $data = $this->mText
;
594 $flags = Revision
::compressRevisionText( $data );
596 # Write to external storage if required
597 if ( $wgDefaultExternalStore ) {
598 if ( is_array( $wgDefaultExternalStore ) ) {
599 // Distribute storage across multiple clusters
600 $store = $wgDefaultExternalStore[mt_rand(0, count( $wgDefaultExternalStore ) - 1)];
602 $store = $wgDefaultExternalStore;
604 require_once('ExternalStore.php');
605 // Store and get the URL
606 $data = ExternalStore
::insert( $store, $data );
608 # This should only happen in the case of a configuration error, where the external store is not valid
609 throw new MWException( "Unable to store text to external storage $store" );
614 $flags .= 'external';
617 # Record the text (or external storage URL) to the text table
618 if( !isset( $this->mTextId
) ) {
619 $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
620 $dbw->insert( 'text',
624 'old_flags' => $flags,
627 $this->mTextId
= $dbw->insertId();
630 # Record the edit in revisions
631 $rev_id = isset( $this->mId
)
633 : $dbw->nextSequenceValue( 'rev_rev_id_val' );
634 $dbw->insert( 'revision',
637 'rev_page' => $this->mPage
,
638 'rev_text_id' => $this->mTextId
,
639 'rev_comment' => $this->mComment
,
640 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
641 'rev_user' => $this->mUser
,
642 'rev_user_text' => $this->mUserText
,
643 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
644 'rev_deleted' => $this->mDeleted
,
648 $this->mId
= !is_null($rev_id) ?
$rev_id : $dbw->insertId();
649 wfProfileOut( $fname );
654 * Lazy-load the revision's text.
655 * Currently hardcoded to the 'text' table storage engine.
660 function loadText() {
661 $fname = 'Revision::loadText';
662 wfProfileIn( $fname );
664 $dbr =& wfGetDB( DB_SLAVE
);
665 $row = $dbr->selectRow( 'text',
666 array( 'old_text', 'old_flags' ),
667 array( 'old_id' => $this->getTextId() ),
671 $dbw =& wfGetDB( DB_MASTER
);
672 $row = $dbw->selectRow( 'text',
673 array( 'old_text', 'old_flags' ),
674 array( 'old_id' => $this->getTextId() ),
678 $text = Revision
::getRevisionText( $row );
679 wfProfileOut( $fname );
685 * Create a new null-revision for insertion into a page's
686 * history. This will not re-save the text, but simply refer
687 * to the text from the previous version.
689 * Such revisions can for instance identify page rename
690 * operations and other such meta-modifications.
692 * @param Database $dbw
693 * @param int $pageId ID number of the page to read from
694 * @param string $summary
698 function newNullRevision( &$dbw, $pageId, $summary, $minor ) {
699 $fname = 'Revision::newNullRevision';
700 wfProfileIn( $fname );
702 $current = $dbw->selectRow(
703 array( 'page', 'revision' ),
704 array( 'page_latest', 'rev_text_id' ),
706 'page_id' => $pageId,
707 'page_latest=rev_id',
712 $revision = new Revision( array(
714 'comment' => $summary,
715 'minor_edit' => $minor,
716 'text_id' => $current->rev_text_id
,
722 wfProfileOut( $fname );
727 * Determine if the current user is allowed to view a particular
728 * field of this revision, if it's marked as deleted.
729 * @param int $field one of self::MW_REV_DELETED_TEXT,
730 * self::MW_REV_DELETED_COMMENT,
731 * self::MW_REV_DELETED_USER
734 function userCan( $field ) {
735 if( ( $this->mDeleted
& $field ) == $field ) {
737 $permission = ( $this->mDeleted
& self
::MW_REV_DELETED_RESTRICTED
) == self
::MW_REV_DELETED_RESTRICTED
740 wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
741 return $wgUser->isAllowed( $permission );