wikimedia / mediawiki

maintenance/language/transstat.php

<?php

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 46 and the first side effect is on line 29.

/**
 * Statistics about the localisation.
 *
 * 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 MaintenanceLanguage
 *
 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
 * @author Antoine Musso <hashar at free dot fr>
 *
 * Output is posted from time to time on:
 * https://www.mediawiki.org/wiki/Localisation_statistics
 */
$optionsWithArgs = [ 'output' ];
$optionsWithoutArgs = [ 'help' ];

require_once __DIR__ . '/../commandLine.inc';
require_once 'languages.inc';
require_once __DIR__ . '/StatOutputs.php';

if ( isset( $options['help'] ) ) {
	showUsage();
}

# Default output is WikiText
if ( !isset( $options['output'] ) ) {
	$options['output'] = 'wiki';
}

/** Print a usage message*/
function showUsage() {

The function showUsage() has been defined more than once; this definition is ignored, only the first definition in maintenance/importImages.php (L358-404) is considered.

	print <<<TEXT
Usage: php transstat.php [--help] [--output=csv|text|wiki]
	--help : this helpful message
	--output : select an output engine one of:
		* 'csv'      : Comma Separated Values.
		* 'wiki'     : MediaWiki syntax (default).
		* 'text'     : Text with tabs.
Example: php maintenance/transstat.php --output=text

TEXT;
	exit( 1 );

The function showUsage() contains an exit expression.

}

# Select an output engine
switch ( $options['output'] ) {
	case 'wiki':
		$output = new WikiStatsOutput();
		break;
	case 'text':
		$output = new TextStatsOutput();
		break;
	case 'csv':
		$output = new CsvStatsOutput();
		break;
	default:
		showUsage();
}

# Languages
$languages = new Languages();

# Header
$output->heading();
$output->blockstart();
$output->element( 'Language', true );
$output->element( 'Code', true );
$output->element( 'Fallback', true );
$output->element( 'Translated', true );
$output->element( '%', true );
$output->element( 'Obsolete', true );
$output->element( '%', true );
$output->element( 'Problematic', true );
$output->element( '%', true );
$output->blockend();

$wgGeneralMessages = $languages->getGeneralMessages();
$wgRequiredMessagesNumber = count( $wgGeneralMessages['required'] );

foreach ( $languages->getLanguages() as $code ) {
	# Don't check English, RTL English or dummy language codes
	if ( $code == 'en' || $code == 'enRTL' || ( is_array( $wgDummyLanguageCodes ) &&
			isset( $wgDummyLanguageCodes[$code] ) )
	) {
		continue;
	}

	# Calculate the numbers
	$language = Language::fetchLanguageName( $code );
	$fallback = $languages->getFallback( $code );
	$messages = $languages->getMessages( $code );
	$messagesNumber = count( $messages['translated'] );
	$requiredMessagesNumber = count( $messages['required'] );
	$requiredMessagesPercent = $output->formatPercent(
		$requiredMessagesNumber,
		$wgRequiredMessagesNumber
	);
	$obsoleteMessagesNumber = count( $messages['obsolete'] );
	$obsoleteMessagesPercent = $output->formatPercent(
		$obsoleteMessagesNumber,
		$messagesNumber,
		true
	);
	$messagesWithMismatchVariables = $languages->getMessagesWithMismatchVariables( $code );
	$emptyMessages = $languages->getEmptyMessages( $code );
	$messagesWithWhitespace = $languages->getMessagesWithWhitespace( $code );
	$nonXHTMLMessages = $languages->getNonXHTMLMessages( $code );
	$messagesWithWrongChars = $languages->getMessagesWithWrongChars( $code );
	$problematicMessagesNumber = count( array_unique( array_merge(
		$messagesWithMismatchVariables,
		$emptyMessages,
		$messagesWithWhitespace,
		$nonXHTMLMessages,
		$messagesWithWrongChars
	) ) );
	$problematicMessagesPercent = $output->formatPercent(
		$problematicMessagesNumber,
		$messagesNumber,
		true
	);

	# Output them
	$output->blockstart();
	$output->element( "$language" );
	$output->element( "$code" );
	$output->element( "$fallback" );
	$output->element( "$requiredMessagesNumber/$wgRequiredMessagesNumber" );
	$output->element( $requiredMessagesPercent );
	$output->element( "$obsoleteMessagesNumber/$messagesNumber" );
	$output->element( $obsoleteMessagesPercent );
	$output->element( "$problematicMessagesNumber/$messagesNumber" );
	$output->element( $problematicMessagesPercent );
	$output->blockend();
}

# Footer
$output->footer();