3 * Core installer command line interface.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\Installer\InstallException
;
25 use MediaWiki\MediaWikiServices
;
28 * Class for the core installer command line interface.
33 class CliInstaller
extends Installer
{
34 private $specifiedScriptPath = false;
36 private $optionMap = [
37 'dbtype' => 'wgDBtype',
38 'dbserver' => 'wgDBserver',
39 'dbname' => 'wgDBname',
40 'dbuser' => 'wgDBuser',
41 'dbpass' => 'wgDBpassword',
42 'dbprefix' => 'wgDBprefix',
43 'dbtableoptions' => 'wgDBTableOptions',
44 'dbport' => 'wgDBport',
45 'dbschema' => 'wgDBmwschema',
46 'dbpath' => 'wgSQLiteDataDir',
47 'server' => 'wgServer',
48 'scriptpath' => 'wgScriptPath',
52 * @param string $siteName
53 * @param string|null $admin
54 * @param array $options
55 * @throws InstallException
57 function __construct( $siteName, $admin = null, array $options = [] ) {
60 parent
::__construct();
62 if ( isset( $options['scriptpath'] ) ) {
63 $this->specifiedScriptPath
= true;
66 foreach ( $this->optionMap
as $opt => $global ) {
67 if ( isset( $options[$opt] ) ) {
68 $GLOBALS[$global] = $options[$opt];
69 $this->setVar( $global, $options[$opt] );
73 if ( isset( $options['lang'] ) ) {
74 global $wgLang, $wgLanguageCode;
75 $this->setVar( '_UserLang', $options['lang'] );
76 $wgLanguageCode = $options['lang'];
77 $this->setVar( 'wgLanguageCode', $wgLanguageCode );
78 $wgContLang = MediaWikiServices
::getInstance()->getContentLanguage();
79 $wgLang = Language
::factory( $options['lang'] );
80 RequestContext
::getMain()->setLanguage( $wgLang );
83 $this->setVar( 'wgSitename', $siteName );
85 $metaNS = $wgContLang->ucfirst( str_replace( ' ', '_', $siteName ) );
86 if ( $metaNS == 'MediaWiki' ) {
89 $this->setVar( 'wgMetaNamespace', $metaNS );
92 $this->setVar( '_AdminName', $admin );
95 if ( !isset( $options['installdbuser'] ) ) {
96 $this->setVar( '_InstallUser',
97 $this->getVar( 'wgDBuser' ) );
98 $this->setVar( '_InstallPassword',
99 $this->getVar( 'wgDBpassword' ) );
101 $this->setVar( '_InstallUser',
102 $options['installdbuser'] );
103 $this->setVar( '_InstallPassword',
104 $options['installdbpass'] ??
"" );
106 // Assume that if we're given the installer user, we'll create the account.
107 $this->setVar( '_CreateDBAccount', true );
110 if ( isset( $options['pass'] ) ) {
111 $this->setVar( '_AdminPassword', $options['pass'] );
114 // Detect and inject any extension found
115 if ( isset( $options['extensions'] ) ) {
116 $status = $this->validateExtensions(
117 'extension', 'extensions', $options['extensions'] );
118 if ( !$status->isOK() ) {
119 throw new InstallException( $status );
121 $this->setVar( '_Extensions', $status->value
);
122 } elseif ( isset( $options['with-extensions'] ) ) {
123 $status = $this->findExtensions();
124 if ( !$status->isOK() ) {
125 throw new InstallException( $status );
127 $this->setVar( '_Extensions', array_keys( $status->value
) );
130 // Set up the default skins
131 if ( isset( $options['skins'] ) ) {
132 $status = $this->validateExtensions( 'skin', 'skins', $options['skins'] );
133 if ( !$status->isOK() ) {
134 throw new InstallException( $status );
136 $skins = $status->value
;
138 $status = $this->findExtensions( 'skins' );
139 if ( !$status->isOK() ) {
140 throw new InstallException( $status );
142 $skins = array_keys( $status->value
);
144 $this->setVar( '_Skins', $skins );
147 $skinNames = array_map( 'strtolower', $skins );
148 $this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
152 private function validateExtensions( $type, $directory, $nameLists ) {
154 $status = new Status
;
155 foreach ( (array)$nameLists as $nameList ) {
156 foreach ( explode( ',', $nameList ) as $name ) {
157 $name = trim( $name );
158 if ( $name === '' ) {
161 $extStatus = $this->getExtensionInfo( $type, $directory, $name );
162 if ( $extStatus->isOK() ) {
163 $extensions[] = $name;
165 $status->merge( $extStatus );
169 $extensions = array_unique( $extensions );
170 $status->value
= $extensions;
177 public function execute() {
178 // If APC is available, use that as the MainCacheType, instead of nothing.
179 // This is hacky and should be consolidated with WebInstallerOptions.
180 // This is here instead of in __construct(), because it should run run after
181 // doEnvironmentChecks(), which populates '_Caches'.
182 if ( count( $this->getVar( '_Caches' ) ) ) {
183 // We detected a CACHE_ACCEL implementation, use it.
184 $this->setVar( '_MainCacheType', 'accel' );
187 $vars = Installer
::getExistingLocalSettings();
189 $status = Status
::newFatal( "config-localsettings-cli-upgrade" );
190 $this->showStatusMessage( $status );
194 $result = $this->performInstallation(
195 [ $this, 'startStage' ],
196 [ $this, 'endStage' ]
198 // PerformInstallation bails on a fatal, so make sure the last item
199 // completed before giving 'next.' Likewise, only provide back on failure
200 $lastStepStatus = end( $result );
201 if ( $lastStepStatus->isOK() ) {
202 return Status
::newGood();
204 return $lastStepStatus;
209 * Write LocalSettings.php to a given path
211 * @param string $path Full path to write LocalSettings.php to
213 public function writeConfigurationFile( $path ) {
214 $ls = InstallerOverrides
::getLocalSettingsGenerator( $this );
215 $ls->writeFile( "$path/LocalSettings.php" );
218 public function startStage( $step ) {
219 // Messages: config-install-database, config-install-tables, config-install-interwiki,
220 // config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
221 // config-install-extensions
222 $this->showMessage( "config-install-$step" );
225 public function endStage( $step, $status ) {
226 $this->showStatusMessage( $status );
227 $this->showMessage( 'config-install-step-done' );
230 public function showMessage( $msg, ...$params ) {
231 echo $this->getMessageText( $msg, $params ) . "\n";
235 public function showError( $msg, ...$params ) {
236 echo "***{$this->getMessageText( $msg, $params )}***\n";
242 * @param array $params
246 protected function getMessageText( $msg, $params ) {
247 $text = wfMessage( $msg, $params )->parse();
249 $text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 <$1>', $text );
251 return Sanitizer
::stripAllTags( $text );
257 public function showHelpBox( $msg /*, ... */ ) {
260 public function showStatusMessage( Status
$status ) {
261 $warnings = array_merge( $status->getWarningsArray(),
262 $status->getErrorsArray() );
264 if ( count( $warnings ) !== 0 ) {
265 foreach ( $warnings as $w ) {
266 $this->showMessage( ...$w );
271 public function envCheckPath() {
272 if ( !$this->specifiedScriptPath
) {
273 $this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
276 return parent
::envCheckPath();
279 protected function envGetDefaultServer() {
280 return null; // Do not guess if installing from CLI
283 public function dirIsExecutable( $dir, $url ) {
284 $this->showMessage( 'config-no-cli-uploads-check', $dir );