NEW : Factoring and Fix external module elementType limit

htdocs/core/class/commonobject.class.php

@@ -3828,11 +3828,9 @@ public function add_object_linked($origin = null, $origin_id = null, $f_user = n
 			$origin = 'order_supplier';
 		}
 
-		// Elements of the core modules which have `$module` property but may to which we don't want to prefix module part to the element name for finding the linked object in llx_element_element.
-		// It's because an entry for this element may be exist in llx_element_element before this modification (version <=14.2) and ave named only with their element name in fk_source or fk_target.
-		$coremodule = array('knowledgemanagement', 'partnership', 'workstation', 'ticket', 'recruitment', 'eventorganization', 'asset');
-		// Add module part to target type if object has $module property and isn't in core modules.
-		$targettype = ((!empty($this->module) && ! in_array($this->module, $coremodule)) ? $this->module.'_' : '').$this->element;
+
+		// Add module part to target type
+		$targettype = $this->getElementType();
 
 		$parameters = array('targettype'=>$targettype);
 		// Hook for explicitly set the targettype if it must be differtent than $this->element
@@ -3882,6 +3880,19 @@ public function add_object_linked($origin = null, $origin_id = null, $f_user = n
 		}
 	}
 
+	/**
+	 * return element type string formated like element_element target_type and source_type
+	 * @return string
+	 */
+	public function getElementType()
+	{
+		// Elements of the core modules having a `$module` property but for which we may not not want to prefix the element name with the module name for finding the linked object in llx_element_element.
+		// It's because existing llx_element_element entries inserted prior to this modification (version <=14.2) may already use the element name alone in fk_source or fk_target (without the module name prefix).
+		$coremodule = array('knowledgemanagement', 'partnership', 'workstation', 'ticket', 'recruitment', 'eventorganization', 'asset');
+		// Add module part to target type if object has $module property and isn't in core modules.
+		return ((!empty($this->module) && ! in_array($this->module, $coremodule)) ? $this->module.'_' : '').$this->element;
+	}
+
 	/**
 	 *	Fetch array of objects linked to current object (object of enabled modules only). Links are loaded into
 	 *		this->linkedObjectsIds array +
@@ -4008,95 +4019,19 @@ public function fetchObjectLinked($sourceid = null, $sourcetype = '', $targetid
 			if (!empty($this->linkedObjectsIds)) {
 				$tmparray = $this->linkedObjectsIds;
 				foreach ($tmparray as $objecttype => $objectids) {       // $objecttype is a module name ('facture', 'mymodule', ...) or a module name with a suffix ('project_task', 'mymodule_myobj', ...)
-					// Parse element/subelement (ex: project_task, cabinetmed_consultation, ...)
-					$module = $element = $subelement = $objecttype;
-					$regs = array();
-					if ($objecttype != 'supplier_proposal' && $objecttype != 'order_supplier' && $objecttype != 'invoice_supplier'
-						&& preg_match('/^([^_]+)_([^_]+)/i', $objecttype, $regs)) {
-						$module = $element = $regs[1];
-						$subelement = $regs[2];
-					}
+					$element_properties = getElementProperties($objecttype);
+					$element = $element_properties['element'];
+					$classpath = $element_properties['classpath'];
+					$classfile = $element_properties['classfile'];
+					$classname = $element_properties['classname'];
+					$module = $element_properties['module'];
 
-					$classpath = $element.'/class';
-					// To work with non standard classpath or module name
-					if ($objecttype == 'facture') {
-						$classpath = 'compta/facture/class';
-					} elseif ($objecttype == 'facturerec') {
-						$classpath = 'compta/facture/class';
-						$module = 'facture';
-					} elseif ($objecttype == 'propal') {
-						$classpath = 'comm/propal/class';
-					} elseif ($objecttype == 'supplier_proposal') {
-						$classpath = 'supplier_proposal/class';
-					} elseif ($objecttype == 'shipping') {
-						$classpath = 'expedition/class';
-						$subelement = 'expedition';
-						$module = 'expedition_bon';
-					} elseif ($objecttype == 'delivery') {
-						$classpath = 'delivery/class';
-						$subelement = 'delivery';
-						$module = 'delivery_note';
-					} elseif ($objecttype == 'invoice_supplier' || $objecttype == 'order_supplier') {
-						$classpath = 'fourn/class';
-						$module = 'fournisseur';
-					} elseif ($objecttype == 'fichinter') {
-						$classpath = 'fichinter/class';
-						$subelement = 'fichinter';
-						$module = 'ficheinter';
-					} elseif ($objecttype == 'subscription') {
-						$classpath = 'adherents/class';
-						$module = 'adherent';
-					} elseif ($objecttype == 'contact') {
-						 $module = 'societe';
-					}
-					// Set classfile
-					$classfile = strtolower($subelement);
-					$classname = ucfirst($subelement);
-
-					if ($objecttype == 'order') {
-						$classfile = 'commande';
-						$classname = 'Commande';
-					} elseif ($objecttype == 'invoice_supplier') {
-						$classfile = 'fournisseur.facture';
-						$classname = 'FactureFournisseur';
-					} elseif ($objecttype == 'order_supplier') {
-						$classfile = 'fournisseur.commande';
-						$classname = 'CommandeFournisseur';
-					} elseif ($objecttype == 'supplier_proposal') {
-						$classfile = 'supplier_proposal';
-						$classname = 'SupplierProposal';
-					} elseif ($objecttype == 'facturerec') {
-						$classfile = 'facture-rec';
-						$classname = 'FactureRec';
-					} elseif ($objecttype == 'subscription') {
-						$classfile = 'subscription';
-						$classname = 'Subscription';
-					} elseif ($objecttype == 'project' || $objecttype == 'projet') {
-						$classpath = 'projet/class';
-						$classfile = 'project';
-						$classname = 'Project';
-					} elseif ($objecttype == 'conferenceorboothattendee') {
-						$classpath = 'eventorganization/class';
-						$classfile = 'conferenceorboothattendee';
-						$classname = 'ConferenceOrBoothAttendee';
-						$module = 'eventorganization';
-					} elseif ($objecttype == 'conferenceorbooth') {
-						$classpath = 'eventorganization/class';
-						$classfile = 'conferenceorbooth';
-						$classname = 'ConferenceOrBooth';
-						$module = 'eventorganization';
-					} elseif ($objecttype == 'mo') {
-						$classpath = 'mrp/class';
-						$classfile = 'mo';
-						$classname = 'Mo';
-						$module = 'mrp';
-					}
 
 					// Here $module, $classfile and $classname are set, we can use them.
 					if (isModEnabled($module) && (($element != $this->element) || $alsosametype)) {
 						if ($loadalsoobjects && (is_numeric($loadalsoobjects) || ($loadalsoobjects === $objecttype))) {
 							dol_include_once('/'.$classpath.'/'.$classfile.'.class.php');
-							//print '/'.$classpath.'/'.$classfile.'.class.php '.class_exists($classname);
+
 							if (class_exists($classname)) {
 								foreach ($objectids as $i => $objectid) {	// $i is rowid into llx_element_element
 									$object = new $classname($this->db);

htdocs/core/db/DoliDB.class.php

@@ -359,6 +359,7 @@ public function getRow($sql)
 		if ($res) {
 			$obj = $this->fetch_object($res);
 			if ($obj) {
+				$this->free($res);
 				return $obj;
 			} else {
 				return 0;
@@ -375,7 +376,6 @@ public function getRow($sql)
 	 *
 	 * @param 	string 		$sql 		The sql query string
 	 * @return 	bool|array				Result
-	 * @deprecated
 	 */
 	public function getRows($sql)
 	{
@@ -387,6 +387,8 @@ public function getRows($sql)
 					$results[] = $obj;
 				}
 			}
