MergeMessageFileList::execute() - Code Metrics - Inspection of "Daily Inspection: Merge "skins: Minor doc and code..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (3592b6)

unknown

created 2016-03-18 17:00 UTC

MergeMessageFileList::execute() D

↳ Parent: MergeMessageFileList

Complexity

Conditions	18
Paths	192

Size

Total Lines	74
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	74
rs	4.9555
cc	18
eloc	44
nc	192
nop	0

How to fix Long Method Complexity

<?php

/**
 * Merge $wgExtensionMessagesFiles from various extensions to produce a
 * single array containing all message files.
 *
 * 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 Maintenance
 */

# Start from scratch
define( 'MW_NO_EXTENSION_MESSAGES', 1 );

require_once __DIR__ . '/Maintenance.php';
$maintClass = 'MergeMessageFileList';
$mmfl = false;

/**
 * Maintenance script that merges $wgExtensionMessagesFiles from various
 * extensions to produce a single array containing all message files.
 *
 * @ingroup Maintenance
 */
class MergeMessageFileList extends Maintenance {
	/**
	 * @var bool
	 */
	protected $hasError;

	function __construct() {
		parent::__construct();
		$this->addOption(
			'list-file',
			'A file containing a list of extension setup files, one per line.',
			false,
			true
		);
		$this->addOption( 'extensions-dir', 'Path where extensions can be found.', false, true );
		$this->addOption( 'output', 'Send output to this file (omit for stdout)', false, true );
		$this->addDescription( 'Merge $wgExtensionMessagesFiles and $wgMessagesDirs from ' .
			' various extensions to produce a single file listing all message files and dirs.'
		);
	}

	public function execute() {
		// @codingStandardsIgnoreStart Ignore error: Global variable "$mmfl" is lacking 'wg' prefix
		global $mmfl;
		// @codingStandardsIgnoreEnd
		global $wgExtensionEntryPointListFiles;

		if ( !count( $wgExtensionEntryPointListFiles )
			&& !$this->hasOption( 'list-file' )
			&& !$this->hasOption( 'extensions-dir' )
		) {
			$this->error( "Either --list-file or --extensions-dir must be provided if " .
				"\$wgExtensionEntryPointListFiles is not set", 1 );
		}

		$mmfl = [ 'setupFiles' => [] ];

		# Add setup files contained in file passed to --list-file
		if ( $this->hasOption( 'list-file' ) ) {
			$extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
		}

		# Now find out files in a directory
		if ( $this->hasOption( 'extensions-dir' ) ) {
			$extdir = $this->getOption( 'extensions-dir' );
			# Allow multiple directories to be passed with ":" as delimiter
			$extdirs = explode( ':', $extdir );
			$entries = [];
			foreach ( $extdirs as $extdir ) {
				$entries = array_merge( $entries, scandir( $extdir ) );
			}
			foreach ( $entries as $extname ) {
				if ( $extname == '.' || $extname == '..' || !is_dir( "$extdir/$extname" ) ) {
					continue;
				}
				$possibilities = [
					"$extdir/$extname/extension.json",
					"$extdir/$extname/skin.json",
					"$extdir/$extname/$extname.php"
				];
				$found = false;
				foreach ( $possibilities as $extfile ) {
					if ( file_exists( $extfile ) ) {
						$mmfl['setupFiles'][] = $extfile;
						$found = true;
						break;
					}
				}

				if ( !$found ) {
					$this->hasError = true;
					$this->error( "Extension {$extname} in {$extdir} lacks expected entry point: " .
						"extension.json, skin.json, or {$extname}.php." );
				}
			}
		}

		# Add setup files defined via configuration
		foreach ( $wgExtensionEntryPointListFiles as $points ) {
			$extensionPaths = $this->readFile( $points );
			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
		}

		if ( $this->hasError ) {
			$this->error( "Some files are missing (see above). Giving up.", 1 );
		}

		if ( $this->hasOption( 'output' ) ) {
			$mmfl['output'] = $this->getOption( 'output' );
		}
		if ( $this->hasOption( 'quiet' ) ) {
			$mmfl['quiet'] = true;
		}
	}

	/**
	 * @param string $fileName
	 * @return array List of absolute extension paths
	 */
	private function readFile( $fileName ) {
		global $IP;

		$files = [];
		$fileLines = file( $fileName );
		if ( $fileLines === false ) {
			$this->hasError = true;
			$this->error( "Unable to open list file $fileName." );

			return $files;
		}
		# Strip comments, discard empty lines, and trim leading and trailing
		# whitespace. Comments start with '#' and extend to the end of the line.
		foreach ( $fileLines as $extension ) {
			$extension = trim( preg_replace( '/#.*/', '', $extension ) );
			if ( $extension !== '' ) {
				# Paths may use the string $IP to be substituted by the actual value
				$extension = str_replace( '$IP', $IP, $extension );
				if ( file_exists( $extension ) ) {
					$files[] = $extension;
				} else {
					$this->hasError = true;
					$this->error( "Extension {$extension} doesn't exist" );
				}
			}
		}

		return $files;
	}
}

