3 * Core installer web interface.
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.
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.
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
25 * Class for the core installer web interface.
30 class WebInstaller
extends Installer
{
33 * @var WebInstallerOutput
45 * Cached session array.
52 * Captured PHP error text. Temporary.
59 * The main sequence of page names. These will be displayed in turn.
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
68 public $pageSequence = [
82 * Out of sequence pages, selectable by the user at any time.
86 protected $otherPages = [
91 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
95 * Array of pages which have declared that they have been submitted, have validated
96 * their input, and need no further processing.
100 protected $happyPages;
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.
109 protected $skippedPages;
112 * Flag indicating that session data may have been lost.
116 public $showSessionWarning = false;
119 * Numeric index of the page we're on
123 protected $tabIndex = 1;
126 * Name of the page we're on
130 protected $currentPageName;
133 * @param WebRequest $request
135 public function __construct( WebRequest
$request ) {
136 parent
::__construct();
137 $this->output
= new WebInstallerOutput( $this );
138 $this->request
= $request;
142 $wgParser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
143 $wgParser->setHook( 'doclink', [ $this, 'docLink' ] );
149 * @param array[] $session Initial session array
151 * @return array[] New session array
153 public function execute( array $session ) {
154 $this->session
= $session;
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;
164 $this->setupLanguage();
166 if ( ( $this->getVar( '_InstallDone' ) ||
$this->getVar( '_UpgradeDone' ) )
167 && $this->request
->getVal( 'localsettings' )
169 $this->request
->response()->header( 'Content-type: application/x-httpd-php' );
170 $this->request
->response()->header(
171 'Content-Disposition: attachment; filename="LocalSettings.php"'
174 $ls = InstallerOverrides
::getLocalSettingsGenerator( $this );
175 $rightsProfile = $this->rightsProfiles
[$this->getVar( '_RightsProfile' )];
176 foreach ( $rightsProfile as $group => $rightsArr ) {
177 $ls->setGroupRights( $group, $rightsArr );
181 return $this->session
;
184 $isCSS = $this->request
->getVal( 'css' );
187 return $this->session
;
190 if ( isset( $session['happyPages'] ) ) {
191 $this->happyPages
= $session['happyPages'];
193 $this->happyPages
= [];
196 if ( isset( $session['skippedPages'] ) ) {
197 $this->skippedPages
= $session['skippedPages'];
199 $this->skippedPages
= [];
202 $lowestUnhappy = $this->getLowestUnhappy();
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();
211 return $this->finish();
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() );
220 return $this->finish();
224 $pageName = $this->request
->getVal( 'page' );
226 if ( in_array( $pageName, $this->otherPages
) ) {
229 $page = $this->getPageByName( $pageName );
232 if ( !$pageName ||
!in_array( $pageName, $this->pageSequence
) ) {
233 $pageId = $lowestUnhappy;
235 $pageId = array_search( $pageName, $this->pageSequence
);
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;
247 $pageName = $this->pageSequence
[$pageId];
248 $page = $this->getPageByName( $pageName );
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 ) {
257 # Skip the skipped pages
258 $nextPageId = $pageId;
262 $nextPage = $this->pageSequence
[$nextPageId];
263 } while ( isset( $this->skippedPages
[$nextPage] ) );
265 $nextPage = $this->pageSequence
[$lowestUnhappy];
268 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
270 return $this->finish();
274 $this->currentPageName
= $page->getName();
275 $this->startPageWrapper( $pageName );
277 if ( $page->isSlow() ) {
278 $this->disableTimeLimit();
281 $result = $page->execute();
283 $this->endPageWrapper();
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';
291 unset( $this->skippedPages
[$pageName] );
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;
300 $lowestUnhappy = $this->getLowestUnhappy();
302 if ( $this->request
->getVal( 'lastPage' ) ) {
303 $nextPage = $this->request
->getVal( 'lastPage' );
304 } elseif ( $pageId !== false ) {
305 $nextPage = $this->pageSequence
[$pageId +
1];
307 $nextPage = $this->pageSequence
[$lowestUnhappy];
310 if ( array_search( $nextPage, $this->pageSequence
) > $lowestUnhappy ) {
311 $nextPage = $this->pageSequence
[$lowestUnhappy];
314 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
317 return $this->finish();
321 * Find the next page in sequence that hasn't been completed
324 public function getLowestUnhappy() {
325 if ( count( $this->happyPages
) == 0 ) {
328 return max( array_keys( $this->happyPages
) ) +
1;
333 * Start the PHP session. This may be called before execute() to start the PHP session.
338 public function startSession() {
339 if ( wfIniGetBool( 'session.auto_start' ) ||
session_id() ) {
344 $this->phpErrors
= [];
345 set_error_handler( [ $this, 'errorHandler' ] );
347 session_name( 'mw_installer_session' );
349 } catch ( Exception
$e ) {
350 restore_error_handler();
353 restore_error_handler();
355 if ( $this->phpErrors
) {
363 * Get a hash of data identifying this MW installation.
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.
370 public function getFingerprint() {
371 // Get the base URL of the installation
372 $url = $this->request
->getFullRequestURL();
373 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
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?
383 return md5( serialize( [
384 'local path' => dirname( __DIR__
),
386 'version' => $GLOBALS['wgVersion']
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
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 );
402 $text = $msg->useDatabase( false )->plain();
403 $this->output
->addHTML( $this->getErrorBox( $text ) );
407 * Temporary error handler for session start debugging.
409 * @param int $errno Unused
410 * @param string $errstr
412 public function errorHandler( $errno, $errstr ) {
413 $this->phpErrors
[] = $errstr;
417 * Clean up from execute()
421 public function finish() {
422 $this->output
->output();
424 $this->session
['happyPages'] = $this->happyPages
;
425 $this->session
['skippedPages'] = $this->skippedPages
;
426 $this->session
['settings'] = $this->settings
;
428 return $this->session
;
432 * We're restarting the installation, reset the session, happyPages, etc
434 public function reset() {
436 $this->happyPages
= [];
437 $this->settings
= [];
441 * Get a URL for submission back to the same script.
443 * @param string[] $query
447 public function getUrl( $query = [] ) {
448 $url = $this->request
->getRequestURL();
449 # Remove existing query
450 $url = preg_replace( '/\?.*$/', '', $url );
453 $url .= '?' . wfArrayToCgi( $query );
460 * Get a WebInstallerPage by name.
462 * @param string $pageName
463 * @return WebInstallerPage
465 public function getPageByName( $pageName ) {
466 $pageClass = 'WebInstaller' . $pageName;
468 return new $pageClass( $this );
472 * Get a session variable.
474 * @param string $name
475 * @param array $default
479 public function getSession( $name, $default = null ) {
480 if ( !isset( $this->session
[$name] ) ) {
483 return $this->session
[$name];
488 * Set a session variable.
490 * @param string $name Key for the variable
491 * @param mixed $value
493 public function setSession( $name, $value ) {
494 $this->session
[$name] = $value;
498 * Get the next tabindex attribute value.
502 public function nextTabIndex() {
503 return $this->tabIndex++
;
507 * Initializes language-related variables.
509 public function setupLanguage() {
510 global $wgLang, $wgContLang, $wgLanguageCode;
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 );
519 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
520 $wgContLang = Language
::factory( $wgLanguageCode );
525 * Retrieves MediaWiki language from Accept-Language HTTP header.
529 public function getAcceptLanguage() {
530 global $wgLanguageCode, $wgRequest;
532 $mwLanguages = Language
::fetchLanguageNames();
533 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
535 foreach ( $headerLanguages as $lang ) {
536 if ( isset( $mwLanguages[$lang] ) ) {
541 return $wgLanguageCode;
545 * Called by execute() before page output starts, to show a page list.
547 * @param string $currentPageName
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";
555 foreach ( $this->pageSequence
as $id => $pageName ) {
556 $happy = !empty( $this->happyPages
[$id] );
557 $s .= $this->getPageListItem(
559 $happy ||
$lastHappy == $id - 1,
568 $s .= "</ul><br/><ul>\n";
569 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
571 $s .= "</ul></div>\n";
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() );
581 $this->output
->addHTMLNoFlush( $s );
585 * Get a list item for the page list.
587 * @param string $pageName
588 * @param bool $enabled
589 * @param string $currentPageName
593 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
594 $s = "<li class=\"config-page-list-item\">";
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();
604 $query = [ 'page' => $pageName ];
606 if ( !in_array( $pageName, $this->pageSequence
) ) {
607 if ( in_array( $currentPageName, $this->pageSequence
) ) {
608 $query['lastPage'] = $currentPageName;
611 $link = Html
::element( 'a',
613 'href' => $this->getUrl( $query )
618 $link = htmlspecialchars( $name );
621 if ( $pageName == $currentPageName ) {
622 $s .= "<span class=\"config-page-current\">$link</span>";
627 $s .= Html
::element( 'span',
629 'class' => 'config-page-disabled'
641 * Output some stuff after a page is finished.
643 private function endPageWrapper() {
644 $this->output
->addHTMLNoFlush(
645 "<div class=\"visualClear\"></div>\n" .
647 "<div class=\"visualClear\"></div>\n" .
652 * Get HTML for an error box with an icon.
654 * @param string $text Wikitext, get this with wfMessage()->plain()
658 public function getErrorBox( $text ) {
659 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
663 * Get HTML for a warning box with an icon.
665 * @param string $text Wikitext, get this with wfMessage()->plain()
669 public function getWarningBox( $text ) {
670 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
674 * Get HTML for an info box with an icon.
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.
682 public function getInfoBox( $text, $icon = false, $class = false ) {
683 $text = $this->parse( $text, true );
684 $icon = ( $icon == false ) ?
685 'images/info-32.png' :
687 $alt = wfMessage( 'config-information' )->text();
689 return Html
::infoBox( $text, $icon, $alt, $class );
693 * Get small text indented help for a preceding form field.
694 * Parameters like wfMessage().
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 );
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" .
716 * @param string $msg Key for wfMessage()
718 public function showHelpBox( $msg /*, ... */ ) {
719 $args = func_get_args();
720 $html = call_user_func_array( [ $this, 'getHelpBox' ], $args );
721 $this->output
->addHTML( $html );
725 * Show a short informational message.
726 * Output looks like a list.
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() ) .
736 $this->output
->addHTML( $html );
740 * @param Status $status
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 );
750 * Label a control by wrapping a config-input div around it and putting a
754 * @param string $forId
755 * @param string $contents
756 * @param string $helpData
759 public function label( $msg, $forId, $contents, $helpData = "" ) {
760 if ( strval( $msg ) == '' ) {
761 $labelText = ' ';
763 $labelText = wfMessage( $msg )->escaped();
766 $attributes = [ 'class' => 'config-label' ];
769 $attributes['for'] = $forId;
772 return "<div class=\"config-block\">\n" .
773 " <div class=\"config-block-label\">\n" .
780 " <div class=\"config-block-elements\">\n" .
787 * Get a labelled text box to configure a variable.
789 * @param mixed[] $params
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)
800 public function getTextBox( $params ) {
801 if ( !isset( $params['controlName'] ) ) {
802 $params['controlName'] = 'config_' . $params['var'];
805 if ( !isset( $params['value'] ) ) {
806 $params['value'] = $this->getVar( $params['var'] );
809 if ( !isset( $params['attribs'] ) ) {
810 $params['attribs'] = [];
812 if ( !isset( $params['help'] ) ) {
813 $params['help'] = "";
818 $params['controlName'],
820 $params['controlName'],
821 30, // intended to be overridden by CSS
823 $params['attribs'] +
[
824 'id' => $params['controlName'],
825 'class' => 'config-input-text',
826 'tabindex' => $this->nextTabIndex()
834 * Get a labelled textarea to configure a variable
836 * @param mixed[] $params
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)
847 public function getTextArea( $params ) {
848 if ( !isset( $params['controlName'] ) ) {
849 $params['controlName'] = 'config_' . $params['var'];
852 if ( !isset( $params['value'] ) ) {
853 $params['value'] = $this->getVar( $params['var'] );
856 if ( !isset( $params['attribs'] ) ) {
857 $params['attribs'] = [];
859 if ( !isset( $params['help'] ) ) {
860 $params['help'] = "";
865 $params['controlName'],
867 $params['controlName'],
871 $params['attribs'] +
[
872 'id' => $params['controlName'],
873 'class' => 'config-input-text',
874 'tabindex' => $this->nextTabIndex()
882 * Get a labelled password box to configure a variable.
884 * Implements password hiding
885 * @param mixed[] $params
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)
896 public function getPasswordBox( $params ) {
897 if ( !isset( $params['value'] ) ) {
898 $params['value'] = $this->getVar( $params['var'] );
901 if ( !isset( $params['attribs'] ) ) {
902 $params['attribs'] = [];
905 $params['value'] = $this->getFakePassword( $params['value'] );
906 $params['attribs']['type'] = 'password';
908 return $this->getTextBox( $params );
912 * Get a labelled checkbox to configure a boolean variable.
914 * @param mixed[] $params
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)
926 public function getCheckBox( $params ) {
927 if ( !isset( $params['controlName'] ) ) {
928 $params['controlName'] = 'config_' . $params['var'];
931 if ( !isset( $params['value'] ) ) {
932 $params['value'] = $this->getVar( $params['var'] );
935 if ( !isset( $params['attribs'] ) ) {
936 $params['attribs'] = [];
938 if ( !isset( $params['help'] ) ) {
939 $params['help'] = "";
941 if ( !isset( $params['labelAttribs'] ) ) {
942 $params['labelAttribs'] = [];
944 if ( isset( $params['rawtext'] ) ) {
945 $labelText = $params['rawtext'];
947 $labelText = $this->parse( wfMessage( $params['label'] )->text() );
950 return "<div class=\"config-input-check\">\n" .
954 $params['labelAttribs'],
956 $params['controlName'],
958 $params['attribs'] +
[
959 'id' => $params['controlName'],
960 'tabindex' => $this->nextTabIndex(),
969 * Get a set of labelled radio buttons.
971 * @param mixed[] $params
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)
987 public function getRadioSet( $params ) {
988 $items = $this->getRadioElements( $params );
990 if ( !isset( $params['label'] ) ) {
993 $label = $params['label'];
996 if ( !isset( $params['controlName'] ) ) {
997 $params['controlName'] = 'config_' . $params['var'];
1000 if ( !isset( $params['help'] ) ) {
1001 $params['help'] = "";
1005 foreach ( $items as $value => $item ) {
1006 $s .= "<li>$item</li>\n";
1010 return $this->label( $label, $params['controlName'], $s, $params['help'] );
1014 * Get a set of labelled radio buttons. You probably want to use getRadioSet(), not this.
1018 * @param mixed[] $params
1021 public function getRadioElements( $params ) {
1022 if ( !isset( $params['controlName'] ) ) {
1023 $params['controlName'] = 'config_' . $params['var'];
1026 if ( !isset( $params['value'] ) ) {
1027 $params['value'] = $this->getVar( $params['var'] );
1032 foreach ( $params['values'] as $value ) {
1035 if ( isset( $params['commonAttribs'] ) ) {
1036 $itemAttribs = $params['commonAttribs'];
1039 if ( isset( $params['itemAttribs'][$value] ) ) {
1040 $itemAttribs = $params['itemAttribs'][$value] +
$itemAttribs;
1043 $checked = $value == $params['value'];
1044 $id = $params['controlName'] . '_' . $value;
1045 $itemAttribs['id'] = $id;
1046 $itemAttribs['tabindex'] = $this->nextTabIndex();
1049 Xml
::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
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()
1062 * Output an error or warning box using a Status object.
1064 * @param Status $status
1066 public function showStatusBox( $status ) {
1067 if ( !$status->isGood() ) {
1068 $text = $status->getWikiText();
1070 if ( $status->isOK() ) {
1071 $box = $this->getWarningBox( $text );
1073 $box = $this->getErrorBox( $text );
1076 $this->output
->addHTML( $box );
1081 * Convenience function to set variables based on form data.
1082 * Assumes that variables containing "password" in the name are (potentially
1085 * @param string[] $varNames
1086 * @param string $prefix The prefix added to variables to obtain form names
1090 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
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 );
1099 $newValues[$name] = $value;
1101 if ( $value === null ) {
1103 $this->setVar( $name, false );
1105 if ( stripos( $name, 'password' ) !== false ) {
1106 $this->setPassword( $name, $value );
1108 $this->setVar( $name, $value );
1117 * Helper for Installer::docLink()
1119 * @param string $page
1123 protected function getDocUrl( $page ) {
1124 $url = "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
1126 if ( in_array( $this->currentPageName
, $this->pageSequence
) ) {
1127 $url .= '&lastPage=' . urlencode( $this->currentPageName
);
1134 * Extension tag hook for a documentation link.
1136 * @param string $linkText
1137 * @param string[] $attribs
1138 * @param Parser $parser Unused
1142 public function docLink( $linkText, $attribs, $parser ) {
1143 $url = $this->getDocUrl( $attribs['href'] );
1145 return '<a href="' . htmlspecialchars( $url ) . '">' .
1146 htmlspecialchars( $linkText ) .
1151 * Helper for "Download LocalSettings" link on WebInstall_Complete
1153 * @param string $text Unused
1154 * @param string[] $attribs Unused
1155 * @param Parser $parser Unused
1157 * @return string Html for download link
1159 public function downloadLinkHook( $text, $attribs, $parser ) {
1160 $anchor = Html
::rawElement( 'a',
1161 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1162 wfMessage( 'config-download-localsettings' )->parse()
1165 return Html
::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
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"
1176 * @return string|bool
1178 public function getLocalSettingsLocation() {
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
1190 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1191 $path = $_SERVER['PHP_SELF'];
1192 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1193 $path = $_SERVER['SCRIPT_NAME'];
1195 if ( $path === false ) {
1196 $this->showError( 'config-no-uri' );
1200 return parent
::envCheckPath();
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
1209 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1210 $path = $_SERVER['PHP_SELF'];
1211 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1212 $path = $_SERVER['SCRIPT_NAME'];
1214 if ( $path !== false ) {
1215 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
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" );
1232 protected function envGetDefaultServer() {
1233 return WebRequest
::detectServer();
1237 * Output stylesheet for web installer pages
1239 public function outputCss() {
1240 $this->request
->response()->header( 'Content-type: text/css' );
1241 echo $this->output
->getCSS();
1247 public function getPhpErrors() {
1248 return $this->phpErrors
;