includes/installer/WebInstallerOutput.php

   1 <?php
   2 /**
   3  * Output handler for the web installer.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 /**
  25  * Output class modelled on OutputPage.
  26  *
  27  * I've opted to use a distinct class rather than derive from OutputPage here in
  28  * the interests of separation of concerns: if we used a subclass, there would be
  29  * quite a lot of things you could do in OutputPage that would break the installer,
  30  * that wouldn't be immediately obvious.
  31  *
  32  * @ingroup Deployment
  33  * @since 1.17
  34  */
  35 class WebInstallerOutput {
  36
  37         /**
  38          * The WebInstaller object this WebInstallerOutput is used by.
  39          *
  40          * @var WebInstaller
  41          */
  42         public $parent;
  43
  44         /**
  45          * Buffered contents that haven't been output yet
  46          * @var string
  47          */
  48         private $contents = '';
  49
  50         /**
  51          * Has the header (or short header) been output?
  52          * @var bool
  53          */
  54         private $headerDone = false;
  55
  56         /**
  57          * @var string
  58          */
  59         public $redirectTarget;
  60
  61         /**
  62          * Does the current page need to allow being used as a frame?
  63          * If not, X-Frame-Options will be output to forbid it.
  64          *
  65          * @var bool
  66          */
  67         public $allowFrames = false;
  68
  69         /**
  70          * Whether to use the limited header (used during CC license callbacks)
  71          * @var bool
  72          */
  73         private $useShortHeader = false;
  74
  75         /**
  76          * @param WebInstaller $parent
  77          */
  78         public function __construct( WebInstaller $parent ) {
  79                 $this->parent = $parent;
  80         }
  81
  82         /**
  83          * @param string $html
  84          */
  85         public function addHTML( $html ) {
  86                 $this->contents .= $html;
  87                 $this->flush();
  88         }
  89
  90         /**
  91          * @param string $text
  92          */
  93         public function addWikiText( $text ) {
  94                 $this->addHTML( $this->parent->parse( $text ) );
  95         }
  96
  97         /**
  98          * @param string $html
  99          */
 100         public function addHTMLNoFlush( $html ) {
 101                 $this->contents .= $html;
 102         }
 103
 104         /**
 105          * @param string $url
 106          *
 107          * @throws MWException
 108          */
 109         public function redirect( $url ) {
 110                 if ( $this->headerDone ) {
 111                         throw new MWException( __METHOD__ . ' called after sending headers' );
 112                 }
 113                 $this->redirectTarget = $url;
 114         }
 115
 116         public function output() {
 117                 $this->flush();
 118
 119                 if ( !$this->redirectTarget ) {
 120                         $this->outputFooter();
 121                 }
 122         }
 123
 124         /**
 125          * Get the stylesheet of the MediaWiki skin.
 126          *
 127          * @return string
 128          */
 129         public function getCSS() {
 130                 global $wgStyleDirectory;
 131
 132                 $moduleNames = [
 133                         // See SkinTemplate::setupSkinUserCss
 134                         'mediawiki.legacy.shared',
 135                         // See Vector::setupSkinUserCss
 136                         'mediawiki.skinning.interface',
 137                 ];
 138
 139                 $resourceLoader = new ResourceLoader();
 140
 141                 if ( file_exists( "$wgStyleDirectory/Vector/skin.json" ) ) {
 142                         // Force loading Vector skin if available as a fallback skin
 143                         // for whatever ResourceLoader wants to have as the default.
 144                         $registry = new ExtensionRegistry();
 145                         $data = $registry->readFromQueue( [
 146                                 "$wgStyleDirectory/Vector/skin.json" => 1,
 147                         ] );
 148                         if ( isset( $data['globals']['wgResourceModules'] ) ) {
 149                                 $resourceLoader->register( $data['globals']['wgResourceModules'] );
 150                         }
 151
 152                         $moduleNames[] = 'skins.vector.styles';
 153                 }
 154
 155                 $moduleNames[] = 'mediawiki.legacy.config';
 156
 157                 $rlContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( [
 158                                 'debug' => 'true',
 159                                 'lang' => $this->getLanguageCode(),
 160                                 'only' => 'styles',
 161                 ] ) );
 162
 163                 $styles = [];
 164                 foreach ( $moduleNames as $moduleName ) {
 165                         /** @var ResourceLoaderFileModule $module */
 166                         $module = $resourceLoader->getModule( $moduleName );
 167                         if ( !$module ) {
 168                                 // T98043: Don't fatal, but it won't look as pretty.
 169                                 continue;
 170                         }
 171
 172                         // Based on: ResourceLoaderFileModule::getStyles (without the DB query)
 173                         $styles = array_merge( $styles, ResourceLoader::makeCombinedStyles(
 174                                 $module->readStyleFiles(
 175                                         $module->getStyleFiles( $rlContext ),
 176                                         $module->getFlip( $rlContext ),
 177                                         $rlContext
 178                         ) ) );
 179                 }
 180
 181                 return implode( "\n", $styles );
 182         }
 183
 184         /**
 185          * "<link>" to index.php?css=1 for the "<head>"
 186          *
 187          * @return string
 188          */
 189         private function getCssUrl() {
 190                 return Html::linkedStyle( $_SERVER['PHP_SELF'] . '?css=1' );
 191         }
 192
 193         public function useShortHeader( $use = true ) {
 194                 $this->useShortHeader = $use;
 195         }
 196
 197         public function allowFrames( $allow = true ) {
 198                 $this->allowFrames = $allow;
 199         }
 200
 201         public function flush() {
 202                 if ( !$this->headerDone ) {
 203                         $this->outputHeader();
 204                 }
 205                 if ( !$this->redirectTarget && strlen( $this->contents ) ) {
 206                         echo $this->contents;
 207                         flush();
 208                         $this->contents = '';
 209                 }
 210         }
 211
 212         /**
 213          * @return string
 214          */
 215         public function getDir() {
 216                 global $wgLang;
 217
 218                 return is_object( $wgLang ) ? $wgLang->getDir() : 'ltr';
 219         }
 220
 221         /**
 222          * @return string
 223          */
 224         public function getLanguageCode() {
 225                 global $wgLang;
 226
 227                 return is_object( $wgLang ) ? $wgLang->getCode() : 'en';
 228         }
 229
 230         /**
 231          * @return string[]
 232          */
 233         public function getHeadAttribs() {
 234                 return [
 235                         'dir' => $this->getDir(),
 236                         'lang' => wfBCP47( $this->getLanguageCode() ),
 237                 ];
 238         }
 239
 240         /**
 241          * Get whether the header has been output
 242          *
 243          * @return bool
 244          */
 245         public function headerDone() {
 246                 return $this->headerDone;
 247         }
 248
 249         public function outputHeader() {
 250                 $this->headerDone = true;
 251                 $this->parent->request->response()->header( 'Content-Type: text/html; charset=utf-8' );
 252
 253                 if ( !$this->allowFrames ) {
 254                         $this->parent->request->response()->header( 'X-Frame-Options: DENY' );
 255                 }
 256
 257                 if ( $this->redirectTarget ) {
 258                         $this->parent->request->response()->header( 'Location: ' . $this->redirectTarget );
 259
 260                         return;
 261                 }
 262
 263                 if ( $this->useShortHeader ) {
 264                         $this->outputShortHeader();
 265
 266                         return;
 267                 }
 268 ?>
 269 <?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>
 270 <head>
 271         <meta name="robots" content="noindex, nofollow" />
 272         <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
 273         <title><?php $this->outputTitle(); ?></title>
 274         <?php echo $this->getCssUrl() . "\n"; ?>
 275         <?php echo $this->getJQuery() . "\n"; ?>
 276         <?php echo Html::linkedScript( 'config.js' ) . "\n"; ?>
 277 </head>
 278
 279 <?php echo Html::openElement( 'body', [ 'class' => $this->getDir() ] ) . "\n"; ?>
 280 <div id="mw-page-base"></div>
 281 <div id="mw-head-base"></div>
 282 <div id="content" class="mw-body">
 283 <div id="bodyContent" class="mw-body-content">
 284
 285 <h1><?php $this->outputTitle(); ?></h1>
 286 <?php
 287         }
 288
 289         public function outputFooter() {
 290                 if ( $this->useShortHeader ) {
 291                         echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
 292
 293                         return;
 294                 }
 295 ?>
 296
 297 </div></div>
 298
 299 <div id="mw-panel">
 300         <div class="portal" id="p-logo">
 301           <a style="background-image: url(images/installer-logo.png);"
 302                 href="https://www.mediawiki.org/"
 303                 title="Main Page"></a>
 304         </div>
 305 <?php
 306         $message = wfMessage( 'config-sidebar' )->plain();
 307         foreach ( explode( '----', $message ) as $section ) {
 308                 echo '<div class="portal"><div class="body">';
 309                 echo $this->parent->parse( $section, true );
 310                 echo '</div></div>';
 311         }
 312 ?>
 313 </div>
 314
 315 <?php
 316                 echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
 317         }
 318
 319         public function outputShortHeader() {
 320 ?>
 321 <?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>
 322 <head>
 323         <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
 324         <meta name="robots" content="noindex, nofollow" />
 325         <title><?php $this->outputTitle(); ?></title>
 326         <?php echo $this->getCssUrl() . "\n"; ?>
 327         <?php echo $this->getJQuery(); ?>
 328         <?php echo Html::linkedScript( 'config.js' ); ?>
 329 </head>
 330
 331 <body style="background-image: none">
 332 <?php
 333         }
 334
 335         public function outputTitle() {
 336                 global $wgVersion;
 337                 echo wfMessage( 'config-title', $wgVersion )->escaped();
 338         }
 339
 340         /**
 341          * @return string
 342          */
 343         public function getJQuery() {
 344                 return Html::linkedScript( "../resources/lib/jquery/jquery.js" );
 345         }
 346
 347 }