VueContentHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Content;
 
use InvalidArgumentException;
use MediaWiki\Config\Config;
use MediaWiki\Content\Renderer\ContentParseParams;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\WikiPage;
use MediaWiki\Parser\ParserFactory;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\ParserOutputFlags;
use MediaWiki\ResourceLoader\VueComponentParser;
use StatusValue;
 
class VueContentHandler extends CodeContentHandler {
 
    private readonly array $textModelsToParse;
 
    private ?VueComponentParser $vueComponentParser = null;
 
    public function __construct(
        string $modelId,
        Config $config,
        private readonly ParserFactory $parserFactory,
        private readonly CodeHighlighter $codeHighlighter,
    ) {
        parent::__construct( $modelId, [ CONTENT_FORMAT_VUE ] );
        $this->textModelsToParse = $config->get( MainConfigNames::TextModelsToParse ) ?? [];
    }
 
    protected function getContentClass() {
        return VueContent::class;
    }
 
    public function makeEmptyContent() {
        $class = $this->getContentClass();
        return new $class( "<template>\n</template>\n\n<script>\n</script>\n\n<style>\n</style>\n" );
    }
 
    protected function fillParserOutput(
        Content $content,
        ContentParseParams $cpoParams,
        ParserOutput &$output
    ) {
        '@phan-var VueContent $content';
        if ( in_array( $content->getModel(), $this->textModelsToParse ) ) {
            // parse just to get links etc into the database, HTML is replaced below.
            $output = $this->parserFactory->getInstance()->parse(
                $content->getText(),
                $cpoParams->getPage(),
                WikiPage::makeParserOptionsFromTitleAndModel(
                    $cpoParams->getPage(),
                    $content->getModel(),
                    'canonical'
                ),
                true,
                true,
                $cpoParams->getRevId()
            );
        }
 
        if ( $cpoParams->getGenerateHtml() ) {
            $highlightOutput = $this->codeHighlighter->highlight( $content->getText(), new CodeHighlighterOptions(
                language: 'vue',
                classes: [ 'mw-vue' ],
                includeLineNumbers: true,
                includeLineLinks: true,
            ) );
            $html = $highlightOutput->getHtml();
            $highlightOutput->getMetadata()->addToParserOutput( $output );
        } else {
            $html = null;
        }
 
        $output->clearWrapperDivClass();
        $output->setContentHolderText( $html );
        // Suppress the TOC (T307691)
        $output->setOutputFlag( ParserOutputFlags::NO_TOC );
        $output->setSections( [] );
    }
 
    public function validateSave( Content $content, ValidationParams $validationParams ): StatusValue {
        $this->vueComponentParser ??= new VueComponentParser;
        try {
            $parsedComponent = $this->vueComponentParser->parse( $content->serialize() );
        } catch ( InvalidArgumentException $e ) {
            // TODO: i18n for error messages
            return StatusValue::newFatal( 'vue-invalid-content', $e->getMessage() );
        }
        if ( $parsedComponent['styleLang'] === 'less' ) {
            return StatusValue::newFatal( 'vue-less-notsupported' );
        }
        return StatusValue::newGood();
    }
}