functions.lib.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2000-2007  Rodolphe Quiedeville    <rodolphe@quiedeville.org>
 * Copyright (C) 2003   Jean-Louis Bergamo      <jlb@j1b.org>
 * Copyright (C) 2004-2025  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2004   Sebastien Di Cintio     <sdicintio@ressource-toi.org>
 * Copyright (C) 2004   Benoit Mortier        <benoit.mortier@opensides.be>
 * Copyright (C) 2004   Christophe Combelles    <ccomb@free.fr>
 * Copyright (C) 2005-2019  Regis Houssin       <regis.houssin@inodbox.com>
 * Copyright (C) 2008   Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
 * Copyright (C) 2010-2018  Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2013   Cédric Salvador       <csalvador@gpcsolutions.fr>
 * Copyright (C) 2013-2026  Alexandre Spangaro      <alexandre@inovea-conseil.com>
 * Copyright (C) 2014   Cédric GROSS        <c.gross@kreiz-it.fr>
 * Copyright (C) 2014-2015  Marcos García       <marcosgdf@gmail.com>
 * Copyright (C) 2015   Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2018-2026  Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2019-2023  Thibault Foucart            <support@ptibogxiv.net>
 * Copyright (C) 2020       Open-Dsi              <support@open-dsi.fr>
 * Copyright (C) 2021       Gauthier VERDOL           <gauthier.verdol@atm-consulting.fr>
 * Copyright (C) 2022-2026  Anthony Berton            <anthony.berton@bb2a.fr>
 * Copyright (C) 2022       Ferran Marcet             <fmarcet@2byte.es>
 * Copyright (C) 2022-2026  Charlene Benke            <charlene@patas-monkey.com>
 * Copyright (C) 2024-2026  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2023-2024  Joachim Kueter              <git-jk@bloxera.com>
 * Copyright (C) 2024   Lenin Rivas         <lenin.rivas777@gmail.com>
 * Copyright (C) 2024   Josep Lluís Amador Teruel <joseplluis@lliuretic.cat>
 * Copyright (C) 2024   Benoît PASCAL       <contact@p-ben.com>
 * Copyright (C) 2025   Vincent Maury       <vmaury@timgroup.fr>
 * Copyright (C) 2026   Benjamin Falière      <benjamin@faliere.com>
 * Copyright (C) 2026   Pierre Ardoin       <developpeur@lesmetiersdubatiment.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/
 */
 
//include_once DOL_DOCUMENT_ROOT.'/core/lib/json.lib.php';
 
// Function for better PHP x compatibility
if (!function_exists('utf8_encode')) {
  function utf8_encode($elements)
  {
    return mb_convert_encoding($elements, 'UTF-8', 'ISO-8859-1');
  }
}
 
if (!function_exists('utf8_decode')) {
  function utf8_decode($elements)
  {
    return mb_convert_encoding($elements, 'ISO-8859-1', 'UTF-8');
  }
}
if (!function_exists('str_starts_with')) {
  function str_starts_with($haystack, $needle)
  {
    return (string) $needle !== '' && strncmp($haystack, $needle, strlen($needle)) === 0;
  }
}
if (!function_exists('str_ends_with')) {
  function str_ends_with($haystack, $needle)
  {
    return $needle !== '' && substr($haystack, -strlen($needle)) === (string) $needle;
  }
}
if (!function_exists('str_contains')) {
  function str_contains($haystack, $needle)
  {
    return $needle !== '' && mb_strpos($haystack, $needle) !== false;
  }
}
 
 
function formatLogObject($data)
{
  if (getDolGlobalInt("MAIN_LOG_ON_ONE_LINE")) {
    return json_encode($data);
  }
 
  return var_export($data, true);
}
 
 
function getMultidirOutput($object, $module = '', $forobject = 0, $mode = 'output')
{
  global $conf;
 
  $subdirectory = '';
  if (!is_object($object) && empty($module)) {
    return null;
  }
  if (empty($module) && !empty($object->element)) {
    $module = $object->element;
  }
 
  // Special case for backward compatibility
  switch ($module) {
    case 'fichinter':
      $module = 'ficheinter';
      break;
    case 'invoice_supplier':
      $module = 'supplier_invoice';
      break;
    case 'order_supplier':
      $module = 'supplier_order';
      break;
    case 'recruitmentjobposition':
      $module = 'recruitment';
      $subdirectory = '/recruitmentjobposition';
      break;
    case 'recruitmentcandidature':
      $module = 'recruitment';
      $subdirectory = '/recruitmentcandidature';
      break;
    case 'knowledgerecord':
      $module = 'knowledgemanagement';
      $subdirectory = '/knowledgerecord';
      break;
    case 'partnership':
      $subdirectory = '/partnership';
      break;
    case 'stocktransfer':
      $subdirectory = '/stocktransfer';
      break;
    case 'commande_fournisseur':
      $module = 'fournisseur';
      $subdirectory = '/commande';
      break;
    case 'expedition':
    case 'shipment':
    case 'shipping':
      $module = 'expedition';
      $subdirectory = '/sending';
      break;
    case 'company':
      $module = 'societe';
      break;
    case 'service':
    case 'produit':
      $module = 'product';
      break;
    case 'project_task':
      $module = 'projet';
 
      // Fetch the project to build the correct path. The signature of this function accepts an object
      // that is not a CommonObject, and even a null when a module is given, so we must not call a method
      // that only a CommonObject owns without testing it exists.
      if (is_object($object) && method_exists($object, 'fetchProject')) {
        $object->fetchProject();
      }
 
      // The ref must be sanitized with dol_sanitizeFileName() and not only with dol_sanitizePathName()
      // done at the end of this function, because a project ref is a user input that may contain a '/',
      // a ':' or an accented char. dol_sanitizePathName() keeps them, so we would not return the
      // directory used by projet/tasks/document.php, that sanitizes the ref with dol_sanitizeFileName().
      if (!empty($object->project->ref)) {
        $subdirectory = '/'.dol_sanitizeFileName($object->project->ref);
      }
      break;
    case 'action':
    case 'actioncomm':
    case 'event':
      $module = 'agenda';
      break;
    default:
      break;
  }
 
  // Get the relative path of directory
  if ($mode == 'output' || $mode == 'outputrel' || $mode == 'version') {
    if (isset($conf->$module) && property_exists($conf->$module, 'multidir_output')) {
      $s = '';
      if ($mode != 'outputrel') {
        // An entity with no directory declared used to return an undefined index, so a relative path
        // that made the caller read or write under the web root. Answer the error instead.
        $entity = (int) (empty($object->entity) ? $conf->entity : $object->entity);
        if (!isset($conf->$module->multidir_output[$entity])) {
          return 'error-diroutput-not-defined-for-this-object='.$module;
        }
        $s = $conf->$module->multidir_output[$entity].$subdirectory;
      }
      if ($forobject && $object->id > 0) {
        $s .= ($mode != 'outputrel' ? '/' : '') . get_exdir(0, 0, 0, 0, $object);
      }
      return dol_sanitizePathName($s);
    } elseif (isset($conf->$module) && property_exists($conf->$module, 'dir_output')) {
      $s = '';
      if ($mode != 'outputrel') {
        $s = $conf->$module->dir_output . $subdirectory;
      }
      if ($forobject && $object->id > 0) {
        $s .= ($mode != 'outputrel' ? '/' : '') . get_exdir(0, 0, 0, 0, $object);
      }
      return dol_sanitizePathName($s);
    } else {
      return 'error-diroutput-not-defined-for-this-object=' . $module;
    }
  } elseif ($mode == 'temp') {
    if (isset($conf->$module) && property_exists($conf->$module, 'multidir_temp')) {
      // Same guard as the 'output' mode above, see the comment there
      $entity = (int) (empty($object->entity) ? $conf->entity : $object->entity);
      if (!isset($conf->$module->multidir_temp[$entity])) {
        return 'error-dirtemp-not-defined-for-this-object='.$module;
      }
      return dol_sanitizePathName($conf->$module->multidir_temp[$entity]);
    } elseif (isset($conf->$module) && property_exists($conf->$module, 'dir_temp')) {
      return dol_sanitizePathName($conf->$module->dir_temp);
    } else {
      return 'error-dirtemp-not-defined-for-this-object=' . $module;
    }
  } else {
    return 'error-bad-value-for-mode';
  }
}
 
function getMultidirTemp($object, $module = '', $forobject = 0)
{
  return getMultidirOutput($object, $module, $forobject, 'temp');
}
 
function getMultidirVersion($object, $module = '', $forobject = 0)
{
  return getMultidirOutput($object, $module, $forobject, 'version');
}
 
 
function getDolGlobalString($key, $default = '')
{
  global $conf;
  return (string) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
 
function getDolGlobalLoginBadCharUnauthorized()
{
  global $dolibarr_login_badcharunauthorized;
 
  if (isset($dolibarr_login_badcharunauthorized)) {
    if ($dolibarr_login_badcharunauthorized === 'MAIN_LOGIN_BADCHARUNAUTHORIZED') {
      return getDolGlobalString('MAIN_LOGIN_BADCHARUNAUTHORIZED', ',@<>"\'');
    }
 
    return (string) $dolibarr_login_badcharunauthorized;
  }
 
  return ',@<>"\'';
}
 
function getDolGlobalInt($key, $default = 0)
{
  global $conf;
  return (int) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
 
function getDolGlobalFloat($key, $default = 0)
{
  global $conf;
  return (float) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
 
function getDolGlobalBool($key, $default = false)
{
  global $conf;
  return (bool) ($conf->global->$key ?? $default);
}
 
function getDolCurrency()
{
  global $conf;
  return (string) $conf->currency;
}
 
function getDolOptimizeSmallScreen()
{
  global $conf;
  return (string) $conf->dol_optimize_smallscreen;
}
 
function getDolEntity()
{
  global $conf;
  return (int) $conf->entity;
}
 
function getDolDBType()
{
  global $conf;
  return $conf->db->type;
}
 
function getDolDefaultContextPage($s)
{
  return str_replace('_', '', basename(dirname($s)).basename($s, '.php'));
}
 
function getDolUserString($key, $default = '', $tmpuser = null)
{
  if (empty($tmpuser)) {
    global $user;
    $tmpuser = $user;
  }
 
  return (string) (isset($tmpuser->conf->$key) ? $tmpuser->conf->$key : $default);
}
 
function getDolUserInt($key, $default = 0, $tmpuser = null)
{
  if (empty($tmpuser)) {
    global $user;
    $tmpuser = $user;
  }
 
  return (int) (isset($tmpuser->conf->$key) ? $tmpuser->conf->$key : $default);
}
 
 
define(
  'MODULE_MAPPING',
  array(
    // Map deprecated names to new names
    'adherent' => 'member',  // Has new directory
    'member_type' => 'adherent_type',   // No directory, but file called adherent_type
    'banque' => 'bank',   // Has new directory
    'contrat' => 'contract', // Has new directory
    'entrepot' => 'stock',   // Has new directory
    'projet'  => 'project', // Has new directory
    'categorie' => 'category', // Has old directory
    'commande' => 'order',    // Has old directory
    'expedition' => 'shipping', // Has old directory
    'facture' => 'invoice', // Has old directory
    'fichinter' => 'intervention', // Has old directory
    'ficheinter' => 'intervention',  // Backup for 'fichinter'
    'propale' => 'propal', // Has old directory
    'societe' => 'thirdparty',  // Has old directory
    'socpeople' => 'contact', // Has old directory
    'fournisseur' => 'supplier',  // Has old directory
 
    'actioncomm' => 'agenda',  // NO module directory (public dir agenda)
    'product_price' => 'productprice', // NO directory
    'product_fournisseur_price' => 'productsupplierprice', // NO directory
  )
);
 
function isModEnabled($module)
{
  global $conf;
 
  // Fix old names (map to new names)
  $arrayconv = MODULE_MAPPING;
  $arrayconvbis = array_flip(MODULE_MAPPING);
 
  if (!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD')) {
    // Special cases: both use the same module.
    $arrayconv['supplier_order'] = 'fournisseur';
    $arrayconv['supplier_invoice'] = 'fournisseur';
  }
 
  $module_alt = $module;
  if (!empty($arrayconv[$module])) {
    $module_alt = $arrayconv[$module];
  }
  $module_bis = $module;
  if (!empty($arrayconvbis[$module])) {
    $module_bis = $arrayconvbis[$module];
  }
 
  return !empty($conf->modules[$module]) || !empty($conf->modules[$module_alt]) || !empty($conf->modules[$module_bis]);
}
 
function getWarningDelay($module, $parmlevel1, $parmlevel2 = '')
{
  global $conf;
 
  // For compatibility with bad naming on module
  $moduletomoduletouse = array(
    'invoice' => 'facture',
  );
  $moduleParmsMapping = array(
    'product' => 'produit',
  );
 
  if (!empty($moduletomoduletouse[$module])) {
    $module = $moduletomoduletouse[$module];
  }
 
  $warningDelayPath = $parmlevel1;
  if (!empty($moduleParmsMapping[$warningDelayPath])) {
    $warningDelayPath = $moduleParmsMapping[$warningDelayPath];
  }
 
  if ($parmlevel2) {
    if (!empty($conf->$module) && !empty($conf->$module->$warningDelayPath) && !empty($conf->$module->$warningDelayPath->$parmlevel2) && !empty($conf->$module->$warningDelayPath->$parmlevel2->warning_delay)) {
      return (int) $conf->$module->$warningDelayPath->$parmlevel2->warning_delay;
    }
  } else {
    if (!empty($conf->$module) && !empty($conf->$module->$warningDelayPath) && !empty($conf->$module->$warningDelayPath->warning_delay)) {
      return (int) $conf->$module->$warningDelayPath->warning_delay;
    }
  }
 
  return 0;
}
 
function isDolTms($timestamp)
{
  if ($timestamp === '') {
    dol_syslog('Using empty string for a timestamp is deprecated, prefer use of null when calling page ' . $_SERVER["PHP_SELF"] . getCallerInfoString(), LOG_NOTICE);
    return false;
  }
  if (is_null($timestamp) || !is_numeric($timestamp)) {
    return false;
  }
 
  return true;
}
 
function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
{
  require_once DOL_DOCUMENT_ROOT . "/core/db/" . $type . '.class.php';
 
  $class = 'DoliDB' . ucfirst($type);
  $db = new $class($type, $host, $user, $pass, $name, $port);
  return $db;
}
 
function getEntity($element, $shared = 1, $currentobject = null)
{
  global $conf, $mc, $hookmanager, $object, $action, $db;
 
  if (!is_object($hookmanager)) {
    include_once DOL_DOCUMENT_ROOT . '/core/class/hookmanager.class.php';
    $hookmanager = new HookManager($db);
  }
 
  // fix different element names (France to English)
  switch ($element) {
    case 'projet':
      $element = 'project';
      break;
    case 'contrat':
      $element = 'contract';
      break; // "/contrat/class/contrat.class.php"
    case 'order_supplier':
      $element = 'supplier_order';
      break; // "/fourn/class/fournisseur.commande.class.php"
    case 'invoice_supplier':
      $element = 'supplier_invoice';
      break; // "/fourn/class/fournisseur.facture.class.php"
  }
 
  if (is_object($mc)) {
    $out = $mc->getEntity($element, $shared, $currentobject);
  } else {
    $out = '';
    $addzero = array('user', 'usergroup', 'cronjob', 'c_email_templates', 'email_template', 'default_values', 'overwrite_trans');
    if (getDolGlobalString('HOLIDAY_ALLOW_ZERO_IN_DIC')) { // this constant break the dictionary admin without Multicompany
      $addzero[] = 'c_holiday_types';
    }
    if (in_array($element, $addzero)) {
      $out .= '0,';
    }
    $out .= ((int) $conf->entity);
  }
 
  // Manipulate entities to query on the fly
  $parameters = array(
    'element' => $element,
    'shared' => $shared,
    'object' => $object,
    'currentobject' => $currentobject,
    'out' => $out
  );
  // @phan-suppress-next-line PhanTypeMismatchArgumentNullable
  $reshook = $hookmanager->executeHooks('hookGetEntity', $parameters, $currentobject, $action); // Note that $action and $object may have been modified by some hooks
 
  if (is_numeric($reshook)) {
    if ($reshook == 0 && !empty($hookmanager->resPrint)) {
      $out .= ',' . $hookmanager->resPrint; // add
    } elseif ($reshook == 1) {
      $out = $hookmanager->resPrint; // replace
    }
  }
 
  return $out;
}
 
function setEntity($currentobject)
{
  global $conf, $mc;
 
  if (is_object($mc) && method_exists($mc, 'setEntity')) {
    return $mc->setEntity($currentobject);
  } else {
    return ((is_object($currentobject) && $currentobject->id > 0 && ((int) $currentobject->entity) > 0) ? (int) $currentobject->entity : $conf->entity);
  }
}
 
function isASecretKey($keyname)
{
  return preg_match('/(_pass|password|_pw|_key|securekey|serverkey|secret\d?|p12key|exportkey|_PW_[a-z]+|token)$/i', $keyname);
}
 
 
function num2Alpha($n)
{
  $r = '';
  for ($r = ""; $n >= 0; $n = intval($n / 26) - 1) {
    $r = chr($n % 26 + 0x41) . $r;
  }
  return $r;
}
 
 
function getBrowserInfo($user_agent)
{
  include_once DOL_DOCUMENT_ROOT . '/includes/mobiledetect/mobiledetectlib/Mobile_Detect.php';
 
  $name = 'unknown';
  $version = '';
  $os = 'unknown';
  $phone = '';
 
  $user_agent = substr($user_agent, 0, 512);  // Avoid to process too large user agent
 
  // @phan-suppress-next-line PhanTypeMismatchArgumentProbablyReal Bad definition of Mobile_Detect function
  $detectmobile = new Mobile_Detect(null, $user_agent);
  $tablet = $detectmobile->isTablet();
 
  if ($detectmobile->isMobile()) {
    $phone = 'unknown';
 
    // If phone/smartphone, we set phone os name.
    if ($detectmobile->is('AndroidOS')) {
      $os = $phone = 'android';
    } elseif ($detectmobile->is('BlackBerryOS')) {
      $os = $phone = 'blackberry';
    } elseif ($detectmobile->is('iOS')) {
      $os = 'ios';
      $phone = 'iphone';
    } elseif ($detectmobile->is('PalmOS')) {
      $os = $phone = 'palm';
    } elseif ($detectmobile->is('SymbianOS')) {
      $os = 'symbian';
    } elseif ($detectmobile->is('webOS')) {
      $os = 'webos';
    } elseif ($detectmobile->is('MaemoOS')) {
      $os = 'maemo';
    } elseif ($detectmobile->is('WindowsMobileOS') || $detectmobile->is('WindowsPhoneOS')) {
      $os = 'windows';
    }
  }
 
  // OS
  if (preg_match('/linux/i', $user_agent)) {
    $os = 'linux';
  } elseif (preg_match('/macintosh/i', $user_agent)) {
    $os = 'macintosh';
  } elseif (preg_match('/windows/i', $user_agent)) {
    $os = 'windows';
  }
 
  // Name
  $reg = array();
  if (preg_match('/firefox(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
    $name = 'firefox';
    $version = empty($reg[2]) ? '' : $reg[2];
  } elseif (preg_match('/edge(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
    $name = 'edge';
    $version = empty($reg[2]) ? '' : $reg[2];
  } elseif (preg_match('/chrome(\/|\s)([\d\.]+)/i', $user_agent, $reg)) {
    $name = 'chrome';
    $version = empty($reg[2]) ? '' : $reg[2];
  } elseif (preg_match('/chrome/i', $user_agent, $reg)) {
    // we can have 'chrome (Mozilla...) chrome x.y' in one string
    $name = 'chrome';
  } elseif (preg_match('/iceweasel/i', $user_agent)) {
    $name = 'iceweasel';
  } elseif (preg_match('/epiphany/i', $user_agent)) {
    $name = 'epiphany';
  } elseif (preg_match('/safari(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
    $name = 'safari';
    $version = empty($reg[2]) ? '' : $reg[2];
  } elseif (preg_match('/opera(\/|\s)([\d\.]*)/i', $user_agent, $reg)) {
    // Safari is often present in string for mobile but its not.
    $name = 'opera';
    $version = empty($reg[2]) ? '' : $reg[2];
  } elseif (preg_match('/(MSIE\s([0-9]+\.[0-9]))|.*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
    $name = 'ie';
    $version = end($reg);
  } elseif (preg_match('/(Windows NT\s([0-9]+\.[0-9])).*(Trident\/[0-9]+.[0-9];.*rv:([0-9]+\.[0-9]+))/i', $user_agent, $reg)) {
    // MS products at end
    $name = 'ie';
    $version = end($reg);
  } elseif (preg_match('/l[iy]n(x|ks)(\‍(|\/|\s)*([\d\.]+)/i', $user_agent, $reg)) {
    // MS products at end
    $name = 'textbrowser';
    $version = empty($reg[3]) ? '' : $reg[3];
  } elseif (preg_match('/w3m\/([\d\.]+)/i', $user_agent, $reg)) {
    // MS products at end
    $name = 'textbrowser';
    $version = empty($reg[1]) ? '' : $reg[1];
  }
 
  if ($tablet) {
    $layout = 'tablet';
  } elseif ($phone) {
    $layout = 'phone';
  } else {
    $layout = 'classic';
  }
 
  return array(
    'browsername' => $name,
    'browserversion' => $version,
    'browseros' => $os,
    'browserua' => $user_agent,
    'layout' => $layout,  // tablet, phone, classic
    'phone' => $phone,    // deprecated
    'tablet' => $tablet   // deprecated
  );
}
 
function dol_shutdown()
{
  global $db;
  $disconnectdone = false;
  $depth = 0;
  if (is_object($db) && !empty($db->connected)) {
    $depth = $db->transaction_opened;
    $disconnectdone = $db->close();
  }
  dol_syslog("--- End access to " . (empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]) . (($disconnectdone && $depth) ? ' (Warn: db disconnection forced, transaction depth was ' . $depth . ')' : ''), (($disconnectdone && $depth) ? LOG_WARNING : LOG_INFO));
}
 
function GETPOSTISSET($paramname)
{
  $isset = false;
 
  $relativepathstring = $_SERVER["PHP_SELF"];
  // Clean $relativepathstring
  if (constant('DOL_URL_ROOT')) {
    $relativepathstring = preg_replace('/^' . preg_quote(constant('DOL_URL_ROOT'), '/') . '/', '', $relativepathstring);
  }
  $relativepathstring = ltrim($relativepathstring, '/');
  $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
 
  // Code for search criteria persistence.
  // Retrieve values if restore_lastsearch_values
  if (!empty($_GET['restore_lastsearch_values'])) {        // Use $_GET here and not GETPOST
    if (!empty($_SESSION['lastsearch_values_' . $relativepathstring])) {  // If there is saved values
      $tmp = json_decode($_SESSION['lastsearch_values_' . $relativepathstring], true);
      if (is_array($tmp)) {
        foreach ($tmp as $key => $val) {
          if ($key == $paramname) { // We are on the requested parameter
            $isset = true;
            break;
          }
        }
      }
    }
    // If there is saved contextpage, limit, page or mode
    if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_' . $relativepathstring])) {
      $isset = true;
    } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_' . $relativepathstring])) {
      $isset = true;
    } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_' . $relativepathstring])) {
      $isset = true;
    } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_' . $relativepathstring])) {
      $isset = true;
    }
  } else {
    $isset = (isset($_POST[$paramname]) || isset($_GET[$paramname])); // We must keep $_POST and $_GET here
  }
 
  return $isset;
}
 
function GETPOSTISARRAY($paramname, $method = 0)
{
  // for $method test need return the same $val as GETPOST
  if (empty($method)) {
    $val = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  } elseif ($method == 1) {
    $val = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  } elseif ($method == 2) {
    $val = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  } elseif ($method == 3) {
    $val = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  } else {
    $val = 'BadFirstParameterForGETPOST';
  }
 
  return is_array($val);
}
 
 
function GETPOSTINT($paramname, $method = 0, $nodefault = 0)
{
  return (int) GETPOST($paramname, 'int', $method, null, null, 0, $nodefault);
}
 
function GETPOSTFLOAT($paramname, $rounding = '', $option = 2)
{
  // price2num() can be used to round to an expected accuracy and/or to sanitize any valid user input (such as "1 234.5", "1 234,5", "1'234,5", "1·234,5", "1,234.5", etc.)
  return (float) price2num(GETPOST($paramname), $rounding, $option);
}
 
function GETPOSTDATE($prefix, $hourTime = '', $gm = 'auto', $saverestore = '')
{
  $m = array();
  if ($hourTime === 'getpost' || $hourTime === 'getpostend') {
    $hour   = (GETPOSTISSET($prefix . 'hour') && GETPOSTINT($prefix . 'hour') >= 0) ? GETPOSTINT($prefix . 'hour') : ($hourTime === 'getpostend' ? 23 : 0);
    $minute = (GETPOSTISSET($prefix . 'min') && GETPOSTINT($prefix . 'min') >= 0) ? GETPOSTINT($prefix . 'min') : ($hourTime === 'getpostend' ? 59 : 0);
    $second = (GETPOSTISSET($prefix . 'sec') && GETPOSTINT($prefix . 'sec') >= 0) ? GETPOSTINT($prefix . 'sec') : ($hourTime === 'getpostend' ? 59 : 0);
  } elseif (preg_match('/^(\d\d):(\d\d):(\d\d)$/', $hourTime, $m)) {
    $hour   = intval($m[1]);
    $minute = intval($m[2]);
    $second = intval($m[3]);
  } elseif ($hourTime === 'end') {
    $hour = 23;
    $minute = 59;
    $second = 59;
  } else {
    $hour = $minute = $second = 0;
  }
 
  if (
    $saverestore
    && !GETPOSTISSET($prefix . 'day')
    && !GETPOSTISSET($prefix . 'month')
    && !GETPOSTISSET($prefix . 'year')
    && isset($_SESSION['DOLDATE_' . $saverestore . '_day'])
    && isset($_SESSION['DOLDATE_' . $saverestore . '_month'])
    && isset($_SESSION['DOLDATE_' . $saverestore . '_year'])
  ) {
    $day = $_SESSION['DOLDATE_' . $saverestore . '_day'];
    $month = $_SESSION['DOLDATE_' . $saverestore . '_month'];
    $year = $_SESSION['DOLDATE_' . $saverestore . '_year'];
  } else {
    $month = GETPOSTINT($prefix . 'month');
    $day = GETPOSTINT($prefix . 'day');
    $year = GETPOSTINT($prefix . 'year');
  }
 
  // normalize out of range values
  $hour = (int) min($hour, 23);
  $minute = (int) min($minute, 59);
  $second = (int) min($second, 59);
 
  if ($saverestore) {
    $_SESSION['DOLDATE_' . $saverestore . '_day'] = $day;
    $_SESSION['DOLDATE_' . $saverestore . '_month'] = $month;
    $_SESSION['DOLDATE_' . $saverestore . '_year'] = $year;
  }
 
  //print "$hour, $minute, $second, $month, $day, $year, $gm<br>";
  return dol_mktime($hour, $minute, $second, $month, $day, $year, $gm);
}
 
function GETPOST($paramname, $check = 'alphanohtml', $method = 0, $filter = null, $options = null, $noreplace = 0, $nodefault = 0)
{
  global $langs, $user;
 
  if (empty($paramname)) {   // Explicit test for null for phan.
    return 'BadFirstParameterForGETPOST';
  }
  if (empty($check)) {
    dol_syslog("Deprecated use of GETPOST, called with 1st param = " . $paramname . " and a 2nd param that is '', when calling page " . $_SERVER["PHP_SELF"], LOG_WARNING);
    // Enable this line to know who call the GETPOST with '' $check parameter.
    //var_dump(getCallerInfoString());
  }
  if (in_array($paramname, array('sortfield', 'sortorder'))) {  // Force the $check to a more appropriated value
    $check = 'aZ09comma';
  }
 
  if (empty($method)) {
    $out = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
  } elseif ($method == 1) {
    $out = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
  } elseif ($method == 2) {
    $out = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
  } elseif ($method == 3) {
    $out = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
  } else {
    return 'BadThirdParameterForGETPOST';
  }
 
  $relativepathstring = ''; // For static analysis - looks possibly undefined if not set.
 
  if (empty($method) || $method == 3 || $method == 4) {
    $relativepathstring = (empty($_SERVER["PHP_SELF"]) ? '' : $_SERVER["PHP_SELF"]);
    // Clean $relativepathstring
    if (constant('DOL_URL_ROOT')) {
      $relativepathstring = preg_replace('/^' . preg_quote(constant('DOL_URL_ROOT'), '/') . '/', '', $relativepathstring);
    }
    $relativepathstring = ltrim($relativepathstring, '/');
    $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
 
    // Code for search criteria persistence.
    // Retrieve saved values if restore_lastsearch_values is set
    if (!empty($_GET['restore_lastsearch_values'])) {        // Use $_GET here and not GETPOST
      if (!empty($_SESSION['lastsearch_values_' . $relativepathstring])) {  // If there is saved values
        $tmp = json_decode($_SESSION['lastsearch_values_' . $relativepathstring], true);
        if (is_array($tmp)) {
          foreach ($tmp as $key => $val) {
            if ($key == $paramname) { // We are on the requested parameter
              $out = $val;
              break;
            }
          }
        }
      }
      // If there is saved contextpage, page or limit
      if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_' . $relativepathstring])) {
        $out = $_SESSION['lastsearch_contextpage_' . $relativepathstring];
      } elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_' . $relativepathstring])) {
        $out = $_SESSION['lastsearch_limit_' . $relativepathstring];
      } elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_' . $relativepathstring])) {
        $out = $_SESSION['lastsearch_page_' . $relativepathstring];
      } elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_' . $relativepathstring])) {
        $out = $_SESSION['lastsearch_mode_' . $relativepathstring];
      }
    } elseif (!isset($_GET['sortfield'])) {
      // Else, retrieve default values if we are not doing a sort
      // If we did a click on a field to sort, we do no apply default values. Same if option MAIN_ENABLE_DEFAULT_VALUES is not set
      if (!empty($_GET['action']) && $_GET['action'] == 'create' && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
        // Search default value from $object->field
        global $object;
        '@phan-var-force CommonObject $object'; // Suppose it's a CommonObject for analysis, but other objects have the $fields field as well
        if (is_object($object) && isset($object->fields[$paramname]['default'])) {
          // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
          $out = $object->fields[$paramname]['default'];
        }
      }
      if (getDolGlobalString('MAIN_ENABLE_DEFAULT_VALUES')) {
        if (!empty($_GET['action']) && (preg_match('/^create/', $_GET['action']) || preg_match('/^presend/', $_GET['action'])) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
          // Now search in setup to overwrite default values
          if (!empty($user->default_values)) {    // $user->default_values defined from menu 'Setup - Default values'
            if (isset($user->default_values[$relativepathstring]['createform'])) {
              foreach ($user->default_values[$relativepathstring]['createform'] as $defkey => $defval) {
                $qualified = 0;
                if ($defkey != '_noquery_') {
                  $tmpqueryarraytohave = explode('&', $defkey);
                  $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
                  $foundintru = 0;
                  foreach ($tmpqueryarraytohave as $tmpquerytohave) {
                    if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
                      $foundintru = 1;
                    }
                  }
                  if (!$foundintru) {
                    $qualified = 1;
                  }
                } else {
                  $qualified = 1;
                }
 
                if ($qualified) {
                  if (isset($user->default_values[$relativepathstring]['createform'][$defkey][$paramname])) {
                    $out = $user->default_values[$relativepathstring]['createform'][$defkey][$paramname];
                    break;
                  }
                }
              }
            }
          }
        } elseif (!empty($paramname) && !isset($_GET[$paramname]) && !isset($_POST[$paramname]) && empty($nodefault)) {
          // Management of default search_filters and sort order
          if (!empty($user->default_values)) {
            // $user->default_values defined from menu 'Setup - Default values'
            //var_dump($user->default_values[$relativepathstring]);
            if ($paramname == 'sortfield' || $paramname == 'sortorder') {
              // Sorted on which fields ? ASC or DESC ?
              if (isset($user->default_values[$relativepathstring]['sortorder'])) {
                // Even if paramname is sortfield, data are stored into ['sortorder...']
                foreach ($user->default_values[$relativepathstring]['sortorder'] as $defkey => $defval) {
                  $qualified = 0;
                  if ($defkey != '_noquery_') {
                    $tmpqueryarraytohave = explode('&', $defkey);
                    $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
                    $foundintru = 0;
                    foreach ($tmpqueryarraytohave as $tmpquerytohave) {
                      if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
                        $foundintru = 1;
                      }
                    }
                    if (!$foundintru) {
                      $qualified = 1;
                    }
                  } else {
                    $qualified = 1;
                  }
 
                  if ($qualified) {
                    $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
                    foreach ($user->default_values[$relativepathstring]['sortorder'][$defkey] as $key => $val) {
                      if ($out) {
                        $out .= ', ';
                      }
                      if ($paramname == 'sortfield') {
                        $out .= dol_string_nospecial($key, '', $forbidden_chars_to_replace);
                      }
                      if ($paramname == 'sortorder') {
                        $out .= dol_string_nospecial($val, '', $forbidden_chars_to_replace);
                      }
                    }
                    //break;  // No break for sortfield and sortorder so we can cumulate fields (is it really useful ?)
                  }
                }
              }
            } elseif (isset($user->default_values[$relativepathstring]['filters'])) {
              foreach ($user->default_values[$relativepathstring]['filters'] as $defkey => $defval) { // $defkey is a querystring like 'a=b&c=d', $defval is key of user
                if (!empty($_GET['disabledefaultvalues'])) {  // If set of default values has been disabled by a request parameter
                  continue;
                }
                $qualified = 0;
                if ($defkey != '_noquery_') {
                  $tmpqueryarraytohave = explode('&', $defkey);
                  $tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
                  $foundintru = 0;
                  foreach ($tmpqueryarraytohave as $tmpquerytohave) {
                    if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
                      $foundintru = 1;
                    }
                  }
                  if (!$foundintru) {
                    $qualified = 1;
                  }
                } else {
                  $qualified = 1;
                }
 
                if ($qualified && isset($user->default_values[$relativepathstring]['filters'][$defkey][$paramname])) {
                  // We must keep $_POST and $_GET here
                  if (isset($_POST['search_all']) || isset($_GET['search_all'])) {
                    // We made a search from quick search menu, do we still use default filter ?
                    if (!getDolGlobalString('MAIN_DISABLE_DEFAULT_FILTER_FOR_QUICK_SEARCH')) {
                      $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
                      $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
                    }
                  } else {
                    $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
                    $out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
                  }
                  break;
                }
              }
            }
          }
        }
      }
    }
  }
 
  // Replace substitution variables for GETPOST (used to get final url with variable parameters or final default value, when using variable parameters __XXX__ in the GET URL)
  // Example of variables: __DAY__, __MONTH__, __YEAR__, __MYCOMPANY_COUNTRY_ID__, __USER_ID__, ...
  // We do this only if var is a GET. If it is a POST, may be we want to post the text with vars as the setup text.
  '@phan-var-force string $paramname';
  if (!is_array($out) && empty($_POST[$paramname]) && empty($noreplace)) {
    if (preg_match('/__([A-Z0-9]+(?:_[A-Z0-9]+){0,3})__/i', $out)) {  // If there is at least one substitution key, we try to replace all known substitution keys
      $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $user, array('mycompany', 'date', 'system', 'user'));
      complete_substitutions_array($substitutionarray, $langs, $user);
 
      $out = make_substitutions($out, $substitutionarray, $langs);
    }
  }
 
  // Check type of variable and make sanitization according to this
  if (preg_match('/^array/', $check)) { // If 'array' or 'array:restricthtml' or 'array:aZ09' or 'array:int'
    $tmpcheck = 'alphanohtml';
    if ($out === null || $out === '') {
      $out = array();
    } elseif (!is_array($out)) {
      $out = explode(',', $out);
    } else {
      $tmparray = explode(':', $check);
      if (!empty($tmparray[1])) {
        $tmpcheck = $tmparray[1];
      }
    }
    foreach ($out as $outkey => $outval) {
      $out[$outkey] = sanitizeVal($outval, $tmpcheck, $filter, $options);
    }
  } else {
    // If field name is 'search_xxx' then we force the add of space after each < and > (when following char is numeric) because it means
    // we use the < or > to make a search on a numeric value to do higher or lower so we can add a space to break html tags
    if (strpos($paramname, 'search_') === 0) {
      $out = preg_replace('/([<>])([-+]?\d)/', '\1 \2', $out);
    }
 
    // @phan-suppress-next-line UnknownSanitizeType
    $out = sanitizeVal($out, $check, $filter, $options);
  }
 
  // Sanitizing for special parameters.
  // Note: There is no reason to allow the backtopage/backtopageforcancel/backtopagejs, backtolist or backtourl parameter to contains an external URL. Only relative URLs are allowed.
  // @TODO Merge backtopage with backtourl
  // @TODO Rename backtolist into backtopagelist
  // @TODO Merge urlfrom into backtourl
  if (preg_match('/^backto/i', $paramname) || preg_match('/^urlfrom/i', $paramname)) {
    $out = str_replace('\\', '/', $out);                // Can be before the loop because only 1 char is replaced. No risk to get it after other replacements.
    $out = str_replace(array(':', ';', '@', "\t", ' '), '', $out);    // Can be before the loop because only 1 char is replaced. No risk to retrieve it after other replacements.
    do {
      $oldstringtoclean = $out;
      $out = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $out);
      $out = preg_replace(array('/^[^\?]*%/'), '', $out);       // We remove any % chars before the ?. Example in url: '/product/stock/card.php?action=create&backtopage=%2Fdolibarr_dev%2Fhtdocs%2Fpro%25duct%2Fcard.php%3Fid%3Dabc'
      $out = preg_replace(array('/^[a-z]*\/\s*\/+/i'), '', $out);   // We remove schema*// to remove external URL
    } while ($oldstringtoclean != $out);
  }
 
  // Code for search criteria persistence.
  // Save data into session if key start with 'search_'
  if (empty($method) || $method == 3 || $method == 4) {
    if (preg_match('/^search_/', $paramname) || in_array($paramname, array('sortorder', 'sortfield'))) {
      //var_dump($paramname.' - '.$out.' '.$user->default_values[$relativepathstring]['filters'][$paramname]);
 
      // We save search key only if $out not empty that means:
      // - posted value not empty, or
      // - if posted value is empty and a default value exists that is not empty (it means we did a filter to an empty value when default was not).
 
      if ($out != '' && isset($user)) { // $out = '0' or 'abc', it is a search criteria to keep
        $user->lastsearch_values_tmp[$relativepathstring][$paramname] = $out;
      }
    }
  }
 
  if ($paramname == 'hashp' && $out == 'shared') {
    $out = ''; // We refuse to have hashp=shared as a parameter
  }
 
  return $out;
}
 
function sanitizeVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
{
  // TODO : use class "Validate" to perform tests (and add missing tests) if needed for factorize
  // Check is done after replacement
  if ($out === null) {
    $out = '';
  }
  switch ($check) {
    case 'none':
    case 'password':
      break;
    case 'int':    // Check param is a numeric value (integer but also float or hexadecimal)
      if (!is_numeric($out)) {
        $out = '';
      }
      break;
    case 'intcomma':
      if (is_array($out)) {
        $out = implode(',', $out);
      }
      if (preg_match('/[^0-9,-]+/i', $out)) {
        $out = '';
      }
      break;
    case 'san_alpha':
      dol_syslog("Use of parameter value 'san_alpha' in GETPOST is deprecated. Use 'alphanohtml', 'aZ09comma', ...", LOG_WARNING);
      $out = filter_var($out, FILTER_SANITIZE_STRING);
      break;
    case 'email':
      $out = filter_var($out, FILTER_SANITIZE_EMAIL);
      break;
    case 'url':
      //$out = filter_var($out, FILTER_SANITIZE_URL); // Not reliable, replaced with FILTER_VALIDATE_URL
      $out = preg_replace('/[^:\/\[\]a-z0-9@\$\'\*\~\.\-_,;\?\!=%&+#]+/i', '', $out);
      // TODO Allow ( ) but only into password of https://login:password@domain...
      break;
    case 'aZ':
      if (!is_array($out)) {
        $out = trim($out);
        if (preg_match('/[^a-z]+/i', $out)) {
          $out = '';
        }
      }
      break;
    case 'aZ09':
      if (!is_array($out)) {
        $out = trim($out);
        if (preg_match('/[^a-z0-9_\-\.]+/i', $out)) {
          $out = '';
        }
      }
      break;
    case 'aZ09arobase':   // great to sanitize $objecttype parameter
      if (!is_array($out)) {
        $out = trim($out);
        if (preg_match('/[^a-z0-9_\-\.@]+/i', $out)) {
          $out = '';
        }
      }
      break;
    case 'aZ09comma':   // great to sanitize $sortfield or $sortorder params that can be 't.abc,t.def_gh'
      if (!is_array($out)) {
        $out = trim($out);
        if (preg_match('/[^a-z0-9_\-\.,]+/i', $out)) {
          $out = '';
        }
      }
      break;
    case 'alpha':   // No html and no ../ and "
    case 'alphanohtml': // Recommended for most scalar parameters and search parameters. Not valid for json string.
      if (!is_array($out)) {
        $out = trim($out);
        do {
          $oldstringtoclean = $out;
          // Remove html tags
          $out = dol_string_nohtmltag($out, 0);
          // Refuse octal syntax \999, hexa syntax \x999 and unicode syntax \u{999} by replacing the \ into / (so if it is a \ for a windows path, it is still ok).
          $out = preg_replace('/\\\‍([0-9xu])/', '/\1', $out);
          // Remove also other dangerous string sequences
          // '../' or '..\' is dangerous because it allows dir transversals
          // '&#38', '&#0000038', '&#x26'... is a the char '&' alone but there is no reason to accept such way to encode input char
          // '"' = '&#34' = '&#0000034' = '&#x22' is dangerous because param in url can close the href= or src= and add javascript functions.
          // '&#47', '&#0000047', '&#x2F' is the char '/' but there is no reason to accept such way to encode this input char
          // '&#92' = '&#0000092' = '&#x5C' is the char '\' but there is no reason to accept such way to encode this input char
          $out = str_ireplace(array('../', '..\\', '&#38', '&#0000038', '&#x26', '&quot', '"', '&#34', '&#0000034', '&#x22', '&#47', '&#0000047', '&#x2F', '&#92', '&#0000092', '&#x5C'), '', $out);
        } while ($oldstringtoclean != $out);
        // keep lines feed
      }
      break;
    case 'alphawithlgt':  // No " and no ../ but we keep balanced < > tags with no special chars inside. Can be used for email string like "Name <email@domain.com>". Less secured than 'alphanohtml'
      if (!is_array($out)) {
        $out = trim($out);
        do {
          $oldstringtoclean = $out;
          // Decode html entities
          $out = dol_html_entity_decode($out, ENT_COMPAT | ENT_HTML5, 'UTF-8');
          // Refuse octal syntax \999, hexa syntax \x999 and unicode syntax \u{999} by replacing the \ into / (so if it is a \ for a windows path, it is still ok).
          $out = preg_replace('/\\\‍([0-9xu])/', '/\1', $out);
          // Remove also other dangerous string sequences
          // '../' or '..\' is dangerous because it allows dir transversals
          // '&#38', '&#0000038', '&#x26'... is a the char '&' alone but there is no reason to accept such way to encode input char
          // '"' = '&#34' = '&#0000034' = '&#x22' is dangerous because param in url can close the href= or src= and add javascript functions.
          // '&#47', '&#0000047', '&#x2F' is the char '/' but there is no reason to accept such way to encode this input char
          // '&#92' = '&#0000092' = '&#x5C' is the char '\' but there is no reason to accept such way to encode this input char
          $out = str_ireplace(array('../', '..\\', '&#38', '&#0000038', '&#x26', '&quot', '"', '&#34', '&#0000034', '&#x22', '&#47', '&#0000047', '&#x2F', '&#92', '&#0000092', '&#x5C'), '', $out);
        } while ($oldstringtoclean != $out);
      }
      break;
    case 'nohtml':    // No html. Valid for JSON strings.
      $out = dol_string_nohtmltag($out, 0);
      break;
    case 'restricthtmlnolink':
    case 'restricthtml':    // Recommended for most html textarea
    case 'restricthtmlallowclass':
    case 'restricthtmlallowiframe':
    case 'restricthtmlallowlinkscript': // Allow link and script tag for head section.
    case 'restricthtmlallowunvalid':
      $out = dol_htmlwithnojs($out, 1, $check);
      break;
    case 'custom':
      if (!empty($out)) {
        if (empty($filter)) {
          return 'BadParameterForGETPOST - Param 3 of sanitizeVal()';
        }
        if (is_null($options)) {
          $options = 0;
        }
        $out = filter_var($out, $filter, $options);
      }
      break;
    default:
      dol_syslog("Error, you call sanitizeVal() with a bad value for the check type. Data will be sanitized with alphanohtml.", LOG_ERR);
      $out = GETPOST($out, 'alphanohtml');
      break;
  }
 
  return $out;
}
 
function dolSetCookie(string $cookiename, string $cookievalue, int $expire = -1)
{
  include_once DOL_DOCUMENT_ROOT.'/blockedlog/lib/securitycore.lib.php';
 
  global $dolibarr_main_force_https;
 
  if ($expire == -1) {
    $expire = (time() + (86400 * 354)); // keep cookie 1 year.
  }
 
  if (PHP_VERSION_ID < 70300) {
    setcookie($cookiename, empty($cookievalue) ? '' : $cookievalue, empty($cookievalue) ? 0 : $expire, '/', '', !(empty($dolibarr_main_force_https) && isHTTPS() === false), true); // add tag httponly
  } else {
    // Only available for php >= 7.3
    $cookieparams = array(
      'expires' => empty($cookievalue) ? 0 : $expire,
      'path' => '/',
      //'domain' => '.mywebsite.com', // the dot at the beginning allows compatibility with subdomains
      'secure' => !(empty($dolibarr_main_force_https) && isHTTPS() === false),
      'httponly' => true,
      'samesite' => 'Lax' // None || Lax  || Strict
    );
    setcookie($cookiename, empty($cookievalue) ? '' : $cookievalue, $cookieparams);
  }
  if (empty($cookievalue)) {
    unset($_COOKIE[$cookiename]);
  }
}
 
if (!function_exists('dol_getprefix')) {
  function dol_getprefix($mode = '')
  {
    // If prefix is for email (we need to have $conf already loaded for this case)
    if ($mode == 'email') {
      global $conf;
 
      if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID')) { // If MAIL_PREFIX_FOR_EMAIL_ID is set
        if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID') != 'SERVER_NAME') {
          return getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID');
        } elseif (isset($_SERVER["SERVER_NAME"])) { // If MAIL_PREFIX_FOR_EMAIL_ID is set to 'SERVER_NAME'
          return $_SERVER["SERVER_NAME"];
        }
      }
 
      // The recommended value if MAIL_PREFIX_FOR_EMAIL_ID is not defined (may be not defined for old versions)
      if (!empty($conf->file->instance_unique_id)) {
        return sha1('dolibarr' . $conf->file->instance_unique_id);
      }
 
      // For backward compatibility when instance_unique_id is not set
      return sha1(DOL_DOCUMENT_ROOT . DOL_URL_ROOT);
    }
 
    // If prefix is for session (no need to have $conf loaded)
    global $dolibarr_main_instance_unique_id, $dolibarr_main_cookie_cryptkey; // This is loaded by filefunc.inc.php
    $tmp_instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; // Unique id of instance
 
    // The recommended value (may be not defined for old versions)
    if (!empty($tmp_instance_unique_id)) {
      return sha1('dolibarr' . $tmp_instance_unique_id);
    }
 
    // For backward compatibility when instance_unique_id is not set
    if (isset($_SERVER["SERVER_NAME"]) && isset($_SERVER["DOCUMENT_ROOT"])) {
      return sha1($_SERVER["SERVER_NAME"] . $_SERVER["DOCUMENT_ROOT"] . DOL_DOCUMENT_ROOT . DOL_URL_ROOT);
    } else {
      return sha1(DOL_DOCUMENT_ROOT . DOL_URL_ROOT);
    }
  }
}
 
function dol_include_once($relpath, $classname = '')
{
  global $conf, $langs, $user, $mysoc; // Do not remove this. They must be defined for files we make "include". Other globals var must be retrieved with $GLOBALS['var']
 
  if (strpos($relpath, '..') !== false) {
    // Found a not valid path
    dol_syslog('functions::dol_include_once Tried to load a file with a path including a forbidden sequence ".." : ' . $relpath, LOG_WARNING);
    return false;
  }
  if (!preg_match('/\.php$/', $relpath)) {
    // Found a not valid path
    dol_syslog('functions::dol_include_once Tried to load a file that is not a PHP file : ' . $relpath, LOG_WARNING);
    return false;
  }
 
  $fullpath = dol_buildpath($relpath);
 
  if (!file_exists($fullpath)) {
    dol_syslog('functions::dol_include_once Tried to load unexisting file: ' . $relpath, LOG_WARNING);
    return false;
  }
  if (!empty($classname) && !class_exists($classname)) {
    return include $fullpath;
  } else {
    return include_once $fullpath;
  }
}
 
 
function dol_buildpath($path, $type = 0, $returnemptyifnotfound = 0)
{
  global $conf;
 
  $path = preg_replace('/^\//', '', $path);
 
  if (empty($type)) { // For a filesystem path
    $res = DOL_DOCUMENT_ROOT . '/' . $path; // Standard default path
    if (is_array($conf->file->dol_document_root)) {
      foreach ($conf->file->dol_document_root as $key => $dirroot) {  // ex: array("main"=>"/home/main/htdocs", "alt0"=>"/home/dirmod/htdocs", ...)
        if ($key == 'main') {
          continue;
        }
        // if (@file_exists($dirroot.'/'.$path)) {
        if (@file_exists($dirroot . '/' . $path)) { // avoid [php:warn]
          if ($key != 'main' && preg_match('/^core\//', $path)) { // When searching into an alternative custom path, we don't want path like 'core/...' because path should be 'modulename/core/...'
            continue;
          }
          $res = $dirroot . '/' . $path;
          return $res;
        }
      }
    }
    if ($returnemptyifnotfound) {
      // Not found into alternate dir
      if ($returnemptyifnotfound == 1 || !file_exists($res)) {
        return '';
      }
    }
  } else {
    // For an url path
    // We try to get local path of file on filesystem from url
    // Note that trying to know if a file on disk exist by forging path on disk from url
    // works only for some web server and some setup. This is bugged when
    // using proxy, rewriting, virtual path, etc...
    $res = '';
    if ($type == 1) {
      $res = DOL_URL_ROOT . '/' . $path; // Standard value
    }
    if ($type == 2) {
      $res = DOL_MAIN_URL_ROOT . '/' . $path; // Standard value
    }
    if ($type == 3) {
      $res = DOL_URL_ROOT . '/' . $path;
    }
 
    foreach ($conf->file->dol_document_root as $key => $dirroot) {  // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
      if ($key == 'main') {
        if ($type == 3) {
          /*global $dolibarr_main_url_root;*/
 
          // Define $urlwithroot
          $urlwithouturlroot = preg_replace('/' . preg_quote(DOL_URL_ROOT, '/') . '$/i', '', trim($conf->file->dol_main_url_root));
          $urlwithroot = $urlwithouturlroot . DOL_URL_ROOT; // This is to use external domain name found into config file
          //$urlwithroot=DOL_MAIN_URL_ROOT;         // This is to use same domain name than current
 
          $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot) . '/' . $path; // Test on start with http is for old conf syntax
        }
        continue;
      }
      $regs = array();
      preg_match('/^([^\?]+(\.css\.php|\.css|\.js\.php|\.js|\.png|\.jpg|\.php)?)/i', $path, $regs); // Take part before '?'
      if (!empty($regs[1])) {
        //print $key.'-'.$dirroot.'/'.$path.'-'.$conf->file->dol_url_root[$type].'<br>'."\n";
        //if (file_exists($dirroot.'/'.$regs[1])) {
        if (@file_exists($dirroot . '/' . $regs[1])) {  // avoid [php:warn]
          if ($type == 1) {
            $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_URL_ROOT) . $conf->file->dol_url_root[$key] . '/' . $path;
          } elseif ($type == 2) {
            $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_MAIN_URL_ROOT) . $conf->file->dol_url_root[$key] . '/' . $path;
          } elseif ($type == 3) {
            /*global $dolibarr_main_url_root;*/
 
            // Define $urlwithroot
            $urlwithouturlroot = preg_replace('/' . preg_quote(DOL_URL_ROOT, '/') . '$/i', '', trim($conf->file->dol_main_url_root));
            $urlwithroot = $urlwithouturlroot . DOL_URL_ROOT; // This is to use external domain name found into config file
            //$urlwithroot=DOL_MAIN_URL_ROOT;         // This is to use same domain name than current
 
            $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot) . $conf->file->dol_url_root[$key] . '/' . $path; // Test on start with http is for old conf syntax
          }
          break;
        }
      }
    }
  }
 
  return $res;
}
 
function dolBuildUrl($url, $params = [], $addtoken = false, $anchor = '')
{
  global $db, $hookmanager;
 
  if (!is_object($hookmanager)) {
    include_once DOL_DOCUMENT_ROOT . '/core/class/hookmanager.class.php';
    $hookmanager = new HookManager($db);
  }
  if ((!isset($params['mainmenu']) || empty($params['mainmenu'])) && GETPOSTISSET('mainmenu')) {
    $params = array_merge($params, ['mainmenu' => (GETPOST('mainmenu', 'restricthtml'))]);
  }
  if ((!isset($params['leftmenu'])/*  || empty($params['leftmenu']) */) && GETPOSTISSET('leftmenu')) { // do not fill leftmenu if we have leftmenu=
    $params = array_merge($params, ['leftmenu' => (GETPOST('leftmenu', 'restricthtml'))]);
  }
  $parameters = [
    'path' => &$url,
    'params' => &$params,
    'addtoken' => &$addtoken,
  ];
  $hookmanager->executeHooks('buildurl', $parameters);
  if ($addtoken) {
    $params = array_merge($params, ['token' => newToken()]);
  }
  if ($params) {
    $url .= '?' . http_build_query($params);
  }
  if ($anchor) {
    $url .= '#' . preg_replace('/[^a-z]/i', '', $anchor);
  }
 
  return $url;
}
 
function dol_get_object_properties($obj, $properties = [])
{
  // Get real properties using get_object_vars() if $properties is empty
  if (empty($properties)) {
    return get_object_vars($obj);
  }
 
  $existingProperties = [];
  $realProperties = get_object_vars($obj);
 
  // Get the real or magic property values
  foreach ($properties as $property) {
    if (array_key_exists($property, $realProperties)) {
      // Real property, add the value
      $existingProperties[$property] = $obj->{$property};
    } elseif (property_exists($obj, $property)) {
      // Magic property
      $existingProperties[$property] = $obj->{$property};
    }
  }
 
  return $existingProperties;
}
 
 
function dol_clone($srcobject, $native = 2)
{
  if ($native == 0) {
    // deprecated method, use the method with native = 2 instead
    dol_syslog("Warning, call to dol_clone() with the deprecated parameter native=0, use 2 instead", LOG_WARNING);
 
    $tmpsavdb = null;
    if (isset($srcobject->db) && isset($srcobject->db->db) && is_object($srcobject->db->db) && get_class($srcobject->db->db) == 'PgSql\Connection') {
      $tmpsavdb = $srcobject->db;
      unset($srcobject->db);    // Such property can not be serialized with pgsl (when object->db->db = 'PgSql\Connection')
    }
 
    $myclone = unserialize(serialize($srcobject));  // serialize then unserialize is a hack to be sure to have a new object for all fields
 
    if (!empty($tmpsavdb)) {
      $srcobject->db = $tmpsavdb;
    }
  } elseif ($native == 2) {
    // recommended method to have a full secured isolated cloned object
    $myclone = new stdClass();
    $tmparray = get_object_vars($srcobject);  // return only public properties
 
    if (is_array($tmparray)) {
      foreach ($tmparray as $propertykey => $propertyval) {
        if (is_scalar($propertyval) || is_array($propertyval)) {
          $myclone->$propertykey = $propertyval;
        }
      }
    }
  } else {
    $myclone = clone $srcobject; // PHP clone is a shallow copy only, not a real clone, so properties of references will keep the reference (referring to the same target/variable)
  }
 
  return $myclone;
}
 
 
function dol_clone_in_array($srcobject, $startlevel = 0)
{
  if (is_object($srcobject)) {
    $srcobject = get_object_vars($srcobject); // exclude private/protected properties
  }
 
  if (is_array($srcobject)) {
    $result = [];
    foreach ($srcobject as $key => $value) {
      if (in_array($key, array('db', 'fields', 'error', 'errorhidden', 'errors', 'oldcopy', 'linkedObjects', 'linked_objects'))) {
        continue;
      }
      $result[$key] = dol_clone_in_array($value, $startlevel + 1);
    }
    return $result;
  }
 
  return $srcobject;
}
 
 
function dol_size($size, $type = '')
{
  global $conf;
  if (empty($conf->dol_optimize_smallscreen)) {
    return $size;
  }
  if ($type == 'width' && $size > 250) {
    return 250;
  } else {
    return 10;
  }
}
 
 
function dol_sanitizeFileName($str, $newstr = '_', $unaccent = 1, $includequotes = 0, $allowdash = 0)
{
  $str = (string) $str;
 
  // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  // Char '>' '<' '|' '$' and ';' are special chars for shells.
  // Char '/' and '\' are file delimiters.
  // Chars '--' can be used into filename to inject special parameters like --use-compress-program to make command with file as parameter making remote execution of command
  $filesystem_forbidden_chars = array('<', '>', '/', '\\', '?', '*', '|', '"', ':', '°', '$', ';', '`');
  if ($includequotes) {
    $filesystem_forbidden_chars[] = "'";
  }
  $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  $tmp = preg_replace('/\-\-+/', '_', $tmp);
  if (empty($allowdash)) {
    $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
    $tmp = preg_replace('/\s+\-$/', '', $tmp);
  }
  $tmp = str_replace('..', '', $tmp);
  $tmp = str_replace('~', $newstr, $tmp);
  $tmp = preg_replace('/\s{2,}/', ' ', $tmp);
 
  return $tmp;
}
 
 
function dol_sanitizePathName($str, $newstr = '_', $unaccent = 0, $allowdash = 0)
{
  // List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
  // Char '>' '<' '|' '$' ';' and '`' are special chars for shells.
  // Char '?' and '*' are for wild card chars.
  // Char '"' is dangerous.
  // Char '°' is just not expected.
  // Chars '-' and '--' can be used into filename to inject special parameters like --use-compress-program to make command with file as parameter making remote execution of command
  // Chars '--' and '~' can be used for path transversal
  $filesystem_forbidden_chars = array('<', '>', '?', '*', '|', '"', '°', '$', ';', '`');
 
  $tmp = $str;
  if ($unaccent) {
    $tmp = dol_string_unaccent($tmp);
  }
  $tmp = dol_string_nospecial($tmp, $newstr, $filesystem_forbidden_chars);
  $tmp = preg_replace('/\-\-+/', $newstr, $tmp);
  if (empty($allowdash)) {
    $tmp = preg_replace('/\s+\-([^\s])/', ' '.$newstr.'$1', $tmp);
    $tmp = preg_replace('/\s+\-$/', '', $tmp);
  }
  $tmp = str_replace('..', $newstr, $tmp);
  $tmp = str_replace('~', $newstr, $tmp);
  $tmp = preg_replace('/\s{2,}/', ' ', $tmp);
 
  return $tmp;
}
 
function dol_sanitizeUrl($stringtoclean, $type = 1)
{
  // We clean string because some hacks try to obfuscate evil strings by inserting non printable chars. Example: 'java(ascci09)scr(ascii00)ipt' is processed like 'javascript' (whatever is place of evil ascii char)
  // We should use dol_string_nounprintableascii but function may not be yet loaded/available
  $stringtoclean = preg_replace('/[\x00-\x1F\x7F]/u', '', $stringtoclean); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  // We clean html comments because some hacks try to obfuscate evil strings by inserting HTML comments. Example: on<!-- -->error=alert(1)
  $stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
 
  $stringtoclean = str_replace('\\', '/', $stringtoclean);
  if ($type == 1) {
    // removing : should disable links to external url like http:aaa)
    // removing ';' should disable "named" html entities encode into an url (we should not have this into an url)
    $stringtoclean = str_replace(array(':', ';', '@'), '', $stringtoclean);
  }
 
  do {
    $oldstringtoclean = $stringtoclean;
    // removing '&colon' should disable links to external url like http:aaa)
    // removing '&#' should disable "numeric" html entities encode into an url (we should not have this into an url)
    $stringtoclean = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $stringtoclean);
  } while ($oldstringtoclean != $stringtoclean);
 
  if ($type == 1) {
    // removing '//' should disable links to external url like //aaa or http//)
    $stringtoclean = preg_replace(array('/^[a-z]*\/\/+/i'), '', $stringtoclean);
  }
 
  return $stringtoclean;
}
 
function dol_sanitizeEmail($stringtoclean)
{
  do {
    $oldstringtoclean = $stringtoclean;
    $stringtoclean = str_ireplace(array('"', ':', '[', ']', "\n", "\r", '\\', '\/'), '', $stringtoclean);
  } while ($oldstringtoclean != $stringtoclean);
 
  return $stringtoclean;
}
 
function dol_sanitizeKeyCode($str)
{
  return preg_replace('/[^\w]+/', '', $str);
}
 
 
function dol_string_unaccent($str)
{
  if (is_null($str)) {
    return '';
  }
 
  if (utf8_check($str)) {
    if (extension_loaded('intl') && getDolGlobalString('MAIN_UNACCENT_USE_TRANSLITERATOR')) {
      $transliterator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: NFC;', Transliterator::FORWARD);
      return $transliterator->transliterate($str);
    }
    // See http://www.utf8-chartable.de/
    $string = rawurlencode($str);
    $replacements = array(
      '%C3%80' => 'A', '%C3%81' => 'A', '%C3%82' => 'A', '%C3%83' => 'A', '%C3%84' => 'A', '%C3%85' => 'A',
      '%C3%87' => 'C',
      '%C3%88' => 'E', '%C3%89' => 'E', '%C3%8A' => 'E', '%C3%8B' => 'E',
      '%C3%8C' => 'I', '%C3%8D' => 'I', '%C3%8E' => 'I', '%C3%8F' => 'I',
      '%C3%91' => 'N',
      '%C3%92' => 'O', '%C3%93' => 'O', '%C3%94' => 'O', '%C3%95' => 'O', '%C3%96' => 'O', '%C5%90' => 'O',
      '%C5%A0' => 'S',
      '%C3%99' => 'U', '%C3%9A' => 'U', '%C3%9B' => 'U', '%C3%9C' => 'U', '%C5%B0' => 'U',
      '%C3%9D' => 'Y', '%C5%B8' => 'y',
      '%C3%A0' => 'a', '%C3%A1' => 'a', '%C3%A2' => 'a', '%C3%A3' => 'a', '%C3%A4' => 'a', '%C3%A5' => 'a',
      '%C3%A7' => 'c',
      '%C3%A8' => 'e', '%C3%A9' => 'e', '%C3%AA' => 'e', '%C3%AB' => 'e',
      '%C3%AC' => 'i', '%C3%AD' => 'i', '%C3%AE' => 'i', '%C3%AF' => 'i',
      '%C3%B1' => 'n',
      '%C3%B2' => 'o', '%C3%B3' => 'o', '%C3%B4' => 'o', '%C3%B5' => 'o', '%C3%B6' => 'o', '%C5%91' => 'o',
      '%C5%A1' => 's',
      '%C3%B9' => 'u', '%C3%BA' => 'u', '%C3%BB' => 'u', '%C3%BC' => 'u', '%C5%B1' => 'u',
      '%C3%BD' => 'y', '%C3%BF' => 'y',
      '%CC%80' => '',
      '%CC%81' => '',
      '%CC%82' => '',
      '%CC%83' => '',
      '%CC%84' => '',
      '%CC%85' => '',
      '%CC%86' => '',
      '%CC%87' => '',
      '%CC%88' => '',
      '%CC%89' => '',
      '%CC%8A' => '',
      '%CC%8B' => '',
      '%CC%8C' => '',
      '%CC%8D' => '',
      '%CC%8E' => '',
      '%CC%8F' => '',
      '%CC%90' => '',
      '%CC%91' => '',
      '%CC%A7' => ''
    );
    $string = strtr($string, $replacements);
    return rawurldecode($string);
  } else {
    // See http://www.ascii-code.com/
    $string = strtr(
      $str,
      "\xC0\xC1\xC2\xC3\xC4\xC5\xC7
      \xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1
      \xD2\xD3\xD4\xD5\xD8\xD9\xDA\xDB\xDD
      \xE0\xE1\xE2\xE3\xE4\xE5\xE7\xE8\xE9\xEA\xEB
      \xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF8
      \xF9\xFA\xFB\xFC\xFD\xFF",
      "AAAAAAC
      EEEEIIIIDN
      OOOOOUUUY
      aaaaaaceeee
      iiiidnooooo
      uuuuyy"
    );
    $string = strtr($string, array("\xC4" => "Ae", "\xC6" => "AE", "\xD6" => "Oe", "\xDC" => "Ue", "\xDE" => "TH", "\xDF" => "ss", "\xE4" => "ae", "\xE6" => "ae", "\xF6" => "oe", "\xFC" => "ue", "\xFE" => "th"));
    return $string;
  }
}
 
function dol_string_nospecial($str, $newstr = '_', $badcharstoreplace = '', $badcharstoremove = '', $keepspaces = 0)
{
  $forbidden_chars_to_replace = array("'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ",", ";", "=", '°', '$', ';'); // more complete than dol_sanitizeFileName
  if (empty($keepspaces)) {
    $forbidden_chars_to_replace[] = " ";
  }
  $forbidden_chars_to_remove = array();
  //$forbidden_chars_to_remove=array("(",")");
 
  if (is_array($badcharstoreplace)) {
    $forbidden_chars_to_replace = $badcharstoreplace;
  }
  if (is_array($badcharstoremove)) {
    $forbidden_chars_to_remove = $badcharstoremove;
  }
 
  // @phan-suppress-next-line PhanPluginSuspiciousParamOrderInternal
  return str_replace($forbidden_chars_to_replace, $newstr, str_replace($forbidden_chars_to_remove, "", $str));
}
 
 
function dol_string_nounprintableascii($str, $removetabcrlf = 1)
{
  if ($removetabcrlf) {
    return preg_replace('/[\x00-\x1F\x7F]/u', '', $str); // /u operator makes UTF8 valid characters being ignored so are not included into the replace
  } else {
    return preg_replace('/[\x00-\x08\x11-\x12\x14-\x1F\x7F]/u', '', $str); // /u operator should make UTF8 valid characters being ignored so are not included into the replace
  }
}
 
function dolSlugify($stringtoslugify)
{
  $slug = dol_string_unaccent($stringtoslugify);
 
  // Convert special characters to their ASCII equivalents
  if (function_exists('iconv')) {
    $slug = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $slug);
  }
 
  // Convert to lowercase
  $slug = strtolower($slug);
 
  // Replace non-alphanumeric characters with hyphens
  $slug = preg_replace('/[^a-z0-9]+/', '-', $slug);
 
  // Remove leading and trailing hyphens
  $slug = trim($slug, '-');
 
  return $slug;
}
 
function dol_escape_js($stringtoescape, $mode = 0, $noescapebackslashn = 0)
{
  if (is_null($stringtoescape)) {
    return '';
  }
 
  // escape quotes and backslashes, newlines, etc.
  $substitjs = array("&#039;" => "\\'", "\r" => '\\r');
  //$substitjs['</']='<\/'; // We removed this. Should be useless.
  if (empty($noescapebackslashn)) {
    $substitjs["\n"] = '\\n';
    $substitjs['\\'] = '\\\\';
  }
  if (empty($mode)) {
    $substitjs["'"] = "\\'";
    $substitjs['"'] = "\\'";
  } elseif ($mode == 1) {
    $substitjs["'"] = "\\'";
  } elseif ($mode == 2) {
    $substitjs['"'] = '\\"';
  } elseif ($mode == 3) {
    $substitjs["'"] = "\\'";
    $substitjs['"'] = "\\\"";
  }
  return strtr((string) $stringtoescape, $substitjs);
}
 
function dol_escape_uri($stringtoescape)
{
  return rawurlencode($stringtoescape);
}
 
function dol_escape_json($stringtoescape)
{
  return str_replace('"', '\"', $stringtoescape);
}
 
function dol_escape_php($stringtoescape, $stringforquotes = 2)
{
  if (is_null($stringtoescape)) {
    return '';
  }
 
  if ($stringforquotes == 2) {
    return str_replace('"', "'", $stringtoescape);
  } elseif ($stringforquotes == 1) {
    // We remove the \ char.
    // If we allow the \ char, we can have $stringtoescape =
    // abc\';phpcodedanger;  so the escapement will become
    // abc\\';phpcodedanger;  and injecting this into
    // $a='...' will give $ac='abc\\';phpcodedanger;
    $stringtoescape = str_replace('\\', '', $stringtoescape);
    return str_replace("'", "\'", str_replace('"', "'", $stringtoescape));
  }
 
  return 'Bad parameter for stringforquotes in dol_escape_php';
}
 
function dol_escape_all($stringtoescape)
{
  return preg_replace('/[^a-z0-9_]/i', '', $stringtoescape);
}
 
function dol_escape_xml($stringtoescape)
{
  return $stringtoescape;
}
 
 
function dol_strtolower($string, $encoding = "UTF-8")
{
  if (function_exists('mb_strtolower')) {
    return mb_strtolower($string, $encoding);
  } else {
    return strtolower($string);
  }
}
 
function dol_strtoupper($string, $encoding = "UTF-8")
{
  if (function_exists('mb_strtoupper')) {
    return mb_strtoupper($string, $encoding);
  } else {
    return strtoupper($string);
  }
}
 
function dol_ucfirst($string, $encoding = "UTF-8")
{
  if (function_exists('mb_substr')) {
    return mb_strtoupper(mb_substr($string, 0, 1, $encoding), $encoding) . mb_substr($string, 1, null, $encoding);
  } else {
    return ucfirst($string);
  }
}
 
function dol_ucwords($string, $encoding = "UTF-8")
{
  if (function_exists('mb_convert_case')) {
    return mb_convert_case($string, MB_CASE_TITLE, $encoding);
  } else {
    return ucwords($string);
  }
}
 
 
function getCallerInfoString()
{
  $backtrace = debug_backtrace();
  $msg = "";
  if (count($backtrace) >= 1) {
    $pos = 1;
    if (count($backtrace) == 1) {
      $pos = 0;
    }
    $trace = $backtrace[$pos];
    if (isset($trace['file'], $trace['line'])) {
      $msg = " From {$trace['file']}:{$trace['line']}.";
    }
  }
  return $msg;
}
 
function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename = '', $restricttologhandler = '', $logcontext = null)
{
  global $conf, $user, $debugbar;
 
  // If syslog module enabled
  if (!isModEnabled('syslog')) {
    return;
  }
 
  // Check if we are into execution of code of a website
  if (defined('USEEXTERNALSERVER') && !defined('USEDOLIBARRSERVER') && !defined('USEDOLIBARREDITOR')) {
    global $website, $websitekey;
    if (is_object($website) && !empty($website->ref)) {
      $suffixinfilename .= '_website_' . $website->ref;
    } elseif (!empty($websitekey)) {
      $suffixinfilename .= '_website_' . $websitekey;
    }
  }
 
  // Check if we have a forced suffix
  if (defined('USESUFFIXINLOG')) {
    $suffixinfilename .= constant('USESUFFIXINLOG');
  }
 
  if ($ident < 0) {
    foreach ($conf->loghandlers as $loghandlerinstance) {
      $loghandlerinstance->setIdent($ident);
    }
  }
 
  if (!empty($message)) {
    // Test log level
    // @phan-suppress-next-line PhanPluginDuplicateArrayKey
    $logLevels = array(LOG_EMERG => 'EMERG', LOG_ALERT => 'ALERT', LOG_CRIT => 'CRITICAL', LOG_ERR => 'ERR', LOG_WARNING => 'WARN', LOG_NOTICE => 'NOTICE', LOG_INFO => 'INFO', LOG_DEBUG => 'DEBUG');
 
    if (!array_key_exists($level, $logLevels)) {
      dol_syslog('Error Bad Log Level ' . $level, LOG_ERR);
      $level = LOG_ERR;
    }
    if ($level > getDolGlobalInt('SYSLOG_LEVEL')) {
      return;
    }
 
    if (!getDolGlobalString('MAIN_SHOW_PASSWORD_INTO_LOG')) {
      $message = preg_replace('/password=\'[^\']*\'/', 'password=\'hidden\'', $message); // protection to avoid to have value of password in log
    }
 
    // If adding log inside HTML page is required
    if ((!empty($_REQUEST['logtohtml']) && getDolGlobalString('MAIN_ENABLE_LOG_TO_HTML'))
      || (is_object($user) && $user->hasRight('debugbar', 'read') && is_object($debugbar))
    ) {
      $ospid = sprintf("%7s", dol_trunc((string) getmypid(), 7, 'right', 'UTF-8', 1));
      $osuser = " " . sprintf("%6s", dol_trunc(function_exists('posix_getuid') ? posix_getuid() : '', 6, 'right', 'UTF-8', 1));
 
      $conf->logbuffer[] = dol_print_date(time(), "%Y-%m-%d %H:%M:%S") . " " . sprintf("%-7s", $logLevels[$level]) . " " . $ospid . " " . $osuser . " " . $message;
    }
 
    //TODO: Remove this. MAIN_ENABLE_LOG_INLINE_HTML should be deprecated and use a log handler dedicated to HTML output
    // If html log tag enabled and url parameter log defined, we show output log on HTML comments
    if (getDolGlobalString('MAIN_ENABLE_LOG_INLINE_HTML') && GETPOSTINT("log")) {
      print "\n\n<!-- Log start\n";
      print dol_escape_htmltag($message) . "\n";
      print "Log end -->\n";
    }
 
    $data = array(
      'message' => $message,
      'script' => (isset($_SERVER['PHP_SELF']) ? basename($_SERVER['PHP_SELF'], '.php') : ''),
      'level' => $level,
      'user' => ((is_object($user) && $user->id) ? $user->login : ''),
      'ip' => '',
      'osuser' => function_exists('posix_getuid') ? (string) posix_getuid() : '',
      'ospid' => (string) getmypid()  // on linux, max value is defined into cat /proc/sys/kernel/pid_max
    );
 
    // For log, we want the reliable IP first.
    $remoteip = getUserRemoteIP(1); // Get ip when page run on a web server
    if (!empty($remoteip)) {
      $data['ip'] = $remoteip;
      // This is when server run behind a reverse proxy
      // A HTTP_X_FORWARDED_FOR as format "ip real of user, ip of proxy1, ip of proxy2, ..."
      // $data['ip'] is last
      if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
        $tmpips = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
        $data['ip'] = '';
        $foundremoteip = 0;
        $j = 0;
        foreach ($tmpips as $tmpip) {
          $tmpip = trim($tmpip);
          if (strtolower($tmpip) == strtolower($remoteip)) {
            $foundremoteip = 1;
          }
          if (empty($data['ip'])) {
            $data['ip'] = $tmpip;
          } else {
            $j++;
            $data['ip'] .= (($j == 1) ? ' [via ' : ',') . $tmpip;
          }
        }
        if (!$foundremoteip) {
          $j++;
          $data['ip'] .= (($j == 1) ? ' [via ' : ',') . $remoteip;
        }
        $data['ip'] .= (($j > 0) ? ']' : '');
      } elseif (!empty($_SERVER['HTTP_CLIENT_IP'])) {
        $tmpips = explode(',', $_SERVER['HTTP_CLIENT_IP']);
        $data['ip'] = '';
        $foundremoteip = 0;
        $j = 0;
        foreach ($tmpips as $tmpip) {
          $tmpip = trim($tmpip);
          if (strtolower($tmpip) == strtolower($remoteip)) {
            $foundremoteip = 1;
          }
          if (empty($data['ip'])) {
            $data['ip'] = $tmpip;
          } else {
            $j++;
            $data['ip'] .= (($j == 1) ? ' [via ' : ',') . $tmpip;
          }
        }
        if (!$foundremoteip) {
          $j++;
          $data['ip'] .= (($j == 1) ? ' [via ' : ',') . $remoteip;
        }
        $data['ip'] .= (($j > 0) ? ']' : '');
      }
    } elseif (!empty($_SERVER['SERVER_ADDR'])) {
      // This is when PHP session is ran inside a web server but not inside a client request (example: init code of apache)
      $data['ip'] = (string) $_SERVER['SERVER_ADDR'];
    } elseif (!empty($_SERVER['COMPUTERNAME'])) {
      // This is when PHP session is ran outside a web server, like from Windows command line (Not always defined, but useful if OS defines it).
      $data['ip'] = (string) $_SERVER['COMPUTERNAME'];
    } else {
      $data['ip'] = '???';
    }
 
    if (!empty($_SERVER['USERNAME'])) {
      // This is when PHP session is ran outside a web server, like from Linux command line (Not always defined, but useful if OS defines it).
      $data['osuser'] = (string) $_SERVER['USERNAME'];
    } elseif (!empty($_SERVER['LOGNAME'])) {
      // This is when PHP session is ran outside a web server, like from Linux command line (Not always defined, but useful if OS defines it).
      $data['osuser'] = (string) $_SERVER['LOGNAME'];
    }
 
    // Loop on each log handler and send output
    foreach ($conf->loghandlers as $loghandlerinstance) {
      if ($restricttologhandler && $loghandlerinstance->code != $restricttologhandler) {
        continue;
      }
      $loghandlerinstance->export($data, $suffixinfilename);
    }
    unset($data);
  }
 
  if ($ident > 0) {
    foreach ($conf->loghandlers as $loghandlerinstance) {
      $loghandlerinstance->setIdent($ident);
    }
  }
}
 
 
function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs = null, $mode = 0, $extralangcode = '')
{
  global $langs, $hookmanager;
 
  $ret = '';
  $countriesusingstate = array('AU', 'CA', 'US', 'IN', 'GB', 'ES', 'UK', 'TR', 'CN'); // See also MAIN_FORCE_STATE_INTO_ADDRESS
 
  // See format of addresses on https://en.wikipedia.org/wiki/Address
  // Address
  if (empty($mode)) {
    $ret .= (($extralangcode && !empty($object->array_languages['address'][$extralangcode])) ? $object->array_languages['address'][$extralangcode] : (empty($object->address) ? '' : preg_replace('/(\r\n|\r|\n)+/', $sep, $object->address)));
  }
  // Zip/Town/State
  if (isset($object->country_code) && in_array($object->country_code, array('AU', 'CA', 'US', 'CN')) || getDolGlobalString('MAIN_FORCE_STATE_INTO_ADDRESS')) {
    // US: title firstname name \n address lines \n town, state, zip \n country
    $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= (($ret && $town) ? $sep : '') . $town;
 
    if (!empty($object->state)) {
      $ret .= ($ret ? ($town ? ", " : $sep) : '') . $object->state;
    }
    if (!empty($object->zip)) {
      $ret .= ($ret ? (($town || $object->state) ? ", " : $sep) : '') . $object->zip;
    }
  } elseif (isset($object->country_code) && in_array($object->country_code, array('GB', 'UK'))) {
    // UK: title firstname name \n address lines \n town state \n zip \n country
    $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= ($ret ? $sep : '') . $town;
    if (!empty($object->state)) {
      $ret .= ($ret ? ", " : '') . $object->state;
    }
    if (!empty($object->zip)) {
      $ret .= ($ret ? $sep : '') . $object->zip;
    }
  } elseif (isset($object->country_code) && in_array($object->country_code, array('ES', 'TR'))) {
    // ES: title firstname name \n address lines \n zip town \n state \n country
    $ret .= ($ret ? $sep : '') . $object->zip;
    $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= ($town ? (($object->zip ? ' ' : '') . $town) : '');
    if (!empty($object->state)) {
      $ret .= $sep . $object->state;
    }
  } elseif (isset($object->country_code) && in_array($object->country_code, array('JP'))) {
    // JP: In romaji, title firstname name\n address lines \n [state,] town zip \n country
    // See https://www.sljfaq.org/afaq/addresses.html
    $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= ($ret ? $sep : '') . ($object->state ? $object->state . ', ' : '') . $town . ($object->zip ? ' ' : '') . $object->zip;
  } elseif (isset($object->country_code) && in_array($object->country_code, array('IT'))) {
    // IT: title firstname name\n address lines \n zip town state_code \n country
    $ret .= ($ret ? $sep : '') . $object->zip;
    $town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= ($town ? (($object->zip ? ' ' : '') . $town) : '');
    $ret .= (empty($object->state_code) ? '' : (' ' . $object->state_code));
  } else {
    // Other: title firstname name \n address lines \n zip town[, state] \n country
    $town = (($extralangcode && !empty($object->array_languages['address'][$extralangcode])) ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
    $ret .= !empty($object->zip) ? (($ret ? $sep : '') . $object->zip) : '';
    $ret .= ($town ? (($object->zip ? ' ' : ($ret ? $sep : '')) . $town) : '');
    if (!empty($object->state) && in_array($object->country_code, $countriesusingstate)) {
      $ret .= ($ret ? ", " : '') . $object->state;
    }
  }
 
  if (!is_object($outputlangs)) {
    $outputlangs = $langs;
  }
  if ($withcountry) {
    $langs->load("dict");
    $ret .= (empty($object->country_code) ? '' : ($ret ? $sep : '') . $outputlangs->convToOutputCharset($outputlangs->transnoentitiesnoconv("Country" . $object->country_code)));
  }
  if ($hookmanager) {
    $parameters = array('withcountry' => $withcountry, 'sep' => $sep, 'outputlangs' => $outputlangs, 'mode' => $mode, 'extralangcode' => $extralangcode);
    $reshook = $hookmanager->executeHooks('formatAddress', $parameters, $object);
    if ($reshook > 0) {
      $ret = '';
    }
    $ret .= $hookmanager->resPrint;
  }
 
  return $ret;
}
 
 
 
function dol_strftime($fmt, $ts = false, $is_gmt = false)
{
  if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
    return dol_print_date($ts, $fmt, $is_gmt);
  } else {
    return 'Error date outside supported range';
  }
}
 
function dol_print_date($time, $format = '', $tzoutput = 'auto', $outputlangs = null, $encodetooutput = false, $decorate = 0)
{
  global $conf, $langs;
 
  // If date undefined or "", we return ""
  if (dol_strlen((string) $time) == 0) {
    return ''; // $time=0 allowed (it means 01/01/1970 00:00:00)
  }
 
  if ($tzoutput === 'auto') {
    $tzoutput = (empty($conf) ? 'tzserver' : (isset($conf->tzuserinputkey) ? $conf->tzuserinputkey : 'tzserver'));
  }
 
  // Clean parameters
  $to_gmt = false;  // false if we want date in server timezone, true if we want to add offset
  $offsettz = $offsetdst = 0;
  if ($tzoutput) {
    $to_gmt = true; // For backward compatibility
    if (is_string($tzoutput)) {
      if ($tzoutput == 'tzserver') {
        $to_gmt = false;
        $offsettzstring = @date_default_timezone_get(); // Example 'Europe/Berlin' or 'Indian/Reunion'
        // @phan-suppress-next-line PhanPluginRedundantAssignment
        $offsettz = 0;  // Timezone offset with server timezone (because to_gmt is false), so 0
        // @phan-suppress-next-line PhanPluginRedundantAssignment
        $offsetdst = 0; // Dst offset with server timezone (because to_gmt is false), so 0
      } elseif ($tzoutput == 'tzuser' || $tzoutput == 'tzuserrel') {
        $to_gmt = true;
        // if no session (by example in cron) may use MAIN_DOLIBARR_USER_TIMEZONE instead UTC
        $offsettzstring = (empty($_SESSION['dol_tz_string']) ? getDolGlobalString('MAIN_DOLIBARR_USER_TIMEZONE', 'UTC') : $_SESSION['dol_tz_string']); // Example 'Europe/Berlin' or 'Indian/Reunion'
 
        if (class_exists('DateTimeZone')) {
          try {
            $user_date_tz = new DateTimeZone($offsettzstring);
          } catch (Exception $e) {
            // Bad value for $offsettzstring
            dol_syslog("DateInvalidTimeZoneException for timezone string '".$offsettzstring."'. Falling back to UTC.", LOG_ERR);
            $user_date_tz = new DateTimeZone('UTC'); // Force valid timezone as UTC
          }
          $user_dt = new DateTime();
          $user_dt->setTimezone($user_date_tz);
          $user_dt->setTimestamp($tzoutput == 'tzuser' ? dol_now() : (int) $time);
          $offsettz = $user_dt->getOffset();  // should include dst ?
        } else {  // with old method (The 'tzuser' was processed like the 'tzuserrel')
          $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60; // Will not be used anymore
          $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60; // Will not be used anymore
        }
      }
    }
  }
  if (!is_object($outputlangs)) {
    $outputlangs = $langs;
  }
  if (!$format) {
    $format = 'daytextshort';
  }
 
  // Do we have to reduce the length of date (year on 2 chars) to save space.
  // Note: dayinputnoreduce is same than day but no reduction of year length will be done
  $reduceformat = (!empty($conf->dol_optimize_smallscreen) && in_array($format, array('day', 'dayhour', 'dayhoursec'))) ? 1 : 0;  // Test on original $format param.
  $format = preg_replace('/inputnoreduce/', '', $format); // so format 'dayinputnoreduce' is processed like day
  $formatwithoutreduce = preg_replace('/reduceformat/', '', $format);
  if ($formatwithoutreduce != $format) {
    $format = $formatwithoutreduce;
    $reduceformat = 1;
  }  // so format 'dayreduceformat' is processed like day
 
  // Change predefined format into computer format. If found translation in lang file we use it, otherwise we use default.
  // TODO Add format daysmallyear and dayhoursmallyear
  if ($format == 'day') {
    $format = ($outputlangs->trans("FormatDateShort") != "FormatDateShort" ? $outputlangs->trans("FormatDateShort") : $conf->format_date_short);
  } elseif ($format == 'hour') {
    $format = ($outputlangs->trans("FormatHourShort") != "FormatHourShort" ? $outputlangs->trans("FormatHourShort") : $conf->format_hour_short);
  } elseif ($format == 'hoursec') {
    $s1 = $outputlangs->trans("FormatDateShort");
    $s2 = $outputlangs->trans("FormatDateHourSecShort");
    $s3 = trim(preg_replace('/'.preg_quote($s1, '/').'/', '', $s2));  // Try to guess the format for FormatHourSecShort using FormatDateShort and FormatDateHourSecShort
    $format = $s3;
    //$format = ($outputlangs->trans("FormatHourSecShort") != "FormatHourSecShort" ? $outputlangs->trans("FormatHourSecShort") : ($s3 ? $s3 : $conf->format_hour_sec_short));
  } elseif ($format == 'hourduration') {
    $format = ($outputlangs->trans("FormatHourShortDuration") != "FormatHourShortDuration" ? $outputlangs->trans("FormatHourShortDuration") : $conf->format_hour_short_duration);
  } elseif ($format == 'daytext') {
    $format = ($outputlangs->trans("FormatDateText") != "FormatDateText" ? $outputlangs->trans("FormatDateText") : $conf->format_date_text);
  } elseif ($format == 'daytextshort') {
    $format = ($outputlangs->trans("FormatDateTextShort") != "FormatDateTextShort" ? $outputlangs->trans("FormatDateTextShort") : $conf->format_date_text_short);
  } elseif ($format == 'dayhour') {
    $format = ($outputlangs->trans("FormatDateHourShort") != "FormatDateHourShort" ? $outputlangs->trans("FormatDateHourShort") : $conf->format_date_hour_short);
  } elseif ($format == 'dayhoursec') {
    $format = ($outputlangs->trans("FormatDateHourSecShort") != "FormatDateHourSecShort" ? $outputlangs->trans("FormatDateHourSecShort") : $conf->format_date_hour_sec_short);
  } elseif ($format == 'dayhourtext') {
    $format = ($outputlangs->trans("FormatDateHourText") != "FormatDateHourText" ? $outputlangs->trans("FormatDateHourText") : $conf->format_date_hour_text);
  } elseif ($format == 'dayhourtextshort') {
    $format = ($outputlangs->trans("FormatDateHourTextShort") != "FormatDateHourTextShort" ? $outputlangs->trans("FormatDateHourTextShort") : $conf->format_date_hour_text_short);
  } elseif ($format == 'dayhourlog') {
    // Format not sensitive to language
    $format = '%Y%m%d%H%M%S';
  } elseif ($format == 'dayhourlogsmall') {
    // Format not sensitive to language
    $format = '%y%m%d%H%M';
  } elseif ($format == 'dayhourldap') {
    $format = '%Y%m%d%H%M%SZ';
  } elseif ($format == 'dayhourxcard') {
    $format = '%Y%m%dT%H%M%SZ';
  } elseif ($format == 'dayxcard') {
    $format = '%Y%m%d';
  } elseif ($format == 'dayrfc') {
    $format = '%Y-%m-%d'; // DATE_RFC3339
  } elseif ($format == 'dayhourrfc') {
    $format = '%Y-%m-%dT%H:%M:%SZ'; // DATETIME RFC3339
  } elseif ($format == 'standard') {
    $format = '%Y-%m-%d %H:%M:%S';
  }
 
  if ($reduceformat) {
    $format = str_replace('%Y', '%y', $format);
    $format = str_replace('yyyy', 'yy', $format);
  }
 
  // Clean format
  if (preg_match('/%b/i', $format)) {   // There is some text to translate
    // We inhibit translation to text made by strftime functions. We will use trans instead later.
    $format = str_replace('%b', '__b__', $format);
    $format = str_replace('%B', '__B__', $format);
  }
  if (preg_match('/%a/i', $format)) {   // There is some text to translate
    // We inhibit translation to text made by strftime functions. We will use trans instead later.
    $format = str_replace('%a', '__a__', $format);
    $format = str_replace('%A', '__A__', $format);
  }
 
  // Analyze date
  $reg = array();
  if (preg_match('/^([0-9][0-9][0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])$/i', (string) $time, $reg)) {  // Deprecated. Ex: 1970-01-01, 1970-01-01 01:00:00, 19700101010000
    dol_print_error(null, "Functions.lib::dol_print_date function called with a bad value" . getCallerInfoString());
    return '';
  } elseif (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i', (string) $time, $reg)) {    // Still available to solve problems in extrafields of type date
    // This part of code should not be used anymore.
    dol_syslog("Functions.lib::dol_print_date function called with a bad value" . getCallerInfoString(), LOG_WARNING);
    // Date has format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'
    $syear  = (!empty($reg[1]) ? $reg[1] : '');
    $smonth = (!empty($reg[2]) ? $reg[2] : '');
    $sday = (!empty($reg[3]) ? $reg[3] : '');
    $shour  = (!empty($reg[4]) ? $reg[4] : '');
    $smin = (!empty($reg[5]) ? $reg[5] : '');
    $ssec = (!empty($reg[6]) ? $reg[6] : '');
 
    $time = dol_mktime((int) $shour, (int) $smin, (int) $ssec, (int) $smonth, (int) $sday, (int) $syear, true);
 
    if ($to_gmt) {
      $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
    } else {
      $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
    }
    $dtts = new DateTime();
    $dtts->setTimestamp($time);
    $dtts->setTimezone($tzo);
    $newformat = str_replace(
      array('%Y', '%y', '%m', '%d', '%H', '%I', '%M', '%S', '%p', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
      array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
      $format
    );
    $ret = $dtts->format($newformat);
    $ret = str_replace(
      array('__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
      array('T', 'Z', '__a__', '__A__', '__b__', '__B__'),
      $ret
    );
  } else {
    // Date is a timestamps
    if ($time < 100000000000) { // Protection against bad date values
      $dtts = new DateTime();
      //var_dump($tzoutput.' '.$offsettzstring.' '.$offsettz.$offsetdst.' x '.$to_gmt);
      if ($to_gmt) {  // to_gmt means "not in php server timezone" (if tzoutput = 'gmt', offsets should be 0 but if = 'tzuser...', offsets may be defined
        $timetouse = (int) $time + $offsettz + $offsetdst; // TODO We could be able to disable use of offsettz and offsetdst to use only offsettzstring.
 
        $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
        $dtts->setTimezone($tzo); // important: must be before the setTimestamp
        $dtts->setTimestamp($timetouse);
      } else {
        $timetouse = (int) $time + $offsettz + $offsetdst; // TODO We could be able to disable use of offsettz and offsetdst to use only offsettzstring.
 
        $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
        $dtts->setTimestamp($timetouse);  // TODO May be we can invert setTimestamp and setTimezone
        $dtts->setTimezone($tzo);
      }
 
      $newformat = str_replace(
        array('%Y', '%y', '%m', '%d', '%H', '%I', '%M', '%S', '%p', '%w', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
        array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', 'w', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
        $format
      );
 
      $ret = $dtts->format($newformat);
      //var_dump($timetouse, $offsettz, $offsetdst, $tzo, $newformat, $ret);
      $ret = str_replace(
        array('__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
        array('T', 'Z', '__a__', '__A__', '__b__', '__B__'),
        $ret
      );
    } else {
      $ret = 'Bad value ' . $time . ' for date';
    }
  }
 
  if (preg_match('/__b__/i', $format)) {
    $timetouse = $time + $offsettz + $offsetdst; // TODO We could be able to disable use of offsettz and offsetdst to use only offsettzstring.
 
    if ($to_gmt) {
      $tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
    } else {
      $tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
    }
    $dtts = new DateTime();
    $dtts->setTimestamp($timetouse);
    $dtts->setTimezone($tzo);
    $month = (int) $dtts->format("m");
    $month = sprintf("%02d", $month); // $month may be return with format '06' on some installation and '6' on other, so we force it to '06'.
    if ($encodetooutput) {
      $monthtext = $outputlangs->transnoentities('Month' . $month);
      $monthtextshort = $outputlangs->transnoentities('MonthShort' . $month);
    } else {
      $monthtext = $outputlangs->transnoentitiesnoconv('Month' . $month);
      $monthtextshort = $outputlangs->transnoentitiesnoconv('MonthShort' . $month);
    }
    //print 'monthtext='.$monthtext.' monthtextshort='.$monthtextshort;
    $ret = str_replace('__b__', $monthtextshort, $ret);
    $ret = str_replace('__B__', $monthtext, $ret);
    //print 'x'.$outputlangs->charset_output.'-'.$ret.'x';
    //return $ret;
  }
  if (preg_match('/__a__/i', $format)) {
    //print "time=$time offsettz=$offsettz offsetdst=$offsetdst offsettzstring=$offsettzstring";
    $timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
 
    if ($to_gmt) {
      $tzo = new DateTimeZone('UTC');
    } else {
      $tzo = new DateTimeZone(date_default_timezone_get());
    }
    $dtts = new DateTime();
    $dtts->setTimestamp($timetouse);
    $dtts->setTimezone($tzo);
    $w = $dtts->format("w");
    $dayweek = $outputlangs->transnoentitiesnoconv('Day' . $w);
 
    $ret = str_replace('__A__', $dayweek, $ret);
    $ret = str_replace('__a__', dol_substr($dayweek, 0, 3), $ret);
  }
 
  if ($decorate) {
    $ret = preg_replace('/(\d\d:\d\d [AP]M)$/', '<span class="'.($decorate === 1 ? 'opacitymedium' : $decorate).'">\1</span>', $ret);
    $ret = preg_replace('/(\d\d:\d\d)$/', '<span class="'.($decorate === 1 ? 'opacitymedium' : $decorate).'">\1</span>', $ret);
  }
 
  return $ret;
}
 
 
function dol_getdate($timestamp, $fast = false, $forcetimezone = '')
{
  if ($timestamp === '') {
    return array();
  }
 
  $datetimeobj = new DateTime();
  $datetimeobj->setTimestamp($timestamp); // Use local PHP server timezone
  if ($forcetimezone) {
    $datetimeobj->setTimezone(new DateTimeZone($forcetimezone == 'gmt' ? 'UTC' : $forcetimezone)); //  (add timezone relative to the date entered)
  }
  $arrayinfo = array(
    'year' => ((int) date_format($datetimeobj, 'Y')),
    'mon' => ((int) date_format($datetimeobj, 'm')),
    'mday' => ((int) date_format($datetimeobj, 'd')),
    'wday' => ((int) date_format($datetimeobj, 'w')),
    'yday' => ((int) date_format($datetimeobj, 'z')),
    'hours' => ((int) date_format($datetimeobj, 'H')),
    'minutes' => ((int) date_format($datetimeobj, 'i')),
    'seconds' => ((int) date_format($datetimeobj, 's')),
    '0' => $timestamp
  );
 
  return $arrayinfo;
}
 
function dol_mktime($hour, $minute, $second, $month, $day, $year, $gm = 'auto', $check = 1)
{
  global $conf;
  //print "- ".$hour.",".$minute.",".$second.",".$month.",".$day.",".$year.",".$_SERVER["WINDIR"]." -";
 
  if ($gm === 'auto') {
    $gm = (empty($conf) ? 'tzserver' : $conf->tzuserinputkey);
  }
  //print 'gm:'.$gm.' gm === auto:'.($gm === 'auto').'<br>';exit;
 
  // Clean parameters
  if ($hour == -1 || empty($hour)) {
    $hour = 0;
  }
  if ($minute == -1 || empty($minute)) {
    $minute = 0;
  }
  if ($second == -1 || empty($second)) {
    $second = 0;
  }
 
  // Check parameters
  if ($check) {
    if (!$month || !$day) {
      return '';
    }
    if ($day > 31) {
      return '';
    }
    if ($month > 12) {
      return '';
    }
    if ($hour < 0 || $hour > 24) {
      return '';
    }
    if ($minute < 0 || $minute > 60) {
      return '';
    }
    if ($second < 0 || $second > 60) {
      return '';
    }
  }
 
  if (empty($gm) || ($gm === 'server' || $gm === 'tzserver')) {
    $default_timezone = @date_default_timezone_get(); // Example 'Europe/Berlin'
    $localtz = new DateTimeZone($default_timezone);
  } elseif ($gm === 'user' || $gm === 'tzuser' || $gm === 'tzuserrel') {
    // We use dol_tz_string first because it is more reliable.
    $default_timezone = (empty($_SESSION["dol_tz_string"]) ? @date_default_timezone_get() : $_SESSION["dol_tz_string"]); // Example 'Europe/Berlin'
    try {
      $localtz = new DateTimeZone($default_timezone);
    } catch (Exception $e) {
      dol_syslog("Warning dol_tz_string contains an invalid value " . json_encode($_SESSION["dol_tz_string"] ?? null), LOG_WARNING);
      $default_timezone = @date_default_timezone_get();
    }
  } elseif (strrpos($gm, "tz,") !== false) {
    $timezone = (string) str_replace("tz,", "", $gm); // Example 'tz,Europe/Berlin'
    try {
      $localtz = new DateTimeZone($timezone);
    } catch (Exception $e) {
      dol_syslog("Warning passed timezone contains an invalid value " . $timezone, LOG_WARNING);
    }
  }
 
  if (empty($localtz)) {
    $localtz = new DateTimeZone('UTC');
  }
  $dt = new DateTime('now', $localtz);
  $dt->setDate((int) $year, (int) $month, (int) $day);
  $dt->setTime((int) $hour, (int) $minute, (int) $second);
  $date = $dt->getTimestamp(); // should include daylight saving time
 
  return $date;
}
 
 
function dol_now($mode = 'gmt')
{
  $ret = 0;
 
  if ($mode === 'auto') {
    $mode = 'gmt';
  }
 
  if ($mode == 'gmt') {
    $ret = time(); // Time for now at greenwich.
  } elseif ($mode == 'tzserver') {    // Time for now with PHP server timezone added
    require_once DOL_DOCUMENT_ROOT . '/core/lib/date.lib.php';
    $tzsecond = getServerTimeZoneInt('now'); // Contains tz+dayling saving time
    $ret = (int) (dol_now('gmt') + ($tzsecond * 3600));
    // } elseif ($mode == 'tzref') {// Time for now with parent company timezone is added
    //  require_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
    //  $tzsecond=getParentCompanyTimeZoneInt();    // Contains tz+dayling saving time
    //  $ret=dol_now('gmt')+($tzsecond*3600);
  } elseif ($mode == 'tzuser' || $mode == 'tzuserrel') {
    // Time for now with user timezone added
    // print 'time: '.time();
    $offsettz = (empty($_SESSION['dol_tz']) ? 0 : $_SESSION['dol_tz']) * 60 * 60;
    $offsetdst = (empty($_SESSION['dol_dst']) ? 0 : $_SESSION['dol_dst']) * 60 * 60;
    $ret = (int) (dol_now('gmt') + ($offsettz + $offsetdst));
  }
 
  return $ret;
}
 
 
function dol_print_size($size, $shortvalue = 0, $shortunit = 0)
{
  global $conf, $langs;
  $level = 1024;
 
  if (!empty($conf->dol_optimize_smallscreen)) {
    $shortunit = 1;
  }
 
  // Set value text
  if (empty($shortvalue) || $size < ($level * 10)) {
    $ret = $size;
    $textunitshort = $langs->trans("b");
    $textunitlong = $langs->trans("Bytes");
  } else {
    $ret = round($size / $level, 0);
    $textunitshort = $langs->trans("Kb");
    $textunitlong = $langs->trans("KiloBytes");
  }
  // Use long or short text unit
  if (empty($shortunit)) {
    $ret .= ' ' . $textunitlong;
  } else {
    $ret .= ' ' . $textunitshort;
  }
 
  return $ret;
}
 
function dol_print_url($url, $target = '_blank', $max = 32, $withpicto = 0, $morecss = '')
{
  global $langs;
 
  if (empty($url)) {
    return '';
  }
 
  $linkstart = '<a href="';
  if (!preg_match('/^http/i', $url)) {
    $linkstart .= 'http://';
  }
  $linkstart .= $url;
  $linkstart .= '"';
  if ($target) {
    $linkstart .= ' target="' . $target . '"';
  }
  $linkstart .= ' title="' . $langs->trans("URL") . ': ' . $url . '"';
  $linkstart .= '>';
 
  $link = '';
  if (!preg_match('/^http/i', $url)) {
    $link .= 'http://';
  }
  $link .= dol_trunc($url, $max);
 
  $linkend = '</a>';
 
  if ($morecss == 'float') {  // deprecated
    return '<div class="nospan' . ($morecss ? ' ' . $morecss : '') . '" style="margin-right: 10px">' . ($withpicto ? img_picto($langs->trans("Url"), 'globe', 'class="paddingrightonly"') : '') . $link . '</div>';
  } else {
    return $linkstart . '<span class="nospan' . ($morecss ? ' ' . $morecss : '') . '" style="margin-right: 10px">' . ($withpicto ? img_picto('', 'globe', 'class="paddingrightonly"') : '') . $link . '</span>' . $linkend;
  }
}
 
function dol_print_email($email, $contactid = 0, $socid = 0, $addlink = 0, $max = 0, $showinvalid = 2, $withpicto = 0, $morecss = 'paddingrightonly')
{
  global $user, $langs, $hookmanager;
 
  //global $conf; $conf->global->AGENDA_ADDACTIONFOREMAIL = 1;
  //$showinvalid = 1; $email = 'rrrrr';
 
  $newemail = dol_escape_htmltag($email);
 
  if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') && $withpicto) {
    $withpicto = 0;
  }
 
  if (empty($email)) {
    return '&nbsp;';
  }
 
  if ($addlink == 1) {
    $newemail = '<a class="' . ($morecss ? $morecss : '') . '" style="text-overflow: ellipsis;" href="';
    if (!preg_match('/^mailto:/i', $email)) {
      $newemail .= 'mailto:';
    }
    $newemail .= $email;
    $newemail .= '" target="_blank">';
 
    $newemail .= ($withpicto ? img_picto($langs->trans("EMail") . ' : ' . $email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '');
 
    if ($max > 0) {
      $newemail .= dol_trunc($email, $max);
    } else {
      $newemail .= $email;
    }
    $newemail .= '</a>';
 
    if ($showinvalid) {
      include_once DOL_DOCUMENT_ROOT.'/core/class/CMailFile.class.php';
      include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
      $emailonly = CMailFile::getValidAddress($email, 2);
      if (!isValidEmail($emailonly)) {
        $langs->load("errors");
        $newemail .= img_warning($langs->transnoentitiesnoconv("ErrorBadEMail", $emailonly), '', 'paddingrightonly');
      } elseif ($showinvalid == 2 && !isValidMailDomain($emailonly)) {
        $langs->load("errors");
        $newemail .= img_warning($langs->transnoentitiesnoconv("ErrorBadMXDomain", $emailonly), '', 'paddingrightonly');
      }
    }
 
    if (($contactid || $socid) && isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
      $type = 'AC_EMAIL';
      $linktoaddaction = '';
      if (getDolGlobalString('AGENDA_ADDACTIONFOREMAIL')) {
        $linktoaddaction = '<a href="' . DOL_URL_ROOT . '/comm/action/card.php?action=create&backtopage=1&actioncode=' . urlencode($type) . '&contactid=' . ((int) $contactid) . '&socid=' . ((int) $socid) . '">' . img_object($langs->trans("AddAction"), "calendar") . '</a>';
      }
      if ($linktoaddaction) {
        $newemail = '<div>' . $newemail . ' ' . $linktoaddaction . '</div>';
      }
    }
  } elseif ($addlink === 'thirdparty') {
    $tmpnewemail = '<a class="' . ($morecss ? $morecss : '') . '" style="text-overflow: ellipsis;" href="' . DOL_URL_ROOT . '/societe/card.php?socid=' . $socid . '&action=presend&mode=init#formmailbeforetitle">';
    $tmpnewemail .= ($withpicto ? img_picto($langs->trans("EMail") . ' : ' . $email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '');
    if ($withpicto == 1) {
      $tmpnewemail .= $newemail;
    }
    $tmpnewemail .= '</a>';
 
    $newemail = $tmpnewemail;
  } else {
    $newemail = ($withpicto ? img_picto($langs->trans("EMail") . ' : ' . $email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '') . $newemail;
 
    if ($showinvalid) {
      include_once DOL_DOCUMENT_ROOT.'/core/class/CMailFile.class.php';
      include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
      $emailonly = CMailFile::getValidAddress($email, 2);
      if (!isValidEmail($emailonly)) {
        $langs->load("errors");
        $newemail .= img_warning($langs->transnoentitiesnoconv("ErrorBadEMail", $email));
      } elseif ($showinvalid == 2 && !isValidMailDomain($emailonly)) {
        $langs->load("errors");
        $newemail .= img_warning($langs->transnoentitiesnoconv("ErrorBadMXDomain", $emailonly));
      }
    }
  }
 
  //$rep = '<div class="nospan" style="margin-right: 10px">';
  //$rep = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '').$newemail;
  //$rep .= '</div>';
  $rep = $newemail;
  if (getDolGlobalString('MAIN_MAIL_COPY_ON_CLICK')) {
    $rep .= showValueWithClipboardCPButton($newemail, 0, 'none');
  }
 
  if ($hookmanager) {
    $parameters = array('cid' => $contactid, 'socid' => $socid, 'addlink' => $addlink, 'picto' => $withpicto);
 
    $reshook = $hookmanager->executeHooks('printEmail', $parameters, $email);
    if ($reshook > 0) {
      $rep = '';
    }
    $rep .= $hookmanager->resPrint;
  }
 
  return $rep;
}
 
 
function getArrayOfSocialNetworks()
{
  global $db;
 
  $socialnetworks = array();
  // Enable caching of array
  require_once DOL_DOCUMENT_ROOT . '/core/lib/memory.lib.php';
  $cachekey = dol_sanitizeKeyCode(str_replace(',', '_', 'socialnetworks_'.getEntity('c_socialnetworks')));
  $dataretrieved = dol_getcache($cachekey);
 
  if (!is_null($dataretrieved)) {
    $socialnetworks = $dataretrieved;
  } else {
    $sql = "SELECT rowid, code, label, url, icon, active FROM " . MAIN_DB_PREFIX . "c_socialnetworks";
    $sql .= " WHERE entity IN (" . getEntity('c_socialnetworks').")";
 
    $resql = $db->query($sql);
    if ($resql) {
      while ($obj = $db->fetch_object($resql)) {
        $socialnetworks[$obj->code] = array(
          'rowid' => $obj->rowid,
          'label' => $obj->label,
          'url' => $obj->url,
          'icon' => $obj->icon,
          'active' => $obj->active,
        );
      }
    }
    dol_setcache($cachekey, $socialnetworks); // If setting cache fails, this is not a problem, so we do not test result.
  }
 
  return (is_array($socialnetworks) ? $socialnetworks : array());
}
 
function dol_print_socialnetworks($value, $contactid, $socid, $type, $dictsocialnetworks = array())
{
  global $hookmanager, $langs, $user;
 
  $htmllink = $value;
 
  if (empty($value)) {
    return '&nbsp;';
  }
 
  if (!empty($type)) {
    $htmllink = '<div class="divsocialnetwork inline-block valignmiddle">';
    // Use dictionary definition for picto $dictsocialnetworks[$type]['icon']
    $htmllink .= '<span class="fab pictofixedwidth ' . ($dictsocialnetworks[$type]['icon'] ? $dictsocialnetworks[$type]['icon'] : 'fa-link') . '"></span>';
    if ($type == 'skype') {
      $htmllink .= dol_escape_htmltag($value);
      $htmllink .= '&nbsp; <a href="skype:';
      $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
      $htmllink .= '?call" alt="' . $langs->trans("Call") . '&nbsp;' . $value . '" title="' . dol_escape_htmltag($langs->trans("Call") . ' ' . $value) . '">';
      $htmllink .= '<img src="' . DOL_URL_ROOT . '/theme/common/skype_callbutton.png" border="0">';
      $htmllink .= '</a><a href="skype:';
      $htmllink .= dol_string_nospecial($value, '_', '', array('@'));
      $htmllink .= '?chat" alt="' . $langs->trans("Chat") . '&nbsp;' . $value . '" title="' . dol_escape_htmltag($langs->trans("Chat") . ' ' . $value) . '">';
      $htmllink .= '<img class="paddingleft" src="' . DOL_URL_ROOT . '/theme/common/skype_chatbutton.png" border="0">';
      $htmllink .= '</a>';
      if (($contactid || $socid) && isModEnabled('agenda') && $user->hasRight('agenda', 'myactions', 'create')) {
        $addlink = 'AC_SKYPE';
        $link = '';
        if (getDolGlobalString('AGENDA_ADDACTIONFORSKYPE')) {
          $link = '<a href="' . DOL_URL_ROOT . '/comm/action/card.php?action=create&backtopage=1&actioncode=' . $addlink . '&contactid=' . $contactid . '&socid=' . $socid . '">' . img_object($langs->trans("AddAction"), "calendar") . '</a>';
        }
        $htmllink .= ($link ? ' ' . $link : '');
      }
    } else {
      if (!empty($dictsocialnetworks[$type]['url'])) {
        $tmpvirginurl = preg_replace('/\/?{socialid}/', '', $dictsocialnetworks[$type]['url']);
        if ($tmpvirginurl) {
          $value = preg_replace('/^www\.' . preg_quote($tmpvirginurl, '/') . '\/?/', '', $value);
          $value = preg_replace('/^' . preg_quote($tmpvirginurl, '/') . '\/?/', '', $value);
 
          $tmpvirginurl3 = preg_replace('/^https:\/\//i', 'https://www.', $tmpvirginurl);
          if ($tmpvirginurl3) {
            $value = preg_replace('/^www\.' . preg_quote($tmpvirginurl3, '/') . '\/?/', '', $value);
            $value = preg_replace('/^' . preg_quote($tmpvirginurl3, '/') . '\/?/', '', $value);
          }
 
          $tmpvirginurl2 = preg_replace('/^https?:\/\//i', '', $tmpvirginurl);
          if ($tmpvirginurl2) {
            $value = preg_replace('/^www\.' . preg_quote($tmpvirginurl2, '/') . '\/?/', '', $value);
            $value = preg_replace('/^' . preg_quote($tmpvirginurl2, '/') . '\/?/', '', $value);
          }
        }
        if (preg_match('/^https?:\/\//i', $value)) {
          $link = $value;
        } else {
          $link = str_replace('{socialid}', $value, $dictsocialnetworks[$type]['url']);
        }
        $valuetoshow = $value;
        $valuetoshow = preg_replace('/https:\/\/www\.(twitter|x|linkedin)\.com\/?/', '', $valuetoshow);
        if (preg_match('/^https?:\/\//i', $link)) {
          $htmllink .= '<a href="' . dol_sanitizeUrl($link, 0) . '" target="_blank" rel="noopener noreferrer">' . dol_escape_htmltag($valuetoshow) . '</a>';
        } else {
          $htmllink .= '<a href="' . dol_sanitizeUrl($link, 1) . '" target="_blank" rel="noopener noreferrer">' . dol_escape_htmltag($valuetoshow) . '</a>';
        }
      } else {
        $htmllink .= dol_escape_htmltag($value);
      }
    }
    $htmllink .= '</div>';
  } else {
    $langs->load("errors");
    $htmllink .= img_warning($langs->trans("ErrorBadSocialNetworkValue", $value));
  }
 
  if ($hookmanager) {
    $parameters = array(
      'value' => $value,
      'cid' => $contactid,
      'socid' => $socid,
      'type' => $type,
      'dictsocialnetworks' => $dictsocialnetworks,
    );
 
    $reshook = $hookmanager->executeHooks('printSocialNetworks', $parameters);
    if ($reshook > 0) {
      $htmllink = '';
    }
    $htmllink .= $hookmanager->resPrint;
  }
 
  return $htmllink;
}
 
function dol_print_profids($profID, $profIDtype, $countrycode = '', $addcpButton = 1)
{
  global $mysoc;
 
  if (empty($profID) || empty($profIDtype)) {
    return '';
  }
  if (empty($countrycode)) {
    $countrycode = $mysoc->country_code;
  }
  $newProfID = $profID;
  $id = substr($profIDtype, -1);
  $ret = '';
  if (strtoupper($countrycode) == 'FR') {
    // France
    // (see https://www.economie.gouv.fr/entreprises/numeros-identification-entreprise)
 
    if ($id == 1 && dol_strlen($newProfID) == 9) {
      // SIREN (ex: 123 123 123)
      $newProfID = substr($newProfID, 0, 3) . ' ' . substr($newProfID, 3, 3) . ' ' . substr($newProfID, 6, 3);
    }
    if ($id == 2 && dol_strlen($newProfID) == 14) {
      // SIRET (ex: 123 123 123 12345)
      $newProfID = substr($newProfID, 0, 3) . ' ' . substr($newProfID, 3, 3) . ' ' . substr($newProfID, 6, 3) . ' ' . substr($newProfID, 9, 5);
    }
    if ($id == 3 && dol_strlen($newProfID) == 5) {
      // NAF/APE (ex: 69.20Z)
      $newProfID = substr($newProfID, 0, 2) . '.' . substr($newProfID, 2, 3);
    }
    if ($profIDtype === 'VAT' && dol_strlen($newProfID) == 13) {
      // TVA intracommunautaire (ex: FR12 123 123 123)
      $newProfID = substr($newProfID, 0, 4) . ' ' . substr($newProfID, 4, 3) . ' ' . substr($newProfID, 7, 3) . ' ' . substr($newProfID, 10, 3);
    }
  }
  if (!empty($addcpButton)) {
    $ret = showValueWithClipboardCPButton(dol_escape_htmltag($profID), ($addcpButton == 1 ? 1 : 0), $newProfID);
  } else {
    $ret = $newProfID;
  }
  return $ret;
}
 
function dol_print_phone($phone, $countrycode = '', $contactid = 0, $socid = 0, $addlink = '', $separ = "&nbsp;", $withpicto = '', $titlealt = '', $adddivfloat = 0, $morecss = 'paddingright')
{
  global $conf, $user, $langs, $mysoc, $hookmanager;
 
  // Clean phone parameter
  $phone = is_null($phone) ? '' : preg_replace("/[\s.-]/", "", trim($phone));
  if (empty($phone)) {
    return '';
  }
  if (getDolGlobalString('MAIN_PHONE_SEPAR')) {
    $separ = getDolGlobalString('MAIN_PHONE_SEPAR');
  }
  if (empty($countrycode) && is_object($mysoc)) {
    $countrycode = $mysoc->country_code;
  }
 
  // Short format for small screens
  if (!empty($conf->dol_optimize_smallscreen) && $separ != 'hidenum') {
    $separ = '';
  }
 
  $newphone = $phone;
  $newphonewa = $phone;
  if (strtoupper($countrycode) == "FR") {
    // France
    if (dol_strlen($phone) == 10) {
      $newphone = substr($newphone, 0, 2) . $separ . substr($newphone, 2, 2) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2);
    } elseif (dol_strlen($phone) == 7) {
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 2);
    } elseif (dol_strlen($phone) == 9) {
      $newphone = substr($newphone, 0, 2) . $separ . substr($newphone, 2, 3) . $separ . substr($newphone, 5, 2) . $separ . substr($newphone, 7, 2);
    } elseif (dol_strlen($phone) == 11) {
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 2) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2);
    } elseif (dol_strlen($phone) == 12) {
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 1) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 13) {
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 3) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "CA") {
    if (dol_strlen($phone) == 10) {
      $newphone = ($separ != '' ? '(' : '') . substr($newphone, 0, 3) . ($separ != '' ? ')' : '') . $separ . substr($newphone, 3, 3) . ($separ != '' ? '-' : '') . substr($newphone, 6, 4);
    }
  } elseif (strtoupper($countrycode) == "PT") { //Portugal
    if (dol_strlen($phone) == 13) { //ex: +351_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 3);
    }
  } elseif (strtoupper($countrycode) == "SR") { //Suriname
    if (dol_strlen($phone) == 10) { //ex: +597_ABC_DEF
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3);
    } elseif (dol_strlen($phone) == 11) { //ex: +597_ABC_DEFG
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 4);
    }
  } elseif (strtoupper($countrycode) == "DE") { //Deutschland
    if (dol_strlen($phone) == 14) { //ex:  +49_ABCD_EFGH_IJK
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 4) . $separ . substr($newphone, 7, 4) . $separ . substr($newphone, 11, 3);
    } elseif (dol_strlen($phone) == 13) { //ex: +49_ABC_DEFG_HIJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 4) . $separ . substr($newphone, 10, 3);
    }
  } elseif (strtoupper($countrycode) == "ES") { //Spain
    if (dol_strlen($phone) == 12) { //ex:  +34_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 3);
    }
  } elseif (strtoupper($countrycode) == "BF") { // Burkina Faso
    if (dol_strlen($phone) == 12) { //ex :  +22 A BC_DE_FG_HI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 1) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "RO") { // Roumanie
    if (dol_strlen($phone) == 12) { //ex :  +40 AB_CDE_FG_HI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "TR") { //Turquie
    if (dol_strlen($phone) == 13) { //ex :  +90 ABC_DEF_GHIJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 4);
    }
  } elseif (strtoupper($countrycode) == "US") { //Etat-Unis
    if (dol_strlen($phone) == 12) { //ex: +1 ABC_DEF_GHIJ
      $newphone = substr($newphone, 0, 2) . $separ . substr($newphone, 2, 3) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 4);
    }
  } elseif (strtoupper($countrycode) == "MX") { //Mexique
    if (dol_strlen($phone) == 12) { //ex: +52 ABCD_EFG_HI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 4) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 11) { //ex: +52 AB_CD_EF_GH
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 2) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2);
    } elseif (dol_strlen($phone) == 13) { //ex: +52 ABC_DEF_GHIJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 4);
    }
  } elseif (strtoupper($countrycode) == "ML") { //Mali
    if (dol_strlen($phone) == 12) { //ex: +223 AB_CD_EF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "TH") { //Thailand
    if (dol_strlen($phone) == 11) { //ex: +66_ABC_DE_FGH
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 3);
    } elseif (dol_strlen($phone) == 12) { //ex: +66_A_BCD_EF_GHI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 1) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 3);
    }
  } elseif (strtoupper($countrycode) == "MU") {
    //Maurice
    if (dol_strlen($phone) == 11) { //ex: +230_ABC_DE_FG
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2);
    } elseif (dol_strlen($phone) == 12) { //ex: +230_ABCD_EF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 4) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "ZA") { //Afrique du sud
    if (dol_strlen($phone) == 12) { //ex: +27_AB_CDE_FG_HI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "SY") { //Syrie
    if (dol_strlen($phone) == 12) { //ex: +963_AB_CD_EF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 13) { //ex: +963_AB_CD_EF_GHI
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 3);
    }
  } elseif (strtoupper($countrycode) == "AE") { //Emirats Arabes Unis
    if (dol_strlen($phone) == 12) { //ex: +971_ABC_DEF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 13) { //ex: +971_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 3);
    } elseif (dol_strlen($phone) == 14) { //ex: +971_ABC_DEF_GHIK
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 4);
    }
  } elseif (strtoupper($countrycode) == "DZ") { //Algeria
    if (dol_strlen($phone) == 13) { //ex: +213_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 3);
    }
  } elseif (strtoupper($countrycode) == "BE") { //Belgique
    if (dol_strlen($phone) == 11) { //ex: +32_ABC_DE_FGH
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 3);
    } elseif (dol_strlen($phone) == 12) { //ex: +32_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 3);
    }
  } elseif (strtoupper($countrycode) == "PF") { //French Polynesia
    if (dol_strlen($phone) == 12) { //ex: +689_AB_CD_EF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "CO") { //Colombie
    if (dol_strlen($phone) == 13) { //ex: +57_ABC_DEF_GH_IJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "JO") { //Jordanie
    if (dol_strlen($phone) == 12) { //ex: +962_A_BCD_EF_GH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 1) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    }
  } elseif (strtoupper($countrycode) == "JM") { //Jamaica
    if (dol_strlen($newphone) == 12) { //ex: +1867_ABC_DEFG
      $newphone = substr($newphone, 0, 5) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 4);
    }
  } elseif (strtoupper($countrycode) == "MG") { //Madagascar
    if (dol_strlen($phone) == 13) { //ex: +261_AB_CD_EFG_HI
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 3) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "GB") { //Royaume uni
    if (dol_strlen($phone) == 13) { //ex: +44_ABCD_EFG_HIJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 4) . $separ . substr($newphone, 7, 3) . $separ . substr($newphone, 10, 3);
    }
  } elseif (strtoupper($countrycode) == "CH") { //Suisse
    if (dol_strlen($phone) == 12) { //ex: +41_AB_CDE_FG_HI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 15) { // +41_AB_CDE_FGH_IJKL
      $newphone = $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 3) . $separ . substr($newphone, 8, 3) . $separ . substr($newphone, 11, 4);
    }
  } elseif (strtoupper($countrycode) == "TN") { //Tunisie
    if (dol_strlen($phone) == 12) { //ex: +216_AB_CDE_FGH
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 3);
    }
  } elseif (strtoupper($countrycode) == "GF") { //Guyane francaise
    if (dol_strlen($phone) == 13) { //ex: +594_ABC_DE_FG_HI  (ABC=594 de nouveau)
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "GP") { //Guadeloupe
    if (dol_strlen($phone) == 13) { //ex: +590_ABC_DE_FG_HI  (ABC=590 de nouveau)
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "MQ") { //Martinique
    if (dol_strlen($phone) == 13) { //ex: +596_ABC_DE_FG_HI  (ABC=596 de nouveau)
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "IT") { //Italie
    if (dol_strlen($phone) == 12) { //ex: +39_ABC_DEF_GHI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 3);
    } elseif (dol_strlen($phone) == 13) { //ex: +39_ABC_DEF_GH_IJ
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "AU") {
    //Australie
    if (dol_strlen($phone) == 12) {
      //ex: +61_A_BCDE_FGHI
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 1) . $separ . substr($newphone, 4, 4) . $separ . substr($newphone, 8, 4);
    }
  } elseif (strtoupper($countrycode) == "LU") {
    // Luxembourg
    if (dol_strlen($phone) == 10) { // fix 6 digits +352_AA_BB_CC
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2);
    } elseif (dol_strlen($phone) == 11) { // fix 7 digits +352_AA_BB_CC_D
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 1);
    } elseif (dol_strlen($phone) == 12) { // fix 8 digits +352_AA_BB_CC_DD
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 2) . $separ . substr($newphone, 6, 2) . $separ . substr($newphone, 8, 2) . $separ . substr($newphone, 10, 2);
    } elseif (dol_strlen($phone) == 13) { // mobile +352_AAA_BB_CC_DD
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 2) . $separ . substr($newphone, 9, 2) . $separ . substr($newphone, 11, 2);
    }
  } elseif (strtoupper($countrycode) == "PE") {
    // Peru
    if (dol_strlen($phone) == 7) { // fix 7 numbers without code AAA_BBBB
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 4);
    } elseif (dol_strlen($phone) == 9) { // mobile add code and fix 9 numbers +51_AAA_BBB_CCC
      $newphonewa = '+51' . $newphone;
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3);
    } elseif (dol_strlen($phone) == 11) { // fix 11 numbers +511_AAA_BBBB
      $newphone = substr($newphone, 0, 4) . $separ . substr($newphone, 4, 3) . $separ . substr($newphone, 7, 4);
    } elseif (dol_strlen($phone) == 12) { // mobile +51_AAA_BBB_CCC
      $newphonewa = $newphone;
      $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 3) . $separ . substr($newphone, 6, 3) . $separ . substr($newphone, 9, 3);
    }
  } elseif (strtoupper($countrycode) == "IN") { //India
    if (dol_strlen($phone) == 13) {
      if ($withpicto == 'phone') { //ex: +91_AB_CDEF_GHIJ
        $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 2) . $separ . substr($newphone, 5, 4) . $separ . substr($newphone, 9, 4);
      } else { //ex: +91_ABCDE_FGHIJ
        $newphone = substr($newphone, 0, 3) . $separ . substr($newphone, 3, 5) . $separ . substr($newphone, 8, 5);
      }
    }
  }
 
  $newphoneastart = $newphoneaend = '';
  if (!empty($addlink)) { // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
    if ($addlink == 'tel' || $conf->browser->layout == 'phone' || (isModEnabled('clicktodial') && getDolGlobalString('CLICKTODIAL_USE_TEL_LINK_ON_PHONE_NUMBERS'))) { // If phone or option for, we use link of phone
      $newphoneastart = '<a href="tel:' . urlencode($phone) . '">';
      $newphoneaend .= '</a>';
    } elseif (isModEnabled('clicktodial') && $addlink == 'AC_TEL') {    // If click to dial, we use click to dial url
      if (empty($user->clicktodial_loaded)) {
        $user->fetch_clicktodial();
      }
 
      // Define urlmask
      $urlmask = getDolGlobalString('CLICKTODIAL_URL', 'ErrorClickToDialModuleNotConfigured');
      if (!empty($user->clicktodial_url)) {
        $urlmask = $user->clicktodial_url;
      }
 
      $clicktodial_poste = (!empty($user->clicktodial_poste) ? urlencode($user->clicktodial_poste) : '');
      $clicktodial_login = (!empty($user->clicktodial_login) ? urlencode($user->clicktodial_login) : '');
      $clicktodial_password = (!empty($user->clicktodial_password) ? urlencode($user->clicktodial_password) : '');
      // This line is for backward compatibility  @phan-suppress-next-line PhanPluginPrintfVariableFormatString
      $url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
      // Those lines are for substitution
      $substitarray = array(
        '__PHONEFROM__' => $clicktodial_poste,
        '__PHONETO__' => urlencode($phone),
        '__LOGIN__' => $clicktodial_login,
        '__PASS__' => $clicktodial_password
      );
      $url = make_substitutions($url, $substitarray);
      if (!getDolGlobalString('CLICKTODIAL_DO_NOT_USE_AJAX_CALL')) {
        // Default and recommended: New method using ajax without submitting a page making a javascript history.go(-1) back
        $newphoneastart = '<a href="' . $url . '" class="cssforclicktodial">';  // Call of ajax is handled by the lib_foot.js.php on class 'cssforclicktodial'
        $newphoneaend = '</a>';
      } else {
        // Old method
        $newphoneastart = '<a href="' . $url . '"';
        if (getDolGlobalString('CLICKTODIAL_FORCENEWTARGET')) {
          $newphoneastart .= ' target="_blank" rel="noopener noreferrer"';
        }
        $newphoneastart .= '>';
        $newphoneaend .= '</a>';
      }
    }
    //if (($contactid || $socid) && isModEnabled('agenda') && $user->hasRight('agenda', 'myactions', 'create'))
    if (isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
      $type = 'AC_TEL';
      $addlinktoagenda = '';
      if ($addlink == 'AC_FAX') {
        $type = 'AC_FAX';
      }
      if (getDolGlobalString('AGENDA_ADDACTIONFORPHONE')) {
        $addlinktoagenda = '<a href="' . DOL_URL_ROOT . '/comm/action/card.php?action=create&backtopage=' . urlencode($_SERVER['REQUEST_URI']) . '&actioncode=' . $type . ($contactid ? '&contactid=' . $contactid : '') . ($socid ? '&socid=' . $socid : '') . '">' . img_object($langs->trans("AddAction"), "calendar") . '</a>';
      }
      if ($addlinktoagenda) {
        $newphone = '<span>' . $newphone . ' ' . $addlinktoagenda . '</span>';
      }
    }
  }
 
  if (getDolGlobalString('CONTACT_PHONEMOBILE_SHOW_LINK_TO_WHATSAPP') && $withpicto == 'mobile') {
    // Link to Whatsapp
    $newphone .= ' <a href="https://wa.me/' . $newphonewa . '" target="_blank"'; // Use api to whatasapp contacts
    $newphone .= '><span class="paddingright fab fa-whatsapp" style="color:#25D366;" title="WhatsApp"></span></a>';
  }
 
  if (empty($titlealt)) {
    $titlealt = ($withpicto == 'fax' ? $langs->trans("Fax") : $langs->trans("Phone"));
  }
  $rep = '';
 
  if ($hookmanager) {
    $parameters = array('countrycode' => $countrycode, 'cid' => $contactid, 'socid' => $socid, 'titlealt' => $titlealt, 'picto' => $withpicto);
    $reshook = $hookmanager->executeHooks('printPhone', $parameters, $phone);
    $rep .= $hookmanager->resPrint;
  }
  if (empty($reshook)) {
    $picto = '';
    if ($withpicto) {
      if ($withpicto == 'fax') {
        $picto = 'phoning_fax';
      } elseif ($withpicto == 'phone') {
        $picto = 'phone';
      } elseif ($withpicto == 'mobile') {
        $picto = 'phoning_mobile';
      } else {
        $picto = '';
      }
    }
    if ($adddivfloat == 1) {
      $rep .= '<div class="nospan float' . ($morecss ? ' ' . $morecss : '') . '">';
    } elseif (empty($adddivfloat)) {
      $rep .= '<span' . ($morecss ? ' class="' . $morecss . '"' : '') . '>';
    }
 
    $rep .= $newphoneastart;
    $rep .= ($withpicto ? img_picto($titlealt, $picto) : '');
    if ($separ != 'hidenum') {
      $rep .= ($withpicto ? ' ' : '') . $newphone;
    }
    $rep .= $newphoneaend;
 
    if ($adddivfloat == 1) {
      $rep .= '</div>';
    } elseif (empty($adddivfloat)) {
      $rep .= '</span>';
    }
  }
 
  return $rep;
}
 
function dol_print_ip($ip, $mode = 0, $showname = 0)
{
  global $conf;
 
  $ret = '';
  if (!isset($conf->cache['resolveips'])) {
    $conf->cache['resolveips'] = array();
  }
 
  if ($mode != 2) {
    $countrycode = dolGetCountryCodeFromIp($ip);
    if ($countrycode) { // If success, countrycode is us, fr, ...
      if (file_exists(DOL_DOCUMENT_ROOT . '/theme/common/flags/' . $countrycode . '.png')) {
        $ret .= picto_from_langcode($countrycode);
      } else {
        $ret .= '(' . $countrycode . ')';
      }
      $ret .= '&nbsp;';
    } else {
      // Nothing
    }
  }
 
  if (in_array($mode, [0, 2])) {
    $domain = '';
    if ($showname) {
      if (!array_key_exists($ip, $conf->cache['resolveips'])) {
        $domain = gethostbyaddr($ip);
        $conf->cache['resolveips'][$ip] = $domain; // false or domain
      } else {
        $domain = $conf->cache['resolveips'][$ip];
      }
    }
    if ($domain) {
      $ret .= $domain;
    } else {
      $ret .= $ip;
    }
  }
 
  return $ret;
}
 
function getUserRemoteIP($trusted = 0)
{
  if ($trusted) { // Return only IP we can rely on (not spoofable by the client)
    $ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']);  // value may be the IP of a proxy
    // Note that if apache module remoteip has been enabled, REMOTE_ADDR can contain the real client (the value from cloudFlare HTTP_CF_CONNECTING_IP for example)
    // This can happen if the proxy were added in the list of trusted proxy.
    return $ip;
  }
 
  // Try to guess the real IP of client (but this may not be reliable)
  if (empty($_SERVER['HTTP_X_FORWARDED_FOR']) || preg_match('/[^0-9\.\:,\[\]\s]/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
    if (empty($_SERVER['HTTP_CLIENT_IP']) || preg_match('/[^0-9\.\:,\[\]\s]/', $_SERVER['HTTP_CLIENT_IP'])) {
      if (empty($_SERVER["HTTP_CF_CONNECTING_IP"])) {
        $ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']);  // value may be the IP of the proxy and not the client
      } else {
        $ip = $_SERVER["HTTP_CF_CONNECTING_IP"];  // value here may have been forged by client
      }
    } else {
      $ip = preg_replace('/,.*$/', '', $_SERVER['HTTP_CLIENT_IP']); // value is clean here but may have been forged by proxy
    }
  } else {
    $ip = preg_replace('/,.*$/', '', $_SERVER['HTTP_X_FORWARDED_FOR']); // value is clean here but may have been forged by proxy
  }
  return $ip;
}
 
function dolGetCountryCodeFromIp($ip)
{
  $countrycode = '';
 
  if (isModEnabled('geoipmaxmind')) {
    if (getDolGlobalString('GEOIP_VERSION') == 'php') {
      $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
    } else {
      $diroffile = getMultidirOutput(null, 'geoipmaxmind');
      $datafile = $diroffile . '/' . getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE_EMBEDDED');
    }
    //$ip='24.24.24.24';
    //$datafile='/usr/share/GeoIP/GeoIP.dat';    Note that this must be downloaded datafile (not same than datafile provided with ubuntu packages)
    if ($datafile) {
      try {
        include_once DOL_DOCUMENT_ROOT . '/core/class/dolgeoip.class.php';
        $geoip = new DolGeoIP('country', $datafile);
        //print 'ip='.$ip.' databaseType='.$geoip->gi->databaseType." GEOIP_CITY_EDITION_REV1=".GEOIP_CITY_EDITION_REV1."\n";
        $countrycode = $geoip->getCountryCodeFromIP($ip);
      } catch (Exception $e) {
        //print 'Error with GeoIP database: '.$e->getMessage();
      }
    }
  }
 
  return $countrycode;
}
 
 
function dol_user_country()
{
  //$ret=$user->xxx;
  $ret = '';
  if (isModEnabled('geoipmaxmind')) {
    $ip = getUserRemoteIP();
    $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
    //$ip='24.24.24.24';
    //$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat';
    include_once DOL_DOCUMENT_ROOT . '/core/class/dolgeoip.class.php';
    $geoip = new DolGeoIP('country', $datafile);
    $countrycode = $geoip->getCountryCodeFromIP($ip);
    $ret = $countrycode;
  }
  return $ret;
}
 
function dol_print_address($address, $htmlid, $element, $id, $noprint = 0, $charfornl = '')
{
  global $hookmanager;
 
  $out = '';
 
  if ($address) {
    if ($hookmanager) {
      $parameters = array('element' => $element, 'id' => $id);
      $reshook = $hookmanager->executeHooks('printAddress', $parameters, $address);
      $out .= $hookmanager->resPrint;
    }
    if (empty($reshook)) {
      if (empty($charfornl)) {
        $out .= nl2br((string) $address);
      } else {
        $out .= preg_replace('/[\r\n]+/', $charfornl, (string) $address);
      }
 
      // TODO Remove this block, we can add this using the hook now
      $showgmap = $showomap = 0;
      if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS')) {
        $showgmap = 1;
      }
      if ($element == 'contact' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_CONTACTS')) {
        $showgmap = 1;
      }
      if ($element == 'member' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_MEMBERS')) {
        $showgmap = 1;
      }
      if ($element == 'user' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_USERS')) {
        $showgmap = 1;
      }
      if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS')) {
        $showomap = 1;
      }
      if ($element == 'contact' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_CONTACTS')) {
        $showomap = 1;
      }
      if ($element == 'member' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_MEMBERS')) {
        $showomap = 1;
      }
      if ($element == 'user' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_USERS')) {
        $showomap = 1;
      }
      if ($showgmap) {
        $url = dol_buildpath('/google/gmaps.php?mode=' . $element . '&id=' . $id, 1);
        $out .= ' <a href="' . $url . '" target="_gmaps"><img id="' . $htmlid . '" class="valigntextbottom" src="' . DOL_URL_ROOT . '/theme/common/gmap.png"></a>';
      }
      if ($showomap) {
        $url = dol_buildpath('/openstreetmap/maps.php?mode=' . $element . '&id=' . $id, 1);
        $out .= ' <a href="' . $url . '" target="_gmaps"><img id="' . $htmlid . '_openstreetmap" class="valigntextbottom" src="' . DOL_URL_ROOT . '/theme/common/gmap.png"></a>';
      }
    }
  }
  if ($noprint) {
    return $out;
  } else {
    print $out;
    return null;
  }
}
 
 
function isValidEmail($address, $acceptsupervisorkey = 0, $acceptuserkey = 0)
{
  if ($acceptsupervisorkey && $address == '__SUPERVISOREMAIL__') {
    return true;
  }
  if ($acceptuserkey && $address == '__USER_EMAIL__') {
    return true;
  }
  if (filter_var($address, FILTER_VALIDATE_EMAIL)) {
    return true;
  }
 
  return false;
}
 
function isValidMXRecord($domain)
{
  if (function_exists('idn_to_ascii') && function_exists('checkdnsrr')) {
    if (!checkdnsrr(idn_to_ascii($domain), 'MX')) {
      return 0;
    }
    if (function_exists('getmxrr')) {
      $mxhosts = array();
      $weight = array();
      getmxrr(idn_to_ascii($domain), $mxhosts, $weight);
      if (count($mxhosts) > 1) {
        return 1;
      }
      if (count($mxhosts) == 1 && !in_array((string) $mxhosts[0], array('', '.'))) {
        return 1;
      }
 
      return 0;
    }
  }
 
  // function idn_to_ascii or checkdnsrr or getmxrr does not exists
  return -1;
}
 
function isValidPhone($phone)
{
  return true;
}
 
 
function dolGetFirstLetters($s, $nbofchar = 1)
{
  $ret = '';
  $tmparray = explode(' ', $s);
  foreach ($tmparray as $tmps) {
    $ret .= dol_substr($tmps, 0, $nbofchar);
  }
 
  return $ret;
}
 
 
function dol_strlen($string, $stringencoding = 'UTF-8')
{
  if (is_null($string)) {
    return 0;
  }
 
  if (function_exists('mb_strlen')) {
    return mb_strlen($string, $stringencoding);
  } else {
    return strlen($string);
  }
}
 
function dol_substr($string, $start, $length = null, $stringencoding = '', $trunconbytes = 0)
{
  global $langs;
 
  if (empty($stringencoding)) {
    $stringencoding = (empty($langs) ? 'UTF-8' : $langs->charset_output);
  }
 
  $ret = '';
  if (empty($trunconbytes)) {
    if (function_exists('mb_substr')) {
      $ret = mb_substr($string, $start, $length, $stringencoding);
    } else {
      $ret = substr($string, $start, $length);
    }
  } else {
    if (function_exists('mb_strcut')) {
      $ret = mb_strcut($string, $start, $length, $stringencoding);
    } else {
      $ret = substr($string, $start, $length);
    }
  }
  return $ret;
}
 
 
function dol_trunc($string, $size = 40, $trunc = 'right', $stringencoding = 'UTF-8', $nodot = 0, $display = 0)
{
  global $conf;
 
  if (empty($size) || getDolGlobalString('MAIN_DISABLE_TRUNC')) {
    return $string;
  }
 
  if (empty($stringencoding)) {
    $stringencoding = 'UTF-8';
  }
  // reduce for small screen
  if (!empty($conf->dol_optimize_smallscreen) && $conf->dol_optimize_smallscreen == 1 && $display == 1) {
    $size = round($size / 3);
  }
 
  // We go always here
  if ($trunc == 'right') {
    $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
    if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
      // If nodot is 0 and size is 1 chars more, we don't trunc and don't add '...'
      return dol_substr($newstring, 0, $size, $stringencoding) . ($nodot ? '' : '…');
    } else {
      //return 'u'.$size.'-'.$newstring.'-'.dol_strlen($newstring,$stringencoding).'-'.$string;
      return $string;
    }
  } elseif ($trunc == 'middle') {
    $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
    if (dol_strlen($newstring, $stringencoding) > 2 && dol_strlen($newstring, $stringencoding) > ($size + 1)) {
      $size1 = (int) round($size / 2);
      $size2 = (int) round($size / 2);
      return dol_substr($newstring, 0, $size1, $stringencoding) . '…' . dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size2, $size2, $stringencoding);
    } else {
      return $string;
    }
  } elseif ($trunc == 'left') {
    $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
    if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
      // If nodot is 0 and size is 1 chars more, we don't trunc and don't add '...'
      return '…' . dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size, $size, $stringencoding);
    } else {
      return $string;
    }
  } elseif ($trunc == 'wrap') {
    $newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
    if (dol_strlen($newstring, $stringencoding) > ($size + 1)) {
      return dol_substr($newstring, 0, $size, $stringencoding) . "\n" . dol_trunc(dol_substr($newstring, $size, dol_strlen($newstring, $stringencoding) - $size, $stringencoding), $size, $trunc);
    } else {
      return $string;
    }
  } else {
    return 'BadParam3CallingDolTrunc';
  }
}
 
 
function vatrate($rate, $addpercent = false, $info_bits = 0, $usestarfornpr = 0, $html = 0)
{
  $morelabel = '';
 
  if (preg_match('/%/', $rate)) {
    $rate = str_replace('%', '', $rate);
    $addpercent = true;
  }
  $reg = array();
  if (preg_match('/\‍((.*)\‍)/', $rate, $reg)) {
    $morelabel = ' (' . $reg[1] . ')';
    $rate = preg_replace('/\s*' . preg_quote($morelabel, '/') . '/', '', $rate);
    $morelabel = ' ' . ($html ? '<span class="opacitymedium small">' : '') . '(' . $reg[1] . ')' . ($html ? '</span>' : '');
  }
  if (preg_match('/\*/', $rate)) {
    $rate = str_replace('*', '', $rate);
    $info_bits |= 1;
  }
 
  // If rate is '9/9/9' we don't change it.  If rate is '9.000' we apply price()
  if (!preg_match('/\//', $rate)) {
    $ret = price($rate, 0, '', 0, 0) . ($addpercent ? '%' : '');
  } else {
    // TODO Split on / and output with a price2num to have clean numbers without ton of 000.
    $ret = $rate . ($addpercent ? '%' : '');
  }
  if (($info_bits & 1) && $usestarfornpr >= 0) {
    $ret .= ' *';
  }
  $ret .= $morelabel;
  return $ret;
}
 
 
function price($amount, $form = 0, $outlangs = '', $trunc = 1, $rounding = -1, $forcerounding = -1, $currency_code = '')
{
  global $langs, $conf;
 
  // Clean parameters
  if (empty($amount)) {
    $amount = 0; // To have a numeric value if amount not defined or = ''
  }
  $amount = (is_numeric($amount) ? $amount : 0); // Check if amount is numeric, for example, an error occurred when amount value = o (letter) instead 0 (number)
  if ($rounding == -1) {
    $rounding = min(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), getDolGlobalString('MAIN_MAX_DECIMALS_TOT'));
  }
  $nbdecimal = $rounding;
 
  if ($outlangs === 'none') {
    // Use international separators
    $dec = '.';
    $thousand = '';
  } else {
    // Output separators by default (french)
    $dec = ',';
    $thousand = ' ';
 
    // If $outlangs not forced, we use use language
    if (!($outlangs instanceof Translate)) {
      $outlangs = $langs;
    }
 
    if ($outlangs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
      $dec = $outlangs->transnoentitiesnoconv("SeparatorDecimal");
    }
    if ($outlangs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
      $thousand = $outlangs->transnoentitiesnoconv("SeparatorThousand");
    }
    if ($thousand == 'None') {
      $thousand = '';
    } elseif ($thousand == 'Space') {
      $thousand = ' ';
    }
  }
  //print "outlangs=".$outlangs->defaultlang." amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
 
  //print "amount=".$amount."-";
  $amount = str_replace(',', '.', $amount); // should be useless
  //print $amount."-";
  $data = explode('.', $amount);
  $decpart = isset($data[1]) ? $data[1] : '';
  $decpart = preg_replace('/0+$/i', '', $decpart); // Remove 0 at end of decimal part
  //print "decpart=".$decpart."<br>";
  $end = '';
 
  // We increase nbdecimal if there is more decimal than asked (to not loose information)
  if (dol_strlen($decpart) > $nbdecimal) {
    $nbdecimal = dol_strlen($decpart);
  }
 
  // If nbdecimal is higher than max to show
  $nbdecimalmaxshown = (int) str_replace('...', '', getDolGlobalString('MAIN_MAX_DECIMALS_SHOWN'));
  if ($trunc && $nbdecimal > $nbdecimalmaxshown) {
    $nbdecimal = $nbdecimalmaxshown;
    if (preg_match('/\.\.\./i', getDolGlobalString('MAIN_MAX_DECIMALS_SHOWN'))) {
      // If output is truncated, we show ...
      $end = '...';
    }
  }
 
  // If force rounding
  if ((string) $forcerounding != '-1' && (string) $forcerounding != '') {
    if ($forcerounding === 'MU') {
      $nbdecimal = getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT');
    } elseif ($forcerounding === 'MT') {
      $nbdecimal = getDolGlobalInt('MAIN_MAX_DECIMALS_TOT');
    } elseif ($forcerounding >= 0) {
      $nbdecimal = (int) $forcerounding;
    }
  }
 
  // Format number
  $output = number_format((float) $amount, $nbdecimal, $dec, $thousand);
  // Add symbol of currency if requested
  $cursymbolbefore = $cursymbolafter = '';
  if ($currency_code && is_object($outlangs)) {
    if ($currency_code == 'auto') {
      $currency_code = $conf->currency;
    }
 
    $listofcurrenciesbefore = array('AUD', 'CAD', 'CNY', 'COP', 'CLP', 'GBP', 'HKD', 'MXN', 'PEN', 'USD', 'CRC', 'ZAR');
    $listoflanguagesbefore = array('nl_NL');
    if (in_array($currency_code, $listofcurrenciesbefore) || in_array($outlangs->defaultlang, $listoflanguagesbefore)) {
      $cursymbolbefore .= $outlangs->getCurrencySymbol($currency_code);
    } else {
      $tmpcur = $outlangs->getCurrencySymbol($currency_code);
      $cursymbolafter .= ($tmpcur == $currency_code ? ' ' . $tmpcur : $tmpcur);
    }
  }
  if ($form) {
    $output = preg_replace('/\s/', '&nbsp;', $output);
    $output = $cursymbolbefore . $output . $end . ($cursymbolafter ? ' <span class="small">'.$cursymbolafter.'</span>' : '');
    $output = preg_replace('/\'/', '&#039;', $output);
  } else {
    $output = $cursymbolbefore . $output . $end . ($cursymbolafter ? ' '.$cursymbolafter : '');
  }
 
  return $output;
}
 
function price2num($amount, $rounding = '', $option = 0)
{
  global $langs;
 
  // Clean parameters
  if (is_null($amount)) {
    $amount = '';
  }
 
  // Round PHP function does not allow number like '1,234.56' nor '1.234,56' nor '1 234,56'
  // Numbers must be '1234.56'
  // Decimal delimiter for PHP and database SQL requests must be '.'
  $dec = ',';
  $thousand = ' ';
  if (is_null($langs)) {  // $langs is not defined, we use english values.
    $dec = '.';
    $thousand = ',';
  } else {
    if ($langs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
      $dec = $langs->transnoentitiesnoconv("SeparatorDecimal");
    }
    if ($langs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
      $thousand = $langs->transnoentitiesnoconv("SeparatorThousand");
    }
  }
  if ($thousand == 'None') {
    $thousand = '';
  } elseif ($thousand == 'Space') {
    $thousand = ' ';
  }
  //print "amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
 
  // Convert value to universal number format (no thousand separator, '.' as decimal separator)
  if ($option != 1) { // If not a PHP number or unknown, we change or clean format
    //print "\n".'PP'.$amount.' - '.$dec.' - '.$thousand.' - '.intval($amount).'<br>';
    if (!is_numeric($amount)) {
      $amount = preg_replace('/[a-zA-Z\/\\\*\‍(\‍)<>\_]/', '', $amount);
    }
 
    if ($option == 2 && $thousand == '.' && preg_match('/\.(\d\d\d)$/', (string) $amount)) {  // It means the . is used as a thousand separator and string come from input data, so 1.123 is 1123
      $amount = str_replace($thousand, '', $amount);
    }
 
    // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
    // to format defined by LC_NUMERIC after a calculation and we want source format to be like defined by Dolibarr setup.
    // So if number was already a good number, it is converted into local Dolibarr setup.
    if (is_numeric($amount)) {
      // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
      $temps = sprintf("%10.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
      $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
      $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
      $amount = number_format($amount, $nbofdec, $dec, $thousand);
    }
    //print "QQ".$amount."<br>\n";
 
    // Now make replaceents (the main goal of function)
 
    if ($thousand != ',' && $thousand != '.') {
      // Accept the two types of decimal points french users (i.e., using ' ' for thousands)
 
      // REGEX: Find the integral and decimal parts.
      //
      // We require that the decimal point only appears once in $amount.
      // The regex `/^(?<int>[^,]*,|[^.]*\.)(?<dec>[^.,]*)$/u` can be broken down as follows:
      // - `(?<int>[^,]*,|[^.]*\.)` is any accepted sequence up to the last potential decimal point '.' or ',' and named `int`.
      //   It covers two cases:
      //   - `[^,]*,`: Any sequence of characters that is not ',' with ',' accepted as the decimal point (from start of string because of earlier `^`);
      //   - `[^.]*\.`: Any sequence of characters that is not a '.' with '.' accepted as the decimal point (from start of string.
      // - `(?<dec>[^.,]*)`: The sequence after the character accepted as the decimal point, not including it.
      $matches = array();
      if (preg_match('/^(?<int>[^,]*,|[^.]*\.)(?<dec>[^.,]*)$/u', $amount, $matches)) {
        $intPart = $matches['int'];
        $decPart = $matches['dec'];
 
        // Remove all commas and dots from intPart
        $intPart = str_replace(['.', ','], '', $intPart);
 
        // Combine intPart and decPart with a dot
        $amount = $intPart . $dec . $decPart;
      }
    }
 
    $amount = str_replace(' ', '', $amount); // To avoid spaces
    $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
    $amount = str_replace($dec, '.', $amount);
 
    $amount = preg_replace('/[^0-9\-\.]/', '', $amount);  // Clean non numeric chars (so it clean some UTF8 spaces for example.
  }
  //print ' XX'.$amount.' '.$rounding;
 
  // Now, $amount is a real PHP float number. We make a rounding if required.
  if ($rounding) {
    $nbofdectoround = '';
    if ($rounding == 'MU') {
      $nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT');  // usually 5
    } elseif ($rounding == 'MT') {
      $nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_TOT');   // usually 2 or 3
    } elseif ($rounding == 'MS') {
      $nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_STOCK', 5);
    } elseif ($rounding == 'CU') {
      $nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_CURRENCY_UNIT', getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT'));  // TODO Use param of currency
    } elseif ($rounding == 'CT') {
      $nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_CURRENCY_TOT', getDolGlobalInt('MAIN_MAX_DECIMALS_TOT'));    // TODO Use param of currency
    } elseif (is_numeric($rounding)) {
      $nbofdectoround = (int) $rounding;
    }
 
    //print " RR".$amount.' - '.$nbofdectoround.'<br>';
    if (dol_strlen($nbofdectoround)) {
      $amount = round(is_string($amount) ? (float) $amount : $amount, $nbofdectoround); // $nbofdectoround can be 0.
    } else {
      return 'ErrorBadParameterProvidedToFunction';
    }
    //print ' SS'.$amount.' - '.$nbofdec.' - '.$dec.' - '.$thousand.' - '.$nbofdectoround.'<br>';
 
    // Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
    // to format defined by LC_NUMERIC after a calculation and we want source format to be defined by Dolibarr setup.
    if (is_numeric($amount)) {
      // We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
      $temps = sprintf("%10.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
      $temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
      $nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
      $amount = number_format($amount, min($nbofdec, $nbofdectoround), $dec, $thousand); // Convert amount to format with dolibarr dec and thousand
    }
    //print "TT".$amount.'<br>';
 
    // Always make replace because each math function (like round) replace
    // with local values and we want a number that has a SQL string format x.y
    if ($thousand != ',' && $thousand != '.') {
      $amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
    }
 
    $amount = str_replace(' ', '', $amount); // To avoid spaces
    $amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
    $amount = str_replace($dec, '.', $amount);
 
    $amount = preg_replace('/[^0-9\-\.]/', '', $amount);  // Clean non numeric chars (so it clean some UTF8 spaces for example.
  }
 
  return $amount;
}
 
 
function get_localtax($vatrate, $local, $thirdparty_buyer = null, $thirdparty_seller = null, $vatnpr = 0)
{
  global $db, $conf, $mysoc;
 
  if (empty($thirdparty_seller) || !is_object($thirdparty_seller)) {
    $thirdparty_seller = $mysoc;
  }
 
  dol_syslog(
    "get_localtax tva=" . $vatrate . " local=" . $local
    ." thirdparty_buyer id=" . (is_object($thirdparty_buyer) ? $thirdparty_buyer->id : '') . "/country_code=" . (is_object($thirdparty_buyer) ? $thirdparty_buyer->country_code : '')
    ." thirdparty_seller id=" . $thirdparty_seller->id . "/country_code=" . $thirdparty_seller->country_code
    ." thirdparty_seller localtax1_assuj=" . $thirdparty_seller->localtax1_assuj . "  thirdparty_seller localtax2_assuj=" . $thirdparty_seller->localtax2_assuj
  );
 
  $vatratecleaned = $vatrate;
  $reg = array();
  if (preg_match('/^(.*)\s*\‍((.*)\‍)$/', (string) $vatrate, $reg)) {     // If vat is "xx (yy)"
    $vatratecleaned = trim($reg[1]);
    $vatratecode = $reg[2];
  }
 
  /*if ($thirdparty_buyer->country_code != $thirdparty_seller->country_code)
  {
    return 0;
  }*/
 
  // Some test to guess with no need to make database access
  if ($mysoc->country_code == 'ES') { // For spain localtaxes 1 and 2, tax is qualified if buyer use local tax
    if ($local == 1) {
      if (!$mysoc->localtax1_assuj || (string) $vatratecleaned == "0") {
        return 0;
      }
      if ($thirdparty_seller->id == $mysoc->id) {
        if (!$thirdparty_buyer->localtax1_assuj) {
          return 0;
        }
      } else {
        if (!$thirdparty_seller->localtax1_assuj) {
          return 0;
        }
      }
    }
 
    if ($local == 2) {
      //if (! $mysoc->localtax2_assuj || (string) $vatratecleaned == "0") return 0;
      if (!$mysoc->localtax2_assuj) {
        return 0; // If main vat is 0, IRPF may be different than 0.
      }
      if ($thirdparty_seller->id == $mysoc->id) {
        if (!$thirdparty_buyer->localtax2_assuj) {
          return 0;
        }
      } else {
        if (!$thirdparty_seller->localtax2_assuj) {
          return 0;
        }
      }
    }
  } else {
    if ($local == 1 && !$thirdparty_seller->localtax1_assuj) {
      return 0;
    }
    if ($local == 2 && !$thirdparty_seller->localtax2_assuj) {
      return 0;
    }
  }
 
  // For some country MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY is forced to on.
  if (in_array($mysoc->country_code, array('ES'))) {
    $conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY = 1;
  }
 
  // Search local taxes
  if (getDolGlobalString('MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY')) {
    if ($local == 1) {
      if ($thirdparty_seller != $mysoc) {
        if (!isOnlyOneLocalTax($local)) {  // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
          return $thirdparty_seller->localtax1_value;
        }
      } else { // i am the seller
        if (!isOnlyOneLocalTax($local)) { // TODO If seller is me, why not always returning this, even if there is only one locatax vat.
          return getDolGlobalString('MAIN_INFO_VALUE_LOCALTAX1');
        }
      }
    }
    if ($local == 2) {
      if ($thirdparty_seller != $mysoc) {
        if (!isOnlyOneLocalTax($local)) {  // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
          // TODO We should also return value defined on thirdparty only if defined
          return $thirdparty_seller->localtax2_value;
        }
      } else { // i am the seller
        if (in_array($mysoc->country_code, array('ES'))) {
          return $thirdparty_buyer->localtax2_value;
        } else {
          return getDolGlobalString('MAIN_INFO_VALUE_LOCALTAX2');
        }
      }
    }
  }
 
  // By default, search value of local tax on line of common tax
  $sql = "SELECT t.localtax1, t.localtax2, t.localtax1_type, t.localtax2_type";
  $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t, " . MAIN_DB_PREFIX . "c_country as c";
  $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '" . $db->escape($thirdparty_seller->country_code) . "'";
  $sql .= " AND t.taux = " . ((float) $vatratecleaned) . " AND t.active = 1";
  $sql .= " AND t.entity IN (" . getEntity('c_tva') . ")";
  if (!empty($vatratecode)) {
    $sql .= " AND t.code ='" . $db->escape($vatratecode) . "'"; // If we have the code, we use it in priority
  } else {
    $sql .= " AND t.recuperableonly = '" . $db->escape((string) $vatnpr) . "'";
  }
 
  $resql = $db->query($sql);
 
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($obj) {
      if ($local == 1) {
        return $obj->localtax1;
      } elseif ($local == 2) {
        return $obj->localtax2;
      }
    }
  }
 
  return 0;
}
 
 
function isOnlyOneLocalTax($local)
{
  $tax = get_localtax_by_third($local);
 
  $valors = explode(":", $tax);
 
  if (count($valors) > 1) {
    return false;
  } else {
    return true;
  }
}
 
function get_localtax_by_third($local)
{
  global $db, $mysoc;
 
  $sql  = " SELECT t.localtax" . ((int) $local) . " as localtax";
  $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t INNER JOIN " . MAIN_DB_PREFIX . "c_country as c ON c.rowid = t.fk_pays";
  $sql .= " WHERE c.code = '" . $db->escape($mysoc->country_code) . "' AND t.active = 1 AND t.entity IN (" . getEntity('c_tva') . ") AND t.taux = (";
  $sql .= "SELECT MAX(tt.taux) FROM " . MAIN_DB_PREFIX . "c_tva as tt INNER JOIN " . MAIN_DB_PREFIX . "c_country as c ON c.rowid = tt.fk_pays";
  $sql .= " WHERE c.code = '" . $db->escape($mysoc->country_code) . "' AND t.entity IN (" . getEntity('c_tva') . ") AND tt.active = 1)";
  $sql .= " AND t.localtax" . ((int) $local) . "_type <> '0'";
  $sql .= " ORDER BY t.rowid DESC";
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($obj) {
      return $obj->localtax;
    } else {
      return '0';
    }
  }
 
  return 'Error';
}
 
 
function getTaxesFromId($vatrate, $buyer = null, $seller = null, $firstparamisid = 1)
{
  global $db;
 
  dol_syslog("getTaxesFromId vat id or rate = " . $vatrate);
 
  // Search local taxes
  $sql = "SELECT t.rowid, t.code, t.taux as rate, t.recuperableonly as npr, t.accountancy_code_sell, t.accountancy_code_buy,";
  $sql .= " t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type";
  $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t";
  if ($firstparamisid) {
    $sql .= " WHERE t.rowid = " . (int) $vatrate;
  } else {
    $vatratecleaned = $vatrate;
    $vatratecode = '';
    $reg = array();
    if (preg_match('/^(.*)\s*\‍((.*)\‍)$/', $vatrate, $reg)) {      // If vat is "xx (yy)"
      $vatratecleaned = $reg[1];
      $vatratecode = $reg[2];
    }
 
    $sql .= ", " . MAIN_DB_PREFIX . "c_country as c";
    /*if ($mysoc->country_code == 'ES') $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'";    // vat in spain use the buyer country ??
    else $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";*/
    $sql .= " WHERE t.fk_pays = c.rowid";
    if (getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')) {
      $sql .= " AND c.code = '" . $db->escape($buyer->country_code) . "'";
    } else {
      $sql .= " AND c.code = '" . $db->escape($seller->country_code) . "'";
    }
    $sql .= " AND t.taux = " . ((float) $vatratecleaned) . " AND t.active = 1";
    $sql .= " AND t.entity IN (" . getEntity('c_tva') . ")";
    if ($vatratecode) {
      $sql .= " AND t.code = '" . $db->escape($vatratecode) . "'";
    }
  }
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($obj) {
      return array(
        'rowid' => $obj->rowid,
        'code' => $obj->code,
        'rate' => $obj->rate,
        'localtax1' => $obj->localtax1,
        'localtax1_type' => $obj->localtax1_type,
        'localtax2' => $obj->localtax2,
        'localtax2_type' => $obj->localtax2_type,
        'npr' => $obj->npr,
        'accountancy_code_sell' => $obj->accountancy_code_sell,
        'accountancy_code_buy' => $obj->accountancy_code_buy
      );
    } else {
      return array();
    }
  } else {
    dol_print_error($db);
  }
 
  return array();
}
 
function getLocalTaxesFromRate($vatrate, $local, $buyer, $seller, $firstparamisid = 0)
{
  global $db, $mysoc;
 
  dol_syslog("getLocalTaxesFromRate vatrate=" . $vatrate . " local=" . $local);
 
  // Search local taxes
  $sql  = "SELECT t.taux as rate, t.code, t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type, t.accountancy_code_sell, t.accountancy_code_buy";
  $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t";
  if ($firstparamisid) {
    $sql .= " WHERE t.rowid = " . (int) $vatrate;
  } else {
    $vatratecleaned = $vatrate;
    $vatratecode = '';
    $reg = array();
    if (preg_match('/^(.*)\s*\‍((.*)\‍)$/', $vatrate, $reg)) {     // If vat is "x.x (yy)"
      $vatratecleaned = $reg[1];
      $vatratecode = $reg[2];
    }
 
    $sql .= ", " . MAIN_DB_PREFIX . "c_country as c";
    if (!empty($mysoc) && $mysoc->country_code == 'ES') {
      $countrycodetouse = ((empty($buyer) || empty($buyer->country_code)) ? $mysoc->country_code : $buyer->country_code);
      $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '" . $db->escape($countrycodetouse) . "'"; // local tax in spain use the buyer country ??
    } else {
      $countrycodetouse = ((empty($seller) || empty($seller->country_code)) ? $mysoc->country_code : $seller->country_code);
      $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '" . $db->escape($countrycodetouse) . "'";
    }
    $sql .= " AND t.taux = " . ((float) $vatratecleaned) . " AND t.active = 1";
    if ($vatratecode) {
      $sql .= " AND t.code = '" . $db->escape($vatratecode) . "'";
    }
  }
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
 
    if ($obj) {
      $vateratestring = $obj->rate . ($obj->code ? ' (' . $obj->code . ')' : '');
 
      if ($local == 1) {
        return array($obj->localtax1_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
      } elseif ($local == 2) {
        return array($obj->localtax2_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
      } else {
        return array($obj->localtax1_type, get_localtax($vateratestring, 1, $buyer, $seller), $obj->localtax2_type, get_localtax($vateratestring, 2, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
      }
    }
  }
 
  return array();
}
 
function get_product_vat_for_country($idprod, $thirdpartytouseforcountry, $idprodfournprice = 0)
{
  global $db, $mysoc;
 
  require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
  $ret = 0;
  $found = 0;
 
  if ($idprod > 0) {
    // Load product
    $product = new Product($db);
    $product->fetch($idprod);
 
    if (($mysoc->country_code == $thirdpartytouseforcountry->country_code)
      || (in_array($mysoc->country_code, array('FR', 'MC')) && in_array($thirdpartytouseforcountry->country_code, array('FR', 'MC')))
      || (in_array($mysoc->country_code, array('MQ', 'GP')) && in_array($thirdpartytouseforcountry->country_code, array('MQ', 'GP')))
    ) {
      // If country of thirdparty to consider is ours
      if ($idprodfournprice > 0) {     // We want vat for product for a "supplier" object
        $result = $product->get_buyprice($idprodfournprice, 0, 0, '');
        if ($result > 0) {
          $ret = $product->vatrate_supplier;
          if ($product->default_vat_code_supplier) {
            $ret .= ' (' . $product->default_vat_code_supplier . ')';
          }
          $found = 1;
        }
      }
      if (!$found) {
        $ret = $product->tva_tx;  // Default sales vat of product
        if ($product->default_vat_code) {
          $ret .= ' (' . $product->default_vat_code . ')';
        }
        $found = 1;
      }
    } else {
      // TODO Read default product vat according to product and an other countrycode.
      // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
    }
  }
 
  if (!$found) {
    if (!getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS')) {
      // If vat of product for the country not found or not defined, we return the first rate found (sorting on use_default, then on higher vat of country).
      $sql = "SELECT t.taux as vat_rate, t.code as default_vat_code";
      $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t, " . MAIN_DB_PREFIX . "c_country as c";
      $sql .= " WHERE t.active = 1 AND t.fk_pays = c.rowid AND c.code = '" . $db->escape($thirdpartytouseforcountry->country_code) . "'";
      $sql .= " AND t.entity IN (" . getEntity('c_tva') . ")";
      $sql .= " ORDER BY t.use_default DESC, t.taux DESC, t.code ASC, t.recuperableonly ASC";
      $sql .= $db->plimit(1);
 
      $resql = $db->query($sql);
      if ($resql) {
        $obj = $db->fetch_object($resql);
        if ($obj) {
          $ret = $obj->vat_rate;
          if ($obj->default_vat_code) {
            $ret .= ' (' . $obj->default_vat_code . ')';
          }
        }
        $db->free($resql);
      } else {
        dol_print_error($db);
      }
    } else {
      // Forced value if autodetect fails. MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS can be
      // '1.23'
      // or '1.23 (CODE)'
      $defaulttx = '';
      if (getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS') != 'none') {
        $defaulttx = getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS');
      }
      /*if (preg_match('/\‍((.*)\‍)/', $defaulttx, $reg)) {
        $defaultcode = $reg[1];
        $defaulttx = preg_replace('/\s*\‍(.*\‍)/', '', $defaulttx);
      }*/
 
      $ret = $defaulttx;
    }
  }
 
  dol_syslog("get_product_vat_for_country: ret=" . $ret);
 
  return $ret;
}
 
function get_product_localtax_for_country($idprod, $local, $thirdpartytouseforcountry)
{
  global $db, $mysoc;
 
  if (!class_exists('Product')) {
    require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
  }
 
  $ret = 0;
  $found = 0;
 
  if ($idprod > 0) {
    // Load product
    $product = new Product($db);
    $result = $product->fetch($idprod);
 
    if ($mysoc->country_code == $thirdpartytouseforcountry->country_code) { // If selling country is ours
      /* Not defined yet, so we don't use this
      if ($local==1) $ret=$product->localtax1_tx;
      elseif ($local==2) $ret=$product->localtax2_tx;
      $found=1;
      */
    } else {
      // TODO Read default product vat according to product and another countrycode.
      // Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
    }
  }
 
  if (!$found) {
    // If vat of product for the country not found or not defined, we return higher vat of country.
    $sql = "SELECT taux as vat_rate, localtax1, localtax2";
    $sql .= " FROM " . MAIN_DB_PREFIX . "c_tva as t, " . MAIN_DB_PREFIX . "c_country as c";
    $sql .= " WHERE t.active=1 AND t.fk_pays = c.rowid AND c.code='" . $db->escape($thirdpartytouseforcountry->country_code) . "'";
    $sql .= " AND t.entity IN (" . getEntity('c_tva') . ")";
    $sql .= " ORDER BY t.taux DESC, t.recuperableonly ASC";
    $sql .= $db->plimit(1);
 
    $resql = $db->query($sql);
    if ($resql) {
      $obj = $db->fetch_object($resql);
      if ($obj) {
        if ($local == 1) {
          $ret = $obj->localtax1;
        } elseif ($local == 2) {
          $ret = $obj->localtax2;
        }
      }
    } else {
      dol_print_error($db);
    }
  }
 
  dol_syslog("get_product_localtax_for_country: ret=" . $ret);
  return $ret;
}
 
function get_default_tva(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
{
  global $mysoc, $db, $hookmanager;
 
  require_once DOL_DOCUMENT_ROOT . '/core/lib/company.lib.php';
 
  // Note: possible values for tva_assuj are 0/1 or franchise/reel
  $seller_use_vat = ((is_numeric($thirdparty_seller->tva_assuj) && !$thirdparty_seller->tva_assuj) || (!is_numeric($thirdparty_seller->tva_assuj) && $thirdparty_seller->tva_assuj == 'franchise')) ? 0 : 1;
 
  if (empty($thirdparty_seller->country_code)) {
    $thirdparty_seller->country_code = $mysoc->country_code;
  }
  $seller_country_code = $thirdparty_seller->country_code;
  $seller_in_cee = isInEEC($thirdparty_seller);
 
  if (empty($thirdparty_buyer->country_code)) {
    $thirdparty_buyer->country_code = $mysoc->country_code;
  }
  $buyer_country_code = $thirdparty_buyer->country_code;
  $buyer_in_cee = isInEEC($thirdparty_buyer);
 
  dol_syslog(
    "get_default_tva: seller use vat=" . $seller_use_vat . ", seller country=" . $seller_country_code . ", seller in cee=" . ((string) (int) $seller_in_cee)
    .", buyer vat number=" . $thirdparty_buyer->tva_intra . " buyer country=" . $buyer_country_code . ", buyer state=" . $thirdparty_buyer->state_id . " buyer in cee=" . ((string) (int) $buyer_in_cee)
    .", idprod=" . $idprod . ", idprodfournprice=" . $idprodfournprice . ", SERVICE_ARE_ECOMMERCE_200238EC=" . getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')
  );
 
  $vatvalue = 0;
  $vatrule = '';
 
  // If services are eServices according to EU Council Directive 2002/38/EC (http://ec.europa.eu/taxation_customs/taxation/vat/traders/e-commerce/article_1610_en.htm)
  // we use the buyer VAT.
  if (getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')) {
    if ($seller_in_cee && $buyer_in_cee) {
      $isacompany = $thirdparty_buyer->isACompany();
      if ($isacompany && !getDolGlobalString('MAIN_USE_VAT_ZERO_FOR_COMPANIES_IN_EEC_EVEN_IF_VAT_ID_UNKNOWN')) {
        require_once DOL_DOCUMENT_ROOT . '/core/lib/functions2.lib.php';
        if (!isValidVATID($thirdparty_buyer)) {
          $isacompany = 0;
        }
      }
 
      if (!$isacompany) {
        $vatvalue = get_product_vat_for_country($idprod, $thirdparty_buyer, $idprodfournprice);
        $vatrule = 'VATRULE 0';
      }
    }
  }
 
  // If seller does not use VAT, default VAT is 0. End of rule.
  if (empty($vatrule) && !$seller_use_vat) {
    //print 'VATRULE 1';
    // TODO get the VAT Code of exemption asked into setup if country isInEEC (from an array list of possible
    // values like VATEX-EU-132-*, VATEX-FR-FRANCHISE, VATEX-EU-AE...
    // When we had recorded it, we also added a corresponding entry into table of vat code if it does not exists yet.
    // Here we test if entry for the VAT exemption code exists in llx_vat, we can return '0 (VATEX-EU-132-xx)'
    // If not, we add it and we return '0 (VATEX-EU-132-xx)'
    $vatvalue = 0;
    $vatrule = 'VATRULE 1';
  }
 
  // 'VATRULE 2' - Force VAT if a buyer department is defined on vat rates dictionary
  if (empty($vatrule) && !empty($thirdparty_buyer->state_id)) {
    $sql = "SELECT d.rowid, t.taux as vat_default_rate, t.code as vat_default_code ";
    $sql .= " FROM " . $db->prefix() . "c_tva as t";
    $sql .= " INNER JOIN " . $db->prefix() . "c_departements as d ON t.fk_department_buyer = d.rowid";
    $sql .= " WHERE d.rowid = " . ((int) $thirdparty_buyer->state_id);
    $sql .= " AND t.active > 0";
    $sql .= " AND t.entity IN (".getEntity('c_tva').")";
    $sql .= " ORDER BY t.use_default DESC, t.taux DESC, t.code ASC, t.recuperableonly ASC";
 
    $res = $db->query($sql);
    if ($res) {
      if ($db->num_rows($res)) {
        $obj = $db->fetch_object($res);
 
        $vatvalue = $obj->vat_default_rate . ' (' . $obj->vat_default_code . ')';
        $vatrule = 'VATRULE 2';
      }
      $db->free($res);
    }
  }
 
  // If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule.
  if (empty($vatrule) && (
    ($seller_country_code == $buyer_country_code)
    || (in_array($seller_country_code, array('FR', 'MC')) && in_array($buyer_country_code, array('FR', 'MC')))
    || (in_array($seller_country_code, array('MQ', 'GP')) && in_array($buyer_country_code, array('MQ', 'GP')))  // We should be able to manage the case of MQ, GP, ... with a deicated vat rate at previous step.
  )) { // Warning ->country_code not always defined
    //print 'VATRULE 3';
    $tmpvat = get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
 
    if ($seller_country_code == 'IN' && getDolGlobalString('MAIN_SALETAX_AUTOSWITCH_I_CS_FOR_INDIA')) {
      // Special case for india.
      //print 'VATRULE 3b';
      $reg = array();
      if (preg_match('/C+S-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id != $thirdparty_buyer->state_id) {
        // we must revert the C+S into I
        $tmpvat = str_replace("C+S", "I", $tmpvat);
      } elseif (preg_match('/I-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id == $thirdparty_buyer->state_id) {
        // we must revert the I into C+S
        $tmpvat = str_replace("I", "C+S", $tmpvat);
      }
    }
 
    $vatvalue = $tmpvat;
    $vatrule = 'VATRULE 3b';
  }
 
  // If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule.
  // 'VATRULE 4' - Not supported
 
  // If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule
  // If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule
  if (empty($vatrule) && ($seller_in_cee && $buyer_in_cee)) {
    $isacompany = $thirdparty_buyer->isACompany();
    if ($isacompany && !getDolGlobalString('MAIN_USE_VAT_ZERO_FOR_COMPANIES_IN_EEC_EVEN_IF_VAT_ID_UNKNOWN')) {
      require_once DOL_DOCUMENT_ROOT . '/core/lib/functions2.lib.php';
      if (!isValidVATID($thirdparty_buyer)) {
        $isacompany = 0;
      }
    }
 
    if (!$isacompany) {
      //print 'VATRULE 5';
      $vatvalue = get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
      $vatrule = 'VATRULE 5';
    } else {
      //print 'VATRULE 6';
      // TODO This is the case of VAT exemption 'VATEX-EU-IC'
      // If entry for the VAT exemption code exists in llx_vat, we can return '0 (VATEX-EU-IC)'
      // If not, we add it and we return '0 (VATEX-EU-IC)'
      $vatvalue = 0;
      $vatrule = 'VATRULE 6';
    }
  }
 
  // If (seller in the European Community and buyer outside the European Community and private buyer) then VAT by default = VAT of the product sold. End of rule
  // I don't see any use case that need this rule, this case is on only if MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC set
  if (empty($vatrule) && getDolGlobalString('MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC') && empty($buyer_in_cee)) {
    $isacompany = $thirdparty_buyer->isACompany();
    if (!$isacompany) {
      $vatvalue = get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
      $vatrule = 'VATRULE extra';
      //print 'VATRULE extra';
    }
  }
 
  // Otherwise the VAT proposed by default=0. End of rule.
  // Rem: This means that at least one of the 2 is outside the European Community and the country differs
  //print 'VATRULE 7';
  // TODO This is the case of VAT exemption 'VATEX-EU-G'
  // If entry for the VAT exemption code exists in llx_vat, we can return '0 (VATEX-xxx)'
  // If not, we add it and we return '0 (VATEX-xxx)'
 
  // Allow an external module to bypass the calculation of prices
  $parameters = array('vatvalue' => $vatvalue, 'vatrule' => $vatrule);
  $tmpobject = null;
  $tmpaction = '';
  // @phan-suppress-next-line PhanPluginConstantVariableNull
  $reshook = $hookmanager->executeHooks('get_default_tva', $parameters, $tmpobject, $tmpaction);  // @phan-suppress-current-line PhanPluginConstantVariableNull
  if ($reshook > 0 && !empty($hookmanager->resArray['vatvalue'])) {
    $vatvalue = $hookmanager->resArray['vatvalue'];
    $vatrule = $hookmanager->resArray['vatrule']; // For information
  }
 
  return $vatvalue;
}
 
 
function get_default_npr(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
{
  global $db;
 
  if ($idprodfournprice > 0) {
    if (!class_exists('ProductFournisseur')) {
      require_once DOL_DOCUMENT_ROOT . '/fourn/class/fournisseur.product.class.php';
    }
    $prodprice = new ProductFournisseur($db);
    $prodprice->fetch_product_fournisseur_price($idprodfournprice);
    return $prodprice->fourn_tva_npr;
  } elseif ($idprod > 0) {
    if (!class_exists('Product')) {
      require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
    }
    $prod = new Product($db);
    $prod->fetch($idprod);
    return $prod->tva_npr;
  }
 
  return 0;
}
 
function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod = 0)
{
  global $mysoc;
 
  if (!is_object($thirdparty_seller)) {
    return -1;
  }
  if (!is_object($thirdparty_buyer)) {
    return -1;
  }
 
  if (empty($thirdparty_seller->country_code)) {
    $thirdparty_seller->country_code = $mysoc->country_code;
  }
  $seller_country_code = $thirdparty_seller->country_code;
  //$seller_in_cee = isInEEC($thirdparty_seller);
 
  if (empty($thirdparty_buyer->country_code)) {
    $thirdparty_buyer->country_code = $mysoc->country_code;
  }
  $buyer_country_code = $thirdparty_buyer->country_code;
  //$buyer_in_cee = isInEEC($thirdparty_buyer);
 
  if ($local == 1) { // Localtax 1
    if ($mysoc->country_code == 'ES') {
      if (is_numeric($thirdparty_buyer->localtax1_assuj) && !$thirdparty_buyer->localtax1_assuj) {
        return 0;
      }
    } else {
      // Si vendeur non assujeti a Localtax1, localtax1 par default=0
      if (is_numeric($thirdparty_seller->localtax1_assuj) && !$thirdparty_seller->localtax1_assuj) {
        return 0;
      }
      if (!is_numeric($thirdparty_seller->localtax1_assuj) && $thirdparty_seller->localtax1_assuj == 'localtax1off') {
        return 0;
      }
    }
  } elseif ($local == 2) { //I Localtax 2
    // Si vendeur non assujeti a Localtax2, localtax2 par default=0
    if (is_numeric($thirdparty_seller->localtax2_assuj) && !$thirdparty_seller->localtax2_assuj) {
      return 0;
    }
    if (!is_numeric($thirdparty_seller->localtax2_assuj) && $thirdparty_seller->localtax2_assuj == 'localtax2off') {
      return 0;
    }
  }
 
  if ($seller_country_code == $buyer_country_code) {
    return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
  }
 
  return 0;
}
 
 
function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = '')
{
  if (empty($modulepart) && is_object($object)) {
    if (!empty($object->module)) {
      $modulepart = $object->module;
    } elseif (!empty($object->element)) {
      $modulepart = $object->element;
    }
  }
 
  $path = '';
 
  // Define $arrayforoldpath that is module path using a hierarchy on more than 1 level.
  $arrayforoldpath = array('cheque' => 2, 'category' => 2, 'supplier_invoice' => 2, 'invoice_supplier' => 2, 'mailing' => 2, 'supplier_payment' => 2);
  if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
    $arrayforoldpath['product'] = 2;
  }
 
  if (empty($level) && array_key_exists($modulepart, $arrayforoldpath)) {
    $level = $arrayforoldpath[$modulepart];
  }
  if (!empty($level) && array_key_exists($modulepart, $arrayforoldpath)) {
    // This part should be removed once all code is using "get_exdir" to forge path, with parameter $object and $modulepart provided.
    if (empty($num) && is_object($object)) {
      $num = ((int) $object->id);
    }
    if (empty($alpha)) {
      $num = preg_replace('/([^0-9])/i', '', $num);
    } else {
      $num = preg_replace('/^.*\-/i', '', $num);
    }
    $num = substr("000" . $num, -$level);
    if ($level == 1) {
      $path = substr($num, 0, 1);
    }
    if ($level == 2) {
      $path = substr($num, 1, 1) . '/' . substr($num, 0, 1);
    }
    if ($level == 3) {
      $path = substr($num, 2, 1) . '/' . substr($num, 1, 1) . '/' . substr($num, 0, 1);
    }
  } else {
    // We will enhance here a common way of forging path for document storage.
    // In a future, we may distribute directories on several levels depending on setup and object.
    // Here, $object->id, $object->ref and $modulepart are required.
    if (in_array($modulepart, array('societe', 'thirdparty')) && $object instanceof Societe) {
      // Special case for thirdparty, where the ref is a company name that is not unique so path on disk is using the ID instead of the ref
      $path = dol_sanitizeFileName((string) $object->id);
    } else {
      $path = dol_sanitizeFileName(empty($object->ref) ? (string) ((is_object($object) && property_exists($object, 'id')) ? ((int) $object->id) : '') : $object->ref);
    }
  }
 
  if (empty($withoutslash) && !empty($path)) {
    $path .= '/';
  }
 
  return $path;
}
 
function dol_mkdir($dir, $dataroot = '', $newmask = '')
{
  dol_syslog("functions.lib::dol_mkdir: dir=" . $dir, LOG_INFO);
 
  $dir = dol_sanitizePathName($dir, '_', 0);
 
  $dir_osencoded = dol_osencode($dir);
  if (@is_dir($dir_osencoded)) {
    return 0;
  }
 
  $nberr = 0;
  $nbcreated = 0;
 
  $ccdir = '';
  if (!empty($dataroot)) {
    // Remove data root from loop
    $dir = str_replace($dataroot . '/', '', $dir);
    $ccdir = $dataroot . '/';
  }
 
  $cdir = explode("/", $dir);
  $num = count($cdir);
  for ($i = 0; $i < $num; $i++) {
    if ($i > 0) {
      $ccdir .= '/' . $cdir[$i];
    } else {
      $ccdir .= $cdir[$i];
    }
    $regs = array();
    if (preg_match("/^.:$/", $ccdir, $regs)) {
      continue; // If the Windows path is incomplete, continue with next directory
    }
 
    // Attention, is_dir() can fail event if the directory exists
    // (i.e. according the open_basedir configuration)
    if ($ccdir) {
      $ccdir_osencoded = dol_osencode($ccdir);
      if (!@is_dir($ccdir_osencoded)) {
        dol_syslog("functions.lib::dol_mkdir: Directory '" . $ccdir . "' is not found (does not exists or is outside open_basedir PHP setting).", LOG_DEBUG);
 
        umask(0);
        $dirmaskdec = octdec((string) $newmask);
        if (empty($newmask)) {
          $dirmaskdec = octdec(getDolGlobalString('MAIN_UMASK', '0755'));
        }
        $dirmaskdec |= octdec('0111'); // Set x bit required for directories
        if (!@mkdir($ccdir_osencoded, $dirmaskdec)) {
          // If the is_dir has returned a false information, we arrive here
          dol_syslog("functions.lib::dol_mkdir: Fails to create directory '" . $ccdir . "' (no permission to write into parent or directory already exists).", LOG_WARNING);
          $nberr++;
        } else {
          dol_syslog("functions.lib::dol_mkdir: Directory '" . $ccdir . "' created", LOG_DEBUG);
          $nberr = 0; // At this point in the code, the previous failures can be ignored -> set $nberr to 0
          $nbcreated++;
        }
      } else {
        $nberr = 0; // At this point in the code, the previous failures can be ignored -> set $nberr to 0
      }
    }
  }
  return ($nberr ? -$nberr : $nbcreated);
}
 
 
function dolChmod($filepath, $newmask = '')
{
  if (!empty($newmask)) {
    @chmod($filepath, octdec($newmask));
  } elseif (getDolGlobalString('MAIN_UMASK')) {
    @chmod($filepath, octdec(getDolGlobalString('MAIN_UMASK')));
  }
}
 
 
function picto_required()
{
  return '<span class="fieldrequired">*</span>';
}
 
 
function dol_string_nohtmltag($stringtoclean, $removelinefeed = 1, $pagecodeto = 'UTF-8', $strip_tags = 0, $removedoublespaces = 1)
{
  if (is_null($stringtoclean)) {
    return '';
  }
 
  if ($removelinefeed == 2) {
    $stringtoclean = preg_replace('/<br[^>]*>(\n|\r)+/ims', '<br>', $stringtoclean);
  }
  $temp = preg_replace('/<br[^>]*>/i', "\n", $stringtoclean);
 
  // We remove entities BEFORE stripping (in case of an open separator char that is entity encoded and not the closing other, the strip will fails)
  $temp = dol_html_entity_decode($temp, ENT_COMPAT | ENT_HTML5, $pagecodeto);
 
  $temp = str_replace('< ', '__ltspace__', $temp);
  $temp = str_replace('<:', '__lttwopoints__', $temp);
 
  if ($strip_tags) {
    $temp = strip_tags($temp);
  } else {
    // Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
    $pattern = "/<[^<>]+>/";
    // Example of $temp: <a href="/myurl" title="<u>A title</u>">0000-021</a>
    // pass 1 - $temp after pass 1: <a href="/myurl" title="A title">0000-021
    // pass 2 - $temp after pass 2: 0000-021
    $tempbis = $temp;
    do {
      $temp = $tempbis;
      $tempbis = str_replace('<>', '', $temp);  // No reason to have this into a text, except if value is to try bypass the next html cleaning
      $tempbis = preg_replace($pattern, '', $tempbis);
      //$idowhile++; print $temp.'-'.$tempbis."\n"; if ($idowhile > 100) break;
    } while ($tempbis != $temp);
 
    $temp = $tempbis;
 
    // Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
    $temp = preg_replace('/<+([a-z]+)/i', '\1', $temp);
  }
 
  $temp = dol_html_entity_decode($temp, ENT_COMPAT, $pagecodeto);
 
  // Remove also carriage returns
  if ($removelinefeed == 1) {
    $temp = str_replace(array("\r\n", "\r", "\n"), " ", $temp);
  }
 
  // And double spaces
  if ($removedoublespaces) {
    while (strpos($temp, "  ") !== false) {
      $temp = str_replace("  ", " ", $temp);
    }
  }
 
  $temp = str_replace('__ltspace__', '< ', $temp);
  $temp = str_replace('__lttwopoints__', '<:', $temp);
 
  return trim($temp);
}
 
function dol_string_onlythesehtmltags($stringtoclean, $cleanalsosomestyles = 1, $removeclassattribute = 1, $cleanalsojavascript = 0, $allowiframe = 0, $allowed_tags = array(), $allowlink = 0, $allowscript = 0, $allowstyle = 0, $allowphp = 0)
{
  $sav_allowed_tags = $allowed_tags;
 
  if (empty($allowed_tags) || (is_string($allowed_tags) && preg_match('/^common/', $allowed_tags))) {
    $allowed_tags = array(
      // HTML 4
      "html",
      "head",
      "body",
      "article",
      "a",
      "abbr",
      "b",
      "blockquote",
      "br",
      "cite",
      "div",
      "dl",
      "dd",
      "dt",
      "em",
      "font",
      "img",
      "ins",
      "hr",
      "i",
      "li",
      "ol",
      "p",
      "q",
      "s",
      "span",
      "strike",
      "strong",
      "title",
      "table",
      "tr",
      "th",
      "td",
      "u",
      "ul",
      "sup",
      "sub",
      "blockquote",
      "pre",
      "h1",
      "h2",
      "h3",
      "h4",
      "h5",
      "h6",
 
      // HTML 5
      "footer",
      "header",
      "menu",
      "menuitem",
      "nav",
      "section"
    );
  }
  $allowed_tags[] = "comment";    // this tags is added to manage comment <!--...--> that are replaced into <comment>...</comment>
  if ($allowiframe) {
    if (!in_array('iframe', $allowed_tags)) {
      $allowed_tags[] = "iframe";
    }
  }
  if ($allowlink) {
    if (!in_array('link', $allowed_tags)) {
      $allowed_tags[] = "link";
    }
    if (!in_array('meta', $allowed_tags)) {
      $allowed_tags[] = "meta";
    }
  }
  if ($allowscript) {
    if (!in_array('script', $allowed_tags)) {
      $allowed_tags[] = "script";
    }
  }
  if ($allowstyle) {
    if (!in_array('style', $allowed_tags)) {
      $allowed_tags[] = "style";
    }
  }
  if (is_string($sav_allowed_tags)) {
    $tmptags = explode(',', $sav_allowed_tags);
    foreach ($tmptags as $tag) {
      if ($tag != 'common') {
        $allowed_tags[] = $tag;
      }
    }
  }
 
 
  $allowed_tags_string = implode("><", $allowed_tags);
  $allowed_tags_string = '<' . $allowed_tags_string . '>';
 
  $stringtoclean = str_replace('<!DOCTYPE html>', '__!DOCTYPE_HTML__', $stringtoclean); // Replace DOCTYPE to avoid to have it removed by the strip_tags
 
  $stringtoclean = dol_string_nounprintableascii($stringtoclean, 0);
 
  //$stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
  $stringtoclean = preg_replace('/<!--([^>]*)-->/', '<comment>\1</comment>', $stringtoclean);
 
  if ($allowphp) {
    $allowed_tags[] = "commentphp";
    $stringtoclean = preg_replace('/^<\?php([^"]+)\?>$/i', '<commentphp>\1__</commentphp>', $stringtoclean);    // Note: <?php ... > is allowed only if on the same line
    $stringtoclean = preg_replace('/"<\?php([^"]+)\?>"/i', '"<commentphp>\1</commentphp>"', $stringtoclean);    // Note: "<?php ... >" is allowed only if on the same line
  }
 
  $stringtoclean = preg_replace('/&colon;/i', ':', $stringtoclean);
  $stringtoclean = preg_replace('/&#58;|&#0+58|&#x3A/i', '', $stringtoclean); // refused string ':' encoded (no reason to have a : encoded like this) to disable 'javascript:...'
 
  // Remove all HTML tags
  $temp = strip_tags($stringtoclean, $allowed_tags_string); // Warning: This remove also undesired </>, so may changes string obfuscated with </> that pass the injection detection into a harmfull string
 
  if ($cleanalsosomestyles) {   // Clean for remaining html tags
    //$temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
    $temp = preg_replace('/position\s*:\s*(absolute|fixed)/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
    $temp = preg_replace('/z-index\s*:/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
  }
  if ($removeclassattribute) {  // Clean for remaining html tags
    $temp = preg_replace('/(<[^>]+)\s+class=((["\']).*?\\3|\\w*)/i', '\\1', $temp);
  }
 
  // Remove 'javascript:' that we should not find into a text
  // Warning: This is not reliable to fight against obfuscated javascript, there is a lot of other solution to include js into a common html tag (only filtered by a GETPOST(.., powerfullfilter)).
  if ($cleanalsojavascript) {
    $temp = preg_replace('/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t\s*:/i', '', $temp);
  }
 
  $temp = str_replace('__!DOCTYPE_HTML__', '<!DOCTYPE html>', $temp); // Restore the DOCTYPE
 
  if ($allowphp) {
    $temp = preg_replace('/<commentphp>(.*)<\/commentphp>/', '<?php\1?>', $temp); // Restore php code
  }
 
  $temp = preg_replace('/<comment>([^>]*)<\/comment>/', '<!--\1-->', $temp);  // Restore html comments
 
 
  return $temp;
}
 
 
function dol_string_onlythesehtmlattributes($stringtoclean, $allowed_attributes = null, $ishtml = null)
{
  if (is_null($allowed_attributes)) {
    $allowed_attributes = array(
      // HTML 4
      "allow",
      "allowfullscreen",
      "alt",
      "async",
      "class",
      "contenteditable",
      "crossorigin",
      "data-html",
      "frameborder",
      "height",
      "href",
      "id",
      "name",
      "property",
      "rel",
      "src",
      "style",
      "target",
      "title",
      "type",
      "width",
 
      // HTML5
      "footer",
      "header",
      "menu",
      "menuitem",
      "nav",
      "section"
    );
  }
  // Always add content and http-equiv for meta tags, required to force encoding and keep html content in utf8 by load/saveHTML functions.
  if (!in_array("content", $allowed_attributes)) {
    $allowed_attributes[] = "content";
  }
  if (!in_array("http-equiv", $allowed_attributes)) {
    $allowed_attributes[] = "http-equiv";
  }
 
  if (class_exists('DOMDocument') && !empty($stringtoclean)) {
    if ($ishtml === 0) {
      $stringtoclean = str_replace('&', '__AMPINTEXT__', $stringtoclean); // Restore & char not entity
    }
 
    // Warning: loadHTML does not support HTML5 on old libxml versions.
    $dom = new DOMDocument('', 'UTF-8');
    // If $stringtoclean is wrong, it will generates warnings. So we disable warnings and restore them later.
    $savwarning = error_reporting();
    error_reporting(E_ALL & ~E_WARNING & ~E_NOTICE);
    $wrapperId = "dol_string_onlythesehtmlattributes___wrapper";
    $dom->loadHTML('<?xml encoding="UTF-8"><div id="' . $wrapperId . '">' . $stringtoclean . '</div>', LIBXML_HTML_NODEFDTD | LIBXML_ERR_NONE | LIBXML_HTML_NOIMPLIED | LIBXML_NONET | LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NOXMLDECL);
    error_reporting($savwarning);
 
    if ($dom instanceof DOMDocument) {
      for ($els = $dom->getElementsByTagname('*'), $i = $els->length - 1; $i >= 0; $i--) {
        $el = $els->item($i);
        if (!$el instanceof DOMElement) {
          continue;
        }
        $attrs = $el->attributes;
        for ($ii = $attrs->length - 1; $ii >= 0; $ii--) {
          //var_dump($attrs->item($ii));
          if (!empty($attrs->item($ii)->name)) {
            if (! in_array($attrs->item($ii)->name, $allowed_attributes)) {
              // Delete attribute if not into allowed_attributes  @phan-suppress-next-line PhanUndeclaredMethod
              $els->item($i)->removeAttribute($attrs->item($ii)->name);
            } elseif (in_array($attrs->item($ii)->name, array('style'))) {
              // If attribute is 'style'
              $valuetoclean = $attrs->item($ii)->value;
 
              if (isset($valuetoclean)) {
                do {
                  $oldvaluetoclean = $valuetoclean;
                  $valuetoclean = preg_replace('/\/\*.*\*\//m', '', $valuetoclean); // clean css comments
                  $valuetoclean = preg_replace('/position\s*:\s*[a-z]+/mi', '', $valuetoclean);
                  if ($els->item($i)->tagName == 'a') { // more paranoiac cleaning for clickable tags.
                    $valuetoclean = preg_replace('/display\s*:/mi', '', $valuetoclean);
                    $valuetoclean = preg_replace('/z-index\s*:/mi', '', $valuetoclean);
                    $valuetoclean = preg_replace('/\s+(top|left|right|bottom)\s*:/mi', '', $valuetoclean);
                  }
 
                  // We do not allow logout|passwordforgotten.php and action= into the content of a "style" tag
                  $valuetoclean = preg_replace('/(logout|passwordforgotten)\.php/mi', '', $valuetoclean);
                  $valuetoclean = preg_replace('/action=/mi', '', $valuetoclean);
                } while ($oldvaluetoclean != $valuetoclean);
              }
 
              $attrs->item($ii)->value = $valuetoclean;
            }
          }
        }
      }
    }
 
    $dom->encoding = 'UTF-8';
    $wrapper = $dom->getElementById($wrapperId);
    $return = '';
    foreach ($wrapper->childNodes as $child) {
      $return .= $dom->saveHTML($child);
    }
 
    if ($ishtml === 0) {
      $return = str_replace('__AMPINTEXT__', '&', $return); // Restore & char not entity
    }
 
    return trim($return);
  } else {
    return $stringtoclean;
  }
}
 
function dol_string_neverthesehtmltags($stringtoclean, $disallowed_tags = array('textarea'), $cleanalsosomestyles = 0)
{
  $temp = $stringtoclean;
  foreach ($disallowed_tags as $tagtoremove) {
    $temp = preg_replace('/<\/?' . $tagtoremove . '>/', '', $temp);
    $temp = preg_replace('/<\/?' . $tagtoremove . '\s+[^>]*>/', '', $temp);
  }
 
  if ($cleanalsosomestyles) {
    $temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/', '', $temp); // Note: If hacker try to introduce css comment into string to avoid this, string should be encoded by the dol_htmlentitiesbr so be harmless
  }
 
  return $temp;
}
 
 
function dolCloseUnclosedHtmlTags($text)
{
  if (!is_string($text) || $text === '') {
    return $text;
  }
 
  // Tags that never carry a closing tag
  $selfclosing = array('br', 'hr', 'img', 'input', 'meta', 'link', 'source', 'col', 'area', 'base', 'embed', 'param', 'track', 'wbr');
 
  $opened = array();
  if (preg_match_all('/<\s*(\/?)([a-zA-Z][a-zA-Z0-9]*)[^>]*?(\/?)\s*>/', $text, $matches, PREG_SET_ORDER)) {
    foreach ($matches as $match) {
      $tag = strtolower($match[2]);
      if (in_array($tag, $selfclosing) || !empty($match[3])) {
        continue;
      }
      if (empty($match[1])) {
        $opened[] = $tag;
      } else {
        // Close the most recent matching opened tag, ignore a stray closing tag
        $idx = array_search($tag, array_reverse($opened, true), true);
        if ($idx !== false) {
          unset($opened[$idx]);
        }
      }
    }
  }
 
  foreach (array_reverse($opened) as $tag) {
    $text .= '</'.$tag.'>';
  }
 
  return $text;
}
 
function dolGetFirstLineOfText($text, $nboflines = 1, $charset = 'UTF-8')
{
  if ($nboflines == 1) {
    if (dol_textishtml($text)) {
      $firstline = preg_replace('/<br[^>]*>.*$/s', '', $text); // The s pattern modifier means the . can match newline characters
      $firstline = preg_replace('/<div[^>]*>.*$/s', '', $firstline); // The s pattern modifier means the . can match newline characters
    } else {
      if (isset($text)) {
        $firstline = preg_replace('/[\n\r].*/', '', $text);
      } else {
        $firstline = '';
      }
    }
    return $firstline . (isset($firstline) && isset($text) && (strlen($firstline) != strlen($text)) ? '...' : '');
  } else {
    $ishtml = 0;
    if (dol_textishtml($text)) {
      $text = preg_replace('/\n/', '', $text);
      $ishtml = 1;
      $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
    } else {
      $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
    }
 
    $text = strtr($text, $repTable);
    if ($charset == 'UTF-8') {
      $pattern = '/(<br[^>]*>)/Uu';
    } else {
      // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
      $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
    }
    $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
 
    $firstline = '';
    $i = 0;
    $countline = 0;
    $lastaddediscontent = 1;
    while ($countline < $nboflines && isset($a[$i])) {
      if (preg_match('/<br[^>]*>/', $a[$i])) {
        if (array_key_exists($i + 1, $a) && !empty($a[$i + 1])) {
          $firstline .= ($ishtml ? "<br>\n" : "\n");
          // Is it a br for a new line of after a printed line ?
          if (!$lastaddediscontent) {
            $countline++;
          }
          $lastaddediscontent = 0;
        }
      } else {
        $firstline .= $a[$i];
        $lastaddediscontent = 1;
        $countline++;
      }
      $i++;
    }
 
    $adddots = (isset($a[$i]) && (!preg_match('/<br[^>]*>/', $a[$i]) || (array_key_exists($i + 1, $a) && !empty($a[$i + 1]))));
    //unset($a);
    $ret = $firstline . ($adddots ? '...' : '');
    //exit;
    return $ret;
  }
}
 
 
function dol_nl2br($stringtoencode, $nl2brmode = 0, $forxml = false)
{
  if (is_null($stringtoencode)) {
    return '';
  }
 
  if (!$nl2brmode) {
    return nl2br($stringtoencode, $forxml);
  } else {
    $ret = preg_replace('/(\r\n|\r|\n)/i', ($forxml ? '<br />' : '<br>'), $stringtoencode);
    return $ret;
  }
}
 
function dol_htmlwithnojs($stringtoencode, $nouseofiframesandbox = 0, $check = 'restricthtml')
{
  if (empty($nouseofiframesandbox) && getDolGlobalString('MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS')) {
    // TODO using sandbox on inline html content is not possible yet with current browsers
    //$s = '<iframe class="iframewithsandbox" sandbox><html><body>';
    //$s .= $stringtoencode;
    //$s .= '</body></html></iframe>';
    return $stringtoencode;
  } else {
    $out = $stringtoencode;
 
    // First clean HTML content
    do {
      $oldstringtoclean = $out;
 
      $outishtml = 0;
      if (dol_textishtml($out)) {
        $outishtml = 1;
      }
 
      // HTML sanitizer by DOMDocument
      if (!empty($out) && getDolGlobalInt('MAIN_RESTRICTHTML_ONLY_VALID_HTML') && $check != 'restricthtmlallowunvalid') {
        try {
          libxml_use_internal_errors(false);  // Avoid to fill memory with xml errors
          if (LIBXML_VERSION < 20900) {
            // Avoid load of external entities (security problem).
            // Required only if LIBXML_VERSION < 20900
            // @phan-suppress-next-line PhanDeprecatedFunctionInternal
            libxml_disable_entity_loader(true);
          }
 
          $dom = new DOMDocument();
          // Add a trick '<div class="tricktoremove">' to solve pb with text without parent tag
          //  like '<h1>Foo</h1><p>bar</p>' that wrongly ends up, without the trick, with '<h1>Foo<p>bar</p></h1>'
          //  like 'abc' that wrongly ends up, without the trick, with '<p>abc</p>'
          // Add also a trick <html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> to solve utf8 lost.
          // I don't know what the xml encoding is the trick for
 
          if (!$outishtml) {
            $out = preg_replace('/&(?![a-zA-Z0-9#]+;)/', '__AMPINTEXT__', $out);
 
            $out = dol_nl2br($out);
          }
 
          // Note: <a href="https://__[aaa]__/aaa.html"> is transformed into <a href="https://__[aaa]__/aaa.html">
          // We don't want that, so we protect __[xxx]__ by replacing [ and ] before loadHTML and restore them after saveHTML
          $out = preg_replace_callback(
            '/__\[([0-9a-zA-Z_]+)\]__/',
            function ($m) {
              return '__BRACKETSTART' . $m[1] . 'BRACKETEND__';
            },
            $out
          );
          $wrapperId = "dol_htmlwithnojs___wrapper___toremove";
          $dom->loadHTML('<?xml encoding="UTF-8"><div id="' . $wrapperId . '">' . $out . '</div>', LIBXML_HTML_NODEFDTD | LIBXML_ERR_NONE | LIBXML_HTML_NOIMPLIED | LIBXML_NONET | LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NOXMLDECL);
 
          $dom->encoding = 'UTF-8';
 
          // Add a layer to remove some styles
          if (getDolGlobalInt('MAIN_RESTRICTHTML_ONLY_VALID_HTML') == 2) {
            foreach ($dom->getElementsByTagName('*') as $el) {
              if (!$el instanceof DOMElement) {
                continue;
              }
 
              // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
              if ($el->hasAttribute('style')) {
                // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                $style = $el->getAttribute('style');
 
                // delete some styles
                $style = preg_replace('/z-index\s*:/i', '', $style);
                $style = preg_replace('/position\s*:/i', '', $style);
                $style = preg_replace('/top\s*:/i', '', $style);
                $style = preg_replace('/left\s*:/i', '', $style);
                $style = preg_replace('/background\s*:/i', '', $style);
                /*
                $style = preg_replace('/width\s*:/i', '', $style);
                $style = preg_replace('/height\s*:/i', '', $style);
                $style = preg_replace('/backdrop-filter\s*:/i', '', $style);
                */
                if (trim($style) === '') {
                  // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                  $el->removeAttribute('style');
                } else {
                  // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                  $el->setAttribute('style', $style);
                }
              }
            }
          }
 
          $wrapper = $dom->getElementById($wrapperId);
          $result = '';
          foreach ($wrapper->childNodes as $child) {
            $result .= $dom->saveHTML($child);
          }
          $out = trim($result);
 
          // Restore [ and ] that were protected before loadHTML
          $out = preg_replace_callback(
            '/__BRACKETSTART([0-9a-zA-Z_]+)BRACKETEND__/',
            function ($m) {
              return '__[' . $m[1] . ']__';
            },
            $out
          );
 
          if (!$outishtml) {        // If $out was not HTML content we made before a dol_nl2br so we must do the opposite operation now
            $out = str_replace('__AMPINTEXT__', '&', $out); // Restore & char not entity
            $out = preg_replace('/<br\s*\/?>/i', "\n", $out);
          }
        } catch (Exception $e) {
          // If error, invalid HTML string with no way to clean it
          //print $e->getMessage();
          $out = 'InvalidHTMLStringCantBeCleaned ' . $e->getMessage();
        }
      }
 
      // HTML sanitizer by Tidy
      // Tidy can't be used for restricthtmlallowunvalid and restricthtmlallowlinkscript
      // Tidy can't be used for non html text content as it is corrupting the new lines fields.
      if (!empty($out) && getDolGlobalInt('MAIN_RESTRICTHTML_ONLY_VALID_HTML_TIDY') && !in_array($check, array('restricthtmlallowunvalid', 'restricthtmlallowlinkscript')) && $outishtml) {
        // TODO Try to implement a hack for restricthtmlallowlinkscript by renaming tag <link> and <script> ?
        try {
          //var_dump($out);
 
          // Try cleaning using tidy
          if (extension_loaded('tidy') && class_exists("tidy")) {
            //print "aaa".$out."\n";
 
            // See options at https://tidy.sourceforge.net/docs/quickref.html
            $config = array(
              'clean' => false,
              // Best will be to set 'quote-marks' to false to not replace " that are used for real text content (not a string symbol for html attribute) into &quot;
              'quote-marks' => false,
              'doctype'     => 'strict',
              'show-body-only' => true,
              "indent-attributes" => false,
              "vertical-space" => false,
              //'ident' => false,     // Not always supported
              "wrap" => 0,
              'preserve-entities' => true
              // HTML5 tags
              //'new-blocklevel-tags' => 'article aside audio bdi canvas details dialog figcaption figure footer header hgroup main menu menuitem nav section source summary template track video',
              //'new-blocklevel-tags' => 'footer header section menu menuitem'
              //'new-empty-tags' => 'command embed keygen source track wbr',
              //'new-inline-tags' => 'audio command datalist embed keygen mark menuitem meter output progress source time video wbr',
            );
 
            // Tidy
            $locale = setlocale(LC_NUMERIC, '0'); // Tidy has a bug and is changing the PHP locale. So we save it to restore it after.
 
            $tidy = new tidy();
            $out = $tidy->repairString($out, $config, 'utf8');
 
            setlocale(LC_NUMERIC, $locale);     // Restore original local
 
            //print "xxx".$out;exit;
          }
 
          //var_dump($out);
        } catch (Exception $e) {
          // If error, invalid HTML string with no way to clean it
          //print $e->getMessage();
          $out = 'InvalidHTMLStringCantBeCleaned ' . $e->getMessage();
        }
      }
 
      // Clear ZERO WIDTH NO-BREAK SPACE, ZERO WIDTH SPACE, ZERO WIDTH JOINER
      // TODO $out = preg_replace('/[\x{2000}-\x{200D}\x{FEFF}]/u', ' ', $out);
      $out = preg_replace('/[\x{200B}-\x{200D}\x{FEFF}]/u', ' ', $out);
 
      // Clean some html entities that are useless so text is cleaner
      $out = preg_replace('/&(tab|newline);/i', ' ', $out);
 
      // Ckeditor uses the numeric entity for apostrophe, so we force it to
      // the text entity (all other special chars are encoded using text entities) so we can then exclude all numeric entities.
      $out = preg_replace('/&#39;/i', '&apos;', $out);
 
      // We replace chars from a/A to z/Z encoded with numeric HTML entities with the real char so we won't loose the chars at the next step (preg_replace).
      // No need to use a loop here, this step is not to sanitize (this is done at next step, this is to try to save chars, even if they are
      // using a non conventionnal way to be encoded, to not have them sanitized just after)
      if (function_exists('realCharForNumericEntities')) {  // May not exist when main.inc.php not loaded, for example in a CLI context
        $out = preg_replace_callback(
          '/&#(x?[0-9][0-9a-f]+;?)/i',
          static function ($m) {
            return realCharForNumericEntities($m);
          },
          $out
        );
      }
 
      // Now we remove all remaining HTML entities starting with a number. We don't want such entities.
      $out = preg_replace('/&#x?[0-9]+/i', '', $out); // For example if we have j&#x61vascript with an entities without the ; to hide the 'a' of 'javascript'.
 
      // Keep only some html tags and remove also some 'javascript:' strings
      if ($check == 'restricthtmlallowlinkscript') {
        $out = dol_string_onlythesehtmltags($out, 0, 1, 0, 0, array(), 1, 1, 1, getDolGlobalInt("UNSECURED_restricthtmlallowlinkscript_ALLOW_PHP"));
      } elseif ($check == 'restricthtmlallowclass' || $check == 'restricthtmlallowunvalid') {
        $out = dol_string_onlythesehtmltags($out, 0, 0, 1);
      } elseif ($check == 'restricthtmlallowiframe') {
        $out = dol_string_onlythesehtmltags($out, 0, 0, 1, 1);
      } else {
        $out = dol_string_onlythesehtmltags($out, 0, 1, 1);   // styles are allowed to allow rich text editor features of ckeditor managed by the "style=" attribute
      }
 
      // Keep only some html attributes and exclude non expected HTML attributes and clean content of some attributes (keep only alt=, title=...).
      if (getDolGlobalString('MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES')) {
        $out = dol_string_onlythesehtmlattributes($out, null, $outishtml);
      }
 
      // Restore entity &apos; into &#39; (restricthtml is for html content so we can use html entity) because it is
      // compatible with HTML 4 used y CKEditor, and HTML 5 (when &apos; works only with HTML5).
      $out = preg_replace('/&apos;/i', "&#39;", $out);
 
      // Now remove js
      // List of dom events is on https://www.w3schools.com/jsref/dom_obj_event.asp and https://developer.mozilla.org/en-US/docs/Web/Events
      $out = preg_replace('/on(mouse|drag|key|load|touch|pointer|select|transition)[a-z]*\s*=/i', '', $out); // onmousexxx can be set on img or any html tag like <img title='...' onmouseover=alert(1)>
      $out = preg_replace('/on(abort|after|animation|auxclick|before|blur|cancel|canplay|canplaythrough|change|click|close|command|contentvisibility|context|cuechange|copy|cut)[a-z]*\s*=/i', '', $out);
      $out = preg_replace('/on(dblclick|drop|durationchange|emptied|end|ended|error|focus(in|out)?|formdata|gotpointercapture|hashchange|input|invalid)[a-z]*\s*=/i', '', $out);
      $out = preg_replace('/on(lost|offline|online|message|pagehide|pageshow)[a-z]*\s*=/i', '', $out);
      $out = preg_replace('/on(paste|pause|play|playing|progress|ratechange|rejectionn|reset|resize|scroll|search|security|seeked|seeking|show|stalled|start|submit|suspend)[a-z]*\s*=/i', '', $out);
      $out = preg_replace('/on(timeupdate|toggle|unhandled|unload|volumechange|waiting|wheel)[a-z]*\s*=/i', '', $out);
      // More not into the previous list
      $out = preg_replace('/on(repeat|begin|finish|beforeinput)[a-z]*\s*=/i', '', $out);
      // Add also a generic removal of any onxxx= attribute
      $out = preg_replace('/\son[a-z]+\s*=/i', ' ', $out);
    } while ($oldstringtoclean != $out);
 
    // Check the limit of external links that are automatically executed in a Rich text content. We count:
    // '<img' to avoid <img src="http...">,  we can only accept "<img src="data:..."
    // 'url(' to avoid inline style like background: url(http...
    // '<link' to avoid <link href="http...">
    $reg = array();
    $tmpout = preg_replace('/<img src="data:/mi', '<__IMG_SRC_DATA__ src="data:', $out);
    preg_match_all('/(<img|url\‍(|<link)/i', $tmpout, $reg);
    $nblinks = count($reg[0]);
    if ($nblinks > getDolGlobalInt("MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT", 1000)) {
      $out = 'ErrorTooManyLinksIntoHTMLString';
    }
 
    if (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 2 || $check == 'restricthtmlnolink') {
      if ($nblinks > 0) {
        $out = 'ErrorHTMLLinksNotAllowed';
      }
    } elseif (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 1) {
      // Refuse any links except it they are to the wrapper document.php or viewimage.php
      $nblinks = 0;
 
      // Loop on each url in src= and url(
      $pattern = '/src=["\']?(http[^"\']+)|url\‍(["\']?(http[^\‍)]+)/';
 
      global $dolibarr_main_url_root;
 
      $matches = array();
      if (preg_match_all($pattern, $out, $matches)) {
        // URLs are into $matches[1] or $matches[2]
        $urls = array();
        foreach ($matches[1] as $tmpval) {
          if (!empty($tmpval)) {
            $urls[] = $tmpval;
          }
        }
        foreach ($matches[2] as $tmpval) {
          if (!empty($tmpval)) {
            $urls[] = $tmpval;
          }
        }
 
        // Show URLs
        $firstexturl = '';
        $secondexturl = '';
        foreach ($urls as $url) {
          $urlok = 0;
          $parsedurl = parse_url($url);
          if (!empty($parsedurl)) {
            if (preg_match('/'.preg_quote($dolibarr_main_url_root, '/').'/', $url)
              //&& preg_match('/(document|viewimage)\.php$/', $parsedurl['path']) && preg_match('/modulepart=(media|mycompany)/', $parsedurl['query'])
            ) {
              $urlok = 1;
            }
          }
          if (!$urlok) {
            $nblinks++;
            if (empty($firstexturl)) {
              $firstexturl = $url;
            } elseif (empty($secondexturl)) {
              $secondexturl = $url;
            }
            //echo "Found url = ".$url . "\n";
          }
        }
        if ($nblinks > 0) {
          $out = 'ErrorHTMLExternalLinksNotAllowed (Example: '.$firstexturl.($secondexturl ? ' '.$secondexturl : '').')';
        }
      }
    }
 
    return $out;
  }
}
 
function dol_htmlentitiesbr($stringtoencode, $nl2brmode = 0, $pagecodefrom = 'UTF-8', $removelasteolbr = 1)
{
  if (is_null($stringtoencode)) {
    return '';
  }
 
  $newstring = $stringtoencode;
  if (dol_textishtml($stringtoencode)) {  // Check if text is already HTML or not
    $newstring = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', '<br>', $newstring); // Replace "<br type="_moz" />" by "<br>". It's same and avoid pb with FPDF.
    if ($removelasteolbr) {
      $newstring = preg_replace('/<br>$/i', '', $newstring); // Remove last <br> (remove only last one)
    }
    $newstring = preg_replace('/[\x{200B}-\x{200D}\x{FEFF}]/u', ' ', $newstring);
    $newstring = strtr($newstring, array('&' => '__PROTECTand__', '<' => '__PROTECTlt__', '>' => '__PROTECTgt__', '"' => '__PROTECTdquot__'));
    $newstring = dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom); // Make entity encoding
    $newstring = strtr($newstring, array('__PROTECTand__' => '&', '__PROTECTlt__' => '<', '__PROTECTgt__' => '>', '__PROTECTdquot__' => '"'));
  } else {
    if ($removelasteolbr) {
      $newstring = preg_replace('/(\r\n|\r|\n)$/i', '', $newstring); // Remove last \n (may remove several)
    }
    $newstring = dol_nl2br(dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom), $nl2brmode);
  }
  // Other substitutions that htmlentities does not do
  //$newstring=str_replace(chr(128),'&euro;',$newstring); // 128 = 0x80. Not in html entity table.     // Seems useles with TCPDF. Make bug with UTF8 languages
  return $newstring;
}
 
function dol_htmlentitiesbr_decode($stringtodecode, $pagecodeto = 'UTF-8')
{
  $ret = dol_html_entity_decode($stringtodecode, ENT_COMPAT | ENT_HTML5, $pagecodeto);
  $ret = preg_replace('/' . "\r\n" . '<br(\s[\sa-zA-Z_="]*)?\/?>/i', "<br>", $ret);
  $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>' . "\r\n" . '/i', "\r\n", $ret);
  $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>' . "\n" . '/i', "\n", $ret);
  $ret = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', "\n", $ret);
  return $ret;
}
 
function dol_htmlcleanlastbr($stringtodecode)
{
  $ret = preg_replace('/&nbsp;$/i', "", $stringtodecode);   // Because wysiwyg editor may add a &nbsp; at end of last line
  $ret = preg_replace('/(<br>|<br(\s[\sa-zA-Z_="]*)?\/?>|' . "\n" . '|' . "\r" . ')+$/i', "", $ret);
  return $ret;
}
 
function dol_html_entity_decode($a, $b, $c = 'UTF-8', $keepsomeentities = 0)
{
  $newstring = $a;
  if ($keepsomeentities) {
    $newstring = strtr($newstring, array('&amp;' => '__andamp__', '&lt;' => '__andlt__', '&gt;' => '__andgt__', '"' => '__dquot__'));
  }
  $newstring = html_entity_decode((string) $newstring, (int) $b, (string) $c);
  if ($keepsomeentities) {
    $newstring = strtr($newstring, array('__andamp__' => '&amp;', '__andlt__' => '&lt;', '__andgt__' => '&gt;', '__dquot__' => '"'));
  }
  return $newstring;
}
 
function dol_htmlentities($string, $flags = ENT_QUOTES | ENT_SUBSTITUTE, $encoding = 'UTF-8', $double_encode = false)
{
  return htmlentities($string, $flags, $encoding, $double_encode);
}
 
function dol_string_is_good_iso($s, $clean = 0)
{
  $len = dol_strlen($s);
  $out = '';
  $ok = 1;
  for ($scursor = 0; $scursor < $len; $scursor++) {
    $ordchar = ord($s[$scursor]);
    //print $scursor.'-'.$ordchar.'<br>';
    if ($ordchar < 32 && $ordchar != 13 && $ordchar != 10) {
      $ok = 0;
      break;
    } elseif ($ordchar > 126 && $ordchar < 160) {
      $ok = 0;
      break;
    } elseif ($clean) {
      $out .= $s[$scursor];
    }
  }
  if ($clean) {
    return $out;
  }
  return $ok;
}
 
function dol_nboflines($s, $maxchar = 0)
{
  if ($s == '') {
    return 0;
  }
  $arraystring = explode("\n", $s);
  $nb = count($arraystring);
 
  return $nb;
}
 
 
function dol_nboflines_bis($text, $maxlinesize = 0, $charset = 'UTF-8')
{
  $repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
  if (dol_textishtml($text)) {
    $repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
  }
 
  $text = strtr($text, $repTable);
  if ($charset == 'UTF-8') {
    $pattern = '/(<br[^>]*>)/Uu';
  } else {
    // /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
    $pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
  }
  $a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
 
  $nblines = (int) floor((count($a) + 1) / 2);
  // count possible auto line breaks
  if ($maxlinesize) {
    foreach ($a as $line) {
      if (dol_strlen($line) > $maxlinesize) {
        //$line_dec = html_entity_decode(strip_tags($line));
        $line_dec = html_entity_decode($line);
        if (dol_strlen($line_dec) > $maxlinesize) {
          $line_dec = wordwrap($line_dec, $maxlinesize, '\n', true);
          $nblines += substr_count($line_dec, '\n');
        }
      }
    }
  }
 
  unset($a);
  return $nblines;
}
 
function dol_textishtml($msg, $option = 0)
{
  if (is_null($msg)) {
    return false;
  }
 
  if ($option == 1) {
    if (preg_match('/<(html|link|script)/i', $msg)) {
      return true;
    } elseif (preg_match('/<body/i', $msg)) {
      return true;
    } elseif (preg_match('/<\/textarea/i', $msg)) {
      return true;
    } elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
      return true;
    } elseif (preg_match('/<br/i', $msg)) {
      return true;
    }
    return false;
  } else {
    // Remove all urls because 'http://aa?param1=abc&amp;param2=def' must not be used inside detection
    $msg = preg_replace('/https?:\/\/[^"\'\s]+/i', '', $msg);
    if (preg_match('/<(html|link|script|body)/i', $msg)) {
      return true;
    } elseif (preg_match('/<\/textarea/i', $msg)) {
      return true;
    } elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
      return true;
    } elseif (preg_match('/<(br|hr)\/>/i', $msg)) {
      return true;
    } elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)>/i', $msg)) {
      return true;
    } elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)\s+[^<>\/]*\/?>/i', $msg)) {
      return true;
    } elseif (preg_match('/<img\s+[^<>]*src[^<>]*>/i', $msg)) {
      return true; // must accept <img src="http://example.com/aaa.png" />
    } elseif (preg_match('/<a\s+[^<>]*href[^<>]*>/i', $msg)) {
      return true; // must accept <a href="http://example.com/aaa.png" />
    } elseif (preg_match('/<h[0-9]>/i', $msg)) {
      return true;
    } elseif (preg_match('/&[A-Z0-9]{1,6};/i', $msg)) {
      // TODO If content is 'A link https://aaa?param=abc&amp;param2=def', it return true but must be false
      return true; // Html entities names (http://www.w3schools.com/tags/ref_entities.asp)
    } elseif (preg_match('/&#[0-9]{2,3};/i', $msg)) {
      return true; // Html entities numbers (http://www.w3schools.com/tags/ref_entities.asp)
    } elseif (preg_match('/&#x[a-f0-9][a-f0-9];/i', $msg)) {
      return true; // Html entities numbers in hexa
    }
 
    return false;
  }
}
 
function dol_concatdesc($text1, $text2, $forxml = false, $invert = false)
{
  if (!empty($invert)) {
    $tmp = $text1;
    $text1 = $text2;
    $text2 = $tmp;
  }
 
  $ret = '';
  $ret .= (!dol_textishtml($text1) && dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text1, 0, 1, '', 1), 0, $forxml) : $text1;
  $ret .= (!empty($text1) && !empty($text2)) ? ((dol_textishtml($text1) || dol_textishtml($text2)) ? ($forxml ? "<br >\n" : "<br>\n") : "\n") : "";
  $ret .= (dol_textishtml($text1) && !dol_textishtml($text2)) ? dol_nl2br(dol_escape_htmltag($text2, 0, 1, '', 1), 0, $forxml) : $text2;
  return $ret;
}
 
function dol_concat($text1, $text2)
{
  return $text1.$text2;
}
 
function safeArrayMap($callback, array $array)
{
  if (!is_string($callback)) {
    throw new InvalidArgumentException("Les callbacks sont désactivés.");
  }
  // Check that $callback is a sure function
  $allowed_callbacks = ['strtolower', 'strtoupper', 'intval'];
  if (!in_array($callback, $allowed_callbacks, true)) {
    throw new InvalidArgumentException("Callback function not allowed.");
  }
  return array_map($callback, $array);
}
 
 
function getCommonSubstitutionArray($outputlangs, $onlykey = 0, $exclude = null, $object = null, $include = null)
{
  global $db, $conf, $mysoc, $user, $extrafields;
 
  $substitutionarray = array();
 
  if ((empty($exclude) || !in_array('user', $exclude)) && (empty($include) || in_array('user', $include)) && $user instanceof User) {
    // Add SIGNATURE into substitutionarray first, so, when we will make the substitution,
    // this will include signature content first and then replace var found into content of signature
    //var_dump($onlykey);
    $emailsendersignature = $user->signature; //  By default, we use the signature of current user. We must complete substitution with signature in c_email_senderprofile of array after calling getCommonSubstitutionArray()
    $usersignature = $user->signature;
    if (getDolGlobalString('MAIN_MAIL_DEFAULT_SIGNATURE_FOR_ALL_USERS') && !empty($user->employee)) {
      $emailsendersignature = getDolGlobalString('MAIN_MAIL_DEFAULT_SIGNATURE_FOR_ALL_USERS');
      $usersignature = getDolGlobalString('MAIN_MAIL_DEFAULT_SIGNATURE_FOR_ALL_USERS');
    }
    $substitutionarray = array_merge($substitutionarray, array(
      '__SENDEREMAIL_SIGNATURE__' => (string) ((!getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc('SignatureFromTheSelectedSenderProfile', 30) : $emailsendersignature) : ''),
      '__USER_SIGNATURE__' => (string) (($usersignature && !getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc(dol_string_nohtmltag($usersignature), 30) : $usersignature) : '')
    ));
 
    if (is_object($user) && ($user instanceof User)) {
      $substitutionarray = array_merge($substitutionarray, array(
        '__USER_ID__' => (string) $user->id,
        '__USER_LOGIN__' => (string) $user->login,
        '__USER_EMAIL__' => (string) $user->email,
        '__USER_PHONE__' => (string) dol_print_phone($user->office_phone, '', 0, 0, '', " ", '', '', -1),
        '__USER_PHONEPRO__' => (string) dol_print_phone($user->user_mobile, '', 0, 0, '', " ", '', '', -1),
        '__USER_PHONEMOBILE__' => (string) dol_print_phone($user->personal_mobile, '', 0, 0, '', " ", '', '', -1),
        '__USER_FAX__' => (string) $user->office_fax,
        '__USER_LASTNAME__' => (string) $user->lastname,
        '__USER_FIRSTNAME__' => (string) $user->firstname,
        '__USER_FULLNAME__' => (string) $user->getFullName($outputlangs),
        '__USER_SUPERVISOR_ID__' => (string) ($user->fk_user ? $user->fk_user : '0'),
        '__USER_JOB__' => (string) $user->job,
        '__USER_REMOTE_IP__' => (string) getUserRemoteIP(),
        '__USER_VCARD_URL__' => (string) $user->getOnlineVirtualCardUrl('', 'external')
      ));
      if (isModEnabled('stock') && getDolGlobalString('MAIN_DEFAULT_WAREHOUSE_USER') && is_object($user->warehouse)) {
        $substitutionarray = array_merge($substitutionarray, array(
          '__USER_WAREHOUSE_ID__' => isset($user->warehouse->id) ? $user->warehouse->id : '',
          '__USER_WAREHOUSE_REF__' => isset($user->warehouse->ref) ? $user->warehouse->ref : '',
          '__USER_WAREHOUSE_DESCRIPTION__' => isset($user->warehouse->description) ? $user->warehouse->description : '',
          '__USER_WAREHOUSE_ADDRESS__' => isset($user->warehouse->address) ? $user->warehouse->address : '',
          '__USER_WAREHOUSE_ZIP__' => isset($user->warehouse->zip) ? $user->warehouse->zip : '',
          '__USER_WAREHOUSE_TOWN__' => isset($user->warehouse->town) ? $user->warehouse->town : '',
          '__USER_WAREHOUSE_PHONE__' => isset($user->warehouse->phone) ? (string) dol_print_phone($user->warehouse->phone, '', 0, 0, '', " ", '', '', -1) : '',
          '__USER_WAREHOUSE_FAX__' => isset($user->warehouse->fax) ? (string) dol_print_phone($user->warehouse->fax, '', 0, 0, '', " ", '', '', -1) : ''
        ));
      }
    }
  }
  if ((empty($exclude) || !in_array('mycompany', $exclude)) && is_object($mysoc) && (empty($include) || in_array('mycompany', $include))) {
    $substitutionarray = array_merge($substitutionarray, array(
      '__MYCOMPANY_NAME__'    => $mysoc->name,
      '__MYCOMPANY_EMAIL__'   => $mysoc->email,
      '__MYCOMPANY_URL__'     => $mysoc->url,
      '__MYCOMPANY_PHONE__'   => dol_print_phone((string) $mysoc->phone, '', 0, 0, '', " ", '', '', -1),
      '__MYCOMPANY_PHONEMOBILE__' => dol_print_phone((string) $mysoc->phone_mobile, '', 0, 0, '', " ", '', '', -1),
      '__MYCOMPANY_FAX__'     => dol_print_phone((string) $mysoc->fax, '', 0, 0, '', " ", '', '', -1),
      '__MYCOMPANY_PROFID1__' => $mysoc->idprof1,
      '__MYCOMPANY_PROFID2__' => $mysoc->idprof2,
      '__MYCOMPANY_PROFID3__' => $mysoc->idprof3,
      '__MYCOMPANY_PROFID4__' => $mysoc->idprof4,
      '__MYCOMPANY_PROFID5__' => $mysoc->idprof5,
      '__MYCOMPANY_PROFID6__' => $mysoc->idprof6,
      '__MYCOMPANY_PROFID7__' => $mysoc->idprof7,
      '__MYCOMPANY_PROFID8__' => $mysoc->idprof8,
      '__MYCOMPANY_PROFID9__' => $mysoc->idprof9,
      '__MYCOMPANY_PROFID10__' => $mysoc->idprof10,
      '__MYCOMPANY_CAPITAL__' => $mysoc->capital,
      '__MYCOMPANY_FULLADDRESS__' => (method_exists($mysoc, 'getFullAddress') ? $mysoc->getFullAddress(1, ', ') : ''),  // $mysoc may be stdClass
      '__MYCOMPANY_ADDRESS__' => $mysoc->address,
      '__MYCOMPANY_VATNUMBER__' => $mysoc->tva_intra,
      '__MYCOMPANY_ZIP__'     => $mysoc->zip,
      '__MYCOMPANY_TOWN__'    => $mysoc->town,
      '__MYCOMPANY_STATE__'    => $mysoc->state,
      '__MYCOMPANY_COUNTRY__'    => $mysoc->country,
      '__MYCOMPANY_COUNTRY_ID__' => $mysoc->country_id,
      '__MYCOMPANY_COUNTRY_CODE__' => $mysoc->country_code,
      '__MYCOMPANY_CURRENCY_CODE__' => $conf->currency
    ));
  }
 
  if (($onlykey || is_object($object)) && (empty($exclude) || !in_array('object', $exclude)) && (empty($include) || in_array('object', $include))) {
    if ($onlykey) {
      $substitutionarray['__ID__'] = '__ID__';
      $substitutionarray['__REF__'] = '__REF__';
      $substitutionarray['__NEWREF__'] = '__NEWREF__';
      $substitutionarray['__LABEL__'] = '__LABEL__';
      $substitutionarray['__REF_CLIENT__'] = '__REF_CLIENT__';
      $substitutionarray['__REF_SUPPLIER__'] = '__REF_SUPPLIER__';
      $substitutionarray['__NOTE_PUBLIC__'] = '__NOTE_PUBLIC__';
      $substitutionarray['__NOTE_PRIVATE__'] = '__NOTE_PRIVATE__';
      $substitutionarray['__EXTRAFIELD_XXX__'] = '__EXTRAFIELD_XXX__';
 
      if (isModEnabled("societe")) {  // Most objects are concerned
        $substitutionarray['__THIRDPARTY_ID__'] = '__THIRDPARTY_ID__';
        $substitutionarray['__THIRDPARTY_NAME__'] = '__THIRDPARTY_NAME__';
        $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = '__THIRDPARTY_NAME_ALIAS__';
        $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = '__THIRDPARTY_CODE_CLIENT__';
        $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = '__THIRDPARTY_CODE_FOURNISSEUR__';
        $substitutionarray['__THIRDPARTY_EMAIL__'] = '__THIRDPARTY_EMAIL__';
        //$substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = '__THIRDPARTY_EMAIL_URLENCODED__';  // We hide this one
        $substitutionarray['__THIRDPARTY_URL__'] = '__THIRDPARTY_URL__';
        //$substitutionarray['__THIRDPARTY_URL_URLENCODED__'] = '__THIRDPARTY_URL_URLENCODED__';    // We hide this one
        $substitutionarray['__THIRDPARTY_PHONE__'] = '__THIRDPARTY_PHONE__';
        $substitutionarray['__THIRDPARTY_FAX__'] = '__THIRDPARTY_FAX__';
        $substitutionarray['__THIRDPARTY_ADDRESS__'] = '__THIRDPARTY_ADDRESS__';
        $substitutionarray['__THIRDPARTY_ZIP__'] = '__THIRDPARTY_ZIP__';
        $substitutionarray['__THIRDPARTY_TOWN__'] = '__THIRDPARTY_TOWN__';
        $substitutionarray['__THIRDPARTY_STATE__'] = '__THIRDPARTY_STATE__';
        $substitutionarray['__THIRDPARTY_IDPROF1__'] = '__THIRDPARTY_IDPROF1__';
        $substitutionarray['__THIRDPARTY_IDPROF2__'] = '__THIRDPARTY_IDPROF2__';
        $substitutionarray['__THIRDPARTY_IDPROF3__'] = '__THIRDPARTY_IDPROF3__';
        $substitutionarray['__THIRDPARTY_IDPROF4__'] = '__THIRDPARTY_IDPROF4__';
        $substitutionarray['__THIRDPARTY_IDPROF5__'] = '__THIRDPARTY_IDPROF5__';
        $substitutionarray['__THIRDPARTY_IDPROF6__'] = '__THIRDPARTY_IDPROF6__';
        $substitutionarray['__THIRDPARTY_IDPROF7__'] = '__THIRDPARTY_IDPROF7__';
        $substitutionarray['__THIRDPARTY_IDPROF8__'] = '__THIRDPARTY_IDPROF8__';
        $substitutionarray['__THIRDPARTY_IDPROF9__'] = '__THIRDPARTY_IDPROF9__';
        $substitutionarray['__THIRDPARTY_IDPROF10__'] = '__THIRDPARTY_IDPROF10__';
        $substitutionarray['__THIRDPARTY_TVAINTRA__'] = '__THIRDPARTY_TVAINTRA__';
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = '__THIRDPARTY_NOTE_PUBLIC__';
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = '__THIRDPARTY_NOTE_PRIVATE__';
      }
      if (isModEnabled('member') && (!is_object($object) || $object->element == 'adherent') && (empty($exclude) || !in_array('member', $exclude)) && (empty($include) || in_array('member', $include))) {
        $substitutionarray['__MEMBER_ID__'] = '__MEMBER_ID__';
        $substitutionarray['__MEMBER_TITLE__'] = '__MEMBER_TITLE__';
        $substitutionarray['__MEMBER_FIRSTNAME__'] = '__MEMBER_FIRSTNAME__';
        $substitutionarray['__MEMBER_LASTNAME__'] = '__MEMBER_LASTNAME__';
        $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = 'Login and pass of the external user account';
        /*$substitutionarray['__MEMBER_NOTE_PUBLIC__'] = '__MEMBER_NOTE_PUBLIC__';
        $substitutionarray['__MEMBER_NOTE_PRIVATE__'] = '__MEMBER_NOTE_PRIVATE__';*/
      }
      // add substitution variables for ticket
      if (isModEnabled('ticket') && (!is_object($object) || $object->element == 'ticket') && (empty($exclude) || !in_array('ticket', $exclude)) && (empty($include) || in_array('ticket', $include))) {
        $substitutionarray['__TICKET_TRACKID__'] = '__TICKET_TRACKID__';
        $substitutionarray['__TICKET_SUBJECT__'] = '__TICKET_SUBJECT__';
        $substitutionarray['__TICKET_TYPE__'] = '__TICKET_TYPE__';
        $substitutionarray['__TICKET_SEVERITY__'] = '__TICKET_SEVERITY__';
        $substitutionarray['__TICKET_CATEGORY__'] = '__TICKET_CATEGORY__';
        $substitutionarray['__TICKET_ANALYTIC_CODE__'] = '__TICKET_ANALYTIC_CODE__';
        $substitutionarray['__TICKET_MESSAGE__'] = '__TICKET_MESSAGE__';
        $substitutionarray['__TICKET_PROGRESSION__'] = '__TICKET_PROGRESSION__';
        $substitutionarray['__TICKET_USER_ASSIGN__'] = '__TICKET_USER_ASSIGN__';
      }
      if (isModEnabled('recruitment') && (!is_object($object) || $object->element == 'recruitmentcandidature') && (empty($exclude) || !in_array('recruitment', $exclude)) && (empty($include) || in_array('recruitment', $include))) {
        $substitutionarray['__CANDIDATE_FULLNAME__'] = '__CANDIDATE_FULLNAME__';
        $substitutionarray['__CANDIDATE_FIRSTNAME__'] = '__CANDIDATE_FIRSTNAME__';
        $substitutionarray['__CANDIDATE_LASTNAME__'] = '__CANDIDATE_LASTNAME__';
      }
      if (isModEnabled('holiday') && (!is_object($object) || $object->element == 'holiday') && (empty($exclude) || !in_array('holiday', $exclude)) && (empty($include) || in_array('holiday', $include))) {
        $substitutionarray['__HOLIDAY_ARRAY_PER_EMPLOYEE_FOR_PERIOD__'] = '__HOLIDAY_ARRAY_PER_EMPLOYEE_FOR_PERIOD__';
      }
      if (isModEnabled('project') && (empty($exclude) || !in_array('project', $exclude)) && (empty($include) || in_array('project', $include))) {   // Most objects
        $substitutionarray['__PROJECT_ID__'] = '__PROJECT_ID__';
        $substitutionarray['__PROJECT_REF__'] = '__PROJECT_REF__';
        $substitutionarray['__PROJECT_NAME__'] = '__PROJECT_NAME__';
        /*$substitutionarray['__PROJECT_NOTE_PUBLIC__'] = '__PROJECT_NOTE_PUBLIC__';
        $substitutionarray['__PROJECT_NOTE_PRIVATE__'] = '__PROJECT_NOTE_PRIVATE__';*/
      }
      if (isModEnabled('contract') && (!is_object($object) || $object->element == 'contract') && (empty($exclude) || !in_array('contract', $exclude)) && (empty($include) || in_array('contract', $include))) {
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = 'Highest date planned for a service start';
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = 'Highest date and hour planned for service start';
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = 'Lowest data for planned expiration of service';
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = 'Lowest date and hour for planned expiration of service';
      }
      if (isModEnabled("propal") && (!is_object($object) || $object->element == 'propal') && (empty($exclude) || !in_array('propal', $exclude)) && (empty($include) || in_array('propal', $include))) {
        $substitutionarray['__ONLINE_SIGN_URL__'] = 'ToOfferALinkForOnlineSignature';
      }
      if (isModEnabled("intervention") && (!is_object($object) || $object->element == 'fichinter') && (empty($exclude) || !in_array('intervention', $exclude)) && (empty($include) || in_array('intervention', $include))) {
        $substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = 'ToOfferALinkForOnlineSignature';
      }
      $substitutionarray['__ONLINE_PAYMENT_URL__'] = 'UrlToPayOnlineIfApplicable';
      $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = 'TextAndUrlToPayOnlineIfApplicable';
      $substitutionarray['__SECUREKEYPAYMENT__'] = 'Security key (if key is not unique per record)';
      $substitutionarray['__SECUREKEYPAYMENT_MEMBER__'] = 'Security key for payment on a member subscription (one key per member)';
      $substitutionarray['__SECUREKEYPAYMENT_ORDER__'] = 'Security key for payment on an order';
      $substitutionarray['__SECUREKEYPAYMENT_INVOICE__'] = 'Security key for payment on an invoice';
      $substitutionarray['__SECUREKEYPAYMENT_CONTRACTLINE__'] = 'Security key for payment on a service of a contract';
 
      $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = 'Direct download url of a proposal';
      $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = 'Direct download url of an order';
      $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = 'Direct download url of an invoice';
      $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = 'Direct download url of a contract';
      $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = 'Direct download url of a supplier proposal';
      $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_ORDER__'] = 'Direct download url of a supplier order';
      $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_INVOICE__'] = 'Direct download url of a supplier invoice';
 
      if (isModEnabled("shipping") && (!is_object($object) || $object->element == 'shipping')) {
        $substitutionarray['__SHIPPINGTRACKNUM__'] = 'Shipping tracking number';
        $substitutionarray['__SHIPPINGTRACKNUMURL__'] = 'Shipping tracking url';
        $substitutionarray['__SHIPPINGMETHOD__'] = 'Shipping method';
      }
      if (isModEnabled("reception") && (!is_object($object) || $object->element == 'reception')) {
        $substitutionarray['__RECEPTIONTRACKNUM__'] = 'Shipping tracking number of shipment';
        $substitutionarray['__RECEPTIONTRACKNUMURL__'] = 'Shipping tracking url';
      }
    } else {
      '@phan-var-force Adherent|Delivery $object';
      $substitutionarray['__ID__'] = $object->id;
      $substitutionarray['__REF__'] = $object->ref;
      $substitutionarray['__NEWREF__'] = $object->newref;
      $substitutionarray['__LABEL__'] = (isset($object->label) ? $object->label : (isset($object->title) ? $object->title : null));
      $substitutionarray['__REF_CLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
      $substitutionarray['__REF_SUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
      $substitutionarray['__NOTE_PUBLIC__'] = (isset($object->note_public) ? $object->note_public : null);
      $substitutionarray['__NOTE_PRIVATE__'] = (isset($object->note_private) ? $object->note_private : null);
 
      $substitutionarray['__DATE_CREATION__'] = (isset($object->date_creation) ? dol_print_date($object->date_creation, 'day', false, $outputlangs) : '');
      $substitutionarray['__DATE_MODIFICATION__'] = (isset($object->date_modification) ? dol_print_date($object->date_modification, 'day', false, $outputlangs) : '');
      $substitutionarray['__DATE_VALIDATION__'] = (isset($object->date_validation) ? dol_print_date($object->date_validation, 'day', false, $outputlangs) : '');
 
      // handle date_delivery: in customer order/supplier order, the property name is delivery_date, in shipment/reception it is date_delivery
      $date_delivery = null;
      if (property_exists($object, 'date_delivery')) {
        $date_delivery =  $object->date_delivery;
      } elseif (property_exists($object, 'delivery_date')) {
        $date_delivery =  $object->delivery_date;
      }
      $substitutionarray['__DATE_DELIVERY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, 'day', false, $outputlangs) : '');
      $substitutionarray['__DATE_DELIVERY_DAY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%d") : '');
      $substitutionarray['__DATE_DELIVERY_DAY_TEXT__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%A") : '');
      $substitutionarray['__DATE_DELIVERY_MON__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%m") : '');
      $substitutionarray['__DATE_DELIVERY_MON_TEXT__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%b") : '');
      $substitutionarray['__DATE_DELIVERY_YEAR__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%Y") : '');
      $substitutionarray['__DATE_DELIVERY_HH__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%H") : '');
      $substitutionarray['__DATE_DELIVERY_MM__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%M") : '');
      $substitutionarray['__DATE_DELIVERY_SS__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%S") : '');
 
      // For backward compatibility (deprecated)
      $substitutionarray['__REFCLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
      $substitutionarray['__REFSUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
 
      $substitutionarray['__SUPPLIER_ORDER_DATE_DELIVERY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, 'day', false, $outputlangs) : '');
      $substitutionarray['__SUPPLIER_ORDER_DELAY_DELIVERY__'] = (isset($object->availability_code) ? ($outputlangs->transnoentities("AvailabilityType" . $object->availability_code) != 'AvailabilityType' . $object->availability_code ? $outputlangs->transnoentities("AvailabilityType" . $object->availability_code) : $outputlangs->convToOutputCharset(isset($object->availability) ? $object->availability : '')) : '');
      $substitutionarray['__EXPIRATION_DATE__'] = (isset($object->fin_validite) ? dol_print_date($object->fin_validite, 'daytext') : '');
 
      if (is_object($object) && ($object->element == 'adherent' || $object->element == 'member') && $object->id > 0) {
        '@phan-var-force Adherent $object';
        $birthday = (empty($object->birth) ? '' : dol_print_date($object->birth, 'day'));
 
        $substitutionarray['__MEMBER_ID__'] = (isset($object->id) ? $object->id : '');
        if (method_exists($object, 'getCivilityLabel')) {
          $substitutionarray['__MEMBER_TITLE__'] = $object->getCivilityLabel();
        }
        $substitutionarray['__MEMBER_FIRSTNAME__'] = (isset($object->firstname) ? $object->firstname : '');
        $substitutionarray['__MEMBER_LASTNAME__'] = (isset($object->lastname) ? $object->lastname : '');
        $substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = '';
        if (method_exists($object, 'getFullName')) {
          $substitutionarray['__MEMBER_FULLNAME__'] = $object->getFullName($outputlangs);
        }
        $substitutionarray['__MEMBER_COMPANY__'] = (isset($object->societe) ? $object->societe : '');
        $substitutionarray['__MEMBER_ADDRESS__'] = (isset($object->address) ? $object->address : '');
        $substitutionarray['__MEMBER_ZIP__'] = (isset($object->zip) ? $object->zip : '');
        $substitutionarray['__MEMBER_TOWN__'] = (isset($object->town) ? $object->town : '');
        $substitutionarray['__MEMBER_STATE__'] = (isset($object->state) ? $object->state : '');
        $substitutionarray['__MEMBER_COUNTRY__'] = (isset($object->country) ? $object->country : '');
        $substitutionarray['__MEMBER_EMAIL__'] = (isset($object->email) ? $object->email : '');
        $substitutionarray['__MEMBER_BIRTH__'] = (isset($birthday) ? $birthday : '');
        $substitutionarray['__MEMBER_PHOTO__'] = (isset($object->photo) ? $object->photo : '');
        $substitutionarray['__MEMBER_LOGIN__'] = (isset($object->login) ? $object->login : '');
        $substitutionarray['__MEMBER_PASSWORD__'] = (isset($object->pass) ? $object->pass : '');
        $substitutionarray['__MEMBER_PHONE__'] = (isset($object->phone) ? dol_print_phone($object->phone) : '');
        $substitutionarray['__MEMBER_PHONEPRO__'] = (isset($object->phone_perso) ? dol_print_phone($object->phone_perso) : '');
        $substitutionarray['__MEMBER_PHONEMOBILE__'] = (isset($object->phone_mobile) ? dol_print_phone($object->phone_mobile) : '');
        $substitutionarray['__MEMBER_TYPE__'] = (isset($object->type) ? $object->type : '');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE__']       = dol_print_date($object->first_subscription_date, 'day');
 
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_RFC__']   = dol_print_date($object->first_subscription_date, 'dayrfc');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'day') : '');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START_RFC__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'dayrfc') : '');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END__']   = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'day') : '');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END_RFC__']   = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'dayrfc') : '');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE__']        = dol_print_date($object->last_subscription_date, 'day');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_RFC__']    = dol_print_date($object->last_subscription_date, 'dayrfc');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START__']  = dol_print_date($object->last_subscription_date_start, 'day');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START_RFC__']  = dol_print_date($object->last_subscription_date_start, 'dayrfc');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END__']    = dol_print_date($object->last_subscription_date_end, 'day');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END_RFC__']    = dol_print_date($object->last_subscription_date_end, 'dayrfc');
      }
 
      if (is_object($object) && $object->element == 'societe') {
        '@phan-var-force Societe $object';
        $substitutionarray['__THIRDPARTY_ID__'] = $object->id ?? '';
        $substitutionarray['__THIRDPARTY_NAME__'] = $object->name ?? '';
        $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = $object->name_alias ?? '';
        $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = $object->code_client ?? '';
        $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = $object->code_fournisseur ?? '';
        $substitutionarray['__THIRDPARTY_EMAIL__'] = $object->email ?? '';
        $substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = urlencode($object->email ?? '');
        $substitutionarray['__THIRDPARTY_URL__'] = $object->url ?? '';
        $substitutionarray['__THIRDPARTY_URL_URLENCODED__'] = urlencode($object->url ?? '');
        $substitutionarray['__THIRDPARTY_PHONE__'] = dol_print_phone($object->phone ?? '');
        $substitutionarray['__THIRDPARTY_FAX__'] = dol_print_phone($object->fax ?? '');
        $substitutionarray['__THIRDPARTY_ADDRESS__'] = $object->address ?? '';
        $substitutionarray['__THIRDPARTY_ZIP__'] = $object->zip ?? '';
        $substitutionarray['__THIRDPARTY_TOWN__'] = $object->town ?? '';
        $substitutionarray['__THIRDPARTY_STATE__'] = $object->state ?? '';
        $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = ($object->country_id > 0 ?: '');
        $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = $object->country_code ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF1__'] = $object->idprof1 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF2__'] = $object->idprof2 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF3__'] = $object->idprof3 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF4__'] = $object->idprof4 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF5__'] = $object->idprof5 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF6__'] = $object->idprof6 ?? '';
        $substitutionarray['__THIRDPARTY_TVAINTRA__'] = $object->tva_intra ?? '';
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = dol_htmlentitiesbr($object->note_public ?? '');
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = dol_htmlentitiesbr($object->note_private ?? '');
      } elseif (is_object($object) && is_object($object->thirdparty)) {
        $substitutionarray['__THIRDPARTY_ID__'] = $object->thirdparty->id ?? '';
        $substitutionarray['__THIRDPARTY_NAME__'] = $object->thirdparty->name ?? '';
        $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = $object->thirdparty->name_alias ?? '';
        $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = $object->thirdparty->code_client ?? '';
        $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = $object->thirdparty->code_fournisseur ?? '';
        $substitutionarray['__THIRDPARTY_EMAIL__'] = $object->thirdparty->email ?? '';
        $substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = urlencode($object->thirdparty->email ?? '');
        $substitutionarray['__THIRDPARTY_PHONE__'] = dol_print_phone($object->thirdparty->phone ?? '');
        $substitutionarray['__THIRDPARTY_FAX__'] = dol_print_phone($object->thirdparty->fax ?? '');
        $substitutionarray['__THIRDPARTY_ADDRESS__'] = $object->thirdparty->address ?? '';
        $substitutionarray['__THIRDPARTY_ZIP__'] = $object->thirdparty->zip ?? '';
        $substitutionarray['__THIRDPARTY_TOWN__'] = $object->thirdparty->town ?? '';
        $substitutionarray['__THIRDPARTY_STATE__'] = $object->thirdparty->state ?? '';
        $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = ($object->thirdparty->country_id > 0 ?: '');
        $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = $object->thirdparty->country_code ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF1__'] = $object->thirdparty->idprof1 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF2__'] = $object->thirdparty->idprof2 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF3__'] = $object->thirdparty->idprof3 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF4__'] = $object->thirdparty->idprof4 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF5__'] = $object->thirdparty->idprof5 ?? '';
        $substitutionarray['__THIRDPARTY_IDPROF6__'] = $object->thirdparty->idprof6 ?? '';
        $substitutionarray['__THIRDPARTY_TVAINTRA__'] = $object->thirdparty->tva_intra ?? '';
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = dol_htmlentitiesbr($object->thirdparty->note_public ?? '');
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = dol_htmlentitiesbr($object->thirdparty->note_private ?? '');
      }
 
      if (is_object($object) && $object->element == 'recruitmentcandidature') {
        '@phan-var-force RecruitmentCandidature $object';
        $substitutionarray['__CANDIDATE_FULLNAME__'] = $object->getFullName($outputlangs);
        $substitutionarray['__CANDIDATE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
        $substitutionarray['__CANDIDATE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
      }
      if (is_object($object) && $object->element == 'conferenceorboothattendee') {
        '@phan-var-force ConferenceOrBoothAttendee $object';
        $substitutionarray['__ATTENDEE_FULLNAME__'] = $object->getFullName($outputlangs);
        $substitutionarray['__ATTENDEE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
        $substitutionarray['__ATTENDEE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
      }
 
      if (is_object($object) && $object->element == 'project') {
        '@phan-var-force Project $object';
        $substitutionarray['__PROJECT_ID__'] = $object->id;
        $substitutionarray['__PROJECT_REF__'] = $object->ref;
        $substitutionarray['__PROJECT_NAME__'] = $object->title;
      } elseif (is_object($object)) {
        $project = null;
        if (!empty($object->project)) {
          $project = $object->project;
        }
        if (!is_null($project) && is_object($project)) {
          $substitutionarray['__PROJECT_ID__'] = $project->id;
          $substitutionarray['__PROJECT_REF__'] = $project->ref;
          $substitutionarray['__PROJECT_NAME__'] = $project->title;
        } else {
          // can substitute variables for project : uses lazy load in "make_substitutions" method
          $project_id = 0;
          if (!empty($object->fk_project) && $object->fk_project > 0) {
            $project_id = $object->fk_project;
          } elseif (!empty($object->fk_projet) && $object->fk_projet > 0) {
            $project_id = $object->fk_project;
          }
          if ($project_id > 0) {
            // path:class:method:id
            $substitutionarray['__PROJECT_ID__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
            $substitutionarray['__PROJECT_REF__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
            $substitutionarray['__PROJECT_NAME__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
          }
        }
      }
 
      if (is_object($object) && $object->element == 'facture') {
        '@phan-var-force Facture $object';
        $substitutionarray['__INVOICE_SITUATION_NUMBER__'] = isset($object->situation_counter) ? $object->situation_counter : '';
      }
      if (is_object($object) && $object->element == 'shipping') {
        '@phan-var-force Expedition $object';
        $substitutionarray['__SHIPPINGTRACKNUM__'] = $object->tracking_number;
        $substitutionarray['__SHIPPINGTRACKNUMURL__'] = $object->tracking_url;
        $substitutionarray['__SHIPPINGMETHOD__'] = $object->shipping_method;
      }
      if (is_object($object) && $object->element == 'reception') {
        '@phan-var-force Reception $object';
        $substitutionarray['__RECEPTIONTRACKNUM__'] = $object->tracking_number;
        $substitutionarray['__RECEPTIONTRACKNUMURL__'] = $object->tracking_url;
      }
 
      if (is_object($object) && $object->element == 'contrat' && $object->id > 0 && is_array($object->lines)) {
        '@phan-var-force Contrat $object';
        $dateplannedstart = '';
        $datenextexpiration = '';
        foreach ($object->lines as $line) {
          if ($line->date_start > $dateplannedstart) {
            $dateplannedstart = $line->date_start;
          }
          if ($line->statut == 4 && $line->date_end && (!$datenextexpiration || $line->date_end < $datenextexpiration)) {
            $datenextexpiration = $line->date_end;
          }
        }
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = dol_print_date($dateplannedstart, 'day');
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE_RFC__'] = dol_print_date($dateplannedstart, 'dayrfc');
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = dol_print_date($dateplannedstart, 'standard');
 
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = dol_print_date($datenextexpiration, 'day');
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE_RFC__'] = dol_print_date($datenextexpiration, 'dayrfc');
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = dol_print_date($datenextexpiration, 'standard');
      }
      // add substitution variables for ticket
      if (is_object($object) && $object->element == 'ticket') {
        '@phan-var-force Ticket $object';
        $substitutionarray['__TICKET_TRACKID__'] = $object->track_id;
        $substitutionarray['__TICKET_SUBJECT__'] = $object->subject;
        $substitutionarray['__TICKET_TYPE__'] = $object->type_code;
        $substitutionarray['__TICKET_SEVERITY__'] = $object->severity_code;
        $substitutionarray['__TICKET_CATEGORY__'] = $object->category_code; // For backward compatibility
        $substitutionarray['__TICKET_ANALYTIC_CODE__'] = $object->category_code;
        $substitutionarray['__TICKET_MESSAGE__'] = $object->message;
        $substitutionarray['__TICKET_PROGRESSION__'] = $object->progress;
        $userstat = new User($db);
        if ($object->fk_user_assign > 0) {
          $userstat->fetch($object->fk_user_assign);
          $substitutionarray['__TICKET_USER_ASSIGN__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
        }
 
        if ($object->fk_user_create > 0) {
          $userstat->fetch($object->fk_user_create);
          $substitutionarray['__USER_CREATE__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
        }
      }
 
      // Create dynamic tags for __EXTRAFIELD_FIELD__
      if ($object->table_element && $object->id > 0) {
        if (!is_object($extrafields)) {
          $extrafields = new ExtraFields($db);
        }
        $extrafields->fetch_name_optionals_label($object->table_element, true);
 
        if ($object->fetch_optionals() > 0) { // @FIXME: Remove this, the fetch should have been done already, by the caller of getCommonSubstitutionArray()
          if (is_array($extrafields->attributes[$object->table_element]['label']) && count($extrafields->attributes[$object->table_element]['label']) > 0) {
            foreach ($extrafields->attributes[$object->table_element]['label'] as $key => $label) {
              if ($extrafields->attributes[$object->table_element]['type'][$key] == 'date') {
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = dol_print_date($object->array_options['options_' . $key], 'day');
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_LOCALE__'] = dol_print_date($object->array_options['options_' . $key], 'day', 'tzserver', $outputlangs);
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_RFC__'] = dol_print_date($object->array_options['options_' . $key], 'dayrfc');
              } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'datetime') {
                $datetime = $object->array_options['options_' . $key];
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour') : '');
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour', 'tzserver', $outputlangs) : '');
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_DAY_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'day', 'tzserver', $outputlangs) : '');
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_RFC__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhourrfc') : '');
              } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'phone') {
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = dol_print_phone($object->array_options['options_' . $key]);
              } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'price') {
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = $object->array_options['options_' . $key];
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_FORMATED__'] = price($object->array_options['options_' . $key]);  // For compatibility
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '_FORMATTED__'] = price($object->array_options['options_' . $key]);
              } elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'select') {
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = !empty($object->array_options['options_' . $key]) ? $object->array_options['options_' . $key] : '';
                $val = $extrafields->attributes[$object->table_element]['param'][$key]['options'][$object->array_options['options_'.$key]] ?? $object->array_options['options_'.$key];
                $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LABEL__'] = $val;
              } elseif ($extrafields->attributes[$object->table_element]['type'][$key] != 'separator') {
                $substitutionarray['__EXTRAFIELD_' . strtoupper($key) . '__'] = !empty($object->array_options['options_' . $key]) ? $object->array_options['options_' . $key] : '';
              }
            }
          }
        }
      }
 
      // Complete substitution array with the url to make online payment
      if (empty($substitutionarray['__REF__'])) {
        $paymenturl = '';
      } else {
        // Set the online payment url link into __ONLINE_PAYMENT_URL__ key
        require_once DOL_DOCUMENT_ROOT . '/core/lib/payments.lib.php';
        $outputlangs->loadLangs(array('paypal', 'other'));
 
        $amounttouse = 0;
        $typeforonlinepayment = 'free';
        if (is_object($object) && $object->element == 'commande') {
          $typeforonlinepayment = 'order';
        }
        if (is_object($object) && $object->element == 'facture') {
          $typeforonlinepayment = 'invoice';
        }
        if (is_object($object) && $object->element == 'member') {
          $typeforonlinepayment = 'member';
          if (!empty($object->last_subscription_amount)) {
            $amounttouse = $object->last_subscription_amount;
          }
        }
        if (is_object($object) && $object->element == 'contrat') {
          $typeforonlinepayment = 'contract';
        }
        if (is_object($object) && $object->element == 'fichinter') {
          $typeforonlinepayment = 'ficheinter';
        }
 
        $url = getOnlinePaymentUrl(0, $typeforonlinepayment, $substitutionarray['__REF__'], (float) $amounttouse);
        $paymenturl = $url;
      }
 
      if ($object->id > 0) {
        $substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = ($paymenturl ? str_replace('\n', "\n", $outputlangs->trans("PredefinedMailContentLink", $paymenturl)) : '');
        $substitutionarray['__ONLINE_PAYMENT_URL__'] = $paymenturl;
 
        // Show structured communication
        if (getDolGlobalString('INVOICE_PAYMENT_ENABLE_STRUCTURED_COMMUNICATION') && $object->element == 'facture') {
          include_once DOL_DOCUMENT_ROOT . '/core/lib/functions_be.lib.php';
          $substitutionarray['__PAYMENT_STRUCTURED_COMMUNICATION__'] = dolBECalculateStructuredCommunication((string) $object->ref, $object->type);
        }
 
        if (getDolGlobalString('PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'propal') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = '';
        }
        if (getDolGlobalString('ORDER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'commande') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = '';
        }
        if (getDolGlobalString('INVOICE_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'facture') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = '';
        }
        if (getDolGlobalString('CONTRACT_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'contrat') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = '';
        }
        if (getDolGlobalString('FICHINTER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'fichinter') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = '';
        }
        if (getDolGlobalString('SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'supplier_proposal') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = '';
        }
        if (getDolGlobalString('SUPPLIER_ORDER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'order_supplier') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_ORDER__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_ORDER__'] = '';
        }
        if (getDolGlobalString('SUPPLIER_INVOICE_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'invoice_supplier') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_INVOICE__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_INVOICE__'] = '';
        }
 
        if (is_object($object) && $object->element == 'propal') {
          '@phan-var-force Propal $object';
          $substitutionarray['__URL_PROPOSAL__'] = DOL_MAIN_URL_ROOT . "/comm/propal/card.php?id=" . $object->id;
          require_once DOL_DOCUMENT_ROOT . '/core/lib/signature.lib.php';
          $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'proposal', (string) $object->ref, 1, $object);
        }
        if (is_object($object) && $object->element == 'commande') {
          '@phan-var-force Commande $object';
          $substitutionarray['__URL_ORDER__'] = DOL_MAIN_URL_ROOT . "/commande/card.php?id=" . $object->id;
        }
        if (is_object($object) && $object->element == 'facture') {
          '@phan-var-force Facture $object';
          $substitutionarray['__URL_INVOICE__'] = DOL_MAIN_URL_ROOT . "/compta/facture/card.php?id=" . $object->id;
        }
        if (is_object($object) && $object->element == 'contrat') {
          '@phan-var-force Contrat $object';
          $substitutionarray['__URL_CONTRACT__'] = DOL_MAIN_URL_ROOT . "/contrat/card.php?id=" . $object->id;
          require_once DOL_DOCUMENT_ROOT . '/core/lib/signature.lib.php';
          $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'contract', (string) $object->ref, 1, $object);
        }
        if (is_object($object) && $object->element == 'fichinter') {
          '@phan-var-force Fichinter $object';
          $substitutionarray['__URL_FICHINTER__'] = DOL_MAIN_URL_ROOT . "/fichinter/card.php?id=" . $object->id;
          require_once DOL_DOCUMENT_ROOT . '/core/lib/signature.lib.php';
          $substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = getOnlineSignatureUrl(0, 'fichinter', (string) $object->ref, 1, $object);
        }
        if (is_object($object) && $object->element == 'supplier_proposal') {
          '@phan-var-force SupplierProposal $object';
          $substitutionarray['__URL_SUPPLIER_PROPOSAL__'] = DOL_MAIN_URL_ROOT . "/supplier_proposal/card.php?id=" . $object->id;
        }
        if (is_object($object) && $object->element == 'invoice_supplier') {
          '@phan-var-force FactureFournisseur $object';
          $substitutionarray['__URL_SUPPLIER_INVOICE__'] = DOL_MAIN_URL_ROOT . "/fourn/facture/card.php?id=" . $object->id;
        }
        if (is_object($object) && $object->element == 'payment_supplier') {
          '@phan-var-force PaiementFourn $object';
          //print_r($object);
          $liste_factures = [];
          $total = 0;
 
          // @FIXME We must not have any repeated SQL access into this function.
          $sql = 'SELECT f.ref,f.multicurrency_code as f_mccode, pf.*
              FROM '.MAIN_DB_PREFIX.'paiementfourn_facturefourn as pf
              JOIN '.MAIN_DB_PREFIX.'facture_fourn as f ON pf.fk_facturefourn = f.rowid
              WHERE pf.fk_paiementfourn = '.((int) $object->id);
 
          $resql = $db->query($sql);
          if ($resql) {
            while ($objp = $db->fetch_object($resql)) {
              $liste_factures[] = ' - '.$outputlangs->trans('Invoice').' '. $objp->ref.' '.$outputlangs->trans('AmountPayed').' '.price($objp->multicurrency_amount, 0, $outputlangs, 0, -1, -1, $objp->multicurrency_code);
            }
          }
          $substitutionarray['__SUPPLIER_PAYMENT_INVOICES_LIST__'] =  implode("\n", $liste_factures);
          ;
          $substitutionarray['__SUPPLIER_PAYMENT_INVOICES_TOTAL__'] = price($object->multicurrency_amount, 0, $outputlangs, 0, -1, -1, $object->multicurrency_code ? $object->multicurrency_code : $conf->currency);
        }
        if (is_object($object) && $object->element == 'shipping') {
          '@phan-var-force Expedition $object';
          $substitutionarray['__URL_SHIPMENT__'] = DOL_MAIN_URL_ROOT . "/expedition/card.php?id=" . $object->id;
          if (getDolGlobalInt('EXPEDITION_ALLOW_ONLINESIGN')) {
            require_once DOL_DOCUMENT_ROOT . '/core/lib/signature.lib.php';
            $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'expedition', (string) $object->ref, 1, $object);
          }
        }
      }
 
      if (is_object($object) && $object->element == 'action') {
        '@phan-var-force ActionComm $object';
        $substitutionarray['__EVENT_LABEL__'] = $object->label;
        $substitutionarray['__EVENT_DESCRIPTION__'] = $object->note;
        $substitutionarray['__EVENT_TYPE__'] = $outputlangs->trans("Action" . $object->type_code);
        $substitutionarray['__EVENT_DATE__'] = dol_print_date($object->datep, 'day', 'auto', $outputlangs);
        $substitutionarray['__EVENT_TIME__'] = dol_print_date($object->datep, 'hour', 'auto', $outputlangs);
        $substitutionarray['__EVENT_DATE_TZUSER__'] = dol_print_date($object->datep, 'day', 'tzuserrel', $outputlangs);
        $substitutionarray['__EVENT_TIME_TZUSER__'] = dol_print_date($object->datep, 'hour', 'tzuserrel', $outputlangs);
      }
    }
  }
 
  if ((empty($exclude) || !in_array('objectamount', $exclude)) && (empty($include) || in_array('objectamount', $include))) {
    '@phan-var-force Facture|FactureRec $object';
    include_once DOL_DOCUMENT_ROOT . '/core/lib/functionsnumtoword.lib.php';
 
    $substitutionarray['__DATE_YMD__']          = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'day', false, $outputlangs) : null) : '';
    $substitutionarray['__DATE_DUE_YMD__']      = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'day', false, $outputlangs) : null) : '';
    $substitutionarray['__DATE_YMD_TEXT__']     = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'daytext', false, $outputlangs) : null) : '';
    $substitutionarray['__DATE_DUE_YMD_TEXT__'] = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'daytext', false, $outputlangs) : null) : '';
 
    $already_payed_all = 0;
    if (is_object($object) && ($object instanceof Facture)) {
      $already_payed_all = $object->totalpaid + $object->totaldeposits + $object->totalcreditnotes;
    }
 
    $substitutionarray['__SIMPLE_HTML_TABLE__'] = is_object($object) && !empty($object->lines) ? showSimpleHTMLTable($outputlangs, $object) : "";
    $substitutionarray['__AMOUNT_EXCL_TAX__'] = is_object($object) ? $object->total_ht : '';
    $substitutionarray['__AMOUNT_EXCL_TAX_TEXT__'] = is_object($object) ? dol_convertToWord($object->total_ht, $outputlangs, '', true) : '';
    $substitutionarray['__AMOUNT_EXCL_TAX_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ht, $outputlangs, $conf->currency, true) : '';
 
    $substitutionarray['__AMOUNT__']          = is_object($object) ? $object->total_ttc : '';
    $substitutionarray['__AMOUNT_TEXT__']     = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, '', true) : '';
    $substitutionarray['__AMOUNT_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, $conf->currency, true) : '';
 
    $substitutionarray['__DEPOSIT_PERCENT__'] = is_object($object) ? $object->deposit_percent : '';
    $substitutionarray['__DEPOSIT_AMOUNT__'] = is_object($object) ? price2num($object->total_ttc * ($object->deposit_percent / 100), 'MT') : '';
 
    $substitutionarray['__AMOUNT_REMAIN__'] = is_object($object) ? price2num($object->total_ttc - $already_payed_all, 'MT') : '';
 
    $substitutionarray['__AMOUNT_VAT__']      = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
    $substitutionarray['__AMOUNT_VAT_TEXT__']      = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, '', true) : dol_convertToWord($object->total_tva, $outputlangs, '', true)) : '';
    $substitutionarray['__AMOUNT_VAT_TEXTCURRENCY__']      = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, $conf->currency, true) : dol_convertToWord($object->total_tva, $outputlangs, $conf->currency, true)) : '';
 
    $mysocuselocaltax1 = false;
    $mysocuselocaltax2 = false;
    if ($mysoc instanceof Societe && !empty($mysoc->country_code)) {
      $tmparray = $mysoc->useLocalTax(-1);
      $mysocuselocaltax1 = $tmparray[1];
      $mysocuselocaltax2 = $tmparray[2];
    }
 
    // Local taxes
    if ($onlykey != 2 || $mysocuselocaltax1) {
      $substitutionarray['__AMOUNT_TAX2__']     = is_object($object) ? $object->total_localtax1 : '';
    }
    if ($onlykey != 2 || $mysocuselocaltax2) {
      $substitutionarray['__AMOUNT_TAX3__']     = is_object($object) ? $object->total_localtax2 : '';
    }
 
    // Amount keys formatted in a currency
    $substitutionarray['__AMOUNT_EXCL_TAX_FORMATTED__'] = is_object($object) ? ($object->total_ht ? price($object->total_ht, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_FORMATTED__']          = is_object($object) ? ($object->total_ttc ? price($object->total_ttc, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_REMAIN_FORMATTED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc - $already_payed_all, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_VAT_FORMATTED__']      = is_object($object) ? (isset($object->total_vat) ? price($object->total_vat, 0, $outputlangs, 0, -1, -1, $conf->currency) : ($object->total_tva ? price($object->total_tva, 0, $outputlangs, 0, -1, -1, $conf->currency) : null)) : '';
    if ($onlykey != 2 || $mysocuselocaltax1) {
      $substitutionarray['__AMOUNT_TAX2_FORMATTED__']     = is_object($object) ? ($object->total_localtax1 ? price($object->total_localtax1, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    }
    if ($onlykey != 2 || $mysocuselocaltax2) {
      $substitutionarray['__AMOUNT_TAX3_FORMATTED__']     = is_object($object) ? ($object->total_localtax2 ? price($object->total_localtax2, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    }
    // Amount keys formatted in a currency (with the typo error for backward compatibility)
    if ($onlykey != 2) {
      $substitutionarray['__AMOUNT_EXCL_TAX_FORMATED__'] = $substitutionarray['__AMOUNT_EXCL_TAX_FORMATTED__'];
      $substitutionarray['__AMOUNT_FORMATED__']          = $substitutionarray['__AMOUNT_FORMATTED__'];
      $substitutionarray['__AMOUNT_REMAIN_FORMATED__']   = $substitutionarray['__AMOUNT_REMAIN_FORMATTED__'];
      $substitutionarray['__AMOUNT_VAT_FORMATED__']      = $substitutionarray['__AMOUNT_VAT_FORMATTED__'];
      if ($mysocuselocaltax1) {
        $substitutionarray['__AMOUNT_TAX2_FORMATED__'] = $substitutionarray['__AMOUNT_TAX2_FORMATTED__'];
      }
      if ($mysoc->useLocalTax2) {
        $substitutionarray['__AMOUNT_TAX3_FORMATED__'] = $substitutionarray['__AMOUNT_TAX3_FORMATTED__'];
      }
    }
 
    $substitutionarray['__AMOUNT_MULTICURRENCY__']          = (is_object($object) && isset($object->multicurrency_total_ttc)) ? $object->multicurrency_total_ttc : '';
    $substitutionarray['__AMOUNT_MULTICURRENCY_FORMATED__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? price($object->multicurrency_total_ttc, 0, $outputlangs, 0, -1, -1, $object->multicurrency_code) : '';
    $substitutionarray['__AMOUNT_MULTICURRENCY_TEXT__']     = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, '', true) : '';
    $substitutionarray['__AMOUNT_MULTICURRENCY_TEXTCURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, $object->multicurrency_code, true) : '';
    $substitutionarray['__MULTICURRENCY_CODE__']          = (is_object($object) && isset($object->multicurrency_code)) ? $object->multicurrency_code : '';
    // TODO Add other keys for foreign multicurrency
 
    // For backward compatibility
    if ($onlykey != 2) {
      $substitutionarray['__TOTAL_TTC__']    = is_object($object) ? $object->total_ttc : '';
      $substitutionarray['__TOTAL_HT__']     = is_object($object) ? $object->total_ht : '';
      $substitutionarray['__TOTAL_VAT__']    = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
    }
  }
 
  if ((empty($exclude) || !in_array('date', $exclude)) && (empty($include) || in_array('date', $include))) {
    include_once DOL_DOCUMENT_ROOT . '/core/lib/date.lib.php';
 
    $now = dol_now();
 
    $tmp = dol_getdate($now, true);
    $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
    $tmp3 = dol_get_prev_month($tmp['mon'], $tmp['year']);
    $tmp4 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
    $tmp5 = dol_get_next_month($tmp['mon'], $tmp['year']);
 
    $daytext = $outputlangs->trans('Day' . $tmp['wday']);
 
    $substitutionarray = array_merge($substitutionarray, array(
      '__NOW_TMS__' => (string) $now,   // Must be the string that represent the int
      '__NOW_TMS_YMD__' => dol_print_date($now, 'day', 'auto', $outputlangs),
      '__DAY__' => (string) $tmp['mday'],
      '__DAY_TEXT__' => $daytext, // Monday
      '__DAY_TEXT_SHORT__' => dol_trunc($daytext, 3, 'right', 'UTF-8', 1), // Mon
      '__DAY_TEXT_MIN__' => dol_trunc($daytext, 1, 'right', 'UTF-8', 1), // M
      '__MONTH__' => (string) $tmp['mon'],
      '__MONTH_TEXT__' => $outputlangs->transnoentitiesnoconv('Month' . sprintf("%02d", $tmp['mon'])),
      '__MONTH_TEXT_SHORT__' => $outputlangs->transnoentitiesnoconv('MonthShort' . sprintf("%02d", $tmp['mon'])),
      '__MONTH_TEXT_MIN__' => $outputlangs->transnoentitiesnoconv('MonthVeryShort' . sprintf("%02d", $tmp['mon'])),
      '__YEAR__' => (string) $tmp['year'],
      '__YEAR_PREVIOUS_MONTH__' => (string) $tmp3['year'],
      '__YEAR_NEXT_MONTH__' => (string) $tmp5['year'],
      '__PREVIOUS_DAY__' => (string) $tmp2['day'],
      '__PREVIOUS_MONTH__' => (string) $tmp3['month'],
      '__PREVIOUS_MONTH_TEXT__' => $outputlangs->transnoentitiesnoconv('Month' . sprintf("%02d", $tmp3['month'])),
      '__PREVIOUS_MONTH_TEXT_SHORT__' => $outputlangs->transnoentitiesnoconv('MonthShort' . sprintf("%02d", $tmp3['month'])),
      '__PREVIOUS_MONTH_TEXT_MIN__' => $outputlangs->transnoentitiesnoconv('MonthVeryShort' . sprintf("%02d", $tmp3['month'])),
      '__PREVIOUS_YEAR__' => (string) ($tmp['year'] - 1),
      '__NEXT_DAY__' => (string) $tmp4['day'],
      '__NEXT_MONTH__' => (string) $tmp5['month'],
      '__NEXT_MONTH_TEXT__' => $outputlangs->transnoentitiesnoconv('Month' . sprintf("%02d", $tmp5['month'])),
      '__NEXT_MONTH_TEXT_SHORT__' => $outputlangs->transnoentitiesnoconv('MonthShort' . sprintf("%02d", $tmp5['month'])),
      '__NEXT_MONTH_TEXT_MIN__' => $outputlangs->transnoentitiesnoconv('MonthVeryShort' . sprintf("%02d", $tmp5['month'])),
      '__NEXT_YEAR__' => (string) ($tmp['year'] + 1),
    ));
  }
 
  if (isModEnabled('multicompany')) {
    $substitutionarray = array_merge($substitutionarray, array('__ENTITY_ID__' => $conf->entity));
  }
  if ((empty($exclude) || !in_array('system', $exclude)) && (empty($include) || in_array('user', $include))) {
    $substitutionarray['__DOL_MAIN_URL_ROOT__'] = DOL_MAIN_URL_ROOT;
    $substitutionarray['__(AnyTranslationKey)__'] = $outputlangs->transnoentitiesnoconv('TranslationOfKey');
    $substitutionarray['__(AnyTranslationKey|langfile)__'] = $outputlangs->transnoentitiesnoconv('TranslationOfKey') . ' (load also language file before)';
    $substitutionarray['__[AnyConstantKey]__'] = $outputlangs->transnoentitiesnoconv('ValueOfConstantKey');
  }
 
  // Note: The lazyload variables are replaced only during the call by make_substitutions, and only if necessary
 
  return $substitutionarray;
}
 
function make_substitutions($text, $substitutionarray, $outputlangs = null, $converttextinhtmlifnecessary = 0)
{
  global $db, $langs;
 
  if (!is_array($substitutionarray)) {
    return 'ErrorBadParameterSubstitutionArrayWhenCalling_make_substitutions';
  }
 
  if (empty($outputlangs)) {
    $outputlangs = $langs;
  }
 
  // Is initial text HTML or simple text ?
  $msgishtml = 0;
  if (dol_textishtml($text, 1)) {
    $msgishtml = 1;
  }
 
  // Make substitution for language keys: __(AnyTranslationKey)__ or __(AnyTranslationKey|langfile)__
  if (is_object($outputlangs)) {
    $reg = array();
    while (preg_match('/__\‍(([^\‍)]+)\‍)__/', $text, $reg)) {
      // If key is __(TranslationKey|langfile)__, then force load of langfile.lang
      $tmp = explode('|', $reg[1]);
      if (!empty($tmp[1])) {
        $outputlangs->load($tmp[1]);
      }
 
      $value = $outputlangs->transnoentitiesnoconv($reg[1]);
 
      if (empty($converttextinhtmlifnecessary)) {
        // convert $newval into HTML is necessary
        $text = preg_replace('/__\‍(' . preg_quote($reg[1], '/') . '\‍)__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
      } else {
        if (! $msgishtml) {
          $valueishtml = dol_textishtml($value, 1);
          //var_dump("valueishtml=".$valueishtml);
 
          if ($valueishtml) {
            $text = dol_htmlentitiesbr($text);
            $msgishtml = 1;
          }
        } else {
          $value = dol_nl2br((string) $value);
        }
 
        $text = preg_replace('/__\‍(' . preg_quote($reg[1], '/') . '\‍)__/', $value, $text);
      }
    }
  }
 
  // Make substitution for constant keys.
  // Must be after the substitution of translation, so if the text of translation contains a string __[xxx]__, it is also converted.
  $reg = array();
  while (preg_match('/__\[([^\]]+)\]__/', $text, $reg)) {
    $originalkeyfound = $reg[1];
    $keyfound = preg_replace('/\|urlencode$/', '', $originalkeyfound);
 
    if (isASecretKey($keyfound)) {
      $value = '*****forbidden*****';
    } else {
      $value = getDolGlobalString($keyfound);
      // Execute some functions on value of substitution key
      if (preg_match('/\|urlencode$/', $originalkeyfound)) {
        $value = urlencode($value);
      }
    }
 
    if (empty($converttextinhtmlifnecessary)) {
      // convert $newval into HTML is necessary
      $text = preg_replace('/__\[' . preg_quote($originalkeyfound, '/') . '\]__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
    } else {
      if (! $msgishtml) {
        $valueishtml = dol_textishtml($value, 1);
 
        if ($valueishtml) {
          $text = dol_htmlentitiesbr($text);
          $msgishtml = 1;
        }
      } else {
        $value = dol_nl2br((string) $value);
      }
 
      $text = preg_replace('/__\[' . preg_quote($originalkeyfound, '/') . '\]__/', $value, $text);
    }
  }
 
  // Make substitution for array $substitutionarray
  foreach ($substitutionarray as $key => $value) {
    if (!isset($value)) {
      continue; // If value is null, it same than not having substitution key at all into array, we do not replace.
    }
 
    if (getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN') && ($key == '__USER_SIGNATURE__' || $key == '__SENDEREMAIL_SIGNATURE__')) {
      $value = ''; // Protection
    }
 
    if (empty($converttextinhtmlifnecessary)) {
      $text = str_replace((string) $key, (string) $value, $text); // Cast to string is needed when value is 123.5 for example
    } else {
      if (! $msgishtml) {
        $valueishtml = dol_textishtml($value, 1);
 
        if ($valueishtml) {
          $text = dol_htmlentitiesbr($text);
          $msgishtml = 1;
        }
      } else {
        $value = dol_nl2br((string) $value);
      }
      $text = str_replace((string) $key, (string) $value, $text); // Cast to string is needed 123.5 for example
    }
  }
 
  /*
  Loop to scan $substitutionarray for couples:    key=__XXX__@lazyload  and  value='path:class:method:id'  or 'path:class:method:id:keyinarrayresult' if method return array
  For each key ending with '@lazyload', we extract the substitution key 'XXX' and we check inside the $text (the 1st parameter of make_substitutions), if the string XXX exists.
  If no, we don't need to make replacement, so we do nothing.
  If yes, we can make the substitution:
 
  include_once $path;
  $tmpobj = new $class($db);
  $valuetouseforsubstitution = $tmpobj->$method($id, '__XXX__');
  And make the replacement of "__XXX__@lazyload" with $valuetouseforsubstitution
  */
  $memory_object_list = array();
  foreach ($substitutionarray as $key => $value) {
    $lazy_load_arr = array();
    if (preg_match('/(__[A-Z\_]+__)@lazyload$/', $key, $lazy_load_arr)) {
      if (isset($lazy_load_arr[1]) && !empty($lazy_load_arr[1])) {
        $key_to_substitute = $lazy_load_arr[1];
        if (preg_match('/' . preg_quote($key_to_substitute, '/') . '/', $text)) {
          $param_arr = explode(':', (string) $value);
          // path:class:method:id
          if (count($param_arr) >= 4) {
            $path = $param_arr[0];
            $class = $param_arr[1];
            $method = $param_arr[2];
            $id = (int) $param_arr[3];
            $keyinarrayresult = empty($param_arr[4]) ? '' : $param_arr[4];
 
            // load class file and init object list in memory
            if (!isset($memory_object_list[$class])) {
              if (dol_is_file(DOL_DOCUMENT_ROOT . $path)) {
                require_once DOL_DOCUMENT_ROOT . $path;
                if (class_exists($class)) {
                  $memory_object_list[$class] = array(
                    'list' => array(),
                  );
                }
              }
            }
 
            // fetch object and set substitution
            if (isset($memory_object_list[$class]) && isset($memory_object_list[$class]['list'])) {
              if (method_exists($class, $method)) {
                if (!isset($memory_object_list[$class]['list'][$id])) {
                  $tmpobj = new $class($db);
                  // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                  $tmpvaluetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute);
                  $memory_object_list[$class]['list'][$id] = $tmpobj;
                } else {
                  // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
                  $tmpobj = $memory_object_list[$class]['list'][$id];
                  // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                  $tmpvaluetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute, true);
                }
 
                if ($keyinarrayresult) {
                  $valuetouseforsubstitution = (string) $tmpvaluetouseforsubstitution[$keyinarrayresult];   // Cast to string in case value is 123.5 for example
                } else {
                  $valuetouseforsubstitution = (string) $tmpvaluetouseforsubstitution;            // Cast to string in case value is 123.5 for example
                }
                $text = str_replace((string) $key_to_substitute, $valuetouseforsubstitution, $text);
              }
            }
          }
        }
      }
    }
  }
 
  return $text;
}
 
function complete_substitutions_array(&$substitutionarray, $outputlangs, $object = null, $parameters = null, $callfunc = "completesubstitutionarray")
{
  global $conf, $user;
 
  require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php';
 
  // Note: substitution key for each extrafields, using key __EXTRA_XXX__ is already available into the getCommonSubstitutionArray used to build the substitution array.
 
  // Check if there is external substitution to do, requested by plugins
  $dirsubstitutions = array_merge(array(), (array) $conf->modules_parts['substitutions']);
 
  foreach ($dirsubstitutions as $reldir) {
    $dir = dol_buildpath($reldir, 0);
 
    // Check if directory exists
    if (!dol_is_dir($dir)) {
      continue;
    }
 
    $substitfiles = dol_dir_list($dir, 'files', 0, 'functions_');
    foreach ($substitfiles as $substitfile) {
      $reg = array();
      if (preg_match('/functions_(.*)\.lib\.php/i', $substitfile['name'], $reg)) {
        $module = $reg[1];
 
        dol_syslog("Library " . $substitfile['name'] . " found into " . $dir);
        // Include the user's functions file
        require_once $dir . $substitfile['name'];
        // Call the user's function, and only if it is defined
        $function_name = $module . "_" . $callfunc;
        if (function_exists($function_name)) {
          $function_name($substitutionarray, $outputlangs, $object, $parameters);
        }
      }
    }
  }
  if (getDolGlobalString('ODT_ENABLE_ALL_TAGS_IN_SUBSTITUTIONS')) {
    // to list all tags in odt template
    $tags = '';
    foreach ($substitutionarray as $key => $value) {
      $tags .= '{' . $key . '} => ' . $value . "\n";
    }
    $substitutionarray = array_merge($substitutionarray, array('__ALL_TAGS__' => $tags));
  }
}
 
function print_date_range($date_start, $date_end, $format = '', $outputlangs = null)
{
  print get_date_range($date_start, $date_end, $format, $outputlangs);
}
 
function get_date_range($date_start, $date_end, $format = '', $outputlangs = null, $withparenthesis = 1)
{
  global $langs;
 
  $out = '';
 
  if (!is_object($outputlangs)) {
    $outputlangs = $langs;
  }
 
  if ($date_start && $date_end) {
    $out .= ($withparenthesis ? ($withparenthesis == 1 ? ' ' : '').'(' : '') . $outputlangs->transnoentitiesnoconv('DateFromTo', dol_print_date($date_start, $format, false, $outputlangs), dol_print_date($date_end, $format, false, $outputlangs)) . ($withparenthesis ? ')' : '');
  }
  if ($date_start && !$date_end) {
    $out .= ($withparenthesis ? ($withparenthesis == 1 ? ' ' : '').'(' : '') . $outputlangs->transnoentitiesnoconv('DateFrom', dol_print_date($date_start, $format, false, $outputlangs)) . ($withparenthesis ? ')' : '');
  }
  if (!$date_start && $date_end) {
    $out .= ($withparenthesis ? ($withparenthesis == 1 ? ' ' : '').'(' : '') . $outputlangs->transnoentitiesnoconv('DateUntil', dol_print_date($date_end, $format, false, $outputlangs)) . ($withparenthesis ? ')' : '');
  }
 
  return $out;
}
 
function dolGetFirstLastname($firstname, $lastname, $nameorder = -1)
{
  $ret = '';
  // If order not defined, we use the setup
  if ($nameorder < 0) {
    $nameorder = (!getDolGlobalString('MAIN_FIRSTNAME_NAME_POSITION') ? 1 : 0);
  }
  if ($nameorder == 1) {
    $ret .= $firstname;
    if ($firstname && $lastname) {
      $ret .= ' ';
    }
    $ret .= $lastname;
  } elseif ($nameorder == 2 || $nameorder == 3) {
    $ret .= $firstname;
    if (empty($ret) && $nameorder == 3) {
      $ret .= $lastname;
    }
  } else {  // 0, 4 or 5
    $ret .= $lastname;
    if (empty($ret) && $nameorder == 5) {
      $ret .= $firstname;
    }
    if ($nameorder == 0) {
      if ($firstname && $lastname) {
        $ret .= ' ';
      }
      $ret .= $firstname;
    }
  }
  return $ret;
}
 
 
function dolSort($arraytosort)
{
  sort($arraytosort);
  return $arraytosort;
}
 
function dol_sort_array(&$array, $index, $order = 'asc', $natsort = 0, $case_sensitive = 0, $keepindex = 0)
{
  // Clean parameters
  $order = strtolower($order);
 
  if (is_array($array)) {
    $sizearray = count($array);
    if ($sizearray > 0) {
      // Build a temp array with sorting key as value
      $temp = array();
      foreach (array_keys($array) as $key) {
        $tmpmultikey = explode(',', $index);
        $newindex = $tmpmultikey[0];
        if (is_object($array[$key])) {
          $temp[$key] = empty($array[$key]->$newindex) ? 0 : $array[$key]->$newindex;
          // Add other keys
          if (!empty($tmpmultikey[1])) {
            $newindex = $tmpmultikey[1];
            $temp[$key] .= '__' . (empty($array[$key]->$newindex) ? 0 : $array[$key]->$newindex);
          }
        } else {
          // @phan-suppress-next-line PhanTypeArraySuspiciousNullable,PhanTypeArraySuspicious,PhanTypeMismatchDimFetch
          $temp[$key] = empty($array[$key][$newindex]) ? 0 : $array[$key][$newindex];
          // Add other keys
          if (!empty($tmpmultikey[1])) {
            $newindex = $tmpmultikey[1];
            // @phan-suppress-next-line PhanTypeArraySuspicious,PhanTypeMismatchDimFetch
            $temp[$key] .= '__' . (empty($array[$key][$newindex]) ? 0 : $array[$key][$newindex]);
          }
        }
        if ($natsort == -1) {
          $temp[$key] = '___' . $temp[$key];        // We add a string at begin of value to force an alpha order when using asort.
        }
      }
      if (empty($natsort) || $natsort == -1) {
        if ($order == 'asc') {
          asort($temp);
        } else {
          arsort($temp);
        }
      } else {
        if ($case_sensitive) {
          natsort($temp);
        } else {
          natcasesort($temp); // natecasesort is not sensible to case
        }
        if ($order != 'asc') {
          $temp = array_reverse($temp, true);
        }
      }
 
      $sorted = array();
 
      foreach (array_keys($temp) as $key) {
        (is_numeric($key) && empty($keepindex)) ? $sorted[] = $array[$key] : $sorted[$key] = $array[$key];
      }
 
      return $sorted;
    }
  }
  return $array;
}
 
 
function utf8_check($str)
{
  $str = (string) $str; // Sometimes string is an int.
 
  // We must use here a binary strlen function (so not dol_strlen)
  $strLength = strlen($str);
  for ($i = 0; $i < $strLength; $i++) {
    if (ord($str[$i]) < 0x80) {
      continue; // 0bbbbbbb
    } elseif ((ord($str[$i]) & 0xE0) == 0xC0) {
      $n = 1; // 110bbbbb
    } elseif ((ord($str[$i]) & 0xF0) == 0xE0) {
      $n = 2; // 1110bbbb
    } elseif ((ord($str[$i]) & 0xF8) == 0xF0) {
      $n = 3; // 11110bbb
    } elseif ((ord($str[$i]) & 0xFC) == 0xF8) {
      $n = 4; // 111110bb
    } elseif ((ord($str[$i]) & 0xFE) == 0xFC) {
      $n = 5; // 1111110b
    } else {
      return false; // Does not match any model
    }
    for ($j = 0; $j < $n; $j++) { // n bytes matching 10bbbbbb follow ?
      if ((++$i == strlen($str)) || ((ord($str[$i]) & 0xC0) != 0x80)) {
        return false;
      }
    }
  }
  return true;
}
 
function utf8_valid($str)
{
  /* 2 other methods to test if string is utf8
   $validUTF8 = mb_check_encoding($messagetext, 'UTF-8');
   $validUTF8b = ! (false === mb_detect_encoding($messagetext, 'UTF-8', true));
   */
  return preg_match('//u', $str) ? true : false;
}
 
 
function ascii_check($str)
{
  if (function_exists('mb_check_encoding')) {
    //if (mb_detect_encoding($str, 'ASCII', true) return false;
    if (!mb_check_encoding($str, 'ASCII')) {
      return false;
    }
  } else {
    if (preg_match('/[^\x00-\x7f]/', $str)) {
      return false; // Contains a byte > 7f
    }
  }
 
  return true;
}
 
 
function dol_osencode($str)
{
  $tmp = ini_get("unicode.filesystem_encoding");
  if (empty($tmp) && !empty($_SERVER["WINDIR"])) {
    $tmp = 'iso-8859-1'; // By default for windows
  }
  if (empty($tmp)) {
    $tmp = 'utf-8'; // By default for other
  }
  if (getDolGlobalString('MAIN_FILESYSTEM_ENCODING')) {
    $tmp = getDolGlobalString('MAIN_FILESYSTEM_ENCODING');
  }
 
  if ($tmp == 'iso-8859-1') {
    return mb_convert_encoding($str, 'ISO-8859-1', 'UTF-8');
  }
  return $str;
}
 
 
function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '', $useCache = true)
{
  global $conf;
 
  // If key empty
  if ($key == '') {
    return 0;
  }
 
  // Check in cache
  if ($useCache && isset($conf->cache['codeid'][$tablename][$key][$fieldid])) { // Can be defined to 0 or ''
    return $conf->cache['codeid'][$tablename][$key][$fieldid]; // Found in cache
  }
 
  dol_syslog('dol_getIdFromCode (value for field ' . $fieldid . ' from key ' . $key . ' not found into cache)', LOG_DEBUG);
 
  $sql = "SELECT " . $db->sanitize($fieldid) . " as valuetoget";
  $sql .= " FROM " . MAIN_DB_PREFIX . $db->sanitize($tablename);
  if ($fieldkey == 'id' || $fieldkey == 'rowid') {
    $sql .= " WHERE " . $db->sanitize($fieldkey) . " = " . ((int) $key);
  } else {
    $sql .= " WHERE " . $db->sanitize($fieldkey) . " = '" . $db->escape($key) . "'";
  }
  if (!empty($entityfilter)) {
    $sql .= " AND entity IN (" . getEntity($tablename) . ")";
  }
  if ($filters) {
    $sql .= $filters;  // @phan-suppress-current-line SqlInjection
  }
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    $valuetoget = '';
    if ($obj) {
      $valuetoget = $obj->valuetoget;
      $conf->cache['codeid'][$tablename][$key][$fieldid] = $valuetoget;
    } else {
      $conf->cache['codeid'][$tablename][$key][$fieldid] = '';
    }
    $db->free($resql);
 
    return $valuetoget;
  } else {
    return -1;
  }
}
 
function isStringVarMatching($var, $regextext, $matchrule = 1)
{
  // Tolerate callers (custom modules, older code) that already pass a full regex with delimiters
  // like '/^(aaa|bbb)/' instead of the bare body. Without this, the function would build
  // '/^/^(aaa|bbb)//' which trips preg_match() with 'Unknown modifier ^'.
  $regextext = preg_replace('#^/\^?#', '', (string) $regextext);
  $regextext = preg_replace('#\$?/[imsxuADSUXJ]*$#', '', $regextext);
 
  if ($matchrule == 1) {
    if ($var == 'mainmenu') {
      global $mainmenu;
      return (preg_match('/^' . $regextext . '/', $mainmenu));
    } elseif ($var == 'leftmenu') {
      global $leftmenu;
      return (preg_match('/^' . $regextext . '/', $leftmenu));
    } else {
      return 'This variable is not accessible with dol_eval';
    }
  } else {
    return 'This value '.$matchrule.' for param $matchrule is not yet implemented';
  }
}
 
 
function verifCond($strToEvaluate, $onlysimplestring = '1')
{
  //print $strToEvaluate."<br>\n";
  $rights = true;
  if (isset($strToEvaluate) && $strToEvaluate !== '') {
    //var_dump($strToEvaluate);
    //$rep = dol_eval($strToEvaluate, 1, 0, '1'); // to show the error
    $rep = dol_eval($strToEvaluate, 1, 1, $onlysimplestring); // The dol_eval() must contains all the "global $xxx;" for all variables $xxx found into the string condition
 
    // On string syntax error, dol_eval may return a string that start with 'Bad call of ...' or 'Bad string syntax to evaluate...' !!!
    //var_dump($strToEvaluate, $rep);
    $rights = (bool) $rep && (!is_string($rep) || (strpos($rep, 'Exception during') === false && strpos($rep, 'Bad call of') === false && strpos($rep, 'Bad string syntax to evaluate') === false));
    //var_dump($rights);
  }
  return $rights;
}
 
function dol_eval($s, $returnvalue = 1, $hideerrors = 1, $onlysimplestring = '1')
{
  if ($returnvalue != 1) {
    dol_syslog("Use of dol_eval with parameter returnvalue = 0 is now forbidden. Please fix this", LOG_ERR);
  }
 
  global $dolibarr_main_use_dol_eval_new;     // experimental option, not yet ready
  if (!empty($dolibarr_main_use_dol_eval_new)) {
    return dol_eval_new($s);
  } else {
    return dol_eval_standard($s, $hideerrors, $onlysimplestring);
  }
}
 
function dol_eval_new($s)
{
  // Only this global variables can be read by eval function and returned to caller
  global $conf, // Read of const is done with getDolGlobalString() but we need $conf->currency for example
  $db, $langs, $user, $website, $websitepage,
  $action, $mainmenu, $leftmenu,
  $mysoc,
  $objectoffield, // To allow the use of $objectoffield in computed fields
 
  // Old variables used
  $object;
 
  if (getDolGlobalString('MAIN_ALLOW_OLD_VAR_OBJ_IN_DOL_EVAL')) {
    global $obj; // To get $obj used into list when dol_eval() is used for computed fields and $obj is not yet $object
  }
 
  // PHP < 7.4.0
  defined('T_COALESCE_EQUAL') || define('T_COALESCE_EQUAL', PHP_INT_MAX);
  defined('T_FN') || define('T_FN', PHP_INT_MAX);
 
  // PHP < 8.0.0
  defined('T_ATTRIBUTE') || define('T_ATTRIBUTE', PHP_INT_MAX);
  defined('T_MATCH') || define('T_MATCH', PHP_INT_MAX);
  defined('T_NAME_FULLY_QUALIFIED') || define('T_NAME_FULLY_QUALIFIED', PHP_INT_MAX);
  defined('T_NAME_QUALIFIED') || define('T_NAME_QUALIFIED', PHP_INT_MAX);
  defined('T_NAME_RELATIVE') || define('T_NAME_RELATIVE', PHP_INT_MAX);
 
  // PHP < 8.1.0
  defined('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG') || define('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG', PHP_INT_MAX);
  defined('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG') || define('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG', PHP_INT_MAX);
  defined('T_ENUM') || define('T_ENUM', PHP_INT_MAX);
  defined('T_READONLY') || define('T_READONLY', PHP_INT_MAX);
 
  // PHP < 8.4.0
  defined('T_PRIVATE_SET') || define('T_PRIVATE_SET', PHP_INT_MAX);
  defined('T_PROTECTED_SET') || define('T_PROTECTED_SET', PHP_INT_MAX);
  defined('T_PUBLIC_SET') || define('T_PUBLIC_SET', PHP_INT_MAX);
 
  $prohibited_token_ids = [
    /*
     * Prohibited int tokens
     */
 
    // T_AND_EQUAL', 'T_ARRAY', 'T_ARRAY_CAST', 'T_AS',
    'T_ABSTRACT',
    'T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG',
    'T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG',
    'T_ATTRIBUTE',
    // 'T_BOOLEAN_AND', 'T_BOOLEAN_OR', 'T_BOOL_CAST', 'T_BREAK',
    'T_BAD_CHARACTER',
    // 'T_CASE', 'T_CLASS_C', 'T_CLONE', 'T_COALESCE', 'T_COALESCE_EQUAL', 'T_COMMENT', 'T_CONCAT_EQUAL',
    // 'T_CONSTANT_ENCAPSED_STRING', 'T_CONTINUE', 'T_CURLY_OPEN',
    'T_CALLABLE',
    'T_CATCH',
    'T_CLASS',
    'T_CLOSE_TAG',
    'T_CONST',
    // 'T_DEC', 'T_DEFAULT', 'T_DIV_EQUAL', 'T_DNUMBER', 'T_DO', 'T_DOC_COMMENT',
    // 'T_DOLLAR_OPEN_CURLY_BRACES', 'T_DOUBLE_ARROW', 'T_DOUBLE_CAST', 'T_DOUBLE_COLON',
    'T_DECLARE',
    'T_DIR',
    // 'T_ELLIPSIS', 'T_ELSE', 'T_ELSEIF', 'T_EMPTY', 'T_ENCAPSED_AND_WHITESPACE', 'T_ENDFOR',
    // 'T_ENDFOREACH', 'T_ENDIF', 'T_ENDSWITCH', 'T_ENDWHILE', 'T_END_HEREDOC',
    'T_ECHO',
    'T_ENDDECLARE',
    'T_ENUM',
    'T_EVAL',
    'T_EXIT',
    'T_EXTENDS',
    // 'T_FOR', 'T_FOREACH',
    'T_FILE',
    'T_FINAL',
    'T_FINALLY',
    'T_FN',
    'T_FUNCTION',
    'T_FUNC_C',
    'T_GLOBAL',
    'T_GOTO',
    'T_HALT_COMPILER',
    // 'T_IF', 'T_INC', 'T_INLINE_HTML', 'T_INSTANCEOF', 'T_INT_CAST', 'T_ISSET', 'T_IS_EQUAL', 'T_IS_GREATER_OR_EQUAL',
    // 'T_IS_IDENTICAL', 'T_IS_NOT_EQUAL', 'T_IS_NOT_IDENTICAL', 'T_IS_SMALLER_OR_EQUAL',
    'T_IMPLEMENTS',
    'T_INCLUDE',
    'T_INCLUDE_ONCE',
    'T_INSTEADOF',
    'T_INTERFACE',
    // 'T_LIST', 'T_LNUMBER', 'T_LOGICAL_AND', 'T_LOGICAL_OR', 'T_LOGICAL_XOR',
    'T_LINE',
    // 'T_MINUS_EQUAL', 'T_MOD_EQUAL', 'T_MUL_EQUAL',
    'T_METHOD_C',
    // 'T_NEW',
    // 'T_NS_SEPARATOR', 'T_NUM_STRING',
    'T_NAMESPACE',
    // 'T_NAME_FULLY_QUALIFIED', 'T_NAME_QUALIFIED', 'T_NAME_RELATIVE', 'T_NS_C',
    // 'T_OBJECT_CAST', 'T_OBJECT_OPERATOR', 'T_OR_EQUAL',
    'T_OPEN_TAG',
    'T_OPEN_TAG_WITH_ECHO',
    // 'T_PAAMAYIM_NEKUDOTAYIM', 'T_PLUS_EQUAL', 'T_POW', 'T_POW_EQUAL',
    'T_PRINT',
    'T_PRIVATE',
    'T_PROTECTED',
    'T_PUBLIC',
    // 'T_PROPERTY_C',
    'T_READONLY',
    'T_REQUIRE',
    'T_REQUIRE_ONCE',
    'T_RETURN',
    // 'T_SL', 'T_SL_EQUAL', 'T_SPACESHIP', 'T_SR', 'T_SR_EQUAL', 'T_START_HEREDOC', 'T_STATIC',
    // 'T_STRING', 'T_STRING_CAST', 'T_STRING_VARNAME', 'T_SWITCH',
    'T_STATIC',
    'T_THROW',
    'T_TRAIT',
    'T_TRAIT_C',
    'T_TRY',
    'T_UNSET',
    'T_UNSET_CAST',
    'T_USE',
    // 'T_VARIABLE',
    'T_VAR',
    // 'T_WHILE', 'T_WHITESPACE',
    // 'T_XOR_EQUAL',
    // 'T_YIELD', 'T_YIELD_FROM',
 
    /*
     * Prohibited string tokens
     */
    ';',
    '`',
  ];
 
  $prohibited_variables = [
    '$_COOKIE',
    '$_ENV',
    '$_FILES',
    '$GLOBALS',
    '$_GET',
    '$_POST',
    '$_REQUEST',
    '$_SERVER',
    '$_SESSION',
  ];
 
  $forbiddenphpfunctions = array();
  $forbiddenphpmethods = array();
 
  // Same list than in dol_eval
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("override_function", "session_id", "session_create_id", "session_regenerate_id"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("get_defined_functions", "get_defined_vars", "get_defined_constants", "get_declared_classes"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function"));
 
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("GETPOST")); // native dolibarr functions
 
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("ob_start"));
 
  // Functions with callable parameters
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("call_user_func", "call_user_func_array"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("array_all", "array_any", "array_diff_ukey", "array_filter", "array_find", "array_find_key", "array_map", "array_reduce", "array_intersect_uassoc", "array_intersect_ukey", "array_walk", "array_walk_recursive"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("usort", "uasort", "uksort"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("preg_replace_callback", "preg_replace_callback_array", "header_register_callback"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("error_log", "set_error_handler", "set_exception_handler", "libxml_set_external_entity_loader", "register_shutdown_function", "register_tick_function", "unregister_tick_function"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("spl_autoload_register", "spl_autoload_unregister", "iterator_apply", "session_set_save_handler"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("forward_static_call", "forward_static_call_array", "register_postsend_function"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("readline_completion_function", "readline_callback_handler_install"));
 
  // Exec functions
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("exec", "passthru", "shell_exec", "system", "proc_open", "popen"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("pcntl_alarm", "pcntl_exec", "pcntl_fork", "pcntl_waitpid", "pcntl_wait", "pcntl_wifexited", "pcntl_wifstopped", "pcntl_wifsignaled", "pcntl_wifcontinued", "pcntl_wexitstatus", "pcntl_wtermsig", "pcntl_wstopsig", "pcntl_signal"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("pcntl_signal_get_handler", "pcntl_signal_dispatch", "pcntl_get_last_error", "pcntl_strerror", "pcntl_sigprocmask", "pcntl_sigwaitinfo", "pcntl_sigtimedwait", "pcntl_getpriority", "pcntl_async_signals", "pcntl_unshare", ));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("putenv", "dl", "apache_child_terminate", "apache_setenv"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_eval", "dol_eval_new", "dol_eval_standard", "executeCLI", "verifCond", "dolEncrypt", "dolDecrypt"));  // native dolibarr functions
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("eval", "create_function", "assert", "mb_ereg_replace")); // function with eval capabilities
 
  // Include functions
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("require", "include", "require_once", "include_once"));
 
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_compress_dir", "dol_decode", "dol_dir_list", "dol_dir_list_in_database", "dol_delete_file", "dol_delete_dir", "dol_delete_dir_recursive", "dol_copy", "archiveOrBackupFile")); // more dolibarr functions
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("chdir", "dir", "fopen", "file", "file_exists", "file_get_contents", "file_put_contents", "fget", "fgetc", "fgetcsv", "flock", "fputs", "fputscsv", "fpassthru", "fscanf", "fseek", "fwrite", "is_file", "is_dir", "is_link", "mkdir", "opendir", "rmdir", "scandir", "symlink", "touch", "unlink", "umask"));
 
  if (!getDolGlobalString('MAIN_ALLOW_OBFUSCATION_METHODS_IN_DOL_EVAL')) {  // We disallow all function that allow to obfuscate the real name of a function
    // @phpcs:ignore
    $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("base64" . "_" . "decode", "rawurl" . "decode", "url" . "decode", "str" . "_rot13", "hex" . "2bin", "printf", "sprintf")); // name of forbidden functions are split to avoid false positive
    $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_concat", "dol_concatdesc"));    // native dolibarr functions
  }
 
  $forbiddenphpmethods = array_merge($forbiddenphpmethods, array('invoke', 'invokeArgs'));  // Methods of ReflectionFunction to execute a function
 
  $prohibited_functions = array_merge($forbiddenphpfunctions, $forbiddenphpmethods);
 
  $prohibited_token_arrangements = [
    // Variable functions "$a(", '"$a"(', "'FN_NAME'(", ('FN_NAME')()
    ' T_VARIABLE ( ',
    ' " ( ',
    ' \' ( ',
    ' T_CONSTANT_ENCAPSED_STRING ( ',
    ' ) ( ',
  ];
 
  $tokens = token_get_all("<?php return {$s};", TOKEN_PARSE);
 
  $tokens_arrangement = ' ';
 
  for ($i = 2, $c = count($tokens) - 1; $i < $c; ++$i) { // ignore <?php return and ;
    if (is_array($tokens[$i])) {
      $token_id = $tokens[$i][0];
      $token_value = $tokens[$i][1];
      $token_name = token_name($tokens[$i][0]);
    } else {
      $token_id = $tokens[$i];
      $token_value = $tokens[$i];
      $token_name = $tokens[$i];
    }
 
    // Ignore whitespaces
    if (T_WHITESPACE === $token_id) {
      continue;
    }
 
    // Keep history to check arrangements
    $tokens_arrangement .= "{$token_name} ";
 
    // Prohibited Variables
    if (
      T_VARIABLE === $token_id
      && in_array($token_value, $prohibited_variables, true)
    ) {
      return "Bad string syntax to evaluate. « {$token_value} » is prohibited in « {$s} »";
    }
 
    // Prohibited Functions
    if (
      T_STRING === $token_id
      && in_array($token_value, $prohibited_functions, true)
    ) {
      return "Bad string syntax to evaluate. « {$token_value} » is prohibited in « {$s} »";
    }
  }
 
  // Prohibited Token IDs
  $maxi = count($prohibited_token_ids);
  for ($i = 0; $i < $maxi; ++$i) {
    if (false !== strpos($tokens_arrangement, " {$prohibited_token_ids[$i]} ")) {
      return "Bad string syntax to evaluate. « {$prohibited_token_ids[$i]} » is prohibited in « {$s} »";
    }
  }
 
  // Prohibited token arrangements
  $maxi = count($prohibited_token_arrangements);
  for ($i = 0; $i < $maxi; ++$i) {
    if (false !== strpos($tokens_arrangement, $prohibited_token_arrangements[$i])) {
      return "Bad string syntax to evaluate. « {$prohibited_token_arrangements[$i]} » is prohibited in « {$s} »";
    }
  }
 
  // Return result
  try {
    return @eval("return {$s};") ?? '';
  } catch (Throwable $ex) {
    return "Bad string syntax to evaluate. Exception during evaluation: " . $s . " - " . $ex->getMessage();
  }
}
 
function dol_eval_standard($s, $hideerrors = 1, $onlysimplestring = '1')
{
  // Only this global variables can be read by eval function and returned to caller
  // The less we have, the better it is.
 
  global $conf; // TODO Remove this to exclude $conf. We can read $conf->module->enabled with isModEnabled(), $conf->global->xxx properties with getDolGlobalString(), $conf->currency with getDolCurrency(), $conf->entity with getDolEntity()
  global $db, $langs, $user, $website, $websitepage;
  global $action, $mainmenu, $leftmenu;
  global $mysoc;
  global $objectoffield;  // To allow the use of $objectoffield in computed fields
  global $object;
 
  // Old variables (deprecated since v23)
  if (getDolGlobalString('MAIN_ALLOW_OLD_VAR_OBJ_IN_DOL_EVAL')) {
    global $obj; // To get $obj used into list when dol_eval() is used for computed fields and $obj is not yet $objectoffield
  }
 
  $isObBufferActive = false;    // When true, the ObBuffer must be cleaned in the exception handler
  if ($onlysimplestring == '0') { // '0' is deprecated, we process it as the more secured '1'
    $onlysimplestring = '1';
  }
  if (!in_array($onlysimplestring, array('1', '2'))) {
    return "Bad call of dol_eval. Parameter onlysimplestring must be '1' or '2'.";
  }
  if (!is_scalar($s)) {
    return "Bad call of dol_eval. First parameter must be a string, found ".var_export($s, true);
  }
 
  try {
    global $dolibarr_main_restrict_eval_methods;
 
    // Set $dolibarr_main_restrict_eval_methods_array
    if (!isset($dolibarr_main_restrict_eval_methods)) {
      $dolibarr_main_restrict_eval_methods = 'getDolGlobalString, getDolGlobalInt, getDolCurrency, getDolEntity, getDolDBType, fetchNoCompute, hasRight, isAdmin, isExternalUser, isModEnabled, isStringVarMatching, abs, min, max, round, dol_now, preg_match';
    }
    //print '$dolibarr_main_restrict_eval_methods = '.$dolibarr_main_restrict_eval_methods."\n";
    $dolibarr_main_restrict_eval_methods_array = explode(',', str_replace(" ", "", $dolibarr_main_restrict_eval_methods));
 
    // Test on dangerous char (used for RCE), we allow only characters to make PHP variable testing
    // We must accept with 1: '1 && getDolGlobalInt("doesnotexist1") && getDolGlobalString("MAIN_FEATURES_LEVEL")'
    // We must accept with 1: '$user->hasRight("cabinetmed", "read") && !$objectoffield->canvas == "patient@cabinetmed"'
    // We must accept with 2: (($var1 = new Task($db)) && ($var1->fetchNoCompute($object->id) <= 99) && ($var2 = new Project($db)) && ($var2->fetchNoCompute($var1->fk_project) > 0)) ? $var2->ref : "Parent project not found"
 
    // Check if there is dynamic call (first we check chars are all into a whitelist chars)
    $specialcharsallowed = '^$_+-.*>&|=!?():"\',/@';
    if ($onlysimplestring == '2') {
      $specialcharsallowed .= '<[]';  // Later we check that < has space before and after
    }
    global $dolibarr_main_allow_unsecured_special_chars_in_dol_eval;
    if (!empty($dolibarr_main_allow_unsecured_special_chars_in_dol_eval)) {
      $specialcharsallowed .= (string) $dolibarr_main_allow_unsecured_special_chars_in_dol_eval;
    }
    if (preg_match('/[^a-z0-9\s' . preg_quote($specialcharsallowed, '/') . ']/i', $s)) {
      return 'Bad string syntax to evaluate (found chars that are not chars for a simple one line clean eval string): ' . $s;
    }
 
    // Check if we found a | without a space before and after
    /* Disabled to allow preg_match('/(AAA|BBB)/')
    $tmps = str_replace(' || ', '__XXX__', $s);
    if (strpos($tmps, '|') !== false) {
      return 'Bad string syntax to evaluate (The char | can be used only when duplicated || with a space before and after): ' . $s;
    }
    */
 
    // Check if there is PHP comments (can be used to obfuscate code)
    if (strpos($s, '/*') !== false || strpos($s, '//') !== false) {
      return 'Bad string syntax to evaluate (The comment string /* and // are not allowed): ' . $s;
    }
 
    // Check if we found a ? without a space before and after
    $tmps = str_replace(' ? ', '__XXX__', $s);
    if (strpos($tmps, '?') !== false) {
      return 'Bad string syntax to evaluate (The char ? can be used only with a space before and after): ' . $s;
    }
 
    // Check if there is a < or <= without spaces after
    if (preg_match('/<=?[^\s]/', $s)) {
      return 'Bad string syntax to evaluate (mode ' . $onlysimplestring . ', found a < or <= without space after): ' . $s;
    }
 
    // Check if there is an include or a require
    if (preg_match('/(include|include_once|require|require_once)/', $s)) {
      return 'Bad string syntax to evaluate (found not allowed key include|include_once|require|require_once): ' . $s;
    }
 
    // Check if there is dynamic call (first we use black list patterns)
    if (preg_match('/\$[\w]*\s*\‍(/', $s)) {
      return 'Bad string syntax to evaluate (mode ' . $onlysimplestring . ', found a call using "$abc(" or "$abc (" instead of using the direct name of the function): ' . $s;
    }
 
    if (empty($dolibarr_main_restrict_eval_methods)) {
      // If $dolibarr_main_restrict_eval_methods was set to '', we must check if we try dynamic call
 
      // First we remove white list pattern of using parenthesis then testing if one open parenthesis exists
      $savescheck = '';
      $scheck = $s;
      while ($scheck && $savescheck != $scheck) {
        $savescheck = $scheck;
        $scheck = preg_replace('/->[a-zA-Z0-9_]+\‍(/', '->__METHOD__', $scheck); // accept parenthesis in '...->method(...'
        $scheck = preg_replace('/::[a-zA-Z0-9_]+\‍(/', '->__METHOD__', $scheck); // accept parenthesis in '...::method(...'
        $scheck = preg_replace('/^\‍(+/', '__PARENTHESIS__ ', $scheck);  // accept parenthesis in '(...'. Must replace with "__PARENTHESIS__ with a space after "to allow following substitutions
        $scheck = preg_replace('/\&\&\s+\‍(/', '__ANDPARENTHESIS__ ', $scheck);  // accept parenthesis in '&& ('. Must replace with "__PARENTHESIS__ with a space after" to allow following substitutions
        $scheck = preg_replace('/\|\|\s+\‍(/', '__ORPARENTHESIS__ ', $scheck); // accept parenthesis in '|| ('. Must replace with "__PARENTHESIS__ with a space after" to allow following substitutions
        $scheck = preg_replace('/^!?[a-zA-Z0-9_]+\‍(/', '__FUNCTION__', $scheck); // accept parenthesis in 'function(' and '!function('
        $scheck = preg_replace('/\s!?[a-zA-Z0-9_]+\‍(/', '__FUNCTION__', $scheck); // accept parenthesis in '... function(' and '... !function('
        $scheck = preg_replace('/^!\‍(/', '__NOTANDPARENTHESIS__', $scheck); // accept parenthesis in '!('
        $scheck = preg_replace('/\s!\‍(/', ' __NOTANDPARENTHESIS__', $scheck); // accept parenthesis in '... !('
        $scheck = preg_replace('/(\^|\')\‍(/', '__REGEXSTART__', $scheck); // To allow preg_match('/^(aaa|bbb)/'...  or  isStringVarMatching('leftmenu', '(aaa|bbb)')
      }
      //print 'scheck='.$scheck." : ".strpos($scheck, '(')."<br>\n";
 
      // Now test if it remains 1 open parenthesis.
      if (strpos($scheck, '(') !== false) {
        return 'Bad string syntax to evaluate (mode ' . $onlysimplestring . ', found call of a function or method without using the direct name of the function): ' . $s;
      }
    }
 
    if (strpos($s, '`') !== false) {
      return 'Bad string syntax to evaluate (backtick char is forbidden): ' . $s;
    }
 
    // Disallow also concat operator
    if (!getDolGlobalString('MAIN_ALLOW_OBFUSCATION_METHODS_IN_DOL_EVAL')) {
      if (preg_match('/[^0-9]+\.[^0-9]+/', $s)) {    // We refuse . if not between 2 numbers
        return 'Bad string syntax to evaluate (dot char is forbidden if not strictly between 2 numbers): ' . $s;
      }
    }
 
    // We exclude string using a $ character that are not an expected global or temporary vars, so that are not:
    // $db, $langs, $leftmenu, $topmenu, $user, $langs, $objectoffield, $var....
    $savescheck = '';
    $scheck = $s;
    while ($scheck && $savescheck != $scheck) {
      $savescheck = $scheck;
      $scheck = preg_replace('/\$conf->[a-z\_]+->enabled/', '__VARCONFENABLED__', $scheck);   // Remove this once $user->module->enabled has been replaced everywhere with isModEnabled.
      $scheck = preg_replace('/\$user->id/', '__VARUSERID__', $scheck);
      $scheck = preg_replace('/\$user->hasRight/', '__VARUSERHASRIGHT__', $scheck);
      $scheck = preg_replace('/\$user->rights/', '__VARUSERHASRIGHT__', $scheck);   // Remove this once $user->rights->xxx is replaced everywhere with $user->hasRight()
      $scheck = preg_replace('/\$user->isAdmin/', '__VARUSERHASRIGHT__', $scheck);
      $scheck = preg_replace('/\$user->admin/', '__VARUSERISADMIN__', $scheck);   // Remove this once $user->admin is replaced everywhere with $user->isAdmin()
      $scheck = preg_replace('/\$user->isExternalUser/', '__VARUSERSOCID__', $scheck);
      $scheck = preg_replace('/\$user->socid/', '__VARUSERSOCID__', $scheck);     // Remove this once $user->admin is replaced everywhere with $user->isExternalUser()
      $scheck = preg_replace('/\‍(\$db\‍)/', '__VARDB__', $scheck);
      $scheck = preg_replace('/\$langs/', '__VARLANGSTRANS__', $scheck);
      $scheck = preg_replace('/\$mysoc/', '__VARMYSOC__', $scheck);
      $scheck = preg_replace('/\$action/', '__VARACTION__', $scheck);
      $scheck = preg_replace('/\$mainmenu/', '__VARMAINMENU__', $scheck);       // Remove this once all tests on $mainmenu has been replaced with isStringVarMatching
      $scheck = preg_replace('/\$leftmenu/', '__VARLEFTMENU__', $scheck);       // Remove this once all tests on $mainmenu has been replaced with isStringVarMatching
      $scheck = preg_replace('/\$websitepage/', '__VARWEBSITEPAGE__', $scheck);
      $scheck = preg_replace('/\$website/', '__VARWEBSITE__', $scheck);
      $scheck = preg_replace('/\$objectoffield/', '__VAROBJECTOFFIELD__', $scheck);
      $scheck = preg_replace('/\$object/', '__VAROBJECT__', $scheck);
      $scheck = preg_replace('/\$var/', '__VARVAR__', $scheck);
 
      // deprecated (now we use $objecf->canvas or $objectoffield->canvas)
      $scheck = preg_replace('/\$soc->canvas/', '__VARSOCCANVAS__', $scheck);
      $scheck = preg_replace('/\$obj->canvas/', '__VAROBJCANVAS__', $scheck);
 
      // Now test if it remains one '$'
      if (strpos($scheck, '$') !== false) {
        dol_syslog('Bad string syntax to evaluate (found use of $ not matching pattern: $user->hasRight, ($db), $langs, $mysoc, $action, $mainmenu, $leftmenu, $website, $websitepage, $objectoffield or $var123): ' . $s, LOG_WARNING);
        return 'Bad string syntax to evaluate (found use of $ not matching pattern: $user->hasRight, ($db), $langs, $mysoc, $action, $mainmenu, $leftmenu, $website, $websitepage, $objectoffield or $var123): ' . $s;
      }
    }
 
    // We block use of php exec or php file functions
    $forbiddenphpstrings = array('_ENV', '_SESSION', '_COOKIE', '_GET', '_GLOBAL', '_POST', '_REQUEST', 'ReflectionFunction', 'SplFileObject', 'SplTempFileObject');
 
    if (empty($dolibarr_main_restrict_eval_methods)) {  // If forced to ''
      // We list all forbidden function as keywords we don't want to see (we don't mind it if is "keyword(" or just "keyword", we don't want "keyword" at all)
      // We must exclude all functions that allow to execute another function. This includes all function that has a parameter with type "callable" to avoid things
      // like we can do with array_map and its callable parameter:  dol_eval('json_encode(array_map(implode("",["ex","ec"]), ["id"]))', 1, 1, '0')
      $forbiddenphpfunctions = array();
      $forbiddenphpmethods = array();
 
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("override_function", "session_id", "session_create_id", "session_regenerate_id"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("get_defined_functions", "get_defined_vars", "get_defined_constants", "get_declared_classes"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function"));
 
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("GETPOST")); // native dolibarr functions
 
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("ob_start"));
 
      // Functions with callable parameters
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("call_user_func", "call_user_func_array"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("array_all", "array_any", "array_diff_ukey", "array_filter", "array_find", "array_find_key", "array_map", "array_reduce", "array_intersect_uassoc", "array_intersect_ukey", "array_walk", "array_walk_recursive"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("usort", "uasort", "uksort"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("preg_replace_callback", "preg_replace_callback_array", "header_register_callback"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("error_log", "set_error_handler", "set_exception_handler", "libxml_set_external_entity_loader", "register_shutdown_function", "register_tick_function", "unregister_tick_function"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("spl_autoload_register", "spl_autoload_unregister", "iterator_apply", "session_set_save_handler"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("forward_static_call", "forward_static_call_array", "register_postsend_function"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("readline_completion_function", "readline_callback_handler_install"));
 
      // Exec functions
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("exec", "passthru", "shell_exec", "system", "proc_open", "popen"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("pcntl_alarm", "pcntl_exec", "pcntl_fork", "pcntl_waitpid", "pcntl_wait", "pcntl_wifexited", "pcntl_wifstopped", "pcntl_wifsignaled", "pcntl_wifcontinued", "pcntl_wexitstatus", "pcntl_wtermsig", "pcntl_wstopsig", "pcntl_signal"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("pcntl_signal_get_handler", "pcntl_signal_dispatch", "pcntl_get_last_error", "pcntl_strerror", "pcntl_sigprocmask", "pcntl_sigwaitinfo", "pcntl_sigtimedwait", "pcntl_getpriority", "pcntl_async_signals", "pcntl_unshare", ));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("putenv", "dl", "apache_child_terminate", "apache_setenv"));
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_eval", "dol_eval_new", "dol_eval_standard", "executeCLI", "verifCond", "dolEncrypt", "dolDecrypt"));  // native dolibarr functions
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("eval", "create_function", "assert", "mb_ereg_replace")); // function with eval capabilities
 
      // Include functions
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("require", "include", "require_once", "include_once"));
 
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_compress_dir", "dol_decode", "dol_dir_list", "dol_dir_list_in_database", "dol_delete_file", "dol_delete_dir", "dol_delete_dir_recursive", "dol_copy", "archiveOrBackupFile")); // more dolibarr functions
      $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("chdir", "dir", "fopen", "file", "file_exists", "file_get_contents", "file_put_contents", "fget", "fgetc", "fgetcsv", "flock", "fputs", "fputscsv", "fpassthru", "fscanf", "fseek", "fwrite", "is_file", "is_dir", "is_link", "mkdir", "opendir", "rmdir", "scandir", "symlink", "touch", "unlink", "umask"));
 
      if (!getDolGlobalString('MAIN_ALLOW_OBFUSCATION_METHODS_IN_DOL_EVAL')) {  // We disallow all function that allow to obfuscate the real name of a function
        // @phpcs:ignore
        $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("base64" . "_" . "decode", "rawurl" . "decode", "url" . "decode", "str" . "_rot13", "hex" . "2bin", "printf", "sprintf")); // name of forbidden functions are split to avoid false positive
        $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_concat", "dol_concatdesc"));    // native dolibarr functions
      }
      // Remove from blacklist the function that are into the whitelist
      /*foreach ($forbiddenphpfunctions as $key => $forbiddenphpfunction) {
        if (in_array($forbiddenphpfunction, $dolibarr_main_restrict_eval_methods_array)) {
          unset($forbiddenphpfunctions[$key]);
        }
      }*/
 
      $forbiddenphpmethods = array_merge($forbiddenphpmethods, array('invoke', 'invokeArgs'));  // Methods of ReflectionFunction to execute a function
      // Remove from blacklist the function that are into the whitelist
      /*foreach ($forbiddenphpmethods as $key => $forbiddenphpmethod) {
        if (in_array($forbiddenphpmethod, $dolibarr_main_restrict_eval_methods_array)) {
          unset($forbiddenphpmethods[$key]);
        }
      }*/
 
      $forbiddenphpregex = 'global\s*\$';
      $forbiddenphpregex .= '|posix_[a-zA-Z0-9_]*|';    // All posix functions
      $forbiddenphpregex .= '\b(' . implode('|', $forbiddenphpfunctions) . ')\b';
 
      $forbiddenphpmethodsregex = '->(' . implode('|', $forbiddenphpmethods) . ')';
 
      // Now scan all forbidden patterns
      do {
        $oldstringtoclean = $s;
        $s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
        $s = preg_replace('/' . $forbiddenphpregex . '/i', '__forbiddenstring__', $s);
        $s = preg_replace('/' . $forbiddenphpmethodsregex . '/i', '__forbiddenstring__', $s);
        //$s = preg_replace('/\$[a-zA-Z0-9_\->\$]+\‍(/i', '', $s); // Remove $function( call and $mycall->mymethod(
      } while ($oldstringtoclean != $s);
 
      if (strpos($s, '__forbiddenstring__') !== false) {
        dol_syslog('Bad string syntax to evaluate: ' . $s, LOG_WARNING);
        return 'Bad string syntax to evaluate: ' . $s;
      }
    }
 
    if (!empty($dolibarr_main_restrict_eval_methods)) {
      // Accept only white-listed allowed function and classes
      // TODO Get all pattern '/([\s\w]+)\‍(/', then check that $matches[1] is a defined class or a function into a given list
      $pattern = '/([\s\w\'\]\"]+)\‍(/';
 
      $matches = array();
      preg_match_all($pattern, $s, $matches);
 
      if (count($matches)) {
        foreach ($matches[1] as $m) {
          $m = trim($m);
          if (empty($m)) {
            continue;
          }
          $reg = array();
          if (!preg_match('/new ([A-Z][\w]+)/i', $m, $reg)) {
            if (!in_array($m, $dolibarr_main_restrict_eval_methods_array)) {
              if ($m != "'" && $m != '"') {
                dol_syslog('Bad string syntax to evaluate: ' . $s, LOG_WARNING);
                return 'Bad string syntax to evaluate. A function or method "'.$m.'" was called and is not into the parameter $dolibarr_main_restrict_eval_methods of white-listed functions and methods: ' . $s;
              }
            }
          } else {
            if (!class_exists($reg[1])) {
              dol_syslog('Bad string syntax to evaluate: Class "'.$reg[1].'" does not exist. ' . $s, LOG_WARNING);
              return 'Bad string syntax to evaluate. Class "'.$reg[1].'" does not exist. ' . $s;
            }
            $parents = class_parents($reg[1]);  // Get list of parent classes of class we want to check
            if (!in_array('CommonObject', $parents)) {  // Only classes that inherit CommonObject are ok. This forbid dangerous classes like ReflectionFunction, SplFileObject, ...
              dol_syslog('Bad string syntax to evaluate: Class "'.$reg[1].'" is not allowed because only classes extended CommonObject can be used in dynamic evaluation. ' . $s, LOG_WARNING);
              return 'Bad string syntax to evaluate. Class "'.$reg[1].'" is not allowed because only classes extended CommonObject can be used in dynamic evaluation. ' . $s;
            }
          }
        }
      }
 
      $forbiddenphpregex = 'global\s*\$';
      $forbiddenphpregex .= '|';      // or
      $forbiddenphpregex .= '}\s*\[';
      $forbiddenphpregex .= '|';      // or
      $forbiddenphpregex .= '\‍)\s*\‍(';
 
      // Now scan all forbidden patterns
      do {
        $oldstringtoclean = $s;
        $s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
        $s = preg_replace('/' . $forbiddenphpregex . '/i', '__forbiddenstring__', $s);
        //$s = preg_replace('/' . $forbiddenphpmethodsregex . '/i', '__forbiddenstring__', $s);
        //$s = preg_replace('/\$[a-zA-Z0-9_\->\$]+\‍(/i', '', $s); // Remove $function( call and $mycall->mymethod(
      } while ($oldstringtoclean != $s);
 
      if (strpos($s, '__forbiddenstring__') !== false) {
        dol_syslog('Bad string syntax to evaluate: ' . $s, LOG_WARNING);
        return 'Bad string syntax to evaluate: ' . $s;
      }
    }
 
    //print $s."<br>\n";
    ob_start(); // An evaluation has no reason to output data
    $isObBufferActive = true;
    $tmps = $hideerrors ? @eval('return ' . $s . ';') : eval('return ' . $s . ';');
    $tmpo = ob_get_clean();     // This close the buffer
    $isObBufferActive = false;
    if ($tmpo) {
      print 'Bad string syntax to evaluate. Some data were output when it should not when evaluating: ' . $s;
    }
    return $tmps;
  } catch (Exception $e) {
    if ($isObBufferActive) {
      // Clean up buffer which was left behind due to exception.
      $tmpo = ob_get_clean();   // This close the buffer
      $isObBufferActive = false;
    }
    $error = 'dol_eval try/catch error for string: ' . $s . ' - Error: ';
    $error .= $e->getMessage();
    dol_syslog($error, LOG_WARNING);
    return 'Exception during evaluation: ' . $s;
  } catch (Error $e) {
    if ($isObBufferActive) {
      // Clean up buffer which was left behind due to exception.
      $tmpo = ob_get_clean();   // This close the buffer
      $isObBufferActive = false;
    }
    $error = 'dol_eval try/catch error for string: ' . $s . ' - Error: ';
    $error .= $e->getMessage();
    dol_syslog($error, LOG_WARNING);
    return 'Exception during evaluation: ' . $s;
  }
}
 
function dol_validElement($element)
{
  return (trim($element) != '');
}
 
 
function getLanguageCodeFromCountryCode($countrycode)
{
  global $mysoc;
 
  if (empty($countrycode)) {
    return null;
  }
 
  if (strtoupper($countrycode) == 'MQ') {
    return 'fr_CA';
  }
  if (strtoupper($countrycode) == 'SE') {
    return 'sv_SE'; // se_SE is Sami/Sweden, and we want in priority sv_SE for SE country
  }
  if (strtoupper($countrycode) == 'CH') {
    if ($mysoc->country_code == 'FR') {
      return 'fr_CH';
    }
    if ($mysoc->country_code == 'DE') {
      return 'de_CH';
    }
    if ($mysoc->country_code == 'IT') {
      return 'it_CH';
    }
  }
 
  // Locale list taken from:
  // http://stackoverflow.com/questions/3191664/
  // list-of-all-locales-and-their-short-codes
  $locales = array(
    'af-ZA',
    'am-ET',
    'ar-AE',
    'ar-BH',
    'ar-DZ',
    'ar-EG',
    'ar-IQ',
    'ar-JO',
    'ar-KW',
    'ar-LB',
    'ar-LY',
    'ar-MA',
    'ar-OM',
    'ar-QA',
    'ar-SA',
    'ar-SY',
    'ar-TN',
    'ar-YE',
    //'as-IN',    // Moved after en-IN
    'ba-RU',
    'be-BY',
    'bg-BG',
    'bn-BD',
    //'bn-IN',    // Moved after en-IN
    'bo-CN',
    'br-FR',
    'ca-ES',
    'co-FR',
    'cs-CZ',
    'cy-GB',
    'da-DK',
    'de-AT',
    'de-CH',
    'de-DE',
    'de-LI',
    'de-LU',
    'dv-MV',
    'el-GR',
    'en-AU',
    'en-BZ',
    'en-CA',
    'en-GB',
    'en-IE',
    'en-IN',
    'as-IN',  // as-IN must be after en-IN (en in priority if country is IN)
    'bn-IN',  // bn-IN must be after en-IN (en in priority if country is IN)
    'en-JM',
    'en-MY',
    'en-NZ',
    'en-PH',
    'en-SG',
    'en-TT',
    'en-US',
    'en-ZA',
    'en-ZW',
    'es-AR',
    'es-BO',
    'es-CL',
    'es-CO',
    'es-CR',
    'es-DO',
    'es-EC',
    'es-ES',
    'es-GT',
    'es-HN',
    'es-MX',
    'es-NI',
    'es-PA',
    'es-PE',
    'es-PR',
    'es-PY',
    'es-SV',
    'es-US',
    'es-UY',
    'es-VE',
    'et-EE',
    'eu-ES',
    'fa-IR',
    'fi-FI',
    'fo-FO',
    'fr-BE',
    'fr-CA',
    'fr-CH',
    'fr-FR',
    'fr-LU',
    'fr-MC',
    'fy-NL',
    'ga-IE',
    'gd-GB',
    'gl-ES',
    'gu-IN',
    'he-IL',
    'hi-IN',
    'hr-BA',
    'hr-HR',
    'hu-HU',
    'hy-AM',
    'id-ID',
    'ig-NG',
    'ii-CN',
    'is-IS',
    'it-CH',
    'it-IT',
    'ja-JP',
    'ka-GE',
    'kk-KZ',
    'kl-GL',
    'km-KH',
    'kn-IN',
    'ko-KR',
    'ky-KG',
    'lb-LU',
    'lo-LA',
    'lt-LT',
    'lv-LV',
    'mi-NZ',
    'mk-MK',
    'ml-IN',
    'mn-MN',
    'mr-IN',
    'ms-BN',
    'ms-MY',
    'mt-MT',
    'nb-NO',
    'ne-NP',
    'nl-BE',
    'nl-NL',
    'nn-NO',
    'oc-FR',
    'or-IN',
    'pa-IN',
    'pl-PL',
    'ps-AF',
    'pt-BR',
    'pt-PT',
    'rm-CH',
    'ro-MD',
    'ro-RO',
    'ru-RU',
    'rw-RW',
    'sa-IN',
    'se-FI',
    'se-NO',
    'se-SE',
    'si-LK',
    'sk-SK',
    'sl-SI',
    'sq-AL',
    'sv-FI',
    'sv-SE',
    'sw-KE',
    'ta-IN',
    'te-IN',
    'th-TH',
    'tk-TM',
    'tn-ZA',
    'tr-TR',
    'tt-RU',
    'ug-CN',
    'uk-UA',
    'ur-PK',
    'vi-VN',
    'wo-SN',
    'xh-ZA',
    'yo-NG',
    'zh-CN',
    'zh-HK',
    'zh-MO',
    'zh-SG',
    'zh-TW',
    'zu-ZA',
  );
 
  $buildprimarykeytotest = strtolower($countrycode) . '-' . strtoupper($countrycode);
  if (in_array($buildprimarykeytotest, $locales)) {
    return strtolower($countrycode) . '_' . strtoupper($countrycode);
  }
 
  if (function_exists('locale_get_primary_language') && function_exists('locale_get_region')) {    // Need extension php-intl
    foreach ($locales as $locale) {
      $locale_language = locale_get_primary_language($locale);
      $locale_region = locale_get_region($locale);
      if (strtoupper($countrycode) == $locale_region) {
        //var_dump($locale.' - '.$locale_language.' - '.$locale_region);
        return strtolower($locale_language) . '_' . strtoupper($locale_region);
      }
    }
  } else {
    dol_syslog("Warning Extension php-intl is not available", LOG_WARNING);
  }
 
  return null;
}
 
function complete_head_from_modules($conf, $langs, $object, &$head, &$h, $type, $mode = 'add', $filterorigmodule = '')
{
  global $hookmanager, $db;
 
  if (isset($conf->modules_parts['tabs'][$type]) && is_array($conf->modules_parts['tabs'][$type])) {
    foreach ($conf->modules_parts['tabs'][$type] as $value) {
      $values = explode(':', $value);
 
      $reg = array();
      if ($mode == 'add' && !preg_match('/^\-/', $values[1])) {
        if (count($values) !== 6) {
          dol_syslog('The module_parts["tabs"] entries must be composed of 6 values separated by ":", but got "' . $value . '". Please check your module descriptor classes.', LOG_ERR);
          continue;
        }
 
        // new declaration with permissions:
        // $value='objecttype:+tabname1:Title1:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
        // $value='objecttype:+tabname1:Title1,class,pathfile,method:langfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'
        if ($values[0] != $type) {
          continue;
        }
 
        $newtab = array();
        $postab = $h;
        // detect if position set in $values[1] ie : +(2)mytab@mymodule (first tab is 0, second is one, ...)
        $str = $values[1];
        $posstart = strpos($str, '(');
        if ($posstart > 0) {
          $posend = strpos($str, ')');
          if ($posstart > 0) {
            $res1 = substr($str, $posstart + 1, $posend - $posstart - 1);
            if (is_numeric($res1)) {
              $postab = (int) $res1;
              $values[1] = '+' . substr($str, $posend + 1);
            }
          }
        }
 
        global $objectoffield;      // So we can use $objectoffield int verifCond
        $objectoffield = $object;
 
        if (!verifCond($values[4], '2')) {
          continue;
        }
 
        if ($values[3]) {
          if ($filterorigmodule) {  // If a filter of module origin has been requested
            if (strpos($values[3], '@')) {  // This is an external module
              if ($filterorigmodule != 'external') {
                continue;
              }
            } else {  // This looks a core module
              if ($filterorigmodule != 'core') {
                continue;
              }
            }
          }
          $langs->load($values[3]);
        }
 
        if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
          // If label is "SUBSTITUION_..."
          $substitutionarray = array();
          complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey' => $values[2]));
          $label = make_substitutions($reg[1], $substitutionarray);
        } else {
          // If label is "Label,Class,File,Method", we call the method to show content inside the badge
          $labeltemp = explode(',', $values[2]);
          $label = $langs->trans($labeltemp[0]);
 
          if (!empty($labeltemp[1]) && is_object($object) && !empty($object->id)) {
            dol_include_once($labeltemp[2]);
            $classtoload = $labeltemp[1];
            if (class_exists($classtoload)) {
              $obj = new $classtoload($db);
              $function = $labeltemp[3];
              if ($obj && $function && method_exists($obj, $function)) {
                // @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
                $nbrec = $obj->$function($object->id, $obj);
                if (!empty($nbrec)) {
                  $label .= '<span class="badge marginleftonlyshort">' . $nbrec . '</span>';
                }
              }
            }
          }
        }
        $url = preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[5]);
        $link = parse_url($url);
        $query = [];
        if (isset($link['query'])) {
          parse_str($link['query'], $query);
        }
        $newtab[0] = dolBuildUrl(dol_buildpath($link['path'], 1), $query);
        $newtab[1] = $label;
        $newtab[2] = str_replace('+', '', $values[1]);
        $h++;
 
        // set tab at its position
        $head = array_merge(array_slice($head, 0, $postab), array($newtab), array_slice($head, $postab));
      } elseif ($mode == 'remove' && preg_match('/^\-/', $values[1])) {
        if ($values[0] != $type) {
          continue;
        }
        $tabname = str_replace('-', '', $values[1]);
        foreach ($head as $key => $val) {
          $condition = (!empty($values[3]) ? verifCond($values[3], '2') : 1);
          //var_dump($key.' - '.$tabname.' - '.$head[$key][2].' - '.$values[3].' - '.$condition);
          if ($head[$key][2] == $tabname && $condition) {
            unset($head[$key]);
            break;
          }
        }
      }
    }
  }
 
  // No need to make a return $head. Var is modified as a reference
  if (!empty($hookmanager)) {
    $parameters = array('object' => $object, 'mode' => $mode, 'head' => &$head, 'filterorigmodule' => $filterorigmodule, 'type' => $type);
    // @phan-suppress-next-line PhanTypeMismatchArgumentNullable
    $reshook = $hookmanager->executeHooks('completeTabsHead', $parameters, $object);
    if ($reshook > 0) {   // Hook ask to replace completely the array
      $head = $hookmanager->resArray;
    } else {        // Hook
      $head = array_merge($head, $hookmanager->resArray);
    }
    $h = count($head);
  }
}
 
 
function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
{
  if (is_null($string)) {
    return array();
  }
 
  if (preg_match('/^\[.*\]$/sm', $delimiter) || preg_match('/^\‍(.*\‍)$/sm', $delimiter)) {
    // This is a regex string
    $newdelimiter = $delimiter;
  } else {
    // This is a simple string
    // @phan-suppress-next-line PhanPluginSuspiciousParamPositionInternal
    $newdelimiter = preg_quote($delimiter, '/');
  }
 
  if ($a = preg_split('/' . $newdelimiter . '/', $string)) {
    $ka = array();
    foreach ($a as $s) { // each part
      if ($s) {
        if ($pos = strpos($s, $kv)) { // key/value delimiter
          $ka[trim(substr($s, 0, $pos))] = trim(substr($s, $pos + strlen($kv)));
        } else { // key delimiter not found
          $ka[] = trim($s);
        }
      }
    }
    return $ka;
  }
 
  return array();
}
 
function dolExplodeKeepIfQuotes($input)
{
  // Use regexp to capture words and section in quotes
  $matches = array();
  preg_match_all('/"([^"]*)"|\'([^\']*)\'|(\S+)/', $input, $matches);
 
  // Merge result and delete empty values
 
  $result = array_map(
    static function ($a, $b, $c) {
      if ($a !== '') {
        return $a;
      }
      if ($b !== '') {
        return $b;
      }
      if ($c !== '') {
        return $c;
      }
      return '';
    },
    $matches[1],
    $matches[2],
    $matches[3]
  );
  return array_values(array_filter(
    $result,
    static function ($val) {
      return $val !== '';
    }
  ));
}
 
 
function dol_getmypid()
{
  if (!function_exists('getmypid')) {
    return mt_rand(99900000, 99965535);
  } else {
    return getmypid();  // May be a number on 64 bits (depending on OS)
  }
}
 
function natural_search($fields, $value, $mode = 0, $nofirstand = 0, $sqltoadd = '')
{
  global $db, $langs;
 
  $value = trim($value);
 
  if ($mode == 0) {
    $value = preg_replace('/\*/', '%', $value); // Replace * with %
  }
  if ($mode == 1) {
    $value = preg_replace('/([!<>=]+)\s+([0-9' . preg_quote($langs->trans("SeparatorDecimal"), '/') . '\-])/', '\1\2', $value); // Clean string '< 10' into '<10' so we can then explode on space to get all tests to do
  }
 
  $value = preg_replace('/\s*\|\s*/', '|', $value);
 
  // Split criteria on ' ' but not if we are inside quotes.
  // For mode 3, the split is done later on the , only and not on the ' '.
  if ($mode != -3 && $mode != 3) {
    $crits = dolExplodeKeepIfQuotes($value);
  } else {
    $crits = array($value);
  }
 
  $res = '';
  if (!is_array($fields)) {
    $fields = array($fields);
  }
  $i1 = 0;  // count the nb of "and" criteria added (all fields / criteria)
  foreach ($crits as $crit) {   // Loop on each AND criteria
    $crit = trim($crit);
    $i2 = 0;  // count the nb of valid criteria added for this this first criteria
    $newres = '';
 
    foreach ($fields as $field) {
      if ($mode == 1) {
        $tmpcrits = explode('|', $crit);
        $i3 = 0;  // count the nb of valid criteria added for this current field
        foreach ($tmpcrits as $tmpcrit) {
          if ($tmpcrit !== '0' && empty($tmpcrit)) {
            continue;
          }
          $tmpcrit = trim($tmpcrit);
 
          $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
 
          $operator = '=';
          $newcrit = preg_replace('/([!<>=]+)/', '', $tmpcrit);
 
          $reg = array();
          preg_match('/([!<>=]+)/', $tmpcrit, $reg);
          if (!empty($reg[1])) {
            $operator = $reg[1];
          }
          if ($newcrit != '') {
            $numnewcrit = price2num($newcrit);
            if (is_numeric($numnewcrit)) {
              $newres .= $db->sanitize($field) . ' ' . $operator . ' ' . ((float) $numnewcrit); // should be a numeric
            } else {
              $newres .= '1 = 2'; // force false, we received a corrupted data
            }
            $i3++; // a criteria was added to string
          }
        }
        $i2++; // a criteria for 1 more field was added to string
      } elseif ($mode == 2 || $mode == -2) {
        $crit = preg_replace('/[^\-0-9,]/', '', $crit); // ID are always integer
        $newres .= ($i2 > 0 ? ' OR ' : '') . $db->sanitize($field) . " " . ($mode == -2 ? 'NOT ' : '');
        $newres .= $crit ? "IN (" . $db->sanitize($db->escape($crit)) . ")" : "IN (0)";
        if ($mode == -2) {
          $newres .= ' OR ' . $db->sanitize($field) . ' IS NULL';
        }
        $i2++; // a criteria for 1 more field was added to string
      } elseif ($mode == 3 || $mode == -3) {
        $tmparray = explode(',', $crit);
        if (count($tmparray)) {
          $listofcodes = '';
          $listofcodesnot = '';
          foreach ($tmparray as $val) {
            $val = trim($val);
            if ($val !== '') {
              if (preg_match('/^!/', $val)) {
                $listofcodesnot .= ($listofcodesnot ? ',' : '');
                $listofcodesnot .= "'" . $db->escape(preg_replace('/^!=?/', '', $val)) . "'";
              } else {
                $listofcodes .= ($listofcodes ? ',' : '');
                $listofcodes .= "'" . $db->escape($val) . "'";
              }
            }
          }
          $newres .= ($i2 > 0 ? ' OR ' : '');
          if ($listofcodes && $listofcodesnot) {
            $newres .= '(';
          }
          if ($listofcodes) {
            $newres .= $db->sanitize($field) . " " . ($mode == -3 ? 'NOT IN' : 'IN') . " (" . $db->sanitize($listofcodes, 1, 0, 1) . ")";
          }
          if ($listofcodes && $listofcodesnot) {
            $newres .= ' AND ';
          }
          if ($listofcodesnot) {
            $newres .= $db->sanitize($field) . " " . ($mode == -3 ? 'IN ' : 'NOT IN') . " (" . $db->sanitize($listofcodesnot, 1, 0, 1) . ")";
          }
          if ($listofcodes && $listofcodesnot) {
            $newres .= ')';
          }
          $i2++; // a criteria for 1 more field was added to string
        }
        if ($mode == -3) {
          $newres .= ' OR ' . $db->sanitize($field) . ' IS NULL';
        }
      } elseif ($mode == 4) {
        $tmparray = explode(',', $crit);
        if (count($tmparray)) {
          $listofcodes = '';
          foreach ($tmparray as $val) {
            $val = trim($val);
            if ($val) {
              $newres .= ($i2 > 0 ? " OR (" : "(") . $db->sanitize($field) . " LIKE '" . $db->escape($val) . ",%'";
              $newres .= ' OR ' . $db->sanitize($field) . " = '" . $db->escape($val) . "'";
              $newres .= ' OR ' . $db->sanitize($field) . " LIKE '%," . $db->escape($val) . "'";
              $newres .= ' OR ' . $db->sanitize($field) . " LIKE '%," . $db->escape($val) . ",%'";
              $newres .= ')';
              $i2++; // a criteria for 1 more field was added to string (we can add several criteria for the same field as it is a multiselect search criteria)
            }
          }
        }
      } else { // $mode=0
        $tmpcrits = explode('|', $crit);
        $i3 = 0;  // count the nb of valid criteria added for the current couple criteria/field
        foreach ($tmpcrits as $tmpcrit) { // loop on each OR criteria
          if ($tmpcrit !== '0' && empty($tmpcrit)) {
            continue;
          }
          $tmpcrit = trim($tmpcrit);
 
          if ($tmpcrit == '^$' || strpos($crit, '!') === 0) { // If we search empty, we must combined different OR fields with AND
            $newres .= (($i2 > 0 || $i3 > 0) ? ' AND ' : '');
          } else {
            $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
          }
 
          $isSellist = false;
          $table = $label = $key = null;
 
          if (strpos($field, 'ef.') === 0) {
            $extrafieldName = substr($field, 3);
            $extrafields = new ExtraFields($db);
            $extrafields->fetch_name_optionals_label('product');
 
            if (isset($extrafields->attributes['product']['type'][$extrafieldName]) && $extrafields->attributes['product']['type'][$extrafieldName] === 'sellist') {
              $isSellist = true;
              $paramArray = $extrafields->attributes['product']['param'][$extrafieldName]['options'] ?? [];
              $param = array_key_first($paramArray);
              list($table, $label, $key) = explode(':', $param);
            }
          }
 
          if (preg_match('/\.(id|rowid)$/', $field)) {  // Special case for rowid that is sometimes a ref so used as a search field
            $newres .= $db->sanitize($field) . " = " . (is_numeric($tmpcrit) ? ((float) $tmpcrit) : '0');
          } else {
            $tmpcrit2 = $tmpcrit;
            $tmpbefore = '%';
            $tmpafter = '%';
            $tmps = '';
 
            if ($isSellist) {
              $newres .= $field . " IN (SELECT t." . $key . " FROM " . $db->prefix() . $table . " AS t WHERE t." . $label . " LIKE '%" . $db->escape($tmpcrit2) . "%')";
            } else {
              if (preg_match('/^!/', $tmpcrit)) {
                $tmps .= $db->sanitize($field) . " NOT LIKE "; // ! as exclude character
                $tmpcrit2 = preg_replace('/^!/', '', $tmpcrit2);
              } else {
                $tmps .= $db->sanitize($field) . " LIKE ";
              }
              $tmps .= "'";
 
              if (preg_match('/^[\^\$]/', $tmpcrit)) {
                $tmpbefore = '';
                $tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
              }
              if (preg_match('/[\^\$]$/', $tmpcrit)) {
                $tmpafter = '';
                $tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
              }
 
              if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
                $tmps = "(" . $tmps;
              }
              $newres .= $tmps;
              $newres .= $tmpbefore;
              $newres .= $db->escape($tmpcrit2);
              $newres .= $tmpafter;
              $newres .= "'";
              if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
                $newres .= " OR " . $field . " IS NULL)";
              }
            }
          }
 
          $i3++;
        }
 
        $i2++; // a criteria for 1 more field was added to string
      }
    }
 
    if ($sqltoadd) {
      $newres .= ($newres ? '' : ' OR ').str_replace('__KEYTOSEARCH__', $crit, $sqltoadd);
    }
 
    if ($newres) {
      $res = $res . ($res ? ' AND ' : '') . ($i2 > 1 ? '(' : '') . $newres . ($i2 > 1 ? ')' : '');
    }
    $i1++;
  }
  $res = ($nofirstand ? "" : " AND ") . "(" . $res . ")";
 
  return $res;
}
 
 
function getImageFileNameForSize($file, $extName, $extImgTarget = '')
{
  $dirName = dirname($file);
  if ($dirName == '.') {
    $dirName = '';
  }
 
  if (!in_array($extName, array('', '_small', '_mini'))) {
    return 'Bad parameter extName';
  }
 
  $fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp|\.webp|\.avif)$/i', '', $file); // We remove image extension, whatever is its case
  $fileName = basename($fileName);
 
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.jpg$/i', $file) ? '.jpg' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.jpeg$/i', $file) ? '.jpeg' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.gif$/i', $file) ? '.gif' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.png$/i', $file) ? '.png' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.bmp$/i', $file) ? '.bmp' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.webp$/i', $file) ? '.webp' : '');
  }
  if (empty($extImgTarget)) {
    $extImgTarget = (preg_match('/\.avif$/i', $file) ? '.avif' : '');
  }
 
  if (!$extImgTarget) {
    return $file;
  }
 
  $subdir = '';
  if ($extName) {
    $subdir = 'thumbs/';
  }
 
  return ($dirName ? $dirName . '/' : '') . $subdir . $fileName . $extName . $extImgTarget; // New filename for thumb
}
 
 
function getLabelSpecialCode($idcode)
{
  global $langs;
 
  $arrayspecialines = array(1 => 'Transport', 2 => 'EcoTax', 3 => 'Option');
  if ($idcode > 10) {
    return 'Module ID ' . $idcode;
  }
  if (!empty($arrayspecialines[$idcode])) {
    return $langs->trans($arrayspecialines[$idcode]);
  }
  return '';
}
 
 
function dolIsAllowedForPreview($file)
{
  // Check .noexe extension in filename
  if (preg_match('/\.noexe$/i', $file)) {
    return 0;
  }
 
  // Check mime types
  $mime_preview = array('avif', 'bmp', 'jpeg', 'png', 'gif', 'tiff', 'pdf', 'plain', 'css', 'webp', 'webm', 'mp4');
  if (getDolGlobalString('MAIN_ALLOW_SVG_FILES_AS_IMAGES')) {
    $mime_preview[] = 'svg+xml';
  }
  //$mime_preview[]='vnd.oasis.opendocument.presentation';
  //$mime_preview[]='archive';
  $num_mime = array_search(dol_mimetype($file, '', 1), $mime_preview);
  if ($num_mime !== false) {
    return 1;
  }
 
  // By default, not allowed for preview
  return 0;
}
 
 
function dol_mimetype($file, $default = 'application/octet-stream', $mode = 0)
{
  $mime = $default;
  $imgmime = 'other.png';
  $famime = 'file-o';
  $srclang = '';
 
  $tmpfile = preg_replace('/\.noexe$/', '', $file);
 
  // Plain text files
  if (preg_match('/\.txt$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.rtx$/i', $tmpfile)) {
    $mime = 'text/richtext';
    $imgmime = 'text.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.csv$/i', $tmpfile)) {
    $mime = 'text/csv';
    $imgmime = 'text.png';
    $famime = 'file-csv';
  } elseif (preg_match('/\.tsv$/i', $tmpfile)) {
    $mime = 'text/tab-separated-values';
    $imgmime = 'text.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.(cf|conf|log)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.ini$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'ini';
    $famime = 'file-alt';
  } elseif (preg_match('/\.md$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'md';
    $famime = 'file-alt';
  } elseif (preg_match('/\.css$/i', $tmpfile)) {
    $mime = 'text/css';
    $imgmime = 'css.png';
    $srclang = 'css';
    $famime = 'file-alt';
  } elseif (preg_match('/\.lang$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'lang';
    $famime = 'file-alt';
  } elseif (preg_match('/\.(crt|cer|key|pub)$/i', $tmpfile)) {  // Certificate files
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.(html|htm|shtml)$/i', $tmpfile)) {   // XML based (HTML/XML/XAML)
    $mime = 'text/html';
    $imgmime = 'html.png';
    $srclang = 'html';
    $famime = 'file-alt';
  } elseif (preg_match('/\.(xml|xhtml)$/i', $tmpfile)) {
    $mime = 'text/xml';
    $imgmime = 'other.png';
    $srclang = 'xml';
    $famime = 'file-alt';
  } elseif (preg_match('/\.xaml$/i', $tmpfile)) {
    $mime = 'text/xml';
    $imgmime = 'other.png';
    $srclang = 'xaml';
    $famime = 'file-alt';
  } elseif (preg_match('/\.bas$/i', $tmpfile)) {          // Languages
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'bas';
    $famime = 'file-code';
  } elseif (preg_match('/\.(c)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'c';
    $famime = 'file-code';
  } elseif (preg_match('/\.(cpp)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'cpp';
    $famime = 'file-code';
  } elseif (preg_match('/\.cs$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'cs';
    $famime = 'file-code';
  } elseif (preg_match('/\.(h)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'h';
    $famime = 'file-code';
  } elseif (preg_match('/\.(java|jsp)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'java';
    $famime = 'file-code';
  } elseif (preg_match('/\.php([0-9]{1})?$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'php.png';
    $srclang = 'php';
    $famime = 'file-code';
  } elseif (preg_match('/\.phtml$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'php.png';
    $srclang = 'php';
    $famime = 'file-code';
  } elseif (preg_match('/\.(pl|pm)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'pl.png';
    $srclang = 'perl';
    $famime = 'file-code';
  } elseif (preg_match('/\.sql$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'sql';
    $famime = 'file-code';
  } elseif (preg_match('/\.js$/i', $tmpfile)) {
    $mime = 'text/x-javascript';
    $imgmime = 'jscript.png';
    $srclang = 'js';
    $famime = 'file-code';
  } elseif (preg_match('/\.odp$/i', $tmpfile)) {          // Open office
    $mime = 'application/vnd.oasis.opendocument.presentation';
    $imgmime = 'ooffice.png';
    $famime = 'file-powerpoint';
  } elseif (preg_match('/\.ods$/i', $tmpfile)) {
    $mime = 'application/vnd.oasis.opendocument.spreadsheet';
    $imgmime = 'ooffice.png';
    $famime = 'file-excel';
  } elseif (preg_match('/\.odt$/i', $tmpfile)) {
    $mime = 'application/vnd.oasis.opendocument.text';
    $imgmime = 'ooffice.png';
    $famime = 'file-word';
  } elseif (preg_match('/\.mdb$/i', $tmpfile)) {          // MS Office
    $mime = 'application/msaccess';
    $imgmime = 'mdb.png';
    $famime = 'file';
  } elseif (preg_match('/\.doc[xm]?$/i', $tmpfile)) {
    $mime = 'application/msword';
    $imgmime = 'doc.png';
    $famime = 'file-word';
  } elseif (preg_match('/\.dot[xm]?$/i', $tmpfile)) {
    $mime = 'application/msword';
    $imgmime = 'doc.png';
    $famime = 'file-word';
  } elseif (preg_match('/\.xlt(x)?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel';
  } elseif (preg_match('/\.xla(m)?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel';
  } elseif (preg_match('/\.xls$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel';
  } elseif (preg_match('/\.xls[bmx]$/i', $tmpfile)) {
    $mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
    $imgmime = 'xls.png';
    $famime = 'file-excel';
  } elseif (preg_match('/\.pps[mx]?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-powerpoint';
    $imgmime = 'ppt.png';
    $famime = 'file-powerpoint';
  } elseif (preg_match('/\.ppt[mx]?$/i', $tmpfile)) {
    $mime = 'application/x-mspowerpoint';
    $imgmime = 'ppt.png';
    $famime = 'file-powerpoint';
  } elseif (preg_match('/\.pdf$/i', $tmpfile)) {          // Other
    $mime = 'application/pdf';
    $imgmime = 'pdf.png';
    $famime = 'file-pdf';
  } elseif (preg_match('/\.bat$/i', $tmpfile)) {          // Scripts
    $mime = 'text/x-bat';
    $imgmime = 'script.png';
    $srclang = 'dos';
    $famime = 'file-code';
  } elseif (preg_match('/\.sh$/i', $tmpfile)) {
    $mime = 'text/x-sh';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code';
  } elseif (preg_match('/\.ksh$/i', $tmpfile)) {
    $mime = 'text/x-ksh';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code';
  } elseif (preg_match('/\.bash$/i', $tmpfile)) {
    $mime = 'text/x-bash';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code';
  } elseif (preg_match('/\.ico$/i', $tmpfile)) {          // Images
    $mime = 'image/x-icon';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.(jpg|jpeg)$/i', $tmpfile)) {
    $mime = 'image/jpeg';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.png$/i', $tmpfile)) {
    $mime = 'image/png';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.gif$/i', $tmpfile)) {
    $mime = 'image/gif';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.bmp$/i', $tmpfile)) {
    $mime = 'image/bmp';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.(tif|tiff)$/i', $tmpfile)) {
    $mime = 'image/tiff';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.svg$/i', $tmpfile)) {
    $mime = 'image/svg+xml';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.webp$/i', $tmpfile)) {
    $mime = 'image/webp';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.vcs$/i', $tmpfile)) {          // Calendar
    $mime = 'text/calendar';
    $imgmime = 'other.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.ics$/i', $tmpfile)) {
    $mime = 'text/calendar';
    $imgmime = 'other.png';
    $famime = 'file-alt';
  } elseif (preg_match('/\.torrent$/i', $tmpfile)) {        // Other
    $mime = 'application/x-bittorrent';
    $imgmime = 'other.png';
    $famime = 'file-o';
  } elseif (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i', $tmpfile)) { // Audio
    $mime = 'audio';
    $imgmime = 'audio.png';
    $famime = 'file-audio';
  } elseif (preg_match('/\.mp4$/i', $tmpfile)) {          // Video
    $mime = 'video/mp4';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.ogv$/i', $tmpfile)) {
    $mime = 'video/ogg';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.webm$/i', $tmpfile)) {
    $mime = 'video/webm';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.avif$/i', $tmpfile)) {
    $mime = 'image/avif';
    $imgmime = 'image.png';
    $famime = 'file-image';
  } elseif (preg_match('/\.avi$/i', $tmpfile)) {
    $mime = 'video/x-msvideo';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.divx$/i', $tmpfile)) {
    $mime = 'video/divx';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.xvid$/i', $tmpfile)) {
    $mime = 'video/xvid';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.(wmv|mpg|mpeg)$/i', $tmpfile)) {
    $mime = 'video';
    $imgmime = 'video.png';
    $famime = 'file-video';
  } elseif (preg_match('/\.(zip|rar|gz|tgz|xz|z|cab|bz2|7z|tar|lzh|zst)$/i', $tmpfile)) { // Archive
    // application/xxx where zzz is zip, ...
    $mime = 'archive';
    $imgmime = 'archive.png';
    $famime = 'file-archive';
  } elseif (preg_match('/\.(exe|com)$/i', $tmpfile)) {          // Exe
    $mime = 'application/octet-stream';
    $imgmime = 'other.png';
    $famime = 'file-o';
  } elseif (preg_match('/\.(dll|lib|o|so|a)$/i', $tmpfile)) {       // Lib
    $mime = 'library';
    $imgmime = 'library.png';
    $famime = 'file-o';
  } elseif (preg_match('/\.err$/i', $tmpfile)) {               // phpcs:ignore
    $mime = 'error';
    $imgmime = 'error.png';
    $famime = 'file-alt';
  }
 
  if ($famime == 'file-o') {
    // file-o seems to not work in fontawesome 5
    $famime = 'file';
  }
 
  // Return mimetype string
  switch ((int) $mode) {
    case 1:
      $tmp = explode('/', $mime);
      return (!empty($tmp[1]) ? $tmp[1] : $tmp[0]);
    case 2:
      return $imgmime;
    case 3:
      return $srclang;
    case 4:
      return $famime;
  }
  return $mime;
}
 
function getDictionaryValue($tablename, $field, $id, $checkentity = false, $rowidfield = 'rowid')
{
  global $conf, $db;
 
  $tablename = preg_replace('/^' . preg_quote(MAIN_DB_PREFIX, '/') . '/', '', $tablename);  // Clean name of table for backward compatibility.
 
  $dictvalues = (isset($conf->cache['dictvalues_' . $tablename]) ? $conf->cache['dictvalues_' . $tablename] : null);
 
  if (is_null($dictvalues)) {
    $dictvalues = array();
 
    $sql = "SELECT * FROM " . MAIN_DB_PREFIX . $tablename . " WHERE 1 = 1"; // Here select * is allowed as it is generic code and we don't have list of fields
    if ($checkentity) {
      $sql .= ' AND entity IN (0,' . getEntity($tablename) . ')';
    }
 
    $resql = $db->query($sql);
    if ($resql) {
      while ($obj = $db->fetch_object($resql)) {
        $dictvalues[$obj->$rowidfield] = $obj;  // $obj is stdClass
      }
    } else {
      dol_print_error($db);
    }
 
    $conf->cache['dictvalues_' . $tablename] = $dictvalues;
  }
 
  if (!empty($dictvalues[$id])) {
    // Found
    $tmp = $dictvalues[$id];
    return (property_exists($tmp, $field) ? $tmp->$field : '');
  } else {
    // Not found
    return '';
  }
}
 
function colorIsLight($stringcolor)
{
  $stringcolor = str_replace('#', '', $stringcolor);
  $res = -1;
  if (!empty($stringcolor)) {
    $res = 0;
    $tmp = explode(',', $stringcolor);
    if (count($tmp) > 1) {   // This is a comma RGB ('255','255','255')
      $r = $tmp[0];
      $g = $tmp[1];
      $b = $tmp[2];
    } else {
      $hexr = $stringcolor[0] . $stringcolor[1];
      $hexg = $stringcolor[2] . $stringcolor[3];
      $hexb = $stringcolor[4] . $stringcolor[5];
      $r = hexdec($hexr);
      $g = hexdec($hexg);
      $b = hexdec($hexb);
    }
    $bright = (max($r, $g, $b) + min($r, $g, $b)) / 510.0; // HSL algorithm
    if ($bright > 0.6) {
      $res = 1;
    }
  }
  return $res;
}
 
function isVisibleToUserType($type_user, &$menuentry, &$listofmodulesforexternal)
{
  //print 'type_user='.$type_user.' module='.$menuentry['module'].' enabled='.$menuentry['enabled'].' perms='.$menuentry['perms'];
  //print 'ok='.in_array($menuentry['module'], $listofmodulesforexternal);
  if (empty($menuentry['enabled'])) {
    return 0; // Entry disabled by condition
  }
  if ($type_user && array_key_exists('module', $menuentry) && $menuentry['module']) {
    $tmploops = explode('|', $menuentry['module']);
    $found = 0;
    foreach ($tmploops as $tmploop) {
      if (in_array($tmploop, $listofmodulesforexternal)) {
        $found++;
        break;
      }
    }
    if (!$found) {
      return 0; // Entry is for menus all excluded to external users
    }
  }
  if (!$menuentry['perms'] && $type_user) {
    return 0; // No permissions and user is external
  }
  if (!$menuentry['perms'] && getDolGlobalString('MAIN_MENU_HIDE_UNAUTHORIZED')) {
    return 0; // No permissions and option to hide when not allowed, even for internal user, is on
  }
  if (!$menuentry['perms']) {
    return 2; // No permissions and user is external
  }
  return 1;
}
 
function roundUpToNextMultiple($n, $x = 5)
{
  $result = (ceil($n) % $x === 0) ? ceil($n) : (round(($n + $x / 2) / $x) * $x);
  return (int) $result;
}
 
 
function getElementProperties($elementType)
{
  global $conf, $db, $hookmanager;
 
  $regs = array();
 
  //$element_type='facture';
 
  $classfile = $classname = $classpath = $subdir = $dir_output = $dir_temp = $parent_element = '';
 
  // Parse element/subelement
  $module = $elementType;
  $element = $elementType;
  $subelement = $elementType;
  $table_element = $elementType;
 
  // If we ask a resource form external module (instead of default path)
  if (preg_match('/^([^@]+)@([^@]+)$/i', $elementType, $regs)) {  // 'myobject@mymodule'
    $element = $subelement = $regs[1];
    $module = $regs[2];
  } elseif (preg_match('/^([^_]+)_([^_]+)/i', $element, $regs)) { // 'myobject_mysubobject' with myobject=mymodule, example 'project_task'
    // This is an alternative syntax to 'myobject@mymodule', so it must not be applied when the previous case already matched,
    // otherwise the module resolved from the '@' syntax would be overwritten by a wrong guess when $element contains a '_'.
    $module = $element = $regs[1];
    $subelement = $regs[2];
  }
 
  // Object lines will use parent classpath and module ref
  if (substr($elementType, -3) == 'det') {
    $module = preg_replace('/det$/', '', $element);
    $subelement = preg_replace('/det$/', '', $subelement);
    $classpath = $module . '/class';
    $classfile = $module;
    $classname = preg_replace('/det$/', 'Line', $element);
    if (in_array($module, array('expedition', 'propale', 'facture', 'contrat', 'fichinter', 'supplier_order', 'commandefournisseur'))) {
      $classname = preg_replace('/det$/', 'Ligne', $element);
    }
  }
  // For compatibility and to work with non standard path
  if ($elementType == "action" || $elementType == "actioncomm") {
    $classpath = 'comm/action/class';
    $subelement = 'Actioncomm';
    $module = 'agenda';
    $table_element = 'actioncomm';
  } elseif ($elementType == 'cronjob') {
    $classpath = 'cron/class';
    $module = 'cron';
    $table_element = 'cron';
  } elseif ($elementType == 'adherent_type') {
    $classpath = 'adherents/class';
    $classfile = 'adherent_type';
    $module = 'adherent';
    $subelement = 'adherent_type';
    $classname = 'AdherentType';
    $table_element = 'adherent_type';
  } elseif ($elementType == 'bank_account') {
    $classpath = 'compta/bank/class';
    $module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
    $classfile = 'account';
    $classname = 'Account';
  } elseif ($elementType == 'bank_line') {
    $classpath = 'compta/bank/class';
    $module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
    $classfile = 'account';
    $classname = 'AccountLine';
  } elseif ($elementType == 'category') {
    $classpath = 'categories/class';
    $module = 'categorie';
    $subelement = 'categorie';
    $table_element = 'categorie';
  } elseif ($elementType == 'contact') {
    $classpath = 'contact/class';
    $classfile = 'contact';
    $module = 'societe';
    $subelement = 'contact';
    $table_element = 'socpeople';
    $subdir = '/contact';
  } elseif ($elementType == 'inventory') {
    $module = 'product';
    $classpath = 'product/inventory/class';
  } elseif ($elementType == 'inventoryline') {
    $module = 'product';
    $classpath = 'product/inventory/class';
    $table_element = 'inventorydet';
    $parent_element = 'inventory';
  } elseif ($elementType == 'stock' || $elementType == 'entrepot' || $elementType == 'warehouse') {
    $module = 'stock';
    $classpath = 'product/stock/class';
    $classfile = 'entrepot';
    $classname = 'Entrepot';
    $table_element = 'entrepot';
  } elseif ($elementType == 'project') {
    $classpath = 'projet/class';
    $module = 'projet';
    $table_element = 'projet';
  } elseif ($elementType == 'project_task') {
    $classpath = 'projet/class';
    $module = 'projet';
    $subelement = 'task';
    $table_element = 'projet_task';
  } elseif ($elementType == 'mo') {
    $classpath = 'mrp/class';
    $module = 'mrp';
    $classfile = 'mo';
    $classname = 'Mo';
    $table_element = 'mrp_mo';
  } elseif ($elementType == 'facture' || $elementType == 'invoice') {
    $classpath = 'compta/facture/class';
    $module = 'facture';
    $subelement = 'facture';
    $table_element = 'facture';
  } elseif ($elementType == 'facturedet') {
    $classpath = 'compta/facture/class';
    $classfile = 'facture';
    $classname = 'FactureLigne';
    $module = 'facture';
    $table_element = 'facturedet';
    $parent_element = 'facture';
  } elseif ($elementType == 'facturerec' || $elementType == 'facture_rec') {
    $classpath = 'compta/facture/class';
    $classfile = 'facture-rec';
    $module = 'facture';
    $classname = 'FactureRec';
  } elseif ($elementType == 'commande' || $elementType == 'order') {
    $classpath = 'commande/class';
    $module = 'commande';
    $subelement = 'commande';
    $table_element = 'commande';
  } elseif ($elementType == 'commandedet') {
    $classpath = 'commande/class';
    $classfile = 'commande';
    $classname = 'OrderLine';
    $module = 'commande';
    $table_element = 'commandedet';
    $parent_element = 'commande';
  } elseif ($elementType == 'propal') {
    $classpath = 'comm/propal/class';
    $table_element = 'propal';
  } elseif ($elementType == 'propaldet') {
    $classpath = 'comm/propal/class';
    $classfile = 'propal';
    $subelement = 'propaleligne';
    $module = 'propal';
    $table_element = 'propaldet';
    $parent_element = 'propal';
  } elseif ($elementType == 'shipping' || $elementType == 'shipment') {
    $classpath = 'expedition/class';
    $classfile = 'expedition';
    $classname = 'Expedition';
    $module = 'expedition';
    $table_element = 'expedition';
  } elseif ($elementType == 'expeditiondet' || $elementType == 'shippingdet') {
    $classpath = 'expedition/class';
    $classfile = 'expedition';
    $classname = 'ExpeditionLigne';
    $module = 'expedition';
    $table_element = 'expeditiondet';
    $parent_element = 'expedition';
  } elseif ($elementType == 'delivery_note') {
    $classpath = 'delivery/class';
    $subelement = 'delivery';
    $module = 'expedition';
  } elseif ($elementType == 'delivery') {
    $classpath = 'delivery/class';
    $subelement = 'delivery';
    $module = 'expedition';
  } elseif ($elementType == 'deliverydet') {
    // @todo
  } elseif ($elementType == 'supplier_proposal') {
    $classpath = 'supplier_proposal/class';
    $module = 'supplier_proposal';
    $element = 'supplierproposal';
    $classfile = 'supplier_proposal';
    $subelement = 'supplierproposal';
  } elseif ($elementType == 'supplier_proposaldet') {
    $classpath = 'supplier_proposal/class';
    $module = 'supplier_proposal';
    $classfile = 'supplier_proposal';
    $classname = 'SupplierProposalLine';
    $table_element = 'supplier_proposaldet';
    $parent_element = 'supplier_proposal';
  } elseif ($elementType == 'contract') {
    $classpath = 'contrat/class';
    $module = 'contrat';
    $subelement = 'contrat';
    $table_element = 'contract';
  } elseif ($elementType == 'contratdet') {
    $classpath = 'contrat/class';
    $module = 'contrat';
    $table_element = 'contratdet';
    $parent_element = 'contrat';
  } elseif ($elementType == 'mailing') {
    $classpath = 'comm/mailing/class';
    $module = 'mailing';
    $classfile = 'mailing';
    $classname = 'Mailing';
    $subelement = '';
  } elseif ($elementType == 'member' || $elementType == 'adherent') {
    $classpath = 'adherents/class';
    $module = 'adherent';
    $subelement = 'adherent';
    $table_element = 'adherent';
  } elseif ($elementType == 'subscription') {
    $classpath = 'adherents/class';
    $classfile = 'subscription';
    $module = 'adherent';
    $subelement = 'subscription';
    $classname = 'Subscription';
    $table_element = 'subscription';
  } elseif ($elementType == 'usergroup') {
    $classpath = 'user/class';
    $module = 'user';
  } elseif ($elementType == 'mrp') {
    $classpath = 'mrp/class';
    $classfile = 'mo';
    $classname = 'Mo';
    $module = 'mrp';
    $subelement = '';
    $table_element = 'mrp_mo';
  } elseif ($elementType == 'mrp_production') {
    $classpath = 'mrp/class';
    $classfile = 'mo';
    $classname = 'MoLine';
    $module = 'mrp';
    $subelement = '';
    $table_element = 'mrp_production';
    $parent_element = 'mo';
  } elseif ($elementType == 'cabinetmed_cons') {
    $classpath = 'cabinetmed/class';
    $module = 'cabinetmed';
    $subelement = 'cabinetmedcons';
    $table_element = 'cabinetmedcons';
  } elseif ($elementType == 'fichinter') {
    $classpath = 'fichinter/class';
    $module = 'ficheinter';
    $subelement = 'fichinter';
    $table_element = 'fichinter';
  } elseif ($elementType == 'dolresource' || $elementType == 'resource') {
    $classpath = 'resource/class';
    $module = 'resource';
    $subelement = 'dolresource';
    $table_element = 'resource';
  } elseif ($elementType == 'opensurvey_sondage') {
    $classpath = 'opensurvey/class';
    $module = 'opensurvey';
    $subelement = 'opensurveysondage';
  } elseif ($elementType == 'order_supplier' || $elementType == 'supplier_order' || $elementType == 'commande_fournisseur' || $elementType == 'commandefournisseur') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $classfile = 'fournisseur.commande';
    $element = 'order_supplier';
    $subelement = '';
    $classname = 'CommandeFournisseur';
    $table_element = 'commande_fournisseur';
  } elseif ($elementType == 'commande_fournisseurdet') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $classfile = 'fournisseur.commande';
    $element = 'commande_fournisseurdet';
    $subelement = '';
    $classname = 'CommandeFournisseurLigne';
    $table_element = 'commande_fournisseurdet';
    $parent_element = 'commande_fournisseur';
  } elseif ($elementType == 'invoice_supplier' || $elementType == 'supplier_invoice' || $elementType == 'facture_fourn') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $classfile = 'fournisseur.facture';
    $element = 'invoice_supplier';
    $subelement = '';
    $classname = 'FactureFournisseur';
    $table_element = 'facture_fourn';
  } elseif ($elementType == 'facture_fourn_det') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $classfile = 'fournisseur.facture';
    $element = 'facture_fourn_det';
    $subelement = '';
    $classname = 'SupplierInvoiceLine';
    $table_element = 'facture_fourn_det';
    $parent_element = 'invoice_supplier';
  } elseif ($elementType == "service") {
    $classpath = 'product/class';
    $module = 'product';
    $subelement = 'product';
    $table_element = 'product';
  } elseif ($elementType == 'product_attribute') {
    $module = 'variants';
    $element = 'product_attribute';
    $subelement = 'product_attribute';
    $classpath = 'variants/class';
    $classfile = 'ProductAttribute';
    $classname = 'ProductAttribute';
    $table_element = 'product_attribute';
  } elseif ($elementType == 'product_attribute_value') {
    $module = 'variants';
    $element = 'product_attribute_value';
    $subelement = 'product_attribute_value';
    $classpath = 'variants/class';
    $classfile = 'ProductAttributeValue';
    $classname = 'ProductAttributeValue';
    $table_element = 'product_attribute_value';
    $parent_element = 'product_attribute';
  } elseif ($elementType == 'salary') {
    $classpath = 'salaries/class';
    $module = 'salaries';
  } elseif ($elementType == 'payment_salary') {
    $classpath = 'salaries/class';
    $classfile = 'paymentsalary';
    $classname = 'PaymentSalary';
    $module = 'salaries';
  } elseif ($elementType == 'payment') {
    $classpath = 'compta/paiement/class';
    $classfile = 'paiement';
    $classname = 'Paiement';
    $module = 'facture';  // A customer payment belongs to the invoice module, there is no 'compta' module
    $element = 'payment';
    $subelement = 'payment';
    $table_element = 'paiement';
  } elseif ($elementType == 'payment_supplier') {
    $classpath = 'fourn/class';
    $classfile = 'paiementfourn';
    $classname = 'PaiementFourn';
    $module = 'fournisseur';
    $element = 'payment_supplier';
    $subelement = 'payment_supplier';
    $table_element = 'paiementfourn';
  } elseif ($elementType == 'payment_various') {
    $classpath = 'compta/bank/class';
    $classfile = 'paymentvarious';
    $classname = 'PaymentVarious';
    $module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
    $element = 'payment_various';
    $subelement = 'payment_various';
    $table_element = 'payment_various';
  } elseif ($elementType == 'stocktransfer') {
    $classpath = 'product/stock/stocktransfer/class';
    $classfile = 'stocktransfer';
    $classname = 'StockTransfer'; // Not the ucfirst() of the element, so it must be set explicitly
    $module = 'stocktransfer';
    $subelement = 'stocktransfer';
    $table_element = 'stocktransfer_stocktransfer';
  } elseif ($elementType == 'job' || $elementType == 'position' || $elementType == 'skill' || $elementType == 'evaluation') {
    $classpath = 'hrm/class';
    $classfile = $elementType;
    $classname = ucfirst($elementType);
    $module = 'hrm';
    $subelement = $elementType;
    $table_element = ($elementType == 'position' ? 'hrm_job_user' : 'hrm_'.$elementType);
    $subdir = '/'.$elementType;
  } elseif ($elementType == 'productlot') {
    $module = 'productbatch';
    $classpath = 'product/stock/class';
    $classfile = 'productlot';
    $classname = 'Productlot';
    $element = 'productlot';
    $subelement = '';
    $table_element = 'product_lot';
  } elseif ($elementType == 'societeaccount') {
    $classpath = 'societe/class';
    $classfile = 'societeaccount';
    $classname = 'SocieteAccount';
    $module = 'societe';
  } elseif ($elementType == 'websitepage' || $elementType == 'website_page') {
    $classpath = 'website/class';
    $classfile = 'websitepage';
    $classname = 'Websitepage';
    $module = 'website';
    $subelement = 'websitepage';
    $table_element = 'website_page';
  } elseif ($elementType == 'fiscalyear') {
    $classpath = 'core/class';
    $module = 'accounting';
    $subelement = 'fiscalyear';
  } elseif ($elementType == 'chargesociales') {
    $classpath = 'compta/sociales/class';
    $module = 'tax';
    $table_element = 'chargesociales';
  } elseif ($elementType == 'tva') {
    $classpath = 'compta/tva/class';
    $module = 'tax';
    $subdir = '/vat';
    $table_element = 'tva';
  } elseif ($elementType == 'emailsenderprofile') {
    $module = '';
    $classpath = 'core/class';
    $classfile = 'emailsenderprofile';
    $classname = 'EmailSenderProfile';
    $table_element = 'c_email_senderprofile';
    $subelement = '';
  } elseif ($elementType == 'conferenceorboothattendee') {
    $classpath = 'eventorganization/class';
    $classfile = 'conferenceorboothattendee';
    $classname = 'ConferenceOrBoothAttendee';
    $module = 'eventorganization';
  } elseif ($elementType == 'conferenceorbooth') {
    $classpath = 'eventorganization/class';
    $classfile = 'conferenceorbooth';
    $classname = 'ConferenceOrBooth';
    $module = 'eventorganization';
    $subdir = '/conferenceorbooth';
  } elseif ($elementType == 'ccountry') {
    $module = '';
    $classpath = 'core/class';
    $classfile = 'ccountry';
    $classname = 'Ccountry';
    $table_element = 'c_country';
    $subelement = '';
  } elseif ($elementType == 'ecmfiles') {
    $module = 'ecm';
    $classpath = 'ecm/class';
    $classfile = 'ecmfiles';
    $classname = 'Ecmfiles';
    $table_element = 'ecmfiles';
    $subelement = '';
  } elseif ($elementType == 'knowledgerecord' || $elementType == 'knowledgemanagement') {
    $module = 'knowledgemanagement';
    $classpath = 'knowledgemanagement/class';
    $classfile = 'knowledgerecord';
    $classname = 'KnowledgeRecord';
    $table_element = 'knowledgemanagement_knowledgerecord';
    $subelement = '';
  } elseif ($elementType == 'customer') {
    $module = 'societe';
    $classpath = 'societe/class';
    $classfile = 'client';
    $classname = 'Client';
    $table_element = 'societe';
    $subelement = '';
  } elseif ($elementType == 'fournisseur' || $elementType == 'supplier') {
    $module = 'societe';
    $classpath = 'fourn/class';
    $classfile = 'fournisseur';
    $classname = 'Fournisseur';
    $table_element = 'societe';
    $subelement = '';
  } elseif ($elementType == 'recruitmentcandidature') {
    $module = 'recruitment';
    $classfile = 'recruitmentcandidature';
    $classpath = 'recruitment/class';
    $classname = 'RecruitmentCandidature';
    $subelement = 'recruitmentcandidature';
    $subdir = '/recruitmentcandidature';
  } elseif ($elementType == 'recruitmentjobposition') {
    $module = 'recruitment';
    $classfile = 'recruitmentjobposition';
    $classpath = 'recruitment/class';
    $classname = 'RecruitmentJobPosition';
    $subelement = 'recruitmentjobposition';
    $subdir = '/recruitmentjobposition';
  }
 
 
  if (empty($classfile)) {
    $classfile = strtolower($subelement);
  }
  if (empty($classname)) {
    $classname = ucfirst($subelement);
  }
  if (empty($classpath)) {
    $classpath = $module . '/class';
  }
 
  //print 'getElementProperties subdir='.$subdir;
 
  // Set dir_output
  if ($module && isset($conf->$module)) { // The generic case
    if (!empty($conf->$module->multidir_output[$conf->entity])) {
      $dir_output = $conf->$module->multidir_output[$conf->entity];
    } elseif (!empty($conf->$module->output[$conf->entity])) {
      $dir_output = $conf->$module->output[$conf->entity];
    } elseif (!empty($conf->$module->dir_output)) {
      $dir_output = $conf->$module->dir_output;
    }
    if (!empty($conf->$module->multidir_temp[$conf->entity])) {
      $dir_temp = $conf->$module->multidir_temp[$conf->entity];
    } elseif (!empty($conf->$module->temp[$conf->entity])) {
      $dir_temp = $conf->$module->temp[$conf->entity];
    } elseif (!empty($conf->$module->dir_temp)) {
      $dir_temp = $conf->$module->dir_temp;
    }
  }
 
  // Overwrite value for special cases
  if ($element == 'order_supplier' && isModEnabled('fournisseur')) {
    $dir_output = $conf->fournisseur->commande->dir_output;
    $dir_temp = $conf->fournisseur->commande->dir_temp;
  } elseif ($element == 'invoice_supplier' && isModEnabled('fournisseur')) {
    $dir_output = $conf->fournisseur->facture->dir_output;
    $dir_temp = $conf->fournisseur->facture->dir_temp;
  } elseif ($elementType == 'payment' && isModEnabled('invoice') && isset($conf->compta->payment)) {
    // A customer payment is stored into a sub object of $conf, not handled by the generic case.
    // Note: we must test $elementType and not $element, because the 'myobject_mysubobject' rule above
    // rewrites $element to 'payment' for the element 'payment_salary' too, which is stored elsewhere.
    $dir_output = $conf->compta->payment->dir_output;
    $dir_temp = $conf->compta->payment->dir_temp;
  } elseif ($elementType == 'payment_supplier' && isModEnabled('fournisseur') && isset($conf->fournisseur->payment)) {
    $dir_output = $conf->fournisseur->payment->dir_output;
    $dir_temp = $conf->fournisseur->payment->dir_temp;
  }
  // The sub directory must not be appended when the module is disabled, because $dir_output is then empty
  // and we would return a path at the root of the file system instead of an empty string.
  if (!empty($dir_output)) {
    $dir_output .= $subdir;
  }
  if (!empty($dir_temp)) {
    $dir_temp .= $subdir;
  }
 
  $elementProperties = array(
    'module' => $module,
    'element' => $element,
    'table_element' => $table_element,
    'subelement' => $subelement,
    'classpath' => $classpath,
    'classfile' => $classfile,
    'classname' => $classname,
    'dir_output' => $dir_output,
    'dir_temp' => $dir_temp,
    'parent_element' => $parent_element,
  );
 
 
  // Add  hook
  if (!is_object($hookmanager)) {
    include_once DOL_DOCUMENT_ROOT . '/core/class/hookmanager.class.php';
    $hookmanager = new HookManager($db);
  }
  $hookmanager->initHooks(array('elementproperties'));
 
 
  // Hook params
  $parameters = array(
    'elementType' => $elementType,
    'elementProperties' => $elementProperties
  );
 
  $reshook = $hookmanager->executeHooks('getElementProperties', $parameters);
 
  if ($reshook) {
    $elementProperties = $hookmanager->resArray;
  } elseif (!empty($hookmanager->resArray) && is_array($hookmanager->resArray)) { // resArray is always an array but for security against misconfigured external modules
    $elementProperties = array_replace($elementProperties, $hookmanager->resArray);
  }
 
  // context of elementproperties doesn't need to exist out of this function so delete it to avoid elementproperties context is equal to all
  if (($key = array_search('elementproperties', $hookmanager->contextarray)) !== false) {
    unset($hookmanager->contextarray[$key]);
  }
 
  return $elementProperties;
}
 
function fetchObjectByElement($element_id, $element_type, $element_ref = '', $useCache = 0, $maxCacheByType = 10)
{
  global $db, $conf;
 
  $ret = 0;
 
  $element_prop = getElementProperties($element_type);
  //var_dump($element_prop); exit;
 
  if ($element_prop['module'] == 'product' || $element_prop['module'] == 'service') {
    // For example, for an extrafield 'product' (shared for both product and service) that is a link to an object,
    // this is called with $element_type = 'product' when we need element properties of a service, we must return a product. If we create the
    // extrafield for a service, it is not supported and not found when editing the product/service card. So we must keep 'product' for extrafields
    // of service and we will return properties of a product.
    $ismodenabled = (isModEnabled('product') || isModEnabled('service'));
  } elseif ($element_prop['module'] == 'societeaccount') {
    $ismodenabled = isModEnabled('website') || isModEnabled('webportal');
  } else {
    $ismodenabled = isModEnabled($element_prop['module']);
  }
  //var_dump('element_type='.$element_type);
  //var_dump($element_prop);
  //var_dump($element_prop['module'].' '.$ismodenabled);
  if (is_array($element_prop) && (empty($element_prop['module']) || $ismodenabled)) {
    if ($useCache === 1 && $element_id > 0
      && !empty($conf->cache['fetchObjectByElement'][$element_type])
      && !empty($conf->cache['fetchObjectByElement'][$element_type][$element_id])
      && is_object($conf->cache['fetchObjectByElement'][$element_type][$element_id])
    ) {
      return $conf->cache['fetchObjectByElement'][$element_type][$element_id];
    }
 
    dol_include_once('/' . $element_prop['classpath'] . '/' . $element_prop['classfile'] . '.class.php');
 
    if (class_exists($element_prop['classname'])) {
      $className = $element_prop['classname'];
      $objecttmp = new $className($db);
      '@phan-var-force CommonObject $objecttmp';
      if ($element_id > 0 || !empty($element_ref)) {
        $ret = $objecttmp->fetch($element_id, $element_ref);
        if ($ret >= 0) {
          if (empty($objecttmp->module)) {
            $objecttmp->module = $element_prop['module'];
          }
 
          if ($useCache > 0) {
            if (!isset($conf->cache['fetchObjectByElement'][$element_type])) {
              $conf->cache['fetchObjectByElement'][$element_type] = [];
            }
 
            // Manage cache limit
            if (! empty($conf->cache['fetchObjectByElement'][$element_type]) && is_array($conf->cache['fetchObjectByElement'][$element_type]) && count($conf->cache['fetchObjectByElement'][$element_type]) >= $maxCacheByType) {
              array_shift($conf->cache['fetchObjectByElement'][$element_type]);
            }
 
            $conf->cache['fetchObjectByElement'][$element_type][$element_id] = $objecttmp;
          }
 
          return $objecttmp;
        }
      } else {
        return $objecttmp;  // returned an object without fetch
      }
    } else {
      dol_syslog($element_prop['classname'] . ' doesn\'t exists in /' . $element_prop['classpath'] . '/' . $element_prop['classfile'] . '.class.php');
      return -1;
    }
  }
 
  return $ret;
}
 
function getExecutableContent()
{
  $arrayofregexextension = array(
    'htm',
    'html',
    'shtml',
    'js',
    'phar',
    'php',
    'php3',
    'php4',
    'php5',
    'phtml',
    'pht',
    'pl',
    'py',
    'cgi',
    'ksh',
    'sh',
    'shtml',
    'bash',
    'bat',
    'cmd',
    'wpk',
    'exe',
    'dmg',
    'appimage'
  );
 
  return $arrayofregexextension;
}
 
function isAFileWithExecutableContent($filename)
{
  $arrayofregexextension = getExecutableContent();
 
  foreach ($arrayofregexextension as $fileextension) {
    if (preg_match('/\.' . preg_quote($fileextension, '/') . '$/i', $filename)) {
      return true;
    }
  }
 
  return false;
}
 
function newToken()
{
  return empty($_SESSION['newtoken']) ? '' : $_SESSION['newtoken'];
}
 
function currentToken()
{
  return isset($_SESSION['token']) ? $_SESSION['token'] : '';
}
 
function getNonce()
{
  global $conf;
 
  if (empty($conf->cache['nonce'])) {
    include_once DOL_DOCUMENT_ROOT . '/core/lib/security.lib.php';
    $conf->cache['nonce'] = dolGetRandomBytes(8);
  }
 
  return $conf->cache['nonce'];
}
 
 
function readfileLowMemory($fullpath_original_file_osencoded, $method = -1)
{
  if ($method == -1) {
    $method = 0;
    if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_FREAD')) {
      $method = 1;
    }
    if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_STREAM_COPY')) {
      $method = 2;
    }
  }
 
  // Be sure we don't have output buffering enabled to have readfile working correctly
  $level = ob_get_level();
  ob_start();
  while (ob_get_level() > $level) {
    ob_end_clean();
  }
 
  // Solution 0
  if ($method == 0) {
    readfile($fullpath_original_file_osencoded);
  } elseif ($method == 1) {
    // Solution 1
    $handle = fopen($fullpath_original_file_osencoded, "rb");
    while (!feof($handle)) {
      print fread($handle, 8192);
    }
    fclose($handle);
  } elseif ($method == 2) {
    // Solution 2
    $handle1 = fopen($fullpath_original_file_osencoded, "rb");
    $handle2 = fopen("php://output", "wb");
    stream_copy_to_stream($handle1, $handle2);
    fclose($handle1);
    fclose($handle2);
  }
}
 
 
function jsonOrUnserialize($stringtodecode, $assoc = true)
{
  $result = json_decode($stringtodecode, $assoc);
  if ($result === null) {
    $result = unserialize($stringtodecode, ['allowed_classes' => false]); // For backward compatibility. Is no more used in recent versions.
  }
 
  return $result;
}
 
 
function forgeSQLFromUniversalSearchCriteria($filter, &$errorstr = '', $noand = 0, $nopar = 0, $noerror = 0, $forbiddenfields = array())
{
  global $db, $user;
 
  if (is_null($filter) || !is_string($filter) || $filter === '') {
    return '';
  }
  if (!preg_match('/^\‍(.*\‍)$/', $filter)) {    // If $filter does not start and end with ()
    $filter = '(' . $filter . ')';
  }
 
  $regexstring = '\‍(([a-zA-Z0-9_\.]+:[<>!=insotlke]+:[^\‍(\‍)]+)\‍)';  // Must be  (aaa:bbb:...) with aaa is a field name (with alias or not) and bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'
  $firstandlastparenthesis = 0;
 
  if (!dolCheckFilters($filter, $errorstr, $firstandlastparenthesis)) {
    if ($noerror) {
      return '1 = 2';
    } else {
      return 'Filter syntax error - ' . $errorstr;    // Bad balance of parenthesis, we return an error message or force a SQL not found
    }
  }
 
  // Test the filter syntax
  $t = preg_replace_callback('/' . $regexstring . '/i', 'dolForgeDummyCriteriaCallback', $filter);
  $t = str_ireplace(array('and', 'or', ' '), '', $t);   // Remove the only strings allowed between each () criteria
 
  // If the string result contains something else than '()', the syntax was wrong
  if (preg_match('/[^\‍(\‍)]/', $t)) {
    $tmperrorstr = 'Bad syntax of the search string';
    $errorstr = 'Bad syntax of the search string: ' . $filter;
    if ($noerror) {
      return '1 = 2';
    } else {
      dol_syslog("forgeSQLFromUniversalSearchCriteria Filter error - " . $errorstr, LOG_WARNING);
      return 'Filter error - ' . $tmperrorstr;    // Bad syntax of the search string, we return an error message or force a SQL not found
    }
  }
 
  global $globalforbiddenfields;  // For use by dolForgeSQLCriteriaCallback()
  $globalforbiddenfields = $forbiddenfields;
 
  $ret = ($noand ? "" : " AND ") . ($nopar ? "" : '(');
  $ret .= preg_replace_callback('/' . $regexstring . '/i', 'dolForgeSQLCriteriaCallback', $filter);
  $ret .= ($nopar ? "" : ')');
 
  if (is_object($db)) {
    $ret = str_replace('__NOW__', "'" . $db->idate(dol_now()) . "'", $ret);
  }
  if (is_object($user)) {
    $ret = str_replace('__USER_ID__', (string) $user->id, $ret);
  }
 
  return $ret;
}
 
function dolForgeExplodeAnd($sqlfilters)
{
  $arrayofandtags = array();
  $nbofchars = dol_strlen($sqlfilters);
 
  $error = '';
  $parenthesislevel = 0;
  $result = dolCheckFilters($sqlfilters, $error, $parenthesislevel);
  if (!$result) {
    return array();
  }
  if ($parenthesislevel >= 1) {
    $sqlfilters = preg_replace('/^\‍(/', '', preg_replace('/\‍)$/', '', $sqlfilters));
  }
 
  $i = 0;
  $s = '';
  $countparenthesis = 0;
  while ($i < $nbofchars) {
    $char = dol_substr($sqlfilters, $i, 1);
 
    if ($char == '(') {
      $countparenthesis++;
    } elseif ($char == ')') {
      $countparenthesis--;
    }
 
    if ($countparenthesis == 0) {
      $char2 = dol_substr($sqlfilters, $i + 1, 1);
      $char3 = dol_substr($sqlfilters, $i + 2, 1);
      if ($char == 'A' && $char2 == 'N' && $char3 == 'D') {
        // We found a AND
        $s = trim($s);
        if (!preg_match('/^\‍(.*\‍)$/', $s)) {
          $s = '(' . $s . ')';
        }
        $arrayofandtags[] = $s;
        $s = '';
        $i += 2;
      } else {
        $s .= $char;
      }
    } else {
      $s .= $char;
    }
    $i++;
  }
  if ($s) {
    $s = trim($s);
    if (!preg_match('/^\‍(.*\‍)$/', $s)) {
      $s = '(' . $s . ')';
    }
    $arrayofandtags[] = $s;
  }
 
  return $arrayofandtags;
}
 
function dolCheckFilters($sqlfilters, &$error = '', &$parenthesislevel = 0)
{
  //$regexstring='\‍(([^:\'\‍(\‍)]+:[^:\'\‍(\‍)]+:[^:\‍(\‍)]+)\‍)';
  //$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
  $tmp = $sqlfilters;
 
  $nb = dol_strlen($tmp);
  $counter = 0;
  $parenthesislevel = 0;
 
  $error = '';
 
  $i = 0;
  while ($i < $nb) {
    $char = dol_substr($tmp, $i, 1);
 
    if ($char == '(') {
      if ($i == $parenthesislevel && $parenthesislevel == $counter) {
        // We open a parenthesis and it is the first char
        $parenthesislevel++;
      }
      $counter++;
    } elseif ($char == ')') {
      $nbcharremaining = ($nb - $i - 1);
      if ($nbcharremaining >= $counter) {
        $parenthesislevel = min($parenthesislevel, $counter - 1);
      }
      if ($parenthesislevel > $counter && $nbcharremaining >= $counter) {
        $parenthesislevel = $counter;
      }
      $counter--;
    }
 
    if ($counter < 0) {
      $error = "Wrong balance of parenthesis in sqlfilters=" . $sqlfilters;
      $parenthesislevel = 0;
      dol_syslog($error, LOG_WARNING);
      return false;
    }
 
    $i++;
  }
 
  if ($counter > 0) {
    $error = "Wrong balance of parenthesis in sqlfilters=" . $sqlfilters;
    $parenthesislevel = 0;
    dol_syslog($error, LOG_WARNING);
    return false;
  }
 
  return true;
}
 
function dolForgeDummyCriteriaCallback($matches)
{
  //dol_syslog("Convert matches ".$matches[1]);
  if (empty($matches[1])) {
    return '';
  }
  $tmp = explode(':', $matches[1]);
  if (count($tmp) < 3) {
    return '';
  }
 
  return '()';  // An empty criteria
}
 
function dolForgeSQLCriteriaCallback($matches)
{
  global $db;
  global $globalforbiddenfields;
 
  //dol_syslog("Convert matches ".$matches[1]);
  if (empty($matches[1])) {
    return '';
  }
  $tmp = explode(':', $matches[1], 3);
  if (count($tmp) < 3) {
    return '';
  }
 
  // Add fields that are forbidden by the caller when using USF search criteria
  // so we can't guess them using sequantial comparisons
  $newforbiddenfields = $globalforbiddenfields;
  if (!is_array($newforbiddenfields)) {
    $newforbiddenfields = array();
  }
  // Add fields that are ALWAYS forbidden when using USF search criteria
  $newforbiddenfields[] = 'pass';
  $newforbiddenfields[] = 'pass_crypted';
  $newforbiddenfields[] = 'api_key';
 
  $operand = preg_replace('/[^a-z0-9\._]/i', '', trim($tmp[0]));
 
  // Test that operand is not a forbidden search field
  if (!empty($newforbiddenfields)) {
    $operandwithoutprefix = preg_replace('/^[a-z0-9_]+\./i', '', $operand); // Remove prefix like t. or o. or s. or u. or d. or ...
    if (in_array(strtolower($operandwithoutprefix), $newforbiddenfields)) {
      return '1=1';
    }
  }
 
  $operator = strtoupper(preg_replace('/[^a-z<>!=]/i', '', trim($tmp[1])));
 
  $realOperator = [
    'NOTLIKE' => 'NOT LIKE',
    'ISNOT' => 'IS NOT',
    'NOTIN' => 'NOT IN',
    '!=' => '<>',
  ];
 
  if (array_key_exists($operator, $realOperator)) {
    $operator = $realOperator[$operator];
  }
 
  $tmpescaped = $tmp[2];
 
  //print "Case: ".$operator." ".$operand." ".$tmpescaped."\n";
 
  $regbis = array();
 
  if ($operator == 'IN' || $operator == 'NOT IN') { // IN is allowed for list of ID/code/field only (or subrequest if $dolibarr_allow_unsecured_select_in_extrafields_filter not enabled)
    global $dolibarr_allow_unsecured_select_in_extrafields_filter;
 
    //if (!preg_match('/^\‍(.*\‍)$/', $tmpescaped)) {
    $tmpescaped2 = '(';
    // Explode and sanitize each element in list
    $tmpelemarray = explode(',', $tmpescaped);
    foreach ($tmpelemarray as $tmpkey => $tmpelem) {
      $reg = array();
      $tmpelem = trim($tmpelem);
      if (preg_match('/^\'(.*)\'$/', $tmpelem, $reg)) {
        $tmpelemarray[$tmpkey] = "'" . $db->escape($db->sanitize($reg[1], 2, 1, 1, 1)) . "'";
      } elseif (ctype_digit((string) $tmpelem)) { // if only 0-9 chars, no .
        $tmpelemarray[$tmpkey] = (int) $tmpelem;
      } elseif (is_numeric((string) $tmpelem)) {  // it can be a float with a .
        $tmpelemarray[$tmpkey] = (float) $tmpelem;
      } elseif (!empty($dolibarr_allow_unsecured_select_in_extrafields_filter)) {
        $tmpelemarray[$tmpkey] = preg_replace('/[^a-z0-9_<>=!\s]/i', '', $tmpelem); // it can be a full subrequest (should be removed in a future as it allows blind SQL injection)
      } else {
        $tmpelemarray[$tmpkey] = preg_replace('/[^a-z0-9_]/i', '', $tmpelem); // it can be a name of field or a substitution variable like '__NOW__'
      }
    }
    $tmpescaped2 .= implode(',', $tmpelemarray);
    $tmpescaped2 .= ')';
 
    $tmpescaped = $tmpescaped2;
  } elseif ($operator == 'LIKE' || $operator == 'NOT LIKE') {
    if (preg_match('/^\'([^\']*)\'$/', $tmpescaped, $regbis)) {
      $tmpescaped = $regbis[1];
    }
    //$tmpescaped = "'".$db->escape($db->escapeforlike($regbis[1]))."'";
    $tmpescaped = "'" . $db->escape($tmpescaped) . "'"; // We do not escape the _ and % so the LIKE will work as expected
  } elseif (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
    // TODO Retrieve type of field for $operand field name.
    // So we can complete format. For example we could complete a year with month and day.
    $tmpescaped = "'" . $db->escape($regbis[1]) . "'";
  } else {
    if (strtoupper($tmpescaped) == 'NULL') {
      $tmpescaped = 'NULL';
    } elseif (ctype_digit((string) $tmpescaped)) {  // if only 0-9 chars, no .
      $tmpescaped = (int) $tmpescaped;
    } elseif (is_numeric((string) $tmpescaped)) { // it can be a float with a .
      $tmpescaped = (float) $tmpescaped;
    } else {
      $tmpescaped = preg_replace('/[^a-z0-9_]/i', '', $tmpescaped); // it can be a name of field or a substitution variable like '__NOW__'
    }
  }
 
  return '(' . $db->escape($operand) . ' ' . strtoupper($operator) . ' ' . $tmpescaped . ')';
}
 
 
function getTimelineIcon($actionstatic, &$histo, $key)
{
  dol_syslog('getTimelineIcon::begin', LOG_DEBUG);
  global $langs;
 
  $out = '<!-- timeline icon -->' . "\n";
  $iconClass = 'fa fa-comments';
  $img_picto = '';
  $colorClass = '';
  $pictoTitle = '';
 
  if ($histo[$key]['percent'] == -1) {
    $colorClass = 'timeline-icon-not-applicble';
    $pictoTitle = $langs->trans('StatusNotApplicable');
  } elseif ($histo[$key]['percent'] == 0) {
    $colorClass = 'timeline-icon-todo';
    $pictoTitle = $langs->trans('StatusActionToDo') . ' (0%)';
  } elseif ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100) {
    $colorClass = 'timeline-icon-in-progress';
    $pictoTitle = $langs->trans('StatusActionInProcess') . ' (' . $histo[$key]['percent'] . '%)';
  } elseif ($histo[$key]['percent'] >= 100) {
    $colorClass = 'timeline-icon-done';
    $pictoTitle = $langs->trans('StatusActionDone') . ' (100%)';
  }
 
  if ($actionstatic->code == 'AC_TICKET_CREATE') {
    $iconClass = 'fa fa-ticket';
  } elseif ($actionstatic->code == 'AC_TICKET_MODIFY') {
    $iconClass = 'fa fa-pencilxxx';
  } elseif (preg_match('/^TICKET_MSG/', $actionstatic->code)) {
    $iconClass = 'fa fa-comments';
  } elseif (preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
    $iconClass = 'fa fa-mask';
  } elseif (getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
    if ($actionstatic->type_picto) {
      $img_picto = img_picto('', $actionstatic->type_picto);
    } else {
      if ($actionstatic->type_code == 'AC_RDV') {
        $iconClass = 'fa fa-handshake';
      } elseif ($actionstatic->type_code == 'AC_TEL') {
        $iconClass = 'fa fa-phone';
      } elseif ($actionstatic->type_code == 'AC_FAX') {
        $iconClass = 'fa fa-fax';
      } elseif ($actionstatic->type_code == 'AC_EMAIL') {
        $iconClass = 'fa fa-envelope';
      } elseif ($actionstatic->type_code == 'AC_INT') {
        $iconClass = 'fa fa-shipping-fast';
      } elseif ($actionstatic->type_code == 'AC_OTH_AUTO') {
        $iconClass = 'fa fa-robot';
      } elseif (!preg_match('/_AUTO/', $actionstatic->type_code)) {
        $iconClass = 'fa fa-robot';
      }
    }
  }
 
  $out .= '<i class="' . $iconClass . ' ' . $colorClass . '" title="' . $pictoTitle . '">' . $img_picto . '</i>' . "\n";
  return $out;
}
 
function getActionCommEcmList($object)
{
  global $db;
 
  $documents = array();
 
  $sql = 'SELECT ecm.rowid as id, ecm.src_object_type, ecm.src_object_id, ecm.filepath, ecm.filename, ecm.agenda_id';
  $sql .= ' FROM ' . MAIN_DB_PREFIX . 'ecm_files ecm';
  $sql .= " WHERE ecm.filepath = 'agenda/" . ((int) $object->id) . "'";
  //$sql.= " ecm.src_object_type = '".$db->escape($object->element)."' AND ecm.src_object_id = ".((int) $object->id); // Old version didn't add object_type during upload
  $sql .= ' OR ecm.agenda_id = ' . (int) $object->id;
  $sql .= ' ORDER BY ecm.position ASC';
 
  $resql = $db->query($sql);
  if ($resql) {
    if ($db->num_rows($resql)) {
      while ($obj = $db->fetch_object($resql)) {
        $documents[$obj->id] = $obj;
      }
    }
  }
 
  return $documents;
}
 
 
function buildParamDate($prefix, $timestamp = null, $hourTime = '', $gm = 'auto')
{
  if ($timestamp === null) {
    $timestamp = GETPOSTDATE($prefix, $hourTime, $gm);
  }
  $TParam = array(
    $prefix . 'day'   => intval(dol_print_date($timestamp, '%d')),
    $prefix . 'month' => intval(dol_print_date($timestamp, '%m')),
    $prefix . 'year'  => intval(dol_print_date($timestamp, '%Y')),
  );
  if ($hourTime === 'getpost' || ($timestamp !== null && dol_print_date($timestamp, '%H:%M:%S') !== '00:00:00')) {
    $TParam = array_merge($TParam, array(
      $prefix . 'hour'   => intval(dol_print_date($timestamp, '%H')),
      $prefix . 'min' => intval(dol_print_date($timestamp, '%M')),
      $prefix . 'sec' => intval(dol_print_date($timestamp, '%S'))
    ));
  }
 
  return '&' . http_build_query($TParam);
}
 
function recordNotFound($message = '', $printheader = 1, $printfooter = 1, $showonlymessage = 0, $params = null)
{
  global $conf, $db, $langs, $hookmanager;
  global $action, $object;
 
  if (!is_object($langs)) {
    include_once DOL_DOCUMENT_ROOT . '/core/class/translate.class.php';
    $langs = new Translate('', $conf);
    $langs->setDefaultLang();
  }
 
  $langs->load("errors");
 
  if ($printheader) {
    if (function_exists("llxHeader")) {
      llxHeader('');
    } elseif (function_exists("llxHeaderVierge")) {
      llxHeaderVierge('');
    }
  }
 
  print '<div class="error">';
  if (empty($message)) {
    print $langs->trans("ErrorRecordNotFound");
  } else {
    print $langs->trans($message);
  }
  print '</div>';
  print '<br>';
 
  if (empty($showonlymessage)) {
    if (empty($hookmanager)) {
      include_once DOL_DOCUMENT_ROOT . '/core/class/hookmanager.class.php';
      $hookmanager = new HookManager($db);
      // Initialize a technical object to manage hooks of page. Note that conf->hooks_modules contains an array of hook context
      $hookmanager->initHooks(array('main'));
    }
 
    $parameters = array('message' => $message, 'params' => $params);
    $reshook = $hookmanager->executeHooks('getErrorRecordNotFound', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
    print $hookmanager->resPrint;
  }
 
  if ($printfooter && function_exists("llxFooter")) {
    llxFooter();
    if (is_object($db)) {
      $db->close();
    }
  }
  exit(0);
}
 
function array_merge_recursive_distinct(array $array1, array $array2): array
{
  $merged = $array1;
 
  foreach ($array2 as $key => $value) {
    if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
      $merged[$key] = array_merge_recursive_distinct($merged[$key], $value);
    } else {
      $merged[$key] = $value;
    }
  }
 
  return $merged;
}
 
function getObjectSocId($obj)
{
  if (!empty($obj->socid)) {
    return (int) $obj->socid;
  } elseif (!empty($obj->soc_id)) {
    return (int) $obj->soc_id;
  } elseif (!empty($obj->societe_id)) {
    return (int) $obj->societe_id;
  }
  return null;
}
 
function getListLimitFromScreenHeight()
{
  $default = 10;
  if (!empty($_SESSION['dol_screenheight']) && $_SESSION['dol_screenheight'] < 700) {
    $default = 8;
  } elseif (!empty($_SESSION['dol_screenheight']) && $_SESSION['dol_screenheight'] < 950) {
    $default = 10;
  } elseif (!empty($_SESSION['dol_screenheight']) && $_SESSION['dol_screenheight'] > 1130) {
    $default = 15;
  }
 
  return $default;
}