maintenance/language/checkExtensioni18n.php

   1 <?php
   2 /**
   3  * Copyright (C) 2007 Ashar Voultoiz <hashar@altern.org>
   4  *
   5  * Based on dumpBackup:
   6  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
   7  *
   8  * http://www.mediawiki.org
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @addtogroup SpecialPage
  26  */
  27
  28 #
  29 # Lacking documentation. Examples:
  30 # php checkExtensioni18n.php /opt/mw/extensions/CentralAuth/CentralAuth.i18n.php wgCentralAuthMessages
  31 # php checkExtensioni18n.php --extdir /opt/mw/extensions/
  32 #
  33 # BUGS: cant guess registered extensions :)
  34 # TODO: let users set parameters to configure checklanguage.inc (it uses globals)
  35
  36 // Filename for the extension i18n files database:
  37 define( 'EXT_I18N_DB', 'i18n.db' );
  38
  39 // Global parameters for checkLanguage.inc
  40 $wgDisplayLevel = 2;
  41 $wgChecks = array( 'untranslated', 'obsolete', 'variables', 'empty', 'whitespace', 'xhtml', 'chars' );
  42
  43 $optionsWithArgs = array( 'extdir' );
  44
  45 require_once( dirname(__FILE__).'/../commandLine.inc' );
  46 require_once( 'languages.inc' );
  47 require_once( 'checkLanguage.inc' );
  48
  49
  50 class extensionLanguages extends languages {
  51         private $mExt18nFilename, $mExtArrayName ;
  52         private $mExtArray;
  53
  54         function __construct( $ext18nFilename, $extArrayName ) {
  55                 $this->mExt18nFilename = $ext18nFilename;
  56                 $this->mExtArrayName = $extArrayName;
  57
  58                 $this->mIgnoredMessages = array();
  59                 $this->mOptionalMessages = array();
  60
  61                 if ( file_exists( $this->mExt18nFilename ) ) {
  62                         require_once( $this->mExt18nFilename );
  63
  64                         $foundarray = false;
  65                         if( isset( ${$this->mExtArrayName} ) )  {
  66                                 // File provided in the db file
  67                                 $foundarray = ${$this->mExtArrayName};
  68                         } else {
  69
  70                                 /* For extensions included elsewhere. For some reason other extensions
  71                                  * break with the global statement, so recheck here.
  72                                  */
  73                                 global ${$this->mExtArrayName};
  74                                 if( isset( ${$this->mExtArrayName} ) )  {
  75                                         $foundarray = ${$this->mExtArrayName};
  76                                 }
  77
  78                                 if(!$foundarray) {
  79                                         // Provided array could not be found we try to guess it.
  80
  81                                         # Using the extension path ($m[1]) and filename ($m[2]):
  82                                         $m = array();
  83                                         preg_match( '%.*/(.*)/(.*).i18n\.php%', $this->mExt18nFilename, $m);
  84                                         $arPathCandidate = 'wg' . $m[1].'Messages';
  85                                         $arFileCandidate = 'wg' . $m[2].'Messages';
  86                                         $funcCandidate = "ef{$m[2]}Messages";
  87
  88                                         // Try them:
  89                                         if( isset($$arPathCandidate) && is_array( $$arPathCandidate ) ) {
  90                                                 print "warning> messages from guessed path array \$$arPathCandidate.\n";
  91                                                 $foundarray = $$arPathCandidate;
  92                                         } elseif( isset($$arFileCandidate) && is_array( $$arFileCandidate ) ) {
  93                                                 print "warning> messages from guessed file array \$$arFileCandidate.\n";
  94                                                 $foundarray = $$arFileCandidate;
  95                                         } elseif( function_exists( $funcCandidate ) ) {
  96                                                 print "warning> messages build from guessed function {$funcCandidate}().\n";
  97                                                 $foundarray = $funcCandidate();
  98                                         }
  99                                 }
 100
 101                                 # We are unlucky, return empty stuff
 102                                 if(!$foundarray) {
 103                                         print "ERROR> failed to guess an array to use.\n";
 104                                         $this->mExtArray = null;
 105                                         $this->mLanguages = null;
 106                                         return;
 107                                 }
 108                         }
 109
 110                         $this->mExtArray = $foundarray ;
 111                         $this->mLanguages = array_keys( $this->mExtArray );
 112                 } else {
 113                         wfDie( "File $this->mExt18nFilename not found\n" );
 114                 }
 115         }
 116
 117         protected function loadRawMessages( $code ) {
 118                 if ( isset( $this->mRawMessages[$code] ) ) {
 119                         return;
 120                 }
 121                 if( isset( $this->mExtArray[$code] ) ) {
 122                         $this->mRawMessages[$code] = $this->mExtArray[$code] ;
 123                 } else {
 124                         $this->mRawMessages[$code] = array();
 125                 }
 126         }
 127
 128         public function getLanguages() {
 129                 return $this->mLanguages;
 130         }
 131 }
 132
 133
 134 function checkExtensionLanguage( $filename, $arrayname ) {
 135         global $wgGeneralMessages, $wgRequiredMessagesNumber;
 136
 137         $extLanguages = new extensionLanguages($filename, $arrayname);
 138
 139         // Stuff needed by the checkLanguage routine (globals)
 140         $wgGeneralMessages = $extLanguages->getGeneralMessages();
 141         $wgRequiredMessagesNumber = count( $wgGeneralMessages['required'] );
 142
 143         $langs = $extLanguages->getLanguages();
 144         if( !$langs ) {
 145                 print "ERROR> \$$arrayname array does not exist.\n";
 146                 return false;
 147         }
 148
 149         print "Found ". count($langs) . " languages : " . implode(' ', $langs) ."\n";
 150         foreach( $langs as $lang ) {
 151                 if( $lang == 'en' ) {
 152                         #print "Skipped english language\n";
 153                         continue;
 154                 }
 155
 156                 checkLanguage( $extLanguages, $lang );
 157         }
 158 }
 159
 160 function checkExtensionRepository( $extdir, $db ) {
 161         $fh = fopen( $extdir. '/' . $db, 'r' );
 162
 163         $line_number = 0;
 164         while( $line = fgets( $fh ) ) {
 165                 $line_number++;
 166
 167                 // Ignore comments
 168                 if( preg_match( '/^#/', $line ) ) {
 169                         continue;
 170                 }
 171
 172                 // Load data from i18n database
 173                 $data = split( ' ', chop($line) );
 174                 $i18n_file = @$data[0];
 175                 $arrayname = @$data[1];
 176
 177                 print "------------------------------------------------------\n";
 178                 print "Checking $i18n_file (\$$arrayname).\n";
 179
 180                 // Check data
 181                 if( !file_exists( $extdir . '/' . $i18n_file ) ) {
 182                         print "ERROR> $i18n_file not found ($db:$line_number).\n";
 183                         continue;
 184                 }
 185 #               if( $arrayname == '' ) {
 186 #                       print "warning> no array name for $i18n_file ($db:$line_number).\n";
 187 #               }
 188
 189                 $i18n_file = $extdir . '/' . $i18n_file ;
 190
 191                 checkExtensionLanguage( $i18n_file, $arrayname );
 192
 193                 print "\n";
 194         }
 195 }
 196
 197
 198 function usage() {
 199 // Usage
 200 print <<<END
 201 Usage:
 202     php checkExtensioni18n.php <filename> <arrayname>
 203     php checkExtensioni18n.php --extdir <exstention repository>
 204
 205
 206 END;
 207 die;
 208 }
 209
 210 // Play with options and arguments
 211 if( isset( $options['extdir'] ) ) {
 212         $extdb = $options['extdir'] . '/' . EXT_I18N_DB ;
 213
 214         if( file_exists( $extdb ) ) {
 215                 checkExtensionRepository( $options['extdir'], EXT_I18N_DB );
 216         } else {
 217                 print "$extdb does not exist\n";
 218         }
 219
 220 } else {
 221         // Check arguments
 222         if ( isset( $argv[0] ) ) {
 223
 224                 if (file_exists( $argv[0] ) ) {
 225                         $filename = $argv[0];
 226                 } else {
 227                         print "Unable to open file '{$argv[0]}'\n";
 228                         usage();
 229                 }
 230
 231                 if ( isset( $argv[1] ) ) {
 232                         $arrayname = $argv[1];
 233                 } else {
 234                         print "You must give an array name to be checked\n";
 235                         usage();
 236                 }
 237
 238                 checkExtensionLanguage( $filename, $arrayname );
 239         } else {
 240                 usage();
 241         }
 242 }
 243
 244 ?>