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-2022  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-2021  Alexandre Spangaro      <aspangaro@open-dsi.fr>
 * 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-2022  Frédéric France             <frederic.france@netlogic.fr>
 * Copyright (C) 2019-2022  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       Anthony Berton            <anthony.berton@bb2a.fr>
 * Copyright (C) 2022       Ferran Marcet             <fmarcet@2byte.es>
 * Copyright (C) 2022       Charlene Benke            <charlene@patas-monkey.com>
 *
 * 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';
 
 
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');
  }
}
 
 
function getDolGlobalString($key, $default = '')
{
  global $conf;
  // return $conf->global->$key ?? $default;
  return (string) (empty($conf->global->$key) ? $default : $conf->global->$key);
}
 
function getDolGlobalInt($key, $default = 0)
{
  global $conf;
  // return $conf->global->$key ?? $default;
  return (int) (empty($conf->global->$key) ? $default : $conf->global->$key);
}
 
function getDolUserString($key, $default = '')
{
  global $user;
  // return $conf->global->$key ?? $default;
  return (string) (empty($user->conf->$key) ? $default : $user->conf->$key);
}
 
function getDolUserInt($key, $default = 0)
{
  global $user;
  // return $conf->global->$key ?? $default;
  return (int) (empty($user->conf->$key) ? $default : $user->conf->$key);
}
 
function isModEnabled($module)
{
  global $conf;
  return !empty($conf->$module->enabled);
}
 
function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
{
  require_once DOL_DOCUMENT_ROOT."/core/db/".$type.'.class.php';
 
  $class = 'DoliDB'.ucfirst($type);
  $dolidb = new $class($type, $host, $user, $pass, $name, $port);
  return $dolidb;
}
 
function getEntity($element, $shared = 1, $currentobject = null)
{
  global $conf, $mc, $hookmanager, $object, $action, $db;
 
  if (! is_object($hookmanager)) {
    $hookmanager = new HookManager($db);
  }
 
  // fix different element names (France to English)
  switch ($element) {
    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', 'c_email_templates', 'email_template', 'default_values');
    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
  );
  $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 && $currentobject->entity > 0) ? $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)
{
  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
 
  $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 = 'lynxlinks';
    $version = empty($reg[3]) ? '' : $reg[3];
  }
 
  if ($tablet) {
    $layout = 'tablet';
  } elseif ($phone) {
    $layout = 'phone';
  } else {
    $layout = 'classic';
  }
 
  return array(
    'browsername' => $name,
    'browserversion' => $version,
    'browseros' => $os,
    'layout' => $layout,
    'phone' => $phone,
    'tablet' => $tablet
  );
}
 
function dol_shutdown()
{
  global $conf, $user, $langs, $db;
  $disconnectdone = false;
  $depth = 0;
  if (is_object($db) && !empty($db->connected)) {
    $depth = $db->transaction_opened;
    $disconnectdone = $db->close();
  }
  dol_syslog("--- End access to ".$_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 = preg_replace('/^\//', '', $relativepathstring);
  $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
  //var_dump($relativepathstring);
  //var_dump($user->default_values);
 
  // 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 GETPOST($paramname, $check = 'alphanohtml', $method = 0, $filter = null, $options = null, $noreplace = 0)
{
  global $mysoc, $user, $conf;
 
  if (empty($paramname)) {
    return 'BadFirstParameterForGETPOST';
  }
  if (empty($check)) {
    dol_syslog("Deprecated use of GETPOST, called with 1st param = ".$paramname." and 2nd param is '', when calling page ".$_SERVER["PHP_SELF"], LOG_WARNING);
    // Enable this line to know who call the GETPOST with '' $check parameter.
    //var_dump(debug_backtrace()[0]);
  }
 
  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';
  }
 
  if (empty($method) || $method == 3 || $method == 4) {
    $relativepathstring = $_SERVER["PHP_SELF"];
    // Clean $relativepathstring
    if (constant('DOL_URL_ROOT')) {
      $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
    }
    $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
    $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
    //var_dump($relativepathstring);
    //var_dump($user->default_values);
 
    // 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
              $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;
        if (is_object($object) && isset($object->fields[$paramname]['default'])) {
          $out = $object->fields[$paramname]['default'];
        }
      }
      if (!empty($conf->global->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;
                  }
                  //var_dump($defkey.'-'.$qualified);
                } 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])) {
          // 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;
                    }
                    //var_dump($defkey.'-'.$qualified);
                  } 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 realy usefull ?)
                  }
                }
              }
            } 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;
                  }
                  //var_dump($defkey.'-'.$qualified);
                } else {
                  $qualified = 1;
                }
 
                if ($qualified) {
                  // We must keep $_POST and $_GET here
                  if (isset($_POST['sall']) || isset($_POST['search_all']) || isset($_GET['sall']) || isset($_GET['search_all'])) {
                    // We made a search from quick search menu, do we still use default filter ?
                    if (empty($conf->global->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;
                }
              }
            }
          }
        }
      }
    }
  }
 
  // Substitution variables for GETPOST (used to get final url with variable parameters or final default value with variable parameters)
  // 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.
  if (!is_array($out) && empty($_POST[$paramname]) && empty($noreplace)) {
    $reg = array();
    $maxloop = 20;
    $loopnb = 0; // Protection against infinite loop
    while (preg_match('/__([A-Z0-9]+_?[A-Z0-9]+)__/i', $out, $reg) && ($loopnb < $maxloop)) {    // Detect '__ABCDEF__' as key 'ABCDEF' and '__ABC_DEF__' as key 'ABC_DEF'. Detection is also correct when 2 vars are side by side.
      $loopnb++;
      $newout = '';
 
      if ($reg[1] == 'DAY') {
        $tmp = dol_getdate(dol_now(), true);
        $newout = $tmp['mday'];
      } elseif ($reg[1] == 'MONTH') {
        $tmp = dol_getdate(dol_now(), true);
        $newout = $tmp['mon'];
      } elseif ($reg[1] == 'YEAR') {
        $tmp = dol_getdate(dol_now(), true);
        $newout = $tmp['year'];
      } elseif ($reg[1] == 'PREVIOUS_DAY') {
        $tmp = dol_getdate(dol_now(), true);
        $tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
        $newout = $tmp2['day'];
      } elseif ($reg[1] == 'PREVIOUS_MONTH') {
        $tmp = dol_getdate(dol_now(), true);
        $tmp2 = dol_get_prev_month($tmp['mon'], $tmp['year']);
        $newout = $tmp2['month'];
      } elseif ($reg[1] == 'PREVIOUS_YEAR') {
        $tmp = dol_getdate(dol_now(), true);
        $newout = ($tmp['year'] - 1);
      } elseif ($reg[1] == 'NEXT_DAY') {
        $tmp = dol_getdate(dol_now(), true);
        $tmp2 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
        $newout = $tmp2['day'];
      } elseif ($reg[1] == 'NEXT_MONTH') {
        $tmp = dol_getdate(dol_now(), true);
        $tmp2 = dol_get_next_month($tmp['mon'], $tmp['year']);
        $newout = $tmp2['month'];
      } elseif ($reg[1] == 'NEXT_YEAR') {
        $tmp = dol_getdate(dol_now(), true);
        $newout = ($tmp['year'] + 1);
      } elseif ($reg[1] == 'MYCOMPANY_COUNTRY_ID' || $reg[1] == 'MYCOUNTRY_ID' || $reg[1] == 'MYCOUNTRYID') {
        $newout = $mysoc->country_id;
      } elseif ($reg[1] == 'USER_ID' || $reg[1] == 'USERID') {
        $newout = $user->id;
      } elseif ($reg[1] == 'USER_SUPERVISOR_ID' || $reg[1] == 'SUPERVISOR_ID' || $reg[1] == 'SUPERVISORID') {
        $newout = $user->fk_user;
      } elseif ($reg[1] == 'ENTITY_ID' || $reg[1] == 'ENTITYID') {
        $newout = $conf->entity;
      } else {
        $newout = ''; // Key not found, we replace with empty string
      }
      //var_dump('__'.$reg[1].'__ -> '.$newout);
      $out = preg_replace('/__'.preg_quote($reg[1], '/').'__/', $newout, $out);
    }
  }
 
  // Check rule
  if (preg_match('/^array/', $check)) { // If 'array' or 'array:restricthtml' or 'array:aZ09' or 'array:intcomma'
    if (!is_array($out) || empty($out)) {
      $out = array();
    } else {
      $tmparray = explode(':', $check);
      if (!empty($tmparray[1])) {
        $tmpcheck = $tmparray[1];
      } else {
        $tmpcheck = 'alphanohtml';
      }
      foreach ($out as $outkey => $outval) {
        $out[$outkey] = sanitizeVal($outval, $tmpcheck, $filter, $options);
      }
    }
  } else {
    $out = sanitizeVal($out, $check, $filter, $options);
  }
 
  // Sanitizing for special parameters.
  // Note: There is no reason to allow the backtopage, backtolist or backtourl parameter to contains an external URL. Only relative URLs are allowed.
  if ($paramname == 'backtopage' || $paramname == 'backtolist' || $paramname == 'backtourl') {
    $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 retreive 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_' or is 'smonth', 'syear', 'month', 'year'
  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;
      }
    }
  }
 
  return $out;
}
 
function GETPOSTINT($paramname, $method = 0)
{
  return (int) GETPOST($paramname, 'int', $method, null, null, 0);
}
 
 
function checkVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
{
  return sanitizeVal($out, $check, $filter, $options);
}
 
function sanitizeVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
{
  global $conf;
 
  // TODO : use class "Validate" to perform tests (and add missing tests) if needed for factorize
  // Check is done after replacement
  switch ($check) {
    case 'none':
      break;
    case 'int':    // Check param is a numeric value (integer but also float or hexadecimal)
      if (!is_numeric($out)) {
        $out = '';
      }
      break;
    case 'intcomma':
      if (preg_match('/[^0-9,-]+/i', $out)) {
        $out = '';
      }
      break;
    case 'san_alpha':
      $out = filter_var($out, FILTER_SANITIZE_STRING);
      break;
    case 'email':
      $out = filter_var($out, FILTER_SANITIZE_EMAIL);
      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 '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 'nohtml':    // No html
      $out = dol_string_nohtmltag($out, 0);
      break;
    case 'alpha':   // No html and no ../ and "
    case 'alphanohtml': // Recommended for most scalar parameters and search parameters
      if (!is_array($out)) {
        $out = trim($out);
        do {
          $oldstringtoclean = $out;
          // Remove html tags
          $out = dol_string_nohtmltag($out, 0);
          // Remove also other dangerous string sequences
          // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
          // '../' or '..\' is dangerous because it allows dir transversals
          // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
          $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $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>". Less secured than 'alphanohtml'
      if (!is_array($out)) {
        $out = trim($out);
        do {
          $oldstringtoclean = $out;
          // Remove html tags
          $out = dol_html_entity_decode($out, ENT_COMPAT | ENT_HTML5, 'UTF-8');
          // '"' is dangerous because param in url can close the href= or src= and add javascript functions.
          // '../' or '..\' is dangerous because it allows dir transversals
          // Note &#38, '&#0000038', '&#x26'... is a simple char like '&' alone but there is no reason to accept such way to encode input data.
          $out = str_ireplace(array('&#38', '&#0000038', '&#x26', '&quot', '&#34', '&#0000034', '&#x22', '"', '&#47', '&#0000047', '&#92', '&#0000092', '&#x2F', '../', '..\\'), '', $out);
        } while ($oldstringtoclean != $out);
      }
      break;
    case 'restricthtml':    // Recommended for most html textarea
    case 'restricthtmlallowunvalid':
      $out = dol_htmlwithnojs($out, 1, $check);
      break;
    case 'custom':
      if (!empty($out)) {
        if (empty($filter)) {
          return 'BadParameterForGETPOST - Param 3 of sanitizeVal()';
        }
        /*if (empty($options)) {
          return 'BadParameterForGETPOST - Param 4 of sanitizeVal()';
        }*/
        $out = filter_var($out, $filter, $options);
      }
      break;
  }
 
  return $out;
}
 
 
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 (!empty($conf->global->MAIL_PREFIX_FOR_EMAIL_ID)) {  // If MAIL_PREFIX_FOR_EMAIL_ID is set
        if ($conf->global->MAIL_PREFIX_FOR_EMAIL_ID != 'SERVER_NAME') {
          return $conf->global->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 include. Other globals var must be retrieved with $GLOBALS['var']
 
  $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)) {
          $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($dolibarr_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;
      }
      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 ($type == 1) {
            $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
          }
          if ($type == 2) {
            $res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_MAIN_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
          }
          if ($type == 3) {
            global $dolibarr_main_url_root;
 
            // Define $urlwithroot
            $urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($dolibarr_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 dol_clone($object, $native = 0)
{
  if ($native == 0) {
    // deprecated method, use the method with native = 2 instead
    $tmpsavdb = null;
    if (isset($object->db) && isset($object->db->db) && is_object($object->db->db) && get_class($object->db->db) == 'PgSql\Connection') {
      $tmpsavdb = $object->db;
      unset($object->db);   // Such property can not be serialized with pgsl (when object->db->db = 'PgSql\Connection')
    }
 
    $myclone = unserialize(serialize($object)); // serialize then unserialize is a hack to be sure to have a new object for all fields
 
    if (!empty($tmpsavdb)) {
      $object->db = $tmpsavdb;
    }
  } elseif ($native == 2) {
    // recommended method to have a full isolated cloned object
    $myclone = new stdClass();
    $tmparray = get_object_vars($object); // 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 $object; // PHP clone is a shallow copy only, not a real clone, so properties of references will keep the reference (refering to the same target/variable)
  }
 
  return $myclone;
}
 
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)
{
  // 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 paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  $filesystem_forbidden_chars = array('<', '>', '/', '\\', '?', '*', '|', '"', ':', '°', '$', ';');
  $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  $tmp = preg_replace('/\-\-+/', '_', $tmp);
  $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  $tmp = preg_replace('/\s+\-$/', '', $tmp);
  $tmp = str_replace('..', '', $tmp);
  return $tmp;
}
 
function dol_sanitizePathName($str, $newstr = '_', $unaccent = 1)
{
  // 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.
  // Chars '--' can be used into filename to inject special paramaters like --use-compress-program to make command with file as parameter making remote execution of command
  $filesystem_forbidden_chars = array('<', '>', '?', '*', '|', '"', '°', '$', ';');
  $tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
  $tmp = preg_replace('/\-\-+/', '_', $tmp);
  $tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
  $tmp = preg_replace('/\s+\-$/', '', $tmp);
  $tmp = str_replace('..', '', $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_string_unaccent($str)
{
  global $conf;
 
  if (utf8_check($str)) {
    if (extension_loaded('intl') && !empty($conf->global->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%A0' => 'S',
    '%C3%99' => 'U', '%C3%9A' => 'U', '%C3%9B' => 'U', '%C3%9C' => '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%A1' => 's',
    '%C3%B9' => 'u', '%C3%BA' => 'u', '%C3%BB' => 'u', '%C3%BC' => 'u',
    '%C3%BD' => 'y', '%C3%BF' => 'y'
    );
    $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 = '')
{
  $forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ",", ";", "=", '°'); // more complete than dol_sanitizeFileName
  $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;
  }
 
  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 dol_escape_js($stringtoescape, $mode = 0, $noescapebackslashn = 0)
{
  // 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($stringtoescape, $substitjs);
}
 
function dol_escape_json($stringtoescape)
{
  return str_replace('"', '\"', $stringtoescape);
}
 
function dol_escape_htmltag($stringtoescape, $keepb = 0, $keepn = 0, $noescapetags = '', $escapeonlyhtmltags = 0)
{
  if ($noescapetags == 'common') {
    $noescapetags = 'html,body,a,b,em,hr,i,u,ul,li,br,div,img,font,p,span,strong,table,tr,td,th,tbody';
  }
 
  // escape quotes and backslashes, newlines, etc.
  if ($escapeonlyhtmltags) {
    $tmp = htmlspecialchars_decode((string) $stringtoescape, ENT_COMPAT);
  } else {
    $tmp = html_entity_decode((string) $stringtoescape, ENT_COMPAT, 'UTF-8');
  }
  if (!$keepb) {
    $tmp = strtr($tmp, array("<b>"=>'', '</b>'=>''));
  }
  if (!$keepn) {
    $tmp = strtr($tmp, array("\r"=>'\\r', "\n"=>'\\n'));
  }
 
  if ($escapeonlyhtmltags) {
    return htmlspecialchars($tmp, ENT_COMPAT, 'UTF-8');
  } else {
    // Escape tags to keep
    // TODO Does not works yet when there is attributes into tag
    $tmparrayoftags = array();
    if ($noescapetags) {
      $tmparrayoftags = explode(',', $noescapetags);
    }
    if (count($tmparrayoftags)) {
      foreach ($tmparrayoftags as $tagtoreplace) {
        $tmp = str_ireplace('<'.$tagtoreplace.'>', '__BEGINTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
        $tmp = str_ireplace('</'.$tagtoreplace.'>', '__ENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
        $tmp = str_ireplace('<'.$tagtoreplace.' />', '__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
      }
    }
 
    $result = htmlentities($tmp, ENT_COMPAT, 'UTF-8');
 
    if (count($tmparrayoftags)) {
      foreach ($tmparrayoftags as $tagtoreplace) {
        $result = str_ireplace('__BEGINTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.'>', $result);
        $result = str_ireplace('__ENDTAGTOREPLACE'.$tagtoreplace.'__', '</'.$tagtoreplace.'>', $result);
        $result = str_ireplace('__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.' />', $result);
      }
    }
 
    return $result;
  }
}
 
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 dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename = '', $restricttologhandler = '', $logcontext = null)
{
  global $conf, $user, $debugbar;
 
  // If syslog module enabled
  if (empty($conf->syslog->enabled)) {
    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
    $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)) {
      throw new Exception('Incorrect log level');
    }
    if ($level > $conf->global->SYSLOG_LEVEL) {
      return;
    }
 
    if (empty($conf->global->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']) && !empty($conf->global->MAIN_ENABLE_LOG_TO_HTML))
      || (!empty($user->rights->debugbar->read) && is_object($debugbar))) {
      $conf->logbuffer[] = dol_print_date(time(), "%Y-%m-%d %H:%M:%S")." ".$logLevels[$level]." ".$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 (!empty($conf->global->MAIN_ENABLE_LOG_INLINE_HTML) && !empty($_GET["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') : false),
      'level' => $level,
      'user' => ((is_object($user) && $user->id) ? $user->login : false),
      'ip' => false
    );
 
    $remoteip = getUserRemoteIP(); // Get ip when page run on a web server
    if (!empty($remoteip)) {
      $data['ip'] = $remoteip;
      // This is when server run behind a reverse proxy
      if (!empty($_SERVER['HTTP_X_FORWARDED_FOR']) && $_SERVER['HTTP_X_FORWARDED_FOR'] != $remoteip) {
        $data['ip'] = $_SERVER['HTTP_X_FORWARDED_FOR'].' -> '.$data['ip'];
      } elseif (!empty($_SERVER['HTTP_CLIENT_IP']) && $_SERVER['HTTP_CLIENT_IP'] != $remoteip) {
        $data['ip'] = $_SERVER['HTTP_CLIENT_IP'].' -> '.$data['ip'];
      }
    } 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'] = $_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 defined it).
      $data['ip'] = $_SERVER['COMPUTERNAME'].(empty($_SERVER['USERNAME']) ? '' : '@'.$_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 usefull if OS defined it).
      $data['ip'] = '???@'.$_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 dolButtonToOpenUrlInDialogPopup($name, $label, $buttonstring, $url, $disabled = '', $morecss = 'button bordertransp', $backtopagejsfields = '')
{
  global $conf;
 
  if (strpos($url, '?') > 0) {
    $url .= '&dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  } else {
    $url .= '?dol_hide_topmenu=1&dol_hide_leftmenu=1&dol_openinpopup='.urlencode($name);
  }
 
  $out = '';
 
  $backtopagejsfieldsid = ''; $backtopagejsfieldslabel = '';
  if ($backtopagejsfields) {
    $tmpbacktopagejsfields = explode(':', $backtopagejsfields);
    if (empty($tmpbacktopagejsfields[1])) { // If the part 'keyforpopupid:' is missing, we add $name for it.
      $backtopagejsfields = $name.":".$backtopagejsfields;
      $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[0]);
    } else {
      $tmp2backtopagejsfields = explode(',', $tmpbacktopagejsfields[1]);
    }
    $backtopagejsfieldsid = empty($tmp2backtopagejsfields[0]) ? '' : $tmp2backtopagejsfields[0];
    $backtopagejsfieldslabel = empty($tmp2backtopagejsfields[1]) ? '' : $tmp2backtopagejsfields[1];
    $url .= '&backtopagejsfields='.urlencode($backtopagejsfields);
  }
 
  //print '<input type="submit" class="button bordertransp"'.$disabled.' value="'.dol_escape_htmltag($langs->trans("MediaFiles")).'" name="file_manager">';
  $out .= '<!-- a link for button to open url into a dialog popup with backtopagejsfields = '.$backtopagejsfields.' -->';
  $out .= '<a class="cursorpointer classlink button_'.$name.($morecss ? ' '.$morecss : '').'"'.$disabled.' title="'.dol_escape_htmltag($label).'"';
  if (empty($conf->use_javascript_ajax)) {
    $out .= ' href="'.DOL_URL_ROOT.$url.'" target="_blank"';
  }
  $out .= '>'.$buttonstring.'</a>';
 
  if (!empty($conf->use_javascript_ajax)) {
    // Add code to open url using the popup. Add also hidden field to retreive the returned variables
    $out .= '<!-- code to open popup and variables to retreive returned variables -->';
    $out .= '<div id="idfordialog'.$name.'" class="hidden">div for dialog</div>';
    $out .= '<div id="varforreturndialogid'.$name.'" class="hidden">div for returned id</div>';
    $out .= '<div id="varforreturndialoglabel'.$name.'" class="hidden">div for returned label</div>';
    $out .= '<!-- Add js code to open dialog popup on dialog -->';
    $out .= '<script type="text/javascript">
          jQuery(document).ready(function () {
            jQuery(".button_'.$name.'").click(function () {
              console.log(\'Open popup with jQuery(...).dialog() on URL '.dol_escape_js(DOL_URL_ROOT.$url).'\');
              var $tmpdialog = $(\'#idfordialog'.$name.'\');
              $tmpdialog.html(\'<iframe class="iframedialog" id="iframedialog'.$name.'" style="border: 0px;" src="'.DOL_URL_ROOT.$url.'" width="100%" height="98%"></iframe>\');
              $tmpdialog.dialog({
                autoOpen: false,
                modal: true,
                height: (window.innerHeight - 150),
                width: \'80%\',
                title: \''.dol_escape_js($label).'\',
                open: function (event, ui) {
                  console.log("open popup name='.$name.', backtopagejsfields='.$backtopagejsfields.'");
                    },
                close: function (event, ui) {
                  returnedid = jQuery("#varforreturndialogid'.$name.'").text();
                  returnedlabel = jQuery("#varforreturndialoglabel'.$name.'").text();
                  console.log("popup has been closed. returnedid (js var defined into parent page)="+returnedid+" returnedlabel="+returnedlabel);
                  if (returnedid != "" && returnedid != "div for returned id") {
                    jQuery("#'.(empty($backtopagejsfieldsid)?"none":$backtopagejsfieldsid).'").val(returnedid);
                  }
                  if (returnedlabel != "" && returnedlabel != "div for returned label") {
                    jQuery("#'.(empty($backtopagejsfieldslabel)?"none":$backtopagejsfieldslabel).'").val(returnedlabel);
                  }
                }
              });
 
              $tmpdialog.dialog(\'open\');
            });
          });
        </script>';
  }
  return $out;
}
 
function dol_fiche_head($links = array(), $active = '0', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '')
{
  print dol_get_fiche_head($links, $active, $title, $notab, $picto, $pictoisfullpath, $morehtmlright, $morecss, $limittoshow, $moretabssuffix);
}
 
function dol_get_fiche_head($links = array(), $active = '', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '')
{
  global $conf, $langs, $hookmanager;
 
  // Show title
  $showtitle = 1;
  if (!empty($conf->dol_optimize_smallscreen)) {
    $showtitle = 0;
  }
 
  $out = "\n".'<!-- dol_fiche_head - dol_get_fiche_head -->';
 
  if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
    $out .= '<div class="tabs'.($picto ? '' : ' nopaddingleft').'" data-role="controlgroup" data-type="horizontal">'."\n";
  }
 
  // Show right part
  if ($morehtmlright) {
    $out .= '<div class="inline-block floatright tabsElem">'.$morehtmlright.'</div>'; // Output right area first so when space is missing, text is in front of tabs and not under.
  }
 
  // Show title
  if (!empty($title) && $showtitle && empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
    $limittitle = 30;
    $out .= '<a class="tabTitle">';
    if ($picto) {
      $noprefix = $pictoisfullpath;
      if (strpos($picto, 'fontawesome_') !== false) {
        $noprefix = 1;
      }
      $out .= img_picto($title, ($noprefix ? '' : 'object_').$picto, '', $pictoisfullpath, 0, 0, '', 'imgTabTitle').' ';
    }
    $out .= '<span class="tabTitleText">'.dol_escape_htmltag(dol_trunc($title, $limittitle)).'</span>';
    $out .= '</a>';
  }
 
  // Show tabs
 
  // Define max of key (max may be higher than sizeof because of hole due to module disabling some tabs).
  $maxkey = -1;
  if (is_array($links) && !empty($links)) {
    $keys = array_keys($links);
    if (count($keys)) {
      $maxkey = max($keys);
    }
  }
 
  // Show tabs
  // if =0 we don't use the feature
  if (empty($limittoshow)) {
    $limittoshow = (empty($conf->global->MAIN_MAXTABS_IN_CARD) ? 99 : $conf->global->MAIN_MAXTABS_IN_CARD);
  }
  if (!empty($conf->dol_optimize_smallscreen)) {
    $limittoshow = 2;
  }
 
  $displaytab = 0;
  $nbintab = 0;
  $popuptab = 0;
  $outmore = '';
  for ($i = 0; $i <= $maxkey; $i++) {
    if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
      // If active tab is already present
      if ($i >= $limittoshow) {
        $limittoshow--;
      }
    }
  }
 
  for ($i = 0; $i <= $maxkey; $i++) {
    if ((is_numeric($active) && $i == $active) || (!empty($links[$i][2]) && !is_numeric($active) && $active == $links[$i][2])) {
      $isactive = true;
    } else {
      $isactive = false;
    }
 
    if ($i < $limittoshow || $isactive) {
      // Output entry with a visible tab
      $out .= '<div class="inline-block tabsElem'.($isactive ? ' tabsElemActive' : '').((!$isactive && !empty($conf->global->MAIN_HIDE_INACTIVETAB_ON_PRINT)) ? ' hideonprint' : '').'"><!-- id tab = '.(empty($links[$i][2]) ? '' : dol_escape_htmltag($links[$i][2])).' -->';
 
      if (isset($links[$i][2]) && $links[$i][2] == 'image') {
        if (!empty($links[$i][0])) {
          $out .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
        } else {
          $out .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
        }
      } elseif (!empty($links[$i][1])) {
        //print "x $i $active ".$links[$i][2]." z";
        $out .= '<div class="tab tab'.($isactive?'active':'unactive').'" style="margin: 0 !important">';
        if (!empty($links[$i][0])) {
          $titletoshow = preg_replace('/<.*$/', '', $links[$i][1]);
          $out .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="tab inline-block valignmiddle'.($morecss ? ' '.$morecss : '').(!empty($links[$i][5]) ? ' '.$links[$i][5] : '').'" href="'.$links[$i][0].'" title="'.dol_escape_htmltag($titletoshow).'">';
        }
        $out .= $links[$i][1];
        if (!empty($links[$i][0])) {
          $out .= '</a>'."\n";
        }
        $out .= empty($links[$i][4]) ? '' : $links[$i][4];
        $out .= '</div>';
      }
 
      $out .= '</div>';
    } else {
      // Add entry into the combo popup with the other tabs
      if (!$popuptab) {
        $popuptab = 1;
        $outmore .= '<div class="popuptabset wordwrap">'; // The css used to hide/show popup
      }
      $outmore .= '<div class="popuptab wordwrap" style="display:inherit;">';
      if (isset($links[$i][2]) && $links[$i][2] == 'image') {
        if (!empty($links[$i][0])) {
          $outmore .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
        } else {
          $outmore .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
        }
      } elseif (!empty($links[$i][1])) {
        $outmore .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="wordwrap inline-block'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">';
        $outmore .= preg_replace('/([a-z])\/([a-z])/i', '\\1 / \\2', $links[$i][1]); // Replace x/y with x / y to allow wrap on long composed texts.
        $outmore .= '</a>'."\n";
      }
      $outmore .= '</div>';
 
      $nbintab++;
    }
    $displaytab = $i;
  }
  if ($popuptab) {
    $outmore .= '</div>';
  }
 
  if ($popuptab) {  // If there is some tabs not shown
    $left = ($langs->trans("DIRECTION") == 'rtl' ? 'right' : 'left');
    $right = ($langs->trans("DIRECTION") == 'rtl' ? 'left' : 'right');
    $widthofpopup = 200;
 
    $tabsname = $moretabssuffix;
    if (empty($tabsname)) {
      $tabsname = str_replace("@", "", $picto);
    }
    $out .= '<div id="moretabs'.$tabsname.'" class="inline-block tabsElem valignmiddle">';
    $out .= '<div class="tab"><a href="#" class="tab moretab inline-block tabunactive"><span class="hideonsmartphone">'.$langs->trans("More").'</span>... ('.$nbintab.')</a></div>'; // Do not use "reposition" class in the "More".
    $out .= '<div id="moretabsList'.$tabsname.'" style="width: '.$widthofpopup.'px; position: absolute; '.$left.': -999em; text-align: '.$left.'; margin:0px; padding:2px; z-index:10;">';
    $out .= $outmore;
    $out .= '</div>';
    $out .= '<div></div>';
    $out .= "</div>\n";
 
    $out .= "<script>";
    $out .= "$('#moretabs".$tabsname."').mouseenter( function() {
      var x = this.offsetLeft, y = this.offsetTop;
      console.log('mouseenter ".$left." x='+x+' y='+y+' window.innerWidth='+window.innerWidth);
      if ((window.innerWidth - x) < ".($widthofpopup + 10).") {
        $('#moretabsList".$tabsname."').css('".$right."','8px');
      }
      $('#moretabsList".$tabsname."').css('".$left."','auto');
      });
    ";
    $out .= "$('#moretabs".$tabsname."').mouseleave( function() { console.log('mouseleave ".$left."'); $('#moretabsList".$tabsname."').css('".$left."','-999em');});";
    $out .= "</script>";
  }
 
  if ((!empty($title) && $showtitle) || $morehtmlright || !empty($links)) {
    $out .= "</div>\n";
  }
 
  if (!$notab || $notab == -1 || $notab == -2 || $notab == -3) {
    $out .= "\n".'<div class="tabBar'.($notab == -1 ? '' : ($notab == -2 ? ' tabBarNoTop' : (($notab == -3 ? ' noborderbottom' : '').' tabBarWithBottom'))).'">'."\n";
  }
 
  $parameters = array('tabname' => $active, 'out' => $out);
  $reshook = $hookmanager->executeHooks('printTabsHead', $parameters); // This hook usage is called just before output the head of tabs. Take also a look at "completeTabsHead"
  if ($reshook > 0) {
    $out = $hookmanager->resPrint;
  }
 
  return $out;
}
 
function dol_fiche_end($notab = 0)
{
  print dol_get_fiche_end($notab);
}
 
function dol_get_fiche_end($notab = 0)
{
  if (!$notab || $notab == -1) {
    return "\n</div>\n";
  } else {
    return '';
  }
}
 
function dol_banner_tab($object, $paramid, $morehtml = '', $shownav = 1, $fieldid = 'rowid', $fieldref = 'ref', $morehtmlref = '', $moreparam = '', $nodbprefix = 0, $morehtmlleft = '', $morehtmlstatus = '', $onlybanner = 0, $morehtmlright = '')
{
  global $conf, $form, $user, $langs, $hookmanager, $action;
 
  $error = 0;
 
  $maxvisiblephotos = 1;
  $showimage = 1;
  $entity = (empty($object->entity) ? $conf->entity : $object->entity);
  $showbarcode = empty($conf->barcode->enabled) ? 0 : (empty($object->barcode) ? 0 : 1);
  if (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && empty($user->rights->barcode->lire_advance)) {
    $showbarcode = 0;
  }
  $modulepart = 'unknown';
 
  if ($object->element == 'societe' || $object->element == 'contact' || $object->element == 'product' || $object->element == 'ticket') {
    $modulepart = $object->element;
  } elseif ($object->element == 'member') {
    $modulepart = 'memberphoto';
  } elseif ($object->element == 'user') {
    $modulepart = 'userphoto';
  }
 
  if (class_exists("Imagick")) {
    if ($object->element == 'expensereport' || $object->element == 'propal' || $object->element == 'commande' || $object->element == 'facture' || $object->element == 'supplier_proposal') {
      $modulepart = $object->element;
    } elseif ($object->element == 'fichinter') {
      $modulepart = 'ficheinter';
    } elseif ($object->element == 'contrat') {
      $modulepart = 'contract';
    } elseif ($object->element == 'order_supplier') {
      $modulepart = 'supplier_order';
    } elseif ($object->element == 'invoice_supplier') {
      $modulepart = 'supplier_invoice';
    }
  }
 
  if ($object->element == 'product') {
    $width = 80;
    $cssclass = 'photowithmargin photoref';
    $showimage = $object->is_photo_available($conf->product->multidir_output[$entity]);
    $maxvisiblephotos = (isset($conf->global->PRODUCT_MAX_VISIBLE_PHOTO) ? $conf->global->PRODUCT_MAX_VISIBLE_PHOTO : 5);
    if ($conf->browser->layout == 'phone') {
      $maxvisiblephotos = 1;
    }
    if ($showimage) {
      $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos('product', $conf->product->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, $width, 0).'</div>';
    } else {
      if (!empty($conf->global->PRODUCT_NODISPLAYIFNOPHOTO)) {
        $nophoto = '';
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
      } else {    // Show no photo link
        $nophoto = '/public/theme/common/nophoto.png';
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photo'.$modulepart.($cssclass ? ' '.$cssclass : '').'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
      }
    }
  } elseif ($object->element == 'ticket') {
    $width = 80;
    $cssclass = 'photoref';
    $showimage = $object->is_photo_available($conf->ticket->multidir_output[$entity].'/'.$object->ref);
    $maxvisiblephotos = (isset($conf->global->TICKET_MAX_VISIBLE_PHOTO) ? $conf->global->TICKET_MAX_VISIBLE_PHOTO : 2);
    if ($conf->browser->layout == 'phone') {
      $maxvisiblephotos = 1;
    }
 
    if ($showimage) {
      $showphoto = $object->show_photos('ticket', $conf->ticket->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, $width, 0);
      if ($object->nbphoto > 0) {
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$showphoto.'</div>';
      } else {
        $showimage = 0;
      }
    }
    if (!$showimage) {
      if (!empty($conf->global->TICKET_NODISPLAYIFNOPHOTO)) {
        $nophoto = '';
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"></div>';
      } else {    // Show no photo link
        $nophoto = img_picto('No photo', 'object_ticket');
        $morehtmlleft .= '<!-- No photo to show -->';
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
        $morehtmlleft .= $nophoto;
        $morehtmlleft .= '</div></div>';
      }
    }
  } else {
    if ($showimage) {
      if ($modulepart != 'unknown') {
        $phototoshow = '';
        // Check if a preview file is available
        if (in_array($modulepart, array('propal', 'commande', 'facture', 'ficheinter', 'contract', 'supplier_order', 'supplier_proposal', 'supplier_invoice', 'expensereport')) && class_exists("Imagick")) {
          $objectref = dol_sanitizeFileName($object->ref);
          $dir_output = (empty($conf->$modulepart->multidir_output[$entity]) ? $conf->$modulepart->dir_output : $conf->$modulepart->multidir_output[$entity])."/";
          if (in_array($modulepart, array('invoice_supplier', 'supplier_invoice'))) {
            $subdir = get_exdir($object->id, 2, 0, 1, $object, $modulepart);
            $subdir .= ((!empty($subdir) && !preg_match('/\/$/', $subdir)) ? '/' : '').$objectref; // the objectref dir is not included into get_exdir when used with level=2, so we add it at end
          } else {
            $subdir = get_exdir($object->id, 0, 0, 1, $object, $modulepart);
          }
          if (empty($subdir)) {
            $subdir = 'errorgettingsubdirofobject'; // Protection to avoid to return empty path
          }
 
          $filepath = $dir_output.$subdir."/";
 
          $filepdf = $filepath.$objectref.".pdf";
          $relativepath = $subdir.'/'.$objectref.'.pdf';
 
          // Define path to preview pdf file (preview precompiled "file.ext" are "file.ext_preview.png")
          $fileimage = $filepdf.'_preview.png';
          $relativepathimage = $relativepath.'_preview.png';
 
          $pdfexists = file_exists($filepdf);
 
          // If PDF file exists
          if ($pdfexists) {
            // Conversion du PDF en image png si fichier png non existant
            if (!file_exists($fileimage) || (filemtime($fileimage) < filemtime($filepdf))) {
              if (empty($conf->global->MAIN_DISABLE_PDF_THUMBS)) {    // If you experience trouble with pdf thumb generation and imagick, you can disable here.
                include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
                $ret = dol_convert_file($filepdf, 'png', $fileimage, '0'); // Convert first page of PDF into a file _preview.png
                if ($ret < 0) {
                  $error++;
                }
              }
            }
          }
 
          if ($pdfexists && !$error) {
            $heightforphotref = 80;
            if (!empty($conf->dol_optimize_smallscreen)) {
              $heightforphotref = 60;
            }
            // If the preview file is found
            if (file_exists($fileimage)) {
              $phototoshow = '<div class="photoref">';
              $phototoshow .= '<img height="'.$heightforphotref.'" class="photo photowithborder" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart=apercu'.$modulepart.'&amp;file='.urlencode($relativepathimage).'">';
              $phototoshow .= '</div>';
            }
          }
        } elseif (!$phototoshow) { // example if modulepart = 'societe' or 'photo'
          $phototoshow .= $form->showphoto($modulepart, $object, 0, 0, 0, 'photowithmargin photoref', 'small', 1, 0, $maxvisiblephotos);
        }
 
        if ($phototoshow) {
          $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">';
          $morehtmlleft .= $phototoshow;
          $morehtmlleft .= '</div>';
        }
      }
 
      if (empty($phototoshow)) {      // Show No photo link (picto of object)
        if ($object->element == 'action') {
          $width = 80;
          $cssclass = 'photorefcenter';
          $nophoto = img_picto('No photo', 'title_agenda');
        } else {
          $width = 14;
          $cssclass = 'photorefcenter';
          $picto = $object->picto;
          $prefix = 'object_';
          if ($object->element == 'project' && !$object->public) {
            $picto = 'project'; // instead of projectpub
          }
          if (strpos($picto, 'fontawesome_') !== false) {
            $prefix = '';
          }
          $nophoto = img_picto('No photo', $prefix.$picto);
        }
        $morehtmlleft .= '<!-- No photo to show -->';
        $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref">';
        $morehtmlleft .= $nophoto;
        $morehtmlleft .= '</div></div>';
      }
    }
  }
 
  if ($showbarcode) {
    $morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$form->showbarcode($object, 100, 'photoref valignmiddle').'</div>';
  }
 
  if ($object->element == 'societe') {
    if (!empty($conf->use_javascript_ajax) && $user->hasRight('societe', 'creer') && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
      $morehtmlstatus .= ajax_object_onoff($object, 'status', 'status', 'InActivity', 'ActivityCeased');
    } else {
      $morehtmlstatus .= $object->getLibStatut(6);
    }
  } elseif ($object->element == 'product') {
    //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Sell").') ';
    if (!empty($conf->use_javascript_ajax) && $user->rights->produit->creer && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
      $morehtmlstatus .= ajax_object_onoff($object, 'status', 'tosell', 'ProductStatusOnSell', 'ProductStatusNotOnSell');
    } else {
      $morehtmlstatus .= '<span class="statusrefsell">'.$object->getLibStatut(6, 0).'</span>';
    }
    $morehtmlstatus .= ' &nbsp; ';
    //$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Buy").') ';
    if (!empty($conf->use_javascript_ajax) && $user->rights->produit->creer && !empty($conf->global->MAIN_DIRECT_STATUS_UPDATE)) {
      $morehtmlstatus .= ajax_object_onoff($object, 'status_buy', 'tobuy', 'ProductStatusOnBuy', 'ProductStatusNotOnBuy');
    } else {
      $morehtmlstatus .= '<span class="statusrefbuy">'.$object->getLibStatut(6, 1).'</span>';
    }
  } elseif (in_array($object->element, array('facture', 'invoice', 'invoice_supplier', 'chargesociales', 'loan', 'tva', 'salary'))) {
    $tmptxt = $object->getLibStatut(6, $object->totalpaid);
    if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
      $tmptxt = $object->getLibStatut(5, $object->totalpaid);
    }
    $morehtmlstatus .= $tmptxt;
  } elseif ($object->element == 'contrat' || $object->element == 'contract') {
    if ($object->statut == 0) {
      $morehtmlstatus .= $object->getLibStatut(5);
    } else {
      $morehtmlstatus .= $object->getLibStatut(4);
    }
  } elseif ($object->element == 'facturerec') {
    if ($object->frequency == 0) {
      $morehtmlstatus .= $object->getLibStatut(2);
    } else {
      $morehtmlstatus .= $object->getLibStatut(5);
    }
  } elseif ($object->element == 'project_task') {
    $object->fk_statut = 1;
    if ($object->progress > 0) {
      $object->fk_statut = 2;
    }
    if ($object->progress >= 100) {
      $object->fk_statut = 3;
    }
    $tmptxt = $object->getLibStatut(5);
    $morehtmlstatus .= $tmptxt; // No status on task
  } else { // Generic case
    if (isset($object->status)) {
      $tmptxt = $object->getLibStatut(6);
      if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
        $tmptxt = $object->getLibStatut(5);
      }
      $morehtmlstatus .= $tmptxt;
    }
  }
 
  // Add if object was dispatched "into accountancy"
  if (isModEnabled('accounting') && in_array($object->element, array('bank', 'paiementcharge', 'facture', 'invoice', 'invoice_supplier', 'expensereport', 'payment_various'))) {
    // Note: For 'chargesociales', 'salaries'... this is the payments that are dispatched (so element = 'bank')
    if (method_exists($object, 'getVentilExportCompta')) {
      $accounted = $object->getVentilExportCompta();
      $langs->load("accountancy");
      $morehtmlstatus .= '</div><div class="statusref statusrefbis"><span class="opacitymedium">'.($accounted > 0 ? $langs->trans("Accounted") : $langs->trans("NotYetAccounted")).'</span>';
    }
  }
 
  // Add alias for thirdparty
  if (!empty($object->name_alias)) {
    $morehtmlref .= '<div class="refidno opacitymedium">'.$object->name_alias.'</div>';
  }
 
  // Add label
  if (in_array($object->element, array('product', 'bank_account', 'project_task'))) {
    if (!empty($object->label)) {
      $morehtmlref .= '<div class="refidno opacitymedium">'.$object->label.'</div>';
    }
  }
 
  // Show address and email
  if (method_exists($object, 'getBannerAddress') && !in_array($object->element, array('product', 'bookmark', 'ecm_directories', 'ecm_files'))) {
    $moreaddress = $object->getBannerAddress('refaddress', $object);
    if ($moreaddress) {
      $morehtmlref .= '<div class="refidno">';
      $morehtmlref .= $moreaddress;
      $morehtmlref .= '</div>';
    }
  }
  if (!empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && ($conf->global->MAIN_SHOW_TECHNICAL_ID == '1' || preg_match('/'.preg_quote($object->element, '/').'/i', $conf->global->MAIN_SHOW_TECHNICAL_ID)) && !empty($object->id)) {
    $morehtmlref .= '<div style="clear: both;"></div>';
    $morehtmlref .= '<div class="refidno opacitymedium">';
    $morehtmlref .= $langs->trans("TechnicalID").': '.$object->id;
    $morehtmlref .= '</div>';
  }
 
  $parameters=array('morehtmlref'=>$morehtmlref);
  $reshook = $hookmanager->executeHooks('formDolBanner', $parameters, $object, $action);
  if ($reshook < 0) {
    setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  } elseif (empty($reshook)) {
    $morehtmlref .= $hookmanager->resPrint;
  } elseif ($reshook > 0) {
    $morehtmlref = $hookmanager->resPrint;
  }
 
 
  print '<div class="'.($onlybanner ? 'arearefnobottom ' : 'arearef ').'heightref valignmiddle centpercent">';
  print $form->showrefnav($object, $paramid, $morehtml, $shownav, $fieldid, $fieldref, $morehtmlref, $moreparam, $nodbprefix, $morehtmlleft, $morehtmlstatus, $morehtmlright);
  print '</div>';
  print '<div class="underrefbanner clearboth"></div>';
}
 
function fieldLabel($langkey, $fieldkey, $fieldrequired = 0)
{
  global $langs;
  $ret = '';
  if ($fieldrequired) {
    $ret .= '<span class="fieldrequired">';
  }
  $ret .= '<label for="'.$fieldkey.'">';
  $ret .= $langs->trans($langkey);
  $ret .= '</label>';
  if ($fieldrequired) {
    $ret .= '</span>';
  }
  return $ret;
}
 
function dol_bc($var, $moreclass = '')
{
  global $bc;
  $ret = ' '.$bc[$var];
  if ($moreclass) {
    $ret = preg_replace('/class=\"/', 'class="'.$moreclass.' ', $ret);
  }
  return $ret;
}
 
function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs = '', $mode = 0, $extralangcode = '')
{
  global $conf, $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 ? $object->array_languages['address'][$extralangcode] : (empty($object->address) ? '' : $object->address));
  }
  // Zip/Town/State
  if (isset($object->country_code) && in_array($object->country_code, array('AU', 'CA', 'US', 'CN')) || !empty($conf->global->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 .= "\n".$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 ? $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 ($is_gmt) ? @gmstrftime($fmt, $ts) : @strftime($fmt, $ts);
  } else {
    return 'Error date into a not supported range';
  }
}
 
function dol_print_date($time, $format = '', $tzoutput = 'auto', $outputlangs = '', $encodetooutput = false)
{
  global $conf, $langs;
 
  // If date undefined or "", we return ""
  if (dol_strlen($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;
  $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'
        $offsettz = 0;  // Timezone offset with server timezone (because to_gmt is false), so 0
        $offsetdst = 0; // Dst offset with server timezone (because to_gmt is false), so 0
      } elseif ($tzoutput == 'tzuser' || $tzoutput == 'tzuserrel') {
        $to_gmt = true;
        $offsettzstring = (empty($_SESSION['dol_tz_string']) ? 'UTC' : $_SESSION['dol_tz_string']); // Example 'Europe/Berlin' or 'Indian/Reunion'
 
        if (class_exists('DateTimeZone')) {
          $user_date_tz = new DateTimeZone($offsettzstring);
          $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'))) ? 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 == '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 inhibate 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 inhibate 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', $time, $reg)) { // Deprecated. Ex: 1970-01-01, 1970-01-01 01:00:00, 19700101010000
    dol_print_error('', "Functions.lib::dol_print_date function called with a bad value from page ".$_SERVER["PHP_SELF"]);
    return '';
  } elseif (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i', $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 from page ".$_SERVER["PHP_SELF"], LOG_WARNING);
    //if (function_exists('debug_print_backtrace')) debug_print_backtrace();
    // 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($shour, $smin, $ssec, $smonth, $sday, $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
      $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);
      $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
      );
      //var_dump($ret);exit;
    } 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 = $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);
  }
 
  return $ret;
}
 
 
function dol_getdate($timestamp, $fast = false, $forcetimezone = '')
{
  $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 ".$_SESSION["dol_tz_string"], LOG_WARNING);
      $default_timezone = @date_default_timezone_get();
    }
  } elseif (strrpos($gm, "tz,") !== false) {
    $timezone = 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');
  }
  //var_dump($localtz);
  //var_dump($year.'-'.$month.'-'.$day.'-'.$hour.'-'.$minute);
  $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
  //var_dump($date);
  return $date;
}
 
 
function dol_now($mode = 'auto')
{
  $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)
{
  global $langs;
 
  if (empty($url)) {
    return '';
  }
 
  $link = '<a href="';
  if (!preg_match('/^http/i', $url)) {
    $link .= 'http://';
  }
  $link .= $url;
  $link .= '"';
  if ($target) {
    $link .= ' target="'.$target.'"';
  }
  $link .= '>';
  if (!preg_match('/^http/i', $url)) {
    $link .= 'http://';
  }
  $link .= dol_trunc($url, $max);
  $link .= '</a>';
  return '<div class="nospan float" style="margin-right: 10px">'.($withpicto ?img_picto($langs->trans("Url"), 'globe').' ' : '').$link.'</div>';
}
 
function dol_print_email($email, $cid = 0, $socid = 0, $addlink = 0, $max = 64, $showinvalid = 1, $withpicto = 0)
{
  global $conf, $user, $langs, $hookmanager;
 
  $newemail = dol_escape_htmltag($email);
 
  if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER) && $withpicto) {
    $withpicto = 0;
  }
 
  if (empty($email)) {
    return '&nbsp;';
  }
 
  if (!empty($addlink)) {
    $newemail = '<a style="text-overflow: ellipsis;" href="';
    if (!preg_match('/^mailto:/i', $email)) {
      $newemail .= 'mailto:';
    }
    $newemail .= $email;
    $newemail .= '">';
    $newemail .= dol_trunc($email, $max);
    $newemail .= '</a>';
    if ($showinvalid && !isValidEmail($email)) {
      $langs->load("errors");
      $newemail .= img_warning($langs->trans("ErrorBadEMail", $email));
    }
 
    if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
      $type = 'AC_EMAIL';
      $link = '';
      if (!empty($conf->global->AGENDA_ADDACTIONFOREMAIL)) {
        $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$type.'&amp;contactid='.$cid.'&amp;socid='.$socid.'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
      }
      if ($link) {
        $newemail = '<div>'.$newemail.' '.$link.'</div>';
      }
    }
  } else {
    if ($showinvalid && !isValidEmail($email)) {
      $langs->load("errors");
      $newemail .= img_warning($langs->trans("ErrorBadEMail", $email));
    }
  }
 
  //$rep = '<div class="nospan" style="margin-right: 10px">';
  $rep = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto)).' ' : '').$newemail;
  //$rep .= '</div>';
  if ($hookmanager) {
    $parameters = array('cid' => $cid, 'socid' => $socid, 'addlink' => $addlink, 'picto' => $withpicto);
 
    $reshook = $hookmanager->executeHooks('printEmail', $parameters, $email);
    if ($reshook > 0) {
      $rep = '';
    }
    $rep .= $hookmanager->resPrint;
  }
 
  return $rep;
}
 
