Split the classes in WebInstallerPage.php into multiple files

Bug: T122634
Change-Id: If6606a0e1c2a5ec5651cc7f83cf7342ff8c6c765

1 files changed, 461 insertions, 0 deletions

diff --git a/includes/installer/WebInstallerOptions.php b/includes/installer/WebInstallerOptions.php
new file mode 100644
index 000000000000..30ea10efa0d0
--- /dev/null
+++ b/includes/installer/WebInstallerOptions.php
@@ -0,0 +1,461 @@
+<?php
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Deployment
+ */
+
+class WebInstallerOptions extends WebInstallerPage {
+
+	/**
+	 * @return string|null
+	 */
+	public function execute() {
+		if ( $this->getVar( '_SkipOptional' ) == 'skip' ) {
+			$this->submitSkins();
+			return 'skip';
+		}
+		if ( $this->parent->request->wasPosted() ) {
+			if ( $this->submit() ) {
+				return 'continue';
+			}
+		}
+
+		$emailwrapperStyle = $this->getVar( 'wgEnableEmail' ) ? '' : 'display: none';
+		$this->startForm();
+		$this->addHTML(
+			# User Rights
+			// getRadioSet() builds a set of labeled radio buttons.
+			// For grep: The following messages are used as the item labels:
+			// config-profile-wiki, config-profile-no-anon, config-profile-fishbowl, config-profile-private
+			$this->parent->getRadioSet( array(
+				'var' => '_RightsProfile',
+				'label' => 'config-profile',
+				'itemLabelPrefix' => 'config-profile-',
+				'values' => array_keys( $this->parent->rightsProfiles ),
+			) ) .
+			$this->parent->getInfoBox( wfMessage( 'config-profile-help' )->plain() ) .
+
+			# Licensing
+			// getRadioSet() builds a set of labeled radio buttons.
+			// For grep: The following messages are used as the item labels:
+			// config-license-cc-by, config-license-cc-by-sa, config-license-cc-by-nc-sa,
+			// config-license-cc-0, config-license-pd, config-license-gfdl,
+			// config-license-none, config-license-cc-choose
+			$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()
+		);
+
+		$skins = $this->parent->findExtensions( 'skins' );
+		$skinHtml = $this->getFieldSetStart( 'config-skins' );
+
+		$skinNames = array_map( 'strtolower', $skins );
+		$chosenSkinName = $this->getVar( 'wgDefaultSkin', $this->parent->getDefaultSkin( $skinNames ) );
+
+		if ( $skins ) {
+			$radioButtons = $this->parent->getRadioElements( array(
+				'var' => 'wgDefaultSkin',
+				'itemLabels' => array_fill_keys( $skinNames, 'config-skins-use-as-default' ),
+				'values' => $skinNames,
+				'value' => $chosenSkinName,
+			) );
+
+			foreach ( $skins as $skin ) {
+				$skinHtml .=
+					'<div class="config-skins-item">' .
+					$this->parent->getCheckBox( array(
+						'var' => "skin-$skin",
+						'rawtext' => $skin,
+						'value' => $this->getVar( "skin-$skin", true ), // all found skins enabled by default
+					) ) .
+					'<div class="config-skins-use-as-default">' . $radioButtons[strtolower( $skin )] . '</div>' .
+					'</div>';
+			}
+		} else {
+			$skinHtml .=
+				$this->parent->getWarningBox( wfMessage( 'config-skins-missing' )->plain() ) .
+				Html::hidden( 'config_wgDefaultSkin', $chosenSkinName );
+		}
+
+		$skinHtml .= $this->parent->getHelpBox( 'config-skins-help' ) .
+			$this->getFieldSetEnd();
+		$this->addHTML( $skinHtml );
+
+		$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',
+				'attribs' => array( 'dir' => 'ltr' ),
+				'help' => $this->parent->getHelpBox( 'config-upload-deleted-help' )
+			) ) .
+			'</div>' .
+			$this->parent->getTextBox( array(
+				'var' => 'wgLogo',
+				'label' => 'config-logo',
+				'attribs' => array( 'dir' => 'ltr' ),
+				'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' );
+		$cachevalDefault = 'none';
+
+		if ( count( $this->getVar( '_Caches' ) ) ) {
+			// A CACHE_ACCEL implementation is available
+			$caches[] = 'accel';
+			$cachevalDefault = 'accel';
+		}
+		$caches[] = 'memcached';
+
+		// We'll hide/show this on demand when the value changes, see config.js.
+		$cacheval = $this->getVar( '_MainCacheType' );
+		if ( !$cacheval ) {
+			// We need to set a default here; but don't hardcode it
+			// or we lose it every time we reload the page for validation
+			// or going back!
+			$cacheval = $cachevalDefault;
+		}
+		$hidden = ( $cacheval == 'memcached' ) ? '' : 'display: none';
+		$this->addHTML(
+			# Advanced settings
+			$this->getFieldSetStart( 'config-advanced-settings' ) .
+			# Object cache settings
+			// getRadioSet() builds a set of labeled radio buttons.
+			// For grep: The following messages are used as the item labels:
+			// config-cache-none, config-cache-accel, config-cache-memcached
+			$this->parent->getRadioSet( array(
+				'var' => '_MainCacheType',
+				'label' => 'config-cache-options',
+				'itemLabelPrefix' => 'config-cache-',
+				'values' => $caches,
+				'value' => $cacheval,
+			) ) .
+			$this->parent->getHelpBox( 'config-cache-help' ) .
+			"<div id=\"config-memcachewrapper\" style=\"$hidden\">" .
+			$this->parent->getTextArea( array(
+				'var' => '_MemCachedServers',
+				'label' => 'config-memcached-servers',
+				'help' => $this->parent->getHelpBox( 'config-memcached-help' )
+			) ) .
+			'</div>' .
+			$this->getFieldSetEnd()
+		);
+		$this->endForm();
+
+		return null;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCCPartnerUrl() {
+		$server = $this->getVar( 'wgServer' );
+		$exitUrl = $server . $this->parent->getUrl( array(
+			'page' => 'Options',
+			'SubmitCC' => 'indeed',
+			'config__LicenseCode' => 'cc',
+			'config_wgRightsUrl' => '[license_url]',
+			'config_wgRightsText' => '[license_name]',
+			'config_wgRightsIcon' => '[license_button]',
+		) );
+		$styleUrl = $server . dirname( dirname( $this->parent->getUrl() ) ) .
+			'/mw-config/config-cc.css';
+		$iframeUrl = '//creativecommons.org/license/?' .
+			wfArrayToCgi( array(
+				'partner' => 'MediaWiki',
+				'exit_url' => $exitUrl,
+				'lang' => $this->getVar( '_UserLang' ),
+				'stylesheet' => $styleUrl,
+			) );
+
+		return $iframeUrl;
+	}
+
+	/**
+	 * @return string
+	 */
+	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";
+	}
+
+	/**
+	 * @return string
+	 */
+	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' ) ) ) .
+			'&#160;&#160;' .
+			htmlspecialchars( $this->getVar( 'wgRightsText' ) ) .
+			"</p>\n" .
+			"<p style=\"text-align: center;\">" .
+			Html::element( 'a',
+				array(
+					'href' => $this->getCCPartnerUrl(),
+					'onclick' => $expandJs,
+				),
+				wfMessage( 'config-cc-again' )->text()
+			) .
+			"</p>\n" .
+			"<script>\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() );
+	}
+
+	/**
+	 * If the user skips this installer page, we still need to set up the default skins, but ignore
+	 * everything else.
+	 *
+	 * @return bool
+	 */
+	public function submitSkins() {
+		$skins = $this->parent->findExtensions( 'skins' );
+		$this->parent->setVar( '_Skins', $skins );
+
+		if ( $skins ) {
+			$skinNames = array_map( 'strtolower', $skins );
+			$this->parent->setVar( 'wgDefaultSkin', $this->parent->getDefaultSkin( $skinNames ) );
+		}
+
+		return true;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function submit() {
+		$this->parent->setVarsFromRequest( array( '_RightsProfile', '_LicenseCode',
+			'wgEnableEmail', 'wgPasswordSender', 'wgEnableUploads', 'wgLogo',
+			'wgEnableUserEmail', 'wgEnotifUserTalk', 'wgEnotifWatchlist',
+			'wgEmailAuthentication', '_MainCacheType', '_MemCachedServers',
+			'wgUseInstantCommons', 'wgDefaultSkin' ) );
+
+		$retVal = true;
+
+		if ( !array_key_exists( $this->getVar( '_RightsProfile' ), $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' );
+				$retVal = false;
+			}
+		} elseif ( array_key_exists( $code, $this->parent->licenses ) ) {
+			// Messages:
+			// config-license-cc-by, config-license-cc-by-sa, config-license-cc-by-nc-sa,
+			// config-license-cc-0, config-license-pd, config-license-gfdl, config-license-none,
+			// config-license-cc-choose
+			$entry = $this->parent->licenses[$code];
+			if ( isset( $entry['text'] ) ) {
+				$this->setVar( 'wgRightsText', $entry['text'] );
+			} else {
+				$this->setVar( 'wgRightsText', wfMessage( 'config-license-' . $code )->text() );
+			}
+			$this->setVar( 'wgRightsUrl', $entry['url'] );
+			$this->setVar( 'wgRightsIcon', $entry['icon'] );
+		} else {
+			$this->setVar( 'wgRightsText', '' );
+			$this->setVar( 'wgRightsUrl', '' );
+			$this->setVar( 'wgRightsIcon', '' );
+		}
+
+		$skinsAvailable = $this->parent->findExtensions( 'skins' );
+		$skinsToInstall = array();
+		foreach ( $skinsAvailable as $skin ) {
+			$this->parent->setVarsFromRequest( array( "skin-$skin" ) );
+			if ( $this->getVar( "skin-$skin" ) ) {
+				$skinsToInstall[] = $skin;
+			}
+		}
+		$this->parent->setVar( '_Skins', $skinsToInstall );
+
+		if ( !$skinsToInstall && $skinsAvailable ) {
+			$this->parent->showError( 'config-skins-must-enable-some' );
+			$retVal = false;
+		}
+		$defaultSkin = $this->getVar( 'wgDefaultSkin' );
+		$skinsToInstallLowercase = array_map( 'strtolower', $skinsToInstall );
+		if ( $skinsToInstall && array_search( $defaultSkin, $skinsToInstallLowercase ) === false ) {
+			$this->parent->showError( 'config-skins-must-enable-default' );
+			$retVal = false;
+		}
+
+		$extsAvailable = $this->parent->findExtensions();
+		$extsToInstall = array();
+		foreach ( $extsAvailable as $ext ) {
+			$this->parent->setVarsFromRequest( array( "ext-$ext" ) );
+			if ( $this->getVar( "ext-$ext" ) ) {
+				$extsToInstall[] = $ext;
+			}
+		}
+		$this->parent->setVar( '_Extensions', $extsToInstall );
+
+		if ( $this->getVar( '_MainCacheType' ) == 'memcached' ) {
+			$memcServers = explode( "\n", $this->getVar( '_MemCachedServers' ) );
+			if ( !$memcServers ) {
+				$this->parent->showError( 'config-memcache-needservers' );
+				$retVal = false;
+			}
+
+			foreach ( $memcServers as $server ) {
+				$memcParts = explode( ":", $server, 2 );
+				if ( !isset( $memcParts[0] )
+					|| ( !IP::isValid( $memcParts[0] )
+						&& ( gethostbyname( $memcParts[0] ) == $memcParts[0] ) )
+				) {
+					$this->parent->showError( 'config-memcache-badip', $memcParts[0] );
+					$retVal = false;
+				} elseif ( !isset( $memcParts[1] ) ) {
+					$this->parent->showError( 'config-memcache-noport', $memcParts[0] );
+					$retVal = false;
+				} elseif ( $memcParts[1] < 1 || $memcParts[1] > 65535 ) {
+					$this->parent->showError( 'config-memcache-badport', 1, 65535 );
+					$retVal = false;
+				}
+			}
+		}
+
+		return $retVal;
+	}
+
+}
+