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 if ( !function_exists( 'version_compare' ) || ( version_compare( phpversion(), '5.3.2' ) < 0 ) ) {
  25         require_once dirname( __FILE__ ) . '/../includes/PHPVersionError.php';
  26         wfPHPVersionError( 'cli' );
  27 }
  28
  29 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
  30 define( 'MEDIAWIKI_INSTALL', true );
  31
  32 require_once dirname( __DIR__ ) . '/maintenance/Maintenance.php';
  33
  34 /**
  35  * Maintenance script to install and configure MediaWiki
  36  *
  37  * Default values for the options are defined in DefaultSettings.php (see the mapping in CliInstaller.php)
  38  * Default for --dbpath (SQLite-specific) is defined in SqliteInstaller::getGlobalDefaults
  39  *
  40  * @ingroup Maintenance
  41  */
  42 class CommandLineInstaller extends Maintenance {
  43         function __construct() {
  44                 parent::__construct();
  45                 global $IP;
  46
  47                 $this->addDescription( "CLI-based MediaWiki installation and configuration.\n" .
  48                         "Defaut options are indicated in parenthesis." );
  49
  50                 $this->addArg( 'name', 'The name of the wiki (MediaWiki)', false );
  51
  52                 $this->addArg( 'admin', 'The username of the wiki administrator.' );
  53                 $this->addOption( 'pass', 'The password for the wiki administrator.', false, true );
  54                 $this->addOption(
  55                         'passfile',
  56                         'An alternative way to provide pass option, as the contents of this file',
  57                         false,
  58                         true
  59                 );
  60                 /* $this->addOption( 'email', 'The email for the wiki administrator', false, true ); */
  61                 $this->addOption(
  62                         'scriptpath',
  63                         'The relative path of the wiki in the web server (/wiki)',
  64                         false,
  65                         true
  66                 );
  67
  68                 $this->addOption( 'lang', 'The language to use (en)', false, true );
  69                 /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
  70
  71                 $this->addOption( 'dbtype', 'The type of database (mysql)', false, true );
  72                 $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
  73                 $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
  74                 $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
  75                 $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
  76                 $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
  77                 $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
  78                 $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
  79                 $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
  80                 $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
  81                 $this->addOption(
  82                         'dbpassfile',
  83                         'An alternative way to provide dbpass option, as the contents of this file',
  84                         false,
  85                         true
  86                 );
  87                 $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
  88                 /*
  89                 $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in pg (mediawiki)', false, true );
  90                 $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)', false, true );
  91                 */
  92                 $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
  93         }
  94
  95         function execute() {
  96                 global $IP;
  97
  98                 $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
  99                 $adminName = $this->getArg( 1 );
 100
 101                 $dbpassfile = $this->getOption( 'dbpassfile' );
 102                 if ( $dbpassfile !== null ) {
 103                         if ( $this->getOption( 'dbpass' ) !== null ) {
 104                                 $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
 105                                         . 'The content of "dbpassfile" overrides "dbpass".' );
 106                         }
 107                         wfSuppressWarnings();
 108                         $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
 109                         wfRestoreWarnings();
 110                         if ( $dbpass === false ) {
 111                                 $this->error( "Couldn't open $dbpassfile", true );
 112                         }
 113                         $this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
 114                 }
 115
 116                 $passfile = $this->getOption( 'passfile' );
 117                 if ( $passfile !== null ) {
 118                         if ( $this->getOption( 'pass' ) !== null ) {
 119                                 $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
 120                                         . 'The content of "passfile" overrides "pass".' );
 121                         }
 122                         wfSuppressWarnings();
 123                         $pass = file_get_contents( $passfile ); // returns false on failure
 124                         wfRestoreWarnings();
 125                         if ( $pass === false ) {
 126                                 $this->error( "Couldn't open $passfile", true );
 127                         }
 128                         $this->mOptions['pass'] = trim( $pass, "\r\n" );
 129                 } elseif ( $this->getOption( 'pass' ) === null ) {
 130                         $this->error( 'You need to provide the option "pass" or "passfile"', true );
 131                 }
 132
 133                 $installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
 134
 135                 $status = $installer->doEnvironmentChecks();
 136                 if ( $status->isGood() ) {
 137                         $installer->showMessage( 'config-env-good' );
 138                 } else {
 139                         $installer->showStatusMessage( $status );
 140
 141                         return;
 142                 }
 143                 if ( !$this->hasOption( 'env-checks' ) ) {
 144                         $installer->execute();
 145                         $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
 146                 }
 147         }
 148
 149         function validateParamsAndArgs() {
 150                 if ( !$this->hasOption( 'env-checks' ) ) {
 151                         parent::validateParamsAndArgs();
 152                 }
 153         }
 154 }
 155
 156 $maintClass = 'CommandLineInstaller';
 157
 158 require_once RUN_MAINTENANCE_IF_MAIN;