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
24 use MediaWiki\MediaWikiServices
;
27 * Class for the core installer web interface.
32 class WebInstaller
extends Installer
{
35 * @var WebInstallerOutput
47 * Cached session array.
54 * Captured PHP error text. Temporary.
61 * The main sequence of page names. These will be displayed in turn.
63 * To add a new installer page:
64 * * Add it to this WebInstaller::$pageSequence property
65 * * Add a "config-page-<name>" message
66 * * Add a "WebInstaller<name>" class
70 public $pageSequence = [
84 * Out of sequence pages, selectable by the user at any time.
88 protected $otherPages = [
93 'UpgradeDoc', // Can't use Upgrade due to Upgrade step
97 * Array of pages which have declared that they have been submitted, have validated
98 * their input, and need no further processing.
102 protected $happyPages;
105 * List of "skipped" pages. These are pages that will automatically continue
106 * to the next page on any GET request. To avoid breaking the "back" button,
107 * they need to be skipped during a back operation.
111 protected $skippedPages;
114 * Flag indicating that session data may have been lost.
118 public $showSessionWarning = false;
121 * Numeric index of the page we're on
125 protected $tabIndex = 1;
128 * Name of the page we're on
132 protected $currentPageName;
135 * @param WebRequest $request
137 public function __construct( WebRequest
$request ) {
138 parent
::__construct();
139 $this->output
= new WebInstallerOutput( $this );
140 $this->request
= $request;
143 $parser = MediaWikiServices
::getInstance()->getParser();
144 $parser->setHook( 'downloadlink', [ $this, 'downloadLinkHook' ] );
145 $parser->setHook( 'doclink', [ $this, 'docLink' ] );
151 * @param array[] $session Initial session array
153 * @return array[] New session array
155 public function execute( array $session ) {
156 $this->session
= $session;
158 if ( isset( $session['settings'] ) ) {
159 $this->settings
= $session['settings'] +
$this->settings
;
160 // T187586 MediaWikiServices works with globals
161 foreach ( $this->settings
as $key => $val ) {
162 $GLOBALS[$key] = $val;
166 $this->setupLanguage();
168 if ( ( $this->getVar( '_InstallDone' ) ||
$this->getVar( '_UpgradeDone' ) )
169 && $this->request
->getVal( 'localsettings' )
172 return $this->session
;
175 $isCSS = $this->request
->getVal( 'css' );
178 return $this->session
;
181 $this->happyPages
= $session['happyPages'] ??
[];
183 $this->skippedPages
= $session['skippedPages'] ??
[];
185 $lowestUnhappy = $this->getLowestUnhappy();
187 # Special case for Creative Commons partner chooser box.
188 if ( $this->request
->getVal( 'SubmitCC' ) ) {
189 $page = $this->getPageByName( 'Options' );
190 $this->output
->useShortHeader();
191 $this->output
->allowFrames();
194 return $this->finish();
197 if ( $this->request
->getVal( 'ShowCC' ) ) {
198 $page = $this->getPageByName( 'Options' );
199 $this->output
->useShortHeader();
200 $this->output
->allowFrames();
201 $this->output
->addHTML( $page->getCCDoneBox() );
203 return $this->finish();
207 $pageName = $this->request
->getVal( 'page' );
209 if ( in_array( $pageName, $this->otherPages
) ) {
212 $page = $this->getPageByName( $pageName );
215 if ( !$pageName ||
!in_array( $pageName, $this->pageSequence
) ) {
216 $pageId = $lowestUnhappy;
218 $pageId = array_search( $pageName, $this->pageSequence
);
221 # If necessary, move back to the lowest-numbered unhappy page
222 if ( $pageId > $lowestUnhappy ) {
223 $pageId = $lowestUnhappy;
224 if ( $lowestUnhappy == 0 ) {
225 # Knocked back to start, possible loss of session data.
226 $this->showSessionWarning
= true;
230 $pageName = $this->pageSequence
[$pageId];
231 $page = $this->getPageByName( $pageName );
234 # If a back button was submitted, go back without submitting the form data.
235 if ( $this->request
->wasPosted() && $this->request
->getBool( 'submit-back' ) ) {
236 if ( $this->request
->getVal( 'lastPage' ) ) {
237 $nextPage = $this->request
->getVal( 'lastPage' );
238 } elseif ( $pageId !== false ) {
240 # Skip the skipped pages
241 $nextPageId = $pageId;
245 $nextPage = $this->pageSequence
[$nextPageId];
246 } while ( isset( $this->skippedPages
[$nextPage] ) );
248 $nextPage = $this->pageSequence
[$lowestUnhappy];
251 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
253 return $this->finish();
257 $this->currentPageName
= $page->getName();
258 $this->startPageWrapper( $pageName );
260 if ( $page->isSlow() ) {
261 $this->disableTimeLimit();
264 $result = $page->execute();
266 $this->endPageWrapper();
268 if ( $result == 'skip' ) {
269 # Page skipped without explicit submission.
270 # Skip it when we click "back" so that we don't just go forward again.
271 $this->skippedPages
[$pageName] = true;
272 $result = 'continue';
274 unset( $this->skippedPages
[$pageName] );
277 # If it was posted, the page can request a continue to the next page.
278 if ( $result === 'continue' && !$this->output
->headerDone() ) {
279 if ( $pageId !== false ) {
280 $this->happyPages
[$pageId] = true;
283 $lowestUnhappy = $this->getLowestUnhappy();
285 if ( $this->request
->getVal( 'lastPage' ) ) {
286 $nextPage = $this->request
->getVal( 'lastPage' );
287 } elseif ( $pageId !== false ) {
288 $nextPage = $this->pageSequence
[$pageId +
1];
290 $nextPage = $this->pageSequence
[$lowestUnhappy];
293 if ( array_search( $nextPage, $this->pageSequence
) > $lowestUnhappy ) {
294 $nextPage = $this->pageSequence
[$lowestUnhappy];
297 $this->output
->redirect( $this->getUrl( [ 'page' => $nextPage ] ) );
300 return $this->finish();
304 * Find the next page in sequence that hasn't been completed
307 public function getLowestUnhappy() {
308 if ( count( $this->happyPages
) == 0 ) {
311 return max( array_keys( $this->happyPages
) ) +
1;
316 * Start the PHP session. This may be called before execute() to start the PHP session.
321 public function startSession() {
322 if ( wfIniGetBool( 'session.auto_start' ) ||
session_id() ) {
327 $this->phpErrors
= [];
328 set_error_handler( [ $this, 'errorHandler' ] );
330 session_name( 'mw_installer_session' );
332 } catch ( Exception
$e ) {
333 restore_error_handler();
336 restore_error_handler();
338 if ( $this->phpErrors
) {
346 * Get a hash of data identifying this MW installation.
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.
353 public function getFingerprint() {
354 // Get the base URL of the installation
355 $url = $this->request
->getFullRequestURL();
356 if ( preg_match( '!^(.*\?)!', $url, $m ) ) {
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?
366 return md5( serialize( [
367 'local path' => dirname( __DIR__
),
369 'version' => $GLOBALS['wgVersion']
374 * Show an error message in a box. Parameters are like wfMessage(), or
375 * alternatively, pass a Message object in.
376 * @param string|Message $msg
377 * @param mixed ...$params
379 public function showError( $msg, ...$params ) {
380 if ( !( $msg instanceof Message
) ) {
383 array_map( 'htmlspecialchars', $params )
386 $text = $msg->useDatabase( false )->plain();
387 $this->output
->addHTML( $this->getErrorBox( $text ) );
391 * Temporary error handler for session start debugging.
393 * @param int $errno Unused
394 * @param string $errstr
396 public function errorHandler( $errno, $errstr ) {
397 $this->phpErrors
[] = $errstr;
401 * Clean up from execute()
405 public function finish() {
406 $this->output
->output();
408 $this->session
['happyPages'] = $this->happyPages
;
409 $this->session
['skippedPages'] = $this->skippedPages
;
410 $this->session
['settings'] = $this->settings
;
412 return $this->session
;
416 * We're restarting the installation, reset the session, happyPages, etc
418 public function reset() {
420 $this->happyPages
= [];
421 $this->settings
= [];
425 * Get a URL for submission back to the same script.
427 * @param string[] $query
431 public function getUrl( $query = [] ) {
432 $url = $this->request
->getRequestURL();
433 # Remove existing query
434 $url = preg_replace( '/\?.*$/', '', $url );
437 $url .= '?' . wfArrayToCgi( $query );
444 * Get a WebInstallerPage by name.
446 * @param string $pageName
447 * @return WebInstallerPage
449 public function getPageByName( $pageName ) {
450 $pageClass = 'WebInstaller' . $pageName;
452 return new $pageClass( $this );
456 * Get a session variable.
458 * @param string $name
459 * @param array|null $default
463 public function getSession( $name, $default = null ) {
464 return $this->session
[$name] ??
$default;
468 * Set a session variable.
470 * @param string $name Key for the variable
471 * @param mixed $value
473 public function setSession( $name, $value ) {
474 $this->session
[$name] = $value;
478 * Get the next tabindex attribute value.
482 public function nextTabIndex() {
483 return $this->tabIndex++
;
487 * Initializes language-related variables.
489 public function setupLanguage() {
490 global $wgLang, $wgContLang, $wgLanguageCode;
492 if ( $this->getSession( 'test' ) === null && !$this->request
->wasPosted() ) {
493 $wgLanguageCode = $this->getAcceptLanguage();
494 $wgLang = Language
::factory( $wgLanguageCode );
495 RequestContext
::getMain()->setLanguage( $wgLang );
496 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
497 $this->setVar( '_UserLang', $wgLanguageCode );
499 $wgLanguageCode = $this->getVar( 'wgLanguageCode' );
501 $wgContLang = MediaWikiServices
::getInstance()->getContentLanguage();
505 * Retrieves MediaWiki language from Accept-Language HTTP header.
509 public function getAcceptLanguage() {
510 global $wgLanguageCode, $wgRequest;
512 $mwLanguages = Language
::fetchLanguageNames( null, 'mwfile' );
513 $headerLanguages = array_keys( $wgRequest->getAcceptLang() );
515 foreach ( $headerLanguages as $lang ) {
516 if ( isset( $mwLanguages[$lang] ) ) {
521 return $wgLanguageCode;
525 * Called by execute() before page output starts, to show a page list.
527 * @param string $currentPageName
529 private function startPageWrapper( $currentPageName ) {
530 $s = "<div class=\"config-page-wrapper\">\n";
531 $s .= "<div class=\"config-page\">\n";
532 $s .= "<div class=\"config-page-list\"><ul>\n";
535 foreach ( $this->pageSequence
as $id => $pageName ) {
536 $happy = !empty( $this->happyPages
[$id] );
537 $s .= $this->getPageListItem(
539 $happy ||
$lastHappy == $id - 1,
548 $s .= "</ul><br/><ul>\n";
549 $s .= $this->getPageListItem( 'Restart', true, $currentPageName );
551 $s .= "</ul></div>\n";
554 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
555 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
556 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
557 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
558 $s .= Html
::element( 'h2', [],
559 wfMessage( 'config-page-' . strtolower( $currentPageName ) )->text() );
561 $this->output
->addHTMLNoFlush( $s );
565 * Get a list item for the page list.
567 * @param string $pageName
568 * @param bool $enabled
569 * @param string $currentPageName
573 private function getPageListItem( $pageName, $enabled, $currentPageName ) {
574 $s = "<li class=\"config-page-list-item\">";
577 // config-page-language, config-page-welcome, config-page-dbconnect, config-page-upgrade,
578 // config-page-dbsettings, config-page-name, config-page-options, config-page-install,
579 // config-page-complete, config-page-restart, config-page-readme, config-page-releasenotes,
580 // config-page-copying, config-page-upgradedoc, config-page-existingwiki
581 $name = wfMessage( 'config-page-' . strtolower( $pageName ) )->text();
584 $query = [ 'page' => $pageName ];
586 if ( !in_array( $pageName, $this->pageSequence
) ) {
587 if ( in_array( $currentPageName, $this->pageSequence
) ) {
588 $query['lastPage'] = $currentPageName;
591 $link = Html
::element( 'a',
593 'href' => $this->getUrl( $query )
598 $link = htmlspecialchars( $name );
601 if ( $pageName == $currentPageName ) {
602 $s .= "<span class=\"config-page-current\">$link</span>";
607 $s .= Html
::element( 'span',
609 'class' => 'config-page-disabled'
621 * Output some stuff after a page is finished.
623 private function endPageWrapper() {
624 $this->output
->addHTMLNoFlush(
625 "<div class=\"visualClear\"></div>\n" .
627 "<div class=\"visualClear\"></div>\n" .
632 * Get HTML for an error box with an icon.
634 * @param string $text Wikitext, get this with wfMessage()->plain()
638 public function getErrorBox( $text ) {
639 return $this->getInfoBox( $text, 'critical-32.png', 'config-error-box' );
643 * Get HTML for a warning box with an icon.
645 * @param string $text Wikitext, get this with wfMessage()->plain()
649 public function getWarningBox( $text ) {
650 return $this->getInfoBox( $text, 'warning-32.png', 'config-warning-box' );
654 * Get HTML for an info box with an icon.
656 * @param string $text Wikitext, get this with wfMessage()->plain()
657 * @param string|bool $icon Icon name, file in mw-config/images. Default: false
658 * @param string|bool $class Additional class name to add to the wrapper div. Default: false.
662 public function getInfoBox( $text, $icon = false, $class = false ) {
663 $text = $this->parse( $text, true );
664 $icon = ( $icon == false ) ?
665 'images/info-32.png' :
667 $alt = wfMessage( 'config-information' )->text();
669 return Html
::infoBox( $text, $icon, $alt, $class );
673 * Get small text indented help for a preceding form field.
674 * Parameters like wfMessage().
679 public function getHelpBox( $msg, ...$args ) {
680 $args = array_map( 'htmlspecialchars', $args );
681 $text = wfMessage( $msg, $args )->useDatabase( false )->plain();
682 $html = $this->parse( $text, true );
684 return "<div class=\"config-help-field-container\">\n" .
685 "<span class=\"config-help-field-hint\" title=\"" .
686 wfMessage( 'config-help-tooltip' )->escaped() . "\">" .
687 wfMessage( 'config-help' )->escaped() . "</span>\n" .
688 "<div class=\"config-help-field-data\">" . $html . "</div>\n" .
694 * @param string $msg Key for wfMessage()
695 * @param mixed ...$params
697 public function showHelpBox( $msg, ...$params ) {
698 $html = $this->getHelpBox( $msg, ...$params );
699 $this->output
->addHTML( $html );
703 * Show a short informational message.
704 * Output looks like a list.
707 * @param mixed ...$params
709 public function showMessage( $msg, ...$params ) {
710 $html = '<div class="config-message">' .
711 $this->parse( wfMessage( $msg, $params )->useDatabase( false )->plain() ) .
713 $this->output
->addHTML( $html );
717 * @param Status $status
719 public function showStatusMessage( Status
$status ) {
720 $errors = array_merge( $status->getErrorsArray(), $status->getWarningsArray() );
721 foreach ( $errors as $error ) {
722 $this->showMessage( ...$error );
727 * Label a control by wrapping a config-input div around it and putting a
731 * @param string $forId
732 * @param string $contents
733 * @param string $helpData
736 public function label( $msg, $forId, $contents, $helpData = "" ) {
737 if ( strval( $msg ) == '' ) {
738 $labelText = "\u{00A0}";
740 $labelText = wfMessage( $msg )->escaped();
743 $attributes = [ 'class' => 'config-label' ];
746 $attributes['for'] = $forId;
749 return "<div class=\"config-block\">\n" .
750 " <div class=\"config-block-label\">\n" .
757 " <div class=\"config-block-elements\">\n" .
764 * Get a labelled text box to configure a variable.
766 * @param mixed[] $params
768 * var: The variable to be configured (required)
769 * label: The message name for the label (required)
770 * attribs: Additional attributes for the input element (optional)
771 * controlName: The name for the input element (optional)
772 * value: The current value of the variable (optional)
773 * help: The html for the help text (optional)
777 public function getTextBox( $params ) {
778 if ( !isset( $params['controlName'] ) ) {
779 $params['controlName'] = 'config_' . $params['var'];
782 if ( !isset( $params['value'] ) ) {
783 $params['value'] = $this->getVar( $params['var'] );
786 if ( !isset( $params['attribs'] ) ) {
787 $params['attribs'] = [];
789 if ( !isset( $params['help'] ) ) {
790 $params['help'] = "";
795 $params['controlName'],
797 $params['controlName'],
798 30, // intended to be overridden by CSS
800 $params['attribs'] +
[
801 'id' => $params['controlName'],
802 'class' => 'config-input-text',
803 'tabindex' => $this->nextTabIndex()
811 * Get a labelled textarea to configure a variable
813 * @param mixed[] $params
815 * var: The variable to be configured (required)
816 * label: The message name for the label (required)
817 * attribs: Additional attributes for the input element (optional)
818 * controlName: The name for the input element (optional)
819 * value: The current value of the variable (optional)
820 * help: The html for the help text (optional)
824 public function getTextArea( $params ) {
825 if ( !isset( $params['controlName'] ) ) {
826 $params['controlName'] = 'config_' . $params['var'];
829 if ( !isset( $params['value'] ) ) {
830 $params['value'] = $this->getVar( $params['var'] );
833 if ( !isset( $params['attribs'] ) ) {
834 $params['attribs'] = [];
836 if ( !isset( $params['help'] ) ) {
837 $params['help'] = "";
842 $params['controlName'],
844 $params['controlName'],
848 $params['attribs'] +
[
849 'id' => $params['controlName'],
850 'class' => 'config-input-text',
851 'tabindex' => $this->nextTabIndex()
859 * Get a labelled password box to configure a variable.
861 * Implements password hiding
862 * @param mixed[] $params
864 * var: The variable to be configured (required)
865 * label: The message name for the label (required)
866 * attribs: Additional attributes for the input element (optional)
867 * controlName: The name for the input element (optional)
868 * value: The current value of the variable (optional)
869 * help: The html for the help text (optional)
873 public function getPasswordBox( $params ) {
874 if ( !isset( $params['value'] ) ) {
875 $params['value'] = $this->getVar( $params['var'] );
878 if ( !isset( $params['attribs'] ) ) {
879 $params['attribs'] = [];
882 $params['value'] = $this->getFakePassword( $params['value'] );
883 $params['attribs']['type'] = 'password';
885 return $this->getTextBox( $params );
889 * Get a labelled checkbox to configure a boolean variable.
891 * @param mixed[] $params
893 * var: The variable to be configured (required)
894 * label: The message name for the label (required)
895 * labelAttribs:Additional attributes for the label element (optional)
896 * attribs: Additional attributes for the input element (optional)
897 * controlName: The name for the input element (optional)
898 * value: The current value of the variable (optional)
899 * help: The html for the help text (optional)
903 public function getCheckBox( $params ) {
904 if ( !isset( $params['controlName'] ) ) {
905 $params['controlName'] = 'config_' . $params['var'];
908 if ( !isset( $params['value'] ) ) {
909 $params['value'] = $this->getVar( $params['var'] );
912 if ( !isset( $params['attribs'] ) ) {
913 $params['attribs'] = [];
915 if ( !isset( $params['help'] ) ) {
916 $params['help'] = "";
918 if ( !isset( $params['labelAttribs'] ) ) {
919 $params['labelAttribs'] = [];
921 $labelText = $params['rawtext'] ??
$this->parse( wfMessage( $params['label'] )->plain() );
923 return "<div class=\"config-input-check\">\n" .
927 $params['labelAttribs'],
929 $params['controlName'],
931 $params['attribs'] +
[
932 'id' => $params['controlName'],
933 'tabindex' => $this->nextTabIndex(),
942 * Get a set of labelled radio buttons.
944 * @param mixed[] $params
946 * var: The variable to be configured (required)
947 * label: The message name for the label (required)
948 * itemLabelPrefix: The message name prefix for the item labels (required)
949 * itemLabels: List of message names to use for the item labels instead
950 * of itemLabelPrefix, keyed by values
951 * values: List of allowed values (required)
952 * itemAttribs: Array of attribute arrays, outer key is the value name (optional)
953 * commonAttribs: Attribute array applied to all items
954 * controlName: The name for the input element (optional)
955 * value: The current value of the variable (optional)
956 * help: The html for the help text (optional)
960 public function getRadioSet( $params ) {
961 $items = $this->getRadioElements( $params );
963 $label = $params['label'] ??
'';
965 if ( !isset( $params['controlName'] ) ) {
966 $params['controlName'] = 'config_' . $params['var'];
969 if ( !isset( $params['help'] ) ) {
970 $params['help'] = "";
974 foreach ( $items as $value => $item ) {
975 $s .= "<li>$item</li>\n";
979 return $this->label( $label, $params['controlName'], $s, $params['help'] );
983 * Get a set of labelled radio buttons. You probably want to use getRadioSet(), not this.
987 * @param mixed[] $params
990 public function getRadioElements( $params ) {
991 if ( !isset( $params['controlName'] ) ) {
992 $params['controlName'] = 'config_' . $params['var'];
995 if ( !isset( $params['value'] ) ) {
996 $params['value'] = $this->getVar( $params['var'] );
1001 foreach ( $params['values'] as $value ) {
1004 if ( isset( $params['commonAttribs'] ) ) {
1005 $itemAttribs = $params['commonAttribs'];
1008 if ( isset( $params['itemAttribs'][$value] ) ) {
1009 $itemAttribs = $params['itemAttribs'][$value] +
$itemAttribs;
1012 $checked = $value == $params['value'];
1013 $id = $params['controlName'] . '_' . $value;
1014 $itemAttribs['id'] = $id;
1015 $itemAttribs['tabindex'] = $this->nextTabIndex();
1018 Xml
::radio( $params['controlName'], $value, $checked, $itemAttribs ) .
1020 Xml
::tags( 'label', [ 'for' => $id ], $this->parse(
1021 isset( $params['itemLabels'] ) ?
1022 wfMessage( $params['itemLabels'][$value] )->plain() :
1023 wfMessage( $params['itemLabelPrefix'] . strtolower( $value ) )->plain()
1031 * Output an error or warning box using a Status object.
1033 * @param Status $status
1035 public function showStatusBox( $status ) {
1036 if ( !$status->isGood() ) {
1037 $text = $status->getWikiText();
1039 if ( $status->isOK() ) {
1040 $box = $this->getWarningBox( $text );
1042 $box = $this->getErrorBox( $text );
1045 $this->output
->addHTML( $box );
1050 * Convenience function to set variables based on form data.
1051 * Assumes that variables containing "password" in the name are (potentially
1054 * @param string[] $varNames
1055 * @param string $prefix The prefix added to variables to obtain form names
1059 public function setVarsFromRequest( $varNames, $prefix = 'config_' ) {
1062 foreach ( $varNames as $name ) {
1063 $value = $this->request
->getVal( $prefix . $name );
1064 // T32524, do not trim passwords
1065 if ( stripos( $name, 'password' ) === false ) {
1066 $value = trim( $value );
1068 $newValues[$name] = $value;
1070 if ( $value === null ) {
1072 $this->setVar( $name, false );
1073 } elseif ( stripos( $name, 'password' ) !== false ) {
1074 $this->setPassword( $name, $value );
1076 $this->setVar( $name, $value );
1084 * Helper for Installer::docLink()
1086 * @param string $page
1090 protected function getDocUrl( $page ) {
1091 $query = [ 'page' => $page ];
1093 if ( in_array( $this->currentPageName
, $this->pageSequence
) ) {
1094 $query['lastPage'] = $this->currentPageName
;
1097 return $this->getUrl( $query );
1101 * Extension tag hook for a documentation link.
1103 * @param string $linkText
1104 * @param string[] $attribs
1105 * @param Parser $parser Unused
1109 public function docLink( $linkText, $attribs, $parser ) {
1110 $url = $this->getDocUrl( $attribs['href'] );
1112 return Html
::element( 'a', [ 'href' => $url ], $linkText );
1116 * Helper for "Download LocalSettings" link on WebInstall_Complete
1118 * @param string $text Unused
1119 * @param string[] $attribs Unused
1120 * @param Parser $parser Unused
1122 * @return string Html for download link
1124 public function downloadLinkHook( $text, $attribs, $parser ) {
1125 $anchor = Html
::rawElement( 'a',
1126 [ 'href' => $this->getUrl( [ 'localsettings' => 1 ] ) ],
1127 wfMessage( 'config-download-localsettings' )->parse()
1130 return Html
::rawElement( 'div', [ 'class' => 'config-download-link' ], $anchor );
1134 * If the software package wants the LocalSettings.php file
1135 * to be placed in a specific location, override this function
1136 * (see mw-config/overrides/README) to return the path of
1137 * where the file should be saved, or false for a generic
1138 * "in the base of your install"
1141 * @return string|bool
1143 public function getLocalSettingsLocation() {
1150 public function envCheckPath() {
1151 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1152 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1153 // to get the path to the current script... hopefully it's reliable. SIGH
1155 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1156 $path = $_SERVER['PHP_SELF'];
1157 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1158 $path = $_SERVER['SCRIPT_NAME'];
1160 if ( $path === false ) {
1161 $this->showError( 'config-no-uri' );
1165 return parent
::envCheckPath();
1168 public function envPrepPath() {
1169 parent
::envPrepPath();
1170 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
1171 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
1172 // to get the path to the current script... hopefully it's reliable. SIGH
1174 if ( !empty( $_SERVER['PHP_SELF'] ) ) {
1175 $path = $_SERVER['PHP_SELF'];
1176 } elseif ( !empty( $_SERVER['SCRIPT_NAME'] ) ) {
1177 $path = $_SERVER['SCRIPT_NAME'];
1179 if ( $path !== false ) {
1180 $scriptPath = preg_replace( '{^(.*)/(mw-)?config.*$}', '$1', $path );
1182 $this->setVar( 'wgScriptPath', "$scriptPath" );
1183 // Update variables set from Setup.php that are derived from wgScriptPath
1184 $this->setVar( 'wgScript', "$scriptPath/index.php" );
1185 $this->setVar( 'wgLoadScript', "$scriptPath/load.php" );
1186 $this->setVar( 'wgStylePath', "$scriptPath/skins" );
1187 $this->setVar( 'wgLocalStylePath', "$scriptPath/skins" );
1188 $this->setVar( 'wgExtensionAssetsPath', "$scriptPath/extensions" );
1189 $this->setVar( 'wgUploadPath', "$scriptPath/images" );
1190 $this->setVar( 'wgResourceBasePath', "$scriptPath" );
1197 protected function envGetDefaultServer() {
1198 return WebRequest
::detectServer();
1202 * Actually output LocalSettings.php for download
1204 * @suppress SecurityCheck-XSS
1206 private function outputLS() {
1207 $this->request
->response()->header( 'Content-type: application/x-httpd-php' );
1208 $this->request
->response()->header(
1209 'Content-Disposition: attachment; filename="LocalSettings.php"'
1212 $ls = InstallerOverrides
::getLocalSettingsGenerator( $this );
1213 $rightsProfile = $this->rightsProfiles
[$this->getVar( '_RightsProfile' )];
1214 foreach ( $rightsProfile as $group => $rightsArr ) {
1215 $ls->setGroupRights( $group, $rightsArr );
1217 echo $ls->getText();
1221 * Output stylesheet for web installer pages
1223 public function outputCss() {
1224 $this->request
->response()->header( 'Content-type: text/css' );
1225 echo $this->output
->getCSS();
1231 public function getPhpErrors() {
1232 return $this->phpErrors
;