function getArrayOfSocialNetworks()
{
  global $conf, $db;
 
  $socialnetworks = array();
  // Enable caching of array
  require_once DOL_DOCUMENT_ROOT.'/core/lib/memory.lib.php';
  $cachekey = 'socialnetworks_' . $conf->entity;
  $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=".$conf->entity;
    $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 $socialnetworks;
}
 
function dol_print_socialnetworks($value, $cid, $socid, $type, $dictsocialnetworks = array())
{
  global $conf, $user, $langs;
 
  $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="fa paddingright '.($dictsocialnetworks[$type]['icon'] ? $dictsocialnetworks[$type]['icon'] : 'fa-link').'"></span>';
    if ($type == 'skype') {
      $htmllink .= dol_escape_htmltag($value);
      $htmllink .= '&nbsp;';
      $htmllink .= '<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 (($cid || $socid) && isModEnabled('agenda') && $user->rights->agenda->myactions->create) {
        $addlink = 'AC_SKYPE';
        $link = '';
        if (!empty($conf->global->AGENDA_ADDACTIONFORSKYPE)) {
          $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$addlink.'&amp;contactid='.$cid.'&amp;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);
          }
        }
        $link = str_replace('{socialid}', $value, $dictsocialnetworks[$type]['url']);
        if (preg_match('/^https?:\/\//i', $link)) {
          $htmllink .= '&nbsp;<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
        } else {
          $htmllink .= '&nbsp;<a href="'.dol_sanitizeUrl($link, 1).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
        }
      } else {
        $htmllink .= dol_escape_htmltag($value);
      }
    }
    $htmllink .= '</div>';
  } else {
    $langs->load("errors");
    $htmllink .= img_warning($langs->trans("ErrorBadSocialNetworkValue", $value));
  }
  return $htmllink;
}
 
function dol_print_profids($profID, $profIDtype, $countrycode = '', $addcpButton = 1, $separ = '&nbsp;')
{
  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
    if ($id == 1 && dol_strlen($newProfID) == 9)  $newProfID = substr($newProfID, 0, 3).$separ.substr($newProfID, 3, 3).$separ.substr($newProfID, 6, 3);
    if ($id == 2 && dol_strlen($newProfID) == 14) $newProfID = substr($newProfID, 0, 3).$separ.substr($newProfID, 3, 3).$separ.substr($newProfID, 6, 3).$separ.substr($newProfID, 9, 5);
    if ($profIDtype === 'VAT' && dol_strlen($newProfID) == 13)  $newProfID = substr($newProfID, 0, 4).$separ.substr($newProfID, 4, 3).$separ.substr($newProfID, 7, 3).$separ.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 = '', $cid = 0, $socid = 0, $addlink = '', $separ = "&nbsp;", $withpicto = '', $titlealt = '', $adddivfloat = 0)
{
  global $conf, $user, $langs, $mysoc, $hookmanager;
 
  // Clean phone parameter
  $phone = is_null($phone) ? '' : preg_replace("/[\s.-]/", "", trim($phone));
  if (empty($phone)) {
    return '';
  }
  if (!empty($conf->global->MAIN_PHONE_SEPAR)) {
    $separ = $conf->global->MAIN_PHONE_SEPAR;
  }
  if (empty($countrycode) && is_object($mysoc)) {
    $countrycode = $mysoc->country_code;
  }
 
  // Short format for small screens
  if ($conf->dol_optimize_smallscreen) {
    $separ = '';
  }
 
  $newphone = $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") {//Allemagne
    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") {//Espagne
    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") {//Thaïlande
    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") {//Algérie
    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") {//Polynésie française
    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, 7, 2).$separ.substr($newphone, 9, 2);
    }
  } elseif (strtoupper($countrycode) == "JM") {//Jamaïque
    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) {// fixe 6 chiffres +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) {// fixe 7 chiffres +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) {// fixe 8 chiffres +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);
    }
  }
  if (!empty($addlink)) { // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
    if ($conf->browser->layout == 'phone' || (isModEnabled('clicktodial') && !empty($conf->global->CLICKTODIAL_USE_TEL_LINK_ON_PHONE_NUMBERS))) { // If phone or option for, we use link of phone
      $newphoneform = $newphone;
      $newphone = '<a href="tel:'.$phone.'"';
      $newphone .= '>'.$newphoneform.'</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 = 'ErrorClickToDialModuleNotConfigured';
      if (!empty($conf->global->CLICKTODIAL_URL)) {
        $urlmask = $conf->global->CLICKTODIAL_URL;
      }
      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
      $url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
      // Thoose lines are for substitution
      $substitarray = array('__PHONEFROM__'=>$clicktodial_poste,
                '__PHONETO__'=>urlencode($phone),
                '__LOGIN__'=>$clicktodial_login,
                '__PASS__'=>$clicktodial_password);
      $url = make_substitutions($url, $substitarray);
      $newphonesav = $newphone;
      if (empty($conf->global->CLICKTODIAL_DO_NOT_USE_AJAX_CALL)) {
        // Default and recommended: New method using ajax without submiting a page making a javascript history.go(-1) back
        $newphone = '<a href="'.$url.'" class="cssforclicktodial"'; // Call of ajax is handled by the lib_foot.js.php on class 'cssforclicktodial'
        $newphone .= '>'.$newphonesav.'</a>';
      } else {
        // Old method
        $newphone = '<a href="'.$url.'"';
        if (!empty($conf->global->CLICKTODIAL_FORCENEWTARGET)) {
          $newphone .= ' target="_blank" rel="noopener noreferrer"';
        }
        $newphone .= '>'.$newphonesav.'</a>';
      }
    }
 
    //if (($cid || $socid) && !empty($conf->agenda->enabled) && $user->rights->agenda->myactions->create)
    if (isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
      $type = 'AC_TEL';
      $link = '';
      if ($addlink == 'AC_FAX') {
        $type = 'AC_FAX';
      }
      if (!empty($conf->global->AGENDA_ADDACTIONFORPHONE)) {
        $link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&amp;backtopage=1&amp;actioncode='.$type.($cid ? '&amp;contactid='.$cid : '').($socid ? '&amp;socid='.$socid : '').'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
      }
      if ($link) {
        $newphone = '<div>'.$newphone.' '.$link.'</div>';
      }
    }
  }
 
  if (empty($titlealt)) {
    $titlealt = ($withpicto == 'fax' ? $langs->trans("Fax") : $langs->trans("Phone"));
  }
  $rep = '';
 
  if ($hookmanager) {
    $parameters = array('countrycode' => $countrycode, 'cid' => $cid, '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 = 'phoning';
      } elseif ($withpicto == 'mobile') {
        $picto = 'phoning_mobile';
      } else {
        $picto = '';
      }
    }
    if ($adddivfloat) {
      $rep .= '<div class="nospan float" style="margin-right: 10px">';
    } else {
      $rep .= '<span style="margin-right: 10px;">';
    }
    $rep .= ($withpicto ?img_picto($titlealt, 'object_'.$picto.'.png').' ' : '').$newphone;
    if ($adddivfloat) {
      $rep .= '</div>';
    } else {
      $rep .= '</span>';
    }
  }
 
  return $rep;
}
 
function dol_print_ip($ip, $mode = 0)
{
  global $conf, $langs;
 
  $ret = '';
 
  if (empty($mode)) {
    $ret .= $ip;
  }
 
  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 .= ' '.img_picto($countrycode.' '.$langs->trans("AccordingToGeoIPDatabase"), DOL_URL_ROOT.'/theme/common/flags/'.$countrycode.'.png', '', 1);
      } else {
        $ret .= ' ('.$countrycode.')';
      }
    } else {
      // Nothing
    }
  }
 
  return $ret;
}
 
