* Copyright (C) ---Replace with your own copyright and developer email--- * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /** * \file htdocs/modulebuilder/template/admin/setup.php * \ingroup mymodule * \brief MyModule setup page. */ // Load Dolibarr environment $res = 0; // Try main.inc.php into web root known defined into CONTEXT_DOCUMENT_ROOT (not always defined) if (!$res && !empty($_SERVER["CONTEXT_DOCUMENT_ROOT"])) { $res = @include $_SERVER["CONTEXT_DOCUMENT_ROOT"]."/main.inc.php"; } // Try main.inc.php into web root detected using web root calculated from SCRIPT_FILENAME $tmp = empty($_SERVER['SCRIPT_FILENAME']) ? '' : $_SERVER['SCRIPT_FILENAME']; $tmp2 = realpath(__FILE__); $i = strlen($tmp) - 1; $j = strlen($tmp2) - 1; while ($i > 0 && $j > 0 && isset($tmp[$i]) && isset($tmp2[$j]) && $tmp[$i] == $tmp2[$j]) { $i--; $j--; } if (!$res && $i > 0 && file_exists(substr($tmp, 0, ($i + 1))."/main.inc.php")) { $res = @include substr($tmp, 0, ($i + 1))."/main.inc.php"; } if (!$res && $i > 0 && file_exists(dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php")) { $res = @include dirname(substr($tmp, 0, ($i + 1)))."/main.inc.php"; } // Try main.inc.php using relative path if (!$res && file_exists("../../main.inc.php")) { $res = @include "../../main.inc.php"; } if (!$res && file_exists("../../../main.inc.php")) { $res = @include "../../../main.inc.php"; } if (!$res) { die("Include of main fails"); } global $langs, $user; // Libraries require_once DOL_DOCUMENT_ROOT."/core/lib/admin.lib.php"; require_once '../lib/mymodule.lib.php'; //require_once "../class/myclass.class.php"; // Translations $langs->loadLangs(array("admin", "mymodule@mymodule")); // Initialize a technical object to manage hooks of page. Note that conf->hooks_modules contains an array of hook context $hookmanager->initHooks(array('mymodulesetup', 'globalsetup')); // Parameters $action = GETPOST('action', 'aZ09'); $backtopage = GETPOST('backtopage', 'alpha'); $modulepart = GETPOST('modulepart', 'aZ09'); // Used by actions_setmoduleoptions.inc.php $value = GETPOST('value', 'alpha'); $label = GETPOST('label', 'alpha'); $scandir = GETPOST('scan_dir', 'alpha'); $type = 'myobject'; $error = 0; $setupnotempty = 0; // Access control if (!$user->admin) { accessforbidden(); } // Set this to 1 to use the factory to manage constants. Warning, the generated module will be compatible with version v15+ only $useFormSetup = 1; if (!class_exists('FormSetup')) { require_once DOL_DOCUMENT_ROOT.'/core/class/html.formsetup.class.php'; } $formSetup = new FormSetup($db); // Access control if (!$user->admin) { accessforbidden(); } // Enter here all parameters in your setup page // Setup conf for selection of an URL $item = $formSetup->newItem('MYMODULE_MYPARAM1'); $item->fieldOverride = (empty($_SERVER['HTTPS']) ? 'http://' : 'https://') . $_SERVER['HTTP_HOST']; $item->cssClass = 'minwidth500'; // Setup conf for selection of a simple string input $item = $formSetup->newItem('MYMODULE_MYPARAM2'); $item->defaultFieldValue = 'default value'; $item->fieldAttr['placeholder'] = 'A placeholder here'; // Setup conf for selection of a simple textarea input but we replace the text of field title $item = $formSetup->newItem('MYMODULE_MYPARAM3'); $item->nameText = $item->getNameText().' more html text '; // Setup conf for a selection of a thirdparty $item = $formSetup->newItem('MYMODULE_MYPARAM4'); $item->setAsThirdpartyType(); // Setup conf for a selection of a boolean $formSetup->newItem('MYMODULE_MYPARAM5')->setAsYesNo(); // Setup conf for a selection of an email template of type thirdparty $formSetup->newItem('MYMODULE_MYPARAM6')->setAsEmailTemplate('thirdparty'); // Setup conf for a selection of a secured key //$formSetup->newItem('MYMODULE_MYPARAM7')->setAsSecureKey(); // Setup conf for a selection of a product $formSetup->newItem('MYMODULE_MYPARAM8')->setAsProduct(); // Add a title for a new section $formSetup->newItem('NewSection')->setAsTitle(); $TField = array( 'test01' => $langs->trans('test01'), 'test02' => $langs->trans('test02'), 'test03' => $langs->trans('test03'), 'test04' => $langs->trans('test04'), 'test05' => $langs->trans('test05'), 'test06' => $langs->trans('test06'), ); // Setup conf for a simple combo list $formSetup->newItem('MYMODULE_MYPARAM9')->setAsSelect($TField); // Setup conf for a multiselect combo list $item = $formSetup->newItem('MYMODULE_MYPARAM10'); $item->setAsMultiSelect($TField); $item->helpText = $langs->transnoentities('MYMODULE_MYPARAM10'); // Setup conf for a category selection $formSetup->newItem('MYMODULE_CATEGORY_ID_XXX')->setAsCategory('product'); // Setup conf MYMODULE_MYPARAM10 $item = $formSetup->newItem('MYMODULE_MYPARAM10'); $item->setAsColor(); $item->defaultFieldValue = '#FF0000'; $item->nameText = $item->getNameText().' more html text '; $item->fieldInputOverride = ''; $item->helpText = $langs->transnoentities('AnHelpMessage'); //$item->fieldValue = ''; //$item->fieldAttr = array() ; // fields attribute only for compatible fields like input text //$item->fieldOverride = false; // set this var to override field output will override $fieldInputOverride and $fieldOutputOverride too //$item->fieldInputOverride = false; // set this var to override field input //$item->fieldOutputOverride = false; // set this var to override field output $setupnotempty += count($formSetup->items); $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']); $moduledir = 'mymodule'; $myTmpObjects = array(); // TODO Scan list of objects to fill this array $myTmpObjects['myobject'] = array('label' => 'MyObject', 'includerefgeneration' => 0, 'includedocgeneration' => 0, 'class' => 'MyObject'); $tmpobjectkey = GETPOST('object', 'aZ09'); if ($tmpobjectkey && !array_key_exists($tmpobjectkey, $myTmpObjects)) { accessforbidden('Bad value for object. Hack attempt ?'); } /* * Actions */ // For retrocompatibility Dolibarr < 15.0 if (versioncompare(explode('.', DOL_VERSION), array(15)) < 0 && $action == 'update' && !empty($user->admin)) { $formSetup->saveConfFromPost(); } include DOL_DOCUMENT_ROOT.'/core/actions_setmoduleoptions.inc.php'; if ($action == 'updateMask') { $maskconst = GETPOST('maskconst', 'aZ09'); $maskvalue = GETPOST('maskvalue', 'alpha'); if ($maskconst && preg_match('/_MASK$/', $maskconst)) { $res = dolibarr_set_const($db, $maskconst, $maskvalue, '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' && $tmpobjectkey) { $modele = GETPOST('module', 'alpha'); $className = $myTmpObjects[$tmpobjectkey]['class']; $tmpobject = new $className($db); '@phan-var-force MyObject $tmpobject'; $tmpobject->initAsSpecimen(); // Search template files $file = ''; $className = ''; $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)) { $className = "pdf_".$modele."_".strtolower($tmpobjectkey); break; } } if ($className !== '') { require_once $file; $module = new $className($db); '@phan-var-force ModelePDFMyObject $module'; '@phan-var-force ModelePDFMyObject $module'; if ($module->write_file($tmpobject, $langs) > 0) { header("Location: ".DOL_URL_ROOT."/document.php?modulepart=mymodule-".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); } } elseif ($action == 'setmod') { // TODO Check if numbering module chosen can be activated by calling method canBeActivated if (!empty($tmpobjectkey)) { $constforval = 'MYMODULE_'.strtoupper($tmpobjectkey)."_ADDON"; dolibarr_set_const($db, $constforval, $value, 'chaine', 0, '', $conf->entity); } } elseif ($action == 'set') { // Activate a model $ret = addDocumentModel($value, $type, $label, $scandir); } elseif ($action == 'del') { $ret = delDocumentModel($value, $type); if ($ret > 0) { if (!empty($tmpobjectkey)) { $constforval = 'MYMODULE_'.strtoupper($tmpobjectkey).'_ADDON_PDF'; if (getDolGlobalString($constforval) == "$value") { dolibarr_del_const($db, $constforval, $conf->entity); } } } } elseif ($action == 'setdoc') { // Set or unset default model if (!empty($tmpobjectkey)) { $constforval = 'MYMODULE_'.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; } // We disable/enable the document template (into llx_document_model table) $ret = delDocumentModel($value, $type); if ($ret > 0) { $ret = addDocumentModel($value, $type, $label, $scandir); } } } elseif ($action == 'unsetdoc') { if (!empty($tmpobjectkey)) { $constforval = 'MYMODULE_'.strtoupper($tmpobjectkey).'_ADDON_PDF'; dolibarr_del_const($db, $constforval, $conf->entity); } } $action = 'edit'; /* * View */ $form = new Form($db); $help_url = ''; $title = "MyModuleSetup"; llxHeader('', $langs->trans($title), $help_url, '', 0, 0, '', '', '', 'mod-mymodule page-admin'); // Subheader $linkback = ''.$langs->trans("BackToModuleList").''; print load_fiche_titre($langs->trans($title), $linkback, 'title_setup'); // Configuration header $head = mymoduleAdminPrepareHead(); print dol_get_fiche_head($head, 'settings', $langs->trans($title), -1, "mymodule@mymodule"); // Setup page goes here echo ''.$langs->trans("MyModuleSetupPage").'

