Fix debug modulebuilder for doc and ref generation

htdocs/core/class/commonobject.class.php

@@ -4555,7 +4555,7 @@ abstract class CommonObject
 		    // Search template files
 			$file = '';
 			$classname = '';
-			$filefound = 0;
+			$filefound = '';
 		    $dirmodels = array('/');
 		    if (is_array($conf->modules_parts['models'])) $dirmodels = array_merge($dirmodels, $conf->modules_parts['models']);
 		    foreach ($dirmodels as $reldir)
@@ -4569,7 +4569,7 @@ abstract class CommonObject
 				    $file = dol_buildpath($reldir.$modelspath.$file, 0);
 				    if (file_exists($file))
 				    {
-					    $filefound = 1;
+					    $filefound = $file;
 					    $classname = $prefix.'_'.$modele;
 					    break;
 				    }
@@ -4766,8 +4766,13 @@ abstract class CommonObject
 				    return -1;
 			    }
 		    } else {
-			    $this->error = $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists", $file);
-			    dol_print_error('', $this->error);
+		    	if (! $filefound) {
+			    	$this->error = $langs->trans("Error").' Failed to load doc generator with modelpaths='.$modelspath.' - modele='.$modele;
+			    	dol_print_error('', $this->error);
+		    	} else {
+		    		$this->error = $langs->trans("Error")." ".$langs->trans("ErrorFileDoesNotExists", $filefound);
+		    		dol_print_error('', $this->error);
+		    	}
 			    return -1;
 		    }
 		} else return $reshook;

htdocs/langs/en_US/admin.lang

@@ -1264,6 +1264,7 @@ FieldEdition=Edition of field %s
 FillThisOnlyIfRequired=Example: +2 (fill only if timezone offset problems are experienced)
 GetBarCode=Get barcode
 NumberingModules=Numbering models
+DocumentModules=Document models
 ##### Module password generation
 PasswordGenerationStandard=Return a password generated according to internal Dolibarr algorithm: 8 characters containing shared numbers and characters in lowercase.
 PasswordGenerationNone=Do not suggest a generated password. Password must be typed in manually.

htdocs/modulebuilder/index.php

@@ -845,7 +845,8 @@ if ($dirins && $action == 'initobject' && $module && $objectname)
 			dol_mkdir($destdir.'/core/modules/'.strtolower($module).'/doc');
 
 			$filetogenerate += array(
-				'core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php'=>'core/modules/'.strtolower($module).'/doc/doc_generic_'.strtolower($objectname).'_odt.modules.php'
+				'core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php'=>'core/modules/'.strtolower($module).'/doc/doc_generic_'.strtolower($objectname).'_odt.modules.php',
+				'core/modules/mymodule/doc/pdf_standard_myobject.modules.php'=>'core/modules/'.strtolower($module).'/doc/pdf_standard_'.strtolower($objectname).'.modules.php'
 			);
 		}
 
@@ -1247,13 +1248,15 @@ if ($dirins && $action == 'confirm_deleteobject' && $objectname)
 			'core/modules/mymodule/mod_myobject_advanced.php'=>'core/modules/'.strtolower($module).'/mod_'.strtolower($objectname).'_advanced.php',
 			'core/modules/mymodule/mod_myobject_standard.php'=>'core/modules/'.strtolower($module).'/mod_'.strtolower($objectname).'_standard.php',
 			'core/modules/mymodule/modules_myobject.php'=>'core/modules/'.strtolower($module).'/modules_'.strtolower($objectname).'.php',
-			'core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php'=>'core/modules/'.strtolower($module).'/doc/doc_generic_'.strtolower($objectname).'_odt.modules.php'
+			'core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php'=>'core/modules/'.strtolower($module).'/doc/doc_generic_'.strtolower($objectname).'_odt.modules.php',
+			'core/modules/mymodule/doc/pdf_standard_myobject.modules.php'=>'core/modules/'.strtolower($module).'/doc/pdf_standard_'.strtolower($objectname).'.modules.php'
 		);
 
 		$resultko = 0;
 		foreach ($filetodelete as $filetodelete)
 		{
 			$resulttmp = dol_delete_file($dir.'/'.$filetodelete, 0, 0, 1);
+			$resulttmp = dol_delete_file($dir.'/'.$filetodelete.'.back', 0, 0, 1);
 			if (!$resulttmp) $resultko++;
 		}
 