function getUserRemoteIP()
{
  if (empty($_SERVER['HTTP_X_FORWARDED_FOR']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
    if (empty($_SERVER['HTTP_CLIENT_IP']) || preg_match('/[^0-9\.\:,\[\]]/', $_SERVER['HTTP_CLIENT_IP'])) {
      if (empty($_SERVER["HTTP_CF_CONNECTING_IP"])) {
        $ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']);  // value may have been 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 = $_SERVER['HTTP_CLIENT_IP']; // value is clean here but may have been forged by proxy
    }
  } else {
    $ip = $_SERVER['HTTP_X_FORWARDED_FOR']; // value is clean here but may have been forged by proxy
  }
  return $ip;
}
 
function isHTTPS()
{
  $isSecure = false;
  if (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') {
    $isSecure = true;
  } elseif (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_SERVER['HTTP_X_FORWARDED_SSL']) && $_SERVER['HTTP_X_FORWARDED_SSL'] == 'on') {
    $isSecure = true;
  }
  return $isSecure;
}
 
function dolGetCountryCodeFromIp($ip)
{
  global $conf;
 
  $countrycode = '';
 
  if (!empty($conf->geoipmaxmind->enabled)) {
    $datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
    //$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)
    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);
  }
 
  return $countrycode;
}
 
 
function dol_user_country()
{
  global $conf, $langs, $user;
 
  //$ret=$user->xxx;
  $ret = '';
  if (!empty($conf->geoipmaxmind->enabled)) {
    $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 $conf, $user, $langs, $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($address);
      } else {
        $out .= preg_replace('/[\r\n]+/', $charfornl, $address);
      }
 
      // TODO Remove this block, we can add this using the hook now
      $showgmap = $showomap = 0;
      if (($element == 'thirdparty' || $element == 'societe') && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS)) {
        $showgmap = 1;
      }
      if ($element == 'contact' && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS_CONTACTS)) {
        $showgmap = 1;
      }
      if ($element == 'member' && !empty($conf->google->enabled) && !empty($conf->global->GOOGLE_ENABLE_GMAPS_MEMBERS)) {
        $showgmap = 1;
      }
      if (($element == 'thirdparty' || $element == 'societe') && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS)) {
        $showomap = 1;
      }
      if ($element == 'contact' && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_CONTACTS)) {
        $showomap = 1;
      }
      if ($element == 'member' && !empty($conf->openstreetmap->enabled) && !empty($conf->global->OPENSTREETMAP_ENABLE_MAPS_MEMBERS)) {
        $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;
  }
}
 
 
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 && !empty($mxhosts[0])) {
        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, $stringencoding = '', $trunconbytes = 0)
{
  global $langs;
 
  if (empty($stringencoding)) {
    $stringencoding = $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) || !empty($conf->global->MAIN_DISABLE_TRUNC)) {
    return $string;
  }
 
  if (empty($stringencoding)) {
    $stringencoding = 'UTF-8';
  }
  // reduce for small screen
  if ($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 = round($size / 2);
      $size2 = 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 img_picto($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0, $alt = '', $morecss = '', $marginleftonlyshort = 2)
{
  global $conf, $langs;
 
  // We forge fullpathpicto for image to $path/img/$picto. By default, we take DOL_URL_ROOT/theme/$conf->theme/img/$picto
  $url = DOL_URL_ROOT;
  $theme = isset($conf->theme) ? $conf->theme : null;
  $path = 'theme/'.$theme;
  // Define fullpathpicto to use into src
  if ($pictoisfullpath) {
    // Clean parameters
    if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
      $picto .= '.png';
    }
    $fullpathpicto = $picto;
    $reg = array();
    if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
      $morecss .= ($morecss ? ' ' : '').$reg[1];
      $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
    }
  } else {
    $pictowithouttext = preg_replace('/(\.png|\.gif|\.svg)$/', '', $picto);
    $pictowithouttext = str_replace('object_', '', $pictowithouttext);
 
    if (strpos($pictowithouttext, 'fontawesome_') !== false || preg_match('/^fa-/', $pictowithouttext)) {
      // This is a font awesome image 'fonwtawesome_xxx' or 'fa-xxx'
      $pictowithouttext = str_replace('fontawesome_', '', $pictowithouttext);
      $pictowithouttext = str_replace('fa-', '', $pictowithouttext);
 
      $pictowithouttextarray = explode('_', $pictowithouttext);
      $marginleftonlyshort = 0;
 
      if (!empty($pictowithouttextarray[1])) {
        // Syntax is 'fontawesome_fakey_faprefix_facolor_fasize' or 'fa-fakey_faprefix_facolor_fasize'
        $fakey      = 'fa-'.$pictowithouttextarray[0];
        $fa         = empty($pictowithouttextarray[1]) ? 'fa' : $pictowithouttextarray[1];
        $facolor    = empty($pictowithouttextarray[2]) ? '' : $pictowithouttextarray[2];
        $fasize     = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
      } else {
        $fakey      = 'fa-'.$pictowithouttext;
        $fa         = 'fa';
        $facolor    = '';
        $fasize     = '';
      }
 
      // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
      // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
      $morestyle = '';
      $reg = array();
      if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
        $morecss .= ($morecss ? ' ' : '').$reg[1];
        $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
      }
      if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
        $morestyle = $reg[1];
        $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
      }
      $moreatt = trim($moreatt);
 
      $enabledisablehtml = '<span class="'.$fa.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
      $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
      /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
        $enabledisablehtml .= $titlealt;
      }*/
      $enabledisablehtml .= '</span>';
 
      return $enabledisablehtml;
    }
 
    if (empty($srconly) && in_array($pictowithouttext, array(
        '1downarrow', '1uparrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected',
        'accountancy', 'accounting_account', 'account', 'accountline', 'action', 'add', 'address', 'angle-double-down', 'angle-double-up', 'asset',
        'bank_account', 'barcode', 'bank', 'bell', 'bill', 'billa', 'billr', 'billd', 'bookmark', 'bom', 'briefcase-medical', 'bug', 'building',
        'card', 'calendarlist', 'calendar', 'calendarmonth', 'calendarweek', 'calendarday', 'calendarperuser', 'calendarpertype',
        'cash-register', 'category', 'chart', 'check', 'clock', 'close_title', 'cog', 'collab', 'company', 'contact', 'country', 'contract', 'conversation', 'cron', 'cubes',
        'currency', 'multicurrency',
        'delete', 'dolly', 'dollyrevert', 'donation', 'download', 'dynamicprice',
        'edit', 'ellipsis-h', 'email', 'entity', 'envelope', 'eraser', 'establishment', 'expensereport', 'external-link-alt', 'external-link-square-alt', 'eye',
        'filter', 'file-code', 'file-export', 'file-import', 'file-upload', 'autofill', 'folder', 'folder-open', 'folder-plus',
        'generate', 'globe', 'globe-americas', 'graph', 'grip', 'grip_title', 'group',
        'help', 'holiday',
        'images', 'incoterm', 'info', 'intervention', 'inventory', 'intracommreport', 'knowledgemanagement',
        'label', 'language', 'line', 'link', 'list', 'list-alt', 'listlight', 'loan', 'lock', 'lot', 'long-arrow-alt-right',
        'margin', 'map-marker-alt', 'member', 'meeting', 'money-bill-alt', 'movement', 'mrp', 'note', 'next',
        'off', 'on', 'order',
        'paiment', 'paragraph', 'play', 'pdf', 'phone', 'phoning', 'phoning_mobile', 'phoning_fax', 'playdisabled', 'previous', 'poll', 'pos', 'printer', 'product', 'propal', 'proposal', 'puce',
        'stock', 'resize', 'service', 'stats', 'trip',
        'security', 'setup', 'share-alt', 'sign-out', 'split', 'stripe', 'stripe-s', 'switch_off', 'switch_on', 'switch_on_red', 'tools', 'unlink', 'uparrow', 'user', 'user-tie', 'vcard', 'wrench',
        'github', 'google', 'jabber', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'youtube', 'google-plus-g', 'whatsapp',
        'chevron-left', 'chevron-right', 'chevron-down', 'chevron-top', 'commercial', 'companies',
        'generic', 'home', 'hrm', 'members', 'products', 'invoicing',
        'partnership', 'payment', 'payment_vat', 'pencil-ruler', 'preview', 'project', 'projectpub', 'projecttask', 'question', 'refresh', 'region',
        'salary', 'shipment', 'state', 'supplier_invoice', 'supplier_invoicea', 'supplier_invoicer', 'supplier_invoiced',
        'technic', 'ticket',
        'error', 'warning',
        'recent', 'reception', 'recruitmentcandidature', 'recruitmentjobposition', 'replacement', 'resource', 'recurring','rss',
        'shapes', 'square', 'stop-circle', 'supplier', 'supplier_proposal', 'supplier_order', 'supplier_invoice',
        'timespent', 'title_setup', 'title_accountancy', 'title_bank', 'title_hrm', 'title_agenda',
        'uncheck', 'url', 'user-cog', 'user-injured', 'user-md', 'vat', 'website', 'workstation', 'webhook', 'world', 'private',
        'conferenceorbooth', 'eventorganization',
        'stamp', 'signature'
      ))) {
      $fakey = $pictowithouttext;
      $facolor = '';
      $fasize = '';
      $fa = 'fas';
      if (in_array($pictowithouttext, array('card', 'bell', 'clock', 'establishment', 'generic', 'minus-square', 'object_generic', 'pdf', 'plus-square', 'timespent', 'note', 'off', 'on', 'object_bookmark', 'bookmark', 'vcard'))) {
        $fa = 'far';
      }
      if (in_array($pictowithouttext, array('black-tie', 'github', 'google', 'skype', 'twitter', 'facebook', 'linkedin', 'instagram', 'snapchat', 'stripe', 'stripe-s', 'youtube', 'google-plus-g', 'whatsapp'))) {
        $fa = 'fab';
      }
 
      $arrayconvpictotofa = array(
        'account'=>'university', 'accounting_account'=>'clipboard-list', 'accountline'=>'receipt', 'accountancy'=>'search-dollar', 'action'=>'calendar-alt', 'add'=>'plus-circle', 'address'=> 'address-book', 'asset'=>'money-check-alt', 'autofill'=>'fill',
        'bank_account'=>'university',
        'bill'=>'file-invoice-dollar', 'billa'=>'file-excel', 'billr'=>'file-invoice-dollar', 'billd'=>'file-medical',
        'supplier_invoice'=>'file-invoice-dollar', 'supplier_invoicea'=>'file-excel', 'supplier_invoicer'=>'file-invoice-dollar', 'supplier_invoiced'=>'file-medical',
        'bom'=>'shapes',
        'card'=>'address-card', 'chart'=>'chart-line', 'company'=>'building', 'contact'=>'address-book', 'contract'=>'suitcase', 'collab'=>'people-arrows', 'conversation'=>'comments', 'country'=>'globe-americas', 'cron'=>'business-time',
        'donation'=>'file-alt', 'dynamicprice'=>'hand-holding-usd',
        'setup'=>'cog', 'companies'=>'building', 'products'=>'cube', 'commercial'=>'suitcase', 'invoicing'=>'coins',
        'accounting'=>'search-dollar', 'category'=>'tag', 'dollyrevert'=>'dolly',
        'generate'=>'plus-square', 'hrm'=>'user-tie', 'incoterm'=>'truck-loading',
        'margin'=>'calculator', 'members'=>'user-friends', 'ticket'=>'ticket-alt', 'globe'=>'external-link-alt', 'lot'=>'barcode',
        'email'=>'at', 'establishment'=>'building', 'edit'=>'pencil-alt', 'entity'=>'globe',
        'graph'=>'chart-line', 'grip_title'=>'arrows-alt', 'grip'=>'arrows-alt', 'help'=>'question-circle',
        'generic'=>'file', 'holiday'=>'umbrella-beach',
        'info'=>'info-circle', 'inventory'=>'boxes', 'intracommreport'=>'globe-europe', 'knowledgemanagement'=>'ticket-alt', 'label'=>'layer-group', 'line'=>'bars', 'loan'=>'money-bill-alt',
        'member'=>'user-alt', 'meeting'=>'chalkboard-teacher', 'mrp'=>'cubes', 'next'=>'arrow-alt-circle-right',
        'trip'=>'wallet', 'expensereport'=>'wallet', 'group'=>'users', 'movement'=>'people-carry',
        'sign-out'=>'sign-out-alt',
        'switch_off'=>'toggle-off', 'switch_on'=>'toggle-on', 'switch_on_red'=>'toggle-on', 'check'=>'check', 'bookmark'=>'star',
        'bank'=>'university', 'close_title'=>'times', 'delete'=>'trash', 'filter'=>'filter',
        'list-alt'=>'list-alt', 'calendarlist'=>'bars', 'calendar'=>'calendar-alt', 'calendarmonth'=>'calendar-alt', 'calendarweek'=>'calendar-week', 'calendarday'=>'calendar-day', 'calendarperuser'=>'table',
        'intervention'=>'ambulance', 'invoice'=>'file-invoice-dollar', 'currency'=>'dollar-sign', 'multicurrency'=>'dollar-sign', 'order'=>'file-invoice',
        'error'=>'exclamation-triangle', 'warning'=>'exclamation-triangle',
        'other'=>'square',
        'playdisabled'=>'play', 'pdf'=>'file-pdf',  'poll'=>'check-double', 'pos'=>'cash-register', 'preview'=>'binoculars', 'project'=>'project-diagram', 'projectpub'=>'project-diagram', 'projecttask'=>'tasks', 'propal'=>'file-signature', 'proposal'=>'file-signature',
        'partnership'=>'handshake', 'payment'=>'money-check-alt', 'payment_vat'=>'money-check-alt', 'phoning'=>'phone', 'phoning_mobile'=>'mobile-alt', 'phoning_fax'=>'fax', 'previous'=>'arrow-alt-circle-left', 'printer'=>'print', 'product'=>'cube', 'puce'=>'angle-right',
        'recent' => 'question', 'reception'=>'dolly', 'recruitmentjobposition'=>'id-card-alt', 'recruitmentcandidature'=>'id-badge',
        'resize'=>'crop', 'supplier_order'=>'dol-order_supplier', 'supplier_proposal'=>'file-signature',
        'refresh'=>'redo', 'region'=>'map-marked', 'replacement'=>'exchange-alt', 'resource'=>'laptop-house', 'recurring'=>'history',
        'service'=>'concierge-bell',
        'state'=>'map-marked-alt', 'security'=>'key', 'salary'=>'wallet', 'shipment'=>'dolly', 'stock'=>'box-open', 'stats' => 'chart-bar', 'split'=>'code-branch', 'stripe'=>'stripe-s',
        'supplier'=>'building', 'technic'=>'cogs',
        'timespent'=>'clock', 'title_setup'=>'tools', 'title_accountancy'=>'money-check-alt', 'title_bank'=>'university', 'title_hrm'=>'umbrella-beach',
        'title_agenda'=>'calendar-alt',
        'uncheck'=>'times', 'uparrow'=>'share', 'url'=>'external-link-alt', 'vat'=>'money-check-alt', 'vcard'=>'address-card',
        'jabber'=>'comment-o',
        'website'=>'globe-americas', 'workstation'=>'pallet', 'webhook'=>'bullseye', 'world'=>'globe', 'private'=>'user-lock',
        'conferenceorbooth'=>'chalkboard-teacher', 'eventorganization'=>'project-diagram'
      );
      if ($pictowithouttext == 'off') {
        $fakey = 'fa-square';
        $fasize = '1.3em';
      } elseif ($pictowithouttext == 'on') {
        $fakey = 'fa-check-square';
        $fasize = '1.3em';
      } elseif ($pictowithouttext == 'listlight') {
        $fakey = 'fa-download';
        $marginleftonlyshort = 1;
      } elseif ($pictowithouttext == 'printer') {
        $fakey = 'fa-print';
        $fasize = '1.2em';
      } elseif ($pictowithouttext == 'note') {
        $fakey = 'fa-sticky-note';
        $marginleftonlyshort = 1;
      } elseif (in_array($pictowithouttext, array('1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'))) {
        $convertarray = array('1uparrow'=>'caret-up', '1downarrow'=>'caret-down', '1leftarrow'=>'caret-left', '1rightarrow'=>'caret-right', '1uparrow_selected'=>'caret-up', '1downarrow_selected'=>'caret-down', '1leftarrow_selected'=>'caret-left', '1rightarrow_selected'=>'caret-right');
        $fakey = 'fa-'.$convertarray[$pictowithouttext];
        if (preg_match('/selected/', $pictowithouttext)) {
          $facolor = '#888';
        }
        $marginleftonlyshort = 1;
      } elseif (!empty($arrayconvpictotofa[$pictowithouttext])) {
        $fakey = 'fa-'.$arrayconvpictotofa[$pictowithouttext];
      } else {
        $fakey = 'fa-'.$pictowithouttext;
      }
 
      if (in_array($pictowithouttext, array('dollyrevert', 'member', 'members', 'contract', 'group', 'resource', 'shipment'))) {
        $morecss .= ' em092';
      }
      if (in_array($pictowithouttext, array('conferenceorbooth', 'collab', 'eventorganization', 'holiday', 'info', 'project', 'workstation'))) {
        $morecss .= ' em088';
      }
      if (in_array($pictowithouttext, array('asset', 'intervention', 'payment', 'loan', 'partnership', 'stock', 'technic'))) {
        $morecss .= ' em080';
      }
 
      // Define $marginleftonlyshort
      $arrayconvpictotomarginleftonly = array(
        'bank', 'check', 'delete', 'generic', 'grip', 'grip_title', 'jabber',
        'grip_title', 'grip', 'listlight', 'note', 'on', 'off', 'playdisabled', 'printer', 'resize', 'sign-out', 'stats', 'switch_on', 'switch_on_red', 'switch_off',
        'uparrow', '1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'
      );
      if (!isset($arrayconvpictotomarginleftonly[$pictowithouttext])) {
        $marginleftonlyshort = 0;
      }
 
      // Add CSS
      $arrayconvpictotomorcess = array(
        'action'=>'infobox-action', 'account'=>'infobox-bank_account', 'accounting_account'=>'infobox-bank_account', 'accountline'=>'infobox-bank_account', 'accountancy'=>'infobox-bank_account', 'asset'=>'infobox-bank_account',
        'bank_account'=>'infobox-bank_account',
        'bill'=>'infobox-commande', 'billa'=>'infobox-commande', 'billr'=>'infobox-commande', 'billd'=>'infobox-commande',
        'margin'=>'infobox-bank_account', 'conferenceorbooth'=>'infobox-project',
        'cash-register'=>'infobox-bank_account', 'contract'=>'infobox-contrat', 'check'=>'font-status4', 'collab'=>'infobox-action', 'conversation'=>'infobox-contrat',
        'donation'=>'infobox-commande', 'dolly'=>'infobox-commande',  'dollyrevert'=>'flip infobox-order_supplier',
        'ecm'=>'infobox-action', 'eventorganization'=>'infobox-project',
        'hrm'=>'infobox-adherent', 'group'=>'infobox-adherent', 'intervention'=>'infobox-contrat',
        'incoterm'=>'infobox-supplier_proposal',
        'currency'=>'infobox-bank_account', 'multicurrency'=>'infobox-bank_account',
        'members'=>'infobox-adherent', 'member'=>'infobox-adherent', 'money-bill-alt'=>'infobox-bank_account',
        'order'=>'infobox-commande',
        'user'=>'infobox-adherent', 'users'=>'infobox-adherent',
        'error'=>'pictoerror', 'warning'=>'pictowarning', 'switch_on'=>'font-status4', 'switch_on_red'=>'font-status8',
        'holiday'=>'infobox-holiday', 'info'=>'opacityhigh', 'invoice'=>'infobox-commande',
        'knowledgemanagement'=>'infobox-contrat rotate90', 'loan'=>'infobox-bank_account',
        'payment'=>'infobox-bank_account', 'payment_vat'=>'infobox-bank_account', 'poll'=>'infobox-adherent', 'pos'=>'infobox-bank_account', 'project'=>'infobox-project', 'projecttask'=>'infobox-project',
        'propal'=>'infobox-propal', 'proposal'=>'infobox-propal','private'=>'infobox-project',
        'reception'=>'flip', 'recruitmentjobposition'=>'infobox-adherent', 'recruitmentcandidature'=>'infobox-adherent',
        'resource'=>'infobox-action',
        'salary'=>'infobox-bank_account', 'shipment'=>'infobox-commande', 'supplier_invoice'=>'infobox-order_supplier', 'supplier_invoicea'=>'infobox-order_supplier', 'supplier_invoiced'=>'infobox-order_supplier',
        'supplier'=>'infobox-order_supplier', 'supplier_order'=>'infobox-order_supplier', 'supplier_proposal'=>'infobox-supplier_proposal',
        'ticket'=>'infobox-contrat', 'title_accountancy'=>'infobox-bank_account', 'title_hrm'=>'infobox-holiday', 'expensereport'=>'infobox-expensereport', 'trip'=>'infobox-expensereport', 'title_agenda'=>'infobox-action',
        'vat'=>'infobox-bank_account',
        //'title_setup'=>'infobox-action', 'tools'=>'infobox-action',
        'list-alt'=>'imgforviewmode', 'calendar'=>'imgforviewmode', 'calendarweek'=>'imgforviewmode', 'calendarmonth'=>'imgforviewmode', 'calendarday'=>'imgforviewmode', 'calendarperuser'=>'imgforviewmode'
      );
      if (!empty($arrayconvpictotomorcess[$pictowithouttext])) {
        $morecss .= ($morecss ? ' ' : '').$arrayconvpictotomorcess[$pictowithouttext];
      }
 
      // Define $color
      $arrayconvpictotocolor = array(
        'address'=>'#6c6aa8', 'building'=>'#6c6aa8', 'bom'=>'#a69944',
        'cog'=>'#999', 'companies'=>'#6c6aa8', 'company'=>'#6c6aa8', 'contact'=>'#6c6aa8', 'cron'=>'#555',
        'dynamicprice'=>'#a69944',
        'edit'=>'#444', 'note'=>'#999', 'error'=>'', 'help'=>'#bbb', 'listlight'=>'#999', 'language'=>'#555',
        //'dolly'=>'#a69944', 'dollyrevert'=>'#a69944',
        'lock'=>'#ddd', 'lot'=>'#a69944',
        'map-marker-alt'=>'#aaa', 'mrp'=>'#a69944', 'product'=>'#a69944', 'service'=>'#a69944', 'inventory'=>'#a69944', 'stock'=>'#a69944', 'movement'=>'#a69944',
        'other'=>'#ddd', 'world'=>'#986c6a',
        'partnership'=>'#6c6aa8', 'playdisabled'=>'#ccc', 'printer'=>'#444', 'projectpub'=>'#986c6a', 'reception'=>'#a69944', 'resize'=>'#444', 'rss'=>'#cba',
        //'shipment'=>'#a69944',
        'security'=>'#999', 'square'=>'#888', 'stop-circle'=>'#888', 'stats'=>'#444', 'switch_off'=>'#999', 'technic'=>'#999', 'timespent'=>'#555',
        'uncheck'=>'#800', 'uparrow'=>'#555', 'user-cog'=>'#999', 'country'=>'#aaa', 'globe-americas'=>'#aaa', 'region'=>'#aaa', 'state'=>'#aaa',
        'website'=>'#304', 'workstation'=>'#a69944'
      );
      if (isset($arrayconvpictotocolor[$pictowithouttext])) {
        $facolor = $arrayconvpictotocolor[$pictowithouttext];
      }
 
      // This snippet only needed since function img_edit accepts only one additional parameter: no separate one for css only.
      // class/style need to be extracted to avoid duplicate class/style validation errors when $moreatt is added to the end of the attributes.
      $morestyle = '';
      $reg = array();
      if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
        $morecss .= ($morecss ? ' ' : '').$reg[1];
        $moreatt = str_replace('class="'.$reg[1].'"', '', $moreatt);
      }
      if (preg_match('/style="([^"]+)"/', $moreatt, $reg)) {
        $morestyle = $reg[1];
        $moreatt = str_replace('style="'.$reg[1].'"', '', $moreatt);
      }
      $moreatt = trim($moreatt);
 
      $enabledisablehtml = '<span class="'.$fa.' '.$fakey.($marginleftonlyshort ? ($marginleftonlyshort == 1 ? ' marginleftonlyshort' : ' marginleftonly') : '');
      $enabledisablehtml .= ($morecss ? ' '.$morecss : '').'" style="'.($fasize ? ('font-size: '.$fasize.';') : '').($facolor ? (' color: '.$facolor.';') : '').($morestyle ? ' '.$morestyle : '').'"'.(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt : '').'>';
      /*if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
        $enabledisablehtml .= $titlealt;
      }*/
      $enabledisablehtml .= '</span>';
 
      return $enabledisablehtml;
    }
 
    if (!empty($conf->global->MAIN_OVERWRITE_THEME_PATH)) {
      $path = $conf->global->MAIN_OVERWRITE_THEME_PATH.'/theme/'.$theme; // If the theme does not have the same name as the module
    } elseif (!empty($conf->global->MAIN_OVERWRITE_THEME_RES)) {
      $path = $conf->global->MAIN_OVERWRITE_THEME_RES.'/theme/'.$conf->global->MAIN_OVERWRITE_THEME_RES; // To allow an external module to overwrite image resources whatever is activated theme
    } elseif (!empty($conf->modules_parts['theme']) && array_key_exists($theme, $conf->modules_parts['theme'])) {
      $path = $theme.'/theme/'.$theme; // If the theme have the same name as the module
    }
 
    // If we ask an image into $url/$mymodule/img (instead of default path)
    $regs = array();
    if (preg_match('/^([^@]+)@([^@]+)$/i', $picto, $regs)) {
      $picto = $regs[1];
      $path = $regs[2]; // $path is $mymodule
    }
 
    // Clean parameters
    if (!preg_match('/(\.png|\.gif|\.svg)$/i', $picto)) {
      $picto .= '.png';
    }
    // If alt path are defined, define url where img file is, according to physical path
    // ex: array(["main"]=>"/home/maindir/htdocs", ["alt0"]=>"/home/moddir0/htdocs", ...)
    foreach ($conf->file->dol_document_root as $type => $dirroot) {
      if ($type == 'main') {
        continue;
      }
      // This need a lot of time, that's why enabling alternative dir like "custom" dir is not recommanded
      if (file_exists($dirroot.'/'.$path.'/img/'.$picto)) {
        $url = DOL_URL_ROOT.$conf->file->dol_url_root[$type];
        break;
      }
    }
 
    // $url is '' or '/custom', $path is current theme or
    $fullpathpicto = $url.'/'.$path.'/img/'.$picto;
  }
 
  if ($srconly) {
    return $fullpathpicto;
  }
    // tag title is used for tooltip on <a>, tag alt can be used with very simple text on image for blind people
  return '<img src="'.$fullpathpicto.'"'.($notitle ? '' : ' alt="'.dol_escape_htmltag($alt).'"').(($notitle || empty($titlealt)) ? '' : ' title="'.dol_escape_htmltag($titlealt).'"').($moreatt ? ' '.$moreatt.($morecss ? ' class="'.$morecss.'"' : '') : ' class="inline-block'.($morecss ? ' '.$morecss : '').'"').'>'; // Alt is used for accessibility, title for popup
}
 
function img_object($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $srconly = 0, $notitle = 0)
{
  if (strpos($picto, '^') === 0) {
    return img_picto($titlealt, str_replace('^', '', $picto), $moreatt, $pictoisfullpath, $srconly, $notitle);
  } else {
    return img_picto($titlealt, 'object_'.$picto, $moreatt, $pictoisfullpath, $srconly, $notitle);
  }
}
 
function img_weather($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $morecss = '')
{
  global $conf;
 
  if (is_numeric($picto)) {
    //$leveltopicto = array(0=>'weather-clear.png', 1=>'weather-few-clouds.png', 2=>'weather-clouds.png', 3=>'weather-many-clouds.png', 4=>'weather-storm.png');
    //$picto = $leveltopicto[$picto];
    return '<i class="fa fa-weather-level'.$picto.'"></i>';
  } elseif (!preg_match('/(\.png|\.gif)$/i', $picto)) {
    $picto .= '.png';
  }
 
  $path = DOL_URL_ROOT.'/theme/'.$conf->theme.'/img/weather/'.$picto;
 
  return img_picto($titlealt, $path, $moreatt, 1, 0, 0, '', $morecss);
}
 
function img_picto_common($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $notitle = 0)
{
  global $conf;
 
  if (!preg_match('/(\.png|\.gif)$/i', $picto)) {
    $picto .= '.png';
  }
 
  if ($pictoisfullpath) {
    $path = $picto;
  } else {
    $path = DOL_URL_ROOT.'/theme/common/'.$picto;
 
    if (!empty($conf->global->MAIN_MODULE_CAN_OVERWRITE_COMMONICONS)) {
      $themepath = DOL_DOCUMENT_ROOT.'/theme/'.$conf->theme.'/img/'.$picto;
 
      if (file_exists($themepath)) {
        $path = $themepath;
      }
    }
  }
 
  return img_picto($titlealt, $path, $moreatt, 1, 0, $notitle);
}
 
function img_action($titlealt, $numaction, $picto = '')
{
  global $langs;
 
  if (empty($titlealt) || $titlealt == 'default') {
    if ($numaction == '-1' || $numaction == 'ST_NO') {
      $numaction = -1;
      $titlealt = $langs->transnoentitiesnoconv('ChangeDoNotContact');
    } elseif ($numaction == '0' || $numaction == 'ST_NEVER') {
      $numaction = 0;
      $titlealt = $langs->transnoentitiesnoconv('ChangeNeverContacted');
    } elseif ($numaction == '1' || $numaction == 'ST_TODO') {
      $numaction = 1;
      $titlealt = $langs->transnoentitiesnoconv('ChangeToContact');
    } elseif ($numaction == '2' || $numaction == 'ST_PEND') {
      $numaction = 2;
      $titlealt = $langs->transnoentitiesnoconv('ChangeContactInProcess');
    } elseif ($numaction == '3' || $numaction == 'ST_DONE') {
      $numaction = 3;
      $titlealt = $langs->transnoentitiesnoconv('ChangeContactDone');
    } else {
      $titlealt = $langs->transnoentitiesnoconv('ChangeStatus '.$numaction);
      $numaction = 0;
    }
  }
  if (!is_numeric($numaction)) {
    $numaction = 0;
  }
 
  return img_picto($titlealt, !empty($picto) ? $picto : 'stcomm'.$numaction.'.png');
}
 
function img_pdf($titlealt = 'default', $size = 3)
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Show');
  }
 
  return img_picto($titlealt, 'pdf'.$size.'.png');
}
 
function img_edit_add($titlealt = 'default', $other = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Add');
  }
 
  return img_picto($titlealt, 'edit_add.png', $other);
}
function img_edit_remove($titlealt = 'default', $other = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Remove');
  }
 
  return img_picto($titlealt, 'edit_remove.png', $other);
}
 
function img_edit($titlealt = 'default', $float = 0, $other = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Modify');
  }
 
  return img_picto($titlealt, 'edit.png', ($float ? 'style="float: '.($langs->tab_translate["DIRECTION"] == 'rtl' ? 'left' : 'right').'"' : "").($other ? ' '.$other : ''));
}
 
function img_view($titlealt = 'default', $float = 0, $other = 'class="valignmiddle"')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('View');
  }
 
  $moreatt = ($float ? 'style="float: right" ' : '').$other;
 
  return img_picto($titlealt, 'eye', $moreatt);
}
 
function img_delete($titlealt = 'default', $other = 'class="pictodelete"', $morecss = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Delete');
  }
 
  return img_picto($titlealt, 'delete.png', $other, false, 0, 0, '', $morecss);
}
 
function img_printer($titlealt = "default", $other = '')
{
  global $langs;
  if ($titlealt == "default") {
    $titlealt = $langs->trans("Print");
  }
  return img_picto($titlealt, 'printer.png', $other);
}
 
function img_split($titlealt = 'default', $other = 'class="pictosplit"')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Split');
  }
 
  return img_picto($titlealt, 'split.png', $other);
}
 
function img_help($usehelpcursor = 1, $usealttitle = 1)
{
  global $langs;
 
  if ($usealttitle) {
    if (is_string($usealttitle)) {
      $usealttitle = dol_escape_htmltag($usealttitle);
    } else {
      $usealttitle = $langs->trans('Info');
    }
  }
 
  return img_picto($usealttitle, 'info.png', 'style="vertical-align: middle;'.($usehelpcursor == 1 ? ' cursor: help' : ($usehelpcursor == 2 ? ' cursor: pointer' : '')).'"');
}
 
function img_info($titlealt = 'default')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Informations');
  }
 
  return img_picto($titlealt, 'info.png', 'style="vertical-align: middle;"');
}
 
function img_warning($titlealt = 'default', $moreatt = '', $morecss = 'pictowarning')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Warning');
  }
 
  //return '<div class="imglatecoin">'.img_picto($titlealt, 'warning_white.png', 'class="pictowarning valignmiddle"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt): '')).'</div>';
  return img_picto($titlealt, 'warning.png', 'class="'.$morecss.'"'.($moreatt ? ($moreatt == '1' ? ' style="float: right"' : ' '.$moreatt) : ''));
}
 
function img_error($titlealt = 'default')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Error');
  }
 
  return img_picto($titlealt, 'error.png');
}
 
function img_next($titlealt = 'default', $moreatt = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Next');
  }
 
  //return img_picto($titlealt, 'next.png', $moreatt);
  return '<span class="fa fa-chevron-right paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
}
 
function img_previous($titlealt = 'default', $moreatt = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Previous');
  }
 
  //return img_picto($titlealt, 'previous.png', $moreatt);
  return '<span class="fa fa-chevron-left paddingright paddingleft" title="'.dol_escape_htmltag($titlealt).'"></span>';
}
 
function img_down($titlealt = 'default', $selected = 0, $moreclass = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Down');
  }
 
  return img_picto($titlealt, ($selected ? '1downarrow_selected.png' : '1downarrow.png'), 'class="imgdown'.($moreclass ? " ".$moreclass : "").'"');
}
 
function img_up($titlealt = 'default', $selected = 0, $moreclass = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Up');
  }
 
  return img_picto($titlealt, ($selected ? '1uparrow_selected.png' : '1uparrow.png'), 'class="imgup'.($moreclass ? " ".$moreclass : "").'"');
}
 
function img_left($titlealt = 'default', $selected = 0, $moreatt = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Left');
  }
 
  return img_picto($titlealt, ($selected ? '1leftarrow_selected.png' : '1leftarrow.png'), $moreatt);
}
 
function img_right($titlealt = 'default', $selected = 0, $moreatt = '')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Right');
  }
 
  return img_picto($titlealt, ($selected ? '1rightarrow_selected.png' : '1rightarrow.png'), $moreatt);
}
 
function img_allow($allow, $titlealt = 'default')
{
  global $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Active');
  }
 
  if ($allow == 1) {
    return img_picto($titlealt, 'tick.png');
  }
 
  return '-';
}
 
function img_credit_card($brand, $morecss = null)
{
  if (is_null($morecss)) {
    $morecss = 'fa-2x';
  }
 
  if ($brand == 'visa' || $brand == 'Visa') {
    $brand = 'cc-visa';
  } elseif ($brand == 'mastercard' || $brand == 'MasterCard') {
    $brand = 'cc-mastercard';
  } elseif ($brand == 'amex' || $brand == 'American Express') {
    $brand = 'cc-amex';
  } elseif ($brand == 'discover' || $brand == 'Discover') {
    $brand = 'cc-discover';
  } elseif ($brand == 'jcb' || $brand == 'JCB') {
    $brand = 'cc-jcb';
  } elseif ($brand == 'diners' || $brand == 'Diners club') {
    $brand = 'cc-diners-club';
  } elseif (!in_array($brand, array('cc-visa', 'cc-mastercard', 'cc-amex', 'cc-discover', 'cc-jcb', 'cc-diners-club'))) {
    $brand = 'credit-card';
  }
 
  return '<span class="fa fa-'.$brand.' fa-fw'.($morecss ? ' '.$morecss : '').'"></span>';
}
 
