<?php
+/**
+ * @package MediaWiki
+ * @todo document
+ */
+/** */
require_once( 'Database.php' );
require_once( 'Article.php' );
+/**
+ * @package MediaWiki
+ * @todo document
+ */
class Revision {
/**
* Load a page revision from a given revision ID number.
function &newFromId( $id ) {
return Revision::newFromConds(
array( 'page_id=rev_page',
- 'rev_id' => IntVal( $id ),
- 'rev_id=old_id' ) );
+ 'rev_id' => IntVal( $id ) ) );
}
/**
* @param int $id
* @return Revision
* @access public
+ * @static
*/
function &newFromTitle( &$title, $id = 0 ) {
if( $id ) {
array( "rev_id=$matchId",
'page_id=rev_page',
'page_namespace' => $title->getNamespace(),
- 'page_title' => $title->getDbkey(),
- 'rev_id=old_id' ) );
+ 'page_title' => $title->getDbkey() ) );
+ }
+
+ /**
+ * Load either the current, or a specified, revision
+ * that's attached to a given page. If not attached
+ * to that page, will return null.
+ *
+ * @param Database $db
+ * @param int $pageid
+ * @param int $id
+ * @return Revision
+ * @access public
+ */
+ function &loadFromPageId( &$db, $pageid, $id = 0 ) {
+ if( $id ) {
+ $matchId = IntVal( $id );
+ } else {
+ $matchId = 'page_latest';
+ }
+ return Revision::loadFromConds(
+ $db,
+ array( "rev_id=$matchId",
+ 'rev_page' => IntVal( $pageid ),
+ 'page_id=rev_page' ) );
+ }
+
+ /**
+ * Load the revision for the given title with the given timestamp.
+ * WARNING: Timestamps may in some circumstances not be unique,
+ * so this isn't the best key to use.
+ *
+ * @param Database $db
+ * @param Title $title
+ * @param string $timestamp
+ * @return Revision
+ * @access public
+ * @static
+ */
+ function &loadFromTimestamp( &$db, &$title, $timestamp ) {
+ return Revision::loadFromConds(
+ $db,
+ array( 'rev_timestamp' => $db->timestamp( $timestamp ),
+ 'page_id=rev_page',
+ 'page_namespace' => $title->getNamespace(),
+ 'page_title' => $title->getDbkey() ) );
}
/**
* @access private
*/
function &newFromConds( $conditions ) {
- $res =& Revision::fetchFromConds( $conditions );
+ $db =& wfGetDB( DB_SLAVE );
+ return Revision::loadFromConds( $db, $conditions );
+ }
+
+ /**
+ * Given a set of conditions, fetch a revision from
+ * the given database connection.
+ *
+ * @param Database $db
+ * @param array $conditions
+ * @return Revision
+ * @static
+ * @access private
+ */
+ function &loadFromConds( &$db, $conditions ) {
+ $res =& Revision::fetchFromConds( $db, $conditions );
if( $res ) {
$row = $res->fetchObject();
$res->free();
*/
function &fetchAllRevisions( &$title ) {
return Revision::fetchFromConds(
+ wfGetDB( DB_SLAVE ),
array( 'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDbkey(),
- 'page_id=rev_page',
- 'rev_id=old_id' ) );
+ 'page_id=rev_page' ) );
}
/**
*/
function &fetchRevision( &$title ) {
return Revision::fetchFromConds(
+ wfGetDB( DB_SLAVE ),
array( 'rev_id=page_latest',
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDbkey(),
- 'page_id=rev_page',
- 'rev_id=old_id' ) );
+ 'page_id=rev_page' ) );
}
- /**
+
+ /**
* Given a set of conditions, return a ResultWrapper
* which will return matching database rows with the
* fields necessary to build Revision objects.
*
+ * @param Database $db
* @param array $conditions
* @return ResultWrapper
* @static
* @access private
*/
- function &fetchFromConds( $conditions ) {
- $dbr =& wfGetDB( DB_SLAVE );
- $res = $dbr->select(
- array( 'page', 'revision', 'text' ),
+ function &fetchFromConds( &$db, $conditions ) {
+ $res = $db->select(
+ array( 'page', 'revision' ),
array( 'page_namespace',
'page_title',
'page_latest',
'rev_id',
'rev_page',
+ 'rev_text_id',
'rev_comment',
'rev_user_text',
'rev_user',
'rev_minor_edit',
'rev_timestamp',
- 'old_flags',
- 'old_text' ),
+ 'rev_deleted' ),
$conditions,
- 'Revision::fetchRow' );
- return $dbr->resultObject( $res );
+ 'Revision::fetchRow',
+ array( 'LIMIT' => 1 ) );
+ return $db->resultObject( $res );
}
/**
* @access private
*/
function Revision( $row ) {
- $this->mId = IntVal( $row->rev_id );
- $this->mPage = IntVal( $row->rev_page );
- $this->mComment = $row->rev_comment;
- $this->mUserText = $row->rev_user_text;
- $this->mUser = IntVal( $row->rev_user );
- $this->mMinorEdit = IntVal( $row->rev_minor_edit );
- $this->mTimestamp = $row->rev_timestamp;
+ if( is_object( $row ) ) {
+ $this->mId = IntVal( $row->rev_id );
+ $this->mPage = IntVal( $row->rev_page );
+ $this->mTextId = IntVal( $row->rev_text_id );
+ $this->mComment = $row->rev_comment;
+ $this->mUserText = $row->rev_user_text;
+ $this->mUser = IntVal( $row->rev_user );
+ $this->mMinorEdit = IntVal( $row->rev_minor_edit );
+ $this->mTimestamp = $row->rev_timestamp;
+ $this->mDeleted = IntVal( $row->rev_deleted );
- $this->mCurrent = ( $row->rev_id == $row->page_latest );
- $this->mTitle = Title::makeTitle( $row->page_namespace,
- $row->page_title );
- $this->mText = $this->getRevisionText( $row );
+ $this->mCurrent = ( $row->rev_id == $row->page_latest );
+ $this->mTitle = Title::makeTitle( $row->page_namespace,
+ $row->page_title );
+
+ if( isset( $row->old_text ) ) {
+ $this->mText = $this->getRevisionText( $row );
+ } else {
+ $this->mText = null;
+ }
+ } elseif( is_array( $row ) ) {
+ // Build a new revision to be saved...
+ global $wgUser;
+
+ $this->mId = isset( $row['id'] ) ? IntVal( $row['id'] ) : null;
+ $this->mPage = isset( $row['page'] ) ? IntVal( $row['page'] ) : null;
+ $this->mTextId = isset( $row['text_id'] ) ? IntVal( $row['text_id'] ) : null;
+ $this->mUserText = isset( $row['user_text'] ) ? StrVal( $row['user_text'] ) : $wgUser->getName();
+ $this->mUser = isset( $row['user'] ) ? IntVal( $row['user'] ) : $wgUser->getId();
+ $this->mMinorEdit = isset( $row['minor_edit'] ) ? IntVal( $row['minor_edit'] ) : 0;
+ $this->mTimestamp = isset( $row['timestamp'] ) ? StrVal( $row['timestamp'] ) : wfTimestamp( TS_MW );
+ $this->mDeleted = isset( $row['deleted'] ) ? IntVal( $row['deleted'] ) : 0;
+
+ // Enforce spacing trimming on supplied text
+ $this->mComment = isset( $row['comment'] ) ? trim( StrVal( $row['comment'] ) ) : null;
+ $this->mText = isset( $row['text'] ) ? rtrim( StrVal( $row['text'] ) ) : null;
+
+ $this->mTitle = null; # Load on demand if needed
+ $this->mCurrent = false;
+ } else {
+ wfDebugDieBacktrace( 'Revision constructor passed invalid row format.' );
+ }
}
- /** @+
+ /**#@+
* @access public
*/
return $this->mId;
}
+ /**
+ * @return int
+ */
+ function getTextId() {
+ return $this->mTextId;
+ }
+
/**
* Returns the title of the page associated with this entry.
* @return Title
return $this->mTitle;
}
+ /**
+ * @return int
+ */
+ function getPage() {
+ return $this->mPage;
+ }
+
/**
* @return int
*/
return (bool)$this->mMinorEdit;
}
+ /**
+ * @return bool
+ */
+ function isDeleted() {
+ return (bool)$this->mDeleted;
+ }
+
/**
* @return string
*/
function getText() {
+ if( is_null( $this->mText ) ) {
+ // Revision text is immutable. Load on demand:
+ $this->mText = $this->loadText();
+ }
return $this->mText;
}
$next = $this->mTitle->getNextRevisionID( $this->mId );
return Revision::newFromTitle( $this->mTitle, $next );
}
- /** @- */
+ /**#@-*/
/**
* Get revision text associated with an old or archive row
return false;
}
+ # Use external methods for external objects, text in table is URL-only then
+ if ( in_array( 'external', $flags ) ) {
+ $url=$text;
+ @list($proto,$path)=explode('://',$url,2);
+ if ($path=="") {
+ wfProfileOut( $fname );
+ return false;
+ }
+ require_once('ExternalStore.php');
+ $text=ExternalStore::fetchFromURL($url);
+ }
+
if( in_array( 'gzip', $flags ) ) {
# Deal with optional compression of archived pages.
# This can be done periodically via maintenance/compressOld.php, and
* @return string
*/
function compressRevisionText( &$text ) {
- global $wgCompressRevisions, $wgUseLatin1;
+ global $wgCompressRevisions;
$flags = array();
- if( !$wgUseLatin1 ) {
- # Revisions not marked this way will be converted
- # on load if $wgLegacyCharset is set in the future.
- $flags[] = 'utf-8';
- }
+
+ # Revisions not marked this way will be converted
+ # on load if $wgLegacyCharset is set in the future.
+ $flags[] = 'utf-8';
+
if( $wgCompressRevisions ) {
if( function_exists( 'gzdeflate' ) ) {
$text = gzdeflate( $text );
}
return implode( ',', $flags );
}
+
+ /**
+ * Insert a new revision into the database, returning the new revision ID
+ * number on success and dies horribly on failure.
+ *
+ * @param Database $dbw
+ * @return int
+ */
+ function insertOn( &$dbw ) {
+ $fname = 'Revision::insertOn';
+ wfProfileIn( $fname );
+
+ $mungedText = $this->mText;
+ $flags = Revision::compressRevisionText( $mungedText );
+
+ # Record the text to the text table
+ if( !isset( $this->mTextId ) ) {
+ $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
+ $dbw->insert( 'text',
+ array(
+ 'old_id' => $old_id,
+ 'old_text' => $mungedText,
+ 'old_flags' => $flags,
+ ), $fname
+ );
+ $this->mTextId = $dbw->insertId();
+ }
+
+ # Record the edit in revisions
+ $rev_id = isset( $this->mId )
+ ? $this->mId
+ : $dbw->nextSequenceValue( 'rev_rev_id_val' );
+ $dbw->insert( 'revision',
+ array(
+ 'rev_id' => $rev_id,
+ 'rev_page' => $this->mPage,
+ 'rev_text_id' => $this->mTextId,
+ 'rev_comment' => $this->mComment,
+ 'rev_minor_edit' => $this->mMinorEdit ? 1 : 0,
+ 'rev_user' => $this->mUser,
+ 'rev_user_text' => $this->mUserText,
+ 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp ),
+ 'rev_deleted' => $this->mDeleted,
+ ), $fname
+ );
+
+ $this->mId = $dbw->insertId();
+
+ wfProfileOut( $fname );
+ return $this->mId;
+ }
+
+ /**
+ * Lazy-load the revision's text.
+ * Currently hardcoded to the 'text' table storage engine.
+ *
+ * @return string
+ * @access private
+ */
+ function loadText() {
+ $fname = 'Revision::loadText';
+ wfProfileIn( $fname );
+
+ $dbr =& wfGetDB( DB_SLAVE );
+ $row = $dbr->selectRow( 'text',
+ array( 'old_text', 'old_flags' ),
+ array( 'old_id' => $this->getTextId() ),
+ $fname);
+
+ $text = Revision::getRevisionText( $row );
+ wfProfileOut( $fname );
+
+ return $text;
+ }
-
+ /**
+ * Create a new null-revision for insertion into a page's
+ * history. This will not re-save the text, but simply refer
+ * to the text from the previous version.
+ *
+ * Such revisions can for instance identify page rename
+ * operations and other such meta-modifications.
+ *
+ * @param Database $dbw
+ * @param int $pageId ID number of the page to read from
+ * @param string $summary
+ * @param bool $minor
+ * @return Revision
+ */
+ function &newNullRevision( &$dbw, $pageId, $summary, $minor ) {
+ $fname = 'Revision::newNullRevision';
+ wfProfileIn( $fname );
+
+ $current = $dbw->selectRow(
+ array( 'page', 'revision' ),
+ array( 'page_latest', 'rev_text_id' ),
+ array(
+ 'page_id' => $pageId,
+ 'page_latest=rev_id',
+ ),
+ $fname );
+
+ if( $current ) {
+ $revision = new Revision( array(
+ 'page' => $pageId,
+ 'comment' => $summary,
+ 'minor_edit' => $minor,
+ 'text_id' => $current->rev_text_id,
+ ) );
+ } else {
+ $revision = null;
+ }
+
+ wfProfileOut( $fname );
+ return $revision;
+ }
+
}
-
-
-?>
\ No newline at end of file
+?>