3 * CLI-based MediaWiki installation and configuration.
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.
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.
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
21 * @ingroup Maintenance
24 if ( !function_exists( 'version_compare' ) ||
( version_compare( PHP_VERSION
, '5.3.2' ) < 0 ) ) {
25 require_once dirname( __FILE__
) . '/../includes/PHPVersionError.php';
26 wfPHPVersionError( 'cli' );
29 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
30 define( 'MEDIAWIKI_INSTALL', true );
32 require_once dirname( __DIR__
) . '/maintenance/Maintenance.php';
35 * Maintenance script to install and configure MediaWiki
37 * Default values for the options are defined in DefaultSettings.php
38 * (see the mapping in CliInstaller.php)
39 * Default for --dbpath (SQLite-specific) is defined in SqliteInstaller::getGlobalDefaults
41 * @ingroup Maintenance
43 class CommandLineInstaller
extends Maintenance
{
44 function __construct() {
45 parent
::__construct();
48 $this->addDescription( "CLI-based MediaWiki installation and configuration.\n" .
49 "Defaut options are indicated in parenthesis." );
51 $this->addArg( 'name', 'The name of the wiki (MediaWiki)', false );
53 $this->addArg( 'admin', 'The username of the wiki administrator.' );
54 $this->addOption( 'pass', 'The password for the wiki administrator.', false, true );
57 'An alternative way to provide pass option, as the contents of this file',
61 /* $this->addOption( 'email', 'The email for the wiki administrator', false, true ); */
64 'The relative path of the wiki in the web server (/wiki)',
69 $this->addOption( 'lang', 'The language to use (en)', false, true );
70 /* $this->addOption( 'cont-lang', 'The content language (en)', false, true ); */
72 $this->addOption( 'dbtype', 'The type of database (mysql)', false, true );
73 $this->addOption( 'dbserver', 'The database host (localhost)', false, true );
74 $this->addOption( 'dbport', 'The database port; only for PostgreSQL (5432)', false, true );
75 $this->addOption( 'dbname', 'The database name (my_wiki)', false, true );
76 $this->addOption( 'dbpath', 'The path for the SQLite DB ($IP/data)', false, true );
77 $this->addOption( 'dbprefix', 'Optional database table name prefix', false, true );
78 $this->addOption( 'installdbuser', 'The user to use for installing (root)', false, true );
79 $this->addOption( 'installdbpass', 'The password for the DB user to install as.', false, true );
80 $this->addOption( 'dbuser', 'The user to use for normal operations (wikiuser)', false, true );
81 $this->addOption( 'dbpass', 'The password for the DB user for normal operations', false, true );
84 'An alternative way to provide dbpass option, as the contents of this file',
88 $this->addOption( 'confpath', "Path to write LocalSettings.php to ($IP)", false, true );
89 $this->addOption( 'dbschema', 'The schema for the MediaWiki DB in '
90 . 'PostgreSQL/Microsoft SQL Server (mediawiki)', false, true );
92 $this->addOption( 'namespace', 'The project namespace (same as the "name" argument)',
95 $this->addOption( 'env-checks', "Run environment checks only, don't change anything" );
101 $siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
102 $adminName = $this->getArg( 1 );
104 $dbpassfile = $this->getOption( 'dbpassfile' );
105 if ( $dbpassfile !== null ) {
106 if ( $this->getOption( 'dbpass' ) !== null ) {
107 $this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
108 . 'The content of "dbpassfile" overrides "dbpass".' );
110 wfSuppressWarnings();
111 $dbpass = file_get_contents( $dbpassfile ); // returns false on failure
113 if ( $dbpass === false ) {
114 $this->error( "Couldn't open $dbpassfile", true );
116 $this->mOptions
['dbpass'] = trim( $dbpass, "\r\n" );
119 $passfile = $this->getOption( 'passfile' );
120 if ( $passfile !== null ) {
121 if ( $this->getOption( 'pass' ) !== null ) {
122 $this->error( 'WARNING: You have provided the options "pass" and "passfile". '
123 . 'The content of "passfile" overrides "pass".' );
125 wfSuppressWarnings();
126 $pass = file_get_contents( $passfile ); // returns false on failure
128 if ( $pass === false ) {
129 $this->error( "Couldn't open $passfile", true );
131 $this->mOptions
['pass'] = trim( $pass, "\r\n" );
132 } elseif ( $this->getOption( 'pass' ) === null ) {
133 $this->error( 'You need to provide the option "pass" or "passfile"', true );
136 $installer = InstallerOverrides
::getCliInstaller( $siteName, $adminName, $this->mOptions
);
138 $status = $installer->doEnvironmentChecks();
139 if ( $status->isGood() ) {
140 $installer->showMessage( 'config-env-good' );
142 $installer->showStatusMessage( $status );
146 if ( !$this->hasOption( 'env-checks' ) ) {
147 $installer->execute();
148 $installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
152 function validateParamsAndArgs() {
153 if ( !$this->hasOption( 'env-checks' ) ) {
154 parent
::validateParamsAndArgs();
159 $maintClass = 'CommandLineInstaller';
161 require_once RUN_MAINTENANCE_IF_MAIN
;