function img_mime($file, $titlealt = '', $morecss = '')
{
  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
 
  $mimetype = dol_mimetype($file, '', 1);
  $mimeimg = dol_mimetype($file, '', 2);
  $mimefa = dol_mimetype($file, '', 4);
 
  if (empty($titlealt)) {
    $titlealt = 'Mime type: '.$mimetype;
  }
 
  //return img_picto_common($titlealt, 'mime/'.$mimeimg, 'class="'.$morecss.'"');
  return '<i class="fa fa-'.$mimefa.' paddingright'.($morecss ? ' '.$morecss : '').'"'.($titlealt ? ' title="'.$titlealt.'"' : '').'></i>';
}
 
 
function img_search($titlealt = 'default', $other = '')
{
  global $conf, $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Search');
  }
 
  $img = img_picto($titlealt, 'search.png', $other, false, 1);
 
  $input = '<input type="image" class="liste_titre" name="button_search" src="'.$img.'" ';
  $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
 
  return $input;
}
 
function img_searchclear($titlealt = 'default', $other = '')
{
  global $conf, $langs;
 
  if ($titlealt == 'default') {
    $titlealt = $langs->trans('Search');
  }
 
  $img = img_picto($titlealt, 'searchclear.png', $other, false, 1);
 
  $input = '<input type="image" class="liste_titre" name="button_removefilter" src="'.$img.'" ';
  $input .= 'value="'.dol_escape_htmltag($titlealt).'" title="'.dol_escape_htmltag($titlealt).'" >';
 
  return $input;
}
 