'; /*if ($action == 'edit') { print $formSetup->generateOutput(true); print '
'; } elseif (!empty($formSetup->items)) { print $formSetup->generateOutput(); print '
'; print ''.$langs->trans("Modify").''; print '
'; } */ if (!empty($formSetup->items)) { print $formSetup->generateOutput(true); print '
'; } else { print '
'.$langs->trans("NothingToSetup"); } foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) { if (!empty($myTmpObjectArray['includerefgeneration'])) { /* * Orders Numbering model */ $setupnotempty++; print load_fiche_titre($langs->trans("NumberingModules", $myTmpObjectArray['label']), '', ''); print ''; print ''; print ''; print ''; print ''; print ''; print ''; print ''."\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); '@phan-var-force ModeleNumRefMyObject $module'; // Show modules according to features level if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) { continue; } if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) { continue; } if ($module->isEnabled()) { dol_include_once('/'.$moduledir.'/class/'.strtolower($myTmpObjectKey).'.class.php'); print ''; // Show example of numbering model print ''."\n"; print ''; $className = $myTmpObjectArray['class']; $mytmpinstance = new $className($db); '@phan-var-force MyObject $mytmpinstance'; $mytmpinstance->initAsSpecimen(); // Info $htmltooltip = ''; $htmltooltip .= ''.$langs->trans("Version").': '.$module->getVersion().'
'; $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.'
'; } else { $htmltooltip .= $langs->trans($module->error).'
'; } } print ''; print "\n"; } } } closedir($handle); } } } print "
'.$langs->trans("Name").''.$langs->trans("Description").''.$langs->trans("Example").''.$langs->trans("Status").''.$langs->trans("ShortInfo").'
'.$module->getName($langs)."\n"; print $module->info($langs); print ''; $tmp = $module->getExample(); if (preg_match('/^Error/', $tmp)) { $langs->load("errors"); print '
'.$langs->trans($tmp).'
'; } elseif ($tmp == 'NotConfigured') { print $langs->trans($tmp); } else { print $tmp; } print '
'; $constforvar = 'MYMODULE_'.strtoupper($myTmpObjectKey).'_ADDON'; if (getDolGlobalString($constforvar) == $file) { print img_picto($langs->trans("Activated"), 'switch_on'); } else { print ''; print img_picto($langs->trans("Disabled"), 'switch_off'); print ''; } print ''; print $form->textwithpicto('', $htmltooltip, 1, 0); print '

