-
Notifications
You must be signed in to change notification settings - Fork 719
/
test_langs.php
615 lines (548 loc) · 15.7 KB
/
test_langs.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
<?php
# MantisBT - A PHP based bugtracking system
# MantisBT 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.
#
# MantisBT 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 MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* Check Language Files
* @package MantisBT
* @copyright Copyright 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright 2002 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
define( 'PLUGINS_DISABLED', true );
define( 'LANG_LOAD_DISABLED', true );
$t_mantis_dir = dirname( dirname( __FILE__ ) ) . '/';
require_once( $t_mantis_dir . 'core.php' );
/**
* Class CheckLangFile.
*
* Processes a language strings file (strings_xxx.txt)
*/
class LangCheckFile {
const BASE = 'strings_english.txt';
/**
* @var string Full path to to the language file
*/
protected $file;
/**
* @var bool True if file is base language (i.e. English)
*/
protected $is_base_language;
/**
* @var string[] List of errors messages detected during checks.
*/
protected $errors = [];
/**
* @var string[] List of warning messages detected during checks.
*/
protected $warnings = [];
/**
* CheckLangFile constructor.
*
* @param string $p_path Path to language files
* @param string $p_file Language file name
*/
public function __construct( $p_path, $p_file ) {
$this->file = $p_path . $p_file;
$this->is_base_language = ( $p_file == self::BASE );
}
/**
* Log an error.
*
* @param string $p_message
*/
protected function logFail( $p_message, $p_line = 0 ) {
if( $p_line ) {
$p_message = "Line $p_line: $p_message";
}
$this->errors[] = $p_message;
}
/**
* Log a warning.
*
* @param string $p_message
*/
protected function logWarn( $p_message, $p_line = 0 ) {
if( $p_line ) {
$p_message = "Line $p_line: $p_message";
}
$this->warnings[] = $p_message;
}
/**
* Check Language File.
*
* @return bool True if success (possibly with warnings), False if errors
*/
public function check() {
$this->checkConfig();
if( $this->checkTokens() ) {
try {
ob_start();
$t_result = eval( "require_once( '$this->file' );" );
$t_data = ob_get_flush();
if( $t_result === false ) {
$this->logFail( 'Failed at eval' );
} elseif( !empty( $t_data ) ) {
$this->logFail(
'Failed at require_once (data output: ' . var_export( $t_data, true ) . ')'
);
}
} catch( ParseError $e ) {
ob_end_clean();
$this->logFail( $e->getMessage(), $e->getLine() );
}
}
return empty( $this->errors );
}
/**
* Print check results.
*
* Prints a table row with 2 cells, the first contains the name of the file
* being checked, and the second the outcome of the check including error
* and warning messages as unordered list if any, with a colored background
* depending on overall status (PASS, WARNINGS, ERRORS).
*/
public function printResults() {
flush();
echo "<tr><td>Testing '" . basename( $this->file ) . "'</td>";
$t_messages = '';
if( $this->warnings ) {
$t_class = 'alert-warning';
$t_warnings = '';
foreach( $this->warnings as $t_msg ) {
$t_warnings .= '<li>' . string_attribute( $t_msg ) . '</li>';
}
$t_messages = sprintf( 'WARNINGS<ul>%s</ul>', $t_warnings );
}
if( $this->errors ) {
$t_class = 'alert-danger';
$t_errors = '';
foreach( $this->errors as $t_msg ) {
$t_errors .= '<li>' . string_attribute( $t_msg ) . '</li>';
}
$t_messages = sprintf( 'ERRORS<ul>%s</ul>', $t_errors )
. $t_messages;
}
if( !$t_messages ) {
$t_class = 'alert-success';
$t_messages = 'PASS';
}
/** @noinspection PhpUndefinedVariableInspection */
printf( '<td class="%s">%s</td>', $t_class, $t_messages );
echo '</tr>' . PHP_EOL;
}
/**
* Check Language File and print results.
*
* @return bool True if success (possibly with warnings), False if errors
*/
public function checkAndPrint() {
$t_status = $this->check();
$this->printResults();
return $t_status;
}
/**
* Check language existence in configuration.
*
* TranslateWiki.net sometimes adds brand new languages; we need to make
* sure that these are properly defined in
* - {@see $g_language_choices_arr}
* - {@see $g_language_auto_map}
* If not, this is reported as a warning as this just means the new language
* cannot be used within MantisBT.
*/
protected function checkConfig() {
global /** @noinspection PhpUnusedLocalVariableInspection */
$g_language_choices_arr, $g_language_auto_map;
# Extract language from file name
# preg_match() can't fail, get_lang_files() uses the same regex
preg_match( '/strings_(.+)\.txt$/', $this->file, $t_matches );
$t_lang = $t_matches[1];
# Check for matching entries in configuration
$t_check = ['g_language_choices_arr', 'g_language_auto_map'];
foreach( $t_check as $t_key => $t_config ) {
if( in_array( $t_lang, $$t_config ) ) {
unset( $t_check[$t_key] );
}
}
# Report errors
if( $t_check ) {
$this->logWarn( "'$t_lang' language is not defined in "
. implode(', ', $t_check )
);
}
}
/**
* Check Language File Tokens
*
* @return boolean
*/
protected function checkTokens() {
$t_source = file_get_contents( $this->file );
try {
$t_tokens = token_get_all( $t_source, TOKEN_PARSE );
} catch( ParseError $e ) {
$this->logFail( $e->getMessage(), $e->getLine() );
return false;
}
$t_line = 0;
$t_variables = array();
static $s_basevariables;
$t_current_var = null;
$t_last_token = 0;
$t_set_variable = false;
$t_variable_array = false;
$t_two_part_string = false;
$t_need_end_variable = false;
$t_expect_end_array = false;
$t_expect_double_quote = false;
$t_setting_variable = false;
$t_pass = true;
$t_fatal = false;
foreach( $t_tokens as $t_token ) {
$t_last_token2 = 0;
if( is_string( $t_token ) ) {
switch( $t_token ) {
case '=':
#
if( $t_last_token != T_VARIABLE ) {
$this->logFail( "'=' sign without variable", $t_line );
$t_pass = false;
}
$t_set_variable = true;
break;
case '[':
if( $t_last_token != T_VARIABLE ) {
$this->logFail( "Unexpected opening square bracket '['", $t_line);
$t_pass = false;
}
$t_variable_array = true;
break;
case ']':
if( !$t_expect_end_array ) {
$this->logFail( "Unexpected closing square bracket ']'", $t_line);
$t_pass = false;
}
$t_expect_end_array = false;
$t_variable_array = false;
break;
case ';':
if( !$t_need_end_variable ) {
$this->logFail( "Unexpected semicolon", $t_line );
$t_pass = false;
}
$t_need_end_variable = false;
break;
case '.':
if( $t_last_token == T_CONSTANT_ENCAPSED_STRING ) {
$t_two_part_string = true;
} else {
$this->logFail( "String concatenation found at unexpected location", $t_line );
$t_pass = false;
}
break;
case '"':
$t_expect_double_quote = !$t_expect_double_quote;
break;
default:
$this->logFail( "Unknown token '$t_token'", $t_line );
$t_pass = false;
break;
}
} else {
# token array
list( $t_id, $t_text, $t_line ) = $t_token;
if( $t_id == T_WHITESPACE || $t_id == T_COMMENT || $t_id == T_DOC_COMMENT ) {
continue;
}
if( $t_need_end_variable ) {
if( $t_two_part_string && $t_id == T_CONSTANT_ENCAPSED_STRING ) {
$t_two_part_string = false;
continue;
}
if( $t_setting_variable && $t_id == T_STRING ) {
$t_last_token = T_VARIABLE;
$t_expect_end_array = true;
continue;
}
$this->logFail( "Unexpected " . token_name( $t_id ) . " token '$t_text'", $t_line );
$t_pass = false;
}
switch( $t_id ) {
case T_OPEN_TAG:
# We expect an initial <?php tag, but it does not require any processing
break;
case T_INLINE_HTML:
$this->logFail( 'Whitespace in language file outside of PHP code block', $t_line );
$t_pass = false;
break;
case T_VARIABLE:
if( $t_expect_double_quote ) {
$this->logFail( "Unexpected " . token_name( $t_id ) . " token '$t_text'", $t_line );
break;
}
if( $t_set_variable && $t_current_var != null ) {
$t_need_end_variable = true;
$t_setting_variable = true;
$t_current_var = null;
break;
}
$t_current_var = $t_text;
break;
case T_STRING:
if( $t_variable_array ) {
$t_current_var .= $t_text;
if( !defined( $t_text ) ) {
$this->logFail( "undefined constant: '$t_text'", $t_line );
}
} else {
$this->logFail( "T_STRING token found at unexpected location", $t_line );
$t_pass = false;
}
if( strpos( $t_current_var, "\n" ) !== false ) {
$this->logFail( "NEW LINE in string: $t_id " . token_name( $t_id ) . " = $t_text", $t_line );
$t_pass = false;
$t_fatal = true;
}
$t_last_token2 = T_VARIABLE;
$t_expect_end_array = true;
break;
case T_CONSTANT_ENCAPSED_STRING:
if( $t_token[1][0] != '\'' ) {
$this->logWarn( "Language strings should be single-quoted", $t_line );
}
if( $t_variable_array ) {
$t_current_var .= $t_text;
$t_last_token2 = T_VARIABLE;
$t_expect_end_array = true;
break;
}
if( $t_last_token == T_VARIABLE && $t_set_variable && $t_current_var != null ) {
if( isset( $t_variables[$t_current_var] ) ) {
$this->logFail( "Duplicate language string '$t_current_var'", $t_line );
} else {
$t_variables[$t_current_var] = $t_text;
}
if( $this->is_base_language ) {
$s_basevariables[$t_current_var] = true;
} elseif( !isset( $s_basevariables[$t_current_var] ) ) {
$this->logWarn( "String '$t_current_var' not defined in English language file" );
}
}
if( strpos( $t_current_var, "\n" ) !== false ) {
$this->logFail( "NEW LINE in string: $t_id " . token_name( $t_id ) . " = $t_text", $t_line );
$t_pass = false;
$t_fatal = true;
}
$t_current_var = null;
$t_need_end_variable = true;
break;
default:
$this->logFail( "Unexpected " . token_name( $t_id ) . " token '$t_text'", $t_line );
$t_pass = false;
break;
}
$t_last_token = $t_id;
if( $t_last_token2 > 0 ) {
$t_last_token = $t_last_token2;
}
}
if( $t_fatal ) {
break;
}
}
return $t_pass;
}
}
access_ensure_global_level( config_get_global( 'admin_site_threshold' ) );
lang_push( 'english' );
set_time_limit( 0 );
layout_page_header();
layout_admin_page_begin();
print_admin_menu_bar( 'test_langs.php' );
?>
<div class="page-content col-md-12 col-xs-12">
<div class="space-10"></div>
<!-- CORE LANGUAGE FILES -->
<div class="widget-box widget-color-blue2">
<div class="widget-header widget-header-small">
<h4 class="widget-title lighter">
<?php print_icon( 'fa-text-width', 'ace-icon' ); ?>
Testing Core Language Files
</h4>
</div>
<div class="widget-body">
<div class="widget-main no-padding table-responsive">
<table class="table table-bordered table-condensed test-langs">
<?php
checklangdir( $t_mantis_dir );
?>
</table>
</div>
</div>
</div>
<div class="space-10"></div>
<!-- PLUGINS -->
<div class="widget-box widget-color-blue2">
<div class="widget-header widget-header-small">
<h4 class="widget-title lighter">
<?php print_icon( 'fa-text-width', 'ace-icon' ); ?>
Testing Plugins Language Files
</h4>
</div>
<div class="widget-body">
<div class="widget-main no-padding table-responsive">
<table class="table table-bordered table-condensed test-langs">
<?php
checkplugins();
?>
</table>
</div>
</div>
</div>
</div>
<?php
layout_admin_page_end();
/**
* Check plugin language files
*/
function checkplugins() {
$t_path = config_get_global( 'plugin_path' );
echo '<tr><td>';
echo "Retrieving Plugins from '$t_path'";
echo '</td>';
try {
$t_plugins = get_plugins( $t_path );
$t_toc = '<ol class="plugins-toc">';
foreach( $t_plugins as $t_plugin => $t_path ) {
$t_toc .= '<li><a href="#plugin-' . $t_plugin . '">' . $t_plugin . '</a></li>';
}
$t_toc .= '</ol>';
print_info( count( $t_plugins ) . " Plugins found" . $t_toc );
} catch( UnexpectedValueException $e ) {
print_fail( $e->getMessage() );
echo '</tr>' . PHP_EOL;
return;
}
echo '</tr>' . PHP_EOL;
foreach( $t_plugins as $t_plugin => $t_path ) {
echo PHP_EOL;
echo '<tr><th colspan="2">';
echo '<a id="plugin-' . $t_plugin . '"></a>';
echo "Checking language files for plugin <em>$t_plugin</em>";
echo '</th></tr>';
checklangdir( $t_path );
}
}
/**
* Get the list of plugins.
*
* @param string $p_path
* @return string[] Plugin names in ascending order.
*
* @throws UnexpectedValueException
*/
function get_plugins( $p_path ) {
$t_iter = new CallbackFilterIterator(
new FileSystemIterator(
$p_path,
FileSystemIterator::KEY_AS_FILENAME
),
/**
* Callback filter function
* @param SplFileInfo $p_current
* @return bool
*/
function( SplFileInfo $p_current ) {
return $p_current->isDir();
}
);
$t_plugins = iterator_to_array( $t_iter );
ksort( $t_plugins, SORT_FLAG_CASE );
return $t_plugins;
}
/**
* Get the language files from the given directory.
*
* @param $p_path
* @return string[] Language file names in ascending order.
*
* @throws UnexpectedValueException
*/
function get_lang_files( $p_path ) {
$t_iter = new FileSystemIterator(
$p_path,
FileSystemIterator::KEY_AS_FILENAME | FileSystemIterator::CURRENT_AS_PATHNAME
);
# Filter language files, excluding 'qqq' pseudo-language
# https://translatewiki.net/wiki/FAQ#Special_private_language_codes_qqq,_qqx
$t_iter = new RegexIterator( $t_iter,
'|^strings_(?(?!qqq).+)\.txt$|',
RegexIterator::MATCH,
RegexIterator::USE_KEY
);
$t_files = array_keys( iterator_to_array( $t_iter ) );
sort( $t_files );
return $t_files;
}
/**
* Check directory of language files
*
* @param string $p_path Path to language files.
*
* @return void
*/
function checklangdir( $p_path ) {
$t_path = rtrim( $p_path, DIRECTORY_SEPARATOR ) . '/lang/';
echo PHP_EOL . '<tr><td>';
echo "Retrieving language files from '$t_path'";
echo '</td>';
if( !is_dir( $t_path ) ) {
print_info( "Directory does not exist" );
echo '</tr>' . PHP_EOL;
return;
} else {
try {
$t_lang_files = get_lang_files( $t_path );
print_info( count( $t_lang_files ) . " files found" );
} catch( UnexpectedValueException $e ) {
print_fail( $e->getMessage() );
echo '</tr>' . PHP_EOL;
return;
}
}
echo '</tr>' . PHP_EOL;
# Check reference English language file
$t_key = array_search( LangCheckFile::BASE, $t_lang_files );
if( $t_key === false ) {
print_fail( "File not found" );
} else {
$t_file = new LangCheckFile( $t_path, LangCheckFile::BASE );
# No point testing other languages if English fails
if( !$t_file->checkAndPrint() ) {
return;
}
unset( $t_lang_files[$t_key] );
}
# Check foreign language files
foreach( $t_lang_files as $t_lang ) {
$t_file = new LangCheckFile( $t_path, $t_lang );
$t_file->checkAndPrint();
}
}
function print_info( $p_message ) {
echo '<td class="alert-info">', ( $p_message ), '</td>';
}
function print_fail( $p_message ) {
echo '<td class="alert-danger">', string_attribute( $p_message ), '</td>';
}