function info_admin($text, $infoonimgalt = 0, $nodiv = 0, $admin = '1', $morecss = 'hideonsmartphone', $textfordropdown = '')
{
  global $conf, $langs;
 
  if ($infoonimgalt) {
    $result = img_picto($text, 'info', 'class="'.($morecss ? ' '.$morecss : '').'"');
  } else {
    if (empty($conf->use_javascript_ajax)) {
      $textfordropdown = '';
    }
 
    $class = (empty($admin) ? 'undefined' : ($admin == '1' ? 'info' : $admin));
    $result = ($nodiv ? '' : '<div class="'.$class.($morecss ? ' '.$morecss : '').($textfordropdown ? ' hidden' : '').'">').'<span class="fa fa-info-circle" title="'.dol_escape_htmltag($admin ? $langs->trans('InfoAdmin') : $langs->trans('Note')).'"></span> '.$text.($nodiv ? '' : '</div>');
 
    if ($textfordropdown) {
      $tmpresult = '<span class="'.$class.'text opacitymedium cursorpointer">'.$langs->trans($textfordropdown).' '.img_picto($langs->trans($textfordropdown), '1downarrow').'</span>';
      $tmpresult .= '<script type="text/javascript">
        jQuery(document).ready(function() {
          jQuery(".'.$class.'text").click(function() {
            console.log("toggle text");
            jQuery(".'.$class.'").toggle();
          });
        });
        </script>';
 
      $result = $tmpresult.$result;
    }
  }
 
  return $result;
}
 
 
function dol_print_error($db = '', $error = '', $errors = null)
{
  global $conf, $langs, $argv;
  global $dolibarr_main_prod;
 
  $out = '';
  $syslog = '';
 
  // If error occurs before the $lang object was loaded
  if (!$langs) {
    require_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
    $langs = new Translate('', $conf);
    $langs->load("main");
  }
 
  // Load translation files required by the error messages
  $langs->loadLangs(array('main', 'errors'));
 
  if ($_SERVER['DOCUMENT_ROOT']) {    // Mode web
    $out .= $langs->trans("DolibarrHasDetectedError").".<br>\n";
    if (getDolGlobalInt('MAIN_FEATURES_LEVEL') > 0) {
      $out .= "You use an experimental or develop level of features, so please do NOT report any bugs or vulnerability, except if problem is confirmed after moving option MAIN_FEATURES_LEVEL back to 0.<br>\n";
    }
    $out .= $langs->trans("InformationToHelpDiagnose").":<br>\n";
 
    $out .= "<b>".$langs->trans("Date").":</b> ".dol_print_date(time(), 'dayhourlog')."<br>\n";
    $out .= "<b>".$langs->trans("Dolibarr").":</b> ".DOL_VERSION." - https://www.dolibarr.org<br>\n";
    if (isset($conf->global->MAIN_FEATURES_LEVEL)) {
      $out .= "<b>".$langs->trans("LevelOfFeature").":</b> ".getDolGlobalInt('MAIN_FEATURES_LEVEL')."<br>\n";
    }
    if (function_exists("phpversion")) {
      $out .= "<b>".$langs->trans("PHP").":</b> ".phpversion()."<br>\n";
    }
    $out .= "<b>".$langs->trans("Server").":</b> ".(isset($_SERVER["SERVER_SOFTWARE"]) ? dol_htmlentities($_SERVER["SERVER_SOFTWARE"], ENT_COMPAT) : '')."<br>\n";
    if (function_exists("php_uname")) {
      $out .= "<b>".$langs->trans("OS").":</b> ".php_uname()."<br>\n";
    }
    $out .= "<b>".$langs->trans("UserAgent").":</b> ".(isset($_SERVER["HTTP_USER_AGENT"]) ? dol_htmlentities($_SERVER["HTTP_USER_AGENT"], ENT_COMPAT) : '')."<br>\n";
    $out .= "<br>\n";
    $out .= "<b>".$langs->trans("RequestedUrl").":</b> ".dol_htmlentities($_SERVER["REQUEST_URI"], ENT_COMPAT)."<br>\n";
    $out .= "<b>".$langs->trans("Referer").":</b> ".(isset($_SERVER["HTTP_REFERER"]) ? dol_htmlentities($_SERVER["HTTP_REFERER"], ENT_COMPAT) : '')."<br>\n";
    $out .= "<b>".$langs->trans("MenuManager").":</b> ".(isset($conf->standard_menu) ? dol_htmlentities($conf->standard_menu, ENT_COMPAT) : '')."<br>\n";
    $out .= "<br>\n";
    $syslog .= "url=".dol_escape_htmltag($_SERVER["REQUEST_URI"]);
    $syslog .= ", query_string=".dol_escape_htmltag($_SERVER["QUERY_STRING"]);
  } else // Mode CLI
  {
    $out .= '> '.$langs->transnoentities("ErrorInternalErrorDetected").":\n".$argv[0]."\n";
    $syslog .= "pid=".dol_getmypid();
  }
 
  if (!empty($conf->modules)) {
    $out .= "<b>".$langs->trans("Modules").":</b> ".join(', ', $conf->modules)."<br>\n";
  }
 
  if (is_object($db)) {
    if ($_SERVER['DOCUMENT_ROOT']) {  // Mode web
      $out .= "<b>".$langs->trans("DatabaseTypeManager").":</b> ".$db->type."<br>\n";
      $out .= "<b>".$langs->trans("RequestLastAccessInError").":</b> ".($db->lastqueryerror() ? dol_escape_htmltag($db->lastqueryerror()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
      $out .= "<b>".$langs->trans("ReturnCodeLastAccessInError").":</b> ".($db->lasterrno() ? dol_escape_htmltag($db->lasterrno()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
      $out .= "<b>".$langs->trans("InformationLastAccessInError").":</b> ".($db->lasterror() ? dol_escape_htmltag($db->lasterror()) : $langs->trans("ErrorNoRequestInError"))."<br>\n";
      $out .= "<br>\n";
    } else // Mode CLI
    {
      // No dol_escape_htmltag for output, we are in CLI mode
      $out .= '> '.$langs->transnoentities("DatabaseTypeManager").":\n".$db->type."\n";
      $out .= '> '.$langs->transnoentities("RequestLastAccessInError").":\n".($db->lastqueryerror() ? $db->lastqueryerror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
      $out .= '> '.$langs->transnoentities("ReturnCodeLastAccessInError").":\n".($db->lasterrno() ? $db->lasterrno() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
      $out .= '> '.$langs->transnoentities("InformationLastAccessInError").":\n".($db->lasterror() ? $db->lasterror() : $langs->transnoentities("ErrorNoRequestInError"))."\n";
    }
    $syslog .= ", sql=".$db->lastquery();
    $syslog .= ", db_error=".$db->lasterror();
  }
 
  if ($error || $errors) {
    $langs->load("errors");
 
    // Merge all into $errors array
    if (is_array($error) && is_array($errors)) {
      $errors = array_merge($error, $errors);
    } elseif (is_array($error)) {
      $errors = $error;
    } elseif (is_array($errors)) {
      $errors = array_merge(array($error), $errors);
    } else {
      $errors = array_merge(array($error), array($errors));
    }
 
    foreach ($errors as $msg) {
      if (empty($msg)) {
        continue;
      }
      if ($_SERVER['DOCUMENT_ROOT']) {  // Mode web
        $out .= "<b>".$langs->trans("Message").":</b> ".dol_escape_htmltag($msg)."<br>\n";
      } else // Mode CLI
      {
        $out .= '> '.$langs->transnoentities("Message").":\n".$msg."\n";
      }
      $syslog .= ", msg=".$msg;
    }
  }
  if (empty($dolibarr_main_prod) && $_SERVER['DOCUMENT_ROOT'] && function_exists('xdebug_print_function_stack') && function_exists('xdebug_call_file')) {
    xdebug_print_function_stack();
    $out .= '<b>XDebug informations:</b>'."<br>\n";
    $out .= 'File: '.xdebug_call_file()."<br>\n";
    $out .= 'Line: '.xdebug_call_line()."<br>\n";
    $out .= 'Function: '.xdebug_call_function()."<br>\n";
    $out .= "<br>\n";
  }
 
  // Return a http header with error code if possible
  if (!headers_sent()) {
    if (function_exists('top_httphead')) {  // In CLI context, the method does not exists
      top_httphead();
    }
    http_response_code(500);
  }
 
  if (empty($dolibarr_main_prod)) {
    print $out;
  } else {
    if (empty($langs->defaultlang)) {
      $langs->setDefaultLang();
    }
    $langs->loadLangs(array("main", "errors")); // Reload main because language may have been set only on previous line so we have to reload files we need.
    // This should not happen, except if there is a bug somewhere. Enabled and check log in such case.
    print 'This website or feature is currently temporarly not available or failed after a technical error.<br><br>This may be due to a maintenance operation. Current status of operation ('.dol_print_date(dol_now(), 'dayhourrfc').') are on next line...<br><br>'."\n";
    print $langs->trans("DolibarrHasDetectedError").'. ';
    print $langs->trans("YouCanSetOptionDolibarrMainProdToZero");
    define("MAIN_CORE_ERROR", 1);
  }
 
  dol_syslog("Error ".$syslog, LOG_ERR);
}
 
function dol_print_error_email($prefixcode, $errormessage = '', $errormessages = array(), $morecss = 'error', $email = '')
{
  global $langs, $conf;
 
  if (empty($email)) {
    $email = $conf->global->MAIN_INFO_SOCIETE_MAIL;
  }
 
  $langs->load("errors");
  $now = dol_now();
 
  print '<br><div class="center login_main_message"><div class="'.$morecss.'">';
  print $langs->trans("ErrorContactEMail", $email, $prefixcode.dol_print_date($now, '%Y%m%d%H%M%S'));
  if ($errormessage) {
    print '<br><br>'.$errormessage;
  }
  if (is_array($errormessages) && count($errormessages)) {
    foreach ($errormessages as $mesgtoshow) {
      print '<br><br>'.$mesgtoshow;
    }
  }
  print '</div></div>';
}
 
function print_liste_field_titre($name, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $tooltip = "", $forcenowrapcolumntitle = 0)
{
  print getTitleFieldOfList($name, 0, $file, $field, $begin, $moreparam, $moreattrib, $sortfield, $sortorder, $prefix, 0, $tooltip, $forcenowrapcolumntitle);
}
 
function getTitleFieldOfList($name, $thead = 0, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $disablesortlink = 0, $tooltip = '', $forcenowrapcolumntitle = 0)
{
  global $conf, $langs, $form;
  //print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
 
  if ($moreattrib == 'class="right"') {
    $prefix .= 'right '; // For backward compatibility
  }
 
  $sortorder = strtoupper($sortorder);
  $out = '';
  $sortimg = '';
 
  $tag = 'th';
  if ($thead == 2) {
    $tag = 'div';
  }
 
  $tmpsortfield = explode(',', $sortfield);
  $sortfield1 = trim($tmpsortfield[0]); // If $sortfield is 'd.datep,d.id', it becomes 'd.datep'
  $tmpfield = explode(',', $field);
  $field1 = trim($tmpfield[0]); // If $field is 'd.datep,d.id', it becomes 'd.datep'
 
  if (empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && empty($forcenowrapcolumntitle)) {
    $prefix = 'wrapcolumntitle '.$prefix;
  }
 
  //var_dump('field='.$field.' field1='.$field1.' sortfield='.$sortfield.' sortfield1='.$sortfield1);
  // If field is used as sort criteria we use a specific css class liste_titre_sel
  // Example if (sortfield,field)=("nom","xxx.nom") or (sortfield,field)=("nom","nom")
  $liste_titre = 'liste_titre';
  if ($field1 && ($sortfield1 == $field1 || $sortfield1 == preg_replace("/^[^\.]+\./", "", $field1))) {
    $liste_titre = 'liste_titre_sel';
  }
 
  $tagstart = '<'.$tag.' class="'.$prefix.$liste_titre.'" '.$moreattrib;
  //$out .= (($field && empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && preg_match('/^[a-zA-Z_0-9\s\.\-:&;]*$/', $name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
  $tagstart .= ($name && empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) && empty($forcenowrapcolumntitle) && !dol_textishtml($name)) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '';
  $tagstart .= '>';
 
  if (empty($thead) && $field && empty($disablesortlink)) {    // If this is a sort field
    $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
    $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
    $options = preg_replace('/&+/i', '&', $options);
    if (!preg_match('/^&/', $options)) {
      $options = '&'.$options;
    }
 
    $sortordertouseinlink = '';
    if ($field1 != $sortfield1) { // We are on another field than current sorted field
      if (preg_match('/^DESC/i', $sortorder)) {
        $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
      } else { // We reverse the var $sortordertouseinlink
        $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
      }
    } else { // We are on field that is the first current sorting criteria
      if (preg_match('/^ASC/i', $sortorder)) {  // We reverse the var $sortordertouseinlink
        $sortordertouseinlink .= str_repeat('desc,', count(explode(',', $field)));
      } else {
        $sortordertouseinlink .= str_repeat('asc,', count(explode(',', $field)));
      }
    }
    $sortordertouseinlink = preg_replace('/,$/', '', $sortordertouseinlink);
    $out .= '<a class="reposition" href="'.$file.'?sortfield='.$field.'&sortorder='.$sortordertouseinlink.'&begin='.$begin.$options.'"';
    //$out .= (empty($conf->global->MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE) ? ' title="'.dol_escape_htmltag($langs->trans($name)).'"' : '');
    $out .= '>';
  }
  if ($tooltip) {
    // You can also use 'TranslationString:keyfortooltiponclick' for a tooltip on click.
    if (preg_match('/:\w+$/', $tooltip)) {
      $tmptooltip = explode(':', $tooltip);
    } else {
      $tmptooltip = array($tooltip);
    }
    $out .= $form->textwithpicto($langs->trans($name), $langs->trans($tmptooltip[0]), 1, 'help', '', 0, 3, (empty($tmptooltip[1]) ? '' : 'extra_'.str_replace('.', '_', $field).'_'.$tmptooltip[1]));
  } else {
    $out .= $langs->trans($name);
  }
 
  if (empty($thead) && $field && empty($disablesortlink)) {    // If this is a sort field
    $out .= '</a>';
  }
 
  if (empty($thead) && $field) {    // If this is a sort field
    $options = preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i', '', (is_scalar($moreparam) ? $moreparam : ''));
    $options = preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i', '', $options);
    $options = preg_replace('/&+/i', '&', $options);
    if (!preg_match('/^&/', $options)) {
      $options = '&'.$options;
    }
 
    if (!$sortorder || $field1 != $sortfield1) {
      //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
      //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
    } else {
      if (preg_match('/^DESC/', $sortorder)) {
        //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
        //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
        $sortimg .= '<span class="nowrap">'.img_up("Z-A", 0, 'paddingright').'</span>';
      }
      if (preg_match('/^ASC/', $sortorder)) {
        //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
        //$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
        $sortimg .= '<span class="nowrap">'.img_down("A-Z", 0, 'paddingright').'</span>';
      }
    }
  }
 
  $tagend = '</'.$tag.'>';
 
  $out = $tagstart.$sortimg.$out.$tagend;
 
  return $out;
}
 
function print_titre($title)
{
  dol_syslog(__FUNCTION__." is deprecated", LOG_WARNING);
 
  print '<div class="titre">'.$title.'</div>';
}
 
function print_fiche_titre($title, $mesg = '', $picto = 'generic', $pictoisfullpath = 0, $id = '')
{
  print load_fiche_titre($title, $mesg, $picto, $pictoisfullpath, $id);
}
 
function load_fiche_titre($titre, $morehtmlright = '', $picto = 'generic', $pictoisfullpath = 0, $id = '', $morecssontable = '', $morehtmlcenter = '')
{
  global $conf;
 
  $return = '';
 
  if ($picto == 'setup') {
    $picto = 'generic';
  }
 
  $return .= "\n";
  $return .= '<table '.($id ? 'id="'.$id.'" ' : '').'class="centpercent notopnoleftnoright table-fiche-title'.($morecssontable ? ' '.$morecssontable : '').'">'; // maring bottom must be same than into print_barre_list
  $return .= '<tr class="titre">';
  if ($picto) {
    $return .= '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle widthpictotitle pictotitle"', $pictoisfullpath).'</td>';
  }
  $return .= '<td class="nobordernopadding valignmiddle col-title">';
  $return .= '<div class="titre inline-block">'.$titre.'</div>';
  $return .= '</td>';
  if (dol_strlen($morehtmlcenter)) {
    $return .= '<td class="nobordernopadding center valignmiddle">'.$morehtmlcenter.'</td>';
  }
  if (dol_strlen($morehtmlright)) {
    $return .= '<td class="nobordernopadding titre_right wordbreakimp right valignmiddle">'.$morehtmlright.'</td>';
  }
  $return .= '</tr></table>'."\n";
 
  return $return;
}
 
function print_barre_liste($titre, $page, $file, $options = '', $sortfield = '', $sortorder = '', $morehtmlcenter = '', $num = -1, $totalnboflines = '', $picto = 'generic', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limit = -1, $hideselectlimit = 0, $hidenavigation = 0, $pagenavastextinput = 0, $morehtmlrightbeforearrow = '')
{
  global $conf, $langs;
 
  $savlimit = $limit;
  $savtotalnboflines = $totalnboflines;
  $totalnboflines = abs((int) $totalnboflines);
 
  if ($picto == 'setup') {
    $picto = 'title_setup.png';
  }
  if (($conf->browser->name == 'ie') && $picto == 'generic') {
    $picto = 'title.gif';
  }
  if ($limit < 0) {
    $limit = $conf->liste_limit;
  }
  if ($savlimit != 0 && (($num > $limit) || ($num == -1) || ($limit == 0))) {
    $nextpage = 1;
  } else {
    $nextpage = 0;
  }
  //print 'totalnboflines='.$totalnboflines.'-savlimit='.$savlimit.'-limit='.$limit.'-num='.$num.'-nextpage='.$nextpage;
 
  print "\n";
  print "<!-- Begin title -->\n";
  print '<table class="centpercent notopnoleftnoright table-fiche-title'.($morecss ? ' '.$morecss : '').'"><tr>'; // maring bottom must be same than into load_fiche_tire
 
  // Left
 
  if ($picto && $titre) {
    print '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">'.img_picto('', $picto, 'class="valignmiddle pictotitle widthpictotitle"', $pictoisfullpath).'</td>';
  }
  print '<td class="nobordernopadding valignmiddle col-title">';
  print '<div class="titre inline-block">'.$titre;
  if (!empty($titre) && $savtotalnboflines >= 0 && (string) $savtotalnboflines != '') {
    print '<span class="opacitymedium colorblack paddingleft">('.$totalnboflines.')</span>';
  }
  print '</div></td>';
 
  // Center
  if ($morehtmlcenter) {
    print '<td class="nobordernopadding center valignmiddle">'.$morehtmlcenter.'</td>';
  }
 
  // Right
  print '<td class="nobordernopadding valignmiddle right">';
  print '<input type="hidden" name="pageplusoneold" value="'.((int) $page + 1).'">';
  if ($sortfield) {
    $options .= "&sortfield=".urlencode($sortfield);
  }
  if ($sortorder) {
    $options .= "&sortorder=".urlencode($sortorder);
  }
  // Show navigation bar
  $pagelist = '';
  if ($savlimit != 0 && ($page > 0 || $num > $limit)) {
    if ($totalnboflines) {  // If we know total nb of lines
      // Define nb of extra page links before and after selected page + ... + first or last
      $maxnbofpage = (empty($conf->dol_optimize_smallscreen) ? 4 : 0);
 
      if ($limit > 0) {
        $nbpages = ceil($totalnboflines / $limit);
      } else {
        $nbpages = 1;
      }
      $cpt = ($page - $maxnbofpage);
      if ($cpt < 0) {
        $cpt = 0;
      }
 
      if ($cpt >= 1) {
        if (empty($pagenavastextinput)) {
          $pagelist .= '<li class="pagination"><a href="'.$file.'?page=0'.$options.'">1</a></li>';
          if ($cpt > 2) {
            $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
          } elseif ($cpt == 2) {
            $pagelist .= '<li class="pagination"><a href="'.$file.'?page=1'.$options.'">2</a></li>';
          }
        }
      }
 
      do {
        if ($pagenavastextinput) {
          if ($cpt == $page) {
            $pagelist .= '<li class="pagination"><input type="text" class="width25 center pageplusone" name="pageplusone" value="'.($page + 1).'"></li>';
            $pagelist .= '/';
          }
        } else {
          if ($cpt == $page) {
            $pagelist .= '<li class="pagination"><span class="active">'.($page + 1).'</span></li>';
          } else {
            $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.$cpt.$options.'">'.($cpt + 1).'</a></li>';
          }
        }
        $cpt++;
      } while ($cpt < $nbpages && $cpt <= ($page + $maxnbofpage));
 
      if (empty($pagenavastextinput)) {
        if ($cpt < $nbpages) {
          if ($cpt < $nbpages - 2) {
            $pagelist .= '<li class="pagination"><span class="inactive">...</span></li>';
          } elseif ($cpt == $nbpages - 2) {
            $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.($nbpages - 2).$options.'">'.($nbpages - 1).'</a></li>';
          }
          $pagelist .= '<li class="pagination"><a href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
        }
      } else {
        //var_dump($page.' '.$cpt.' '.$nbpages);
        $pagelist .= '<li class="pagination paginationlastpage"><a href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
      }
    } else {
      $pagelist .= '<li class="pagination"><span class="active">'.($page + 1)."</li>";
    }
  }
 
  if ($savlimit || $morehtmlright || $morehtmlrightbeforearrow) {
    print_fleche_navigation($page, $file, $options, $nextpage, $pagelist, $morehtmlright, $savlimit, $totalnboflines, $hideselectlimit, $morehtmlrightbeforearrow); // output the div and ul for previous/last completed with page numbers into $pagelist
  }
 
  // js to autoselect page field on focus
  if ($pagenavastextinput) {
    print ajax_autoselect('.pageplusone');
  }
 
  print '</td>';
 
  print '</tr></table>'."\n";
  print "<!-- End title -->\n\n";
}
 
function print_fleche_navigation($page, $file, $options = '', $nextpage = 0, $betweenarrows = '', $afterarrows = '', $limit = -1, $totalnboflines = 0, $hideselectlimit = 0, $beforearrows = '')
{
  global $conf, $langs;
 
  print '<div class="pagination"><ul>';
  if ($beforearrows) {
    print '<li class="paginationbeforearrows">';
    print $beforearrows;
    print '</li>';
  }
  if ((int) $limit > 0 && empty($hideselectlimit)) {
    $pagesizechoices = '10:10,15:15,20:20,30:30,40:40,50:50,100:100,250:250,500:500,1000:1000';
    $pagesizechoices .= ',5000:5000,10000:10000,20000:20000';
    //$pagesizechoices.=',0:'.$langs->trans("All");     // Not yet supported
    //$pagesizechoices.=',2:2';
    if (!empty($conf->global->MAIN_PAGESIZE_CHOICES)) {
      $pagesizechoices = $conf->global->MAIN_PAGESIZE_CHOICES;
    }
 
    print '<li class="pagination">';
    print '<select class="flat selectlimit" name="limit" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'">';
    $tmpchoice = explode(',', $pagesizechoices);
    $tmpkey = $limit.':'.$limit;
    if (!in_array($tmpkey, $tmpchoice)) {
      $tmpchoice[] = $tmpkey;
    }
    $tmpkey = $conf->liste_limit.':'.$conf->liste_limit;
    if (!in_array($tmpkey, $tmpchoice)) {
      $tmpchoice[] = $tmpkey;
    }
    asort($tmpchoice, SORT_NUMERIC);
    foreach ($tmpchoice as $val) {
      $selected = '';
      $tmp = explode(':', $val);
      $key = $tmp[0];
      $val = $tmp[1];
      if ($key != '' && $val != '') {
        if ((int) $key == (int) $limit) {
          $selected = ' selected="selected"';
        }
        print '<option name="'.$key.'"'.$selected.'>'.dol_escape_htmltag($val).'</option>'."\n";
      }
    }
    print '</select>';
    if ($conf->use_javascript_ajax) {
      print '<!-- JS CODE TO ENABLE select limit to launch submit of page -->
                <script>
                  jQuery(document).ready(function () {
                    jQuery(".selectlimit").change(function() {
                            console.log("Change limit. Send submit");
                            $(this).parents(\'form:first\').submit();
                    });
                  });
                </script>
                ';
    }
    print '</li>';
  }
  if ($page > 0) {
    print '<li class="pagination paginationpage paginationpageleft"><a class="paginationprevious" href="'.$file.'?page='.($page - 1).$options.'"><i class="fa fa-chevron-left" title="'.dol_escape_htmltag($langs->trans("Previous")).'"></i></a></li>';
  }
  if ($betweenarrows) {
    print '<!--<div class="betweenarrows nowraponall inline-block">-->';
    print $betweenarrows;
    print '<!--</div>-->';
  }
  if ($nextpage > 0) {
    print '<li class="pagination paginationpage paginationpageright"><a class="paginationnext" href="'.$file.'?page='.($page + 1).$options.'"><i class="fa fa-chevron-right" title="'.dol_escape_htmltag($langs->trans("Next")).'"></i></a></li>';
  }
  if ($afterarrows) {
    print '<li class="paginationafterarrows">';
    print $afterarrows;
    print '</li>';
  }
  print '</ul></div>'."\n";
}
 
 
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">' : '').'('.$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 occured when amount value = o (letter) instead 0 (number)
  if ($rounding < 0) {
    $rounding = min($conf->global->MAIN_MAX_DECIMALS_UNIT, $conf->global->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 (!is_object($outlangs)) {
      $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."-";
  $datas = explode('.', $amount);
  $decpart = isset($datas[1]) ? $datas[1] : '';
  $decpart = preg_replace('/0+$/i', '', $decpart); // Supprime les 0 de fin de partie decimale
  //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);
  }
  // Si on depasse max
  if ($trunc && $nbdecimal > $conf->global->MAIN_MAX_DECIMALS_SHOWN) {
    $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_SHOWN;
    if (preg_match('/\.\.\./i', $conf->global->MAIN_MAX_DECIMALS_SHOWN)) {
      // Si un affichage est tronque, on montre des ...
      $end = '...';
    }
  }
 
  // If force rounding
  if ((string) $forcerounding != '-1') {
    if ($forcerounding == 'MU') {
      $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_UNIT;
    } elseif ($forcerounding == 'MT') {
      $nbdecimal = $conf->global->MAIN_MAX_DECIMALS_TOT;
    } elseif ($forcerounding >= 0) {
      $nbdecimal = $forcerounding;
    }
  }
 
  // Format number
  $output = number_format($amount, $nbdecimal, $dec, $thousand);
  if ($form) {
    $output = preg_replace('/\s/', '&nbsp;', $output);
    $output = preg_replace('/\'/', '&#039;', $output);
  }
  // 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');
    $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);
    }
  }
  $output = $cursymbolbefore.$output.$end.($cursymbolafter ? ' ' : '').$cursymbolafter;
 
  return $output;
}
 
function price2num($amount, $rounding = '', $option = 0)
{
  global $langs, $conf;
 
  // 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("%0.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 replace (the main goal of function)
    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.
  }
  //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 = $conf->global->MAIN_MAX_DECIMALS_UNIT;
    } elseif ($rounding == 'MT') {
      $nbofdectoround = $conf->global->MAIN_MAX_DECIMALS_TOT;
    } elseif ($rounding == 'MS') {
      $nbofdectoround = isset($conf->global->MAIN_MAX_DECIMALS_STOCK) ? $conf->global->MAIN_MAX_DECIMALS_STOCK : 5;
    } elseif ($rounding == 'CU') {
      $nbofdectoround = max($conf->global->MAIN_MAX_DECIMALS_UNIT, 8);  // TODO Use param of currency
    } elseif ($rounding == 'CT') {
      $nbofdectoround = max($conf->global->MAIN_MAX_DECIMALS_TOT, 8);   // 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("%0.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 showDimensionInBestUnit($dimension, $unit, $type, $outputlangs, $round = -1, $forceunitoutput = 'no', $use_short_label = 0)
{
  require_once DOL_DOCUMENT_ROOT.'/core/lib/product.lib.php';
 
  if (($forceunitoutput == 'no' && $dimension < 1 / 10000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -6)) {
    $dimension = $dimension * 1000000;
    $unit = $unit - 6;
  } elseif (($forceunitoutput == 'no' && $dimension < 1 / 10 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -3)) {
    $dimension = $dimension * 1000;
    $unit = $unit - 3;
  } elseif (($forceunitoutput == 'no' && $dimension > 100000000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 6)) {
    $dimension = $dimension / 1000000;
    $unit = $unit + 6;
  } elseif (($forceunitoutput == 'no' && $dimension > 100000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 3)) {
    $dimension = $dimension / 1000;
    $unit = $unit + 3;
  }
  // Special case when we want output unit into pound or ounce
  /* TODO
  if ($unit < 90 && $type == 'weight' && is_numeric($forceunitoutput) && (($forceunitoutput == 98) || ($forceunitoutput == 99))
  {
    $dimension = // convert dimension from standard unit into ounce or pound
    $unit = $forceunitoutput;
  }
  if ($unit > 90 && $type == 'weight' && is_numeric($forceunitoutput) && $forceunitoutput < 90)
  {
    $dimension = // convert dimension from standard unit into ounce or pound
    $unit = $forceunitoutput;
  }*/
 
  $ret = price($dimension, 0, $outputlangs, 0, 0, $round);
  $ret .= ' '.measuringUnitString(0, $type, $unit, $use_short_label, $outputlangs);
 
  return $ret;
}
 
 
function get_localtax($vatrate, $local, $thirdparty_buyer = "", $thirdparty_seller = "", $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*\‍((.*)\‍)$/', $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 (!empty($conf->global->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 $conf->global->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 $conf->global->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";
  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($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.localtax1, t.localtax2 ";
  $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.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 tt.active = 1";
  $sql .= "  )";
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($local == 1) {
      return $obj->localtax1;
    } elseif ($local == 2) {
      return $obj->localtax2;
    }
  }
 
  return 0;
}
 
 
function getTaxesFromId($vatrate, $buyer = null, $seller = null, $firstparamisid = 1)
{
  global $db, $mysoc;
 
  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 AND c.code = '".$db->escape($seller->country_code)."'";
    $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) {
      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 ($mysoc->country_code == 'ES') {
      $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'"; // local tax in spain use the buyer country ??
    } else {
      $sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape(empty($seller->country_code) ? $mysoc->country_code : $seller->country_code)."'";
    }
    $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, $thirdpartytouse, $idprodfournprice = 0)
{
  global $db, $conf, $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 == $thirdpartytouse->country_code) {
      // If country to consider is ours
      if ($idprodfournprice > 0) {     // We want vat for product for a "supplier" object
        $result = $product->get_buyprice($idprodfournprice, 0, 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 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 (empty($conf->global->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($thirdpartytouse->country_code)."'";
      $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 ($conf->global->MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS != 'none') {
        $defaulttx = $conf->global->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, $thirdpartytouse)
{
  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 == $thirdpartytouse->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($thirdpartytouse->country_code)."'";
    $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 $conf;
 
  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;
 
  $seller_country_code = $thirdparty_seller->country_code;
  $seller_in_cee = isInEEC($thirdparty_seller);
 
  $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=".$seller_in_cee.", buyer vat number=".$thirdparty_buyer->tva_intra." buyer country=".$buyer_country_code.", buyer in cee=".$buyer_in_cee.", idprod=".$idprod.", idprodfournprice=".$idprodfournprice.", SERVICE_ARE_ECOMMERCE_200238EC=".(!empty($conf->global->SERVICES_ARE_ECOMMERCE_200238EC) ? $conf->global->SERVICES_ARE_ECOMMERCE_200238EC : ''));
 
  // 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 (!empty($conf->global->SERVICE_ARE_ECOMMERCE_200238EC)) {
    if ($seller_in_cee && $buyer_in_cee) {
      $isacompany = $thirdparty_buyer->isACompany();
      if ($isacompany && !empty($conf->global->MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL)) {
        require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
        if (!isValidVATID($thirdparty_buyer)) {
          $isacompany = 0;
        }
      }
 
      if (!$isacompany) {
        //print 'VATRULE 0';
        return get_product_vat_for_country($idprod, $thirdparty_buyer, $idprodfournprice);
      }
    }
  }
 
  // If seller does not use VAT
  if (!$seller_use_vat) {
    //print 'VATRULE 1';
    return 0;
  }
 
  // Le test ci-dessus ne devrait pas etre necessaire. Me signaler l'exemple du cas juridique concerne si le test suivant n'est pas suffisant.
 
  // Si le (pays vendeur = pays acheteur) alors la TVA par defaut=TVA du produit vendu. Fin de regle.
  if (($seller_country_code == $buyer_country_code)
  || (in_array($seller_country_code, array('FR', 'MC')) && in_array($buyer_country_code, array('FR', 'MC')))) { // Warning ->country_code not always defined
    //print 'VATRULE 2';
    return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
  }
 
  // Si (vendeur et acheteur dans Communaute europeenne) et (bien vendu = moyen de transports neuf comme auto, bateau, avion) alors TVA par defaut=0 (La TVA doit etre paye par l'acheteur au centre d'impots de son pays et non au vendeur). Fin de regle.
  // 'VATRULE 3' - Not supported
 
  // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = entreprise) alors TVA par defaut=0. Fin de regle
  // Si (vendeur et acheteur dans Communaute europeenne) et (acheteur = particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  if (($seller_in_cee && $buyer_in_cee)) {
    $isacompany = $thirdparty_buyer->isACompany();
    if ($isacompany && !empty($conf->global->MAIN_USE_VAT_COMPANIES_IN_EEC_WITH_INVALID_VAT_ID_ARE_INDIVIDUAL)) {
      require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
      if (!isValidVATID($thirdparty_buyer)) {
        $isacompany = 0;
      }
    }
 
    if (!$isacompany) {
      //print 'VATRULE 4';
      return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
    } else {
      //print 'VATRULE 5';
      return 0;
    }
  }
 
  // Si (vendeur dans Communaute europeene et acheteur hors Communaute europeenne et acheteur particulier) alors TVA par defaut=TVA du produit vendu. Fin de regle
  // I don't see any use case that need this rule.
  if (!empty($conf->global->MAIN_USE_VAT_OF_PRODUCT_FOR_INDIVIDUAL_CUSTOMER_OUT_OF_EEC) && empty($buyer_in_cee)) {
    $isacompany = $thirdparty_buyer->isACompany();
    if (!$isacompany) {
      return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
      //print 'VATRULE extra';
    }
  }
 
  // Sinon la TVA proposee par defaut=0. Fin de regle.
  // Rem: Cela signifie qu'au moins un des 2 est hors Communaute europeenne et que le pays differe
  //print 'VATRULE 6';
  return 0;
}
 
 
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 ($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 ($thirdparty_seller->country_code == $thirdparty_buyer->country_code) {
    return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
  }
 
  return 0;
}
 
function yn($yesno, $case = 1, $color = 0)
{
  global $langs;
 
  $result = 'unknown';
  $classname = '';
  if ($yesno == 1 || strtolower($yesno) == 'yes' || strtolower($yesno) == 'true') {   // A mettre avant test sur no a cause du == 0
    $result = $langs->trans('yes');
    if ($case == 1 || $case == 3) {
      $result = $langs->trans("Yes");
    }
    if ($case == 2) {
      $result = '<input type="checkbox" value="1" checked disabled>';
    }
    if ($case == 3) {
      $result = '<input type="checkbox" value="1" checked disabled> '.$result;
    }
 
    $classname = 'ok';
  } elseif ($yesno == 0 || strtolower($yesno) == 'no' || strtolower($yesno) == 'false') {
    $result = $langs->trans("no");
    if ($case == 1 || $case == 3) {
      $result = $langs->trans("No");
    }
    if ($case == 2) {
      $result = '<input type="checkbox" value="0" disabled>';
    }
    if ($case == 3) {
      $result = '<input type="checkbox" value="0" disabled> '.$result;
    }
 
    if ($color == 2) {
      $classname = 'ok';
    } else {
      $classname = 'error';
    }
  }
  if ($color) {
    return '<span class="'.$classname.'">'.$result.'</span>';
  }
  return $result;
}
 
function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = '')
{
  global $conf;
 
  if (empty($modulepart) && !empty($object->module)) {
    $modulepart = $object->module;
  }
 
  $path = '';
 
  $arrayforoldpath = array('cheque', 'category', 'holiday', 'supplier_invoice', 'invoice_supplier', 'mailing', 'supplier_payment');
  if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
    $arrayforoldpath[] = 'product';
  }
  if (!empty($level) && in_array($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($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.
    //var_dump($modulepart);
    $path = dol_sanitizeFileName(empty($object->ref) ? (string) $object->id : $object->ref);
  }
 
  if (empty($withoutslash) && !empty($path)) {
    $path .= '/';
  }
 
  return $path;
}
 
function dol_mkdir($dir, $dataroot = '', $newmask = '')
{
  global $conf;
 
  dol_syslog("functions.lib::dol_mkdir: dir=".$dir, LOG_INFO);
 
  $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];
    }
    if (preg_match("/^.:$/", $ccdir, $regs)) {
      continue; // Si chemin Windows incomplet, on poursuit par rep suivant
    }
 
    // Attention, le is_dir() peut echouer bien que le rep existe.
    // (ex selon config de open_basedir)
    if ($ccdir) {
      $ccdir_osencoded = dol_osencode($ccdir);
      if (!@is_dir($ccdir_osencoded)) {
        dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' does not exists or is outside open_basedir PHP setting.", LOG_DEBUG);
 
        umask(0);
        $dirmaskdec = octdec((string) $newmask);
        if (empty($newmask)) {
          $dirmaskdec = empty($conf->global->MAIN_UMASK) ? octdec('0755') : octdec($conf->global->MAIN_UMASK);
        }
        $dirmaskdec |= octdec('0111'); // Set x bit required for directories
        if (!@mkdir($ccdir_osencoded, $dirmaskdec)) {
          // Si le is_dir a renvoye une fausse info, alors on passe ici.
          dol_syslog("functions.lib::dol_mkdir: Fails to create directory '".$ccdir."' or directory already exists.", LOG_WARNING);
          $nberr++;
        } else {
          dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' created", LOG_DEBUG);
          $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignore
          $nbcreated++;
        }
      } else {
        $nberr = 0; // On remet a zero car si on arrive ici, cela veut dire que les echecs precedents peuvent etre ignores
      }
    }
  }
  return ($nberr ? -$nberr : $nbcreated);
}
 
 
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);
 
  if ($strip_tags) {
    $temp = strip_tags($temp);
  } else {
    // Remove '<' into remainging, 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 quotes
  if ($removedoublespaces) {
    while (strpos($temp, "  ")) {
      $temp = str_replace("  ", " ", $temp);
    }
  }
 
  $temp = str_replace('__ltspace__', '< ', $temp);
 
  return trim($temp);
}
 
function dol_string_onlythesehtmltags($stringtoclean, $cleanalsosomestyles = 1, $removeclassattribute = 1, $cleanalsojavascript = 0, $allowiframe = 0, $allowed_tags = array())
{
  if (empty($allowed_tags)) {
    $allowed_tags = array(
      "html", "head", "meta", "body", "article", "a", "abbr", "b", "blockquote", "br", "cite", "div", "dl", "dd", "dt", "em", "font", "img", "ins", "hr", "i", "li", "link",
      "ol", "p", "q", "s", "section", "span", "strike", "strong", "title", "table", "tr", "th", "td", "u", "ul", "sup", "sub", "blockquote", "pre", "h1", "h2", "h3", "h4", "h5", "h6"
    );
  }
  $allowed_tags[] = "comment";    // this tags is added to manage comment <!--...--> that are replaced into <comment>...</comment>
  if ($allowiframe) {
    $allowed_tags[] = "iframe";
  }
 
  $allowed_tags_string = join("><", $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);
 
  $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:...'
 
  $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
  }
  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 with
  // 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
 
  $temp = preg_replace('/<comment>([^>]*)<\/comment>/', '<!--\1-->', $temp);  // Restore html comments
 
 
  return $temp;
}
 
 
function dol_string_onlythesehtmlattributes($stringtoclean, $allowed_attributes = array("allow", "allowfullscreen", "alt", "class", "contenteditable", "data-html", "frameborder", "height", "href", "id", "name", "src", "style", "target", "title", "width"))
{
  if (class_exists('DOMDocument') && !empty($stringtoclean)) {
    $stringtoclean = '<?xml encoding="UTF-8"><html><body>'.$stringtoclean.'</body></html>';
 
    $dom = new DOMDocument(null, 'UTF-8');
    $dom->loadHTML($stringtoclean, LIBXML_ERR_NONE|LIBXML_HTML_NOIMPLIED|LIBXML_HTML_NODEFDTD|LIBXML_NONET|LIBXML_NOWARNING|LIBXML_NOXMLDECL);
 
    if (is_object($dom)) {
      for ($els = $dom->getElementsByTagname('*'), $i = $els->length - 1; $i >= 0; $i--) {
        for ($attrs = $els->item($i)->attributes, $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
              $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;
            }
          }
        }
      }
    }
 
    $return = $dom->saveHTML();
    //$return = '<html><body>aaaa</p>bb<p>ssdd</p>'."\n<p>aaa</p>aa<p>bb</p>";
 
    $return = preg_replace('/^'.preg_quote('<?xml encoding="UTF-8">', '/').'/', '', $return);
    $return = preg_replace('/^'.preg_quote('<html><body>', '/').'/', '', $return);
    $return = preg_replace('/'.preg_quote('</body></html>', '/').'$/', '', $return);
    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 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 {
      $firstline = preg_replace('/[\n\r].*/', '', $text);
    }
    return $firstline.((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;
    $nba = count($a); // 2x nb of lines in $a because $a contains also a line for each new line separator
    while (($i < $nba) && ($i < ($nboflines * 2))) {
      if ($i % 2 == 0) {
        $firstline .= $a[$i];
      } elseif (($i < (($nboflines * 2) - 1)) && ($i < ($nba - 1))) {
        $firstline .= ($ishtml ? "<br>\n" : "\n");
      }
      $i++;
    }
    unset($a);
    return $firstline.(($i < $nba) ? '...' : '');
  }
}
 
 
function dol_nl2br($stringtoencode, $nl2brmode = 0, $forxml = false)
{
  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')
{
  global $conf;
 
  if (empty($nouseofiframesandbox) && !empty($conf->global->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;
 
    do {
      $oldstringtoclean = $out;
 
      if (!empty($out) && !empty($conf->global->MAIN_RESTRICTHTML_ONLY_VALID_HTML) && $check != 'restricthtmlallowunvalid') {
        try {
          $dom = new DOMDocument;
          // Add a trick to solve pb with text without parent tag
          // like '<h1>Foo</h1><p>bar</p>' that wrongly ends up without the trick into '<h1>Foo<p>bar</p></h1>'
          // like 'abc' that wrongly ends up without the tric into with '<p>abc</p>'
          $out = '<div class="tricktoremove">'.$out.'</div>';
 
          $dom->loadHTML($out, LIBXML_ERR_NONE|LIBXML_HTML_NOIMPLIED|LIBXML_HTML_NODEFDTD|LIBXML_NONET|LIBXML_NOWARNING|LIBXML_NOXMLDECL);
          $out = trim($dom->saveHTML());
 
          // Remove the trick added to solve pb with text without parent tag
          $out = preg_replace('/^<div class="tricktoremove">/', '', $out);
          $out = preg_replace('/<\/div>$/', '', $out);
        } catch (Exception $e) {
          // If error, invalid HTML string with no way to clean it
          //print $e->getMessage();
          $out = 'InvalidHTMLString';
        }
      }
 
      // Clean some html entities that are useless so text is cleaner
      $out = preg_replace('/&(tab|newline);/i', ' ', $out);
 
      // Ckeditor use the numeric entitic for apostrophe so we force it to 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 coventionnel way to be encoded, to not have them sanitized just after)
      $out = preg_replace_callback('/&#(x?[0-9][0-9a-f]+;?)/i', 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
      $out = dol_string_onlythesehtmltags($out, 0, 1, 1);
 
      // We should also exclude non expected HTML attributes and clean content of some attributes (keep only alt=, title=...).
      if (!empty($conf->global->MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES)) {
        // Warning, the function may add a LF so we are forced to trim to compare with old $out without having always a difference and an infinit loop.
        $out = dol_string_onlythesehtmlattributes($out);
      }
 
      // Restore entity &apos; into &#39; (restricthtml is for html content so we can use html entity)
      $out = preg_replace('/&apos;/i', "&#39;", $out);
    } while ($oldstringtoclean != $out);
 
    // Check the limit of external links in a Rich text content. We count '<img' and 'url('
    $reg = array();
    preg_match_all('/(<img|url\‍()/i', $out, $reg);
    if (count($reg[0]) > getDolGlobalInt("MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT", 1000)) {
      $out = 'TooManyLinksIntoHTMLString';
    }
 
    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 = strtr($newstring, array('&'=>'__and__', '<'=>'__lt__', '>'=>'__gt__', '"'=>'__dquot__'));
    $newstring = dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom); // Make entity encoding
    $newstring = strtr($newstring, array('__and__'=>'&', '__lt__'=>'<', '__gt__'=>'>', '__dquot__'=>'"'));
  } 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/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)>/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/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)>/i', $msg)) {
      return true;
    } elseif (preg_match('/<br\/>/i', $msg)) {
      return true;
    } elseif (preg_match('/<(br|div|font|li|p|span|strong|table)>/i', $msg)) {
      return true;
    } elseif (preg_match('/<(br|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)
    }
 
    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 getCommonSubstitutionArray($outputlangs, $onlykey = 0, $exclude = null, $object = null)
{
  global $db, $conf, $mysoc, $user, $extrafields;
 
  $substitutionarray = array();
 
  if (empty($exclude) || !in_array('user', $exclude)) {
    // 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; //  dy 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;
    $substitutionarray = array_merge($substitutionarray, array(
      '__SENDEREMAIL_SIGNATURE__' => (string) ((empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN)) ? ($onlykey == 2 ? dol_trunc('SignatureFromTheSelectedSenderProfile', 30) : $emailsendersignature) : ''),
      '__USER_SIGNATURE__' => (string) (($usersignature && empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN)) ? ($onlykey == 2 ? dol_trunc(dol_string_nohtmltag($usersignature), 30) : $usersignature) : '')
    ));
 
    if (is_object($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),
        '__USER_PHONEPRO__' => (string) dol_print_phone($user->user_mobile),
        '__USER_PHONEMOBILE__' => (string) dol_print_phone($user->personal_mobile),
        '__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()
        ));
    }
  }
  if ((empty($exclude) || !in_array('mycompany', $exclude)) && is_object($mysoc)) {
    $substitutionarray = array_merge($substitutionarray, array(
      '__MYCOMPANY_NAME__'    => $mysoc->name,
      '__MYCOMPANY_EMAIL__'   => $mysoc->email,
      '__MYCOMPANY_PHONE__'   => dol_print_phone($mysoc->phone),
      '__MYCOMPANY_FAX__'     => dol_print_phone($mysoc->fax),
      '__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_CAPITAL__' => $mysoc->capital,
      '__MYCOMPANY_FULLADDRESS__' => (method_exists($mysoc, 'getFullAddress') ? $mysoc->getFullAddress(1, ', ') : ''),  // $mysoc may be stdClass
      '__MYCOMPANY_ADDRESS__' => $mysoc->address,
      '__MYCOMPANY_ZIP__'     => $mysoc->zip,
      '__MYCOMPANY_TOWN__'    => $mysoc->town,
      '__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))) {
    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_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_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_TVAINTRA__'] = '__THIRDPARTY_TVAINTRA__';
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = '__THIRDPARTY_NOTE_PUBLIC__';
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = '__THIRDPARTY_NOTE_PRIVATE__';
      }
      if (isModEnabled('adherent') && (!is_object($object) || $object->element == 'adherent')) {
        $substitutionarray['__MEMBER_ID__'] = '__MEMBER_ID__';
        $substitutionarray['__MEMBER_CIVILITY__'] = '__MEMBER_CIVILITY__';
        $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 variables subtitutions ticket
      if (isModEnabled('ticket') && (!is_object($object) || $object->element == 'ticket')) {
        $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')) {
        $substitutionarray['__CANDIDATE_FULLNAME__'] = '__CANDIDATE_FULLNAME__';
        $substitutionarray['__CANDIDATE_FIRSTNAME__'] = '__CANDIDATE_FIRSTNAME__';
        $substitutionarray['__CANDIDATE_LASTNAME__'] = '__CANDIDATE_LASTNAME__';
      }
      if (isModEnabled('project')) {    // 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('contrat') && (!is_object($object) || $object->element == 'contract')) {
        $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')) {
        $substitutionarray['__ONLINE_SIGN_URL__'] = 'ToOfferALinkForOnlineSignature';
      }
      if (isModEnabled("ficheinter") && (!is_object($object) || $object->element == 'fichinter')) {
        $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';
 
      if (isModEnabled("expedition") && (!is_object($object) || $object->element == 'shipping')) {
        $substitutionarray['__SHIPPINGTRACKNUM__'] = 'Shipping tracking number';
        $substitutionarray['__SHIPPINGTRACKNUMURL__'] = 'Shipping tracking url';
      }
      if (isModEnabled("reception") && (!is_object($object) || $object->element == 'reception')) {
        $substitutionarray['__RECEPTIONTRACKNUM__'] = 'Shippin tracking number of shipment';
        $substitutionarray['__RECEPTIONTRACKNUMURL__'] = 'Shipping tracking url';
      }
    } else {
      $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);
      if ($object->element == "shipping") {
        $substitutionarray['__DATE_DELIVERY__'] = (isset($object->date_delivery) ? dol_print_date($object->date_delivery, 'day', 0, $outputlangs) : '');
      } else {
        $substitutionarray['__DATE_DELIVERY__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, 'day', 0, $outputlangs) : '');
      }
      $substitutionarray['__DATE_DELIVERY_DAY__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%d") : '');
      $substitutionarray['__DATE_DELIVERY_DAY_TEXT__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%A") : '');
      $substitutionarray['__DATE_DELIVERY_MON__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%m") : '');
      $substitutionarray['__DATE_DELIVERY_MON_TEXT__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%b") : '');
      $substitutionarray['__DATE_DELIVERY_YEAR__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%Y") : '');
      $substitutionarray['__DATE_DELIVERY_HH__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%H") : '');
      $substitutionarray['__DATE_DELIVERY_MM__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%M") : '');
      $substitutionarray['__DATE_DELIVERY_SS__'] = (isset($object->date_livraison) ? dol_print_date($object->date_livraison, "%S") : '');
 
      // For backward compatibility
      $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($object->date_livraison) ? dol_print_date($object->date_livraison, 'day', 0, $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 : '')) : '');
 
      if (is_object($object) && ($object->element == 'adherent' || $object->element == 'member') && $object->id > 0) {
        $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_CIVILITY__'] = $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_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, 'dayrfc');
        $substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START__'] = (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, 'dayrfc') : '');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE__']        = dol_print_date($object->last_subscription_date, 'dayrfc');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START__']  = dol_print_date($object->last_subscription_date_start, 'dayrfc');
        $substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END__']    = dol_print_date($object->last_subscription_date_end, 'dayrfc');
      }
 
      if (is_object($object) && $object->element == 'societe') {
        $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object) ? $object->id : '');
        $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object) ? $object->name : '');
        $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object) ? $object->name_alias : '');
        $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object) ? $object->code_client : '');
        $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object) ? $object->code_fournisseur : '');
        $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object) ? $object->email : '');
        $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object) ? dol_print_phone($object->phone) : '');
        $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object) ? dol_print_phone($object->fax) : '');
        $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object) ? $object->address : '');
        $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object) ? $object->zip : '');
        $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object) ? $object->town : '');
        $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object) ? $object->country_id : '');
        $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object) ? $object->country_code : '');
        $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object) ? $object->idprof1 : '');
        $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object) ? $object->idprof2 : '');
        $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object) ? $object->idprof3 : '');
        $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object) ? $object->idprof4 : '');
        $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object) ? $object->idprof5 : '');
        $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object) ? $object->idprof6 : '');
        $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object) ? $object->tva_intra : '');
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_public) : '');
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object) ? dol_htmlentitiesbr($object->note_private) : '');
      } elseif (is_object($object->thirdparty)) {
        $substitutionarray['__THIRDPARTY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->id : '');
        $substitutionarray['__THIRDPARTY_NAME__'] = (is_object($object->thirdparty) ? $object->thirdparty->name : '');
        $substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = (is_object($object->thirdparty) ? $object->thirdparty->name_alias : '');
        $substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_client : '');
        $substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = (is_object($object->thirdparty) ? $object->thirdparty->code_fournisseur : '');
        $substitutionarray['__THIRDPARTY_EMAIL__'] = (is_object($object->thirdparty) ? $object->thirdparty->email : '');
        $substitutionarray['__THIRDPARTY_PHONE__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->phone) : '');
        $substitutionarray['__THIRDPARTY_FAX__'] = (is_object($object->thirdparty) ? dol_print_phone($object->thirdparty->fax) : '');
        $substitutionarray['__THIRDPARTY_ADDRESS__'] = (is_object($object->thirdparty) ? $object->thirdparty->address : '');
        $substitutionarray['__THIRDPARTY_ZIP__'] = (is_object($object->thirdparty) ? $object->thirdparty->zip : '');
        $substitutionarray['__THIRDPARTY_TOWN__'] = (is_object($object->thirdparty) ? $object->thirdparty->town : '');
        $substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_id : '');
        $substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = (is_object($object->thirdparty) ? $object->thirdparty->country_code : '');
        $substitutionarray['__THIRDPARTY_IDPROF1__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof1 : '');
        $substitutionarray['__THIRDPARTY_IDPROF2__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof2 : '');
        $substitutionarray['__THIRDPARTY_IDPROF3__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof3 : '');
        $substitutionarray['__THIRDPARTY_IDPROF4__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof4 : '');
        $substitutionarray['__THIRDPARTY_IDPROF5__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof5 : '');
        $substitutionarray['__THIRDPARTY_IDPROF6__'] = (is_object($object->thirdparty) ? $object->thirdparty->idprof6 : '');
        $substitutionarray['__THIRDPARTY_TVAINTRA__'] = (is_object($object->thirdparty) ? $object->thirdparty->tva_intra : '');
        $substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_public) : '');
        $substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = (is_object($object->thirdparty) ? dol_htmlentitiesbr($object->thirdparty->note_private) : '');
      }
 
      if (is_object($object) && $object->element == 'recruitmentcandidature') {
        $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->project)) {
        $substitutionarray['__PROJECT_ID__'] = (is_object($object->project) ? $object->project->id : '');
        $substitutionarray['__PROJECT_REF__'] = (is_object($object->project) ? $object->project->ref : '');
        $substitutionarray['__PROJECT_NAME__'] = (is_object($object->project) ? $object->project->title : '');
      }
      if (is_object($object->projet)) { // Deprecated, for backward compatibility
        $substitutionarray['__PROJECT_ID__'] = (is_object($object->projet) ? $object->projet->id : '');
        $substitutionarray['__PROJECT_REF__'] = (is_object($object->projet) ? $object->projet->ref : '');
        $substitutionarray['__PROJECT_NAME__'] = (is_object($object->projet) ? $object->projet->title : '');
      }
      if (is_object($object) && $object->element == 'project') {
        $substitutionarray['__PROJECT_NAME__'] = $object->title;
      }
 
      if (is_object($object) && $object->element == 'shipping') {
        $substitutionarray['__SHIPPINGTRACKNUM__'] = $object->tracking_number;
        $substitutionarray['__SHIPPINGTRACKNUMURL__'] = $object->tracking_url;
      }
      if (is_object($object) && $object->element == 'reception') {
        $substitutionarray['__RECEPTIONTRACKNUM__'] = $object->tracking_number;
        $substitutionarray['__RECEPTIONTRACKNUMURL__'] = $object->tracking_url;
      }
 
      if (is_object($object) && $object->element == 'contrat' && $object->id > 0 && is_array($object->lines)) {
        $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, 'dayrfc');
        $substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = dol_print_date($dateplannedstart, 'standard');
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = dol_print_date($datenextexpiration, 'dayrfc');
        $substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = dol_print_date($datenextexpiration, 'standard');
      }
      // add substition variable for ticket
      if (is_object($object) && $object->element == 'ticket') {
        $substitutionarray['__TICKET_TRACKID__'] = $object->track_id;
        $substitutionarray['__REF__'] = $object->ref;
        $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) {
          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) {
              $substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = $object->array_options['options_'.$key];
              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]);
              }
            }
          }
        }
      }
 
      // Complete substitution array with the url to make online payment
      $paymenturl = '';
      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'));
        $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 (is_object($object) && $object->element == 'contrat') {
          $typeforonlinepayment = 'contract';
        }
        if (is_object($object) && $object->element == 'fichinter') {
          $typeforonlinepayment = 'ficheinter';
        }
        $url = getOnlinePaymentUrl(0, $typeforonlinepayment, $substitutionarray['__REF__']);
        $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;
 
        if (is_object($object) && $object->element == 'propal') {
          require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
          $substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'proposal', $object->ref);
        }
        if (is_object($object) && $object->element == 'fichinter') {
          require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
          $substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = getOnlineSignatureUrl(0, 'fichinter', $object->ref);
        }
        if (!empty($conf->global->PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'propal') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = '';
        }
        if (!empty($conf->global->ORDER_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'commande') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = '';
        }
        if (!empty($conf->global->INVOICE_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'facture') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = '';
        }
        if (!empty($conf->global->CONTRACT_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'contrat') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = '';
        }
        if (!empty($conf->global->FICHINTER_ALLOW_EXTERNAL_DOWNLOAD) && is_object($object) && $object->element == 'fichinter') {
          $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = $object->getLastMainDocLink($object->element);
        } else {
          $substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = '';
        }
        if (!empty($conf->global->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 (is_object($object) && $object->element == 'propal') {
          $substitutionarray['__URL_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/comm/propal/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'commande') {
          $substitutionarray['__URL_ORDER__'] = DOL_MAIN_URL_ROOT."/commande/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'facture') {
          $substitutionarray['__URL_INVOICE__'] = DOL_MAIN_URL_ROOT."/compta/facture/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'contrat') {
          $substitutionarray['__URL_CONTRACT__'] = DOL_MAIN_URL_ROOT."/contrat/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'fichinter') {
          $substitutionarray['__URL_FICHINTER__'] = DOL_MAIN_URL_ROOT."/fichinter/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'supplier_proposal') {
          $substitutionarray['__URL_SUPPLIER_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/supplier_proposal/card.php?id=".$object->id;
        }
        if (is_object($object) && $object->element == 'shipping') {
          $substitutionarray['__URL_SHIPMENT__'] = DOL_MAIN_URL_ROOT."/expedition/card.php?id=".$object->id;
        }
      }
 
      if (is_object($object) && $object->element == 'action') {
        $substitutionarray['__EVENT_LABEL__'] = $object->label;
        $substitutionarray['__EVENT_DATE__'] = dol_print_date($object->datep, '%A %d %b %Y');
        $substitutionarray['__EVENT_TIME__'] = dol_print_date($object->datep, '%H:%M:%S');
      }
    }
  }
  if (empty($exclude) || !in_array('objectamount', $exclude)) {
    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', 0, $outputlangs) : null) : '';
    $substitutionarray['__DATE_DUE_YMD__']    = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'day', 0, $outputlangs) : null) : '';
 
    $already_payed_all = 0;
    if (is_object($object) && ($object instanceof Facture)) {
      $already_payed_all = $object->sumpayed + $object->sumdeposit + $object->sumcreditnote;
    }
 
    $substitutionarray['__AMOUNT_EXCL_TAX__'] = is_object($object) ? $object->total_ht : '';
 
    $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['__AMOUNT_REMAIN__'] = is_object($object) ? $object->total_ttc - $already_payed_all : '';
 
    $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)) : '';
 
    if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
      $substitutionarray['__AMOUNT_TAX2__']     = is_object($object) ? $object->total_localtax1 : '';
    }
    if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
      $substitutionarray['__AMOUNT_TAX3__']     = is_object($object) ? $object->total_localtax2 : '';
    }
 
    // Amount keys formated in a currency
    $substitutionarray['__AMOUNT_EXCL_TAX_FORMATED__'] = is_object($object) ? ($object->total_ht ? price($object->total_ht, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_FORMATED__']          = is_object($object) ? ($object->total_ttc ? price($object->total_ttc, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_REMAIN_FORMATED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc - $already_payed_all, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    $substitutionarray['__AMOUNT_VAT_FORMATED__']      = 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 || $mysoc->useLocalTax(1)) {
      $substitutionarray['__AMOUNT_TAX2_FORMATED__']     = is_object($object) ? ($object->total_localtax1 ? price($object->total_localtax1, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    }
    if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
      $substitutionarray['__AMOUNT_TAX3_FORMATED__']     = is_object($object) ? ($object->total_localtax2 ? price($object->total_localtax2, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
    }
 
    $substitutionarray['__AMOUNT_MULTICURRENCY__']          = (is_object($object) && isset($object->multicurrency_total_ttc)) ? $object->multicurrency_total_ttc : '';
    $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) : '';
    // 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) : '';
    }
  }
 
  //var_dump($substitutionarray['__AMOUNT_FORMATED__']);
  if (empty($exclude) || !in_array('date', $exclude)) {
    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__' => (int) $now,
      '__NOW_TMS_YMD__' => dol_print_date($now, 'day', 0, $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->trans('Month'.sprintf("%02d", $tmp['mon'])),
      '__MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp['mon'])),
      '__MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp['mon'])),
      '__YEAR__' => (string) $tmp['year'],
      '__PREVIOUS_DAY__' => (string) $tmp2['day'],
      '__PREVIOUS_MONTH__' => (string) $tmp3['month'],
      '__PREVIOUS_YEAR__' => (string) ($tmp['year'] - 1),
      '__NEXT_DAY__' => (string) $tmp4['day'],
      '__NEXT_MONTH__' => (string) $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)) {
    $substitutionarray['__DOL_MAIN_URL_ROOT__'] = DOL_MAIN_URL_ROOT;
    $substitutionarray['__(AnyTranslationKey)__'] = $outputlangs->trans('TranslationOfKey');
    $substitutionarray['__(AnyTranslationKey|langfile)__'] = $outputlangs->trans('TranslationOfKey').' (load also language file before)';
    $substitutionarray['__[AnyConstantKey]__'] = $outputlangs->trans('ValueOfConstantKey');
  }
 
  return $substitutionarray;
}
 
