WebInstallerOutput.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class WebInstallerOutput {

    public $parent;

    private $contents = '';

    private $headerDone = false;

    public $redirectTarget;

    public $allowFrames = false;

    private $useShortHeader = false;

    public function __construct( WebInstaller $parent ) {
        $this->parent = $parent;
    }

    public function addHTML( $html ) {
        $this->contents .= $html;
        $this->flush();
    }

    public function addWikiTextAsInterface( $text ) {
        $this->addHTML( $this->parent->parse( $text ) );
    }

    public function addHTMLNoFlush( $html ) {
        $this->contents .= $html;
    }

    public function redirect( $url ) {
        if ( $this->headerDone ) {
            throw new MWException( __METHOD__ . ' called after sending headers' );
        }
        $this->redirectTarget = $url;
    }

    public function output() {
        $this->flush();

        if ( !$this->redirectTarget ) {
            $this->outputFooter();
        }
    }

    public function getCSS() {
        global $wgStyleDirectory;

        $moduleNames = [
            // Based on Skin::getDefaultModules
            'mediawiki.legacy.shared',
            // Based on Vector::setupSkinUserCss
            'mediawiki.skinning.interface',
        ];

        $resourceLoader = MediaWikiServices::getInstance()->getResourceLoader();

        if ( file_exists( "$wgStyleDirectory/Vector/skin.json" ) ) {
            // Force loading Vector skin if available as a fallback skin
            // for whatever ResourceLoader wants to have as the default.
            $registry = new ExtensionRegistry();
            $data = $registry->readFromQueue( [
                "$wgStyleDirectory/Vector/skin.json" => 1,
            ] );
            if ( isset( $data['globals']['wgResourceModules'] ) ) {
                $resourceLoader->register( $data['globals']['wgResourceModules'] );
            }

            $moduleNames[] = 'skins.vector.styles';
        }

        $moduleNames[] = 'mediawiki.legacy.config';

        $rlContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( [
                'debug' => 'true',
                'lang' => $this->getLanguage()->getCode(),
                'only' => 'styles',
        ] ) );

        $styles = [];
        foreach ( $moduleNames as $moduleName ) {
            $module = $resourceLoader->getModule( $moduleName );
            '@phan-var ResourceLoaderFileModule $module';
            if ( !$module ) {
                // T98043: Don't fatal, but it won't look as pretty.
                continue;
            }

            // Based on: ResourceLoaderFileModule::getStyles (without the DB query)
            $styles = array_merge( $styles, ResourceLoader::makeCombinedStyles(
                $module->readStyleFiles(
                    $module->getStyleFiles( $rlContext ),
                    $module->getFlip( $rlContext ),
                    $rlContext
            ) ) );
        }

        return implode( "\n", $styles );
    }

    private function getCssUrl() {
        return Html::linkedStyle( $this->parent->getUrl( [ 'css' => 1 ] ) );
    }

    public function useShortHeader( $use = true ) {
        $this->useShortHeader = $use;
    }

    public function allowFrames( $allow = true ) {
        $this->allowFrames = $allow;
    }

    public function flush() {
        if ( !$this->headerDone ) {
            $this->outputHeader();
        }
        if ( !$this->redirectTarget && strlen( $this->contents ) ) {
            echo $this->contents;
            flush();
            $this->contents = '';
        }
    }

    private function getLanguage() {
        global $wgLang;

        return is_object( $wgLang ) ? $wgLang : Language::factory( 'en' );
    }

    public function getHeadAttribs() {
        return [
            'dir' => $this->getLanguage()->getDir(),
            'lang' => $this->getLanguage()->getHtmlCode(),
        ];
    }

    public function headerDone() {
        return $this->headerDone;
    }

    public function outputHeader() {
        $this->headerDone = true;
        $this->parent->request->response()->header( 'Content-Type: text/html; charset=utf-8' );

        if ( !$this->allowFrames ) {
            $this->parent->request->response()->header( 'X-Frame-Options: DENY' );
        }

        if ( $this->redirectTarget ) {
            $this->parent->request->response()->header( 'Location: ' . $this->redirectTarget );

            return;
        }

        if ( $this->useShortHeader ) {
            $this->outputShortHeader();

            return;
        }
?>
<?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>

<head>
    <meta name="robots" content="noindex, nofollow" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <title><?php $this->outputTitle(); ?></title>
    <?php echo $this->getCssUrl() . "\n"; ?>
    <?php echo $this->getJQuery() . "\n"; ?>
    <?php echo Html::linkedScript( 'config.js' ) . "\n"; ?>
</head>

<?php echo Html::openElement( 'body', [ 'class' => $this->getLanguage()->getDir() ] ) . "\n"; ?>
<div id="mw-page-base"></div>
<div id="mw-head-base"></div>
<div id="content" class="mw-body" role="main">
<div id="bodyContent" class="mw-body-content">

<h1><?php $this->outputTitle(); ?></h1>
<?php
    }

    public function outputFooter() {
        if ( $this->useShortHeader ) {
            echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );

            return;
        }
?>

</div></div>

<div id="mw-panel">
    <div class="portal" id="p-logo">
        <a href="https://www.mediawiki.org/" title="Main Page"></a>
    </div>
<?php
    $message = wfMessage( 'config-sidebar' )->plain();
    // Section 1: External links
    // @todo FIXME: Migrate to plain link label messages (T227297).
    foreach ( explode( '----', $message ) as $section ) {
        echo '<div class="portal"><div class="body">';
        echo $this->parent->parse( $section, true );
        echo '</div></div>';
    }
    // Section 2: Installer pages
    echo '<div class="portal"><div class="body"><ul>';
    foreach ( [
        'config-sidebar-readme' => 'Readme',
        'config-sidebar-relnotes' => 'ReleaseNotes',
        'config-sidebar-license' => 'Copying',
        'config-sidebar-upgrade' => 'UpgradeDoc',
    ] as $msgKey => $pageName ) {
        echo $this->parent->makeLinkItem(
            $this->parent->getDocUrl( $pageName ),
            wfMessage( $msgKey )->text()
        );
    }
    echo '</ul></div></div>';
?>
</div>

<?php
        echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
    }

    public function outputShortHeader() {
?>
<?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>

<head>
    <meta name="robots" content="noindex, nofollow" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <title><?php $this->outputTitle(); ?></title>
    <?php echo $this->getCssUrl() . "\n"; ?>
    <?php echo $this->getJQuery() . "\n"; ?>
    <?php echo Html::linkedScript( 'config.js' ) . "\n"; ?>
</head>

<body style="background-image: none">
<?php
    }

    public function outputTitle() {
        global $wgVersion;
        echo wfMessage( 'config-title', $wgVersion )->escaped();
    }

    public function getJQuery() {
        return Html::linkedScript( "../resources/lib/jquery/jquery.js" );
    }

}