6e41514320d80d1b4b99c77c25cb1fc6fe929b48
3 * Base code for web installer pages.
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 * Abstract class to define pages for the web installer.
30 abstract class WebInstallerPage
{
33 * The WebInstaller object this WebInstallerPage belongs to.
42 abstract public function execute();
45 * @param WebInstaller $parent
47 public function __construct( WebInstaller
$parent ) {
48 $this->parent
= $parent;
52 * Is this a slow-running page in the installer? If so, WebInstaller will
53 * set_time_limit(0) before calling execute(). Right now this only applies
54 * to Install and Upgrade pages
56 * @return bool Always false in this default implementation.
58 public function isSlow() {
65 public function addHTML( $html ) {
66 $this->parent
->output
->addHTML( $html );
69 public function startForm() {
71 "<div class=\"config-section\">\n" .
76 'action' => $this->parent
->getUrl( array( 'page' => $this->getName() ) )
83 * @param string|bool $continue
84 * @param string|bool $back
86 public function endForm( $continue = 'continue', $back = 'back' ) {
87 $s = "<div class=\"config-submit\">\n";
90 if ( $id === false ) {
91 $s .= Html
::hidden( 'lastPage', $this->parent
->request
->getVal( 'lastPage' ) );
95 // Fake submit button for enter keypress (bug 26267)
96 // Messages: config-continue, config-restart, config-regenerate
97 $s .= Xml
::submitButton(
98 wfMessage( "config-$continue" )->text(),
100 'name' => "enter-$continue",
101 'style' => 'visibility:hidden;overflow:hidden;width:1px;margin:0'
107 // Message: config-back
108 $s .= Xml
::submitButton(
109 wfMessage( "config-$back" )->text(),
111 'name' => "submit-$back",
112 'tabindex' => $this->parent
->nextTabIndex()
118 // Messages: config-continue, config-restart, config-regenerate
119 $s .= Xml
::submitButton(
120 wfMessage( "config-$continue" )->text(),
122 'name' => "submit-$continue",
123 'tabindex' => $this->parent
->nextTabIndex(),
128 $s .= "</div></form></div>\n";
129 $this->addHTML( $s );
135 public function getName() {
136 return str_replace( 'WebInstaller', '', get_class( $this ) );
142 protected function getId() {
143 return array_search( $this->getName(), $this->parent
->pageSequence
);
148 * @param mixed $default
152 public function getVar( $var, $default = null ) {
153 return $this->parent
->getVar( $var, $default );
157 * @param string $name
158 * @param mixed $value
160 public function setVar( $name, $value ) {
161 $this->parent
->setVar( $name, $value );
165 * Get the starting tags of a fieldset.
167 * @param string $legend Message name
171 protected function getFieldsetStart( $legend ) {
172 return "\n<fieldset><legend>" . wfMessage( $legend )->escaped() . "</legend>\n";
176 * Get the end tag of a fieldset.
180 protected function getFieldsetEnd() {
181 return "</fieldset>\n";
185 * Opens a textarea used to display the progress of a long operation
187 protected function startLiveBox() {
189 '<div id="config-spinner" style="display:none;">' .
190 '<img src="images/ajax-loader.gif" /></div>' .
191 '<script>jQuery( "#config-spinner" ).show();</script>' .
192 '<div id="config-live-log">' .
193 '<textarea name="LiveLog" rows="10" cols="30" readonly="readonly">'
195 $this->parent
->output
->flush();
199 * Opposite to WebInstallerPage::startLiveBox
201 protected function endLiveBox() {
202 $this->addHTML( '</textarea></div>
203 <script>jQuery( "#config-spinner" ).hide()</script>' );
204 $this->parent
->output
->flush();
209 class WebInstallerLanguage
extends WebInstallerPage
{
212 * @return string|null
214 public function execute() {
216 $r = $this->parent
->request
;
217 $userLang = $r->getVal( 'uselang' );
218 $contLang = $r->getVal( 'ContLang' );
220 $languages = Language
::fetchLanguageNames();
221 $lifetime = intval( ini_get( 'session.gc_maxlifetime' ) );
223 $lifetime = 1440; // PHP default
226 if ( $r->wasPosted() ) {
228 if ( $this->parent
->getSession( 'test' ) === null ) {
229 $requestTime = $r->getVal( 'LanguageRequestTime' );
230 if ( !$requestTime ) {
231 // The most likely explanation is that the user was knocked back
232 // from another page on POST due to session expiry
233 $msg = 'config-session-expired';
234 } elseif ( time() - $requestTime > $lifetime ) {
235 $msg = 'config-session-expired';
237 $msg = 'config-no-session';
239 $this->parent
->showError( $msg, $wgLang->formatTimePeriod( $lifetime ) );
241 if ( isset( $languages[$userLang] ) ) {
242 $this->setVar( '_UserLang', $userLang );
244 if ( isset( $languages[$contLang] ) ) {
245 $this->setVar( 'wgLanguageCode', $contLang );
250 } elseif ( $this->parent
->showSessionWarning
) {
251 # The user was knocked back from another page to the start
252 # This probably indicates a session expiry
253 $this->parent
->showError( 'config-session-expired',
254 $wgLang->formatTimePeriod( $lifetime ) );
257 $this->parent
->setSession( 'test', true );
259 if ( !isset( $languages[$userLang] ) ) {
260 $userLang = $this->getVar( '_UserLang', 'en' );
262 if ( !isset( $languages[$contLang] ) ) {
263 $contLang = $this->getVar( 'wgLanguageCode', 'en' );
266 $s = Html
::hidden( 'LanguageRequestTime', time() ) .
267 $this->getLanguageSelector( 'uselang', 'config-your-language', $userLang,
268 $this->parent
->getHelpBox( 'config-your-language-help' ) ) .
269 $this->getLanguageSelector( 'ContLang', 'config-wiki-language', $contLang,
270 $this->parent
->getHelpBox( 'config-wiki-language-help' ) );
271 $this->addHTML( $s );
272 $this->endForm( 'continue', false );
278 * Get a "<select>" for selecting languages.
280 * @param string $name
281 * @param string $label
282 * @param string $selectedCode
283 * @param string $helpHtml
287 public function getLanguageSelector( $name, $label, $selectedCode, $helpHtml = '' ) {
288 global $wgDummyLanguageCodes;
292 $s .= Html
::openElement( 'select', array( 'id' => $name, 'name' => $name,
293 'tabindex' => $this->parent
->nextTabIndex() ) ) . "\n";
295 $languages = Language
::fetchLanguageNames();
297 foreach ( $languages as $code => $lang ) {
298 if ( isset( $wgDummyLanguageCodes[$code] ) ) {
301 $s .= "\n" . Xml
::option( "$code - $lang", $code, $code == $selectedCode );
303 $s .= "\n</select>\n";
305 return $this->parent
->label( $label, $name, $s );
310 class WebInstallerExistingWiki
extends WebInstallerPage
{
315 public function execute() {
316 // If there is no LocalSettings.php, continue to the installer welcome page
317 $vars = Installer
::getExistingLocalSettings();
322 // Check if the upgrade key supplied to the user has appeared in LocalSettings.php
323 if ( $vars['wgUpgradeKey'] !== false
324 && $this->getVar( '_UpgradeKeySupplied' )
325 && $this->getVar( 'wgUpgradeKey' ) === $vars['wgUpgradeKey']
327 // It's there, so the user is authorized
328 $status = $this->handleExistingUpgrade( $vars );
329 if ( $status->isOK() ) {
333 $this->parent
->showStatusBox( $status );
334 $this->endForm( 'continue' );
340 // If there is no $wgUpgradeKey, tell the user to add one to LocalSettings.php
341 if ( $vars['wgUpgradeKey'] === false ) {
342 if ( $this->getVar( 'wgUpgradeKey', false ) === false ) {
343 $secretKey = $this->getVar( 'wgSecretKey' ); // preserve $wgSecretKey
344 $this->parent
->generateKeys();
345 $this->setVar( 'wgSecretKey', $secretKey );
346 $this->setVar( '_UpgradeKeySupplied', true );
349 $this->addHTML( $this->parent
->getInfoBox(
350 wfMessage( 'config-upgrade-key-missing', "<pre dir=\"ltr\">\$wgUpgradeKey = '" .
351 $this->getVar( 'wgUpgradeKey' ) . "';</pre>" )->plain()
353 $this->endForm( 'continue' );
358 // If there is an upgrade key, but it wasn't supplied, prompt the user to enter it
360 $r = $this->parent
->request
;
361 if ( $r->wasPosted() ) {
362 $key = $r->getText( 'config_wgUpgradeKey' );
363 if ( !$key ||
$key !== $vars['wgUpgradeKey'] ) {
364 $this->parent
->showError( 'config-localsettings-badkey' );
365 $this->showKeyForm();
370 $status = $this->handleExistingUpgrade( $vars );
371 if ( $status->isOK() ) {
374 $this->parent
->showStatusBox( $status );
375 $this->showKeyForm();
380 $this->showKeyForm();
387 * Show the "enter key" form
389 protected function showKeyForm() {
392 $this->parent
->getInfoBox( wfMessage( 'config-localsettings-upgrade' )->plain() ) .
394 $this->parent
->getTextBox( array(
395 'var' => 'wgUpgradeKey',
396 'label' => 'config-localsettings-key',
397 'attribs' => array( 'autocomplete' => 'off' ),
400 $this->endForm( 'continue' );
404 * @param string[] $names
405 * @param mixed[] $vars
409 protected function importVariables( $names, $vars ) {
410 $status = Status
::newGood();
411 foreach ( $names as $name ) {
412 if ( !isset( $vars[$name] ) ) {
413 $status->fatal( 'config-localsettings-incomplete', $name );
415 $this->setVar( $name, $vars[$name] );
422 * Initiate an upgrade of the existing database
424 * @param mixed[] $vars Variables from LocalSettings.php
428 protected function handleExistingUpgrade( $vars ) {
430 if ( !isset( $vars['wgDBtype'] ) ||
431 !in_array( $vars['wgDBtype'], Installer
::getDBTypes() )
433 return Status
::newFatal( 'config-localsettings-connection-error', '' );
436 // Set the relevant variables from LocalSettings.php
437 $requiredVars = array( 'wgDBtype' );
438 $status = $this->importVariables( $requiredVars, $vars );
439 $installer = $this->parent
->getDBInstaller();
440 $status->merge( $this->importVariables( $installer->getGlobalNames(), $vars ) );
441 if ( !$status->isOK() ) {
445 if ( isset( $vars['wgDBadminuser'] ) ) {
446 $this->setVar( '_InstallUser', $vars['wgDBadminuser'] );
448 $this->setVar( '_InstallUser', $vars['wgDBuser'] );
450 if ( isset( $vars['wgDBadminpassword'] ) ) {
451 $this->setVar( '_InstallPassword', $vars['wgDBadminpassword'] );
453 $this->setVar( '_InstallPassword', $vars['wgDBpassword'] );
456 // Test the database connection
457 $status = $installer->getConnection();
458 if ( !$status->isOK() ) {
459 // Adjust the error message to explain things correctly
460 $status->replaceMessage( 'config-connection-error',
461 'config-localsettings-connection-error' );
467 $this->setVar( '_ExistingDBSettings', true );
474 class WebInstallerWelcome
extends WebInstallerPage
{
479 public function execute() {
480 if ( $this->parent
->request
->wasPosted() ) {
481 if ( $this->getVar( '_Environment' ) ) {
485 $this->parent
->output
->addWikiText( wfMessage( 'config-welcome' )->plain() );
486 $status = $this->parent
->doEnvironmentChecks();
487 if ( $status->isGood() ) {
488 $this->parent
->output
->addHTML( '<span class="success-message">' .
489 wfMessage( 'config-env-good' )->escaped() . '</span>' );
490 $this->parent
->output
->addWikiText( wfMessage( 'config-copyright',
491 SpecialVersion
::getCopyrightAndAuthorList() )->plain() );
495 $this->parent
->showStatusMessage( $status );
503 class WebInstallerDBConnect
extends WebInstallerPage
{
506 * @return string|null When string, "skip" or "continue"
508 public function execute() {
509 if ( $this->getVar( '_ExistingDBSettings' ) ) {
513 $r = $this->parent
->request
;
514 if ( $r->wasPosted() ) {
515 $status = $this->submit();
517 if ( $status->isGood() ) {
518 $this->setVar( '_UpgradeDone', false );
522 $this->parent
->showStatusBox( $status );
528 $types = "<ul class=\"config-settings-block\">\n";
530 $defaultType = $this->getVar( 'wgDBtype' );
532 // Messages: config-dbsupport-mysql, config-dbsupport-postgres, config-dbsupport-oracle,
533 // config-dbsupport-sqlite, config-dbsupport-mssql
535 foreach ( Installer
::getDBTypes() as $type ) {
536 $dbSupport .= wfMessage( "config-dbsupport-$type" )->plain() . "\n";
538 $this->addHTML( $this->parent
->getInfoBox(
539 wfMessage( 'config-support-info', trim( $dbSupport ) )->text() ) );
541 // It's possible that the library for the default DB type is not compiled in.
542 // In that case, instead select the first supported DB type in the list.
543 $compiledDBs = $this->parent
->getCompiledDBs();
544 if ( !in_array( $defaultType, $compiledDBs ) ) {
545 $defaultType = $compiledDBs[0];
548 foreach ( $compiledDBs as $type ) {
549 $installer = $this->parent
->getDBInstaller( $type );
553 $installer->getReadableName(),
557 $type == $defaultType,
558 array( 'class' => 'dbRadio', 'rel' => "DB_wrapper_$type" )
562 // Messages: config-header-mysql, config-header-postgres, config-header-oracle,
563 // config-header-sqlite
564 $settings .= Html
::openElement(
567 'id' => 'DB_wrapper_' . $type,
568 'class' => 'dbWrapper'
571 Html
::element( 'h3', array(), wfMessage( 'config-header-' . $type )->text() ) .
572 $installer->getConnectForm() .
576 $types .= "</ul><br style=\"clear: left\"/>\n";
578 $this->addHTML( $this->parent
->label( 'config-db-type', false, $types ) . $settings );
587 public function submit() {
588 $r = $this->parent
->request
;
589 $type = $r->getVal( 'DBType' );
591 return Status
::newFatal( 'config-invalid-db-type' );
593 $this->setVar( 'wgDBtype', $type );
594 $installer = $this->parent
->getDBInstaller( $type );
596 return Status
::newFatal( 'config-invalid-db-type' );
599 return $installer->submitConnectForm();
604 class WebInstallerUpgrade
extends WebInstallerPage
{
607 * @return bool Always true.
609 public function isSlow() {
614 * @return string|null
616 public function execute() {
617 if ( $this->getVar( '_UpgradeDone' ) ) {
618 // Allow regeneration of LocalSettings.php, unless we are working
619 // from a pre-existing LocalSettings.php file and we want to avoid
620 // leaking its contents
621 if ( $this->parent
->request
->wasPosted() && !$this->getVar( '_ExistingDBSettings' ) ) {
622 // Done message acknowledged
626 // Show the done message again
627 // Make them click back again if they want to do the upgrade again
628 $this->showDoneMessage();
634 // wgDBtype is generally valid here because otherwise the previous page
635 // (connect) wouldn't have declared its happiness
636 $type = $this->getVar( 'wgDBtype' );
637 $installer = $this->parent
->getDBInstaller( $type );
639 if ( !$installer->needsUpgrade() ) {
643 if ( $this->parent
->request
->wasPosted() ) {
644 $installer->preUpgrade();
646 $this->startLiveBox();
647 $result = $installer->doUpgrade();
651 // If they're going to possibly regenerate LocalSettings, we
652 // need to create the upgrade/secret keys. Bug 26481
653 if ( !$this->getVar( '_ExistingDBSettings' ) ) {
654 $this->parent
->generateKeys();
656 $this->setVar( '_UpgradeDone', true );
657 $this->showDoneMessage();
664 $this->addHTML( $this->parent
->getInfoBox(
665 wfMessage( 'config-can-upgrade', $GLOBALS['wgVersion'] )->plain() ) );
671 public function showDoneMessage() {
673 $regenerate = !$this->getVar( '_ExistingDBSettings' );
675 $msg = 'config-upgrade-done';
677 $msg = 'config-upgrade-done-no-regenerate';
679 $this->parent
->disableLinkPopups();
681 $this->parent
->getInfoBox(
683 $this->getVar( 'wgServer' ) .
684 $this->getVar( 'wgScriptPath' ) . '/index' .
685 $this->getVar( 'wgScriptExtension' )
686 )->plain(), 'tick-32.png'
689 $this->parent
->restoreLinkPopups();
690 $this->endForm( $regenerate ?
'regenerate' : false, false );
695 class WebInstallerDBSettings
extends WebInstallerPage
{
698 * @return string|null
700 public function execute() {
701 $installer = $this->parent
->getDBInstaller( $this->getVar( 'wgDBtype' ) );
703 $r = $this->parent
->request
;
704 if ( $r->wasPosted() ) {
705 $status = $installer->submitSettingsForm();
706 if ( $status === false ) {
708 } elseif ( $status->isGood() ) {
711 $this->parent
->showStatusBox( $status );
715 $form = $installer->getSettingsForm();
716 if ( $form === false ) {
721 $this->addHTML( $form );
729 class WebInstallerName
extends WebInstallerPage
{
734 public function execute() {
735 $r = $this->parent
->request
;
736 if ( $r->wasPosted() ) {
737 if ( $this->submit() ) {
744 // Encourage people to not name their site 'MediaWiki' by blanking the
745 // field. I think that was the intent with the original $GLOBALS['wgSitename']
746 // but these two always were the same so had the effect of making the
747 // installer forget $wgSitename when navigating back to this page.
748 if ( $this->getVar( 'wgSitename' ) == 'MediaWiki' ) {
749 $this->setVar( 'wgSitename', '' );
752 // Set wgMetaNamespace to something valid before we show the form.
753 // $wgMetaNamespace defaults to $wgSiteName which is 'MediaWiki'
754 $metaNS = $this->getVar( 'wgMetaNamespace' );
757 wfMessage( 'config-ns-other-default' )->inContentLanguage()->text()
761 $this->parent
->getTextBox( array(
762 'var' => 'wgSitename',
763 'label' => 'config-site-name',
764 'help' => $this->parent
->getHelpBox( 'config-site-name-help' )
766 // getRadioSet() builds a set of labeled radio buttons.
767 // For grep: The following messages are used as the item labels:
768 // config-ns-site-name, config-ns-generic, config-ns-other
769 $this->parent
->getRadioSet( array(
770 'var' => '_NamespaceType',
771 'label' => 'config-project-namespace',
772 'itemLabelPrefix' => 'config-ns-',
773 'values' => array( 'site-name', 'generic', 'other' ),
774 'commonAttribs' => array( 'class' => 'enableForOther',
775 'rel' => 'config_wgMetaNamespace' ),
776 'help' => $this->parent
->getHelpBox( 'config-project-namespace-help' )
778 $this->parent
->getTextBox( array(
779 'var' => 'wgMetaNamespace',
780 'label' => '', // @todo Needs a label?
781 'attribs' => array( 'readonly' => 'readonly', 'class' => 'enabledByOther' )
783 $this->getFieldSetStart( 'config-admin-box' ) .
784 $this->parent
->getTextBox( array(
785 'var' => '_AdminName',
786 'label' => 'config-admin-name',
787 'help' => $this->parent
->getHelpBox( 'config-admin-help' )
789 $this->parent
->getPasswordBox( array(
790 'var' => '_AdminPassword',
791 'label' => 'config-admin-password',
793 $this->parent
->getPasswordBox( array(
794 'var' => '_AdminPasswordConfirm',
795 'label' => 'config-admin-password-confirm'
797 $this->parent
->getTextBox( array(
798 'var' => '_AdminEmail',
802 'label' => 'config-admin-email',
803 'help' => $this->parent
->getHelpBox( 'config-admin-email-help' )
805 $this->parent
->getCheckBox( array(
806 'var' => '_Subscribe',
807 'label' => 'config-subscribe',
808 'help' => $this->parent
->getHelpBox( 'config-subscribe-help' )
810 $this->getFieldSetEnd() .
811 $this->parent
->getInfoBox( wfMessage( 'config-almost-done' )->text() ) .
812 // getRadioSet() builds a set of labeled radio buttons.
813 // For grep: The following messages are used as the item labels:
814 // config-optional-continue, config-optional-skip
815 $this->parent
->getRadioSet( array(
816 'var' => '_SkipOptional',
817 'itemLabelPrefix' => 'config-optional-',
818 'values' => array( 'continue', 'skip' )
822 // Restore the default value
823 $this->setVar( 'wgMetaNamespace', $metaNS );
833 public function submit() {
835 $this->parent
->setVarsFromRequest( array( 'wgSitename', '_NamespaceType',
836 '_AdminName', '_AdminPassword', '_AdminPasswordConfirm', '_AdminEmail',
837 '_Subscribe', '_SkipOptional', 'wgMetaNamespace' ) );
839 // Validate site name
840 if ( strval( $this->getVar( 'wgSitename' ) ) === '' ) {
841 $this->parent
->showError( 'config-site-name-blank' );
846 $nsType = $this->getVar( '_NamespaceType' );
847 if ( $nsType == 'site-name' ) {
848 $name = $this->getVar( 'wgSitename' );
849 // Sanitize for namespace
850 // This algorithm should match the JS one in WebInstallerOutput.php
851 $name = preg_replace( '/[\[\]\{\}|#<>%+? ]/', '_', $name );
852 $name = str_replace( '&', '&', $name );
853 $name = preg_replace( '/__+/', '_', $name );
854 $name = ucfirst( trim( $name, '_' ) );
855 } elseif ( $nsType == 'generic' ) {
856 $name = wfMessage( 'config-ns-generic' )->text();
858 $name = $this->getVar( 'wgMetaNamespace' );
861 // Validate namespace
862 if ( strpos( $name, ':' ) !== false ) {
865 // Title-style validation
866 $title = Title
::newFromText( $name );
868 $good = $nsType == 'site-name';
870 $name = $title->getDBkey();
875 $this->parent
->showError( 'config-ns-invalid', $name );
879 // Make sure it won't conflict with any existing namespaces
881 $nsIndex = $wgContLang->getNsIndex( $name );
882 if ( $nsIndex !== false && $nsIndex !== NS_PROJECT
) {
883 $this->parent
->showError( 'config-ns-conflict', $name );
887 $this->setVar( 'wgMetaNamespace', $name );
889 // Validate username for creation
890 $name = $this->getVar( '_AdminName' );
891 if ( strval( $name ) === '' ) {
892 $this->parent
->showError( 'config-admin-name-blank' );
896 $cname = User
::getCanonicalName( $name, 'creatable' );
897 if ( $cname === false ) {
898 $this->parent
->showError( 'config-admin-name-invalid', $name );
901 $this->setVar( '_AdminName', $cname );
907 $pwd = $this->getVar( '_AdminPassword' );
908 $user = User
::newFromName( $cname );
910 $valid = $user->getPasswordValidity( $pwd );
912 $valid = 'config-admin-name-invalid';
914 if ( strval( $pwd ) === '' ) {
915 # $user->getPasswordValidity just checks for $wgMinimalPasswordLength.
916 # This message is more specific and helpful.
917 $msg = 'config-admin-password-blank';
918 } elseif ( $pwd !== $this->getVar( '_AdminPasswordConfirm' ) ) {
919 $msg = 'config-admin-password-mismatch';
920 } elseif ( $valid !== true ) {
923 if ( $msg !== false ) {
924 call_user_func_array( array( $this->parent
, 'showError' ), (array)$msg );
925 $this->setVar( '_AdminPassword', '' );
926 $this->setVar( '_AdminPasswordConfirm', '' );
930 // Validate e-mail if provided
931 $email = $this->getVar( '_AdminEmail' );
932 if ( $email && !Sanitizer
::validateEmail( $email ) ) {
933 $this->parent
->showError( 'config-admin-error-bademail' );
936 // If they asked to subscribe to mediawiki-announce but didn't give
937 // an e-mail, show an error. Bug 29332
938 if ( !$email && $this->getVar( '_Subscribe' ) ) {
939 $this->parent
->showError( 'config-subscribe-noemail' );
948 class WebInstallerOptions
extends WebInstallerPage
{
951 * @return string|null
953 public function execute() {
954 if ( $this->getVar( '_SkipOptional' ) == 'skip' ) {
955 $this->submitSkins();
958 if ( $this->parent
->request
->wasPosted() ) {
959 if ( $this->submit() ) {
964 $emailwrapperStyle = $this->getVar( 'wgEnableEmail' ) ?
'' : 'display: none';
968 // getRadioSet() builds a set of labeled radio buttons.
969 // For grep: The following messages are used as the item labels:
970 // config-profile-wiki, config-profile-no-anon, config-profile-fishbowl, config-profile-private
971 $this->parent
->getRadioSet( array(
972 'var' => '_RightsProfile',
973 'label' => 'config-profile',
974 'itemLabelPrefix' => 'config-profile-',
975 'values' => array_keys( $this->parent
->rightsProfiles
),
977 $this->parent
->getInfoBox( wfMessage( 'config-profile-help' )->plain() ) .
980 // getRadioSet() builds a set of labeled radio buttons.
981 // For grep: The following messages are used as the item labels:
982 // config-license-cc-by, config-license-cc-by-sa, config-license-cc-by-nc-sa,
983 // config-license-cc-0, config-license-pd, config-license-gfdl,
984 // config-license-none, config-license-cc-choose
985 $this->parent
->getRadioSet( array(
986 'var' => '_LicenseCode',
987 'label' => 'config-license',
988 'itemLabelPrefix' => 'config-license-',
989 'values' => array_keys( $this->parent
->licenses
),
990 'commonAttribs' => array( 'class' => 'licenseRadio' ),
992 $this->getCCChooser() .
993 $this->parent
->getHelpBox( 'config-license-help' ) .
996 $this->getFieldSetStart( 'config-email-settings' ) .
997 $this->parent
->getCheckBox( array(
998 'var' => 'wgEnableEmail',
999 'label' => 'config-enable-email',
1000 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'emailwrapper' ),
1002 $this->parent
->getHelpBox( 'config-enable-email-help' ) .
1003 "<div id=\"emailwrapper\" style=\"$emailwrapperStyle\">" .
1004 $this->parent
->getTextBox( array(
1005 'var' => 'wgPasswordSender',
1006 'label' => 'config-email-sender'
1008 $this->parent
->getHelpBox( 'config-email-sender-help' ) .
1009 $this->parent
->getCheckBox( array(
1010 'var' => 'wgEnableUserEmail',
1011 'label' => 'config-email-user',
1013 $this->parent
->getHelpBox( 'config-email-user-help' ) .
1014 $this->parent
->getCheckBox( array(
1015 'var' => 'wgEnotifUserTalk',
1016 'label' => 'config-email-usertalk',
1018 $this->parent
->getHelpBox( 'config-email-usertalk-help' ) .
1019 $this->parent
->getCheckBox( array(
1020 'var' => 'wgEnotifWatchlist',
1021 'label' => 'config-email-watchlist',
1023 $this->parent
->getHelpBox( 'config-email-watchlist-help' ) .
1024 $this->parent
->getCheckBox( array(
1025 'var' => 'wgEmailAuthentication',
1026 'label' => 'config-email-auth',
1028 $this->parent
->getHelpBox( 'config-email-auth-help' ) .
1030 $this->getFieldSetEnd()
1033 $skins = $this->parent
->findExtensions( 'skins' );
1034 $skinHtml = $this->getFieldSetStart( 'config-skins' );
1036 $skinNames = array_map( 'strtolower', $skins );
1037 $chosenSkinName = $this->getVar( 'wgDefaultSkin', $this->parent
->getDefaultSkin( $skinNames ) );
1040 $radioButtons = $this->parent
->getRadioElements( array(
1041 'var' => 'wgDefaultSkin',
1042 'itemLabels' => array_fill_keys( $skinNames, 'config-skins-use-as-default' ),
1043 'values' => $skinNames,
1044 'value' => $chosenSkinName,
1047 foreach ( $skins as $skin ) {
1049 '<div class="config-skins-item">' .
1050 $this->parent
->getCheckBox( array(
1051 'var' => "skin-$skin",
1053 'value' => $this->getVar( "skin-$skin", true ), // all found skins enabled by default
1055 '<div class="config-skins-use-as-default">' . $radioButtons[strtolower( $skin )] . '</div>' .
1060 $this->parent
->getWarningBox( wfMessage( 'config-skins-missing' )->plain() ) .
1061 Html
::hidden( 'config_wgDefaultSkin', $chosenSkinName );
1064 $skinHtml .= $this->parent
->getHelpBox( 'config-skins-help' ) .
1065 $this->getFieldSetEnd();
1066 $this->addHTML( $skinHtml );
1068 $extensions = $this->parent
->findExtensions();
1070 if ( $extensions ) {
1071 $extHtml = $this->getFieldSetStart( 'config-extensions' );
1073 foreach ( $extensions as $ext ) {
1074 $extHtml .= $this->parent
->getCheckBox( array(
1075 'var' => "ext-$ext",
1080 $extHtml .= $this->parent
->getHelpBox( 'config-extensions-help' ) .
1081 $this->getFieldSetEnd();
1082 $this->addHTML( $extHtml );
1085 // Having / in paths in Windows looks funny :)
1086 $this->setVar( 'wgDeletedDirectory',
1088 '/', DIRECTORY_SEPARATOR
,
1089 $this->getVar( 'wgDeletedDirectory' )
1093 $uploadwrapperStyle = $this->getVar( 'wgEnableUploads' ) ?
'' : 'display: none';
1096 $this->getFieldSetStart( 'config-upload-settings' ) .
1097 $this->parent
->getCheckBox( array(
1098 'var' => 'wgEnableUploads',
1099 'label' => 'config-upload-enable',
1100 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'uploadwrapper' ),
1101 'help' => $this->parent
->getHelpBox( 'config-upload-help' )
1103 '<div id="uploadwrapper" style="' . $uploadwrapperStyle . '">' .
1104 $this->parent
->getTextBox( array(
1105 'var' => 'wgDeletedDirectory',
1106 'label' => 'config-upload-deleted',
1107 'attribs' => array( 'dir' => 'ltr' ),
1108 'help' => $this->parent
->getHelpBox( 'config-upload-deleted-help' )
1111 $this->parent
->getTextBox( array(
1113 'label' => 'config-logo',
1114 'attribs' => array( 'dir' => 'ltr' ),
1115 'help' => $this->parent
->getHelpBox( 'config-logo-help' )
1119 $this->parent
->getCheckBox( array(
1120 'var' => 'wgUseInstantCommons',
1121 'label' => 'config-instantcommons',
1122 'help' => $this->parent
->getHelpBox( 'config-instantcommons-help' )
1124 $this->getFieldSetEnd()
1127 $caches = array( 'none' );
1128 if ( count( $this->getVar( '_Caches' ) ) ) {
1129 $caches[] = 'accel';
1131 $caches[] = 'memcached';
1133 // We'll hide/show this on demand when the value changes, see config.js.
1134 $cacheval = $this->getVar( 'wgMainCacheType' );
1136 // We need to set a default here; but don't hardcode it
1137 // or we lose it every time we reload the page for validation
1141 $hidden = ( $cacheval == 'memcached' ) ?
'' : 'display: none';
1144 $this->getFieldSetStart( 'config-advanced-settings' ) .
1145 # Object cache settings
1146 // getRadioSet() builds a set of labeled radio buttons.
1147 // For grep: The following messages are used as the item labels:
1148 // config-cache-none, config-cache-accel, config-cache-memcached
1149 $this->parent
->getRadioSet( array(
1150 'var' => 'wgMainCacheType',
1151 'label' => 'config-cache-options',
1152 'itemLabelPrefix' => 'config-cache-',
1153 'values' => $caches,
1154 'value' => $cacheval,
1156 $this->parent
->getHelpBox( 'config-cache-help' ) .
1157 "<div id=\"config-memcachewrapper\" style=\"$hidden\">" .
1158 $this->parent
->getTextArea( array(
1159 'var' => '_MemCachedServers',
1160 'label' => 'config-memcached-servers',
1161 'help' => $this->parent
->getHelpBox( 'config-memcached-help' )
1164 $this->getFieldSetEnd()
1174 public function getCCPartnerUrl() {
1175 $server = $this->getVar( 'wgServer' );
1176 $exitUrl = $server . $this->parent
->getUrl( array(
1177 'page' => 'Options',
1178 'SubmitCC' => 'indeed',
1179 'config__LicenseCode' => 'cc',
1180 'config_wgRightsUrl' => '[license_url]',
1181 'config_wgRightsText' => '[license_name]',
1182 'config_wgRightsIcon' => '[license_button]',
1184 $styleUrl = $server . dirname( dirname( $this->parent
->getUrl() ) ) .
1185 '/mw-config/config-cc.css';
1186 $iframeUrl = 'https://creativecommons.org/license/?' .
1187 wfArrayToCgi( array(
1188 'partner' => 'MediaWiki',
1189 'exit_url' => $exitUrl,
1190 'lang' => $this->getVar( '_UserLang' ),
1191 'stylesheet' => $styleUrl,
1200 public function getCCChooser() {
1201 $iframeAttribs = array(
1202 'class' => 'config-cc-iframe',
1203 'name' => 'config-cc-iframe',
1204 'id' => 'config-cc-iframe',
1209 if ( $this->getVar( '_CCDone' ) ) {
1210 $iframeAttribs['src'] = $this->parent
->getUrl( array( 'ShowCC' => 'yes' ) );
1212 $iframeAttribs['src'] = $this->getCCPartnerUrl();
1214 $wrapperStyle = ( $this->getVar( '_LicenseCode' ) == 'cc-choose' ) ?
'' : 'display: none';
1216 return "<div class=\"config-cc-wrapper\" id=\"config-cc-wrapper\" style=\"$wrapperStyle\">\n" .
1217 Html
::element( 'iframe', $iframeAttribs, '', false /* not short */ ) .
1224 public function getCCDoneBox() {
1225 $js = "parent.document.getElementById('config-cc-wrapper').style.height = '$1';";
1226 // If you change this height, also change it in config.css
1227 $expandJs = str_replace( '$1', '54em', $js );
1228 $reduceJs = str_replace( '$1', '70px', $js );
1231 Html
::element( 'img', array( 'src' => $this->getVar( 'wgRightsIcon' ) ) ) .
1233 htmlspecialchars( $this->getVar( 'wgRightsText' ) ) .
1235 "<p style=\"text-align: center;\">" .
1238 'href' => $this->getCCPartnerUrl(),
1239 'onclick' => $expandJs,
1241 wfMessage( 'config-cc-again' )->text()
1245 # Reduce the wrapper div height
1246 htmlspecialchars( $reduceJs ) .
1251 public function submitCC() {
1252 $newValues = $this->parent
->setVarsFromRequest(
1253 array( 'wgRightsUrl', 'wgRightsText', 'wgRightsIcon' ) );
1254 if ( count( $newValues ) != 3 ) {
1255 $this->parent
->showError( 'config-cc-error' );
1259 $this->setVar( '_CCDone', true );
1260 $this->addHTML( $this->getCCDoneBox() );
1264 * If the user skips this installer page, we still need to set up the default skins, but ignore
1269 public function submitSkins() {
1270 $skins = $this->parent
->findExtensions( 'skins' );
1271 $this->parent
->setVar( '_Skins', $skins );
1274 $skinNames = array_map( 'strtolower', $skins );
1275 $this->parent
->setVar( 'wgDefaultSkin', $this->parent
->getDefaultSkin( $skinNames ) );
1284 public function submit() {
1285 $this->parent
->setVarsFromRequest( array( '_RightsProfile', '_LicenseCode',
1286 'wgEnableEmail', 'wgPasswordSender', 'wgEnableUploads', 'wgLogo',
1287 'wgEnableUserEmail', 'wgEnotifUserTalk', 'wgEnotifWatchlist',
1288 'wgEmailAuthentication', 'wgMainCacheType', '_MemCachedServers',
1289 'wgUseInstantCommons', 'wgDefaultSkin' ) );
1293 if ( !array_key_exists( $this->getVar( '_RightsProfile' ), $this->parent
->rightsProfiles
) ) {
1294 reset( $this->parent
->rightsProfiles
);
1295 $this->setVar( '_RightsProfile', key( $this->parent
->rightsProfiles
) );
1298 $code = $this->getVar( '_LicenseCode' );
1299 if ( $code == 'cc-choose' ) {
1300 if ( !$this->getVar( '_CCDone' ) ) {
1301 $this->parent
->showError( 'config-cc-not-chosen' );
1304 } elseif ( array_key_exists( $code, $this->parent
->licenses
) ) {
1306 // config-license-cc-by, config-license-cc-by-sa, config-license-cc-by-nc-sa,
1307 // config-license-cc-0, config-license-pd, config-license-gfdl, config-license-none,
1308 // config-license-cc-choose
1309 $entry = $this->parent
->licenses
[$code];
1310 if ( isset( $entry['text'] ) ) {
1311 $this->setVar( 'wgRightsText', $entry['text'] );
1313 $this->setVar( 'wgRightsText', wfMessage( 'config-license-' . $code )->text() );
1315 $this->setVar( 'wgRightsUrl', $entry['url'] );
1316 $this->setVar( 'wgRightsIcon', $entry['icon'] );
1318 $this->setVar( 'wgRightsText', '' );
1319 $this->setVar( 'wgRightsUrl', '' );
1320 $this->setVar( 'wgRightsIcon', '' );
1323 $skinsAvailable = $this->parent
->findExtensions( 'skins' );
1324 $skinsToInstall = array();
1325 foreach ( $skinsAvailable as $skin ) {
1326 $this->parent
->setVarsFromRequest( array( "skin-$skin" ) );
1327 if ( $this->getVar( "skin-$skin" ) ) {
1328 $skinsToInstall[] = $skin;
1331 $this->parent
->setVar( '_Skins', $skinsToInstall );
1333 if ( !$skinsToInstall && $skinsAvailable ) {
1334 $this->parent
->showError( 'config-skins-must-enable-some' );
1337 $defaultSkin = $this->getVar( 'wgDefaultSkin' );
1338 $skinsToInstallLowercase = array_map( 'strtolower', $skinsToInstall );
1339 if ( $skinsToInstall && array_search( $defaultSkin, $skinsToInstallLowercase ) === false ) {
1340 $this->parent
->showError( 'config-skins-must-enable-default' );
1344 $extsAvailable = $this->parent
->findExtensions();
1345 $extsToInstall = array();
1346 foreach ( $extsAvailable as $ext ) {
1347 $this->parent
->setVarsFromRequest( array( "ext-$ext" ) );
1348 if ( $this->getVar( "ext-$ext" ) ) {
1349 $extsToInstall[] = $ext;
1352 $this->parent
->setVar( '_Extensions', $extsToInstall );
1354 if ( $this->getVar( 'wgMainCacheType' ) == 'memcached' ) {
1355 $memcServers = explode( "\n", $this->getVar( '_MemCachedServers' ) );
1356 if ( !$memcServers ) {
1357 $this->parent
->showError( 'config-memcache-needservers' );
1361 foreach ( $memcServers as $server ) {
1362 $memcParts = explode( ":", $server, 2 );
1363 if ( !isset( $memcParts[0] )
1364 ||
( !IP
::isValid( $memcParts[0] )
1365 && ( gethostbyname( $memcParts[0] ) == $memcParts[0] ) )
1367 $this->parent
->showError( 'config-memcache-badip', $memcParts[0] );
1369 } elseif ( !isset( $memcParts[1] ) ) {
1370 $this->parent
->showError( 'config-memcache-noport', $memcParts[0] );
1372 } elseif ( $memcParts[1] < 1 ||
$memcParts[1] > 65535 ) {
1373 $this->parent
->showError( 'config-memcache-badport', 1, 65535 );
1384 class WebInstallerInstall
extends WebInstallerPage
{
1387 * @return bool Always true.
1389 public function isSlow() {
1394 * @return string|bool
1396 public function execute() {
1397 if ( $this->getVar( '_UpgradeDone' ) ) {
1399 } elseif ( $this->getVar( '_InstallDone' ) ) {
1401 } elseif ( $this->parent
->request
->wasPosted() ) {
1403 $this->addHTML( "<ul>" );
1404 $results = $this->parent
->performInstallation(
1405 array( $this, 'startStage' ),
1406 array( $this, 'endStage' )
1408 $this->addHTML( "</ul>" );
1409 // PerformInstallation bails on a fatal, so make sure the last item
1410 // completed before giving 'next.' Likewise, only provide back on failure
1411 $lastStep = end( $results );
1412 $continue = $lastStep->isOK() ?
'continue' : false;
1413 $back = $lastStep->isOK() ?
false : 'back';
1414 $this->endForm( $continue, $back );
1417 $this->addHTML( $this->parent
->getInfoBox( wfMessage( 'config-install-begin' )->plain() ) );
1425 * @param string $step
1427 public function startStage( $step ) {
1428 // Messages: config-install-database, config-install-tables, config-install-interwiki,
1429 // config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage
1430 $this->addHTML( "<li>" . wfMessage( "config-install-$step" )->escaped() .
1431 wfMessage( 'ellipsis' )->escaped() );
1433 if ( $step == 'extension-tables' ) {
1434 $this->startLiveBox();
1439 * @param string $step
1440 * @param Status $status
1442 public function endStage( $step, $status ) {
1443 if ( $step == 'extension-tables' ) {
1444 $this->endLiveBox();
1446 $msg = $status->isOk() ?
'config-install-step-done' : 'config-install-step-failed';
1447 $html = wfMessage( 'word-separator' )->escaped() . wfMessage( $msg )->escaped();
1448 if ( !$status->isOk() ) {
1449 $html = "<span class=\"error\">$html</span>";
1451 $this->addHTML( $html . "</li>\n" );
1452 if ( !$status->isGood() ) {
1453 $this->parent
->showStatusBox( $status );
1459 class WebInstallerComplete
extends WebInstallerPage
{
1461 public function execute() {
1462 // Pop up a dialog box, to make it difficult for the user to forget
1463 // to download the file
1464 $lsUrl = $this->getVar( 'wgServer' ) . $this->parent
->getURL( array( 'localsettings' => 1 ) );
1465 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) &&
1466 strpos( $_SERVER['HTTP_USER_AGENT'], 'MSIE' ) !== false
1468 // JS appears to be the only method that works consistently with IE7+
1469 $this->addHtml( "\n<script>jQuery( function () { location.href = " .
1470 Xml
::encodeJsVar( $lsUrl ) . "; } );</script>\n" );
1472 $this->parent
->request
->response()->header( "Refresh: 0;url=$lsUrl" );
1476 $this->parent
->disableLinkPopups();
1478 $this->parent
->getInfoBox(
1479 wfMessage( 'config-install-done',
1481 $this->getVar( 'wgServer' ) .
1482 $this->getVar( 'wgScriptPath' ) . '/index' .
1483 $this->getVar( 'wgScriptExtension' ),
1485 )->plain(), 'tick-32.png'
1488 $this->addHTML( $this->parent
->getInfoBox(
1489 wfMessage( 'config-extension-link' )->text() ) );
1491 $this->parent
->restoreLinkPopups();
1492 $this->endForm( false, false );
1497 class WebInstallerRestart
extends WebInstallerPage
{
1500 * @return string|null
1502 public function execute() {
1503 $r = $this->parent
->request
;
1504 if ( $r->wasPosted() ) {
1505 $really = $r->getVal( 'submit-restart' );
1507 $this->parent
->reset();
1514 $s = $this->parent
->getWarningBox( wfMessage( 'config-help-restart' )->plain() );
1515 $this->addHTML( $s );
1516 $this->endForm( 'restart' );
1523 abstract class WebInstallerDocument
extends WebInstallerPage
{
1528 abstract protected function getFileName();
1530 public function execute() {
1531 $text = $this->getFileContents();
1532 $text = InstallDocFormatter
::format( $text );
1533 $this->parent
->output
->addWikiText( $text );
1535 $this->endForm( false );
1541 public function getFileContents() {
1542 $file = __DIR__
. '/../../' . $this->getFileName();
1543 if ( !file_exists( $file ) ) {
1544 return wfMessage( 'config-nofile', $file )->plain();
1547 return file_get_contents( $file );
1552 class WebInstallerReadme
extends WebInstallerDocument
{
1557 protected function getFileName() {
1563 class WebInstallerReleaseNotes
extends WebInstallerDocument
{
1566 * @throws MWException
1569 protected function getFileName() {
1572 if ( !preg_match( '/^(\d+)\.(\d+).*/i', $wgVersion, $result ) ) {
1573 throw new MWException( 'Variable $wgVersion has an invalid value.' );
1576 return 'RELEASE-NOTES-' . $result[1] . '.' . $result[2];
1581 class WebInstallerUpgradeDoc
extends WebInstallerDocument
{
1586 protected function getFileName() {
1592 class WebInstallerCopying
extends WebInstallerDocument
{
1597 protected function getFileName() {