diff --git a/core/dbobject.class.php b/core/dbobject.class.php index 5b1e3dd187..8543907963 100644 --- a/core/dbobject.class.php +++ b/core/dbobject.class.php @@ -57,7 +57,7 @@ require_once('mutex.class.inc.php'); /** - * A persistent object, as defined by the metamodel + * A persistent object, as defined by the metamodel * * @package iTopORM * @api @@ -299,9 +299,9 @@ abstract class DBObject implements iDisplay /** * Whether the object is already persisted in DB or not. - * + * * @api - * + * * @return bool */ public function IsNew() @@ -311,9 +311,9 @@ abstract class DBObject implements iDisplay /** * Returns an Id for memory objects - * + * * @internal - * + * * @param string $sClass * * @return int @@ -350,7 +350,7 @@ abstract class DBObject implements iDisplay $sRet .= "$sClass::$iPKey ($sFriendlyname)
\n"; return $sRet; } - + /** * Alias of DBObject::Reload() * @@ -373,7 +373,7 @@ abstract class DBObject implements iDisplay * * @internal * @see m_bFullyLoaded - * + * * @return bool * @throws CoreException */ @@ -496,7 +496,7 @@ abstract class DBObject implements iDisplay { $aAttList = $aAttToLoad[$sClassAlias]; } - + foreach($aAttList as $sAttCode=>$oAttDef) { // Skip links (could not be loaded by the mean of this query) @@ -556,7 +556,7 @@ abstract class DBObject implements iDisplay $bFullyLoaded = false; } } - + // Load extended data if ($aExtendedDataSpec != null) { @@ -580,7 +580,7 @@ abstract class DBObject implements iDisplay * * @internal * @see Set() - * + * * @param string $sAttCode * @param mixed $value */ @@ -785,11 +785,11 @@ abstract class DBObject implements iDisplay /** * Get the label of an attribute. - * + * * Shortcut to the field's AttributeDefinition->GetLabel() * * @api - * + * * @param string $sAttCode * * @return string @@ -862,7 +862,7 @@ abstract class DBObject implements iDisplay * * @internal * @see Get - * + * * @param string $sAttCode * * @return int|mixed|null @@ -967,7 +967,7 @@ abstract class DBObject implements iDisplay * Returns the default value of the $sAttCode. * * Returns the default value of the given attribute. - * + * * @internal * * @param string $sAttCode @@ -988,12 +988,12 @@ abstract class DBObject implements iDisplay * @internal * * @return array|null - */ + */ public function GetExtendedData() { return $this->m_aExtendedData; } - + /** * Set the HighlightCode * @@ -1015,7 +1015,7 @@ abstract class DBObject implements iDisplay { $fCurrentRank = $aHighlightScale[$this->m_sHighlightCode]['rank']; } - + if (array_key_exists($sCode, $aHighlightScale)) { $fRank = $aHighlightScale[$sCode]['rank']; @@ -1025,13 +1025,13 @@ abstract class DBObject implements iDisplay } } } - + /** * Get the current HighlightCode - * + * * @internal * @used-by DBObject::ComputeHighlightCode() - * + * * @return string|null The Hightlight code (null if none set, meaning rank = 0) */ protected function GetHighlightCode() @@ -1080,7 +1080,7 @@ abstract class DBObject implements iDisplay * corresponding to the external key and getting the value from it * * UNUSED ? - * + * * @internal * @todo: check if this is dead code. * @@ -1149,7 +1149,7 @@ abstract class DBObject implements iDisplay /** * @api - * + * * @param string $sAttCode * @param bool $bLocalize * @@ -1195,11 +1195,11 @@ abstract class DBObject implements iDisplay /** * Get the value as it must be in the edit areas (forms) - * + * * Makes a raw text representation of the value. * * @internal - * + * * @param string $sAttCode * * @return int|mixed|string @@ -1229,7 +1229,7 @@ abstract class DBObject implements iDisplay else { $sEditValue = 0; - } + } } else { @@ -1245,14 +1245,14 @@ abstract class DBObject implements iDisplay /** * Get $sAttCode formatted as XML - * + * * The returned value is a text that is suitable for insertion into an XML node. * Depending on the type of attribute, the returned text is either: * * A literal, with XML entities already escaped, * * XML * * @api - * + * * @param string $sAttCode * @param bool $bLocalize * @@ -1290,10 +1290,10 @@ abstract class DBObject implements iDisplay } /** - * + * * @see GetAsHTML() * @see GetOriginal() - * + * * @param string $sAttCode * @param bool $bLocalize * @@ -1468,7 +1468,7 @@ abstract class DBObject implements iDisplay /** * @internal - * + * * @param string $sClass * * @return mixed @@ -1523,7 +1523,7 @@ abstract class DBObject implements iDisplay * Get the id * * @api - * + * * @return string|null */ public function GetKey() @@ -1534,7 +1534,7 @@ abstract class DBObject implements iDisplay /** * Primary key Setter * Usable only for not yet persisted DBObjects - * + * * @internal * * @param int $iNewKey the desired identifier @@ -1547,7 +1547,7 @@ abstract class DBObject implements iDisplay { throw new CoreException("An object id must be an integer value ($iNewKey)"); } - + if ($this->m_bIsInDB && !empty($this->m_iKey) && ($this->m_iKey != $iNewKey)) { throw new CoreException("Changing the key ({$this->m_iKey} to $iNewKey) on an object (class {".get_class($this).") wich already exists in the Database"); @@ -1557,7 +1557,7 @@ abstract class DBObject implements iDisplay /** * Get the icon representing this object - * + * * @api * * @param boolean $bImgTag If true the result is a full IMG tag (or an empty string if no icon is defined) @@ -1647,7 +1647,7 @@ abstract class DBObject implements iDisplay * * Returns the label as defined in the dictionary for the language of the current user * - * @api + * @api * * @return string (empty for default name scheme) */ @@ -1714,7 +1714,7 @@ abstract class DBObject implements iDisplay /** * Helper to get the state - * + * * @api * * @return mixed|string '' if no state attribute, object representing its value otherwise @@ -1736,9 +1736,9 @@ abstract class DBObject implements iDisplay /** * Get the label (raw text) of the current state * helper for MetaModel::GetStateLabel() - * + * * @api - * + * * @return mixed|string * * @throws ArchivedObjectException @@ -1785,7 +1785,7 @@ abstract class DBObject implements iDisplay * Define attributes read-only from the end-user perspective * * @return array|null List of attcodes - */ + */ public static function GetReadOnlyAttributes() { return null; @@ -1794,14 +1794,14 @@ abstract class DBObject implements iDisplay /** * Get predefined objects - * + * * The predefined objects will be synchronized with the DB at each install/upgrade * As soon as a class has predefined objects, then nobody can create nor delete objects * * @internal * * @return array An array of id => array of attcode => php value(so-called "real value": integer, string, ormDocument, DBObjectSet, etc.) - */ + */ public static function GetPredefinedObjects() { return null; @@ -1930,7 +1930,7 @@ abstract class DBObject implements iDisplay * Note: Attributes (and flags) from the target state and the transition are combined. * * @internal - * + * * @param string $sStimulus * @param string $sOriginState Default is current state * @@ -2137,7 +2137,7 @@ abstract class DBObject implements iDisplay /** * @internal - * + * * @throws \CoreException * @throws \OQLException * @@ -2509,7 +2509,7 @@ abstract class DBObject implements iDisplay * * an array of displayable error is added in {@see DBObject::$m_aDeleteIssues} * - * @internal + * @internal * * @param \DeletionPlan $oDeletionPlan * @@ -2626,7 +2626,7 @@ abstract class DBObject implements iDisplay { // The value is a scalar, the comparison must be 100% strict if($this->m_aOrigValues[$sAtt] !== $proposedValue) - { + { //echo "$sAtt:
\n";
 					//var_dump($this->m_aOrigValues[$sAtt]);
 					//var_dump($proposedValue);
@@ -2748,7 +2748,7 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Used only by insert, Meant to be overloaded
-     * 
+     *
      * @overwritable-hook You can extend this method in order to provide your own logic.
 	 */
 	protected function OnObjectKeyReady()
@@ -2856,7 +2856,7 @@ abstract class DBObject implements iDisplay
 		// fields in first array, values in the second
 		$aFieldsToWrite = array();
 		$aValuesToWrite = array();
-		
+
 		if (!empty($this->m_iKey) && ($this->m_iKey >= 0))
 		{
 			// Add it to the list of fields to write
@@ -2865,7 +2865,7 @@ abstract class DBObject implements iDisplay
 		}
 
 		$aHierarchicalKeys = array();
-		
+
 		foreach(MetaModel::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef) {
 			// Skip this attribute if not defined in this table
 			if ((!MetaModel::IsAttributeOrigin($sTableClass, $sAttCode) && !$oAttDef->CopyOnAllTables())
@@ -2875,7 +2875,7 @@ abstract class DBObject implements iDisplay
 			$aAttColumns = $oAttDef->GetSQLValues($this->m_aCurrValues[$sAttCode]);
 			foreach($aAttColumns as $sColumn => $sValue)
 			{
-				$aFieldsToWrite[] = "`$sColumn`"; 
+				$aFieldsToWrite[] = "`$sColumn`";
 				$aValuesToWrite[] = CMDBSource::Quote($sValue);
 			}
 			if ($oAttDef->IsHierarchicalKey())
@@ -2899,7 +2899,7 @@ abstract class DBObject implements iDisplay
 					self::$m_aBulkInsertCols[$sClass][$sTable] = implode(', ', $aFieldsToWrite);
 				}
 				self::$m_aBulkInsertItems[$sClass][$sTable][] = '('.implode (', ', $aValuesToWrite).')';
-				
+
 				$iNewKey = 999999; // TODO - compute next id....
 			}
 			else
@@ -2984,7 +2984,7 @@ abstract class DBObject implements iDisplay
 		// fields in first array, values in the second
 		$aFieldsToWrite = array();
 		$aValuesToWrite = array();
-		
+
 		if (!empty($this->m_iKey) && ($this->m_iKey >= 0))
 		{
 			// Add it to the list of fields to write
@@ -3019,7 +3019,7 @@ abstract class DBObject implements iDisplay
 			$aAttColumns = $oAttDef->GetSQLValues($value);
 			foreach($aAttColumns as $sColumn => $sValue)
 			{
-				$aFieldsToWrite[] = "`$sColumn`"; 
+				$aFieldsToWrite[] = "`$sColumn`";
 				$aValuesToWrite[] = CMDBSource::Quote($sValue);
 			}
 			if ($oAttDef->IsHierarchicalKey())
@@ -3157,6 +3157,10 @@ abstract class DBObject implements iDisplay
 					// First query built upon on the root class, because the ID must be created first
 					$this->m_iKey = $this->DBInsertSingleTable($sRootClass);
 
+					//since N°5324: issue with test and db links events
+					$this->SetReadOnly('No modification allowed during transaction');
+					MetaModel::StartReentranceProtection($this);
+
 					// Then do the leaf class, if different from the root class
 					if ($sClass != $sRootClass) {
 						$this->DBInsertSingleTable($sClass);
@@ -3206,6 +3210,7 @@ abstract class DBObject implements iDisplay
 				}
 			}
 
+			$this->SetReadWrite();
 			$this->m_bIsInDB = true;
 			$this->m_bDirty = false;
 			foreach ($this->m_aCurrValues as $sAttCode => $value) {
@@ -3215,9 +3220,6 @@ abstract class DBObject implements iDisplay
 				$this->m_aOrigValues[$sAttCode] = $value;
 			}
 
-			// Prevent DBUpdate at this point (reentrance protection)
-			MetaModel::StartReentranceProtection($this);
-
 			try {
 				$this->PostInsertActions();
 			}
@@ -3293,7 +3295,7 @@ abstract class DBObject implements iDisplay
 		$this->RecordObjCreation();
 		return $ret;
 	}
