💡 N°3513 PHPDoc

Regression introduced by b1ca1f2630 / N°3513

.editorconfig

@@ -280,17 +280,17 @@ ij_javascript_while_brace_force = always
 ij_javascript_while_on_new_line = false
 ij_javascript_wrap_comments = false
 
-[{*.ctp,*.hphp,*.inc,*.module,*.php,*.php4,*.php5,*.phtml}]
+[{*.ctp, *.hphp, *.inc, *.module, *.php, *.php4, *.php5, *.phtml}]
 indent_style = tab
 ij_continuation_indent_size = 4
 ij_smart_tabs = true
 ij_wrap_on_typing = false
-ij_php_align_assignments = false
+ij_php_align_assignments = true
 ij_php_align_class_constants = false
 ij_php_align_group_field_declarations = false
 ij_php_align_inline_comments = false
-ij_php_align_key_value_pairs = false
-ij_php_align_multiline_array_initializer_expression = false
+ij_php_align_key_value_pairs = true
+ij_php_align_multiline_array_initializer_expression = true
 ij_php_align_multiline_binary_operation = false
 ij_php_align_multiline_chained_methods = false
 ij_php_align_multiline_extends_list = false

.make/license/updateLicenses.php

@@ -10,10 +10,6 @@
  *       `curl -L -o /usr/bin/jq.exe https://github.com/stedolan/jq/releases/latest/download/jq-win64.exe`
  *    this is a Windows port : https://stedolan.github.io/jq/
  *
- * Known bug on Windows :
- *   Licenses added from Composer contains a path in the product node (N°3870)
- *   `<product scope="lib">C:\Dev\wamp64\www\itop-dev\.make\license/../..//lib/symfony/console</product>`
- *
  * Licenses sources :
  *  * `composer licenses --format json` (see https://getcomposer.org/doc/03-cli.md#licenses)
  *  * keep every existing nodes with `/licenses/license[11]/product/@scope` not in ['lib', 'datamodels']
@@ -70,39 +66,83 @@ function get_license_nodes($file_path)
 	$xp = new DOMXPath($dom);
 
 	$licenseList = $xp->query('/licenses/license');
-	$licenses = iterator_to_array($licenseList);
+	$licenses    = iterator_to_array($licenseList);
 
 	usort($licenses, 'sort_by_product');
+
 	return $licenses;
 }
 
+/** @noinspection SuspiciousAssignmentsInspection */
+function fix_product_name(DOMNode &$oProductNode)
+{
+	$sProductNameOrig = $oProductNode->nodeValue;
+
+	// sample : `C:\Dev\wamp64\www\itop-27\.make\license/../..//lib/symfony/polyfill-ctype`
+	$sProductNameFixed = remove_dir_from_string($sProductNameOrig, 'lib/');
+
+	// sample : `C:\Dev\wamp64\www\itop-27\.make\license/../..//datamodels/2.x/authent-cas/vendor/apereo/phpcas`
+	$sProductNameFixed = remove_dir_from_string($sProductNameFixed, 'vendor/');
+
+	$oProductNode->nodeValue = $sProductNameFixed;
+}
+
+function remove_dir_from_string($sString, $sNeedle)
+{
+	if (strpos($sString, $sNeedle) === false) {
+		return $sString;
+	}
+
+	$sStringTmp   = strstr($sString, $sNeedle);
+	$sStringFixed = str_replace($sNeedle, '', $sStringTmp);
+
+	// DEBUG trace O:)
+//	echo "$sNeedle = $sString => $sStringFixed\n";
+
+	return $sStringFixed;
+}
+
 $old_licenses = get_license_nodes($xmlFilePath);
 
 //generate file with updated licenses
 $generated_license_file_path = __DIR__."/provfile.xml";
-exec("bash " . __DIR__ . "/gen-community-license.sh $iTopFolder > ". $generated_license_file_path);
+echo "- Generating licences...";
+exec("bash ".__DIR__."/gen-community-license.sh $iTopFolder > ".$generated_license_file_path);
+echo "OK!\n";
+
+echo "- Get licenses nodes...";
 $new_licenses = get_license_nodes($generated_license_file_path);
