<?php
/**
- * @todo document
+ * Representation of a page version.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
* @file
*/
* @todo document
*/
class Revision {
+ protected $mId;
+ protected $mPage;
+ protected $mUserText;
+ protected $mOrigUserText;
+ protected $mUser;
+ protected $mMinorEdit;
+ protected $mTimestamp;
+ protected $mDeleted;
+ protected $mSize;
+ protected $mSha1;
+ protected $mParentId;
+ protected $mComment;
+ protected $mText;
+ protected $mTextRow;
+ protected $mTitle;
+ protected $mCurrent;
+ protected $mContentModel;
+ protected $mContentFormat;
+ protected $mContent;
+ protected $mContentHandler;
+
const DELETED_TEXT = 1;
const DELETED_COMMENT = 2;
const DELETED_USER = 4;
* Load a page revision from a given revision ID number.
* Returns null if no such revision can be found.
*
- * @param int $id
- * @access public
- * @static
+ * @param $id Integer
+ * @return Revision or null
*/
public static function newFromId( $id ) {
- return Revision::newFromConds(
- array( 'page_id=rev_page',
- 'rev_id' => intval( $id ) ) );
+ return Revision::newFromConds( array( 'rev_id' => intval( $id ) ) );
}
/**
* that's attached to a given title. If not attached
* to that title, will return null.
*
- * @param Title $title
- * @param int $id
- * @return Revision
+ * @param $title Title
+ * @param $id Integer (optional)
+ * @return Revision or null
*/
public static function newFromTitle( $title, $id = 0 ) {
- $conds = array(
- 'page_namespace' => $title->getNamespace(),
- 'page_title' => $title->getDBkey()
+ $conds = array(
+ 'page_namespace' => $title->getNamespace(),
+ 'page_title' => $title->getDBkey()
);
if ( $id ) {
// Use the specified ID
$dbw = wfGetDB( DB_MASTER );
$latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
if ( $latest === false ) {
- // Page does not exist
- return null;
+ return null; // page does not exist
}
$conds['rev_id'] = $latest;
} else {
// Use a join to get the latest revision
$conds[] = 'rev_id=page_latest';
}
- $conds[] = 'page_id=rev_page';
+ return Revision::newFromConds( $conds );
+ }
+
+ /**
+ * Load either the current, or a specified, revision
+ * that's attached to a given page ID.
+ * Returns null if no such revision can be found.
+ *
+ * @param $revId Integer
+ * @param $pageId Integer (optional)
+ * @return Revision or null
+ */
+ public static function newFromPageId( $pageId, $revId = 0 ) {
+ $conds = array( 'page_id' => $pageId );
+ if ( $revId ) {
+ $conds['rev_id'] = $revId;
+ } elseif ( wfGetLB()->getServerCount() > 1 ) {
+ // Get the latest revision ID from the master
+ $dbw = wfGetDB( DB_MASTER );
+ $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
+ if ( $latest === false ) {
+ return null; // page does not exist
+ }
+ $conds['rev_id'] = $latest;
+ } else {
+ $conds[] = 'rev_id = page_latest';
+ }
return Revision::newFromConds( $conds );
}
/**
* Make a fake revision object from an archive table row. This is queried
* for permissions or even inserted (as in Special:Undelete)
- * @fixme: should be a subclass for RevisionDelete. [TS]
+ * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
+ *
+ * @param $row
+ * @param $overrides array
+ *
+ * @return Revision
*/
public static function newFromArchiveRow( $row, $overrides = array() ) {
+ global $wgContentHandlerUseDB;
+
$attribs = $overrides + array(
- 'page' => isset( $row->page_id ) ? $row->page_id : null,
+ 'page' => isset( $row->ar_page_id ) ? $row->ar_page_id : null,
'id' => isset( $row->ar_rev_id ) ? $row->ar_rev_id : null,
'comment' => $row->ar_comment,
'user' => $row->ar_user,
'minor_edit' => $row->ar_minor_edit,
'text_id' => isset( $row->ar_text_id ) ? $row->ar_text_id : null,
'deleted' => $row->ar_deleted,
- 'len' => $row->ar_len);
+ 'len' => $row->ar_len,
+ 'sha1' => isset( $row->ar_sha1 ) ? $row->ar_sha1 : null,
+ 'content_model' => isset( $row->ar_content_model ) ? $row->ar_content_model : null,
+ 'content_format' => isset( $row->ar_content_format ) ? $row->ar_content_format : null,
+ );
+
+ if ( !$wgContentHandlerUseDB ) {
+ unset( $attribs['content_model'] );
+ unset( $attribs['content_format'] );
+ }
+
if ( isset( $row->ar_text ) && !$row->ar_text_id ) {
// Pre-1.5 ar_text row
$attribs['text'] = self::getRevisionText( $row, 'ar_' );
+ if ( $attribs['text'] === false ) {
+ throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
+ }
}
return new self( $attribs );
}
+ /**
+ * @since 1.19
+ *
+ * @param $row
+ * @return Revision
+ */
+ public static function newFromRow( $row ) {
+ return new self( $row );
+ }
+
/**
* Load a page revision from a given revision ID number.
* Returns null if no such revision can be found.
*
- * @param Database $db
- * @param int $id
- * @access public
- * @static
+ * @param $db DatabaseBase
+ * @param $id Integer
+ * @return Revision or null
*/
public static function loadFromId( $db, $id ) {
- return Revision::loadFromConds( $db,
- array( 'page_id=rev_page',
- 'rev_id' => intval( $id ) ) );
+ return Revision::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
}
/**
* 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
- * @static
+ * @param $db DatabaseBase
+ * @param $pageid Integer
+ * @param $id Integer
+ * @return Revision or null
*/
public static function loadFromPageId( $db, $pageid, $id = 0 ) {
- $conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
+ $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
if( $id ) {
- $conds['rev_id']=intval($id);
+ $conds['rev_id'] = intval( $id );
} else {
- $conds[]='rev_id=page_latest';
+ $conds[] = 'rev_id=page_latest';
}
return Revision::loadFromConds( $db, $conds );
}
* that's attached to a given page. If not attached
* to that page, will return null.
*
- * @param Database $db
- * @param Title $title
- * @param int $id
- * @return Revision
- * @access public
- * @static
+ * @param $db DatabaseBase
+ * @param $title Title
+ * @param $id Integer
+ * @return Revision or null
*/
public static function loadFromTitle( $db, $title, $id = 0 ) {
if( $id ) {
} else {
$matchId = 'page_latest';
}
- return Revision::loadFromConds(
- $db,
+ return Revision::loadFromConds( $db,
array( "rev_id=$matchId",
- 'page_id=rev_page',
- 'page_namespace' => $title->getNamespace(),
- 'page_title' => $title->getDBkey() ) );
+ 'page_namespace' => $title->getNamespace(),
+ 'page_title' => $title->getDBkey() )
+ );
}
/**
* 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
+ * @param $db DatabaseBase
+ * @param $title Title
+ * @param $timestamp String
+ * @return Revision or null
*/
public static function loadFromTimestamp( $db, $title, $timestamp ) {
- return Revision::loadFromConds(
- $db,
+ return Revision::loadFromConds( $db,
array( 'rev_timestamp' => $db->timestamp( $timestamp ),
- 'page_id=rev_page',
- 'page_namespace' => $title->getNamespace(),
- 'page_title' => $title->getDBkey() ) );
+ 'page_namespace' => $title->getNamespace(),
+ 'page_title' => $title->getDBkey() )
+ );
}
/**
* Given a set of conditions, fetch a revision.
*
- * @param array $conditions
- * @return Revision
- * @access private
- * @static
+ * @param $conditions Array
+ * @return Revision or null
*/
public static function newFromConds( $conditions ) {
$db = wfGetDB( DB_SLAVE );
- $row = Revision::loadFromConds( $db, $conditions );
- if( is_null( $row ) && wfGetLB()->getServerCount() > 1 ) {
+ $rev = Revision::loadFromConds( $db, $conditions );
+ if( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
$dbw = wfGetDB( DB_MASTER );
- $row = Revision::loadFromConds( $dbw, $conditions );
+ $rev = Revision::loadFromConds( $dbw, $conditions );
}
- return $row;
+ return $rev;
}
/**
* Given a set of conditions, fetch a revision from
* the given database connection.
*
- * @param Database $db
- * @param array $conditions
- * @return Revision
- * @access private
- * @static
+ * @param $db DatabaseBase
+ * @param $conditions Array
+ * @return Revision or null
*/
private static function loadFromConds( $db, $conditions ) {
$res = Revision::fetchFromConds( $db, $conditions );
if( $res ) {
$row = $res->fetchObject();
- $res->free();
if( $row ) {
$ret = new Revision( $row );
return $ret;
* fetch all of a given page's revisions in turn.
* Each row can be fed to the constructor to get objects.
*
- * @param Title $title
+ * @param $title Title
* @return ResultWrapper
- * @access public
- * @static
*/
public static 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' ) );
+ 'page_namespace' => $title->getNamespace(),
+ 'page_title' => $title->getDBkey() )
+ );
}
/**
* which will return matching database rows with the
* fields necessary to build Revision objects.
*
- * @param Database $db
- * @param array $conditions
+ * @param $db DatabaseBase
+ * @param $conditions Array
* @return ResultWrapper
- * @access private
- * @static
*/
private static function fetchFromConds( $db, $conditions ) {
- $fields = self::selectFields();
- $fields[] = 'page_namespace';
- $fields[] = 'page_title';
- $fields[] = 'page_latest';
- $res = $db->select(
- array( 'page', 'revision' ),
+ $fields = array_merge(
+ self::selectFields(),
+ self::selectPageFields(),
+ self::selectUserFields()
+ );
+ return $db->select(
+ array( 'revision', 'page', 'user' ),
$fields,
$conditions,
__METHOD__,
- array( 'LIMIT' => 1 ) );
- $ret = $db->resultObject( $res );
- return $ret;
+ array( 'LIMIT' => 1 ),
+ array( 'page' => self::pageJoinCond(), 'user' => self::userJoinCond() )
+ );
+ }
+
+ /**
+ * Return the value of a select() JOIN conds array for the user table.
+ * This will get user table rows for logged-in users.
+ * @since 1.19
+ * @return Array
+ */
+ public static function userJoinCond() {
+ return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
+ }
+
+ /**
+ * Return the value of a select() page conds array for the paeg table.
+ * This will assure that the revision(s) are not orphaned from live pages.
+ * @since 1.19
+ * @return Array
+ */
+ public static function pageJoinCond() {
+ return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
}
/**
* Return the list of revision fields that should be selected to create
* a new revision.
+ * @return array
*/
- static function selectFields() {
- return array(
+ public static function selectFields() {
+ global $wgContentHandlerUseDB;
+
+ $fields = array(
'rev_id',
'rev_page',
'rev_text_id',
'rev_timestamp',
'rev_comment',
- 'rev_user_text,'.
+ 'rev_user_text',
'rev_user',
'rev_minor_edit',
'rev_deleted',
'rev_len',
- 'rev_parent_id'
+ 'rev_parent_id',
+ 'rev_sha1',
);
+
+ if ( $wgContentHandlerUseDB ) {
+ $fields[] = 'rev_content_format';
+ $fields[] = 'rev_content_model';
+ }
+
+ return $fields;
}
-
+
/**
- * Return the list of text fields that should be selected to read the
+ * Return the list of text fields that should be selected to read the
* revision text
+ * @return array
*/
- static function selectTextFields() {
+ public static function selectTextFields() {
return array(
'old_text',
'old_flags'
);
}
+
/**
* Return the list of page fields that should be selected from page table
+ * @return array
*/
- static function selectPageFields() {
+ public static function selectPageFields() {
return array(
'page_namespace',
'page_title',
+ 'page_id',
'page_latest'
);
}
/**
- * @param object $row
+ * Return the list of user fields that should be selected from user table
+ * @return array
+ */
+ public static function selectUserFields() {
+ return array( 'user_name' );
+ }
+
+ /**
+ * Constructor
+ *
+ * @param $row Mixed: either a database row or an array
* @access private
*/
- function Revision( $row ) {
+ function __construct( $row ) {
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 );
- if( !isset( $row->rev_parent_id ) )
- $this->mParentId = is_null($row->rev_parent_id) ? null : 0;
- else
+ if( !isset( $row->rev_parent_id ) ) {
+ $this->mParentId = is_null( $row->rev_parent_id ) ? null : 0;
+ } else {
$this->mParentId = intval( $row->rev_parent_id );
+ }
- if( !isset( $row->rev_len ) || is_null( $row->rev_len ) )
+ if( !isset( $row->rev_len ) || is_null( $row->rev_len ) ) {
$this->mSize = null;
- else
+ } else {
$this->mSize = intval( $row->rev_len );
+ }
+
+ if ( !isset( $row->rev_sha1 ) ) {
+ $this->mSha1 = null;
+ } else {
+ $this->mSha1 = $row->rev_sha1;
+ }
if( isset( $row->page_latest ) ) {
$this->mCurrent = ( $row->rev_id == $row->page_latest );
- $this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title );
- $this->mTitle->resetArticleID( $this->mPage );
+ $this->mTitle = Title::newFromRow( $row );
} else {
$this->mCurrent = false;
$this->mTitle = null;
}
+ if( !isset( $row->rev_content_model ) || is_null( $row->rev_content_model ) ) {
+ $this->mContentModel = null; # determine on demand if needed
+ } else {
+ $this->mContentModel = intval( $row->rev_content_model );
+ }
+
+ if( !isset( $row->rev_content_format ) || is_null( $row->rev_content_format ) ) {
+ $this->mContentFormat = null; # determine on demand if needed
+ } else {
+ $this->mContentFormat = intval( $row->rev_content_format );
+ }
+
// Lazy extraction...
$this->mText = null;
if( isset( $row->old_text ) ) {
// 'text' table row entry will be lazy-loaded
$this->mTextRow = null;
}
+
+ // Use user_name for users and rev_user_text for IPs...
+ $this->mUserText = null; // lazy load if left null
+ if ( $this->mUser == 0 ) {
+ $this->mUserText = $row->rev_user_text; // IP user
+ } elseif ( isset( $row->user_name ) ) {
+ $this->mUserText = $row->user_name; // logged-in user
+ }
+ $this->mOrigUserText = $row->rev_user_text;
} elseif( is_array( $row ) ) {
// Build a new revision to be saved...
- global $wgUser;
+ global $wgUser; // ugh
+
+
+ # if we have a content object, use it to set the model and type
+ if ( !empty( $row['content'] ) ) {
+ if ( !empty( $row['text_id'] ) ) { #FIXME: when is that set? test with external store setup! check out insertOn()
+ throw new MWException( "Text already stored in external store (id {$row['text_id']}), can't serialize content object" );
+ }
+
+ $row['content_model'] = $row['content']->getModel();
+ # note: mContentFormat is initializes later accordingly
+ # note: content is serialized later in this method!
+ # also set text to null?
+ }
$this->mId = isset( $row['id'] ) ? intval( $row['id'] ) : null;
$this->mPage = isset( $row['page'] ) ? intval( $row['page'] ) : 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->mTimestamp = isset( $row['timestamp'] ) ? strval( $row['timestamp'] ) : wfTimestampNow();
$this->mDeleted = isset( $row['deleted'] ) ? intval( $row['deleted'] ) : 0;
$this->mSize = isset( $row['len'] ) ? intval( $row['len'] ) : null;
$this->mParentId = isset( $row['parent_id'] ) ? intval( $row['parent_id'] ) : null;
+ $this->mSha1 = isset( $row['sha1'] ) ? strval( $row['sha1'] ) : null;
+
+ $this->mContentModel = isset( $row['content_model'] ) ? intval( $row['content_model'] ) : null;
+ $this->mContentFormat = isset( $row['content_format'] ) ? intval( $row['content_format'] ) : null;
// 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->mTextRow = null;
+ # if we have a content object, override mText and mContentModel
+ if ( !empty( $row['content'] ) ) {
+ $handler = $this->getContentHandler();
+ $this->mContent = $row['content'];
+
+ $this->mContentModel = $this->mContent->getModel();
+ $this->mContentHandler = null;
+
+ $this->mText = $handler->serializeContent( $row['content'], $this->getContentFormat() );
+ } elseif ( !is_null( $this->mText ) ) {
+ $handler = $this->getContentHandler();
+ $this->mContent = $handler->unserializeContent( $this->mText );
+ }
+
$this->mTitle = null; # Load on demand if needed
- $this->mCurrent = false;
- # If we still have no len_size, see it we have the text to figure it out
- if ( !$this->mSize )
- $this->mSize = is_null($this->mText) ? null : strlen($this->mText);
+ $this->mCurrent = false; #XXX: really? we are about to create a revision. it will usually then be the current one.
+
+ # If we still have no length, see it we have the text to figure it out
+ if ( !$this->mSize ) {
+ if ( !is_null( $this->mContent ) ) {
+ $this->mSize = $this->mContent->getSize();
+ } else {
+ #XXX: my be inconsistent with the notion of "size" use for the present content model
+ #NOTE: should never happen if we have either text or content object!
+ $this->mSize = is_null( $this->mText ) ? null : strlen( $this->mText );
+ }
+ }
+
+ # Same for sha1
+ if ( $this->mSha1 === null ) {
+ $this->mSha1 = is_null( $this->mText ) ? null : self::base36Sha1( $this->mText );
+ }
+
+ $this->getContentModel(); # force lazy init
+ $this->getContentFormat(); # force lazy init
} else {
throw new MWException( 'Revision constructor passed invalid row format.' );
}
- $this->mUnpatrolled = NULL;
- }
+ $this->mUnpatrolled = null;
- /**#@+
- * @access public
- */
+ // @TODO: add support for ar_content_format, ar_content_model, rev_content_format, rev_content_model to API
+ // @TODO: get rid of $mText
+ }
/**
* Get revision ID
- * @return int
+ *
+ * @return Integer
*/
public function getId() {
return $this->mId;
}
+ /**
+ * Set the revision ID
+ *
+ * @since 1.19
+ * @param $id Integer
+ */
+ public function setId( $id ) {
+ $this->mId = $id;
+ }
+
/**
* Get text row ID
- * @return int
+ *
+ * @return Integer
*/
public function getTextId() {
return $this->mTextId;
/**
* Get parent revision ID (the original previous page revision)
- * @return int
+ *
+ * @return Integer|null
*/
public function getParentId() {
return $this->mParentId;
/**
* Returns the length of the text in this revision, or null if unknown.
- * @return int
+ *
+ * @return Integer
*/
public function getSize() {
return $this->mSize;
}
+ /**
+ * Returns the base36 sha1 of the text in this revision, or null if unknown.
+ *
+ * @return String
+ */
+ public function getSha1() {
+ return $this->mSha1;
+ }
+
/**
* Returns the title of the page associated with this entry.
+ *
* @return Title
*/
public function getTitle() {
$dbr = wfGetDB( DB_SLAVE );
$row = $dbr->selectRow(
array( 'page', 'revision' ),
- array( 'page_namespace', 'page_title' ),
+ self::selectPageFields(),
array( 'page_id=rev_page',
- 'rev_id' => $this->mId ),
- 'Revision::getTitle' );
- if( $row ) {
- $this->mTitle = Title::makeTitle( $row->page_namespace,
- $row->page_title );
+ 'rev_id' => $this->mId ),
+ __METHOD__ );
+ if ( $row ) {
+ $this->mTitle = Title::newFromRow( $row );
}
return $this->mTitle;
}
/**
* Set the title of the revision
- * @param Title $title
+ *
+ * @param $title Title
*/
public function setTitle( $title ) {
$this->mTitle = $title;
/**
* Get the page ID
- * @return int
+ *
+ * @return Integer
*/
public function getPage() {
return $this->mPage;
/**
* Fetch revision's user id if it's available to the specified audience.
- * If the specified audience does not have access to it, zero will be
+ * If the specified audience does not have access to it, zero will be
* returned.
*
- * @param integer $audience One of:
+ * @param $audience Integer: one of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the ID regardless of permissions
- *
- *
- * @return int
+ * @param $user User object to check for, only if FOR_THIS_USER is passed
+ * to the $audience parameter
+ * @return Integer
*/
- public function getUser( $audience = self::FOR_PUBLIC ) {
+ public function getUser( $audience = self::FOR_PUBLIC, User $user = null ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
return 0;
- } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
+ } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER, $user ) ) {
return 0;
} else {
return $this->mUser;
/**
* Fetch revision's user id without regard for the current user's permissions
- * @return string
+ *
+ * @return String
*/
public function getRawUser() {
return $this->mUser;
/**
* Fetch revision's username if it's available to the specified audience.
- * If the specified audience does not have access to the username, an
+ * If the specified audience does not have access to the username, an
* empty string will be returned.
*
- * @param integer $audience One of:
+ * @param $audience Integer: one of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
- *
+ * @param $user User object to check for, only if FOR_THIS_USER is passed
+ * to the $audience parameter
* @return string
*/
- public function getUserText( $audience = self::FOR_PUBLIC ) {
+ public function getUserText( $audience = self::FOR_PUBLIC, User $user = null ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
- return "";
- } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
- return "";
+ return '';
+ } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER, $user ) ) {
+ return '';
} else {
- return $this->mUserText;
+ return $this->getRawUserText();
}
}
/**
* Fetch revision's username without regard for view restrictions
- * @return string
+ *
+ * @return String
*/
public function getRawUserText() {
+ if ( $this->mUserText === null ) {
+ $this->mUserText = User::whoIs( $this->mUser ); // load on demand
+ if ( $this->mUserText === false ) {
+ # This shouldn't happen, but it can if the wiki was recovered
+ # via importing revs and there is no user table entry yet.
+ $this->mUserText = $this->mOrigUserText;
+ }
+ }
return $this->mUserText;
}
/**
* Fetch revision comment if it's available to the specified audience.
- * If the specified audience does not have access to the comment, an
+ * If the specified audience does not have access to the comment, an
* empty string will be returned.
*
- * @param integer $audience One of:
+ * @param $audience Integer: one of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
- *
- * @return string
+ * @param $user User object to check for, only if FOR_THIS_USER is passed
+ * to the $audience parameter
+ * @return String
*/
- function getComment( $audience = self::FOR_PUBLIC ) {
+ function getComment( $audience = self::FOR_PUBLIC, User $user = null ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
- return "";
- } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_COMMENT ) ) {
- return "";
+ return '';
+ } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_COMMENT, $user ) ) {
+ return '';
} else {
return $this->mComment;
}
/**
* Fetch revision comment without regard for the current user's permissions
- * @return string
+ *
+ * @return String
*/
public function getRawComment() {
return $this->mComment;
}
/**
- * @return bool
+ * @return Boolean
*/
public function isMinor() {
return (bool)$this->mMinorEdit;
}
-
+
/**
- * @return int rcid of the unpatrolled row, zero if there isn't one
+ * @return Integer rcid of the unpatrolled row, zero if there isn't one
*/
public function isUnpatrolled() {
- if( $this->mUnpatrolled !== NULL ) {
+ if( $this->mUnpatrolled !== null ) {
return $this->mUnpatrolled;
}
$dbr = wfGetDB( DB_SLAVE );
}
/**
- * int $field one of DELETED_* bitfield constants
- * @return bool
+ * @param $field int one of DELETED_* bitfield constants
+ *
+ * @return Boolean
*/
public function isDeleted( $field ) {
- return ($this->mDeleted & $field) == $field;
+ return ( $this->mDeleted & $field ) == $field;
}
-
+
/**
* Get the deletion bitfield of the revision
- */
+ *
+ * @return int
+ */
public function getVisibility() {
return (int)$this->mDeleted;
}
/**
* Fetch revision text if it's available to the specified audience.
- * If the specified audience does not have the ability to view this
+ * If the specified audience does not have the ability to view this
* revision, an empty string will be returned.
*
- * @param integer $audience One of:
+ * @param $audience Integer: one of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
+ * @param $user User object to check for, only if FOR_THIS_USER is passed
+ * to the $audience parameter
+ * @return String
+ * @deprecated in 1.WD, use getContent() instead
+ */
+ public function getText( $audience = self::FOR_PUBLIC, User $user = null ) { #FIXME: deprecated, replace usage! #FIXME: used a LOT!
+ wfDeprecated( __METHOD__, '1.WD' );
+
+ $content = $this->getContent();
+ return ContentHandler::getContentText( $content ); # returns the raw content text, if applicable
+ }
+
+ /**
+ * Fetch revision content if it's available to the specified audience.
+ * If the specified audience does not have the ability to view this
+ * revision, null will be returned.
*
+ * @param $audience Integer: one of:
+ * Revision::FOR_PUBLIC to be displayed to all users
+ * Revision::FOR_THIS_USER to be displayed to $wgUser
+ * Revision::RAW get the text regardless of permissions
+ * @param $user User object to check for, only if FOR_THIS_USER is passed
+ * to the $audience parameter
+ * @return Content
*
- * @return string
+ * @since 1.WD
*/
- public function getText( $audience = self::FOR_PUBLIC ) {
+ public function getContent( $audience = self::FOR_PUBLIC, User $user = null ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_TEXT ) ) {
- return "";
- } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_TEXT ) ) {
- return "";
+ return null;
+ } elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_TEXT, $user ) ) {
+ return null;
} else {
- return $this->getRawText();
+ return $this->getContentInternal();
}
}
/**
* Alias for getText(Revision::FOR_THIS_USER)
+ *
+ * @deprecated since 1.17
+ * @return String
*/
public function revText() {
+ wfDeprecated( __METHOD__, '1.17' );
return $this->getText( self::FOR_THIS_USER );
}
/**
* Fetch revision text without regard for view restrictions
- * @return string
+ *
+ * @return String
*/
- public function getRawText() {
- if( is_null( $this->mText ) ) {
- // Revision text is immutable. Load on demand:
- $this->mText = $this->loadText();
+ public function getRawText() { #FIXME: deprecated, replace usage!
+ return $this->getText( self::RAW );
+ }
+
+ protected function getContentInternal() {
+ if( is_null( $this->mContent ) ) {
+ // Revision is immutable. Load on demand:
+
+ $handler = $this->getContentHandler();
+ $format = $this->getContentFormat();
+ $title = $this->getTitle();
+
+ if( is_null( $this->mText ) ) {
+ // Load text on demand:
+ $this->mText = $this->loadText();
+ }
+
+ $this->mContent = is_null( $this->mText ) ? null : $handler->unserializeContent( $this->mText, $format );
}
- return $this->mText;
+
+ return $this->mContent;
}
/**
- * @return string
+ * Returns the content model for this revision.
+ *
+ * If no content model was stored in the database, $this->getTitle()->getContentModel() is
+ * used to determine the content model to use. If no title is know, CONTENT_MODEL_WIKITEXT
+ * is used as a last resort.
+ *
+ * @return int the content model id associated with this revision, see the CONTENT_MODEL_XXX constants.
+ **/
+ public function getContentModel() {
+ if ( !$this->mContentModel ) {
+ $title = $this->getTitle();
+ $this->mContentModel = ( $title ? $title->getContentModel() : CONTENT_MODEL_WIKITEXT );
+
+ assert( !empty( $this->mContentModel ) );
+ }
+
+ return $this->mContentModel;
+ }
+
+ /**
+ * Returns the content format for this revision.
+ *
+ * If no content format was stored in the database, the default format for this
+ * revision's content model is returned.
+ *
+ * @return int the content format id associated with this revision, see the CONTENT_FORMAT_XXX constants.
+ **/
+ public function getContentFormat() {
+ if ( !$this->mContentFormat ) {
+ $handler = $this->getContentHandler();
+ $this->mContentFormat = $handler->getDefaultFormat();
+
+ assert( !empty( $this->mContentFormat ) );
+ }
+
+ return $this->mContentFormat;
+ }
+
+ /**
+ * Returns the content handler appropriate for this revision's content model.
+ *
+ * @return ContentHandler
+ */
+ public function getContentHandler() {
+ if ( !$this->mContentHandler ) {
+ $model = $this->getContentModel();
+ $this->mContentHandler = ContentHandler::getForModelID( $model );
+
+ assert( $this->mContentHandler->isSupportedFormat( $this->getContentFormat() ) );
+ }
+
+ return $this->mContentHandler;
+ }
+
+ /**
+ * @return String
*/
public function getTimestamp() {
- return wfTimestamp(TS_MW, $this->mTimestamp);
+ return wfTimestamp( TS_MW, $this->mTimestamp );
}
/**
- * @return bool
+ * @return Boolean
*/
public function isCurrent() {
return $this->mCurrent;
/**
* Get previous revision for this title
- * @return Revision
+ *
+ * @return Revision or null
*/
public function getPrevious() {
if( $this->getTitle() ) {
}
/**
- * @return Revision
+ * Get next revision for this title
+ *
+ * @return Revision or null
*/
public function getNext() {
if( $this->getTitle() ) {
/**
* Get previous revision Id for this page_id
* This is used to populate rev_parent_id on save
- * @param Database $db
- * @return int
+ *
+ * @param $db DatabaseBase
+ * @return Integer
*/
private function getPreviousRevisionId( $db ) {
- if( is_null($this->mPage) ) {
+ if( is_null( $this->mPage ) ) {
return 0;
}
# Use page_latest if ID is not given
__METHOD__,
array( 'ORDER BY' => 'rev_id DESC' ) );
}
- return intval($prevId);
+ return intval( $prevId );
}
/**
* $row is usually an object from wfFetchRow(), both the flags and the text
* field must be included
*
- * @param object $row The text data
- * @param string $prefix table prefix (default 'old_')
- * @return string $text|false the text requested
+ * @param $row Object: the text data
+ * @param $prefix String: table prefix (default 'old_')
+ * @return String: text the text requested or false on failure
*/
public static function getRevisionText( $row, $prefix = 'old_' ) {
wfProfileIn( __METHOD__ );
# 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=="") {
+ $url = $text;
+ $parts = explode( '://', $url, 2 );
+ if( count( $parts ) == 1 || $parts[1] == '' ) {
wfProfileOut( __METHOD__ );
return false;
}
- $text=ExternalStore::fetchFromURL($url);
+ $text = ExternalStore::fetchFromURL( $url );
}
// If the text was fetched without an error, convert it
}
global $wgLegacyEncoding;
- if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) ) {
+ if( $text !== false && $wgLegacyEncoding
+ && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
+ {
# Old revisions kept around in a legacy encoding?
# Upconvert on demand.
# ("utf8" checked for compatibility with some broken
# conversion scripts 2008-12-30)
- global $wgInputEncoding, $wgContLang;
- $text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
+ global $wgContLang;
+ $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
}
}
wfProfileOut( __METHOD__ );
* data is compressed, and 'utf-8' if we're saving in UTF-8
* mode.
*
- * @param mixed $text reference to a text
- * @return string
+ * @param $text Mixed: reference to a text
+ * @return String
*/
public static function compressRevisionText( &$text ) {
global $wgCompressRevisions;
* 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
+ * @param $dbw DatabaseBase: (master connection)
+ * @return Integer
*/
public function insertOn( $dbw ) {
- global $wgDefaultExternalStore;
+ global $wgDefaultExternalStore, $wgContentHandlerUseDB;
wfProfileIn( __METHOD__ );
# Record the text (or external storage URL) to the text table
if( !isset( $this->mTextId ) ) {
- $old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
+ $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
$dbw->insert( 'text',
array(
'old_id' => $old_id,
$this->mTextId = $dbw->insertId();
}
+ if ( $this->mComment === null ) $this->mComment = "";
+
# 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,
- 'rev_len' => $this->mSize,
- 'rev_parent_id' => is_null($this->mParentId) ?
- $this->getPreviousRevisionId( $dbw ) : $this->mParentId
- ), __METHOD__
+ : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
+
+ $row = 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,
+ 'rev_len' => $this->mSize,
+ 'rev_parent_id' => is_null( $this->mParentId )
+ ? $this->getPreviousRevisionId( $dbw )
+ : $this->mParentId,
+ 'rev_sha1' => is_null( $this->mSha1 )
+ ? Revision::base36Sha1( $this->mText )
+ : $this->mSha1,
);
- $this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
-
+ if ( $wgContentHandlerUseDB ) {
+ $row[ 'rev_content_model' ] = $this->getContentModel();
+ $row[ 'rev_content_format' ] = $this->getContentFormat();
+ }
+
+ $dbw->insert( 'revision', $row, __METHOD__ );
+
+ $this->mId = !is_null( $rev_id ) ? $rev_id : $dbw->insertId();
+
wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
-
+
wfProfileOut( __METHOD__ );
return $this->mId;
}
+ /**
+ * Get the base 36 SHA-1 value for a string of text
+ * @param $text String
+ * @return String
+ */
+ public static function base36Sha1( $text ) {
+ return wfBaseConvert( sha1( $text ), 16, 36, 31 );
+ }
+
/**
* Lazy-load the revision's text.
* Currently hardcoded to the 'text' table storage engine.
*
- * @return string
+ * @return String
*/
protected function loadText() {
wfProfileIn( __METHOD__ );
if( $wgRevisionCacheExpiry ) {
$text = $wgMemc->get( $key );
if( is_string( $text ) ) {
- wfDebug( __METHOD__. ": got id $textId from cache\n" );
+ wfDebug( __METHOD__ . ": got id $textId from cache\n" );
wfProfileOut( __METHOD__ );
return $text;
}
* 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 mixed Revision, or null on error
+ * @param $dbw DatabaseBase
+ * @param $pageId Integer: ID number of the page to read from
+ * @param $summary String: revision's summary
+ * @param $minor Boolean: whether the revision should be considered as minor
+ * @return Revision|null on error
*/
public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
+ global $wgContentHandlerUseDB;
+
wfProfileIn( __METHOD__ );
+ $fields = array( 'page_latest', 'rev_text_id', 'rev_len', 'rev_sha1' );
+
+ if ( $wgContentHandlerUseDB ) {
+ $fields[] = 'rev_content_model';
+ $fields[] = 'rev_content_format';
+ }
+
$current = $dbw->selectRow(
array( 'page', 'revision' ),
- array( 'page_latest', 'rev_text_id', 'rev_len' ),
+ $fields,
array(
'page_id' => $pageId,
'page_latest=rev_id',
__METHOD__ );
if( $current ) {
- $revision = new Revision( array(
+ $row = array(
'page' => $pageId,
'comment' => $summary,
'minor_edit' => $minor,
'text_id' => $current->rev_text_id,
'parent_id' => $current->page_latest,
- 'len' => $current->rev_len
- ) );
+ 'len' => $current->rev_len,
+ 'sha1' => $current->rev_sha1,
+ );
+
+ if ( $wgContentHandlerUseDB ) {
+ $row[ 'content_model' ] = $current->rev_content_model;
+ $row[ 'content_format' ] = $current->rev_content_format;
+ }
+
+ $revision = new Revision( $row );
} else {
$revision = null;
}
/**
* Determine if the current user is allowed to view a particular
* field of this revision, if it's marked as deleted.
- * @param int $field one of self::DELETED_TEXT,
- * self::DELETED_COMMENT,
- * self::DELETED_USER
- * @return bool
+ *
+ * @param $field Integer:one of self::DELETED_TEXT,
+ * self::DELETED_COMMENT,
+ * self::DELETED_USER
+ * @param $user User object to check, or null to use $wgUser
+ * @return Boolean
+ */
+ public function userCan( $field, User $user = null ) {
+ return self::userCanBitfield( $this->mDeleted, $field, $user );
+ }
+
+ /**
+ * Determine if the current user is allowed to view a particular
+ * field of this revision, if it's marked as deleted. This is used
+ * by various classes to avoid duplication.
+ *
+ * @param $bitfield Integer: current field
+ * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
+ * self::DELETED_COMMENT = File::DELETED_COMMENT,
+ * self::DELETED_USER = File::DELETED_USER
+ * @param $user User object to check, or null to use $wgUser
+ * @return Boolean
*/
- public function userCan( $field ) {
- if( $this->mDeleted & $field ) {
- global $wgUser;
- $permission = ( $this->mDeleted & self::DELETED_RESTRICTED )
- ? 'suppressrevision'
- : ( $field & self::DELETED_TEXT ) ? 'deletedtext' : 'deletedhistory';
- wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
- return $wgUser->isAllowed( $permission );
+ public static function userCanBitfield( $bitfield, $field, User $user = null ) {
+ if( $bitfield & $field ) { // aspect is deleted
+ if ( $bitfield & self::DELETED_RESTRICTED ) {
+ $permission = 'suppressrevision';
+ } elseif ( $field & self::DELETED_TEXT ) {
+ $permission = 'deletedtext';
+ } else {
+ $permission = 'deletedhistory';
+ }
+ wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
+ if ( $user === null ) {
+ global $wgUser;
+ $user = $wgUser;
+ }
+ return $user->isAllowed( $permission );
} else {
return true;
}
}
-
/**
* Get rev_timestamp from rev_id, without loading the rest of the row
- * @param Title $title
- * @param integer $id
+ *
+ * @param $title Title
+ * @param $id Integer
+ * @return String
*/
static function getTimestampFromId( $title, $id ) {
$dbr = wfGetDB( DB_SLAVE );
// Casting fix for DB2
- if ($id == '') {
+ if ( $id == '' ) {
$id = 0;
}
$conds = array( 'rev_id' => $id );
- $conds['rev_page'] = $title->getArticleId();
+ $conds['rev_page'] = $title->getArticleID();
$timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
# Not in slave, try master
/**
* Get count of revisions per page...not very efficient
- * @param Database $db
- * @param int $id, page id
+ *
+ * @param $db DatabaseBase
+ * @param $id Integer: page id
+ * @return Integer
*/
static function countByPageId( $db, $id ) {
$row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
/**
* Get count of revisions per page...not very efficient
- * @param Database $db
- * @param Title $title
+ *
+ * @param $db DatabaseBase
+ * @param $title Title
+ * @return Integer
*/
static function countByTitle( $db, $title ) {
- $id = $title->getArticleId();
+ $id = $title->getArticleID();
if( $id ) {
return Revision::countByPageId( $db, $id );
}
return 0;
}
}
-
-/**
- * Aliases for backwards compatibility with 1.6
- */
-define( 'MW_REV_DELETED_TEXT', Revision::DELETED_TEXT );
-define( 'MW_REV_DELETED_COMMENT', Revision::DELETED_COMMENT );
-define( 'MW_REV_DELETED_USER', Revision::DELETED_USER );
-define( 'MW_REV_DELETED_RESTRICTED', Revision::DELETED_RESTRICTED );
dépôts / lhc / web / wiklou.git / blobdiff