-	
+
 	/**
 	 * This function is automatically called after cloning an object with the "clone" PHP language construct
 	 * The purpose of this method is to reset the appropriate attributes of the object in
@@ -3382,6 +3384,7 @@ abstract class DBObject implements iDisplay
 					}
 				}
 
+				$this->SetReadOnly('No modification allowed during transaction');
 				$iTransactionRetry = 1;
 				$bIsTransactionEnabled = MetaModel::GetConfig()->Get('db_core_transactions_enabled');
 				if ($bIsTransactionEnabled) {
@@ -3496,6 +3499,8 @@ abstract class DBObject implements iDisplay
 				// following lines are resetting changes (so after this {@see DBObject::ListChanges()} won't return changes anymore)
 				// new values are already in the object (call {@see DBObject::Get()} to get them)
 				// call {@see DBObject::ListPreviousValuesForUpdatedAttributes()} to get changed fields and previous values
+
+				$this->SetReadWrite();
 				$this->m_bDirty = false;
 				$this->m_aTouchedAtt = array();
 				$this->m_aModifiedAtt = array();
@@ -3909,7 +3914,7 @@ abstract class DBObject implements iDisplay
      * First, checks if the object can be deleted regarding database integrity.
      * If the answer is yes, it performs any required cleanup (delete other objects or reset external keys) in addition to the object
      * deletion.
-     * 
+     *
      * @api
      *
      * @param \DeletionPlan $oDeletionPlan Do not use: aims at dealing with recursion
@@ -4332,7 +4337,7 @@ abstract class DBObject implements iDisplay
      *
      * @api
      *
-	 */	 	
+	 */
 	public function Reset($sAttCode)
 	{
 		$this->Set($sAttCode, $this->GetDefaultValue($sAttCode));
@@ -4344,7 +4349,7 @@ abstract class DBObject implements iDisplay
      * Suitable for use as a lifecycle action
      *
      * @api
-	 */	 	
+	 */
 	public function Copy($sDestAttCode, $sSourceAttCode)
 	{
 		$oTypeValueToCopy = MetaModel::GetAttributeDef(get_class($this), $sSourceAttCode);
@@ -4674,7 +4679,7 @@ abstract class DBObject implements iDisplay
 			{
 				throw new CoreException("Unknown attribute '$sExtKeyAttCode' for the class ".get_class($this));
 			}
-			
+
 			$oKeyAttDef = MetaModel::GetAttributeDef(get_class($this), $sExtKeyAttCode);
 			if (!$oKeyAttDef instanceof AttributeExternalKey)
 			{
@@ -4692,14 +4697,14 @@ abstract class DBObject implements iDisplay
 				$ret  = $oRemoteObj->GetForTemplate($sRemoteAttCode);
 			}
 		}
-		else 
+		else
 		{
 			switch($sPlaceholderAttCode)
 			{
 				case 'id':
 				$ret = $this->GetKey();
 				break;
-				
+
 				case 'name()':
 				$ret = $this->GetName();
 				break;
@@ -4886,7 +4891,7 @@ abstract class DBObject implements iDisplay
 		if ($oOwner)
 		{
 			$sLinkSetOwnerClass = get_class($oOwner);
-			
+
 			$oMyChangeOp = MetaModel::NewObject($sChangeOpClass);
 			$oMyChangeOp->Set("objclass", $sLinkSetOwnerClass);
 			$oMyChangeOp->Set("objkey", $iLinkSetOwnerId);
@@ -4913,7 +4918,7 @@ abstract class DBObject implements iDisplay
 		{
 			/** @var \AttributeLinkedSet $oLinkSet */
 			if (($oLinkSet->GetTrackingLevel() & LINKSET_TRACKING_LIST) == 0) continue;
-			
+
 			$iLinkSetOwnerId  = $this->Get($sExtKeyAttCode);
 			$oMyChangeOp = $this->PrepareChangeOpLinkSet($iLinkSetOwnerId, $oLinkSet, 'CMDBChangeOpSetAttributeLinksAddRemove');
 			if ($oMyChangeOp)
@@ -4983,7 +4988,7 @@ abstract class DBObject implements iDisplay
 				// Keep track of link changes
 				//
 				if (($oLinkSet->GetTrackingLevel() & LINKSET_TRACKING_DETAILS) == 0) continue;
-				
+
 				$iLinkSetOwnerId  = $this->Get($sExtKeyAttCode);
 				$oMyChangeOp = $this->PrepareChangeOpLinkSet($iLinkSetOwnerId, $oLinkSet, 'CMDBChangeOpSetAttributeLinksTune');
 				if ($oMyChangeOp)
@@ -5132,7 +5137,7 @@ abstract class DBObject implements iDisplay
 		$this->FireEventCheckToDelete($oDeletionPlan);
 		$this->DoCheckToDelete($oDeletionPlan);
 		$oDeletionPlan->SetDeletionIssues($this, $this->m_aDeleteIssues, $this->m_bSecurityIssue);
-	
+
 		$aDependentObjects = $this->GetReferencingObjects(true /* allow all data */);
 
 		// Getting and setting time limit are not symmetric:
@@ -5314,7 +5319,7 @@ abstract class DBObject implements iDisplay
 				$aSynchroClasses[] = $sTarget;
 			}
 		}
-		
+
 		foreach($aSynchroClasses as $sClass)
 		{
 			if ($this instanceof $sClass)
diff --git a/core/metamodel.class.php b/core/metamodel.class.php
index 7e3b8cdc85..eef5783aa8 100644
--- a/core/metamodel.class.php
+++ b/core/metamodel.class.php
@@ -1241,7 +1241,7 @@ abstract class MetaModel
 			}
 			$sTable = self::DBGetTable($sClass);
 
-			// Could be completed later with all the classes that are using a given table 
+			// Could be completed later with all the classes that are using a given table
 			if (!array_key_exists($sTable, $aTables)) {
 				$aTables[$sTable] = array();
 			}
@@ -3522,7 +3522,7 @@ abstract class MetaModel
 		}
 
 		// Set the "host class" as soon as possible, since HierarchicalKeys use it for their 'target class' as well
-		// and this needs to be know early (for Init_IsKnowClass 19 lines below)		
+		// and this needs to be know early (for Init_IsKnowClass 19 lines below)
 		$oAtt->SetHostClass($sTargetClass);
 
 		// Some attributes could refer to a class
@@ -3564,7 +3564,7 @@ abstract class MetaModel
 
 		self::$m_aAttribDefs[$sTargetClass][$oAtt->GetCode()] = $oAtt;
 		self::$m_aAttribOrigins[$sTargetClass][$oAtt->GetCode()] = $sTargetClass;
-		// Note: it looks redundant to put targetclass there, but a mix occurs when inheritance is used		
+		// Note: it looks redundant to put targetclass there, but a mix occurs when inheritance is used
 	}
 
 	/**
@@ -3764,7 +3764,7 @@ abstract class MetaModel
 		self::$m_aStimuli[$sTargetClass][$oStimulus->GetCode()] = $oStimulus;
 
 		// I wanted to simplify the syntax of the declaration of objects in the biz model
-		// Therefore, the reference to the host class is set there 
+		// Therefore, the reference to the host class is set there
 		$oStimulus->SetHostClass($sTargetClass);
 	}
 
@@ -6470,7 +6470,7 @@ abstract class MetaModel
 				$aCache['m_aExtensionClassNames'] = self::$m_aExtensionClassNames;
 				$aCache['m_Category2Class'] = self::$m_Category2Class;
 				$aCache['m_aRootClasses'] = self::$m_aRootClasses; // array of "classname" => "rootclass"
-				$aCache['m_aParentClasses'] = self::$m_aParentClasses; // array of ("classname" => array of "parentclass") 
+				$aCache['m_aParentClasses'] = self::$m_aParentClasses; // array of ("classname" => array of "parentclass")
 				$aCache['m_aChildClasses'] = self::$m_aChildClasses; // array of ("classname" => array of "childclass")
 				$aCache['m_aClassParams'] = self::$m_aClassParams; // array of ("classname" => array of class information)
 				$aCache['m_aAttribDefs'] = self::$m_aAttribDefs; // array of ("classname" => array of attributes)
@@ -7567,6 +7567,20 @@ abstract class MetaModel
 		return false;
 	}
 
+	/**
+	 * @since 3.1.0 N°5324: to ease reentrance checks when using events on links (to avoid reentering if main link object ongoing operation)
+	 */
+	public static function GetReentranceObjectByChildClass(string $sParentClass, $sKey)
+	{
+		foreach (self::EnumChildClasses($sParentClass, ENUM_CHILD_CLASSES_ALL, false) as $sChildClass){
+			if (self::GetReentranceObject($sChildClass, $sKey)){
+				return true;
+			}
+		}
+
+		return false;
+	}
+
 	/**
 	 * @param \DBObject $oObject
 	 *