@@ -2485,7 +2488,7 @@ if ($module == 'initmodule')
 							//$propstat = $reflector->getStaticProperties();
 							//var_dump($reflectorpropdefault);
 
-							print '<form action="'.$_SERVER["PHP_SELF"].'" method="POST" class="center">';
+							print '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
 							print '<input type="hidden" name="token" value="'.newToken().'">';
 							print '<input type="hidden" name="action" value="addproperty">';
 							print '<input type="hidden" name="tab" value="objects">';

htdocs/modulebuilder/template/admin/setup.php

@@ -53,11 +53,14 @@ if (!$user->admin) accessforbidden();
 $action = GETPOST('action', 'alpha');
 $backtopage = GETPOST('backtopage', 'alpha');
 
+$value = GETPOST('value', 'alpha');
+
 $arrayofparameters = array(
 	'MYMODULE_MYPARAM1'=>array('css'=>'minwidth200', 'enabled'=>1),
 	'MYMODULE_MYPARAM2'=>array('css'=>'minwidth500', 'enabled'=>1)
 );
 
+$error = 0;
 
 
 /*
@@ -69,12 +72,116 @@ if ((float) DOL_VERSION >= 6)
 	include DOL_DOCUMENT_ROOT.'/core/actions_setmoduleoptions.inc.php';
 }
 
+if ($action == 'updateMask')
+{
+	$maskconstorder = GETPOST('maskconstorder', 'alpha');
+	$maskorder = GETPOST('maskorder', 'alpha');
+
+	if ($maskconstorder) $res = dolibarr_set_const($db, $maskconstorder, $maskorder, 'chaine', 0, '', $conf->entity);
+
+	if (!$res > 0) $error++;
+
+	if (!$error)
+	{
+		setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
+	} else {
+		setEventMessages($langs->trans("Error"), null, 'errors');
+	}
+} elseif ($action == 'specimen')
+{
+	$modele = GETPOST('module', 'alpha');
+	$tmpobjectkey = GETPOST('object');
+
+	$tmpobject = new $tmpobjectkey($db);
+	$tmpobject->initAsSpecimen();
+
+	// Search template files
+	$file = ''; $classname = ''; $filefound = 0;
+	$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
+	foreach ($dirmodels as $reldir)
+	{
+		$file = dol_buildpath($reldir."core/modules/mymodule/doc/pdf_".$modele."_".strtolower($tmpobjectkey).".modules.php", 0);
+		if (file_exists($file))
+		{
+			$filefound = 1;
+			$classname = "pdf_".$modele;
+			break;
+		}
+	}
+
+	if ($filefound)
+	{
+		require_once $file;
+
+		$module = new $classname($db);
+
+		if ($module->write_file($tmpobject, $langs) > 0)
+		{
+			header("Location: ".DOL_URL_ROOT."/document.php?modulepart=".strtolower($tmpobjectkey)."&file=SPECIMEN.pdf");
+			return;
+		} else {
+			setEventMessages($module->error, null, 'errors');
+			dol_syslog($module->error, LOG_ERR);
+		}
+	} else {
+		setEventMessages($langs->trans("ErrorModuleNotFound"), null, 'errors');
+		dol_syslog($langs->trans("ErrorModuleNotFound"), LOG_ERR);
+	}
+}
+
+// Activate a model
+elseif ($action == 'set')
+{
+	$ret = addDocumentModel($value, $type, $label, $scandir);
+} elseif ($action == 'del')
+{
+	$tmpobjectkey = GETPOST('object');
+
+	$ret = delDocumentModel($value, $type);
+	if ($ret > 0)
+	{
+		$constforval = strtoupper($tmpobjectkey).'_ADDON_PDF';
+		if ($conf->global->$constforval == "$value") dolibarr_del_const($db, $constforval, $conf->entity);
+	}
+}
+
+// Set default model
+elseif ($action == 'setdoc')
+{
+	$tmpobjectkey = GETPOST('object');
+	$constforval = strtoupper($tmpobjectkey).'_ADDON_PDF';
+	if (dolibarr_set_const($db, $constforval, $value, 'chaine', 0, '', $conf->entity))
+	{
+		// The constant that was read before the new set
+		// We therefore requires a variable to have a coherent view
+		$conf->global->$constforval = $value;
+	}
+
+	// On active le modele
+	$ret = delDocumentModel($value, $type);
+	if ($ret > 0)
+	{
+		$ret = addDocumentModel($value, $type, $label, $scandir);
+	}
+} elseif ($action == 'setmod')
+{
+	// TODO Check if numbering module chosen can be activated
+	// by calling method canBeActivated
+	$tmpobjectkey = GETPOST('object');
+
+	dolibarr_set_const($db, strtoupper($tmpobjectkey)."_ADDON", $value, 'chaine', 0, '', $conf->entity);
+}
+
 
 
 /*
  * View
  */
 
