Merge remote-tracking branch 'origin/support/2.7' into develop

# Conflicts: # core/log.class.inc.php # datamodels/2.x/itop-attachments/renderers.itop-attachments.php # js/search/search_form_criteria_enum.js # lib/composer/autoload_classmap.php # lib/composer/autoload_static.php # test/core/dictTest.php
2026-04-22 01:58:47 +02:00 · 2021-12-08 18:30:20 +01:00
parent cd5286d03b e6d61d1ebd
commit c9ef543e2e
11 changed files with 579 additions and 30 deletions
--- a/test/application/privUITransactionFileTest.php
+++ b/test/application/privUITransactionFileTest.php
@@ -178,5 +178,13 @@ class privUITransactionFileTest extends ItopDataTestCase
 		$this->assertTrue($bUser1Login2, 'Login with user1 throw an error');
 		$bResult = privUITransactionFile::RemoveTransaction($sTransactionIdUserSupport);
 		$this->assertTrue($bResult, 'Token created by support user must be removed in the support user context');
+
+		// test when no user logged (combodo-unauthenticated-form module for example)
+		UserRights::_ResetSessionCache();
+		$sTransactionIdUnauthenticatedUser = privUITransactionFile::GetNewTransactionId();
+		$bResult = privUITransactionFile::IsTransactionValid($sTransactionIdUnauthenticatedUser, false);
+		$this->assertTrue($bResult, 'Token created by unauthenticated user must be valid when no user logged');
+		$bResult = privUITransactionFile::RemoveTransaction($sTransactionIdUnauthenticatedUser);
+		$this->assertTrue($bResult, 'Token created by unauthenticated user must be removed when no user logged');
 	}
 }