-exec("rm -f ". $generated_license_file_path);
+unlink($generated_license_file_path);
 
 foreach ($old_licenses as $b) {
 	$aProductNode = get_product_node($b);
 
-	if (get_scope($aProductNode) !== "lib" && get_scope($aProductNode) !== "datamodels" )
-	{
+	if (get_scope($aProductNode) !== "lib" && get_scope($aProductNode) !== "datamodels") {
 		$new_licenses[] = $b;
 	}
 }
 
 usort($new_licenses, 'sort_by_product');
+echo "OK!\n";
 
+echo "- Overwritting Combodo license file...";
 $new_dom = new DOMDocument("1.0");
 $new_dom->formatOutput = true;
 $root = $new_dom->createElement("licenses");
 $new_dom->appendChild($root);
 
 foreach ($new_licenses as $b) {
-	$node = $new_dom->importNode($b,true);
-	$root->appendChild($new_dom->importNode($b,true));
+	$node = $new_dom->importNode($b, true);
+
+	// N°3870 fix when running script in Windows
+	// fix should be in gen-community-license.sh but it is easier to do it here !
+	if (strncasecmp(PHP_OS, 'WIN', 3) === 0) {
+		$oProductNodeOrig = get_product_node($node);
+		fix_product_name($oProductNodeOrig);
+	}
+
+	$root->appendChild($node);
 }
 
-$new_dom->save($xmlFilePath);
+$new_dom->save($xmlFilePath);
+echo "OK!\n";

core/cmdbsource.class.inc.php

@@ -154,6 +154,16 @@ class CMDBSource
 
 	/** @var mysqli $m_oMysqli */
 	protected static $m_oMysqli;
+	/**
+	 * The mysqli object is really hard to mock ! This attribute is used only in certain methods, so that we can mock only a very little subset of the mysqli object.
+	 * We are setting it in {@see Init}, by default it is a copy of {@see $m_oMysqli}
+	 * The mock can be injected using the setter {@see SetMySQLiForQuery}
+	 *
+	 * @var mysqli $oMySQLiForQuery
+	 * @see GetMySQLiForQuery
+	 * @see SetMySQLiForQuery
+	 * @since 2.7.5 N°3513 new var to allow mock in tests ({@see \Combodo\iTop\Test\UnitTest\Core\TransactionsTest})
+	 */
 	protected static $oMySQLiForQuery;
 
 	/**
@@ -235,6 +245,8 @@ class CMDBSource
 	 *
 	 * @return \mysqli
 	 * @throws \MySQLException
+	 *
+	 * @uses IsOpenedDbConnectionUsingTls when asking for a TLS connection, to check if it was really opened using TLS
 	 */
 	public static function GetMysqliInstance(
 		$sDbHost, $sUser, $sPwd, $sSource = '', $bTlsEnabled = false, $sTlsCa = null, $bCheckTlsAfterConnection = false
@@ -337,41 +349,41 @@ class CMDBSource
 	 * parameters were used.<br>
 	 * This method can be called to ensure that the DB connection really uses TLS.
 	 *
-	 * <p>We're using this object connection : {@link self::$m_oMysqli}
+	 * <p>We're using our own mysqli instance to do the check as this check is done when creating the mysqli instance : the consumer
+	 * might want a dedicated object, and if so we don't want to overwrite the one saved in CMDBSource !<br>
+	 * This is the case for example with {@see \iTopMutex} !
 	 *
 	 * @param \mysqli $oMysqli
 	 *
-	 * @return boolean true if the connection was really established using TLS
+	 * @return boolean true if the connection was really established using TLS, false otherwise
 	 * @throws \MySQLException
 	 *
+	 * @used-by GetMysqliInstance
 	 * @uses IsMySqlVarNonEmpty
+	 * @uses 'ssl_version' MySQL var
+	 * @uses 'ssl_cipher' MySQL var
 	 */
 	private static function IsOpenedDbConnectionUsingTls($oMysqli)
 	{
-		if (self::$m_oMysqli == null)
-		{
-			self::$m_oMysqli = $oMysqli;
-		}
-
-		$bNonEmptySslVersionVar = self::IsMySqlVarNonEmpty('ssl_version');
-		$bNonEmptySslCipherVar = self::IsMySqlVarNonEmpty('ssl_cipher');
+		$bNonEmptySslVersionVar = self::IsMySqlVarNonEmpty('ssl_version', $oMysqli);
+		$bNonEmptySslCipherVar = self::IsMySqlVarNonEmpty('ssl_cipher', $oMysqli);
 
 		return ($bNonEmptySslVersionVar && $bNonEmptySslCipherVar);
 	}
 
 	/**
 	 * @param string $sVarName
+	 * @param mysqli $oMysqli connection to use for the query
 	 *
 	 * @return bool
 	 * @throws \MySQLException
-	 *
-	 * @uses SHOW STATUS queries
+	 * @uses 'SHOW SESSION STATUS' queries
 	 */
-	private static function IsMySqlVarNonEmpty($sVarName)
+	private static function IsMySqlVarNonEmpty($sVarName, $oMysqli)
 	{
 		try
 		{
-			$sResult = self::QueryToScalar("SHOW SESSION STATUS LIKE '$sVarName'", 1);
+			$sResult = self::QueryToScalar("SHOW SESSION STATUS LIKE '$sVarName'", 1, $oMysqli);
 		}
 		catch (MySQLQueryHasNoResultException $e)
 		{
@@ -709,7 +721,7 @@ class CMDBSource
 		{
 			$aContext = array('query' => $sSql);
 
-			$iMySqlErrorNo = self::$m_oMysqli->errno;
+			$iMySqlErrorNo = self::GetMySQLiForQuery()->errno;
 			$aMySqlHasGoneAwayErrorCodes = MySQLHasGoneAwayException::getErrorCodes();
 			if (in_array($iMySqlErrorNo, $aMySqlHasGoneAwayErrorCodes))
 			{
@@ -731,7 +743,7 @@ class CMDBSource
 	private static function LogDeadLock(Exception $e)
 	{
 		// checks MySQL error code
-		$iMySqlErrorNo = self::$m_oMysqli->errno;
+		$iMySqlErrorNo = self::GetMySQLiForQuery()->errno;
 		if (!in_array($iMySqlErrorNo, array(self::MYSQL_ERRNO_WAIT_TIMEOUT, self::MYSQL_ERRNO_DEADLOCK)))
 		{
 			return;
@@ -739,7 +751,7 @@ class CMDBSource
 
 		// Get error info
 		$sUser = UserRights::GetUser();
-		$oError = self::$m_oMysqli->query('SHOW ENGINE INNODB STATUS');
+		$oError = self::GetMySQLiForQuery()->query('SHOW ENGINE INNODB STATUS');
 		if ($oError !== false)
 		{
 			$aData = $oError->fetch_all(MYSQLI_ASSOC);
@@ -967,17 +979,21 @@ class CMDBSource
 	/**
 	 * @param string $sSql
 	 * @param int $iCol beginning at 0
+	 * @param mysqli $oMysqli if not null will query using this connection, otherwise will use {@see GetMySQLiForQuery}
 	 *
 	 * @return string corresponding cell content on the first line
 	 * @throws \MySQLException
 	 * @throws \MySQLQueryHasNoResultException
+	 * @since 2.7.5-2 2.7.6 3.0.0 N°4215 new optional mysqli param
 	 */
-	public static function QueryToScalar($sSql, $iCol = 0)
+	public static function QueryToScalar($sSql, $iCol = 0, $oMysqli = null)
 	{
+		$oMysqliToQuery = (is_null($oMysqli)) ? self::GetMySQLiForQuery() : $oMysqli;
+
 		$oKPI = new ExecutionKPI();
 		try
 		{
-			$oResult = self::GetMySQLiForQuery()->query($sSql);
+			$oResult = $oMysqliToQuery->query($sSql);
 		}
 		catch(mysqli_sql_exception $e)
 		{

datamodels/2.x/itop-portal-base/portal/src/Controller/ManageBrickController.php

@@ -813,15 +813,15 @@ class ManageBrickController extends BrickController
 					'iItemsCount' => $oSet->Count(),
 					'aColumnsDefinition' => $aColumnsDefinition,
 				);
-			}
 
-			IssueLog::Debug('Portal ManageBrick query', LogChannels::PORTAL, array(
-				'sPortalId' => $sPortalId,
-				'sBrickId' => $sBrickId,
-				'sGroupingTab' => $sGroupingTab,
-				'oql' => $oSet->GetFilter()->ToOQL(),
-				'aGroupingTabs' => $aGroupingTabs,
-			));
+				IssueLog::Debug('Portal ManageBrick query', LogChannels::PORTAL, array(
+					'sPortalId' => $sPortalId,
+					'sBrickId' => $sBrickId,
+					'sGroupingTab' => $sGroupingTab,
+					'oql' => $oSet->GetFilter()->ToOQL(),
+					'aGroupingTabs' => $aGroupingTabs,
+				));
+			}
 		} else {
 			$aGroupingAreasData = array();
 			$sGroupingArea = null;

setup/compiler.class.inc.php

@@ -58,7 +58,7 @@ class MFCompiler
 	 * @var string
 	 * @since 2.7.5 3.0.0 N°4020
 	 */
-	public const REBUILD_HKEYS_NEVER= APPROOT.'data/.setup-rebuild-hkeys-never';
+	const REBUILD_HKEYS_NEVER = APPROOT.'data/.setup-rebuild-hkeys-never';
 
 	/** @var \ModelFactory */
 	protected $oFactory;

test/application/UtilsTest.php

@@ -443,10 +443,10 @@ class UtilsTest extends \Combodo\iTop\Test\UnitTest\ItopTestCase
 	{
 		return [
 			'123 int value' => ['123', 123],
-			'-1 no limit' => ['-1', -1],
-			'56k' => ['56k', 56 * 1024],
-			'512M' => ['512M', 512 * 1024 * 1024],
-			'2G' => ['2G', 2 * 1024 * 1024 * 1024],
+			'-1 no limit'   => ['-1', -1],
+			'56k'           => ['56k', 56 * 1024],
+			'512M'          => ['512M', 512 * 1024 * 1024],
+			'2G'            => ['2G', 2 * 1024 * 1024 * 1024],
 		];
 	}
 }

test/core/CMDBSource/CMDBSourceTest.php

@@ -5,6 +5,7 @@ namespace Combodo\iTop\Test\UnitTest\Core;
 
 use CMDBSource;
 use Combodo\iTop\Test\UnitTest\ItopTestCase;
+use utils;
 
 /**
  * @since 2.7.0
@@ -115,4 +116,23 @@ class CMDBSourceTest extends ItopTestCase
 			),
 		);
 	}
+
+	/**
+	 * @throws \ConfigException
+	 * @throws \CoreException
+	 * @throws \MySQLException
+	 * @since 3.0.0 N°4215
+	 */
+	public function testIsOpenedDbConnectionUsingTls() {
+		$oConfig = utils::GetConfig();
+		CMDBSource::InitFromConfig($oConfig);
+		$oMysqli = CMDBSource::GetMysqli();
+
+		// resets \CMDBSource::$oMySQLiForQuery to simulate call to \CMDBSource::Init with a TLS connexion
+		$this->InvokeNonPublicStaticMethod(CMDBSource::class, 'SetMySQLiForQuery',[null]);
+
+		// before N°4215 fix, this was crashing : "Call to a member function query() on null"
+		$bIsTlsCnx = $this->InvokeNonPublicStaticMethod(CMDBSource::class, 'IsOpenedDbConnectionUsingTls',[$oMysqli]);
+		$this->assertFalse($bIsTlsCnx);
+	}
 }