maintenance/install.php

   1 <?php
   2 /**
   3  * CLI-based MediaWiki installation and configuration.
   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 Maintenance
  22  */
  23
  24 require_once __DIR__ . '/Maintenance.php';
  25
  26 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
  27 define( 'MEDIAWIKI_INSTALL', true );
  28
  29 /**
  30  * Maintenance script to install and configure MediaWiki
  31  *
  32  * Default values for the options are defined in DefaultSettings.php
  33  * (see the mapping in CliInstaller.php)
  34  * Default for --dbpath (SQLite-specific) is defined in SqliteInstaller::getGlobalDefaults
  35  *
  36  * @ingroup Maintenance
  37  */
  38 class CommandLineInstaller extends Maintenance {
  39         function __construct() {
  40                 parent::__construct();
  41                 global $IP;
  42
  43                 $this->addDescription( "CLI-based MediaWiki installation and configuration.\n" .
  44                         "Default options are indicated in parentheses." );
  45
  46                 $this->addArg( 'name', 'The name of the wiki (MediaWiki)', false );
  47
  48                 $this->addArg( 'admin', 'The username of the wiki administrator.' );
  49                 $this->addOption( 'pass', 'The password for the wiki administrator.', false, true );
  50                 $this->addOption(
  51                         'passfile',
  52                         'An alternative way to provide pass option, as the contents of this file',
  53                         false,
  54                         true
  55                 );
  56                 /* $this->addOption( 'email', 'The email for the wiki administrator', false, true ); */
  57                 $this->addOption(
  58                         'scriptpath',
  59                         'The relative path of the wiki in the web server (/wiki)',
  60                         false,
  61                         true
  62                 );
  63                 $this->addOption(
  64                         'server',
  65                         'The base URL of the web server the wiki will be on (http://localhost)',
  66                         false,
  67                         true
  68                 );
  69
  70                 $this->addOption( 'lang', 'The language to use (en)', false, true );
  71                 /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
  72
  73                 $this->addOption( 'dbtype', 'The type of database (mysql)', false, true );
  74                 $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
  75                 $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
  76                 $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
  77                 $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
  78                 $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
  79                 $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
  80                 $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
  81                 $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
  82                 $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
  83                 $this->addOption(
  84                         'dbpassfile',
  85                         'An alternative way to provide dbpass option, as the contents of this file',
  86                         false,
  87                         true
  88                 );
  89                 $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
  90                 $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in '
  91                         . 'PostgreSQL/Microsoft SQL Server (mediawiki)', false, true );
  92                 /*
  93                 $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)',
  94                         false, true );
  95                 */
  96                 $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
  97
  98                 $this->addOption( 'with-extensions', "Detect and include extensions" );
  99                 $this->addOption( 'extensions', 'Comma-separated list of extensions to install',
 100                         false, true, false, true );
 101                 $this->addOption( 'skins', 'Comma-separated list of skins to install (default: all)',
 102                         false, true, false, true );
 103         }
 104
 105         public function getDbType() {
 106                 if ( $this->hasOption( 'env-checks' ) ) {
 107                         return Maintenance::DB_NONE;
 108                 }
 109                 return parent::getDbType();
 110         }
 111
 112         function execute() {
 113                 global $IP;
 114
 115                 $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
 116                 $adminName = $this->getArg( 1 );
 117                 $envChecksOnly = $this->hasOption( 'env-checks' );
 118
 119                 $this->setDbPassOption();
 120                 if ( !$envChecksOnly ) {
 121                         $this->setPassOption();
 122                 }
 123
 124                 try {
 125                         $installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
 126                 } catch ( \MediaWiki\Installer\InstallException $e ) {
 127                         $this->output( $e->getStatus()->getMessage( false, false, 'en' )->text() . "\n" );
 128                         return false;
 129                 }
 130
 131                 $status = $installer->doEnvironmentChecks();
 132                 if ( $status->isGood() ) {
 133                         $installer->showMessage( 'config-env-good' );
 134                 } else {
 135                         $installer->showStatusMessage( $status );
 136
 137                         return false;
 138                 }
 139                 if ( !$envChecksOnly ) {
 140                         $status = $installer->execute();
 141                         if ( !$status->isGood() ) {
 142                                 $installer->showStatusMessage( $status );
 143
 144                                 return false;
 145                         }
 146                         $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
 147                         $installer->showMessage(
 148                                 'config-install-success',
 149                                 $installer->getVar( 'wgServer' ),
 150                                 $installer->getVar( 'wgScriptPath' )
 151                         );
 152                 }
 153                 return true;
 154         }
 155
 156         private function setDbPassOption() {
 157                 $dbpassfile = $this->getOption( 'dbpassfile' );
 158                 if ( $dbpassfile !== null ) {
 159                         if ( $this->getOption( 'dbpass' ) !== null ) {
 160                                 $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
 161                                         . 'The content of "dbpassfile" overrides "dbpass".' );
 162                         }
 163                         Wikimedia\suppressWarnings();
 164                         $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
 165                         Wikimedia\restoreWarnings();
 166                         if ( $dbpass === false ) {
 167                                 $this->fatalError( "Couldn't open $dbpassfile" );
 168                         }
 169                         $this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
 170                 }
 171         }
 172
 173         private function setPassOption() {
 174                 $passfile = $this->getOption( 'passfile' );
 175                 if ( $passfile !== null ) {
 176                         if ( $this->getOption( 'pass' ) !== null ) {
 177                                 $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
 178                                         . 'The content of "passfile" overrides "pass".' );
 179                         }
 180                         Wikimedia\suppressWarnings();
 181                         $pass = file_get_contents( $passfile ); // returns false on failure
 182                         Wikimedia\restoreWarnings();
 183                         if ( $pass === false ) {
 184                                 $this->fatalError( "Couldn't open $passfile" );
 185                         }
 186                         $this->mOptions['pass'] = trim( $pass, "\r\n" );
 187                 } elseif ( $this->getOption( 'pass' ) === null ) {
 188                         $this->fatalError( 'You need to provide the option "pass" or "passfile"' );
 189                 }
 190         }
 191
 192         function validateParamsAndArgs() {
 193                 if ( !$this->hasOption( 'env-checks' ) ) {
 194                         parent::validateParamsAndArgs();
 195                 }
 196         }
 197 }
 198
 199 $maintClass = CommandLineInstaller::class;
 200
 201 require_once RUN_MAINTENANCE_IF_MAIN;