bn8/ldapsaisie
1
0
Fork 0
mirror of https://gitlab.easter-eggs.com/ee/ldapsaisie.git synced 2024-12-20 15:33:47 +01:00
Code Issues Projects Releases Wiki Activity

LSlang: improve generate_lang_file command

Browse source 
Improve detection in PHP files, add detection in LSaddons/LSauthMethod 
config files and includes PHP files. Add -I/--include-upstream parameter 
(and use it for generate_ldapsaisie_pot command)
This commit is contained in:
Benjamin Renard 2021-01-29 15:23:22 +01:00
parent bc9cc77cde
commit 40a17c3524
1 changed files with 113 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
src/includes/class/class.LSlang.php
View file

@ -232,7 +232,7 @@ if (php_sapi_name() != "cli") return true;
**/ **/
global $LSlang_cli_logger, $available_onlys, $available_withouts; global $LSlang_cli_logger, $available_onlys, $available_withouts;
$available_onlys = array("config", "templates", "addons"); $available_onlys = array("config", "templates", "addons", "auth_methods", "includes");
$available_withouts = array_merge($available_onlys, array("select-list")); $available_withouts = array_merge($available_onlys, array("select-list"));
function cli_generate_lang_file($command_args) { function cli_generate_lang_file($command_args) {
// Use global variables to share it with sub-functions // Use global variables to share it with sub-functions
@ -251,6 +251,7 @@ function cli_generate_lang_file($command_args) {
// Parameters // Parameters
$only = null; $only = null;
$withouts = array(); $withouts = array();
$include_upstream = false;
$copyoriginalvalue = False; $copyoriginalvalue = False;
$interactive = False; $interactive = False;
$interactive_exit = False; // Exit flag set when user type 'q' $interactive_exit = False; // Exit flag set when user type 'q'
@ -308,6 +309,11 @@ function cli_generate_lang_file($command_args) {
LScli :: usage("You could not use only -O/--only parameter combined with -W/--without parameter."); LScli :: usage("You could not use only -O/--only parameter combined with -W/--without parameter.");
break; break;
case '-I':
case '--include-upstream':
$include_upstream=True;
break;
case '--copy-original-value': case '--copy-original-value':
case '-c': case '-c':
$copyoriginalvalue=True; $copyoriginalvalue=True;
@ -687,26 +693,27 @@ function cli_generate_lang_file($command_args) {
} }
} }
$LSlang_cli_logger -> info("Looking for string to translate in templates file"); $LSlang_cli_logger -> info("Looking for string to translate in templates file");
find_and_parse_template_file(LS_ROOT_DIR.'/'.LS_TEMPLATES_DIR); if ($include_upstream) find_and_parse_template_file(LS_ROOT_DIR.'/'.LS_TEMPLATES_DIR);
find_and_parse_template_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_TEMPLATES_DIR); find_and_parse_template_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_TEMPLATES_DIR);
} }
/* /*
* Manage addons files * Manage custom PHP code/config files
*/ */
function parse_php_file($file) {
if (!in_array('addons', $withouts) && (!$only || $only == 'addons')) {
function parse_addon_file($file) {
global $LSlang_cli_logger; global $LSlang_cli_logger;
$LSlang_cli_logger -> debug("Looking for string to translate in '$file' LSaddon file"); $LSlang_cli_logger -> debug("Looking for string to translate in '$file' PHP file");
$count = 0; $count = 0;
foreach(file($file) as $line) {
$count++;
$offset=0;
while ($pos = strpos($line,'__(',$offset)) {
$quote=''; $quote='';
$res=''; $res='';
foreach(file($file) as $line) {
$count++;
$LSlang_cli_logger -> trace("Handle line #$count of '$file' PHP file");
$offset=0;
while ($pos = strpos($line,'__(',$offset)) {
$LSlang_cli_logger -> trace("$file:$count: detect keyword at position #$pos ('$line')");
for ($i=$pos+3;$i<strlen($line);$i++) { for ($i=$pos+3;$i<strlen($line);$i++) {
$offset=$i; // Always increase offset to avoid infinity-loop
if (empty($quote)) { if (empty($quote)) {
// Quote char not detected : try to detect it // Quote char not detected : try to detect it
if ($line[$i]=='\\' || $line[$i]==" " || $line[$i]=="\t") { if ($line[$i]=='\\' || $line[$i]==" " || $line[$i]=="\t") {
@ -719,7 +726,6 @@ function cli_generate_lang_file($command_args) {
} }
elseif ($line[$i]=='$' || $line[$i]==')') { elseif ($line[$i]=='$' || $line[$i]==')') {
// Variable translation not possible or end function call detected // Variable translation not possible or end function call detected
$offset=$i;
break; break;
} }
else { else {
@ -736,8 +742,8 @@ function cli_generate_lang_file($command_args) {
$res.=$line[$i]; $res.=$line[$i];
} }
elseif ($line[$i]==$quote) { elseif ($line[$i]==$quote) {
// End quote char detected : set offset for next detection and break this one // End quote char detected : reset quote char detection and break detection
$offset=$i; $quote='';
break; break;
} }
else { else {
@ -746,17 +752,21 @@ function cli_generate_lang_file($command_args) {
} }
} }
} }
if (!empty($res)) add($res, absolute2relative_path($file).":$count"); // Include detected string if not empty and quote char was detected and reseted
if (!empty($res) && empty($quote)) {
add($res, absolute2relative_path($file).":$count");
$res='';
}
} }
} }
} }
function find_and_parse_addon_file($dir) { function find_and_parse_php_file($dir, $filename_regex) {
if (is_dir($dir)) { if (is_dir($dir)) {
if ($dh = opendir($dir)) { if ($dh = opendir($dir)) {
while (($file = readdir($dh)) !== false) { while (($file = readdir($dh)) !== false) {
if (preg_match('/^LSaddons\.(.+)\.php$/',$file)) { if (preg_match($filename_regex, $file)) {
parse_addon_file($dir.'/'.$file); parse_php_file($dir.'/'.$file);
} }
} }
closedir($dh); closedir($dh);
@ -764,9 +774,36 @@ function cli_generate_lang_file($command_args) {
} }
} }
/*
* Manage includes files
*/
if (!in_array('includes', $withouts) && (!$only || $only == 'includes')) {
// Note: Upstream code most only use gettext translation, do not handle it here
if ($include_upstream) find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_INCLUDE_DIR, '/^(.+)\.php$/');
find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_INCLUDE_DIR, '/^(.+)\.php$/');
if ($include_upstream) find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_CLASS_DIR, '/^class\.(.+)\.php$/');
find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_CLASS_DIR, '/^class\.(.+)\.php$/');
}
/*
* Manage addons files
*/
if (!in_array('addons', $withouts) && (!$only || $only == 'addons')) {
$LSlang_cli_logger -> info("Looking for string to translate in LSaddons PHP code"); $LSlang_cli_logger -> info("Looking for string to translate in LSaddons PHP code");
find_and_parse_addon_file(LS_ROOT_DIR.'/'.LS_ADDONS_DIR); if ($include_upstream) find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_ADDONS_DIR, '/^LSaddons\.(.+)\.php$/');
find_and_parse_addon_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_ADDONS_DIR); find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_ADDONS_DIR, '/^LSaddons\.(.+)\.php$/');
$LSlang_cli_logger -> info("Looking for string to translate in LSaddons configuration files");
if ($include_upstream) find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_CONF_DIR.'/LSaddons', '/^config\.LSaddons\.(.+)\.php$$/');
find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_CONF_DIR.'/LSaddons', '/^config\.LSaddons\.(.+)\.php$$/');
}
/*
* Manage auth methods files
*/
if (!in_array('auth_methods', $withouts) && (!$only || $only == 'auth_methods')) {
$LSlang_cli_logger -> info("Looking for string to translate in LSauthMethods configuration files");
if ($include_upstream) find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_CONF_DIR.'/LSauth', '/^config\.(.+)\.php$$/');
find_and_parse_php_file(LS_ROOT_DIR.'/'.LS_LOCAL_DIR.LS_CONF_DIR.'/LSauth', '/^config\.(.+)\.php$$/');
} }
// Sort resulting strings // Sort resulting strings
@ -909,6 +946,7 @@ function cli_generate_lang_file_args_autocompleter($comp_words, $comp_word_num,
'-l', '--lang', '-l', '--lang',
'-o', '--output', '-o', '--output',
'-f', '--format', '-f', '--format',
'-I', '--include-upstream',
) )
); );
return LScli :: autocomplete_opts($opts, $comp_word); return LScli :: autocomplete_opts($opts, $comp_word);
@ -926,6 +964,7 @@ LScli :: add_command(
" -O/--only Only handle specified messages. Must be one", " -O/--only Only handle specified messages. Must be one",
" of the following values :", " of the following values :",
" - ".implode("\n - ", $available_onlys), " - ".implode("\n - ", $available_onlys),
" -I/--include-upstream Include upstream code to message lookup",
" -c/--copy-original-value Copy original value as translated value when", " -c/--copy-original-value Copy original value as translated value when",
" no translated value exists", " no translated value exists",
" -i/--interactive Interactive mode : ask user to enter", " -i/--interactive Interactive mode : ask user to enter",
@ -1000,6 +1039,7 @@ function cli_generate_ldapsaisie_pot($command_args) {
"-o", LS_I18N_DIR_PATH."/ldapsaisie-templates.pot", "-o", LS_I18N_DIR_PATH."/ldapsaisie-templates.pot",
"-f", "pot", "-f", "pot",
"--only", "templates", "--only", "templates",
"--include-upstream",
), ),
false // do not exit false // do not exit
); );