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
  64                 $this->addOption( 'lang', 'The language to use (en)', false, true );
  65                 /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
  66
  67                 $this->addOption( 'dbtype', 'The type of database (mysql)', false, true );
  68                 $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
  69                 $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
  70                 $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
  71                 $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
  72                 $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
  73                 $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
  74                 $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
  75                 $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
  76                 $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
  77                 $this->addOption(
  78                         'dbpassfile',
  79                         'An alternative way to provide dbpass option, as the contents of this file',
  80                         false,
  81                         true
  82                 );
  83                 $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
  84                 $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in '
  85                         . 'PostgreSQL/Microsoft SQL Server (mediawiki)', false, true );
  86                 /*
  87                 $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)',
  88                         false, true );
  89                 */
  90                 $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
  91         }
  92
  93         public function getDbType() {
  94                 if ( $this->hasOption( 'env-checks' ) ) {
  95                         return Maintenance::DB_NONE;
  96                 }
  97                 return parent::getDbType();
  98         }
  99
 100         function execute() {
 101                 global $IP;
 102
 103                 $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
 104                 $adminName = $this->getArg( 1 );
 105                 $envChecksOnly = $this->hasOption( 'env-checks' );
 106
 107                 $this->setDbPassOption();
 108                 if ( !$envChecksOnly ) {
 109                         $this->setPassOption();
 110                 }
 111
 112                 $installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
 113
 114                 $status = $installer->doEnvironmentChecks();
 115                 if ( $status->isGood() ) {
 116                         $installer->showMessage( 'config-env-good' );
 117                 } else {
 118                         $installer->showStatusMessage( $status );
 119
 120                         return;
 121                 }
 122                 if ( !$envChecksOnly ) {
 123                         $installer->execute();
 124                         $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
 125                 }
 126         }
 127
 128         private function setDbPassOption() {
 129                 $dbpassfile = $this->getOption( 'dbpassfile' );
 130                 if ( $dbpassfile !== null ) {
 131                         if ( $this->getOption( 'dbpass' ) !== null ) {
 132                                 $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
 133                                         . 'The content of "dbpassfile" overrides "dbpass".' );
 134                         }
 135                         MediaWiki\suppressWarnings();
 136                         $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
 137                         MediaWiki\restoreWarnings();
 138                         if ( $dbpass === false ) {
 139                                 $this->error( "Couldn't open $dbpassfile", true );
 140                         }
 141                         $this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
 142                 }
 143         }
 144
 145         private function setPassOption() {
 146                 $passfile = $this->getOption( 'passfile' );
 147                 if ( $passfile !== null ) {
 148                         if ( $this->getOption( 'pass' ) !== null ) {
 149                                 $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
 150                                         . 'The content of "passfile" overrides "pass".' );
 151                         }
 152                         MediaWiki\suppressWarnings();
 153                         $pass = file_get_contents( $passfile ); // returns false on failure
 154                         MediaWiki\restoreWarnings();
 155                         if ( $pass === false ) {
 156                                 $this->error( "Couldn't open $passfile", true );
 157                         }
 158                         $this->mOptions['pass'] = trim( $pass, "\r\n" );
 159                 } elseif ( $this->getOption( 'pass' ) === null ) {
 160                         $this->error( 'You need to provide the option "pass" or "passfile"', true );
 161                 }
 162         }
 163
 164         function validateParamsAndArgs() {
 165                 if ( !$this->hasOption( 'env-checks' ) ) {
 166                         parent::validateParamsAndArgs();
 167                 }
 168         }
 169 }
 170
 171 $maintClass = 'CommandLineInstaller';
 172
 173 require_once RUN_MAINTENANCE_IF_MAIN;