<?php
/**
+ * Helper class for checkLanguage.php script.
+ *
+ * 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
*/
+/**
+ * @ingroup MaintenanceLanguage
+ */
class CheckLanguageCLI {
protected $code = null;
protected $level = 2;
protected $doLinks = false;
+ protected $linksPrefix = '';
protected $wikiCode = 'en';
protected $checkAll = false;
protected $output = 'plain';
/**
* Constructor.
- * @param $options Options for script.
+ * @param $options array Options for script.
*/
public function __construct( Array $options ) {
if ( isset( $options['help'] ) ) {
echo $this->help();
- exit();
+ exit(1);
}
- if ( isset($options['lang']) ) {
+ if ( isset( $options['lang'] ) ) {
$this->code = $options['lang'];
} else {
global $wgLanguageCode;
$this->code = $wgLanguageCode;
}
- if ( isset($options['level']) ) {
+ if ( isset( $options['level'] ) ) {
$this->level = $options['level'];
}
- $this->doLinks = isset($options['links']);
- $this->includeExif = !isset($options['noexif']);
- $this->checkAll = isset($options['all']);
+ $this->doLinks = isset( $options['links'] );
+ $this->includeExif = !isset( $options['noexif'] );
+ $this->checkAll = isset( $options['all'] );
+
+ if ( isset( $options['prefix'] ) ) {
+ $this->linksPrefix = $options['prefix'];
+ }
- if ( isset($options['wikilang']) ) {
+ if ( isset( $options['wikilang'] ) ) {
$this->wikiCode = $options['wikilang'];
}
$this->checks = explode( ',', $options['whitelist'] );
} elseif ( isset( $options['blacklist'] ) ) {
$this->checks = array_diff(
- $this->defaultChecks(),
+ isset( $options['easy'] ) ? $this->easyChecks() : $this->defaultChecks(),
explode( ',', $options['blacklist'] )
);
+ } elseif ( isset( $options['easy'] ) ) {
+ $this->checks = $this->easyChecks();
} else {
$this->checks = $this->defaultChecks();
}
- if ( isset($options['output']) ) {
+ if ( isset( $options['output'] ) ) {
$this->output = $options['output'];
}
/**
* Get the default checks.
- * @return A list of the default checks.
+ * @return array A list of the default checks.
*/
protected function defaultChecks() {
return array(
'untranslated', 'duplicate', 'obsolete', 'variables', 'empty', 'plural',
'whitespace', 'xhtml', 'chars', 'links', 'unbalanced', 'namespace',
- 'projecttalk', 'skin', 'magic', 'magic-over', 'magic-case', 'special',
+ 'projecttalk', 'magic', 'magic-old', 'magic-over', 'magic-case',
+ 'special', 'special-old',
);
}
/**
- * Get the non-message checks.
- * @return A list of the non-message checks.
+ * Get the checks which check other things than messages.
+ * @return array A list of the non-message checks.
*/
protected function nonMessageChecks() {
return array(
- 'namespace', 'projecttalk', 'skin', 'magic', 'magic-over', 'magic-case',
- 'special',
+ 'namespace', 'projecttalk', 'magic', 'magic-old', 'magic-over',
+ 'magic-case', 'special', 'special-old',
+ );
+ }
+
+ /**
+ * Get the checks that can easily be treated by non-speakers of the language.
+ * @return Array A list of the easy checks.
+ */
+ protected function easyChecks() {
+ return array(
+ 'duplicate', 'obsolete', 'empty', 'whitespace', 'xhtml', 'chars', 'magic-old',
+ 'magic-over', 'magic-case', 'special-old',
);
}
/**
* Get all checks.
- * @return An array of all check names mapped to their function names.
+ * @return array An array of all check names mapped to their function names.
*/
protected function getChecks() {
return array(
'untranslated' => 'getUntranslatedMessages',
'duplicate' => 'getDuplicateMessages',
'obsolete' => 'getObsoleteMessages',
- 'variables' => 'getMessagesWithoutVariables',
+ 'variables' => 'getMessagesWithMismatchVariables',
'plural' => 'getMessagesWithoutPlural',
'empty' => 'getEmptyMessages',
'whitespace' => 'getMessagesWithWhitespace',
'unbalanced' => 'getMessagesWithUnbalanced',
'namespace' => 'getUntranslatedNamespaces',
'projecttalk' => 'getProblematicProjectTalks',
- 'skin' => 'getUntranslatedSkins',
'magic' => 'getUntranslatedMagicWords',
+ 'magic-old' => 'getObsoleteMagicWords',
'magic-over' => 'getOverridingMagicWords',
'magic-case' => 'getCaseMismatchMagicWords',
'special' => 'getUntraslatedSpecialPages',
+ 'special-old' => 'getObsoleteSpecialPages',
+ );
+ }
+
+ /**
+ * Get total count for each check non-messages check.
+ * @return array An array of all check names mapped to a two-element array:
+ * function name to get the total count and language code or null
+ * for checked code.
+ */
+ protected function getTotalCount() {
+ return array(
+ 'namespace' => array( 'getNamespaceNames', 'en' ),
+ 'projecttalk' => null,
+ 'magic' => array( 'getMagicWords', 'en' ),
+ 'magic-old' => array( 'getMagicWords', null ),
+ 'magic-over' => array( 'getMagicWords', null ),
+ 'magic-case' => array( 'getMagicWords', null ),
+ 'special' => array( 'getSpecialPageAliases', 'en' ),
+ 'special-old' => array( 'getSpecialPageAliases', null ),
);
}
/**
* Get all check descriptions.
- * @return An array of all check names mapped to their descriptions.
+ * @return array An array of all check names mapped to their descriptions.
*/
protected function getDescriptions() {
return array(
'untranslated' => '$1 message(s) of $2 are not translated to $3, but exist in en:',
'duplicate' => '$1 message(s) of $2 are translated the same in en and $3:',
'obsolete' => '$1 message(s) of $2 do not exist in en or are in the ignore list, but exist in $3:',
- 'variables' => '$1 message(s) of $2 in $3 don\'t use some variables that en uses:',
+ 'variables' => '$1 message(s) of $2 in $3 don\'t match the variables used in en:',
'plural' => '$1 message(s) of $2 in $3 don\'t use {{plural}} while en uses:',
'empty' => '$1 message(s) of $2 in $3 are empty or -:',
'whitespace' => '$1 message(s) of $2 in $3 have trailing whitespace:',
'unbalanced' => '$1 message(s) of $2 in $3 have unbalanced {[]}:',
'namespace' => '$1 namespace name(s) of $2 are not translated to $3, but exist in en:',
'projecttalk' => '$1 namespace name(s) and alias(es) in $3 are project talk namespaces without the parameter:',
- 'skin' => '$1 skin name(s) of $2 are not translated to $3, but exist in en:',
'magic' => '$1 magic word(s) of $2 are not translated to $3, but exist in en:',
+ 'magic-old' => '$1 magic word(s) of $2 do not exist in en, but exist in $3:',
'magic-over' => '$1 magic word(s) of $2 in $3 do not contain the original en word(s):',
'magic-case' => '$1 magic word(s) of $2 in $3 change the case-sensitivity of the original en word:',
'special' => '$1 special page alias(es) of $2 are not translated to $3, but exist in en:',
+ 'special-old' => '$1 special page alias(es) of $2 do not exist in en, but exist in $3:',
);
}
/**
* Get help.
- * @return The help string.
+ * @return string The help string.
*/
protected function help() {
return <<<ENDS
Run this script to check a specific language file, or all of them.
Command line settings are in form --parameter[=value].
Parameters:
- * lang: Language code (default: the installation default language).
- * all: Check all customized languages.
- * help: Show this help.
- * level: Show the following display level (default: 2).
- * links: Link the message values (default off).
- * wikilang: For the links, what is the content language of the wiki to display the output in (default en).
- * whitelist: Do only the following checks (form: code,code).
- * blacklist: Don't do the following checks (form: code,code).
- * noexif: Don't check for EXIF messages (a bit hard and boring to translate), if you know that they are currently not translated and want to focus on other problems (default off).
+ --help: Show this help.
+ --lang: Language code (default: the installation default language).
+ --all: Check all customized languages.
+ --level: Show the following display level (default: 2):
+ * 0: Skip the checks (useful for checking syntax).
+ * 1: Show only the stub headers and number of wrong messages, without list of messages.
+ * 2: Show only the headers and the message keys, without the message values.
+ * 3: Show both the headers and the complete messages, with both keys and values.
+ --links: Link the message values (default off).
+ --prefix: prefix to add to links.
+ --wikilang: For the links, what is the content language of the wiki to display the output in (default en).
+ --noexif: Do not check for EXIF messages (a bit hard and boring to translate), if you know
+ that they are currently not translated and want to focus on other problems (default off).
+ --whitelist: Do only the following checks (form: code,code).
+ --blacklist: Do not do the following checks (form: code,code).
+ --easy: Do only the easy checks, which can be treated by non-speakers of the language.
+
Check codes (ideally, all of them should result 0; all the checks are executed by default (except language-specific check blacklists in checkLanguage.inc):
* untranslated: Messages which are required to translate, but are not translated.
* duplicate: Messages which translation equal to fallback
- * obsolete: Messages which are untranslatable, but translated.
- * variables: Messages without variables which should be used.
+ * obsolete: Messages which are untranslatable or do not exist, but are translated.
+ * variables: Messages without variables which should be used, or with variables which should not be used.
* empty: Empty messages and messages that contain only -.
* whitespace: Messages which have trailing whitespace.
* xhtml: Messages which are not well-formed XHTML (checks only few common errors).
* unbalanced: Messages which contains unequal numbers of opening {[ and closing ]}.
* namespace: Namespace names that were not translated.
* projecttalk: Namespace names and aliases where the project talk does not contain $1.
- * skin: Skin names that were not translated.
* magic: Magic words that were not translated.
+ * magic-old: Magic words which do not exist.
* magic-over: Magic words that override the original English word.
* magic-case: Magic words whose translation changes the case-sensitivity of the original English word.
* special: Special page names that were not translated.
-Display levels (default: 2):
- * 0: Skip the checks (useful for checking syntax).
- * 1: Show only the stub headers and number of wrong messages, without list of messages.
- * 2: Show only the headers and the message keys, without the message values.
- * 3: Show both the headers and the complete messages, with both keys and values.
+ * special-old: Special page names which do not exist.
ENDS;
}
/**
* Get the check blacklist.
- * @return The list of checks which should not be executed.
+ * @return array The list of checks which should not be executed.
*/
protected function getCheckBlacklist() {
global $checkBlacklist;
/**
* Check a language.
- * @param $code The language code.
- * @return The results.
+ * @param $code string The language code.
+ * @return array The results.
*/
protected function checkLanguage( $code ) {
# Syntax check only
+ $results = array();
if ( $this->level === 0 ) {
$this->L->getMessages( $code );
- return;
+ return $results;
}
- $results = array();
$checkFunctions = $this->getChecks();
$checkBlacklist = $this->getCheckBlacklist();
foreach ( $this->checks as $check ) {
if ( isset( $checkBlacklist[$code] ) &&
in_array( $check, $checkBlacklist[$code] ) ) {
- $result[$check] = array();
+ $results[$check] = array();
continue;
}
$callback = array( $this->L, $checkFunctions[$check] );
if ( !is_callable( $callback ) ) {
- # DEBUG
- # throw new MWException( "Unkown check $check." );
- continue;
+ throw new MWException( "Unkown check $check." );
}
- $results[$check] = call_user_func( $callback , $code );
+ $results[$check] = call_user_func( $callback, $code );
}
return $results;
/**
* Format a message key.
- * @param $key The message key.
- * @param $code The language code.
- * @return The formatted message key.
+ * @param $key string The message key.
+ * @param $code string The language code.
+ * @return string The formatted message key.
*/
protected function formatKey( $key, $code ) {
if ( $this->doLinks ) {
$displayKey = ucfirst( $key );
if ( $code == $this->wikiCode ) {
- return "[[MediaWiki:$displayKey|$key]]";
+ return "[[{$this->linksPrefix}MediaWiki:$displayKey|$key]]";
} else {
- return "[[MediaWiki:$displayKey/$code|$key]]";
+ return "[[{$this->linksPrefix}MediaWiki:$displayKey/$code|$key]]";
}
} else {
return $key;
/**
* Output the checks results as plain text.
- * @return The checks results as plain text.
*/
protected function outputText() {
foreach ( $this->results as $code => $results ) {
foreach ( $results as $check => $messages ) {
$count = count( $messages );
if ( $count ) {
- switch( $check ) {
- case 'untranslated':
- $translatable = $this->L->getGeneralMessages();
- $total = count( $translatable['translatable'] );
- break;
- case 'namespace':
- $total = count( $this->L->getNamespaceNames( 'en' ) );
- break;
- case 'projecttalk':
- $total = null;
- break;
- case 'skin':
- $total = count( $this->L->getSkinNames( 'en' ) );
- break;
- case 'magic':
- $total = count( $this->L->getMagicWords( 'en' ) );
- break;
- case 'magic-over':
- case 'magic-case':
- $total = count( $this->L->getMagicWords( $code ) );
- break;
- case 'special':
- $total = count( $this->L->getSpecialPageAliases( 'en' ) );
- break;
- default:
- $total = $translated;
+ if ( $check == 'untranslated' ) {
+ $translatable = $this->L->getGeneralMessages();
+ $total = count( $translatable['translatable'] );
+ } elseif ( in_array( $check, $this->nonMessageChecks() ) ) {
+ $totalCount = $this->getTotalCount();
+ $totalCount = $totalCount[$check];
+ $callback = array( $this->L, $totalCount[0] );
+ $callCode = $totalCount[1] ? $totalCount[1] : $code;
+ $total = count( call_user_func( $callback, $callCode ) );
+ } else {
+ $total = $translated;
}
$search = array( '$1', '$2', '$3' );
$replace = array( $count, $total, $code );
/**
* Output the checks results as wiki text.
- * @return The checks results as wiki text.
*/
function outputWiki() {
- global $wgContLang, $IP;
$detailText = '';
- $rows[] = '! Language !! Code !! Total !! ' . implode( ' !! ', $this->checks );
+ $rows[] = '! Language !! Code !! Total !! ' . implode( ' !! ', array_diff( $this->checks, $this->nonMessageChecks() ) );
foreach ( $this->results as $code => $results ) {
$detailTextForLang = "==$code==\n";
$numbers = array();
# Don't list languages without problems
continue;
}
- $language = $wgContLang->getLanguageName( $code );
+ $language = Language::fetchLanguageName( $code );
$rows[] = "| $language || $code || $problems || " . implode( ' || ', $numbers );
}
$tableRows = implode( "\n|-\n", $rows );
- $version = SpecialVersion::getVersion( $IP );
+ $version = SpecialVersion::getVersion( 'nodb' );
echo <<<EOL
'''Check results are for:''' <code>$version</code>
/**
* Check if there are any results for the checks, in any language.
- * @return True if there are any results, false if not.
+ * @return bool True if there are any results, false if not.
*/
protected function isEmpty() {
- foreach( $this->results as $code => $results ) {
- foreach( $results as $check => $messages ) {
+ foreach( $this->results as $results ) {
+ foreach( $results as $messages ) {
if( !empty( $messages ) ) {
return false;
}
}
}
+/**
+ * @ingroup MaintenanceLanguage
+ */
class CheckExtensionsCLI extends CheckLanguageCLI {
private $extensions;
/**
* Constructor.
- * @param $options Options for script.
- * @param $extension The extension name (or names).
+ * @param $options array Options for script.
+ * @param $extension string The extension name (or names).
*/
public function __construct( Array $options, $extension ) {
if ( isset( $options['help'] ) ) {
echo $this->help();
- exit();
+ exit(1);
}
- if ( isset($options['lang']) ) {
+ if ( isset( $options['lang'] ) ) {
$this->code = $options['lang'];
} else {
global $wgLanguageCode;
$this->code = $wgLanguageCode;
}
- if ( isset($options['level']) ) {
+ if ( isset( $options['level'] ) ) {
$this->level = $options['level'];
}
- $this->doLinks = isset($options['links']);
+ $this->doLinks = isset( $options['links'] );
- if ( isset($options['wikilang']) ) {
+ if ( isset( $options['wikilang'] ) ) {
$this->wikiCode = $options['wikilang'];
}
$this->checks = explode( ',', $options['whitelist'] );
} elseif ( isset( $options['blacklist'] ) ) {
$this->checks = array_diff(
- $this->defaultChecks(),
+ isset( $options['easy'] ) ? $this->easyChecks() : $this->defaultChecks(),
explode( ',', $options['blacklist'] )
);
+ } elseif ( isset( $options['easy'] ) ) {
+ $this->checks = $this->easyChecks();
} else {
$this->checks = $this->defaultChecks();
}
- if ( isset($options['output']) ) {
+ if ( isset( $options['output'] ) ) {
$this->output = $options['output'];
}
$this->extensions = array();
$extensions = new PremadeMediawikiExtensionGroups();
$extensions->addAll();
- if( $extension == 'all' ) {
- foreach( MessageGroups::singleton()->getGroups() as $group ) {
- if( strpos( $group->getId(), 'ext-' ) === 0 && !$group->isMeta() ) {
+ if ( $extension == 'all' ) {
+ foreach ( MessageGroups::singleton()->getGroups() as $group ) {
+ if ( strpos( $group->getId(), 'ext-' ) === 0 && !$group->isMeta() ) {
$this->extensions[] = new extensionLanguages( $group );
}
}
- } elseif( $extension == 'wikimedia' ) {
+ } elseif ( $extension == 'wikimedia' ) {
$wikimedia = MessageGroups::getGroup( 'ext-0-wikimedia' );
- foreach( $wikimedia->wmfextensions() as $extension ) {
+ foreach ( $wikimedia->wmfextensions() as $extension ) {
$group = MessageGroups::getGroup( $extension );
$this->extensions[] = new extensionLanguages( $group );
}
+ } elseif ( $extension == 'flaggedrevs' ) {
+ foreach ( MessageGroups::singleton()->getGroups() as $group ) {
+ if ( strpos( $group->getId(), 'ext-flaggedrevs-' ) === 0 && !$group->isMeta() ) {
+ $this->extensions[] = new extensionLanguages( $group );
+ }
+ }
} else {
$extensions = explode( ',', $extension );
- foreach( $extensions as $extension ) {
+ foreach ( $extensions as $extension ) {
$group = MessageGroups::getGroup( 'ext-' . $extension );
- if( $group ) {
+ if ( $group ) {
$extension = new extensionLanguages( $group );
$this->extensions[] = $extension;
} else {
/**
* Get the default checks.
- * @return A list of the default checks.
+ * @return array A list of the default checks.
*/
protected function defaultChecks() {
return array(
);
}
+ /**
+ * Get the checks which check other things than messages.
+ * @return array A list of the non-message checks.
+ */
+ protected function nonMessageChecks() {
+ return array();
+ }
+
+ /**
+ * Get the checks that can easily be treated by non-speakers of the language.
+ * @return arrayA list of the easy checks.
+ */
+ protected function easyChecks() {
+ return array(
+ 'duplicate', 'obsolete', 'empty', 'whitespace', 'xhtml', 'chars',
+ );
+ }
+
/**
* Get help.
- * @return The help string.
+ * @return string The help string.
*/
protected function help() {
return <<<ENDS
Run this script to check the status of a specific language in extensions, or all of them.
Command line settings are in form --parameter[=value], except for the first one.
Parameters:
- * First parameter (mandatory): Extension name, multiple extension names (separated by commas), "all" for all the extensions or "wikimedia" for extensions used by Wikimedia.
+ * First parameter (mandatory): Extension name, multiple extension names (separated by commas), "all" for all the extensions, "wikimedia" for extensions used by Wikimedia or "flaggedrevs" for all FLaggedRevs extension messages.
* lang: Language code (default: the installation default language).
* help: Show this help.
* level: Show the following display level (default: 2).
* wikilang: For the links, what is the content language of the wiki to display the output in (default en).
* whitelist: Do only the following checks (form: code,code).
* blacklist: Do not perform the following checks (form: code,code).
- * duplicate: Additionally check for messages which are translated the same to English (default off).
+ * easy: Do only the easy checks, which can be treated by non-speakers of the language.
Check codes (ideally, all of them should result 0; all the checks are executed by default (except language-specific check blacklists in checkLanguage.inc):
* untranslated: Messages which are required to translate, but are not translated.
* duplicate: Messages which translation equal to fallback
* obsolete: Messages which are untranslatable, but translated.
- * variables: Messages without variables which should be used.
+ * variables: Messages without variables which should be used, or with variables which should not be used.
* empty: Empty messages.
* whitespace: Messages which have trailing whitespace.
* xhtml: Messages which are not well-formed XHTML (checks only few common errors).
/**
* Check a language and show the results.
- * @param $code The language code.
+ * @param $code string The language code.
*/
protected function checkLanguage( $code ) {
foreach( $this->extensions as $extension ) {
# Blacklist some checks for some languages
$checkBlacklist = array(
#'code' => array( 'check1', 'check2' ... )
+'az' => array( 'plural' ),
+'bo' => array( 'plural' ),
+'dz' => array( 'plural' ),
+'id' => array( 'plural' ),
+'fa' => array( 'plural' ),
'gan' => array( 'plural' ),
+'gan-hans' => array( 'plural' ),
+'gan-hant' => array( 'plural' ),
'gn' => array( 'plural' ),
'hak' => array( 'plural' ),
'hu' => array( 'plural' ),
'ja' => array( 'plural' ), // Does not use plural
+'jv' => array( 'plural' ),
'ka' => array( 'plural' ),
'kk-arab' => array( 'plural' ),
'kk-cyrl' => array( 'plural' ),
'kk-latn' => array( 'plural' ),
+'km' => array( 'plural' ),
+'kn' => array( 'plural' ),
'ko' => array( 'plural' ),
+'lzh' => array( 'plural' ),
'mn' => array( 'plural' ),
'ms' => array( 'plural' ),
-'my' => array( 'chars' ), // Uses a lot zwnj
+'my' => array( 'plural', 'chars' ), // Uses a lot zwnj
'sah' => array( 'plural' ),
'sq' => array( 'plural' ),
'tet' => array( 'plural' ),
'th' => array( 'plural' ),
+'to' => array( 'plural' ),
+'tr' => array( 'plural' ),
+'vi' => array( 'plural' ),
'wuu' => array( 'plural' ),
'xmf' => array( 'plural' ),
+'yo' => array( 'plural' ),
'yue' => array( 'plural' ),
'zh' => array( 'plural' ),
'zh-classical' => array( 'plural' ),