CliInstaller::writeConfigurationFile() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

CliInstaller::writeConfigurationFile() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: CliInstaller

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Core installer command line interface.
 *
 * 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
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Deployment
 */

/**
 * Class for the core installer command line interface.
 *
 * @ingroup Deployment
 * @since 1.17
 */
class CliInstaller extends Installer {
	private $specifiedScriptPath = false;

	private $optionMap = [
		'dbtype' => 'wgDBtype',
		'dbserver' => 'wgDBserver',
		'dbname' => 'wgDBname',
		'dbuser' => 'wgDBuser',
		'dbpass' => 'wgDBpassword',
		'dbprefix' => 'wgDBprefix',
		'dbtableoptions' => 'wgDBTableOptions',
		'dbmysql5' => 'wgDBmysql5',
		'dbport' => 'wgDBport',
		'dbschema' => 'wgDBmwschema',
		'dbpath' => 'wgSQLiteDataDir',
		'server' => 'wgServer',
		'scriptpath' => 'wgScriptPath',
	];

	/**
	 * Constructor.
	 *
	 * @param string $siteName
	 * @param string $admin
	 * @param array $option
	 */
	function __construct( $siteName, $admin = null, array $option = [] ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		global $wgContLang;

		parent::__construct();

		if ( isset( $option['scriptpath'] ) ) {
			$this->specifiedScriptPath = true;
		}

		foreach ( $this->optionMap as $opt => $global ) {
			if ( isset( $option[$opt] ) ) {
				$GLOBALS[$global] = $option[$opt];
				$this->setVar( $global, $option[$opt] );
			}
		}

		if ( isset( $option['lang'] ) ) {
			global $wgLang, $wgLanguageCode;
			$this->setVar( '_UserLang', $option['lang'] );
			$wgContLang = Language::factory( $option['lang'] );
			$wgLang = Language::factory( $option['lang'] );
			$wgLanguageCode = $option['lang'];
			RequestContext::getMain()->setLanguage( $wgLang );
		}

		$this->setVar( 'wgSitename', $siteName );

		$metaNS = $wgContLang->ucfirst( str_replace( ' ', '_', $siteName ) );
		if ( $metaNS == 'MediaWiki' ) {
			$metaNS = 'Project';
		}
		$this->setVar( 'wgMetaNamespace', $metaNS );

		if ( $admin ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$this->setVar( '_AdminName', $admin );
		}

		if ( !isset( $option['installdbuser'] ) ) {
			$this->setVar( '_InstallUser',
				$this->getVar( 'wgDBuser' ) );
			$this->setVar( '_InstallPassword',
				$this->getVar( 'wgDBpassword' ) );
		} else {
			$this->setVar( '_InstallUser',
				$option['installdbuser'] );
			$this->setVar( '_InstallPassword',
				isset( $option['installdbpass'] ) ? $option['installdbpass'] : "" );

			// Assume that if we're given the installer user, we'll create the account.
			$this->setVar( '_CreateDBAccount', true );
		}

		if ( isset( $option['pass'] ) ) {
			$this->setVar( '_AdminPassword', $option['pass'] );
		}

		// Set up the default skins
		$skins = $this->findExtensions( 'skins' );
		$this->setVar( '_Skins', $skins );

		if ( $skins ) {
			$skinNames = array_map( 'strtolower', $skins );
			$this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
		}
	}

	/**
	 * Main entry point.
	 */
	public function execute() {
		$vars = Installer::getExistingLocalSettings();
		if ( $vars ) {
			$this->showStatusMessage(
				Status::newFatal( "config-localsettings-cli-upgrade" )
			);
		}

		$this->performInstallation(
			[ $this, 'startStage' ],
			[ $this, 'endStage' ]
		);
	}

	/**
	 * Write LocalSettings.php to a given path
	 *
	 * @param string $path Full path to write LocalSettings.php to
	 */
	public function writeConfigurationFile( $path ) {
		$ls = InstallerOverrides::getLocalSettingsGenerator( $this );
		$ls->writeFile( "$path/LocalSettings.php" );
	}

	public function startStage( $step ) {
		// Messages: config-install-database, config-install-tables, config-install-interwiki,
		// config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
		// config-install-extensions
		$this->showMessage( "config-install-$step" );
	}

