RevisionStoreRecord.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Revision;
 
use InvalidArgumentException;
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Permissions\Authority;
use MediaWiki\User\UserIdentity;
use MWTimestamp;
 
class RevisionStoreRecord extends RevisionRecord {
 
    protected $mCurrent = false;
 
    public function __construct(
        PageIdentity $page,
        UserIdentity $user,
        CommentStoreComment $comment,
        \stdClass $row,
        RevisionSlots $slots,
        $wikiId = self::LOCAL
    ) {
        parent::__construct( $page, $slots, $wikiId );
        $this->mId = intval( $row->rev_id );
        $this->mPageId = intval( $row->rev_page );
        $this->mComment = $comment;
 
        // Don't use MWTimestamp::convert, instead let any detailed exception from MWTimestamp
        // bubble up (T254210)
        $timestamp = ( new MWTimestamp( $row->rev_timestamp ) )->getTimestamp( TS_MW );
 
        $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 );
        }
 
        $pageIdBasedOnPage = $this->getArticleId( $this->mPage );
        if ( $this->mPageId && $pageIdBasedOnPage && $this->mPageId !== $pageIdBasedOnPage ) {
            throw new InvalidArgumentException(
                'The given page (' . $this->mPage . ')' .
                ' does not belong to page ID ' . $this->mPageId .
                ' but actually belongs to ' . $this->getArticleId( $this->mPage )
            );
        }
    }
 
    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 );
    }
 
    public function userCan( $field, Authority $performer ) {
        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, $performer );
    }
 
    public function getId( $wikiId = self::LOCAL ) {
        // overwritten just to add a guarantee to the contract
        return parent::getId( $wikiId );
    }
 
    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.
        $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.
        $this->mSha1 ??= $this->mSlots->computeSha1();
 
        return $this->mSha1;
    }
 
    public function getUser( $audience = self::FOR_PUBLIC, Authority $performer = null ) {
        // overwritten just to add a guarantee to the contract
        return parent::getUser( $audience, $performer );
    }
 
    public function getComment( $audience = self::FOR_PUBLIC, Authority $performer = null ) {
        // overwritten just to add a guarantee to the contract
        return parent::getComment( $audience, $performer );
    }
 
    public function getTimestamp() {
        // overwritten just to add a guarantee to the contract
        return parent::getTimestamp();
    }
 
    public function isReadyForInsertion() {
        return true;
    }
 
}