.
/**
* 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( __FILE__, 2 ) . '/';
require_once( $t_mantis_dir . 'core.php' );
/**
* Class CheckLangFile.
*
* Processes a language strings file (strings_xxx.txt)
*/
class LangCheckFile {
const BASE = 'strings_english.txt';
/**
* Comma-delimited list of valid tags and attributes for language strings
* @see http://htmlpurifier.org/live/configdoc/plain.html#HTML.Allowed
*/
const VALID_TAGS = 'em,strong,i,b,br,p,ul,ol,li,table,tr,td,code,a[href|title],span[class],abbr[title]';
/**
* @var bool True if HTML syntax checks can be performed
* (i.e. if DOM and libxml PHP extensions are available).
* @see canDoHtmlChecks().
*/
protected static $can_do_html_check;
/**
* @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 = [];
/**
* @var HTMLPurifier
* @see http://htmlpurifier.org/
*/
protected $purifier;
/**
* 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 );
# Initialize HTML Purifier object
# - define list of tags and attributes allowed in language strings
# - disable the cache for now, as this is only used sporadically by
# admins/devs, so the performance hit (~ 1-2 sec) is acceptable.
$t_purifier_config = HTMLPurifier_Config::create( [
'Cache.DefinitionImpl' => null,
'HTML.Allowed' => self::VALID_TAGS,
] );
$this->purifier = new HTMLPurifier( $t_purifier_config );
}
/**
* 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;
}
/**
* Returns True if HTML tags validation can be performed.
* @return bool
*/
public static function canDoHtmlChecks() {
if( self::$can_do_html_check === null ) {
self::$can_do_html_check = extension_loaded( 'dom' ) && extension_loaded( 'libxml' );
}
return self::$can_do_html_check;
}
/**
* 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 "| Testing '" . basename( $this->file ) . "' | ";
$t_messages = '';
if( $this->warnings ) {
$t_class = 'alert-warning';
$t_warnings = '';
foreach( $this->warnings as $t_msg ) {
$t_warnings .= '' . string_attribute( $t_msg ) . '';
}
$t_messages = sprintf( 'WARNINGS', $t_warnings );
}
if( $this->errors ) {
$t_class = 'alert-danger';
$t_errors = '';
foreach( $this->errors as $t_msg ) {
$t_errors .= '' . string_attribute( $t_msg ) . '';
}
$t_messages = sprintf( 'ERRORS', $t_errors )
. $t_messages;
}
if( !$t_messages ) {
$t_class = 'alert-success';
$t_messages = 'PASS';
}
/** @noinspection PhpUndefinedVariableInspection */
printf( '%s | ', $t_class, $t_messages );
echo '
' . 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 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_text[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;
}
# Perform HTML tags validation if the string contains any
if( $this::canDoHtmlChecks()
&& preg_match( '~~iU', $t_text)
) {
/** @noinspection PhpComposerExtensionStubsInspection */
$t_dom = new DOMDocument();
set_error_handler(
function( $p_type, $p_error ) {
$t_msg = preg_replace( '/^DOM.*: (.*), line.*$/U', '\\1', $p_error );
/** @noinspection PhpUnhandledExceptionInspection See try/catch block below*/
throw new Exception( $t_msg );
},
E_WARNING
);
try {
/** @noinspection PhpComposerExtensionStubsInspection */
$t_dom->loadHTML( $t_text, LIBXML_HTML_NOIMPLIED );
}
catch( Exception $e ) {
$this->logWarn( $e->getMessage() . " for string $t_current_var", $t_line );
}
restore_error_handler();
$this->checkInvalidTags( $t_current_var, $t_text, $t_line );
}
$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;
}
/**
* Use HTML Purifier to ensure the string does not contain unsupported tags.
*
* Will log an error if the purified string is not equal to the original.
* @see LangCheckFile::compareToPurified()
*
* @param string $p_var Name of language string variable to check
* @param string $p_text Language string
* @param int $p_line Line number in language file
*
* @return void
*/
private function checkInvalidTags( $p_var, $p_text, $p_line ) {
$t_pure = $this->purifier->purify( $p_text );
# Special cases handling
# - sprintf variable '%1$s' inside href gets urlencoded
if( $p_var == '$s_webmaster_contact_information' ) {
$t_pure = str_replace( '%25', '%', $t_pure );
}
# Prepare original language string for comparison with HTML Purifier output
# - transform
tag with or without trailing '/' into '
'
$p_text = preg_replace( '##i', '
', $p_text );
if( $t_pure != $p_text ) {
$this->logFail( "$p_var contains unsupported or invalid tags or attributes.", $p_line );
}
}
}
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' );
?>
';
echo "Retrieving Plugins from '$t_path'";
echo ' | ';
try {
$t_plugins = get_plugins( $t_path );
$t_toc = '';
foreach( $t_plugins as $t_plugin => $t_path ) {
$t_toc .= '- ' . $t_plugin . '
';
}
$t_toc .= '
';
print_info( count( $t_plugins ) . " Plugins found" . $t_toc );
} catch( UnexpectedValueException $e ) {
print_fail( $e->getMessage() );
echo '' . PHP_EOL;
return;
}
echo '' . PHP_EOL;
foreach( $t_plugins as $t_plugin => $t_path ) {
echo PHP_EOL;
echo '| ';
echo '';
echo "Checking language files for plugin $t_plugin";
echo ' |
|---|
';
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 . '| ';
echo "Retrieving language files from '$t_path'";
echo ' | ';
if( !is_dir( $t_path ) ) {
print_info( "Directory does not exist" );
echo '
' . 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 '' . PHP_EOL;
return;
}
}
echo '' . 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 '', ( $p_message ), ' | ';
}
function print_fail( $p_message ) {
echo '', string_attribute( $p_message ), ' | ';
}