RevisionStoreRecord.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Revision;
 
use CommentStoreComment;
use InvalidArgumentException;
use MediaWiki\User\UserIdentity;
use MWTimestamp;
use Title;
use User;
use Wikimedia\Assert\Assert;
 
class RevisionStoreRecord extends RevisionRecord {
 
    protected $mCurrent = false;
 
    public function __construct(
        Title $title,
        UserIdentity $user,
        CommentStoreComment $comment,
        $row,
        RevisionSlots $slots,
        $dbDomain = false
    ) {
        parent::__construct( $title, $slots, $dbDomain );
        Assert::parameterType( \stdClass::class, $row, '$row' );
 
        $this->mId = intval( $row->rev_id );
        $this->mPageId = intval( $row->rev_page );
        $this->mComment = $comment;
 
        $timestamp = MWTimestamp::convert( TS_MW, $row->rev_timestamp );
        Assert::parameter(
            is_string( $timestamp ),
            '$row->rev_timestamp',
            "must be a valid timestamp (rev_id={$this->mId}, rev_timestamp={$row->rev_timestamp})"
        );
 
        $this->mUser = $user;
        $this->mMinorEdit = boolval( $row->rev_minor_edit );
        $this->mTimestamp = $timestamp;
        $this->mDeleted = intval( $row->rev_deleted );
 
        // NOTE: rev_parent_id = 0 indicates that there is no parent revision, while null
        // indicates that the parent revision is unknown. As per MW 1.31, the database schema
        // allows rev_parent_id to be NULL.
        $this->mParentId = isset( $row->rev_parent_id ) ? intval( $row->rev_parent_id ) : null;
        $this->mSize = isset( $row->rev_len ) ? intval( $row->rev_len ) : null;
        $this->mSha1 = !empty( $row->rev_sha1 ) ? $row->rev_sha1 : null;
 
        // NOTE: we must not call $this->mTitle->getLatestRevID() here, since the state of
        // page_latest may be in limbo during revision creation. In that case, calling
        // $this->mTitle->getLatestRevID() would cause a bad value to be cached in the Title
        // object. During page creation, that bad value would be 0.
        if ( isset( $row->page_latest ) ) {
            $this->mCurrent = ( $row->rev_id == $row->page_latest );
        }
 
        // sanity check
        if (
            $this->mPageId && $this->mTitle->exists()
            && $this->mPageId !== $this->mTitle->getArticleID()
        ) {
            throw new InvalidArgumentException(
                'The given Title (' . $this->mTitle->getPrefixedText() . ')' .
                ' does not belong to page ID ' . $this->mPageId .
                ' but actually belongs to ' . $this->mTitle->getArticleID()
            );
        }
    }
 
    public function isCurrent() {
        return $this->mCurrent;
    }
 
    public function isDeleted( $field ) {
        if ( $this->isCurrent() && $field === self::DELETED_TEXT ) {
            // Current revisions of pages cannot have the content hidden. Skipping this
            // check is very useful for Parser as it fetches templates using newKnownCurrent().
            // Calling getVisibility() in that case triggers a verification database query.
            return false; // no need to check
        }
 
        return parent::isDeleted( $field );
    }
 
    protected function userCan( $field, User $user ) {
        if ( $this->isCurrent() && $field === self::DELETED_TEXT ) {
            // Current revisions of pages cannot have the content hidden. Skipping this
            // check is very useful for Parser as it fetches templates using newKnownCurrent().
            // Calling getVisibility() in that case triggers a verification database query.
            return true; // no need to check
        }
 
        return parent::userCan( $field, $user );
    }
 
    public function getId() {
        // overwritten just to add a guarantee to the contract
        return parent::getId();
    }
 
    public function getSize() {
        // If length is null, calculate and remember it (potentially SLOW!).
        // This is for compatibility with old database rows that don't have the field set.
        if ( $this->mSize === null ) {
            $this->mSize = $this->mSlots->computeSize();
        }
 
        return $this->mSize;
    }
 
    public function getSha1() {
        // If hash is null, calculate it and remember (potentially SLOW!)
        // This is for compatibility with old database rows that don't have the field set.
        if ( $this->mSha1 === null ) {
            $this->mSha1 = $this->mSlots->computeSha1();
        }
 
        return $this->mSha1;
    }
 
    public function getUser( $audience = self::FOR_PUBLIC, User $user = null ) {
        // overwritten just to add a guarantee to the contract
        return parent::getUser( $audience, $user );
    }
 
    public function getComment( $audience = self::FOR_PUBLIC, User $user = null ) {
        // overwritten just to add a guarantee to the contract
        return parent::getComment( $audience, $user );
    }
 
    public function getTimestamp() {
        // overwritten just to add a guarantee to the contract
        return parent::getTimestamp();
    }
 
    public function isReadyForInsertion() {
        return true;
    }
 
}
 
class_alias( RevisionStoreRecord::class, 'MediaWiki\Storage\RevisionStoreRecord' );