File: /home4/cca63905/public_html/guiaweb/htdocs/core/lib/admin.lib.php
<?php
/* Copyright (C) 2008-2011 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2016 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2012 J. Fernando Lagrange <fernando@demo-tic.org>
* Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
* Copyright (C) 2023 Eric Seigne <eric.seigne@cap-rel.fr>
* Copyright (C) 2024-2025 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2024-2025 Frédéric France <frederic.france@free.fr>
*
* 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 <https://www.gnu.org/licenses/>.
* or see https://www.gnu.org/
*/
/**
* \file htdocs/core/lib/admin.lib.php
* \brief Library of admin functions
*/
require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
/**
* Renvoi une version en chaine depuis une version en tableau
*
* @param array<int<0,2>,int|string> $versionarray Tableau de version (vermajeur,vermineur,autre)
* @return string Chaine version
* @see versioncompare()
*/
function versiontostring($versionarray)
{
$string = '?';
if (isset($versionarray[0])) {
$string = $versionarray[0];
}
if (isset($versionarray[1])) {
$string .= '.'.$versionarray[1];
}
if (isset($versionarray[2])) {
$string .= '.'.$versionarray[2];
}
return $string;
}
/**
* Compare 2 versions (stored into 2 arrays), to know if a version (a,b,c) is lower than (x,y,z)
* To check using a string version do a preg_split('/[\.\-]/', strinversion) to convert the string into an array.
* To check with Dolibarr version use versiondolibarrarray() to get the array of Dolibarr current version
*
* For example: if (versioncompare(versiondolibarrarray(),array(4,0,-5)) >= 0) is true if version is 4.0 alpha or higher.
* For example: if (versioncompare(versiondolibarrarray(),array(4,0,0)) >= 0) is true if version is 4.0 final or higher.
* For example: if (versioncompare(versiondolibarrarray(),array(4,0,1)) >= 0) is true if version is 4.0.1 or higher.
* Alternative way to compare: if ((float) DOL_VERSION >= 4.0) is true if version is 4.0 alpha or higher (works only to compare first and second level)
*
* @param array<int|string> $versionarray1 Array of version (vermajor,verminor,patch)
* @param array<int|string> $versionarray2 Array of version (vermajor,verminor,patch)
* @return int<-4,4> -4,-3,-2,-1 if versionarray1<versionarray2 (value depends on level of difference)
* 0 if same
* 1,2,3,4 if versionarray1>versionarray2 (value depends on level of difference)
* @see versiontostring()
*/
function versioncompare($versionarray1, $versionarray2)
{
$ret = 0;
$level = 0;
$count1 = count($versionarray1);
$count2 = count($versionarray2);
$maxcount = max($count1, $count2);
while ($level < $maxcount) {
$operande1 = isset($versionarray1[$level]) ? $versionarray1[$level] : 0;
$operande2 = isset($versionarray2[$level]) ? $versionarray2[$level] : 0;
if (preg_match('/alpha|dev/i', $operande1)) {
$operande1 = -5;
}
if (preg_match('/alpha|dev/i', $operande2)) {
$operande2 = -5;
}
if (preg_match('/beta$/i', $operande1)) {
$operande1 = -4;
}
if (preg_match('/beta$/i', $operande2)) {
$operande2 = -4;
}
if (preg_match('/beta([0-9])+/i', $operande1)) {
$operande1 = -3;
}
if (preg_match('/beta([0-9])+/i', $operande2)) {
$operande2 = -3;
}
if (preg_match('/rc$/i', $operande1)) {
$operande1 = -2;
}
if (preg_match('/rc$/i', $operande2)) {
$operande2 = -2;
}
if (preg_match('/rc([0-9])+/i', $operande1)) {
$operande1 = -1;
}
if (preg_match('/rc([0-9])+/i', $operande2)) {
$operande2 = -1;
}
$level++;
//print 'level '.$level.' '.$operande1.'-'.$operande2.'<br>';
if ($operande1 < $operande2) {
$ret = -$level;
break;
}
if ($operande1 > $operande2) {
$ret = $level;
break;
}
}
//print join('.',$versionarray1).'('.count($versionarray1).') / '.join('.',$versionarray2).'('.count($versionarray2).') => '.$ret.'<br>'."\n";
return $ret; // return level=1 if difference is on the main version, level=2 on minor version, level=3 on maintenance version, level=4 on development phase version
}
/**
* Return version PHP
*
* @return array<int<0,2>,string> Tableau de version (vermajeur,vermineur,autre)
* @see versioncompare()
*/
function versionphparray()
{
return explode('.', PHP_VERSION);
}
/**
* Return version Dolibarr
*
* @return array<int<0,2>,string> Array of version (vermajor,verminor,vermaintenance,other)
* @see versioncompare()
*/
function versiondolibarrarray()
{
return preg_split('/[\-\.]/', DOL_VERSION);
}
/**
* Launch a sql file. Function is used by:
* - Migrate process (dolibarr-xyz-abc.sql)
* - Loading sql menus (auguria)
* - Running specific Sql by a module init
* - Loading sql file of website import package
* Install process however does not use it.
* Note that SQL files must have all comments at start of line. Also this function take ';' as the char to detect end of sql request
*
* @param string $sqlfile Full path to sql file
* @param int $silent 1=Do not output anything, 0=Output line for update page
* @param int $entity Entity targeted for multicompany module
* @param int $usesavepoint 1=Run a savepoint before each request and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).
* @param string $handler Handler targeted for menu (replace __HANDLER__ with this value between quotes)
* @param string $okerror Family of errors we accept ('default', 'none')
* @param int $linelengthlimit Limit for length of each line (Use 0 if unknown, may be faster if defined)
* @param int $nocommentremoval Do no try to remove comments (in such a case, we consider that each line is a request, so use also $linelengthlimit=0)
* @param int $offsetforchartofaccount Offset to use to load chart of account table to update sql on the fly to add offset to rowid and account_parent value
* @param int $colspan 2=Add a colspan=2 on td
* @param int $onlysqltoimportwebsite Only sql requests used to import a website template are allowed. This is a security feature to disallow SQL injection when loading a template.
* @param string $database Database (replace __DATABASE__ with this value)
* @return int Return integer <=0 if KO, >0 if OK
*/
function run_sql($sqlfile, $silent = 1, $entity = 0, $usesavepoint = 1, $handler = '', $okerror = 'default', $linelengthlimit = 32768, $nocommentremoval = 0, $offsetforchartofaccount = 0, $colspan = 0, $onlysqltoimportwebsite = 0, $database = '')
{
global $db, $conf, $langs;
dol_syslog("Admin.lib::run_sql run sql file ".$sqlfile." silent=".$silent." entity=".$entity." usesavepoint=".$usesavepoint." handler=".$handler." okerror=".$okerror, LOG_DEBUG);
if (!is_numeric($linelengthlimit)) {
dol_syslog("Admin.lib::run_sql param linelengthlimit is not a numeric", LOG_ERR);
return -1;
}
$ok = 0;
$error = 0;
$i = 0;
$buffer = '';
$arraysql = array();
// Get version of database
$versionarray = $db->getVersionArray();
// TODO Restore all sequences "/* new line */\n" into "" in $sqlfile.
$fp = fopen($sqlfile, "r");
if ($fp) {
while (!feof($fp)) {
// Warning fgets with second parameter that is null or 0 hang.
if ($linelengthlimit > 0) {
$buf = fgets($fp, $linelengthlimit);
} else {
$buf = fgets($fp);
}
// Test if request must be ran only for particular database or version (if yes, we must remove the -- comment)
$reg = array();
if (preg_match('/^--\sV(MYSQL|PGSQL)([^\s]*)/i', $buf, $reg)) {
$qualified = 1;
// restrict on database type
if (!empty($reg[1])) {
if (!preg_match('/'.preg_quote($reg[1]).'/i', $db->type)) {
$qualified = 0;
}
}
// restrict on version
if ($qualified) {
if (!empty($reg[2])) {
if (is_numeric($reg[2])) { // This is a version
$versionrequest = explode('.', $reg[2]);
//var_dump($versionrequest);
//var_dump($versionarray);
if (!count($versionrequest) || !count($versionarray) || versioncompare($versionrequest, $versionarray) > 0) {
$qualified = 0;
}
} else { // This is a test on a constant. For example when we have -- VMYSQLUTF8UNICODE, we test constant $conf->global->UTF8UNICODE
$dbcollation = strtoupper(preg_replace('/_/', '', $conf->db->dolibarr_main_db_collation));
//var_dump($reg[2]);
//var_dump($dbcollation);
if (empty($conf->db->dolibarr_main_db_collation) || ($reg[2] != $dbcollation)) {
$qualified = 0;
}
//var_dump($qualified);
}
}
}
if ($qualified) {
// Version qualified, delete SQL comments
$buf = preg_replace('/^--\sV(MYSQL|PGSQL)([^\s]*)/i', '', $buf);
//print "Ligne $i qualifi?e par version: ".$buf.'<br>';
}
}
// Add line buf to buffer if not a comment
if ($nocommentremoval || !preg_match('/^\s*--/', $buf)) {
if (empty($nocommentremoval)) {
$buf = preg_replace('/([,;ERLT0\)])\s+--.*$/i', '\1', $buf); //remove comment on lines that does not start with --, before adding it to the buffer
}
if ($buffer) {
$buffer .= ' ';
}
$buffer .= trim($buf);
}
//print $buf.'<br>';exit;
if (preg_match('/;\s*$/', $buffer)) {
// If string contains the end of request string (';'), we save it into $arraysql.
// Found new request
if ($buffer) {
$arraysql[$i] = $buffer;
}
$i++;
$buffer = '';
}
}
if ($buffer) {
$arraysql[$i] = $buffer;
}
fclose($fp);
} else {
dol_syslog("Admin.lib::run_sql failed to open file ".$sqlfile, LOG_ERR);
}
// Loop on each request to see if there is a __+MAX_table__ key
$listofmaxrowid = array(); // This is a cache table
foreach ($arraysql as $i => $sql) {
$newsql = $sql;
// Replace __+MAX_table__ with max of table
while (preg_match('/__\+MAX_([A-Za-z0-9_]+)__/i', $newsql, $reg)) {
$table = $reg[1];
if (!isset($listofmaxrowid[$table])) {
//var_dump($db);
$sqlgetrowid = 'SELECT MAX(rowid) as max from '.preg_replace('/^llx_/', MAIN_DB_PREFIX, $table);
$resql = $db->query($sqlgetrowid);
if ($resql) {
$obj = $db->fetch_object($resql);
$listofmaxrowid[$table] = $obj->max;
if (empty($listofmaxrowid[$table])) {
$listofmaxrowid[$table] = 0;
}
} else {
if (!$silent) {
print '<tr><td class="tdtop"'.($colspan ? ' colspan="'.$colspan.'"' : '').'>';
print '<div class="error">'.$langs->trans("Failed to get max rowid for ".$table)."</div>";
print '</td></tr>';
}
$error++;
break;
}
}
// Replace __+MAX_llx_table__ with +999
$from = '__+MAX_'.$table.'__';
$to = '+'.$listofmaxrowid[$table];
$newsql = str_replace($from, $to, $newsql);
dol_syslog('Admin.lib::run_sql New Request '.($i + 1).' (replacing '.$from.' to '.$to.')', LOG_DEBUG);
$arraysql[$i] = $newsql;
}
if ($offsetforchartofaccount > 0) {
// Replace lines
// 'INSERT INTO llx_accounting_account (entity, rowid, fk_pcg_version, pcg_type, account_number, account_parent, label, active) VALUES (__ENTITY__, 1401, 'PCG99-ABREGE', 'CAPIT', '1234', 1400,...'
// with
// 'INSERT INTO llx_accounting_account (entity, rowid, fk_pcg_version, pcg_type, account_number, account_parent, label, active) VALUES (__ENTITY__, 1401 + 200100000, 'PCG99-ABREGE','CAPIT', '1234', 1400 + 200100000,...'
// Note: string with 'PCG99-ABREGE','CAPIT', 1234 instead of 'PCG99-ABREGE','CAPIT', '1234' is also supported
$newsql = preg_replace('/VALUES\s*\(__ENTITY__, \s*(\d+)\s*,(\s*\'[^\',]*\'\s*,\s*\'[^\',]*\'\s*,\s*\'?[^\',]*\'?\s*),\s*\'?([^\',]*)\'?/ims', 'VALUES (__ENTITY__, \1 + '.((int) $offsetforchartofaccount).', \2, \3 + '.((int) $offsetforchartofaccount), $newsql);
$newsql = preg_replace('/([,\s])0 \+ '.((int) $offsetforchartofaccount).'/ims', '\1 0', $newsql);
//var_dump($newsql);
$arraysql[$i] = $newsql;
// FIXME Because we force the rowid during insert, we must also update the sequence with postgresql by running
// SELECT dol_util_rebuild_sequences();
}
}
// Loop on each request to execute request
$cursorinsert = 0;
$listofinsertedrowid = array();
$keyforsql = md5($sqlfile);
foreach ($arraysql as $i => $sql) {
if ($sql) {
// Test if the SQL is allowed SQL
if ($onlysqltoimportwebsite) {
$newsql = str_replace(array("\'"), '__BACKSLASHQUOTE__', $sql); // Replace the \' char
// Remove all strings contents including the ' so we can analyse SQL instruction only later
$l = strlen($newsql);
$is = 0;
$quoteopen = 0;
$newsqlclean = '';
while ($is < $l) {
$char = $newsql[$is];
if ($char == "'") {
if ($quoteopen) {
$quoteopen--;
} else {
$quoteopen++;
}
} elseif (empty($quoteopen)) {
$newsqlclean .= $char;
}
$is++;
}
$newsqlclean = str_replace(array("null"), '__000__', $newsqlclean);
//print $newsqlclean."<br>\n";
$qualified = 0;
// A very small control. This can still by bypassed by adding a second SQL request concatenated
if (preg_match('/^--/', $newsqlclean)) {
$qualified = 1;
} elseif (preg_match('/^UPDATE llx_website SET \w+ = \d+\+\d+ WHERE rowid = \d+;$/', $newsqlclean)) {
$qualified = 1;
} elseif (preg_match('/^INSERT INTO llx_website_page\([a-z0-9_\s,]+\) VALUES\([0-9_\s,\+]+\);$/', $newsqlclean)) {
// Insert must match
// INSERT INTO llx_website_page(rowid, fk_page, fk_website, pageurl, aliasalt, title, description, lang, image, keywords, status, date_creation, tms, import_key, grabbed_from, type_container, htmlheader, content, author_alias) VALUES(1+123, null, 17, , , , , , , , , , , null, , , , , );
$qualified = 1;
}
// Another check to allow some legitimate original urls
if (!$qualified) {
if (preg_match('/^UPDATE llx_website SET \w+ = \'[a-zA-Z,\s]*\' WHERE rowid = \d+;$/', $sql)) {
$qualified = 1;
}
}
// We also check content
$extractphp = dolKeepOnlyPhpCode($sql);
$extractphpold = '';
// Security analysis
$errorphpcheck = checkPHPCode($extractphpold, $extractphp); // Contains the setEventMessages
if ($errorphpcheck) {
$error++;
//print 'Request '.($i + 1)." contains non allowed instructions.<br>\n";
//print "newsqlclean = ".$newsqlclean."<br>\n";
dol_syslog('Admin.lib::run_sql Request '.($i + 1)." contains PHP code and checking this code returns errorphpcheck='.$errorphpcheck.'", LOG_WARNING);
dol_syslog("sql=".$sql, LOG_DEBUG);
break;
}
if (!$qualified) {
$error++;
//print 'Request '.($i + 1)." contains non allowed instructions.<br>\n";
//print "newsqlclean = ".$newsqlclean."<br>\n";
dol_syslog('Admin.lib::run_sql Request '.($i + 1)." contains non allowed instructions.", LOG_WARNING);
dol_syslog('$newsqlclean='.$newsqlclean, LOG_DEBUG);
break;
}
}
// Replace the prefix tables
if (MAIN_DB_PREFIX != 'llx_') {
$sql = preg_replace('/llx_/i', MAIN_DB_PREFIX, $sql);
}
if (!empty($handler)) {
$sql = preg_replace('/__HANDLER__/i', "'".$db->escape($handler)."'", $sql);
}
if (!empty($database)) {
$sql = preg_replace('/__DATABASE__/i', $db->escape($database), $sql);
}
$newsql = preg_replace('/__ENTITY__/i', (!empty($entity) ? $entity : (string) $conf->entity), $sql);
// Add log of request
if (!$silent) {
print '<tr class="trforrunsql'.$keyforsql.'"><td class="tdtop opacitymedium"'.($colspan ? ' colspan="'.$colspan.'"' : '').'>'.$langs->trans("Request").' '.($i + 1)." sql='".dol_htmlentities($newsql, ENT_NOQUOTES)."'</td></tr>\n";
}
dol_syslog('Admin.lib::run_sql Request '.($i + 1), LOG_DEBUG);
$sqlmodified = 0;
// Replace for encrypt data
if (preg_match_all('/__ENCRYPT\(\'([^\']+)\'\)__/i', $newsql, $reg)) {
$num = count($reg[0]);
for ($j = 0; $j < $num; $j++) {
$from = $reg[0][$j];
$to = $db->encrypt($reg[1][$j]);
$newsql = str_replace($from, $to, $newsql);
}
$sqlmodified++;
}
// Replace for decrypt data
if (preg_match_all('/__DECRYPT\(\'([A-Za-z0-9_]+)\'\)__/i', $newsql, $reg)) {
$num = count($reg[0]);
for ($j = 0; $j < $num; $j++) {
$from = $reg[0][$j];
$to = $db->decrypt($reg[1][$j]);
$newsql = str_replace($from, $to, $newsql);
}
$sqlmodified++;
}
// Replace __x__ with the rowid of the result of the insert number x
while (preg_match('/__([0-9]+)__/', $newsql, $reg)) {
$cursor = $reg[1];
if (empty($listofinsertedrowid[$cursor])) {
if (!$silent) {
print '<tr><td class="tdtop"'.($colspan ? ' colspan="'.$colspan.'"' : '').'>';
print '<div class="error">'.$langs->trans("FileIsNotCorrect")."</div>";
print '</td></tr>';
}
$error++;
break;
}
$from = '__'.$cursor.'__';
$to = $listofinsertedrowid[$cursor];
$newsql = str_replace($from, $to, $newsql);
$sqlmodified++;
}
if ($sqlmodified) {
dol_syslog('Admin.lib::run_sql New Request '.($i + 1), LOG_DEBUG);
}
$result = $db->query($newsql, $usesavepoint);
if ($result) {
if (!$silent) {
print '<!-- Result = OK -->'."\n";
}
if (preg_replace('/insert into ([^\s]+)/i', $newsql, $reg)) {
$cursorinsert++;
// It's an insert
$table = preg_replace('/([^a-zA-Z_]+)/i', '', $reg[1]);
$insertedrowid = $db->last_insert_id($table);
$listofinsertedrowid[$cursorinsert] = $insertedrowid;
dol_syslog('Admin.lib::run_sql Insert nb '.$cursorinsert.', done in table '.$table.', rowid is '.$listofinsertedrowid[$cursorinsert], LOG_DEBUG);
}
// print '<td class="right">OK</td>';
} else {
$errno = $db->errno();
if (!$silent) {
print '<!-- Result = '.$errno.' -->'."\n";
}
// Define list of errors we accept (array $okerrors)
$okerrors = array( // By default
'DB_ERROR_TABLE_ALREADY_EXISTS',
'DB_ERROR_COLUMN_ALREADY_EXISTS',
'DB_ERROR_KEY_NAME_ALREADY_EXISTS',
'DB_ERROR_TABLE_OR_KEY_ALREADY_EXISTS', // PgSql use same code for table and key already exist
'DB_ERROR_RECORD_ALREADY_EXISTS',
'DB_ERROR_NOSUCHTABLE',
'DB_ERROR_NOSUCHFIELD',
'DB_ERROR_NO_FOREIGN_KEY_TO_DROP',
'DB_ERROR_NO_INDEX_TO_DROP',
'DB_ERROR_CANNOT_CREATE', // Qd contrainte deja existante
'DB_ERROR_CANT_DROP_PRIMARY_KEY',
'DB_ERROR_PRIMARY_KEY_ALREADY_EXISTS',
'DB_ERROR_22P02'
);
if ($okerror == 'none') {
$okerrors = array();
}
// Is it an error we accept
if (!in_array($errno, $okerrors)) {
if (!$silent) {
print '<tr><td class="tdtop"'.($colspan ? ' colspan="'.$colspan.'"' : '').'>';
print '<div class="error">'.$langs->trans("Error")." ".$db->errno()." (Req ".($i + 1)."): ".$newsql."<br>".$db->error()."</div>";
print '</td></tr>'."\n";
}
dol_syslog('Admin.lib::run_sql Request '.($i + 1)." Error ".$db->errno()." ".$newsql."<br>".$db->error(), LOG_ERR);
$error++;
}
}
}
}
if (!$silent) {
print '<tr><td>'.$langs->trans("ProcessMigrateScript").'</td>';
print '<td class="right">';
if ($error == 0) {
print '<span class="ok">'.$langs->trans("OK").'</span>';
} else {
print '<span class="error">'.$langs->trans("Error").'</span>';
}
//if (!empty($conf->use_javascript_ajax)) { // use_javascript_ajax is not defined
print '<script type="text/javascript">
jQuery(document).ready(function() {
function init_trrunsql'.$keyforsql.'()
{
console.log("toggle .trforrunsql'.$keyforsql.'");
jQuery(".trforrunsql'.$keyforsql.'").toggle();
}
init_trrunsql'.$keyforsql.'();
jQuery(".trforrunsqlshowhide'.$keyforsql.'").click(function() {
init_trrunsql'.$keyforsql.'();
});
});
</script>';
if (count($arraysql)) {
print ' - <a class="trforrunsqlshowhide'.$keyforsql.'" href="#" title="'.($langs->trans("ShowHideTheNRequests", count($arraysql))).'">'.$langs->trans("ShowHideDetails").'</a>';
} else {
print ' - <span class="opacitymedium">'.$langs->trans("ScriptIsEmpty").'</span>';
}
//}
print '</td></tr>'."\n";
}
if ($error == 0) {
$ok = 1;
} else {
$ok = 0;
}
return $ok;
}
/**
* Delete a constant
*
* @param DoliDB $db Database handler
* @param int|string $name Name of constant or rowid of line
* @param int $entity Multi company id, -1 for all entities
* @return int Return integer <0 if KO, >0 if OK
*
* @see dolibarr_get_const(), dolibarr_set_const(), dol_set_user_param()
*/
function dolibarr_del_const($db, $name, $entity = 1)
{
global $conf, $hookmanager;
if (empty($name)) {
dol_print_error(null, 'Error call dolibar_del_const with parameter name empty');
return -1;
}
if (! is_object($hookmanager)) {
require_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($db);
}
$parameters = array(
'name' => $name,
'entity' => $entity,
);
$reshook = $hookmanager->executeHooks('dolibarrDelConst', $parameters); // Note that $action and $object may have been modified by some hooks
if ($reshook != 0) {
return $reshook;
}
$sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
$sql .= " WHERE (".$db->decrypt('name')." = '".$db->escape((string) $name)."'";
if (is_numeric($name)) { // This case seems used in the setup of constant page only, to delete a line.
$sql .= " OR rowid = ".((int) $name);
}
$sql .= ")";
if ($entity >= 0) {
$sql .= " AND entity = ".((int) $entity);
}
dol_syslog("admin.lib::dolibarr_del_const", LOG_DEBUG);
$resql = $db->query($sql);
if ($resql) {
$conf->global->$name = '';
return 1;
} else {
dol_print_error($db);
return -1;
}
}
/**
* Get the value of a setup constant from database
*
* @param DoliDB $db Database handler
* @param string $name Name of constant
* @param int $entity Multi company id
* @return string Value of constant
*
* @see dolibarr_del_const(), dolibarr_set_const(), dol_set_user_param()
*/
function dolibarr_get_const($db, $name, $entity = 1)
{
$value = '';
$sql = "SELECT ".$db->decrypt('value')." as value";
$sql .= " FROM ".MAIN_DB_PREFIX."const";
$sql .= " WHERE name = ".$db->encrypt($name);
$sql .= " AND entity = ".((int) $entity);
dol_syslog("admin.lib::dolibarr_get_const", LOG_DEBUG);
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
include_once DOL_DOCUMENT_ROOT.'/core/lib/security.lib.php';
$value = dolDecrypt($obj->value);
}
}
return $value;
}
/**
* Insert a parameter (key,value) into database (delete old key then insert it again).
*
* @param DoliDB $db Database handler
* @param string $name Name of constant
* @param int|string $value Value of constant
* @param string $type Type of constant. Deprecated, only strings are allowed for $value. Caller must json encode/decode to store other type of data.
* @param int $visible Is constant visible in Setup->Other page (0 by default)
* @param string $note Note on parameter
* @param int $entity Multi company id (0 means all entities)
* @return int -1 if KO, 1 if OK
*
* @see dolibarr_del_const(), dolibarr_get_const(), dol_set_user_param()
*/
function dolibarr_set_const($db, $name, $value, $type = 'chaine', $visible = 0, $note = '', $entity = 1)
{
global $conf, $hookmanager;
// Clean parameters
$name = trim($name);
$value = (string) $value;
// Check parameters
if (empty($name)) {
dol_print_error($db, "Error: Call to function dolibarr_set_const with wrong parameters");
exit;
}
if (! is_object($hookmanager)) {
require_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($db);
}
$value = (string) $value; // We force type string (may be int)
$parameters = array(
'name' => $name,
'value' => $value,
'type' => $type,
'visible' => $visible,
'note' => $note,
'entity' => $entity,
);
$reshook = $hookmanager->executeHooks('dolibarrSetConst', $parameters); // Note that $action and $object may have been modified by some hooks
if ($reshook != 0) {
return $reshook;
}
//dol_syslog("dolibarr_set_const name=$name, value=$value type=$type, visible=$visible, note=$note entity=$entity");
$db->begin();
$sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
$sql .= " WHERE name = ".$db->encrypt($name);
if ($entity >= 0) {
$sql .= " AND entity = ".((int) $entity);
}
dol_syslog("admin.lib::dolibarr_set_const", LOG_DEBUG);
$resql = $db->query($sql);
if (strcmp($value, '')) { // true if different. Must work for $value='0' or $value=0
if (!preg_match('/^(MAIN_LOGEVENTS|MAIN_AGENDA_ACTIONAUTO)/', $name) && (preg_match('/(_KEY|_EXPORTKEY|_SECUREKEY|_SERVERKEY|_PASS|_PASSWORD|_PW|_PW_TICKET|_PW_EMAILING|_SECRET|_SECURITY_TOKEN|_WEB_TOKEN)$/', $name))) {
// This seems a sensitive constant, we encrypt its value
// To list all sensitive constant, you can make a
// WHERE name like '%\_KEY' or name like '%\_EXPORTKEY' or name like '%\_SECUREKEY' or name like '%\_SERVERKEY' or name like '%\_PASS' or name like '%\_PASSWORD' or name like '%\_SECRET'
// or name like '%\_SECURITY_TOKEN' or name like '%\WEB_TOKEN'
include_once DOL_DOCUMENT_ROOT.'/core/lib/security.lib.php';
$newvalue = dolEncrypt($value);
} else {
$newvalue = $value;
}
$sql = "INSERT INTO ".MAIN_DB_PREFIX."const(name, value, type, visible, note, entity)";
$sql .= " VALUES (";
$sql .= $db->encrypt($name);
$sql .= ", ".$db->encrypt($newvalue);
$sql .= ", '".$db->escape($type)."', ".((int) $visible).", '".$db->escape($note)."', ".((int) $entity).")";
//print "sql".$value."-".pg_escape_string($value)."-".$sql;exit;
//print "xx".$db->escape($value);
dol_syslog("admin.lib::dolibarr_set_const", LOG_DEBUG);
$resql = $db->query($sql);
}
if ($resql) {
$db->commit();
$conf->global->$name = $value;
return 1;
} else {
$db->rollback();
return -1;
}
}
/**
* Prepare array with list of tabs
*
* @param int $nbofactivatedmodules Number if activated modules
* @param int $nboftotalmodules Nb of total modules
* @param int $nbmodulesnotautoenabled Nb of modules not auto enabled that are activated
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function modules_prepare_head($nbofactivatedmodules, $nboftotalmodules, $nbmodulesnotautoenabled)
{
global $langs, $form;
$desc = $langs->trans("ModulesDesc", '{picto}');
$desc = str_replace('{picto}', img_picto('', 'switch_off'), $desc);
$h = 0;
$head = array();
$mode = getDolGlobalString('MAIN_MODULE_SETUP_ON_LIST_BY_DEFAULT', 'commonkanban');
$head[$h][0] = DOL_URL_ROOT."/admin/modules.php?mode=".$mode;
if ($nbmodulesnotautoenabled <= getDolGlobalInt('MAIN_MIN_NB_ENABLED_MODULE_FOR_WARNING', 1)) { // If only minimal initial modules enabled)
//$head[$h][1] = $form->textwithpicto($langs->trans("AvailableModules"), $desc);
$head[$h][1] = $langs->trans("AvailableModules");
$head[$h][1] .= $form->textwithpicto('', $langs->trans("YouMustEnableOneModule").'.<br><br><span class="opacitymedium">'.$desc.'</span>', 1, 'warning');
} else {
//$head[$h][1] = $langs->trans("AvailableModules").$form->textwithpicto('<span class="badge marginleftonly">'.$nbofactivatedmodules.' / '.$nboftotalmodules.'</span>', $desc, 1, 'help', '', 1, 3);
$head[$h][1] = $langs->trans("AvailableModules").'<span class="badge marginleftonly">'.$nbofactivatedmodules.' / '.$nboftotalmodules.'</span>';
}
$head[$h][2] = 'modules';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/modules.php?mode=marketplace";
$head[$h][1] = $langs->trans("ModulesMarketPlaces");
$head[$h][2] = 'marketplace';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/modules.php?mode=deploy";
$head[$h][1] = $langs->trans("AddExtensionThemeModuleOrOther");
$head[$h][2] = 'deploy';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/modules.php?mode=develop";
$head[$h][1] = $langs->trans("ModulesDevelopYourModule");
$head[$h][2] = 'develop';
$h++;
return $head;
}
/**
* Prepare array with list of tabs
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function ihm_prepare_head()
{
global $langs, $conf;
$h = 0;
$head = array();
$head[$h][0] = DOL_URL_ROOT."/admin/ihm.php?mode=other";
$head[$h][1] = $langs->trans("LanguageAndPresentation");
$head[$h][2] = 'other';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/ihm.php?mode=template";
$head[$h][1] = $langs->trans("SkinAndColors");
$head[$h][2] = 'template';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/ihm.php?mode=dashboard";
$head[$h][1] = $langs->trans("Dashboard");
$head[$h][2] = 'dashboard';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/ihm.php?mode=login";
$head[$h][1] = $langs->trans("LoginPage");
$head[$h][2] = 'login';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/ihm.php?mode=css";
$head[$h][1] = $langs->trans("CSSPage");
$head[$h][2] = 'css';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/tools/ui/index.php";
$head[$h][1] = $langs->trans("UxComponentsDoc").' '.img_picto('', 'external-link-square-alt');
$head[$h][2] = 'css';
$h++;
complete_head_from_modules($conf, $langs, null, $head, $h, 'ihm_admin');
complete_head_from_modules($conf, $langs, null, $head, $h, 'ihm_admin', 'remove');
return $head;
}
/**
* Prepare array with list of tabs
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function security_prepare_head()
{
global $db, $langs, $conf;
$h = 0;
$head = array();
$head[$h][0] = DOL_URL_ROOT."/admin/security_other.php";
$head[$h][1] = $langs->trans("Miscellaneous");
$head[$h][2] = 'misc';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/security_captcha.php";
$head[$h][1] = $langs->trans("Captcha");
$head[$h][2] = 'captcha';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/security.php";
$head[$h][1] = $langs->trans("Passwords");
$head[$h][2] = 'passwords';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/security_file.php";
$head[$h][1] = $langs->trans("Files").' ('.$langs->trans("UploadName").' | '.$langs->trans("Download").')';
$head[$h][2] = 'file';
$h++;
/*
$head[$h][0] = DOL_URL_ROOT."/admin/security_file_download.php";
$head[$h][1] = $langs->trans("Files").' ('.$langs->trans("Download").')';
$head[$h][2] = 'filedownload';
$h++;
*/
$head[$h][0] = DOL_URL_ROOT."/admin/proxy.php";
$head[$h][1] = $langs->trans("ExternalAccess");
$head[$h][2] = 'proxy';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/events.php";
$head[$h][1] = $langs->trans("Audit");
$head[$h][2] = 'audit';
$h++;
// Show permissions lines
$nbPerms = 0;
$sql = "SELECT COUNT(r.id) as nb";
$sql .= " FROM ".MAIN_DB_PREFIX."rights_def as r";
$sql .= " WHERE r.libelle NOT LIKE 'tou%'"; // On ignore droits "tous"
$sql .= " AND entity = ".((int) $conf->entity);
$sql .= " AND bydefault = 1";
if (!getDolGlobalString('MAIN_USE_ADVANCED_PERMS')) {
$sql .= " AND r.perms NOT LIKE '%_advance'"; // Hide advanced perms if option is not enabled
}
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
$nbPerms = $obj->nb;
}
} else {
dol_print_error($db);
}
if (getDolGlobalString('MAIN_SECURITY_USE_DEFAULT_PERMISSIONS')) {
$head[$h][0] = DOL_URL_ROOT."/admin/perms.php";
$head[$h][1] = $langs->trans("DefaultRights");
if ($nbPerms > 0) {
$head[$h][1] .= (!getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') ? '<span class="badge marginleftonlyshort">'.$nbPerms.'</span>' : '');
}
$head[$h][2] = 'default';
$h++;
}
return $head;
}
/**
* Prepare array with list of tabs
*
* @param DolibarrModules $object Descriptor class
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function modulehelp_prepare_head($object)
{
global $langs, $conf;
$h = 0;
$head = array();
// FIX for compatibility habitual tabs
$object->id = $object->numero;
$head[$h][0] = DOL_URL_ROOT."/admin/modulehelp.php?id=".$object->id.'&mode=desc';
$head[$h][1] = $langs->trans("Description");
$head[$h][2] = 'desc';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/modulehelp.php?id=".$object->id.'&mode=feature';
$head[$h][1] = $langs->trans("TechnicalServicesProvided");
$head[$h][2] = 'feature';
$h++;
if ($object->isCoreOrExternalModule() == 'external') {
$head[$h][0] = DOL_URL_ROOT."/admin/modulehelp.php?id=".$object->id.'&mode=changelog';
$head[$h][1] = $langs->trans("ChangeLog");
$head[$h][2] = 'changelog';
$h++;
}
complete_head_from_modules($conf, $langs, $object, $head, $h, 'modulehelp_admin');
complete_head_from_modules($conf, $langs, $object, $head, $h, 'modulehelp_admin', 'remove');
return $head;
}
/**
* Prepare array with list of tabs
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function translation_prepare_head()
{
global $langs, $conf;
$h = 0;
$head = array();
$head[$h][0] = DOL_URL_ROOT."/admin/translation.php?mode=searchkey";
$head[$h][1] = $langs->trans("TranslationKeySearch");
$head[$h][2] = 'searchkey';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/translation.php?mode=overwrite";
$head[$h][1] = '<span class="valignmiddle">'.$langs->trans("TranslationOverwriteKey").'</span><span class="fa fa-plus-circle valignmiddle paddingleft"></span>';
$head[$h][2] = 'overwrite';
$h++;
complete_head_from_modules($conf, $langs, null, $head, $h, 'translation_admin');
complete_head_from_modules($conf, $langs, null, $head, $h, 'translation_admin', 'remove');
return $head;
}
/**
* Prepare array with list of tabs
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function defaultvalues_prepare_head()
{
global $langs, $conf;
$h = 0;
$head = array();
$head[$h][0] = DOL_URL_ROOT."/admin/defaultvalues.php?mode=createform";
$head[$h][1] = $langs->trans("DefaultCreateForm");
$head[$h][2] = 'createform';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/defaultvalues.php?mode=filters";
$head[$h][1] = $langs->trans("DefaultSearchFilters");
$head[$h][2] = 'filters';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/defaultvalues.php?mode=sortorder";
$head[$h][1] = $langs->trans("DefaultSortOrder");
$head[$h][2] = 'sortorder';
$h++;
if (!empty($conf->use_javascript_ajax)) {
$head[$h][0] = DOL_URL_ROOT."/admin/defaultvalues.php?mode=focus";
$head[$h][1] = $langs->trans("DefaultFocus");
$head[$h][2] = 'focus';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/defaultvalues.php?mode=mandatory";
$head[$h][1] = $langs->trans("DefaultMandatory");
$head[$h][2] = 'mandatory';
$h++;
}
/*$head[$h][0] = DOL_URL_ROOT."/admin/translation.php?mode=searchkey";
$head[$h][1] = $langs->trans("TranslationKeySearch");
$head[$h][2] = 'searchkey';
$h++;*/
complete_head_from_modules($conf, $langs, null, $head, $h, 'defaultvalues_admin');
complete_head_from_modules($conf, $langs, null, $head, $h, 'defaultvalues_admin', 'remove');
return $head;
}
/**
* Return list of session
*
* @return array<string,array{login:string,age:int,creation:null|int|false,modification:int|false,raw:string,remote_ip:?string,user_agent:?string}> Array list of sessions
*/
function listOfSessions()
{
global $conf, $php_session_save_handler;
$arrayofSessions = array();
// Set the handler of session
if (!empty($php_session_save_handler) && $php_session_save_handler == 'db') {
require_once DOL_DOCUMENT_ROOT.'/core/lib/phpsessionin'.$php_session_save_handler.'.lib.php';
return dolListSessions();
}
// session.save_path can be returned empty so we set a default location and work from there
$sessPath = '/tmp';
$iniPath = ini_get("session.save_path");
if ($iniPath) {
$sessPath = $iniPath;
}
$sessPath .= '/'; // We need the trailing slash
dol_syslog('admin.lib:listOfSessions sessPath='.$sessPath);
$dh = @opendir(dol_osencode($sessPath));
if ($dh) {
while (($file = @readdir($dh)) !== false) {
if (preg_match('/^sess_/i', $file) && $file != "." && $file != "..") {
$fullpath = $sessPath.$file;
if (!@is_dir($fullpath) && is_readable($fullpath)) {
$sessValues = file_get_contents($fullpath); // get raw session data
// Example of possible value
//$sessValues = 'newtoken|s:32:"1239f7a0c4b899200fe9ca5ea394f307";dol_loginmesg|s:0:"";newtoken|s:32:"1236457104f7ae0f328c2928973f3cb5";dol_loginmesg|s:0:"";token|s:32:"123615ad8d650c5cc4199b9a1a76783f";
// dol_login|s:5:"admin";dol_authmode|s:8:"dolibarr";dol_tz|s:1:"1";dol_tz_string|s:13:"Europe/Berlin";dol_dst|i:0;dol_dst_observed|s:1:"1";dol_dst_first|s:0:"";dol_dst_second|s:0:"";dol_screenwidth|s:4:"1920";
// dol_screenheight|s:3:"971";dol_company|s:12:"MyBigCompany";dol_entity|i:1;mainmenu|s:4:"home";leftmenuopened|s:10:"admintools";idmenu|s:0:"";leftmenu|s:10:"admintools";';
if (preg_match('/dol_login/i', $sessValues) && // limit to dolibarr session
(preg_match('/dol_entity\|i:'.$conf->entity.';/i', $sessValues) || preg_match('/dol_entity\|s:([0-9]+):"'.$conf->entity.'"/i', $sessValues)) && // limit to current entity
preg_match('/dol_company\|s:([0-9]+):"('.getDolGlobalString('MAIN_INFO_SOCIETE_NOM').')"/i', $sessValues)) { // limit to company name
$tmp = explode('_', $file);
$idsess = $tmp[1];
$regs = array();
$arrayofSessions[$idsess]["login"] = '';
$loginfound = preg_match('/dol_login\|s:[0-9]+:"([A-Za-z0-9]+)"/i', $sessValues, $regs);
if ($loginfound) {
$arrayofSessions[$idsess]["login"] = (string) $regs[1];
}
$arrayofSessions[$idsess]["age"] = time() - filectime($fullpath);
$arrayofSessions[$idsess]["creation"] = filectime($fullpath);
$arrayofSessions[$idsess]["modification"] = filemtime($fullpath);
$arrayofSessions[$idsess]["user_agent"] = null;
$arrayofSessions[$idsess]["remote_ip"] = null;
$arrayofSessions[$idsess]["raw"] = $sessValues;
}
}
}
}
@closedir($dh);
}
return $arrayofSessions;
}
/**
* Purge existing sessions
*
* @param string $mysessionid To avoid to try to delete my own session
* @return int >0 if OK, <0 if KO
*/
function purgeSessions($mysessionid)
{
global $conf;
$sessPath = ini_get("session.save_path")."/";
dol_syslog('admin.lib:purgeSessions mysessionid='.$mysessionid.' sessPath='.$sessPath);
$error = 0;
$dh = @opendir(dol_osencode($sessPath));
if ($dh) {
while (($file = @readdir($dh)) !== false) {
if ($file != "." && $file != "..") {
$fullpath = $sessPath.$file;
if (!@is_dir($fullpath)) {
$sessValues = file_get_contents($fullpath); // get raw session data
if (preg_match('/dol_login/i', $sessValues) && // limit to dolibarr session
(preg_match('/dol_entity\|i:('.$conf->entity.')/', $sessValues) || preg_match('/dol_entity\|s:([0-9]+):"('.$conf->entity.')"/i', $sessValues)) && // limit to current entity
preg_match('/dol_company\|s:([0-9]+):"(' . getDolGlobalString('MAIN_INFO_SOCIETE_NOM').')"/i', $sessValues)) { // limit to company name
$tmp = explode('_', $file);
$idsess = $tmp[1];
// We remove session if it's not ourself
if ($idsess != $mysessionid) {
$res = @unlink($fullpath);
if (!$res) {
$error++;
}
}
}
}
}
}
@closedir($dh);
}
if (!$error) {
return 1;
} else {
return -$error;
}
}
/**
* Enable a module
*
* @param string $value Name of module to activate
* @param int $withdeps Activate/Disable also all dependencies
* @param int $noconfverification Remove verification of $conf variable for module
* @return array{nbmodules?:int,errors:string[],nbperms?:int} array('nbmodules'=>nb modules activated with success, 'errors=>array of error messages, 'nbperms'=>Nb permission added);
*/
function activateModule($value, $withdeps = 1, $noconfverification = 0)
{
global $db, $langs, $conf, $mysoc;
$ret = array();
// Check parameters
if (empty($value)) {
$ret['errors'] = array('ErrorBadParameter');
return $ret;
}
$ret = array('nbmodules' => 0, 'errors' => array(), 'nbperms' => 0);
$modName = $value;
$modFile = $modName.".class.php";
// Loop on each directory to fill $modulesdir
$modulesdir = dolGetModulesDirs();
// Loop on each modulesdir directories
$found = false;
foreach ($modulesdir as $dir) {
if (file_exists($dir.$modFile)) {
$found = @include_once $dir.$modFile;
if ($found) {
break;
}
}
}
$objMod = new $modName($db);
'@phan-var-force DolibarrModules $objMod';
// Test if PHP version ok
$verphp = versionphparray();
$vermin = isset($objMod->phpmin) ? $objMod->phpmin : 0;
if (is_array($vermin) && versioncompare($verphp, $vermin) < 0) {
$ret['errors'][] = $langs->trans("ErrorModuleRequirePHPVersion", versiontostring($vermin));
return $ret;
}
// Test if Dolibarr version ok
$verdol = versiondolibarrarray();
$vermin = isset($objMod->need_dolibarr_version) ? $objMod->need_dolibarr_version : 0;
//print 'version: '.versioncompare($verdol,$vermin).' - '.join(',',$verdol).' - '.join(',',$vermin);exit;
if (is_array($vermin) && versioncompare($verdol, $vermin) < 0) {
$ret['errors'][] = $langs->trans("ErrorModuleRequireDolibarrVersion", versiontostring($vermin));
return $ret;
}
// Test if javascript requirement ok
if (!empty($objMod->need_javascript_ajax) && empty($conf->use_javascript_ajax)) {
$ret['errors'][] = $langs->trans("ErrorModuleRequireJavascript");
return $ret;
}
$const_name = $objMod->const_name;
if ($noconfverification == 0) {
if (getDolGlobalString($const_name)) {
return $ret;
}
}
$result = $objMod->init(); // Enable module
if ($result <= 0) {
$ret['errors'][] = $objMod->error;
} else {
if ($withdeps) {
if (isset($objMod->depends) && is_array($objMod->depends) && !empty($objMod->depends)) {
// Activation of modules this module depends on
// this->depends may be array('modModule1', 'mmodModule2') or array('always'=>array('modModule1'), 'FR'=>array('modModule2"))
foreach ($objMod->depends as $key => $modulestringorarray) {
//var_dump((! is_numeric($key)) && ! preg_match('/^always/', $key) && $mysoc->country_code && ! preg_match('/^'.$mysoc->country_code.'/', $key));exit;
if ((!is_numeric($key)) && !preg_match('/^always/', $key) && $mysoc->country_code && !preg_match('/^'.$mysoc->country_code.'/', $key)) {
dol_syslog("We are not concerned by dependency with key=".$key." because our country is ".$mysoc->country_code);
continue;
}
if (!is_array($modulestringorarray)) {
$modulestringorarray = array($modulestringorarray);
}
foreach ($modulestringorarray as $modulestring) {
$activate = false;
$activateerr = '';
foreach ($modulesdir as $dir) {
if (file_exists($dir.$modulestring.".class.php")) {
$resarray = activateModule($modulestring);
if (empty($resarray['errors'])) {
$activate = true;
} else {
$activateerr = implode(', ', $resarray['errors']);
foreach ($resarray['errors'] as $errorMessage) {
dol_syslog($errorMessage, LOG_ERR);
}
}
break;
}
}
if ($activate) {
$ret['nbmodules'] += $resarray['nbmodules'];
$ret['nbperms'] += $resarray['nbperms'];
} else {
if ($activateerr) {
$ret['errors'][] = $activateerr;
}
$ret['errors'][] = $langs->trans('activateModuleDependNotSatisfied', $objMod->name, $modulestring, $objMod->name).'<br>'.$langs->trans('activateModuleDependNotSatisfied2', $modulestring, $objMod->name);
}
}
}
}
if (isset($objMod->conflictwith) && is_array($objMod->conflictwith) && !empty($objMod->conflictwith)) {
// Deactivation des modules qui entrent en conflict
$num = count($objMod->conflictwith);
for ($i = 0; $i < $num; $i++) {
foreach ($modulesdir as $dir) {
if (file_exists($dir.$objMod->conflictwith[$i].".class.php")) {
unActivateModule($objMod->conflictwith[$i], 0);
}
}
}
}
}
}
if (!count($ret['errors'])) {
$ret['nbmodules']++;
$ret['nbperms'] += (is_array($objMod->rights) ? count($objMod->rights) : 0);
}
return $ret;
}
/**
* Disable a module
*
* @param string $value Nom du module a desactiver
* @param int $requiredby 1=Desactive aussi modules dependants
* @return string Error message or '';
*/
function unActivateModule($value, $requiredby = 1)
{
global $db, $modules, $conf;
// Check parameters
if (empty($value)) {
return 'ErrorBadParameter';
}
$ret = '';
$modName = $value;
$modFile = $modName.".class.php";
// Loop on each directory to fill $modulesdir
$modulesdir = dolGetModulesDirs();
// Loop on each modulesdir directories
$found = false;
foreach ($modulesdir as $dir) {
if (file_exists($dir.$modFile)) {
$found = @include_once $dir.$modFile;
if ($found) {
break;
}
}
}
if ($found) {
$objMod = new $modName($db);
'@phan-var-force DolibarrModules $objMod';
$result = $objMod->remove();
if ($result <= 0) {
$ret = $objMod->error;
}
} else { // We come here when we try to unactivate a module when module does not exists anymore in sources
//print $dir.$modFile;exit;
// TODO Replace this after DolibarrModules is moved as abstract class with a try catch to show module we try to disable has not been found or could not be loaded
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
$genericMod = new DolibarrModules($db);
$genericMod->name = preg_replace('/^mod/i', '', $modName);
$genericMod->rights_class = strtolower(preg_replace('/^mod/i', '', $modName));
$genericMod->const_name = 'MAIN_MODULE_'.strtoupper(preg_replace('/^mod/i', '', $modName));
dol_syslog("modules::unActivateModule Failed to find module file, we use generic function with name ".$modName);
$genericMod->remove('');
}
// Disable modules that depends on module we disable
if (!$ret && $requiredby && isset($objMod) && is_object($objMod) && is_array($objMod->requiredby)) {
$countrb = count($objMod->requiredby);
for ($i = 0; $i < $countrb; $i++) {
//var_dump($objMod->requiredby[$i]);
unActivateModule($objMod->requiredby[$i]);
}
}
return $ret;
}
/**
* Add external modules to list of dictionaries.
* Addition is done into var $taborder, $tabname, etc... that are passed with pointers.
*
* @param int[] $taborder Taborder
* @param string[] $tabname Tabname
* @param string[] $tablib Tablib
* @param string[] $tabsql Tabsql
* @param string[] $tabsqlsort Tabsqlsort
* @param string[] $tabfield Tabfield
* @param string[] $tabfieldvalue Tabfieldvalue
* @param string[] $tabfieldinsert Tabfieldinsert
* @param string[] $tabrowid Tabrowid
* @param bool[] $tabcond Tabcond
* @param array<array<string,string>> $tabhelp Tabhelp
* @param array<string|int,array<int|string,string|array<string,string>>> $tabcomplete Tab complete (will replace all other in future). Key is table name.
* @return int 1
*/
function complete_dictionary_with_modules(&$taborder, &$tabname, &$tablib, &$tabsql, &$tabsqlsort, &$tabfield, &$tabfieldvalue, &$tabfieldinsert, &$tabrowid, &$tabcond, &$tabhelp, &$tabcomplete)
{
global $db, $langs;
dol_syslog("complete_dictionary_with_modules Search external modules to complete the list of dictionary tables", LOG_DEBUG, 1);
// Search modules
$modulesdir = dolGetModulesDirs();
$i = 0; // is a sequencer of modules found
$j = 0; // j is module number. Automatically affected if module number not defined.
foreach ($modulesdir as $dir) {
// Load modules attributes in arrays (name, numero, orders) from dir directory
//print $dir."\n<br>";
dol_syslog("Scan directory ".$dir." for modules");
$handle = @opendir(dol_osencode($dir));
if (is_resource($handle)) {
while (($file = readdir($handle)) !== false) {
//print "$i ".$file."\n<br>";
if (is_readable($dir.$file) && substr($file, 0, 3) == 'mod' && substr($file, dol_strlen($file) - 10) == '.class.php') {
$modName = substr($file, 0, dol_strlen($file) - 10);
if ($modName) {
include_once $dir.$file;
$objMod = new $modName($db);
'@phan-var-force DolibarrModules $objMod';
if ($objMod->numero > 0) {
$j = $objMod->numero;
} else {
$j = 1000 + $i;
}
$modulequalified = 1;
// We discard modules according to features level (PS: if module is activated we always show it)
$const_name = 'MAIN_MODULE_'.strtoupper(preg_replace('/^mod/i', '', get_class($objMod)));
if ($objMod->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2 && !getDolGlobalString($const_name)) {
$modulequalified = 0;
}
if ($objMod->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1 && !getDolGlobalString($const_name)) {
$modulequalified = 0;
}
// If module is not activated disqualified
if (!getDolGlobalString($const_name)) {
$modulequalified = 0;
}
if ($modulequalified) {
// Load languages files of module
if (isset($objMod->langfiles) && is_array($objMod->langfiles)) {
foreach ($objMod->langfiles as $langfile) {
$langs->load($langfile);
}
}
// phpcs:disable
// Complete the arrays &$tabname,&$tablib,&$tabsql,&$tabsqlsort,&$tabfield,&$tabfieldvalue,&$tabfieldinsert,&$tabrowid,&$tabcond
// @phan-suppress-next-line PhanUndeclaredProperty
if (empty($objMod->dictionaries) && !empty($objMod->{"dictionnaries"})) {
// @phan-suppress-next-line PhanUndeclaredProperty
$objMod->dictionaries = $objMod->{"dictionnaries"}; // For backward compatibility
}
// phpcs:enable
if (!empty($objMod->dictionaries)) {
//var_dump($objMod->dictionaries['tabname']);
$nbtabname = $nbtablib = $nbtabsql = $nbtabsqlsort = $nbtabfield = $nbtabfieldvalue = $nbtabfieldinsert = $nbtabrowid = $nbtabcond = $nbtabfieldcheck = $nbtabhelp = 0;
$tabnamerelwithkey = array();
foreach ($objMod->dictionaries['tabname'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $val);
$nbtabname++;
$taborder[] = max($taborder) + 1;
$tabname[] = $val;
$tabnamerelwithkey[$key] = $val;
$tabcomplete[$tmptablename]['picto'] = $objMod->picto;
} // Position
foreach ($objMod->dictionaries['tablib'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtablib++;
$tablib[] = $val;
$tabcomplete[$tmptablename]['lib'] = $val;
}
foreach ($objMod->dictionaries['tabsql'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabsql++;
$tabsql[] = $val;
$tabcomplete[$tmptablename]['sql'] = $val;
}
foreach ($objMod->dictionaries['tabsqlsort'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabsqlsort++;
$tabsqlsort[] = $val;
$tabcomplete[$tmptablename]['sqlsort'] = $val;
}
foreach ($objMod->dictionaries['tabfield'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabfield++;
$tabfield[] = $val;
$tabcomplete[$tmptablename]['field'] = $val;
}
foreach ($objMod->dictionaries['tabfieldvalue'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabfieldvalue++;
$tabfieldvalue[] = $val;
$tabcomplete[$tmptablename]['value'] = $val;
}
foreach ($objMod->dictionaries['tabfieldinsert'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabfieldinsert++;
$tabfieldinsert[] = $val;
$tabcomplete[$tmptablename]['fieldinsert'] = $val;
}
foreach ($objMod->dictionaries['tabrowid'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabrowid++;
$tabrowid[] = $val;
$tabcomplete[$tmptablename]['rowid'] = $val;
}
foreach ($objMod->dictionaries['tabcond'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabcond++;
$tabcond[] = $val;
$tabcomplete[$tmptablename]['cond'] = $val;
}
if (!empty($objMod->dictionaries['tabhelp'])) {
foreach ($objMod->dictionaries['tabhelp'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabhelp++;
$tabhelp[] = $val;
$tabcomplete[$tmptablename]['help'] = $val;
}
}
if (!empty($objMod->dictionaries['tabfieldcheck'])) {
foreach ($objMod->dictionaries['tabfieldcheck'] as $key => $val) {
$tmptablename = preg_replace('/'.MAIN_DB_PREFIX.'/', '', $tabnamerelwithkey[$key]);
$nbtabfieldcheck++;
$tabcomplete[$tmptablename]['fieldcheck'] = $val;
}
}
if ($nbtabname != $nbtablib || $nbtablib != $nbtabsql || $nbtabsql != $nbtabsqlsort) {
print 'Error in descriptor of module '.$const_name.'. Array ->dictionaries has not same number of record for key "tabname", "tablib", "tabsql" and "tabsqlsort"';
//print "$const_name: $nbtabname=$nbtablib=$nbtabsql=$nbtabsqlsort=$nbtabfield=$nbtabfieldvalue=$nbtabfieldinsert=$nbtabrowid=$nbtabcond=$nbtabfieldcheck=$nbtabhelp\n";
} else {
$taborder[] = 0; // Add an empty line
}
}
$j++;
$i++;
} else {
dol_syslog("Module ".get_class($objMod)." not qualified");
}
}
}
}
closedir($handle);
} else {
dol_syslog("htdocs/admin/modules.php: Failed to open directory ".$dir.". See permission and open_basedir option.", LOG_WARNING);
}
}
dol_syslog("", LOG_DEBUG, -1);
return 1;
}
/**
* Activate external modules mandatory when country is country_code
*
* @param string $country_code CountryCode
* @return int 1
*/
function activateModulesRequiredByCountry($country_code)
{
global $db;
$modulesdir = dolGetModulesDirs();
foreach ($modulesdir as $dir) {
// Load modules attributes in arrays (name, numero, orders) from dir directory
dol_syslog("Scan directory ".$dir." for modules");
$handle = @opendir(dol_osencode($dir));
if (is_resource($handle)) {
while (($file = readdir($handle)) !== false) {
if (is_readable($dir.$file) && substr($file, 0, 3) == 'mod' && substr($file, dol_strlen($file) - 10) == '.class.php') {
$modName = substr($file, 0, dol_strlen($file) - 10);
if ($modName) {
include_once $dir.$file;
$objMod = new $modName($db);
'@phan-var-force DolibarrModules $objMod';
$modulequalified = 1;
// We discard modules according to features level (PS: if module is activated we always show it)
$const_name = 'MAIN_MODULE_'.strtoupper(preg_replace('/^mod/i', '', get_class($objMod)));
if ($objMod->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
$modulequalified = 0;
}
if ($objMod->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
$modulequalified = 0;
}
if (getDolGlobalString($const_name)) {
$modulequalified = 0; // already activated
}
if ($modulequalified) {
// Load languages files of module
if (property_exists($objMod, 'automatic_activation') && isset($objMod->automatic_activation) && is_array($objMod->automatic_activation) && isset($objMod->automatic_activation[$country_code])) {
activateModule($modName);
setEventMessages($objMod->automatic_activation[$country_code], null, 'warnings');
}
} else {
dol_syslog("Module ".get_class($objMod)." not qualified");
}
}
}
}
closedir($handle);
} else {
dol_syslog("htdocs/admin/modules.php: Failed to open directory ".$dir.". See permission and open_basedir option.", LOG_WARNING);
}
}
return 1;
}
/**
* Search external modules to complete the list of contact element
*
* @param array<string,string> $elementList elementList
* @return int 1
*/
function complete_elementList_with_modules(&$elementList)
{
global $db, $modules, $conf, $langs;
// Search modules
$filename = array();
$modules = array();
$orders = array();
$categ = array();
$dirmod = array();
$i = 0; // is a sequencer of modules found
$j = 0; // j is module number. Automatically affected if module number not defined.
dol_syslog("complete_elementList_with_modules Search external modules to complete the list of contact element", LOG_DEBUG, 1);
$modulesdir = dolGetModulesDirs();
foreach ($modulesdir as $dir) {
// Load modules attributes in arrays (name, numero, orders) from dir directory
//print $dir."\n<br>";
dol_syslog("Scan directory ".$dir." for modules");
$handle = @opendir(dol_osencode($dir));
if (is_resource($handle)) {
while (($file = readdir($handle)) !== false) {
//print "$i ".$file."\n<br>";
if (is_readable($dir.$file) && substr($file, 0, 3) == 'mod' && substr($file, dol_strlen($file) - 10) == '.class.php') {
$modName = substr($file, 0, dol_strlen($file) - 10);
if ($modName) {
include_once $dir.$file;
$objMod = new $modName($db);
if ($objMod->numero > 0) {
$j = $objMod->numero;
} else {
$j = 1000 + $i;
}
$modulequalified = 1;
// We discard modules according to features level (PS: if module is activated we always show it)
$const_name = 'MAIN_MODULE_'.strtoupper(preg_replace('/^mod/i', '', get_class($objMod)));
if ($objMod->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2 && getDolGlobalString($const_name)) {
$modulequalified = 0;
}
if ($objMod->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1 && getDolGlobalString($const_name)) {
$modulequalified = 0;
}
// If module is not activated disqualified
if (!getDolGlobalString($const_name)) {
$modulequalified = 0;
}
if ($modulequalified) {
// Load languages files of module
if (isset($objMod->langfiles) && is_array($objMod->langfiles)) {
foreach ($objMod->langfiles as $langfile) {
$langs->load($langfile);
}
}
$modules[$i] = $objMod;
$filename[$i] = $modName;
$orders[$i] = $objMod->family."_".$j; // Sort on family then module number
$dirmod[$i] = $dir;
//print "x".$modName." ".$orders[$i]."\n<br>";
if (!empty($objMod->module_parts['contactelement'])) {
if (is_array($objMod->module_parts['contactelement'])) {
foreach ($objMod->module_parts['contactelement'] as $elem => $title) {
$elementList[$elem] = $langs->trans($title);
}
} else {
$elementList[$objMod->name] = $langs->trans($objMod->name);
}
}
$j++;
$i++;
} else {
dol_syslog("Module ".get_class($objMod)." not qualified");
}
}
}
}
closedir($handle);
} else {
dol_syslog("htdocs/admin/modules.php: Failed to open directory ".$dir.". See permission and open_basedir option.", LOG_WARNING);
}
}
dol_syslog("", LOG_DEBUG, -1);
return 1;
}
/**
* Show array with constants to edit
*
* @param array<string,array{type:string,label:string,tooltip?:string}>|array<int,string> $tableau Array of constants array('key'=>array('type'=>type, 'label'=>label, 'tooltip'=>tooltip)
* where type can be 'string', 'text', 'textarea', 'html', 'yesno', 'emailtemplate:xxx', ...
* @param int<2,3> $strictw3c 0=Include form into table (deprecated), 1=Form is outside table to respect W3C (deprecated), 2=No form nor button at all, 3=No form nor button at all and each field has a unique name (form is output by caller, recommended) (typed as int<2,3> to highlight the deprecated values)
* @param string $helptext Tooltip help to use for the column name of values
* @param string $text Text to use for the column name of values
* @return void
*/
function form_constantes($tableau, $strictw3c = 2, $helptext = '', $text = 'Value')
{
global $db, $langs, $conf, $user;
global $_Avery_Labels;
$form = new Form($db);
if (empty($strictw3c)) {
dol_syslog("Warning: Function 'form_constantes' was called with parameter strictw3c = 0, this is deprecated. Value must be 2 now.", LOG_WARNING);
}
if (!empty($strictw3c) && $strictw3c == 1) {
print "\n".'<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
print '<input type="hidden" name="token" value="'.newToken().'">';
print '<input type="hidden" name="action" value="updateall">';
}
print '<div class="div-table-responsive-no-min">';
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print '<td class="">'.$langs->trans("Description").'</td>';
print '<td>';
$text = $langs->trans($text);
print $form->textwithpicto($text, $helptext, 1, 'help', '', 0, 2, 'idhelptext');
print '</td>';
if (empty($strictw3c)) {
print '<td class="center" width="80">'.$langs->trans("Action").'</td>';
}
print "</tr>\n";
$label = '';
foreach ($tableau as $key => $const) { // Loop on each param
$label = '';
// $const is a const key like 'MYMODULE_ABC'
if (is_numeric($key)) { // Very old behaviour
$type = 'string';
} else {
if (is_array($const)) {
$type = $const['type'];
$label = $const['label'];
$const = $key;
} else {
$type = $const;
$const = $key;
}
}
$sql = "SELECT ";
$sql .= "rowid";
$sql .= ", ".$db->decrypt('name')." as name";
$sql .= ", ".$db->decrypt('value')." as value";
$sql .= ", type";
$sql .= ", note";
$sql .= " FROM ".MAIN_DB_PREFIX."const";
$sql .= " WHERE ".$db->decrypt('name')." = '".$db->escape($const)."'";
$sql .= " AND entity IN (0, ".$conf->entity.")";
$sql .= " ORDER BY name ASC, entity DESC";
$result = $db->query($sql);
dol_syslog("List params", LOG_DEBUG);
if ($result) {
$obj = $db->fetch_object($result); // Take first result of select
if (empty($obj)) { // If not yet into table
$obj = (object) array('rowid' => '', 'name' => $const, 'value' => '', 'type' => $type, 'note' => '');
}
if (empty($strictw3c)) { // deprecated. must be always true.
print "\n".'<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
print '<input type="hidden" name="token" value="'.newToken().'">';
print '<input type="hidden" name="page_y" value="'.newToken().'">';
print '<input type="hidden" name="action" value="update">';
}
print '<tr class="oddeven">';
// Show label of parameter
print '<td>';
print '<input type="hidden" name="rowid'.(empty($strictw3c) ? '' : '[]').'" value="'.$obj->rowid.'">';
print '<input type="hidden" name="constname'.(empty($strictw3c) ? '' : '[]').'" value="'.$const.'">';
print '<input type="hidden" name="constnote_'.$obj->name.'" value="'.nl2br(dol_escape_htmltag($obj->note)).'">';
print '<input type="hidden" name="consttype_'.$obj->name.'" value="'.($obj->type ? $obj->type : 'string').'">';
$picto = 'generic';
$tmparray = explode(':', $obj->type);
if (!empty($tmparray[1])) {
$picto = preg_replace('/_send$/', '', $tmparray[1]);
}
print img_picto('', $picto, 'class="pictofixedwidth"');
if (!empty($tableau[$key]['tooltip'])) {
print $form->textwithpicto($label ? $label : $langs->trans('Desc'.$const), $tableau[$key]['tooltip']);
} else {
print($label ? $label : $langs->trans('Desc'.$const));
}
if ($const == 'ADHERENT_MAILMAN_URL') {
print '. '.$langs->trans("Example").': <a href="#" id="exampleclick1">'.img_down().'</a><br>';
//print 'http://lists.example.com/cgi-bin/mailman/admin/%LISTE%/members?adminpw=%MAILMAN_ADMINPW%&subscribees=%EMAIL%&send_welcome_msg_to_this_batch=1';
print '<div id="example1" class="hidden">';
print 'http://lists.example.com/cgi-bin/mailman/admin/%LISTE%/members/add?subscribees_upload=%EMAIL%&adminpw=%MAILMAN_ADMINPW%&subscribe_or_invite=0&send_welcome_msg_to_this_batch=0&notification_to_list_owner=0';
print '</div>';
} elseif ($const == 'ADHERENT_MAILMAN_UNSUB_URL') {
print '. '.$langs->trans("Example").': <a href="#" id="exampleclick2">'.img_down().'</a><br>';
print '<div id="example2" class="hidden">';
print 'http://lists.example.com/cgi-bin/mailman/admin/%LISTE%/members/remove?unsubscribees_upload=%EMAIL%&adminpw=%MAILMAN_ADMINPW%&send_unsub_ack_to_this_batch=0&send_unsub_notifications_to_list_owner=0';
print '</div>';
//print 'http://lists.example.com/cgi-bin/mailman/admin/%LISTE%/members/remove?adminpw=%MAILMAN_ADMINPW%&unsubscribees=%EMAIL%';
} elseif ($const == 'ADHERENT_MAILMAN_LISTS') {
print '. '.$langs->trans("Example").': <a href="#" id="exampleclick3">'.img_down().'</a><br>';
print '<div id="example3" class="hidden">';
print 'mymailmanlist<br>';
print 'mymailmanlist1,mymailmanlist2<br>';
print 'TYPE:Type1:mymailmanlist1,TYPE:Type2:mymailmanlist2<br>';
if (isModEnabled('category')) {
print 'CATEG:Categ1:mymailmanlist1,CATEG:Categ2:mymailmanlist2<br>';
}
print '</div>';
//print 'http://lists.example.com/cgi-bin/mailman/admin/%LISTE%/members/remove?adminpw=%MAILMAN_ADMINPW%&unsubscribees=%EMAIL%';
} elseif (in_array($const, ['ADHERENT_MAIL_FROM', 'ADHERENT_CC_MAIL_FROM'])) {
print ' '.img_help(1, $langs->trans("EMailHelpMsgSPFDKIM"));
}
print "</td>\n";
// Value
if ($const == 'ADHERENT_CARD_TYPE' || $const == 'ADHERENT_ETIQUETTE_TYPE') {
print '<td>';
// List of possible labels (defined into $_Avery_Labels variable set into format_cards.lib.php)
require_once DOL_DOCUMENT_ROOT.'/core/lib/format_cards.lib.php';
$arrayoflabels = array();
foreach (array_keys($_Avery_Labels) as $codecards) {
$arrayoflabels[$codecards] = $_Avery_Labels[$codecards]['name'];
}
print $form->selectarray('constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')), $arrayoflabels, ($obj->value ? $obj->value : 'CARD'), 1, 0, 0);
print '<input type="hidden" name="consttype" value="yesno">';
print '<input type="hidden" name="constnote'.(empty($strictw3c) ? '' : '[]').'" value="'.nl2br(dol_escape_htmltag($obj->note)).'">';
print '</td>';
} else {
print '<td>';
print '<input type="hidden" name="consttype'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')).'" value="'.($obj->type ? $obj->type : 'string').'">';
print '<input type="hidden" name="constnote'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')).'" value="'.nl2br(dol_escape_htmltag($obj->note)).'">';
if ($obj->type == 'textarea' || in_array($const, array('ADHERENT_CARD_TEXT', 'ADHERENT_CARD_TEXT_RIGHT', 'ADHERENT_ETIQUETTE_TEXT'))) {
print '<textarea class="flat" name="constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')).'" cols="50" rows="5" wrap="soft">'."\n";
print $obj->value;
print "</textarea>\n";
} elseif ($obj->type == 'html') {
require_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
$doleditor = new DolEditor('constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')), $obj->value, '', 160, 'dolibarr_notes', '', false, false, isModEnabled('fckeditor'), ROWS_5, '90%');
$doleditor->Create();
} elseif ($obj->type == 'yesno') {
print $form->selectyesno('constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')), $obj->value, 1, false, 0, 1);
} elseif (preg_match('/emailtemplate/', $obj->type)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/html.formmail.class.php';
$formmail = new FormMail($db);
$tmp = explode(':', $obj->type);
$nboftemplates = $formmail->fetchAllEMailTemplate($tmp[1], $user, null, -1); // We set lang=null to get in priority record with no lang
//$arraydefaultmessage = $formmail->getEMailTemplate($db, $tmp[1], $user, null, 0, 1, '');
$arrayofmessagename = array();
if (is_array($formmail->lines_model)) {
foreach ($formmail->lines_model as $modelmail) {
//var_dump($modelmail);
$moreonlabel = '';
if (!empty($arrayofmessagename[$modelmail->label])) {
$moreonlabel = ' <span class="opacitymedium">('.$langs->trans("SeveralLangugeVariatFound").')</span>';
}
// The 'label' is the key that is unique if we exclude the language
$arrayofmessagename[$modelmail->label.':'.$tmp[1]] = $langs->trans(preg_replace('/\(|\)/', '', $modelmail->label)).$moreonlabel;
}
}
//var_dump($arraydefaultmessage);
//var_dump($arrayofmessagename);
print $form->selectarray('constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')), $arrayofmessagename, $obj->value.':'.$tmp[1], 'None', 0, 0, '', 0, 0, 0, '', '', 1);
print '<a href="'.DOL_URL_ROOT.'/admin/mails_templates.php?action=create&type_template='.urlencode($tmp[1]).'&backtopage='.urlencode($_SERVER["PHP_SELF"]).'">'.img_picto('', 'add').'</a>';
} elseif (preg_match('/MAIL_FROM$/i', $const)) {
print img_picto('', 'email', 'class="pictofixedwidth"').'<input type="text" class="flat minwidth300" name="constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')).'" value="'.dol_escape_htmltag($obj->value).'">';
} else { // type = 'string' ou 'chaine'
print '<input type="text" class="flat minwidth300" name="constvalue'.(empty($strictw3c) ? '' : ($strictw3c == 3 ? '_'.$const : '[]')).'" value="'.dol_escape_htmltag($obj->value).'">';
}
print '</td>';
}
// Submit button
if (empty($strictw3c)) { // deprecated. must be always true.
print '<td class="center">';
print '<input type="submit" class="button small reposition" value="'.$langs->trans("Update").'" name="update">';
print "</td>";
}
print "</tr>\n";
if (empty($strictw3c)) {
print "</form>\n";
}
}
}
print '</table>';
print '</div>';
if (!empty($strictw3c) && $strictw3c == 1) {
print '<div align="center"><input type="submit" class="button small reposition" value="'.$langs->trans("Update").'" name="update"></div>';
print "</form>\n";
}
}
/**
* Show array with constants to edit
*
* @param DolibarrModules[] $modules Array of all modules
* @return string HTML string with warning
*/
function showModulesExludedForExternal($modules)
{
global $langs;
$text = $langs->transnoentitiesnoconv("OnlyFollowingModulesAreOpenedToExternalUsers");
$listofmodules = explode(',', getDolGlobalString('MAIN_MODULES_FOR_EXTERNAL')); // List of modules qualified for external user management
$i = 0;
if (!empty($modules)) {
$tmpmodules = dol_sort_array($modules, 'module_position');
foreach ($tmpmodules as $module) { // Loop on array of modules
$moduleconst = $module->const_name;
$modulename = strtolower($module->name);
//print 'modulename='.$modulename;
//if (empty($conf->global->$moduleconst)) continue;
if (!in_array($modulename, $listofmodules)) {
continue;
}
//var_dump($modulename.' - '.$langs->trans('Module'.$module->numero.'Name'));
if ($i > 0) {
$text .= ', ';
} else {
$text .= ' ';
}
$i++;
$tmptext = $langs->transnoentitiesnoconv('Module'.$module->numero.'Name');
if ($tmptext != 'Module'.$module->numero.'Name') {
$text .= $langs->transnoentitiesnoconv('Module'.$module->numero.'Name');
} else {
$text .= $langs->transnoentitiesnoconv($module->name);
}
}
}
return $text;
}
/**
* Add document model used by doc generator
*
* @param string $name Model name
* @param string $type Model type
* @param string $label Model label
* @param string $description Model description
* @return int Return integer <0 if KO, >0 if OK
*/
function addDocumentModel($name, $type, $label = '', $description = '')
{
global $db, $conf;
$db->begin();
$sql = "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity, libelle, description)";
$sql .= " VALUES ('".$db->escape($name)."','".$db->escape($type)."',".((int) $conf->entity).", ";
$sql .= ($label ? "'".$db->escape($label)."'" : 'null').", ";
$sql .= (!empty($description) ? "'".$db->escape($description)."'" : "null");
$sql .= ")";
dol_syslog("admin.lib::addDocumentModel", LOG_DEBUG);
$resql = $db->query($sql);
if ($resql) {
$db->commit();
return 1;
} else {
dol_print_error($db);
$db->rollback();
return -1;
}
}
/**
* Delete document model used by doc generator
*
* @param string $name Model name
* @param string $type Model type
* @return int Return integer <0 if KO, >0 if OK
*/
function delDocumentModel($name, $type)
{
global $db, $conf;
$db->begin();
$sql = "DELETE FROM ".MAIN_DB_PREFIX."document_model";
$sql .= " WHERE nom = '".$db->escape($name)."'";
$sql .= " AND type = '".$db->escape($type)."'";
$sql .= " AND entity = ".((int) $conf->entity);
dol_syslog("admin.lib::delDocumentModel", LOG_DEBUG);
$resql = $db->query($sql);
if ($resql) {
$db->commit();
return 1;
} else {
dol_print_error($db);
$db->rollback();
return -1;
}
}
/**
* Return the php_info into an array
*
* @return array<string,array<string,string|array{local:string,master:string}>> Array with PHP info
*/
function phpinfo_array()
{
ob_start();
phpinfo();
$phpinfostring = ob_get_contents();
ob_end_clean();
$info_arr = array();
$info_lines = explode("\n", strip_tags($phpinfostring, "<tr><td><h2>"));
$cat = "General";
foreach ($info_lines as $line) {
// new cat?
$title = array();
preg_match("~<h2>(.*)</h2>~", $line, $title) ? $cat = $title[1] : null;
$val = array();
if (preg_match("~<tr><td[^>]+>([^<]*)</td><td[^>]+>([^<]*)</td></tr>~", $line, $val)) {
$info_arr[trim($cat)][trim($val[1])] = $val[2];
} elseif (preg_match("~<tr><td[^>]+>([^<]*)</td><td[^>]+>([^<]*)</td><td[^>]+>([^<]*)</td></tr>~", $line, $val)) {
$info_arr[trim($cat)][trim($val[1])] = array("local" => $val[2], "master" => $val[3]);
}
}
return $info_arr;
}
/**
* Return array head with list of tabs to view object information.
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function company_admin_prepare_head()
{
global $langs, $conf;
$h = 0;
$head = array();
$head[$h][0] = DOL_URL_ROOT."/admin/company.php";
$head[$h][1] = $langs->trans("Company");
$head[$h][2] = 'company';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/company_socialnetworks.php";
$head[$h][1] = $langs->trans("SocialNetworksInformation");
$head[$h][2] = 'socialnetworks';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/openinghours.php";
$head[$h][1] = $langs->trans("OpeningHours");
$head[$h][2] = 'openinghours';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/accountant.php";
$head[$h][1] = $langs->trans("Accountant");
$head[$h][2] = 'accountant';
$h++;
complete_head_from_modules($conf, $langs, null, $head, $h, 'mycompany_admin', 'add');
complete_head_from_modules($conf, $langs, null, $head, $h, 'mycompany_admin', 'remove');
return $head;
}
/**
* Return array head with list of tabs to view object information.
*
* @return array<array{0:string,1:string,2:string}> Array of tabs to show
*/
function email_admin_prepare_head()
{
global $langs, $conf, $user;
$h = 0;
$head = array();
if (!empty($user->admin) && (empty($_SESSION['leftmenu']) || $_SESSION['leftmenu'] != 'email_templates')) {
$head[$h][0] = DOL_URL_ROOT."/admin/mails.php";
$head[$h][1] = $langs->trans("OutGoingEmailSetup");
$head[$h][2] = 'common';
$h++;
if (isModEnabled('mailing')) {
$head[$h][0] = DOL_URL_ROOT."/admin/mails_emailing.php";
$head[$h][1] = $langs->trans("OutGoingEmailSetupForEmailing", $langs->transnoentitiesnoconv("EMailing"));
$head[$h][2] = 'common_emailing';
$h++;
}
if (isModEnabled('ticket')) {
$head[$h][0] = DOL_URL_ROOT."/admin/mails_ticket.php";
$head[$h][1] = $langs->trans("OutGoingEmailSetupForEmailing", $langs->transnoentitiesnoconv("Ticket"));
$head[$h][2] = 'common_ticket';
$h++;
}
if (!getDolGlobalString('MAIN_MAIL_HIDE_CUSTOM_SENDING_METHOD_FOR_PASSWORD_RESET')) {
$head[$h][0] = DOL_URL_ROOT."/admin/mails_passwordreset.php";
$head[$h][1] = $langs->trans("OutGoingEmailSetupForEmailing", $langs->transnoentitiesnoconv("PasswordReset"));
$head[$h][2] = 'common_passwordreset';
$h++;
}
}
// Admin and non admin can view this menu entry, but it is not shown yet when we on user menu "Email templates"
if (empty($_SESSION['leftmenu']) || $_SESSION['leftmenu'] != 'email_templates') {
$head[$h][0] = DOL_URL_ROOT."/admin/mails_senderprofile_list.php";
$head[$h][1] = $langs->trans("EmailSenderProfiles");
$head[$h][2] = 'senderprofiles';
$h++;
}
$head[$h][0] = DOL_URL_ROOT."/admin/mails_templates.php";
$head[$h][1] = $langs->trans("EMailTemplates");
$head[$h][2] = 'templates';
$h++;
$head[$h][0] = DOL_URL_ROOT."/admin/mails_ingoing.php";
$head[$h][1] = $langs->trans("InGoingEmailSetup", $langs->transnoentitiesnoconv("EMailing"));
$head[$h][2] = 'common_ingoing';
$h++;
complete_head_from_modules($conf, $langs, null, $head, $h, 'email_admin', 'remove');
return $head;
}