1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
|
<?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 Installer
*/
namespace MediaWiki\Installer;
use MediaWiki\Context\RequestContext;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Password\UserPasswordPolicy;
use MediaWiki\Status\Status;
use MediaWiki\User\User;
use Wikimedia\Message\MessageSpecifier;
/**
* Class for the core installer command line interface.
*
* @ingroup Installer
* @since 1.17
*/
class CliInstaller extends Installer {
/** @var bool */
private $specifiedScriptPath = false;
private const OPTION_MAP = [
'dbtype' => 'wgDBtype',
'dbserver' => 'wgDBserver',
'dbname' => 'wgDBname',
'dbuser' => 'wgDBuser',
'dbpass' => 'wgDBpassword',
'dbprefix' => 'wgDBprefix',
'dbtableoptions' => 'wgDBTableOptions',
'dbport' => 'wgDBport',
'dbssl' => 'wgDBssl',
'dbschema' => 'wgDBmwschema',
'dbpath' => 'wgSQLiteDataDir',
'server' => 'wgServer',
'scriptpath' => 'wgScriptPath',
];
/**
* @param string $siteName
* @param string|null $admin
* @param array $options
* @throws InstallException
*/
public function __construct( $siteName, $admin = null, array $options = [] ) {
global $wgPasswordPolicy;
parent::__construct();
if ( isset( $options['scriptpath'] ) ) {
$this->specifiedScriptPath = true;
}
foreach ( self::OPTION_MAP as $opt => $global ) {
if ( isset( $options[$opt] ) ) {
$GLOBALS[$global] = $options[$opt];
$this->setVar( $global, $options[$opt] );
}
}
if ( isset( $options['lang'] ) ) {
global $wgLang, $wgLanguageCode;
$this->setVar( '_UserLang', $options['lang'] );
$wgLanguageCode = $options['lang'];
$this->setVar( 'wgLanguageCode', $wgLanguageCode );
$wgLang = MediaWikiServices::getInstance()->getLanguageFactory()
->getLanguage( $options['lang'] );
RequestContext::getMain()->setLanguage( $wgLang );
}
$this->setVar( 'wgSitename', $siteName );
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$metaNS = $contLang->ucfirst( str_replace( ' ', '_', $siteName ) );
if ( $metaNS == 'MediaWiki' ) {
$metaNS = 'Project';
}
$this->setVar( 'wgMetaNamespace', $metaNS );
if ( !isset( $options['installdbuser'] ) ) {
$this->setVar( '_InstallUser',
$this->getVar( 'wgDBuser' ) );
$this->setVar( '_InstallPassword',
$this->getVar( 'wgDBpassword' ) );
} else {
$this->setVar( '_InstallUser',
$options['installdbuser'] );
$this->setVar( '_InstallPassword',
$options['installdbpass'] ?? "" );
// Assume that if we're given the installer user, we'll create the account.
$this->setVar( '_CreateDBAccount', true );
}
if ( $admin ) {
$this->setVar( '_AdminName', $admin );
if ( isset( $options['pass'] ) ) {
$adminUser = User::newFromName( $admin );
if ( !$adminUser ) {
throw new InstallException( Status::newFatal( 'config-admin-name-invalid' ) );
}
$upp = new UserPasswordPolicy(
$wgPasswordPolicy['policies'],
$wgPasswordPolicy['checks']
);
$status = $upp->checkUserPasswordForGroups( $adminUser, $options['pass'],
[ 'bureaucrat', 'sysop', 'interface-admin' ] ); // per Installer::createSysop()
if ( !$status->isGood() ) {
throw new InstallException( Status::newFatal(
$status->getMessage( 'config-admin-error-password-invalid' ) ) );
}
$this->setVar( '_AdminPassword', $options['pass'] );
}
}
// Detect and inject any extension found
if ( isset( $options['extensions'] ) ) {
$status = $this->validateExtensions(
'extension', 'extensions', $options['extensions'] );
if ( !$status->isOK() ) {
throw new InstallException( $status );
}
$this->setVar( '_Extensions', $status->value );
} elseif ( isset( $options['with-extensions'] ) ) {
$status = $this->findExtensions();
if ( !$status->isOK() ) {
throw new InstallException( $status );
}
$this->setVar( '_Extensions', array_keys( $status->value ) );
}
// Set up the default skins
if ( isset( $options['skins'] ) ) {
$status = $this->validateExtensions( 'skin', 'skins', $options['skins'] );
if ( !$status->isOK() ) {
throw new InstallException( $status );
}
$skins = $status->value;
} else {
$status = $this->findExtensions( 'skins' );
if ( !$status->isOK() ) {
throw new InstallException( $status );
}
$skins = array_keys( $status->value );
}
$this->setVar( '_Skins', $skins );
if ( $skins ) {
$skinNames = array_map( 'strtolower', $skins );
$this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
}
$this->setVar( '_WithDevelopmentSettings', isset( $options['with-developmentsettings'] ) );
}
private function validateExtensions( $type, $directory, $nameLists ) {
$extensions = [];
$status = new Status;
foreach ( (array)$nameLists as $nameList ) {
foreach ( explode( ',', $nameList ) as $name ) {
$name = trim( $name );
if ( $name === '' ) {
continue;
}
$extStatus = $this->getExtensionInfo( $type, $directory, $name );
if ( $extStatus->isOK() ) {
$extensions[] = $name;
} else {
$status->merge( $extStatus );
}
}
}
$extensions = array_unique( $extensions );
$status->value = $extensions;
return $status;
}
/**
* Main entry point.
* @return Status
*/
public function execute() {
// If APC is available, use that as the MainCacheType, instead of nothing.
// This is hacky and should be consolidated with WebInstallerOptions.
// This is here instead of in __construct(), because it should run after
// doEnvironmentChecks(), which populates '_Caches'.
if ( count( $this->getVar( '_Caches' ) ) ) {
// We detected a CACHE_ACCEL implementation, use it.
$this->setVar( '_MainCacheType', 'accel' );
}
$vars = Installer::getExistingLocalSettings();
if ( $vars ) {
$status = Status::newFatal( "config-localsettings-cli-upgrade" );
$this->showStatusMessage( $status );
return $status;
}
$result = $this->performInstallation(
[ $this, 'startStage' ],
[ $this, 'endStage' ]
);
// PerformInstallation bails on a fatal, so make sure the last item
// completed before giving 'next.' Likewise, only provide back on failure
$lastStepStatus = end( $result );
if ( $lastStepStatus->isOK() ) {
return Status::newGood();
} else {
return $lastStepStatus;
}
}
/**
* Write LocalSettings.php to a given path
*
* @param string $path Full path to write LocalSettings.php to
*/
public function writeConfigurationFile( $path ) {
$ls = InstallerOverrides::getLocalSettingsGenerator( $this );
$ls->writeFile( "$path/LocalSettings.php" );
}
public function startStage( $step ) {
// Messages: config-install-database, config-install-tables, config-install-interwiki,
// config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
// config-install-extensions
$this->showMessage( "config-install-$step" );
}
public function endStage( $step, $status ) {
$this->showStatusMessage( $status );
if ( $status->isOK() ) {
$this->showMessage( 'config-install-step-done' );
} else {
$this->showError( 'config-install-step-failed' );
}
}
public function showMessage( $msg, ...$params ) {
// @phan-suppress-next-line SecurityCheck-XSS
echo $this->getMessageText( $msg, $params ) . "\n";
flush();
}
public function showSuccess( $msg, ...$params ) {
// @phan-suppress-next-line SecurityCheck-XSS
echo $this->getMessageText( $msg, $params ) . "\n";
flush();
}
public function showWarning( $msg, ...$params ) {
// @phan-suppress-next-line SecurityCheck-XSS
echo $this->getMessageText( $msg, $params ) . "\n";
flush();
}
public function showError( $msg, ...$params ) {
// @phan-suppress-next-line SecurityCheck-XSS
echo "***{$this->getMessageText( $msg, $params )}***\n";
flush();
}
/**
* @param string|MessageSpecifier $msg
* @param array $params
* @return string
*/
protected function getMessageText( $msg, $params ) {
$text = wfMessage( $msg, $params )->parse();
$text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 <$1>', $text );
return Sanitizer::stripAllTags( $text );
}
/**
* Dummy
* @param string $msg Key for wfMessage()
* @param mixed ...$params
*/
public function showHelpBox( $msg, ...$params ) {
}
public function showStatusMessage( Status $status ) {
// Show errors at the end in CLI installer to make them easier to notice
foreach ( $status->getMessages( 'warning' ) as $msg ) {
$this->showMessage( $msg );
}
foreach ( $status->getMessages( 'error' ) as $msg ) {
$this->showMessage( $msg );
}
}
public function envCheckPath() {
if ( !$this->specifiedScriptPath ) {
$this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
}
return parent::envCheckPath();
}
protected function envGetDefaultServer() {
// Use a basic value if the user didn't pass in --server
return 'http://localhost';
}
public function dirIsExecutable( $dir, $url ) {
$this->showMessage( 'config-no-cli-uploads-check', $dir );
return false;
}
}
|