includes/installer/CliInstaller.php

   1 <?php
   2 /**
   3  * Core installer command line interface.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Deployment
  22  */
  23
  24 use MediaWiki\Installer\InstallException;
  25 use MediaWiki\MediaWikiServices;
  26
  27 /**
  28  * Class for the core installer command line interface.
  29  *
  30  * @ingroup Deployment
  31  * @since 1.17
  32  */
  33 class CliInstaller extends Installer {
  34         private $specifiedScriptPath = false;
  35
  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',
  49         ];
  50
  51         /**
  52          * @param string $siteName
  53          * @param string|null $admin
  54          * @param array $options
  55          * @throws InstallException
  56          */
  57         function __construct( $siteName, $admin = null, array $options = [] ) {
  58                 global $wgContLang;
  59
  60                 parent::__construct();
  61
  62                 if ( isset( $options['scriptpath'] ) ) {
  63                         $this->specifiedScriptPath = true;
  64                 }
  65
  66                 foreach ( $this->optionMap as $opt => $global ) {
  67                         if ( isset( $options[$opt] ) ) {
  68                                 $GLOBALS[$global] = $options[$opt];
  69                                 $this->setVar( $global, $options[$opt] );
  70                         }
  71                 }
  72
  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 );
  81                 }
  82
  83                 $this->setVar( 'wgSitename', $siteName );
  84
  85                 $metaNS = $wgContLang->ucfirst( str_replace( ' ', '_', $siteName ) );
  86                 if ( $metaNS == 'MediaWiki' ) {
  87                         $metaNS = 'Project';
  88                 }
  89                 $this->setVar( 'wgMetaNamespace', $metaNS );
  90
  91                 if ( $admin ) {
  92                         $this->setVar( '_AdminName', $admin );
  93                 }
  94
  95                 if ( !isset( $options['installdbuser'] ) ) {
  96                         $this->setVar( '_InstallUser',
  97                                 $this->getVar( 'wgDBuser' ) );
  98                         $this->setVar( '_InstallPassword',
  99                                 $this->getVar( 'wgDBpassword' ) );
 100                 } else {
 101                         $this->setVar( '_InstallUser',
 102                                 $options['installdbuser'] );
 103                         $this->setVar( '_InstallPassword',
 104                                 $options['installdbpass'] ?? "" );
 105
 106                         // Assume that if we're given the installer user, we'll create the account.
 107                         $this->setVar( '_CreateDBAccount', true );
 108                 }
 109
 110                 if ( isset( $options['pass'] ) ) {
 111                         $this->setVar( '_AdminPassword', $options['pass'] );
 112                 }
 113
 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 );
 120                         }
 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 );
 126                         }
 127                         $this->setVar( '_Extensions', array_keys( $status->value ) );
 128                 }
 129
 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 );
 135                         }
 136                         $skins = $status->value;
 137                 } else {
 138                         $status = $this->findExtensions( 'skins' );
 139                         if ( !$status->isOK() ) {
 140                                 throw new InstallException( $status );
 141                         }
 142                         $skins = array_keys( $status->value );
 143                 }
 144                 $this->setVar( '_Skins', $skins );
 145
 146                 if ( $skins ) {
 147                         $skinNames = array_map( 'strtolower', $skins );
 148                         $this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
 149                 }
 150         }
 151
 152         private function validateExtensions( $type, $directory, $nameLists ) {
 153                 $extensions = [];
 154                 $status = new Status;
 155                 foreach ( (array)$nameLists as $nameList ) {
 156                         foreach ( explode( ',', $nameList ) as $name ) {
 157                                 $name = trim( $name );
 158                                 if ( $name === '' ) {
 159                                         continue;
 160                                 }
 161                                 $extStatus = $this->getExtensionInfo( $type, $directory, $name );
 162                                 if ( $extStatus->isOK() ) {
 163                                         $extensions[] = $name;
 164                                 } else {
 165                                         $status->merge( $extStatus );
 166                                 }
 167                         }
 168                 }
 169                 $extensions = array_unique( $extensions );
 170                 $status->value = $extensions;
 171                 return $status;
 172         }
 173
 174         /**
 175          * Main entry point.
 176          */
 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' );
 185                 }
 186
 187                 $vars = Installer::getExistingLocalSettings();
 188                 if ( $vars ) {
 189                         $status = Status::newFatal( "config-localsettings-cli-upgrade" );
 190                         $this->showStatusMessage( $status );
 191                         return $status;
 192                 }
 193
 194                 $result = $this->performInstallation(
 195                         [ $this, 'startStage' ],
 196                         [ $this, 'endStage' ]
 197                 );
 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();
 203                 } else {
 204                         return $lastStepStatus;
 205                 }
 206         }
 207
 208         /**
 209          * Write LocalSettings.php to a given path
 210          *
 211          * @param string $path Full path to write LocalSettings.php to
 212          */
 213         public function writeConfigurationFile( $path ) {
 214                 $ls = InstallerOverrides::getLocalSettingsGenerator( $this );
 215                 $ls->writeFile( "$path/LocalSettings.php" );
 216         }
 217
 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" );
 223         }
 224
 225         public function endStage( $step, $status ) {
 226                 $this->showStatusMessage( $status );
 227                 $this->showMessage( 'config-install-step-done' );
 228         }
 229
 230         public function showMessage( $msg, ...$params ) {
 231                 echo $this->getMessageText( $msg, $params ) . "\n";
 232                 flush();
 233         }
 234
 235         public function showError( $msg, ...$params ) {
 236                 echo "***{$this->getMessageText( $msg, $params )}***\n";
 237                 flush();
 238         }
 239
 240         /**
 241          * @param string $msg
 242          * @param array $params
 243          *
 244          * @return string
 245          */
 246         protected function getMessageText( $msg, $params ) {
 247                 $text = wfMessage( $msg, $params )->parse();
 248
 249                 $text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 &lt;$1&gt;', $text );
 250
 251                 return Sanitizer::stripAllTags( $text );
 252         }
 253
 254         /**
 255          * Dummy
 256          */
 257         public function showHelpBox( $msg /*, ... */ ) {
 258         }
 259
 260         public function showStatusMessage( Status $status ) {
 261                 $warnings = array_merge( $status->getWarningsArray(),
 262                         $status->getErrorsArray() );
 263
 264                 if ( count( $warnings ) !== 0 ) {
 265                         foreach ( $warnings as $w ) {
 266                                 $this->showMessage( ...$w );
 267                         }
 268                 }
 269         }
 270
 271         public function envCheckPath() {
 272                 if ( !$this->specifiedScriptPath ) {
 273                         $this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
 274                 }
 275
 276                 return parent::envCheckPath();
 277         }
 278
 279         protected function envGetDefaultServer() {
 280                 // Use a basic value if the user didn't pass in --server
 281                 return 'http://localhost';
 282         }
 283
 284         public function dirIsExecutable( $dir, $url ) {
 285                 $this->showMessage( 'config-no-cli-uploads-check', $dir );
 286
 287                 return false;
 288         }
 289 }