1.23.14/php/SpecialJavaScriptTest_8php_source.html

<?php

class SpecialJavaScriptTest extends SpecialPage {


    private static $frameworks = array(

        'qunit',

    );


    public function __construct() {

        parent::__construct( 'JavaScriptTest' );

    }


    public function execute( $par ) {

        $out = $this->getOutput();


        $this->setHeaders();

        $out->disallowUserJs();


        if ( $par === null ) {

            // No framework specified

            $out->setStatusCode( 404 );

            $out->setPageTitle( $this->msg( 'javascripttest' ) );

            $out->addHTML(

                $this->msg( 'javascripttest-pagetext-noframework' )->parseAsBlock()

                . $this->getFrameworkListHtml()

            );

            return;

        }


        // Determine framework and mode

        $pars = explode( '/', $par, 2 );


        $framework = $pars[0];

        if ( !in_array( $framework, self::$frameworks ) ) {

            // Framework not found

            $out->setStatusCode( 404 );

            $out->addHTML(

                '<div class="error">'

                . $this->msg( 'javascripttest-pagetext-unknownframework' )

                    ->plaintextParams( $par )->parseAsBlock()

                . '</div>'

                . $this->getFrameworkListHtml()

            );

            return;

        }


        // This special page is disabled by default ($wgEnableJavaScriptTest), and contains

        // no sensitive data. In order to allow TestSwarm to embed it into a test client window,

        // we need to allow iframing of this page.

        $out->allowClickjacking();

        $out->setSubtitle(

            $this->msg( 'javascripttest-backlink' )

                ->rawParams( Linker::linkKnown( $this->getPageTitle() ) )

        );


        // Custom actions

        if ( isset( $pars[1] ) ) {

            $action = $pars[1];

            if ( !in_array( $action, array( 'export', 'plain' ) ) ) {

                $out->setStatusCode( 404 );

                $out->addHTML(

                    '<div class="error">'

                    . $this->msg( 'javascripttest-pagetext-unknownaction' )

                        ->plaintextParams( $action )->parseAsBlock()

                    . '</div>'

                );

                return;

            }

            $method = $action . ucfirst( $framework );

            $this->$method();

            return;

        }


        $out->addModules( 'mediawiki.special.javaScriptTest' );


        $method = 'view' . ucfirst( $framework );

        $this->$method();

        $out->setPageTitle( $this->msg(

            'javascripttest-title',

            // Messages: javascripttest-qunit-name

            $this->msg( "javascripttest-$framework-name" )->plain()

        ) );

    }


    private function getFrameworkListHtml() {

        $list = '<ul>';

        foreach ( self::$frameworks as $framework ) {

            $list .= Html::rawElement(

                'li',

                array(),

                Linker::link(

                    $this->getPageTitle( $framework ),

                    // Message: javascripttest-qunit-name

                    $this->msg( "javascripttest-$framework-name" )->escaped()

                )

            );

        }

        $list .= '</ul>';


        return $this->msg( 'javascripttest-pagetext-frameworks' )->rawParams( $list )

            ->parseAsBlock();

    }


    private function wrapSummaryHtml( $html ) {

        return "<div id=\"mw-javascripttest-summary\">$html</div>";

    }


    private function viewQUnit() {

        global $wgJavaScriptTestConfig;


        $out = $this->getOutput();

        $testConfig = $wgJavaScriptTestConfig;


        $modules = $out->getResourceLoader()->getTestModuleNames( 'qunit' );


        $summary = $this->msg( 'javascripttest-qunit-intro' )

            ->params( $wgJavaScriptTestConfig['qunit']['documentation'] )

            ->parseAsBlock();


        $baseHtml = <<<HTML

<div class="mw-content-ltr">

<div id="qunit"></div>

</div>

HTML;


        // Used in ./tests/qunit/data/testrunner.js, see also documentation of

        // $wgJavaScriptTestConfig in DefaultSettings.php

        $out->addJsConfigVars(

            'QUnitTestSwarmInjectJSPath',

            $testConfig['qunit']['testswarm-injectjs']

        );


        $out->addHtml( $this->wrapSummaryHtml( $summary ) . $baseHtml );


        // The testrunner configures QUnit and essentially depends on it. However, test suites

        // are reusable in environments that preload QUnit (or a compatibility interface to

        // another framework). Therefore we have to load it ourselves.

        $out->addHtml( Html::inlineScript(

            ResourceLoader::makeLoaderConditionalScript(

                Xml::encodeJsCall( 'mw.loader.using', array(

                    array( 'jquery.qunit', 'jquery.qunit.completenessTest' ),

                    new XmlJsCode(

                        'function () {' . Xml::encodeJsCall( 'mw.loader.load', array( $modules ) ) . '}'

                    )

                ) )

            )

        ) );

    }


    private function exportQUnit() {

        $out = $this->getOutput();


        $out->disable();


        $rl = $out->getResourceLoader();


        $query = array(

            'lang' => $this->getLanguage()->getCode(),

            'skin' => $this->getSkin()->getSkinName(),

            'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',

        );

        $embedContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );

        $query['only'] = 'scripts';

        $startupContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );


        $modules = $rl->getTestModuleNames( 'qunit' );


        // The below is essentially a pure-javascript version of OutputPage::getHeadScripts.

        $startup = $rl->makeModuleResponse( $startupContext, array(

            'startup' => $rl->getModule( 'startup' ),

        ) );

        // Embed page-specific mw.config variables.

        // The current Special page shouldn't be relevant to tests, but various modules (which

        // are loaded before the test suites), reference mw.config while initialising.

        $code = ResourceLoader::makeConfigSetScript( $out->getJSVars() );

        // Embed private modules as they're not allowed to be loaded dynamically

        $code .= $rl->makeModuleResponse( $embedContext, array(

            'user.options' => $rl->getModule( 'user.options' ),

            'user.tokens' => $rl->getModule( 'user.tokens' ),

        ) );

        $code .= Xml::encodeJsCall( 'mw.loader.load', array( $modules ) );


        header( 'Content-Type: text/javascript; charset=utf-8' );

        header( 'Cache-Control: private, no-cache, must-revalidate' );

        header( 'Pragma: no-cache' );

        echo $startup;

        echo "\n";

        // Note: The following has to be wrapped in a script tag because the startup module also

        // writes a script tag (the one loading mediawiki.js). Script tags are synchronous, block

        // each other, and run in order. But they don't nest. The code appended after the startup

        // module runs before the added script tag is parsed and executed.

        echo Xml::encodeJsCall( 'document.write', array( Html::inlineScript( $code  ) ) );

    }


    private function plainQUnit() {

        $out = $this->getOutput();

        $out->disable();


        $url = $this->getPageTitle( 'qunit/export' )->getFullURL( array(

            'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',

        ) );


        $styles = $out->makeResourceLoaderLink( 'jquery.qunit', ResourceLoaderModule::TYPE_STYLES, false );

        // Use 'raw' since this is a plain HTML page without ResourceLoader

        $scripts = $out->makeResourceLoaderLink( 'jquery.qunit', ResourceLoaderModule::TYPE_SCRIPTS, false, array( 'raw' => 'true' ) );


        $head = trim( $styles['html'] . $scripts['html'] );

        $html = <<<HTML

<!DOCTYPE html>

<title>QUnit</title>

$head

<div id="qunit"></div>

HTML;

        $html .= "\n" . Html::linkedScript( $url );


        header( 'Content-Type: text/html; charset=utf-8' );

        echo $html;

    }


    protected function getGroupName() {

        return 'other';

    }

}