require_once RUN_MAINTENANCE_IF_MAIN;

$queue = [];
foreach ( $mmfl['setupFiles'] as $fileName ) {
	if ( strval( $fileName ) === '' ) {
		continue;
	}
	if ( empty( $mmfl['quiet'] ) ) {
		fwrite( STDERR, "Loading data from $fileName\n" );
	}
	// Using extension.json or skin.json
	if ( substr( $fileName, -strlen( '.json' ) ) === '.json' ) {
		$queue[$fileName] = 1;
	} else {
		require_once $fileName;
	}
}

if ( $queue ) {

	$registry = new ExtensionRegistry();
	$data = $registry->readFromQueue( $queue );
	foreach ( [ 'wgExtensionMessagesFiles', 'wgMessagesDirs' ] as $var ) {
		if ( isset( $data['globals'][$var] ) ) {
			$GLOBALS[$var] = array_merge( $data['globals'][$var], $GLOBALS[$var] );
		}
	}
}

fwrite( STDERR, "\n" );
$s =
	"<" . "?php\n" .
	"## This file is generated by mergeMessageFileList.php. Do not edit it directly.\n\n" .
	"if ( defined( 'MW_NO_EXTENSION_MESSAGES' ) ) return;\n\n" .
	'$wgExtensionMessagesFiles = ' . var_export( $wgExtensionMessagesFiles, true ) . ";\n\n" .
	'$wgMessagesDirs = ' . var_export( $wgMessagesDirs, true ) . ";\n\n";

$dirs = [
	$IP,
	dirname( __DIR__ ),
	realpath( $IP )
];

foreach ( $dirs as $dir ) {
	$s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
}

