diff options
Diffstat (limited to 'includes/installer/WebInstallerPage.php')
| -rw-r--r-- | includes/installer/WebInstallerPage.php | 1238 |
1 files changed, 1238 insertions, 0 deletions
diff --git a/includes/installer/WebInstallerPage.php b/includes/installer/WebInstallerPage.php new file mode 100644 index 00000000..5c30182b --- /dev/null +++ b/includes/installer/WebInstallerPage.php @@ -0,0 +1,1238 @@ +<?php +/** + * Base code for web installer pages. + * + * @file + * @ingroup Deployment + */ + +/** + * Abstract class to define pages for the web installer. + * + * @ingroup Deployment + * @since 1.17 + */ +abstract class WebInstallerPage { + + /** + * The WebInstaller object this WebInstallerPage belongs to. + * + * @var WebInstaller + */ + public $parent; + + public abstract function execute(); + + /** + * Constructor. + * + * @param $parent WebInstaller + */ + public function __construct( WebInstaller $parent ) { + $this->parent = $parent; + } + + public function addHTML( $html ) { + $this->parent->output->addHTML( $html ); + } + + public function startForm() { + $this->addHTML( + "<div class=\"config-section\">\n" . + Html::openElement( + 'form', + array( + 'method' => 'post', + 'action' => $this->parent->getUrl( array( 'page' => $this->getName() ) ) + ) + ) . "\n" + ); + } + + public function endForm( $continue = 'continue', $back = 'back' ) { + $s = "<div class=\"config-submit\">\n"; + $id = $this->getId(); + + if ( $id === false ) { + $s .= Html::hidden( 'lastPage', $this->parent->request->getVal( 'lastPage' ) ); + } + + if ( $continue ) { + // Fake submit button for enter keypress (bug 26267) + $s .= Xml::submitButton( wfMsg( "config-$continue" ), + array( 'name' => "enter-$continue", 'style' => 'visibility:hidden;overflow:hidden;width:1px;margin:0' ) ) . "\n"; + } + + if ( $back ) { + $s .= Xml::submitButton( wfMsg( "config-$back" ), + array( + 'name' => "submit-$back", + 'tabindex' => $this->parent->nextTabIndex() + ) ) . "\n"; + } + + if ( $continue ) { + $s .= Xml::submitButton( wfMsg( "config-$continue" ), + array( + 'name' => "submit-$continue", + 'tabindex' => $this->parent->nextTabIndex(), + ) ) . "\n"; + } + + $s .= "</div></form></div>\n"; + $this->addHTML( $s ); + } + + public function getName() { + return str_replace( 'WebInstaller_', '', get_class( $this ) ); + } + + protected function getId() { + return array_search( $this->getName(), $this->parent->pageSequence ); + } + + public function getVar( $var ) { + return $this->parent->getVar( $var ); + } + + public function setVar( $name, $value ) { + $this->parent->setVar( $name, $value ); + } + + /** + * Get the starting tags of a fieldset. + * + * @param $legend String: message name + */ + protected function getFieldsetStart( $legend ) { + return "\n<fieldset><legend>" . wfMsgHtml( $legend ) . "</legend>\n"; + } + + /** + * Get the end tag of a fieldset. + */ + protected function getFieldsetEnd() { + return "</fieldset>\n"; + } + + /** + * Opens a textarea used to display the progress of a long operation + */ + protected function startLiveBox() { + $this->addHTML( + '<div id="config-spinner" style="display:none;"><img src="../skins/common/images/ajax-loader.gif" /></div>' . + '<script>jQuery( "#config-spinner" ).show();</script>' . + '<textarea id="config-live-log" name="LiveLog" rows="10" cols="30" readonly="readonly">' + ); + $this->parent->output->flush(); + } + + /** + * Opposite to startLiveBox() + */ + protected function endLiveBox() { + $this->addHTML( '</textarea> +<script>jQuery( "#config-spinner" ).hide()</script>' ); + $this->parent->output->flush(); + } +} + +class WebInstaller_Language extends WebInstallerPage { + + public function execute() { + global $wgLang; + $r = $this->parent->request; + $userLang = $r->getVal( 'UserLang' ); + $contLang = $r->getVal( 'ContLang' ); + + $lifetime = intval( ini_get( 'session.gc_maxlifetime' ) ); + if ( !$lifetime ) { + $lifetime = 1440; // PHP default + } + + if ( $r->wasPosted() ) { + # Do session test + if ( $this->parent->getSession( 'test' ) === null ) { + $requestTime = $r->getVal( 'LanguageRequestTime' ); + if ( !$requestTime ) { + // The most likely explanation is that the user was knocked back + // from another page on POST due to session expiry + $msg = 'config-session-expired'; + } elseif ( time() - $requestTime > $lifetime ) { + $msg = 'config-session-expired'; + } else { + $msg = 'config-no-session'; + } + $this->parent->showError( $msg, $wgLang->formatTimePeriod( $lifetime ) ); + } else { + $languages = Language::getLanguageNames(); + if ( isset( $languages[$userLang] ) ) { + $this->setVar( '_UserLang', $userLang ); + } + if ( isset( $languages[$contLang] ) ) { + $this->setVar( 'wgLanguageCode', $contLang ); + } + return 'continue'; + } + } elseif ( $this->parent->showSessionWarning ) { + # The user was knocked back from another page to the start + # This probably indicates a session expiry + $this->parent->showError( 'config-session-expired', $wgLang->formatTimePeriod( $lifetime ) ); + } + + $this->parent->setSession( 'test', true ); + + if ( !isset( $languages[$userLang] ) ) { + $userLang = $this->getVar( '_UserLang', 'en' ); + } + if ( !isset( $languages[$contLang] ) ) { + $contLang = $this->getVar( 'wgLanguageCode', 'en' ); + } + $this->startForm(); + $s = Html::hidden( 'LanguageRequestTime', time() ) . + $this->getLanguageSelector( 'UserLang', 'config-your-language', $userLang, $this->parent->getHelpBox( 'config-your-language-help' ) ) . + $this->getLanguageSelector( 'ContLang', 'config-wiki-language', $contLang, $this->parent->getHelpBox( 'config-wiki-language-help' ) ); + $this->addHTML( $s ); + $this->endForm( 'continue', false ); + } + + /** + * Get a <select> for selecting languages. + */ + public function getLanguageSelector( $name, $label, $selectedCode ) { + global $wgDummyLanguageCodes; + $s = Html::openElement( 'select', array( 'id' => $name, 'name' => $name ) ) . "\n"; + + $languages = Language::getLanguageNames(); + ksort( $languages ); + $dummies = array_flip( $wgDummyLanguageCodes ); + foreach ( $languages as $code => $lang ) { + if ( isset( $dummies[$code] ) ) continue; + $s .= "\n" . Xml::option( "$code - $lang", $code, $code == $selectedCode ); + } + $s .= "\n</select>\n"; + return $this->parent->label( $label, $name, $s ); + } + +} + +class WebInstaller_ExistingWiki extends WebInstallerPage { + public function execute() { + // If there is no LocalSettings.php, continue to the installer welcome page + $vars = Installer::getExistingLocalSettings(); + if ( !$vars ) { + return 'skip'; + } + + // Check if the upgrade key supplied to the user has appeared in LocalSettings.php + if ( $vars['wgUpgradeKey'] !== false + && $this->getVar( '_UpgradeKeySupplied' ) + && $this->getVar( 'wgUpgradeKey' ) === $vars['wgUpgradeKey'] ) + { + // It's there, so the user is authorized + $status = $this->handleExistingUpgrade( $vars ); + if ( $status->isOK() ) { + return 'skip'; + } else { + $this->startForm(); + $this->parent->showStatusBox( $status ); + $this->endForm( 'continue' ); + return 'output'; + } + } + + // If there is no $wgUpgradeKey, tell the user to add one to LocalSettings.php + if ( $vars['wgUpgradeKey'] === false ) { + if ( $this->getVar( 'wgUpgradeKey', false ) === false ) { + $secretKey = $this->getVar( 'wgSecretKey' ); // preserve $wgSecretKey + $this->parent->generateKeys(); + $this->setVar( 'wgSecretKey', $secretKey ); + $this->setVar( '_UpgradeKeySupplied', true ); + } + $this->startForm(); + $this->addHTML( $this->parent->getInfoBox( + wfMsgNoTrans( 'config-upgrade-key-missing', + "<pre>\$wgUpgradeKey = '" . $this->getVar( 'wgUpgradeKey' ) . "';</pre>" ) + ) ); + $this->endForm( 'continue' ); + return 'output'; + } + + // If there is an upgrade key, but it wasn't supplied, prompt the user to enter it + + $r = $this->parent->request; + if ( $r->wasPosted() ) { + $key = $r->getText( 'config_wgUpgradeKey' ); + if( !$key || $key !== $vars['wgUpgradeKey'] ) { + $this->parent->showError( 'config-localsettings-badkey' ); + $this->showKeyForm(); + return 'output'; + } + // Key was OK + $status = $this->handleExistingUpgrade( $vars ); + if ( $status->isOK() ) { + return 'continue'; + } else { + $this->parent->showStatusBox( $status ); + $this->showKeyForm(); + return 'output'; + } + } else { + $this->showKeyForm(); + return 'output'; + } + } + + /** + * Show the "enter key" form + */ + protected function showKeyForm() { + $this->startForm(); + $this->addHTML( + $this->parent->getInfoBox( wfMsgNoTrans( 'config-localsettings-upgrade' ) ). + '<br />' . + $this->parent->getTextBox( array( + 'var' => 'wgUpgradeKey', + 'label' => 'config-localsettings-key', + 'attribs' => array( 'autocomplete' => 'off' ), + ) ) + ); + $this->endForm( 'continue' ); + } + + protected function importVariables( $names, $vars ) { + $status = Status::newGood(); + foreach ( $names as $name ) { + if ( !isset( $vars[$name] ) ) { + $status->fatal( 'config-localsettings-incomplete', $name ); + } + $this->setVar( $name, $vars[$name] ); + } + return $status; + } + + /** + * Initiate an upgrade of the existing database + * @param $vars Variables from LocalSettings.php and AdminSettings.php + * @return Status + */ + protected function handleExistingUpgrade( $vars ) { + // Check $wgDBtype + if ( !isset( $vars['wgDBtype'] ) || !in_array( $vars['wgDBtype'], Installer::getDBTypes() ) ) { + return Status::newFatal( 'config-localsettings-connection-error', '' ); + } + + // Set the relevant variables from LocalSettings.php + $requiredVars = array( 'wgDBtype' ); + $status = $this->importVariables( $requiredVars , $vars ); + $installer = $this->parent->getDBInstaller(); + $status->merge( $this->importVariables( $installer->getGlobalNames(), $vars ) ); + if ( !$status->isOK() ) { + return $status; + } + + if ( isset( $vars['wgDBadminuser'] ) ) { + $this->setVar( '_InstallUser', $vars['wgDBadminuser'] ); + } else { + $this->setVar( '_InstallUser', $vars['wgDBuser'] ); + } + if ( isset( $vars['wgDBadminpassword'] ) ) { + $this->setVar( '_InstallPassword', $vars['wgDBadminpassword'] ); + } else { + $this->setVar( '_InstallPassword', $vars['wgDBpassword'] ); + } + + // Test the database connection + $status = $installer->getConnection(); + if ( !$status->isOK() ) { + // Adjust the error message to explain things correctly + $status->replaceMessage( 'config-connection-error', + 'config-localsettings-connection-error' ); + return $status; + } + + // All good + $this->setVar( '_ExistingDBSettings', true ); + return $status; + } +} + +class WebInstaller_Welcome extends WebInstallerPage { + + public function execute() { + if ( $this->parent->request->wasPosted() ) { + if ( $this->getVar( '_Environment' ) ) { + return 'continue'; + } + } + $this->parent->output->addWikiText( wfMsgNoTrans( 'config-welcome' ) ); + $status = $this->parent->doEnvironmentChecks(); + if ( $status->isGood() ) { + $this->parent->output->addHTML( '<span class="success-message">' . + wfMsgHtml( 'config-env-good' ) . '</span>' ); + $this->parent->output->addWikiText( wfMsgNoTrans( 'config-copyright', + SpecialVersion::getCopyrightAndAuthorList() ) ); + $this->startForm(); + $this->endForm(); + } else { + $this->parent->showStatusMessage( $status ); + } + } + +} + +class WebInstaller_DBConnect extends WebInstallerPage { + + public function execute() { + if ( $this->getVar( '_ExistingDBSettings' ) ) { + return 'skip'; + } + + $r = $this->parent->request; + if ( $r->wasPosted() ) { + $status = $this->submit(); + + if ( $status->isGood() ) { + $this->setVar( '_UpgradeDone', false ); + return 'continue'; + } else { + $this->parent->showStatusBox( $status ); + } + } + + $this->startForm(); + + $types = "<ul class=\"config-settings-block\">\n"; + $settings = ''; + $defaultType = $this->getVar( 'wgDBtype' ); + + $dbSupport = ''; + foreach( $this->parent->getDBTypes() as $type ) { + $link = DatabaseBase::newFromType( $type )->getSoftwareLink(); + $dbSupport .= wfMsgNoTrans( "config-support-$type", $link ) . "\n"; + } + $this->addHTML( $this->parent->getInfoBox( + wfMsg( 'config-support-info', $dbSupport ) ) ); + + foreach ( $this->parent->getVar( '_CompiledDBs' ) as $type ) { + $installer = $this->parent->getDBInstaller( $type ); + $types .= + '<li>' . + Xml::radioLabel( + $installer->getReadableName(), + 'DBType', + $type, + "DBType_$type", + $type == $defaultType, + array( 'class' => 'dbRadio', 'rel' => "DB_wrapper_$type" ) + ) . + "</li>\n"; + + $settings .= + Html::openElement( 'div', array( 'id' => 'DB_wrapper_' . $type, 'class' => 'dbWrapper' ) ) . + Html::element( 'h3', array(), wfMsg( 'config-header-' . $type ) ) . + $installer->getConnectForm() . + "</div>\n"; + } + $types .= "</ul><br clear=\"left\"/>\n"; + + $this->addHTML( + $this->parent->label( 'config-db-type', false, $types ) . + $settings + ); + + $this->endForm(); + } + + public function submit() { + $r = $this->parent->request; + $type = $r->getVal( 'DBType' ); + $this->setVar( 'wgDBtype', $type ); + $installer = $this->parent->getDBInstaller( $type ); + if ( !$installer ) { + return Status::newFatal( 'config-invalid-db-type' ); + } + return $installer->submitConnectForm(); + } + +} + +class WebInstaller_Upgrade extends WebInstallerPage { + + public function execute() { + if ( $this->getVar( '_UpgradeDone' ) ) { + // Allow regeneration of LocalSettings.php, unless we are working + // from a pre-existing LocalSettings.php file and we want to avoid + // leaking its contents + if ( $this->parent->request->wasPosted() && !$this->getVar( '_ExistingDBSettings' ) ) { + // Done message acknowledged + return 'continue'; + } else { + // Back button click + // Show the done message again + // Make them click back again if they want to do the upgrade again + $this->showDoneMessage(); + return 'output'; + } + } + + // wgDBtype is generally valid here because otherwise the previous page + // (connect) wouldn't have declared its happiness + $type = $this->getVar( 'wgDBtype' ); + $installer = $this->parent->getDBInstaller( $type ); + + if ( !$installer->needsUpgrade() ) { + return 'skip'; + } + + if ( $this->parent->request->wasPosted() ) { + $installer->preUpgrade(); + + $this->startLiveBox(); + $result = $installer->doUpgrade(); + $this->endLiveBox(); + + if ( $result ) { + // If they're going to possibly regenerate LocalSettings, we + // need to create the upgrade/secret keys. Bug 26481 + if( !$this->getVar( '_ExistingDBSettings' ) ) { + $this->parent->generateKeys(); + } + $this->setVar( '_UpgradeDone', true ); + $this->showDoneMessage(); + return 'output'; + } + } + + $this->startForm(); + $this->addHTML( $this->parent->getInfoBox( + wfMsgNoTrans( 'config-can-upgrade', $GLOBALS['wgVersion'] ) ) ); + $this->endForm(); + } + + public function showDoneMessage() { + $this->startForm(); + $regenerate = !$this->getVar( '_ExistingDBSettings' ); + if ( $regenerate ) { + $msg = 'config-upgrade-done'; + } else { + $msg = 'config-upgrade-done-no-regenerate'; + } + $this->parent->disableLinkPopups(); + $this->addHTML( + $this->parent->getInfoBox( + wfMsgNoTrans( $msg, + $GLOBALS['wgServer'] . + $this->getVar( 'wgScriptPath' ) . '/index' . + $this->getVar( 'wgScriptExtension' ) + ), 'tick-32.png' + ) + ); + $this->parent->restoreLinkPopups(); + $this->endForm( $regenerate ? 'regenerate' : false, false ); + } + +} + +class WebInstaller_DBSettings extends WebInstallerPage { + + public function execute() { + $installer = $this->parent->getDBInstaller( $this->getVar( 'wgDBtype' ) ); + + $r = $this->parent->request; + if ( $r->wasPosted() ) { + $status = $installer->submitSettingsForm(); + if ( $status === false ) { + return 'skip'; + } elseif ( $status->isGood() ) { + return 'continue'; + } else { + $this->parent->showStatusBox( $status ); + } + } + + $form = $installer->getSettingsForm(); + if ( $form === false ) { + return 'skip'; + } + + $this->startForm(); + $this->addHTML( $form ); + $this->endForm(); + } + +} + +class WebInstaller_Name extends WebInstallerPage { + + public function execute() { + $r = $this->parent->request; + if ( $r->wasPosted() ) { + if ( $this->submit() ) { + return 'continue'; + } + } + + $this->startForm(); + + // Encourage people to not name their site 'MediaWiki' by blanking the + // field. I think that was the intent with the original $GLOBALS['wgSitename'] + // but these two always were the same so had the effect of making the + // installer forget $wgSitename when navigating back to this page. + if ( $this->getVar( 'wgSitename' ) == 'MediaWiki' ) { + $this->setVar( 'wgSitename', '' ); + } + + // Set wgMetaNamespace to something valid before we show the form. + // $wgMetaNamespace defaults to $wgSiteName which is 'MediaWiki' + $metaNS = $this->getVar( 'wgMetaNamespace' ); + $this->setVar( 'wgMetaNamespace', wfMsgForContent( 'config-ns-other-default' ) ); + + $this->addHTML( + $this->parent->getTextBox( array( + 'var' => 'wgSitename', + 'label' => 'config-site-name', + 'help' => $this->parent->getHelpBox( 'config-site-name-help' ) + ) ) . + $this->parent->getRadioSet( array( + 'var' => '_NamespaceType', + 'label' => 'config-project-namespace', + 'itemLabelPrefix' => 'config-ns-', + 'values' => array( 'site-name', 'generic', 'other' ), + 'commonAttribs' => array( 'class' => 'enableForOther', 'rel' => 'config_wgMetaNamespace' ), + 'help' => $this->parent->getHelpBox( 'config-project-namespace-help' ) + ) ) . + $this->parent->getTextBox( array( + 'var' => 'wgMetaNamespace', + 'label' => '', //TODO: Needs a label? + 'attribs' => array( 'readonly' => 'readonly', 'class' => 'enabledByOther' ), + + ) ) . + $this->getFieldSetStart( 'config-admin-box' ) . + $this->parent->getTextBox( array( + 'var' => '_AdminName', + 'label' => 'config-admin-name', + 'help' => $this->parent->getHelpBox( 'config-admin-help' ) + ) ) . + $this->parent->getPasswordBox( array( + 'var' => '_AdminPassword', + 'label' => 'config-admin-password', + ) ) . + $this->parent->getPasswordBox( array( + 'var' => '_AdminPassword2', + 'label' => 'config-admin-password-confirm' + ) ) . + $this->parent->getTextBox( array( + 'var' => '_AdminEmail', + 'label' => 'config-admin-email', + 'help' => $this->parent->getHelpBox( 'config-admin-email-help' ) + ) ) . + $this->parent->getCheckBox( array( + 'var' => '_Subscribe', + 'label' => 'config-subscribe', + 'help' => $this->parent->getHelpBox( 'config-subscribe-help' ) + ) ) . + $this->getFieldSetEnd() . + $this->parent->getInfoBox( wfMsg( 'config-almost-done' ) ) . + $this->parent->getRadioSet( array( + 'var' => '_SkipOptional', + 'itemLabelPrefix' => 'config-optional-', + 'values' => array( 'continue', 'skip' ) + ) ) + ); + + // Restore the default value + $this->setVar( 'wgMetaNamespace', $metaNS ); + + $this->endForm(); + return 'output'; + } + + public function submit() { + $retVal = true; + $this->parent->setVarsFromRequest( array( 'wgSitename', '_NamespaceType', + '_AdminName', '_AdminPassword', '_AdminPassword2', '_AdminEmail', + '_Subscribe', '_SkipOptional', 'wgMetaNamespace' ) ); + + // Validate site name + if ( strval( $this->getVar( 'wgSitename' ) ) === '' ) { + $this->parent->showError( 'config-site-name-blank' ); + $retVal = false; + } + + // Fetch namespace + $nsType = $this->getVar( '_NamespaceType' ); + if ( $nsType == 'site-name' ) { + $name = $this->getVar( 'wgSitename' ); + // Sanitize for namespace + // This algorithm should match the JS one in WebInstallerOutput.php + $name = preg_replace( '/[\[\]\{\}|#<>%+? ]/', '_', $name ); + $name = str_replace( '&', '&', $name ); + $name = preg_replace( '/__+/', '_', $name ); + $name = ucfirst( trim( $name, '_' ) ); + } elseif ( $nsType == 'generic' ) { + $name = wfMsg( 'config-ns-generic' ); + } else { // other + $name = $this->getVar( 'wgMetaNamespace' ); + } + + // Validate namespace + if ( strpos( $name, ':' ) !== false ) { + $good = false; + } else { + // Title-style validation + $title = Title::newFromText( $name ); + if ( !$title ) { + $good = $nsType == 'site-name'; + } else { + $name = $title->getDBkey(); + $good = true; + } + } + if ( !$good ) { + $this->parent->showError( 'config-ns-invalid', $name ); + $retVal = false; + } + + // Make sure it won't conflict with any existing namespaces + global $wgContLang; + $nsIndex = $wgContLang->getNsIndex( $name ); + if( $nsIndex !== false && $nsIndex !== NS_PROJECT ) { + $this->parent->showError( 'config-ns-conflict', $name ); + $retVal = false; + } + + $this->setVar( 'wgMetaNamespace', $name ); + + // Validate username for creation + $name = $this->getVar( '_AdminName' ); + if ( strval( $name ) === '' ) { + $this->parent->showError( 'config-admin-name-blank' ); + $cname = $name; + $retVal = false; + } else { + $cname = User::getCanonicalName( $name, 'creatable' ); + if ( $cname === false ) { + $this->parent->showError( 'config-admin-name-invalid', $name ); + $retVal = false; + } else { + $this->setVar( '_AdminName', $cname ); + } + } + + // Validate password + $msg = false; + $valid = false; + $pwd = $this->getVar( '_AdminPassword' ); + $user = User::newFromName( $cname ); + $valid = $user && $user->getPasswordValidity( $pwd ); + if ( strval( $pwd ) === '' ) { + # $user->getPasswordValidity just checks for $wgMinimalPasswordLength. + # This message is more specific and helpful. + $msg = 'config-admin-password-blank'; + } elseif ( $pwd !== $this->getVar( '_AdminPassword2' ) ) { + $msg = 'config-admin-password-mismatch'; + } elseif ( $valid !== true ) { + # As of writing this will only catch the username being e.g. 'FOO' and + # the password 'foo' + $msg = $valid; + } + if ( $msg !== false ) { + call_user_func_array( array( $this->parent, 'showError' ), (array)$msg ); + $this->setVar( '_AdminPassword', '' ); + $this->setVar( '_AdminPassword2', '' ); + $retVal = false; + } + + // Validate e-mail if provided + $email = $this->getVar( '_AdminEmail' ); + if( $email && !User::isValidEmailAddr( $email ) ) { + $this->parent->showError( 'config-admin-error-bademail' ); + $retVal = false; + } + + return $retVal; + } + +} + +class WebInstaller_Options extends WebInstallerPage { + + public function execute() { + if ( $this->getVar( '_SkipOptional' ) == 'skip' ) { + return 'skip'; + } + if ( $this->parent->request->wasPosted() ) { + if ( $this->submit() ) { + return 'continue'; + } + } + + $emailwrapperStyle = $this->getVar( 'wgEnableEmail' ) ? '' : 'display: none'; + $this->startForm(); + $this->addHTML( + # User Rights + $this->parent->getRadioSet( array( + 'var' => '_RightsProfile', + 'label' => 'config-profile', + 'itemLabelPrefix' => 'config-profile-', + 'values' => array_keys( $this->parent->rightsProfiles ), + ) ) . + $this->parent->getInfoBox( wfMsgNoTrans( 'config-profile-help' ) ) . + + # Licensing + $this->parent->getRadioSet( array( + 'var' => '_LicenseCode', + 'label' => 'config-license', + 'itemLabelPrefix' => 'config-license-', + 'values' => array_keys( $this->parent->licenses ), + 'commonAttribs' => array( 'class' => 'licenseRadio' ), + ) ) . + $this->getCCChooser() . + $this->parent->getHelpBox( 'config-license-help' ) . + + # E-mail + $this->getFieldSetStart( 'config-email-settings' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEnableEmail', + 'label' => 'config-enable-email', + 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'emailwrapper' ), + ) ) . + $this->parent->getHelpBox( 'config-enable-email-help' ) . + "<div id=\"emailwrapper\" style=\"$emailwrapperStyle\">" . + $this->parent->getTextBox( array( + 'var' => 'wgPasswordSender', + 'label' => 'config-email-sender' + ) ) . + $this->parent->getHelpBox( 'config-email-sender-help' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEnableUserEmail', + 'label' => 'config-email-user', + ) ) . + $this->parent->getHelpBox( 'config-email-user-help' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEnotifUserTalk', + 'label' => 'config-email-usertalk', + ) ) . + $this->parent->getHelpBox( 'config-email-usertalk-help' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEnotifWatchlist', + 'label' => 'config-email-watchlist', + ) ) . + $this->parent->getHelpBox( 'config-email-watchlist-help' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEmailAuthentication', + 'label' => 'config-email-auth', + ) ) . + $this->parent->getHelpBox( 'config-email-auth-help' ) . + "</div>" . + $this->getFieldSetEnd() + ); + + $extensions = $this->parent->findExtensions(); + + if( $extensions ) { + $extHtml = $this->getFieldSetStart( 'config-extensions' ); + + foreach( $extensions as $ext ) { + $extHtml .= $this->parent->getCheckBox( array( + 'var' => "ext-$ext", + 'rawtext' => $ext, + ) ); + } + + $extHtml .= $this->parent->getHelpBox( 'config-extensions-help' ) . + $this->getFieldSetEnd(); + $this->addHTML( $extHtml ); + } + + // Having / in paths in Windows looks funny :) + $this->setVar( 'wgDeletedDirectory', + str_replace( + '/', DIRECTORY_SEPARATOR, + $this->getVar( 'wgDeletedDirectory' ) + ) + ); + + $uploadwrapperStyle = $this->getVar( 'wgEnableUploads' ) ? '' : 'display: none'; + $this->addHTML( + # Uploading + $this->getFieldSetStart( 'config-upload-settings' ) . + $this->parent->getCheckBox( array( + 'var' => 'wgEnableUploads', + 'label' => 'config-upload-enable', + 'attribs' => array( 'class' => 'showHideRadio', 'rel' => 'uploadwrapper' ), + 'help' => $this->parent->getHelpBox( 'config-upload-help' ) + ) ) . + '<div id="uploadwrapper" style="' . $uploadwrapperStyle . '">' . + $this->parent->getTextBox( array( + 'var' => 'wgDeletedDirectory', + 'label' => 'config-upload-deleted', + 'help' => $this->parent->getHelpBox( 'config-upload-deleted-help' ) + ) ) . + '</div>' . + $this->parent->getTextBox( array( + 'var' => 'wgLogo', + 'label' => 'config-logo', + 'help' => $this->parent->getHelpBox( 'config-logo-help' ) + ) ) + ); + $this->addHTML( + $this->parent->getCheckBox( array( + 'var' => 'wgUseInstantCommons', + 'label' => 'config-instantcommons', + 'help' => $this->parent->getHelpBox( 'config-instantcommons-help' ) + ) ) . + $this->getFieldSetEnd() + ); + + $caches = array( 'none' ); + if( count( $this->getVar( '_Caches' ) ) ) { + $caches[] = 'accel'; + } + $caches[] = 'memcached'; + + $this->addHTML( + # Advanced settings + $this->getFieldSetStart( 'config-advanced-settings' ) . + # Object cache settings + $this->parent->getRadioSet( array( + 'var' => 'wgMainCacheType', + 'label' => 'config-cache-options', + 'itemLabelPrefix' => 'config-cache-', + 'values' => $caches, + 'value' => 'none', + ) ) . + $this->parent->getHelpBox( 'config-cache-help' ) . + '<div id="config-memcachewrapper">' . + $this->parent->getTextArea( array( + 'var' => '_MemCachedServers', + 'label' => 'config-memcached-servers', + 'help' => $this->parent->getHelpBox( 'config-memcached-help' ) + ) ) . + '</div>' . + $this->getFieldSetEnd() + ); + $this->endForm(); + } + + public function getCCPartnerUrl() { + global $wgServer; + $exitUrl = $wgServer . $this->parent->getUrl( array( + 'page' => 'Options', + 'SubmitCC' => 'indeed', + 'config__LicenseCode' => 'cc', + 'config_wgRightsUrl' => '[license_url]', + 'config_wgRightsText' => '[license_name]', + 'config_wgRightsIcon' => '[license_button]', + ) ); + $styleUrl = $wgServer . dirname( dirname( $this->parent->getUrl() ) ) . + '/skins/common/config-cc.css'; + $iframeUrl = 'http://creativecommons.org/license/?' . + wfArrayToCGI( array( + 'partner' => 'MediaWiki', + 'exit_url' => $exitUrl, + 'lang' => $this->getVar( '_UserLang' ), + 'stylesheet' => $styleUrl, + ) ); + return $iframeUrl; + } + + public function getCCChooser() { + $iframeAttribs = array( + 'class' => 'config-cc-iframe', + 'name' => 'config-cc-iframe', + 'id' => 'config-cc-iframe', + 'frameborder' => 0, + 'width' => '100%', + 'height' => '100%', + ); + if ( $this->getVar( '_CCDone' ) ) { + $iframeAttribs['src'] = $this->parent->getUrl( array( 'ShowCC' => 'yes' ) ); + } else { + $iframeAttribs['src'] = $this->getCCPartnerUrl(); + } + $wrapperStyle = ($this->getVar('_LicenseCode') == 'cc-choose') ? '' : 'display: none'; + + return + "<div class=\"config-cc-wrapper\" id=\"config-cc-wrapper\" style=\"$wrapperStyle\">\n" . + Html::element( 'iframe', $iframeAttribs, '', false /* not short */ ) . + "</div>\n"; + } + + public function getCCDoneBox() { + $js = "parent.document.getElementById('config-cc-wrapper').style.height = '$1';"; + // If you change this height, also change it in config.css + $expandJs = str_replace( '$1', '54em', $js ); + $reduceJs = str_replace( '$1', '70px', $js ); + return + '<p>'. + Html::element( 'img', array( 'src' => $this->getVar( 'wgRightsIcon' ) ) ) . + '  ' . + htmlspecialchars( $this->getVar( 'wgRightsText' ) ) . + "</p>\n" . + "<p style=\"text-align: center\">" . + Html::element( 'a', + array( + 'href' => $this->getCCPartnerUrl(), + 'onclick' => $expandJs, + ), + wfMsg( 'config-cc-again' ) + ) . + "</p>\n" . + "<script type=\"text/javascript\">\n" . + # Reduce the wrapper div height + htmlspecialchars( $reduceJs ) . + "\n" . + "</script>\n"; + } + + public function submitCC() { + $newValues = $this->parent->setVarsFromRequest( + array( 'wgRightsUrl', 'wgRightsText', 'wgRightsIcon' ) ); + if ( count( $newValues ) != 3 ) { + $this->parent->showError( 'config-cc-error' ); + return; + } + $this->setVar( '_CCDone', true ); + $this->addHTML( $this->getCCDoneBox() ); + } + + public function submit() { + $this->parent->setVarsFromRequest( array( '_RightsProfile', '_LicenseCode', + 'wgEnableEmail', 'wgPasswordSender', 'wgEnableUploads', 'wgLogo', + 'wgEnableUserEmail', 'wgEnotifUserTalk', 'wgEnotifWatchlist', + 'wgEmailAuthentication', 'wgMainCacheType', '_MemCachedServers', + 'wgUseInstantCommons' ) ); + + if ( !in_array( $this->getVar( '_RightsProfile' ), + array_keys( $this->parent->rightsProfiles ) ) ) + { + reset( $this->parent->rightsProfiles ); + $this->setVar( '_RightsProfile', key( $this->parent->rightsProfiles ) ); + } + + $code = $this->getVar( '_LicenseCode' ); + if ( $code == 'cc-choose' ) { + if ( !$this->getVar( '_CCDone' ) ) { + $this->parent->showError( 'config-cc-not-chosen' ); + return false; + } + } elseif ( in_array( $code, array_keys( $this->parent->licenses ) ) ) { + $entry = $this->parent->licenses[$code]; + if ( isset( $entry['text'] ) ) { + $this->setVar( 'wgRightsText', $entry['text'] ); + } else { + $this->setVar( 'wgRightsText', wfMsg( 'config-license-' . $code ) ); + } + $this->setVar( 'wgRightsUrl', $entry['url'] ); + $this->setVar( 'wgRightsIcon', $entry['icon'] ); + } else { + $this->setVar( 'wgRightsText', '' ); + $this->setVar( 'wgRightsUrl', '' ); + $this->setVar( 'wgRightsIcon', '' ); + } + + $extsAvailable = $this->parent->findExtensions(); + $extsToInstall = array(); + foreach( $extsAvailable as $ext ) { + if( $this->parent->request->getCheck( 'config_ext-' . $ext ) ) { + $extsToInstall[] = $ext; + } + } + $this->parent->setVar( '_Extensions', $extsToInstall ); + + if( $this->getVar( 'wgMainCacheType' ) == 'memcached' ) { + $memcServers = explode( "\n", $this->getVar( '_MemCachedServers' ) ); + if( !$memcServers ) { + $this->parent->showError( 'config-memcache-needservers' ); + return false; + } + + foreach( $memcServers as $server ) { + $memcParts = explode( ":", $server ); + if( !IP::isValid( $memcParts[0] ) ) { + $this->parent->showError( 'config-memcache-badip', $memcParts[0] ); + return false; + } elseif( !isset( $memcParts[1] ) ) { + $this->parent->showError( 'config-memcache-noport', $memcParts[0] ); + return false; + } elseif( $memcParts[1] < 1 || $memcParts[1] > 65535 ) { + $this->parent->showError( 'config-memcache-badport', 1, 65535 ); + return false; + } + } + } + return true; + } + +} + +class WebInstaller_Install extends WebInstallerPage { + + public function execute() { + if( $this->getVar( '_UpgradeDone' ) ) { + return 'skip'; + } elseif( $this->getVar( '_InstallDone' ) ) { + return 'continue'; + } elseif( $this->parent->request->wasPosted() ) { + $this->startForm(); + $this->addHTML("<ul>"); + $results = $this->parent->performInstallation( + array( $this, 'startStage'), + array( $this, 'endStage' ) + ); + $this->addHTML("</ul>"); + // PerformInstallation bails on a fatal, so make sure the last item + // completed before giving 'next.' Likewise, only provide back on failure + $lastStep = end( $results ); + $continue = $lastStep->isOK() ? 'continue' : false; + $back = $lastStep->isOK() ? false : 'back'; + $this->endForm( $continue, $back ); + } else { + $this->startForm(); + $this->addHTML( $this->parent->getInfoBox( wfMsgNoTrans( 'config-install-begin' ) ) ); + $this->endForm(); + } + return true; + } + + public function startStage( $step ) { + $this->addHTML( "<li>" . wfMsgHtml( "config-install-$step" ) . wfMsg( 'ellipsis') ); + if ( $step == 'extension-tables' ) { + $this->startLiveBox(); + } + } + + public function endStage( $step, $status ) { + if ( $step == 'extension-tables' ) { + $this->endLiveBox(); + } + $msg = $status->isOk() ? 'config-install-step-done' : 'config-install-step-failed'; + $html = wfMsgHtml( 'word-separator' ) . wfMsgHtml( $msg ); + if ( !$status->isOk() ) { + $html = "<span class=\"error\">$html</span>"; + } + $this->addHTML( $html . "</li>\n" ); + if( !$status->isGood() ) { + $this->parent->showStatusBox( $status ); + } + } + +} + +class WebInstaller_Complete extends WebInstallerPage { + + public function execute() { + // Pop up a dialog box, to make it difficult for the user to forget + // to download the file + $lsUrl = $GLOBALS['wgServer'] . $this->parent->getURL( array( 'localsettings' => 1 ) ); + if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && strpos( $_SERVER['HTTP_USER_AGENT'], 'MSIE' ) !== false ) { + // JS appears the only method that works consistently with IE7+ + $this->addHtml( "\n<script type=\"" . $GLOBALS['wgJsMimeType'] . '">jQuery( document ).ready( function() { document.location=' + . Xml::encodeJsVar( $lsUrl) . "; } );</script>\n" ); + } else { + $this->parent->request->response()->header( "Refresh: 0;url=$lsUrl" ); + } + + $this->startForm(); + $this->parent->disableLinkPopups(); + $this->addHTML( + $this->parent->getInfoBox( + wfMsgNoTrans( 'config-install-done', + $lsUrl, + $GLOBALS['wgServer'] . + $this->getVar( 'wgScriptPath' ) . '/index' . + $this->getVar( 'wgScriptExtension' ), + '<downloadlink/>' + ), 'tick-32.png' + ) + ); + $this->parent->restoreLinkPopups(); + $this->endForm( false, false ); + } +} + +class WebInstaller_Restart extends WebInstallerPage { + + public function execute() { + $r = $this->parent->request; + if ( $r->wasPosted() ) { + $really = $r->getVal( 'submit-restart' ); + if ( $really ) { + $this->parent->reset(); + } + return 'continue'; + } + + $this->startForm(); + $s = $this->parent->getWarningBox( wfMsgNoTrans( 'config-help-restart' ) ); + $this->addHTML( $s ); + $this->endForm( 'restart' ); + } + +} + +abstract class WebInstaller_Document extends WebInstallerPage { + + protected abstract function getFileName(); + + public function execute() { + $text = $this->getFileContents(); + $text = $this->formatTextFile( $text ); + $this->parent->output->addWikiText( $text ); + $this->startForm(); + $this->endForm( false ); + } + + public function getFileContents() { + return file_get_contents( dirname( __FILE__ ) . '/../../' . $this->getFileName() ); + } + + protected function formatTextFile( $text ) { + // Use Unix line endings, escape some wikitext stuff + $text = str_replace( array( '<', '{{', '[[', "\r" ), + array( '<', '{{', '[[', '' ), $text ); + // join word-wrapped lines into one + do { + $prev = $text; + $text = preg_replace( "/\n([\\*#\t])([^\n]*?)\n([^\n#\\*:]+)/", "\n\\1\\2 \\3", $text ); + } while ( $text != $prev ); + // Replace tab indents with colons + $text = preg_replace( '/^\t\t/m', '::', $text ); + $text = preg_replace( '/^\t/m', ':', $text ); + // turn (bug nnnn) into links + $text = preg_replace_callback('/bug (\d+)/', array( $this, 'replaceBugLinks' ), $text ); + // add links to manual to every global variable mentioned + $text = preg_replace_callback('/(\$wg[a-z0-9_]+)/i', array( $this, 'replaceConfigLinks' ), $text ); + return $text; + } + + private function replaceBugLinks( $matches ) { + return '<span class="config-plainlink">[https://bugzilla.wikimedia.org/' . + $matches[1] . ' bug ' . $matches[1] . ']</span>'; + } + + private function replaceConfigLinks( $matches ) { + return '<span class="config-plainlink">[http://www.mediawiki.org/wiki/Manual:' . + $matches[1] . ' ' . $matches[1] . ']</span>'; + } + +} + +class WebInstaller_Readme extends WebInstaller_Document { + protected function getFileName() { return 'README'; } +} + +class WebInstaller_ReleaseNotes extends WebInstaller_Document { + protected function getFileName() { return 'RELEASE-NOTES'; } +} + +class WebInstaller_UpgradeDoc extends WebInstaller_Document { + protected function getFileName() { return 'UPGRADE'; } +} + +class WebInstaller_Copying extends WebInstaller_Document { + protected function getFileName() { return 'COPYING'; } +} + |