3 * Copyright (C) 2007 Ashar Voultoiz <hashar@altern.org>
6 * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
8 * http://www.mediawiki.org
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.
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.
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
25 * @addtogroup SpecialPage
29 # Lacking documentation. Examples:
30 # php checkExtensioni18n.php /opt/mw/extensions/CentralAuth/CentralAuth.i18n.php wgCentralAuthMessages
31 # php checkExtensioni18n.php --extdir /opt/mw/extensions/
33 # BUGS: cant guess registered extensions :)
34 # TODO: let users set parameters to configure checklanguage.inc (it uses globals)
36 // Filename for the extension i18n files database:
37 define( 'EXT_I18N_DB', 'i18n.db' );
39 // Global parameters for checkLanguage.inc
41 $wgChecks = array( 'untranslated', 'obsolete', 'variables', 'empty', 'whitespace', 'xhtml', 'chars' );
43 $optionsWithArgs = array( 'extdir', 'lang' );
45 require_once( dirname(__FILE__
).'/../commandLine.inc' );
46 require_once( 'languages.inc' );
47 require_once( 'checkLanguage.inc' );
50 class extensionLanguages
extends languages
{
51 private $mExt18nFilename, $mExtArrayName ;
54 function __construct( $ext18nFilename, $extArrayName ) {
55 $this->mExt18nFilename
= $ext18nFilename;
56 $this->mExtArrayName
= $extArrayName;
58 $this->mIgnoredMessages
= array();
59 $this->mOptionalMessages
= array();
61 if ( file_exists( $this->mExt18nFilename
) ) {
62 require_once( $this->mExt18nFilename
);
65 if( isset( $
{$this->mExtArrayName
} ) ) {
66 // File provided in the db file
67 $foundarray = $
{$this->mExtArrayName
};
70 /* For extensions included elsewhere. For some reason other extensions
71 * break with the global statement, so recheck here.
73 global $
{$this->mExtArrayName
};
74 if( is_array( $
{$this->mExtArrayName
} ) ) {
75 $foundarray = $
{$this->mExtArrayName
};
78 /* we might have been given a function name, test it too */
79 if( function_exists( $this->mExtArrayName
) ) {
81 $funcName = $this->mExtArrayName
;
82 $foundarray = $funcName();
86 // Provided array could not be found we try to guess it.
88 # Using the extension path ($m[1]) and filename ($m[2]):
90 preg_match( '%.*/(.*)/(.*).i18n\.php%', $this->mExt18nFilename
, $m);
91 $arPathCandidate = 'wg' . $m[1].'Messages';
92 $arFileCandidate = 'wg' . $m[2].'Messages';
93 $funcCandidate = "ef{$m[2]}Messages";
96 if( isset($
$arPathCandidate) && is_array( $
$arPathCandidate ) ) {
97 print "warning> messages from guessed path array \$$arPathCandidate.\n";
98 $foundarray = $
$arPathCandidate;
99 } elseif( isset($
$arFileCandidate) && is_array( $
$arFileCandidate ) ) {
100 print "warning> messages from guessed file array \$$arFileCandidate.\n";
101 $foundarray = $
$arFileCandidate;
102 } elseif( function_exists( $funcCandidate ) ) {
103 print "warning> messages build from guessed function {$funcCandidate}().\n";
104 $foundarray = $funcCandidate();
108 # We are unlucky, return empty stuff
110 print "ERROR> failed to guess an array to use.\n";
111 $this->mExtArray
= null;
112 $this->mLanguages
= null;
117 $this->mExtArray
= $foundarray ;
118 $this->mLanguages
= array_keys( $this->mExtArray
);
120 wfDie( "File $this->mExt18nFilename not found\n" );
124 protected function loadRawMessages( $code ) {
125 if ( isset( $this->mRawMessages
[$code] ) ) {
128 if( isset( $this->mExtArray
[$code] ) ) {
129 $this->mRawMessages
[$code] = $this->mExtArray
[$code] ;
131 $this->mRawMessages
[$code] = array();
135 public function getLanguages() {
136 return $this->mLanguages
;
141 * @param $filename Filename containing the extension i18n
142 * @param $arrayname The name of the array in the filename
143 * @param $filter Optional, restrict check to a given language code (default; null)
145 function checkExtensionLanguage( $filename, $arrayname, $filter = null ) {
146 global $wgGeneralMessages, $wgRequiredMessagesNumber;
148 $extLanguages = new extensionLanguages($filename, $arrayname);
150 // Stuff needed by the checkLanguage routine (globals)
151 $wgGeneralMessages = $extLanguages->getGeneralMessages();
152 $wgRequiredMessagesNumber = count( $wgGeneralMessages['required'] );
154 $langs = $extLanguages->getLanguages();
156 print "ERROR> \$$arrayname array does not exist.\n";
162 $nErrors +
= checkLanguage( $extLanguages, $filter );
164 print "Will check ". count($langs) . " languages : " . implode(' ', $langs) .".\n";
165 foreach( $langs as $lang ) {
166 if( $lang == 'en' ) {
167 #print "Skipped english language\n";
171 $nErrors +
= checkLanguage( $extLanguages, $lang );
179 * Read the db file, parse it, start the check.
181 function checkExtensionRepository( $extdir, $db ) {
182 $fh = fopen( $extdir. '/' . $db, 'r' );
185 while( $line = fgets( $fh ) ) {
189 if( preg_match( '/^#/', $line ) ) {
193 // Load data from i18n database
194 $data = split( ' ', chop($line) );
195 $i18n_file = @$data[0];
196 $arrayname = @$data[1];
198 print "------------------------------------------------------\n";
199 print "Checking $i18n_file (\$$arrayname).\n";
202 if( !file_exists( $extdir . '/' . $i18n_file ) ) {
203 print "ERROR> $i18n_file not found ($db:$line_number).\n";
206 # if( $arrayname == '' ) {
207 # print "warning> no array name for $i18n_file ($db:$line_number).\n";
210 $i18n_file = $extdir . '/' . $i18n_file ;
213 $nErrors = checkExtensionLanguage( $i18n_file, $arrayname, $myLang );
215 print "\nFound $nErrors error for this extension.\n";
217 print "\nFound $nErrors errors for this extension.\n";
231 php checkExtensioni18n.php <filename> <arrayname>
232 php checkExtensioni18n.php --extdir <extension repository>
235 --lang <language code> : only check the given language.
242 // Play with options and arguments
243 $myLang = isset($options['lang']) ?
$options['lang'] : null;
245 if( isset( $options['extdir'] ) ) {
246 $extdb = $options['extdir'] . '/' . EXT_I18N_DB
;
248 if( file_exists( $extdb ) ) {
249 checkExtensionRepository( $options['extdir'], EXT_I18N_DB
);
251 print "$extdb does not exist\n";
256 if ( isset( $argv[0] ) ) {
258 if (file_exists( $argv[0] ) ) {
259 $filename = $argv[0];
261 print "Unable to open file '{$argv[0]}'\n";
265 if ( isset( $argv[1] ) ) {
266 $arrayname = $argv[1];
268 print "You must give an array name to be checked\n";
273 checkExtensionLanguage( $filename, $arrayname, $myLang );