if ( isset( $mmfl['output'] ) ) {
	file_put_contents( $mmfl['output'], $s );
} else {
	echo $s;
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report 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 28. 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			* Merge $wgExtensionMessagesFiles from various extensions to produce a
4			* single array containing all message files.
5			*
6			* This program is free software; you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License along
17			* with this program; if not, write to the Free Software Foundation, Inc.,
18			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19			* http://www.gnu.org/copyleft/gpl.html
20			*
21			* @file
22			* @ingroup Maintenance
23			*/
24
25			# Start from scratch
26			define( 'MW_NO_EXTENSION_MESSAGES', 1 );
27
28			require_once __DIR__ . '/Maintenance.php';
29			$maintClass = 'MergeMessageFileList';
30			$mmfl = false;
31
32			/**
33			* Maintenance script that merges $wgExtensionMessagesFiles from various
34			* extensions to produce a single array containing all message files.
35			*
36			* @ingroup Maintenance
37			*/
38			class MergeMessageFileList extends Maintenance {
39			/**
40			* @var bool
41			*/
42			protected $hasError;
43
44			function __construct() {
45			parent::__construct();
46			$this->addOption(
47			'list-file',
48			'A file containing a list of extension setup files, one per line.',
49			false,
50			true
51			);
52			$this->addOption( 'extensions-dir', 'Path where extensions can be found.', false, true );
53			$this->addOption( 'output', 'Send output to this file (omit for stdout)', false, true );
54			$this->addDescription( 'Merge $wgExtensionMessagesFiles and $wgMessagesDirs from ' .
55			' various extensions to produce a single file listing all message files and dirs.'
56			);
57			}
58
59			public function execute() {
60			// @codingStandardsIgnoreStart Ignore error: Global variable "$mmfl" is lacking 'wg' prefix
61			global $mmfl;
62			// @codingStandardsIgnoreEnd
63			global $wgExtensionEntryPointListFiles;
64
65			if ( !count( $wgExtensionEntryPointListFiles )
66			&& !$this->hasOption( 'list-file' )
67			&& !$this->hasOption( 'extensions-dir' )
68			) {
69			$this->error( "Either --list-file or --extensions-dir must be provided if " .
70			"\$wgExtensionEntryPointListFiles is not set", 1 );
71			}
72
73			$mmfl = [ 'setupFiles' => [] ];
74
75			# Add setup files contained in file passed to --list-file
76			if ( $this->hasOption( 'list-file' ) ) {
77			$extensionPaths = $this->readFile( $this->getOption( 'list-file' ) );
78			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
79			}
80
81			# Now find out files in a directory
82			if ( $this->hasOption( 'extensions-dir' ) ) {
83			$extdir = $this->getOption( 'extensions-dir' );
84			# Allow multiple directories to be passed with ":" as delimiter
85			$extdirs = explode( ':', $extdir );
86			$entries = [];
87			foreach ( $extdirs as $extdir ) {
88			$entries = array_merge( $entries, scandir( $extdir ) );
89			}
90			foreach ( $entries as $extname ) {
91			if ( $extname == '.' \|\| $extname == '..' \|\| !is_dir( "$extdir/$extname" ) ) {
92			continue;
93			}
94			$possibilities = [
95			"$extdir/$extname/extension.json",
96			"$extdir/$extname/skin.json",
97			"$extdir/$extname/$extname.php"
98			];
99			$found = false;
100			foreach ( $possibilities as $extfile ) {
101			if ( file_exists( $extfile ) ) {
102			$mmfl['setupFiles'][] = $extfile;
103			$found = true;
104			break;
105			}
106			}
107
108			if ( !$found ) {
109			$this->hasError = true;
110			$this->error( "Extension {$extname} in {$extdir} lacks expected entry point: " .
111			"extension.json, skin.json, or {$extname}.php." );
112			}
113			}
114			}
115
116			# Add setup files defined via configuration
117			foreach ( $wgExtensionEntryPointListFiles as $points ) {
118			$extensionPaths = $this->readFile( $points );
119			$mmfl['setupFiles'] = array_merge( $mmfl['setupFiles'], $extensionPaths );
120			}
121
122			if ( $this->hasError ) {
123			$this->error( "Some files are missing (see above). Giving up.", 1 );
124			}
125
126			if ( $this->hasOption( 'output' ) ) {
127			$mmfl['output'] = $this->getOption( 'output' );
128			}
129			if ( $this->hasOption( 'quiet' ) ) {
130			$mmfl['quiet'] = true;
131			}
132			}
133
134			/**
135			* @param string $fileName
136			* @return array List of absolute extension paths
137			*/
138			private function readFile( $fileName ) {
139			global $IP;
140
141			$files = [];
142			$fileLines = file( $fileName );
143			if ( $fileLines === false ) {
144			$this->hasError = true;
145			$this->error( "Unable to open list file $fileName." );
146
147			return $files;
148			}
149			# Strip comments, discard empty lines, and trim leading and trailing
150			# whitespace. Comments start with '#' and extend to the end of the line.
151			foreach ( $fileLines as $extension ) {
152			$extension = trim( preg_replace( '/#.*/', '', $extension ) );
153			if ( $extension !== '' ) {
154			# Paths may use the string $IP to be substituted by the actual value
155			$extension = str_replace( '$IP', $IP, $extension );
156			if ( file_exists( $extension ) ) {
157			$files[] = $extension;
158			} else {
159			$this->hasError = true;
160			$this->error( "Extension {$extension} doesn't exist" );
161			}
162			}
163			}
164
165			return $files;
166			}
167			}
168
169			require_once RUN_MAINTENANCE_IF_MAIN;
170
171			$queue = [];
172			foreach ( $mmfl['setupFiles'] as $fileName ) {
173			if ( strval( $fileName ) === '' ) {
174			continue;
175			}
176			if ( empty( $mmfl['quiet'] ) ) {
177			fwrite( STDERR, "Loading data from $fileName\n" );
178			}
179			// Using extension.json or skin.json
180			if ( substr( $fileName, -strlen( '.json' ) ) === '.json' ) {
181			$queue[$fileName] = 1;
182			} else {
183			require_once $fileName;
184			}
185			}
186
187			if ( $queue ) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$queue` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
188			$registry = new ExtensionRegistry();
189			$data = $registry->readFromQueue( $queue );
190			foreach ( [ 'wgExtensionMessagesFiles', 'wgMessagesDirs' ] as $var ) {
191			if ( isset( $data['globals'][$var] ) ) {
192			$GLOBALS[$var] = array_merge( $data['globals'][$var], $GLOBALS[$var] );
193			}
194			}
195			}
196
197			fwrite( STDERR, "\n" );
198			$s =
199			"<" . "?php\n" .
200			"## This file is generated by mergeMessageFileList.php. Do not edit it directly.\n\n" .
201			"if ( defined( 'MW_NO_EXTENSION_MESSAGES' ) ) return;\n\n" .
202			'$wgExtensionMessagesFiles = ' . var_export( $wgExtensionMessagesFiles, true ) . ";\n\n" .
203			'$wgMessagesDirs = ' . var_export( $wgMessagesDirs, true ) . ";\n\n";
204
205			$dirs = [
206			$IP,
207			dirname( __DIR__ ),
208			realpath( $IP )
209			];
210
211			foreach ( $dirs as $dir ) {
212			$s = preg_replace( "/'" . preg_quote( $dir, '/' ) . "([^']*)'/", '"$IP\1"', $s );
213			}
214
215			if ( isset( $mmfl['output'] ) ) {
216			file_put_contents( $mmfl['output'], $s );
217			} else {
218			echo $s;
219			}
220

wikimedia / mediawiki

Branch — master (3592b6)

MergeMessageFileList::execute() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like