JavaScriptContentHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Content;
 
use MediaWiki\Config\Config;
use MediaWiki\Content\Renderer\ContentParseParams;
use MediaWiki\Content\Transform\PreSaveTransformParams;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\WikiPage;
use MediaWiki\Parser\ParserFactory;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Parser\ParserOutputFlags;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
 
class JavaScriptContentHandler extends CodeContentHandler {
 
    private readonly array $textModelsToParse;
 
    public function __construct(
        string $modelId,
        Config $config,
        private readonly ParserFactory $parserFactory,
        private readonly UserOptionsLookup $userOptionsLookup,
        private readonly CodeHighlighter $codeHighlighter,
    ) {
        parent::__construct( $modelId, [ CONTENT_FORMAT_JAVASCRIPT ] );
        $this->textModelsToParse = $config->get( MainConfigNames::TextModelsToParse ) ?? [];
    }
 
    protected function getContentClass() {
        return JavaScriptContent::class;
    }
 
    public function supportsRedirects() {
        return true;
    }
 
    public function makeRedirectContent( Title $destination, $text = '' ) {
        // The parameters are passed as a string so the / is not url-encoded by wfArrayToCgi
        $url = $destination->getFullURL( 'action=raw&ctype=text/javascript', false, PROTO_RELATIVE );
        $class = $this->getContentClass();
        // Don't needlessly encode ampersands in URLs (T107289).
        // Avoid FormatJson or Html::encodeJsCall to ensure long-term byte-identical stability,
        // as required for JavaScriptContent::getRedirectTarget validation.
        $redirectContent = '/* #REDIRECT */mw.loader.load('
            . json_encode( $url, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE )
            . ');';
        return new $class( $redirectContent );
    }
 
    public function preSaveTransform(
        Content $content,
        PreSaveTransformParams $pstParams
    ): Content {
        '@phan-var JavascriptContent $content';
 
        $parserOptions = $pstParams->getParserOptions();
        // @todo Make pre-save transformation optional for script pages (T34858)
        if ( !$this->userOptionsLookup->getBoolOption( $pstParams->getUser(), 'pst-cssjs' ) ) {
            // Allow bot users to disable the pre-save transform for CSS/JS (T236828).
            $parserOptions = clone $parserOptions;
            $parserOptions->setPreSaveTransform( false );
        }
 
        $text = $content->getText();
        $pst = $this->parserFactory->getInstance()->preSaveTransform(
            $text,
            $pstParams->getPage(),
            $pstParams->getUser(),
            $parserOptions
        );
 
        $contentClass = $this->getContentClass();
        return new $contentClass( $pst );
    }
 
    protected function fillParserOutput(
        Content $content,
        ContentParseParams $cpoParams,
        ParserOutput &$output
    ) {
        '@phan-var JavaScriptContent $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: 'javascript',
                classes: [ 'mw-js' ],
                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( [] );
    }
}
class_alias( JavaScriptContentHandler::class, 'JavaScriptContentHandler' );