PageHTMLHandler.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Handler;
 
use Config;
use LogicException;
use MediaWiki\Page\PageLookup;
use MediaWiki\Parser\ParserCacheFactory;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\SimpleHandler;
use MediaWiki\Rest\StringStream;
use MediaWiki\Revision\RevisionLookup;
use TitleFormatter;
use Wikimedia\Assert\Assert;
use Wikimedia\UUID\GlobalIdGenerator;
 
class PageHTMLHandler extends SimpleHandler {
 
    private $htmlHelper;
 
    private $contentHelper;
 
    public function __construct(
        Config $config,
        RevisionLookup $revisionLookup,
        TitleFormatter $titleFormatter,
        ParserCacheFactory $parserCacheFactory,
        GlobalIdGenerator $globalIdGenerator,
        PageLookup $pageLookup
    ) {
        $this->contentHelper = new PageContentHelper(
            $config,
            $revisionLookup,
            $titleFormatter,
            $pageLookup
        );
        $this->htmlHelper = new ParsoidHTMLHelper(
            $parserCacheFactory->getParserCache( 'parsoid' ),
            $parserCacheFactory->getRevisionOutputCache( 'parsoid' ),
            $globalIdGenerator
        );
    }
 
    protected function postValidationSetup() {
        $this->contentHelper->init( $this->getAuthority(), $this->getValidatedParams() );
 
        $page = $this->contentHelper->getPage();
        if ( $page ) {
            $this->htmlHelper->init( $page );
        }
    }
 
    public function run(): Response {
        $this->contentHelper->checkAccess();
 
        $page = $this->contentHelper->getPage();
 
        // The call to $this->contentHelper->getPage() should not return null if
        // $this->contentHelper->checkAccess() did not throw.
        Assert::invariant( $page !== null, 'Page should be known' );
 
        $outputMode = $this->getOutputMode();
        switch ( $outputMode ) {
            case 'html':
                $parserOutput = $this->htmlHelper->getHtml();
                $response = $this->getResponseFactory()->create();
                // TODO: need to respect content-type returned by Parsoid.
                $response->setHeader( 'Content-Type', 'text/html' );
                $this->contentHelper->setCacheControl( $response, $parserOutput->getCacheExpiry() );
                $response->setBody( new StringStream( $parserOutput->getText() ) );
                break;
            case 'with_html':
                $parserOutput = $this->htmlHelper->getHtml();
                $body = $this->contentHelper->constructMetadata();
                $body['html'] = $parserOutput->getText();
                $response = $this->getResponseFactory()->createJson( $body );
                $this->contentHelper->setCacheControl( $response, $parserOutput->getCacheExpiry() );
                break;
            default:
                throw new LogicException( "Unknown HTML type $outputMode" );
        }
 
        return $response;
    }
 
    protected function getETag(): ?string {
        if ( !$this->contentHelper->isAccessible() ) {
            return null;
        }
        return $this->htmlHelper->getETag();
    }
 
    protected function getLastModified(): ?string {
        if ( !$this->contentHelper->isAccessible() ) {
            return null;
        }
        return $this->htmlHelper->getLastModified();
    }
 
    private function getOutputMode(): string {
        return $this->getConfig()['format'];
    }
 
    public function needsWriteAccess(): bool {
        return false;
    }
 
    public function getParamSettings(): array {
        return $this->contentHelper->getParamSettings();
    }
}