WebInstallerOutput.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer;
 
use LogicException;
use MediaWiki\Context\RequestContext;
use MediaWiki\Html\Html;
use MediaWiki\Language\Language;
use MediaWiki\MediaWikiServices;
use MediaWiki\Request\FauxRequest;
use MediaWiki\ResourceLoader as RL;
use MediaWiki\ResourceLoader\ResourceLoader;
 
class WebInstallerOutput {
 
    public $parent;
 
    private $contents = '';
 
    private $headerDone = false;
 
    public $redirectTarget;
 
    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 LogicException( __METHOD__ . ' called after sending headers' );
        }
        $this->redirectTarget = $url;
    }
 
    public function output() {
        $this->flush();
 
        if ( !$this->redirectTarget ) {
            $this->outputFooter();
        }
    }
 
    public function getCSS() {
        $resourceLoader = MediaWikiServices::getInstance()->getResourceLoader();
 
        $rlContext = new RL\Context( $resourceLoader, new FauxRequest( [
            'debug' => 'true',
            'lang' => $this->getLanguage()->getCode(),
            'only' => 'styles',
        ] ) );
 
        $module = new RL\SkinModule( [
            'features' => [
                'elements',
                'interface-message-box'
            ],
            'styles' => [
                'mw-config/config.css',
            ],
        ] );
        $module->setConfig( $resourceLoader->getConfig() );
 
        // Based on MediaWiki\ResourceLoader\FileModule::getStyles, without the DB query
        $styles = ResourceLoader::makeCombinedStyles(
            $module->readStyleFiles(
                $module->getStyleFiles( $rlContext ),
                $rlContext
            )
        );
 
        return implode( "\n", $styles );
    }
 
    private function getCssUrl() {
        return Html::linkedStyle( $this->parent->getUrl( [ 'css' => 1 ] ) );
    }
 
    public function flush() {
        if ( !$this->headerDone ) {
            $this->outputHeader();
        }
        if ( !$this->redirectTarget && strlen( $this->contents ) ) {
            echo $this->contents;
            flush();
            $this->contents = '';
        }
    }
 
    private function getLanguage() {
        return RequestContext::getMain()->getLanguage();
    }
 
    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' );
        $this->parent->request->response()->header( 'X-Frame-Options: DENY' );
 
        $cspPolicy = "default-src 'self'; style-src 'self' 'unsafe-inline'; object-src 'none';" .
            " script-src 'self' 'nonce-" . $this->getCSPNonce() . "';" .
            " img-src 'self'; frame-src 'self'; base-uri 'none'";
 
        $this->parent->request->response()->header( 'Content-Security-Policy: ' . $cspPolicy );
 
        if ( $this->redirectTarget ) {
            $this->parent->request->response()->header( 'Location: ' . $this->redirectTarget );
 
            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->getCodex() . "\n"; ?>
    <?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() {
?>
 
</div></div>
 
<aside id="mw-panel">
    <div class="portal" id="p-logo">
        <a href="https://www.mediawiki.org/" title="Main Page"></a>
    </div>
<?php
        // @phpcs:disable Generic.WhiteSpace.ScopeIndent.IncorrectExact
        $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-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>';
        // @phpcs:enable
?>
</aside>
 
<?php
        echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
    }
 
    public function outputTitle() {
        echo wfMessage( 'config-title', MW_VERSION )->escaped();
    }
 
    public function getJQuery() {
        return Html::linkedScript( "../resources/lib/jquery/jquery.js" );
    }
 
    public function getCodex() {
        return Html::linkedStyle( "../resources/lib/codex/codex.style.css" );
    }
 
    public function getCSPNonce() {
        static $nonce;
        if ( $nonce === null ) {
            // Spec says at least 16 bytes. Do 18 so it encodes evenly in base64
            $nonce = base64_encode( random_bytes( 18 ) );
        }
        return $nonce;
    }
}