+
+			$this->free($res);
 			return $results;
 		}
 

htdocs/core/lib/functions.lib.php

@@ -10866,6 +10866,7 @@ function dolGetButtonTitle($label, $helpText = '', $iconClass = 'fa fa-file', $u
  */
 function getElementProperties($element_type)
 {
+	global $db, $hookmanager;
 	$regs = array();
 
 	$classfile = $classname = $classpath = '';
@@ -10986,35 +10987,113 @@ function getElementProperties($element_type)
 		'classfile' => $classfile,
 		'classname' => $classname
 	);
+
+
+	// Add  hook
+	if (!is_object($hookmanager)) {
+		include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
+		$hookmanager = new HookManager($db);
+	}
+	$hookmanager->initHooks(array('elementproperties'));
+
+
+	// Hook params
+	$parameters = array(
+		'element_type' => $element_type,
+		'element_properties' => $element_properties
+	);
+
+	$reshook = $hookmanager->executeHooks('getElementProperties', $parameters);
+
+	if ($reshook) {
+		$element_properties = $hookmanager->resArray;
+	} else {
+		foreach ($hookmanager->resArray as $k => $desc) {
+			$element_properties[$k] = $desc;
+		}
+	}
+
+	// context of elementproperties doesn't need to exist out of this function so delete it to avoid elementproperties is equal to all
+	if (($key = array_search('elementproperties', $hookmanager->contextarray)) !== false) {
+		unset($hookmanager->contextarray[$key]);
+	}
+
 	return $element_properties;
 }
 
 /**
  * Fetch an object from its id and element_type
  * Inclusion of classes is automatic
  *
- * @param	int     	$element_id 	Element id
- * @param	string  	$element_type 	Element type
- * @param	string     	$element_ref 	Element ref (Use this or element_id but not both)
- * @return 	int|object 					object || 0 || -1 if error
+ * @param int $element_id Element id
+ * @param string $element_type Element type
+ * @param string $element_ref Element ref (Use this or element_id but not both)
+ * @param bool $useCache if you want to store object in cache
+ * @param int $maxCacheByType number of object in cache for this element type
+ * @return    int|object                    object || 0 || -1 if error
  */
