WebInstallerOutput.php

Go to the documentation of this file.

<?php
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 addWikiText( $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();
        $this->outputFooter();
    }

    public function getCSS( $dir ) {
        // All CSS files these modules reference will be concatenated in sequence
        // and loaded as one file.
        $moduleNames = array(
            'mediawiki.legacy.shared',
            'mediawiki.skinning.interface',
            'skins.vector.styles',
            'mediawiki.legacy.config',
        );

        $prepend = '';
        $css = '';

        $resourceLoader = new ResourceLoader();
        foreach ( $moduleNames as $moduleName ) {
            $module = $resourceLoader->getModule( $moduleName );
            $cssFileNames = $module->getAllStyleFiles();

            wfSuppressWarnings();
            foreach ( $cssFileNames as $cssFileName ) {
                if ( !file_exists( $cssFileName ) ) {
                    $prepend .= ResourceLoader::makeComment( "Unable to find $cssFileName." );
                    continue;
                }

                if ( !is_readable( $cssFileName ) ) {
                    $prepend .= ResourceLoader::makeComment( "Unable to read $cssFileName. " .
                        "Please check file permissions." );
                    continue;
                }

                try {

                    if ( preg_match( '/\.less$/', $cssFileName ) ) {
                        // Run the LESS compiler for *.less files (bug 55589)
                        $compiler = ResourceLoader::getLessCompiler();
                        $cssFileContents = $compiler->compileFile( $cssFileName );
                    } else {
                        // Regular CSS file
                        $cssFileContents = file_get_contents( $cssFileName );
                    }

                    if ( $cssFileContents ) {
                        // Rewrite URLs, though don't bother embedding images. While static image
                        // files may be cached, CSS returned by this function is definitely not.
                        $cssDirName = dirname( $cssFileName );
                        $css .= CSSMin::remap(
                            /* source */ $cssFileContents,
                            /* local */ $cssDirName,
                            /* remote */ '..' . str_replace(
                                array( $GLOBALS['IP'], DIRECTORY_SEPARATOR ),
                                array( '', '/' ),
                                $cssDirName
                            ),
                            /* embedData */ false
                        );
                    } else {
                        $prepend .= ResourceLoader::makeComment( "Unable to read $cssFileName." );
                    }
                } catch ( Exception $e ) {
                    $prepend .= ResourceLoader::formatException( $e );
                }

                $css .= "\n";
            }
            wfRestoreWarnings();
        }

        $css = $prepend . $css;

        if ( $dir == 'rtl' ) {
            $css = CSSJanus::transform( $css, true );
        }

        return $css;
    }

    private function getCssUrl() {
        return Html::linkedStyle( $_SERVER['PHP_SELF'] . '?css=' . $this->getDir() );
    }

    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 = '';
        }
    }

    public function getDir() {
        global $wgLang;

        return is_object( $wgLang ) ? $wgLang->getDir() : 'ltr';
    }

    public function getLanguageCode() {
        global $wgLang;

        return is_object( $wgLang ) ? $wgLang->getCode() : 'en';
    }

    public function getHeadAttribs() {
        return array(
            'dir' => $this->getDir(),
            'lang' => $this->getLanguageCode(),
        );
    }

    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( '../skins/common/config.js' ) . "\n"; ?>
</head>

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

<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 style="background-image: url(../skins/common/images/mediawiki.png);"
        href="https://www.mediawiki.org/"
        title="Main Page"></a>
    </div>
    <div class="portal"><div class="body">
<?php
    echo $this->parent->parse( wfMessage( 'config-sidebar' )->plain(), true );
?>
    </div></div>
</div>

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

    public function outputShortHeader() {
?>
<?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>
<head>
    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <meta name="robots" content="noindex, nofollow" />
    <title><?php $this->outputTitle(); ?></title>
    <?php echo $this->getCssUrl() . "\n"; ?>
    <?php echo $this->getJQuery(); ?>
    <?php echo Html::linkedScript( '../skins/common/config.js' ); ?>
</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" );
    }

}