\n"; } if (!empty($myTmpObjectArray['includedocgeneration'])) { /* * Document templates generators */ $setupnotempty++; $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 = '".$db->escape($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 ''."\n"; print ''."\n"; print ''; print ''; print '\n"; print '\n"; print ''; print ''; print "\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)) { $filelist = array(); 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); '@phan-var-force ModelePDFMyObject $module'; $modulequalified = 1; if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) { $modulequalified = 0; } if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) { $modulequalified = 0; } if ($modulequalified) { print ''; // Active if (in_array($name, $def)) { print ''; } else { print '"; } // Default print ''; // Info $htmltooltip = ''.$langs->trans("Name").': '.$module->name; $htmltooltip .= '
'.$langs->trans("Type").': '.($module->type ? $module->type : $langs->trans("Unknown")); if ($module->type == 'pdf') { $htmltooltip .= '
'.$langs->trans("Width").'/'.$langs->trans("Height").': '.$module->page_largeur.'/'.$module->page_hauteur; } $htmltooltip .= '
'.$langs->trans("Path").': '.preg_replace('/^\//', '', $realpath).'/'.$file; $htmltooltip .= '

'.$langs->trans("FeaturesSupported").':'; $htmltooltip .= '
'.$langs->trans("Logo").': '.yn($module->option_logo, 1, 1); $htmltooltip .= '
'.$langs->trans("MultiLanguage").': '.yn($module->option_multilang, 1, 1); print ''; // Preview print ''; print "\n"; } } } } } } } } print '
'.$langs->trans("Name").''.$langs->trans("Description").''.$langs->trans("Status")."'.$langs->trans("Default")."'.$langs->trans("ShortInfo").''.$langs->trans("Preview").'
'; print(empty($module->name) ? $name : $module->name); print "\n"; if (method_exists($module, 'info')) { print $module->info($langs); // @phan-suppress-current-line PhanUndeclaredMethod } else { print $module->description; } print ''."\n"; print ''; print img_picto($langs->trans("Enabled"), 'switch_on'); print ''; print ''."\n"; print 'scandir).'&label='.urlencode($module->name).'">'.img_picto($langs->trans("Disabled"), 'switch_off').''; print "'; $constforvar = 'MYMODULE_'.strtoupper($myTmpObjectKey).'_ADDON_PDF'; if (getDolGlobalString($constforvar) == $name) { //print img_picto($langs->trans("Default"), 'on'); // Even if choice is the default value, we allow to disable it. Replace this with previous line if you need to disable unset print 'scandir).'&label='.urlencode($module->name).'&type='.urlencode($type).'" alt="'.$langs->trans("Disable").'">'.img_picto($langs->trans("Enabled"), 'on').''; } else { print 'scandir).'&label='.urlencode($module->name).'" alt="'.$langs->trans("Default").'">'.img_picto($langs->trans("Disabled"), 'off').''; } print ''; print $form->textwithpicto('', $htmltooltip, 1, 0); print ''; if ($module->type == 'pdf') { $newname = preg_replace('/_'.preg_quote(strtolower($myTmpObjectKey), '/').'/', '', $name); print ''.img_object($langs->trans("Preview"), 'pdf').''; } else { print img_object($langs->trans("PreviewNotAvailable"), 'generic'); } print '
'; } } if (empty($setupnotempty)) { print '
'.$langs->trans("NothingToSetup"); } // Page end print dol_get_fiche_end(); llxFooter(); $db->close();