RevisionHandler.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Handler;
 
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use RequestContext;
use User;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
 
class RevisionHandler extends SimpleHandler {
    private $revisionLookup;
 
    private $permissionManager;
 
    private $user;
 
    private $revision = null;
 
    public function __construct(
        RevisionLookup $revisionLookup,
        PermissionManager $permissionManager
    ) {
        $this->revisionLookup = $revisionLookup;
        $this->permissionManager = $permissionManager;
 
        // @todo Inject this, when there is a good way to do that
        $this->user = RequestContext::getMain()->getUser();
    }
 
    private function getRevision() {
        $id = $this->getValidatedParams()['id'];
 
        if ( $this->revision === null ) {
            $rev = $this->revisionLookup->getRevisionById( $id );
 
            // If null was returned, remember it as false, since null means uninitialized.
            $this->revision = $rev ?: false;
        }
 
        return $this->revision;
    }
 
    public function run( $id ) {
        $rev = $this->getRevision();
        if ( !$rev ) {
            throw new LocalizedHttpException(
                new MessageValue( 'rest-nonexistent-revision', [ $id ] ), 404 );
        }
        if ( !$this->permissionManager->userCan( 'read', $this->user, $rev->getPageAsLinkTarget() ) ) {
            throw new LocalizedHttpException(
                new MessageValue( 'rest-permission-denied-revision', [ $id ] ), 403 );
        }
 
        $responseData = [
            'id' => $rev->getId(),
            'page' => [
                'id' => $rev->getPageId(),
                'title' => $rev->getPageAsLinkTarget()->getText(),
            ],
            'size' => $rev->getSize(),
            'minor' => $rev->isMinor(),
            'timestamp' => wfTimestamp( TS_ISO_8601, $rev->getTimestamp() ),
        ];
 
        $revUser = $rev->getUser( RevisionRecord::FOR_THIS_USER, $this->user );
        if ( $revUser ) {
            $responseData['user'] = [
                'id' => $revUser->isRegistered() ? $revUser->getId() : null,
                'name' => $revUser->getName()
            ];
        } else {
            $responseData['user'] = null;
        }
 
        $comment = $rev->getComment( RevisionRecord::FOR_THIS_USER, $this->user );
        $responseData['comment'] = $comment ? $comment->text : null;
 
        $parent = $this->revisionLookup->getPreviousRevision( $rev );
        if ( $parent ) {
            $responseData['delta'] = $rev->getSize() - $parent->getSize();
        } else {
            $responseData['delta'] = null;
        }
        return $this->getResponseFactory()->createJson( $responseData );
    }
 
    public function needsWriteAccess() {
        return false;
    }
 
    public function getParamSettings() {
        return [
            'id' => [
                self::PARAM_SOURCE => 'path',
                ParamValidator::PARAM_TYPE => 'integer',
                ParamValidator::PARAM_REQUIRED => true,
            ],
        ];
    }
 
    protected function getETag(): ?string {
        $rev = $this->getRevision();
        if ( !$rev || $rev->getVisibility() !== 0 ) {
            return null;
        }
 
        $tag = $rev->getId();
 
        return '"' . $tag . '"';
    }
 
    protected function getLastModified(): ?string {
        $rev = $this->getRevision();
        if ( !$rev || $rev->getVisibility() !== 0 ) {
            return null;
        }
 
        return $rev->getTimestamp();
    }
 
    protected function hasRepresentation() {
        $rev = $this->getRevision();
        return $rev ? true : false;
    }
}