* Copyright (C) 2023 Alexandre Janniaux * Copyright (C) 2024-2025 MDW * Copyright (C) 2024-2026 Frédéric France * * This program 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 3 of the License, or * (at your option) any later version. * * This program 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 this program. If not, see . * or see https://www.gnu.org/ */ /** * \file test/phpunit/LangTest.php * \ingroup test * \brief PHPUnit test * \remarks To run this script as CLI: phpunit filename.php */ global $conf, $user, $langs, $db; //define('TEST_DB_FORCE_TYPE','mysql'); // This is to force using mysql driver //require_once 'PHPUnit/Autoload.php'; require_once dirname(__FILE__).'/../../htdocs/master.inc.php'; require_once dirname(__FILE__).'/../../htdocs/core/lib/security.lib.php'; require_once dirname(__FILE__).'/../../htdocs/core/lib/security2.lib.php'; require_once dirname(__FILE__).'/CommonClassTest.class.php'; if (! defined('NOREQUIREUSER')) { define('NOREQUIREUSER', '1'); } if (! defined('NOREQUIREDB')) { define('NOREQUIREDB', '1'); } if (! defined('NOREQUIRESOC')) { define('NOREQUIRESOC', '1'); } if (! defined('NOREQUIRETRAN')) { define('NOREQUIRETRAN', '1'); } if (! defined('NOCSRFCHECK')) { define('NOCSRFCHECK', '1'); } if (! defined('NOTOKENRENEWAL')) { define('NOTOKENRENEWAL', '1'); } if (! defined('NOREQUIREMENU')) { define('NOREQUIREMENU', '1'); // If there is no menu to show } if (! defined('NOREQUIREHTML')) { define('NOREQUIREHTML', '1'); // If we don't need to load the html.form.class.php } if (! defined('NOREQUIREAJAX')) { define('NOREQUIREAJAX', '1'); } if (! defined("NOLOGIN")) { define("NOLOGIN", '1'); // If this page is public (can be called outside logged session) } if (empty($user->id)) { print "Load permissions for admin user nb 1".PHP_EOL; $user->fetch(1); $user->loadRights(); } $conf->global->MAIN_DISABLE_ALL_MAILS = 1; /** * Class for PHPUnit tests * * @backupGlobals disabled * @backupStaticAttributes enabled * @remarks backupGlobals must be disabled to have db,conf,user and lang not erased. * @phan-file-suppress PhanUndeclaredClass * @phan-file-suppress PhanUndeclaredExtendedClass * @phan-file-suppress PhanUndeclaredMethod * @phan-file-suppress PhanUndeclaredProperty */ class LangTest extends CommonClassTest { /** * Data provider for testLang * * @return array */ public function langDataProvider(): array { $langCodes = []; foreach (glob(DOL_DOCUMENT_ROOT.'/langs/[a-z]*_*') as $path) { $code = basename($path); if (! preg_match('/^[a-z]+_[A-Z]+$/', $code)) { continue; } if (in_array($code, array('mk_MK'))) { // We exclude some language not yet ready continue; } $langCodes[$code] = [$code]; } return $langCodes; } /** * testTransWithHTMLInParam * * @return void */ public function testTransWithHTMLInParam(): void { global $conf,$user,$langs,$db; $conf = $this->savconf; $user = $this->savuser; $langs = $this->savlangs; $db = $this->savdb; include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php'; $newlang = new Translate('', $conf); $newlang->setDefaultLang('fr_FR'); $newlang->load("admin"); // ErrorModuleRequirePHPVersion is a string than contains accent é and (french comment) // The ->transnoentities() does not escape nothing into entities. $result = $newlang->transnoentities("ModuleMustBeEnabled", 'éaaa'); print "result=".$result.PHP_EOL; $this->assertEquals('Le module éaaa doit être activé', $result, 'Translation transnoentities ko'); // ErrorModuleRequirePHPVersion is a string than contains accent é and (french comment) // The ->trans() escapes content into ModuleMustBeEnabled except b, strong, a, i, br and span tags, // but content of parameters are escaped $result = $newlang->trans("ModuleMustBeEnabled", 'éaaa'); print "result=".$result.PHP_EOL; $this->assertEquals('Le module éaaa doit être activé', $result, 'Translation trans ko'); return; } /** * testTransWithPercent * * @return void */ public function testTransWithPercent(): void { global $conf,$user,$langs,$db; $conf = $this->savconf; $user = $this->savuser; $langs = $this->savlangs; $db = $this->savdb; include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php'; $newlang = new Translate('', $conf); $newlang->setDefaultLang('fr_FR'); $newlang->load("main"); $result = $newlang->trans("DatabaseConnection"); print "result=".$result.PHP_EOL; $this->assertEquals('Connexion à la base', $result); $result = $newlang->transnoentities("FormatDateHourSecShort"); print "result=".$result.PHP_EOL; $this->assertEquals('%d/%m/%Y %H:%M:%S', $result); $newlang = new Translate('', $conf); $newlang->setDefaultLang('en_US'); $newlang->load("main"); $result = $newlang->transnoentities("FormatDateHourText"); print "result=".$result.PHP_EOL; $this->assertEquals('%B %d, %Y, %I:%M %p', $result); return; } /** * testLang * * @return void * @depends testTransWithHTMLInParam */ public function testLang(): void { global $conf,$user,$langs,$db; $conf = $this->savconf; $user = $this->savuser; $langs = $this->savlangs; $db = $this->savdb; include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php'; foreach ($this->langDataProvider() as $case) { list($code) = $case; $prefix = __METHOD__."($code) "; $tmplangs = new Translate('', $conf); $langcode = $code; $tmplangs->setDefaultLang($langcode); $tmplangs->load("main"); print PHP_EOL.$prefix."Check language files".PHP_EOL; $result = $tmplangs->transnoentitiesnoconv("FONTFORPDF"); print $prefix."FONTFORPDF=".$result.PHP_EOL; $this->assertTrue(in_array($result, array('msungstdlight', 'stsongstdlight', 'helvetica', 'DejaVuSans', 'cid0jp', 'cid0kr', 'freemono', 'freeserif')), 'Error bad value '.$result.' for FONTFORPDF in main.lang file '.$code); $result = $tmplangs->transnoentitiesnoconv("DIRECTION"); print $prefix."DIRECTION=".$result.PHP_EOL; $this->assertTrue(in_array($result, array('rtl', 'ltr')), 'Error bad value for DIRECTION in main.lang file '.$code); $result = $tmplangs->transnoentitiesnoconv("SeparatorDecimal"); print $prefix."SeparatorDecimal=".$result.PHP_EOL; $this->assertTrue(in_array($result, array('.',',','/','。',' ','','None')), 'Error on decimal separator for lang code '.$code); // Note that ، that is coma for RTL languages is not supported $result = $tmplangs->transnoentitiesnoconv("SeparatorThousand"); print $prefix."SeparatorThousand=".$result.PHP_EOL; $this->assertTrue(in_array($result, array('.',',','/',' ','','\'','None','Space')), 'Error on thousand separator for lang code '.$code); // Note that ، that is coma for RTL languages is not supported // Test java string contains only d,M,y,/,-,. and not m,... $result = $tmplangs->transnoentitiesnoconv("FormatDateShortJava"); print $prefix."FormatDateShortJava=".$result.PHP_EOL; $tmpvar = preg_match('/^[dMy\/\-\.]+$/', $result); $this->assertEquals(1, $tmpvar, 'FormatDateShortJava KO for lang code '.$code.'. Does not match /[dMy\/\-\.]+/'); $result = $tmplangs->trans("FormatDateShortJavaInput"); print $prefix."FormatDateShortJavaInput=".$result.PHP_EOL; $tmpvar = preg_match('/^[dMy\/\-\.]+$/', $result); $this->assertEquals(1, $tmpvar, 'FormatDateShortJavaInput KO for lang code '.$code.'. Does not match /^[dMy\/\-\.]+$/'); unset($tmplangs); print $prefix."Check syntax rules in the language files".PHP_EOL; foreach (glob(DOL_DOCUMENT_ROOT.'/langs/'.$code.'/*.lang') as $fullpath) { $file = basename($fullpath); //print $prefix.'Check lang file '.$file.PHP_EOL; $filecontent = file_get_contents($fullpath); $result = preg_match('/=--$/m', $filecontent); // A special % char we don't want. We want the common one. //print $prefix."Result for checking we don't have bad percent char = ".$result.PHP_EOL; $this->assertTrue($result == 0, 'Found a translation KEY=-- in file '.$code.'/'.$file.'. We probably want Key=- instead.'); $result = strpos($filecontent, '％'); // A special % char we don't want. We want the common one. //print $prefix."Result for checking we don't have bad percent char = ".$result.PHP_EOL; $this->assertTrue($result === false, 'Found a bad percent char ％ instead of % in file '.$code.'/'.$file); $reg = array(); $result = preg_match('/(.*)([^%])%$/m', $filecontent, $reg); // A sequence of char we don't want //print $prefix."Result for checking we don't have bad percent char = ".$result.PHP_EOL; $this->assertTrue($result == 0, 'Found the character % alone in the translation file '.$code.'/'.$file.' on line '.(empty($reg[1]) ? '' : $reg[1]).(empty($reg[2]) ? '' : $reg[2]).'. We probably want %s or %%'); $result = preg_match('/%n/m', $filecontent); // A sequence of char we don't want //print $prefix."Result for checking we don't have bad percent char = ".$result.PHP_EOL; $this->assertTrue($result == 0, 'Found a sequence %n in the translation file '.$code.'/'.$file.'. We probably want %s'); $result = preg_match('/<<<<<input autofocus onfocus='alert(1337)' <--!' into fields ", // Expected "FilterOnInto", " [ 'Result of lang->trans must have original translation string with its original HTML tag, but inserted values must be fully encoded.', // Description "fr_FR", // Langcode "main", // Dict "Rechercher le critère '<input autofocus onfocus='alert(1337)' <--!' dans les champs ", // Expected "FilterOnInto", "savconf; $user = $this->savuser; $langs = $this->savlangs; $db = $this->savdb; foreach ($this->transDataProvider() as $casename => $case) { list($description, $langcode, $dict, $expected, $key, $param1, $param2) = array_pad($case, 7, ''); $tmplangs = new Translate('', $conf); $tmplangs->setDefaultLang($langcode); $tmplangs->load($dict); $result = $tmplangs->trans($key, $param1, $param2); $prefix = __METHOD__."($casename) "; print $prefix."result trans $key = ".$result.PHP_EOL; $this->assertEquals($expected, $result, $description); } } }