]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - maintenance/install.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / maintenance / install.php
index 34e3ea85f3a5ebbc95a0b35cc35219dfbf44df99..0b3fc84323b0d8210b1b5ec3aaad7f9deb841e77 100644 (file)
@@ -1,6 +1,7 @@
 <?php
-
 /**
+ * CLI-based MediaWiki installation and configuration.
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
- * @see wfWaitForSlaves()
  */
 
-if ( !function_exists( 'version_compare' ) || ( version_compare( phpversion(), '5.2.3' ) < 0 ) ) {
-       echo "You are using PHP version " . phpversion() . " but MediaWiki needs PHP 5.2.3 or higher. ABORTING.\n" .
-       "Check if you have a newer php executable with a different name, such as php5.\n";
-       die( 1 );
-}
+require_once __DIR__ . '/Maintenance.php';
 
 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
 define( 'MEDIAWIKI_INSTALL', true );
 
-require_once( dirname( dirname( __FILE__ ) )."/maintenance/Maintenance.php" );
-
+/**
+ * Maintenance script to install and configure MediaWiki
+ *
+ * Default values for the options are defined in DefaultSettings.php
+ * (see the mapping in CliInstaller.php)
+ * Default for --dbpath (SQLite-specific) is defined in SqliteInstaller::getGlobalDefaults
+ *
+ * @ingroup Maintenance
+ */
 class CommandLineInstaller extends Maintenance {
        function __construct() {
                parent::__construct();
                global $IP;
 
-               $this->addArg( 'name', 'The name of the wiki', true);
+               $this->addDescription( "CLI-based MediaWiki installation and configuration.\n" .
+                       "Default options are indicated in parentheses." );
+
+               $this->addArg( 'name', 'The name of the wiki (MediaWiki)', false );
 
-               $this->addArg( 'admin', 'The username of the wiki administrator (WikiSysop)', true );
-               $this->addOption( 'pass', 'The password for the wiki administrator. You will be prompted for this if it isn\'t provided', false, true );
-               $this->addOption( 'email', 'The email for the wiki administrator', false, true );
-               $this->addOption( 'scriptpath', 'The relative path of the wiki in the web server (/wiki)', false, true );
+               $this->addArg( 'admin', 'The username of the wiki administrator.' );
+               $this->addOption( 'pass', 'The password for the wiki administrator.', false, true );
+               $this->addOption(
+                       'passfile',
+                       'An alternative way to provide pass option, as the contents of this file',
+                       false,
+                       true
+               );
+               /* $this->addOption( 'email', 'The email for the wiki administrator', false, true ); */
+               $this->addOption(
+                       'scriptpath',
+                       'The relative path of the wiki in the web server (/wiki)',
+                       false,
+                       true
+               );
 
                $this->addOption( 'lang', 'The language to use (en)', false, true );
                /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
@@ -50,39 +68,101 @@ class CommandLineInstaller extends Maintenance {
                $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
                $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
                $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
-               $this->addOption( 'dbpath', 'The path for the SQLite DB (/var/data)', false, true );
+               $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
+               $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
                $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
-               $this->addOption( 'installdbpass', 'The pasword for the DB user to install as.', false, true );
+               $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
                $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
-               $this->addOption( 'dbpass', 'The pasword for the DB user for normal operations', false, true );
-               $this->addOption( 'confpath', "Path to write LocalSettings.php to, default $IP", false, true );
-               /* $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in pg (mediawiki)', false, true ); */
-               /* $this->addOption( 'namespace', 'The project namespace (same as the name)', false, true ); */
+               $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
+               $this->addOption(
+                       'dbpassfile',
+                       'An alternative way to provide dbpass option, as the contents of this file',
+                       false,
+                       true
+               );
+               $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
+               $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in '
+                       . 'PostgreSQL/Microsoft SQL Server (mediawiki)', false, true );
+               /*
+               $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)',
+                       false, true );
+               */
                $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
+
+               $this->addOption( 'with-extensions', "Detect and include extensions" );
+       }
+
+       public function getDbType() {
+               if ( $this->hasOption( 'env-checks' ) ) {
+                       return Maintenance::DB_NONE;
+               }
+               return parent::getDbType();
        }
 
        function execute() {
-               global $IP, $wgTitle;
-               $siteName = isset( $this->mArgs[0] ) ? $this->mArgs[0] : "Don't care"; // Will not be set if used with --env-checks
-               $adminName = isset( $this->mArgs[1] ) ? $this->mArgs[1] : null;
-               $wgTitle = Title::newFromText( 'Installer script' );
+               global $IP;
+
+               $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
+               $adminName = $this->getArg( 1 );
+               $envChecksOnly = $this->hasOption( 'env-checks' );
 
-               $installer =
-                       new CliInstaller( $siteName, $adminName, $this->mOptions );
+               $this->setDbPassOption();
+               if ( !$envChecksOnly ) {
+                       $this->setPassOption();
+               }
+
+               $installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
 
                $status = $installer->doEnvironmentChecks();
-               if( $status->isGood() ) {
+               if ( $status->isGood() ) {
                        $installer->showMessage( 'config-env-good' );
                } else {
                        $installer->showStatusMessage( $status );
+
                        return;
                }
-               if( !$this->hasOption( 'env-checks' ) ) {
+               if ( !$envChecksOnly ) {
                        $installer->execute();
                        $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
                }
        }
 
+       private function setDbPassOption() {
+               $dbpassfile = $this->getOption( 'dbpassfile' );
+               if ( $dbpassfile !== null ) {
+                       if ( $this->getOption( 'dbpass' ) !== null ) {
+                               $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
+                                       . 'The content of "dbpassfile" overrides "dbpass".' );
+                       }
+                       MediaWiki\suppressWarnings();
+                       $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
+                       MediaWiki\restoreWarnings();
+                       if ( $dbpass === false ) {
+                               $this->error( "Couldn't open $dbpassfile", true );
+                       }
+                       $this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
+               }
+       }
+
+       private function setPassOption() {
+               $passfile = $this->getOption( 'passfile' );
+               if ( $passfile !== null ) {
+                       if ( $this->getOption( 'pass' ) !== null ) {
+                               $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
+                                       . 'The content of "passfile" overrides "pass".' );
+                       }
+                       MediaWiki\suppressWarnings();
+                       $pass = file_get_contents( $passfile ); // returns false on failure
+                       MediaWiki\restoreWarnings();
+                       if ( $pass === false ) {
+                               $this->error( "Couldn't open $passfile", true );
+                       }
+                       $this->mOptions['pass'] = trim( $pass, "\r\n" );
+               } elseif ( $this->getOption( 'pass' ) === null ) {
+                       $this->error( 'You need to provide the option "pass" or "passfile"', true );
+               }
+       }
+
        function validateParamsAndArgs() {
                if ( !$this->hasOption( 'env-checks' ) ) {
                        parent::validateParamsAndArgs();
@@ -90,6 +170,6 @@ class CommandLineInstaller extends Maintenance {
        }
 }
 
-$maintClass = "CommandLineInstaller";
+$maintClass = 'CommandLineInstaller';
 
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;