maintenance/language/checkLanguage.inc

   1 <?php
   2 /**
   3  * Helper class for checkLanguage.php script.
   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 MaintenanceLanguage
  22  */
  23
  24 /**
  25  * @ingroup MaintenanceLanguage
  26  */
  27 class CheckLanguageCLI {
  28         protected $code  = null;
  29         protected $level = 2;
  30         protected $doLinks = false;
  31         protected $linksPrefix = '';
  32         protected $wikiCode = 'en';
  33         protected $checkAll = false;
  34         protected $output = 'plain';
  35         protected $checks = array();
  36         protected $L = null;
  37
  38         protected $results = array();
  39
  40         private $includeExif = false;
  41
  42         /**
  43          * Constructor.
  44          * @param $options array Options for script.
  45          */
  46         public function __construct( Array $options ) {
  47                 if ( isset( $options['help'] ) ) {
  48                         echo $this->help();
  49                         exit(1);
  50                 }
  51
  52                 if ( isset( $options['lang'] ) ) {
  53                         $this->code = $options['lang'];
  54                 } else {
  55                         global $wgLanguageCode;
  56                         $this->code = $wgLanguageCode;
  57                 }
  58
  59                 if ( isset( $options['level'] ) ) {
  60                         $this->level = $options['level'];
  61                 }
  62
  63                 $this->doLinks = isset( $options['links'] );
  64                 $this->includeExif = !isset( $options['noexif'] );
  65                 $this->checkAll = isset( $options['all'] );
  66
  67                 if ( isset( $options['prefix'] ) ) {
  68                         $this->linksPrefix = $options['prefix'];
  69                 }
  70
  71                 if ( isset( $options['wikilang'] ) ) {
  72                         $this->wikiCode = $options['wikilang'];
  73                 }
  74
  75                 if ( isset( $options['whitelist'] ) ) {
  76                         $this->checks = explode( ',', $options['whitelist'] );
  77                 } elseif ( isset( $options['blacklist'] ) ) {
  78                         $this->checks = array_diff(
  79                                 isset( $options['easy'] ) ? $this->easyChecks() : $this->defaultChecks(),
  80                                 explode( ',', $options['blacklist'] )
  81                         );
  82                 } elseif ( isset( $options['easy'] ) ) {
  83                         $this->checks = $this->easyChecks();
  84                 } else {
  85                         $this->checks = $this->defaultChecks();
  86                 }
  87
  88                 if ( isset( $options['output'] ) ) {
  89                         $this->output = $options['output'];
  90                 }
  91
  92                 $this->L = new languages( $this->includeExif );
  93         }
  94
  95         /**
  96          * Get the default checks.
  97          * @return array A list of the default checks.
  98          */
  99         protected function defaultChecks() {
 100                 return array(
 101                         'untranslated', 'duplicate', 'obsolete', 'variables', 'empty', 'plural',
 102                         'whitespace', 'xhtml', 'chars', 'links', 'unbalanced', 'namespace',
 103                         'projecttalk', 'magic', 'magic-old', 'magic-over', 'magic-case',
 104                         'special', 'special-old',
 105                 );
 106         }
 107
 108         /**
 109          * Get the checks which check other things than messages.
 110          * @return array A list of the non-message checks.
 111          */
 112         protected function nonMessageChecks() {
 113                 return array(
 114                         'namespace', 'projecttalk', 'magic', 'magic-old', 'magic-over',
 115                         'magic-case', 'special', 'special-old',
 116                 );
 117         }
 118
 119         /**
 120          * Get the checks that can easily be treated by non-speakers of the language.
 121          * @return Array A list of the easy checks.
 122          */
 123         protected function easyChecks() {
 124                 return array(
 125                         'duplicate', 'obsolete', 'empty', 'whitespace', 'xhtml', 'chars', 'magic-old',
 126                         'magic-over', 'magic-case', 'special-old',
 127                 );
 128         }
 129
 130         /**
 131          * Get all checks.
 132          * @return array An array of all check names mapped to their function names.
 133          */
 134         protected function getChecks() {
 135                 return array(
 136                         'untranslated' => 'getUntranslatedMessages',
 137                         'duplicate'    => 'getDuplicateMessages',
 138                         'obsolete'     => 'getObsoleteMessages',
 139                         'variables'    => 'getMessagesWithMismatchVariables',
 140                         'plural'       => 'getMessagesWithoutPlural',
 141                         'empty'        => 'getEmptyMessages',
 142                         'whitespace'   => 'getMessagesWithWhitespace',
 143                         'xhtml'        => 'getNonXHTMLMessages',
 144                         'chars'        => 'getMessagesWithWrongChars',
 145                         'links'        => 'getMessagesWithDubiousLinks',
 146                         'unbalanced'   => 'getMessagesWithUnbalanced',
 147                         'namespace'    => 'getUntranslatedNamespaces',
 148                         'projecttalk'  => 'getProblematicProjectTalks',
 149                         'magic'        => 'getUntranslatedMagicWords',
 150                         'magic-old'    => 'getObsoleteMagicWords',
 151                         'magic-over'   => 'getOverridingMagicWords',
 152                         'magic-case'   => 'getCaseMismatchMagicWords',
 153                         'special'      => 'getUntraslatedSpecialPages',
 154                         'special-old'  => 'getObsoleteSpecialPages',
 155                 );
 156         }
 157
 158         /**
 159          * Get total count for each check non-messages check.
 160          * @return array An array of all check names mapped to a two-element array:
 161          * function name to get the total count and language code or null
 162          * for checked code.
 163          */
 164         protected function getTotalCount() {
 165                 return array(
 166                         'namespace'    => array( 'getNamespaceNames', 'en' ),
 167                         'projecttalk'  => null,
 168                         'magic'        => array( 'getMagicWords', 'en' ),
 169                         'magic-old'    => array( 'getMagicWords', null ),
 170                         'magic-over'   => array( 'getMagicWords', null ),
 171                         'magic-case'   => array( 'getMagicWords', null ),
 172                         'special'      => array( 'getSpecialPageAliases', 'en' ),
 173                         'special-old'  => array( 'getSpecialPageAliases', null ),
 174                 );
 175         }
 176
 177         /**
 178          * Get all check descriptions.
 179          * @return array An array of all check names mapped to their descriptions.
 180          */
 181         protected function getDescriptions() {
 182                 return array(
 183                         'untranslated' => '$1 message(s) of $2 are not translated to $3, but exist in en:',
 184                         'duplicate'    => '$1 message(s) of $2 are translated the same in en and $3:',
 185                         'obsolete'     => '$1 message(s) of $2 do not exist in en or are in the ignore list, but exist in $3:',
 186                         'variables'    => '$1 message(s) of $2 in $3 don\'t match the variables used in en:',
 187                         'plural'       => '$1 message(s) of $2 in $3 don\'t use {{plural}} while en uses:',
 188                         'empty'        => '$1 message(s) of $2 in $3 are empty or -:',
 189                         'whitespace'   => '$1 message(s) of $2 in $3 have trailing whitespace:',
 190                         'xhtml'        => '$1 message(s) of $2 in $3 contain illegal XHTML:',
 191                         'chars'        => '$1 message(s) of $2 in $3 include hidden chars which should not be used in the messages:',
 192                         'links'        => '$1 message(s) of $2 in $3 have problematic link(s):',
 193                         'unbalanced'   => '$1 message(s) of $2 in $3 have unbalanced {[]}:',
 194                         'namespace'    => '$1 namespace name(s) of $2 are not translated to $3, but exist in en:',
 195                         'projecttalk'  => '$1 namespace name(s) and alias(es) in $3 are project talk namespaces without the parameter:',
 196                         'magic'        => '$1 magic word(s) of $2 are not translated to $3, but exist in en:',
 197                         'magic-old'    => '$1 magic word(s) of $2 do not exist in en, but exist in $3:',
 198                         'magic-over'   => '$1 magic word(s) of $2 in $3 do not contain the original en word(s):',
 199                         'magic-case'   => '$1 magic word(s) of $2 in $3 change the case-sensitivity of the original en word:',
 200                         'special'      => '$1 special page alias(es) of $2 are not translated to $3, but exist in en:',
 201                         'special-old'  => '$1 special page alias(es) of $2 do not exist in en, but exist in $3:',
 202                 );
 203         }
 204
 205         /**
 206          * Get help.
 207          * @return string The help string.
 208          */
 209         protected function help() {
 210                 return <<<ENDS
 211 Run this script to check a specific language file, or all of them.
 212 Command line settings are in form --parameter[=value].
 213 Parameters:
 214         --help: Show this help.
 215         --lang: Language code (default: the installation default language).
 216         --all: Check all customized languages.
 217         --level: Show the following display level (default: 2):
 218                 * 0: Skip the checks (useful for checking syntax).
 219                 * 1: Show only the stub headers and number of wrong messages, without list of messages.
 220                 * 2: Show only the headers and the message keys, without the message values.
 221                 * 3: Show both the headers and the complete messages, with both keys and values.
 222         --links: Link the message values (default off).
 223         --prefix: prefix to add to links.
 224         --wikilang: For the links, what is the content language of the wiki to display the output in (default en).
 225         --noexif: Do not check for EXIF messages (a bit hard and boring to translate), if you know
 226                 that they are currently not translated and want to focus on other problems (default off).
 227         --whitelist: Do only the following checks (form: code,code).
 228         --blacklist: Do not do the following checks (form: code,code).
 229         --easy: Do only the easy checks, which can be treated by non-speakers of the language.
 230
 231 Check codes (ideally, all of them should result 0; all the checks are executed by default (except language-specific check blacklists in checkLanguage.inc):
 232         * untranslated: Messages which are required to translate, but are not translated.
 233         * duplicate: Messages which translation equal to fallback
 234         * obsolete: Messages which are untranslatable or do not exist, but are translated.
 235         * variables: Messages without variables which should be used, or with variables which should not be used.
 236         * empty: Empty messages and messages that contain only -.
 237         * whitespace: Messages which have trailing whitespace.
 238         * xhtml: Messages which are not well-formed XHTML (checks only few common errors).
 239         * chars: Messages with hidden characters.
 240         * links: Messages which contains broken links to pages (does not find all).
 241         * unbalanced: Messages which contains unequal numbers of opening {[ and closing ]}.
 242         * namespace: Namespace names that were not translated.
 243         * projecttalk: Namespace names and aliases where the project talk does not contain $1.
 244         * magic: Magic words that were not translated.
 245         * magic-old: Magic words which do not exist.
 246         * magic-over: Magic words that override the original English word.
 247         * magic-case: Magic words whose translation changes the case-sensitivity of the original English word.
 248         * special: Special page names that were not translated.
 249         * special-old: Special page names which do not exist.
 250
 251 ENDS;
 252         }
 253
 254         /**
 255          * Execute the script.
 256          */
 257         public function execute() {
 258                 $this->doChecks();
 259                 if ( $this->level > 0 ) {
 260                         switch ( $this->output ) {
 261                                 case 'plain':
 262                                         $this->outputText();
 263                                         break;
 264                                 case 'wiki':
 265                                         $this->outputWiki();
 266                                         break;
 267                                 default:
 268                                         throw new MWException( "Invalid output type $this->output" );
 269                         }
 270                 }
 271         }
 272
 273         /**
 274          * Execute the checks.
 275          */
 276         protected function doChecks() {
 277                 $ignoredCodes = array( 'en', 'enRTL' );
 278
 279                 $this->results = array();
 280                 # Check the language
 281                 if ( $this->checkAll ) {
 282                         foreach ( $this->L->getLanguages() as $language ) {
 283                                 if ( !in_array( $language, $ignoredCodes ) ) {
 284                                         $this->results[$language] = $this->checkLanguage( $language );
 285                                 }
 286                         }
 287                 } else {
 288                         if ( in_array( $this->code, $ignoredCodes ) ) {
 289                                 throw new MWException( "Cannot check code $this->code." );
 290                         } else {
 291                                 $this->results[$this->code] = $this->checkLanguage( $this->code );
 292                         }
 293                 }
 294         }
 295
 296         /**
 297          * Get the check blacklist.
 298          * @return array The list of checks which should not be executed.
 299          */
 300         protected function getCheckBlacklist() {
 301                 global $checkBlacklist;
 302                 return $checkBlacklist;
 303         }
 304
 305         /**
 306          * Check a language.
 307          * @param $code string The language code.
 308          * @return array The results.
 309          */
 310         protected function checkLanguage( $code ) {
 311                 # Syntax check only
 312                 $results = array();
 313                 if ( $this->level === 0 ) {
 314                         $this->L->getMessages( $code );
 315                         return $results;
 316                 }
 317
 318                 $checkFunctions = $this->getChecks();
 319                 $checkBlacklist = $this->getCheckBlacklist();
 320                 foreach ( $this->checks as $check ) {
 321                         if ( isset( $checkBlacklist[$code] ) &&
 322                                 in_array( $check, $checkBlacklist[$code] ) ) {
 323                                 $results[$check] = array();
 324                                 continue;
 325                         }
 326
 327                         $callback = array( $this->L, $checkFunctions[$check] );
 328                         if ( !is_callable( $callback ) ) {
 329                                 throw new MWException( "Unkown check $check." );
 330                         }
 331                         $results[$check] = call_user_func( $callback, $code );
 332                 }
 333
 334                 return $results;
 335         }
 336
 337         /**
 338          * Format a message key.
 339          * @param $key string The message key.
 340          * @param $code string The language code.
 341          * @return string The formatted message key.
 342          */
 343         protected function formatKey( $key, $code ) {
 344                 if ( $this->doLinks ) {
 345                         $displayKey = ucfirst( $key );
 346                         if ( $code == $this->wikiCode ) {
 347                                 return "[[{$this->linksPrefix}MediaWiki:$displayKey|$key]]";
 348                         } else {
 349                                 return "[[{$this->linksPrefix}MediaWiki:$displayKey/$code|$key]]";
 350                         }
 351                 } else {
 352                         return $key;
 353                 }
 354         }
 355
 356         /**
 357          * Output the checks results as plain text.
 358          */
 359         protected function outputText() {
 360                 foreach ( $this->results as $code => $results ) {
 361                         $translated = $this->L->getMessages( $code );
 362                         $translated = count( $translated['translated'] );
 363                         foreach ( $results as $check => $messages ) {
 364                                 $count = count( $messages );
 365                                 if ( $count ) {
 366                                         if ( $check == 'untranslated' ) {
 367                                                 $translatable = $this->L->getGeneralMessages();
 368                                                 $total = count( $translatable['translatable'] );
 369                                         } elseif ( in_array( $check, $this->nonMessageChecks() ) ) {
 370                                                 $totalCount = $this->getTotalCount();
 371                                                 $totalCount = $totalCount[$check];
 372                                                 $callback = array( $this->L, $totalCount[0] );
 373                                                 $callCode = $totalCount[1] ? $totalCount[1] : $code;
 374                                                 $total = count( call_user_func( $callback, $callCode ) );
 375                                         } else {
 376                                                 $total = $translated;
 377                                         }
 378                                         $search = array( '$1', '$2', '$3' );
 379                                         $replace = array( $count, $total, $code );
 380                                         $descriptions = $this->getDescriptions();
 381                                         echo "\n" . str_replace( $search, $replace, $descriptions[$check] ) . "\n";
 382                                         if ( $this->level == 1 ) {
 383                                                 echo "[messages are hidden]\n";
 384                                         } else {
 385                                                 foreach ( $messages as $key => $value ) {
 386                                                         if( !in_array( $check, $this->nonMessageChecks() ) ) {
 387                                                                 $key = $this->formatKey( $key, $code );
 388                                                         }
 389                                                         if ( $this->level == 2 || empty( $value ) ) {
 390                                                                 echo "* $key\n";
 391                                                         } else {
 392                                                                 echo "* $key:           '$value'\n";
 393                                                         }
 394                                                 }
 395                                         }
 396                                 }
 397                         }
 398                 }
 399         }
 400
 401         /**
 402          * Output the checks results as wiki text.
 403          */
 404         function outputWiki() {
 405                 $detailText = '';
 406                 $rows[] = '! Language !! Code !! Total !! ' . implode( ' !! ', array_diff( $this->checks, $this->nonMessageChecks() ) );
 407                 foreach ( $this->results as $code => $results ) {
 408                         $detailTextForLang = "==$code==\n";
 409                         $numbers = array();
 410                         $problems = 0;
 411                         $detailTextForLangChecks = array();
 412                         foreach ( $results as $check => $messages ) {
 413                                 if( in_array( $check, $this->nonMessageChecks() ) ) {
 414                                         continue;
 415                                 }
 416                                 $count = count( $messages );
 417                                 if ( $count ) {
 418                                         $problems += $count;
 419                                         $messageDetails = array();
 420                                         foreach ( $messages as $key => $details ) {
 421                                                 $displayKey = $this->formatKey( $key, $code );
 422                                                 $messageDetails[] = $displayKey;
 423                                         }
 424                                         $detailTextForLangChecks[] = "=== $code-$check ===\n* " . implode( ', ', $messageDetails );
 425                                         $numbers[] = "'''[[#$code-$check|$count]]'''";
 426                                 } else {
 427                                         $numbers[] = $count;
 428                                 }
 429
 430                         }
 431
 432                         if ( count( $detailTextForLangChecks ) ) {
 433                                 $detailText .= $detailTextForLang . implode( "\n", $detailTextForLangChecks ) . "\n";
 434                         }
 435
 436                         if ( !$problems ) {
 437                                 # Don't list languages without problems
 438                                 continue;
 439                         }
 440                         $language = Language::fetchLanguageName( $code );
 441                         $rows[] = "| $language || $code || $problems || " . implode( ' || ', $numbers );
 442                 }
 443
 444                 $tableRows = implode( "\n|-\n", $rows );
 445
 446                 $version = SpecialVersion::getVersion( 'nodb' );
 447                 echo <<<EOL
 448 '''Check results are for:''' <code>$version</code>
 449
 450
 451 {| class="sortable wikitable" border="2" cellpadding="4" cellspacing="0" style="background-color: #F9F9F9; border: 1px #AAAAAA solid; border-collapse: collapse; clear: both;"
 452 $tableRows
 453 |}
 454
 455 $detailText
 456
 457 EOL;
 458         }
 459
 460         /**
 461          * Check if there are any results for the checks, in any language.
 462          * @return bool True if there are any results, false if not.
 463          */
 464         protected function isEmpty() {
 465                 foreach( $this->results as $results ) {
 466                         foreach( $results as $messages ) {
 467                                 if( !empty( $messages ) ) {
 468                                         return false;
 469                                 }
 470                         }
 471                 }
 472                 return true;
 473         }
 474 }
 475
 476 /**
 477  * @ingroup MaintenanceLanguage
 478  */
 479 class CheckExtensionsCLI extends CheckLanguageCLI {
 480         private $extensions;
 481
 482         /**
 483          * Constructor.
 484          * @param $options array Options for script.
 485          * @param $extension string The extension name (or names).
 486          */
 487         public function __construct( Array $options, $extension ) {
 488                 if ( isset( $options['help'] ) ) {
 489                         echo $this->help();
 490                         exit(1);
 491                 }
 492
 493                 if ( isset( $options['lang'] ) ) {
 494                         $this->code = $options['lang'];
 495                 } else {
 496                         global $wgLanguageCode;
 497                         $this->code = $wgLanguageCode;
 498                 }
 499
 500                 if ( isset( $options['level'] ) ) {
 501                         $this->level = $options['level'];
 502                 }
 503
 504                 $this->doLinks = isset( $options['links'] );
 505
 506                 if ( isset( $options['wikilang'] ) ) {
 507                         $this->wikiCode = $options['wikilang'];
 508                 }
 509
 510                 if ( isset( $options['whitelist'] ) ) {
 511                         $this->checks = explode( ',', $options['whitelist'] );
 512                 } elseif ( isset( $options['blacklist'] ) ) {
 513                         $this->checks = array_diff(
 514                                 isset( $options['easy'] ) ? $this->easyChecks() : $this->defaultChecks(),
 515                                 explode( ',', $options['blacklist'] )
 516                         );
 517                 } elseif ( isset( $options['easy'] ) ) {
 518                         $this->checks = $this->easyChecks();
 519                 } else {
 520                         $this->checks = $this->defaultChecks();
 521                 }
 522
 523                 if ( isset( $options['output'] ) ) {
 524                         $this->output = $options['output'];
 525                 }
 526
 527                 # Some additional checks not enabled by default
 528                 if ( isset( $options['duplicate'] ) ) {
 529                         $this->checks[] = 'duplicate';
 530                 }
 531
 532                 $this->extensions = array();
 533                 $extensions = new PremadeMediawikiExtensionGroups();
 534                 $extensions->addAll();
 535                 if ( $extension == 'all' ) {
 536                         foreach ( MessageGroups::singleton()->getGroups() as $group ) {
 537                                 if ( strpos( $group->getId(), 'ext-' ) === 0 && !$group->isMeta() ) {
 538                                         $this->extensions[] = new extensionLanguages( $group );
 539                                 }
 540                         }
 541                 } elseif ( $extension == 'wikimedia' ) {
 542                         $wikimedia = MessageGroups::getGroup( 'ext-0-wikimedia' );
 543                         foreach ( $wikimedia->wmfextensions() as $extension ) {
 544                                 $group = MessageGroups::getGroup( $extension );
 545                                 $this->extensions[] = new extensionLanguages( $group );
 546                         }
 547                 } elseif ( $extension == 'flaggedrevs' ) {
 548                         foreach ( MessageGroups::singleton()->getGroups() as $group ) {
 549                                 if ( strpos( $group->getId(), 'ext-flaggedrevs-' ) === 0 && !$group->isMeta() ) {
 550                                         $this->extensions[] = new extensionLanguages( $group );
 551                                 }
 552                         }
 553                 } else {
 554                         $extensions = explode( ',', $extension );
 555                         foreach ( $extensions as $extension ) {
 556                                 $group = MessageGroups::getGroup( 'ext-' . $extension );
 557                                 if ( $group ) {
 558                                         $extension = new extensionLanguages( $group );
 559                                         $this->extensions[] = $extension;
 560                                 } else {
 561                                         print "No such extension $extension.\n";
 562                                 }
 563                         }
 564                 }
 565         }
 566
 567         /**
 568          * Get the default checks.
 569          * @return array A list of the default checks.
 570          */
 571         protected function defaultChecks() {
 572                 return array(
 573                         'untranslated', 'duplicate', 'obsolete', 'variables', 'empty', 'plural',
 574                         'whitespace', 'xhtml', 'chars', 'links', 'unbalanced',
 575                 );
 576         }
 577
 578         /**
 579          * Get the checks which check other things than messages.
 580          * @return array A list of the non-message checks.
 581          */
 582         protected function nonMessageChecks() {
 583                 return array();
 584         }
 585
 586         /**
 587          * Get the checks that can easily be treated by non-speakers of the language.
 588          * @return arrayA list of the easy checks.
 589          */
 590         protected function easyChecks() {
 591                 return array(
 592                         'duplicate', 'obsolete', 'empty', 'whitespace', 'xhtml', 'chars',
 593                 );
 594         }
 595
 596         /**
 597          * Get help.
 598          * @return string The help string.
 599          */
 600         protected function help() {
 601                 return <<<ENDS
 602 Run this script to check the status of a specific language in extensions, or all of them.
 603 Command line settings are in form --parameter[=value], except for the first one.
 604 Parameters:
 605         * 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.
 606         * lang: Language code (default: the installation default language).
 607         * help: Show this help.
 608         * level: Show the following display level (default: 2).
 609         * links: Link the message values (default off).
 610         * wikilang: For the links, what is the content language of the wiki to display the output in (default en).
 611         * whitelist: Do only the following checks (form: code,code).
 612         * blacklist: Do not perform the following checks (form: code,code).
 613         * easy: Do only the easy checks, which can be treated by non-speakers of the language.
 614 Check codes (ideally, all of them should result 0; all the checks are executed by default (except language-specific check blacklists in checkLanguage.inc):
 615         * untranslated: Messages which are required to translate, but are not translated.
 616         * duplicate: Messages which translation equal to fallback
 617         * obsolete: Messages which are untranslatable, but translated.
 618         * variables: Messages without variables which should be used, or with variables which should not be used.
 619         * empty: Empty messages.
 620         * whitespace: Messages which have trailing whitespace.
 621         * xhtml: Messages which are not well-formed XHTML (checks only few common errors).
 622         * chars: Messages with hidden characters.
 623         * links: Messages which contains broken links to pages (does not find all).
 624         * unbalanced: Messages which contains unequal numbers of opening {[ and closing ]}.
 625 Display levels (default: 2):
 626         * 0: Skip the checks (useful for checking syntax).
 627         * 1: Show only the stub headers and number of wrong messages, without list of messages.
 628         * 2: Show only the headers and the message keys, without the message values.
 629         * 3: Show both the headers and the complete messages, with both keys and values.
 630
 631 ENDS;
 632         }
 633
 634         /**
 635          * Execute the script.
 636          */
 637         public function execute() {
 638                 $this->doChecks();
 639         }
 640
 641         /**
 642          * Check a language and show the results.
 643          * @param $code string The language code.
 644          */
 645         protected function checkLanguage( $code ) {
 646                 foreach( $this->extensions as $extension ) {
 647                         $this->L = $extension;
 648                         $this->results = array();
 649                         $this->results[$code] = parent::checkLanguage( $code );
 650
 651                         if( !$this->isEmpty() ) {
 652                                 echo $extension->name() . ":\n";
 653
 654                                 if( $this->level > 0 ) {
 655                                         switch( $this->output ) {
 656                                                 case 'plain':
 657                                                         $this->outputText();
 658                                                         break;
 659                                                 case 'wiki':
 660                                                         $this->outputWiki();
 661                                                         break;
 662                                                 default:
 663                                                         throw new MWException( "Invalid output type $this->output" );
 664                                         }
 665                                 }
 666
 667                                 echo "\n";
 668                         }
 669                 }
 670         }
 671 }
 672
 673 # Blacklist some checks for some languages
 674 $checkBlacklist = array(
 675 #'code'        => array( 'check1', 'check2' ... )
 676 'az'           => array( 'plural' ),
 677 'bo'           => array( 'plural' ),
 678 'dz'           => array( 'plural' ),
 679 'id'           => array( 'plural' ),
 680 'fa'           => array( 'plural' ),
 681 'gan'          => array( 'plural' ),
 682 'gan-hans'     => array( 'plural' ),
 683 'gan-hant'     => array( 'plural' ),
 684 'gn'           => array( 'plural' ),
 685 'hak'          => array( 'plural' ),
 686 'hu'           => array( 'plural' ),
 687 'ja'           => array( 'plural' ), // Does not use plural
 688 'jv'           => array( 'plural' ),
 689 'ka'           => array( 'plural' ),
 690 'kk-arab'      => array( 'plural' ),
 691 'kk-cyrl'      => array( 'plural' ),
 692 'kk-latn'      => array( 'plural' ),
 693 'km'           => array( 'plural' ),
 694 'kn'           => array( 'plural' ),
 695 'ko'           => array( 'plural' ),
 696 'lzh'          => array( 'plural' ),
 697 'mn'           => array( 'plural' ),
 698 'ms'           => array( 'plural' ),
 699 'my'           => array( 'plural', 'chars' ),  // Uses a lot zwnj
 700 'sah'          => array( 'plural' ),
 701 'sq'           => array( 'plural' ),
 702 'tet'          => array( 'plural' ),
 703 'th'           => array( 'plural' ),
 704 'to'           => array( 'plural' ),
 705 'tr'           => array( 'plural' ),
 706 'vi'           => array( 'plural' ),
 707 'wuu'          => array( 'plural' ),
 708 'xmf'          => array( 'plural' ),
 709 'yo'           => array( 'plural' ),
 710 'yue'          => array( 'plural' ),
 711 'zh'           => array( 'plural' ),
 712 'zh-classical' => array( 'plural' ),
 713 'zh-cn'        => array( 'plural' ),
 714 'zh-hans'      => array( 'plural' ),
 715 'zh-hant'      => array( 'plural' ),
 716 'zh-hk'        => array( 'plural' ),
 717 'zh-sg'        => array( 'plural' ),
 718 'zh-tw'        => array( 'plural' ),
 719 'zh-yue'       => array( 'plural' ),
 720 );