	public function endStage( $step, $status ) {
		$this->showStatusMessage( $status );
		$this->showMessage( 'config-install-step-done' );
	}

	public function showMessage( $msg /*, ... */ ) {
		echo $this->getMessageText( func_get_args() ) . "\n";
		flush();
	}

	public function showError( $msg /*, ... */ ) {
		echo "***{$this->getMessageText( func_get_args() )}***\n";
		flush();
	}

	/**
	 * @param array $params
	 *
	 * @return string
	 */
	protected function getMessageText( $params ) {
		$msg = array_shift( $params );

		$text = wfMessage( $msg, $params )->parse();

		$text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 &lt;$1&gt;', $text );

		return html_entity_decode( strip_tags( $text ), ENT_QUOTES );
	}

	/**
	 * Dummy
	 */
	public function showHelpBox( $msg /*, ... */ ) {
	}

	public function showStatusMessage( Status $status ) {
		$warnings = array_merge( $status->getWarningsArray(),
			$status->getErrorsArray() );

		if ( count( $warnings ) !== 0 ) {
			foreach ( $warnings as $w ) {
				call_user_func_array( [ $this, 'showMessage' ], $w );
			}
		}

		if ( !$status->isOK() ) {
			echo "\n";
			exit( 1 );

		}
	}

	public function envCheckPath() {
		if ( !$this->specifiedScriptPath ) {
			$this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
		}

		return parent::envCheckPath();
	}

	protected function envGetDefaultServer() {
		return null; // Do not guess if installing from CLI
	}

	public function dirIsExecutable( $dir, $url ) {
		$this->showMessage( 'config-no-cli-uploads-check', $dir );

		return false;
	}
}


