includes/installer/WebInstaller.php

   1 <?php
   2 /**
   3  * Core installer web interface.
   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  * Class for the core installer web interface.
  26  *
  27  * @ingroup Deployment
  28  * @since 1.17
  29  */
  30 class WebInstaller extends Installer {
  31
  32         /**
  33          * @var WebInstallerOutput
  34          */
  35         public $output;
  36
  37         /**
  38          * WebRequest object.
  39          *
  40          * @var WebRequest
  41          */
  42         public $request;
  43
  44         /**
  45          * Cached session array.
  46          *
  47          * @var array[]
  48          */
  49         protected $session;
  50
  51         /**
  52          * Captured PHP error text. Temporary.
  53          *
  54          * @var string[]
  55          */
  56         protected $phpErrors;
  57
  58         /**
  59          * The main sequence of page names. These will be displayed in turn.
  60          *
  61          * To add a new installer page:
  62          *    * Add it to this WebInstaller::$pageSequence property
  63          *    * Add a "config-page-<name>" message
  64          *    * Add a "WebInstaller<name>" class
  65          *
  66          * @var string[]
  67          */
  68         public $pageSequence = [
  69                 'Language',
  70                 'ExistingWiki',
  71                 'Welcome',
  72                 'DBConnect',
  73                 'Upgrade',
  74                 'DBSettings',
  75                 'Name',
  76                 'Options',
  77                 'Install',
  78                 'Complete',
  79         ];
  80
  81         /**
  82          * Out of sequence pages, selectable by the user at any time.
  83          *
  84          * @var string[]
  85          */
  86         protected $otherPages = [
  87                 'Restart',
  88                 'Readme',
  89                 'ReleaseNotes',
  90                 'Copying',
  91                 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
  92         ];
  93
  94         /**
  95          * Array of pages which have declared that they have been submitted, have validated
  96          * their input, and need no further processing.
  97          *
  98          * @var bool[]
  99          */
 100         protected $happyPages;
 101
 102         /**
 103          * List of "skipped" pages. These are pages that will automatically continue
 104          * to the next page on any GET request. To avoid breaking the "back" button,
 105          * they need to be skipped during a back operation.
 106          *
 107          * @var bool[]
 108          */
 109         protected $skippedPages;
 110
 111         /**
 112          * Flag indicating that session data may have been lost.
 113          *
 114          * @var bool
 115          */
 116         public $showSessionWarning = false;
 117
 118         /**
 119          * Numeric index of the page we're on
 120          *
 121          * @var int
 122          */
 123         protected $tabIndex = 1;
 124
 125         /**
 126          * Name of the page we're on
 127          *
 128          * @var string
 129          */
 130         protected $currentPageName;
 131
 132         /**
 133          * @param WebRequest $request
 134          */
 135         public function __construct( WebRequest $request ) {
 136                 parent::__construct();
 137                 $this->output = new WebInstallerOutput( $this );
 138                 $this->request = $request;
 139
 140                 // Add parser hooks
 141                 global $wgParser;
 142                 $wgParser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
 143                 $wgParser->setHook( 'doclink', [ $this, 'docLink' ] );
 144         }
 145
 146         /**
 147          * Main entry point.
 148          *
 149          * @param array[] $session Initial session array
 150          *
 151          * @return array[] New session array
 152          */
 153         public function execute( array $session ) {
 154                 $this->session = $session;
 155
 156                 if ( isset( $session['settings'] ) ) {
 157                         $this->settings = $session['settings'] + $this->settings;
 158                         // T187586 MediaWikiServices works with globals
 159                         foreach ( $this->settings as $key => $val ) {
 160                                 $GLOBALS[$key] = $val;
 161                         }
 162                 }
 163
 164                 $this->setupLanguage();
 165
 166                 if ( ( $this->getVar( '_InstallDone' ) || $this->getVar( '_UpgradeDone' ) )
 167                         && $this->request->getVal( 'localsettings' )
 168                 ) {
 169                         $this->request->response()->header( 'Content-type: application/x-httpd-php' );
 170                         $this->request->response()->header(
 171                                 'Content-Disposition: attachment; filename="LocalSettings.php"'
 172                         );
 173
 174                         $ls = InstallerOverrides::getLocalSettingsGenerator( $this );
 175                         $rightsProfile = $this->rightsProfiles[$this->getVar( '_RightsProfile' )];
 176                         foreach ( $rightsProfile as $group => $rightsArr ) {
 177                                 $ls->setGroupRights( $group, $rightsArr );
 178                         }
 179                         echo $ls->getText();
 180
 181                         return $this->session;
 182                 }
 183
 184                 $isCSS = $this->request->getVal( 'css' );
 185                 if ( $isCSS ) {
 186                         $this->outputCss();
 187                         return $this->session;
 188                 }
 189
 190                 if ( isset( $session['happyPages'] ) ) {
 191                         $this->happyPages = $session['happyPages'];
 192                 } else {
 193                         $this->happyPages = [];
 194                 }
 195
 196                 if ( isset( $session['skippedPages'] ) ) {
 197                         $this->skippedPages = $session['skippedPages'];
 198                 } else {
 199                         $this->skippedPages = [];
 200                 }
 201
 202                 $lowestUnhappy = $this->getLowestUnhappy();
 203
 204                 # Special case for Creative Commons partner chooser box.
 205                 if ( $this->request->getVal( 'SubmitCC' ) ) {
 206                         $page = $this->getPageByName( 'Options' );
 207                         $this->output->useShortHeader();
 208                         $this->output->allowFrames();
 209                         $page->submitCC();
 210
 211                         return $this->finish();
 212                 }
 213
 214                 if ( $this->request->getVal( 'ShowCC' ) ) {
 215                         $page = $this->getPageByName( 'Options' );
 216                         $this->output->useShortHeader();
 217                         $this->output->allowFrames();
 218                         $this->output->addHTML( $page->getCCDoneBox() );
 219
 220                         return $this->finish();
 221                 }
 222
 223                 # Get the page name.
 224                 $pageName = $this->request->getVal( 'page' );
 225
 226                 if ( in_array( $pageName, $this->otherPages ) ) {
 227                         # Out of sequence
 228                         $pageId = false;
 229                         $page = $this->getPageByName( $pageName );
 230                 } else {
 231                         # Main sequence
 232                         if ( !$pageName || !in_array( $pageName, $this->pageSequence ) ) {
 233                                 $pageId = $lowestUnhappy;
 234                         } else {
 235                                 $pageId = array_search( $pageName, $this->pageSequence );
 236                         }
 237
 238                         # If necessary, move back to the lowest-numbered unhappy page
 239                         if ( $pageId > $lowestUnhappy ) {
 240                                 $pageId = $lowestUnhappy;
 241                                 if ( $lowestUnhappy == 0 ) {
 242                                         # Knocked back to start, possible loss of session data.
 243                                         $this->showSessionWarning = true;
 244                                 }
 245                         }
 246
 247                         $pageName = $this->pageSequence[$pageId];
 248                         $page = $this->getPageByName( $pageName );
 249                 }
 250
 251                 # If a back button was submitted, go back without submitting the form data.
 252                 if ( $this->request->wasPosted() && $this->request->getBool( 'submit-back' ) ) {
 253                         if ( $this->request->getVal( 'lastPage' ) ) {
 254                                 $nextPage = $this->request->getVal( 'lastPage' );
 255                         } elseif ( $pageId !== false ) {
 256                                 # Main sequence page
 257                                 # Skip the skipped pages
 258                                 $nextPageId = $pageId;
 259
 260                                 do {
 261                                         $nextPageId--;
 262                                         $nextPage = $this->pageSequence[$nextPageId];
 263                                 } while ( isset( $this->skippedPages[$nextPage] ) );
 264                         } else {
 265                                 $nextPage = $this->pageSequence[$lowestUnhappy];
 266                         }
 267
 268                         $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
 269
 270                         return $this->finish();
 271                 }
 272
 273                 # Execute the page.
 274                 $this->currentPageName = $page->getName();
 275                 $this->startPageWrapper( $pageName );
 276
 277                 if ( $page->isSlow() ) {
 278                         $this->disableTimeLimit();
 279                 }
 280
 281                 $result = $page->execute();
 282
 283                 $this->endPageWrapper();
 284
 285                 if ( $result == 'skip' ) {
 286                         # Page skipped without explicit submission.
 287                         # Skip it when we click "back" so that we don't just go forward again.
 288                         $this->skippedPages[$pageName] = true;
 289                         $result = 'continue';
 290                 } else {
 291                         unset( $this->skippedPages[$pageName] );
 292                 }
 293
 294                 # If it was posted, the page can request a continue to the next page.
 295                 if ( $result === 'continue' && !$this->output->headerDone() ) {
 296                         if ( $pageId !== false ) {
 297                                 $this->happyPages[$pageId] = true;
 298                         }
 299
 300                         $lowestUnhappy = $this->getLowestUnhappy();
 301
 302                         if ( $this->request->getVal( 'lastPage' ) ) {
 303                                 $nextPage = $this->request->getVal( 'lastPage' );
 304                         } elseif ( $pageId !== false ) {
 305                                 $nextPage = $this->pageSequence[$pageId + 1];
 306                         } else {
 307                                 $nextPage = $this->pageSequence[$lowestUnhappy];
 308                         }
 309
 310                         if ( array_search( $nextPage, $this->pageSequence ) > $lowestUnhappy ) {
 311                                 $nextPage = $this->pageSequence[$lowestUnhappy];
 312                         }
 313
 314                         $this->output->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
 315                 }
 316
 317                 return $this->finish();
 318         }
 319
 320         /**
 321          * Find the next page in sequence that hasn't been completed
 322          * @return int
 323          */
 324         public function getLowestUnhappy() {
 325                 if ( count( $this->happyPages ) == 0 ) {
 326                         return 0;
 327                 } else {
 328                         return max( array_keys( $this->happyPages ) ) + 1;
 329                 }
 330         }
 331
 332         /**
 333          * Start the PHP session. This may be called before execute() to start the PHP session.
 334          *
 335          * @throws Exception
 336          * @return bool
 337          */
 338         public function startSession() {
 339                 if ( wfIniGetBool( 'session.auto_start' ) || session_id() ) {
 340                         // Done already
 341                         return true;
 342                 }
 343
 344                 $this->phpErrors = [];
 345                 set_error_handler( [ $this, 'errorHandler' ] );
 346                 try {
 347                         session_name( 'mw_installer_session' );
 348                         session_start();
 349                 } catch ( Exception $e ) {
 350                         restore_error_handler();
 351                         throw $e;
 352                 }
 353                 restore_error_handler();
 354
 355                 if ( $this->phpErrors ) {
 356                         return false;
 357                 }
 358
 359                 return true;
 360         }
 361
 362         /**
 363          * Get a hash of data identifying this MW installation.
 364          *
 365          * This is used by mw-config/index.php to prevent multiple installations of MW
 366          * on the same cookie domain from interfering with each other.
 367          *
 368          * @return string
 369          */
 370         public function getFingerprint() {
 371                 // Get the base URL of the installation
 372                 $url = $this->request->getFullRequestURL();
 373                 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
 374                         // Trim query string
 375                         $url = $m[1];
 376                 }
 377                 if ( preg_match( '!^(.*)/[^/]*/[^/]*$!', $url, $m ) ) {
 378                         // This... seems to try to get the base path from
 379                         // the /mw-config/index.php. Kinda scary though?
 380                         $url = $m[1];
 381                 }
 382
 383                 return md5( serialize( [
 384                         'local path' => dirname( __DIR__ ),
 385                         'url' => $url,
 386                         'version' => $GLOBALS['wgVersion']
 387                 ] ) );
 388         }
 389
 390         /**
 391          * Show an error message in a box. Parameters are like wfMessage(), or
 392          * alternatively, pass a Message object in.
 393          * @param string|Message $msg
 394          */
 395         public function showError( $msg /*...*/ ) {
 396                 if ( !( $msg instanceof Message ) ) {
 397                         $args = func_get_args();
 398                         array_shift( $args );
 399                         $args = array_map( 'htmlspecialchars', $args );
 400                         $msg = wfMessage( $msg, $args );
 401                 }
 402                 $text = $msg->useDatabase( false )->plain();
 403                 $this->output->addHTML( $this->getErrorBox( $text ) );
 404         }
 405
 406         /**
 407          * Temporary error handler for session start debugging.
 408          *
 409          * @param int $errno Unused
 410          * @param string $errstr
 411          */
 412         public function errorHandler( $errno, $errstr ) {
 413                 $this->phpErrors[] = $errstr;
 414         }
 415
 416         /**
 417          * Clean up from execute()
 418          *
 419          * @return array[]
 420          */
 421         public function finish() {
 422                 $this->output->output();
 423
 424                 $this->session['happyPages'] = $this->happyPages;
 425                 $this->session['skippedPages'] = $this->skippedPages;
 426                 $this->session['settings'] = $this->settings;
 427
 428                 return $this->session;
 429         }
 430
 431         /**
 432          * We're restarting the installation, reset the session, happyPages, etc
 433          */
 434         public function reset() {
 435                 $this->session = [];
 436                 $this->happyPages = [];
 437                 $this->settings = [];
 438         }
 439
 440         /**
 441          * Get a URL for submission back to the same script.
 442          *
 443          * @param string[] $query
 444          *
 445          * @return string
 446          */
 447         public function getUrl( $query = [] ) {
 448                 $url = $this->request->getRequestURL();
 449                 # Remove existing query
 450                 $url = preg_replace( '/\?.*$/', '', $url );
 451
 452                 if ( $query ) {
 453                         $url .= '?' . wfArrayToCgi( $query );
 454                 }
 455
 456                 return $url;
 457         }
 458
 459         /**
 460          * Get a WebInstallerPage by name.
 461          *
 462          * @param string $pageName
 463          * @return WebInstallerPage
 464          */
 465         public function getPageByName( $pageName ) {
 466                 $pageClass = 'WebInstaller' . $pageName;
 467
 468                 return new $pageClass( $this );
 469         }
 470
 471         /**
 472          * Get a session variable.
 473          *
 474          * @param string $name
 475          * @param array $default
 476          *
 477          * @return array
 478          */
 479         public function getSession( $name, $default = null ) {
 480                 if ( !isset( $this->session[$name] ) ) {
 481                         return $default;
 482                 } else {
 483                         return $this->session[$name];
 484                 }
 485         }
 486
 487         /**
 488          * Set a session variable.
 489          *
 490          * @param string $name Key for the variable
 491          * @param mixed $value
 492          */
 493         public function setSession( $name, $value ) {
 494                 $this->session[$name] = $value;
 495         }
 496
 497         /**
 498          * Get the next tabindex attribute value.
 499          *
 500          * @return int
 501          */
 502         public function nextTabIndex() {
 503                 return $this->tabIndex++;
 504         }
 505
 506         /**
 507          * Initializes language-related variables.
 508          */
 509         public function setupLanguage() {
 510                 global $wgLang, $wgContLang, $wgLanguageCode;
 511
 512                 if ( $this->getSession( 'test' ) === null && !$this->request->wasPosted() ) {
 513                         $wgLanguageCode = $this->getAcceptLanguage();
 514                         $wgLang = $wgContLang = Language::factory( $wgLanguageCode );
 515                         RequestContext::getMain()->setLanguage( $wgLang );
 516                         $this->setVar( 'wgLanguageCode', $wgLanguageCode );
 517                         $this->setVar( '_UserLang', $wgLanguageCode );
 518                 } else {
 519                         $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
 520                         $wgContLang = Language::factory( $wgLanguageCode );
 521                 }
 522         }
 523
 524         /**
 525          * Retrieves MediaWiki language from Accept-Language HTTP header.
 526          *
 527          * @return string
 528          */
 529         public function getAcceptLanguage() {
 530                 global $wgLanguageCode, $wgRequest;
 531
 532                 $mwLanguages = Language::fetchLanguageNames();
 533                 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
 534
 535                 foreach ( $headerLanguages as $lang ) {
 536                         if ( isset( $mwLanguages[$lang] ) ) {
 537                                 return $lang;
 538                         }
 539                 }
 540
 541                 return $wgLanguageCode;
 542         }
 543
 544         /**
 545          * Called by execute() before page output starts, to show a page list.
 546          *
 547          * @param string $currentPageName
 548          */
 549         private function startPageWrapper( $currentPageName ) {
 550                 $s = "<div class=\"config-page-wrapper\">\n";
 551                 $s .= "<div class=\"config-page\">\n";
 552                 $s .= "<div class=\"config-page-list\"><ul>\n";
 553                 $lastHappy = -1;
 554
 555                 foreach ( $this->pageSequence as $id => $pageName ) {
 556                         $happy = !empty( $this->happyPages[$id] );
 557                         $s .= $this->getPageListItem(
 558                                 $pageName,
 559                                 $happy || $lastHappy == $id - 1,
 560                                 $currentPageName
 561                         );
 562
 563                         if ( $happy ) {
 564                                 $lastHappy = $id;
 565                         }
 566                 }
 567
 568                 $s .= "</ul><br/><ul>\n";
 569                 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
 570                 // End list pane
 571                 $s .= "</ul></div>\n";
 572
 573                 // Messages:
 574                 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
 575                 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
 576                 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
 577                 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
 578                 $s .= Html::element( 'h2', [],
 579                         wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
 580
 581                 $this->output->addHTMLNoFlush( $s );
 582         }
 583
 584         /**
 585          * Get a list item for the page list.
 586          *
 587          * @param string $pageName
 588          * @param bool $enabled
 589          * @param string $currentPageName
 590          *
 591          * @return string
 592          */
 593         private function getPageListItem( $pageName, $enabled, $currentPageName ) {
 594                 $s = "<li class=\"config-page-list-item\">";
 595
 596                 // Messages:
 597                 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
 598                 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
 599                 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
 600                 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
 601                 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
 602
 603                 if ( $enabled ) {
 604                         $query = [ 'page' => $pageName ];
 605
 606                         if ( !in_array( $pageName, $this->pageSequence ) ) {
 607                                 if ( in_array( $currentPageName, $this->pageSequence ) ) {
 608                                         $query['lastPage'] = $currentPageName;
 609                                 }
 610
 611                                 $link = Html::element( 'a',
 612                                         [
 613                                                 'href' => $this->getUrl( $query )
 614                                         ],
 615                                         $name
 616                                 );
 617                         } else {
 618                                 $link = htmlspecialchars( $name );
 619                         }
 620
 621                         if ( $pageName == $currentPageName ) {
 622                                 $s .= "<span class=\"config-page-current\">$link</span>";
 623                         } else {
 624                                 $s .= $link;
 625                         }
 626                 } else {
 627                         $s .= Html::element( 'span',
 628                                 [
 629                                         'class' => 'config-page-disabled'
 630                                 ],
 631                                 $name
 632                         );
 633                 }
 634
 635                 $s .= "</li>\n";
 636
 637                 return $s;
 638         }
 639
 640         /**
 641          * Output some stuff after a page is finished.
 642          */
 643         private function endPageWrapper() {
 644                 $this->output->addHTMLNoFlush(
 645                         "<div class=\"visualClear\"></div>\n" .
 646                         "</div>\n" .
 647                         "<div class=\"visualClear\"></div>\n" .
 648                         "</div>" );
 649         }
 650
 651         /**
 652          * Get HTML for an error box with an icon.
 653          *
 654          * @param string $text Wikitext, get this with wfMessage()->plain()
 655          *
 656          * @return string
 657          */
 658         public function getErrorBox( $text ) {
 659                 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
 660         }
 661
 662         /**
 663          * Get HTML for a warning box with an icon.
 664          *
 665          * @param string $text Wikitext, get this with wfMessage()->plain()
 666          *
 667          * @return string
 668          */
 669         public function getWarningBox( $text ) {
 670                 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
 671         }
 672
 673         /**
 674          * Get HTML for an info box with an icon.
 675          *
 676          * @param string $text Wikitext, get this with wfMessage()->plain()
 677          * @param string|bool $icon Icon name, file in mw-config/images. Default: false
 678          * @param string|bool $class Additional class name to add to the wrapper div. Default: false.
 679          *
 680          * @return string
 681          */
 682         public function getInfoBox( $text, $icon = false, $class = false ) {
 683                 $text = $this->parse( $text, true );
 684                 $icon = ( $icon == false ) ?
 685                         'images/info-32.png' :
 686                         'images/' . $icon;
 687                 $alt = wfMessage( 'config-information' )->text();
 688
 689                 return Html::infoBox( $text, $icon, $alt, $class );
 690         }
 691
 692         /**
 693          * Get small text indented help for a preceding form field.
 694          * Parameters like wfMessage().
 695          *
 696          * @param string $msg
 697          * @return string
 698          */
 699         public function getHelpBox( $msg /*, ... */ ) {
 700                 $args = func_get_args();
 701                 array_shift( $args );
 702                 $args = array_map( 'htmlspecialchars', $args );
 703                 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
 704                 $html = $this->parse( $text, true );
 705
 706                 return "<div class=\"config-help-field-container\">\n" .
 707                         "<span class=\"config-help-field-hint\" title=\"" .
 708                         wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
 709                         wfMessage( 'config-help' )->escaped() . "</span>\n" .
 710                         "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
 711                         "</div>\n";
 712         }
 713
 714         /**
 715          * Output a help box.
 716          * @param string $msg Key for wfMessage()
 717          */
 718         public function showHelpBox( $msg /*, ... */ ) {
 719                 $args = func_get_args();
 720                 $html = call_user_func_array( [ $this, 'getHelpBox' ], $args );
 721                 $this->output->addHTML( $html );
 722         }
 723
 724         /**
 725          * Show a short informational message.
 726          * Output looks like a list.
 727          *
 728          * @param string $msg
 729          */
 730         public function showMessage( $msg /*, ... */ ) {
 731                 $args = func_get_args();
 732                 array_shift( $args );
 733                 $html = '<div class="config-message">' .
 734                         $this->parse( wfMessage( $msg, $args )->useDatabase( false )->plain() ) .
 735                         "</div>\n";
 736                 $this->output->addHTML( $html );
 737         }
 738
 739         /**
 740          * @param Status $status
 741          */
 742         public function showStatusMessage( Status $status ) {
 743                 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
 744                 foreach ( $errors as $error ) {
 745                         call_user_func_array( [ $this, 'showMessage' ], $error );
 746                 }
 747         }
 748
 749         /**
 750          * Label a control by wrapping a config-input div around it and putting a
 751          * label before it.
 752          *
 753          * @param string $msg
 754          * @param string $forId
 755          * @param string $contents
 756          * @param string $helpData
 757          * @return string
 758          */
 759         public function label( $msg, $forId, $contents, $helpData = "" ) {
 760                 if ( strval( $msg ) == '' ) {
 761                         $labelText = '&#160;';
 762                 } else {
 763                         $labelText = wfMessage( $msg )->escaped();
 764                 }
 765
 766                 $attributes = [ 'class' => 'config-label' ];
 767
 768                 if ( $forId ) {
 769                         $attributes['for'] = $forId;
 770                 }
 771
 772                 return "<div class=\"config-block\">\n" .
 773                         "  <div class=\"config-block-label\">\n" .
 774                         Xml::tags( 'label',
 775                                 $attributes,
 776                                 $labelText
 777                         ) . "\n" .
 778                         $helpData .
 779                         "  </div>\n" .
 780                         "  <div class=\"config-block-elements\">\n" .
 781                         $contents .
 782                         "  </div>\n" .
 783                         "</div>\n";
 784         }
 785
 786         /**
 787          * Get a labelled text box to configure a variable.
 788          *
 789          * @param mixed[] $params
 790          *    Parameters are:
 791          *      var:         The variable to be configured (required)
 792          *      label:       The message name for the label (required)
 793          *      attribs:     Additional attributes for the input element (optional)
 794          *      controlName: The name for the input element (optional)
 795          *      value:       The current value of the variable (optional)
 796          *      help:        The html for the help text (optional)
 797          *
 798          * @return string
 799          */
 800         public function getTextBox( $params ) {
 801                 if ( !isset( $params['controlName'] ) ) {
 802                         $params['controlName'] = 'config_' . $params['var'];
 803                 }
 804
 805                 if ( !isset( $params['value'] ) ) {
 806                         $params['value'] = $this->getVar( $params['var'] );
 807                 }
 808
 809                 if ( !isset( $params['attribs'] ) ) {
 810                         $params['attribs'] = [];
 811                 }
 812                 if ( !isset( $params['help'] ) ) {
 813                         $params['help'] = "";
 814                 }
 815
 816                 return $this->label(
 817                         $params['label'],
 818                         $params['controlName'],
 819                         Xml::input(
 820                                 $params['controlName'],
 821                                 30, // intended to be overridden by CSS
 822                                 $params['value'],
 823                                 $params['attribs'] + [
 824                                         'id' => $params['controlName'],
 825                                         'class' => 'config-input-text',
 826                                         'tabindex' => $this->nextTabIndex()
 827                                 ]
 828                         ),
 829                         $params['help']
 830                 );
 831         }
 832
 833         /**
 834          * Get a labelled textarea to configure a variable
 835          *
 836          * @param mixed[] $params
 837          *    Parameters are:
 838          *      var:         The variable to be configured (required)
 839          *      label:       The message name for the label (required)
 840          *      attribs:     Additional attributes for the input element (optional)
 841          *      controlName: The name for the input element (optional)
 842          *      value:       The current value of the variable (optional)
 843          *      help:        The html for the help text (optional)
 844          *
 845          * @return string
 846          */
 847         public function getTextArea( $params ) {
 848                 if ( !isset( $params['controlName'] ) ) {
 849                         $params['controlName'] = 'config_' . $params['var'];
 850                 }
 851
 852                 if ( !isset( $params['value'] ) ) {
 853                         $params['value'] = $this->getVar( $params['var'] );
 854                 }
 855
 856                 if ( !isset( $params['attribs'] ) ) {
 857                         $params['attribs'] = [];
 858                 }
 859                 if ( !isset( $params['help'] ) ) {
 860                         $params['help'] = "";
 861                 }
 862
 863                 return $this->label(
 864                         $params['label'],
 865                         $params['controlName'],
 866                         Xml::textarea(
 867                                 $params['controlName'],
 868                                 $params['value'],
 869                                 30,
 870                                 5,
 871                                 $params['attribs'] + [
 872                                         'id' => $params['controlName'],
 873                                         'class' => 'config-input-text',
 874                                         'tabindex' => $this->nextTabIndex()
 875                                 ]
 876                         ),
 877                         $params['help']
 878                 );
 879         }
 880
 881         /**
 882          * Get a labelled password box to configure a variable.
 883          *
 884          * Implements password hiding
 885          * @param mixed[] $params
 886          *    Parameters are:
 887          *      var:         The variable to be configured (required)
 888          *      label:       The message name for the label (required)
 889          *      attribs:     Additional attributes for the input element (optional)
 890          *      controlName: The name for the input element (optional)
 891          *      value:       The current value of the variable (optional)
 892          *      help:        The html for the help text (optional)
 893          *
 894          * @return string
 895          */
 896         public function getPasswordBox( $params ) {
 897                 if ( !isset( $params['value'] ) ) {
 898                         $params['value'] = $this->getVar( $params['var'] );
 899                 }
 900
 901                 if ( !isset( $params['attribs'] ) ) {
 902                         $params['attribs'] = [];
 903                 }
 904
 905                 $params['value'] = $this->getFakePassword( $params['value'] );
 906                 $params['attribs']['type'] = 'password';
 907
 908                 return $this->getTextBox( $params );
 909         }
 910
 911         /**
 912          * Get a labelled checkbox to configure a boolean variable.
 913          *
 914          * @param mixed[] $params
 915          *    Parameters are:
 916          *      var:         The variable to be configured (required)
 917          *      label:       The message name for the label (required)
 918          *      labelAttribs:Additional attributes for the label element (optional)
 919          *      attribs:     Additional attributes for the input element (optional)
 920          *      controlName: The name for the input element (optional)
 921          *      value:       The current value of the variable (optional)
 922          *      help:        The html for the help text (optional)
 923          *
 924          * @return string
 925          */
 926         public function getCheckBox( $params ) {
 927                 if ( !isset( $params['controlName'] ) ) {
 928                         $params['controlName'] = 'config_' . $params['var'];
 929                 }
 930
 931                 if ( !isset( $params['value'] ) ) {
 932                         $params['value'] = $this->getVar( $params['var'] );
 933                 }
 934
 935                 if ( !isset( $params['attribs'] ) ) {
 936                         $params['attribs'] = [];
 937                 }
 938                 if ( !isset( $params['help'] ) ) {
 939                         $params['help'] = "";
 940                 }
 941                 if ( !isset( $params['labelAttribs'] ) ) {
 942                         $params['labelAttribs'] = [];
 943                 }
 944                 if ( isset( $params['rawtext'] ) ) {
 945                         $labelText = $params['rawtext'];
 946                 } else {
 947                         $labelText = $this->parse( wfMessage( $params['label'] )->text() );
 948                 }
 949
 950                 return "<div class=\"config-input-check\">\n" .
 951                         $params['help'] .
 952                         Html::rawElement(
 953                                 'label',
 954                                 $params['labelAttribs'],
 955                                 Xml::check(
 956                                         $params['controlName'],
 957                                         $params['value'],
 958                                         $params['attribs'] + [
 959                                                 'id' => $params['controlName'],
 960                                                 'tabindex' => $this->nextTabIndex(),
 961                                         ]
 962                                 ) .
 963                                 $labelText . "\n"
 964                                 ) .
 965                         "</div>\n";
 966         }
 967
 968         /**
 969          * Get a set of labelled radio buttons.
 970          *
 971          * @param mixed[] $params
 972          *    Parameters are:
 973          *      var:             The variable to be configured (required)
 974          *      label:           The message name for the label (required)
 975          *      itemLabelPrefix: The message name prefix for the item labels (required)
 976          *      itemLabels:      List of message names to use for the item labels instead
 977          *                       of itemLabelPrefix, keyed by values
 978          *      values:          List of allowed values (required)
 979          *      itemAttribs:     Array of attribute arrays, outer key is the value name (optional)
 980          *      commonAttribs:   Attribute array applied to all items
 981          *      controlName:     The name for the input element (optional)
 982          *      value:           The current value of the variable (optional)
 983          *      help:            The html for the help text (optional)
 984          *
 985          * @return string
 986          */
 987         public function getRadioSet( $params ) {
 988                 $items = $this->getRadioElements( $params );
 989
 990                 if ( !isset( $params['label'] ) ) {
 991                         $label = '';
 992                 } else {
 993                         $label = $params['label'];
 994                 }
 995
 996                 if ( !isset( $params['controlName'] ) ) {
 997                         $params['controlName'] = 'config_' . $params['var'];
 998                 }
 999
1000                 if ( !isset( $params['help'] ) ) {
1001                         $params['help'] = "";
1002                 }
1003
1004                 $s = "<ul>\n";
1005                 foreach ( $items as $value => $item ) {
1006                         $s .= "<li>$item</li>\n";
1007                 }
1008                 $s .= "</ul>\n";
1009
1010                 return $this->label( $label, $params['controlName'], $s, $params['help'] );
1011         }
1012
1013         /**
1014          * Get a set of labelled radio buttons. You probably want to use getRadioSet(), not this.
1015          *
1016          * @see getRadioSet
1017          *
1018          * @param mixed[] $params
1019          * @return array
1020          */
1021         public function getRadioElements( $params ) {
1022                 if ( !isset( $params['controlName'] ) ) {
1023                         $params['controlName'] = 'config_' . $params['var'];
1024                 }
1025
1026                 if ( !isset( $params['value'] ) ) {
1027                         $params['value'] = $this->getVar( $params['var'] );
1028                 }
1029
1030                 $items = [];
1031
1032                 foreach ( $params['values'] as $value ) {
1033                         $itemAttribs = [];
1034
1035                         if ( isset( $params['commonAttribs'] ) ) {
1036                                 $itemAttribs = $params['commonAttribs'];
1037                         }
1038
1039                         if ( isset( $params['itemAttribs'][$value] ) ) {
1040                                 $itemAttribs = $params['itemAttribs'][$value] + $itemAttribs;
1041                         }
1042
1043                         $checked = $value == $params['value'];
1044                         $id = $params['controlName'] . '_' . $value;
1045                         $itemAttribs['id'] = $id;
1046                         $itemAttribs['tabindex'] = $this->nextTabIndex();
1047
1048                         $items[$value] =
1049                                 Xml::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1050                                 '&#160;' .
1051                                 Xml::tags( 'label', [ 'for' => $id ], $this->parse(
1052                                         isset( $params['itemLabels'] ) ?
1053                                                 wfMessage( $params['itemLabels'][$value] )->plain() :
1054                                                 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1055                                 ) );
1056                 }
1057
1058                 return $items;
1059         }
1060
1061         /**
1062          * Output an error or warning box using a Status object.
1063          *
1064          * @param Status $status
1065          */
1066         public function showStatusBox( $status ) {
1067                 if ( !$status->isGood() ) {
1068                         $text = $status->getWikiText();
1069
1070                         if ( $status->isOK() ) {
1071                                 $box = $this->getWarningBox( $text );
1072                         } else {
1073                                 $box = $this->getErrorBox( $text );
1074                         }
1075
1076                         $this->output->addHTML( $box );
1077                 }
1078         }
1079
1080         /**
1081          * Convenience function to set variables based on form data.
1082          * Assumes that variables containing "password" in the name are (potentially
1083          * fake) passwords.
1084          *
1085          * @param string[] $varNames
1086          * @param string $prefix The prefix added to variables to obtain form names
1087          *
1088          * @return string[]
1089          */
1090         public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1091                 $newValues = [];
1092
1093                 foreach ( $varNames as $name ) {
1094                         $value = $this->request->getVal( $prefix . $name );
1095                         // T32524, do not trim passwords
1096                         if ( stripos( $name, 'password' ) === false ) {
1097                                 $value = trim( $value );
1098                         }
1099                         $newValues[$name] = $value;
1100
1101                         if ( $value === null ) {
1102                                 // Checkbox?
1103                                 $this->setVar( $name, false );
1104                         } else {
1105                                 if ( stripos( $name, 'password' ) !== false ) {
1106                                         $this->setPassword( $name, $value );
1107                                 } else {
1108                                         $this->setVar( $name, $value );
1109                                 }
1110                         }
1111                 }
1112
1113                 return $newValues;
1114         }
1115
1116         /**
1117          * Helper for Installer::docLink()
1118          *
1119          * @param string $page
1120          *
1121          * @return string
1122          */
1123         protected function getDocUrl( $page ) {
1124                 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1125
1126                 if ( in_array( $this->currentPageName, $this->pageSequence ) ) {
1127                         $url .= '&lastPage=' . urlencode( $this->currentPageName );
1128                 }
1129
1130                 return $url;
1131         }
1132
1133         /**
1134          * Extension tag hook for a documentation link.
1135          *
1136          * @param string $linkText
1137          * @param string[] $attribs
1138          * @param Parser $parser Unused
1139          *
1140          * @return string
1141          */
1142         public function docLink( $linkText, $attribs, $parser ) {
1143                 $url = $this->getDocUrl( $attribs['href'] );
1144
1145                 return '<a href="' . htmlspecialchars( $url ) . '">' .
1146                         htmlspecialchars( $linkText ) .
1147                         '</a>';
1148         }
1149
1150         /**
1151          * Helper for "Download LocalSettings" link on WebInstall_Complete
1152          *
1153          * @param string $text Unused
1154          * @param string[] $attribs Unused
1155          * @param Parser $parser Unused
1156          *
1157          * @return string Html for download link
1158          */
1159         public function downloadLinkHook( $text, $attribs, $parser ) {
1160                 $anchor = Html::rawElement( 'a',
1161                         [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1162                         wfMessage( 'config-download-localsettings' )->parse()
1163                 );
1164
1165                 return Html::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1166         }
1167
1168         /**
1169          * If the software package wants the LocalSettings.php file
1170          * to be placed in a specific location, override this function
1171          * (see mw-config/overrides/README) to return the path of
1172          * where the file should be saved, or false for a generic
1173          * "in the base of your install"
1174          *
1175          * @since 1.27
1176          * @return string|bool
1177          */
1178         public function getLocalSettingsLocation() {
1179                 return false;
1180         }
1181
1182         /**
1183          * @return bool
1184          */
1185         public function envCheckPath() {
1186                 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1187                 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1188                 // to get the path to the current script... hopefully it's reliable. SIGH
1189                 $path = false;
1190                 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1191                         $path = $_SERVER['PHP_SELF'];
1192                 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1193                         $path = $_SERVER['SCRIPT_NAME'];
1194                 }
1195                 if ( $path === false ) {
1196                         $this->showError( 'config-no-uri' );
1197                         return false;
1198                 }
1199
1200                 return parent::envCheckPath();
1201         }
1202
1203         public function envPrepPath() {
1204                 parent::envPrepPath();
1205                 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1206                 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1207                 // to get the path to the current script... hopefully it's reliable. SIGH
1208                 $path = false;
1209                 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1210                         $path = $_SERVER['PHP_SELF'];
1211                 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1212                         $path = $_SERVER['SCRIPT_NAME'];
1213                 }
1214                 if ( $path !== false ) {
1215                         $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1216
1217                         $this->setVar( 'wgScriptPath', "$scriptPath" );
1218                         // Update variables set from Setup.php that are derived from wgScriptPath
1219                         $this->setVar( 'wgScript', "$scriptPath/index.php" );
1220                         $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1221                         $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1222                         $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1223                         $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1224                         $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1225                         $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1226                 }
1227         }
1228
1229         /**
1230          * @return string
1231          */
1232         protected function envGetDefaultServer() {
1233                 return WebRequest::detectServer();
1234         }
1235
1236         /**
1237          * Output stylesheet for web installer pages
1238          */
1239         public function outputCss() {
1240                 $this->request->response()->header( 'Content-type: text/css' );
1241                 echo $this->output->getCSS();
1242         }
1243
1244         /**
1245          * @return string[]
1246          */
1247         public function getPhpErrors() {
1248                 return $this->phpErrors;
1249         }
1250
1251 }