RevisionArchiveRecord.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Revision;
 
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Permissions\Authority;
use MediaWiki\User\UserIdentity;
use MediaWiki\Utils\MWTimestamp;
use stdClass;
use Wikimedia\Assert\Assert;
 
class RevisionArchiveRecord extends RevisionRecord {
 
    protected $mArchiveId;
 
    public function __construct(
        PageIdentity $page,
        UserIdentity $user,
        CommentStoreComment $comment,
        stdClass $row,
        RevisionSlots $slots,
        $wikiId = self::LOCAL
    ) {
        parent::__construct( $page, $slots, $wikiId );
 
        $timestamp = MWTimestamp::convert( TS_MW, $row->ar_timestamp );
        Assert::parameter( is_string( $timestamp ), '$row->rev_timestamp', 'must be a valid timestamp' );
 
        $this->mArchiveId = intval( $row->ar_id );
 
        // NOTE: ar_page_id may be different from $this->mPage->getId() in some cases,
        // notably when a partially restored page has been moved, and a new page has been created
        // with the same title. Archive rows for that title will then have the wrong page id.
        $this->mPageId = isset( $row->ar_page_id ) ? intval( $row->ar_page_id ) : $this->getArticleId( $this->mPage );
 
        // NOTE: ar_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 ar_parent_id to be NULL.
        $this->mParentId = isset( $row->ar_parent_id ) ? intval( $row->ar_parent_id ) : null;
        $this->mId = isset( $row->ar_rev_id ) ? intval( $row->ar_rev_id ) : null;
        $this->mComment = $comment;
        $this->mUser = $user;
        $this->mTimestamp = $timestamp;
        $this->mMinorEdit = boolval( $row->ar_minor_edit );
        $this->mDeleted = intval( $row->ar_deleted );
        $this->mSize = isset( $row->ar_len ) ? intval( $row->ar_len ) : null;
        $this->mSha1 = !empty( $row->ar_sha1 ) ? $row->ar_sha1 : null;
    }
 
    public function getArchiveId() {
        return $this->mArchiveId;
    }
 
    public function getId( $wikiId = self::LOCAL ) {
        // overwritten just to refine the contract specification.
        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 userCan( $field, Authority $performer ) {
        // This revision belongs to a deleted page, so check the relevant permissions as well. (T345777)
 
        // Viewing the content requires either 'deletedtext' or 'undelete' (for legacy reasons)
        if (
            $field === self::DELETED_TEXT &&
            !$performer->authorizeRead( 'deletedtext', $this->getPage() ) &&
            !$performer->authorizeRead( 'undelete', $this->getPage() )
        ) {
            return false;
        }
 
        // Viewing the edit summary requires 'deletedhistory'
        if (
            $field === self::DELETED_COMMENT &&
            !$performer->authorizeRead( 'deletedhistory', $this->getPage() )
        ) {
            return false;
        }
 
        // Other fields of revisions of deleted pages are public, per T232389 (unless revision-deleted)
 
        return parent::userCan( $field, $performer );
    }
 
    public function audienceCan( $field, $audience, Authority $performer = null ) {
        // This revision belongs to a deleted page, so check the relevant permissions as well. (T345777)
        // See userCan().
        if (
            $audience == self::FOR_PUBLIC &&
            ( $field === self::DELETED_TEXT || $field === self::DELETED_COMMENT )
        ) {
            // TODO: Should this use PermissionManager::isEveryoneAllowed() or something?
            // But RevisionRecord::audienceCan() doesn't do that either…
            return false;
        }
 
        // This calls userCan(), which checks the user's permissions
        return parent::audienceCan( $field, $audience, $performer );
    }
 
    public function isReadyForInsertion() {
        return true;
    }
 
}