1			<?php
2			/**
3			* Core installer command line interface.
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 Deployment
22			*/
23
24			/**
25			* Class for the core installer command line interface.
26			*
27			* @ingroup Deployment
28			* @since 1.17
29			*/
30			class CliInstaller extends Installer {
31			private $specifiedScriptPath = false;
32
33			private $optionMap = [
34			'dbtype' => 'wgDBtype',
35			'dbserver' => 'wgDBserver',
36			'dbname' => 'wgDBname',
37			'dbuser' => 'wgDBuser',
38			'dbpass' => 'wgDBpassword',
39			'dbprefix' => 'wgDBprefix',
40			'dbtableoptions' => 'wgDBTableOptions',
41			'dbmysql5' => 'wgDBmysql5',
42			'dbport' => 'wgDBport',
43			'dbschema' => 'wgDBmwschema',
44			'dbpath' => 'wgSQLiteDataDir',
45			'server' => 'wgServer',
46			'scriptpath' => 'wgScriptPath',
47			];
48
49			/**
50			* Constructor.
51			*
52			* @param string $siteName
53			* @param string $admin
54			* @param array $option
55			*/
56			function __construct( $siteName, $admin = null, array $option = [] ) {
			0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `__construct` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
57			global $wgContLang;
58
59			parent::__construct();
60
61			if ( isset( $option['scriptpath'] ) ) {
62			$this->specifiedScriptPath = true;
63			}
64
65			foreach ( $this->optionMap as $opt => $global ) {
66			if ( isset( $option[$opt] ) ) {
67			$GLOBALS[$global] = $option[$opt];
68			$this->setVar( $global, $option[$opt] );
69			}
70			}
71
72			if ( isset( $option['lang'] ) ) {
73			global $wgLang, $wgLanguageCode;
74			$this->setVar( '_UserLang', $option['lang'] );
75			$wgContLang = Language::factory( $option['lang'] );
76			$wgLang = Language::factory( $option['lang'] );
77			$wgLanguageCode = $option['lang'];
78			RequestContext::getMain()->setLanguage( $wgLang );
79			}
80
81			$this->setVar( 'wgSitename', $siteName );
82
83			$metaNS = $wgContLang->ucfirst( str_replace( ' ', '_', $siteName ) );
84			if ( $metaNS == 'MediaWiki' ) {
85			$metaNS = 'Project';
86			}
87			$this->setVar( 'wgMetaNamespace', $metaNS );
88
89			if ( $admin ) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$admin` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
90			$this->setVar( '_AdminName', $admin );
91			}
92
93			if ( !isset( $option['installdbuser'] ) ) {
94			$this->setVar( '_InstallUser',
95			$this->getVar( 'wgDBuser' ) );
96			$this->setVar( '_InstallPassword',
97			$this->getVar( 'wgDBpassword' ) );
98			} else {
99			$this->setVar( '_InstallUser',
100			$option['installdbuser'] );
101			$this->setVar( '_InstallPassword',
102			isset( $option['installdbpass'] ) ? $option['installdbpass'] : "" );
103
104			// Assume that if we're given the installer user, we'll create the account.
105			$this->setVar( '_CreateDBAccount', true );
106			}
107
108			if ( isset( $option['pass'] ) ) {
109			$this->setVar( '_AdminPassword', $option['pass'] );
110			}
111
112			// Set up the default skins
113			$skins = $this->findExtensions( 'skins' );
114			$this->setVar( '_Skins', $skins );
115
116			if ( $skins ) {
117			$skinNames = array_map( 'strtolower', $skins );
118			$this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
119			}
120			}
121
122			/**
123			* Main entry point.
124			*/
125			public function execute() {
126			$vars = Installer::getExistingLocalSettings();
127			if ( $vars ) {
128			$this->showStatusMessage(
129			Status::newFatal( "config-localsettings-cli-upgrade" )
130			);
131			}
132
133			$this->performInstallation(
134			[ $this, 'startStage' ],
135			[ $this, 'endStage' ]
136			);
137			}
138
139			/**
140			* Write LocalSettings.php to a given path
141			*
142			* @param string $path Full path to write LocalSettings.php to
143			*/
144			public function writeConfigurationFile( $path ) {
145			$ls = InstallerOverrides::getLocalSettingsGenerator( $this );
146			$ls->writeFile( "$path/LocalSettings.php" );
147			}
148
149			public function startStage( $step ) {
150			// Messages: config-install-database, config-install-tables, config-install-interwiki,
151			// config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
152			// config-install-extensions
153			$this->showMessage( "config-install-$step" );
154			}
155
156			public function endStage( $step, $status ) {
157			$this->showStatusMessage( $status );
158			$this->showMessage( 'config-install-step-done' );
159			}
160
161			public function showMessage( $msg /, ... / ) {
162			echo $this->getMessageText( func_get_args() ) . "\n";
163			flush();
164			}
165
166			public function showError( $msg /, ... / ) {
167			echo "*{$this->getMessageText( func_get_args() )}*\n";
168			flush();
169			}
170
171			/**
172			* @param array $params
173			*
174			* @return string
175			*/
176			protected function getMessageText( $params ) {
177			$msg = array_shift( $params );
178
179			$text = wfMessage( $msg, $params )->parse();
180
181			$text = preg_replace( '/<a href="(.?)".?>(.*?)<\/a>/', '$2 <$1>', $text );
182
183			return html_entity_decode( strip_tags( $text ), ENT_QUOTES );
184			}
185
186			/**
187			* Dummy
188			*/
189			public function showHelpBox( $msg /, ... / ) {
190			}
191
192			public function showStatusMessage( Status $status ) {
193			$warnings = array_merge( $status->getWarningsArray(),
194			$status->getErrorsArray() );
195
196			if ( count( $warnings ) !== 0 ) {
197			foreach ( $warnings as $w ) {
198			call_user_func_array( [ $this, 'showMessage' ], $w );
199			}
200			}
201
202			if ( !$status->isOK() ) {
203			echo "\n";
204			exit( 1 );
			0 ignored issues – show Coding Style Compatibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `showStatusMessage()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
205			}
206			}
207
208			public function envCheckPath() {
209			if ( !$this->specifiedScriptPath ) {
210			$this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
211			}
212
213			return parent::envCheckPath();
214			}
215
216			protected function envGetDefaultServer() {
217			return null; // Do not guess if installing from CLI
218			}
219
220			public function dirIsExecutable( $dir, $url ) {
221			$this->showMessage( 'config-no-cli-uploads-check', $dir );
222
223			return false;
224			}
225			}
226

wikimedia / mediawiki

CliInstaller::writeConfigurationFile() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CliInstaller::writeConfigurationFile() A
last analyzed 2016-11-13 17:42 UTC