RevisionSourceHandler.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Handler;
 
use Config;
use LogicException;
use MediaWiki\Page\PageLookup;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use TitleFormatter;
 
class RevisionSourceHandler extends SimpleHandler {
 
    private $contentHelper;
 
    public function __construct(
        Config $config,
        RevisionLookup $revisionLookup,
        TitleFormatter $titleFormatter,
        PageLookup $pageLookup
    ) {
        $this->contentHelper = new RevisionContentHelper(
            $config,
            $revisionLookup,
            $titleFormatter,
            $pageLookup
        );
    }
 
    protected function postValidationSetup() {
        $this->contentHelper->init( $this->getAuthority(), $this->getValidatedParams() );
    }
 
    private function constructHtmlUrl( RevisionRecord $rev ): string {
        return $this->getRouter()->getRouteUrl(
            '/v1/revision/{id}/html',
            [ 'id' => $rev->getId() ]
        );
    }
 
    public function run() {
        $this->contentHelper->checkAccess();
 
        $outputMode = $this->getOutputMode();
        switch ( $outputMode ) {
            case 'bare':
                $revisionRecord = $this->contentHelper->getTargetRevision();
                $body = $this->contentHelper->constructMetadata();
                // @phan-suppress-next-line PhanTypeMismatchArgumentNullable revisionRecord is set when used
                $body['html_url'] = $this->constructHtmlUrl( $revisionRecord );
                $response = $this->getResponseFactory()->createJson( $body );
                $this->contentHelper->setCacheControl( $response );
                break;
            case 'source':
                $content = $this->contentHelper->getContent();
                $body = $this->contentHelper->constructMetadata();
                $body['source'] = $content->getText();
                break;
            default:
                throw new LogicException( "Unknown output mode $outputMode" );
        }
 
        $response = $this->getResponseFactory()->createJson( $body );
        $this->contentHelper->setCacheControl( $response );
 
        return $response;
    }
 
    protected function getETag(): ?string {
        return $this->contentHelper->getETag();
    }
 
    protected function getLastModified(): ?string {
        return $this->contentHelper->getLastModified();
    }
 
    private function getOutputMode(): string {
        return $this->getConfig()['format'];
    }
 
    public function needsWriteAccess(): bool {
        return false;
    }
 
    public function getParamSettings(): array {
        return $this->contentHelper->getParamSettings();
    }
 
    protected function hasRepresentation() {
        return $this->contentHelper->hasContent();
    }
}