function make_substitutions($text, $substitutionarray, $outputlangs = null, $converttextinhtmlifnecessary = 0)
{
  global $conf, $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("$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)) {
    $keyfound = $reg[1];
    if (isASecretKey($keyfound)) {
      $value = '*****forbidden*****';
    } else {
      $value = empty($conf->global->$keyfound) ? '' : $conf->global->$keyfound;
    }
 
    if (empty($converttextinhtmlifnecessary)) {
      // convert $newval into HTML is necessary
      $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $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("$value");
      }
 
      $text = preg_replace('/__\['.preg_quote($keyfound, '/').'\]__/', $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 (($key == '__USER_SIGNATURE__' || $key == '__SENDEREMAIL_SIGNATURE__') && (!empty($conf->global->MAIN_MAIL_DO_NOT_USE_SIGN))) {
      $value = ''; // Protection
    }
 
    if (empty($converttextinhtmlifnecessary)) {
      $text = str_replace("$key", "$value", $text); // We must keep the " to work 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("$value");
      }
      $text = str_replace("$key", "$value", $text); // We must keep the " to work when value is 123.5 for example
    }
  }
 
  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 (!empty($conf->global->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 = '')
{
  print get_date_range($date_start, $date_end, $format, $outputlangs);
}
 
function get_date_range($date_start, $date_end, $format = '', $outputlangs = '', $withparenthesis = 1)
{
  global $langs;
 
  $out = '';
 
  if (!is_object($outputlangs)) {
    $outputlangs = $langs;
  }
 
  if ($date_start && $date_end) {
    $out .= ($withparenthesis ? ' (' : '').$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 ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateFrom', dol_print_date($date_start, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  }
  if (!$date_start && $date_end) {
    $out .= ($withparenthesis ? ' (' : '').$outputlangs->transnoentitiesnoconv('DateUntil', dol_print_date($date_end, $format, false, $outputlangs)).($withparenthesis ? ')' : '');
  }
 
  return $out;
}
 
function dolGetFirstLastname($firstname, $lastname, $nameorder = -1)
{
  global $conf;
 
  $ret = '';
  // If order not defined, we use the setup
  if ($nameorder < 0) {
    $nameorder = (empty($conf->global->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 setEventMessage($mesgs, $style = 'mesgs')
{
  //dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING);   This is not deprecated, it is used by setEventMessages function
  if (!is_array($mesgs)) {
    // If mesgs is a string
    if ($mesgs) {
      $_SESSION['dol_events'][$style][] = $mesgs;
    }
  } else {
    // If mesgs is an array
    foreach ($mesgs as $mesg) {
      if ($mesg) {
        $_SESSION['dol_events'][$style][] = $mesg;
      }
    }
  }
}
 
function setEventMessages($mesg, $mesgs, $style = 'mesgs', $messagekey = '')
{
  if (empty($mesg) && empty($mesgs)) {
    dol_syslog("Try to add a message in stack with empty message", LOG_WARNING);
  } else {
    if ($messagekey) {
      // Complete message with a js link to set a cookie "DOLHIDEMESSAGE".$messagekey;
      // TODO
      $mesg .= '';
    }
    if (empty($messagekey) || empty($_COOKIE["DOLHIDEMESSAGE".$messagekey])) {
      if (!in_array((string) $style, array('mesgs', 'warnings', 'errors'))) {
        dol_print_error('', 'Bad parameter style='.$style.' for setEventMessages');
      }
      if (empty($mesgs)) {
        setEventMessage($mesg, $style);
      } else {
        if (!empty($mesg) && !in_array($mesg, $mesgs)) {
          setEventMessage($mesg, $style); // Add message string if not already into array
        }
        setEventMessage($mesgs, $style);
      }
    }
  }
}
 
function dol_htmloutput_events($disabledoutputofmessages = 0)
{
  // Show mesgs
  if (isset($_SESSION['dol_events']['mesgs'])) {
    if (empty($disabledoutputofmessages)) {
      dol_htmloutput_mesg('', $_SESSION['dol_events']['mesgs']);
    }
    unset($_SESSION['dol_events']['mesgs']);
  }
  // Show errors
  if (isset($_SESSION['dol_events']['errors'])) {
    if (empty($disabledoutputofmessages)) {
      dol_htmloutput_mesg('', $_SESSION['dol_events']['errors'], 'error');
    }
    unset($_SESSION['dol_events']['errors']);
  }
 
  // Show warnings
  if (isset($_SESSION['dol_events']['warnings'])) {
    if (empty($disabledoutputofmessages)) {
      dol_htmloutput_mesg('', $_SESSION['dol_events']['warnings'], 'warning');
    }
    unset($_SESSION['dol_events']['warnings']);
  }
}
 
function get_htmloutput_mesg($mesgstring = '', $mesgarray = '', $style = 'ok', $keepembedded = 0)
{
  global $conf, $langs;
 
  $ret = 0;
  $return = '';
  $out = '';
  $divstart = $divend = '';
 
  // If inline message with no format, we add it.
  if ((empty($conf->use_javascript_ajax) || !empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) || $keepembedded) && !preg_match('/<div class=".*">/i', $out)) {
    $divstart = '<div class="'.$style.' clearboth">';
    $divend = '</div>';
  }
 
  if ((is_array($mesgarray) && count($mesgarray)) || $mesgstring) {
    $langs->load("errors");
    $out .= $divstart;
    if (is_array($mesgarray) && count($mesgarray)) {
      foreach ($mesgarray as $message) {
        $ret++;
        $out .= $langs->trans($message);
        if ($ret < count($mesgarray)) {
          $out .= "<br>\n";
        }
      }
    }
    if ($mesgstring) {
      $ret++;
      $out .= $langs->trans($mesgstring);
    }
    $out .= $divend;
  }
 
  if ($out) {
    if (!empty($conf->use_javascript_ajax) && empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY) && empty($keepembedded)) {
      $return = '<script>
          $(document).ready(function() {
            var block = '.(!empty($conf->global->MAIN_USE_JQUERY_BLOCKUI) ? "true" : "false").'
            if (block) {
              $.dolEventValid("","'.dol_escape_js($out).'");
            } else {
              /* jnotify(message, preset of message type, keepmessage) */
              $.jnotify("'.dol_escape_js($out).'",
              "'.($style == "ok" ? 3000 : $style).'",
              '.($style == "ok" ? "false" : "true").',
              { remove: function (){} } );
            }
          });
        </script>';
    } else {
      $return = $out;
    }
  }
 
  return $return;
}
 
function get_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
{
  return get_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
}
 
function dol_htmloutput_mesg($mesgstring = '', $mesgarray = array(), $style = 'ok', $keepembedded = 0)
{
  if (empty($mesgstring) && (!is_array($mesgarray) || count($mesgarray) == 0)) {
    return;
  }
 
  $iserror = 0;
  $iswarning = 0;
  if (is_array($mesgarray)) {
    foreach ($mesgarray as $val) {
      if ($val && preg_match('/class="error"/i', $val)) {
        $iserror++;
        break;
      }
      if ($val && preg_match('/class="warning"/i', $val)) {
        $iswarning++;
        break;
      }
    }
  } elseif ($mesgstring && preg_match('/class="error"/i', $mesgstring)) {
    $iserror++;
  } elseif ($mesgstring && preg_match('/class="warning"/i', $mesgstring)) {
    $iswarning++;
  }
  if ($style == 'error') {
    $iserror++;
  }
  if ($style == 'warning') {
    $iswarning++;
  }
 
  if ($iserror || $iswarning) {
    // Remove div from texts
    $mesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $mesgstring);
    $mesgstring = preg_replace('/<div class="(error|warning)">/', '', $mesgstring);
    $mesgstring = preg_replace('/<\/div>/', '', $mesgstring);
    // Remove div from texts array
    if (is_array($mesgarray)) {
      $newmesgarray = array();
      foreach ($mesgarray as $val) {
        if (is_string($val)) {
          $tmpmesgstring = preg_replace('/<\/div><div class="(error|warning)">/', '<br>', $val);
          $tmpmesgstring = preg_replace('/<div class="(error|warning)">/', '', $tmpmesgstring);
          $tmpmesgstring = preg_replace('/<\/div>/', '', $tmpmesgstring);
          $newmesgarray[] = $tmpmesgstring;
        } else {
          dol_syslog("Error call of dol_htmloutput_mesg with an array with a value that is not a string", LOG_WARNING);
        }
      }
      $mesgarray = $newmesgarray;
    }
    print get_htmloutput_mesg($mesgstring, $mesgarray, ($iserror ? 'error' : 'warning'), $keepembedded);
  } else {
    print get_htmloutput_mesg($mesgstring, $mesgarray, 'ok', $keepembedded);
  }
}
 
function dol_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
{
  dol_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
}
 
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) {
      $temp = array();
      foreach (array_keys($array) as $key) {
        if (is_object($array[$key])) {
          $temp[$key] = empty($array[$key]->$index) ? 0 : $array[$key]->$index;
        } else {
          $temp[$key] = empty($array[$key][$index]) ? 0 : $array[$key][$index];
        }
        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 = dol_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 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)
{
  global $conf;
 
  $tmp = ini_get("unicode.filesystem_encoding"); // Disponible avec PHP 6.0
  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 (!empty($conf->global->MAIN_FILESYSTEM_ENCODING)) {
    $tmp = $conf->global->MAIN_FILESYSTEM_ENCODING;
  }
 
  if ($tmp == 'iso-8859-1') {
    return utf8_decode($str);
  }
  return $str;
}
 
 
function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '')
{
  global $cache_codes;
 
  // If key empty
  if ($key == '') {
    return '';
  }
 
  // Check in cache
  if (isset($cache_codes[$tablename][$key][$fieldid])) {  // Can be defined to 0 or ''
    return $cache_codes[$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 ".$fieldid." as valuetoget";
  $sql .= " FROM ".MAIN_DB_PREFIX.$tablename;
  $sql .= " WHERE ".$fieldkey." = '".$db->escape($key)."'";
  if (!empty($entityfilter)) {
    $sql .= " AND entity IN (".getEntity($tablename).")";
  }
  if ($filters) {
    $sql .= $filters;
  }
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($obj) {
      $cache_codes[$tablename][$key][$fieldid] = $obj->valuetoget;
    } else {
      $cache_codes[$tablename][$key][$fieldid] = '';
    }
    $db->free($resql);
    return $cache_codes[$tablename][$key][$fieldid];
  } else {
    return -1;
  }
}
 
function verifCond($strToEvaluate)
{
  global $user, $conf, $langs;
  global $leftmenu;
  global $rights; // To export to dol_eval function
 
  //print $strToEvaluate."<br>\n";
  $rights = true;
  if (isset($strToEvaluate) && $strToEvaluate !== '') {
    //var_dump($strToEvaluate);
    $rep = dol_eval($strToEvaluate, 1, 1, '1'); // The dol_eval must contains all the global $xxx for all variables $xxx found into the string condition
    $rights = $rep && (!is_string($rep) || strpos($rep, 'Bad string syntax to evaluate') === false);
    //var_dump($rights);
  }
  return $rights;
}
 
function dol_eval($s, $returnvalue = 0, $hideerrors = 1, $onlysimplestring = '1')
{
  // Only global variables can be changed by eval function and returned to caller
  global $db, $langs, $user, $conf, $website, $websitepage;
  global $action, $mainmenu, $leftmenu;
  global $rights;
  global $object;
  global $mysoc;
 
  global $obj; // To get $obj used into list when dol_eval is used for computed fields and $obj is not yet $object
  global $soc; // For backward compatibility
 
  // Test on dangerous char (used for RCE), we allow only characters to make PHP variable testing
  if ($onlysimplestring == '1') {
    // We must accept: '1 && getDolGlobalInt("doesnotexist1") && $conf->global->MAIN_FEATURES_LEVEL'
    // We must accept: '$conf->barcode->enabled || preg_match(\'/^AAA/\',$leftmenu)'
    // We must accept: '$user->rights->cabinetmed->read && !$object->canvas=="patient@cabinetmed"'
    if (preg_match('/[^a-z0-9\s'.preg_quote('^$_+-.*>&|=!?():"\',/@', '/').']/i', $s)) {
      if ($returnvalue) {
        return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
      } else {
        dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
        return '';
      }
      // TODO
      // We can exclude all parenthesis ( that are not '($db' and 'getDolGlobalInt(' and 'getDolGlobalString(' and 'preg_match(' and 'isModEnabled('
      // ...
    }
  } elseif ($onlysimplestring == '2') {
    // We must accept: (($reloadedobj = new Task($db)) && ($reloadedobj->fetchNoCompute($object->id) > 0) && ($secondloadedobj = new Project($db)) && ($secondloadedobj->fetchNoCompute($reloadedobj->fk_project) > 0)) ? $secondloadedobj->ref : "Parent project not found"
    if (preg_match('/[^a-z0-9\s'.preg_quote('^$_+-.*>&|=!?():"\',/@;[]', '/').']/i', $s)) {
      if ($returnvalue) {
        return 'Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s;
      } else {
        dol_syslog('Bad string syntax to evaluate (found chars that are not chars for simplestring): '.$s);
        return '';
      }
    }
  }
  if (strpos($s, '::') !== false) {
    if ($returnvalue) {
      return 'Bad string syntax to evaluate (double : char is forbidden): '.$s;
    } else {
      dol_syslog('Bad string syntax to evaluate (double : char is forbidden): '.$s);
      return '';
    }
  }
  if (strpos($s, '`') !== false) {
    if ($returnvalue) {
      return 'Bad string syntax to evaluate (backtick char is forbidden): '.$s;
    } else {
      dol_syslog('Bad string syntax to evaluate (backtick char is forbidden): '.$s);
      return '';
    }
  }
  if (preg_match('/[^0-9]+\.[^0-9]+/', $s)) { // We refuse . if not between 2 numbers
    if ($returnvalue) {
      return 'Bad string syntax to evaluate (dot char is forbidden): '.$s;
    } else {
      dol_syslog('Bad string syntax to evaluate (dot char is forbidden): '.$s);
      return '';
    }
  }
 
  // We block use of php exec or php file functions
  $forbiddenphpstrings = array('$$');
  $forbiddenphpstrings = array_merge($forbiddenphpstrings, array('_ENV', '_SESSION', '_COOKIE', '_GET', '_POST', '_REQUEST'));
 
  $forbiddenphpfunctions = array("exec", "passthru", "shell_exec", "system", "proc_open", "popen", "eval", "dol_eval", "executeCLI", "verifCond", "base64_decode");
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("fopen", "file_put_contents", "fputs", "fputscsv", "fwrite", "fpassthru", "require", "include", "mkdir", "rmdir", "symlink", "touch", "unlink", "umask"));
  $forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function", "call_user_func"));
 
  $forbiddenphpregex = 'global\s+\$|\b('.implode('|', $forbiddenphpfunctions).')\b';
 
  do {
    $oldstringtoclean = $s;
    $s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
    $s = preg_replace('/'.$forbiddenphpregex.'/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);
    if ($returnvalue) {
      return 'Bad string syntax to evaluate: '.$s;
    } else {
      dol_syslog('Bad string syntax to evaluate: '.$s);
      return '';
    }
  }
 
  //print $s."<br>\n";
  if ($returnvalue) {
    if ($hideerrors) {
      return @eval('return '.$s.';');
    } else {
      return eval('return '.$s.';');
    }
  } else {
    if ($hideerrors) {
      @eval($s);
    } else {
      eval($s);
    }
  }
}
 
function dol_validElement($element)
{
  return (trim($element) != '');
}
 
function picto_from_langcode($codelang, $moreatt = '', $notitlealt = 0)
{
  if (empty($codelang)) {
    return '';
  }
 
  if ($codelang == 'auto') {
    return '<span class="fa fa-language"></span>';
  }
 
  $langtocountryflag = array(
    'ar_AR' => '',
    'ca_ES' => 'catalonia',
    'da_DA' => 'dk',
    'fr_CA' => 'mq',
    'sv_SV' => 'se',
    'sw_SW' => 'unknown',
    'AQ' => 'unknown',
    'CW' => 'unknown',
    'IM' => 'unknown',
    'JE' => 'unknown',
    'MF' => 'unknown',
    'BL' => 'unknown',
    'SX' => 'unknown'
  );
 
  if (isset($langtocountryflag[$codelang])) {
    $flagImage = $langtocountryflag[$codelang];
  } else {
    $tmparray = explode('_', $codelang);
    $flagImage = empty($tmparray[1]) ? $tmparray[0] : $tmparray[1];
  }
 
  return img_picto_common($codelang, 'flags/'.strtolower($flagImage).'.png', $moreatt, 0, $notitlealt);
}
 
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 Exention 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) {
          // 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;
          }
 
          if (verifCond($values[4])) {
            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)) {
                    $nbrec = $obj->$function($object->id, $obj);
                    $label .= '<span class="badge marginleftonlyshort">'.$nbrec.'</span>';
                  }
                }
              }
            }
 
            $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[5]), 1);
            $head[$h][1] = $label;
            $head[$h][2] = str_replace('+', '', $values[1]);
            $h++;
          }
        } elseif (count($values) == 5) {       // case deprecated
          dol_syslog('Passing 5 values in tabs module_parts is deprecated. Please update to 6 with permissions.', LOG_WARNING);
 
          if ($values[0] != $type) {
            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)) {
            $substitutionarray = array();
            complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey'=>$values[2]));
            $label = make_substitutions($reg[1], $substitutionarray);
          } else {
            $label = $langs->trans($values[2]);
          }
 
          $head[$h][0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[4]), 1);
          $head[$h][1] = $label;
          $head[$h][2] = str_replace('+', '', $values[1]);
          $h++;
        }
      } 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]) : 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);
    $reshook = $hookmanager->executeHooks('completeTabsHead', $parameters);
    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 printCommonFooter($zone = 'private')
{
  global $conf, $hookmanager, $user, $debugbar;
  global $action;
  global $micro_start_time;
 
  if ($zone == 'private') {
    print "\n".'<!-- Common footer for private page -->'."\n";
  } else {
    print "\n".'<!-- Common footer for public page -->'."\n";
  }
 
  // A div to store page_y POST parameter so we can read it using javascript
  print "\n<!-- A div to store page_y POST parameter -->\n";
  print '<div id="page_y" style="display: none;">'.(GETPOST('page_y') ? GETPOST('page_y') : '').'</div>'."\n";
 
  $parameters = array();
  $reshook = $hookmanager->executeHooks('printCommonFooter', $parameters); // Note that $action and $object may have been modified by some hooks
  if (empty($reshook)) {
    if (!empty($conf->global->MAIN_HTML_FOOTER)) {
      print $conf->global->MAIN_HTML_FOOTER."\n";
    }
 
    print "\n";
    if (!empty($conf->use_javascript_ajax)) {
      print "\n<!-- A script section to add menuhider handler on backoffice, manage focus and madatory fields, tuning info, ... -->\n";
      print '<script>'."\n";
      print 'jQuery(document).ready(function() {'."\n";
 
      if ($zone == 'private' && empty($conf->dol_use_jmobile)) {
        print "\n";
        print '/* JS CODE TO ENABLE to manage handler to switch left menu page (menuhider) */'."\n";
        print 'jQuery("li.menuhider").click(function(event) {';
        print '  if (!$( "body" ).hasClass( "sidebar-collapse" )){ event.preventDefault(); }'."\n";
        print '  console.log("We click on .menuhider");'."\n";
        print '  $("body").toggleClass("sidebar-collapse")'."\n";
        print '});'."\n";
      }
 
      // Management of focus and mandatory for fields
      if ($action == 'create' || $action == 'edit' || (empty($action) && (preg_match('/new\.php/', $_SERVER["PHP_SELF"])))) {
        print '/* JS CODE TO ENABLE to manage focus and mandatory form fields */'."\n";
        $relativepathstring = $_SERVER["PHP_SELF"];
        // Clean $relativepathstring
        if (constant('DOL_URL_ROOT')) {
          $relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
        }
        $relativepathstring = preg_replace('/^\//', '', $relativepathstring);
        $relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
        //$tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
        if (!empty($user->default_values[$relativepathstring]['focus'])) {
          foreach ($user->default_values[$relativepathstring]['focus'] as $defkey => $defval) {
            $qualified = 0;
            if ($defkey != '_noquery_') {
              $tmpqueryarraytohave = explode('&', $defkey);
              $foundintru = 0;
              foreach ($tmpqueryarraytohave as $tmpquerytohave) {
                $tmpquerytohaveparam = explode('=', $tmpquerytohave);
                //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
                if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
                  $foundintru = 1;
                }
              }
              if (!$foundintru) {
                $qualified = 1;
              }
              //var_dump($defkey.'-'.$qualified);
            } else {
              $qualified = 1;
            }
 
            if ($qualified) {
              foreach ($defval as $paramkey => $paramval) {
                // Set focus on field
                print 'jQuery("input[name=\''.$paramkey.'\']").focus();'."\n";
                print 'jQuery("textarea[name=\''.$paramkey.'\']").focus();'."\n";
                print 'jQuery("select[name=\''.$paramkey.'\']").focus();'."\n"; // Not really usefull, but we keep it in case of.
              }
            }
          }
        }
        if (!empty($user->default_values[$relativepathstring]['mandatory'])) {
          foreach ($user->default_values[$relativepathstring]['mandatory'] as $defkey => $defval) {
            $qualified = 0;
            if ($defkey != '_noquery_') {
              $tmpqueryarraytohave = explode('&', $defkey);
              $foundintru = 0;
              foreach ($tmpqueryarraytohave as $tmpquerytohave) {
                $tmpquerytohaveparam = explode('=', $tmpquerytohave);
                //print "console.log('".$tmpquerytohaveparam[0]." ".$tmpquerytohaveparam[1]." ".GETPOST($tmpquerytohaveparam[0])."');";
                if (!GETPOSTISSET($tmpquerytohaveparam[0]) || ($tmpquerytohaveparam[1] != GETPOST($tmpquerytohaveparam[0]))) {
                  $foundintru = 1;
                }
              }
              if (!$foundintru) {
                $qualified = 1;
              }
              //var_dump($defkey.'-'.$qualified);
            } else {
              $qualified = 1;
            }
 
            if ($qualified) {
              foreach ($defval as $paramkey => $paramval) {
                // Add property 'required' on input
                print 'jQuery("input[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
                print 'jQuery("textarea[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
                print '// required on a select works only if key is "", so we add the required attributes but also we reset the key -1 or 0 to an empty string'."\n";
                print 'jQuery("select[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
                print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'-1\']").prop(\'value\', \'\');'."\n";
                print 'jQuery("select[name=\''.$paramkey.'\'] option[value=\'0\']").prop(\'value\', \'\');'."\n";
 
                // Add 'field required' class on closest td for all input elements : input, textarea and select
                print 'jQuery(":input[name=\'' . $paramkey . '\']").closest("tr").find("td:first").addClass("fieldrequired");' . "\n";
              }
            }
          }
        }
      }
 
      print '});'."\n";
 
      // End of tuning
      if (!empty($_SERVER['MAIN_SHOW_TUNING_INFO']) || !empty($conf->global->MAIN_SHOW_TUNING_INFO)) {
        print "\n";
        print "/* JS CODE TO ENABLE to add memory info */\n";
        print 'window.console && console.log("';
        if (!empty($conf->global->MEMCACHED_SERVER)) {
          print 'MEMCACHED_SERVER='.$conf->global->MEMCACHED_SERVER.' - ';
        }
        print 'MAIN_OPTIMIZE_SPEED='.(isset($conf->global->MAIN_OPTIMIZE_SPEED) ? $conf->global->MAIN_OPTIMIZE_SPEED : 'off');
        if (!empty($micro_start_time)) {   // Works only if MAIN_SHOW_TUNING_INFO is defined at $_SERVER level. Not in global variable.
          $micro_end_time = microtime(true);
          print ' - Build time: '.ceil(1000 * ($micro_end_time - $micro_start_time)).' ms';
        }
 
        if (function_exists("memory_get_usage")) {
          print ' - Mem: '.memory_get_usage(); // Do not use true here, it seems it takes the peak amount
        }
        if (function_exists("memory_get_peak_usage")) {
          print ' - Real mem peak: '.memory_get_peak_usage(true);
        }
        if (function_exists("zend_loader_file_encoded")) {
          print ' - Zend encoded file: '.(zend_loader_file_encoded() ? 'yes' : 'no');
        }
        print '");'."\n";
      }
 
      print "\n".'</script>'."\n";
 
      // Google Analytics
      // TODO Add a hook here
      if (!empty($conf->google->enabled) && !empty($conf->global->MAIN_GOOGLE_AN_ID)) {
        $tmptagarray = explode(',', $conf->global->MAIN_GOOGLE_AN_ID);
        foreach ($tmptagarray as $tmptag) {
          print "\n";
          print "<!-- JS CODE TO ENABLE for google analtics tag -->\n";
          print "
          <!-- Global site tag (gtag.js) - Google Analytics -->
          <script async src=\"https://www.googletagmanager.com/gtag/js?id=".trim($tmptag)."\"></script>
          <script>
          window.dataLayer = window.dataLayer || [];
          function gtag(){dataLayer.push(arguments);}
          gtag('js', new Date());
 
          gtag('config', '".trim($tmptag)."');
          </script>";
          print "\n";
        }
      }
    }
 
    // Add Xdebug coverage of code
    if (defined('XDEBUGCOVERAGE')) {
      print_r(xdebug_get_code_coverage());
    }
 
    // Add DebugBar data
    if (!empty($user->rights->debugbar->read) && is_object($debugbar)) {
      $debugbar['time']->stopMeasure('pageaftermaster');
      print '<!-- Output debugbar data -->'."\n";
      $renderer = $debugbar->getRenderer();
      print $debugbar->getRenderer()->render();
    } elseif (count($conf->logbuffer)) {    // If there is some logs in buffer to show
      print "\n";
      print "<!-- Start of log output\n";
      //print '<div class="hidden">'."\n";
      foreach ($conf->logbuffer as $logline) {
        print $logline."<br>\n";
      }
      //print '</div>'."\n";
      print "End of log output -->\n";
    }
  }
}
 
function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
{
  if ($a = explode($delimiter, $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 dol_set_focus($selector)
{
  print "\n".'<!-- Set focus onto a specific field -->'."\n";
  print '<script>jQuery(document).ready(function() { jQuery("'.dol_escape_js($selector).'").focus(); });</script>'."\n";
}
 
 
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)
{
  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("DecimalSeparator"), '/').'\-])/', '\1\2', $value); // Clean string '< 10' into '<10' so we can the explode on space to get all tests to do
  }
 
  $value = preg_replace('/\s*\|\s*/', '|', $value);
 
  $crits = explode(' ', $value);
  $res = '';
  if (!is_array($fields)) {
    $fields = array($fields);
  }
 
  $j = 0;
  foreach ($crits as $crit) {
    $crit = trim($crit);
    $i = 0;
    $i2 = 0;
    $newres = '';
    foreach ($fields as $field) {
      if ($mode == 1) {
        $operator = '=';
        $newcrit = preg_replace('/([<>=]+)/', '', $crit);
 
        $reg = array();
        preg_match('/([<>=]+)/', $crit, $reg);
        if (!empty($reg[1])) {
          $operator = $reg[1];
        }
        if ($newcrit != '') {
          $numnewcrit = price2num($newcrit);
          if (is_numeric($numnewcrit)) {
            $newres .= ($i2 > 0 ? ' OR ' : '').$field.' '.$operator.' '.((float) $numnewcrit); // should be a numeric
          } else {
            $newres .= ($i2 > 0 ? ' OR ' : '').'1 = 2'; // force false
          }
          $i2++; // a criteria was added to string
        }
      } elseif ($mode == 2 || $mode == -2) {
        $crit = preg_replace('/[^0-9,]/', '', $crit); // ID are always integer
        $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -2 ? 'NOT ' : '');
        $newres .= $crit ? "IN (".$db->sanitize($db->escape($crit)).")" : "IN (0)";
        if ($mode == -2) {
          $newres .= ' OR '.$field.' IS NULL';
        }
        $i2++; // a criteria was added to string
      } elseif ($mode == 3 || $mode == -3) {
        $tmparray = explode(',', $crit);
        if (count($tmparray)) {
          $listofcodes = '';
          foreach ($tmparray as $val) {
            $val = trim($val);
            if ($val) {
              $listofcodes .= ($listofcodes ? ',' : '');
              $listofcodes .= "'".$db->escape($val)."'";
            }
          }
          $newres .= ($i2 > 0 ? ' OR ' : '').$field." ".($mode == -3 ? 'NOT ' : '')."IN (".$db->sanitize($listofcodes, 1).")";
          $i2++; // a criteria was added to string
        }
        if ($mode == -3) {
          $newres .= ' OR '.$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 (" : "(").$field." LIKE '".$db->escape($val).",%'";
              $newres .= ' OR '.$field." = '".$db->escape($val)."'";
              $newres .= ' OR '.$field." LIKE '%,".$db->escape($val)."'";
              $newres .= ' OR '.$field." LIKE '%,".$db->escape($val).",%'";
              $newres .= ')';
              $i2++;
            }
          }
        }
      } else // $mode=0
      {
        $tmpcrits = explode('|', $crit);
        $i3 = 0;
        foreach ($tmpcrits as $tmpcrit) {
          if ($tmpcrit !== '0' && empty($tmpcrit)) {
            continue;
          }
 
          $newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
 
          if (preg_match('/\.(id|rowid)$/', $field)) {  // Special case for rowid that is sometimes a ref so used as a search field
            $newres .= $field." = ".(is_numeric(trim($tmpcrit)) ? ((float) trim($tmpcrit)) : '0');
          } else {
            $tmpcrit = trim($tmpcrit);
            $tmpcrit2 = $tmpcrit;
            $tmpbefore = '%';
            $tmpafter = '%';
            if (preg_match('/^!/', $tmpcrit)) {
              $newres .= $field." NOT LIKE '"; // ! as exclude character
              $tmpcrit2 = preg_replace('/^!/', '', $tmpcrit2);
            } else $newres .= $field." LIKE '";
 
            if (preg_match('/^[\^\$]/', $tmpcrit)) {
              $tmpbefore = '';
              $tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
            }
            if (preg_match('/[\^\$]$/', $tmpcrit)) {
              $tmpafter = '';
              $tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
            }
            $newres .= $tmpbefore;
            $newres .= $db->escape($tmpcrit2);
            $newres .= $tmpafter;
            $newres .= "'";
            if ($tmpcrit2 == '') {
              $newres .= " OR ".$field." IS NULL";
            }
          }
 
          $i3++;
        }
        $i2++; // a criteria was added to string
      }
      $i++;
    }
    if ($newres) {
      $res = $res.($res ? ' AND ' : '').($i2 > 1 ? '(' : '').$newres.($i2 > 1 ? ')' : '');
    }
    $j++;
  }
  $res = ($nofirstand ? "" : " AND ")."(".$res.")";
  //print 'xx'.$res.'yy';
  return $res;
}
 