+$form = new Form($db);
+
+$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
+
 $page_name = "MyModuleSetup";
 llxHeader('', $langs->trans($page_name));
 
@@ -140,6 +247,270 @@ if ($action == 'edit')
 }
 
 
+$moduledir = 'mymodule';
+$myTmpObjects = array();
+$myTmpObjects['MyObject']=array('includerefgeneration'=>0, 'includedocgeneration'=>0);
+
+
+
+foreach($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
+	if ($myTmpObjectArray['includerefgeneration']) {
+		/*
+		 * Orders Numbering model
+		 */
+		
+		print load_fiche_titre($langs->trans("NumberingModules", $myTmpObjectKey), '', '');
+		
+		print '<table class="noborder centpercent">';
+		print '<tr class="liste_titre">';
+		print '<td>'.$langs->trans("Name").'</td>';
+		print '<td>'.$langs->trans("Description").'</td>';
+		print '<td class="nowrap">'.$langs->trans("Example").'</td>';
+		print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
+		print '<td class="center" width="16">'.$langs->trans("ShortInfo").'</td>';
+		print '</tr>'."\n";
+		
+		clearstatcache();
+		
+		foreach ($dirmodels as $reldir)
+		{
+			$dir = dol_buildpath($reldir."core/modules/".$moduledir);
+			
+			if (is_dir($dir))
+			{
+				$handle = opendir($dir);
+				if (is_resource($handle))
+				{
+					while (($file = readdir($handle)) !== false)
+					{
+						if (strpos($file, 'mod_'.strtolower($myTmpObjectKey).'_') === 0 && substr($file, dol_strlen($file) - 3, 3) == 'php')
+						{
+							$file = substr($file, 0, dol_strlen($file) - 4);
+							
+							require_once $dir.'/'.$file.'.php';
+							
+							$module = new $file($db);
+							
+							// Show modules according to features level
+							if ($module->version == 'development' && $conf->global->MAIN_FEATURES_LEVEL < 2) continue;
+							if ($module->version == 'experimental' && $conf->global->MAIN_FEATURES_LEVEL < 1) continue;
+							
+							if ($module->isEnabled())
+							{
+								dol_include_once('/'.$moduledir.'/class/'.strtolower($myTmpObjectKey).'.class.php');
+								
+								print '<tr class="oddeven"><td>'.$module->name."</td><td>\n";
+								print $module->info();
+								print '</td>';
+								
+								// Show example of numbering model
+								print '<td class="nowrap">';
+								$tmp = $module->getExample();
+								if (preg_match('/^Error/', $tmp)) print '<div class="error">'.$langs->trans($tmp).'</div>';
+								elseif ($tmp == 'NotConfigured') print $langs->trans($tmp);
+								else print $tmp;
+								print '</td>'."\n";
+								
+								print '<td class="center">';
+								$constforvar = 'MYMODULE_'.strtoupper($myTmpObjectKey).'_ADDON';
+								if ($conf->global->$constforvar == $file)
+								{
+									print img_picto($langs->trans("Activated"), 'switch_on');
+								} else {
+									print '<a href="'.$_SERVER["PHP_SELF"].'?action=setmod&amp;value='.$file.'">';
+									print img_picto($langs->trans("Disabled"), 'switch_off');
+									print '</a>';
+								}
+								print '</td>';
+								
+								$mytmpinstance = new $myTmpObjectKey($db);
+								$mytmpinstance->initAsSpecimen();
+								
+								// Info
+								$htmltooltip = '';
+								$htmltooltip .= ''.$langs->trans("Version").': <b>'.$module->getVersion().'</b><br>';
+								
+								$nextval = $module->getNextValue($mytmpinstance);
+								if ("$nextval" != $langs->trans("NotAvailable")) {  // Keep " on nextval
+									$htmltooltip .= ''.$langs->trans("NextValue").': ';
+									if ($nextval) {
+										if (preg_match('/^Error/', $nextval) || $nextval == 'NotConfigured')
+											$nextval = $langs->trans($nextval);
+											$htmltooltip .= $nextval.'<br>';
+									} else {
+										$htmltooltip .= $langs->trans($module->error).'<br>';
+									}
+								}
+								
+								print '<td class="center">';
+								print $form->textwithpicto('', $htmltooltip, 1, 0);
+								print '</td>';
+								
+								print "</tr>\n";
+							}
+						}
+					}
+					closedir($handle);
+				}
+			}
+		}
+		print "</table><br>\n";
+	}
+	
+	
+	if ($myTmpObjectArray['includedocgeneration']) {
+		/*
+		 * Document templates generators
+		 */
+		$type = strtolower($myTmpObjectKey);
+		
+		print load_fiche_titre($langs->trans("DocumentModules", $myTmpObjectKey), '', '');
+		
+		// Load array def with activated templates
+		$def = array();
+		$sql = "SELECT nom";
+		$sql .= " FROM ".MAIN_DB_PREFIX."document_model";
+		$sql .= " WHERE type = '".$type."'";
+		$sql .= " AND entity = ".$conf->entity;
+		$resql = $db->query($sql);
+		if ($resql)
+		{
+			$i = 0;
+			$num_rows = $db->num_rows($resql);
+			while ($i < $num_rows)
+			{
+				$array = $db->fetch_array($resql);
+				array_push($def, $array[0]);
+				$i++;
+			}
+		} else {
+			dol_print_error($db);
+		}
+		
+		
+		print "<table class=\"noborder\" width=\"100%\">\n";
+		print "<tr class=\"liste_titre\">\n";
+		print '<td>'.$langs->trans("Name").'</td>';
+		print '<td>'.$langs->trans("Description").'</td>';
+		print '<td class="center" width="60">'.$langs->trans("Status")."</td>\n";
+		print '<td class="center" width="60">'.$langs->trans("Default")."</td>\n";
+		print '<td class="center" width="38">'.$langs->trans("ShortInfo").'</td>';
+		print '<td class="center" width="38">'.$langs->trans("Preview").'</td>';
+		print "</tr>\n";
+		
+		clearstatcache();
+		
+		foreach ($dirmodels as $reldir)
+		{
+			foreach (array('', '/doc') as $valdir)
+			{
+				$realpath = $reldir."core/modules/".$moduledir.$valdir;
+				$dir = dol_buildpath($realpath);
+				
+				if (is_dir($dir))
+				{
+					$handle = opendir($dir);
+					if (is_resource($handle))
+					{
+						while (($file = readdir($handle)) !== false)
+						{
+							$filelist[] = $file;
+						}
+						closedir($handle);
+						arsort($filelist);
+						
+						foreach ($filelist as $file)
+						{
+							if (preg_match('/\.modules\.php$/i', $file) && preg_match('/^(pdf_|doc_)/', $file))
+							{
+								if (file_exists($dir.'/'.$file))
+								{
+									$name = substr($file, 4, dol_strlen($file) - 16);
+									$classname = substr($file, 0, dol_strlen($file) - 12);
+									
+									require_once $dir.'/'.$file;
+									$module = new $classname($db);
+									
+									$modulequalified = 1;
+									if ($module->version == 'development' && $conf->global->MAIN_FEATURES_LEVEL < 2) $modulequalified = 0;
+									if ($module->version == 'experimental' && $conf->global->MAIN_FEATURES_LEVEL < 1) $modulequalified = 0;
+									
+									if ($modulequalified)
+									{
+										print '<tr class="oddeven"><td width="100">';
+										print (empty($module->name) ? $name : $module->name);
+										print "</td><td>\n";
+										if (method_exists($module, 'info')) print $module->info($langs);
+										else print $module->description;
+										print '</td>';
+										
+										// Active
+										if (in_array($name, $def))
+										{
+											print '<td class="center">'."\n";
+											print '<a href="'.$_SERVER["PHP_SELF"].'?action=del&value='.$name.'">';
+											print img_picto($langs->trans("Enabled"), 'switch_on');
+											print '</a>';
+											print '</td>';
+										} else {
+											print '<td class="center">'."\n";
+											print '<a href="'.$_SERVER["PHP_SELF"].'?action=set&value='.$name.'&amp;scan_dir='.$module->scandir.'&amp;label='.urlencode($module->name).'">'.img_picto($langs->trans("Disabled"), 'switch_off').'</a>';
+											print "</td>";
+										}
+										
+										// Default
+										print '<td class="center">';
+										$constforvar = 'MYMODULE_'.strtoupper($myTmpObjectKey).'_ADDON';
+										if ($conf->global->$constforvar == $name)
+										{
+											print img_picto($langs->trans("Default"), 'on');
+										} else {
+											print '<a href="'.$_SERVER["PHP_SELF"].'?action=setdoc&value='.$name.'&amp;scan_dir='.$module->scandir.'&amp;label='.urlencode($module->name).'" alt="'.$langs->trans("Default").'">'.img_picto($langs->trans("Disabled"), 'off').'</a>';
+										}
+										print '</td>';
+										
+										// Info
+										$htmltooltip = ''.$langs->trans("Name").': '.$module->name;
+										$htmltooltip .= '<br>'.$langs->trans("Type").': '.($module->type ? $module->type : $langs->trans("Unknown"));
+										if ($module->type == 'pdf')
+										{
+											$htmltooltip .= '<br>'.$langs->trans("Width").'/'.$langs->trans("Height").': '.$module->page_largeur.'/'.$module->page_hauteur;
+										}
+										$htmltooltip .= '<br>'.$langs->trans("Path").': '.preg_replace('/^\//', '', $realpath).'/'.$file;
+										
+										$htmltooltip .= '<br><br><u>'.$langs->trans("FeaturesSupported").':</u>';
+										$htmltooltip .= '<br>'.$langs->trans("Logo").': '.yn($module->option_logo, 1, 1);
+										$htmltooltip .= '<br>'.$langs->trans("MultiLanguage").': '.yn($module->option_multilang, 1, 1);
+										
+										print '<td class="center">';
+										print $form->textwithpicto('', $htmltooltip, 1, 0);
+										print '</td>';
+										
+										// Preview
+										print '<td class="center">';
+										if ($module->type == 'pdf')
+										{
+											print '<a href="'.$_SERVER["PHP_SELF"].'?action=specimen&module='.$name.'&object='.$myTmpObjectKey.'">'.img_object($langs->trans("Preview"), 'generic').'</a>';
+										} else {
+											print img_object($langs->trans("PreviewNotAvailable"), 'generic');
+										}
+										print '</td>';
+										
+										print "</tr>\n";
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+		
+		print '</table>';
+	}
+}
+
+
 // Page end
 dol_fiche_end();
 

htdocs/modulebuilder/template/core/modules/mymodule/doc/doc_generic_myobject_odt.modules.php

@@ -27,7 +27,7 @@
  *	\brief      File of class to build ODT documents for myobjects
  */
 
-require_once DOL_DOCUMENT_ROOT.'/core/modules/myobject/modules_myobject.php';
+dol_include_once('/mymodule/core/modules/mymodule/modules_myobject.php');
 require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
 require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
 require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';

htdocs/modulebuilder/template/core/modules/mymodule/modules_myobject.php

@@ -122,11 +122,10 @@ abstract class ModeleNumRefMyObject
 	/**
 	 *	Returns next assigned value
 	 *
-	 *	@param	Societe		$objsoc     Object thirdparty
 	 *	@param	Object		$object		Object we need next value for
 	 *	@return	string      Valeur
 	 */
-	public function getNextValue($objsoc, $object)
+	public function getNextValue($object)
 	{
 		global $langs;
 		return $langs->trans("NotAvailable");