-function fetchObjectByElement($element_id, $element_type, $element_ref = '')
+function fetchObjectByElement($element_id, $element_type, $element_ref = '', $useCache = false, $maxCacheByType = 10)
 {
 	global $conf, $db;
 
 	$element_prop = getElementProperties($element_type);
 	if (is_array($element_prop) && $conf->{$element_prop['module']}->enabled) {
 		dol_include_once('/'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
 
-		$objecttmp = new $element_prop['classname']($db);
-		$ret = $objecttmp->fetch($element_id, $element_ref);
-		if ($ret >= 0) {
-			return $objecttmp;
+		if ($useCache) {
+			$objecttmp = fetchObjectFromCache($element_prop['classname'], $element_id, $element_ref, $maxCacheByType);
+			if (is_object($objecttmp)) {
+				return $objecttmp;
+			}
+		} else {
+			$objecttmp = new $element_prop['classname']($db);
+			$ret = $objecttmp->fetch($element_id, $element_ref);
+			if ($ret >= 0) {
+				return $objecttmp;
+			}
 		}
 	}
 	return 0;
 }
 
+
+
+/**
+ * return an object stored in memory cache
+ *
+ * @param string $objetClassName object cs name
+ * @param int    $objectId       object Id
+ * @param string $objectRef       object ref
+ * @param int    $maxCacheByType max number of storable object fore each type
+ * @return  int|object                    object || 0 || -1 if error
+ */
+function fetchObjectFromCache($objetClassName, $objectId, $objectRef = false, $maxCacheByType = 10)
+{
+	global $db,$globalCacheForGetObjectFromCache;
+
+	if (!class_exists($objetClassName)) {
+		return -1;
+	}
+
+	if (empty($globalCacheForGetObjectFromCache[$objetClassName][$objectId])) {
+		$object = new $objetClassName($db);
+		$res = $object->fetch($objectId, $objectRef);
+		if ($res <= 0) {
+			return $res;
+		}
+
+		if (is_array($globalCacheForGetObjectFromCache[$objetClassName]) && count($globalCacheForGetObjectFromCache[$objetClassName]) >= $maxCacheByType) {
+			array_shift($globalCacheForGetObjectFromCache[$objetClassName]);
+		}
+
+		$globalCacheForGetObjectFromCache[$objetClassName][$objectId] = $object;
+	} else {
+		$object = $globalCacheForGetObjectFromCache[$objetClassName][$objectId];
+	}
+
+	return $object;
+}
+
 /**
  * Return if a file can contains executable content
  *

htdocs/install/mysql/migration/16.0.0-17.0.0.sql

@@ -118,6 +118,12 @@ ALTER TABLE llx_ticket ADD email_date datetime after email_msgid;
 
 ALTER TABLE llx_cronjob ADD COLUMN pid integer;
 
+
+ALTER TABLE llx_element_element MODIFY COLUMN sourcetype VARCHAR(64) NOT NULL;
+ALTER TABLE llx_element_element MODIFY COLUMN targettype VARCHAR(64) NOT NULL;
+ALTER TABLE llx_c_type_contact MODIFY COLUMN element VARCHAR(64) NOT NULL;
+
+
 INSERT INTO llx_c_hrm_public_holiday (code, entity, fk_country, dayrule, year, month, day, active) VALUES('BE-VICTORYDAY',  0, 2, '', 0,  5,  8, 1);
 INSERT INTO llx_c_hrm_public_holiday (code, entity, fk_country, dayrule, year, month, day, active) VALUES('BE-NATIONALDAY', 0, 2, '', 0,  7, 21, 1);
 INSERT INTO llx_c_hrm_public_holiday (code, entity, fk_country, dayrule, year, month, day, active) VALUES('BE-ASSOMPTION',  0, 2, '', 0,  8, 15, 1);

htdocs/install/mysql/tables/llx_c_type_contact.sql

@@ -30,7 +30,7 @@
 create table llx_c_type_contact
 (
   rowid      	integer     AUTO_INCREMENT PRIMARY KEY,
-  element       varchar(30) NOT NULL,
+  element       varchar(64) NOT NULL,
   source        varchar(8)  DEFAULT 'external' NOT NULL,
   code          varchar(32) NOT NULL,
   libelle 	    varchar(128)	NOT NULL,

htdocs/install/mysql/tables/llx_element_element.sql

@@ -24,8 +24,8 @@ create table llx_element_element
 (
   rowid           	integer AUTO_INCREMENT PRIMARY KEY,  
   fk_source			integer NOT NULL,
-  sourcetype		varchar(32) NOT NULL,
+  sourcetype		varchar(64) NOT NULL,
   fk_target			integer NOT NULL,
-  targettype		varchar(32) NOT NULL
+  targettype		varchar(64) NOT NULL
 ) ENGINE=innodb;