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