function showDirectDownloadLink($object)
{
  global $conf, $langs;
 
  $out = '';
  $url = $object->getLastMainDocLink($object->element);
 
  $out .= img_picto($langs->trans("PublicDownloadLinkDesc"), 'globe').' <span class="opacitymedium">'.$langs->trans("DirectDownloadLink").'</span><br>';
  if ($url) {
    $out .= '<div class="urllink"><input type="text" id="directdownloadlink" class="quatrevingtpercent" value="'.$url.'"></div>';
    $out .= ajax_autoselect("directdownloadlink", 0);
  } else {
    $out .= '<div class="urllink">'.$langs->trans("FileNotShared").'</div>';
  }
 
  return $out;
}
 
function getImageFileNameForSize($file, $extName, $extImgTarget = '')
{
  $dirName = dirname($file);
  if ($dirName == '.') {
    $dirName = '';
  }
 
  $fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp|\.webp)$/i', '', $file); // We remove 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 (!$extImgTarget) {
    return $file;
  }
 
  $subdir = '';
  if ($extName) {
    $subdir = 'thumbs/';
  }
 
  return ($dirName ? $dirName.'/' : '').$subdir.$fileName.$extName.$extImgTarget; // New filename for thumb
}
 
 
function getAdvancedPreviewUrl($modulepart, $relativepath, $alldata = 0, $param = '')
{
  global $conf, $langs;
 
  if (empty($conf->use_javascript_ajax)) {
    return '';
  }
 
  $isAllowedForPreview = dolIsAllowedForPreview($relativepath);
 
  if ($alldata == 1) {
    if ($isAllowedForPreview) {
      return array('target'=>'_blank', 'css'=>'documentpreview', 'url'=>DOL_URL_ROOT.'/document.php?modulepart='.$modulepart.'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : ''), 'mime'=>dol_mimetype($relativepath));
    } else {
      return array();
    }
  }
 
  // old behavior, return a string
  if ($isAllowedForPreview) {
    return 'javascript:document_preview(\''.dol_escape_js(DOL_URL_ROOT.'/document.php?modulepart='.$modulepart.'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : '')).'\', \''.dol_mimetype($relativepath).'\', \''.dol_escape_js($langs->trans('Preview')).'\')';
  } else {
    return '';
  }
}
 
 
function ajax_autoselect($htmlname, $addlink = '', $textonlink = 'Link')
{
  global $langs;
  $out = '<script>
               jQuery(document).ready(function () {
            jQuery("'.((strpos($htmlname, '.') === 0 ? '' : '#').$htmlname).'").click(function() { jQuery(this).select(); } );
        });
        </script>';
  if ($addlink) {
    if ($textonlink === 'image') {
      $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.img_picto('', 'globe').'</a>';
    } else {
      $out .= ' <a href="'.$addlink.'" target="_blank" rel="noopener noreferrer">'.$langs->trans("Link").'</a>';
    }
  }
  return $out;
}
 
function dolIsAllowedForPreview($file)
{
  global $conf;
 
  // Check .noexe extension in filename
  if (preg_match('/\.noexe$/i', $file)) {
    return 0;
  }
 
  // Check mime types
  $mime_preview = array('bmp', 'jpeg', 'png', 'gif', 'tiff', 'pdf', 'plain', 'css', 'webp');
  if (!empty($conf->global->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-text-o';
  }
  if (preg_match('/\.rtx$/i', $tmpfile)) {
    $mime = 'text/richtext';
    $imgmime = 'text.png';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.csv$/i', $tmpfile)) {
    $mime = 'text/csv';
    $imgmime = 'text.png';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.tsv$/i', $tmpfile)) {
    $mime = 'text/tab-separated-values';
    $imgmime = 'text.png';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.(cf|conf|log)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.ini$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'ini';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.md$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'md';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.css$/i', $tmpfile)) {
    $mime = 'text/css';
    $imgmime = 'css.png';
    $srclang = 'css';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.lang$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'lang';
    $famime = 'file-text-o';
  }
  // Certificate files
  if (preg_match('/\.(crt|cer|key|pub)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $famime = 'file-text-o';
  }
  // XML based (HTML/XML/XAML)
  if (preg_match('/\.(html|htm|shtml)$/i', $tmpfile)) {
    $mime = 'text/html';
    $imgmime = 'html.png';
    $srclang = 'html';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.(xml|xhtml)$/i', $tmpfile)) {
    $mime = 'text/xml';
    $imgmime = 'other.png';
    $srclang = 'xml';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.xaml$/i', $tmpfile)) {
    $mime = 'text/xml';
    $imgmime = 'other.png';
    $srclang = 'xaml';
    $famime = 'file-text-o';
  }
  // Languages
  if (preg_match('/\.bas$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'bas';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.(c)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'c';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.(cpp)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'cpp';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.cs$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'cs';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.(h)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'h';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.(java|jsp)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'java';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.php([0-9]{1})?$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'php.png';
    $srclang = 'php';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.phtml$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'php.png';
    $srclang = 'php';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.(pl|pm)$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'pl.png';
    $srclang = 'perl';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.sql$/i', $tmpfile)) {
    $mime = 'text/plain';
    $imgmime = 'text.png';
    $srclang = 'sql';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.js$/i', $tmpfile)) {
    $mime = 'text/x-javascript';
    $imgmime = 'jscript.png';
    $srclang = 'js';
    $famime = 'file-code-o';
  }
  // Open office
  if (preg_match('/\.odp$/i', $tmpfile)) {
    $mime = 'application/vnd.oasis.opendocument.presentation';
    $imgmime = 'ooffice.png';
    $famime = 'file-powerpoint-o';
  }
  if (preg_match('/\.ods$/i', $tmpfile)) {
    $mime = 'application/vnd.oasis.opendocument.spreadsheet';
    $imgmime = 'ooffice.png';
    $famime = 'file-excel-o';
  }
  if (preg_match('/\.odt$/i', $tmpfile)) {
    $mime = 'application/vnd.oasis.opendocument.text';
    $imgmime = 'ooffice.png';
    $famime = 'file-word-o';
  }
  // MS Office
  if (preg_match('/\.mdb$/i', $tmpfile)) {
    $mime = 'application/msaccess';
    $imgmime = 'mdb.png';
    $famime = 'file-o';
  }
  if (preg_match('/\.doc[xm]?$/i', $tmpfile)) {
    $mime = 'application/msword';
    $imgmime = 'doc.png';
    $famime = 'file-word-o';
  }
  if (preg_match('/\.dot[xm]?$/i', $tmpfile)) {
    $mime = 'application/msword';
    $imgmime = 'doc.png';
    $famime = 'file-word-o';
  }
  if (preg_match('/\.xlt(x)?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel-o';
  }
  if (preg_match('/\.xla(m)?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel-o';
  }
  if (preg_match('/\.xls$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-excel';
    $imgmime = 'xls.png';
    $famime = 'file-excel-o';
  }
  if (preg_match('/\.xls[bmx]$/i', $tmpfile)) {
    $mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
    $imgmime = 'xls.png';
    $famime = 'file-excel-o';
  }
  if (preg_match('/\.pps[mx]?$/i', $tmpfile)) {
    $mime = 'application/vnd.ms-powerpoint';
    $imgmime = 'ppt.png';
    $famime = 'file-powerpoint-o';
  }
  if (preg_match('/\.ppt[mx]?$/i', $tmpfile)) {
    $mime = 'application/x-mspowerpoint';
    $imgmime = 'ppt.png';
    $famime = 'file-powerpoint-o';
  }
  // Other
  if (preg_match('/\.pdf$/i', $tmpfile)) {
    $mime = 'application/pdf';
    $imgmime = 'pdf.png';
    $famime = 'file-pdf-o';
  }
  // Scripts
  if (preg_match('/\.bat$/i', $tmpfile)) {
    $mime = 'text/x-bat';
    $imgmime = 'script.png';
    $srclang = 'dos';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.sh$/i', $tmpfile)) {
    $mime = 'text/x-sh';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.ksh$/i', $tmpfile)) {
    $mime = 'text/x-ksh';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code-o';
  }
  if (preg_match('/\.bash$/i', $tmpfile)) {
    $mime = 'text/x-bash';
    $imgmime = 'script.png';
    $srclang = 'bash';
    $famime = 'file-code-o';
  }
  // Images
  if (preg_match('/\.ico$/i', $tmpfile)) {
    $mime = 'image/x-icon';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.(jpg|jpeg)$/i', $tmpfile)) {
    $mime = 'image/jpeg';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.png$/i', $tmpfile)) {
    $mime = 'image/png';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.gif$/i', $tmpfile)) {
    $mime = 'image/gif';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.bmp$/i', $tmpfile)) {
    $mime = 'image/bmp';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.(tif|tiff)$/i', $tmpfile)) {
    $mime = 'image/tiff';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.svg$/i', $tmpfile)) {
    $mime = 'image/svg+xml';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  if (preg_match('/\.webp$/i', $tmpfile)) {
    $mime = 'image/webp';
    $imgmime = 'image.png';
    $famime = 'file-image-o';
  }
  // Calendar
  if (preg_match('/\.vcs$/i', $tmpfile)) {
    $mime = 'text/calendar';
    $imgmime = 'other.png';
    $famime = 'file-text-o';
  }
  if (preg_match('/\.ics$/i', $tmpfile)) {
    $mime = 'text/calendar';
    $imgmime = 'other.png';
    $famime = 'file-text-o';
  }
  // Other
  if (preg_match('/\.torrent$/i', $tmpfile)) {
    $mime = 'application/x-bittorrent';
    $imgmime = 'other.png';
    $famime = 'file-o';
  }
  // Audio
  if (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i', $tmpfile)) {
    $mime = 'audio';
    $imgmime = 'audio.png';
    $famime = 'file-audio-o';
  }
  // Video
  if (preg_match('/\.mp4$/i', $tmpfile)) {
    $mime = 'video/mp4';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.ogv$/i', $tmpfile)) {
    $mime = 'video/ogg';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.webm$/i', $tmpfile)) {
    $mime = 'video/webm';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.avi$/i', $tmpfile)) {
    $mime = 'video/x-msvideo';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.divx$/i', $tmpfile)) {
    $mime = 'video/divx';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.xvid$/i', $tmpfile)) {
    $mime = 'video/xvid';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  if (preg_match('/\.(wmv|mpg|mpeg)$/i', $tmpfile)) {
    $mime = 'video';
    $imgmime = 'video.png';
    $famime = 'file-video-o';
  }
  // Archive
  if (preg_match('/\.(zip|rar|gz|tgz|z|cab|bz2|7z|tar|lzh|zst)$/i', $tmpfile)) {
    $mime = 'archive';
    $imgmime = 'archive.png';
    $famime = 'file-archive-o';
  }    // application/xxx where zzz is zip, ...
  // Exe
  if (preg_match('/\.(exe|com)$/i', $tmpfile)) {
    $mime = 'application/octet-stream';
    $imgmime = 'other.png';
    $famime = 'file-o';
  }
  // Lib
  if (preg_match('/\.(dll|lib|o|so|a)$/i', $tmpfile)) {
    $mime = 'library';
    $imgmime = 'library.png';
    $famime = 'file-o';
  }
  // Err
  if (preg_match('/\.err$/i', $tmpfile)) {
    $mime = 'error';
    $imgmime = 'error.png';
    $famime = 'file-text-o';
  }
 
  // Return string
  if ($mode == 1) {
    $tmp = explode('/', $mime);
    return (!empty($tmp[1]) ? $tmp[1] : $tmp[0]);
  }
  if ($mode == 2) {
    return $imgmime;
  }
  if ($mode == 3) {
    return $srclang;
  }
  if ($mode == 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)
{
  global $conf;
 
  //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 && $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'] && !empty($conf->global->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)
{
  return (ceil($n) % $x === 0) ? ceil($n) : round(($n + $x / 2) / $x) * $x;
}
 
function dolGetBadge($label, $html = '', $type = 'primary', $mode = '', $url = '', $params = array())
{
  $attr = array(
    'class'=>'badge '.(!empty($mode) ? ' badge-'.$mode : '').(!empty($type) ? ' badge-'.$type : '').(empty($params['css']) ? '' : ' '.$params['css'])
  );
 
  if (empty($html)) {
    $html = $label;
  }
 
  if (!empty($url)) {
    $attr['href'] = $url;
  }
 
  if ($mode === 'dot') {
    $attr['class'] .= ' classfortooltip';
    $attr['title'] = $html;
    $attr['aria-label'] = $label;
    $html = '';
  }
 
  // Override attr
  if (!empty($params['attr']) && is_array($params['attr'])) {
    foreach ($params['attr'] as $key => $value) {
      if ($key == 'class') {
        $attr['class'] .= ' '.$value;
      } elseif ($key == 'classOverride') {
        $attr['class'] = $value;
      } else {
        $attr[$key] = $value;
      }
    }
  }
 
  // TODO: add hook
 
  // escape all attribute
  $attr = array_map('dol_escape_htmltag', $attr);
 
  $TCompiledAttr = array();
  foreach ($attr as $key => $value) {
    $TCompiledAttr[] = $key.'="'.$value.'"';
  }
 
  $compiledAttributes = !empty($TCompiledAttr) ?implode(' ', $TCompiledAttr) : '';
 
  $tag = !empty($url) ? 'a' : 'span';
 
  return '<'.$tag.' '.$compiledAttributes.'>'.$html.'</'.$tag.'>';
}
 
 
function dolGetStatus($statusLabel = '', $statusLabelShort = '', $html = '', $statusType = 'status0', $displayMode = 0, $url = '', $params = array())
{
  global $conf;
 
  $return = '';
  $dolGetBadgeParams = array();
 
  if (!empty($params['badgeParams'])) {
    $dolGetBadgeParams = $params['badgeParams'];
  }
 
  // TODO : add a hook
  if ($displayMode == 0) {
    $return = !empty($html) ? $html : (empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort));
  } elseif ($displayMode == 1) {
    $return = !empty($html) ? $html : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
  } elseif (!empty($conf->global->MAIN_STATUS_USES_IMAGES)) {
    // Use status with images (for backward compatibility)
    $return = '';
    $htmlLabel      = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : $statusLabel).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
    $htmlLabelShort = (in_array($displayMode, array(1, 2, 5)) ? '<span class="hideonsmartphone">' : '').(!empty($html) ? $html : (!empty($statusLabelShort) ? $statusLabelShort : $statusLabel)).(in_array($displayMode, array(1, 2, 5)) ? '</span>' : '');
 
    // For small screen, we always use the short label instead of long label.
    if (!empty($conf->dol_optimize_smallscreen)) {
      if ($displayMode == 0) {
        $displayMode = 1;
      } elseif ($displayMode == 4) {
        $displayMode = 2;
      } elseif ($displayMode == 6) {
        $displayMode = 5;
      }
    }
 
    // For backward compatibility. Image's filename are still in French, so we use this array to convert
    $statusImg = array(
      'status0' => 'statut0',
      'status1' => 'statut1',
      'status2' => 'statut2',
      'status3' => 'statut3',
      'status4' => 'statut4',
      'status5' => 'statut5',
      'status6' => 'statut6',
      'status7' => 'statut7',
      'status8' => 'statut8',
      'status9' => 'statut9'
    );
 
    if (!empty($statusImg[$statusType])) {
      $htmlImg = img_picto($statusLabel, $statusImg[$statusType]);
    } else {
      $htmlImg = img_picto($statusLabel, $statusType);
    }
 
    if ($displayMode === 2) {
      $return = $htmlImg.' '.$htmlLabelShort;
    } elseif ($displayMode === 3) {
      $return = $htmlImg;
    } elseif ($displayMode === 4) {
      $return = $htmlImg.' '.$htmlLabel;
    } elseif ($displayMode === 5) {
      $return = $htmlLabelShort.' '.$htmlImg;
    } else { // $displayMode >= 6
      $return = $htmlLabel.' '.$htmlImg;
    }
  } elseif (empty($conf->global->MAIN_STATUS_USES_IMAGES) && !empty($displayMode)) {
    // Use new badge
    $statusLabelShort = (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
 
    $dolGetBadgeParams['attr']['class'] = 'badge-status';
    $dolGetBadgeParams['attr']['title'] = empty($params['tooltip']) ? $statusLabel : ($params['tooltip'] != 'no' ? $params['tooltip'] : '');
 
    if ($displayMode == 3) {
      $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), '', $statusType, 'dot', $url, $dolGetBadgeParams);
    } elseif ($displayMode === 5) {
      $return = dolGetBadge($statusLabelShort, $html, $statusType, '', $url, $dolGetBadgeParams);
    } else {
      $return = dolGetBadge((empty($conf->dol_optimize_smallscreen) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), $html, $statusType, '', $url, $dolGetBadgeParams);
    }
  }
 
  return $return;
}
 
 
function dolGetButtonAction($label, $text = '', $actionType = 'default', $url = '', $id = '', $userRight = 1, $params = array())
{
  global $hookmanager, $action, $object, $langs;
 
  //var_dump($params);
  if (!empty($params['isDropdown']))
    $class = "dropdown-item";
  else {
    $class = 'butAction';
    if ($actionType == 'danger' || $actionType == 'delete') {
      $class = 'butActionDelete';
      if (!empty($url) && strpos($url, 'token=') === false) $url .= '&token='.newToken();
    }
  }
  $attr = array(
    'class' => $class,
    'href' => empty($url) ? '' : $url,
    'title' => $label
  );
 
  if (empty($text)) {
    $text = $label;
    $attr['title'] = ''; // if html not set, leave label on title is redundant
  } else {
    $attr['title'] = $label;
    $attr['aria-label'] = $label;
  }
 
  if (empty($userRight)) {
    $attr['class'] = 'butActionRefused';
    $attr['href'] = '';
    $attr['title'] = (($label && $text && $label != $text) ? $label : $langs->trans('NotEnoughPermissions'));
  }
 
  if (!empty($id)) {
    $attr['id'] = $id;
  }
 
  // Override attr
  if (!empty($params['attr']) && is_array($params['attr'])) {
    foreach ($params['attr'] as $key => $value) {
      if ($key == 'class') {
        $attr['class'] .= ' '.$value;
      } elseif ($key == 'classOverride') {
        $attr['class'] = $value;
      } else {
        $attr[$key] = $value;
      }
    }
  }
 
  // automatic add tooltip when title is detected
  if (!empty($attr['title']) && !empty($attr['class']) && strpos($attr['class'], 'classfortooltip') === false) {
    $attr['class'].= ' classfortooltip';
  }
 
  // Js Confirm button
  if ($userRight && !empty($params['confirm'])) {
    if (!is_array($params['confirm'])) {
      $params['confirm'] = array();
    }
 
    if (empty($params['confirm']['url'])) {
      $params['confirm']['url'] = $url . (strpos($url, '?') > 0 ? '&' : '?') . 'confirm=yes';
    }
 
    // for js desabled compatibility set $url as call to confirm action and $params['confirm']['url'] to confirmed action
    $attr['data-confirm-url'] = $params['confirm']['url'];
    $attr['data-confirm-title'] = !empty($params['confirm']['title']) ? $params['confirm']['title'] : $langs->trans('ConfirmBtnCommonTitle', $label);
    $attr['data-confirm-content'] = !empty($params['confirm']['content']) ? $params['confirm']['content'] : $langs->trans('ConfirmBtnCommonContent', $label);
    $attr['data-confirm-content'] = preg_replace("/\r|\n/", "", $attr['data-confirm-content']);
    $attr['data-confirm-action-btn-label'] = !empty($params['confirm']['action-btn-label']) ? $params['confirm']['action-btn-label'] : $langs->trans('Confirm');
    $attr['data-confirm-cancel-btn-label'] = !empty($params['confirm']['cancel-btn-label']) ? $params['confirm']['cancel-btn-label'] : $langs->trans('CloseDialog');
    $attr['data-confirm-modal'] = !empty($params['confirm']['modal']) ? $params['confirm']['modal'] : true;
 
    $attr['class'].= ' butActionConfirm';
  }
 
  if (isset($attr['href']) && empty($attr['href'])) {
    unset($attr['href']);
  }
 
  // escape all attribute
  $attr = array_map('dol_escape_htmltag', $attr);
 
  $TCompiledAttr = array();
  foreach ($attr as $key => $value) {
    $TCompiledAttr[] = $key.'= "'.$value.'"';
  }
 
  $compiledAttributes = empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr);
 
  $tag = !empty($attr['href']) ? 'a' : 'span';
 
 
  $parameters = array(
    'TCompiledAttr' => $TCompiledAttr,        // array
    'compiledAttributes' => $compiledAttributes,  // string
    'attr' => $attr,
    'tag' => $tag,
    'label' => $label,
    'html' => $text,
    'actionType' => $actionType,
    'url' => $url,
    'id' => $id,
    'userRight' => $userRight,
    'params' => $params
  );
 
  $reshook = $hookmanager->executeHooks('dolGetButtonAction', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
  if ($reshook < 0) setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
 
  if (empty($reshook)) {
    if (dol_textishtml($text)) {  // If content already HTML encoded
      return '<' . $tag . ' ' . $compiledAttributes . '>' . $text . '</' . $tag . '>';
    } else {
      return '<' . $tag . ' ' . $compiledAttributes . '>' . dol_escape_htmltag($text) . '</' . $tag . '>';
    }
  } else {
    return $hookmanager->resPrint;
  }
}
 
function dolGetButtonTitleSeparator($moreClass = "")
{
  return '<span class="button-title-separator '.$moreClass.'" ></span>';
}
 
function getFieldErrorIcon($fieldValidationErrorMsg)
{
  $out = '';
  if (!empty($fieldValidationErrorMsg)) {
    $out.= '<span class="field-error-icon classfortooltip" title="'.dol_escape_htmltag($fieldValidationErrorMsg, 1).'"  role="alert" >'; // role alert is used for accessibility
    $out.= '<span class="fa fa-exclamation-circle" aria-hidden="true" ></span>'; // For accessibility icon is separated and aria-hidden
    $out.= '</span>';
  }
 
  return $out;
}
 
function dolGetButtonTitle($label, $helpText = '', $iconClass = 'fa fa-file', $url = '', $id = '', $status = 1, $params = array())
{
  global $langs, $conf, $user;
 
  // Actually this conf is used in css too for external module compatibility and smooth transition to this function
  if (!empty($conf->global->MAIN_BUTTON_HIDE_UNAUTHORIZED) && (!$user->admin) && $status <= 0) {
    return '';
  }
 
  $class = 'btnTitle';
  if (in_array($iconClass, array('fa fa-plus-circle', 'fa fa-plus-circle size15x', 'fa fa-comment-dots', 'fa fa-paper-plane'))) {
    $class .= ' btnTitlePlus';
  }
  $useclassfortooltip = 1;
 
  if (!empty($params['morecss'])) {
    $class .= ' '.$params['morecss'];
  }
 
  $attr = array(
    'class' => $class,
    'href' => empty($url) ? '' : $url
  );
 
  if (!empty($helpText)) {
    $attr['title'] = dol_escape_htmltag($helpText);
  } elseif (empty($attr['title']) && $label) {
    $attr['title'] = $label;
    $useclassfortooltip = 0;
  }
 
  if ($status == 2) {
    $attr['class'] .= ' btnTitleSelected';
  } elseif ($status <= 0) {
    $attr['class'] .= ' refused';
 
    $attr['href'] = '';
 
    if ($status == -1) { // disable
      $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("FeatureDisabled"));
    } elseif ($status == 0) { // Not enough permissions
      $attr['title'] = dol_escape_htmltag($langs->transnoentitiesnoconv("NotEnoughPermissions"));
    }
  }
 
  if (!empty($attr['title']) && $useclassfortooltip) {
    $attr['class'] .= ' classfortooltip';
  }
 
  if (!empty($id)) {
    $attr['id'] = $id;
  }
 
  // Override attr
  if (!empty($params['attr']) && is_array($params['attr'])) {
    foreach ($params['attr'] as $key => $value) {
      if ($key == 'class') {
        $attr['class'] .= ' '.$value;
      } elseif ($key == 'classOverride') {
        $attr['class'] = $value;
      } else {
        $attr[$key] = $value;
      }
    }
  }
 
  if (isset($attr['href']) && empty($attr['href'])) {
    unset($attr['href']);
  }
 
  // TODO : add a hook
 
  // escape all attribute
  $attr = array_map('dol_escape_htmltag', $attr);
 
  $TCompiledAttr = array();
  foreach ($attr as $key => $value) {
    $TCompiledAttr[] = $key.'="'.$value.'"';
  }
 
  $compiledAttributes = (empty($TCompiledAttr) ? '' : implode(' ', $TCompiledAttr));
 
  $tag = (empty($attr['href']) ? 'span' : 'a');
 
  $button = '<'.$tag.' '.$compiledAttributes.'>';
  $button .= '<span class="'.$iconClass.' valignmiddle btnTitle-icon"></span>';
  if (!empty($params['forcenohideoftext'])) {
    $button .= '<span class="valignmiddle text-plus-circle btnTitle-label'.(empty($params['forcenohideoftext']) ? ' hideonsmartphone' : '').'">'.$label.'</span>';
  }
  $button .= '</'.$tag.'>';
 
  return $button;
}
 
function getElementProperties($element_type)
{
  $regs = array();
 
  $classfile = $classname = $classpath = '';
 
  // Parse element/subelement (ex: project_task)
  $module = $element_type;
  $element = $element_type;
  $subelement = $element_type;
 
  // If we ask an resource form external module (instead of default path)
  if (preg_match('/^([^@]+)@([^@]+)$/i', $element_type, $regs)) {
    $element = $subelement = $regs[1];
    $module = $regs[2];
  }
 
  //print '<br>1. element : '.$element.' - module : '.$module .'<br>';
  if (preg_match('/^([^_]+)_([^_]+)/i', $element, $regs)) {
    $module = $element = $regs[1];
    $subelement = $regs[2];
  }
 
  // For compat
  if ($element_type == "action") {
    $classpath = 'comm/action/class';
    $subelement = 'Actioncomm';
    $module = 'agenda';
  }
 
  // To work with non standard path
  if ($element_type == 'facture' || $element_type == 'invoice') {
    $classpath = 'compta/facture/class';
    $module = 'facture';
    $subelement = 'facture';
  }
  if ($element_type == 'commande' || $element_type == 'order') {
    $classpath = 'commande/class';
    $module = 'commande';
    $subelement = 'commande';
  }
  if ($element_type == 'propal') {
    $classpath = 'comm/propal/class';
  }
  if ($element_type == 'supplier_proposal') {
    $classpath = 'supplier_proposal/class';
  }
  if ($element_type == 'shipping') {
    $classpath = 'expedition/class';
    $subelement = 'expedition';
    $module = 'expedition_bon';
  }
  if ($element_type == 'delivery') {
    $classpath = 'delivery/class';
    $subelement = 'delivery';
    $module = 'delivery_note';
  }
  if ($element_type == 'contract') {
    $classpath = 'contrat/class';
    $module = 'contrat';
    $subelement = 'contrat';
  }
  if ($element_type == 'member') {
    $classpath = 'adherents/class';
    $module = 'adherent';
    $subelement = 'adherent';
  }
  if ($element_type == 'cabinetmed_cons') {
    $classpath = 'cabinetmed/class';
    $module = 'cabinetmed';
    $subelement = 'cabinetmedcons';
  }
  if ($element_type == 'fichinter') {
    $classpath = 'fichinter/class';
    $module = 'ficheinter';
    $subelement = 'fichinter';
  }
  if ($element_type == 'dolresource' || $element_type == 'resource') {
    $classpath = 'resource/class';
    $module = 'resource';
    $subelement = 'dolresource';
  }
  if ($element_type == 'propaldet') {
    $classpath = 'comm/propal/class';
    $module = 'propal';
    $subelement = 'propaleligne';
  }
  if ($element_type == 'order_supplier') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $subelement = 'commandefournisseur';
    $classfile = 'fournisseur.commande';
  }
  if ($element_type == 'invoice_supplier') {
    $classpath = 'fourn/class';
    $module = 'fournisseur';
    $subelement = 'facturefournisseur';
    $classfile = 'fournisseur.facture';
  }
  if ($element_type == "service") {
    $classpath = 'product/class';
    $subelement = 'product';
  }
 
  if (empty($classfile)) {
    $classfile = strtolower($subelement);
  }
  if (empty($classname)) {
    $classname = ucfirst($subelement);
  }
  if (empty($classpath)) {
    $classpath = $module.'/class';
  }
 
  $element_properties = array(
    'module' => $module,
    'classpath' => $classpath,
    'element' => $element,
    'subelement' => $subelement,
    'classfile' => $classfile,
    'classname' => $classname
  );
  return $element_properties;
}
 
function fetchObjectByElement($element_id, $element_type, $element_ref = '')
{
  global $conf, $db;
 
  $element_prop = getElementProperties($element_type);
  if (is_array($element_prop) && $conf->{$element_prop['module']}->enabled) {
    dol_include_once('/'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
 
    $objecttmp = new $element_prop['classname']($db);
    $ret = $objecttmp->fetch($element_id, $element_ref);
    if ($ret >= 0) {
      return $objecttmp;
    }
  }
  return 0;
}
 
function isAFileWithExecutableContent($filename)
{
  if (preg_match('/\.(htm|html|js|phar|php|php\d+|phtml|pht|pl|py|cgi|ksh|sh|shtml|bash|bat|cmd|wpk|exe|dmg)$/i', $filename)) {
    return true;
  }
 
  return false;
}
 
function newToken()
{
  return empty($_SESSION['newtoken']) ? '' : $_SESSION['newtoken'];
}
 
function currentToken()
{
  return isset($_SESSION['token']) ? $_SESSION['token'] : '';
}
 
function startSimpleTable($header, $link = "", $arguments = "", $emptyRows = 0, $number = -1)
{
  global $langs;
 
  print '<div class="div-table-responsive-no-min">';
  print '<table class="noborder centpercent">';
  print '<tr class="liste_titre">';
 
  print $emptyRows < 1 ? '<th>' : '<th colspan="'.($emptyRows + 1).'">';
 
  print $langs->trans($header);
 
  // extra space between the first header and the number
  if ($number > -1) {
    print ' ';
  }
 
  if (!empty($link)) {
    if (!empty($arguments)) {
      print '<a href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
    } else {
      print '<a href="'.DOL_URL_ROOT.'/'.$link.'">';
    }
  }
 
  if ($number > -1) {
    print '<span class="badge">'.$number.'</span>';
  }
 
  if (!empty($link)) {
    print '</a>';
  }
 
  print '</th>';
 
  if ($number < 0 && !empty($link)) {
    print '<th class="right">';
 
    if (!empty($arguments)) {
      print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'?'.$arguments.'">';
    } else {
      print '<a class="commonlink" href="'.DOL_URL_ROOT.'/'.$link.'">';
    }
 
    print $langs->trans("FullList");
    print '</a>';
    print '</th>';
  }
 
  print '</tr>';
}
 
function finishSimpleTable($addLineBreak = false)
{
  print '</table>';
  print '</div>';
 
  if ($addLineBreak) {
    print '<br>';
  }
}
 
function addSummaryTableLine($tableColumnCount, $num, $nbofloop = 0, $total = 0, $noneWord = "None", $extraRightColumn = false)
{
  global $langs;
 
  if ($num === 0) {
    print '<tr class="oddeven">';
    print '<td colspan="'.$tableColumnCount.'" class="opacitymedium">'.$langs->trans($noneWord).'</td>';
    print '</tr>';
    return;
  }
 
  if ($nbofloop === 0) {
    // don't show a summary line
    return;
  }
 
  if ($num === 0) {
    $colspan = $tableColumnCount;
  } elseif ($num > $nbofloop) {
    $colspan = $tableColumnCount;
  } else {
    $colspan = $tableColumnCount - 1;
  }
 
  if ($extraRightColumn) {
    $colspan--;
  }
 
  print '<tr class="liste_total">';
 
  if ($nbofloop > 0 && $num > $nbofloop) {
    print '<td colspan="'.$colspan.'" class="right">'.$langs->trans("XMoreLines", ($num - $nbofloop)).'</td>';
  } else {
    print '<td colspan="'.$colspan.'" class="right"> '.$langs->trans("Total").'</td>';
    print '<td class="right" width="100">'.price($total).'</td>';
  }
 
  if ($extraRightColumn) {
    print '<td></td>';
  }
 
  print '</tr>';
}
 
function readfileLowMemory($fullpath_original_file_osencoded, $method = -1)
{
  global $conf;
 
  if ($method == -1) {
    $method = 0;
    if (!empty($conf->global->MAIN_FORCE_READFILE_WITH_FREAD)) {
      $method = 1;
    }
    if (!empty($conf->global->MAIN_FORCE_READFILE_WITH_STREAM_COPY)) {
      $method = 2;
    }
  }
 
  // Be sure we don't have output buffering enabled to have readfile working correctly
  while (ob_get_level()) {
    ob_end_flush();
  }
 
  // 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 showValueWithClipboardCPButton($valuetocopy, $showonlyonhover = 1, $texttoshow = '')
{
  /*
  global $conf;
 
  if (!empty($conf->dol_no_mouse_hover)) {
    $showonlyonhover = 0;
  }*/
 
  $tag = 'span';  // Using div (like any style of type 'block') does not work when using the js copy code.
  if ($texttoshow === 'none') {
    $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint"></span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  } elseif ($texttoshow) {
    $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPValueToPrint">'.dol_escape_htmltag($texttoshow, 1, 1).'</span><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  } else {
    $result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'"><'.$tag.' class="clipboardCPValue">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'><span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft paddingright"></span><span class="clipboardCPText"></span></span>';
  }
 
  return $result;
}
 
 
function jsonOrUnserialize($stringtodecode)
{
  $result = json_decode($stringtodecode);
  if ($result === null) {
    $result = unserialize($stringtodecode);
  }
 
  return $result;
}
 
 
function dolCheckFilters($sqlfilters, &$error = '')
{
  //$regexstring='\‍(([^:\'\‍(\‍)]+:[^:\'\‍(\‍)]+:[^:\‍(\‍)]+)\‍)';
  //$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
  $tmp = $sqlfilters;
  $i = 0; $nb = strlen($tmp);
  $counter = 0;
  while ($i < $nb) {
    if ($tmp[$i] == '(') {
      $counter++;
    }
    if ($tmp[$i] == ')') {
      $counter--;
    }
    if ($counter < 0) {
      $error = "Bad sqlfilters=".$sqlfilters;
      dol_syslog($error, LOG_WARNING);
      return false;
    }
    $i++;
  }
  return true;
}
 
function dolForgeCriteriaCallback($matches)
{
  global $db;
 
  dol_syslog("Convert matches ".$matches[1]);
  if (empty($matches[1])) {
    return '';
  }
  $tmp = explode(':', $matches[1], 3);
 
  if (count($tmp) < 3) {
    return '';
  }
 
  $operand = preg_replace('/[^a-z0-9\._]/i', '', trim($tmp[0]));
 
  $operator = strtoupper(preg_replace('/[^a-z<>=]/i', '', trim($tmp[1])));
  if ($operator == 'NOTLIKE') {
    $operator = 'NOT LIKE';
  }
 
  $tmpescaped = trim($tmp[2]);
  $regbis = array();
  if ($operator == 'IN') {
    $tmpescaped = "(".$db->sanitize($tmpescaped, 1).")";
  } elseif (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
    $tmpescaped = "'".$db->escape($regbis[1])."'";
  } else {
    $tmpescaped = $db->sanitize($db->escape($tmpescaped));
  }
 
  return $db->escape($operand).' '.$db->escape($operator)." ".$tmpescaped;
}
 
 
 
function getTimelineIcon($actionstatic, &$histo, $key)
{
  global $conf, $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 (!empty($conf->global->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 $conf, $db;
 
  $documents = array();
 
  $sql = 'SELECT ecm.rowid as id, ecm.src_object_type, ecm.src_object_id, ecm.filepath, ecm.filename';
  $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 .= ' 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 show_actions_messaging($conf, $langs, $db, $filterobj, $objcon = '', $noprint = 0, $actioncode = '', $donetodo = 'done', $filters = array(), $sortfield = 'a.datep,a.id', $sortorder = 'DESC')
{
  global $user, $conf;
  global $form;
 
  global $param, $massactionbutton;
 
  dol_include_once('/comm/action/class/actioncomm.class.php');
 
  // Check parameters
  if (!is_object($filterobj) && !is_object($objcon)) {
    dol_print_error('', 'BadParameter');
  }
 
  $histo = array();
  $numaction = 0;
  $now = dol_now();
 
  $sortfield_list = explode(',', $sortfield);
  $sortfield_label_list = array('a.id' => 'id', 'a.datep' => 'dp', 'a.percent' => 'percent');
  $sortfield_new_list = array();
  foreach ($sortfield_list as $sortfield_value) {
    $sortfield_new_list[] = $sortfield_label_list[trim($sortfield_value)];
  }
  $sortfield_new = implode(',', $sortfield_new_list);
 
  if (isModEnabled('agenda')) {
    // Search histo on actioncomm
    if (is_object($objcon) && $objcon->id > 0) {
      $sql = "SELECT DISTINCT a.id, a.label as label,";
    } else {
      $sql = "SELECT a.id, a.label as label,";
    }
    $sql .= " a.datep as dp,";
    $sql .= " a.note as message,";
    $sql .= " a.datep2 as dp2,";
    $sql .= " a.percent as percent, 'action' as type,";
    $sql .= " a.fk_element, a.elementtype,";
    $sql .= " a.fk_contact,";
    $sql .= " c.code as acode, c.libelle as alabel, c.picto as apicto,";
    $sql .= " u.rowid as user_id, u.login as user_login, u.photo as user_photo, u.firstname as user_firstname, u.lastname as user_lastname";
    if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
      $sql .= ", sp.lastname, sp.firstname";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
      $sql .= ", m.lastname, m.firstname";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
      $sql .= ", o.ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
      $sql .= ", o.ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
      $sql .= ", o.ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
      $sql .= ", o.ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
      $sql .= ", o.ref";
    }
    $sql .= " FROM ".MAIN_DB_PREFIX."actioncomm as a";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."user as u on u.rowid = a.fk_user_action";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_actioncomm as c ON a.fk_action = c.id";
 
    $force_filter_contact = false;
    if (is_object($objcon) && $objcon->id > 0) {
      $force_filter_contact = true;
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."actioncomm_resources as r ON a.id = r.fk_actioncomm";
      $sql .= " AND r.element_type = '".$db->escape($objcon->table_element)."' AND r.fk_element = ".((int) $objcon->id);
    }
 
    if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
      $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."socpeople as sp ON a.fk_contact = sp.rowid";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Dolresource') {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."element_resources as er";
      $sql .= " ON er.resource_type = 'dolresource'";
      $sql .= " AND er.element_id = a.id";
      $sql .= " AND er.resource_id = ".((int) $filterobj->id);
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
      $sql .= ", ".MAIN_DB_PREFIX."adherent as m";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
      $sql .= ", ".MAIN_DB_PREFIX."commande_fournisseur as o";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
      $sql .= ", ".MAIN_DB_PREFIX."product as o";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
      $sql .= ", ".MAIN_DB_PREFIX."ticket as o";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
      $sql .= ", ".MAIN_DB_PREFIX."bom_bom as o";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
      $sql .= ", ".MAIN_DB_PREFIX."contrat as o";
    }
 
    $sql .= " WHERE a.entity IN (".getEntity('agenda').")";
    if ($force_filter_contact === false) {
      if (is_object($filterobj) && in_array(get_class($filterobj), array('Societe', 'Client', 'Fournisseur')) && $filterobj->id) {
        $sql .= " AND a.fk_soc = ".((int) $filterobj->id);
      } elseif (is_object($filterobj) && get_class($filterobj) == 'Project' && $filterobj->id) {
        $sql .= " AND a.fk_project = ".((int) $filterobj->id);
      } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
        $sql .= " AND a.fk_element = m.rowid AND a.elementtype = 'member'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
        $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'order_supplier'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
        $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'product'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
        $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'ticket'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      } elseif (is_object($filterobj) && get_class($filterobj) == 'BOM') {
        $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'bom'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      } elseif (is_object($filterobj) && get_class($filterobj) == 'Contrat') {
        $sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'contract'";
        if ($filterobj->id) {
          $sql .= " AND a.fk_element = ".((int) $filterobj->id);
        }
      }
    }
 
    // Condition on actioncode
    if (!empty($actioncode)) {
      if (empty($conf->global->AGENDA_USE_EVENT_TYPE)) {
        if ($actioncode == 'AC_NON_AUTO') {
          $sql .= " AND c.type != 'systemauto'";
        } elseif ($actioncode == 'AC_ALL_AUTO') {
          $sql .= " AND c.type = 'systemauto'";
        } else {
          if ($actioncode == 'AC_OTH') {
            $sql .= " AND c.type != 'systemauto'";
          } elseif ($actioncode == 'AC_OTH_AUTO') {
            $sql .= " AND c.type = 'systemauto'";
          }
        }
      } else {
        if ($actioncode == 'AC_NON_AUTO') {
          $sql .= " AND c.type != 'systemauto'";
        } elseif ($actioncode == 'AC_ALL_AUTO') {
          $sql .= " AND c.type = 'systemauto'";
        } else {
          $sql .= " AND c.code = '".$db->escape($actioncode)."'";
        }
      }
    }
    if ($donetodo == 'todo') {
      $sql .= " AND ((a.percent >= 0 AND a.percent < 100) OR (a.percent = -1 AND a.datep > '".$db->idate($now)."'))";
    } elseif ($donetodo == 'done') {
      $sql .= " AND (a.percent = 100 OR (a.percent = -1 AND a.datep <= '".$db->idate($now)."'))";
    }
    if (is_array($filters) && $filters['search_agenda_label']) {
      $sql .= natural_search('a.label', $filters['search_agenda_label']);
    }
  }
 
  // Add also event from emailings. TODO This should be replaced by an automatic event ? May be it's too much for very large emailing.
  if (isModEnabled('mailing') && !empty($objcon->email)
    && (empty($actioncode) || $actioncode == 'AC_OTH_AUTO' || $actioncode == 'AC_EMAILING')) {
    $langs->load("mails");
 
    $sql2 = "SELECT m.rowid as id, m.titre as label, mc.date_envoi as dp, mc.date_envoi as dp2, '100' as percent, 'mailing' as type";
    $sql2 .= ", null as fk_element, '' as elementtype, null as contact_id";
    $sql2 .= ", 'AC_EMAILING' as acode, '' as alabel, '' as apicto";
    $sql2 .= ", u.rowid as user_id, u.login as user_login, u.photo as user_photo, u.firstname as user_firstname, u.lastname as user_lastname"; // User that valid action
    if (is_object($filterobj) && get_class($filterobj) == 'Societe') {
      $sql2 .= ", '' as lastname, '' as firstname";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Adherent') {
      $sql2 .= ", '' as lastname, '' as firstname";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'CommandeFournisseur') {
      $sql2 .= ", '' as ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Product') {
      $sql2 .= ", '' as ref";
    } elseif (is_object($filterobj) && get_class($filterobj) == 'Ticket') {
      $sql2 .= ", '' as ref";
    }
    $sql2 .= " FROM ".MAIN_DB_PREFIX."mailing as m, ".MAIN_DB_PREFIX."mailing_cibles as mc, ".MAIN_DB_PREFIX."user as u";
    $sql2 .= " WHERE mc.email = '".$db->escape($objcon->email)."'"; // Search is done on email.
    $sql2 .= " AND mc.statut = 1";
    $sql2 .= " AND u.rowid = m.fk_user_valid";
    $sql2 .= " AND mc.fk_mailing=m.rowid";
  }
 
  if (!empty($sql) && !empty($sql2)) {
    $sql = $sql." UNION ".$sql2;
  } elseif (empty($sql) && !empty($sql2)) {
    $sql = $sql2;
  }
 
  // TODO Add limit in nb of results
  if ($sql) { // May not be defined if module Agenda is not enabled and mailing module disabled too
    $sql .= $db->order($sortfield_new, $sortorder);
 
    dol_syslog("function.lib::show_actions_messaging", LOG_DEBUG);
    $resql = $db->query($sql);
    if ($resql) {
      $i = 0;
      $num = $db->num_rows($resql);
 
      while ($i < $num) {
        $obj = $db->fetch_object($resql);
 
        if ($obj->type == 'action') {
          $contactaction = new ActionComm($db);
          $contactaction->id = $obj->id;
          $result = $contactaction->fetchResources();
          if ($result < 0) {
            dol_print_error($db);
            setEventMessage("actions.lib::show_actions_messaging Error fetch ressource", 'errors');
          }
 
          //if ($donetodo == 'todo') $sql.= " AND ((a.percent >= 0 AND a.percent < 100) OR (a.percent = -1 AND a.datep > '".$db->idate($now)."'))";
          //elseif ($donetodo == 'done') $sql.= " AND (a.percent = 100 OR (a.percent = -1 AND a.datep <= '".$db->idate($now)."'))";
          $tododone = '';
          if (($obj->percent >= 0 and $obj->percent < 100) || ($obj->percent == -1 && $obj->dp > $now)) {
            $tododone = 'todo';
          }
 
          $histo[$numaction] = array(
            'type'=>$obj->type,
            'tododone'=>$tododone,
            'id'=>$obj->id,
            'datestart'=>$db->jdate($obj->dp),
            'dateend'=>$db->jdate($obj->dp2),
            'note'=>$obj->label,
            'message'=>$obj->message,
            'percent'=>$obj->percent,
 
            'userid'=>$obj->user_id,
            'login'=>$obj->user_login,
            'userfirstname'=>$obj->user_firstname,
            'userlastname'=>$obj->user_lastname,
            'userphoto'=>$obj->user_photo,
 
            'contact_id'=>$obj->fk_contact,
            'socpeopleassigned' => $contactaction->socpeopleassigned,
            'lastname'=>$obj->lastname,
            'firstname'=>$obj->firstname,
            'fk_element'=>$obj->fk_element,
            'elementtype'=>$obj->elementtype,
            // Type of event
            'acode'=>$obj->acode,
            'alabel'=>$obj->alabel,
            'libelle'=>$obj->alabel, // deprecated
            'apicto'=>$obj->apicto
          );
        } else {
          $histo[$numaction] = array(
            'type'=>$obj->type,
            'tododone'=>'done',
            'id'=>$obj->id,
            'datestart'=>$db->jdate($obj->dp),
            'dateend'=>$db->jdate($obj->dp2),
            'note'=>$obj->label,
            'message'=>$obj->message,
            'percent'=>$obj->percent,
            'acode'=>$obj->acode,
 
            'userid'=>$obj->user_id,
            'login'=>$obj->user_login,
            'userfirstname'=>$obj->user_firstname,
            'userlastname'=>$obj->user_lastname,
            'userphoto'=>$obj->user_photo
          );
        }
 
        $numaction++;
        $i++;
      }
    } else {
      dol_print_error($db);
    }
  }
 
  // Set $out to show events
  $out = '';
 
  if (!isModEnabled('agenda')) {
    $langs->loadLangs(array("admin", "errors"));
    $out = info_admin($langs->trans("WarningModuleXDisabledSoYouMayMissEventHere", $langs->transnoentitiesnoconv("Module2400Name")), 0, 0, 'warning');
  }
 
  if (isModEnabled('agenda') || (isModEnabled('mailing') && !empty($objcon->email))) {
    $delay_warning = $conf->global->MAIN_DELAY_ACTIONS_TODO * 24 * 60 * 60;
 
    require_once DOL_DOCUMENT_ROOT.'/comm/action/class/actioncomm.class.php';
    include_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
    require_once DOL_DOCUMENT_ROOT.'/core/class/html.formactions.class.php';
    require_once DOL_DOCUMENT_ROOT.'/contact/class/contact.class.php';
 
    $formactions = new FormActions($db);
 
    $actionstatic = new ActionComm($db);
    $userstatic = new User($db);
    $contactstatic = new Contact($db);
    $userGetNomUrlCache = array();
 
    $out .= '<div class="filters-container" >';
    $out .= '<form name="listactionsfilter" class="listactionsfilter" action="'.$_SERVER["PHP_SELF"].'" method="POST">';
    $out .= '<input type="hidden" name="token" value="'.newToken().'">';
 
    if ($objcon && get_class($objcon) == 'Contact' &&
      (is_null($filterobj) || get_class($filterobj) == 'Societe')) {
      $out .= '<input type="hidden" name="id" value="'.$objcon->id.'" />';
    } else {
      $out .= '<input type="hidden" name="id" value="'.$filterobj->id.'" />';
    }
    if ($filterobj && get_class($filterobj) == 'Societe') {
      $out .= '<input type="hidden" name="socid" value="'.$filterobj->id.'" />';
    }
 
    $out .= "\n";
 
    $out .= '<div class="div-table-responsive-no-min">';
    $out .= '<table class="noborder borderbottom centpercent">';
 
    $out .= '<tr class="liste_titre">';
 
    $out .= getTitleFieldOfList('Date', 0, $_SERVER["PHP_SELF"], 'a.datep', '', $param, '', $sortfield, $sortorder, '')."\n";
 
    $out .= '<th class="liste_titre"><strong class="hideonsmartphone">'.$langs->trans("Search").' : </strong></th>';
    if ($donetodo) {
      $out .= '<th class="liste_titre"></th>';
    }
    $out .= '<th class="liste_titre">';
    $out .= '<span class="fas fa-square inline-block fawidth30" style=" color: #ddd;" title="'.$langs->trans("ActionType").'"></span>';
    //$out .= img_picto($langs->trans("Type"), 'type');
    $out .= $formactions->select_type_actions($actioncode, "actioncode", '', empty($conf->global->AGENDA_USE_EVENT_TYPE) ? 1 : -1, 0, 0, 1, 'minwidth200imp');
    $out .= '</th>';
    $out .= '<th class="liste_titre maxwidth100onsmartphone">';
    $out .= '<input type="text" class="maxwidth100onsmartphone" name="search_agenda_label" value="'.$filters['search_agenda_label'].'" placeholder="'.$langs->trans("Label").'">';
    $out .= '</th>';
 
    $out .= '<th class="liste_titre width50 middle">';
    $searchpicto = $form->showFilterAndCheckAddButtons($massactionbutton ? 1 : 0, 'checkforselect', 1);
    $out .= $searchpicto;
    $out .= '</th>';
    $out .= '</tr>';
 
 
    $out .= '</table>';
 
    $out .= '</form>';
    $out .= '</div>';
 
    $out .= "\n";
 
    $out .= '<ul class="timeline">';
 
    if ($donetodo) {
      $tmp = '';
      if (get_class($filterobj) == 'Societe') {
        $tmp .= '<a href="'.DOL_URL_ROOT.'/comm/action/list.php?mode=show_list&socid='.$filterobj->id.'&status=done">';
      }
      $tmp .= ($donetodo != 'done' ? $langs->trans("ActionsToDoShort") : '');
      $tmp .= ($donetodo != 'done' && $donetodo != 'todo' ? ' / ' : '');
      $tmp .= ($donetodo != 'todo' ? $langs->trans("ActionsDoneShort") : '');
      //$out.=$langs->trans("ActionsToDoShort").' / '.$langs->trans("ActionsDoneShort");
      if (get_class($filterobj) == 'Societe') {
        $tmp .= '</a>';
      }
      $out .= getTitleFieldOfList($tmp);
    }
 
 
    //require_once DOL_DOCUMENT_ROOT.'/comm/action/class/cactioncomm.class.php';
    //$caction=new CActionComm($db);
    //$arraylist=$caction->liste_array(1, 'code', '', (empty($conf->global->AGENDA_USE_EVENT_TYPE)?1:0), '', 1);
 
    $actualCycleDate = false;
 
    // Loop on each event to show it
    foreach ($histo as $key => $value) {
      $actionstatic->fetch($histo[$key]['id']); // TODO Do we need this, we already have a lot of data of line into $histo
 
      $actionstatic->type_picto = $histo[$key]['apicto'];
      $actionstatic->type_code = $histo[$key]['acode'];
 
      $url = DOL_URL_ROOT.'/comm/action/card.php?id='.$histo[$key]['id'];
 
      $tmpa = dol_getdate($histo[$key]['datestart'], false);
      if ($actualCycleDate !== $tmpa['year'].'-'.$tmpa['yday']) {
        $actualCycleDate = $tmpa['year'].'-'.$tmpa['yday'];
        $out .= '<!-- timeline time label -->';
        $out .= '<li class="time-label">';
        $out .= '<span class="timeline-badge-date">';
        $out .= dol_print_date($histo[$key]['datestart'], 'daytext', 'tzuserrel', $langs);
        $out .= '</span>';
        $out .= '</li>';
        $out .= '<!-- /.timeline-label -->';
      }
 
 
      $out .= '<!-- timeline item -->'."\n";
      $out .= '<li class="timeline-code-'.strtolower($actionstatic->code).'">';
 
      $out .= getTimelineIcon($actionstatic, $histo, $key);
 
      $out .= '<div class="timeline-item">'."\n";
 
      $out .= '<span class="timeline-header-action">';
 
      if (isset($histo[$key]['type']) && $histo[$key]['type'] == 'mailing') {
        $out .= '<a class="timeline-btn" href="'.DOL_URL_ROOT.'/comm/mailing/card.php?id='.$histo[$key]['id'].'">'.img_object($langs->trans("ShowEMailing"), "email").' ';
        $out .= $histo[$key]['id'];
        $out .= '</a> ';
      } else {
        $out .= $actionstatic->getNomUrl(1, -1, 'valignmiddle').' ';
      }
 
      if ($user->hasRight('agenda', 'allactions', 'create') ||
        (($actionstatic->authorid == $user->id || $actionstatic->userownerid == $user->id) && !empty($user->rights->agenda->myactions->create))) {
        $out .= '<a class="timeline-btn" href="'.DOL_MAIN_URL_ROOT.'/comm/action/card.php?action=edit&token='.newToken().'&id='.$actionstatic->id.'&backtopage='.urlencode($_SERVER["PHP_SELF"].'?'.$param).'"><i class="fa fa-pencil" title="'.$langs->trans("Modify").'" ></i></a>';
      }
 
      $out .= '</span>';
      // Date
      $out .= '<span class="time"><i class="fa fa-clock-o"></i> ';
      $out .= dol_print_date($histo[$key]['datestart'], 'dayhour', 'tzuserrel');
      if ($histo[$key]['dateend'] && $histo[$key]['dateend'] != $histo[$key]['datestart']) {
        $tmpa = dol_getdate($histo[$key]['datestart'], true);
        $tmpb = dol_getdate($histo[$key]['dateend'], true);
        if ($tmpa['mday'] == $tmpb['mday'] && $tmpa['mon'] == $tmpb['mon'] && $tmpa['year'] == $tmpb['year']) {
          $out .= '-'.dol_print_date($histo[$key]['dateend'], 'hour', 'tzuserrel');
        } else {
          $out .= '-'.dol_print_date($histo[$key]['dateend'], 'dayhour', 'tzuserrel');
        }
      }
      $late = 0;
      if ($histo[$key]['percent'] == 0 && $histo[$key]['datestart'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
        $late = 1;
      }
      if ($histo[$key]['percent'] == 0 && !$histo[$key]['datestart'] && $histo[$key]['dateend'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
        $late = 1;
      }
      if ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100 && $histo[$key]['dateend'] && $histo[$key]['dateend'] < ($now - $delay_warning)) {
        $late = 1;
      }
      if ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100 && !$histo[$key]['dateend'] && $histo[$key]['datestart'] && $histo[$key]['datestart'] < ($now - $delay_warning)) {
        $late = 1;
      }
      if ($late) {
        $out .= img_warning($langs->trans("Late")).' ';
      }
      $out .= "</span>\n";
 
      // Ref
      $out .= '<h3 class="timeline-header">';
 
      // Author of event
      $out .= '<span class="messaging-author">';
      if ($histo[$key]['userid'] > 0) {
        if (!isset($userGetNomUrlCache[$histo[$key]['userid']])) { // is in cache ?
          $userstatic->fetch($histo[$key]['userid']);
          $userGetNomUrlCache[$histo[$key]['userid']] = $userstatic->getNomUrl(-1, '', 0, 0, 16, 0, 'firstelselast', '');
        }
        $out .= $userGetNomUrlCache[$histo[$key]['userid']];
      }
      $out .= '</span>';
 
      // Title
      $out .= ' <span class="messaging-title">';
 
      if (preg_match('/^TICKET_MSG/', $actionstatic->code)) {
        $out .= $langs->trans('TicketNewMessage');
      } elseif (preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
        $out .= $langs->trans('TicketNewMessage').' <em>('.$langs->trans('Private').')</em>';
      } else {
        if (isset($histo[$key]['type']) && $histo[$key]['type'] == 'action') {
          $transcode = $langs->trans("Action".$histo[$key]['acode']);
          $libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : $histo[$key]['alabel']);
          $libelle = $histo[$key]['note'];
          $actionstatic->id = $histo[$key]['id'];
          $out .= dol_trunc($libelle, 120);
        }
        if (isset($histo[$key]['type']) && $histo[$key]['type'] == 'mailing') {
          $out .= '<a href="'.DOL_URL_ROOT.'/comm/mailing/card.php?id='.$histo[$key]['id'].'">'.img_object($langs->trans("ShowEMailing"), "email").' ';
          $transcode = $langs->trans("Action".$histo[$key]['acode']);
          $libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : 'Send mass mailing');
          $out .= dol_trunc($libelle, 120);
        }
      }
 
      $out .= '</span>';
 
      $out .= '</h3>';
 
      if (!empty($histo[$key]['message'])
        && $actionstatic->code != 'AC_TICKET_CREATE'
        && $actionstatic->code != 'AC_TICKET_MODIFY'
      ) {
        $out .= '<div class="timeline-body">';
        $out .= $histo[$key]['message'];
        $out .= '</div>';
      }
 
      // Timeline footer
      $footer = '';
 
      // Contact for this action
      if (isset($histo[$key]['socpeopleassigned']) && is_array($histo[$key]['socpeopleassigned']) && count($histo[$key]['socpeopleassigned']) > 0) {
        $contactList = '';
        foreach ($histo[$key]['socpeopleassigned'] as $cid => $Tab) {
          $contact = new Contact($db);
          $result = $contact->fetch($cid);
 
          if ($result < 0) {
            dol_print_error($db, $contact->error);
          }
 
          if ($result > 0) {
            $contactList .= !empty($contactList) ? ', ' : '';
            $contactList .= $contact->getNomUrl(1);
            if (isset($histo[$key]['acode']) && $histo[$key]['acode'] == 'AC_TEL') {
              if (!empty($contact->phone_pro)) {
                $contactList .= '('.dol_print_phone($contact->phone_pro).')';
              }
            }
          }
        }
 
        $footer .= $langs->trans('ActionOnContact').' : '.$contactList;
      } elseif (empty($objcon->id) && isset($histo[$key]['contact_id']) && $histo[$key]['contact_id'] > 0) {
        $contact = new Contact($db);
        $result = $contact->fetch($histo[$key]['contact_id']);
 
        if ($result < 0) {
          dol_print_error($db, $contact->error);
        }
 
        if ($result > 0) {
          $footer .= $contact->getNomUrl(1);
          if (isset($histo[$key]['acode']) && $histo[$key]['acode'] == 'AC_TEL') {
            if (!empty($contact->phone_pro)) {
              $footer .= '('.dol_print_phone($contact->phone_pro).')';
            }
          }
        }
      }
 
      $documents = getActionCommEcmList($actionstatic);
      if (!empty($documents)) {
        $footer .= '<div class="timeline-documents-container">';
        foreach ($documents as $doc) {
          $footer .= '<span id="document_'.$doc->id.'" class="timeline-documents" ';
          $footer .= ' data-id="'.$doc->id.'" ';
          $footer .= ' data-path="'.$doc->filepath.'"';
          $footer .= ' data-filename="'.dol_escape_htmltag($doc->filename).'" ';
          $footer .= '>';
 
          $filePath = DOL_DATA_ROOT.'/'.$doc->filepath.'/'.$doc->filename;
          $mime = dol_mimetype($filePath);
          $file = $actionstatic->id.'/'.$doc->filename;
          $thumb = $actionstatic->id.'/thumbs/'.substr($doc->filename, 0, strrpos($doc->filename, '.')).'_mini'.substr($doc->filename, strrpos($doc->filename, '.'));
          $doclink = dol_buildpath('document.php', 1).'?modulepart=actions&attachment=0&file='.urlencode($file).'&entity='.$conf->entity;
          $viewlink = dol_buildpath('viewimage.php', 1).'?modulepart=actions&file='.urlencode($thumb).'&entity='.$conf->entity;
 
          $mimeAttr = ' mime="'.$mime.'" ';
          $class = '';
          if (in_array($mime, array('image/png', 'image/jpeg', 'application/pdf'))) {
            $class .= ' documentpreview';
          }
 
          $footer .= '<a href="'.$doclink.'" class="btn-link '.$class.'" target="_blank" rel="noopener noreferrer" '.$mimeAttr.' >';
          $footer .= img_mime($filePath).' '.$doc->filename;
          $footer .= '</a>';
 
          $footer .= '</span>';
        }
        $footer .= '</div>';
      }
 
      if (!empty($footer)) {
        $out .= '<div class="timeline-footer">'.$footer.'</div>';
      }
 
      $out .= '</div>'."\n"; // end timeline-item
 
      $out .= '</li>';
      $out .= '<!-- END timeline item -->';
 
      $i++;
    }
 
    $out .= "</ul>\n";
 
    if (empty($histo)) {
      $out .= '<span class="opacitymedium">'.$langs->trans("NoRecordFound").'</span>';
    }
  }
 
  if ($noprint) {
    return $out;
  } else {
    print $out;
  }
}