--- a/test/core/dictApcuTest.php
+++ b/test/core/dictApcuTest.php
@@ -0,0 +1,402 @@
+<?php
+// Copyright (c) 2010-2017 Combodo SARL
+//
+//   This file is part of iTop.
+//
+//   iTop is free software; you can redistribute it and/or modify
+//   it under the terms of the GNU Affero General Public License as published by
+//   the Free Software Foundation, either version 3 of the License, or
+//   (at your option) any later version.
+//
+//   iTop 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 Affero General Public License for more details.
+//
+//   You should have received a copy of the GNU Affero General Public License
+//   along with iTop. If not, see <http://www.gnu.org/licenses/>
+//
+
+/**
+ * Created by PhpStorm.
+ * User: Eric
+ * Date: 30/10/2017
+ * Time: 13:43
+ */
+
+namespace Combodo\iTop\Test\UnitTest\Core;
+
+use Combodo\iTop\Test\UnitTest\ItopTestCase;
+use Dict;
+use Exception;
+
+
+/**
+ * @runTestsInSeparateProcesses
+ * @preserveGlobalState disabled
+ * @backupGlobals disabled
+ */
+class dictApcuTest extends ItopTestCase
+{
+	private $sEnvName;
+	private $oApcService;
+	private $sDictionaryFolder;
+
+	protected function setUp()
+	{
+		parent::setUp();
+		require_once (APPROOT.'core' . DIRECTORY_SEPARATOR . 'coreexception.class.inc.php');
+		require_once (APPROOT.'core' . DIRECTORY_SEPARATOR . 'dict.class.inc.php');
+		require_once (APPROOT.'core' . DIRECTORY_SEPARATOR . 'apc-service.class.inc.php');
+
+		$this->sEnvName = time();
+		$_SESSION['itop_env'] = $this->sEnvName;
+
+		$this->oApcService = $this->createMock(\ApcService::class);
+		Dict::SetApcService($this->oApcService);
+		Dict::EnableCache('toto');
+
+		Dict::SetLanguagesList(['FR FR' => 'fr', 'EN US' => 'en', 'DE DE' => 'de', 'RU RU' => 'de']);
+
+		$this->InitDictionnaries();
+	}
+
+	private function InitDictionnaries(){
+		clearstatcache();
+		$this->sDictionaryFolder = APPROOT."env-$this->sEnvName" . DIRECTORY_SEPARATOR . "dictionaries";
+		@mkdir($this->sDictionaryFolder, 0777, true);
+
+		$sLabels = <<<STR
+        'label1' => 'fr1',
+STR;
+		$this->InitDictionnary($this->sDictionaryFolder, 'FR FR', 'fr-fr', $sLabels);
+
+		$sLabels = <<<STR
+        'label1' => 'ru1',
+        'label2' => 'ru2',
+STR;
+		$this->InitDictionnary($this->sDictionaryFolder, 'RU RU', 'ru-ru', $sLabels);
+		$sLabels = <<<STR
+        'label1' => 'en1',
+        'label2' => 'en2',
+        'label3' => 'en3',
+STR;
+		$this->InitDictionnary($this->sDictionaryFolder, 'EN US', 'en-us', $sLabels);
+
+		clearstatcache();
+	}
+
+	private function InitDictionnary($sDictionaryFolder, $sLanguageCode, $sLanguageCodeInFilename, $sLabels){
+		$sContent = <<<PHP
+<?php
+//
+// Dictionary built by the compiler for the language "FR FR"
+//
+Dict::SetEntries('$sLanguageCode', array(
+        $sLabels
+));
+PHP;
+		file_put_contents($sDictionaryFolder . DIRECTORY_SEPARATOR . "$sLanguageCodeInFilename.dict.php", $sContent);
+	}
+
+	private function InitBrokenDictionnary($sDictionaryFolder, $sLanguageCode, $sLanguageCodeInFilename){
+		$sContent = <<<PHP
+<?php
+//
+// Dictionary built by the compiler for the language "FR FR"
+//
+Dict::SetEntries('$sLanguageCode', 'stringinsteadofanarray');
+PHP;
+		file_put_contents($sDictionaryFolder . DIRECTORY_SEPARATOR . "$sLanguageCodeInFilename.dict.php", $sContent);
+	}
+
+	protected function tearDown()
+	{
+		foreach (glob(APPROOT."env-$this->sEnvName" . DIRECTORY_SEPARATOR . "dictionaries" . DIRECTORY_SEPARATOR . "*") as $sFile){
+			unlink($sFile);
+		}
+		rmdir(APPROOT."env-$this->sEnvName" . DIRECTORY_SEPARATOR . "dictionaries");
+		rmdir(APPROOT."env-$this->sEnvName");
+	}
+
+	public function InitLangIfNeeded_NoApcProvider(){
+		return [
+			'apcu mocked' => [ 'bApcuMocked' => true ],
+			'integration test - apcu service like in production - install php-apcu before' => [ 'bApcuMocked' => false ],
+		];
+	}
+
+	/**
+	 * @dataProvider InitLangIfNeeded_NoApcProvider
+	 */
+	public function testInitLangIfNeeded_NoApc($bApcuMocked){
+		if ($bApcuMocked) {
+			$this->oApcService->expects($this->any())
+				->method('function_exists')
+				->willReturn(false);
+
+			$this->oApcService->expects($this->never())
+				->method('apc_fetch');
+
+			$this->oApcService->expects($this->never())
+				->method('apc_store');
+		} else {
+			Dict::SetApcService(null);
+		}
+
+		//EN US default language
+		$this->assertEquals('en1', Dict::S('label1'));
+		$this->assertEquals('en2', Dict::S('label2'));
+		$this->assertEquals('en3', Dict::S('label3'));
+		$this->assertEquals('not_defined_label', Dict::S('not_defined_label'));
+
+		//default language set to RU RU
+		Dict::SetDefaultLanguage('RU RU');
+		$this->assertEquals('ru1', Dict::S('label1'));
+		$this->assertEquals('ru2', Dict::S('label2'));
+		$this->assertEquals('en3', Dict::S('label3'));
+		$this->assertEquals('not_defined_label', Dict::S('not_defined_label'));
+
+		//user language set to FR FR
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('fr1', Dict::S('label1'));
+		$this->assertEquals('ru2', Dict::S('label2'));
+		$this->assertEquals('en3', Dict::S('label3'));
+		$this->assertEquals('not_defined_label', Dict::S('not_defined_label'));
+	}
+
+	public function testInitLangIfNeeded_Apc_LanguageMismatchDictionnary(){
+		//language mismatch!!
+		$sLabels = <<<STR
+        'label1' => 'de1',
+STR;
+		$this->InitDictionnary($this->sDictionaryFolder, 'RU RU', 'de-de', $sLabels);
+
+		clearstatcache();
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(false);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_fetch');
+
+		$this->oApcService->expects($this->never())
+			->method('apc_store');
+
+		Dict::SetUserLanguage('DE DE');
+		$this->assertEquals('label1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_Apc_BrokenUserDictionnary(){
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'DE DE', 'de-de');
+
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(false);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_fetch');
+
+		$this->oApcService->expects($this->never())
+			->method('apc_store');
+
+		Dict::SetUserLanguage('DE DE');
+		$this->assertEquals('en1', Dict::S('label1'));
+
+		Dict::SetDefaultLanguage('RU RU');
+		$this->assertEquals('ru1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_Apc_BrokenDictionnary_UserAndDefault(){
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'DE DE', 'de-de');
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'RU RU', 'ru-ru');
+
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(false);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_fetch');
+
+		$this->oApcService->expects($this->never())
+			->method('apc_store');
+
+		Dict::SetUserLanguage('DE DE');
+		Dict::SetDefaultLanguage('RU RU');
+		$this->assertEquals('en1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_Apc_BrokenDictionnary_ALL(){
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'DE DE', 'de-de');
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'RU RU', 'ru-ru');
+		$this->InitBrokenDictionnary($this->sDictionaryFolder, 'EN US', 'en-us');
+
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(false);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_fetch');
+
+		$this->oApcService->expects($this->never())
+			->method('apc_store');
+
+		Dict::SetUserLanguage('DE DE');
+		Dict::SetDefaultLanguage('RU RU');
+		$this->assertEquals('label1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_ApcFromCache_PropertyInUserDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(1))
+			->method('apc_fetch')
+			->with('toto-dict-FR FR')
+			->willReturn(['label1' => 'fr1']);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_store');
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('fr1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_ApcStore_PropertyInUserDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(1))
+			->method('apc_fetch')
+			->with('toto-dict-FR FR')
+			->willReturn(false);
+
+		$this->oApcService->expects($this->exactly(1))
+			->method('apc_store')
+			->with('toto-dict-FR FR', ['label1' => 'fr1']);
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('fr1', Dict::S('label1'));
+	}
+
+	//corrupted data not fixed
+	//we will return label from another dictionary (defaut one => russian here)
+	public function testInitLangIfNeeded_Apc_CorruptedCache_PropertyInUserDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(2))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'])
+			->willReturnOnConsecutiveCalls('corrupteddata', ['label1' => 'ru1']);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_store');
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('ru1', Dict::S('label1'));
+	}
+
+	public function testInitLangIfNeeded_Apc_PropertyInDefaultLanguageDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(2))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'])
+			->willReturnOnConsecutiveCalls([], false);
+
+		$this->oApcService->expects($this->exactly(1))
+			->method('apc_store')
+			->withConsecutive(['toto-dict-RU RU', ['label1' => 'ru1', 'label2' => 'ru2']]
+			);
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('ru2', Dict::S('label2'));
+	}
+
+	//corrupted data not fixed
+	//we will return label from default language dictionary (EN here)
+	public function testInitLangIfNeeded_ApcCorrupted_PropertyInDefaultLanguageDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(3))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'], ['toto-dict-EN US'])
+			->willReturnOnConsecutiveCalls([], 'corrupteddata', ['label1' => 'en1', 'label2' => 'en2', 'label3' => 'en3']);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_store');
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('en2', Dict::S('label2'));
+	}
+
+	public function testInitLangIfNeeded_Apc_PropertyInDictDefaultLanguageDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(3))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'], ['toto-dict-EN US'])
+			->willReturnOnConsecutiveCalls([], [], false);
+
+		$this->oApcService->expects($this->exactly(1))
+			->method('apc_store')
+			->withConsecutive(
+				['toto-dict-EN US', ['label1' => 'en1', 'label2' => 'en2', 'label3' => 'en3']]
+			);
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('en3', Dict::S('label3'));
+	}
+
+	public function testInitLangIfNeeded_ApcCorrupted_PropertyInDictDefaultLanguageDictionnary(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(3))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'], ['toto-dict-EN US'])
+			->willReturnOnConsecutiveCalls([], [], 'corrupteddata');
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_store');
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('label3', Dict::S('label3'));
+	}
+
+	public function testInitLangIfNeeded_Apc_PropertyNotFound(){
+		$this->oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(true);
+
+		$this->oApcService->expects($this->exactly(3))
+			->method('apc_fetch')
+			->withConsecutive(['toto-dict-FR FR'], ['toto-dict-RU RU'], ['toto-dict-EN US'])
+			->willReturnOnConsecutiveCalls([], [], []);
+
+		$this->oApcService->expects($this->exactly(0))
+			->method('apc_store');
+
+		Dict::SetDefaultLanguage('RU RU');
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('undefined_label', Dict::S('undefined_label'));
+	}
+}
--- a/test/core/dictTest.php
+++ b/test/core/dictTest.php
@@ -38,19 +38,83 @@ use Exception;
 */
 class dictTest extends ItopTestCase
 {
+	private $sEnvName;
+
 	protected function setUp()
 	{
 		parent::setUp();
-		require_once (APPROOT.'core/dict.class.inc.php');
-		require_once 'mockDict.incphp';
+
+		require_once(APPROOT.'core'.DIRECTORY_SEPARATOR.'apc-service.class.inc.php');
+
+		$this->sEnvName = time();
+		$sDictionaryFolder = APPROOT."env-$this->sEnvName".DIRECTORY_SEPARATOR."dictionaries";
+		@mkdir($sDictionaryFolder, 0777, true);
+
+		$sContent = <<<PHP
+<?php
+//
+// Dictionary built by the compiler for the language "FR FR"
+//
+Dict::SetEntries('FR FR', array(
+        'label1' => 'gabu',
+));
+PHP;
+		file_put_contents($sDictionaryFolder.DIRECTORY_SEPARATOR."fr-fr.dict.php", $sContent);
+		$sContent = <<<PHP
+<?php
+//
+// Dictionary built by the compiler for the language "FR FR"
+//
+Dict::SetEntries('EN EN', array(
+        'label1' => 'zomeu',
+));
+PHP;
+		file_put_contents($sDictionaryFolder.DIRECTORY_SEPARATOR."en-en.dict.php", $sContent);
+
+		$_SESSION['itop_env'] = $this->sEnvName;
 	}

-    /**
-     * @throws Exception
-     */
-    public function testType()
+	protected function tearDown()
 	{
+		foreach (glob(APPROOT."env-$this->sEnvName".DIRECTORY_SEPARATOR."dictionaries".DIRECTORY_SEPARATOR."*") as $sFile) {
+			unlink($sFile);
+		}
+		rmdir(APPROOT."env-$this->sEnvName".DIRECTORY_SEPARATOR."dictionaries");
+		rmdir(APPROOT."env-$this->sEnvName");
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function testType()
+	{
+		$_SESSION['itop_env'] = 'production';
 		$this->assertInternalType('string', Dict::S('Core:AttributeURL'));
 		$this->assertInternalType('string', Dict::Format('Change:AttName_SetTo', '1', '2'));
 	}
+
+	public function testInitLangIfNeeded_NoApc()
+	{
+		$oApcService = $this->createMock(\ApcService::class);
+		Dict::SetApcService($oApcService);
+		Dict::EnableCache('toto');
+
+		$oApcService->expects($this->any())
+			->method('function_exists')
+			->willReturn(false);
+
+		$oApcService->expects($this->never())
+			->method('apc_fetch')
+			->willReturn(false);
+
+		$oApcService->expects($this->never())
+			->method('apc_store')
+			->willReturn(false);
+
+		Dict::SetLanguagesList(['FR FR' => 'fr', 'EN EN' => 'en']);
+		Dict::SetUserLanguage('FR FR');
+		$this->assertEquals('gabu', Dict::S('label1'));
+		Dict::SetUserLanguage('EN EN');
+		$this->assertEquals('zomeu', Dict::S('label1'));
+	}
 }