CommandLineInstaller::__construct()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 53
Code Lines 38

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 38
nc 1
nop 0
dl 0
loc 53
rs 9.5797
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 26 and the first side effect is on line 24.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
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
	function execute() {
94
		global $IP;
95
96
		$siteName = $this->getArg( 0, 'MediaWiki' ); // Will not be set if used with --env-checks
97
		$adminName = $this->getArg( 1 );
98
99
		$dbpassfile = $this->getOption( 'dbpassfile' );
100
		if ( $dbpassfile !== null ) {
101
			if ( $this->getOption( 'dbpass' ) !== null ) {
102
				$this->error( 'WARNING: You have provided the options "dbpass" and "dbpassfile". '
103
					. 'The content of "dbpassfile" overrides "dbpass".' );
104
			}
105
			MediaWiki\suppressWarnings();
106
			$dbpass = file_get_contents( $dbpassfile ); // returns false on failure
107
			MediaWiki\restoreWarnings();
108
			if ( $dbpass === false ) {
109
				$this->error( "Couldn't open $dbpassfile", true );
110
			}
111
			$this->mOptions['dbpass'] = trim( $dbpass, "\r\n" );
112
		}
113
114
		$passfile = $this->getOption( 'passfile' );
115
		if ( $passfile !== null ) {
116
			if ( $this->getOption( 'pass' ) !== null ) {
117
				$this->error( 'WARNING: You have provided the options "pass" and "passfile". '
118
					. 'The content of "passfile" overrides "pass".' );
119
			}
120
			MediaWiki\suppressWarnings();
121
			$pass = file_get_contents( $passfile ); // returns false on failure
122
			MediaWiki\restoreWarnings();
123
			if ( $pass === false ) {
124
				$this->error( "Couldn't open $passfile", true );
125
			}
126
			$this->mOptions['pass'] = trim( $pass, "\r\n" );
127
		} elseif ( $this->getOption( 'pass' ) === null ) {
128
			$this->error( 'You need to provide the option "pass" or "passfile"', true );
129
		}
130
131
		$installer = InstallerOverrides::getCliInstaller( $siteName, $adminName, $this->mOptions );
132
133
		$status = $installer->doEnvironmentChecks();
134
		if ( $status->isGood() ) {
135
			$installer->showMessage( 'config-env-good' );
136
		} else {
137
			$installer->showStatusMessage( $status );
138
139
			return;
140
		}
141
		if ( !$this->hasOption( 'env-checks' ) ) {
142
			$installer->execute();
143
			$installer->writeConfigurationFile( $this->getOption( 'confpath', $IP ) );
144
		}
145
	}
146
147
	function validateParamsAndArgs() {
148
		if ( !$this->hasOption( 'env-checks' ) ) {
149
			parent::validateParamsAndArgs();
150
		}
151
	}
152
}
153
154
$maintClass = 'CommandLineInstaller';
155
156
require_once RUN_MAINTENANCE_IF_MAIN;
157