File: /home4/cca63905/public_html/guiaweb/htdocs/core/lib/functions.lib.php
<?php
/* Copyright (C) 2000-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2003 Jean-Louis Bergamo <jlb@j1b.org>
* Copyright (C) 2004-2025 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
* Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
* Copyright (C) 2004 Christophe Combelles <ccomb@free.fr>
* Copyright (C) 2005-2019 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2008 Raphael Bertrand (Resultic) <raphael.bertrand@resultic.fr>
* Copyright (C) 2010-2018 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2013 Cédric Salvador <csalvador@gpcsolutions.fr>
* Copyright (C) 2013-2024 Alexandre Spangaro <alexandre@inovea-conseil.com>
* Copyright (C) 2014 Cédric GROSS <c.gross@kreiz-it.fr>
* Copyright (C) 2014-2015 Marcos García <marcosgdf@gmail.com>
* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2018-2025 Frédéric France <frederic.france@free.fr>
* Copyright (C) 2019-2023 Thibault Foucart <support@ptibogxiv.net>
* Copyright (C) 2020 Open-Dsi <support@open-dsi.fr>
* Copyright (C) 2021 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
* Copyright (C) 2022 Anthony Berton <anthony.berton@bb2a.fr>
* Copyright (C) 2022 Ferran Marcet <fmarcet@2byte.es>
* Copyright (C) 2022-2025 Charlene Benke <charlene@patas-monkey.com>
* Copyright (C) 2024-2025 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2023-2024 Joachim Kueter <git-jk@bloxera.com>
* Copyright (C) 2024 Lenin Rivas <lenin.rivas777@gmail.com>
* Copyright (C) 2024 Josep Lluís Amador Teruel <joseplluis@lliuretic.cat>
* Copyright (C) 2024 Benoît PASCAL <contact@p-ben.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
* or see https://www.gnu.org/
*/
/**
* \file htdocs/core/lib/functions.lib.php
* \brief A set of functions for Dolibarr
* This file contains all frequently used functions.
*/
//include_once DOL_DOCUMENT_ROOT.'/core/lib/json.lib.php';
// Function for better PHP x compatibility
if (!function_exists('utf8_encode')) {
/**
* Implement utf8_encode for PHP that does not support it.
*
* @param mixed $elements PHP Object to json encode
* @return string Json encoded string
* @phan-suppress PhanRedefineFunctionInternal
*/
function utf8_encode($elements)
{
return mb_convert_encoding($elements, 'UTF-8', 'ISO-8859-1');
}
}
if (!function_exists('utf8_decode')) {
/**
* Implement utf8_decode for PHP that does not support it.
*
* @param mixed $elements PHP Object to json encode
* @return string Json encoded string
* @phan-suppress PhanRedefineFunctionInternal
*/
function utf8_decode($elements)
{
return mb_convert_encoding($elements, 'ISO-8859-1', 'UTF-8');
}
}
if (!function_exists('str_starts_with')) {
/**
* str_starts_with
*
* @param string $haystack haystack
* @param string $needle needle
* @return boolean
* @phan-suppress PhanRedefineFunctionInternal
*/
function str_starts_with($haystack, $needle)
{
return (string) $needle !== '' && strncmp($haystack, $needle, strlen($needle)) === 0;
}
}
if (!function_exists('str_ends_with')) {
/**
* str_ends_with
*
* @param string $haystack haystack
* @param string $needle needle
* @return boolean
* @phan-suppress PhanRedefineFunctionInternal
*/
function str_ends_with($haystack, $needle)
{
return $needle !== '' && substr($haystack, -strlen($needle)) === (string) $needle;
}
}
if (!function_exists('str_contains')) {
/**
* str_contains
*
* @param string $haystack haystack
* @param string $needle needle
* @return boolean
* @phan-suppress PhanRedefineFunctionInternal
*/
function str_contains($haystack, $needle)
{
return $needle !== '' && mb_strpos($haystack, $needle) !== false;
}
}
/**
* Return the full path of the directory where a module (or an object of a module) stores its files.
* Path may depends on the entity if a multicompany module is enabled.
*
* @param CommonObject $object Dolibarr common object.
* @param string $module Override object element, for example to use 'mycompany' instead of 'societe'
* @param int $forobject Return the more complete path for the given object instead of for the module only.
* @param string $mode 'output' (full main dir) or 'outputrel' (relative dir) or 'temp' (full dir for temporary files) or 'version' (full dir for archived files)
* @return string|null The path of the relative directory of the module, ending with /
* @since Dolibarr V18
*/
function getMultidirOutput($object, $module = '', $forobject = 0, $mode = 'output')
{
global $conf;
if (!is_object($object) && empty($module)) {
return null;
}
if (empty($module) && !empty($object->element)) {
$module = $object->element;
}
// Special case for backward compatibility
if ($module == 'fichinter') {
$module = 'ficheinter';
} elseif ($module == 'invoice_supplier') {
$module = 'supplier_invoice';
} elseif ($module == 'order_supplier') {
$module = 'supplier_order';
}
// Get the relative path of directory
if ($mode == 'output' || $mode == 'outputrel' || $mode == 'version') {
if (isset($conf->$module) && property_exists($conf->$module, 'multidir_output')) {
$s = '';
if ($mode != 'outputrel') {
$s = $conf->$module->multidir_output[(empty($object->entity) ? $conf->entity : $object->entity)];
}
if ($forobject && $object->id > 0) {
$s .= ($mode != 'outputrel' ? '/' : '').get_exdir(0, 0, 0, 0, $object);
}
return $s;
} elseif (isset($conf->$module) && property_exists($conf->$module, 'dir_output')) {
$s = '';
if ($mode != 'outputrel') {
$s = $conf->$module->dir_output;
}
if ($forobject && $object->id > 0) {
$s .= ($mode != 'outputrel' ? '/' : '').get_exdir(0, 0, 0, 0, $object);
}
return $s;
} else {
return 'error-diroutput-not-defined-for-this-object='.$module;
}
} elseif ($mode == 'temp') {
if (isset($conf->$module) && property_exists($conf->$module, 'multidir_temp')) {
return $conf->$module->multidir_temp[(empty($object->entity) ? $conf->entity : $object->entity)];
} elseif (isset($conf->$module) && property_exists($conf->$module, 'dir_temp')) {
return $conf->$module->dir_temp;
} else {
return 'error-dirtemp-not-defined-for-this-object='.$module;
}
} else {
return 'error-bad-value-for-mode';
}
}
/**
* Return the full path of the directory where a module (or an object of a module) stores its temporary files.
* Path may depends on the entity if a multicompany module is enabled.
*
* @param CommonObject $object Dolibarr common object
* @param string $module Override object element, for example to use 'mycompany' instead of 'societe'
* @param int $forobject Return the more complete path for the given object instead of for the module only.
* @return string|null The path of the relative temp directory of the module
*/
function getMultidirTemp($object, $module = '', $forobject = 0)
{
return getMultidirOutput($object, $module, $forobject, 'temp');
}
/**
* Return the full path of the directory where a module (or an object of a module) stores its versioned files.
* Path may depends on the entity if a multicompany module is enabled.
*
* @param CommonObject $object Dolibarr common object
* @param string $module Override object element, for example to use 'mycompany' instead of 'societe'
* @param int $forobject Return the more complete path for the given object instead of for the module only.
* @return string|null The path of the relative version directory of the module
*/
function getMultidirVersion($object, $module = '', $forobject = 0)
{
return getMultidirOutput($object, $module, $forobject, 'version');
}
/**
* Return a Dolibarr global constant string value
*
* @param string $key Key to return value, return $default if not set
* @param string|int|float $default Value to return if not defined
* @return string Value returned
* @see getDolUserString()
*/
function getDolGlobalString($key, $default = '')
{
global $conf;
return (string) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
/**
* Return a Dolibarr global constant int value.
* The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.
*
* @param string $key Key to return value, return $default if not set
* @param int $default Value to return if not defined
* @return int Value returned
* @see getDolUserInt()
*/
function getDolGlobalInt($key, $default = 0)
{
global $conf;
return (int) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
/**
* Return a Dolibarr global constant float value.
* The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.
*
* @param string $key Key to return value, return $default if not set
* @param float $default Value to return if not defined
* @return float Value returned
* @see getDolUserInt()
*/
function getDolGlobalFloat($key, $default = 0)
{
global $conf;
return (float) (isset($conf->global->$key) ? $conf->global->$key : $default);
}
/**
* Return a Dolibarr global constant boolean value.
* The constants $conf->global->xxx are loaded by the script master.inc.php included at begin of any PHP page.
*
* @param string $key Key to return value, return $default if not set
* @param bool $default Value to return if not defined
* @return bool Value returned
*/
function getDolGlobalBool($key, $default = false)
{
global $conf;
return (bool) ($conf->global->$key ?? $default);
}
/**
* Return Dolibarr user constant string value
*
* @param string $key Key to return value, return '' if not set
* @param string|int|float $default Value to return
* @param User $tmpuser To get another user than current user
* @return string
* @see getDolGlobalString()
*/
function getDolUserString($key, $default = '', $tmpuser = null)
{
if (empty($tmpuser)) {
global $user;
$tmpuser = $user;
}
return (string) (isset($tmpuser->conf->$key) ? $tmpuser->conf->$key : $default);
}
/**
* Return Dolibarr user constant int value
*
* @param string $key Key to return value, return 0 if not set
* @param int $default Value to return
* @param User $tmpuser To get another user than current user
* @return int
*/
function getDolUserInt($key, $default = 0, $tmpuser = null)
{
if (empty($tmpuser)) {
global $user;
$tmpuser = $user;
}
return (int) (isset($tmpuser->conf->$key) ? $tmpuser->conf->$key : $default);
}
/**
* This mapping defines the conversion to the current internal
* names from the alternative allowed names (including effectively deprecated
* and future new names (not yet used as internal names).
*
* This allows to map any temporary or future name to the effective internal name.
*
* The value is typically the name of module's root directory.
*/
define(
'MODULE_MAPPING',
array(
// Map deprecated names to new names
'adherent' => 'member', // Has new directory
'member_type' => 'adherent_type', // No directory, but file called adherent_type
'banque' => 'bank', // Has new directory
'contrat' => 'contract', // Has new directory
'entrepot' => 'stock', // Has new directory
'projet' => 'project', // Has new directory
'categorie' => 'category', // Has old directory
'commande' => 'order', // Has old directory
'expedition' => 'shipping', // Has old directory
'facture' => 'invoice', // Has old directory
'fichinter' => 'intervention', // Has old directory
'ficheinter' => 'intervention', // Backup for 'fichinter'
'propale' => 'propal', // Has old directory
'socpeople' => 'contact', // Has old directory
'fournisseur' => 'supplier', // Has old directory
'actioncomm' => 'agenda', // NO module directory (public dir agenda)
'product_price' => 'productprice', // NO directory
'product_fournisseur_price' => 'productsupplierprice', // NO directory
)
);
/**
* Is Dolibarr module enabled
*
* @param string $module Module name to check
* @return boolean True if module is enabled
*/
function isModEnabled($module)
{
global $conf;
// Fix old names (map to new names)
$arrayconv = MODULE_MAPPING;
$arrayconvbis = array_flip(MODULE_MAPPING);
if (!getDolGlobalString('MAIN_USE_NEW_SUPPLIERMOD')) {
// Special cases: both use the same module.
$arrayconv['supplier_order'] = 'fournisseur';
$arrayconv['supplier_invoice'] = 'fournisseur';
}
// Special case.
// @TODO Replace isModEnabled('delivery_note') with
// isModEnabled('shipping') && getDolGlobalString('MAIN_SUBMODULE_EXPEDITION')
if ($module == 'delivery_note') {
if (!getDolGlobalString('MAIN_SUBMODULE_EXPEDITION')) {
return false;
} else {
$module = 'shipping';
}
}
$module_alt = $module;
if (!empty($arrayconv[$module])) {
$module_alt = $arrayconv[$module];
}
$module_bis = $module;
if (!empty($arrayconvbis[$module])) {
$module_bis = $arrayconvbis[$module];
}
return !empty($conf->modules[$module]) || !empty($conf->modules[$module_alt]) || !empty($conf->modules[$module_bis]);
//return !empty($conf->$module->enabled);
}
/**
* Return a warning delay
* You can use it like this: if (getWarningDelay('module', 'paramlevel1'))
* It replaces old syntax: if ($conf->module->user->rights->module->level1)
*
* @param string $module Module of permission to check (Example: 'bank', 'contrat', ...)
* @param string $parmlevel1 Parameter level1 (Example: 'rappro', 'services', ...)
* @param string $parmlevel2 Parameter level2 (Example: 'inactifs', ...)
* @return int Return the warning delay
*/
function getWarningDelay($module, $parmlevel1, $parmlevel2 = '')
{
global $conf;
// For compatibility with bad naming on module
$moduletomoduletouse = array(
'invoice' => 'facture',
);
$moduleParmsMapping = array(
'product' => 'produit',
);
if (!empty($moduletomoduletouse[$module])) {
$module = $moduletomoduletouse[$module];
}
$warningDelayPath = $parmlevel1;
if (!empty($moduleParmsMapping[$warningDelayPath])) {
$warningDelayPath = $moduleParmsMapping[$warningDelayPath];
}
if ($parmlevel2) {
if (!empty($conf->$module->$warningDelayPath->warning_delay)) {
if (!empty($conf->$module->$warningDelayPath->$parmlevel2->warning_delay)) {
return (int) $conf->$module->$warningDelayPath->$parmlevel2->warning_delay;
}
}
} else {
if (!empty($conf->$module->$warningDelayPath->warning_delay)) {
return (int) $conf->$module->$warningDelayPath->$parmlevel1->warning_delay;
}
}
return 0;
}
/**
* isDolTms check if a timestamp is valid.
*
* @param int|string|null $timestamp timestamp to check
* @return bool
*/
function isDolTms($timestamp)
{
if ($timestamp === '') {
dol_syslog('Using empty string for a timestamp is deprecated, prefer use of null when calling page '.$_SERVER["PHP_SELF"] . getCallerInfoString(), LOG_NOTICE);
return false;
}
if (is_null($timestamp) || !is_numeric($timestamp)) {
return false;
}
return true;
}
/**
* Return a DoliDB instance (database handler).
*
* @param string $type Type of database (mysql, pgsql...)
* @param string $host Address of database server
* @param string $user Authorized username
* @param string $pass Password (clear)
* @param string $name Name of database
* @param int $port Port of database server
* @return DoliDB A DoliDB instance
*/
function getDoliDBInstance($type, $host, $user, $pass, $name, $port)
{
require_once DOL_DOCUMENT_ROOT."/core/db/".$type.'.class.php';
$class = 'DoliDB'.ucfirst($type);
$db = new $class($type, $host, $user, $pass, $name, $port);
return $db;
}
/**
* Get list of entity id to use.
*
* @param string $element Current element
* 'societe', 'socpeople', 'actioncomm', 'agenda', 'resource',
* 'product', 'productprice', 'stock', 'bom', 'mo',
* 'propal', 'supplier_proposal', 'invoice', 'supplier_invoice', 'payment_various',
* 'categorie', 'bank_account', 'bank_account', 'adherent', 'user',
* 'commande', 'supplier_order', 'expedition', 'intervention', 'survey',
* 'contract', 'tax', 'expensereport', 'holiday', 'multicurrency', 'project',
* 'email_template', 'event', 'donation'
* 'c_paiement', 'c_payment_term', ...
* @param int<0,1> $shared 0=Return id of current entity only,
* 1=Return id of current entity + shared entities (default)
* @param ?CommonObject $currentobject Current object if needed
* @return string Entity id(s) to use ( eg. entity IN ('.getEntity(elementname).')' )
*/
function getEntity($element, $shared = 1, $currentobject = null)
{
global $conf, $mc, $hookmanager, $object, $action, $db;
if (!is_object($hookmanager)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($db);
}
// fix different element names (France to English)
switch ($element) {
case 'projet':
$element = 'project';
break;
case 'contrat':
$element = 'contract';
break; // "/contrat/class/contrat.class.php"
case 'order_supplier':
$element = 'supplier_order';
break; // "/fourn/class/fournisseur.commande.class.php"
case 'invoice_supplier':
$element = 'supplier_invoice';
break; // "/fourn/class/fournisseur.facture.class.php"
}
if (is_object($mc)) {
$out = $mc->getEntity($element, $shared, $currentobject);
} else {
$out = '';
$addzero = array('user', 'usergroup', 'cronjob', 'c_email_templates', 'email_template', 'default_values', 'overwrite_trans');
if (getDolGlobalString('HOLIDAY_ALLOW_ZERO_IN_DIC')) { // this constant break the dictionary admin without Multicompany
$addzero[] = 'c_holiday_types';
}
if (in_array($element, $addzero)) {
$out .= '0,';
}
$out .= ((int) $conf->entity);
}
// Manipulate entities to query on the fly
$parameters = array(
'element' => $element,
'shared' => $shared,
'object' => $object,
'currentobject' => $currentobject,
'out' => $out
);
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
$reshook = $hookmanager->executeHooks('hookGetEntity', $parameters, $currentobject, $action); // Note that $action and $object may have been modified by some hooks
if (is_numeric($reshook)) {
if ($reshook == 0 && !empty($hookmanager->resPrint)) {
$out .= ','.$hookmanager->resPrint; // add
} elseif ($reshook == 1) {
$out = $hookmanager->resPrint; // replace
}
}
return $out;
}
/**
* Set entity id to use when to create an object
*
* @param CommonObject $currentobject Current object
* @return int Entity id to use ( eg. entity = '.setEntity($object) )
*/
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);
}
}
/**
* Return if string has a name dedicated to store a secret
*
* @param string $keyname Name of key to test
* @return boolean True if key is used to store a secret
*/
function isASecretKey($keyname)
{
return preg_match('/(_pass|password|_pw|_key|securekey|serverkey|secret\d?|p12key|exportkey|_PW_[a-z]+|token)$/i', $keyname);
}
/**
* Return a numeric value into an Excel like column number. So 0 return 'A', 1 returns 'B'..., 26 return 'AA'
*
* @param int|string $n Numeric value
* @return string Column in Excel format
*/
function num2Alpha($n)
{
for ($r = ""; $n >= 0; $n = intval($n / 26) - 1) {
$r = chr($n % 26 + 0x41) . $r;
}
return $r;
}
/**
* Return information about user browser
*
* Returns array with the following format:
* array(
* 'browsername' => Browser name (firefox|chrome|iceweasel|epiphany|safari|opera|ie|unknown)
* 'browserversion' => Browser version. Empty if unknown
* 'browseros' => Set with mobile OS (android|blackberry|ios|palm|symbian|webos|maemo|windows|unknown)
* 'layout' => (tablet|phone|classic)
* 'phone' => empty if not mobile, (android|blackberry|ios|palm|unknown) if mobile
* 'tablet' => true/false
* )
*
* @param string $user_agent Content of $_SERVER["HTTP_USER_AGENT"] variable
* @return array{browsername:string,browserversion:string,browseros:string,browserua:string,layout:string,phone:string,tablet:bool} Check function documentation
*/
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 = 'textbrowser';
$version = empty($reg[3]) ? '' : $reg[3];
} elseif (preg_match('/w3m\/([\d\.]+)/i', $user_agent, $reg)) {
// MS products at end
$name = 'textbrowser';
$version = empty($reg[1]) ? '' : $reg[1];
}
if ($tablet) {
$layout = 'tablet';
} elseif ($phone) {
$layout = 'phone';
} else {
$layout = 'classic';
}
return array(
'browsername' => $name,
'browserversion' => $version,
'browseros' => $os,
'browserua' => $user_agent,
'layout' => $layout, // tablet, phone, classic
'phone' => $phone, // deprecated
'tablet' => $tablet // deprecated
);
}
/**
* Function called at end of web php process
*
* @return void
*/
function dol_shutdown()
{
global $db;
$disconnectdone = false;
$depth = 0;
if (is_object($db) && !empty($db->connected)) {
$depth = $db->transaction_opened;
$disconnectdone = $db->close();
}
dol_syslog("--- End access to ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]).(($disconnectdone && $depth) ? ' (Warn: db disconnection forced, transaction depth was '.$depth.')' : ''), (($disconnectdone && $depth) ? LOG_WARNING : LOG_INFO));
}
/**
* Return true if we are in a context of submitting the parameter $paramname from a POST of a form.
* Warning:
* For action=add, use: $var = GETPOST('var'); // No GETPOSTISSET, so GETPOST always called and default value is retrieved if not a form POST, and value of form is retrieved if it is a form POST.
* For action=update, use: $var = GETPOSTISSET('var') ? GETPOST('var') : $object->var;
*
* @param string $paramname Name or parameter to test
* @return boolean True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
*/
function GETPOSTISSET($paramname)
{
$isset = false;
$relativepathstring = $_SERVER["PHP_SELF"];
// Clean $relativepathstring
if (constant('DOL_URL_ROOT')) {
$relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
}
$relativepathstring = ltrim($relativepathstring, '/');
$relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
//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;
}
/**
* Return true if the parameter $paramname is submit from a POST OR GET as an array.
* Can be used before GETPOST to know if the $check param of GETPOST need to check an array or a string
*
* @param string $paramname Name or parameter to test
* @param int<0,3> $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
* @return bool True if we have just submit a POST or GET request with the parameter provided (even if param is empty)
*/
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);
}
/**
* Return value of a param into GET or POST supervariable.
* Use the property $user->default_values[path]['createform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
* Note: The property $user->default_values is loaded by main.php when loading the user.
*
* @param string $paramname Name of parameter to found
* @param string $check Type of check
* '' or 'none'=no check (deprecated)
* 'password'=allow characters for a password
* 'email'=allow characters for an email "email@domain.com"
* 'url'=allow characters for an url
* 'array', 'array:restricthtml' or 'array:aZ09' to check it's an array
* 'int'=check it's numeric (integer or float)
* 'intcomma'=check it's integer+comma ('1,2,3,4...')
* 'alphanohtml'=check there is no html content and no " and no ../ ('alpha' is an alias of 'alphanohtml')
* 'alphawithlgt'=alpha with lgt and no " and no ../ (Can be used for email string like "Name <email@domain.com>")
* 'aZ'=check it's a-z only
* 'aZ09'=check it's simple alpha string (recommended for keys)
* 'aZ09arobase'=check it's a string for an element type ('myobject@mymodule')
* 'aZ09comma'=check it's a string for a sortfield or sortorder
* 'san_alpha'=Use filter_var with FILTER_SANITIZE_STRING (do not use this for free text string)
* 'nohtml'=check there is no html content
* 'restricthtml'=check html content is restricted to some tags only
* 'custom'= custom filter specify $filter and $options)
* @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get)
* @param ?int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
* @param mixed $options Options to pass to filter_var when $check is set to 'custom'
* @param int $noreplace Force disable of replacement of __xxx__ strings.
* @return string|array<mixed> Value found (string or array), or '' if check fails
*/
function GETPOST($paramname, $check = 'alphanohtml', $method = 0, $filter = null, $options = null, $noreplace = 0)
{
global $mysoc, $user, $conf;
if (empty($paramname)) { // Explicit test for null for phan.
return 'BadFirstParameterForGETPOST';
}
if (empty($check)) {
dol_syslog("Deprecated use of GETPOST, called with 1st param = ".$paramname." and a 2nd param that is '', when calling page ".$_SERVER["PHP_SELF"], LOG_WARNING);
// Enable this line to know who call the GETPOST with '' $check parameter.
//var_dump(getCallerInfoString());
}
if (empty($method)) {
$out = isset($_GET[$paramname]) ? $_GET[$paramname] : (isset($_POST[$paramname]) ? $_POST[$paramname] : '');
} elseif ($method == 1) {
$out = isset($_GET[$paramname]) ? $_GET[$paramname] : '';
} elseif ($method == 2) {
$out = isset($_POST[$paramname]) ? $_POST[$paramname] : '';
} elseif ($method == 3) {
$out = isset($_POST[$paramname]) ? $_POST[$paramname] : (isset($_GET[$paramname]) ? $_GET[$paramname] : '');
} else {
return 'BadThirdParameterForGETPOST';
}
$relativepathstring = ''; // For static analysis - looks possibly undefined if not set.
if (empty($method) || $method == 3 || $method == 4) {
$relativepathstring = (empty($_SERVER["PHP_SELF"]) ? '' : $_SERVER["PHP_SELF"]);
// Clean $relativepathstring
if (constant('DOL_URL_ROOT')) {
$relativepathstring = preg_replace('/^'.preg_quote(constant('DOL_URL_ROOT'), '/').'/', '', $relativepathstring);
}
$relativepathstring = ltrim($relativepathstring, '/');
$relativepathstring = preg_replace('/^custom\//', '', $relativepathstring);
//var_dump($relativepathstring);
//var_dump($user->default_values);
// Code for search criteria persistence.
// Retrieve saved values if restore_lastsearch_values is set
if (!empty($_GET['restore_lastsearch_values'])) { // Use $_GET here and not GETPOST
if (!empty($_SESSION['lastsearch_values_'.$relativepathstring])) { // If there is saved values
$tmp = json_decode($_SESSION['lastsearch_values_'.$relativepathstring], true);
if (is_array($tmp)) {
foreach ($tmp as $key => $val) {
if ($key == $paramname) { // We are on the requested parameter
$out = $val;
break;
}
}
}
}
// If there is saved contextpage, page or limit
if ($paramname == 'contextpage' && !empty($_SESSION['lastsearch_contextpage_'.$relativepathstring])) {
$out = $_SESSION['lastsearch_contextpage_'.$relativepathstring];
} elseif ($paramname == 'limit' && !empty($_SESSION['lastsearch_limit_'.$relativepathstring])) {
$out = $_SESSION['lastsearch_limit_'.$relativepathstring];
} elseif ($paramname == 'page' && !empty($_SESSION['lastsearch_page_'.$relativepathstring])) {
$out = $_SESSION['lastsearch_page_'.$relativepathstring];
} elseif ($paramname == 'mode' && !empty($_SESSION['lastsearch_mode_'.$relativepathstring])) {
$out = $_SESSION['lastsearch_mode_'.$relativepathstring];
}
} elseif (!isset($_GET['sortfield'])) {
// Else, retrieve default values if we are not doing a sort
// If we did a click on a field to sort, we do no apply default values. Same if option MAIN_ENABLE_DEFAULT_VALUES is not set
if (!empty($_GET['action']) && $_GET['action'] == 'create' && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
// Search default value from $object->field
global $object;
'@phan-var-force CommonObject $object'; // Suppose it's a CommonObject for analysis, but other objects have the $fields field as well
if (is_object($object) && isset($object->fields[$paramname]['default'])) {
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
$out = $object->fields[$paramname]['default'];
}
}
if (getDolGlobalString('MAIN_ENABLE_DEFAULT_VALUES')) {
if (!empty($_GET['action']) && (preg_match('/^create/', $_GET['action']) || preg_match('/^presend/', $_GET['action'])) && !isset($_GET[$paramname]) && !isset($_POST[$paramname])) {
// Now search in setup to overwrite default values
if (!empty($user->default_values)) { // $user->default_values defined from menu 'Setup - Default values'
if (isset($user->default_values[$relativepathstring]['createform'])) {
foreach ($user->default_values[$relativepathstring]['createform'] as $defkey => $defval) {
$qualified = 0;
if ($defkey != '_noquery_') {
$tmpqueryarraytohave = explode('&', $defkey);
$tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
$foundintru = 0;
foreach ($tmpqueryarraytohave as $tmpquerytohave) {
if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
$foundintru = 1;
}
}
if (!$foundintru) {
$qualified = 1;
}
//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 really useful ?)
}
}
}
} elseif (isset($user->default_values[$relativepathstring]['filters'])) {
foreach ($user->default_values[$relativepathstring]['filters'] as $defkey => $defval) { // $defkey is a querystring like 'a=b&c=d', $defval is key of user
if (!empty($_GET['disabledefaultvalues'])) { // If set of default values has been disabled by a request parameter
continue;
}
$qualified = 0;
if ($defkey != '_noquery_') {
$tmpqueryarraytohave = explode('&', $defkey);
$tmpqueryarraywehave = explode('&', dol_string_nohtmltag($_SERVER['QUERY_STRING']));
$foundintru = 0;
foreach ($tmpqueryarraytohave as $tmpquerytohave) {
if (!in_array($tmpquerytohave, $tmpqueryarraywehave)) {
$foundintru = 1;
}
}
if (!$foundintru) {
$qualified = 1;
}
//var_dump($defkey.'-'.$qualified);
} else {
$qualified = 1;
}
if ($qualified && isset($user->default_values[$relativepathstring]['filters'][$defkey][$paramname])) {
// We must keep $_POST and $_GET here
if (isset($_POST['search_all']) || isset($_GET['search_all'])) {
// We made a search from quick search menu, do we still use default filter ?
if (!getDolGlobalString('MAIN_DISABLE_DEFAULT_FILTER_FOR_QUICK_SEARCH')) {
$forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
$out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
}
} else {
$forbidden_chars_to_replace = array(" ", "'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ";", "="); // we accept _, -, . and ,
$out = dol_string_nospecial($user->default_values[$relativepathstring]['filters'][$defkey][$paramname], '', $forbidden_chars_to_replace);
}
break;
}
}
}
}
}
}
}
}
// Substitution variables for GETPOST (used to get final url with variable parameters or final default value, when using variable parameters __XXX__ in the GET URL)
// Example of variables: __DAY__, __MONTH__, __YEAR__, __MYCOMPANY_COUNTRY_ID__, __USER_ID__, ...
// We do this only if var is a GET. If it is a POST, may be we want to post the text with vars as the setup text.
'@phan-var-force string $paramname';
if (!is_array($out) && empty($_POST[$paramname]) && empty($noreplace)) {
$reg = array();
$regreplace = array();
$maxloop = 20;
$loopnb = 0; // Protection against infinite loop
while (preg_match('/__([A-Z0-9]+(?:_[A-Z0-9]+){0,3})__/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;
} elseif ($reg[1] == 'ID') {
$newout = '__ID__'; // We keep __ID__ we find into backtopage url
} else {
$newout = 'REGREPLACE_'.$loopnb; // Key not found, we replace with temporary string to reload later
$regreplace[$loopnb] = $reg[0];
}
//var_dump('__'.$reg[1].'__ -> '.$newout);
$out = preg_replace('/__'.preg_quote($reg[1], '/').'__/', $newout, $out);
}
if (!empty($regreplace)) {
foreach ($regreplace as $key => $value) {
$out = preg_replace('/REGREPLACE_'.$key.'/', $value, $out);
}
}
}
// Check type of variable and make sanitization according to this
if (preg_match('/^array/', $check)) { // If 'array' or 'array:restricthtml' or 'array:aZ09' or 'array:intcomma'
$tmpcheck = 'alphanohtml';
if (empty($out)) {
$out = array();
} elseif (!is_array($out)) {
$out = explode(',', $out);
} else {
$tmparray = explode(':', $check);
if (!empty($tmparray[1])) {
$tmpcheck = $tmparray[1];
}
}
foreach ($out as $outkey => $outval) {
$out[$outkey] = sanitizeVal($outval, $tmpcheck, $filter, $options);
}
} else {
// If field name is 'search_xxx' then we force the add of space after each < and > (when following char is numeric) because it means
// we use the < or > to make a search on a numeric value to do higher or lower so we can add a space to break html tags
if (strpos($paramname, 'search_') === 0) {
$out = preg_replace('/([<>])([-+]?\d)/', '\1 \2', $out);
}
// @phan-suppress-next-line UnknownSanitizeType
$out = sanitizeVal($out, $check, $filter, $options);
}
// Sanitizing for special parameters.
// Note: There is no reason to allow the backtopage/backtopageforcancel/backtopagejs, backtolist or backtourl parameter to contains an external URL. Only relative URLs are allowed.
// @TODO Merge backtopage with backtourl
// @TODO Rename backtolist into backtopagelist
if (preg_match('/^backto/i', $paramname)) {
$out = str_replace('\\', '/', $out); // Can be before the loop because only 1 char is replaced. No risk to get it after other replacements.
$out = str_replace(array(':', ';', '@', "\t", ' '), '', $out); // Can be before the loop because only 1 char is replaced. No risk to retrieve it after other replacements.
do {
$oldstringtoclean = $out;
$out = str_ireplace(array('javascript', 'vbscript', '&colon', '&#'), '', $out);
$out = preg_replace(array('/^[^\?]*%/'), '', $out); // We remove any % chars before the ?. Example in url: '/product/stock/card.php?action=create&backtopage=%2Fdolibarr_dev%2Fhtdocs%2Fpro%25duct%2Fcard.php%3Fid%3Dabc'
$out = preg_replace(array('/^[a-z]*\/\s*\/+/i'), '', $out); // We remove schema*// to remove external URL
} while ($oldstringtoclean != $out);
}
// Code for search criteria persistence.
// Save data into session if key start with 'search_'
if (empty($method) || $method == 3 || $method == 4) {
if (preg_match('/^search_/', $paramname) || in_array($paramname, array('sortorder', 'sortfield'))) {
//var_dump($paramname.' - '.$out.' '.$user->default_values[$relativepathstring]['filters'][$paramname]);
// We save search key only if $out not empty that means:
// - posted value not empty, or
// - if posted value is empty and a default value exists that is not empty (it means we did a filter to an empty value when default was not).
if ($out != '' && isset($user)) {// $out = '0' or 'abc', it is a search criteria to keep
$user->lastsearch_values_tmp[$relativepathstring][$paramname] = $out;
}
}
}
return $out;
}
/**
* Return the value of a $_GET or $_POST supervariable, converted into integer.
* Use the property $user->default_values[path]['creatform'] and/or $user->default_values[path]['filters'] and/or $user->default_values[path]['sortorder']
* Note: The property $user->default_values is loaded by main.php when loading the user.
*
* @param string $paramname Name of the $_GET or $_POST parameter
* @param int<0,3> $method Type of method (0 = $_GET then $_POST, 1 = only $_GET, 2 = only $_POST, 3 = $_POST then $_GET)
* @return int Value converted into integer
*/
function GETPOSTINT($paramname, $method = 0)
{
return (int) GETPOST($paramname, 'int', $method, null, null, 0);
}
/**
* Return the value of a $_GET or $_POST supervariable, converted into float.
*
* @param string $paramname Name of the $_GET or $_POST parameter
* @param ''|'MU'|'MT'|'MS'|'CU'|'CT'|int $rounding Type of rounding ('', 'MU', 'MT, 'MS', 'CU', 'CT', integer) {@see price2num()}
* @return float Value converted into float
* @since Dolibarr V20
*/
function GETPOSTFLOAT($paramname, $rounding = '')
{
// price2num() is used to sanitize any valid user input (such as "1 234.5", "1 234,5", "1'234,5", "1·234,5", "1,234.5", etc.)
return (float) price2num(GETPOST($paramname), $rounding, 2);
}
/**
* Helper function that combines values of a dolibarr DatePicker (such as Form::selectDate) for year, month, day (and
* optionally hour, minute, second) fields to return a timestamp.
*
* @param string $prefix Prefix used to build the date selector (for instance using Form::selectDate). Example: 'select_datec'
* @param string $hourTime 'getpost' or 'getpostend' to include hour, minute, second values from the HTTP request,
* or 'XX:YY:ZZ' to set hour, minute, second respectively, for example '23:59:59'
* or 'end' means '23:59:59'
* or '' means '00:00:00' (default)
* @param int|string $gm Passed to dol_mktime. In most cases, when used with 'getpost' or 'getpostend', it should be 'tzuserrel'. Use 'auto' if you need dates related to 'tzserver' (like in accountancy).
* @param string $saverestore Use a string family context to save retrieved date so it will be used on the next retrieval for the same family context (if value not already defined in parameters).
* @return int|string Date as a timestamp, '' or false if error
*
* @see dol_mktime()
*/
function GETPOSTDATE($prefix, $hourTime = '', $gm = 'auto', $saverestore = '')
{
$m = array();
if ($hourTime === 'getpost' || $hourTime === 'getpostend') {
$hour = (GETPOSTISSET($prefix . 'hour') && GETPOSTINT($prefix . 'hour') >= 0) ? GETPOSTINT($prefix . 'hour') : ($hourTime === 'getpostend' ? 23 : 0);
$minute = (GETPOSTISSET($prefix . 'min') && GETPOSTINT($prefix . 'min') >= 0) ? GETPOSTINT($prefix . 'min') : ($hourTime === 'getpostend' ? 59 : 0);
$second = (GETPOSTISSET($prefix . 'second') && GETPOSTINT($prefix . 'second') >= 0) ? GETPOSTINT($prefix . 'second') : ($hourTime === 'getpostend' ? 59 : 0);
} elseif (preg_match('/^(\d\d):(\d\d):(\d\d)$/', $hourTime, $m)) {
$hour = intval($m[1]);
$minute = intval($m[2]);
$second = intval($m[3]);
} elseif ($hourTime === 'end') {
$hour = 23;
$minute = 59;
$second = 59;
} else {
$hour = $minute = $second = 0;
}
if ($saverestore && !GETPOSTISSET($prefix.'day') && !GETPOSTISSET($prefix.'month') && !GETPOSTISSET($prefix.'year')) {
$day = $_SESSION['DOLDATE_'.$saverestore.'_day'];
$month = $_SESSION['DOLDATE_'.$saverestore.'_month'];
$year = $_SESSION['DOLDATE_'.$saverestore.'_year'];
} else {
$month = GETPOSTINT($prefix . 'month');
$day = GETPOSTINT($prefix . 'day');
$year = GETPOSTINT($prefix . 'year');
}
// normalize out of range values
$hour = (int) min($hour, 23);
$minute = (int) min($minute, 59);
$second = (int) min($second, 59);
if ($saverestore) {
$_SESSION['DOLDATE_'.$saverestore.'_day'] = $day;
$_SESSION['DOLDATE_'.$saverestore.'_month'] = $month;
$_SESSION['DOLDATE_'.$saverestore.'_year'] = $year;
}
//print "$hour, $minute, $second, $month, $day, $year, $gm<br>";
return dol_mktime($hour, $minute, $second, $month, $day, $year, $gm);
}
/**
* Return a sanitized or empty value after checking value against a rule.
*
* @param string|array<mixed> $out Value to check/clear.
* @param string $check Type of check/sanitizing
* @param ?int $filter Filter to apply when $check is set to 'custom'. (See http://php.net/manual/en/filter.filters.php for détails)
* @param ?mixed $options Options to pass to filter_var when $check is set to 'custom'
* @return string|array<mixed> Value sanitized (string or array). It may be '' if format check fails.
* @deprecated
*/
function checkVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
{
return sanitizeVal($out, $check, $filter, $options);
}
/**
* Return a sanitized or empty value after checking value against a rule.
*
* @param string|mixed[]|null $out Value to check/clear.
* @param string $check Type of check/sanitizing
* @param ?int $filter Filter to apply when $check is set to 'custom' (deprecated). (See http://php.net/manual/en/filter.filters.php for détails)
* @param ?mixed $options Options to pass to filter_var when $check is set to 'custom'
* @return string|array<mixed> Value sanitized (string or array). It may be '' if format check fails.
*/
function sanitizeVal($out = '', $check = 'alphanohtml', $filter = null, $options = null)
{
// TODO : use class "Validate" to perform tests (and add missing tests) if needed for factorize
// Check is done after replacement
if ($out === null) {
$out = '';
}
switch ($check) {
case 'none':
case 'password':
break;
case 'int': // Check param is a numeric value (integer but also float or hexadecimal)
if (!is_numeric($out)) {
$out = '';
}
break;
case 'intcomma':
if (is_array($out)) {
$out = implode(',', $out);
}
if (preg_match('/[^0-9,-]+/i', $out)) {
$out = '';
}
break;
case 'san_alpha':
$out = filter_var($out, FILTER_SANITIZE_STRING);
break;
case 'email':
$out = filter_var($out, FILTER_SANITIZE_EMAIL);
break;
case 'url':
//$out = filter_var($out, FILTER_SANITIZE_URL); // Not reliable, replaced with FILTER_VALIDATE_URL
$out = preg_replace('/[^:\/\[\]a-z0-9@\$\'\*\~\.\-_,;\?\!=%&+#]+/i', '', $out);
// TODO Allow ( ) but only into password of https://login:password@domain...
break;
case 'aZ':
if (!is_array($out)) {
$out = trim($out);
if (preg_match('/[^a-z]+/i', $out)) {
$out = '';
}
}
break;
case 'aZ09':
if (!is_array($out)) {
$out = trim($out);
if (preg_match('/[^a-z0-9_\-\.]+/i', $out)) {
$out = '';
}
}
break;
case 'aZ09arobase': // great to sanitize $objecttype parameter
if (!is_array($out)) {
$out = trim($out);
if (preg_match('/[^a-z0-9_\-\.@]+/i', $out)) {
$out = '';
}
}
break;
case 'aZ09comma': // great to sanitize $sortfield or $sortorder params that can be 't.abc,t.def_gh'
if (!is_array($out)) {
$out = trim($out);
if (preg_match('/[^a-z0-9_\-\.,]+/i', $out)) {
$out = '';
}
}
break;
case 'alpha': // No html and no ../ and "
case 'alphanohtml': // Recommended for most scalar parameters and search parameters. Not valid for json string.
if (!is_array($out)) {
$out = trim($out);
do {
$oldstringtoclean = $out;
// Remove html tags
$out = dol_string_nohtmltag($out, 0);
// Refuse octal syntax \999, hexa syntax \x999 and unicode syntax \u{999} by replacing the \ into / (so if it is a \ for a windows path, it is still ok).
$out = preg_replace('/\\\([0-9xu])/', '/\1', $out);
// Remove also other dangerous string sequences
// '../' or '..\' is dangerous because it allows dir transversals
// '&', '&', '&'... is a the char '&' alone but there is no reason to accept such way to encode input char
// '"' = '"' = '"' = '"' is dangerous because param in url can close the href= or src= and add javascript functions.
// '/', '/', '/' is the char '/' but there is no reason to accept such way to encode this input char
// '\' = '\' = '\' is the char '\' but there is no reason to accept such way to encode this input char
$out = str_ireplace(array('../', '..\\', '&', '&', '&', '"', '"', '"', '"', '"', '/', '/', '/', '\', '\', '\'), '', $out);
} while ($oldstringtoclean != $out);
// keep lines feed
}
break;
case 'alphawithlgt': // No " and no ../ but we keep balanced < > tags with no special chars inside. Can be used for email string like "Name <email@domain.com>". Less secured than 'alphanohtml'
if (!is_array($out)) {
$out = trim($out);
do {
$oldstringtoclean = $out;
// Decode html entities
$out = dol_html_entity_decode($out, ENT_COMPAT | ENT_HTML5, 'UTF-8');
// Refuse octal syntax \999, hexa syntax \x999 and unicode syntax \u{999} by replacing the \ into / (so if it is a \ for a windows path, it is still ok).
$out = preg_replace('/\\\([0-9xu])/', '/\1', $out);
// Remove also other dangerous string sequences
// '../' or '..\' is dangerous because it allows dir transversals
// '&', '&', '&'... is a the char '&' alone but there is no reason to accept such way to encode input char
// '"' = '"' = '"' = '"' is dangerous because param in url can close the href= or src= and add javascript functions.
// '/', '/', '/' is the char '/' but there is no reason to accept such way to encode this input char
// '\' = '\' = '\' is the char '\' but there is no reason to accept such way to encode this input char
$out = str_ireplace(array('../', '..\\', '&', '&', '&', '"', '"', '"', '"', '"', '/', '/', '/', '\', '\', '\'), '', $out);
} while ($oldstringtoclean != $out);
}
break;
case 'nohtml': // No html. Valid for JSON strings.
$out = dol_string_nohtmltag($out, 0);
break;
case 'restricthtmlnolink':
case 'restricthtml': // Recommended for most html textarea
case 'restricthtmlallowclass':
case 'restricthtmlallowiframe':
case 'restricthtmlallowlinkscript': // Allow link and script tag for head section.
case 'restricthtmlallowunvalid':
$out = dol_htmlwithnojs($out, 1, $check);
break;
case 'custom':
if (!empty($out)) {
if (empty($filter)) {
return 'BadParameterForGETPOST - Param 3 of sanitizeVal()';
}
if (is_null($options)) {
$options = 0;
}
$out = filter_var($out, $filter, $options);
}
break;
default:
dol_syslog("Error, you call sanitizeVal() with a bad value for the check type. Data will be sanitized with alphanohtml.", LOG_ERR);
$out = GETPOST($out, 'alphanohtml');
break;
}
return $out;
}
/**
* Set a cookie
*
* @param string $cookiename Cookie name
* @param string $cookievalue Cookie value
* @param int $expire Expire delay. If 0, expire at end of session. -1 means 1 year.
* @return void
*/
function dolSetCookie(string $cookiename, string $cookievalue, int $expire = -1)
{
global $dolibarr_main_force_https;
if ($expire == -1) {
$expire = (time() + (86400 * 354)); // keep cookie 1 year.
}
if (PHP_VERSION_ID < 70300) {
setcookie($cookiename, empty($cookievalue) ? '' : $cookievalue, empty($cookievalue) ? 0 : $expire, '/', '', !(empty($dolibarr_main_force_https) && isHTTPS() === false), true); // add tag httponly
} else {
// Only available for php >= 7.3
$cookieparams = array(
'expires' => empty($cookievalue) ? 0 : $expire,
'path' => '/',
//'domain' => '.mywebsite.com', // the dot at the beginning allows compatibility with subdomains
'secure' => !(empty($dolibarr_main_force_https) && isHTTPS() === false),
'httponly' => true,
'samesite' => 'Lax' // None || Lax || Strict
);
setcookie($cookiename, empty($cookievalue) ? '' : $cookievalue, $cookieparams);
}
if (empty($cookievalue)) {
unset($_COOKIE[$cookiename]);
}
}
if (!function_exists('dol_getprefix')) {
/**
* Return a prefix to use for this Dolibarr instance, for session/cookie names or email id.
* The prefix is unique for instance and avoid conflict between multi-instances, even when having two instances with same root dir
* or two instances in same virtual servers.
* This function must not use dol_hash (that is used for password hash) and need to have all context $conf loaded.
*
* @param string $mode '' (prefix for session name) or 'email' (prefix for email id)
* @return string A calculated prefix
* @phan-suppress PhanRedefineFunction - Also defined in webportal.main.inc.php
*/
function dol_getprefix($mode = '')
{
// If prefix is for email (we need to have $conf already loaded for this case)
if ($mode == 'email') {
global $conf;
if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID')) { // If MAIL_PREFIX_FOR_EMAIL_ID is set
if (getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID') != 'SERVER_NAME') {
return getDolGlobalString('MAIL_PREFIX_FOR_EMAIL_ID');
} elseif (isset($_SERVER["SERVER_NAME"])) { // If MAIL_PREFIX_FOR_EMAIL_ID is set to 'SERVER_NAME'
return $_SERVER["SERVER_NAME"];
}
}
// The recommended value if MAIL_PREFIX_FOR_EMAIL_ID is not defined (may be not defined for old versions)
if (!empty($conf->file->instance_unique_id)) {
return sha1('dolibarr'.$conf->file->instance_unique_id);
}
// For backward compatibility when instance_unique_id is not set
return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
}
// If prefix is for session (no need to have $conf loaded)
global $dolibarr_main_instance_unique_id, $dolibarr_main_cookie_cryptkey; // This is loaded by filefunc.inc.php
$tmp_instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; // Unique id of instance
// The recommended value (may be not defined for old versions)
if (!empty($tmp_instance_unique_id)) {
return sha1('dolibarr'.$tmp_instance_unique_id);
}
// For backward compatibility when instance_unique_id is not set
if (isset($_SERVER["SERVER_NAME"]) && isset($_SERVER["DOCUMENT_ROOT"])) {
return sha1($_SERVER["SERVER_NAME"].$_SERVER["DOCUMENT_ROOT"].DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
} else {
return sha1(DOL_DOCUMENT_ROOT.DOL_URL_ROOT);
}
}
}
/**
* Make an include_once using default root and alternate root if it fails.
* To link to a core file, use include(DOL_DOCUMENT_ROOT.'/pathtofile')
* To link to a module file from a module file, use include './mymodulefile';
* To link to a module file from a core file, then this function can be used (call by hook / trigger / speciales pages)
*
* @param string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...)
* @param string $classname Class name (deprecated)
* @return bool True if load is a success, False if it fails
*/
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;
}
}
/**
* Return path of url or filesystem. Can check into alternate dir or alternate dir + main dir depending on value of $returnemptyifnotfound.
*
* @param string $path Relative path to file (if mode=0) or relative url (if mode=1). Ie: mydir/myfile, ../myfile
* @param int $type 0=Used for a Filesystem path,
* 1=Used for an URL path (output relative),
* 2=Used for an URL path (output full path using same host that current url),
* 3=Used for an URL path (output full path using host defined into $dolibarr_main_url_root of conf file, for an access from internet)
* @param int $returnemptyifnotfound 0:If $type==0 and if file was not found into alternate dir, return default path into main dir (no test on it)
* 1:If $type==0 and if file was not found into alternate dir, return empty string
* 2:If $type==0 and if file was not found into alternate dir, test into main dir, return default path if found, empty string if not found
* @return string Full filesystem path (if path=0) or '' if file not found, Full url path (if mode=1)
*/
function dol_buildpath($path, $type = 0, $returnemptyifnotfound = 0)
{
global $conf;
$path = preg_replace('/^\//', '', $path);
if (empty($type)) { // For a filesystem path
$res = DOL_DOCUMENT_ROOT.'/'.$path; // Standard default path
if (is_array($conf->file->dol_document_root)) {
foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array("main"=>"/home/main/htdocs", "alt0"=>"/home/dirmod/htdocs", ...)
if ($key == 'main') {
continue;
}
// if (@file_exists($dirroot.'/'.$path)) {
if (@file_exists($dirroot.'/'.$path)) { // avoid [php:warn]
$res = $dirroot.'/'.$path;
return $res;
}
}
}
if ($returnemptyifnotfound) {
// Not found into alternate dir
if ($returnemptyifnotfound == 1 || !file_exists($res)) {
return '';
}
}
} else {
// For an url path
// We try to get local path of file on filesystem from url
// Note that trying to know if a file on disk exist by forging path on disk from url
// works only for some web server and some setup. This is bugged when
// using proxy, rewriting, virtual path, etc...
$res = '';
if ($type == 1) {
$res = DOL_URL_ROOT.'/'.$path; // Standard value
}
if ($type == 2) {
$res = DOL_MAIN_URL_ROOT.'/'.$path; // Standard value
}
if ($type == 3) {
$res = DOL_URL_ROOT.'/'.$path;
}
foreach ($conf->file->dol_document_root as $key => $dirroot) { // ex: array(["main"]=>"/home/main/htdocs", ["alt0"]=>"/home/dirmod/htdocs", ...)
if ($key == 'main') {
if ($type == 3) {
/*global $dolibarr_main_url_root;*/
// Define $urlwithroot
$urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($conf->file->dol_main_url_root));
$urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
//$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
$res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot).'/'.$path; // Test on start with http is for old conf syntax
}
continue;
}
$regs = array();
preg_match('/^([^\?]+(\.css\.php|\.css|\.js\.php|\.js|\.png|\.jpg|\.php)?)/i', $path, $regs); // Take part before '?'
if (!empty($regs[1])) {
//print $key.'-'.$dirroot.'/'.$path.'-'.$conf->file->dol_url_root[$type].'<br>'."\n";
//if (file_exists($dirroot.'/'.$regs[1])) {
if (@file_exists($dirroot.'/'.$regs[1])) { // avoid [php:warn]
if ($type == 1) {
$res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
} elseif ($type == 2) {
$res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : DOL_MAIN_URL_ROOT).$conf->file->dol_url_root[$key].'/'.$path;
} elseif ($type == 3) {
/*global $dolibarr_main_url_root;*/
// Define $urlwithroot
$urlwithouturlroot = preg_replace('/'.preg_quote(DOL_URL_ROOT, '/').'$/i', '', trim($conf->file->dol_main_url_root));
$urlwithroot = $urlwithouturlroot.DOL_URL_ROOT; // This is to use external domain name found into config file
//$urlwithroot=DOL_MAIN_URL_ROOT; // This is to use same domain name than current
$res = (preg_match('/^http/i', $conf->file->dol_url_root[$key]) ? '' : $urlwithroot).$conf->file->dol_url_root[$key].'/'.$path; // Test on start with http is for old conf syntax
}
break;
}
}
}
}
return $res;
}
/**
* Get properties for an object - including magic properties when requested
*
* Only returns properties that exist
*
* @param object $obj Object to get properties from
* @param string[] $properties Optional list of properties to get.
* When empty, only gets public properties.
* @return array<string,mixed> Hash for retrieved values (key=name)
*/
function dol_get_object_properties($obj, $properties = [])
{
// Get real properties using get_object_vars() if $properties is empty
if (empty($properties)) {
return get_object_vars($obj);
}
$existingProperties = [];
$realProperties = get_object_vars($obj);
// Get the real or magic property values
foreach ($properties as $property) {
if (array_key_exists($property, $realProperties)) {
// Real property, add the value
$existingProperties[$property] = $obj->{$property};
} elseif (property_exists($obj, $property)) {
// Magic property
$existingProperties[$property] = $obj->{$property};
}
}
return $existingProperties;
}
/**
* Create a clone of instance of object (new instance with same value for each properties)
* With native = 0: Property that are references are different memory area in the new object (full isolation clone). This means $this->object of new object may not be valid (except this->db that is voluntarly kept).
* With native = 1: Use PHP clone. Property that are reference are same pointer. This means $this->db of new object is still valid but point to same this->db than original object.
* With native = 2: Property that are reference are different memory area in the new object (full isolation clone). Only scalar and array values are cloned. This means method are not availables and $this->db of new object is not valid.
*
* @template T
*
* @param T $object Object to clone
* @param int $native 0=Full isolation method, 1=Native PHP method, 2=Full isolation method keeping only scalar and array properties (recommended)
* @return T Clone object
*
* @see https://php.net/manual/language.oop5.cloning.php
* @phan-suppress PhanTypeExpectedObjectPropAccess
*/
function dol_clone($object, $native = 2)
{
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 (referring to the same target/variable)
}
return $myclone;
}
/**
* Optimize a size for some browsers (phone, smarphone...)
*
* @param int $size Size we want
* @param string $type Type of optimizing:
* '' = function used to define a size for truncation
* 'width' = function is used to define a width
* @return int New size after optimizing
*/
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;
}
}
/**
* Clean a string to use it as a file name.
* Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' is allowed).
*
* @param string $str String to clean
* @param string $newstr String to replace bad chars with.
* @param int $unaccent 1=Remove also accent (default), 0 do not remove them
* @param int $includequotes 1=Include simple quotes (double is already included by default)
* @return string String cleaned
*
* @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizePathName()
*/
function dol_sanitizeFileName($str, $newstr = '_', $unaccent = 1, $includequotes = 0)
{
// List of special chars for filenames in windows are defined on page https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
// Char '>' '<' '|' '$' and ';' are special chars for shells.
// Char '/' and '\' are file delimiters.
// Chars '--' can be used into filename to inject special parameters like --use-compress-program to make command with file as parameter making remote execution of command
$filesystem_forbidden_chars = array('<', '>', '/', '\\', '?', '*', '|', '"', ':', '°', '$', ';', '`');
if ($includequotes) {
$filesystem_forbidden_chars[] = "'";
}
$tmp = dol_string_nospecial($unaccent ? dol_string_unaccent($str) : $str, $newstr, $filesystem_forbidden_chars);
$tmp = preg_replace('/\-\-+/', '_', $tmp);
$tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
$tmp = preg_replace('/\s+\-$/', '', $tmp);
$tmp = str_replace('..', '', $tmp);
return $tmp;
}
/**
* Clean a string to use it as a path name. Similar to dol_sanitizeFileName but accept / and \ chars.
* Replace also '--' and ' -' strings, they are used for parameters separation (Note: ' - ' and 'x-y' is allowed).
*
* @param string $str String to clean
* @param string $newstr String to replace bad chars with
* @param int $unaccent 1=Remove also accent (default), 0 do not remove them
* @return string String cleaned
*
* @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitizeFileName()
*/
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 parameters like --use-compress-program to make command with file as parameter making remote execution of command
$filesystem_forbidden_chars = array('<', '>', '?', '*', '|', '"', '°', '$', ';', '`');
$tmp = $str;
if ($unaccent) {
$tmp = dol_string_unaccent($tmp);
}
$tmp = dol_string_nospecial($tmp, $newstr, $filesystem_forbidden_chars);
$tmp = preg_replace('/\-\-+/', '_', $tmp);
$tmp = preg_replace('/\s+\-([^\s])/', ' _$1', $tmp);
$tmp = preg_replace('/\s+\-$/', '', $tmp);
$tmp = str_replace('..', '', $tmp);
return $tmp;
}
/**
* Clean a string to use it as an URL (into a href or src attribute)
*
* @param string $stringtoclean String to clean
* @param int $type 0=Accept all Url, 1=Clean external Url (keep only relative Url)
* @return string Escaped string.
*/
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;
}
/**
* Clean a string to use it as an Email.
*
* @param string $stringtoclean String to clean. Example 'abc@mycompany.com <My name>'
* @return string Escaped string.
*/
function dol_sanitizeEmail($stringtoclean)
{
do {
$oldstringtoclean = $stringtoclean;
$stringtoclean = str_ireplace(array('"', ':', '[', ']',"\n", "\r", '\\', '\/'), '', $stringtoclean);
} while ($oldstringtoclean != $stringtoclean);
return $stringtoclean;
}
/**
* Clean a string to use it as a key or code. So only char a-Z, A-Z, _ and 0-9 is kept.
*
* @param string $str String to clean
* @return string String cleaned (a-zA-Z_)
*
* @see dol_string_nospecial(), dol_string_unaccent(), dol_sanitize...()
*/
function dol_sanitizeKeyCode($str)
{
return preg_replace('/[^\w]+/', '', $str);
}
/**
* Clean a string from all accent characters to be used as ref, login or by dol_sanitizeFileName
*
* @param string $str String to clean. Must be an ascii or utf8 string without any htmlentities.
* @return string Cleaned string
*
* @see dol_sanitizeFilename(), dol_string_nospecial()
*/
function dol_string_unaccent($str)
{
if (is_null($str)) {
return '';
}
if (utf8_check($str)) {
if (extension_loaded('intl') && getDolGlobalString('MAIN_UNACCENT_USE_TRANSLITERATOR')) {
$transliterator = Transliterator::createFromRules(':: Any-Latin; :: Latin-ASCII; :: NFD; :: [:Nonspacing Mark:] Remove; :: NFC;', Transliterator::FORWARD);
return $transliterator->transliterate($str);
}
// See http://www.utf8-chartable.de/
$string = rawurlencode($str);
$replacements = array(
'%C3%80' => 'A', '%C3%81' => 'A', '%C3%82' => 'A', '%C3%83' => 'A', '%C3%84' => 'A', '%C3%85' => 'A',
'%C3%87' => 'C',
'%C3%88' => 'E', '%C3%89' => 'E', '%C3%8A' => 'E', '%C3%8B' => 'E',
'%C3%8C' => 'I', '%C3%8D' => 'I', '%C3%8E' => 'I', '%C3%8F' => 'I',
'%C3%91' => 'N',
'%C3%92' => 'O', '%C3%93' => 'O', '%C3%94' => 'O', '%C3%95' => 'O', '%C3%96' => 'O',
'%C5%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;
}
}
/**
* Clean a string from all punctuation characters to use it as a ref or login.
* This is a more complete function than dol_sanitizeFileName().
*
* @param string $str String to clean
* @param string $newstr String to replace forbidden chars with
* @param string[]|string $badcharstoreplace Array of forbidden characters to replace. Use '' to keep default list.
* @param string[]|string $badcharstoremove Array of forbidden characters to remove. Use '' to keep default list.
* @param int<0,1> $keepspaces 1=Do not treat space as a special char to replace or remove
* @return string Cleaned string
*
* @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nounprintableascii()
*/
function dol_string_nospecial($str, $newstr = '_', $badcharstoreplace = '', $badcharstoremove = '', $keepspaces = 0)
{
$forbidden_chars_to_replace = array("'", "/", "\\", ":", "*", "?", "\"", "<", ">", "|", "[", "]", ",", ";", "=", '°', '$', ';'); // more complete than dol_sanitizeFileName
if (empty($keepspaces)) {
$forbidden_chars_to_replace[] = " ";
}
$forbidden_chars_to_remove = array();
//$forbidden_chars_to_remove=array("(",")");
if (is_array($badcharstoreplace)) {
$forbidden_chars_to_replace = $badcharstoreplace;
}
if (is_array($badcharstoremove)) {
$forbidden_chars_to_remove = $badcharstoremove;
}
// @phan-suppress-next-line PhanPluginSuspiciousParamOrderInternal
return str_replace($forbidden_chars_to_replace, $newstr, str_replace($forbidden_chars_to_remove, "", $str));
}
/**
* Clean a string from all non printable ASCII chars (0x00-0x1F and 0x7F). It can also removes also Tab-CR-LF. UTF8 chars remains.
* This can be used to sanitize a string and view its real content. Some hacks try to obfuscate attacks by inserting non printable chars.
* Note, for information: UTF8 on 1 byte are: \x00-\7F
* 2 bytes are: byte 1 \xc0-\xdf, byte 2 = \x80-\xbf
* 3 bytes are: byte 1 \xe0-\xef, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf
* 4 bytes are: byte 1 \xf0-\xf7, byte 2 = \x80-\xbf, byte 3 = \x80-\xbf, byte 4 = \x80-\xbf
* @param string $str String to clean
* @param int $removetabcrlf Remove also CR-LF
* @return string Cleaned string
*
* @see dol_sanitizeFilename(), dol_string_unaccent(), dol_string_nospecial()
*/
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
}
}
/**
* Returns text slugified (lowercase and no special char, separator is "-").
*
* @param string $stringtoslugify String to slugify
* @return string Slugified string
*/
function dolSlugify($stringtoslugify)
{
$slug = dol_string_unaccent($stringtoslugify);
// Convert special characters to their ASCII equivalents
if (function_exists('iconv')) {
$slug = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $slug);
}
// Convert to lowercase
$slug = strtolower($slug);
// Replace non-alphanumeric characters with hyphens
$slug = preg_replace('/[^a-z0-9]+/', '-', $slug);
// Remove leading and trailing hyphens
$slug = trim($slug, '-');
return $slug;
}
/**
* Returns text escaped for inclusion into javascript code
*
* @param string $stringtoescape String to escape
* @param int<0,3> $mode 0=Escape also ' and " into ', 1=Escape ' but not " for usage into 'string', 2=Escape " but not ' for usage into "string", 3=Escape ' and " with \
* @param int $noescapebackslashn 0=Escape also \n. 1=Do not escape \n.
* @return string Escaped string. Both ' and " are escaped into ' if they are escaped.
*/
function dol_escape_js($stringtoescape, $mode = 0, $noescapebackslashn = 0)
{
if (is_null($stringtoescape)) {
return '';
}
// escape quotes and backslashes, newlines, etc.
$substitjs = array("'" => "\\'", "\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);
}
/**
* Returns text escaped by RFC 3986 for inclusion into a clickable link.
* This method can be used on the ...in links like href="javascript:..." because when clicking on such links, the browserfirst decode the strind
* and then interpret content that can be javascript.
* Usage of this escapement should be limited to links href="javascript:...". For common URL, use urlencode instead.
*
* @param string $stringtoescape String to escape
* @return string Escaped string.
*/
function dol_escape_uri($stringtoescape)
{
return rawurlencode($stringtoescape);
}
/**
* Returns text escaped for inclusion into javascript code
*
* @param string $stringtoescape String to escape
* @return string Escaped string for JSON content.
*/
function dol_escape_json($stringtoescape)
{
return str_replace('"', '\"', $stringtoescape);
}
/**
* Returns text escaped for inclusion into a php string, build with double quotes " or '
*
* @param string $stringtoescape String to escape
* @param int<1,2> $stringforquotes 2=String for doublequotes, 1=String for simple quotes
* @return string Escaped string for PHP content.
*/
function dol_escape_php($stringtoescape, $stringforquotes = 2)
{
if (is_null($stringtoescape)) {
return '';
}
if ($stringforquotes == 2) {
return str_replace('"', "'", $stringtoescape);
} elseif ($stringforquotes == 1) {
// We remove the \ char.
// If we allow the \ char, we can have $stringtoescape =
// abc\';phpcodedanger; so the escapement will become
// abc\\';phpcodedanger; and injecting this into
// $a='...' will give $ac='abc\\';phpcodedanger;
$stringtoescape = str_replace('\\', '', $stringtoescape);
return str_replace("'", "\'", str_replace('"', "'", $stringtoescape));
}
return 'Bad parameter for stringforquotes in dol_escape_php';
}
/**
* Returns text escaped for all protocols (so only alpha chars and numbers)
*
* @param string $stringtoescape String to escape
* @return string Escaped string for XML content.
*/
function dol_escape_all($stringtoescape)
{
return preg_replace('/[^a-z0-9_]/i', '', $stringtoescape);
}
/**
* Returns text escaped for inclusion into a XML string
*
* @param string $stringtoescape String to escape
* @return string Escaped string for XML content.
*/
function dol_escape_xml($stringtoescape)
{
return $stringtoescape;
}
/**
* Return a string label (so on 1 line only and that should not contains any HTML) ready to be output on HTML page.
* To use text that is not HTML content inside an attribute, you can simply use only dol_escape_htmltag(). In doubt, use dolPrintHTMLForAttribute().
*
* @param string $s String to print
* @param int $escapeonlyhtmltags 1=Escape only html tags, not the special chars like accents.
* @return string String ready for HTML output
* @see dolPrintText()
*/
function dolPrintLabel($s, $escapeonlyhtmltags = 0)
{
return dol_escape_htmltag(dol_string_nohtmltag($s, 1, 'UTF-8', 0, 0), 0, 0, '', $escapeonlyhtmltags, 1);
}
/**
* Return a string label (possible on several lines and that should not contains any HTML) ready to be output on HTML page.
* To use text that is not HTML content inside an attribute, you can simply use only dol_escape_htmltag(). In doubt, use dolPrintHTMLForAttribute().
*
* @param string $s String to print
* @return string String ready for HTML output
* @see dolPrintLabel(), dolPrintHTML()
*/
function dolPrintText($s)
{
return dol_escape_htmltag(dol_string_nohtmltag($s, 2, 'UTF-8', 0, 0), 0, 1, '', 0, 1);
}
/**
* Return a string (that can be on several lines) ready to be output on a HTML page.
* To output a text inside an attribute, you can use dolPrintHTMLForAttribute() or dolPrintHTMLForTextArea() inside a textarea
* With dolPrintHTML(), only content not already in HTML is encoded with HTML.
*
* @param int|float|string $s String to print
* @param int $allowiframe Allow iframe tags
* @return string String ready for HTML output (sanitized and escape)
* @see dolPrintHTMLForAttribute(), dolPrintHTMLFortextArea(), dolPrintText()
*/
function dolPrintHTML($s, $allowiframe = 0)
{
// If text is already HTML, we want to escape only dangerous chars else we want to escape all content.
//$isAlreadyHTML = dol_textishtml($s);
// dol_htmlentitiesbr encode all chars except "'" if string is not already HTML, but
// encode only special char like é but not &, <, >, ", ' if already HTML.
$stringWithEntitesForSpecialChar = dol_htmlentitiesbr((string) $s);
return dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags($stringWithEntitesForSpecialChar, 1, 1, 1, $allowiframe)), 1, 1, 'common', 0, 1);
}
/**
* Return a string ready to be output into an HTML attribute (alt, title, data-html, ...)
* With dolPrintHTMLForAttribute(), the content is HTML encode, even if it is already HTML content.
*
* @param string $s String to print
* @param int $escapeonlyhtmltags 1=Escape only html tags, not the special chars like accents.
* @param string[] $allowothertags List of other tags allowed
* @return string String ready for HTML output
* @see dolPrintHTML(), dolPrintHTMLFortextArea()
*/
function dolPrintHTMLForAttribute($s, $escapeonlyhtmltags = 0, $allowothertags = array())
{
$allowedtags = array('br', 'b', 'font', 'hr', 'span');
if (!empty($allowothertags) && is_array($allowothertags)) {
$allowedtags = array_merge($allowedtags, $allowothertags);
}
// The dol_htmlentitiesbr will convert simple text into html, including switching accent into HTML entities
// The dol_escape_htmltag will escape html tags.
if ($escapeonlyhtmltags) {
return dol_escape_htmltag(dol_string_onlythesehtmltags($s, 1, 0, 0, 0, $allowedtags), 1, -1, '', 1, 1);
} else {
return dol_escape_htmltag(dol_string_onlythesehtmltags(dol_htmlentitiesbr($s), 1, 0, 0, 0, $allowedtags), 1, -1, '', 0, 1);
}
}
/**
* Return a string ready to be output on a href attribute (this one need a special because we need content is HTML with no way to detect it is HTML).
* With dolPrintHTMLForAttribute(), the content is HTML encode, even if it is already HTML content.
*
* @param string $s String to print
* @return string String ready for HTML output
* @see dolPrintHTML(), dolPrintHTMLFortextArea()
*/
function dolPrintHTMLForAttributeUrl($s)
{
// The dol_htmlentitiesbr has been removed compared to dolPrintHTMLForAttribute because we know content is a HTML URL string (even if we have no way to detect it automatically)
// The dol_escape_htmltag will escape html chars.
$escapeonlyhtmltags = 1;
return dol_escape_htmltag(dol_string_onlythesehtmltags($s, 1, 1, 1, 0, array()), 0, 0, '', $escapeonlyhtmltags, 1);
}
/**
* Return a string ready to be output on input textarea.
* Differs from dolPrintHTML because all tags are escape. With dolPrintHTML, all tags except common one are escaped.
*
* @param string $s String to print
* @param int $allowiframe Allow iframe tags
* @return string String ready for HTML output into a textarea
* @see dolPrintHTML(), dolPrintHTMLForAttribute()
*/
function dolPrintHTMLForTextArea($s, $allowiframe = 0)
{
return dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr($s), 1, 1, 1, $allowiframe)), 1, 1, '', 0, 1);
}
/**
* Return a string ready to be output on an HTML attribute (alt, title, ...)
*
* @param string $s String to print
* @return string String ready for HTML output
*/
function dolPrintPassword($s)
{
return htmlspecialchars($s, ENT_HTML5, 'UTF-8');
}
/**
* Returns text escaped for inclusion in HTML alt or title or value tags, or into values of HTML input fields.
* When we need to output strings on pages, we should use:
* - dolPrintLabel...
* - dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(...), 1, 1, 1, 0)), 1, 1, 'common', 0, 1) for notes or descriptions into textarea, add 'common' if into a html content
* - dolPrintPassword that is a simple htmlspecialchars(... , ENT_COMPAT, 'UTF-8') for passwords.
*
* @param string $stringtoescape String to escape
* @param int $keepb 1=Replace b tags with escaped value (except if in $noescapetags), 0=Remove them completely
* @param int $keepn 1=Preserve \r\n strings, 0=Replace them with escaped value, -1=Remove them. Set to 1 when escaping for a <textarea>.
* @param string $noescapetags '' (escape all html tags) or 'common' (do not escape some common tags) or list of tags to not escape.
* @param int $escapeonlyhtmltags 1=Escape only html tags and double quotes, not the special chars like accents.
* @param int $cleanalsojavascript Clean also javascript. @TODO switch this option to 1 by default.
* @return string Escaped string
* @see dol_string_nohtmltag(), dol_string_onlythesehtmltags(), dol_string_nospecial(), dol_string_unaccent(), dol_htmlentitiesbr()
*/
function dol_escape_htmltag($stringtoescape, $keepb = 0, $keepn = 0, $noescapetags = '', $escapeonlyhtmltags = 0, $cleanalsojavascript = 0)
{
if ($noescapetags == 'common') {
$noescapetags = 'html,body,a,b,em,hr,i,u,ul,ol,li,br,div,img,font,p,span,strong,table,tr,td,th,tbody,h1,h2,h3,h4,h5,h6,h7,h8,h9';
// Add also html5 tags
$noescapetags .= ',header,footer,nav,section,menu,menuitem';
}
if ($cleanalsojavascript) {
$stringtoescape = dol_string_onlythesehtmltags($stringtoescape, 0, 0, $cleanalsojavascript, 0, array(), 0);
}
// escape quotes and backslashes, newlines, etc.
if ($escapeonlyhtmltags) {
$tmp = htmlspecialchars_decode((string) $stringtoescape, ENT_COMPAT);
} else {
// We make a manipulation by calling the html_entity_decode() to convert content into NON HTML UTF8 string.
// Because content can be or not already HTML.
// For example, this decode è into è so string is UTF8 (but numbers entities like ' is not decoded).
// In a future, we should not need this
$tmp = (string) $stringtoescape;
// We protect the 6 special entities that we don't want to decode.
$tmp = str_ireplace('<', '__DONOTDECODELT', $tmp);
$tmp = str_ireplace('>', '__DONOTDECODEGT', $tmp);
$tmp = str_ireplace('&', '__DONOTDECODEAMP', $tmp);
$tmp = str_ireplace('"', '__DONOTDECODEQUOT', $tmp);
$tmp = str_ireplace('&apos', '__DONOTDECODEAPOS', $tmp);
$tmp = str_ireplace(''', '__DONOTDECODE39', $tmp);
$tmp = html_entity_decode((string) $tmp, ENT_COMPAT, 'UTF-8'); // Convert entities into UTF8
// We restore the 6 special entities that we don't want to have been decoded by previous command
$tmp = str_ireplace('__DONOTDECODELT', '<', $tmp);
$tmp = str_ireplace('__DONOTDECODEGT', '>', $tmp);
$tmp = str_ireplace('__DONOTDECODEAMP', '&', $tmp);
$tmp = str_ireplace('__DONOTDECODEQUOT', '"', $tmp);
$tmp = str_ireplace('__DONOTDECODEAPOS', '&apos', $tmp);
$tmp = str_ireplace('__DONOTDECODE39', ''', $tmp);
$tmp = str_ireplace(''', '__SIMPLEQUOTE__', $tmp); // HTML 4
}
if (!$keepb) {
$tmp = strtr($tmp, array("<b>" => '', '</b>' => '', '<strong>' => '', '</strong>' => ''));
}
if (!$keepn) {
$tmp = strtr($tmp, array("\r" => '\\r', "\n" => '\\n'));
} elseif ($keepn == -1) {
$tmp = strtr($tmp, array("\r" => '', "\n" => ''));
}
if ($escapeonlyhtmltags) {
$tmp = htmlspecialchars($tmp, ENT_COMPAT, 'UTF-8');
return $tmp;
} else {
// Now we protect all the tags we want to keep
$tmparrayoftags = array();
if ($noescapetags) {
$tmparrayoftags = explode(',', $noescapetags);
}
if (count($tmparrayoftags)) {
// Now we will protect tags (defined into $tmparrayoftags) that we want to keep untouched
$reg = array();
// Remove reserved keywords. They are forbidden in a source string
$tmp = str_ireplace(array('__DOUBLEQUOTE', '__BEGINTAGTOREPLACE', '__ENDTAGTOREPLACE', '__BEGINENDTAGTOREPLACE'), '', $tmp);
foreach ($tmparrayoftags as $tagtoreplace) {
// For case of tag without attributes '<abc>', '</abc>', '<abc />', we protect them to avoid transformation by htmlentities() later
$tmp = preg_replace('/<'.preg_quote($tagtoreplace, '/').'>/', '__BEGINTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
$tmp = str_ireplace('</'.$tagtoreplace.'>', '__ENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
$tmp = preg_replace('/<'.preg_quote($tagtoreplace, '/').' \/>/', '__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', $tmp);
// For case of tag with attributes
do {
$tmpold = $tmp;
if (preg_match('/<'.preg_quote($tagtoreplace, '/').'(\s+)([^>]+)>/', $tmp, $reg)) {
// We want to protect the attribute part ... in '<xxx ...>' to avoid transformation by htmlentities() later
$tmpattributes = str_ireplace(array('[', ']'), '_', $reg[2]); // We must never have [ ] inside the attribute string
$tmpattributes = str_ireplace('"', '__DOUBLEQUOTE__', $tmpattributes);
$tmpattributes = preg_replace('/[^a-z0-9_%,\/\?\;\s=&\.\-@:\.#\+]/i', '', $tmpattributes);
//$tmpattributes = preg_replace("/float:\s*(left|right)/", "", $tmpattributes); // Disabled: we must not remove content
$tmp = str_replace('<'.$tagtoreplace.$reg[1].$reg[2].'>', '__BEGINTAGTOREPLACE'.$tagtoreplace.'['.$tmpattributes.']__', $tmp);
}
$diff = strcmp($tmpold, $tmp);
} while ($diff);
}
$tmp = str_ireplace('&', '__ANDNOSEMICOLON__', $tmp);
$tmp = str_ireplace('"', '__DOUBLEQUOTENOSEMICOLON__', $tmp);
$tmp = str_ireplace('<', '__LESSTHAN__', $tmp);
$tmp = str_ireplace('>', '__GREATERTHAN__', $tmp);
}
// Warning: htmlentities encode all special chars that remains (except "'" with ENT_COMPAT).
$result = htmlentities($tmp, ENT_COMPAT, 'UTF-8');
//print $result;
if (count($tmparrayoftags)) {
// Restore protected tags
foreach ($tmparrayoftags as $tagtoreplace) {
$result = str_ireplace('__BEGINTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.'>', $result);
$result = preg_replace('/__BEGINTAGTOREPLACE'.$tagtoreplace.'\[([^\]]*)\]__/', '<'.$tagtoreplace.' \1>', $result);
$result = str_ireplace('__ENDTAGTOREPLACE'.$tagtoreplace.'__', '</'.$tagtoreplace.'>', $result);
$result = str_ireplace('__BEGINENDTAGTOREPLACE'.$tagtoreplace.'__', '<'.$tagtoreplace.' />', $result);
$result = preg_replace('/__BEGINENDTAGTOREPLACE'.$tagtoreplace.'\[([^\]]*)\]__/', '<'.$tagtoreplace.' \1 />', $result);
}
$result = str_ireplace('__DOUBLEQUOTE__', '"', $result);
$result = str_ireplace('__ANDNOSEMICOLON__', '&', $result);
$result = str_ireplace('__DOUBLEQUOTENOSEMICOLON__', '"', $result);
$result = str_ireplace('__LESSTHAN__', '<', $result);
$result = str_ireplace('__GREATERTHAN__', '>', $result);
}
$result = str_ireplace('__SIMPLEQUOTE__', ''', $result);
//$result="\n\n\n".var_export($tmp, true)."\n\n\n".var_export($result, true);
return $result;
}
}
/**
* Convert a string to lower. Never use strtolower because it does not works with UTF8 strings.
*
* @param string $string String to encode
* @param string $encoding Character set encoding
* @return string String converted
*/
function dol_strtolower($string, $encoding = "UTF-8")
{
if (function_exists('mb_strtolower')) {
return mb_strtolower($string, $encoding);
} else {
return strtolower($string);
}
}
/**
* Convert a string to upper. Never use strtolower because it does not works with UTF8 strings.
*
* @param string $string String to encode
* @param string $encoding Character set encoding
* @return string String converted
* @see dol_ucfirst(), dol_ucwords()
*/
function dol_strtoupper($string, $encoding = "UTF-8")
{
if (function_exists('mb_strtoupper')) {
return mb_strtoupper($string, $encoding);
} else {
return strtoupper($string);
}
}
/**
* Convert first character of the first word of a string to upper. Never use ucfirst because it does not works with UTF8 strings.
*
* @param string $string String to encode
* @param string $encoding Character set encodign
* @return string String converted
* @see dol_strtoupper(), dol_ucwords()
*/
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);
}
}
/**
* Convert first character of all the words of a string to upper.
*
* @param string $string String to encode
* @param string $encoding Character set encodign
* @return string String converted
* @see dol_strtoupper(), dol_ucfirst()
*/
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);
}
}
/**
* Get caller info as a string that can be appended to a log message.
*
* @return string
*/
function getCallerInfoString()
{
$backtrace = debug_backtrace();
$msg = "";
if (count($backtrace) >= 1) {
$pos = 1;
if (count($backtrace) == 1) {
$pos = 0;
}
$trace = $backtrace[$pos];
if (isset($trace['file'], $trace['line'])) {
$msg = " From {$trace['file']}:{$trace['line']}.";
}
}
return $msg;
}
/**
* Write log message into outputs. Possible outputs can be:
* SYSLOG_HANDLERS = ["mod_syslog_file"] file name is then defined by SYSLOG_FILE
* SYSLOG_HANDLERS = ["mod_syslog_syslog"] facility is then defined by SYSLOG_FACILITY
* Warning, syslog functions are bugged on Windows, generating memory protection faults. To solve
* this, use logging to files instead of syslog (see setup of module).
* Note: If constant 'SYSLOG_FILE_NO_ERROR' defined, we never output any error message when writing to log fails.
* Note: You can get log message into html sources by adding parameter &logtohtml=1 (constant MAIN_LOGTOHTML must be set)
* This function works only if syslog module is enabled.
* This must not use any call to other function calling dol_syslog (avoid infinite loop).
*
* @param string $message Line to log. ''=Show nothing
* @param int<0,7> $level Log level
* On Windows LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=6, LOG_DEBUG=6 if define_syslog_variables ou PHP 5.3+, 7 if dolibarr
* On Linux LOG_ERR=3, LOG_WARNING=4, LOG_NOTICE=5, LOG_INFO=6, LOG_DEBUG=7
* @param int<-1,1> $ident 1=Increase ident of 1 (after log), -1=Decrease ident of 1 (before log)
* @param string $suffixinfilename When output is a file, append this suffix into default log filename. Example '_stripe', '_mail'
* @param string $restricttologhandler Force output of log only to this log handler
* @param ?array<string,mixed> $logcontext If defined, an array with extra information (can be used by some log handlers)
* @return void
* @phan-suppress PhanPluginUnknownArrayFunctionParamType $logcontext is not defined in detail
*/
function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename = '', $restricttologhandler = '', $logcontext = null)
{
global $conf, $user, $debugbar;
// If syslog module enabled
if (!isModEnabled('syslog')) {
return;
}
// Check if we are into execution of code of a website
if (defined('USEEXTERNALSERVER') && !defined('USEDOLIBARRSERVER') && !defined('USEDOLIBARREDITOR')) {
global $website, $websitekey;
if (is_object($website) && !empty($website->ref)) {
$suffixinfilename .= '_website_'.$website->ref;
} elseif (!empty($websitekey)) {
$suffixinfilename .= '_website_'.$websitekey;
}
}
// Check if we have a forced suffix
if (defined('USESUFFIXINLOG')) {
$suffixinfilename .= constant('USESUFFIXINLOG');
}
if ($ident < 0) {
foreach ($conf->loghandlers as $loghandlerinstance) {
$loghandlerinstance->setIdent($ident);
}
}
if (!empty($message)) {
// Test log level
// @phan-suppress-next-line PhanPluginDuplicateArrayKey
$logLevels = array(LOG_EMERG => 'EMERG', LOG_ALERT => 'ALERT', LOG_CRIT => 'CRITICAL', LOG_ERR => 'ERR', LOG_WARNING => 'WARN', LOG_NOTICE => 'NOTICE', LOG_INFO => 'INFO', LOG_DEBUG => 'DEBUG');
if (!array_key_exists($level, $logLevels)) {
dol_syslog('Error Bad Log Level '.$level, LOG_ERR);
$level = LOG_ERR;
}
if ($level > getDolGlobalInt('SYSLOG_LEVEL')) {
return;
}
if (!getDolGlobalString('MAIN_SHOW_PASSWORD_INTO_LOG')) {
$message = preg_replace('/password=\'[^\']*\'/', 'password=\'hidden\'', $message); // protection to avoid to have value of password in log
}
// If adding log inside HTML page is required
if ((!empty($_REQUEST['logtohtml']) && getDolGlobalString('MAIN_ENABLE_LOG_TO_HTML'))
|| (is_object($user) && $user->hasRight('debugbar', 'read') && is_object($debugbar))) {
$ospid = sprintf("%7s", dol_trunc((string) getmypid(), 7, 'right', 'UTF-8', 1));
$osuser = " ".sprintf("%6s", dol_trunc(function_exists('posix_getuid') ? posix_getuid() : '', 6, 'right', 'UTF-8', 1));
$conf->logbuffer[] = dol_print_date(time(), "%Y-%m-%d %H:%M:%S")." ".sprintf("%-7s", $logLevels[$level])." ".$ospid." ".$osuser." ".$message;
}
//TODO: Remove this. MAIN_ENABLE_LOG_INLINE_HTML should be deprecated and use a log handler dedicated to HTML output
// If html log tag enabled and url parameter log defined, we show output log on HTML comments
if (getDolGlobalString('MAIN_ENABLE_LOG_INLINE_HTML') && GETPOSTINT("log")) {
print "\n\n<!-- Log start\n";
print dol_escape_htmltag($message)."\n";
print "Log end -->\n";
}
$data = array(
'message' => $message,
'script' => (isset($_SERVER['PHP_SELF']) ? basename($_SERVER['PHP_SELF'], '.php') : ''),
'level' => $level,
'user' => ((is_object($user) && $user->id) ? $user->login : ''),
'ip' => '',
'osuser' => function_exists('posix_getuid') ? (string) posix_getuid() : '',
'ospid' => (string) getmypid() // on linux, max value is defined into cat /proc/sys/kernel/pid_max
);
// For log, we want the reliable IP first.
$remoteip = getUserRemoteIP(1); // Get ip when page run on a web server
if (!empty($remoteip)) {
$data['ip'] = $remoteip;
// This is when server run behind a reverse proxy
// A HTTP_X_FORWARDED_FOR as format "ip real of user, ip of proxy1, ip of proxy2, ..."
// $data['ip'] is last
if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
$tmpips = explode(',', $_SERVER['HTTP_X_FORWARDED_FOR']);
$data['ip'] = '';
$foundremoteip = 0;
$j = 0;
foreach ($tmpips as $tmpip) {
$tmpip = trim($tmpip);
if (strtolower($tmpip) == strtolower($remoteip)) {
$foundremoteip = 1;
}
if (empty($data['ip'])) {
$data['ip'] = $tmpip;
} else {
$j++;
$data['ip'] .= (($j == 1) ? ' [via ' : ',').$tmpip;
}
}
if (!$foundremoteip) {
$j++;
$data['ip'] .= (($j == 1) ? ' [via ' : ',').$remoteip;
}
$data['ip'] .= (($j > 0) ? ']' : '');
} elseif (!empty($_SERVER['HTTP_CLIENT_IP'])) {
$tmpips = explode(',', $_SERVER['HTTP_CLIENT_IP']);
$data['ip'] = '';
$foundremoteip = 0;
$j = 0;
foreach ($tmpips as $tmpip) {
$tmpip = trim($tmpip);
if (strtolower($tmpip) == strtolower($remoteip)) {
$foundremoteip = 1;
}
if (empty($data['ip'])) {
$data['ip'] = $tmpip;
} else {
$j++;
$data['ip'] .= (($j == 1) ? ' [via ' : ',').$tmpip;
}
}
if (!$foundremoteip) {
$j++;
$data['ip'] .= (($j == 1) ? ' [via ' : ',').$remoteip;
}
$data['ip'] .= (($j > 0) ? ']' : '');
}
} elseif (!empty($_SERVER['SERVER_ADDR'])) {
// This is when PHP session is ran inside a web server but not inside a client request (example: init code of apache)
$data['ip'] = (string) $_SERVER['SERVER_ADDR'];
} elseif (!empty($_SERVER['COMPUTERNAME'])) {
// This is when PHP session is ran outside a web server, like from Windows command line (Not always defined, but useful if OS defines it).
$data['ip'] = (string) $_SERVER['COMPUTERNAME'];
} else {
$data['ip'] = '???';
}
if (!empty($_SERVER['USERNAME'])) {
// This is when PHP session is ran outside a web server, like from Linux command line (Not always defined, but useful if OS defines it).
$data['osuser'] = (string) $_SERVER['USERNAME'];
} elseif (!empty($_SERVER['LOGNAME'])) {
// This is when PHP session is ran outside a web server, like from Linux command line (Not always defined, but useful if OS defines it).
$data['osuser'] = (string) $_SERVER['LOGNAME'];
}
// Loop on each log handler and send output
foreach ($conf->loghandlers as $loghandlerinstance) {
if ($restricttologhandler && $loghandlerinstance->code != $restricttologhandler) {
continue;
}
$loghandlerinstance->export($data, $suffixinfilename);
}
unset($data);
}
if ($ident > 0) {
foreach ($conf->loghandlers as $loghandlerinstance) {
$loghandlerinstance->setIdent($ident);
}
}
}
/**
* Create a dialog with two buttons for export and overwrite of a website
*
* @param string $name Unique identifier for the dialog
* @param string $label Title of the dialog
* @param string $buttonstring Text for the button that opens the dialog
* @param string $exportSiteName Name of the "submit" input for site export
* @param string $overwriteGitUrl URL for the link that triggers the overwrite action in GIT
* @param Website $website Website object
* @return string HTML and JavaScript code for the button and the dialog
*/
function dolButtonToOpenExportDialog($name, $label, $buttonstring, $exportSiteName, $overwriteGitUrl, $website)
{
global $langs, $db;
$form = new Form($db);
$templatenameforexport = $website->name_template; // Example 'website_template-corporate'
if (empty($templatenameforexport)) {
$templatenameforexport = 'website_'.$website->ref;
}
$out = '';
$out .= '<input type="button" class="cursorpointer button bordertransp" id="open-dialog-' . $name . '" value="'.dol_escape_htmltag($buttonstring).'"/>';
// for generate popup
$out .= '<script nonce="' . getNonce() . '" type="text/javascript">';
$out .= 'jQuery(document).ready(function () {';
$out .= ' jQuery("#open-dialog-' . $name . '").click(function () {';
$out .= ' var dialogHtml = \'';
$dialogcontent = ' <div id="custom-dialog-' . $name . '">';
$dialogcontent .= ' <div style="margin-top: 20px;">';
$dialogcontent .= ' <label for="export-site-' . $name . '"><strong>'.$langs->trans("ExportSiteLabel").'...</label><br>';
$dialogcontent .= ' <button class="button smallpaddingimp" id="export-site-' . $name . '">' . dol_escape_htmltag($langs->trans("DownloadZip")) . '</button>';
$dialogcontent .= ' </div>';
$dialogcontent .= ' <br>';
$dialogcontent .= ' <div style="margin-top: 20px;">';
$dialogcontent .= ' <strong>'.$langs->trans("ExportSiteGitLabel").' '.$form->textwithpicto('', $langs->trans("SourceFiles"), 1, 'help', '', 0, 3, '').'</strong><br>';
$dialogcontent .= ' <form action="'.dol_escape_htmltag($overwriteGitUrl).'" method="POST">';
$dialogcontent .= ' <input type="hidden" name="action" value="overwritesite">';
$dialogcontent .= ' <input type="hidden" name="token" value="'.newToken().'">';
$dialogcontent .= ' <input type="text" autofocus name="export_path" id="export-path-'.$name.'" placeholder="'.$langs->trans('ExportPath').'" style="width:400px " value="'.dol_escape_htmltag($templatenameforexport).'"/><br>';
$dialogcontent .= ' <button type="submit" class="button smallpaddingimp" id="overwrite-git-' . $name . '">' . dol_escape_htmltag($langs->trans("ExportIntoGIT")) . '</button>';
$dialogcontent .= ' </form>';
$dialogcontent .= ' </div>';
$dialogcontent .= ' </div>';
$out .= dol_escape_js($dialogcontent);
$out .= '\';';
// Add the content of the dialog to the body of the page
$out .= ' var $dialog = jQuery("#custom-dialog-' . $name . '");';
$out .= ' if ($dialog.length > 0) {
$dialog.remove();
}
jQuery("body").append(dialogHtml);';
// Configuration of popup
$out .= ' jQuery("#custom-dialog-' . $name . '").dialog({';
$out .= ' autoOpen: false,';
$out .= ' modal: true,';
$out .= ' height: 290,';
$out .= ' width: "40%",';
$out .= ' title: "' . dol_escape_js($label) . '",';
$out .= ' });';
// Simulate a click on the original "submit" input to export the site.
$out .= ' jQuery("#export-site-' . $name . '").click(function () {';
$out .= ' console.log("Clic on exportsite.");';
$out .= ' var target = jQuery("input[name=\'' . dol_escape_js($exportSiteName) . '\']");';
$out .= ' console.log("element founded:", target.length > 0);';
$out .= ' if (target.length > 0) { target.click(); }';
$out .= ' jQuery("#custom-dialog-' . $name . '").dialog("close");';
$out .= ' });';
// open popup
$out .= ' jQuery("#custom-dialog-' . $name . '").dialog("open");';
$out .= ' return false;';
$out .= ' });';
$out .= '});';
$out .= '</script>';
return $out;
}
/**
* Return HTML code to output a button to open a dialog popup box.
* Such buttons must be included inside a HTML form.
*
* @param string $name A name for the html component
* @param string $label Label shown in Popup title top bar
* @param string $buttonstring button string (HTML text we can click on)
* @param string $url Relative Url to open. For example '/project/card.php'
* @param string $disabled Disabled text
* @param string $morecss More CSS
* @param string $jsonopen Some JS code to execute on click/open of popup
* @param string $jsonclose Some JS code to execute on close of popup
* Value is 'keyforpopupid:Name_of_html_component_to_set_with id,Name_of_html_component_to_set_with_label'
* @param string $accesskey A key to use shortcut
* @return string HTML component with button
*/
function dolButtonToOpenUrlInDialogPopup($name, $label, $buttonstring, $url, $disabled = '', $morecss = 'classlink button bordertransp', $jsonopen = '', $jsonclose = '', $accesskey = '')
{
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 = '';
//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 -->';
$out .= '<a '.($accesskey ? ' accesskey="'.$accesskey.'"' : '').' class="cursorpointer reposition button_'.$name.($morecss ? ' '.$morecss : '').'"'.$disabled.' title="'.dol_escape_htmltag($label).'"';
if (empty($conf->use_javascript_ajax)) {
$out .= ' href="'.DOL_URL_ROOT.$url.'" target="_blank"';
} elseif ($jsonopen) {
$out .= ' href="#" onclick="'.$jsonopen.'"';
} else {
$out .= ' href="#"';
}
$out .= '>'.$buttonstring.'</a>';
if (!empty($conf->use_javascript_ajax)) {
// Add code to open url using the popup.
$out .= '<!-- code to open popup and variables to retrieve returned variables -->';
$out .= '<div id="idfordialog'.$name.'" class="hidden">'.(getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2 ? 'div for dialog' : '').'</div>';
$out .= '<!-- Add js code to open dialog popup on dialog -->';
$out .= '<script nonce="'.getNonce().'" 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.'");
},
close: function (event, ui) {
console.log("Popup is closed, run jsonclose = '.$jsonclose.'");
'.(empty($jsonclose) ? '' : $jsonclose.';').'
}
});
$tmpdialog.dialog(\'open\');
return false;
});
});
</script>';
}
return $out;
}
/**
* Show tab header of a card
*
* @param array<int,array<int<0,5>,string>> $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
* @param string $active Active tab name (document', 'info', 'ldap', ....)
* @param string $title Title
* @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no sepaaration under tab (to start a tab just after), -3=Add tab header but no footer separation
* @param string $picto Add a picto on tab title
* @param int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.
* @param string $morehtmlright Add more html content on right of tabs title
* @param string $morecss More Css
* @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
* @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
* @return void
* @deprecated Use print dol_get_fiche_head() instead
*/
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);
}
/**
* Show tabs of a record
*
* @param array<int,array<int<0,5>,string>> $links Array of tabs (0=>url, 1=>label, 2=>code, 3=>not used, 4=>text after link, 5=>morecssonlink). Currently initialized by calling a function xxx_admin_prepare_head. Note that label into $links[$i][1] must be already HTML escaped.
* @param string $active Active tab name (using the old numeric int is deprecated)
* @param string $title Title
* @param int $notab -1 or 0=Add tab header, 1=no tab header (if you set this to 1, using print dol_get_fiche_end() to close tab is not required), -2=Add tab header with no separation under tab (to start a tab just after), -3=-2+'noborderbottom'
* @param string $picto Add a picto on tab title
* @param int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.
* @param string $morehtmlright Add more html content on right of tabs title
* @param string $morecss More CSS on the link <a>
* @param int $limittoshow Limit number of tabs to show. Use 0 to use automatic default value.
* @param string $moretabssuffix A suffix to use when you have several dol_get_fiche_head() in same page
* @param int $dragdropfile 0 (default) or 1. 1 enable a drop zone for file to be upload, 0 disable it
* @param string $morecssdiv More CSS on the div
* @return string
*/
function dol_get_fiche_head($links = array(), $active = '', $title = '', $notab = 0, $picto = '', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limittoshow = 0, $moretabssuffix = '', $dragdropfile = 0, $morecssdiv = '')
{
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 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 = getDolGlobalInt('MAIN_MAXTABS_IN_CARD', 99);
}
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 && getDolGlobalString('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).'">';
}
if ($displaytab == 0 && $picto) {
$out .= img_picto($title, $picto, '', $pictoisfullpath, 0, 0, '', 'imgTabTitle paddingright marginrightonlyshort');
}
$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_content = '';
if (isset($links[$i][2]) && $links[$i][2] == 'image') {
if (!empty($links[$i][0])) {
$outmore_content .= '<a class="tabimage'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">'.$links[$i][1].'</a>'."\n";
} else {
$outmore_content .= '<span class="tabspan">'.$links[$i][1].'</span>'."\n";
}
} elseif (!empty($links[$i][1])) {
$outmore_content .= '<a'.(!empty($links[$i][2]) ? ' id="'.$links[$i][2].'"' : '').' class="wordwrap inline-block'.($morecss ? ' '.$morecss : '').'" href="'.$links[$i][0].'">';
$outmore_content .= 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_content .= '</a>'."\n";
}
if ($outmore_content !== '') {
$outmore .= '<div class="popuptab wordwrap" style="display:inherit;">' . $outmore_content . '</div>';
}
$nbintab++;
}
$displaytab = $i + 1;
}
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 = 240;
$tabsname = $moretabssuffix;
if (empty($tabsname)) {
$tabsname = str_replace("@", "", $picto);
}
$out .= '<div id="moretabs'.$tabsname.'" class="inline-block tabsElem valignmiddle">';
if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2) {
$out .= '<div class="tab valignmiddle"><a href="#" class="tab moretab inline-block tabunactive valignmiddle"><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 nonce="'.getNonce().'">';
$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 || $notab == -4) {
$out .= "\n".'<div id="dragDropAreaTabBar" class="tabBar'.($notab == -1 ? '' : ($notab == -2 ? ' tabBarNoTop' : ((($notab == -3 || $notab == -4) ? ' noborderbottom' : '').($notab == -4 ? '' : ' tabBarWithBottom'))));
$out .= ($morecssdiv ? ' '.$morecssdiv : '');
$out .= '">'."\n";
}
if (!empty($dragdropfile)) {
include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
$out .= dragAndDropFileUpload("dragDropAreaTabBar");
}
$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;
}
/**
* Show tab footer of a card
*
* @param int<-1,1> $notab -1 or 0=Add tab footer, 1=no tab footer
* @return void
* @deprecated Use print dol_get_fiche_end() instead
*/
function dol_fiche_end($notab = 0)
{
print dol_get_fiche_end($notab);
}
/**
* Return tab footer of a card
*
* @param int<-1,1> $notab -1 or 0=Add tab footer, 1=no tab footer
* @return string
*/
function dol_get_fiche_end($notab = 0)
{
if (!$notab || $notab == -1) {
return "\n</div>\n";
} else {
return '';
}
}
/**
* Show tab footer of a card.
* Note: $object->next_prev_filter can be set to restrict select to find next or previous record by $form->showrefnav.
*
* @param CommonObject $object Object to show
* @param string $paramid Name of parameter to use to name the id into the URL next/previous link
* @param string $morehtml More html content to output just before the nav bar
* @param int|bool $shownav Show Condition (navigation is shown if value is 1 or true)
* @param string $fieldid Name of the field in DB to use to select next et previous (we make the select max and min on this field). Use 'none' for no prev/next search.
* @param string $fieldref Name of the field (object->ref) to use to select next et previous
* @param string $morehtmlref More html to show after the ref (see $morehtmlleft for before)
* @param string $moreparam More param to add in nav link url.
* @param int $nodbprefix Do not include DB prefix to forge table name
* @param string $morehtmlleft More html code to show before the ref (see $morehtmlref for after)
* @param string $morehtmlstatus More html code to show under navigation arrows
* @param int $onlybanner Put this to 1, if the card will contains only a banner (this add css 'arearefnobottom' on div)
* @param string $morehtmlright More html code to show before navigation arrows
* @return void
*/
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);
// @phan-suppress-next-line PhanUndeclaredMethod
$showbarcode = !isModEnabled('barcode') ? 0 : (empty($object->barcode) ? 0 : 1);
if (getDolGlobalString('MAIN_USE_ADVANCED_PERMS') && !$user->hasRight('barcode', 'lire_advance')) {
$showbarcode = 0;
}
$modulepart = 'unknown';
if (in_array($object->element, ['societe', 'contact', 'product', 'ticket', 'bom'])) {
$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' || $object->element == 'intervention') {
$modulepart = 'ficheinter';
} elseif ($object->element == 'contrat' || $object->element == 'contract') {
$modulepart = 'contract';
} elseif ($object->element == 'order_supplier') {
$modulepart = 'supplier_order';
} elseif ($object->element == 'invoice_supplier') {
$modulepart = 'supplier_invoice';
}
}
if ($object->element == 'product') {
/** @var Product $object */
'@phan-var-force Product $object';
$width = 80;
$cssclass = 'photowithmargin photoref';
$showimage = $object->is_photo_available($conf->product->multidir_output[$entity]);
$maxvisiblephotos = getDolGlobalInt('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], 1, $maxvisiblephotos, 0, 0, 0, 0, $width, 0, '').'</div>';
} else {
if (getDolGlobalString('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 : '').'" title="'.dol_escape_htmltag($langs->trans("UploadAnImageToSeeAPhotoHere", $langs->transnoentitiesnoconv("Documents"))).'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
}
}
} elseif ($object->element == 'category') {
/** @var Categorie $object */
'@phan-var-force Categorie $object';
$width = 80;
$cssclass = 'photowithmargin photoref';
$showimage = $object->isAnyPhotoAvailable($conf->categorie->multidir_output[$entity]);
$maxvisiblephotos = getDolGlobalInt('CATEGORY_MAX_VISIBLE_PHOTO', 5);
if ($conf->browser->layout == 'phone') {
$maxvisiblephotos = 1;
}
if ($showimage) {
$morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos('category', $conf->categorie->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, 0, $width, 0, '').'</div>';
} else {
if (getDolGlobalString('CATEGORY_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 : '').'" title="'.dol_escape_htmltag($langs->trans("UploadAnImageToSeeAPhotoHere", $langs->transnoentitiesnoconv("Documents"))).'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
}
}
} elseif ($object->element == 'bom') {
/** @var BOM $object */
'@phan-var-force Bom $object';
$width = 80;
$cssclass = 'photowithmargin photoref';
$showimage = $object->is_photo_available($conf->bom->multidir_output[$entity]);
$maxvisiblephotos = getDolGlobalInt('BOM_MAX_VISIBLE_PHOTO', 5);
if ($conf->browser->layout == 'phone') {
$maxvisiblephotos = 1;
}
if ($showimage) {
$morehtmlleft .= '<div class="floatleft inline-block valignmiddle divphotoref">'.$object->show_photos('bom', $conf->bom->multidir_output[$entity], 'small', $maxvisiblephotos, 0, 0, 0, 0, $width, 0, '').'</div>';
} else {
if (getDolGlobalString('BOM_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 : '').'" title="'.dol_escape_htmltag($langs->trans("UploadAnImageToSeeAPhotoHere", $langs->transnoentitiesnoconv("Documents"))).'" alt="No photo"'.($width ? ' style="width: '.$width.'px"' : '').' src="'.DOL_URL_ROOT.$nophoto.'"></div>';
}
}
} elseif ($object->element == 'ticket') {
$width = 80;
$cssclass = 'photoref';
/** @var Ticket $object */
'@phan-var-force Ticket $object';
$showimage = $object->is_photo_available($conf->ticket->multidir_output[$entity].'/'.$object->ref);
$maxvisiblephotos = getDolGlobalInt('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 (getDolGlobalString('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' || method_exists($object, 'getDataToShowPhoto')) {
$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 existent
if (!file_exists($fileimage) || (filemtime($fileimage) < filemtime($filepdf))) {
if (!getDolGlobalString('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.'&file='.urlencode($relativepathimage).'">';
$phototoshow .= '</div>';
}
}
} elseif (!$phototoshow) { // example if modulepart = 'societe' or 'photo' or 'memberphoto'
$phototoshow .= $form->showphoto($modulepart, $object, 0, 0, 0, 'photowithmargin photoref', 'small', 1, 0);
}
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; // @phan-suppress-current-line PhanUndeclaredProperty
$prefix = 'object_';
if ($object->element == 'project' && !$object->public) { // @phan-suppress-current-line PhanUndeclaredProperty
$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>';
}
}
}
// Show barcode
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') && getDolGlobalString('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->hasRight('produit', 'creer') && getDolGlobalString('MAIN_DIRECT_STATUS_UPDATE')) {
$morehtmlstatus .= ajax_object_onoff($object, 'status', 'tosell', 'ProductStatusOnSell', 'ProductStatusNotOnSell');
} else {
$morehtmlstatus .= '<span class="statusrefsell">'.$object->getLibStatut(6, 0).'</span>';
}
$morehtmlstatus .= ' ';
//$morehtmlstatus.=$langs->trans("Status").' ('.$langs->trans("Buy").') ';
if (!empty($conf->use_javascript_ajax) && $user->hasRight('produit', 'creer') && getDolGlobalString('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('salary'))) {
'@phan-var-force Salary $object';
$tmptxt = $object->getLibStatut(6, $object->alreadypaid);
if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
$tmptxt = $object->getLibStatut(5, $object->alreadypaid);
}
$morehtmlstatus .= $tmptxt;
} elseif (in_array($object->element, array('facture', 'invoice', 'invoice_supplier'))) { // TODO Move this to use ->alreadypaid
'@phan-var-force Facture|FactureFournisseur|CommonInvoice $object';
$totalallpayments = $object->getSommePaiement(0);
$totalallpayments += $object->getSumCreditNotesUsed(0);
$totalallpayments += $object->getSumDepositsUsed(0);
$tmptxt = $object->getLibStatut(6, $totalallpayments);
if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
$tmptxt = $object->getLibStatut(5, $totalallpayments);
}
$morehtmlstatus .= $tmptxt;
} elseif (in_array($object->element, array('chargesociales', 'loan', 'tva'))) { // TODO Move this to use ->alreadypaid
'@phan-var-force ChargeSociales|Loan|Tva $object';
$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') {
'@phan-var-force FactureRec $object';
if ($object->frequency == 0) {
$morehtmlstatus .= $object->getLibStatut(2);
} else {
$morehtmlstatus .= $object->getLibStatut(5);
}
} elseif ($object->element == 'project_task') {
$tmptxt = $object->getLibStatut(4);
$morehtmlstatus .= $tmptxt;
} elseif (method_exists($object, 'getLibStatut')) { // Generic case for status
$tmptxt = $object->getLibStatut(6);
if (empty($tmptxt) || $tmptxt == $object->getLibStatut(3)) {
$tmptxt = $object->getLibStatut(5);
}
$morehtmlstatus .= $tmptxt;
}
// Say if object was dispatched/transferred "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(1);
$langs->load("accountancy");
$morehtmlstatus .= '</div><div class="statusref statusrefbis"><span class="opacitymedium">'.($accounted > 0 ? '<a href="'.DOL_URL_ROOT.'/accountancy/bookkeeping/list.php?search_mvt_num='.((int) $accounted).'">'.$langs->trans("Accounted").'</a>' : $langs->trans("NotYetAccounted")).'</span>';
}
}
// Add alias for thirdparty
if (!empty($object->name_alias)) {
'@phan-var-force Societe $object';
$morehtmlref .= '<div class="refidno opacitymedium">'.dol_escape_htmltag($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); // address, email, url, social networks
if ($moreaddress) {
$morehtmlref .= '<div class="refidno refaddress">';
$morehtmlref .= $moreaddress;
$morehtmlref .= '</div>';
}
}
if (getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && (getDolGlobalString('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").': '.((int) $object->id);
$morehtmlref .= '</div>';
}
$parameters = array('morehtmlref' => &$morehtmlref, 'moreparam' => &$moreparam, 'morehtmlleft' => &$morehtmlleft, 'morehtmlstatus' => &$morehtmlstatus, 'morehtmlright' => &$morehtmlright);
$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;
}
// $morehtml is the right part (link "Back to list")
// $morehtmlleft is the picto or photo of banner
// $morehtmlstatus is part under the status
// $morehtmlright is part of htmlright
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>';
}
/**
* Show a string with the label tag dedicated to the HTML edit field.
*
* @param string $langkey Translation key
* @param string $fieldkey Key of the html select field the text refers to
* @param int $fieldrequired 1=Field is mandatory
* @return string
* @deprecated Form::editfieldkey
*/
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;
}
/**
* Return a formatted address (part address/zip/town/state) according to country rules.
* See https://en.wikipedia.org/wiki/Address
*
* @param Object $object A company or contact object
* @param int $withcountry 1=Add country into address string
* @param string $sep Separator to use to separate info when building string
* @param ?Translate $outputlangs Object lang that contains language for text translation.
* @param int $mode 0=Standard output, 1=Remove address
* @param string $extralangcode User extralanguage $langcode as values for address, town
* @return string Formatted string
* @see dol_print_address()
*/
function dol_format_address($object, $withcountry = 0, $sep = "\n", $outputlangs = null, $mode = 0, $extralangcode = '')
{
global $langs, $hookmanager;
$ret = '';
$countriesusingstate = array('AU', 'CA', 'US', 'IN', 'GB', 'ES', 'UK', 'TR', 'CN'); // See also MAIN_FORCE_STATE_INTO_ADDRESS
// See format of addresses on https://en.wikipedia.org/wiki/Address
// Address
if (empty($mode)) {
$ret .= (($extralangcode && !empty($object->array_languages['address'][$extralangcode])) ? $object->array_languages['address'][$extralangcode] : (empty($object->address) ? '' : preg_replace('/(\r\n|\r|\n)+/', $sep, $object->address)));
}
// Zip/Town/State
if (isset($object->country_code) && in_array($object->country_code, array('AU', 'CA', 'US', 'CN')) || getDolGlobalString('MAIN_FORCE_STATE_INTO_ADDRESS')) {
// US: title firstname name \n address lines \n town, state, zip \n country
$town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= (($ret && $town) ? $sep : '').$town;
if (!empty($object->state)) {
$ret .= ($ret ? ($town ? ", " : $sep) : '').$object->state;
}
if (!empty($object->zip)) {
$ret .= ($ret ? (($town || $object->state) ? ", " : $sep) : '').$object->zip;
}
} elseif (isset($object->country_code) && in_array($object->country_code, array('GB', 'UK'))) {
// UK: title firstname name \n address lines \n town state \n zip \n country
$town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= ($ret ? $sep : '').$town;
if (!empty($object->state)) {
$ret .= ($ret ? ", " : '').$object->state;
}
if (!empty($object->zip)) {
$ret .= ($ret ? $sep : '').$object->zip;
}
} elseif (isset($object->country_code) && in_array($object->country_code, array('ES', 'TR'))) {
// ES: title firstname name \n address lines \n zip town \n state \n country
$ret .= ($ret ? $sep : '').$object->zip;
$town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
if (!empty($object->state)) {
$ret .= $sep.$object->state;
}
} elseif (isset($object->country_code) && in_array($object->country_code, array('JP'))) {
// JP: In romaji, title firstname name\n address lines \n [state,] town zip \n country
// See https://www.sljfaq.org/afaq/addresses.html
$town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= ($ret ? $sep : '').($object->state ? $object->state.', ' : '').$town.($object->zip ? ' ' : '').$object->zip;
} elseif (isset($object->country_code) && in_array($object->country_code, array('IT'))) {
// IT: title firstname name\n address lines \n zip town state_code \n country
$ret .= ($ret ? $sep : '').$object->zip;
$town = ($extralangcode ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= ($town ? (($object->zip ? ' ' : '').$town) : '');
$ret .= (empty($object->state_code) ? '' : (' '.$object->state_code));
} else {
// Other: title firstname name \n address lines \n zip town[, state] \n country
$town = (($extralangcode && !empty($object->array_languages['address'][$extralangcode])) ? $object->array_languages['town'][$extralangcode] : (empty($object->town) ? '' : $object->town));
$ret .= !empty($object->zip) ? (($ret ? $sep : '').$object->zip) : '';
$ret .= ($town ? (($object->zip ? ' ' : ($ret ? $sep : '')).$town) : '');
if (!empty($object->state) && in_array($object->country_code, $countriesusingstate)) {
$ret .= ($ret ? ", " : '').$object->state;
}
}
if (!is_object($outputlangs)) {
$outputlangs = $langs;
}
if ($withcountry) {
$langs->load("dict");
$ret .= (empty($object->country_code) ? '' : ($ret ? $sep : '').$outputlangs->convToOutputCharset($outputlangs->transnoentitiesnoconv("Country".$object->country_code)));
}
if ($hookmanager) {
$parameters = array('withcountry' => $withcountry, 'sep' => $sep, 'outputlangs' => $outputlangs,'mode' => $mode, 'extralangcode' => $extralangcode);
$reshook = $hookmanager->executeHooks('formatAddress', $parameters, $object);
if ($reshook > 0) {
$ret = '';
}
$ret .= $hookmanager->resPrint;
}
return $ret;
}
/**
* Format a string.
*
* @param string $fmt Format of strftime function (http://php.net/manual/fr/function.strftime.php)
* @param int|false $ts Timestamp (If is_gmt is true, timestamp is already includes timezone and daylight saving offset, if is_gmt is false, timestamp is a GMT timestamp and we must compensate with server PHP TZ)
* @param bool $is_gmt See comment of timestamp parameter
* @return string A formatted string
* @see dol_stringtotime()
*/
function dol_strftime($fmt, $ts = false, $is_gmt = false)
{
if ((abs($ts) <= 0x7FFFFFFF)) { // check if number in 32-bit signed range
return dol_print_date($ts, $fmt, $is_gmt);
} else {
return 'Error date outside supported range';
}
}
/**
* Output date in a string format according to outputlangs (or langs if not defined).
* Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset
*
* @param null|int|string $time GM Timestamps date
* @param string $format Output date format (tag of strftime function)
* "%d %b %Y",
* "%d/%m/%Y %H:%M",
* "%d/%m/%Y %H:%M:%S",
* "%B"=Long text of month, "%A"=Long text of day, "%b"=Short text of month, "%a"=Short text of day
* "day", "daytext", "dayhour", "dayhourldap", "dayhourtext", "dayrfc", "dayhourrfc", "...inputnoreduce", "...reduceformat"
* @param string|bool $tzoutput true or 'gmt' => string is for Greenwich location
* false or 'tzserver' => output string is for local PHP server TZ usage
* 'tzuser' => output string is for user TZ (current browser TZ with current dst) => In a future, we should have same behaviour than 'tzuserrel'
* 'tzuserrel' => output string is for user TZ (current browser TZ with dst or not, depending on date position)
* @param ?Translate $outputlangs Object lang that contains language for text translation.
* @param boolean $encodetooutput false=no convert into output pagecode
* @return string Formatted date or '' if time is null
*
* @see dol_mktime(), dol_stringtotime(), dol_getdate(), selectDate()
*/
function dol_print_date($time, $format = '', $tzoutput = 'auto', $outputlangs = null, $encodetooutput = false)
{
global $conf, $langs;
// If date undefined or "", we return ""
if (dol_strlen((string) $time) == 0) {
return ''; // $time=0 allowed (it means 01/01/1970 00:00:00)
}
if ($tzoutput === 'auto') {
$tzoutput = (empty($conf) ? 'tzserver' : (isset($conf->tzuserinputkey) ? $conf->tzuserinputkey : 'tzserver'));
}
// Clean parameters
$to_gmt = false;
$offsettz = $offsetdst = 0;
if ($tzoutput) {
$to_gmt = true; // For backward compatibility
if (is_string($tzoutput)) {
if ($tzoutput == 'tzserver') {
$to_gmt = false;
$offsettzstring = @date_default_timezone_get(); // Example 'Europe/Berlin' or 'Indian/Reunion'
// @phan-suppress-next-line PhanPluginRedundantAssignment
$offsettz = 0; // Timezone offset with server timezone (because to_gmt is false), so 0
// @phan-suppress-next-line PhanPluginRedundantAssignment
$offsetdst = 0; // Dst offset with server timezone (because to_gmt is false), so 0
} elseif ($tzoutput == 'tzuser' || $tzoutput == 'tzuserrel') {
$to_gmt = true;
$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', 'dayhoursec'))) ? 1 : 0; // Test on original $format param.
$format = preg_replace('/inputnoreduce/', '', $format); // so format 'dayinputnoreduce' is processed like day
$formatwithoutreduce = preg_replace('/reduceformat/', '', $format);
if ($formatwithoutreduce != $format) {
$format = $formatwithoutreduce;
$reduceformat = 1;
} // so format 'dayreduceformat' is processed like day
// Change predefined format into computer format. If found translation in lang file we use it, otherwise we use default.
// TODO Add format daysmallyear and dayhoursmallyear
if ($format == 'day') {
$format = ($outputlangs->trans("FormatDateShort") != "FormatDateShort" ? $outputlangs->trans("FormatDateShort") : $conf->format_date_short);
} elseif ($format == 'hour') {
$format = ($outputlangs->trans("FormatHourShort") != "FormatHourShort" ? $outputlangs->trans("FormatHourShort") : $conf->format_hour_short);
} elseif ($format == 'hourduration') {
$format = ($outputlangs->trans("FormatHourShortDuration") != "FormatHourShortDuration" ? $outputlangs->trans("FormatHourShortDuration") : $conf->format_hour_short_duration);
} elseif ($format == 'daytext') {
$format = ($outputlangs->trans("FormatDateText") != "FormatDateText" ? $outputlangs->trans("FormatDateText") : $conf->format_date_text);
} elseif ($format == 'daytextshort') {
$format = ($outputlangs->trans("FormatDateTextShort") != "FormatDateTextShort" ? $outputlangs->trans("FormatDateTextShort") : $conf->format_date_text_short);
} elseif ($format == 'dayhour') {
$format = ($outputlangs->trans("FormatDateHourShort") != "FormatDateHourShort" ? $outputlangs->trans("FormatDateHourShort") : $conf->format_date_hour_short);
} elseif ($format == 'dayhoursec') {
$format = ($outputlangs->trans("FormatDateHourSecShort") != "FormatDateHourSecShort" ? $outputlangs->trans("FormatDateHourSecShort") : $conf->format_date_hour_sec_short);
} elseif ($format == 'dayhourtext') {
$format = ($outputlangs->trans("FormatDateHourText") != "FormatDateHourText" ? $outputlangs->trans("FormatDateHourText") : $conf->format_date_hour_text);
} elseif ($format == 'dayhourtextshort') {
$format = ($outputlangs->trans("FormatDateHourTextShort") != "FormatDateHourTextShort" ? $outputlangs->trans("FormatDateHourTextShort") : $conf->format_date_hour_text_short);
} elseif ($format == 'dayhourlog') {
// Format not sensitive to language
$format = '%Y%m%d%H%M%S';
} elseif ($format == 'dayhourlogsmall') {
// Format not sensitive to language
$format = '%y%m%d%H%M';
} elseif ($format == 'dayhourldap') {
$format = '%Y%m%d%H%M%SZ';
} elseif ($format == 'dayhourxcard') {
$format = '%Y%m%dT%H%M%SZ';
} elseif ($format == 'dayxcard') {
$format = '%Y%m%d';
} elseif ($format == 'dayrfc') {
$format = '%Y-%m-%d'; // DATE_RFC3339
} elseif ($format == 'dayhourrfc') {
$format = '%Y-%m-%dT%H:%M:%SZ'; // DATETIME RFC3339
} elseif ($format == 'standard') {
$format = '%Y-%m-%d %H:%M:%S';
}
if ($reduceformat) {
$format = str_replace('%Y', '%y', $format);
$format = str_replace('yyyy', 'yy', $format);
}
// Clean format
if (preg_match('/%b/i', $format)) { // There is some text to translate
// We inhibit translation to text made by strftime functions. We will use trans instead later.
$format = str_replace('%b', '__b__', $format);
$format = str_replace('%B', '__B__', $format);
}
if (preg_match('/%a/i', $format)) { // There is some text to translate
// We inhibit translation to text made by strftime functions. We will use trans instead later.
$format = str_replace('%a', '__a__', $format);
$format = str_replace('%A', '__A__', $format);
}
// Analyze date
$reg = array();
if (preg_match('/^([0-9][0-9][0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])([0-9][0-9])$/i', (string) $time, $reg)) { // Deprecated. Ex: 1970-01-01, 1970-01-01 01:00:00, 19700101010000
dol_print_error(null, "Functions.lib::dol_print_date function called with a bad value from page ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_SERVER["PHP_SELF"]));
return '';
} elseif (preg_match('/^([0-9]+)\-([0-9]+)\-([0-9]+) ?([0-9]+)?:?([0-9]+)?:?([0-9]+)?/i', (string) $time, $reg)) { // Still available to solve problems in extrafields of type date
// This part of code should not be used anymore.
dol_syslog("Functions.lib::dol_print_date function called with a bad value from page ".(empty($_SERVER["PHP_SELF"]) ? 'unknown' : $_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((int) $shour, (int) $smin, (int) $ssec, (int) $smonth, (int) $sday, (int) $syear, true);
if ($to_gmt) {
$tzo = new DateTimeZone('UTC'); // when to_gmt is true, base for offsettz and offsetdst (so timetouse) is UTC
} else {
$tzo = new DateTimeZone(date_default_timezone_get()); // when to_gmt is false, base for offsettz and offsetdst (so timetouse) is PHP server
}
$dtts = new DateTime();
$dtts->setTimestamp($time);
$dtts->setTimezone($tzo);
$newformat = str_replace(
array('%Y', '%y', '%m', '%d', '%H', '%I', '%M', '%S', '%p', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
$format
);
$ret = $dtts->format($newformat);
$ret = str_replace(
array('__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
array('T', 'Z', '__a__', '__A__', '__b__', '__B__'),
$ret
);
} else {
// Date is a timestamps
if ($time < 100000000000) { // Protection against bad date values
$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', '%w', 'T', 'Z', '__a__', '__A__', '__b__', '__B__'),
array('Y', 'y', 'm', 'd', 'H', 'h', 'i', 's', 'A', 'w', '__£__', '__$__', '__{__', '__}__', '__[__', '__]__'),
$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 = (int) $dtts->format("m");
$month = sprintf("%02d", $month); // $month may be return with format '06' on some installation and '6' on other, so we force it to '06'.
if ($encodetooutput) {
$monthtext = $outputlangs->transnoentities('Month'.$month);
$monthtextshort = $outputlangs->transnoentities('MonthShort'.$month);
} else {
$monthtext = $outputlangs->transnoentitiesnoconv('Month'.$month);
$monthtextshort = $outputlangs->transnoentitiesnoconv('MonthShort'.$month);
}
//print 'monthtext='.$monthtext.' monthtextshort='.$monthtextshort;
$ret = str_replace('__b__', $monthtextshort, $ret);
$ret = str_replace('__B__', $monthtext, $ret);
//print 'x'.$outputlangs->charset_output.'-'.$ret.'x';
//return $ret;
}
if (preg_match('/__a__/i', $format)) {
//print "time=$time offsettz=$offsettz offsetdst=$offsetdst offsettzstring=$offsettzstring";
$timetouse = $time + $offsettz + $offsetdst; // TODO Replace this with function Date PHP. We also should not use anymore offsettz and offsetdst but only offsettzstring.
if ($to_gmt) {
$tzo = new DateTimeZone('UTC');
} else {
$tzo = new DateTimeZone(date_default_timezone_get());
}
$dtts = new DateTime();
$dtts->setTimestamp($timetouse);
$dtts->setTimezone($tzo);
$w = $dtts->format("w");
$dayweek = $outputlangs->transnoentitiesnoconv('Day'.$w);
$ret = str_replace('__A__', $dayweek, $ret);
$ret = str_replace('__a__', dol_substr($dayweek, 0, 3), $ret);
}
return $ret;
}
/**
* Return an array with locale date info.
* WARNING: This function use PHP server timezone by default to return locale information.
* Be aware to add the third parameter to "UTC" if you need to work on UTC.
*
* @param int $timestamp Timestamp
* @param boolean $fast Fast mode. deprecated.
* @param string $forcetimezone '' to use the PHP server timezone. Or use a form like 'gmt', 'Europe/Paris' or '+0200' to force timezone.
* @return array{}|array{seconds:int<0,59>,minutes:int<0,59>,hours:int<0,23>,mday:int<1,31>,wday:int<0,6>,mon:int<1,12>,year:int<0,9999>,yday:int<0,366>,0:int} Array of information
* 'seconds' => $secs,
* 'minutes' => $min,
* 'hours' => $hour,
* 'mday' => $day,
* 'wday' => $dow, 0=sunday, 6=saturday
* 'mon' => $month,
* 'year' => $year,
* 'yday' => floor($secsInYear/$_day_power)
* '0' => original timestamp
* @see dol_print_date(), dol_stringtotime(), dol_mktime()
*/
function dol_getdate($timestamp, $fast = false, $forcetimezone = '')
{
if ($timestamp === '') {
return array();
}
$datetimeobj = new DateTime();
$datetimeobj->setTimestamp($timestamp); // Use local PHP server timezone
if ($forcetimezone) {
$datetimeobj->setTimezone(new DateTimeZone($forcetimezone == 'gmt' ? 'UTC' : $forcetimezone)); // (add timezone relative to the date entered)
}
$arrayinfo = array(
'year' => ((int) date_format($datetimeobj, 'Y')),
'mon' => ((int) date_format($datetimeobj, 'm')),
'mday' => ((int) date_format($datetimeobj, 'd')),
'wday' => ((int) date_format($datetimeobj, 'w')),
'yday' => ((int) date_format($datetimeobj, 'z')),
'hours' => ((int) date_format($datetimeobj, 'H')),
'minutes' => ((int) date_format($datetimeobj, 'i')),
'seconds' => ((int) date_format($datetimeobj, 's')),
'0' => $timestamp
);
return $arrayinfo;
}
/**
* Return a timestamp date built from detailed information (by default a local PHP server timestamp)
* Replace function mktime not available under Windows if year < 1970
* PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows
*
* @param int $hour Hour (can be -1 for undefined)
* @param int $minute Minute (can be -1 for undefined)
* @param int $second Second (can be -1 for undefined)
* @param int $month Month (1 to 12)
* @param int $day Day (1 to 31)
* @param int $year Year
* @param bool|int|string $gm True or 1 or 'gmt'=Input information are GMT values
* False or 0 or 'tzserver' = local to server TZ
* 'auto'
* 'tzuser' = local to user TZ taking dst into account at the current date. Not yet implemented.
* 'tzuserrel' = local to user TZ taking dst into account at the given date. Use this one to convert date input from user into a GMT date.
* 'tz,TimeZone' = use specified timezone
* @param int $check 0=No check on parameters (Can use day 32, etc...)
* @return int|'' Date as a timestamp, '' if error
* @see dol_print_date(), dol_stringtotime(), dol_getdate()
*/
function dol_mktime($hour, $minute, $second, $month, $day, $year, $gm = 'auto', $check = 1)
{
global $conf;
//print "- ".$hour.",".$minute.",".$second.",".$month.",".$day.",".$year.",".$_SERVER["WINDIR"]." -";
if ($gm === 'auto') {
$gm = (empty($conf) ? 'tzserver' : $conf->tzuserinputkey);
}
//print 'gm:'.$gm.' gm === auto:'.($gm === 'auto').'<br>';exit;
// Clean parameters
if ($hour == -1 || empty($hour)) {
$hour = 0;
}
if ($minute == -1 || empty($minute)) {
$minute = 0;
}
if ($second == -1 || empty($second)) {
$second = 0;
}
// Check parameters
if ($check) {
if (!$month || !$day) {
return '';
}
if ($day > 31) {
return '';
}
if ($month > 12) {
return '';
}
if ($hour < 0 || $hour > 24) {
return '';
}
if ($minute < 0 || $minute > 60) {
return '';
}
if ($second < 0 || $second > 60) {
return '';
}
}
if (empty($gm) || ($gm === 'server' || $gm === 'tzserver')) {
$default_timezone = @date_default_timezone_get(); // Example 'Europe/Berlin'
$localtz = new DateTimeZone($default_timezone);
} elseif ($gm === 'user' || $gm === 'tzuser' || $gm === 'tzuserrel') {
// We use dol_tz_string first because it is more reliable.
$default_timezone = (empty($_SESSION["dol_tz_string"]) ? @date_default_timezone_get() : $_SESSION["dol_tz_string"]); // Example 'Europe/Berlin'
try {
$localtz = new DateTimeZone($default_timezone);
} catch (Exception $e) {
dol_syslog("Warning dol_tz_string contains an invalid value ".json_encode($_SESSION["dol_tz_string"] ?? null), LOG_WARNING);
$default_timezone = @date_default_timezone_get();
}
} elseif (strrpos($gm, "tz,") !== false) {
$timezone = 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;
}
/**
* Return date for now. In most cases, we use this function without parameters (that means GMT time).
*
* @param string $mode 'auto' => for backward compatibility (avoid this),
* 'gmt' => we return GMT timestamp,
* 'tzserver' => we add the PHP server timezone
* 'tzref' => we add the company timezone. Not implemented.
* 'tzuser' or 'tzuserrel' => we add the user timezone
* @return int $date Timestamp
*/
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;
}
/**
* Return string with formatted size
*
* @param int $size Size to print
* @param int $shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b)
* @param int $shortunit Use short label of size unit (for example 'b' instead of 'bytes')
* @return string Link
*/
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;
}
/**
* Show Url link
*
* @param string $url Url to show
* @param string $target Target for link
* @param int $max Max number of characters to show
* @param int $withpicto With picto
* @param string $morecss More CSS
* @return string HTML Link
*/
function dol_print_url($url, $target = '_blank', $max = 32, $withpicto = 0, $morecss = '')
{
global $langs;
if (empty($url)) {
return '';
}
$linkstart = '<a href="';
if (!preg_match('/^http/i', $url)) {
$linkstart .= 'http://';
}
$linkstart .= $url;
$linkstart .= '"';
if ($target) {
$linkstart .= ' target="'.$target.'"';
}
$linkstart .= ' title="'.$langs->trans("URL").': '.$url.'"';
$linkstart .= '>';
$link = '';
if (!preg_match('/^http/i', $url)) {
$link .= 'http://';
}
$link .= dol_trunc($url, $max);
$linkend = '</a>';
if ($morecss == 'float') { // deprecated
return '<div class="nospan'.($morecss ? ' '.$morecss : '').'" style="margin-right: 10px">'.($withpicto ? img_picto($langs->trans("Url"), 'globe', 'class="paddingrightonly"') : '').$link.'</div>';
} else {
return $linkstart.'<span class="nospan'.($morecss ? ' '.$morecss : '').'" style="margin-right: 10px">'.($withpicto ? img_picto('', 'globe', 'class="paddingrightonly"') : '').$link.'</span>'.$linkend;
}
}
/**
* Show EMail link formatted for HTML output.
*
* @param string $email EMail to show (only email, without 'Name of recipient' before)
* @param int $cid Id of contact if known
* @param int $socid Id of third party if known
* @param int|string $addlink 0=no link, 1=email has a html email link (+ link to create action if constant AGENDA_ADDACTIONFOREMAIL is on), 'thirdparty'=link to the thirdparty presend email
* @param int $max Max number of characters to show. Use -1 to hide the mail text and show only the picto.
* @param int $showinvalid 1=Show warning if syntax email is wrong
* @param int|string $withpicto 0=Show email, 1=Show picto of email + email, 2=Show only picto
* @param string $morecss More CSS
* @return string HTML Link
*/
function dol_print_email($email, $cid = 0, $socid = 0, $addlink = 0, $max = 64, $showinvalid = 1, $withpicto = 0, $morecss = 'paddingrightonly')
{
global $user, $langs, $hookmanager;
//global $conf; $conf->global->AGENDA_ADDACTIONFOREMAIL = 1;
//$showinvalid = 1; $email = 'rrrrr';
$newemail = dol_escape_htmltag($email);
if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') && $withpicto) {
$withpicto = 0;
}
if (empty($email)) {
return ' ';
}
if ($addlink == 1) {
$newemail = '<a class="'.($morecss ? $morecss : '').'" style="text-overflow: ellipsis;" href="';
if (!preg_match('/^mailto:/i', $email)) {
$newemail .= 'mailto:';
}
$newemail .= $email;
$newemail .= '" target="_blank">';
$newemail .= ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '');
if ($max > 0) {
$newemail .= dol_trunc($email, $max);
} else {
$newemail .= $email;
}
$newemail .= '</a>';
if ($showinvalid && !isValidEmail($email)) {
$langs->load("errors");
$newemail .= img_warning($langs->trans("ErrorBadEMail", $email), '', 'paddingrightonly');
}
if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
$type = 'AC_EMAIL';
$linktoaddaction = '';
if (getDolGlobalString('AGENDA_ADDACTIONFOREMAIL')) {
$linktoaddaction = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&backtopage=1&actioncode='.urlencode($type).'&contactid='.((int) $cid).'&socid='.((int) $socid).'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
}
if ($linktoaddaction) {
$newemail = '<div>'.$newemail.' '.$linktoaddaction.'</div>';
}
}
} elseif ($addlink === 'thirdparty') {
$tmpnewemail = '<a class="'.($morecss ? $morecss : '').'" style="text-overflow: ellipsis;" href="'.DOL_URL_ROOT.'/societe/card.php?socid='.$socid.'&action=presend&mode=init#formmailbeforetitle">';
$tmpnewemail .= ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '');
if ($withpicto == 1) {
$tmpnewemail .= $newemail;
}
$tmpnewemail .= '</a>';
$newemail = $tmpnewemail;
} else {
$newemail = ($withpicto ? img_picto($langs->trans("EMail").' : '.$email, (is_numeric($withpicto) ? 'email' : $withpicto), 'class="paddingrightonly"') : '').$newemail;
if ($showinvalid && !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), 'class="paddingrightonly"') : '').$newemail;
//$rep .= '</div>';
$rep = $newemail;
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;
}
/**
* Get array of social network dictionary
*
* @return array<string,array{rowid:int,label:string,url:string,icon:string,active:int}> Array of Social Networks Dictionary
*/
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;
}
/**
* Show social network link
*
* @param string $value Social network ID to show (only skype, without 'Name of recipient' before)
* @param int $cid Id of contact if known
* @param int $socid Id of third party if known
* @param string $type 'skype','facebook',...
* @param array<string,array{rowid:int,label:string,url:string,icon:string,active:int}> $dictsocialnetworks List of socialnetworks available
* @return string HTML Link
*/
function dol_print_socialnetworks($value, $cid, $socid, $type, $dictsocialnetworks = array())
{
global $hookmanager, $langs, $user;
$htmllink = $value;
if (empty($value)) {
return ' ';
}
if (!empty($type)) {
$htmllink = '<div class="divsocialnetwork inline-block valignmiddle">';
// Use dictionary definition for picto $dictsocialnetworks[$type]['icon']
$htmllink .= '<span class="fab pictofixedwidth '.($dictsocialnetworks[$type]['icon'] ? $dictsocialnetworks[$type]['icon'] : 'fa-link').'"></span>';
if ($type == 'skype') {
$htmllink .= dol_escape_htmltag($value);
$htmllink .= ' <a href="skype:';
$htmllink .= dol_string_nospecial($value, '_', '', array('@'));
$htmllink .= '?call" alt="'.$langs->trans("Call").' '.$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").' '.$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->hasRight('agenda', 'myactions', 'create')) {
$addlink = 'AC_SKYPE';
$link = '';
if (getDolGlobalString('AGENDA_ADDACTIONFORSKYPE')) {
$link = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&backtopage=1&actioncode='.$addlink.'&contactid='.$cid.'&socid='.$socid.'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
}
$htmllink .= ($link ? ' '.$link : '');
}
} else {
$networkconstname = 'MAIN_INFO_SOCIETE_'.strtoupper($type).'_URL';
if (getDolGlobalString($networkconstname)) {
$link = str_replace('{socialid}', $value, getDolGlobalString($networkconstname));
$valuetoshow = $value;
if (preg_match('/^https?:\/\//i', $link)) {
$valuetoshow = preg_replace('/https:\/\/www\.linkedin\./', 'linkedin.', $valuetoshow);
//$valuetoshow = preg_replace('/www\.twitter\./', 'twitter.', $valuetoshow);
$htmllink .= '<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($valuetoshow).'</a>';
} elseif ($link) {
$htmllink .= '<a href="'.dol_sanitizeUrl($link, 1).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($valuetoshow).'</a>';
}
} elseif (!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 .= '<a href="'.dol_sanitizeUrl($link, 0).'" target="_blank" rel="noopener noreferrer">'.dol_escape_htmltag($value).'</a>';
} else {
$htmllink .= '<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));
}
if ($hookmanager) {
$parameters = array(
'value' => $value,
'cid' => $cid,
'socid' => $socid,
'type' => $type,
'dictsocialnetworks' => $dictsocialnetworks,
);
$reshook = $hookmanager->executeHooks('printSocialNetworks', $parameters);
if ($reshook > 0) {
$htmllink = '';
}
$htmllink .= $hookmanager->resPrint;
}
return $htmllink;
}
/**
* Format professional IDs according to their country
*
* @param string $profID Value of profID to format
* @param string $profIDtype Type of profID to format ('1', '2', '3', '4', '5', '6' or 'VAT')
* @param string $countrycode Country code to use for formatting
* @param int<0,2> $addcpButton Add button to copy to clipboard (1 => show only on hoover ; 2 => always display )
* @return string Formatted profID
*/
function dol_print_profids($profID, $profIDtype, $countrycode = '', $addcpButton = 1)
{
global $mysoc;
if (empty($profID) || empty($profIDtype)) {
return '';
}
if (empty($countrycode)) {
$countrycode = $mysoc->country_code;
}
$newProfID = $profID;
$id = substr($profIDtype, -1);
$ret = '';
if (strtoupper($countrycode) == 'FR') {
// France
// (see https://www.economie.gouv.fr/entreprises/numeros-identification-entreprise)
if ($id == 1 && dol_strlen($newProfID) == 9) {
// SIREN (ex: 123 123 123)
$newProfID = substr($newProfID, 0, 3).' '.substr($newProfID, 3, 3).' '.substr($newProfID, 6, 3);
}
if ($id == 2 && dol_strlen($newProfID) == 14) {
// SIRET (ex: 123 123 123 12345)
$newProfID = substr($newProfID, 0, 3).' '.substr($newProfID, 3, 3).' '.substr($newProfID, 6, 3).' '.substr($newProfID, 9, 5);
}
if ($id == 3 && dol_strlen($newProfID) == 5) {
// NAF/APE (ex: 69.20Z)
$newProfID = substr($newProfID, 0, 2).'.'.substr($newProfID, 2, 3);
}
if ($profIDtype === 'VAT' && dol_strlen($newProfID) == 13) {
// TVA intracommunautaire (ex: FR12 123 123 123)
$newProfID = substr($newProfID, 0, 4).' '.substr($newProfID, 4, 3).' '.substr($newProfID, 7, 3).' '.substr($newProfID, 10, 3);
}
}
if (!empty($addcpButton)) {
$ret = showValueWithClipboardCPButton(dol_escape_htmltag($profID), ($addcpButton == 1 ? 1 : 0), $newProfID);
} else {
$ret = $newProfID;
}
return $ret;
}
/**
* Format phone numbers according to country
*
* @param string $phone Phone number to format
* @param string $countrycode Country code to use for formatting
* @param int $cid Id of contact if known
* @param int $socid Id of third party if known
* @param string $addlink ''=no link to create action, 'AC_TEL'=add link to clicktodial (if module enabled) and add link to create event (if conf->global->AGENDA_ADDACTIONFORPHONE set), 'tel'=Force "tel:..." link
* @param string $separ Separation between numbers for a better visibility example : xx.xx.xx.xx.xx. You can also use 'hidenum' to hide the number, keep only the picto.
* @param string $withpicto Show picto ('fax', 'phone', 'mobile')
* @param string $titlealt Text to show on alt
* @param int $adddivfloat Add div float around phone.
* @param string $morecss Add more css
* @return string Formatted phone number
*/
function dol_print_phone($phone, $countrycode = '', $cid = 0, $socid = 0, $addlink = '', $separ = " ", $withpicto = '', $titlealt = '', $adddivfloat = 0, $morecss = 'paddingright')
{
global $conf, $user, $langs, $mysoc, $hookmanager;
// Clean phone parameter
$phone = is_null($phone) ? '' : preg_replace("/[\s.-]/", "", trim($phone));
if (empty($phone)) {
return '';
}
if (getDolGlobalString('MAIN_PHONE_SEPAR')) {
$separ = getDolGlobalString('MAIN_PHONE_SEPAR');
}
if (empty($countrycode) && is_object($mysoc)) {
$countrycode = $mysoc->country_code;
}
// Short format for small screens
if (!empty($conf->dol_optimize_smallscreen) && $separ != 'hidenum') {
$separ = '';
}
$newphone = $phone;
$newphonewa = $phone;
if (strtoupper($countrycode) == "FR") {
// France
if (dol_strlen($phone) == 10) {
$newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 2).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2);
} elseif (dol_strlen($phone) == 7) {
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2);
} elseif (dol_strlen($phone) == 9) {
$newphone = substr($newphone, 0, 2).$separ.substr($newphone, 2, 3).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2);
} elseif (dol_strlen($phone) == 11) {
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 2).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2);
} elseif (dol_strlen($phone) == 12) {
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 1).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
} elseif (dol_strlen($phone) == 13) {
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 3).$separ.substr($newphone, 11, 2);
}
} elseif (strtoupper($countrycode) == "CA") {
if (dol_strlen($phone) == 10) {
$newphone = ($separ != '' ? '(' : '').substr($newphone, 0, 3).($separ != '' ? ')' : '').$separ.substr($newphone, 3, 3).($separ != '' ? '-' : '').substr($newphone, 6, 4);
}
} elseif (strtoupper($countrycode) == "PT") {//Portugal
if (dol_strlen($phone) == 13) {//ex: +351_ABC_DEF_GHI
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3).$separ.substr($newphone, 10, 3);
}
} elseif (strtoupper($countrycode) == "SR") {//Suriname
if (dol_strlen($phone) == 10) {//ex: +597_ABC_DEF
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 3);
} elseif (dol_strlen($phone) == 11) {//ex: +597_ABC_DEFG
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 4);
}
} elseif (strtoupper($countrycode) == "DE") {//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) {// fix 6 digits +352_AA_BB_CC
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2);
} elseif (dol_strlen($phone) == 11) {// fix 7 digits +352_AA_BB_CC_D
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 1);
} elseif (dol_strlen($phone) == 12) {// fix 8 digits +352_AA_BB_CC_DD
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 2).$separ.substr($newphone, 6, 2).$separ.substr($newphone, 8, 2).$separ.substr($newphone, 10, 2);
} elseif (dol_strlen($phone) == 13) {// mobile +352_AAA_BB_CC_DD
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 7, 2).$separ.substr($newphone, 9, 2).$separ.substr($newphone, 11, 2);
}
} elseif (strtoupper($countrycode) == "PE") {
// Peru
if (dol_strlen($phone) == 7) {// fix 7 chiffres without code AAA_BBBB
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 4);
} elseif (dol_strlen($phone) == 9) {// mobile add code and fix 9 chiffres +51_AAA_BBB_CCC
$newphonewa = '+51'.$newphone;
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 10, 3);
} elseif (dol_strlen($phone) == 11) {// fix 11 chiffres +511_AAA_BBBB
$newphone = substr($newphone, 0, 4).$separ.substr($newphone, 4, 3).$separ.substr($newphone, 8, 4);
} elseif (dol_strlen($phone) == 12) {// mobile +51_AAA_BBB_CCC
$newphonewa = $newphone;
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 3).$separ.substr($newphone, 6, 3).$separ.substr($newphone, 10, 3).$separ.substr($newphone, 14, 3);
}
} elseif (strtoupper($countrycode) == "IN") {//India
if (dol_strlen($phone) == 13) {
if ($withpicto == 'phone') {//ex: +91_AB_CDEF_GHIJ
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 2).$separ.substr($newphone, 5, 4).$separ.substr($newphone, 9, 4);
} else {//ex: +91_ABCDE_FGHIJ
$newphone = substr($newphone, 0, 3).$separ.substr($newphone, 3, 5).$separ.substr($newphone, 8, 5);
}
}
}
$newphoneastart = $newphoneaend = '';
if (!empty($addlink)) { // Link on phone number (+ link to add action if conf->global->AGENDA_ADDACTIONFORPHONE set)
if ($addlink == 'tel' || $conf->browser->layout == 'phone' || (isModEnabled('clicktodial') && getDolGlobalString('CLICKTODIAL_USE_TEL_LINK_ON_PHONE_NUMBERS'))) { // If phone or option for, we use link of phone
$newphoneastart = '<a href="tel:'.urlencode($phone).'">';
$newphoneaend .= '</a>';
} elseif (isModEnabled('clicktodial') && $addlink == 'AC_TEL') { // If click to dial, we use click to dial url
if (empty($user->clicktodial_loaded)) {
$user->fetch_clicktodial();
}
// Define urlmask
$urlmask = getDolGlobalString('CLICKTODIAL_URL', 'ErrorClickToDialModuleNotConfigured');
if (!empty($user->clicktodial_url)) {
$urlmask = $user->clicktodial_url;
}
$clicktodial_poste = (!empty($user->clicktodial_poste) ? urlencode($user->clicktodial_poste) : '');
$clicktodial_login = (!empty($user->clicktodial_login) ? urlencode($user->clicktodial_login) : '');
$clicktodial_password = (!empty($user->clicktodial_password) ? urlencode($user->clicktodial_password) : '');
// This line is for backward compatibility @phan-suppress-next-line PhanPluginPrintfVariableFormatString
$url = sprintf($urlmask, urlencode($phone), $clicktodial_poste, $clicktodial_login, $clicktodial_password);
// Those lines are for substitution
$substitarray = array('__PHONEFROM__' => $clicktodial_poste,
'__PHONETO__' => urlencode($phone),
'__LOGIN__' => $clicktodial_login,
'__PASS__' => $clicktodial_password);
$url = make_substitutions($url, $substitarray);
if (!getDolGlobalString('CLICKTODIAL_DO_NOT_USE_AJAX_CALL')) {
// Default and recommended: New method using ajax without submitting a page making a javascript history.go(-1) back
$newphoneastart = '<a href="'.$url.'" class="cssforclicktodial">'; // Call of ajax is handled by the lib_foot.js.php on class 'cssforclicktodial'
$newphoneaend = '</a>';
} else {
// Old method
$newphoneastart = '<a href="'.$url.'"';
if (getDolGlobalString('CLICKTODIAL_FORCENEWTARGET')) {
$newphoneastart .= ' target="_blank" rel="noopener noreferrer"';
}
$newphoneastart .= '>';
$newphoneaend .= '</a>';
}
}
//if (($cid || $socid) && isModEnabled('agenda') && $user->hasRight('agenda', 'myactions', 'create'))
if (isModEnabled('agenda') && $user->hasRight("agenda", "myactions", "create")) {
$type = 'AC_TEL';
$addlinktoagenda = '';
if ($addlink == 'AC_FAX') {
$type = 'AC_FAX';
}
if (getDolGlobalString('AGENDA_ADDACTIONFORPHONE')) {
$addlinktoagenda = '<a href="'.DOL_URL_ROOT.'/comm/action/card.php?action=create&backtopage='. urlencode($_SERVER['REQUEST_URI']) .'&actioncode='.$type.($cid ? '&contactid='.$cid : '').($socid ? '&socid='.$socid : '').'">'.img_object($langs->trans("AddAction"), "calendar").'</a>';
}
if ($addlinktoagenda) {
$newphone = '<span>'.$newphone.' '.$addlinktoagenda.'</span>';
}
}
}
if (getDolGlobalString('CONTACT_PHONEMOBILE_SHOW_LINK_TO_WHATSAPP') && $withpicto == 'mobile') {
// Link to Whatsapp
$newphone .= ' <a href="https://wa.me/'.$newphonewa.'" target="_blank"';// Use api to whatasapp contacts
$newphone .= '><span class="paddingright fab fa-whatsapp" style="color:#25D366;" title="WhatsApp"></span></a>';
}
if (empty($titlealt)) {
$titlealt = ($withpicto == 'fax' ? $langs->trans("Fax") : $langs->trans("Phone"));
}
$rep = '';
if ($hookmanager) {
$parameters = array('countrycode' => $countrycode, 'cid' => $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 == 1) {
$rep .= '<div class="nospan float'.($morecss ? ' '.$morecss : '').'">';
} elseif (empty($adddivfloat)) {
$rep .= '<span'.($morecss ? ' class="'.$morecss.'"' : '').'>';
}
$rep .= $newphoneastart;
$rep .= ($withpicto ? img_picto($titlealt, 'object_'.$picto.'.png') : '');
if ($separ != 'hidenum') {
$rep .= ($withpicto ? ' ' : '').$newphone;
}
$rep .= $newphoneaend;
if ($adddivfloat == 1) {
$rep .= '</div>';
} elseif (empty($adddivfloat)) {
$rep .= '</span>';
}
}
return $rep;
}
/**
* Return an IP formatted to be shown on screen
*
* @param string $ip IP
* @param int $mode 0=return IP + country/flag, 1=return only country/flag, 2=return only IP
* @param int $showname 1=Show reverse domain name instead of IP
* @return string Formatted IP, with country if GeoIP module is enabled
*/
function dol_print_ip($ip, $mode = 0, $showname = 0)
{
global $conf;
$ret = '';
if (!isset($conf->cache['resolveips'])) {
$conf->cache['resolveips'] = array();
}
if ($mode != 2) {
$countrycode = dolGetCountryCodeFromIp($ip);
if ($countrycode) { // If success, countrycode is us, fr, ...
if (file_exists(DOL_DOCUMENT_ROOT.'/theme/common/flags/'.$countrycode.'.png')) {
$ret .= picto_from_langcode($countrycode);
// $ret .= img_picto($countrycode.' '.$langs->trans("AccordingToGeoIPDatabase"), DOL_URL_ROOT.'/theme/common/flags/'.$countrycode.'.png', '', 1);
} else {
$ret .= '('.$countrycode.')';
}
$ret .= ' ';
} else {
// Nothing
}
}
if (in_array($mode, [0, 2])) {
$domain = '';
if ($showname) {
if (!array_key_exists($ip, $conf->cache['resolveips'])) {
$domain = gethostbyaddr($ip);
$conf->cache['resolveips'][$ip] = $domain; // false or domain
} else {
$domain = $conf->cache['resolveips'][$ip];
}
}
if ($domain) {
$ret .= $domain;
} else {
$ret .= $ip;
}
}
return $ret;
}
/**
* Return the real IP of remote user.
* Take HTTP_X_FORWARDED_FOR (defined when using proxy)
* Then HTTP_CLIENT_IP if defined (rare)
* Then REMOTE_ADDR (the last seerver ip in proxy chain).
* REMOTE_ADDR can't be modified by client and may be the IP of a proxy.
* Note: that if Apache module "remoteip" module is on, $_SERVER["REMOTE_ADDR"] may be replaced y HTTP_X_FORWARDED_FOR directly
* from CF-Connecting-IP, but only if remote is in trusted cloudflare list.
*
* @param int $trusted 0=Default, 1=Trusted value (the last IP that was not altered by client)
* @return string Real IP of remote user.
*/
function getUserRemoteIP($trusted = 0)
{
if ($trusted) { // Return only IP we can rely on (not spoofable by the client)
$ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']); // value may be the IP of a proxy
// Note that if apache module remoteip has been enabled, REMOTE_ADDR can contain the real client (the value from cloudFlare HTTP_CF_CONNECTING_IP for example)
// This can happen if the proxy were added in the list of trusted proxy.
return $ip;
}
// Try to guess the real IP of client (but this may not be reliable)
if (empty($_SERVER['HTTP_X_FORWARDED_FOR']) || preg_match('/[^0-9\.\:,\[\]\s]/', $_SERVER['HTTP_X_FORWARDED_FOR'])) {
if (empty($_SERVER['HTTP_CLIENT_IP']) || preg_match('/[^0-9\.\:,\[\]\s]/', $_SERVER['HTTP_CLIENT_IP'])) {
if (empty($_SERVER["HTTP_CF_CONNECTING_IP"])) {
$ip = (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']); // value may be the IP of the proxy and not the client
} else {
$ip = $_SERVER["HTTP_CF_CONNECTING_IP"]; // value here may have been forged by client
}
} else {
$ip = preg_replace('/,.*$/', '', $_SERVER['HTTP_CLIENT_IP']); // value is clean here but may have been forged by proxy
}
} else {
$ip = preg_replace('/,.*$/', '', $_SERVER['HTTP_X_FORWARDED_FOR']); // value is clean here but may have been forged by proxy
}
return $ip;
}
/**
* Return if we are using a HTTPS connection
* Check HTTPS (no way to be modified by user but may be empty or wrong if user is using a proxy)
* Take HTTP_X_FORWARDED_PROTO (defined when using proxy)
* Then HTTP_X_FORWARDED_SSL
*
* @return boolean True if user is using HTTPS
*/
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;
}
/**
* Return a country code from IP. Empty string if not found.
*
* @param string $ip IP
* @return string Country code ('us', 'fr', ...)
*/
function dolGetCountryCodeFromIp($ip)
{
$countrycode = '';
if (isModEnabled('geoipmaxmind')) {
$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)
if ($datafile) {
try {
include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
$geoip = new DolGeoIP('country', $datafile);
//print 'ip='.$ip.' databaseType='.$geoip->gi->databaseType." GEOIP_CITY_EDITION_REV1=".GEOIP_CITY_EDITION_REV1."\n";
$countrycode = $geoip->getCountryCodeFromIP($ip);
} catch (Exception $e) {
//print 'Error with GeoIP database: '.$e->getMessage();
}
}
}
return $countrycode;
}
/**
* Return country code for current user.
* If software is used inside a local network, detection may fails (we need a public ip)
*
* @return string Country code (fr, es, it, us, ...)
*/
function dol_user_country()
{
global $conf, $langs, $user;
//$ret=$user->xxx;
$ret = '';
if (isModEnabled('geoipmaxmind')) {
$ip = getUserRemoteIP();
$datafile = getDolGlobalString('GEOIPMAXMIND_COUNTRY_DATAFILE');
//$ip='24.24.24.24';
//$datafile='E:\Mes Sites\Web\Admin1\awstats\maxmind\GeoIP.dat';
include_once DOL_DOCUMENT_ROOT.'/core/class/dolgeoip.class.php';
$geoip = new DolGeoIP('country', $datafile);
$countrycode = $geoip->getCountryCodeFromIP($ip);
$ret = $countrycode;
}
return $ret;
}
/**
* Format address string
*
* @param string $address Address string, already formatted with dol_format_address()
* @param string $htmlid Html ID (for example 'gmap')
* @param string $element 'thirdparty'|'contact'|'member'|'user'|'other'
* @param int $id Id of object
* @param int $noprint No output. Result is the function return
* @param string $charfornl Char to use instead of nl2br. '' means we use a standad nl2br.
* @return ?string Nothing if noprint is 0, formatted address if noprint is 1
* @see dol_format_address()
*/
function dol_print_address($address, $htmlid, $element, $id, $noprint = 0, $charfornl = '')
{
global $hookmanager;
$out = '';
if ($address) {
if ($hookmanager) {
$parameters = array('element' => $element, 'id' => $id);
$reshook = $hookmanager->executeHooks('printAddress', $parameters, $address);
$out .= $hookmanager->resPrint;
}
if (empty($reshook)) {
if (empty($charfornl)) {
$out .= nl2br((string) $address);
} else {
$out .= preg_replace('/[\r\n]+/', $charfornl, (string) $address);
}
// TODO Remove this block, we can add this using the hook now
$showgmap = $showomap = 0;
if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS')) {
$showgmap = 1;
}
if ($element == 'contact' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_CONTACTS')) {
$showgmap = 1;
}
if ($element == 'member' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_MEMBERS')) {
$showgmap = 1;
}
if ($element == 'user' && isModEnabled('google') && getDolGlobalString('GOOGLE_ENABLE_GMAPS_USERS')) {
$showgmap = 1;
}
if (($element == 'thirdparty' || $element == 'societe') && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS')) {
$showomap = 1;
}
if ($element == 'contact' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_CONTACTS')) {
$showomap = 1;
}
if ($element == 'member' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_MEMBERS')) {
$showomap = 1;
}
if ($element == 'user' && isModEnabled('openstreetmap') && getDolGlobalString('OPENSTREETMAP_ENABLE_MAPS_USERS')) {
$showomap = 1;
}
if ($showgmap) {
$url = dol_buildpath('/google/gmaps.php?mode='.$element.'&id='.$id, 1);
$out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
}
if ($showomap) {
$url = dol_buildpath('/openstreetmap/maps.php?mode='.$element.'&id='.$id, 1);
$out .= ' <a href="'.$url.'" target="_gmaps"><img id="'.$htmlid.'_openstreetmap" class="valigntextbottom" src="'.DOL_URL_ROOT.'/theme/common/gmap.png"></a>';
}
}
}
if ($noprint) {
return $out;
} else {
print $out;
return null;
}
}
/**
* Return true if email syntax is ok.
*
* @param string $address email (Ex: "toto@example.com". Long form "John Do <johndo@example.com>" will be false)
* @param int $acceptsupervisorkey If 1, the special string '__SUPERVISOREMAIL__' is also accepted as valid
* @param int $acceptuserkey If 1, the special string '__USER_EMAIL__' is also accepted as valid
* @return boolean true if email syntax is OK, false if KO or empty string
* @see isValidMXRecord()
*/
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;
}
/**
* Return if the domain name has a valid MX record.
* WARNING: This need function idn_to_ascii, checkdnsrr and getmxrr
*
* @param string $domain Domain name (Ex: "yahoo.com", "yhaoo.com", "dolibarr.fr")
* @return int -1 if error (function not available), 0=Not valid, 1=Valid
* @see isValidEmail()
* @suppress PhanDeprecatedFunctionInternal Error in Phan plugins incorrectly tags some functions here
*/
function isValidMXRecord($domain)
{
if (function_exists('idn_to_ascii') && function_exists('checkdnsrr')) {
if (!checkdnsrr(idn_to_ascii($domain), 'MX')) {
return 0;
}
if (function_exists('getmxrr')) {
$mxhosts = array();
$weight = array();
getmxrr(idn_to_ascii($domain), $mxhosts, $weight);
if (count($mxhosts) > 1) {
return 1;
}
if (count($mxhosts) == 1 && !in_array((string) $mxhosts[0], array('', '.'))) {
return 1;
}
return 0;
}
}
// function idn_to_ascii or checkdnsrr or getmxrr does not exists
return -1;
}
/**
* Return true if phone number syntax is ok
* TODO Decide what to do with this
*
* @param string $phone phone (Ex: "0601010101")
* @return boolean true if phone syntax is OK, false if KO or empty string
*/
function isValidPhone($phone)
{
return true;
}
/**
* Return first letters of a strings.
* Example with nbofchar=1: 'ghi' will return 'g' but 'abc def' will return 'ad'
* Example with nbofchar=2: 'ghi' will return 'gh' but 'abc def' will return 'abde'
*
* @param string $s String to truncate
* @param int $nbofchar Nb of characters to keep
* @return string Return first chars.
*/
function dolGetFirstLetters($s, $nbofchar = 1)
{
$ret = '';
$tmparray = explode(' ', $s);
foreach ($tmparray as $tmps) {
$ret .= dol_substr($tmps, 0, $nbofchar);
}
return $ret;
}
/**
* Make a strlen call. Works even if mbstring module not enabled
*
* @param string $string String to calculate length
* @param string $stringencoding Encoding of string
* @return int Length of string
*/
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);
}
}
/**
* Make a substring. Works even if mbstring module is not enabled for better compatibility.
*
* @param string $string String to scan
* @param int $start Start position (0 for first char)
* @param int|null $length Length (in nb of characters or nb of bytes depending on trunconbytes param)
* @param string $stringencoding Page code used for input string encoding
* @param int $trunconbytes 1=Length is max of bytes instead of max of characters
* @return string substring
*/
function dol_substr($string, $start, $length = null, $stringencoding = '', $trunconbytes = 0)
{
global $langs;
if (empty($stringencoding)) {
$stringencoding = (empty($langs) ? 'UTF-8' : $langs->charset_output);
}
$ret = '';
if (empty($trunconbytes)) {
if (function_exists('mb_substr')) {
$ret = mb_substr($string, $start, $length, $stringencoding);
} else {
$ret = substr($string, $start, $length);
}
} else {
if (function_exists('mb_strcut')) {
$ret = mb_strcut($string, $start, $length, $stringencoding);
} else {
$ret = substr($string, $start, $length);
}
}
return $ret;
}
/**
* Truncate a string to a particular length adding '…' if string larger than length.
* If length = max length+1, we do no truncate to avoid having just 1 char replaced with '…'.
* MAIN_DISABLE_TRUNC=1 can disable all truncings
*
* @param string $string String to truncate
* @param int $size Max string size visible (excluding …). 0 for no limit. WARNING: Final string size can have 3 more chars (if we added …, or if size was max+1 so it does not worse to replace with ...)
* @param string $trunc Where to trunc: 'right', 'left', 'middle' (size must be a 2 power), 'wrap'
* @param string $stringencoding Tell what is source string encoding
* @param int $nodot Truncation do not add … after truncation. So it's an exact truncation.
* @param int $display Trunc is used to display data and can be changed for small screen. TODO Remove this param (must be dealt with CSS)
* @return string Truncated string. WARNING: length is never higher than $size if $nodot is set, but can be 3 chars higher otherwise.
*/
function dol_trunc($string, $size = 40, $trunc = 'right', $stringencoding = 'UTF-8', $nodot = 0, $display = 0)
{
global $conf;
if (empty($size) || getDolGlobalString('MAIN_DISABLE_TRUNC')) {
return $string;
}
if (empty($stringencoding)) {
$stringencoding = 'UTF-8';
}
// reduce for small screen
if (!empty($conf->dol_optimize_smallscreen) && $conf->dol_optimize_smallscreen == 1 && $display == 1) {
$size = round($size / 3);
}
// We go always here
if ($trunc == 'right') {
$newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
// If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
return dol_substr($newstring, 0, $size, $stringencoding).($nodot ? '' : '…');
} else {
//return 'u'.$size.'-'.$newstring.'-'.dol_strlen($newstring,$stringencoding).'-'.$string;
return $string;
}
} elseif ($trunc == 'middle') {
$newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
if (dol_strlen($newstring, $stringencoding) > 2 && dol_strlen($newstring, $stringencoding) > ($size + 1)) {
$size1 = (int) round($size / 2);
$size2 = (int) round($size / 2);
return dol_substr($newstring, 0, $size1, $stringencoding).'…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size2, $size2, $stringencoding);
} else {
return $string;
}
} elseif ($trunc == 'left') {
$newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
if (dol_strlen($newstring, $stringencoding) > ($size + ($nodot ? 0 : 1))) {
// If nodot is 0 and size is 1 chars more, we don't trunc and don't add …
return '…'.dol_substr($newstring, dol_strlen($newstring, $stringencoding) - $size, $size, $stringencoding);
} else {
return $string;
}
} elseif ($trunc == 'wrap') {
$newstring = dol_textishtml($string) ? dol_string_nohtmltag($string, 1) : $string;
if (dol_strlen($newstring, $stringencoding) > ($size + 1)) {
return dol_substr($newstring, 0, $size, $stringencoding)."\n".dol_trunc(dol_substr($newstring, $size, dol_strlen($newstring, $stringencoding) - $size, $stringencoding), $size, $trunc);
} else {
return $string;
}
} else {
return 'BadParam3CallingDolTrunc';
}
}
/**
* Return the picto for a data type
*
* @param string $key Key
* @param string $morecss Add more css to the object
* @return string Pïcto for the key
*/
function getPictoForType($key, $morecss = '')
{
// Set array with type -> picto
$type2picto = array(
'varchar' => 'font',
'text' => 'font',
'html' => 'code',
'int' => 'sort-numeric-down',
'double' => 'sort-numeric-down',
'price' => 'currency',
'pricecy' => 'multicurrency',
'password' => 'key',
'boolean' => 'check-square',
'date' => 'calendar',
'datetime' => 'calendar',
'duration' => 'hourglass',
'phone' => 'phone',
'mail' => 'email',
'url' => 'url',
'ip' => 'country',
'select' => 'list',
'sellist' => 'list',
'stars' => 'fontawesome_star_fas',
'radio' => 'check-circle',
'checkbox' => 'list',
'chkbxlst' => 'list',
'link' => 'link',
'icon' => "question",
'point' => "country",
'multipts' => 'country',
'linestrg' => "country",
'polygon' => "country",
'separate' => 'minus'
);
if (!empty($type2picto[$key])) {
return img_picto('', $type2picto[$key], 'class="pictofixedwidth'.($morecss ? ' '.$morecss : '').'"');
}
return img_picto('', 'generic', 'class="pictofixedwidth'.($morecss ? ' '.$morecss : '').'"');
}
/**
* Show picto whatever it's its name (generic function)
*
* @param string $titlealt Text on title tag for tooltip. Not used if param notitle is set to 1.
* @param string $picto Name of image file to show ('filenew', ...).
* For font awesome icon (example 'user'), you can use picto_nocolor to not have the color of picto forced.
* If no extension provided and it is not a font awesome icon, we use '.png'. Image must be stored into theme/xxx/img directory.
* Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
* Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
* Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
* Example: fontawesome_envelope-open-text_fas_red_1em if you want to use fontaweseome icons: fontawesome_<icon-name>_<style>_<color>_<size> (only icon-name is mandatory)
* @param string $moreatt Add more attribute on img tag (For example 'class="pictofixedwidth"')
* @param int<0,1> $pictoisfullpath If true or 1, image path is a full path, 0 if not
* @param int $srconly Return only content of the src attribute of img.
* @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
* @param string $alt Force alt for blind people
* @param string $morecss Add more class css on img tag (For example 'myclascss').
* @param int $marginleftonlyshort 1 = Add a short left margin on picto, 2 = Add a larger left margin on picto, 0 = No margin left. Works for fontawesome picto only.
* @param string[] $allowothertags List of other tags allowed in title and alt attribute
* @return string Return img tag
* @see img_object(), img_picto_common()
*/
function img_picto($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $srconly = 0, $notitle = 0, $alt = '', $morecss = '', $marginleftonlyshort = 2, $allowothertags = array())
{
global $conf;
// 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;
if (empty($picto)) {
$picto = 'generic';
}
// 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 {
// $picto can not be null since replaced with 'generic' in that case
//$pictowithouttext = preg_replace('/(\.png|\.gif|\.svg)$/', '', (is_null($picto) ? '' : $picto));
$pictowithouttext = preg_replace('/(\.png|\.gif|\.svg)$/', '', $picto);
$pictowithouttext = str_replace('object_', '', $pictowithouttext);
$pictowithouttext = str_replace('_nocolor', '', $pictowithouttext);
// Fix some values of $pictowithouttext
$pictoconvertkey = array('facture' => 'bill', 'shipping' => 'shipment', 'fichinter' => 'intervention', 'agenda' => 'calendar', 'invoice_supplier' => 'supplier_invoice', 'order_supplier' => 'supplier_order');
if (in_array($pictowithouttext, array_keys($pictoconvertkey))) {
$pictowithouttext = $pictoconvertkey[$pictowithouttext];
}
if (strpos($pictowithouttext, 'fontawesome_') === 0 || strpos($pictowithouttext, 'fa-') === 0) {
// This is a font awesome image 'fontawesome_xxx' or 'fa-xxx'
$pictowithouttext = str_replace('fontawesome_', '', $pictowithouttext);
$pictowithouttext = str_replace('fa-', '', $pictowithouttext);
// Compatibility with old fontawesome versions
if ($pictowithouttext == 'file-o') {
$pictowithouttext = 'file';
}
$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];
$faprefix = empty($pictowithouttextarray[1]) ? 'fas' : $pictowithouttextarray[1];
$facolor = empty($pictowithouttextarray[2]) ? '' : $pictowithouttextarray[2];
$fasize = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
} else {
$fakey = 'fa-'.$pictowithouttext;
$faprefix = 'fas';
$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="'.$faprefix.' '.$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 : '').'>';
$enabledisablehtml .= '</span>';
return $enabledisablehtml;
}
if (empty($srconly) && in_array($pictowithouttext, getImgPictoNameList())) {
$fakey = $pictowithouttext;
$facolor = '';
$fasize = '';
$fa = getDolGlobalString('MAIN_FONTAWESOME_ICON_STYLE', 'fas');
if (in_array($pictowithouttext, array('card', 'bell', 'clock', 'establishment', 'file', 'file-o', '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', 'discord', 'facebook', 'flickr', 'github', 'google', 'google-plus-g', 'instagram', 'linkedin', 'meetup', 'microsoft', 'pinterest', 'skype', 'slack', 'twitter', 'reddit', 'snapchat', 'stripe', 'stripe-s', 'tumblr', 'viadeo', 'whatsapp', 'youtube'))) {
$fa = 'fab';
}
$arrayconvpictotofa = getImgPictoConv('fa');
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', 'reception'))) {
$morecss .= ' em092';
}
if (in_array($pictowithouttext, array('conferenceorbooth', 'collab', 'eventorganization', 'holiday', 'info', 'info_black', '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_grey', 'switch_on_red', 'switch_off',
'uparrow', '1uparrow', '1downarrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected'
);
if (!array_key_exists($pictowithouttext, $arrayconvpictotomarginleftonly)) {
$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',
'bookcal' => 'infobox-action',
'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_warning' => 'font-status4 warning', 'switch_on_red' => 'font-status8',
'holiday' => 'infobox-holiday', 'info' => 'opacityhigh', 'info_black' => 'font-status1', '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 infobox-order_supplier', 'recruitmentjobposition' => 'infobox-adherent', 'recruitmentcandidature' => 'infobox-adherent',
'resource' => 'infobox-action',
'salary' => 'infobox-bank_account', 'shapes' => 'infobox-adherent', 'shipment' => 'infobox-commande', 'stripe' => 'infobox-bank_account', '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', 'calendarpertype' => 'imgforviewmode'
);
if (!empty($arrayconvpictotomorcess[$pictowithouttext]) && strpos($picto, '_nocolor') === false) {
$morecss .= ($morecss ? ' ' : '').$arrayconvpictotomorcess[$pictowithouttext];
}
// Define $color
$arrayconvpictotocolor = array(
'address' => '#6c6aa8', 'building' => '#6c6aa8', 'bom' => '#a69944',
'clone' => '#999', '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', 'resize' => '#444', 'rss' => '#cba',
//'shipment'=>'#a69944',
'search-plus' => '#808080', 'security' => '#999', 'square' => '#888', 'stop-circle' => '#888', 'stats' => '#444', 'switch_off' => '#999',
'technic' => '#999', 'tick' => '#282', '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]) && strpos($picto, '_nocolor') === false) {
$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 : '').'>';
$enabledisablehtml .= '</span>';
return $enabledisablehtml;
}
if (getDolGlobalString('MAIN_OVERWRITE_THEME_PATH')) {
$path = getDolGlobalString('MAIN_OVERWRITE_THEME_PATH') . '/theme/'.$theme; // If the theme does not have the same name as the module
} elseif (getDolGlobalString('MAIN_OVERWRITE_THEME_RES')) {
$path = getDolGlobalString('MAIN_OVERWRITE_THEME_RES') . '/theme/' . getDolGlobalString('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 recommended
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="'.dolPrintHTMLForAttribute($alt, 0, $allowothertags).'"').(($notitle || empty($titlealt)) ? '' : ' title="'.dolPrintHTMLForAttribute($titlealt, 0, $allowothertags).'"').($moreatt ? ' '.$moreatt.($morecss ? ' class="'.$morecss.'"' : '') : ' class="inline-block'.($morecss ? ' '.$morecss : '').'"').'>'; // Alt is used for accessibility, title for popup
}
/**
* Get all usage icon key usable for img_picto(..., key)
*
* @return string[]
*/
function getImgPictoNameList()
{
return array(
'1downarrow', '1uparrow', '1leftarrow', '1rightarrow', '1uparrow_selected', '1downarrow_selected', '1leftarrow_selected', '1rightarrow_selected',
'accountancy', 'accounting_account', 'account', 'accountline', 'action', 'add', 'address', 'ai', 'angle-double-down', 'angle-double-up', 'asset',
'back', 'bank_account', 'barcode', 'bank', 'bell', 'bill', 'billa', 'billr', 'billd', 'birthday-cake', 'bom', 'bookcal', 'bookmark', 'briefcase-medical', 'bug', 'building',
'card', 'calendarlist', 'calendar', 'calendarmonth', 'calendarweek', 'calendarday', 'calendarperuser', 'calendarpertype', 'hourglass',
'cash-register', 'category', 'chart', 'check', 'clock', 'clone', 'close_title', 'code', 'cog', 'collab', 'company', 'contact', 'country', 'contract', 'conversation', 'cron', 'cross', 'cubes',
'check-circle', 'check-square', 'circle', 'stop-circle', 'currency', 'multicurrency',
'chevron-left', 'chevron-right', 'chevron-down', 'chevron-up',
'chevron-double-left', 'chevron-double-right', 'chevron-double-down', 'chevron-double-top',
'commercial', 'companies',
'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', 'file-o', 'file-code', 'file-export', 'file-import', 'file-upload', 'autofill', 'folder', 'folder-open', 'folder-plus', 'font',
'generate', 'generic', 'globe', 'globe-americas', 'graph', 'grip', 'grip_title', 'group',
'hands-helping', 'help', 'holiday',
'id-card', 'images', 'incoterm', 'info', 'info_black', 'intervention', 'inventory', 'intracommreport', 'jobprofile',
'key', 'knowledgemanagement',
'label', 'language', 'layout', 'line', 'link', 'list', 'list-alt', 'listlight', 'loan', 'lock', 'lot', 'long-arrow-alt-right',
'margin', 'map-marker-alt', 'member', 'meeting', 'minus', 'money-bill-alt', 'movement', 'mrp', 'note', 'next',
'off', 'on', 'order',
'paragraph', 'play', 'pdf', 'phone', 'phoning', 'phoning_mobile', 'phoning_fax', 'playdisabled', 'previous', 'poll', 'pos', 'printer', 'product', 'propal', 'proposal', 'puce',
'resize', 'search', 'service', 'stats', 'stock',
'security', 'setup', 'share-alt', 'sign-out', 'split', 'stripe', 'stripe-s', 'switch_off', 'switch_on', 'switch_on_grey', 'switch_on_warning', 'switch_on_red', 'tools', 'unlink', 'uparrow', 'user', 'user-tie', 'vcard', 'wrench',
'discord', 'facebook', 'flickr', 'instagram','linkedin', 'github', 'google', 'jabber', 'meetup', 'microsoft', 'skype', 'slack', 'twitter', 'pinterest', 'reddit', 'snapchat', 'tumblr', 'youtube', 'viadeo', 'google-plus-g', 'whatsapp',
'generic', 'home', 'hrm', 'members', 'products', 'invoicing',
'partnership', 'payment', 'payment_vat', 'pencil-ruler', 'pictoconfirm', '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',
'search-plus', 'shapes', 'skill', 'square', 'sort-numeric-down', 'status', 'stop-circle', 'supplier', 'supplier_proposal', 'supplier_order', 'supplier_invoice',
'terminal', 'tick', 'timespent', 'title_setup', 'title_accountancy', 'title_bank', 'title_hrm', 'title_agenda', 'trip',
'uncheck', 'undo', 'url', 'user-cog', 'user-injured', 'user-md', 'upload', 'vat', 'website', 'workstation', 'webhook', 'world', 'private',
'conferenceorbooth', 'eventorganization',
'stamp', 'signature',
'webportal'
);
}
/**
* Get array to convert the Dolibarr picto keys into font awesome keys
*
* @param string $mode 'fa' to get conversion array for Font-Awesome
* @return string[] Array of conversion
* @see img_picto()
*/
function getImgPictoConv($mode = 'fa')
{
global $conf;
// Array when the fa picto key is different than the Dolibarr picto key.
$arrayconvpictotofa = array(
'account' => 'university', 'accounting_account' => 'clipboard-list', 'accountline' => 'receipt', 'accountancy' => 'search-dollar', 'action' => 'calendar-alt', 'add' => 'plus-circle', 'address' => 'address-book', 'ai' => 'magic',
'asset' => 'money-check-alt', 'autofill' => 'fill',
'back' => 'arrow-left', 'bank_account' => 'university',
'bill' => 'file-invoice-dollar', 'billa' => 'file-excel', 'billr' => 'file-invoice-dollar', 'billd' => 'file-medical',
'bookcal' => 'calendar-check',
'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', 'cross' => 'times',
'chevron-double-left' => 'angle-double-left', 'chevron-double-right' => 'angle-double-right', 'chevron-double-down' => 'angle-double-down', 'chevron-double-top' => 'angle-double-up',
'donation' => 'file-alt', 'dynamicprice' => 'hand-holding-usd',
'setup' => 'cog', 'companies' => 'building', 'products' => 'cube', 'commercial' => 'suitcase', 'invoicing' => 'coins',
'accounting' => 'search-dollar', 'category' => 'tag', 'dollyrevert' => 'dolly',
'file-o' => 'file', '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', 'info_black' => 'info-circle', 'inventory' => 'boxes', 'intracommreport' => 'globe-europe', 'jobprofile' => 'cogs',
'knowledgemanagement' => 'ticket-alt', 'label' => 'layer-group', 'layout' => 'columns', '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_grey' => 'toggle-on', 'switch_on_warning' => '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', 'calendarpertype' => 'table',
'intervention' => 'ambulance', 'invoice' => 'file-invoice-dollar', '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', 'pictoconfirm' => 'check-square', 'phoning' => 'phone', 'phoning_mobile' => 'mobile-alt', 'phoning_fax' => 'fax', 'previous' => 'arrow-alt-circle-left', 'printer' => 'print', 'product' => 'cube', 'puce' => 'angle-right',
'recent' => 'check-square', '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',
'skill' => 'shapes', 'state' => 'map-marked-alt', 'security' => 'key', 'salary' => 'wallet', 'shipment' => 'dolly', 'stock' => 'box-open', 'stats' => 'chart-bar', 'split' => 'code-branch',
'status' => 'stop-circle',
'stripe' => 'stripe-s', 'supplier' => 'building',
'technic' => 'cogs', 'tick' => 'check', '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' => 'arrow-alt-circle-down',
'jabber' => 'comment',
'website' => 'globe-americas', 'workstation' => 'pallet', 'webhook' => 'bullseye', 'world' => 'globe', 'private' => 'user-lock',
'conferenceorbooth' => 'chalkboard-teacher', 'eventorganization' => 'project-diagram',
'webportal' => 'door-open'
);
if ($conf->currency == 'EUR') {
$arrayconvpictotofa['currency'] = 'euro-sign';
$arrayconvpictotofa['multicurrency'] = 'dollar-sign';
} else {
$arrayconvpictotofa['currency'] = 'dollar-sign';
$arrayconvpictotofa['multicurrency'] = 'euro-sign';
}
return $arrayconvpictotofa;
}
/**
* Show a picto called object_picto (generic function)
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $picto Name of image to show object_picto (example: user, group, action, bill, contract, propal, product, ...)
* For external modules use imagename@mymodule to search into directory "img" of module.
* @param string $moreatt Add more attribute on img tag (ie: class="datecallink")
* @param int $pictoisfullpath If 1, image path is a full path
* @param int $srconly Return only content of the src attribute of img.
* @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
* @param string[] $allowothertags List of other tags allowed in title attribute
* @return string Return img tag
* @see img_picto(), img_picto_common()
*/
function img_object($titlealt, $picto, $moreatt = '', $pictoisfullpath = 0, $srconly = 0, $notitle = 0, $allowothertags = array())
{
if (strpos($picto, '^') === 0) {
return img_picto($titlealt, str_replace('^', '', $picto), $moreatt, $pictoisfullpath, $srconly, $notitle, '', '', 2, $allowothertags);
} else {
return img_picto($titlealt, 'object_'.$picto, $moreatt, $pictoisfullpath, $srconly, $notitle, '', '', 2, $allowothertags);
}
}
/**
* Show weather picto
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string|int $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory. Or level of meteo image (0-4).
* @param string $moreatt Add more attribute on img tag
* @param int $pictoisfullpath If 1, image path is a full path
* @param string $morecss More CSS
* @return string Return img tag
* @see img_object(), img_picto()
*/
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);
}
/**
* Show picto (generic function)
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $picto Name of image file to show (If no extension provided, we use '.png'). Image must be stored into htdocs/theme/common directory.
* @param string $moreatt Add more attribute on img tag
* @param int $pictoisfullpath If 1, image path is a full path
* @param int $notitle 1=Disable tag title. Use it if you add js tooltip, to avoid duplicate tooltip.
* @return string Return img tag
* @see img_object(), img_picto()
*/
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 (getDolGlobalInt('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);
}
/**
* Show logo action
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $numaction Action id or code to show
* @param string $picto Name of image file to show ('filenew', ...)
* If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory.
* Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img
* Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img
* Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
* @param string $moreatt More attributes
* @return string Return an img tag
*/
function img_action($titlealt, $numaction, $picto = '', $moreatt = '')
{
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) ? 'stcomm'.$numaction.'.png' : $picto), $moreatt);
}
/**
* Show pdf logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param int $size Taille de l'icone : 3 = 16x16px , 2 = 14x14px
* @return string Retourne tag img
*/
function img_pdf($titlealt = 'default', $size = 3)
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Show');
}
return img_picto($titlealt, 'pdf'.$size.'.png');
}
/**
* Show logo +
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Return tag img
*/
function img_edit_add($titlealt = 'default', $other = '')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Add');
}
return img_picto($titlealt, 'edit_add.png', $other);
}
/**
* Show logo -
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Return tag img
*/
function img_edit_remove($titlealt = 'default', $other = '')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Remove');
}
return img_picto($titlealt, 'edit_remove.png', $other);
}
/**
* Show logo edit/modify fiche
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param integer $float If you have to put the style "float: right"
* @param string $other Add more attributes on img
* @return string Return tag img
*/
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 : ''));
}
/**
* Show logo view card
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param integer $float If you have to put the style "float: right"
* @param string $other Add more attributes on img
* @return string Return tag img
*/
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);
}
/**
* Show delete logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @param string $morecss More CSS
* @return string Retourne tag img
*/
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, 0, 0, 0, '', $morecss);
}
/**
* Show printer logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
function img_printer($titlealt = "default", $other = '')
{
global $langs;
if ($titlealt == "default") {
$titlealt = $langs->trans("Print");
}
return img_picto($titlealt, 'printer.png', $other);
}
/**
* Show split logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
function img_split($titlealt = 'default', $other = 'class="pictosplit"')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Split');
}
return img_picto($titlealt, 'split.png', $other);
}
/**
* Show help logo with cursor "?"
*
* @param int $usehelpcursor 1=Use help cursor, 2=Use click pointer cursor, 0=No specific cursor
* @param int|string $usealttitle Text to use as alt title
* @return string Return tag img
*/
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' : '')).'"');
}
/**
* Show info logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @return string Return img tag
*/
function img_info($titlealt = 'default')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Informations');
}
return img_picto($titlealt, 'info.png', 'style="vertical-align: middle;"');
}
/**
* Show warning logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"'). If 1, add float: right. Can't be "class" attribute.
* @param string $morecss Add more CSS
* @return string Return img tag
*/
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) : ''));
}
/**
* Show error logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @return string Return img tag
*/
function img_error($titlealt = 'default')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Error');
}
return img_picto($titlealt, 'error.png');
}
/**
* Show next logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
* @return string Return img tag
*/
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>';
}
/**
* Show previous logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
* @return string Return img tag
*/
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>';
}
/**
* Show down arrow logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param int $selected Selected
* @param string $moreclass Add more CSS classes
* @return string Return img tag
*/
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 : "").'"');
}
/**
* Show top arrow logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param int $selected Selected
* @param string $moreclass Add more CSS classes
* @return string Return img tag
*/
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 : "").'"');
}
/**
* Show left arrow logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param int $selected Selected
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
* @return string Return img tag
*/
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);
}
/**
* Show right arrow logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param int $selected Selected
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"')
* @return string Return img tag
*/
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);
}
/**
* Show tick logo if allowed
*
* @param string $allow Allow
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @return string Return img tag
*/
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 '-';
}
/**
* Return image of a credit card according to its brand name
*
* @param string $brand Brand name of credit card
* @param string $morecss More CSS
* @return string Return img tag
*/
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>';
}
/**
* Show MIME img of a file
*
* @param string $file Filename
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $morecss More css
* @return string Return img tag
*/
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.' '.(preg_match('/pictofixedwidth/', $morecss) ? '' : 'paddingright ').($morecss ? ' '.$morecss : '').'"'.($titlealt ? ' title="'.dolPrintHTMLForAttribute($titlealt).'"' : '').'></i>';
}
/**
* Show search logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
function img_search($titlealt = 'default', $other = '')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Search');
}
$img = img_picto($titlealt, 'search.png', $other, 0, 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;
}
/**
* Show search logo
*
* @param string $titlealt Text on alt and title of image. Alt only if param notitle is set to 1. If text is "TextA:TextB", use Text A on alt and Text B on title.
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
function img_searchclear($titlealt = 'default', $other = '')
{
global $langs;
if ($titlealt == 'default') {
$titlealt = $langs->trans('Search');
}
$img = img_picto($titlealt, 'searchclear.png', $other, 0, 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;
}
/**
* Show information in HTML for admin users or standard users
*
* @param string $text Text info
* @param integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
* @param int $nodiv No div
* @param string $admin '1'=Info for admin users. '0'=Info for standard users (change only the look), 'info', 'error', 'warning', 'xxx'=Other
* @param string $morecss More CSS ('', 'warning', 'error')
* @param string $textfordropdown Show a text to click to dropdown the info box.
* @param string $picto '' or 'warning'
* @return string String with info text
*/
function info_admin($text, $infoonimgalt = 0, $nodiv = 0, $admin = '1', $morecss = 'hideonsmartphone', $textfordropdown = '', $picto = '')
{
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));
$fa = 'info-circle';
if ($picto == 'warning') {
$fa = 'exclamation-triangle';
}
$result = ($nodiv ? '' : '<div class="wordbreak '.$class.($morecss ? ' '.$morecss : '').($textfordropdown ? ' hidden' : '').'">').'<span class="fa fa-'.$fa.'" title="'.dol_escape_htmltag($admin ? $langs->trans('InfoAdmin') : $langs->trans('Note')).'"></span> ';
$result .= dol_escape_htmltag($text, 1, 0, 'div,span,b,br,a');
$result .= ($nodiv ? '' : '</div>');
if ($textfordropdown) {
$tmpresult = '<span class="'.$class.'text opacitymedium cursorpointer">'.$langs->trans($textfordropdown).' '.img_picto($langs->trans($textfordropdown), '1downarrow').'</span>';
$tmpresult .= '<script nonce="'.getNonce().'" 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;
}
/**
* Displays error message system with all the information to facilitate the diagnosis and the escalation of the bugs.
* This function must be called when a blocking technical error is encountered.
* However, one must try to call it only within php pages, classes must return their error through their property "error".
*
* @param DoliDB|null $db Database handler
* @param string|string[] $error String or array of errors strings to show
* @param string[]|null $errors Array of errors
* @return void
* @see dol_htmloutput_errors()
*/
function dol_print_error($db = null, $error = '', $errors = null)
{
global $conf, $langs, $user, $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 ($user instanceof User) {
$out .= "<b>".$langs->trans("Login").":</b> ".$user->login."<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> " . (isset($_SERVER["REQUEST_URI"]) ? 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=" . (isset($_SERVER["REQUEST_URI"]) ? dol_escape_htmltag($_SERVER["REQUEST_URI"]) : '');
$syslog .= ", query_string=" . (isset($_SERVER["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> ".implode(', ', $conf->modules)."<br>\n";
}
if (is_object($db)) {
if ($_SERVER['DOCUMENT_ROOT']) { // Mode web
$out .= "<b>".$langs->trans("DatabaseTypeManager").":</b> ".$db->type."<br>\n";
$lastqueryerror = $db->lastqueryerror();
if (!utf8_check($lastqueryerror)) {
$lastqueryerror = "SQL error string is not a valid UTF8 string. We can't show it.";
}
$out .= "<b>".$langs->trans("RequestLastAccessInError").":</b> ".($lastqueryerror ? dol_escape_htmltag($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) {
// Merge all into $errors array
if (is_array($error) && is_array($errors)) {
$errors = array_merge($error, $errors);
} elseif (is_array($error)) { // deprecated, use second parameters
$errors = $error;
} elseif (is_array($errors) && !empty($error)) {
$errors = array_merge(array($error), $errors);
} elseif (!empty($error)) {
$errors = array_merge(array($error), array($errors));
}
$langs->load("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 information:</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 we use 500, message is not output with some command line tools
http_response_code(202); // If we use 202, this is not really an error message, but this allow to output message on command line tools
}
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 temporarily 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");
if (!defined("MAIN_CORE_ERROR")) {
define("MAIN_CORE_ERROR", 1);
}
}
dol_syslog("Error ".$syslog, LOG_ERR);
}
/**
* Show a public email and error code to contact if technical error
*
* @param string $prefixcode Prefix of public error code
* @param string $errormessage Complete error message
* @param string[] $errormessages Array of error messages
* @param string $morecss More css
* @param string $email Email
* @return void
*/
function dol_print_error_email($prefixcode, $errormessage = '', $errormessages = array(), $morecss = 'error', $email = '')
{
global $langs;
if (empty($email)) {
$email = getDolGlobalString('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>';
}
/**
* Show title line of an array
*
* @param ?string $name Label of field
* @param string $file Url used when we click on sort picto
* @param string $field Field to use for new sorting
* @param string $begin ("" by default)
* @param string $moreparam Add more parameters on sort url links ("" by default)
* @param string $moreattrib Options of attribute td ("" by default)
* @param ?string $sortfield Current field used to sort
* @param ?string $sortorder Current sort order
* @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
* @param ?string $tooltip Tooltip
* @param int $forcenowrapcolumntitle No need for use 'wrapcolumntitle' css style
* @return void
*/
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);
}
/**
* Get title line of an array
*
* @param ?string $name Translation key of field to show or complete HTML string to show
* @param int<0,2> $thead 0=To use with standard table format, 1=To use inside <thead><tr>, 2=To use with <div>
* @param string $file Url used when we click on sort picto
* @param string $field Field to use for new sorting. Empty if this field is not sortable. Example "t.abc" or "t.abc,t.def"
* @param string $begin ("" by default)
* @param string $moreparam Add more parameters on sort url links ("" by default)
* @param string $moreattrib Add more attributes on th ("" by default). To add more css class, use param $prefix.
* @param ?string $sortfield Current field used to sort (Ex: 'd.datep,d.id')
* @param ?string $sortorder Current sort order (Ex: 'asc,desc')
* @param string $prefix Prefix for css. Use space after prefix to add your own CSS tag, for example 'mycss '.
* @param int<0,1> $disablesortlink 1=Disable sort link
* @param ?string $tooltip Tooltip
* @param int<0,1> $forcenowrapcolumntitle No need to use 'wrapcolumntitle' css style
* @return string
*/
function getTitleFieldOfList($name, $thead = 0, $file = "", $field = "", $begin = "", $moreparam = "", $moreattrib = "", $sortfield = "", $sortorder = "", $prefix = "", $disablesortlink = 0, $tooltip = '', $forcenowrapcolumntitle = 0)
{
global $langs, $form;
//print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
if ($moreattrib == 'class="right"') {
$prefix .= 'right '; // For backward compatibility
}
$sortorder = strtoupper((string) $sortorder);
$out = '';
$sortimg = '';
$tag = 'th';
if ($thead == 2) {
$tag = 'div';
}
$tmpsortfield = explode(',', (string) $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 (!getDolGlobalString('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 && !getDolGlobalString('MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE') && empty($forcenowrapcolumntitle) && !dol_textishtml($name)) ? ' title="'.dolPrintHTMLForAttribute($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='.urlencode($field).'&sortorder='.urlencode($sortordertouseinlink).'&begin='.urlencode($begin).$options.'"';
//$out .= (getDolGlobalString('MAIN_DISABLE_WRAPPING_ON_COLUMN_TITLE') ? '' : ' title="'.dol_escape_htmltag($langs->trans($name)).'"');
$out .= '>';
}
if ($tooltip) {
// You can also use 'TranslationString:keyfortooltiponclick:tooltipdirection' for a tooltip on click or to change tooltip position.
if (strpos($tooltip, ':') !== false) {
$tmptooltip = explode(':', $tooltip);
} else {
$tmptooltip = array($tooltip);
}
$out .= $form->textwithpicto($langs->trans((string) $name), $langs->trans($tmptooltip[0]), (empty($tmptooltip[2]) ? '1' : $tmptooltip[2]), 'help', '', 0, 3, (empty($tmptooltip[1]) ? '' : 'extra_'.str_replace('.', '_', $field).'_'.$tmptooltip[1]));
} else {
$out .= $langs->trans((string) $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)) {
// Nothing
} else {
if (preg_match('/^DESC/', $sortorder)) {
$sortimg .= '<span class="nowrap">'.img_up("Z-A", 0, 'paddingright').'</span>';
}
if (preg_match('/^ASC/', $sortorder)) {
$sortimg .= '<span class="nowrap">'.img_down("A-Z", 0, 'paddingright').'</span>';
}
}
}
$tagend = '</'.$tag.'>';
$out = $tagstart.$sortimg.$out.$tagend;
return $out;
}
/**
* Show a title.
*
* @param string $title Title to show
* @return void
* @deprecated Use load_fiche_titre instead
* @see load_fiche_titre()
*/
function print_titre($title)
{
dol_syslog(__FUNCTION__." is deprecated", LOG_WARNING);
print '<div class="titre">'.$title.'</div>';
}
/**
* Show a title with picto
*
* @param string $title Title to show
* @param string $mesg Added message to show on right
* @param string $picto Icon to use before title (should be a 32x32 transparent png file)
* @param int $pictoisfullpath 1=Icon name is a full absolute url of image
* @param string $id To force an id on html objects by example id="name" where name is id
* @return void
* @deprecated Use print load_fiche_titre instead
*/
function print_fiche_titre($title, $mesg = '', $picto = 'generic', $pictoisfullpath = 0, $id = '')
{
print load_fiche_titre($title, $mesg, $picto, $pictoisfullpath, $id);
}
/**
* Load a title with picto
*
* @param string $title Title to show (HTML sanitized content). Can be a string with a <br> as a substring.
* @param string $morehtmlright Added message to show on right
* @param string $picto Icon to use before title (should be a 32x32 transparent png file)
* @param int<0,1> $pictoisfullpath 1=Icon name is a full absolute url of image
* @param string $id To force an id on html objects
* @param string $morecssontable More css on table
* @param string $morehtmlcenter Added message to show on center
* @return string
* @see print_barre_liste()
*/
function load_fiche_titre($title, $morehtmlright = '', $picto = 'generic', $pictoisfullpath = 0, $id = '', $morecssontable = '', $morehtmlcenter = '')
{
$return = '';
if ($picto == 'setup') {
$picto = 'generic';
}
$return .= "\n";
$return .= '<table '.($id ? 'id="'.$id.'" ' : '').'class="centpercent notopnoleftnoright table-fiche-title'.($morecssontable ? ' '.$morecssontable : '').'">'; // margin bottom must be same than into print_barre_list
$return .= '<tr class="toptitle">';
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">';
$return .= '<span class="inline-block valignmiddle">'.$title.'</span>'; // $title is already HTML sanitized content
$return .= '</div>';
$return .= '</td>';
if (dol_strlen($morehtmlcenter)) {
$return .= '<td class="nobordernopadding center valignmiddle col-center">'.$morehtmlcenter.'</td>';
}
if (dol_strlen($morehtmlright)) {
$return .= '<td class="nobordernopadding titre_right wordbreakimp right valignmiddle col-right">'.$morehtmlright.'</td>';
}
$return .= '</tr></table>'."\n";
return $return;
}
/**
* Print a title with navigation controls for pagination
*
* @param string $title Title to show (required). Can be a string with a <br> as a substring.
* @param int|null $page Numero of page to show in navigation links (required)
* @param string $file Url of page (required)
* @param string $options More parameters for links ('' by default, does not include sortfield neither sortorder). Value must be 'urlencoded' before calling function.
* @param ?string $sortfield Field to sort on ('' by default)
* @param ?string $sortorder Order to sort ('' by default)
* @param string $morehtmlcenter String in the middle ('' by default). We often find here string $massaction coming from $form->selectMassAction()
* @param int $num Number of records found by select with limit+1
* @param int|string $totalnboflines Total number of records/lines for all pages (if known). Use a negative value of number to not show number. Use '' if unknown.
* @param string $picto Icon to use before title (should be a 32x32 transparent png file)
* @param int $pictoisfullpath 1=Icon name is a full absolute url of image
* @param string $morehtmlright More html to show (after arrows)
* @param string $morecss More css to the table
* @param int $limit Max number of lines (-1 = use default, 0 = no limit, > 0 = limit).
* @param int|string $selectlimitsuffix Suffix for limit ID of -1 to hide the select limit combo
* @param int $hidenavigation Force to hide the arrows and page for navigation
* @param int $pagenavastextinput 1=Do not suggest list of pages to navigate but suggest the page number into an input field.
* @param string $morehtmlrightbeforearrow More html to show (before arrows)
* @return void
*/
function print_barre_liste($title, $page, $file, $options = '', $sortfield = '', $sortorder = '', $morehtmlcenter = '', $num = -1, $totalnboflines = '', $picto = 'generic', $pictoisfullpath = 0, $morehtmlright = '', $morecss = '', $limit = -1, $selectlimitsuffix = 0, $hidenavigation = 0, $pagenavastextinput = 0, $morehtmlrightbeforearrow = '')
{
global $conf, $langs;
$savlimit = $limit;
$savtotalnboflines = $totalnboflines;
if (is_numeric($totalnboflines)) {
$totalnboflines = abs($totalnboflines);
}
// Detect if there is a subtitle
$subtitle = '';
$tmparray = preg_split('/<br>/i', $title, 2);
if (!empty($tmparray[1])) {
$title = $tmparray[0];
$subtitle = $tmparray[1];
}
$page = (int) $page;
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.'-selectlimitsuffix='.$selectlimitsuffix.'-hidenavigation='.$hidenavigation;
print "\n";
print "<!-- Begin print_barre_liste -->\n";
print '<table class="centpercent notopnoleftnoright table-fiche-title'.($morecss ? ' '.$morecss : '').'">';
print '<tr class="toptitle">'; // margin bottom must be same than into load_fiche_tire
// Left
if ($picto && $title) {
print '<td class="nobordernopadding widthpictotitle valignmiddle col-picto">';
print img_picto('', $picto, 'class="valignmiddle pictotitle widthpictotitle"', $pictoisfullpath);
print '</td>';
}
print '<td class="nobordernopadding valignmiddle col-title">';
print '<div class="titre inline-block">';
print '<span class="inline-block valignmiddle print-barre-liste">'.$title.'</span>'; // $title may contains HTML like a combo list from page consumption.php, so we do not use dolPrintLabel here()
if (!empty($title) && $savtotalnboflines >= 0 && (string) $savtotalnboflines != '' && $totalnboflines > 0) {
print '<span class="opacitymedium colorblack marginleftonly totalnboflines valignmiddle" title="'.$langs->trans("NbRecordQualified").'">('.$totalnboflines.')</span>';
}
print '</div>';
if (!empty($subtitle)) {
print '<br><div class="subtitle inline-block hideonsmartphone">'.$subtitle.'</div>';
}
print '</td>';
// Center
if ($morehtmlcenter && empty($conf->dol_optimize_smallscreen)) {
print '<td class="nobordernopadding center valignmiddle col-center">'.$morehtmlcenter.'</td>';
}
// Right
print '<td class="nobordernopadding valignmiddle right col-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 class="reposition" 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 class="reposition" href="'.$file.'?page=1'.$options.'">2</a></li>';
}
}
}
do {
if ($pagenavastextinput) {
if ($cpt == $page) {
$pagelist .= '<li class="pagination pageplusone valignmiddle"><input type="text" class="'.($totalnboflines > 100 ? 'width40' : 'width25').' center pageplusone heightofcombo" 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 class="reposition" 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 class="reposition" href="'.$file.'?page='.($nbpages - 2).$options.'">'.($nbpages - 1).'</a></li>';
}
$pagelist .= '<li class="pagination"><a class="reposition" href="'.$file.'?page='.($nbpages - 1).$options.'">'.$nbpages.'</a></li>';
}
} else {
//var_dump($page.' '.$cpt.' '.$nbpages);
$pagelist .= '<li class="pagination paginationlastpage"><a class="reposition" 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, $selectlimitsuffix, $morehtmlrightbeforearrow, $hidenavigation); // 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>';
print '</table>'."\n";
// Center
if ($morehtmlcenter && !empty($conf->dol_optimize_smallscreen)) {
print '<div class="nobordernopadding marginbottomonly center valignmiddle col-center centpercent">'.$morehtmlcenter.'</div>';
}
print "<!-- End title -->\n\n";
}
/**
* Function to show navigation arrows into lists
*
* @param int $page Number of page
* @param string $file Page URL (in most cases provided with $_SERVER["PHP_SELF"])
* @param string $options Other url parameters to propagate ("" by default, may include sortfield and sortorder)
* @param integer $nextpage Do we show a next page button
* @param string $betweenarrows HTML content to show between arrows. MUST contains '<li> </li>' tags or '<li><span> </span></li>'.
* @param string $afterarrows HTML content to show after arrows. Must NOT contains '<li> </li>' tags.
* @param int $limit Max nb of record to show (-1 = no combo with limit, 0 = no limit, > 0 = limit)
* @param int $totalnboflines Total number of records/lines for all pages (if known)
* @param int|string $selectlimitsuffix A suffix for the limit ID, or -1 to hide the select of limit
* @param string $beforearrows HTML content to show before arrows. Must NOT contains '<li> </li>' tags.
* @param int $hidenavigation Force to hide the switch mode view and the navigation tool (hide limit section, html in $betweenarrows and $afterarrows but not $beforearrows)
* @return void
*/
function print_fleche_navigation($page, $file, $options = '', $nextpage = 0, $betweenarrows = '', $afterarrows = '', $limit = -1, $totalnboflines = 0, $selectlimitsuffix = '', $beforearrows = '', $hidenavigation = 0)
{
global $conf, $langs;
print '<div class="pagination"><ul>';
if ($beforearrows) {
print '<li class="paginationbeforearrows">';
print $beforearrows;
print '</li>';
}
if (empty($hidenavigation)) {
if ((int) $limit > 0 && (empty($selectlimitsuffix) || !is_numeric($selectlimitsuffix))) {
$pagesizechoices = '10:10,15:15,20:20,25:25,50:50,100:100,250:250,500:500,1000:1000';
$pagesizechoices .= ',5000:5000';
//$pagesizechoices .= ',10000:10000'; // Memory trouble on most browsers
//$pagesizechoices .= ',20000:20000'; // Memory trouble on most browsers
//$pagesizechoices .= ',0:'.$langs->trans("All"); // Not yet supported
//$pagesizechoices .= ',2:2';
if (getDolGlobalString('MAIN_PAGESIZE_CHOICES')) {
$pagesizechoices = getDolGlobalString('MAIN_PAGESIZE_CHOICES');
}
if (getDolGlobalString('MAIN_USE_HTML5_LIMIT_SELECTOR')) {
print '<li class="pagination">';
print '<input onfocus="this.value=null;" onchange="this.blur();" class="flat selectlimit nopadding maxwidth75 right pageplusone" id="limit" name="limit" list="limitlist" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'" value="'.$limit.'">';
print '<datalist id="limitlist">';
} else {
print '<li class="paginationcombolimit valignmiddle">';
print '<select id="limit'.(is_numeric($selectlimitsuffix) ? '' : $selectlimitsuffix).'" name="limit" class="flat selectlimit nopadding maxwidth75 center'.(is_numeric($selectlimitsuffix) ? '' : ' '.$selectlimitsuffix).'" title="'.dol_escape_htmltag($langs->trans("MaxNbOfRecordPerPage")).'">';
}
$tmpchoice = explode(',', $pagesizechoices);
$tmpkey = $limit.':'.$limit;
if (!in_array($tmpkey, $tmpchoice)) {
$tmpchoice[$tmpkey] = $tmpkey;
}
$tmpkey = $conf->liste_limit.':'.$conf->liste_limit;
if (!in_array($tmpkey, $tmpchoice)) {
$tmpchoice[$tmpkey] = $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";
}
}
if (getDolGlobalString('MAIN_USE_HTML5_LIMIT_SELECTOR')) {
print '</datalist>';
} else {
print '</select>';
print ajax_combobox("limit".(is_numeric($selectlimitsuffix) ? '' : $selectlimitsuffix), array(), 0, 0, 'resolve', '-1', 'limit');
//print ajax_combobox("limit");
}
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("We change limit so we submit the form");
$(this).parents(\'form:first\').submit();
});
});
</script>
';
}
print '</li>';
}
if ($page > 0) {
print '<li class="pagination paginationpage paginationpageleft"><a class="paginationprevious reposition" 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 reposition" 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";
}
/**
* Return a string with VAT rate label formatted for view output
* Used into pdf and HTML pages
*
* @param string $rate Rate value to format ('19.6', '19,6', '19.6%', '19,6%', '19.6 (CODEX)', ...)
* @param boolean $addpercent Add a percent % sign in output
* @param int $info_bits Miscellaneous information on vat (0=Default, 1=French NPR vat)
* @param int $usestarfornpr -1=Never show, 0 or 1=Use '*' for NPR vat rates
* @param int $html Used for html output
* @return string String with formatted amounts ('19,6' or '19,6%' or '8.5% (NPR)' or '8.5% *' or '19,6 (CODEX)')
*/
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 to format a value into an amount for visual output
* Function used into PDF and HTML pages
*
* @param int|float|string|null $amount Amount value to format
* @param int<0,1> $form Type of formatting: 1=HTML, 0=no formatting (no by default)
* @param Translate|string|null $outlangs Object langs for output. '' use default lang. 'none' use international separators.
* @param int $trunc 1=Truncate if there is more decimals than MAIN_MAX_DECIMALS_SHOWN (default), 0=Does not truncate. Deprecated because amount are rounded (to unit or total amount accuracy) before being inserted into database or after a computation, so this parameter should be useless.
* @param int<-1,max> $rounding MINIMUM number of decimal to show: 0=no change, -1=we use min(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), getDolGlobalString('MAIN_MAX_DECIMALS_TOT'))
* @param ''|'MU'|'MT'|'MS'|'CU'|'CT'|int<-2,max> $forcerounding MAXIMUM number of decimal to forcerounding decimal: -1=no change, -2=keep non zero part, 'MU' or 'MT' or a numeric to round to MU or MT or to a given number of decimal
* @param string $currency_code To add currency symbol (''=add nothing, 'auto'=Use default currency, 'XXX'=add currency symbols for XXX currency)
* @return string String with formatted amount
*
* @see price2num() Revert function of price
*/
function price($amount, $form = 0, $outlangs = '', $trunc = 1, $rounding = -1, $forcerounding = -1, $currency_code = '')
{
global $langs, $conf;
// Clean parameters
if (empty($amount)) {
$amount = 0; // To have a numeric value if amount not defined or = ''
}
$amount = (is_numeric($amount) ? $amount : 0); // Check if amount is numeric, for example, an error occurred when amount value = o (letter) instead 0 (number)
if ($rounding == -1) {
$rounding = min(getDolGlobalString('MAIN_MAX_DECIMALS_UNIT'), getDolGlobalString('MAIN_MAX_DECIMALS_TOT'));
}
$nbdecimal = $rounding;
if ($outlangs === 'none') {
// Use international separators
$dec = '.';
$thousand = '';
} else {
// Output separators by default (french)
$dec = ',';
$thousand = ' ';
// If $outlangs not forced, we use use language
if (!($outlangs instanceof Translate)) {
$outlangs = $langs;
}
if ($outlangs->transnoentitiesnoconv("SeparatorDecimal") != "SeparatorDecimal") {
$dec = $outlangs->transnoentitiesnoconv("SeparatorDecimal");
}
if ($outlangs->transnoentitiesnoconv("SeparatorThousand") != "SeparatorThousand") {
$thousand = $outlangs->transnoentitiesnoconv("SeparatorThousand");
}
if ($thousand == 'None') {
$thousand = '';
} elseif ($thousand == 'Space') {
$thousand = ' ';
}
}
//print "outlangs=".$outlangs->defaultlang." amount=".$amount." html=".$form." trunc=".$trunc." nbdecimal=".$nbdecimal." dec='".$dec."' thousand='".$thousand."'<br>";
//print "amount=".$amount."-";
$amount = str_replace(',', '.', $amount); // should be useless
//print $amount."-";
$data = explode('.', $amount);
$decpart = isset($data[1]) ? $data[1] : '';
$decpart = preg_replace('/0+$/i', '', $decpart); // 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);
}
// If nbdecimal is higher than max to show
$nbdecimalmaxshown = (int) str_replace('...', '', getDolGlobalString('MAIN_MAX_DECIMALS_SHOWN'));
if ($trunc && $nbdecimal > $nbdecimalmaxshown) {
$nbdecimal = $nbdecimalmaxshown;
if (preg_match('/\.\.\./i', getDolGlobalString('MAIN_MAX_DECIMALS_SHOWN'))) {
// If output is truncated, we show ...
$end = '...';
}
}
// If force rounding
if ((string) $forcerounding != '-1' && (string) $forcerounding != '') {
if ($forcerounding === 'MU') {
$nbdecimal = getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT');
} elseif ($forcerounding === 'MT') {
$nbdecimal = getDolGlobalInt('MAIN_MAX_DECIMALS_TOT');
} elseif ($forcerounding >= 0) {
$nbdecimal = (int) $forcerounding;
}
}
// Format number
$output = number_format((float) $amount, $nbdecimal, $dec, $thousand);
// Add symbol of currency if requested
$cursymbolbefore = $cursymbolafter = '';
if ($currency_code && is_object($outlangs)) {
if ($currency_code == 'auto') {
$currency_code = $conf->currency;
}
$listofcurrenciesbefore = array('AUD', 'CAD', 'CNY', 'COP', 'CLP', 'GBP', 'HKD', 'MXN', 'PEN', 'USD', 'CRC', 'ZAR');
$listoflanguagesbefore = array('nl_NL');
if (in_array($currency_code, $listofcurrenciesbefore) || in_array($outlangs->defaultlang, $listoflanguagesbefore)) {
$cursymbolbefore .= $outlangs->getCurrencySymbol($currency_code);
} else {
$tmpcur = $outlangs->getCurrencySymbol($currency_code);
$cursymbolafter .= ($tmpcur == $currency_code ? ' '.$tmpcur : $tmpcur);
}
}
$output = $cursymbolbefore.$output.$end.($cursymbolafter ? ' ' : '').$cursymbolafter;
if ($form) {
$output = preg_replace('/\s/', ' ', $output);
$output = preg_replace('/\'/', ''', $output);
}
return $output;
}
/**
* Function that return a number with universal decimal format (decimal separator is '.') from an amount typed by a user.
* Function to use on each input amount before any numeric test or database insert. A better name for this function
* should be roundtext2num().
*
* @param int|float|string|null $amount Amount to convert/clean or round
* @param ''|'MU'|'MT'|'MS'|'CU'|'CT'|int<0,max> $rounding ''=No rounding
* 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT)
* 'MT'=Round to Max for totals with Tax (MAIN_MAX_DECIMALS_TOT)
* 'MS'=Round to Max for stock quantity (MAIN_MAX_DECIMALS_STOCK)
* 'CU'=Round to Max unit price of foreign currency accuracy
* 'CT'=Round to Max for totals with Tax of foreign currency accuracy
* Numeric = Nb of digits for rounding (For example 2 for a percentage)
* @param int<0,2> $option Put 1 if you know that content is already universal format number (so no correction on decimal will be done)
* Put 2 if you know that number is a user input (so we know we have to fix decimal separator).
* @return string Amount with universal numeric format (Example: '99.99999'), or error message.
* If conversion fails to return a numeric, it returns:
* - text unchanged or partial if ($rounding = ''): price2num('W9ç', '', 0) => '9ç', price2num('W9ç', '', 1) => 'W9ç', price2num('W9ç', '', 2) => '9ç'
* - '0' if ($rounding is defined): price2num('W9ç', 'MT', 0) => '9', price2num('W9ç', 'MT', 1) => '0', price2num('W9ç', 'MT', 2) => '9'
* Note: The best way to guarantee a numeric value is to add a cast (float) before the price2num().
* If amount is null or '', it returns '' if $rounding = '', it returns '0' if $rounding is defined.
*
* @see price() Opposite function of price2num
*/
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("%10.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
$temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
$nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
$amount = number_format($amount, $nbofdec, $dec, $thousand);
}
//print "QQ".$amount."<br>\n";
// Now make replaceents (the main goal of function)
if ($thousand != ',' && $thousand != '.') {
// Accept the two types of decimal points french users (i.e., using ' ' for thousands)
// REGEX: Find the integral and decimal parts.
//
// We require that the decimal point only appears once in $amount.
// The regex `/^(?<int>[^,]*,|[^.]*\.)(?<dec>[^.,]*)$/u` can be broken down as follows:
// - `(?<int>[^,]*,|[^.]*\.)` is any accepted sequence up to the last potential decimal point '.' or ',' and named `int`.
// It covers two cases:
// - `[^,]*,`: Any sequence of characters that is not ',' with ',' accepted as the decimal point (from start of string because of earlier `^`);
// - `[^.]*\.`: Any sequence of characters that is not a '.' with '.' accepted as the decimal point (from start of string.
// - `(?<dec>[^.,]*)`: The sequence after the character accepted as the decimal point, not including it.
$matches = array();
if (preg_match('/^(?<int>[^,]*,|[^.]*\.)(?<dec>[^.,]*)$/u', $amount, $matches)) {
$intPart = $matches['int'];
$decPart = $matches['dec'];
// Remove all commas and dots from intPart
$intPart = str_replace(['.', ','], '', $intPart);
// Combine intPart and decPart with a dot
$amount = $intPart . $dec . $decPart;
}
}
$amount = str_replace(' ', '', $amount); // To avoid spaces
$amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
$amount = str_replace($dec, '.', $amount);
$amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
}
//print ' XX'.$amount.' '.$rounding;
// Now, $amount is a real PHP float number. We make a rounding if required.
if ($rounding) {
$nbofdectoround = '';
if ($rounding == 'MU') {
$nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT'); // usually 5
} elseif ($rounding == 'MT') {
$nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_TOT'); // usually 2 or 3
} elseif ($rounding == 'MS') {
$nbofdectoround = isset($conf->global->MAIN_MAX_DECIMALS_STOCK) ? getDolGlobalInt('MAIN_MAX_DECIMALS_STOCK') : 5;
} elseif ($rounding == 'CU') {
$nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_CURRENCY_UNIT', getDolGlobalInt('MAIN_MAX_DECIMALS_UNIT')); // TODO Use param of currency
} elseif ($rounding == 'CT') {
$nbofdectoround = getDolGlobalInt('MAIN_MAX_DECIMALS_CURRENCY_TOT', getDolGlobalInt('MAIN_MAX_DECIMALS_TOT')); // TODO Use param of currency
} elseif (is_numeric($rounding)) {
$nbofdectoround = (int) $rounding;
}
//print " RR".$amount.' - '.$nbofdectoround.'<br>';
if (dol_strlen($nbofdectoround)) {
$amount = round(is_string($amount) ? (float) $amount : $amount, $nbofdectoround); // $nbofdectoround can be 0.
} else {
return 'ErrorBadParameterProvidedToFunction';
}
//print ' SS'.$amount.' - '.$nbofdec.' - '.$dec.' - '.$thousand.' - '.$nbofdectoround.'<br>';
// Convert amount to format with dolibarr dec and thousand (this is because PHP convert a number
// to format defined by LC_NUMERIC after a calculation and we want source format to be defined by Dolibarr setup.
if (is_numeric($amount)) {
// We put in temps value of decimal ("0.00001"). Works with 0 and 2.0E-5 and 9999.10
$temps = sprintf("%10.10F", $amount - intval($amount)); // temps=0.0000000000 or 0.0000200000 or 9999.1000000000
$temps = preg_replace('/([\.1-9])0+$/', '\\1', $temps); // temps=0. or 0.00002 or 9999.1
$nbofdec = max(0, dol_strlen($temps) - 2); // -2 to remove "0."
$amount = number_format($amount, min($nbofdec, $nbofdectoround), $dec, $thousand); // Convert amount to format with dolibarr dec and thousand
}
//print "TT".$amount.'<br>';
// Always make replace because each math function (like round) replace
// with local values and we want a number that has a SQL string format x.y
if ($thousand != ',' && $thousand != '.') {
$amount = str_replace(',', '.', $amount); // To accept 2 notations for french users
}
$amount = str_replace(' ', '', $amount); // To avoid spaces
$amount = str_replace($thousand, '', $amount); // Replace of thousand before replace of dec to avoid pb if thousand is .
$amount = str_replace($dec, '.', $amount);
$amount = preg_replace('/[^0-9\-\.]/', '', $amount); // Clean non numeric chars (so it clean some UTF8 spaces for example.
}
return $amount;
}
/**
* Output a dimension with best unit
*
* @param float $dimension Dimension
* @param int $unit Unit scale of dimension (Example: 0=kg, -3=g, -6=mg, 98=ounce, 99=pound, ...)
* @param string $type 'weight', 'volume', ...
* @param Translate $outputlangs Translate language object
* @param int<-1,max> $round -1 = non rounding, x = number of decimal
* @param string $forceunitoutput 'no' or numeric (-3, -6, ...) compared to $unit (In most case, this value is value defined into $conf->global->MAIN_WEIGHT_DEFAULT_UNIT)
* @param int<0,1> $use_short_label 1=Use short label ('g' instead of 'gram'). Short labels are not translated.
* @return string String to show dimensions
*/
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 *= 1000000;
$unit -= 6;
} elseif (($forceunitoutput == 'no' && $dimension < 1 / 10 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == -3)) {
$dimension *= 1000;
$unit -= 3;
} elseif (($forceunitoutput == 'no' && $dimension > 100000000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 6)) {
$dimension /= 1000000;
$unit += 6;
} elseif (($forceunitoutput == 'no' && $dimension > 100000 && $unit < 90) || (is_numeric($forceunitoutput) && $forceunitoutput == 3)) {
$dimension /= 1000;
$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);
// @phan-suppress-next-line PhanPluginSuspiciousParamPosition
$ret .= ' '.measuringUnitString(0, $type, $unit, $use_short_label, $outputlangs);
return $ret;
}
/**
* Return localtax rate for a particular vat, when selling a product with vat $vatrate, from a $thirdparty_buyer to a $thirdparty_seller
* Note: This function applies same rules than get_default_tva
*
* @param float|string $vatrate Vat rate. Can be '8.5' or '8.5 (VATCODEX)' for example
* @param int $local Local tax to search and return (1 or 2 return only tax rate 1 or tax rate 2)
* @param ?Societe $thirdparty_buyer Object of buying third party
* @param ?Societe $thirdparty_seller Object of selling third party ($mysoc if not defined)
* @param int<0,1> $vatnpr If vat rate is NPR or not
* @return int<0,0>|string 0 if not found, localtax rate if found (Can be '20', '-19:-15:-9')
* @see get_default_tva()
*/
function get_localtax($vatrate, $local, $thirdparty_buyer = null, $thirdparty_seller = null, $vatnpr = 0)
{
global $db, $conf, $mysoc;
if (empty($thirdparty_seller) || !is_object($thirdparty_seller)) {
$thirdparty_seller = $mysoc;
}
dol_syslog("get_localtax tva=".$vatrate." local=".$local." thirdparty_buyer id=".(is_object($thirdparty_buyer) ? $thirdparty_buyer->id : '')."/country_code=".(is_object($thirdparty_buyer) ? $thirdparty_buyer->country_code : '')." thirdparty_seller id=".$thirdparty_seller->id."/country_code=".$thirdparty_seller->country_code." thirdparty_seller localtax1_assuj=".$thirdparty_seller->localtax1_assuj." thirdparty_seller localtax2_assuj=".$thirdparty_seller->localtax2_assuj);
$vatratecleaned = $vatrate;
$reg = array();
if (preg_match('/^(.*)\s*\((.*)\)$/', (string) $vatrate, $reg)) { // If vat is "xx (yy)"
$vatratecleaned = trim($reg[1]);
$vatratecode = $reg[2];
}
/*if ($thirdparty_buyer->country_code != $thirdparty_seller->country_code)
{
return 0;
}*/
// Some test to guess with no need to make database access
if ($mysoc->country_code == 'ES') { // For spain localtaxes 1 and 2, tax is qualified if buyer use local tax
if ($local == 1) {
if (!$mysoc->localtax1_assuj || (string) $vatratecleaned == "0") {
return 0;
}
if ($thirdparty_seller->id == $mysoc->id) {
if (!$thirdparty_buyer->localtax1_assuj) {
return 0;
}
} else {
if (!$thirdparty_seller->localtax1_assuj) {
return 0;
}
}
}
if ($local == 2) {
//if (! $mysoc->localtax2_assuj || (string) $vatratecleaned == "0") return 0;
if (!$mysoc->localtax2_assuj) {
return 0; // If main vat is 0, IRPF may be different than 0.
}
if ($thirdparty_seller->id == $mysoc->id) {
if (!$thirdparty_buyer->localtax2_assuj) {
return 0;
}
} else {
if (!$thirdparty_seller->localtax2_assuj) {
return 0;
}
}
}
} else {
if ($local == 1 && !$thirdparty_seller->localtax1_assuj) {
return 0;
}
if ($local == 2 && !$thirdparty_seller->localtax2_assuj) {
return 0;
}
}
// For some country MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY is forced to on.
if (in_array($mysoc->country_code, array('ES'))) {
$conf->global->MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY = 1;
}
// Search local taxes
if (getDolGlobalString('MAIN_GET_LOCALTAXES_VALUES_FROM_THIRDPARTY')) {
if ($local == 1) {
if ($thirdparty_seller != $mysoc) {
if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
return $thirdparty_seller->localtax1_value;
}
} else { // i am the seller
if (!isOnlyOneLocalTax($local)) { // TODO If seller is me, why not always returning this, even if there is only one locatax vat.
return getDolGlobalString('MAIN_INFO_VALUE_LOCALTAX1');
}
}
}
if ($local == 2) {
if ($thirdparty_seller != $mysoc) {
if (!isOnlyOneLocalTax($local)) { // TODO We should provide $vatrate to search on correct line and not always on line with highest vat rate
// TODO We should also return value defined on thirdparty only if defined
return $thirdparty_seller->localtax2_value;
}
} else { // i am the seller
if (in_array($mysoc->country_code, array('ES'))) {
return $thirdparty_buyer->localtax2_value;
} else {
return getDolGlobalString('MAIN_INFO_VALUE_LOCALTAX2');
}
}
}
}
// By default, search value of local tax on line of common tax
$sql = "SELECT t.localtax1, t.localtax2, t.localtax1_type, t.localtax2_type";
$sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
$sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($thirdparty_seller->country_code)."'";
$sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
$sql .= " AND t.entity IN (".getEntity('c_tva').")";
if (!empty($vatratecode)) {
$sql .= " AND t.code ='".$db->escape($vatratecode)."'"; // If we have the code, we use it in priority
} else {
$sql .= " AND t.recuperableonly = '".$db->escape((string) $vatnpr)."'";
}
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
if ($local == 1) {
return $obj->localtax1;
} elseif ($local == 2) {
return $obj->localtax2;
}
}
}
return 0;
}
/**
* Return true if LocalTax (1 or 2) is unique.
* Example: If localtax1 is 5 on line with highest common vat rate, return true
* Example: If localtax1 is 5:8:15 on line with highest common vat rate, return false
*
* @param int $local Local tax to test (1 or 2)
* @return boolean True if LocalTax have multiple values, False if not
*/
function isOnlyOneLocalTax($local)
{
$tax = get_localtax_by_third($local);
$valors = explode(":", $tax);
if (count($valors) > 1) {
return false;
} else {
return true;
}
}
/**
* Get values of localtaxes (1 or 2) for company country for the common vat with the highest value
*
* @param int $local LocalTax to get
* @return string Values of localtax (Can be '20', '-19:-15:-9') or 'Error'
*/
function get_localtax_by_third($local)
{
global $db, $mysoc;
$sql = " SELECT t.localtax".$local." as localtax";
$sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t INNER JOIN ".MAIN_DB_PREFIX."c_country as c ON c.rowid = t.fk_pays";
$sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND t.active = 1 AND t.entity IN (".getEntity('c_tva').") AND t.taux = (";
$sql .= "SELECT MAX(tt.taux) FROM ".MAIN_DB_PREFIX."c_tva as tt INNER JOIN ".MAIN_DB_PREFIX."c_country as c ON c.rowid = tt.fk_pays";
$sql .= " WHERE c.code = '".$db->escape($mysoc->country_code)."' AND t.entity IN (".getEntity('c_tva').") AND tt.active = 1)";
$sql .= " AND t.localtax".$local."_type <> '0'";
$sql .= " ORDER BY t.rowid DESC";
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
return $obj->localtax;
} else {
return '0';
}
}
return 'Error';
}
/**
* Get tax (VAT) main information from Id.
* You can also call getLocalTaxesFromRate() after to get only localtax fields.
*
* @param float|string $vatrate VAT ID or Rate. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
* @param ?Societe $buyer Company object
* @param ?Societe $seller Company object
* @param int<0,1> $firstparamisid 1 if first param is id into table (use this if you can)
* @return array{}|array{rowid:int,code:string,rate:float,localtax1:float,localtax1_type:string,localtax2:float,localtax2_type:string,npr:float,accountancy_code_sell:string,accountancy_code_buy:string} array('rowid'=> , 'code'=> ...)
* @see getLocalTaxesFromRate()
*/
function getTaxesFromId($vatrate, $buyer = null, $seller = null, $firstparamisid = 1)
{
global $db;
dol_syslog("getTaxesFromId vat id or rate = ".$vatrate);
// Search local taxes
$sql = "SELECT t.rowid, t.code, t.taux as rate, t.recuperableonly as npr, t.accountancy_code_sell, t.accountancy_code_buy,";
$sql .= " t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type";
$sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
if ($firstparamisid) {
$sql .= " WHERE t.rowid = ".(int) $vatrate;
} else {
$vatratecleaned = $vatrate;
$vatratecode = '';
$reg = array();
if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "xx (yy)"
$vatratecleaned = $reg[1];
$vatratecode = $reg[2];
}
$sql .= ", ".MAIN_DB_PREFIX."c_country as c";
/*if ($mysoc->country_code == 'ES') $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($buyer->country_code)."'"; // vat in spain use the buyer country ??
else $sql.= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($seller->country_code)."'";*/
$sql .= " WHERE t.fk_pays = c.rowid";
if (getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')) {
$sql .= " AND c.code = '".$db->escape($buyer->country_code)."'";
} else {
$sql .= " AND c.code = '".$db->escape($seller->country_code)."'";
}
$sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
$sql .= " AND t.entity IN (".getEntity('c_tva').")";
if ($vatratecode) {
$sql .= " AND t.code = '".$db->escape($vatratecode)."'";
}
}
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
return array(
'rowid' => $obj->rowid,
'code' => $obj->code,
'rate' => $obj->rate,
'localtax1' => $obj->localtax1,
'localtax1_type' => $obj->localtax1_type,
'localtax2' => $obj->localtax2,
'localtax2_type' => $obj->localtax2_type,
'npr' => $obj->npr,
'accountancy_code_sell' => $obj->accountancy_code_sell,
'accountancy_code_buy' => $obj->accountancy_code_buy
);
} else {
return array();
}
} else {
dol_print_error($db);
}
return array();
}
/**
* Get type and rate of localtaxes for a particular vat rate/country of a thirdparty.
* This does not take into account the seller setup if subject to vat or not, only country.
*
* TODO This function is ALSO called to retrieve type for building PDF. Such call of function must be removed.
* Instead this function must be called when adding a line to get the array of possible values for localtax and type, and then
* provide the selected value to the function calcul_price_total.
*
* @param float|string $vatrate VAT ID or Rate+Code. Value can be value or the string with code into parenthesis or rowid if $firstparamisid is 1. Example: '8.5' or '8.5 (8.5NPR)' or 123.
* @param int<0,2> $local Number of localtax (1 or 2, or 0 to return 1 & 2)
* @param ?Societe $buyer Company object
* @param ?Societe $seller Company object
* @param int<0,1> $firstparamisid 1 if first param is ID into table instead of Rate+code (use this if you can)
* @return array{}|array{0:string,1:int|string,2:string,3:string}|array{0:string,1:int|string,2:string,3:int|string,4:string,5:string} array(localtax_type1('1-6' or '0' if not found), rate localtax1, localtax_type2, rate localtax2, accountancycodecust, accountancycodesupp)
* @see getTaxesFromId()
*/
function getLocalTaxesFromRate($vatrate, $local, $buyer, $seller, $firstparamisid = 0)
{
global $db, $mysoc;
dol_syslog("getLocalTaxesFromRate vatrate=".$vatrate." local=".$local);
// Search local taxes
$sql = "SELECT t.taux as rate, t.code, t.localtax1, t.localtax1_type, t.localtax2, t.localtax2_type, t.accountancy_code_sell, t.accountancy_code_buy";
$sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
if ($firstparamisid) {
$sql .= " WHERE t.rowid = ".(int) $vatrate;
} else {
$vatratecleaned = $vatrate;
$vatratecode = '';
$reg = array();
if (preg_match('/^(.*)\s*\((.*)\)$/', $vatrate, $reg)) { // If vat is "x.x (yy)"
$vatratecleaned = $reg[1];
$vatratecode = $reg[2];
}
$sql .= ", ".MAIN_DB_PREFIX."c_country as c";
if (!empty($mysoc) && $mysoc->country_code == 'ES') {
$countrycodetouse = ((empty($buyer) || empty($buyer->country_code)) ? $mysoc->country_code : $buyer->country_code);
$sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($countrycodetouse)."'"; // local tax in spain use the buyer country ??
} else {
$countrycodetouse = ((empty($seller) || empty($seller->country_code)) ? $mysoc->country_code : $seller->country_code);
$sql .= " WHERE t.fk_pays = c.rowid AND c.code = '".$db->escape($countrycodetouse)."'";
}
$sql .= " AND t.taux = ".((float) $vatratecleaned)." AND t.active = 1";
if ($vatratecode) {
$sql .= " AND t.code = '".$db->escape($vatratecode)."'";
}
}
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
$vateratestring = $obj->rate.($obj->code ? ' ('.$obj->code.')' : '');
if ($local == 1) {
return array($obj->localtax1_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
} elseif ($local == 2) {
return array($obj->localtax2_type, get_localtax($vateratestring, $local, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
} else {
return array($obj->localtax1_type, get_localtax($vateratestring, 1, $buyer, $seller), $obj->localtax2_type, get_localtax($vateratestring, 2, $buyer, $seller), $obj->accountancy_code_sell, $obj->accountancy_code_buy);
}
}
}
return array();
}
/**
* Return vat rate of a product in a particular country, or default country vat if product is unknown.
* Function called by get_default_tva(). Do not use this function directly, prefer to use get_default_tva().
*
* @param int $idprod Id of product or 0 if not a predefined product
* @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
* @param int $idprodfournprice Id product_fournisseur_price (for "supplier" proposal/order/invoice)
* @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)'
* @see get_default_tva(), get_product_localtax_for_country()
*/
function get_product_vat_for_country($idprod, $thirdpartytouse, $idprodfournprice = 0)
{
global $db, $mysoc;
require_once DOL_DOCUMENT_ROOT.'/product/class/product.class.php';
$ret = 0;
$found = 0;
if ($idprod > 0) {
// Load product
$product = new Product($db);
$product->fetch($idprod);
if (($mysoc->country_code == $thirdpartytouse->country_code)
|| (in_array($mysoc->country_code, array('FR', 'MC')) && in_array($thirdpartytouse->country_code, array('FR', 'MC')))
|| (in_array($mysoc->country_code, array('MQ', 'GP')) && in_array($thirdpartytouse->country_code, array('MQ', 'GP')))
) {
// If country of thirdparty to consider is ours
if ($idprodfournprice > 0) { // We want vat for product for a "supplier" object
$result = $product->get_buyprice($idprodfournprice, 0, 0, '');
if ($result > 0) {
$ret = $product->vatrate_supplier;
if ($product->default_vat_code_supplier) {
$ret .= ' ('.$product->default_vat_code_supplier.')';
}
$found = 1;
}
}
if (!$found) {
$ret = $product->tva_tx; // Default sales vat of product
if ($product->default_vat_code) {
$ret .= ' ('.$product->default_vat_code.')';
}
$found = 1;
}
} else {
// TODO Read default product vat according to product and an other countrycode.
// Vat for couple anothercountrycode/product is data that is not managed and store yet, so we will fallback on next rule.
}
}
if (!$found) {
if (!getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS')) {
// If vat of product for the country not found or not defined, we return the first rate found (sorting on use_default, then on higher vat of country).
$sql = "SELECT t.taux as vat_rate, t.code as default_vat_code";
$sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t, ".MAIN_DB_PREFIX."c_country as c";
$sql .= " WHERE t.active = 1 AND t.fk_pays = c.rowid AND c.code = '".$db->escape($thirdpartytouse->country_code)."'";
$sql .= " AND t.entity IN (".getEntity('c_tva').")";
$sql .= " ORDER BY t.use_default DESC, t.taux DESC, t.code ASC, t.recuperableonly ASC";
$sql .= $db->plimit(1);
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
$ret = $obj->vat_rate;
if ($obj->default_vat_code) {
$ret .= ' ('.$obj->default_vat_code.')';
}
}
$db->free($resql);
} else {
dol_print_error($db);
}
} else {
// Forced value if autodetect fails. MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS can be
// '1.23'
// or '1.23 (CODE)'
$defaulttx = '';
if (getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS') != 'none') {
$defaulttx = getDolGlobalString('MAIN_VAT_DEFAULT_IF_AUTODETECT_FAILS');
}
/*if (preg_match('/\((.*)\)/', $defaulttx, $reg)) {
$defaultcode = $reg[1];
$defaulttx = preg_replace('/\s*\(.*\)/', '', $defaulttx);
}*/
$ret = $defaulttx;
}
}
dol_syslog("get_product_vat_for_country: ret=".$ret);
return $ret;
}
/**
* Return localtax vat rate of a product in a particular country or default country vat if product is unknown
*
* @param int $idprod Id of product
* @param int $local 1 for localtax1, 2 for localtax 2
* @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...)
* @return int Return integer <0 if KO, Vat rate if OK
* @see get_product_vat_for_country()
*/
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 .= " AND t.entity IN (".getEntity('c_tva').")";
$sql .= " ORDER BY t.taux DESC, t.recuperableonly ASC";
$sql .= $db->plimit(1);
$resql = $db->query($sql);
if ($resql) {
$obj = $db->fetch_object($resql);
if ($obj) {
if ($local == 1) {
$ret = $obj->localtax1;
} elseif ($local == 2) {
$ret = $obj->localtax2;
}
}
} else {
dol_print_error($db);
}
}
dol_syslog("get_product_localtax_for_country: ret=".$ret);
return $ret;
}
/**
* Function that return vat rate of a product line (according to seller, buyer and product vat rate)
* VATRULE 1: If seller does not use VAT, default VAT is 0. End of rule.
* VATRULE 2: If buyer department has a VAT rule from vat rates dictionary then it's the default VAT rate. End of rule.
* VATRULE 3: If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule.
* VATRULE 4: If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule.
* VATRULE 5: If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule
* VATRULE 6: If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule
* VATRULE 7: Otherwise the VAT proposed by default=0. End of rule.
*
* @param Societe $thirdparty_seller Object Seller company
* @param Societe $thirdparty_buyer Object Buyer company
* @param int $idprod Id product
* @param int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)
* @return float|string Vat rate to use with format 5.0 or '5.0 (XXX)', -1 if we can't guess it
* @see get_default_localtax(), get_default_npr()
*/
function get_default_tva(Societe $thirdparty_seller, Societe $thirdparty_buyer, $idprod = 0, $idprodfournprice = 0)
{
global $mysoc, $db;
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
// Note: possible values for tva_assuj are 0/1 or franchise/reel
$seller_use_vat = ((is_numeric($thirdparty_seller->tva_assuj) && !$thirdparty_seller->tva_assuj) || (!is_numeric($thirdparty_seller->tva_assuj) && $thirdparty_seller->tva_assuj == 'franchise')) ? 0 : 1;
if (empty($thirdparty_seller->country_code)) {
$thirdparty_seller->country_code = $mysoc->country_code;
}
$seller_country_code = $thirdparty_seller->country_code;
$seller_in_cee = isInEEC($thirdparty_seller);
if (empty($thirdparty_buyer->country_code)) {
$thirdparty_buyer->country_code = $mysoc->country_code;
}
$buyer_country_code = $thirdparty_buyer->country_code;
$buyer_in_cee = isInEEC($thirdparty_buyer);
dol_syslog("get_default_tva: seller use vat=".$seller_use_vat.", seller country=".$seller_country_code.", seller in cee=".((string) (int) $seller_in_cee).", buyer vat number=".$thirdparty_buyer->tva_intra." buyer country=".$buyer_country_code.", buyer state=".$thirdparty_buyer->state_id." buyer in cee=".((string) (int) $buyer_in_cee).", idprod=".$idprod.", idprodfournprice=".$idprodfournprice.", SERVICE_ARE_ECOMMERCE_200238EC=".getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC'));
// If services are eServices according to EU Council Directive 2002/38/EC (http://ec.europa.eu/taxation_customs/taxation/vat/traders/e-commerce/article_1610_en.htm)
// we use the buyer VAT.
if (getDolGlobalString('SERVICE_ARE_ECOMMERCE_200238EC')) {
if ($seller_in_cee && $buyer_in_cee) {
$isacompany = $thirdparty_buyer->isACompany();
if ($isacompany && getDolGlobalString('MAIN_USE_VAT_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, default VAT is 0. End of rule.
if (!$seller_use_vat) {
//print 'VATRULE 1';
return 0;
}
// 'VATRULE 2' - Force VAT if a buyer department is defined on vat rates dictionary
if (!empty($thirdparty_buyer->state_id)) {
$sql = "SELECT d.rowid, t.taux as vat_default_rate, t.code as vat_default_code ";
$sql .= " FROM ".$db->prefix()."c_tva as t";
$sql .= " INNER JOIN ".$db->prefix()."c_departements as d ON t.fk_department_buyer = d.rowid";
$sql .= " WHERE d.rowid = ".((int) $thirdparty_buyer->state_id);
$sql .= " ORDER BY t.use_default DESC, t.taux DESC, t.code ASC, t.recuperableonly ASC";
$res = $db->query($sql);
if ($res) {
if ($db->num_rows($res)) {
$obj = $db->fetch_object($res);
return $obj->vat_default_rate.' ('.$obj->vat_default_code.')';
}
$db->free($res);
}
}
// If the (seller country = buyer country) then the default VAT = VAT of the product sold. End of rule.
if (($seller_country_code == $buyer_country_code)
|| (in_array($seller_country_code, array('FR', 'MC')) && in_array($buyer_country_code, array('FR', 'MC')))
|| (in_array($seller_country_code, array('MQ', 'GP')) && in_array($buyer_country_code, array('MQ', 'GP')))
) { // Warning ->country_code not always defined
//print 'VATRULE 3';
$tmpvat = get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
if ($seller_country_code == 'IN' && getDolGlobalString('MAIN_SALETAX_AUTOSWITCH_I_CS_FOR_INDIA')) {
// Special case for india.
//print 'VATRULE 3b';
$reg = array();
if (preg_match('/C+S-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id != $thirdparty_buyer->state_id) {
// we must revert the C+S into I
$tmpvat = str_replace("C+S", "I", $tmpvat);
} elseif (preg_match('/I-(\d+)/', $tmpvat, $reg) && $thirdparty_seller->state_id == $thirdparty_buyer->state_id) {
// we must revert the I into C+S
$tmpvat = str_replace("I", "C+S", $tmpvat);
}
}
return $tmpvat;
}
// If (seller and buyer in the European Community) and (property sold = new means of transport such as car, boat, plane) then VAT by default = 0 (VAT must be paid by the buyer to the tax center of his country and not to the seller). End of rule.
// 'VATRULE 4' - Not supported
// If (seller and buyer in the European Community) and (buyer = individual) then VAT by default = VAT of the product sold. End of rule
// If (seller and buyer in European Community) and (buyer = company) then VAT by default=0. End of rule
if (($seller_in_cee && $buyer_in_cee)) {
$isacompany = $thirdparty_buyer->isACompany();
if ($isacompany && getDolGlobalString('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 5';
return get_product_vat_for_country($idprod, $thirdparty_seller, $idprodfournprice);
} else {
//print 'VATRULE 6';
return 0;
}
}
// If (seller in the European Community and buyer outside the European Community and private buyer) then VAT by default = VAT of the product sold. End of rule
// I don't see any use case that need this rule.
if (getDolGlobalString('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';
}
}
// Otherwise the VAT proposed by default=0. End of rule.
// Rem: This means that at least one of the 2 is outside the European Community and the country differs
//print 'VATRULE 7';
return 0;
}
/**
* Function that returns whether VAT must be recoverable collected VAT (e.g.: VAT NPR in France)
*
* @param Societe $thirdparty_seller Thirdparty seller
* @param Societe $thirdparty_buyer Thirdparty buyer
* @param int $idprod Id product
* @param int $idprodfournprice Id supplier price for product
* @return int<0,1> 0 or 1
* @see get_default_tva(), get_default_localtax()
*/
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 that return localtax of a product line (according to seller, buyer and product vat rate)
* If the seller is not subject to VAT, then default VAT=0. Rule/Test ends.
* If (seller country == buyer country) default VAT=sold product VAT. Rule/Test ends.
* Else, default VAT=0. Rule/Test ends
*
* @param Societe $thirdparty_seller Third party seller
* @param Societe $thirdparty_buyer Third party buyer
* @param int $local Localtax to process (1 or 2)
* @param int $idprod Id product
* @return int localtax, -1 if it can not be determined
* @see get_default_tva(), get_default_npr()
*/
function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod = 0)
{
global $mysoc;
if (!is_object($thirdparty_seller)) {
return -1;
}
if (!is_object($thirdparty_buyer)) {
return -1;
}
if (empty($thirdparty_seller->country_code)) {
$thirdparty_seller->country_code = $mysoc->country_code;
}
$seller_country_code = $thirdparty_seller->country_code;
//$seller_in_cee = isInEEC($thirdparty_seller);
if (empty($thirdparty_buyer->country_code)) {
$thirdparty_buyer->country_code = $mysoc->country_code;
}
$buyer_country_code = $thirdparty_buyer->country_code;
//$buyer_in_cee = isInEEC($thirdparty_buyer);
if ($local == 1) { // Localtax 1
if ($mysoc->country_code == 'ES') {
if (is_numeric($thirdparty_buyer->localtax1_assuj) && !$thirdparty_buyer->localtax1_assuj) {
return 0;
}
} else {
// Si vendeur non assujeti a Localtax1, localtax1 par default=0
if (is_numeric($thirdparty_seller->localtax1_assuj) && !$thirdparty_seller->localtax1_assuj) {
return 0;
}
if (!is_numeric($thirdparty_seller->localtax1_assuj) && $thirdparty_seller->localtax1_assuj == 'localtax1off') {
return 0;
}
}
} elseif ($local == 2) { //I Localtax 2
// Si vendeur non assujeti a Localtax2, localtax2 par default=0
if (is_numeric($thirdparty_seller->localtax2_assuj) && !$thirdparty_seller->localtax2_assuj) {
return 0;
}
if (!is_numeric($thirdparty_seller->localtax2_assuj) && $thirdparty_seller->localtax2_assuj == 'localtax2off') {
return 0;
}
}
if ($seller_country_code == $buyer_country_code) {
return get_product_localtax_for_country($idprod, $local, $thirdparty_seller);
}
return 0;
}
/**
* Return yes or no in current language
*
* @param int<0, 1>|'yes'|'true'|'no'|'false' $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
* @param integer|string $format 1=Yes/No, 0=yes/no, 2=Disabled/enabled checkbox, 3=Disabled/enabled checkbox + Yes/No, 4 or Text=Use picto
* @param int $color 0=texte only, 1=Text is formatted with a color font style ('ok' or 'error'), 2=Text is formatted with 'ok' color.
* @return string HTML string
*/
function yn($yesno, $format = 1, $color = 0)
{
global $langs;
$result = 'unknown';
$classname = '';
if ($yesno == 1 || (isset($yesno) && (strtolower($yesno) == 'yes' || strtolower($yesno) == 'true'))) { // To set to 'no' before the test because of the '== 0'
$result = $langs->trans('yes');
if ($format == 1 || $format == 3) {
$result = $langs->trans("Yes");
}
if ($format == 2) {
$result = '<input type="checkbox" value="1" checked disabled>';
}
if ($format == 3) {
$result = '<input type="checkbox" value="1" checked disabled> '.$result;
}
if ($format == 4 || !is_numeric($format)) {
$result = img_picto(is_numeric($format) ? '' : $format, 'check');
}
$classname = 'ok';
} elseif ($yesno == 0 || strtolower($yesno) == 'no' || strtolower($yesno) == 'false') {
$result = $langs->trans("no");
if ($format == 1 || $format == 3) {
$result = $langs->trans("No");
}
if ($format == 2) {
$result = '<input type="checkbox" value="0" disabled>';
}
if ($format == 3) {
$result = '<input type="checkbox" value="0" disabled> '.$result;
}
if ($format == 4 || !is_numeric($format)) {
$result = img_picto(is_numeric($format) ? '' : $format, 'uncheck');
}
if ($color == 2) {
$classname = 'ok';
} else {
$classname = 'error';
}
}
if ($color) {
return '<span class="'.$classname.'">'.$result.'</span>';
}
return $result;
}
/**
* Return a path to have a the directory according to object where files are stored.
* This function is called by getMultidirOutput
* New usage: $conf->module->multidir_output[$object->entity].'/'.get_exdir(0, 0, 0, 1, $object, '').'/'
* or: $conf->module->dir_output.'/'.get_exdir(0, 0, 0, 0, $object, '')
*
* Example of output with new usage: $object is invoice -> 'INYYMM-ABCD'
* Example of output with old usage: '015' with level 3->"0/1/5/", '015' with level 1->"5/", 'ABC-1' with level 3 ->"0/0/1/"
*
* @param string|int $num Id of object (deprecated, $object->id will be used in future)
* @param int $level Level of subdirs to return (1, 2 or 3 levels). (deprecated, global setup will be used in future)
* @param int $alpha 0=Keep number only to forge path, 1=Use alpha part after the - (By default, use 0). (deprecated, global option will be used in future)
* @param int $withoutslash 0=With slash at end (except if '/', we return ''), 1=without slash at end
* @param ?CommonObject $object Object to use to get ref to forge the path.
* @param string $modulepart Type of object ('invoice_supplier, 'donation', 'invoice', ...'). Use '' for autodetect from $object.
* @return string Dir to use ending. Example '' or '1/' or '1/2/'
* @see getMultidirOutput()
*/
function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = '')
{
if (empty($modulepart) && is_object($object)) {
if (!empty($object->module)) {
$modulepart = $object->module;
} elseif (!empty($object->element)) {
$modulepart = $object->element;
}
}
$path = '';
// Define $arrayforoldpath that is module path using a hierarchy on more than 1 level.
$arrayforoldpath = array('cheque' => 2, 'category' => 2, 'holiday' => 2, 'supplier_invoice' => 2, 'invoice_supplier' => 2, 'mailing' => 2, 'supplier_payment' => 2);
if (getDolGlobalInt('PRODUCT_USE_OLD_PATH_FOR_PHOTO')) {
$arrayforoldpath['product'] = 2;
}
if (empty($level) && array_key_exists($modulepart, $arrayforoldpath)) {
$level = $arrayforoldpath[$modulepart];
}
if (!empty($level) && array_key_exists($modulepart, $arrayforoldpath)) {
// This part should be removed once all code is using "get_exdir" to forge path, with parameter $object and $modulepart provided.
if (empty($num) && is_object($object)) {
$num = $object->id;
}
if (empty($alpha)) {
$num = preg_replace('/([^0-9])/i', '', $num);
} else {
$num = preg_replace('/^.*\-/i', '', $num);
}
$num = substr("000".$num, -$level);
if ($level == 1) {
$path = substr($num, 0, 1);
}
if ($level == 2) {
$path = substr($num, 1, 1).'/'.substr($num, 0, 1);
}
if ($level == 3) {
$path = substr($num, 2, 1).'/'.substr($num, 1, 1).'/'.substr($num, 0, 1);
}
} else {
// We will enhance here a common way of forging path for document storage.
// In a future, we may distribute directories on several levels depending on setup and object.
// Here, $object->id, $object->ref and $modulepart are required.
if (in_array($modulepart, array('societe', 'thirdparty')) && $object instanceOf Societe) {
// Special case for thirdparty, where the ref is a company name that is not unique so path on disk is using the ID instead of the ref
$path = dol_sanitizeFileName((string) $object->id);
} else {
$path = dol_sanitizeFileName(empty($object->ref) ? (string) ((is_object($object) && property_exists($object, 'id')) ? $object->id : '') : $object->ref);
}
}
if (empty($withoutslash) && !empty($path)) {
$path .= '/';
}
return $path;
}
/**
* Creation of a directory (this can create recursive subdir)
*
* @param string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir')
* @param string $dataroot Data root directory (To avoid having the data root in the loop. Using this will also lost the warning, on first dir, saying PHP has no permission when open_basedir is used)
* @param string $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444'
* @return int Return integer < 0 if KO, 0 = already exists, > 0 if OK
*/
function dol_mkdir($dir, $dataroot = '', $newmask = '')
{
dol_syslog("functions.lib::dol_mkdir: dir=".$dir, LOG_INFO);
$dir = dol_sanitizePathName($dir, '_', 0);
$dir_osencoded = dol_osencode($dir);
if (@is_dir($dir_osencoded)) {
return 0;
}
$nberr = 0;
$nbcreated = 0;
$ccdir = '';
if (!empty($dataroot)) {
// Remove data root from loop
$dir = str_replace($dataroot.'/', '', $dir);
$ccdir = $dataroot.'/';
}
$cdir = explode("/", $dir);
$num = count($cdir);
for ($i = 0; $i < $num; $i++) {
if ($i > 0) {
$ccdir .= '/'.$cdir[$i];
} else {
$ccdir .= $cdir[$i];
}
$regs = array();
if (preg_match("/^.:$/", $ccdir, $regs)) {
continue; // If the Windows path is incomplete, continue with next directory
}
// Attention, is_dir() can fail event if the directory exists
// (i.e. according the open_basedir configuration)
if ($ccdir) {
$ccdir_osencoded = dol_osencode($ccdir);
if (!@is_dir($ccdir_osencoded)) {
dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' is not found (does not exists or is outside open_basedir PHP setting).", LOG_DEBUG);
umask(0);
$dirmaskdec = octdec((string) $newmask);
if (empty($newmask)) {
$dirmaskdec = octdec(getDolGlobalString('MAIN_UMASK', '0755'));
}
$dirmaskdec |= octdec('0111'); // Set x bit required for directories
if (!@mkdir($ccdir_osencoded, $dirmaskdec)) {
// If the is_dir has returned a false information, we arrive here
dol_syslog("functions.lib::dol_mkdir: Fails to create directory '".$ccdir."' (no permission to write into parent or directory already exists).", LOG_WARNING);
$nberr++;
} else {
dol_syslog("functions.lib::dol_mkdir: Directory '".$ccdir."' created", LOG_DEBUG);
$nberr = 0; // At this point in the code, the previous failures can be ignored -> set $nberr to 0
$nbcreated++;
}
} else {
$nberr = 0; // At this point in the code, the previous failures can be ignored -> set $nberr to 0
}
}
}
return ($nberr ? -$nberr : $nbcreated);
}
/**
* Change mod of a file
*
* @param string $filepath Full file path
* @param string $newmask Force new mask. For example '0644'
* @return void
*/
function dolChmod($filepath, $newmask = '')
{
if (!empty($newmask)) {
@chmod($filepath, octdec($newmask));
} elseif (getDolGlobalString('MAIN_UMASK')) {
@chmod($filepath, octdec(getDolGlobalString('MAIN_UMASK')));
}
}
/**
* Return picto saying a field is required
*
* @return string Chaine avec picto obligatoire
*/
function picto_required()
{
return '<span class="fieldrequired">*</span>';
}
/**
* Clean a string from all HTML tags and entities.
* This function differs from strip_tags because:
* - <br> are replaced with \n if removelinefeed=0 or 1
* - if entities are found, they are decoded BEFORE the strip
* - you can decide to convert line feed into a space
*
* @param string $stringtoclean String to clean
* @param integer $removelinefeed 1=Replace all new lines by 1 space, 0=Only ending new lines are removed others are replaced with \n, 2=The ending new line is removed but others are kept with the same number of \n than the nb of <br> when there is both "...<br>\n..."
* @param string $pagecodeto Encoding of input/output string
* @param integer $strip_tags 0=Use internal strip, 1=Use strip_tags() php function (bugged when text contains a < char that is not for a html tag or when tags is not closed like '<img onload=aaa')
* @param integer $removedoublespaces Replace double space into one space
* @return string String cleaned
*
* @see dol_escape_htmltag() strip_tags() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags(), dolStripPhpCode()
*/
function dol_string_nohtmltag($stringtoclean, $removelinefeed = 1, $pagecodeto = 'UTF-8', $strip_tags = 0, $removedoublespaces = 1)
{
if (is_null($stringtoclean)) {
return '';
}
if ($removelinefeed == 2) {
$stringtoclean = preg_replace('/<br[^>]*>(\n|\r)+/ims', '<br>', $stringtoclean);
}
$temp = preg_replace('/<br[^>]*>/i', "\n", $stringtoclean);
// We remove entities BEFORE stripping (in case of an open separator char that is entity encoded and not the closing other, the strip will fails)
$temp = dol_html_entity_decode($temp, ENT_COMPAT | ENT_HTML5, $pagecodeto);
$temp = str_replace('< ', '__ltspace__', $temp);
$temp = str_replace('<:', '__lttwopoints__', $temp);
if ($strip_tags) {
$temp = strip_tags($temp);
} else {
// Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
$pattern = "/<[^<>]+>/";
// Example of $temp: <a href="/myurl" title="<u>A title</u>">0000-021</a>
// pass 1 - $temp after pass 1: <a href="/myurl" title="A title">0000-021
// pass 2 - $temp after pass 2: 0000-021
$tempbis = $temp;
do {
$temp = $tempbis;
$tempbis = str_replace('<>', '', $temp); // No reason to have this into a text, except if value is to try bypass the next html cleaning
$tempbis = preg_replace($pattern, '', $tempbis);
//$idowhile++; print $temp.'-'.$tempbis."\n"; if ($idowhile > 100) break;
} while ($tempbis != $temp);
$temp = $tempbis;
// Remove '<' into remaining, so remove non closing html tags like '<abc' or '<<abc'. Note: '<123abc' is not a html tag (can be kept), but '<abc123' is (must be removed).
$temp = preg_replace('/<+([a-z]+)/i', '\1', $temp);
}
$temp = dol_html_entity_decode($temp, ENT_COMPAT, $pagecodeto);
// Remove also carriage returns
if ($removelinefeed == 1) {
$temp = str_replace(array("\r\n", "\r", "\n"), " ", $temp);
}
// And double quotes
if ($removedoublespaces) {
while (strpos($temp, " ")) {
$temp = str_replace(" ", " ", $temp);
}
}
$temp = str_replace('__ltspace__', '< ', $temp);
$temp = str_replace('__lttwopoints__', '<:', $temp);
return trim($temp);
}
/**
* Clean a string to keep only desirable HTML tags.
* Complementary of dol_string_onlythesehtmlattributes().
* WARNING: This also clean HTML comments (because they can be used to obfuscate tag name).
*
* @param string $stringtoclean String to clean
* @param int $cleanalsosomestyles Remove absolute/fixed positioning from inline styles
* @param int $removeclassattribute 1=Remove the class attribute from tags
* @param int $cleanalsojavascript Remove also occurrence of 'javascript:'.
* @param int $allowiframe Allow iframe tags.
* @param string[] $allowed_tags List of allowed tags to replace the default list
* @param int $allowlink Allow "link" tags (for head html section)
* @param int $allowscript Allow "script" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
* @param int $allowstyle Allow "style" tags (for head html section when using GETPOST with mode 'restricthtmlallowlinkscript')
* @param int $allowphp Allow "php" tags (Deprecated. Should never be used. If you can add php, you can also print in the php the code to output the other non allowed tags)
* @return string String cleaned
*
* @see dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_neverthesehtmltags()
*/
function dol_string_onlythesehtmltags($stringtoclean, $cleanalsosomestyles = 1, $removeclassattribute = 1, $cleanalsojavascript = 0, $allowiframe = 0, $allowed_tags = array(), $allowlink = 0, $allowscript = 0, $allowstyle = 0, $allowphp = 0)
{
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",
"ol", "p", "q", "s", "span", "strike", "strong", "title", "table", "tr", "th", "td", "u", "ul", "sup", "sub", "blockquote", "pre", "h1", "h2", "h3", "h4", "h5", "h6",
"header", "footer", "nav", "section", "menu", "menuitem" // html5 tags
);
}
$allowed_tags[] = "comment"; // this tags is added to manage comment <!--...--> that are replaced into <comment>...</comment>
if ($allowiframe) {
if (!in_array('iframe', $allowed_tags)) {
$allowed_tags[] = "iframe";
}
}
if ($allowlink) {
if (!in_array('link', $allowed_tags)) {
$allowed_tags[] = "link";
}
}
if ($allowscript) {
if (!in_array('script', $allowed_tags)) {
$allowed_tags[] = "script";
}
}
if ($allowstyle) {
if (!in_array('style', $allowed_tags)) {
$allowed_tags[] = "style";
}
}
$allowed_tags_string = implode("><", $allowed_tags);
$allowed_tags_string = '<'.$allowed_tags_string.'>';
$stringtoclean = str_replace('<!DOCTYPE html>', '__!DOCTYPE_HTML__', $stringtoclean); // Replace DOCTYPE to avoid to have it removed by the strip_tags
$stringtoclean = dol_string_nounprintableascii($stringtoclean, 0);
//$stringtoclean = preg_replace('/<!--[^>]*-->/', '', $stringtoclean);
$stringtoclean = preg_replace('/<!--([^>]*)-->/', '<comment>\1</comment>', $stringtoclean);
if ($allowphp) {
$allowed_tags[] = "commentphp";
$stringtoclean = preg_replace('/^<\?php([^"]+)\?>$/i', '<commentphp>\1__</commentphp>', $stringtoclean); // Note: <?php ... > is allowed only if on the same line
$stringtoclean = preg_replace('/"<\?php([^"]+)\?>"/i', '"<commentphp>\1</commentphp>"', $stringtoclean); // Note: "<?php ... >" is allowed only if on the same line
}
$stringtoclean = preg_replace('/:/i', ':', $stringtoclean);
$stringtoclean = preg_replace('/:|�+58|:/i', '', $stringtoclean); // refused string ':' encoded (no reason to have a : encoded like this) to disable 'javascript:...'
// Remove all HTML tags
$temp = strip_tags($stringtoclean, $allowed_tags_string); // Warning: This remove also undesired </>, so may changes string obfuscated with </> that pass the injection detection into a harmfull string
if ($cleanalsosomestyles) { // Clean for remaining html tags
$temp = preg_replace('/position\s*:\s*(absolute|fixed)\s*!\s*important/i', '', $temp); // Note: If hacker try to introduce css comment into string to bypass this regex, the string must also be encoded by the dol_htmlentitiesbr during output so it become harmless
}
if ($removeclassattribute) { // Clean for remaining html tags
$temp = preg_replace('/(<[^>]+)\s+class=((["\']).*?\\3|\\w*)/i', '\\1', $temp);
}
// Remove 'javascript:' that we should not find into a text
// Warning: This is not reliable to fight against obfuscated javascript, there is a lot of other solution to include js into a common html tag (only filtered by a GETPOST(.., powerfullfilter)).
if ($cleanalsojavascript) {
$temp = preg_replace('/j\s*a\s*v\s*a\s*s\s*c\s*r\s*i\s*p\s*t\s*:/i', '', $temp);
}
$temp = str_replace('__!DOCTYPE_HTML__', '<!DOCTYPE html>', $temp); // Restore the DOCTYPE
if ($allowphp) {
$temp = preg_replace('/<commentphp>(.*)<\/commentphp>/', '<?php\1?>', $temp); // Restore php code
}
$temp = preg_replace('/<comment>([^>]*)<\/comment>/', '<!--\1-->', $temp); // Restore html comments
return $temp;
}
/**
* Clean a string from some undesirable HTML tags.
* Note: Complementary to dol_string_onlythesehtmltags().
* This method is used for example by dol_htmlwithnojs() when option MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES is set to 1.
*
* @param string $stringtoclean String to clean
* @param string[] $allowed_attributes Array of tags not allowed
* @return string String cleaned
*
* @see dol_htmlwithnojs() dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_neverthesehtmltags()
* @phan-suppress PhanUndeclaredProperty
*/
function dol_string_onlythesehtmlattributes($stringtoclean, $allowed_attributes = null)
{
if (is_null($allowed_attributes)) {
$allowed_attributes = array(
"allow", "allowfullscreen", "alt", "async", "class", "contenteditable", "crossorigin", "data-html", "frameborder", "height", "href", "id", "name", "property", "rel", "src", "style", "target", "title", "type", "width",
// HTML5
"header", "footer", "nav", "section", "menu", "menuitem"
);
}
// Always add content and http-equiv for meta tags, required to force encoding and keep html content in utf8 by load/saveHTML functions.
if (!in_array("content", $allowed_attributes)) {
$allowed_attributes[] = "content";
}
if (!in_array("http-equiv", $allowed_attributes)) {
$allowed_attributes[] = "http-equiv";
}
if (class_exists('DOMDocument') && !empty($stringtoclean)) {
//$stringtoclean = '<?xml encoding="UTF-8"><html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>'.$stringtoclean.'</body></html>';
$stringtoclean = '<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>'.$stringtoclean.'</body></html>';
// Warning: loadHTML does not support HTML5 on old libxml versions.
$dom = new DOMDocument('', 'UTF-8');
// If $stringtoclean is wrong, it will generates warnings. So we disable warnings and restore them later.
$savwarning = error_reporting();
error_reporting(E_ALL & ~E_WARNING & ~E_NOTICE);
$dom->loadHTML($stringtoclean, LIBXML_ERR_NONE | LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD | LIBXML_NONET | LIBXML_NOWARNING | LIBXML_NOXMLDECL);
error_reporting($savwarning);
if ($dom instanceof DOMDocument) {
for ($els = $dom->getElementsByTagname('*'), $i = $els->length - 1; $i >= 0; $i--) {
$el = $els->item($i);
if (!$el instanceof DOMElement) {
continue;
}
$attrs = $el->attributes;
for ($ii = $attrs->length - 1; $ii >= 0; $ii--) {
//var_dump($attrs->item($ii));
if (!empty($attrs->item($ii)->name)) {
if (! in_array($attrs->item($ii)->name, $allowed_attributes)) {
// Delete attribute if not into allowed_attributes @phan-suppress-next-line PhanUndeclaredMethod
$els->item($i)->removeAttribute($attrs->item($ii)->name);
} elseif (in_array($attrs->item($ii)->name, array('style'))) {
// If attribute is 'style'
$valuetoclean = $attrs->item($ii)->value;
if (isset($valuetoclean)) {
do {
$oldvaluetoclean = $valuetoclean;
$valuetoclean = preg_replace('/\/\*.*\*\//m', '', $valuetoclean); // clean css comments
$valuetoclean = preg_replace('/position\s*:\s*[a-z]+/mi', '', $valuetoclean);
if ($els->item($i)->tagName == 'a') { // more paranoiac cleaning for clickable tags.
$valuetoclean = preg_replace('/display\s*:/mi', '', $valuetoclean);
$valuetoclean = preg_replace('/z-index\s*:/mi', '', $valuetoclean);
$valuetoclean = preg_replace('/\s+(top|left|right|bottom)\s*:/mi', '', $valuetoclean);
}
// We do not allow logout|passwordforgotten.php and action= into the content of a "style" tag
$valuetoclean = preg_replace('/(logout|passwordforgotten)\.php/mi', '', $valuetoclean);
$valuetoclean = preg_replace('/action=/mi', '', $valuetoclean);
} while ($oldvaluetoclean != $valuetoclean);
}
$attrs->item($ii)->value = $valuetoclean;
}
}
}
}
}
$dom->encoding = 'UTF-8';
$return = $dom->saveHTML(); // This may add a LF at end of lines, so we will trim later
//$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><head><', '/').'[^<>]*'.preg_quote('></head><body>', '/').'/', '', $return);
$return = preg_replace('/'.preg_quote('</body></html>', '/').'$/', '', trim($return));
return trim($return);
} else {
return $stringtoclean;
}
}
/**
* Clean a string from some undesirable HTML tags.
* Note: You should use instead dol_string_onlythesehtmltags() that is more secured if you can.
*
* @param string $stringtoclean String to clean
* @param string[] $disallowed_tags Array of tags not allowed
* @param int<0,1> $cleanalsosomestyles Clean also some tags
* @return string String cleaned
*
* @see dol_escape_htmltag() strip_tags() dol_string_nohtmltag() dol_string_onlythesehtmltags() dol_string_onlythesehtmlattributes()
*/
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;
}
/**
* Return first line of text. Cut will depends if content is HTML or not.
*
* @param string $text Input text
* @param int $nboflines Nb of lines to get (default is 1 = first line only)
* @param string $charset Charset of $text string (UTF-8 by default)
* @return string Output text
* @see dol_nboflines_bis(), dol_string_nohtmltag(), dol_escape_htmltag()
*/
function dolGetFirstLineOfText($text, $nboflines = 1, $charset = 'UTF-8')
{
if ($nboflines == 1) {
if (dol_textishtml($text)) {
$firstline = preg_replace('/<br[^>]*>.*$/s', '', $text); // The s pattern modifier means the . can match newline characters
$firstline = preg_replace('/<div[^>]*>.*$/s', '', $firstline); // The s pattern modifier means the . can match newline characters
} else {
if (isset($text)) {
$firstline = preg_replace('/[\n\r].*/', '', $text);
} else {
$firstline = '';
}
}
return $firstline.(isset($firstline) && isset($text) && (strlen($firstline) != strlen($text)) ? '...' : '');
} else {
$ishtml = 0;
if (dol_textishtml($text)) {
$text = preg_replace('/\n/', '', $text);
$ishtml = 1;
$repTable = array("\t" => " ", "\n" => " ", "\r" => " ", "\0" => " ", "\x0B" => " ");
} else {
$repTable = array("\t" => " ", "\n" => "<br>", "\r" => " ", "\0" => " ", "\x0B" => " ");
}
$text = strtr($text, $repTable);
if ($charset == 'UTF-8') {
$pattern = '/(<br[^>]*>)/Uu';
} else {
// /U is to have UNGREEDY regex to limit to one html tag. /u is for UTF8 support
$pattern = '/(<br[^>]*>)/U'; // /U is to have UNGREEDY regex to limit to one html tag.
}
$a = preg_split($pattern, $text, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
$firstline = '';
$i = 0;
$countline = 0;
$lastaddediscontent = 1;
while ($countline < $nboflines && isset($a[$i])) {
if (preg_match('/<br[^>]*>/', $a[$i])) {
if (array_key_exists($i + 1, $a) && !empty($a[$i + 1])) {
$firstline .= ($ishtml ? "<br>\n" : "\n");
// Is it a br for a new line of after a printed line ?
if (!$lastaddediscontent) {
$countline++;
}
$lastaddediscontent = 0;
}
} else {
$firstline .= $a[$i];
$lastaddediscontent = 1;
$countline++;
}
$i++;
}
$adddots = (isset($a[$i]) && (!preg_match('/<br[^>]*>/', $a[$i]) || (array_key_exists($i + 1, $a) && !empty($a[$i + 1]))));
//unset($a);
$ret = $firstline.($adddots ? '...' : '');
//exit;
return $ret;
}
}
/**
* Replace CRLF in string with a HTML BR tag.
* WARNING: The content after operation contains some HTML tags (the <br>) so be sure to also have
* encoded the special chars of stringtoencode into HTML before with dol_htmlentitiesbr().
*
* @param string $stringtoencode String to encode
* @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
* @param bool $forxml false=Use <br>, true=Use <br />
* @return string String encoded
* @see dol_htmlentitiesbr(), dol_nboflines(), dolGetFirstLineOfText()
*/
function dol_nl2br($stringtoencode, $nl2brmode = 0, $forxml = false)
{
if (is_null($stringtoencode)) {
return '';
}
if (!$nl2brmode) {
return nl2br($stringtoencode, $forxml);
} else {
$ret = preg_replace('/(\r\n|\r|\n)/i', ($forxml ? '<br />' : '<br>'), $stringtoencode);
return $ret;
}
}
/**
* Sanitize a HTML to remove js, dangerous content and external links.
* This function is used by dolPrintHTML... function for example.
*
* @param string $stringtoencode String to encode
* @param int $nouseofiframesandbox 0=Default, 1=Allow use of option MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS for html sanitizing (not yet working)
* @param string $check 'restricthtmlnolink' or 'restricthtml' or 'restricthtmlallowclass' or 'restricthtmlallowiframe' or 'restricthtmlallowlinkscript' or 'restricthtmlallowunvalid'
* @return string HTML sanitized
*/
function dol_htmlwithnojs($stringtoencode, $nouseofiframesandbox = 0, $check = 'restricthtml')
{
if (empty($nouseofiframesandbox) && getDolGlobalString('MAIN_SECURITY_USE_SANDBOX_FOR_HTMLWITHNOJS')) {
// TODO using sandbox on inline html content is not possible yet with current browsers
//$s = '<iframe class="iframewithsandbox" sandbox><html><body>';
//$s .= $stringtoencode;
//$s .= '</body></html></iframe>';
return $stringtoencode;
} else {
$out = $stringtoencode;
// First clean HTML content
do {
$oldstringtoclean = $out;
if (!empty($out) && getDolGlobalString('MAIN_RESTRICTHTML_ONLY_VALID_HTML') && $check != 'restricthtmlallowunvalid') {
try {
libxml_use_internal_errors(false); // Avoid to fill memory with xml errors
if (LIBXML_VERSION < 20900) {
// Avoid load of external entities (security problem).
// Required only if LIBXML_VERSION < 20900
// @phan-suppress-next-line PhanDeprecatedFunctionInternal
libxml_disable_entity_loader(true);
}
$dom = new DOMDocument();
// Add a trick '<div class="tricktoremove">' to solve pb with text without parent tag
// like '<h1>Foo</h1><p>bar</p>' that wrongly ends up, without the trick, with '<h1>Foo<p>bar</p></h1>'
// like 'abc' that wrongly ends up, without the trick, with '<p>abc</p>'
// Add also a trick <html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> to solve utf8 lost.
// I don't know what the xml encoding is the trick for
if (dol_textishtml($out)) {
//$out = '<?xml encoding="UTF-8"><html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body><div class="tricktoremove">'.$out.'</div></body></html>';
$out = '<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body><div class="tricktoremove">'.$out.'</div></body></html>';
//$out = '<html><head><meta charset="utf-8"></head><body><div class="tricktoremove">'.$out.'</div></body></html>';
} else {
//$out = '<?xml encoding="UTF-8"><html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body><div class="tricktoremove">'.dol_nl2br($out).'</div></body></html>';
$out = '<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body><div class="tricktoremove">'.dol_nl2br($out).'</div></body></html>';
//$out = '<html><head><meta charset="utf-8"></head><body><div class="tricktoremove">'.dol_nl2br($out).'</div></body></html>';
}
$dom->loadHTML($out, LIBXML_HTML_NODEFDTD | LIBXML_ERR_NONE | LIBXML_HTML_NOIMPLIED | LIBXML_NONET | LIBXML_NOWARNING | LIBXML_NOERROR | LIBXML_NOXMLDECL);
$dom->encoding = 'UTF-8';
$out = trim($dom->saveHTML());
// Remove the trick added to solve pb with text in utf8 and text without parent tag
//$out = preg_replace('/^'.preg_quote('<?xml encoding="UTF-8">', '/').'/', '', $out);
$out = preg_replace('/^'.preg_quote('<html><head><', '/').'[^<>]+'.preg_quote('></head><body><div class="tricktoremove">', '/').'/', '', $out);
$out = preg_replace('/'.preg_quote('</div></body></html>', '/').'$/', '', trim($out));
// $out = preg_replace('/^<\?xml encoding="UTF-8"><div class="tricktoremove">/', '', $out);
// $out = preg_replace('/<\/div>$/', '', $out);
// var_dump('rrrrrrrrrrrrrrrrrrrrrrrrrrrrr'.$out);
} catch (Exception $e) {
// If error, invalid HTML string with no way to clean it
//print $e->getMessage();
$out = 'InvalidHTMLStringCantBeCleaned '.$e->getMessage();
}
}
if (!empty($out) && getDolGlobalString('MAIN_RESTRICTHTML_ONLY_VALID_HTML_TIDY') && !in_array($check, array('restricthtmlallowunvalid', 'restricthtmlallowlinkscript'))) {
// Tidy can't be used for restricthtmlallowunvalid and restricthtmlallowlinkscript
// TODO Try to implement a hack for restricthtmlallowlinkscript by renaming tag <link> and <script> ?
try {
//var_dump($out);
// Try cleaning using tidy
if (extension_loaded('tidy') && class_exists("tidy")) {
//print "aaa".$out."\n";
// See options at https://tidy.sourceforge.net/docs/quickref.html
$config = array(
'clean' => false,
// Best will be to set 'quote-marks' to false to not replace " that are used for real text content (not a string symbol for html attribute) into "
'quote-marks' => false,
'doctype' => 'strict',
'show-body-only' => true,
"indent-attributes" => false,
"vertical-space" => false,
//'ident' => false, // Not always supported
"wrap" => 0,
'preserve-entities' => true
// HTML5 tags
//'new-blocklevel-tags' => 'article aside audio bdi canvas details dialog figcaption figure footer header hgroup main menu menuitem nav section source summary template track video',
//'new-blocklevel-tags' => 'footer header section menu menuitem'
//'new-empty-tags' => 'command embed keygen source track wbr',
//'new-inline-tags' => 'audio command datalist embed keygen mark menuitem meter output progress source time video wbr',
);
// Tidy
$tidy = new tidy();
$out = $tidy->repairString($out, $config, 'utf8');
//print "xxx".$out;exit;
}
//var_dump($out);
} catch (Exception $e) {
// If error, invalid HTML string with no way to clean it
//print $e->getMessage();
$out = 'InvalidHTMLStringCantBeCleaned '.$e->getMessage();
}
}
// Clear ZERO WIDTH NO-BREAK SPACE, ZERO WIDTH SPACE, ZERO WIDTH JOINER
$out = preg_replace('/[\x{200B}-\x{200D}\x{FEFF}]/u', ' ', $out);
// Clean some html entities that are useless so text is cleaner
$out = preg_replace('/&(tab|newline);/i', ' ', $out);
// Ckeditor uses the numeric entity for apostrophe, so we force it to
// the text entity (all other special chars are encoded using text entities) so we can then exclude all numeric entities.
$out = preg_replace('/'/i', ''', $out);
// We replace chars from a/A to z/Z encoded with numeric HTML entities with the real char so we won't loose the chars at the next step (preg_replace).
// No need to use a loop here, this step is not to sanitize (this is done at next step, this is to try to save chars, even if they are
// using a non conventionnal way to be encoded, to not have them sanitized just after)
if (function_exists('realCharForNumericEntities')) { // May not exist when main.inc.php not loaded, for example in a CLI context
$out = preg_replace_callback(
'/&#(x?[0-9][0-9a-f]+;?)/i',
/**
* @param string[] $m
* @return string
*/
static function ($m) {
return realCharForNumericEntities($m);
},
$out
);
}
// Now we remove all remaining HTML entities starting with a number. We don't want such entities.
$out = preg_replace('/&#x?[0-9]+/i', '', $out); // For example if we have javascript with an entities without the ; to hide the 'a' of 'javascript'.
// Keep only some html tags and remove also some 'javascript:' strings
if ($check == 'restricthtmlallowlinkscript') {
$out = dol_string_onlythesehtmltags($out, 0, 1, 0, 0, array(), 1, 1, 1, getDolGlobalInt("UNSECURED_restricthtmlallowlinkscript_ALLOW_PHP"));
} elseif ($check == 'restricthtmlallowclass' || $check == 'restricthtmlallowunvalid') {
$out = dol_string_onlythesehtmltags($out, 0, 0, 1);
} elseif ($check == 'restricthtmlallowiframe') {
$out = dol_string_onlythesehtmltags($out, 0, 0, 1, 1);
} else {
$out = dol_string_onlythesehtmltags($out, 0, 1, 1);
}
// Keep only some html attributes and exclude non expected HTML attributes and clean content of some attributes (keep only alt=, title=...).
if (getDolGlobalString('MAIN_RESTRICTHTML_REMOVE_ALSO_BAD_ATTRIBUTES')) {
$out = dol_string_onlythesehtmlattributes($out);
}
// Restore entity ' into ' (restricthtml is for html content so we can use html entity) because it is
// compatible with HTML 4 used y CKEditor, and HTML 5 (when ' works only with HTML5).
$out = preg_replace('/'/i', "'", $out);
// Now remove js
// List of dom events is on https://www.w3schools.com/jsref/dom_obj_event.asp and https://developer.mozilla.org/en-US/docs/Web/Events
$out = preg_replace('/on(mouse|drag|key|load|touch|pointer|select|transition)[a-z]*\s*=/i', '', $out); // onmousexxx can be set on img or any html tag like <img title='...' onmouseover=alert(1)>
$out = preg_replace('/on(abort|after|animation|auxclick|before|blur|cancel|canplay|canplaythrough|change|click|close|contextmenu|cuechange|copy|cut)[a-z]*\s*=/i', '', $out);
$out = preg_replace('/on(dblclick|drop|durationchange|emptied|end|ended|error|focus(in|out)?|formdata|gotpointercapture|hashchange|input|invalid)[a-z]*\s*=/i', '', $out);
$out = preg_replace('/on(lostpointercapture|offline|online|pagehide|pageshow)[a-z]*\s*=/i', '', $out);
$out = preg_replace('/on(paste|pause|play|playing|progress|ratechange|reset|resize|scroll|search|seeked|seeking|show|stalled|start|submit|suspend)[a-z]*\s*=/i', '', $out);
$out = preg_replace('/on(timeupdate|toggle|unload|volumechange|waiting|wheel)[a-z]*\s*=/i', '', $out);
// More not into the previous list
$out = preg_replace('/on(repeat|begin|finish|beforeinput)[a-z]*\s*=/i', '', $out);
} while ($oldstringtoclean != $out);
// Check the limit of external links that are automatically executed in a Rich text content. We count:
// '<img' to avoid <img src="http...">, we can only accept "<img src="data:..."
// 'url(' to avoid inline style like background: url(http...
// '<link' to avoid <link href="http...">
$reg = array();
$tmpout = preg_replace('/<img src="data:/mi', '<__IMG_SRC_DATA__ src="data:', $out);
preg_match_all('/(<img|url\(|<link)/i', $tmpout, $reg);
$nblinks = count($reg[0]);
if ($nblinks > getDolGlobalInt("MAIN_SECURITY_MAX_IMG_IN_HTML_CONTENT", 1000)) {
$out = 'ErrorTooManyLinksIntoHTMLString';
}
if (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 2 || $check == 'restricthtmlnolink') {
if ($nblinks > 0) {
$out = 'ErrorHTMLLinksNotAllowed';
}
} elseif (getDolGlobalInt('MAIN_DISALLOW_URL_INTO_DESCRIPTIONS') == 1) {
$nblinks = 0;
// Loop on each url in src= and url(
$pattern = '/src=["\']?(http[^"\']+)|url\(["\']?(http[^\)]+)/';
$matches = array();
if (preg_match_all($pattern, $out, $matches)) {
// URLs are into $matches[1]
$urls = $matches[1];
// Affiche les URLs
foreach ($urls as $url) {
$nblinks++;
echo "Found url = ".$url . "\n";
}
if ($nblinks > 0) {
$out = 'ErrorHTMLExternalLinksNotAllowed';
}
}
}
return $out;
}
}
/**
* This function is called to encode a string into a HTML string but differs from htmlentities because a detection is
* done before to see if text is already HTML or not. Also, all entities but &,<,>," (because protected by code) and ' (because not included by the ENT_COMPAT mode) are converted.
* This permits to encode special chars to entities with no double encoding for already encoded HTML strings.
* This function also remove last EOL or BR if $removelasteolbr=1 (default).
* For PDF usage, you can show text by 2 ways:
* - writeHTMLCell -> param must be encoded into HTML.
* - MultiCell -> param must not be encoded into HTML.
* Because writeHTMLCell convert also \n into <br>, if function is used to build PDF, nl2brmode must be 1.
* Note: When we output string on pages, we should use
* - dolPrintHTML... that is dol_escape_htmltag(dol_htmlwithnojs(dol_string_onlythesehtmltags(dol_htmlentitiesbr(), 1, 1, 1), 1, 1) for notes or descriptions,
* - dolPrintPassword that is a simple htmlspecialchars( , ENT_COMPAT, 'UTF-8') for passwords.
*
* @param string $stringtoencode String to encode
* @param int $nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)
* @param string $pagecodefrom Pagecode stringtoencode is encoded
* @param int $removelasteolbr 1=Remove last br or lasts \n (default), 0=Do nothing
* @return string String encoded
* @see dol_escape_htmltag(), dolGetFirstLineOfText(), dol_string_onlythesehtmltags()
*/
function dol_htmlentitiesbr($stringtoencode, $nl2brmode = 0, $pagecodefrom = 'UTF-8', $removelasteolbr = 1)
{
if (is_null($stringtoencode)) {
return '';
}
$newstring = $stringtoencode;
if (dol_textishtml($stringtoencode)) { // Check if text is already HTML or not
$newstring = preg_replace('/<br(\s[\sa-zA-Z_="]*)?\/?>/i', '<br>', $newstring); // Replace "<br type="_moz" />" by "<br>". It's same and avoid pb with FPDF.
if ($removelasteolbr) {
$newstring = preg_replace('/<br>$/i', '', $newstring); // Remove last <br> (remove only last one)
}
$newstring = preg_replace('/[\x{200B}-\x{200D}\x{FEFF}]/u', ' ', $newstring);
$newstring = strtr($newstring, array('&' => '__PROTECTand__', '<' => '__PROTECTlt__', '>' => '__PROTECTgt__', '"' => '__PROTECTdquot__'));
$newstring = dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom); // Make entity encoding
$newstring = strtr($newstring, array('__PROTECTand__' => '&', '__PROTECTlt__' => '<', '__PROTECTgt__' => '>', '__PROTECTdquot__' => '"'));
} else {
if ($removelasteolbr) {
$newstring = preg_replace('/(\r\n|\r|\n)$/i', '', $newstring); // Remove last \n (may remove several)
}
$newstring = dol_nl2br(dol_htmlentities($newstring, ENT_COMPAT, $pagecodefrom), $nl2brmode);
}
// Other substitutions that htmlentities does not do
//$newstring=str_replace(chr(128),'€',$newstring); // 128 = 0x80. Not in html entity table. // Seems useles with TCPDF. Make bug with UTF8 languages
return $newstring;
}
/**
* This function is called to decode a HTML string (it decodes entities and br tags)
*
* @param string $stringtodecode String to decode
* @param string $pagecodeto Page code for result
* @return string String decoded
*/
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;
}
/**
* This function remove all ending \n and br at end
*
* @param string $stringtodecode String to decode
* @return string String decoded
*/
function dol_htmlcleanlastbr($stringtodecode)
{
$ret = preg_replace('/ $/i', "", $stringtodecode); // Because wysiwyg editor may add a at end of last line
$ret = preg_replace('/(<br>|<br(\s[\sa-zA-Z_="]*)?\/?>|'."\n".'|'."\r".')+$/i', "", $ret);
return $ret;
}
/**
* Replace html_entity_decode functions to manage errors
*
* @param string $a Operand a
* @param int $b Operand b (ENT_QUOTES|ENT_HTML5=convert simple, double quotes, colon, e accent, ...)
* @param string $c Operand c
* @param int $keepsomeentities Entities but &, <, >, " are not converted.
* @return string String decoded
*/
function dol_html_entity_decode($a, $b, $c = 'UTF-8', $keepsomeentities = 0)
{
$newstring = $a;
if ($keepsomeentities) {
$newstring = strtr($newstring, array('&' => '__andamp__', '<' => '__andlt__', '>' => '__andgt__', '"' => '__dquot__'));
}
$newstring = html_entity_decode((string) $newstring, (int) $b, (string) $c);
if ($keepsomeentities) {
$newstring = strtr($newstring, array('__andamp__' => '&', '__andlt__' => '<', '__andgt__' => '>', '__dquot__' => '"'));
}
return $newstring;
}
/**
* Replace htmlentities functions.
* Goal of this function is to be sure to have default values of htmlentities that match what we need.
*
* @param string $string The input string to encode
* @param int $flags Flags (see PHP doc above)
* @param string $encoding Encoding page code
* @param bool $double_encode When double_encode is turned off, PHP will not encode existing html entities
* @return string $ret Encoded string
* @see dol_htmlentitiesbr()
*/
function dol_htmlentities($string, $flags = ENT_QUOTES | ENT_SUBSTITUTE, $encoding = 'UTF-8', $double_encode = false)
{
return htmlentities($string, $flags, $encoding, $double_encode);
}
/**
* Check if a string is a correct iso string
* If not, it will not be considered as HTML encoded even if it is by FPDF.
* Example, if string contains euro symbol that has ascii code 128
*
* @param string $s String to check
* @param int $clean Clean if it is not an ISO. Warning, if file is utf8, you will get a bad formatted file.
* @return int|string 0 if bad iso, 1 if good iso, Or the clean string if $clean is 1
* @deprecated Duplicate of ascii_check()
* @see ascii_check()
*/
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;
}
/**
* Return nb of lines of a clear text
*
* @param string $s String to check
* @param int $maxchar Not yet used
* @return int Number of lines
* @see dol_nboflines_bis(), dolGetFirstLineOfText()
*/
function dol_nboflines($s, $maxchar = 0)
{
if ($s == '') {
return 0;
}
$arraystring = explode("\n", $s);
$nb = count($arraystring);
return $nb;
}
/**
* Return nb of lines of a formatted text with \n and <br> (WARNING: string must not have mixed \n and br separators)
*
* @param string $text Text
* @param int $maxlinesize Linewidth in character count (default = 0 == nolimit)
* @param string $charset Give the charset used to encode the $text variable in memory.
* @return int Number of lines
* @see dol_nboflines(), dolGetFirstLineOfText()
*/
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;
}
/**
* Return if a text is a html content
*
* @param string $msg Content to check
* @param int $option 0=Full detection, 1=Fast check
* @return boolean true/false
* @see dol_concatdesc()
*/
function dol_textishtml($msg, $option = 0)
{
if (is_null($msg)) {
return false;
}
if ($option == 1) {
if (preg_match('/<(html|link|script)/i', $msg)) {
return true;
} elseif (preg_match('/<body/i', $msg)) {
return true;
} elseif (preg_match('/<\/textarea/i', $msg)) {
return true;
} elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
return true;
} elseif (preg_match('/<br/i', $msg)) {
return true;
}
return false;
} else {
// Remove all urls because 'http://aa?param1=abc&param2=def' must not be used inside detection
$msg = preg_replace('/https?:\/\/[^"\'\s]+/i', '', $msg);
if (preg_match('/<(html|link|script|body)/i', $msg)) {
return true;
} elseif (preg_match('/<\/textarea/i', $msg)) {
return true;
} elseif (preg_match('/<(b|em|i|u)(\s+[^>]+)?>/i', $msg)) {
return true;
} elseif (preg_match('/<(br|hr)\/>/i', $msg)) {
return true;
} elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)>/i', $msg)) {
return true;
} elseif (preg_match('/<(br|hr|div|font|li|p|span|strong|table)\s+[^<>\/]*\/?>/i', $msg)) {
return true;
} elseif (preg_match('/<img\s+[^<>]*src[^<>]*>/i', $msg)) {
return true; // must accept <img src="http://example.com/aaa.png" />
} elseif (preg_match('/<a\s+[^<>]*href[^<>]*>/i', $msg)) {
return true; // must accept <a href="http://example.com/aaa.png" />
} elseif (preg_match('/<h[0-9]>/i', $msg)) {
return true;
} elseif (preg_match('/&[A-Z0-9]{1,6};/i', $msg)) {
// TODO If content is 'A link https://aaa?param=abc&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;
}
}
/**
* Concat 2 descriptions with a new line between them (second operand after first one with appropriate new line separator)
* text1 html + text2 html => text1 + '<br>' + text2
* text1 html + text2 txt => text1 + '<br>' + dol_nl2br(text2)
* text1 txt + text2 html => dol_nl2br(text1) + '<br>' + text2
* text1 txt + text2 txt => text1 + '\n' + text2
*
* @param string $text1 Text 1
* @param string $text2 Text 2
* @param bool $forxml true=Use <br /> instead of <br> if we have to add a br tag
* @param bool $invert invert order of description lines (we often use config MAIN_CHANGE_ORDER_CONCAT_DESCRIPTION in this parameter)
* @return string Text 1 + new line + Text2
* @see dol_textishtml()
*/
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;
}
/**
* Return array of possible common substitutions. This includes several families like: 'system', 'mycompany', 'object', 'objectamount', 'date', 'user'
*
* @param Translate $outputlangs Output language
* @param int $onlykey 1=Do not calculate some heavy values of keys (performance enhancement when we need only the keys),
* 2=Values are trunc and html sanitized (to use for help tooltip)
* @param string[]|null $exclude Array of family keys we want to exclude. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)
* @param ?CommonObject $object Object for keys on object
* @param string[]|null $include Array of family keys we want to include. For example array('system', 'mycompany', 'object', 'objectamount', 'date', 'user', ...)
* @return array<string,string> Array of substitutions
* @see setSubstitFromObject()
* @phan-suppress PhanTypeArraySuspiciousNullable,PhanTypePossiblyInvalidDimOffset,PhanUndeclaredProperty
*/
function getCommonSubstitutionArray($outputlangs, $onlykey = 0, $exclude = null, $object = null, $include = null)
{
global $db, $conf, $mysoc, $user, $extrafields;
$substitutionarray = array();
if ((empty($exclude) || !in_array('user', $exclude)) && (empty($include) || in_array('user', $include)) && $user instanceof User) {
// Add SIGNATURE into substitutionarray first, so, when we will make the substitution,
// this will include signature content first and then replace var found into content of signature
//var_dump($onlykey);
$emailsendersignature = $user->signature; // By default, we use the signature of current user. We must complete substitution with signature in c_email_senderprofile of array after calling getCommonSubstitutionArray()
$usersignature = $user->signature;
$substitutionarray = array_merge($substitutionarray, array(
'__SENDEREMAIL_SIGNATURE__' => (string) ((!getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc('SignatureFromTheSelectedSenderProfile', 30) : $emailsendersignature) : ''),
'__USER_SIGNATURE__' => (string) (($usersignature && !getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN')) ? ($onlykey == 2 ? dol_trunc(dol_string_nohtmltag($usersignature), 30) : $usersignature) : '')
));
if (is_object($user) && ($user instanceof User)) {
$substitutionarray = array_merge($substitutionarray, array(
'__USER_ID__' => (string) $user->id,
'__USER_LOGIN__' => (string) $user->login,
'__USER_EMAIL__' => (string) $user->email,
'__USER_PHONE__' => (string) dol_print_phone($user->office_phone, '', 0, 0, '', " ", '', '', -1),
'__USER_PHONEPRO__' => (string) dol_print_phone($user->user_mobile, '', 0, 0, '', " ", '', '', -1),
'__USER_PHONEMOBILE__' => (string) dol_print_phone($user->personal_mobile, '', 0, 0, '', " ", '', '', -1),
'__USER_FAX__' => (string) $user->office_fax,
'__USER_LASTNAME__' => (string) $user->lastname,
'__USER_FIRSTNAME__' => (string) $user->firstname,
'__USER_FULLNAME__' => (string) $user->getFullName($outputlangs),
'__USER_SUPERVISOR_ID__' => (string) ($user->fk_user ? $user->fk_user : '0'),
'__USER_JOB__' => (string) $user->job,
'__USER_REMOTE_IP__' => (string) getUserRemoteIP(),
'__USER_VCARD_URL__' => (string) $user->getOnlineVirtualCardUrl('', 'external')
));
}
}
if ((empty($exclude) || !in_array('mycompany', $exclude)) && is_object($mysoc) && (empty($include) || in_array('mycompany', $include))) {
$substitutionarray = array_merge($substitutionarray, array(
'__MYCOMPANY_NAME__' => $mysoc->name,
'__MYCOMPANY_EMAIL__' => $mysoc->email,
'__MYCOMPANY_URL__' => $mysoc->url,
'__MYCOMPANY_PHONE__' => dol_print_phone($mysoc->phone, '', 0, 0, '', " ", '', '', -1),
'__MYCOMPANY_PHONEMOBILE__' => dol_print_phone($mysoc->phone_mobile, '', 0, 0, '', " ", '', '', -1),
'__MYCOMPANY_FAX__' => dol_print_phone($mysoc->fax, '', 0, 0, '', " ", '', '', -1),
'__MYCOMPANY_PROFID1__' => $mysoc->idprof1,
'__MYCOMPANY_PROFID2__' => $mysoc->idprof2,
'__MYCOMPANY_PROFID3__' => $mysoc->idprof3,
'__MYCOMPANY_PROFID4__' => $mysoc->idprof4,
'__MYCOMPANY_PROFID5__' => $mysoc->idprof5,
'__MYCOMPANY_PROFID6__' => $mysoc->idprof6,
'__MYCOMPANY_PROFID7__' => $mysoc->idprof7,
'__MYCOMPANY_PROFID8__' => $mysoc->idprof8,
'__MYCOMPANY_PROFID9__' => $mysoc->idprof9,
'__MYCOMPANY_PROFID10__' => $mysoc->idprof10,
'__MYCOMPANY_CAPITAL__' => $mysoc->capital,
'__MYCOMPANY_FULLADDRESS__' => (method_exists($mysoc, 'getFullAddress') ? $mysoc->getFullAddress(1, ', ') : ''), // $mysoc may be stdClass
'__MYCOMPANY_ADDRESS__' => $mysoc->address,
'__MYCOMPANY_ZIP__' => $mysoc->zip,
'__MYCOMPANY_TOWN__' => $mysoc->town,
'__MYCOMPANY_STATE__' => $mysoc->state,
'__MYCOMPANY_COUNTRY__' => $mysoc->country,
'__MYCOMPANY_COUNTRY_ID__' => $mysoc->country_id,
'__MYCOMPANY_COUNTRY_CODE__' => $mysoc->country_code,
'__MYCOMPANY_CURRENCY_CODE__' => $conf->currency
));
}
if (($onlykey || is_object($object)) && (empty($exclude) || !in_array('object', $exclude)) && (empty($include) || in_array('object', $include))) {
if ($onlykey) {
$substitutionarray['__ID__'] = '__ID__';
$substitutionarray['__REF__'] = '__REF__';
$substitutionarray['__NEWREF__'] = '__NEWREF__';
$substitutionarray['__LABEL__'] = '__LABEL__';
$substitutionarray['__REF_CLIENT__'] = '__REF_CLIENT__';
$substitutionarray['__REF_SUPPLIER__'] = '__REF_SUPPLIER__';
$substitutionarray['__NOTE_PUBLIC__'] = '__NOTE_PUBLIC__';
$substitutionarray['__NOTE_PRIVATE__'] = '__NOTE_PRIVATE__';
$substitutionarray['__EXTRAFIELD_XXX__'] = '__EXTRAFIELD_XXX__';
if (isModEnabled("societe")) { // Most objects are concerned
$substitutionarray['__THIRDPARTY_ID__'] = '__THIRDPARTY_ID__';
$substitutionarray['__THIRDPARTY_NAME__'] = '__THIRDPARTY_NAME__';
$substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = '__THIRDPARTY_NAME_ALIAS__';
$substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = '__THIRDPARTY_CODE_CLIENT__';
$substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = '__THIRDPARTY_CODE_FOURNISSEUR__';
$substitutionarray['__THIRDPARTY_EMAIL__'] = '__THIRDPARTY_EMAIL__';
//$substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = '__THIRDPARTY_EMAIL_URLENCODED__'; // We hide this one
$substitutionarray['__THIRDPARTY_URL__'] = '__THIRDPARTY_URL__';
//$substitutionarray['__THIRDPARTY_URL_URLENCODED__'] = '__THIRDPARTY_URL_URLENCODED__'; // We hide this one
$substitutionarray['__THIRDPARTY_PHONE__'] = '__THIRDPARTY_PHONE__';
$substitutionarray['__THIRDPARTY_FAX__'] = '__THIRDPARTY_FAX__';
$substitutionarray['__THIRDPARTY_ADDRESS__'] = '__THIRDPARTY_ADDRESS__';
$substitutionarray['__THIRDPARTY_ZIP__'] = '__THIRDPARTY_ZIP__';
$substitutionarray['__THIRDPARTY_TOWN__'] = '__THIRDPARTY_TOWN__';
$substitutionarray['__THIRDPARTY_STATE__'] = '__THIRDPARTY_STATE__';
$substitutionarray['__THIRDPARTY_IDPROF1__'] = '__THIRDPARTY_IDPROF1__';
$substitutionarray['__THIRDPARTY_IDPROF2__'] = '__THIRDPARTY_IDPROF2__';
$substitutionarray['__THIRDPARTY_IDPROF3__'] = '__THIRDPARTY_IDPROF3__';
$substitutionarray['__THIRDPARTY_IDPROF4__'] = '__THIRDPARTY_IDPROF4__';
$substitutionarray['__THIRDPARTY_IDPROF5__'] = '__THIRDPARTY_IDPROF5__';
$substitutionarray['__THIRDPARTY_IDPROF6__'] = '__THIRDPARTY_IDPROF6__';
$substitutionarray['__THIRDPARTY_IDPROF7__'] = '__THIRDPARTY_IDPROF7__';
$substitutionarray['__THIRDPARTY_IDPROF8__'] = '__THIRDPARTY_IDPROF8__';
$substitutionarray['__THIRDPARTY_IDPROF9__'] = '__THIRDPARTY_IDPROF9__';
$substitutionarray['__THIRDPARTY_IDPROF10__'] = '__THIRDPARTY_IDPROF10__';
$substitutionarray['__THIRDPARTY_TVAINTRA__'] = '__THIRDPARTY_TVAINTRA__';
$substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = '__THIRDPARTY_NOTE_PUBLIC__';
$substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = '__THIRDPARTY_NOTE_PRIVATE__';
}
if (isModEnabled('member') && (!is_object($object) || $object->element == 'adherent') && (empty($exclude) || !in_array('member', $exclude)) && (empty($include) || in_array('member', $include))) {
$substitutionarray['__MEMBER_ID__'] = '__MEMBER_ID__';
$substitutionarray['__MEMBER_TITLE__'] = '__MEMBER_TITLE__';
$substitutionarray['__MEMBER_FIRSTNAME__'] = '__MEMBER_FIRSTNAME__';
$substitutionarray['__MEMBER_LASTNAME__'] = '__MEMBER_LASTNAME__';
$substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = 'Login and pass of the external user account';
/*$substitutionarray['__MEMBER_NOTE_PUBLIC__'] = '__MEMBER_NOTE_PUBLIC__';
$substitutionarray['__MEMBER_NOTE_PRIVATE__'] = '__MEMBER_NOTE_PRIVATE__';*/
}
// add substitution variables for ticket
if (isModEnabled('ticket') && (!is_object($object) || $object->element == 'ticket') && (empty($exclude) || !in_array('ticket', $exclude)) && (empty($include) || in_array('ticket', $include))) {
$substitutionarray['__TICKET_TRACKID__'] = '__TICKET_TRACKID__';
$substitutionarray['__TICKET_SUBJECT__'] = '__TICKET_SUBJECT__';
$substitutionarray['__TICKET_TYPE__'] = '__TICKET_TYPE__';
$substitutionarray['__TICKET_SEVERITY__'] = '__TICKET_SEVERITY__';
$substitutionarray['__TICKET_CATEGORY__'] = '__TICKET_CATEGORY__';
$substitutionarray['__TICKET_ANALYTIC_CODE__'] = '__TICKET_ANALYTIC_CODE__';
$substitutionarray['__TICKET_MESSAGE__'] = '__TICKET_MESSAGE__';
$substitutionarray['__TICKET_PROGRESSION__'] = '__TICKET_PROGRESSION__';
$substitutionarray['__TICKET_USER_ASSIGN__'] = '__TICKET_USER_ASSIGN__';
}
if (isModEnabled('recruitment') && (!is_object($object) || $object->element == 'recruitmentcandidature') && (empty($exclude) || !in_array('recruitment', $exclude)) && (empty($include) || in_array('recruitment', $include))) {
$substitutionarray['__CANDIDATE_FULLNAME__'] = '__CANDIDATE_FULLNAME__';
$substitutionarray['__CANDIDATE_FIRSTNAME__'] = '__CANDIDATE_FIRSTNAME__';
$substitutionarray['__CANDIDATE_LASTNAME__'] = '__CANDIDATE_LASTNAME__';
}
if (isModEnabled('project') && (empty($exclude) || !in_array('project', $exclude)) && (empty($include) || in_array('project', $include))) { // Most objects
$substitutionarray['__PROJECT_ID__'] = '__PROJECT_ID__';
$substitutionarray['__PROJECT_REF__'] = '__PROJECT_REF__';
$substitutionarray['__PROJECT_NAME__'] = '__PROJECT_NAME__';
/*$substitutionarray['__PROJECT_NOTE_PUBLIC__'] = '__PROJECT_NOTE_PUBLIC__';
$substitutionarray['__PROJECT_NOTE_PRIVATE__'] = '__PROJECT_NOTE_PRIVATE__';*/
}
if (isModEnabled('contract') && (!is_object($object) || $object->element == 'contract') && (empty($exclude) || !in_array('contract', $exclude)) && (empty($include) || in_array('contract', $include))) {
$substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = 'Highest date planned for a service start';
$substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = 'Highest date and hour planned for service start';
$substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = 'Lowest data for planned expiration of service';
$substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = 'Lowest date and hour for planned expiration of service';
}
if (isModEnabled("propal") && (!is_object($object) || $object->element == 'propal') && (empty($exclude) || !in_array('propal', $exclude)) && (empty($include) || in_array('propal', $include))) {
$substitutionarray['__ONLINE_SIGN_URL__'] = 'ToOfferALinkForOnlineSignature';
}
if (isModEnabled("intervention") && (!is_object($object) || $object->element == 'fichinter') && (empty($exclude) || !in_array('intervention', $exclude)) && (empty($include) || in_array('intervention', $include))) {
$substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = 'ToOfferALinkForOnlineSignature';
}
$substitutionarray['__ONLINE_PAYMENT_URL__'] = 'UrlToPayOnlineIfApplicable';
$substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = 'TextAndUrlToPayOnlineIfApplicable';
$substitutionarray['__SECUREKEYPAYMENT__'] = 'Security key (if key is not unique per record)';
$substitutionarray['__SECUREKEYPAYMENT_MEMBER__'] = 'Security key for payment on a member subscription (one key per member)';
$substitutionarray['__SECUREKEYPAYMENT_ORDER__'] = 'Security key for payment on an order';
$substitutionarray['__SECUREKEYPAYMENT_INVOICE__'] = 'Security key for payment on an invoice';
$substitutionarray['__SECUREKEYPAYMENT_CONTRACTLINE__'] = 'Security key for payment on a service of a contract';
$substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = 'Direct download url of a proposal';
$substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = 'Direct download url of an order';
$substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = 'Direct download url of an invoice';
$substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = 'Direct download url of a contract';
$substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = 'Direct download url of a supplier proposal';
if (isModEnabled("shipping") && (!is_object($object) || $object->element == 'shipping')) {
$substitutionarray['__SHIPPINGTRACKNUM__'] = 'Shipping tracking number';
$substitutionarray['__SHIPPINGTRACKNUMURL__'] = 'Shipping tracking url';
$substitutionarray['__SHIPPINGMETHOD__'] = 'Shipping method';
}
if (isModEnabled("reception") && (!is_object($object) || $object->element == 'reception')) {
$substitutionarray['__RECEPTIONTRACKNUM__'] = 'Shipping tracking number of shipment';
$substitutionarray['__RECEPTIONTRACKNUMURL__'] = 'Shipping tracking url';
}
} else {
'@phan-var-force Adherent|Delivery $object';
/** @var Adherent|Delivery $object */
$substitutionarray['__ID__'] = $object->id;
$substitutionarray['__REF__'] = $object->ref;
$substitutionarray['__NEWREF__'] = $object->newref;
$substitutionarray['__LABEL__'] = (isset($object->label) ? $object->label : (isset($object->title) ? $object->title : null));
$substitutionarray['__REF_CLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
$substitutionarray['__REF_SUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
$substitutionarray['__NOTE_PUBLIC__'] = (isset($object->note_public) ? $object->note_public : null);
$substitutionarray['__NOTE_PRIVATE__'] = (isset($object->note_private) ? $object->note_private : null);
$substitutionarray['__DATE_CREATION__'] = (isset($object->date_creation) ? dol_print_date($object->date_creation, 'day', false, $outputlangs) : '');
$substitutionarray['__DATE_MODIFICATION__'] = (isset($object->date_modification) ? dol_print_date($object->date_modification, 'day', false, $outputlangs) : '');
$substitutionarray['__DATE_VALIDATION__'] = (isset($object->date_validation) ? dol_print_date($object->date_validation, 'day', false, $outputlangs) : '');
// handle date_delivery: in customer order/supplier order, the property name is delivery_date, in shipment/reception it is date_delivery
$date_delivery = null;
if (property_exists($object, 'date_delivery')) {
$date_delivery = $object->date_delivery;
} elseif (property_exists($object, 'delivery_date')) {
$date_delivery = $object->delivery_date;
}
$substitutionarray['__DATE_DELIVERY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, 'day', false, $outputlangs) : '');
$substitutionarray['__DATE_DELIVERY_DAY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%d") : '');
$substitutionarray['__DATE_DELIVERY_DAY_TEXT__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%A") : '');
$substitutionarray['__DATE_DELIVERY_MON__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%m") : '');
$substitutionarray['__DATE_DELIVERY_MON_TEXT__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%b") : '');
$substitutionarray['__DATE_DELIVERY_YEAR__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%Y") : '');
$substitutionarray['__DATE_DELIVERY_HH__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%H") : '');
$substitutionarray['__DATE_DELIVERY_MM__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%M") : '');
$substitutionarray['__DATE_DELIVERY_SS__'] = (isset($date_delivery) ? dol_print_date($date_delivery, "%S") : '');
// For backward compatibility (deprecated)
$substitutionarray['__REFCLIENT__'] = (isset($object->ref_client) ? $object->ref_client : (isset($object->ref_customer) ? $object->ref_customer : null));
$substitutionarray['__REFSUPPLIER__'] = (isset($object->ref_supplier) ? $object->ref_supplier : null);
$substitutionarray['__SUPPLIER_ORDER_DATE_DELIVERY__'] = (isset($date_delivery) ? dol_print_date($date_delivery, 'day', false, $outputlangs) : '');
$substitutionarray['__SUPPLIER_ORDER_DELAY_DELIVERY__'] = (isset($object->availability_code) ? ($outputlangs->transnoentities("AvailabilityType".$object->availability_code) != 'AvailabilityType'.$object->availability_code ? $outputlangs->transnoentities("AvailabilityType".$object->availability_code) : $outputlangs->convToOutputCharset(isset($object->availability) ? $object->availability : '')) : '');
$substitutionarray['__EXPIRATION_DATE__'] = (isset($object->fin_validite) ? dol_print_date($object->fin_validite, 'daytext') : '');
if (is_object($object) && ($object->element == 'adherent' || $object->element == 'member') && $object->id > 0) {
'@phan-var-force Adherent $object';
/** @var Adherent $object */
$birthday = (empty($object->birth) ? '' : dol_print_date($object->birth, 'day'));
$substitutionarray['__MEMBER_ID__'] = (isset($object->id) ? $object->id : '');
if (method_exists($object, 'getCivilityLabel')) {
$substitutionarray['__MEMBER_TITLE__'] = $object->getCivilityLabel();
}
$substitutionarray['__MEMBER_FIRSTNAME__'] = (isset($object->firstname) ? $object->firstname : '');
$substitutionarray['__MEMBER_LASTNAME__'] = (isset($object->lastname) ? $object->lastname : '');
$substitutionarray['__MEMBER_USER_LOGIN_INFORMATION__'] = '';
if (method_exists($object, 'getFullName')) {
$substitutionarray['__MEMBER_FULLNAME__'] = $object->getFullName($outputlangs);
}
$substitutionarray['__MEMBER_COMPANY__'] = (isset($object->societe) ? $object->societe : '');
$substitutionarray['__MEMBER_ADDRESS__'] = (isset($object->address) ? $object->address : '');
$substitutionarray['__MEMBER_ZIP__'] = (isset($object->zip) ? $object->zip : '');
$substitutionarray['__MEMBER_TOWN__'] = (isset($object->town) ? $object->town : '');
$substitutionarray['__MEMBER_STATE__'] = (isset($object->state) ? $object->state : '');
$substitutionarray['__MEMBER_COUNTRY__'] = (isset($object->country) ? $object->country : '');
$substitutionarray['__MEMBER_EMAIL__'] = (isset($object->email) ? $object->email : '');
$substitutionarray['__MEMBER_BIRTH__'] = (isset($birthday) ? $birthday : '');
$substitutionarray['__MEMBER_PHOTO__'] = (isset($object->photo) ? $object->photo : '');
$substitutionarray['__MEMBER_LOGIN__'] = (isset($object->login) ? $object->login : '');
$substitutionarray['__MEMBER_PASSWORD__'] = (isset($object->pass) ? $object->pass : '');
$substitutionarray['__MEMBER_PHONE__'] = (isset($object->phone) ? dol_print_phone($object->phone) : '');
$substitutionarray['__MEMBER_PHONEPRO__'] = (isset($object->phone_perso) ? dol_print_phone($object->phone_perso) : '');
$substitutionarray['__MEMBER_PHONEMOBILE__'] = (isset($object->phone_mobile) ? dol_print_phone($object->phone_mobile) : '');
$substitutionarray['__MEMBER_TYPE__'] = (isset($object->type) ? $object->type : '');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE__'] = dol_print_date($object->first_subscription_date, 'day');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_RFC__'] = dol_print_date($object->first_subscription_date, 'dayrfc');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'day') : '');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_START_RFC__'] = (isset($object->first_subscription_date_start) ? dol_print_date($object->first_subscription_date_start, 'dayrfc') : '');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END__'] = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'day') : '');
$substitutionarray['__MEMBER_FIRST_SUBSCRIPTION_DATE_END_RFC__'] = (isset($object->first_subscription_date_end) ? dol_print_date($object->first_subscription_date_end, 'dayrfc') : '');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE__'] = dol_print_date($object->last_subscription_date, 'day');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_RFC__'] = dol_print_date($object->last_subscription_date, 'dayrfc');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START__'] = dol_print_date($object->last_subscription_date_start, 'day');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_START_RFC__'] = dol_print_date($object->last_subscription_date_start, 'dayrfc');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END__'] = dol_print_date($object->last_subscription_date_end, 'day');
$substitutionarray['__MEMBER_LAST_SUBSCRIPTION_DATE_END_RFC__'] = dol_print_date($object->last_subscription_date_end, 'dayrfc');
}
if (is_object($object) && $object->element == 'societe') {
/** @var Societe $object */
'@phan-var-force Societe $object';
$substitutionarray['__THIRDPARTY_ID__'] = $object->id ?? '';
$substitutionarray['__THIRDPARTY_NAME__'] = $object->name ?? '';
$substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = $object->name_alias ?? '';
$substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = $object->code_client ?? '';
$substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = $object->code_fournisseur ?? '';
$substitutionarray['__THIRDPARTY_EMAIL__'] = $object->email ?? '';
$substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = urlencode($object->email ?? '');
$substitutionarray['__THIRDPARTY_URL__'] = $object->url ?? '';
$substitutionarray['__THIRDPARTY_URL_URLENCODED__'] = urlencode($object->url ?? '');
$substitutionarray['__THIRDPARTY_PHONE__'] = dol_print_phone($object->phone ?? '');
$substitutionarray['__THIRDPARTY_FAX__'] = dol_print_phone($object->fax ?? '');
$substitutionarray['__THIRDPARTY_ADDRESS__'] = $object->address ?? '';
$substitutionarray['__THIRDPARTY_ZIP__'] = $object->zip ?? '';
$substitutionarray['__THIRDPARTY_TOWN__'] = $object->town ?? '';
$substitutionarray['__THIRDPARTY_STATE__'] = $object->state ?? '';
$substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = ($object->country_id > 0 ?: '');
$substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = $object->country_code ?? '';
$substitutionarray['__THIRDPARTY_IDPROF1__'] = $object->idprof1 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF2__'] = $object->idprof2 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF3__'] = $object->idprof3 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF4__'] = $object->idprof4 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF5__'] = $object->idprof5 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF6__'] = $object->idprof6 ?? '';
$substitutionarray['__THIRDPARTY_TVAINTRA__'] = $object->tva_intra ?? '';
$substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = dol_htmlentitiesbr($object->note_public ?? '');
$substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = dol_htmlentitiesbr($object->note_private ?? '');
} elseif (is_object($object) && is_object($object->thirdparty)) {
$substitutionarray['__THIRDPARTY_ID__'] = $object->thirdparty->id ?? '';
$substitutionarray['__THIRDPARTY_NAME__'] = $object->thirdparty->name ?? '';
$substitutionarray['__THIRDPARTY_NAME_ALIAS__'] = $object->thirdparty->name_alias ?? '';
$substitutionarray['__THIRDPARTY_CODE_CLIENT__'] = $object->thirdparty->code_client ?? '';
$substitutionarray['__THIRDPARTY_CODE_FOURNISSEUR__'] = $object->thirdparty->code_fournisseur ?? '';
$substitutionarray['__THIRDPARTY_EMAIL__'] = $object->thirdparty->email ?? '';
$substitutionarray['__THIRDPARTY_EMAIL_URLENCODED__'] = urlencode($object->thirdparty->email ?? '');
$substitutionarray['__THIRDPARTY_PHONE__'] = dol_print_phone($object->thirdparty->phone ?? '');
$substitutionarray['__THIRDPARTY_FAX__'] = dol_print_phone($object->thirdparty->fax ?? '');
$substitutionarray['__THIRDPARTY_ADDRESS__'] = $object->thirdparty->address ?? '';
$substitutionarray['__THIRDPARTY_ZIP__'] = $object->thirdparty->zip ?? '';
$substitutionarray['__THIRDPARTY_TOWN__'] = $object->thirdparty->town ?? '';
$substitutionarray['__THIRDPARTY_STATE__'] = $object->thirdparty->state ?? '';
$substitutionarray['__THIRDPARTY_COUNTRY_ID__'] = ($object->thirdparty->country_id > 0 ?: '');
$substitutionarray['__THIRDPARTY_COUNTRY_CODE__'] = $object->thirdparty->country_code ?? '';
$substitutionarray['__THIRDPARTY_IDPROF1__'] = $object->thirdparty->idprof1 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF2__'] = $object->thirdparty->idprof2 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF3__'] = $object->thirdparty->idprof3 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF4__'] = $object->thirdparty->idprof4 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF5__'] = $object->thirdparty->idprof5 ?? '';
$substitutionarray['__THIRDPARTY_IDPROF6__'] = $object->thirdparty->idprof6 ?? '';
$substitutionarray['__THIRDPARTY_TVAINTRA__'] = $object->thirdparty->tva_intra ?? '';
$substitutionarray['__THIRDPARTY_NOTE_PUBLIC__'] = dol_htmlentitiesbr($object->thirdparty->note_public ?? '');
$substitutionarray['__THIRDPARTY_NOTE_PRIVATE__'] = dol_htmlentitiesbr($object->thirdparty->note_private ?? '');
}
if (is_object($object) && $object->element == 'recruitmentcandidature') {
'@phan-var-force RecruitmentCandidature $object';
/** @var RecruitmentCandidature $object */
$substitutionarray['__CANDIDATE_FULLNAME__'] = $object->getFullName($outputlangs);
$substitutionarray['__CANDIDATE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
$substitutionarray['__CANDIDATE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
}
if (is_object($object) && $object->element == 'conferenceorboothattendee') {
'@phan-var-force ConferenceOrBoothAttendee $object';
/** ConferenceOrBoothAttendee $object */
$substitutionarray['__ATTENDEE_FULLNAME__'] = $object->getFullName($outputlangs);
$substitutionarray['__ATTENDEE_FIRSTNAME__'] = isset($object->firstname) ? $object->firstname : '';
$substitutionarray['__ATTENDEE_LASTNAME__'] = isset($object->lastname) ? $object->lastname : '';
}
if (is_object($object) && $object->element == 'project') {
'@phan-var-force Project $object';
/** @var Project $object */
$substitutionarray['__PROJECT_ID__'] = $object->id;
$substitutionarray['__PROJECT_REF__'] = $object->ref;
$substitutionarray['__PROJECT_NAME__'] = $object->title;
} elseif (is_object($object)) {
$project = null;
if (!empty($object->project)) {
$project = $object->project;
} elseif (!empty($object->projet)) { // Deprecated, for backward compatibility
$project = $object->projet;
}
if (!is_null($project) && is_object($project)) {
$substitutionarray['__PROJECT_ID__'] = $project->id;
$substitutionarray['__PROJECT_REF__'] = $project->ref;
$substitutionarray['__PROJECT_NAME__'] = $project->title;
} else {
// can substitute variables for project : uses lazy load in "make_substitutions" method
$project_id = 0;
if (!empty($object->fk_project) && $object->fk_project > 0) {
$project_id = $object->fk_project;
} elseif (!empty($object->fk_projet) && $object->fk_projet > 0) {
$project_id = $object->fk_project;
}
if ($project_id > 0) {
// path:class:method:id
$substitutionarray['__PROJECT_ID__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
$substitutionarray['__PROJECT_REF__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
$substitutionarray['__PROJECT_NAME__@lazyload'] = '/projet/class/project.class.php:Project:fetchAndSetSubstitution:' . $project_id;
}
}
}
if (is_object($object) && $object->element == 'facture') {
'@phan-var-force Facture $object';
/** @var Facture $object */
$substitutionarray['__INVOICE_SITUATION_NUMBER__'] = isset($object->situation_counter) ? $object->situation_counter : '';
}
if (is_object($object) && $object->element == 'shipping') {
'@phan-var-force Expedition $object';
/** @var Expedition $object */
$substitutionarray['__SHIPPINGTRACKNUM__'] = $object->tracking_number;
$substitutionarray['__SHIPPINGTRACKNUMURL__'] = $object->tracking_url;
$substitutionarray['__SHIPPINGMETHOD__'] = $object->shipping_method;
}
if (is_object($object) && $object->element == 'reception') {
'@phan-var-force Reception $object';
/** @var Reception $object */
$substitutionarray['__RECEPTIONTRACKNUM__'] = $object->tracking_number;
$substitutionarray['__RECEPTIONTRACKNUMURL__'] = $object->tracking_url;
}
if (is_object($object) && $object->element == 'contrat' && $object->id > 0 && is_array($object->lines)) {
'@phan-var-force Contrat $object';
/** @var Contrat $object */
$dateplannedstart = '';
$datenextexpiration = '';
foreach ($object->lines as $line) {
if ($line->date_start > $dateplannedstart) {
$dateplannedstart = $line->date_start;
}
if ($line->statut == 4 && $line->date_end && (!$datenextexpiration || $line->date_end < $datenextexpiration)) {
$datenextexpiration = $line->date_end;
}
}
$substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE__'] = dol_print_date($dateplannedstart, 'day');
$substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATE_RFC__'] = dol_print_date($dateplannedstart, 'dayrfc');
$substitutionarray['__CONTRACT_HIGHEST_PLANNED_START_DATETIME__'] = dol_print_date($dateplannedstart, 'standard');
$substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE__'] = dol_print_date($datenextexpiration, 'day');
$substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATE_RFC__'] = dol_print_date($datenextexpiration, 'dayrfc');
$substitutionarray['__CONTRACT_LOWEST_EXPIRATION_DATETIME__'] = dol_print_date($datenextexpiration, 'standard');
}
// add substitution variables for ticket
if (is_object($object) && $object->element == 'ticket') {
'@phan-var-force Ticket $object';
/** @var Ticket $object */
$substitutionarray['__TICKET_TRACKID__'] = $object->track_id;
$substitutionarray['__TICKET_SUBJECT__'] = $object->subject;
$substitutionarray['__TICKET_TYPE__'] = $object->type_code;
$substitutionarray['__TICKET_SEVERITY__'] = $object->severity_code;
$substitutionarray['__TICKET_CATEGORY__'] = $object->category_code; // For backward compatibility
$substitutionarray['__TICKET_ANALYTIC_CODE__'] = $object->category_code;
$substitutionarray['__TICKET_MESSAGE__'] = $object->message;
$substitutionarray['__TICKET_PROGRESSION__'] = $object->progress;
$userstat = new User($db);
if ($object->fk_user_assign > 0) {
$userstat->fetch($object->fk_user_assign);
$substitutionarray['__TICKET_USER_ASSIGN__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
}
if ($object->fk_user_create > 0) {
$userstat->fetch($object->fk_user_create);
$substitutionarray['__USER_CREATE__'] = dolGetFirstLastname($userstat->firstname, $userstat->lastname);
}
}
// Create dynamic tags for __EXTRAFIELD_FIELD__
if ($object->table_element && $object->id > 0) {
if (!is_object($extrafields)) {
$extrafields = new ExtraFields($db);
}
$extrafields->fetch_name_optionals_label($object->table_element, true);
if ($object->fetch_optionals() > 0) {
if (is_array($extrafields->attributes[$object->table_element]['label']) && count($extrafields->attributes[$object->table_element]['label']) > 0) {
foreach ($extrafields->attributes[$object->table_element]['label'] as $key => $label) {
if ($extrafields->attributes[$object->table_element]['type'][$key] == 'date') {
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_date($object->array_options['options_'.$key], 'day');
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = dol_print_date($object->array_options['options_'.$key], 'day', 'tzserver', $outputlangs);
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = dol_print_date($object->array_options['options_'.$key], 'dayrfc');
} elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'datetime') {
$datetime = $object->array_options['options_'.$key];
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour') : '');
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhour', 'tzserver', $outputlangs) : '');
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_DAY_LOCALE__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'day', 'tzserver', $outputlangs) : '');
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_RFC__'] = ($datetime != "0000-00-00 00:00:00" ? dol_print_date($datetime, 'dayhourrfc') : '');
} elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'phone') {
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = dol_print_phone($object->array_options['options_'.$key]);
} elseif ($extrafields->attributes[$object->table_element]['type'][$key] == 'price') {
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = $object->array_options['options_'.$key];
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_FORMATED__'] = price($object->array_options['options_'.$key]); // For compatibility
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'_FORMATTED__'] = price($object->array_options['options_'.$key]);
} elseif ($extrafields->attributes[$object->table_element]['type'][$key] != 'separator') {
$substitutionarray['__EXTRAFIELD_'.strtoupper($key).'__'] = !empty($object->array_options['options_'.$key]) ? $object->array_options['options_'.$key] : '';
}
}
}
}
}
// Complete substitution array with the url to make online payment
if (empty($substitutionarray['__REF__'])) {
$paymenturl = '';
} else {
// Set the online payment url link into __ONLINE_PAYMENT_URL__ key
require_once DOL_DOCUMENT_ROOT.'/core/lib/payments.lib.php';
$outputlangs->loadLangs(array('paypal', 'other'));
$amounttouse = 0;
$typeforonlinepayment = 'free';
if (is_object($object) && $object->element == 'commande') {
$typeforonlinepayment = 'order';
}
if (is_object($object) && $object->element == 'facture') {
$typeforonlinepayment = 'invoice';
}
if (is_object($object) && $object->element == 'member') {
$typeforonlinepayment = 'member';
if (!empty($object->last_subscription_amount)) {
$amounttouse = $object->last_subscription_amount;
}
}
if (is_object($object) && $object->element == 'contrat') {
$typeforonlinepayment = 'contract';
}
if (is_object($object) && $object->element == 'fichinter') {
$typeforonlinepayment = 'ficheinter';
}
$url = getOnlinePaymentUrl(0, $typeforonlinepayment, $substitutionarray['__REF__'], $amounttouse);
$paymenturl = $url;
}
if ($object->id > 0) {
$substitutionarray['__ONLINE_PAYMENT_TEXT_AND_URL__'] = ($paymenturl ? str_replace('\n', "\n", $outputlangs->trans("PredefinedMailContentLink", $paymenturl)) : '');
$substitutionarray['__ONLINE_PAYMENT_URL__'] = $paymenturl;
// Show structured communication
if (getDolGlobalString('INVOICE_PAYMENT_ENABLE_STRUCTURED_COMMUNICATION') && $object->element == 'facture') {
include_once DOL_DOCUMENT_ROOT.'/core/lib/functions_be.lib.php';
$substitutionarray['__PAYMENT_STRUCTURED_COMMUNICATION__'] = dolBECalculateStructuredCommunication($object->ref, $object->type);
}
if (getDolGlobalString('PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'propal') {
$substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_PROPOSAL__'] = '';
}
if (getDolGlobalString('ORDER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'commande') {
$substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_ORDER__'] = '';
}
if (getDolGlobalString('INVOICE_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'facture') {
$substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_INVOICE__'] = '';
}
if (getDolGlobalString('CONTRACT_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'contrat') {
$substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_CONTRACT__'] = '';
}
if (getDolGlobalString('FICHINTER_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'fichinter') {
$substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_FICHINTER__'] = '';
}
if (getDolGlobalString('SUPPLIER_PROPOSAL_ALLOW_EXTERNAL_DOWNLOAD') && is_object($object) && $object->element == 'supplier_proposal') {
$substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = $object->getLastMainDocLink($object->element);
} else {
$substitutionarray['__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__'] = '';
}
if (is_object($object) && $object->element == 'propal') {
'@phan-var-force Propal $object';
/** @var Propal $object */
$substitutionarray['__URL_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/comm/propal/card.php?id=".$object->id;
require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
$substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'proposal', $object->ref, 1, $object);
}
if (is_object($object) && $object->element == 'commande') {
'@phan-var-force Commande $object';
/** @var Commande $object */
$substitutionarray['__URL_ORDER__'] = DOL_MAIN_URL_ROOT."/commande/card.php?id=".$object->id;
}
if (is_object($object) && $object->element == 'facture') {
'@phan-var-force Facture $object';
/** @var Facture $object */
$substitutionarray['__URL_INVOICE__'] = DOL_MAIN_URL_ROOT."/compta/facture/card.php?id=".$object->id;
}
if (is_object($object) && $object->element == 'contrat') {
'@phan-var-force Contrat $object';
/** @var Contrat $object */
$substitutionarray['__URL_CONTRACT__'] = DOL_MAIN_URL_ROOT."/contrat/card.php?id=".$object->id;
require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
$substitutionarray['__ONLINE_SIGN_URL__'] = getOnlineSignatureUrl(0, 'contract', $object->ref, 1, $object);
}
if (is_object($object) && $object->element == 'fichinter') {
'@phan-var-force Fichinter $object';
/** @var Fichinter $object */
$substitutionarray['__URL_FICHINTER__'] = DOL_MAIN_URL_ROOT."/fichinter/card.php?id=".$object->id;
require_once DOL_DOCUMENT_ROOT.'/core/lib/signature.lib.php';
$substitutionarray['__ONLINE_SIGN_FICHINTER_URL__'] = getOnlineSignatureUrl(0, 'fichinter', $object->ref, 1, $object);
}
if (is_object($object) && $object->element == 'supplier_proposal') {
'@phan-var-force SupplierProposal $object';
/** @var SupplierProposal $object */
$substitutionarray['__URL_SUPPLIER_PROPOSAL__'] = DOL_MAIN_URL_ROOT."/supplier_proposal/card.php?id=".$object->id;
}
if (is_object($object) && $object->element == 'invoice_supplier') {
'@phan-var-force FactureFournisseur $object';
/** @var FactureFournisseur $object */
$substitutionarray['__URL_SUPPLIER_INVOICE__'] = DOL_MAIN_URL_ROOT."/fourn/facture/card.php?id=".$object->id;
}
if (is_object($object) && $object->element == 'shipping') {
'@phan-var-force Expedition $object';
/** @var Expedition $object */
$substitutionarray['__URL_SHIPMENT__'] = DOL_MAIN_URL_ROOT."/expedition/card.php?id=".$object->id;
}
}
if (is_object($object) && $object->element == 'action') {
'@phan-var-force ActionComm $object';
/** @var ActionComm $object */
$substitutionarray['__EVENT_LABEL__'] = $object->label;
$substitutionarray['__EVENT_TYPE__'] = $outputlangs->trans("Action".$object->type_code);
$substitutionarray['__EVENT_DATE__'] = dol_print_date($object->datep, 'day', 'auto', $outputlangs);
$substitutionarray['__EVENT_TIME__'] = dol_print_date($object->datep, 'hour', 'auto', $outputlangs);
}
}
}
if ((empty($exclude) || !in_array('objectamount', $exclude)) && (empty($include) || in_array('objectamount', $include))) {
'@phan-var-force Facture|FactureRec $object';
/** @var Facture|FactureRec|null $object */
include_once DOL_DOCUMENT_ROOT.'/core/lib/functionsnumtoword.lib.php';
$substitutionarray['__DATE_YMD__'] = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'day', false, $outputlangs) : null) : '';
$substitutionarray['__DATE_DUE_YMD__'] = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'day', false, $outputlangs) : null) : '';
$substitutionarray['__DATE_YMD_TEXT__'] = is_object($object) ? (isset($object->date) ? dol_print_date($object->date, 'daytext', false, $outputlangs) : null) : '';
$substitutionarray['__DATE_DUE_YMD_TEXT__'] = is_object($object) ? (isset($object->date_lim_reglement) ? dol_print_date($object->date_lim_reglement, 'daytext', false, $outputlangs) : null) : '';
$already_payed_all = 0;
if (is_object($object) && ($object instanceof Facture)) {
$already_payed_all = $object->sumpayed + $object->sumdeposit + $object->sumcreditnote;
}
$substitutionarray['__AMOUNT_EXCL_TAX__'] = is_object($object) ? $object->total_ht : '';
$substitutionarray['__AMOUNT_EXCL_TAX_TEXT__'] = is_object($object) ? dol_convertToWord($object->total_ht, $outputlangs, '', true) : '';
$substitutionarray['__AMOUNT_EXCL_TAX_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ht, $outputlangs, $conf->currency, true) : '';
$substitutionarray['__AMOUNT__'] = is_object($object) ? $object->total_ttc : '';
$substitutionarray['__AMOUNT_TEXT__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, '', true) : '';
$substitutionarray['__AMOUNT_TEXTCURRENCY__'] = is_object($object) ? dol_convertToWord($object->total_ttc, $outputlangs, $conf->currency, true) : '';
$substitutionarray['__AMOUNT_REMAIN__'] = is_object($object) ? price2num($object->total_ttc - $already_payed_all, 'MT') : '';
$substitutionarray['__AMOUNT_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
$substitutionarray['__AMOUNT_VAT_TEXT__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, '', true) : dol_convertToWord($object->total_tva, $outputlangs, '', true)) : '';
$substitutionarray['__AMOUNT_VAT_TEXTCURRENCY__'] = is_object($object) ? (isset($object->total_vat) ? dol_convertToWord($object->total_vat, $outputlangs, $conf->currency, true) : dol_convertToWord($object->total_tva, $outputlangs, $conf->currency, true)) : '';
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 formatted in a currency
$substitutionarray['__AMOUNT_EXCL_TAX_FORMATTED__'] = is_object($object) ? ($object->total_ht ? price($object->total_ht, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
$substitutionarray['__AMOUNT_FORMATTED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
$substitutionarray['__AMOUNT_REMAIN_FORMATTED__'] = is_object($object) ? ($object->total_ttc ? price($object->total_ttc - $already_payed_all, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
$substitutionarray['__AMOUNT_VAT_FORMATTED__'] = is_object($object) ? (isset($object->total_vat) ? price($object->total_vat, 0, $outputlangs, 0, -1, -1, $conf->currency) : ($object->total_tva ? price($object->total_tva, 0, $outputlangs, 0, -1, -1, $conf->currency) : null)) : '';
if ($onlykey != 2 || $mysoc->useLocalTax(1)) {
$substitutionarray['__AMOUNT_TAX2_FORMATTED__'] = is_object($object) ? ($object->total_localtax1 ? price($object->total_localtax1, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
}
if ($onlykey != 2 || $mysoc->useLocalTax(2)) {
$substitutionarray['__AMOUNT_TAX3_FORMATTED__'] = is_object($object) ? ($object->total_localtax2 ? price($object->total_localtax2, 0, $outputlangs, 0, -1, -1, $conf->currency) : null) : '';
}
// Amount keys formatted in a currency (with the typo error for backward compatibility)
if ($onlykey != 2) {
$substitutionarray['__AMOUNT_EXCL_TAX_FORMATED__'] = $substitutionarray['__AMOUNT_EXCL_TAX_FORMATTED__'];
$substitutionarray['__AMOUNT_FORMATED__'] = $substitutionarray['__AMOUNT_FORMATTED__'];
$substitutionarray['__AMOUNT_REMAIN_FORMATED__'] = $substitutionarray['__AMOUNT_REMAIN_FORMATTED__'];
$substitutionarray['__AMOUNT_VAT_FORMATED__'] = $substitutionarray['__AMOUNT_VAT_FORMATTED__'];
if ($mysoc instanceof Societe && $mysoc->useLocalTax(1)) {
$substitutionarray['__AMOUNT_TAX2_FORMATED__'] = $substitutionarray['__AMOUNT_TAX2_FORMATTED__'];
}
if ($mysoc instanceof Societe && $mysoc->useLocalTax(2)) {
$substitutionarray['__AMOUNT_TAX3_FORMATED__'] = $substitutionarray['__AMOUNT_TAX3_FORMATTED__'];
}
}
$substitutionarray['__AMOUNT_MULTICURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? $object->multicurrency_total_ttc : '';
$substitutionarray['__AMOUNT_MULTICURRENCY_TEXT__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, '', true) : '';
$substitutionarray['__AMOUNT_MULTICURRENCY_TEXTCURRENCY__'] = (is_object($object) && isset($object->multicurrency_total_ttc)) ? dol_convertToWord($object->multicurrency_total_ttc, $outputlangs, $object->multicurrency_code, true) : '';
$substitutionarray['__MULTICURRENCY_CODE__'] = (is_object($object) && isset($object->multicurrency_code)) ? $object->multicurrency_code : '';
// TODO Add other keys for foreign multicurrency
// For backward compatibility
if ($onlykey != 2) {
$substitutionarray['__TOTAL_TTC__'] = is_object($object) ? $object->total_ttc : '';
$substitutionarray['__TOTAL_HT__'] = is_object($object) ? $object->total_ht : '';
$substitutionarray['__TOTAL_VAT__'] = is_object($object) ? (isset($object->total_vat) ? $object->total_vat : $object->total_tva) : '';
}
}
if ((empty($exclude) || !in_array('date', $exclude)) && (empty($include) || in_array('date', $include))) {
include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
$now = dol_now();
$tmp = dol_getdate($now, true);
$tmp2 = dol_get_prev_day($tmp['mday'], $tmp['mon'], $tmp['year']);
$tmp3 = dol_get_prev_month($tmp['mon'], $tmp['year']);
$tmp4 = dol_get_next_day($tmp['mday'], $tmp['mon'], $tmp['year']);
$tmp5 = dol_get_next_month($tmp['mon'], $tmp['year']);
$daytext = $outputlangs->trans('Day'.$tmp['wday']);
$substitutionarray = array_merge($substitutionarray, array(
'__NOW_TMS__' => (string) $now, // Must be the string that represent the int
'__NOW_TMS_YMD__' => dol_print_date($now, 'day', 'auto', $outputlangs),
'__DAY__' => (string) $tmp['mday'],
'__DAY_TEXT__' => $daytext, // Monday
'__DAY_TEXT_SHORT__' => dol_trunc($daytext, 3, 'right', 'UTF-8', 1), // Mon
'__DAY_TEXT_MIN__' => dol_trunc($daytext, 1, 'right', 'UTF-8', 1), // M
'__MONTH__' => (string) $tmp['mon'],
'__MONTH_TEXT__' => $outputlangs->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'],
'__YEAR_PREVIOUS_MONTH__' => (string) $tmp3['year'],
'__YEAR_NEXT_MONTH__' => (string) $tmp5['year'],
'__PREVIOUS_DAY__' => (string) $tmp2['day'],
'__PREVIOUS_MONTH__' => (string) $tmp3['month'],
'__PREVIOUS_MONTH_TEXT__' => $outputlangs->trans('Month'.sprintf("%02d", $tmp3['month'])),
'__PREVIOUS_MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp3['month'])),
'__PREVIOUS_MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp3['month'])),
'__PREVIOUS_YEAR__' => (string) ($tmp['year'] - 1),
'__NEXT_DAY__' => (string) $tmp4['day'],
'__NEXT_MONTH__' => (string) $tmp5['month'],
'__NEXT_MONTH_TEXT__' => $outputlangs->trans('Month'.sprintf("%02d", $tmp5['month'])),
'__NEXT_MONTH_TEXT_SHORT__' => $outputlangs->trans('MonthShort'.sprintf("%02d", $tmp5['month'])),
'__NEXT_MONTH_TEXT_MIN__' => $outputlangs->trans('MonthVeryShort'.sprintf("%02d", $tmp5['month'])),
'__NEXT_YEAR__' => (string) ($tmp['year'] + 1),
));
}
if (isModEnabled('multicompany')) {
$substitutionarray = array_merge($substitutionarray, array('__ENTITY_ID__' => $conf->entity));
}
if ((empty($exclude) || !in_array('system', $exclude)) && (empty($include) || in_array('user', $include))) {
$substitutionarray['__DOL_MAIN_URL_ROOT__'] = DOL_MAIN_URL_ROOT;
$substitutionarray['__(AnyTranslationKey)__'] = $outputlangs->trans('TranslationOfKey');
$substitutionarray['__(AnyTranslationKey|langfile)__'] = $outputlangs->trans('TranslationOfKey').' (load also language file before)';
$substitutionarray['__[AnyConstantKey]__'] = $outputlangs->trans('ValueOfConstantKey');
}
// Note: The lazyload variables are replaced only during the call by make_substitutions, and only if necessary
return $substitutionarray;
}
/**
* Make substitution into a text string, replacing keys with vals from $substitutionarray (oldval=>newval),
* and texts like __(TranslationKey|langfile)__ and __[ConstantKey]__ are also replaced.
* Example of usage:
* $substitutionarray = getCommonSubstitutionArray($langs, 0, null, $thirdparty);
* complete_substitutions_array($substitutionarray, $langs, $thirdparty);
* $mesg = make_substitutions($mesg, $substitutionarray, $langs);
*
* @param string $text Source string in which we must do substitution
* @param array<string,null|string|float|int> $substitutionarray Array with key->val to substitute. Example: array('__MYKEY__' => 'MyVal', ...)
* @param ?Translate $outputlangs Output language
* @param int<0,1> $converttextinhtmlifnecessary 0=Convert only value into HTML if text is already in HTML
* 1=Will also convert initial $text into HTML if we try to insert one value that is HTML
* @return string Output string after substitutions
* @see complete_substitutions_array(), getCommonSubstitutionArray()
*/
function make_substitutions($text, $substitutionarray, $outputlangs = null, $converttextinhtmlifnecessary = 0)
{
global $conf, $db, $langs;
if (!is_array($substitutionarray)) {
return 'ErrorBadParameterSubstitutionArrayWhenCalling_make_substitutions';
}
if (empty($outputlangs)) {
$outputlangs = $langs;
}
// Is initial text HTML or simple text ?
$msgishtml = 0;
if (dol_textishtml($text, 1)) {
$msgishtml = 1;
}
// Make substitution for language keys: __(AnyTranslationKey)__ or __(AnyTranslationKey|langfile)__
if (is_object($outputlangs)) {
$reg = array();
while (preg_match('/__\(([^\)]+)\)__/', $text, $reg)) {
// If key is __(TranslationKey|langfile)__, then force load of langfile.lang
$tmp = explode('|', $reg[1]);
if (!empty($tmp[1])) {
$outputlangs->load($tmp[1]);
}
$value = $outputlangs->transnoentitiesnoconv($reg[1]);
if (empty($converttextinhtmlifnecessary)) {
// convert $newval into HTML is necessary
$text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $msgishtml ? dol_htmlentitiesbr($value) : $value, $text);
} else {
if (! $msgishtml) {
$valueishtml = dol_textishtml($value, 1);
//var_dump("valueishtml=".$valueishtml);
if ($valueishtml) {
$text = dol_htmlentitiesbr($text);
$msgishtml = 1;
}
} else {
$value = dol_nl2br((string) $value);
}
$text = preg_replace('/__\('.preg_quote($reg[1], '/').'\)__/', $value, $text);
}
}
}
// Make substitution for constant keys.
// Must be after the substitution of translation, so if the text of translation contains a string __[xxx]__, it is also converted.
$reg = array();
while (preg_match('/__\[([^\]]+)\]__/', $text, $reg)) {
$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((string) $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__') && (getDolGlobalString('MAIN_MAIL_DO_NOT_USE_SIGN'))) {
$value = ''; // Protection
}
if (empty($converttextinhtmlifnecessary)) {
$text = str_replace((string) $key, (string) $value, $text); // Cast to string is needed when value is 123.5 for example
} else {
if (! $msgishtml) {
$valueishtml = dol_textishtml($value, 1);
if ($valueishtml) {
$text = dol_htmlentitiesbr($text);
$msgishtml = 1;
}
} else {
$value = dol_nl2br((string) $value);
}
$text = str_replace((string) $key, (string) $value, $text); // Cast to string is needed 123.5 for example
}
}
// TODO Implement the lazyload substitution
/*
add a loop to scan $substitutionarray:
For each key ending with '@lazyload', we extract the substitution key 'XXX' and we check inside the $text (the 1st parameter of make_substitutions), if the string XXX exists.
If no, we don't need to make replacement, so we do nothing.
If yes, we can make the substitution:
include_once $path;
$tmpobj = new $class($db);
$valuetouseforsubstitution = $tmpobj->$method($id, '__XXX__');
And make the replacement of "__XXX__@lazyload" with $valuetouseforsubstitution
*/
$memory_object_list = array();
foreach ($substitutionarray as $key => $value) {
$lazy_load_arr = array();
if (preg_match('/(__[A-Z\_]+__)@lazyload$/', $key, $lazy_load_arr)) {
if (isset($lazy_load_arr[1]) && !empty($lazy_load_arr[1])) {
$key_to_substitute = $lazy_load_arr[1];
if (preg_match('/' . preg_quote($key_to_substitute, '/') . '/', $text)) {
$param_arr = explode(':', (string) $value);
// path:class:method:id
if (count($param_arr) == 4) {
$path = $param_arr[0];
$class = $param_arr[1];
$method = $param_arr[2];
$id = (int) $param_arr[3];
// load class file and init object list in memory
if (!isset($memory_object_list[$class])) {
if (dol_is_file(DOL_DOCUMENT_ROOT . $path)) {
require_once DOL_DOCUMENT_ROOT . $path;
if (class_exists($class)) {
$memory_object_list[$class] = array(
'list' => array(),
);
}
}
}
// fetch object and set substitution
if (isset($memory_object_list[$class]) && isset($memory_object_list[$class]['list'])) {
if (method_exists($class, $method)) {
if (!isset($memory_object_list[$class]['list'][$id])) {
$tmpobj = new $class($db);
// @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
$valuetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute);
$memory_object_list[$class]['list'][$id] = $tmpobj;
} else {
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable
$tmpobj = $memory_object_list[$class]['list'][$id];
// @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
$valuetouseforsubstitution = $tmpobj->$method($id, $key_to_substitute, true);
}
$text = str_replace((string) $key_to_substitute, (string) $valuetouseforsubstitution, $text); // Cast to string in case value is 123.5 for example
}
}
}
}
}
}
}
return $text;
}
/**
* Complete the $substitutionarray with more entries coming from external module that had set the "substitutions=1" into module_part array.
* In this case, method completesubstitutionarray provided by module is called.
*
* @param array<string,string|float|null> $substitutionarray Array substitution old value => new value value
* @param Translate $outputlangs Output language
* @param ?CommonObject $object Source object
* @param ?mixed $parameters Add more parameters (useful to pass product lines)
* @param string $callfunc What is the name of the custom function that will be called? (default: completesubstitutionarray)
* @return void
* @see make_substitutions()
*/
function complete_substitutions_array(&$substitutionarray, $outputlangs, $object = null, $parameters = null, $callfunc = "completesubstitutionarray")
{
global $conf, $user;
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
// Note: substitution key for each extrafields, using key __EXTRA_XXX__ is already available into the getCommonSubstitutionArray used to build the substitution array.
// Check if there is external substitution to do, requested by plugins
$dirsubstitutions = array_merge(array(), (array) $conf->modules_parts['substitutions']);
foreach ($dirsubstitutions as $reldir) {
$dir = dol_buildpath($reldir, 0);
// Check if directory exists
if (!dol_is_dir($dir)) {
continue;
}
$substitfiles = dol_dir_list($dir, 'files', 0, 'functions_');
foreach ($substitfiles as $substitfile) {
$reg = array();
if (preg_match('/functions_(.*)\.lib\.php/i', $substitfile['name'], $reg)) {
$module = $reg[1];
dol_syslog("Library ".$substitfile['name']." found into ".$dir);
// Include the user's functions file
require_once $dir.$substitfile['name'];
// Call the user's function, and only if it is defined
$function_name = $module."_".$callfunc;
if (function_exists($function_name)) {
$function_name($substitutionarray, $outputlangs, $object, $parameters);
}
}
}
}
if (getDolGlobalString('ODT_ENABLE_ALL_TAGS_IN_SUBSTITUTIONS')) {
// to list all tags in odt template
$tags = '';
foreach ($substitutionarray as $key => $value) {
$tags .= '{'.$key.'} => '.$value."\n";
}
$substitutionarray = array_merge($substitutionarray, array('__ALL_TAGS__' => $tags));
}
}
/**
* Format output for start and end date
*
* @param int $date_start Start date
* @param int $date_end End date
* @param string $format Output format
* @param Translate $outputlangs Output language
* @return void
*/
function print_date_range($date_start, $date_end, $format = '', $outputlangs = null)
{
print get_date_range($date_start, $date_end, $format, $outputlangs);
}
/**
* Format output for start and end date
*
* @param int $date_start Start date
* @param int $date_end End date
* @param string $format Output date format ('day', 'dayhour', ...)
* @param Translate $outputlangs Output language
* @param integer $withparenthesis 1=Add parenthesis, 0=no parenthesis
* @return string String
*/
function get_date_range($date_start, $date_end, $format = '', $outputlangs = null, $withparenthesis = 1)
{
global $langs;
$out = '';
if (!is_object($outputlangs)) {
$outputlangs = $langs;
}
if ($date_start && $date_end) {
$out .= ($withparenthesis ? ' (' : '').$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;
}
/**
* Return firstname and lastname in correct order
*
* @param string $firstname Firstname
* @param string $lastname Lastname
* @param int $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
* @return string Firstname + lastname or Lastname + firstname
*/
function dolGetFirstLastname($firstname, $lastname, $nameorder = -1)
{
global $conf;
$ret = '';
// If order not defined, we use the setup
if ($nameorder < 0) {
$nameorder = (!getDolGlobalString('MAIN_FIRSTNAME_NAME_POSITION') ? 1 : 0);
}
if ($nameorder == 1) {
$ret .= $firstname;
if ($firstname && $lastname) {
$ret .= ' ';
}
$ret .= $lastname;
} elseif ($nameorder == 2 || $nameorder == 3) {
$ret .= $firstname;
if (empty($ret) && $nameorder == 3) {
$ret .= $lastname;
}
} else { // 0, 4 or 5
$ret .= $lastname;
if (empty($ret) && $nameorder == 5) {
$ret .= $firstname;
}
if ($nameorder == 0) {
if ($firstname && $lastname) {
$ret .= ' ';
}
$ret .= $firstname;
}
}
return $ret;
}
/**
* Set event message in dol_events session object. Will be output by calling dol_htmloutput_events.
* Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
* Note: Prefer to use setEventMessages instead.
*
* @param string|string[] $mesgs Message string or array
* @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
* @param int $noduplicate 1 means we do not add the message if already present in session stack
* @param int $attop Add the message in the top of the stack (at bottom by default)
* @return void
* @see dol_htmloutput_events()
*/
function setEventMessage($mesgs, $style = 'mesgs', $noduplicate = 0, $attop = 0)
{
//dol_syslog(__FUNCTION__ . " is deprecated", LOG_WARNING); This is not deprecated, it is used by setEventMessages function
if (!is_array($mesgs)) {
$mesgs = trim((string) $mesgs);
// If mesgs is a not an empty string
if ($mesgs) {
if (!empty($noduplicate) && isset($_SESSION['dol_events'][$style]) && in_array($mesgs, $_SESSION['dol_events'][$style])) {
return;
}
if ($attop) {
array_unshift($_SESSION['dol_events'][$style], $mesgs);
} else {
$_SESSION['dol_events'][$style][] = $mesgs;
}
}
} else {
// If mesgs is an array
foreach ($mesgs as $mesg) {
$mesg = trim((string) $mesg);
if ($mesg) {
if (!empty($noduplicate) && isset($_SESSION['dol_events'][$style]) && in_array($mesg, $_SESSION['dol_events'][$style])) {
return;
}
if ($attop) {
array_unshift($_SESSION['dol_events'][$style], $mesgs);
} else {
$_SESSION['dol_events'][$style][] = $mesg;
}
}
}
}
}
/**
* Set event messages in dol_events session object. Will be output by calling dol_htmloutput_events.
* Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function.
*
* @param string|null $mesg Message string
* @param string[]|null $mesgs Message array
* @param string $style Which style to use ('mesgs' by default, 'warnings', 'errors')
* @param string $messagekey A key to be used to allow the feature "Never show this message during this session again"
* @param int $noduplicate 1 means we do not add the message if already present in session stack
* @param int $attop Add the message in the top of the stack (at bottom by default)
* @return void
* @see dol_htmloutput_events()
*/
function setEventMessages($mesg, $mesgs, $style = 'mesgs', $messagekey = '', $noduplicate = 0, $attop = 0)
{
if (empty($mesg) && empty($mesgs)) {
dol_syslog("Try to add a message in stack, but value to add is empty message" . getCallerInfoString(), LOG_WARNING);
} else {
if ($messagekey) {
// Complete message with a js link to set a cookie "DOLHIDEMESSAGE".$messagekey;
// TODO
$mesg .= '';
}
if (empty($messagekey) || empty($_COOKIE["DOLUSER_HIDEMESSAGE".$messagekey])) {
if (!in_array((string) $style, array('mesgs', 'warnings', 'errors'))) {
dol_print_error(null, 'Bad parameter style='.$style.' for setEventMessages');
}
if (empty($mesgs)) {
setEventMessage((string) $mesg, $style, $noduplicate, $attop);
} else {
if (!empty($mesg) && !in_array($mesg, $mesgs)) {
setEventMessage($mesg, $style, $noduplicate, $attop); // Add message string if not already into array
}
setEventMessage($mesgs, $style, $noduplicate, $attop);
}
}
}
}
/**
* Print formatted messages to output (Used to show messages on html output).
* Note: Calling dol_htmloutput_events is done into pages by standard llxFooter() function, so there is
* no need to call it explicitly.
*
* @param int $disabledoutputofmessages Clear all messages stored into session without displaying them
* @return void
* @see dol_htmloutput_mesg()
*/
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']);
}
}
/**
* Get formatted messages to output (Used to show messages on html output).
* This include also the translation of the message key.
*
* @param string $mesgstring Message string or message key
* @param string[] $mesgarray Array of message strings or message keys
* @param string $style Style of message output ('ok' or 'error')
* @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
* @return string Return html output
*
* @see dol_print_error()
* @see dol_htmloutput_errors()
* @see setEventMessages()
*/
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) || getDolGlobalString('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) && !getDolGlobalString('MAIN_DISABLE_JQUERY_JNOTIFY') && empty($keepembedded)) {
$return = '<script nonce="'.getNonce().'">
$(document).ready(function() {
/* 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;
}
/**
* Get formatted error messages to output (Used to show messages on html output).
*
* @param string $mesgstring Error message
* @param string[] $mesgarray Error messages array
* @param int $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
* @return string Return html output
*
* @see dol_print_error()
* @see dol_htmloutput_mesg()
*/
function get_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
{
return get_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
}
/**
* Print formatted messages to output (Used to show messages on html output).
*
* @param string $mesgstring Message string or message key
* @param string[] $mesgarray Array of message strings or message keys
* @param string $style Which style to use ('ok', 'warning', 'error')
* @param int $keepembedded Set to 1 if message must be kept embedded into its html place (this disable jnotify)
* @return void
*
* @see dol_print_error()
* @see dol_htmloutput_errors()
* @see setEventMessages()
*/
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);
}
}
/**
* Print formatted error messages to output (Used to show messages on html output).
*
* @param string $mesgstring Error message
* @param string[] $mesgarray Error messages array
* @param int<0,1> $keepembedded Set to 1 in error message must be kept embedded into its html place (this disable jnotify)
* @return void
*
* @see dol_print_error()
* @see dol_htmloutput_mesg()
*/
function dol_htmloutput_errors($mesgstring = '', $mesgarray = array(), $keepembedded = 0)
{
dol_htmloutput_mesg($mesgstring, $mesgarray, 'error', $keepembedded);
}
/**
* Advanced sort array by the value of a given key, which produces ascending (default) or descending
* output and uses optionally natural case insensitive sorting (which can be optionally case sensitive as well).
*
* @phpstan-template T of array<string|int,mixed>
* @phan-template T of array<string|int,mixed>
* @param array<string|int,mixed> $array Array to sort (array of array('key1'=>val1,'key2'=>val2,'key3'...) or array of objects)
* @phpstan-param T $array
* @phan-param T $array
* @param string $index Key in array to use for sorting criteria
* @param string $order Sort order ('asc' or 'desc')
* @param int<-1,1> $natsort If values are strings (I said value not type): 0=Use alphabetical order, 1=use "natural" sort (natsort), -1=Force alpha order
* If values are numeric (I said value not type): 0=Use numeric order (even if type is string) so use a "natural" sort, 1=use "natural" sort too (same than 0), -1=Force alphabetical order
* @param int<0,1> $case_sensitive 1=sort is case sensitive, 0=not case sensitive
* @param int<0,1> $keepindex If 0 and index key of array to sort is a numeric, then index will be rewritten. If 1 or index key is not numeric, key for index is kept after sorting.
* @return array<string|int,mixed> Return the sorted array (the source array is not modified !)
* @phpstan-return T
* @phan-return T // Seems useful
* @phan-suppress PhanTypeMismatchReturn // T not understood without caller
*/
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 {
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable,PhanTypeArraySuspicious,PhanTypeMismatchDimFetch
$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;
}
/**
* Check if a string is in UTF8. Seems similar to utf8_valid() but in pure PHP.
*
* @param string $str String to check
* @return boolean True if string is UTF8 or ISO compatible with UTF8, False if not (ISO with special non utf8 char or Binary)
* @see utf8_valid()
*/
function utf8_check($str)
{
$str = (string) $str; // Sometimes string is an int.
// We must use here a binary strlen function (so not dol_strlen)
$strLength = strlen($str);
for ($i = 0; $i < $strLength; $i++) {
if (ord($str[$i]) < 0x80) {
continue; // 0bbbbbbb
} elseif ((ord($str[$i]) & 0xE0) == 0xC0) {
$n = 1; // 110bbbbb
} elseif ((ord($str[$i]) & 0xF0) == 0xE0) {
$n = 2; // 1110bbbb
} elseif ((ord($str[$i]) & 0xF8) == 0xF0) {
$n = 3; // 11110bbb
} elseif ((ord($str[$i]) & 0xFC) == 0xF8) {
$n = 4; // 111110bb
} elseif ((ord($str[$i]) & 0xFE) == 0xFC) {
$n = 5; // 1111110b
} else {
return false; // Does not match any model
}
for ($j = 0; $j < $n; $j++) { // n bytes matching 10bbbbbb follow ?
if ((++$i == strlen($str)) || ((ord($str[$i]) & 0xC0) != 0x80)) {
return false;
}
}
}
return true;
}
/**
* Check if a string is in UTF8. Seems similar to utf8_check().
*
* @param string $str String to check
* @return boolean True if string is valid UTF8 string, false if corrupted
* @see utf8_check()
*/
function utf8_valid($str)
{
/* 2 other methods to test if string is utf8
$validUTF8 = mb_check_encoding($messagetext, 'UTF-8');
$validUTF8b = ! (false === mb_detect_encoding($messagetext, 'UTF-8', true));
*/
return preg_match('//u', $str) ? true : false;
}
/**
* Check if a string is in ASCII
*
* @param string $str String to check
* @return boolean True if string is ASCII, False if not (byte value > 0x7F)
*/
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;
}
/**
* Return a string encoded into OS filesystem encoding. This function is used to define
* value to pass to filesystem PHP functions.
*
* @param string $str String to encode (UTF-8)
* @return string Encoded string (UTF-8, ISO-8859-1)
*/
function dol_osencode($str)
{
$tmp = ini_get("unicode.filesystem_encoding");
if (empty($tmp) && !empty($_SERVER["WINDIR"])) {
$tmp = 'iso-8859-1'; // By default for windows
}
if (empty($tmp)) {
$tmp = 'utf-8'; // By default for other
}
if (getDolGlobalString('MAIN_FILESYSTEM_ENCODING')) {
$tmp = getDolGlobalString('MAIN_FILESYSTEM_ENCODING');
}
if ($tmp == 'iso-8859-1') {
return mb_convert_encoding($str, 'ISO-8859-1', 'UTF-8');
}
return $str;
}
/**
* Return an id or code from a code or id.
* Store also Code-Id into a cache to speed up next request on same table and key.
*
* @param DoliDB $db Database handler
* @param string|int $key Code (string) or Id (int) to get Id or Code
* @param string $tablename Table name without prefix
* @param string $fieldkey Field to search the key into
* @param string $fieldid Field to get
* @param int $entityfilter Filter by entity
* @param string $filters Filters to add. WARNING: string must be escaped for SQL and not coming from user input.
* @param bool $useCache If true (default), cache will be queried and updated.
* @return int<-1,max>|string ID of code if OK, 0 if key empty, -1 if KO
* @see $langs->getLabelFromKey
*/
function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '', $useCache = true)
{
global $conf;
// If key empty
if ($key == '') {
return 0;
}
// Check in cache
if ($useCache && isset($conf->cache['codeid'][$tablename][$key][$fieldid])) { // Can be defined to 0 or ''
return $conf->cache['codeid'][$tablename][$key][$fieldid]; // Found in cache
}
dol_syslog('dol_getIdFromCode (value for field '.$fieldid.' from key '.$key.' not found into cache)', LOG_DEBUG);
$sql = "SELECT ".$fieldid." as valuetoget";
$sql .= " FROM ".MAIN_DB_PREFIX.$tablename;
if ($fieldkey == 'id' || $fieldkey == 'rowid') {
$sql .= " WHERE ".$fieldkey." = ".((int) $key);
} else {
$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);
$valuetoget = '';
if ($obj) {
$valuetoget = $obj->valuetoget;
$conf->cache['codeid'][$tablename][$key][$fieldid] = $valuetoget;
} else {
$conf->cache['codeid'][$tablename][$key][$fieldid] = '';
}
$db->free($resql);
return $valuetoget;
} else {
return -1;
}
}
/**
* Check if a variable with name $var startx with $text.
* Can be used to forge dol_eval() conditions.
*
* @param string $var Variable
* @param string $regextext Text that must be a valid regex string
* @param int<0,1> $matchrule 1=Test if start with, 0=Test if equal
* @return boolean|string True or False, text if bad usage.
*/
function isStringVarMatching($var, $regextext, $matchrule = 1)
{
if ($matchrule == 1) {
if ($var == 'mainmenu') {
global $mainmenu;
return (preg_match('/^'.$regextext.'/', $mainmenu));
} elseif ($var == 'leftmenu') {
global $leftmenu;
return (preg_match('/^'.$regextext.'/', $leftmenu));
} else {
return 'This variable is not accessible with dol_eval';
}
} else {
return 'This value for matchrule is not implemented';
}
}
/**
* Verify if condition in string is ok or not
*
* @param string $strToEvaluate String with condition to check
* @param string $onlysimplestring '0' (deprecated, do not use it anymore)=Accept all chars,
* '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';',
* '2' (used for example for the compute property of extrafields)=Accept also '[]'
* @return boolean True or False. Note: It returns also True if $strToEvaluate is ''. False if error
*/
function verifCond($strToEvaluate, $onlysimplestring = '1')
{
//print $strToEvaluate."<br>\n";
$rights = true;
if (isset($strToEvaluate) && $strToEvaluate !== '') {
//var_dump($strToEvaluate);
//$rep = dol_eval($strToEvaluate, 1, 0, '1'); // to show the error
$rep = dol_eval($strToEvaluate, 1, 1, $onlysimplestring); // The dol_eval() must contains all the "global $xxx;" for all variables $xxx found into the string condition
$rights = (bool) $rep && (!is_string($rep) || strpos($rep, 'Bad string syntax to evaluate') === false);
//var_dump($rights);
}
return $rights;
}
/**
* Replace eval function to add more security.
* This function is called by verifCond() for example.
*
* @param string $s String to evaluate
* @param int<0,1> $returnvalue 0=No return (deprecated, used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
* @param int<0,1> $hideerrors 1=Hide errors
* @param string $onlysimplestring '0' (deprecated, do not use it anymore) = Accept all chars,
* '1' (most common use) = Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';',
* '2' (used for example for the compute property of extrafields) = Accept also '<[]'
* @return string Return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)).
* @see verifCond(), checkPHPCode() to see sanitizing rules that should be very close.
* @phan-suppress PhanPluginUnsafeEval
*/
function dol_eval($s, $returnvalue = 1, $hideerrors = 1, $onlysimplestring = '1')
{
if ($returnvalue != 1) {
dol_syslog("Use of dol_eval with parameter returnvalue = 0 is now forbidden. Please fix this", LOG_ERR);
}
if (getDolGlobalString("MAIN_USE_DOL_EVAL_NEW")) {
return dol_eval_new($s);
} else {
return dol_eval_standard($s, $returnvalue, $hideerrors, $onlysimplestring);
}
}
/**
* Replace eval function to add more security.
* This function is called by dol_eval(), itself called by verifCond() or trans() and transnoentitiesnoconv().
*
* @param string $s String to evaluate
* @return void|string Nothing or return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)).
* @see verifCond(), checkPHPCode() to see sanitizing rules that should be very close.
* @phan-suppress PhanPluginUnsafeEval
*/
function dol_eval_new($s)
{
// Only this global variables can be read by eval function and returned to caller
global $conf, // Read of const is done with getDolGlobalString() but we need $conf->currency for example
$db, $langs, $user, $website, $websitepage,
$action, $mainmenu, $leftmenu,
$mysoc,
$objectoffield, // To allow the use of $objectoffield in computed fields
// Old variables used
$object,
$obj; // To get $obj used into list when dol_eval() is used for computed fields and $obj is not yet $object
// PHP < 7.4.0
defined('T_COALESCE_EQUAL') || define('T_COALESCE_EQUAL', PHP_INT_MAX);
defined('T_FN') || define('T_FN', PHP_INT_MAX);
// PHP < 8.0.0
defined('T_ATTRIBUTE') || define('T_ATTRIBUTE', PHP_INT_MAX);
defined('T_MATCH') || define('T_MATCH', PHP_INT_MAX);
defined('T_NAME_FULLY_QUALIFIED') || define('T_NAME_FULLY_QUALIFIED', PHP_INT_MAX);
defined('T_NAME_QUALIFIED') || define('T_NAME_QUALIFIED', PHP_INT_MAX);
defined('T_NAME_RELATIVE') || define('T_NAME_RELATIVE', PHP_INT_MAX);
// PHP < 8.1.0
defined('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG') || define('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG', PHP_INT_MAX);
defined('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG') || define('T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG', PHP_INT_MAX);
defined('T_ENUM') || define('T_ENUM', PHP_INT_MAX);
defined('T_READONLY') || define('T_READONLY', PHP_INT_MAX);
// PHP < 8.4.0
defined('T_PRIVATE_SET') || define('T_PRIVATE_SET', PHP_INT_MAX);
defined('T_PROTECTED_SET') || define('T_PROTECTED_SET', PHP_INT_MAX);
defined('T_PUBLIC_SET') || define('T_PUBLIC_SET', PHP_INT_MAX);
$prohibited_token_ids = [
/*
* Prohibited int tokens
*/
// T_AND_EQUAL', 'T_ARRAY', 'T_ARRAY_CAST', 'T_AS',
'T_ABSTRACT', 'T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG', 'T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG', 'T_ATTRIBUTE',
// 'T_BOOLEAN_AND', 'T_BOOLEAN_OR', 'T_BOOL_CAST', 'T_BREAK',
'T_BAD_CHARACTER',
// 'T_CASE', 'T_CLASS_C', 'T_CLONE', 'T_COALESCE', 'T_COALESCE_EQUAL', 'T_COMMENT', 'T_CONCAT_EQUAL',
// 'T_CONSTANT_ENCAPSED_STRING', 'T_CONTINUE', 'T_CURLY_OPEN',
'T_CALLABLE', 'T_CATCH', 'T_CLASS', 'T_CLOSE_TAG', 'T_CONST',
// 'T_DEC', 'T_DEFAULT', 'T_DIV_EQUAL', 'T_DNUMBER', 'T_DO', 'T_DOC_COMMENT',
// 'T_DOLLAR_OPEN_CURLY_BRACES', 'T_DOUBLE_ARROW', 'T_DOUBLE_CAST', 'T_DOUBLE_COLON',
'T_DECLARE', 'T_DIR',
// 'T_ELLIPSIS', 'T_ELSE', 'T_ELSEIF', 'T_EMPTY', 'T_ENCAPSED_AND_WHITESPACE', 'T_ENDFOR',
// 'T_ENDFOREACH', 'T_ENDIF', 'T_ENDSWITCH', 'T_ENDWHILE', 'T_END_HEREDOC',
'T_ECHO', 'T_ENDDECLARE', 'T_ENUM', 'T_EVAL', 'T_EXIT', 'T_EXTENDS',
// 'T_FOR', 'T_FOREACH',
'T_FILE', 'T_FINAL', 'T_FINALLY', 'T_FN', 'T_FUNCTION', 'T_FUNC_C',
'T_GLOBAL', 'T_GOTO',
'T_HALT_COMPILER',
// 'T_IF', 'T_INC', 'T_INLINE_HTML', 'T_INSTANCEOF', 'T_INT_CAST', 'T_ISSET', 'T_IS_EQUAL', 'T_IS_GREATER_OR_EQUAL',
// 'T_IS_IDENTICAL', 'T_IS_NOT_EQUAL', 'T_IS_NOT_IDENTICAL', 'T_IS_SMALLER_OR_EQUAL',
'T_IMPLEMENTS', 'T_INCLUDE', 'T_INCLUDE_ONCE', 'T_INSTEADOF', 'T_INTERFACE',
// 'T_LIST', 'T_LNUMBER', 'T_LOGICAL_AND', 'T_LOGICAL_OR', 'T_LOGICAL_XOR',
'T_LINE',
// 'T_MINUS_EQUAL', 'T_MOD_EQUAL', 'T_MUL_EQUAL',
'T_METHOD_C',
// 'T_NEW',
// 'T_NS_SEPARATOR', 'T_NUM_STRING',
'T_NAMESPACE',
// 'T_NAME_FULLY_QUALIFIED', 'T_NAME_QUALIFIED', 'T_NAME_RELATIVE', 'T_NS_C',
// 'T_OBJECT_CAST', 'T_OBJECT_OPERATOR', 'T_OR_EQUAL',
'T_OPEN_TAG', 'T_OPEN_TAG_WITH_ECHO',
// 'T_PAAMAYIM_NEKUDOTAYIM', 'T_PLUS_EQUAL', 'T_POW', 'T_POW_EQUAL',
'T_PRINT', 'T_PRIVATE', 'T_PROTECTED', 'T_PUBLIC',
// 'T_PROPERTY_C',
'T_READONLY', 'T_REQUIRE', 'T_REQUIRE_ONCE', 'T_RETURN',
// 'T_SL', 'T_SL_EQUAL', 'T_SPACESHIP', 'T_SR', 'T_SR_EQUAL', 'T_START_HEREDOC', 'T_STATIC',
// 'T_STRING', 'T_STRING_CAST', 'T_STRING_VARNAME', 'T_SWITCH',
'T_STATIC',
'T_THROW', 'T_TRAIT', 'T_TRAIT_C', 'T_TRY',
'T_UNSET', 'T_UNSET_CAST', 'T_USE',
// 'T_VARIABLE',
'T_VAR',
// 'T_WHILE', 'T_WHITESPACE',
// 'T_XOR_EQUAL',
// 'T_YIELD', 'T_YIELD_FROM',
/*
* Prohibited string tokens
*/
';', '`',
];
$prohibited_variables = [
'$_COOKIE', '$_ENV', '$_FILES', '$GLOBALS', '$_GET', '$_POST', '$_REQUEST', '$_SERVER', '$_SESSION',
];
$prohibited_functions = [
// 'base64_decode', 'rawurldecode', 'urldecode', 'str_rot13', 'hex2bin', // I haven't managed to inject anything with these functions yet, can someone confirm?
// 'get_defined_functions', 'get_defined_vars', 'get_defined_constants', 'get_declared_classes', // Should we really block the admin from viewing these lists?
'override_function', 'session_id', 'session_create_id', 'session_regenerate_id',
'call_user_func', 'call_user_func_array', // PREVENT calling forbidden functions
'exec', 'passthru', 'shell_exec', 'system', 'proc_open', 'popen',
'dol_eval', 'dol_eval_new', 'dol_eval_standard', 'dol_contctdesc', 'executeCLI', 'verifCond', 'GETPOST', // Native Dolibarr functions
'create_function', 'assert', 'mb_ereg_replace', 'mb_eregi_replace', // function with eval capabilities
'dol_compress_dir', 'dol_decode', 'dol_delete_file', 'dol_delete_dir', 'dol_delete_dir_recursive', 'dol_copy', 'archiveOrBackupFile', // more dolibarr functions
'fopen', 'file_put_contents', 'fputs', 'fputscsv', 'fwrite', 'fpassthru', 'mkdir', 'rmdir', 'symlink', 'touch', 'unlink', 'umask', // PHP functions related to file operations
'invoke', 'invokeArgs', // Method of ReflectionFunction to execute a function
'filter_input', 'filter_input_array', 'GETPOST', // PREVENT CODE INJECTION
];
$prohibited_token_arrangements = [
// Variable functions « $a( », « "$a"( », « 'FN_NAME'( », ('FN_NAME')()
' T_VARIABLE ( ', ' " ( ', ' \' ( ', ' T_CONSTANT_ENCAPSED_STRING ( ', ' ) ( ',
];
$tokens = token_get_all("<?php return {$s};", TOKEN_PARSE);
$tokens_arrangement = ' ';
for ($i = 2, $c = count($tokens) - 1; $i < $c; ++$i) { // ignore <?php return and ;
if (is_array($tokens[$i])) {
$token_id = $tokens[$i][0];
$token_value = $tokens[$i][1];
$token_name = token_name($tokens[$i][0]);
} else {
$token_id = $tokens[$i];
$token_value = $tokens[$i];
$token_name = $tokens[$i];
}
// Ignore whitespaces
if (T_WHITESPACE === $token_id) {
continue;
}
// Keep history to check arrangements
$tokens_arrangement .= "{$token_name} ";
// Prohibited Variables
if (T_VARIABLE === $token_id
&& in_array($token_value, $prohibited_variables, true)
) {
return "« {$token_value} » is prohibited in « {$s} »";
}
// Prohibited Functions
if (T_STRING === $token_id
&& in_array($token_value, $prohibited_functions, true)
) {
return "« {$token_value} » is prohibited in « {$s} »";
}
}
// Prohibited Token IDs
$maxi = count($prohibited_token_ids);
for ($i = 0; $i < $maxi; ++$i) {
if (false !== strpos($tokens_arrangement, " {$prohibited_token_ids[$i]} ")) {
return "« {$prohibited_token_ids[$i]} » is prohibited in « {$s} »";
}
}
// Prohibited token arrangements
$maxi = count($prohibited_token_arrangements);
for ($i = 0; $i < $maxi; ++$i) {
if (false !== strpos($tokens_arrangement, $prohibited_token_arrangements[$i])) {
return "« {$prohibited_token_arrangements[$i]} » is prohibited in « {$s} »";
}
}
// Return result
try {
return @eval("return {$s};") ?? '';
} catch (Throwable $ex) {
return "Exception during evaluation: ".$s." - ".$ex->getMessage();
}
}
/**
* Replace eval function to add more security.
* This function is called by dol_eval(), itself called by verifCond() or trans() and transnoentitiesnoconv().
*
* @param string $s String to evaluate
* @param int<0,1> $returnvalue 0=No return (deprecated, used to execute eval($a=something)). 1=Value of eval is returned (used to eval($something)).
* @param int<0,1> $hideerrors 1=Hide errors
* @param string $onlysimplestring '0' (deprecated, do not use it anymore)=Accept all chars,
* '1' (most common use)=Accept only simple string with char 'a-z0-9\s^$_+-.*>&|=!?():"\',/@';',
* '2' (used for example for the compute property of extrafields)=Accept also '<[]'
* @return void|string Nothing or return result of eval (even if type can be int, it is safer to assume string and find all potential typing issues as abs(dol_eval(...)).
* @see verifCond(), checkPHPCode() to see sanitizing rules that should be very close.
* @phan-suppress PhanPluginUnsafeEval
*/
function dol_eval_standard($s, $returnvalue = 1, $hideerrors = 1, $onlysimplestring = '1')
{
// Only this global variables can be read by eval function and returned to caller
global $conf; // Read of const is done with getDolGlobalString() but we need $conf->currency for example
global $db, $langs, $user, $website, $websitepage;
global $action, $mainmenu, $leftmenu;
global $mysoc;
global $objectoffield; // To allow the use of $objectoffield in computed fields
// Old variables used (deprecated)
global $object;
global $obj; // To get $obj used into list when dol_eval() is used for computed fields and $obj is not yet $object
$isObBufferActive = false; // When true, the ObBuffer must be cleaned in the exception handler
if (!in_array($onlysimplestring, array('0', '1', '2'))) {
return "Bad call of dol_eval. Parameter onlysimplestring must be '0' (deprecated), '1' or '2'";
}
try {
// Test on dangerous char (used for RCE), we allow only characters to make PHP variable testing
if ($onlysimplestring == '1' || $onlysimplestring == '2') {
// We must accept with 1: '1 && getDolGlobalInt("doesnotexist1") && getDolGlobalString("MAIN_FEATURES_LEVEL")'
// We must accept with 1: '$user->hasRight("cabinetmed", "read") && !$object->canvas=="patient@cabinetmed"'
// We must accept with 2: (($reloadedobj = new Task($db)) && ($reloadedobj->fetchNoCompute($object->id) <= 99) && ($secondloadedobj = new Project($db)) && ($secondloadedobj->fetchNoCompute($reloadedobj->fk_project) > 0)) ? $secondloadedobj->ref : "Parent project not found"
// Check if there is dynamic call (first we check chars are all into a whitelist chars)
$specialcharsallowed = '^$_+-.*>&|=!?():"\',/@';
if ($onlysimplestring == '2') {
$specialcharsallowed .= '<[]';
}
if (getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL')) {
$specialcharsallowed .= getDolGlobalString('MAIN_ALLOW_UNSECURED_SPECIAL_CHARS_IN_DOL_EVAL');
}
if (preg_match('/[^a-z0-9\s'.preg_quote($specialcharsallowed, '/').']/i', $s)) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (found chars that are not chars for a simple one line clean eval string): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (found chars that are not chars for a simple one line clean eval string): '.$s, LOG_WARNING);
return '';
}
}
// Check if we found a ? without a space before and after
$tmps = str_replace(' ? ', '__XXX__', $s);
if (strpos($tmps, '?') !== false) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (The char ? can be used only with a space before and after): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (The char ? can be used only with a space before and after): '.$s, LOG_WARNING);
return '';
}
}
// Check if there is a < or <= without spaces before/after
if (preg_match('/<=?[^\s]/', $s)) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (mode '.$onlysimplestring.', found a < or <= without space before and after): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (mode '.$onlysimplestring.', found a < or <= without space before and after): '.$s, LOG_WARNING);
return '';
}
}
// Check if there is dynamic call (first we use black list patterns)
if (preg_match('/\$[\w]*\s*\(/', $s)) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (mode '.$onlysimplestring.', found a call using "$abc(" or "$abc (" instead of using the direct name of the function): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (mode '.$onlysimplestring.', found a call using "$abc(" or "$abc (" instead of using the direct name of the function): '.$s, LOG_WARNING);
return '';
}
}
// Now we check if we try dynamic call
// First we remove white list pattern of using parenthesis then testing if one open parenthesis exists
$savescheck = '';
$scheck = $s;
while ($scheck && $savescheck != $scheck) {
$savescheck = $scheck;
$scheck = preg_replace('/->[a-zA-Z0-9_]+\(/', '->__METHOD__', $scheck); // accept parenthesis in '...->method(...'
$scheck = preg_replace('/::[a-zA-Z0-9_]+\(/', '->__METHOD__', $scheck); // accept parenthesis in '...::method(...'
$scheck = preg_replace('/^\(+/', '__PARENTHESIS__ ', $scheck); // accept parenthesis in '(...'. Must replace with "__PARENTHESIS__ with a space after "to allow following substitutions
$scheck = preg_replace('/\&\&\s+\(/', '__ANDPARENTHESIS__ ', $scheck); // accept parenthesis in '&& ('. Must replace with "__PARENTHESIS__ with a space after" to allow following substitutions
$scheck = preg_replace('/\|\|\s+\(/', '__ORPARENTHESIS__ ', $scheck); // accept parenthesis in '|| ('. Must replace with "__PARENTHESIS__ with a space after" to allow following substitutions
$scheck = preg_replace('/^!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in 'function(' and '!function('
$scheck = preg_replace('/\s!?[a-zA-Z0-9_]+\(/', '__FUNCTION__', $scheck); // accept parenthesis in '... function(' and '... !function('
$scheck = preg_replace('/^!\(/', '__NOTANDPARENTHESIS__', $scheck); // accept parenthesis in '!('
$scheck = preg_replace('/\s!\(/', '__NOTANDPARENTHESIS__', $scheck); // accept parenthesis in '... !('
$scheck = preg_replace('/(\^|\')\(/', '__REGEXSTART__', $scheck); // To allow preg_match('/^(aaa|bbb)/'... or isStringVarMatching('leftmenu', '(aaa|bbb)')
}
//print 'scheck='.$scheck." : ".strpos($scheck, '(')."<br>\n";
// Now test if it remains 1 open parenthesis.
if (strpos($scheck, '(') !== false) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (mode '.$onlysimplestring.', found call of a function or method without using the direct name of the function): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (mode '.$onlysimplestring.', found call of a function or method without using the direct name of the function): '.$s, LOG_WARNING);
return '';
}
}
// TODO
// We can exclude $ char that are not in dol_eval global, so that are not:
// $db, $langs, $leftmenu, $topmenu, $user, $langs, $objectoffield, $object, $obj, ...,
}
if (is_array($s) || $s === 'Array') {
if ($returnvalue) {
return 'Bad string syntax to evaluate (value is Array): '.var_export($s, true);
} else {
dol_syslog('Bad string syntax to evaluate (value is Array): '.var_export($s, true), LOG_WARNING);
return '';
}
}
if (!getDolGlobalString('MAIN_ALLOW_DOUBLE_COLON_IN_DOL_EVAL') && strpos($s, '::') !== false) {
if ($returnvalue) {
return 'Bad string syntax to evaluate (double : char is forbidden without setting MAIN_ALLOW_DOUBLE_COLON_IN_DOL_EVAL): '.$s;
} else {
dol_syslog('Bad string syntax to evaluate (double : char is forbidden without setting MAIN_ALLOW_DOUBLE_COLON_IN_DOL_EVAL): '.$s, LOG_WARNING);
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, LOG_WARNING);
return '';
}
}
// Disallow also concat
if (getDolGlobalString('MAIN_DISALLOW_STRING_OBFUSCATION_IN_DOL_EVAL')) {
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, LOG_WARNING);
return '';
}
}
}
// We block use of php exec or php file functions
$forbiddenphpstrings = array('$$', '$_', '}[', ')(');
$forbiddenphpstrings = array_merge($forbiddenphpstrings, array('_ENV', '_SESSION', '_COOKIE', '_GET', '_GLOBAL', '_POST', '_REQUEST', 'ReflectionFunction'));
// We list all forbidden function as keywords we don't want to see (we don't mind it if is "kewyord(" or just "keyword", we don't want "keyword" at all)
// We must exclude all functions that allow to execute another function. This includes all function that has a parameter with type "callable" to avoid things
// like we can do with array_map and its callable parameter: dol_eval('json_encode(array_map(implode("",["ex","ec"]), ["id"]))', 1, 1, '0')
$forbiddenphpfunctions = array();
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("override_function", "session_id", "session_create_id", "session_regenerate_id"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("get_defined_functions", "get_defined_vars", "get_defined_constants", "get_declared_classes"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("function", "call_user_func", "call_user_func_array"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("array_all", "array_any", "array_diff_ukey", "array_filter", "array_find", "array_find_key", "array_map", "array_reduce", "array_intersect_uassoc", "array_intersect_ukey", "array_walk", "array_walk_recursive"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("usort", "uasort", "uksort", "preg_replace_callback", "preg_replace_callback_array", "header_register_callback"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("set_error_handler", "set_exception_handler", "libxml_set_external_entity_loader", "register_shutdown_function", "register_tick_function", "unregister_tick_function"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("spl_autoload_register", "spl_autoload_unregister", "iterator_apply", "session_set_save_handler"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("forward_static_call", "forward_static_call_array", "register_postsend_function"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("ob_start"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("require", "include", "require_once", "include_once"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("exec", "passthru", "shell_exec", "system", "proc_open", "popen"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_eval", "dol_eval_new", "dol_eval_standard", "dol_concatdesc", "executeCLI", "verifCond", "GETPOST")); // native dolibarr functions
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("eval", "create_function", "assert", "mb_ereg_replace")); // function with eval capabilities
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("readline_completion_function", "readline_callback_handler_install"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_compress_dir", "dol_decode", "dol_delete_file", "dol_delete_dir", "dol_delete_dir_recursive", "dol_copy", "archiveOrBackupFile")); // more dolibarr functions
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("fopen", "file_put_contents", "fputs", "fputscsv", "fwrite", "fpassthru", "mkdir", "rmdir", "symlink", "touch", "unlink", "umask"));
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("require", "include"));
if (getDolGlobalString('MAIN_DISALLOW_STRING_OBFUSCATION_IN_DOL_EVAL')) { // We disabllow all function that allow to obfuscate the real name of a function
// @phpcs:ignore
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("base64"."_"."decode", "rawurl"."decode", "url"."decode", "str"."_rot13", "hex"."2bin")); // name of forbidden functions are split to avoid false positive
$forbiddenphpfunctions = array_merge($forbiddenphpfunctions, array("dol_concatdesc")); // native dolibarr functions
}
$forbiddenphpmethods = array('invoke', 'invokeArgs'); // Method of ReflectionFunction to execute a function
$forbiddenphpregex = 'global\s*\$';
$forbiddenphpregex .= '|';
$forbiddenphpregex .= '\b('.implode('|', $forbiddenphpfunctions).')\b';
$forbiddenphpmethodsregex = '->('.implode('|', $forbiddenphpmethods).')';
do {
$oldstringtoclean = $s;
$s = str_ireplace($forbiddenphpstrings, '__forbiddenstring__', $s);
$s = preg_replace('/'.$forbiddenphpregex.'/i', '__forbiddenstring__', $s);
$s = preg_replace('/'.$forbiddenphpmethodsregex.'/i', '__forbiddenstring__', $s);
//$s = preg_replace('/\$[a-zA-Z0-9_\->\$]+\(/i', '', $s); // Remove $function( call and $mycall->mymethod(
} while ($oldstringtoclean != $s);
if (strpos($s, '__forbiddenstring__') !== false) {
dol_syslog('Bad string syntax to evaluate: '.$s, LOG_WARNING);
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) {
ob_start(); // An evaluation has no reason to output data
$isObBufferActive = true;
$tmps = $hideerrors ? @eval('return ' . $s . ';') : eval('return ' . $s . ';');
$tmpo = ob_get_clean();
$isObBufferActive = false;
if ($tmpo) {
print 'Bad string syntax to evaluate. Some data were output when it should not when evaluating: ' . $s;
}
return $tmps;
} else {
dol_syslog('Do not use anymore dol_eval with param returnvalue=0', LOG_WARNING);
if ($hideerrors) {
@eval($s);
} else {
eval($s);
}
return '';
}
} catch (Error $e) {
if ($isObBufferActive) {
// Clean up buffer which was left behind due to exception.
$tmpo = ob_get_clean();
$isObBufferActive = false;
}
$error = 'dol_eval try/catch error : ';
$error .= $e->getMessage();
dol_syslog($error, LOG_WARNING);
if ($returnvalue) {
return 'Exception during evaluation: '.$s;
} else {
return '';
}
}
}
/**
* Return if var element is ok
*
* @param string $element Variable to check
* @return boolean Return true of variable is not empty
* @see getElementProperties()
*/
function dol_validElement($element)
{
return (trim($element) != '');
}
/**
* Return img flag of country for a language code or country code.
*
* @param string $codelang Language code ('en_IN', 'fr_CA', ...) or ISO Country code on 2 characters in uppercase ('IN', 'FR')
* @param string $moreatt Add more attribute on img tag (For example 'style="float: right"' or 'class="saturatemedium"')
* @param int<0,1> $notitlealt No title alt
* @return string HTML img string with flag.
*/
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];
}
$morecss = '';
$reg = array();
if (preg_match('/class="([^"]+)"/', $moreatt, $reg)) {
$morecss = $reg[1];
$moreatt = "";
}
// return img_picto_common($codelang, 'flags/'.strtolower($flagImage).'.png', $moreatt, 0, $notitlealt);
return '<span class="flag-sprite '.strtolower($flagImage).($morecss ? ' '.$morecss : '').'"'.($moreatt ? ' '.$moreatt : '').(!$notitlealt ? ' title="'.$codelang.'"' : '').'></span>';
}
/**
* Return default language from country code.
* Return null if not found.
*
* @param string $countrycode Country code like 'US', 'FR', 'CA', 'ES', 'IN', 'MX', ...
* @return ?string Value of locale like 'en_US', 'fr_FR', ... or null if not found
*/
function getLanguageCodeFromCountryCode($countrycode)
{
global $mysoc;
if (empty($countrycode)) {
return null;
}
if (strtoupper($countrycode) == 'MQ') {
return 'fr_CA';
}
if (strtoupper($countrycode) == 'SE') {
return 'sv_SE'; // se_SE is Sami/Sweden, and we want in priority sv_SE for SE country
}
if (strtoupper($countrycode) == 'CH') {
if ($mysoc->country_code == 'FR') {
return 'fr_CH';
}
if ($mysoc->country_code == 'DE') {
return 'de_CH';
}
if ($mysoc->country_code == 'IT') {
return 'it_CH';
}
}
// Locale list taken from:
// http://stackoverflow.com/questions/3191664/
// list-of-all-locales-and-their-short-codes
$locales = array(
'af-ZA',
'am-ET',
'ar-AE',
'ar-BH',
'ar-DZ',
'ar-EG',
'ar-IQ',
'ar-JO',
'ar-KW',
'ar-LB',
'ar-LY',
'ar-MA',
'ar-OM',
'ar-QA',
'ar-SA',
'ar-SY',
'ar-TN',
'ar-YE',
//'as-IN', // Moved after en-IN
'ba-RU',
'be-BY',
'bg-BG',
'bn-BD',
//'bn-IN', // Moved after en-IN
'bo-CN',
'br-FR',
'ca-ES',
'co-FR',
'cs-CZ',
'cy-GB',
'da-DK',
'de-AT',
'de-CH',
'de-DE',
'de-LI',
'de-LU',
'dv-MV',
'el-GR',
'en-AU',
'en-BZ',
'en-CA',
'en-GB',
'en-IE',
'en-IN',
'as-IN', // as-IN must be after en-IN (en in priority if country is IN)
'bn-IN', // bn-IN must be after en-IN (en in priority if country is IN)
'en-JM',
'en-MY',
'en-NZ',
'en-PH',
'en-SG',
'en-TT',
'en-US',
'en-ZA',
'en-ZW',
'es-AR',
'es-BO',
'es-CL',
'es-CO',
'es-CR',
'es-DO',
'es-EC',
'es-ES',
'es-GT',
'es-HN',
'es-MX',
'es-NI',
'es-PA',
'es-PE',
'es-PR',
'es-PY',
'es-SV',
'es-US',
'es-UY',
'es-VE',
'et-EE',
'eu-ES',
'fa-IR',
'fi-FI',
'fo-FO',
'fr-BE',
'fr-CA',
'fr-CH',
'fr-FR',
'fr-LU',
'fr-MC',
'fy-NL',
'ga-IE',
'gd-GB',
'gl-ES',
'gu-IN',
'he-IL',
'hi-IN',
'hr-BA',
'hr-HR',
'hu-HU',
'hy-AM',
'id-ID',
'ig-NG',
'ii-CN',
'is-IS',
'it-CH',
'it-IT',
'ja-JP',
'ka-GE',
'kk-KZ',
'kl-GL',
'km-KH',
'kn-IN',
'ko-KR',
'ky-KG',
'lb-LU',
'lo-LA',
'lt-LT',
'lv-LV',
'mi-NZ',
'mk-MK',
'ml-IN',
'mn-MN',
'mr-IN',
'ms-BN',
'ms-MY',
'mt-MT',
'nb-NO',
'ne-NP',
'nl-BE',
'nl-NL',
'nn-NO',
'oc-FR',
'or-IN',
'pa-IN',
'pl-PL',
'ps-AF',
'pt-BR',
'pt-PT',
'rm-CH',
'ro-MD',
'ro-RO',
'ru-RU',
'rw-RW',
'sa-IN',
'se-FI',
'se-NO',
'se-SE',
'si-LK',
'sk-SK',
'sl-SI',
'sq-AL',
'sv-FI',
'sv-SE',
'sw-KE',
'ta-IN',
'te-IN',
'th-TH',
'tk-TM',
'tn-ZA',
'tr-TR',
'tt-RU',
'ug-CN',
'uk-UA',
'ur-PK',
'vi-VN',
'wo-SN',
'xh-ZA',
'yo-NG',
'zh-CN',
'zh-HK',
'zh-MO',
'zh-SG',
'zh-TW',
'zu-ZA',
);
$buildprimarykeytotest = strtolower($countrycode).'-'.strtoupper($countrycode);
if (in_array($buildprimarykeytotest, $locales)) {
return strtolower($countrycode).'_'.strtoupper($countrycode);
}
if (function_exists('locale_get_primary_language') && function_exists('locale_get_region')) { // Need extension php-intl
foreach ($locales as $locale) {
$locale_language = locale_get_primary_language($locale);
$locale_region = locale_get_region($locale);
if (strtoupper($countrycode) == $locale_region) {
//var_dump($locale.' - '.$locale_language.' - '.$locale_region);
return strtolower($locale_language).'_'.strtoupper($locale_region);
}
}
} else {
dol_syslog("Warning Extension php-intl is not available", LOG_WARNING);
}
return null;
}
/**
* Complete or removed entries into a head array (used to build tabs).
* For example, with value added by external modules. Such values are declared into $conf->modules_parts['tab'].
* Or by change using hook completeTabsHead
*
* @param Conf $conf Object conf
* @param Translate $langs Object langs
* @param ?Object $object Object object
* @param array<array{0:string,1:string,2:string}> $head List of head tabs (updated by this function)
* @param int $h New position to fill (updated by this function)
* @param string $type Value for object where objectvalue can be
* 'thirdparty' to add a tab in third party view
* 'intervention' to add a tab in intervention view
* 'supplier_order' to add a tab in purchase order view
* 'supplier_invoice' to add a tab in purchase invoice view
* 'invoice' to add a tab in sales invoice view
* 'order' to add a tab in sales order view
* 'contract' to add a table in contract view
* 'product' to add a tab in product view
* 'propal' to add a tab in propal view
* 'user' to add a tab in user view
* 'group' to add a tab in group view
* 'member' to add a tab in foundation member view
* 'categories_x' to add a tab in category view ('x': type of category (0=product, 1=supplier, 2=customer, 3=member)
* 'ecm' to add a tab for another ecm view
* 'stock' to add a tab for warehouse view
* @param 'add'|'remove' $mode 'add' to complete head, 'remove' to remove entries
* @param string $filterorigmodule Filter on module origin: 'external' will show only external modules. 'core' only core modules. No filter (default) will add both.
* @return void
*/
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])) {
$newtab = array();
$postab = $h;
// detect if position set in $values[1] ie : +(2)mytab@mymodule (first tab is 0, second is one, ...)
$str = $values[1];
$posstart = strpos($str, '(');
if ($posstart > 0) {
$posend = strpos($str, ')');
if ($posstart > 0) {
$res1 = substr($str, $posstart + 1, $posend - $posstart - 1);
if (is_numeric($res1)) {
$postab = (int) $res1;
$values[1] = '+' . substr($str, $posend + 1);
}
}
}
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], '2')) {
if ($values[3]) {
if ($filterorigmodule) { // If a filter of module origin has been requested
if (strpos($values[3], '@')) { // This is an external module
if ($filterorigmodule != 'external') {
continue;
}
} else { // This looks a core module
if ($filterorigmodule != 'core') {
continue;
}
}
}
$langs->load($values[3]);
}
if (preg_match('/SUBSTITUTION_([^_]+)/i', $values[2], $reg)) {
// If label is "SUBSTITUION_..."
$substitutionarray = array();
complete_substitutions_array($substitutionarray, $langs, $object, array('needforkey' => $values[2]));
$label = make_substitutions($reg[1], $substitutionarray);
} else {
// If label is "Label,Class,File,Method", we call the method to show content inside the badge
$labeltemp = explode(',', $values[2]);
$label = $langs->trans($labeltemp[0]);
if (!empty($labeltemp[1]) && is_object($object) && !empty($object->id)) {
dol_include_once($labeltemp[2]);
$classtoload = $labeltemp[1];
if (class_exists($classtoload)) {
$obj = new $classtoload($db);
$function = $labeltemp[3];
if ($obj && $function && method_exists($obj, $function)) {
// @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
$nbrec = $obj->$function($object->id, $obj);
if (!empty($nbrec)) {
$label .= '<span class="badge marginleftonlyshort">'.$nbrec.'</span>';
}
}
}
}
}
$newtab[0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[5]), 1);
$newtab[1] = $label;
$newtab[2] = str_replace('+', '', $values[1]);
$h++;
} else {
continue;
}
} 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]);
}
$newtab[0] = dol_buildpath(preg_replace('/__ID__/i', ((is_object($object) && !empty($object->id)) ? $object->id : ''), $values[4]), 1);
$newtab[1] = $label;
$newtab[2] = str_replace('+', '', $values[1]);
$h++;
}
// set tab at its position
$head = array_merge(array_slice($head, 0, $postab), array($newtab), array_slice($head, $postab));
} elseif ($mode == 'remove' && preg_match('/^\-/', $values[1])) {
if ($values[0] != $type) {
continue;
}
$tabname = str_replace('-', '', $values[1]);
foreach ($head as $key => $val) {
$condition = (!empty($values[3]) ? verifCond($values[3], '2') : 1);
//var_dump($key.' - '.$tabname.' - '.$head[$key][2].' - '.$values[3].' - '.$condition);
if ($head[$key][2] == $tabname && $condition) {
unset($head[$key]);
break;
}
}
}
}
}
// No need to make a return $head. Var is modified as a reference
if (!empty($hookmanager)) {
$parameters = array('object' => $object, 'mode' => $mode, 'head' => &$head, 'filterorigmodule' => $filterorigmodule);
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable
$reshook = $hookmanager->executeHooks('completeTabsHead', $parameters, $object);
if ($reshook > 0) { // Hook ask to replace completely the array
$head = $hookmanager->resArray;
} else { // Hook
$head = array_merge($head, $hookmanager->resArray);
}
$h = count($head);
}
}
/**
* Print common footer :
* conf->global->MAIN_HTML_FOOTER
* js for switch of menu hider
* js for conf->global->MAIN_GOOGLE_AN_ID
* js for conf->global->MAIN_SHOW_TUNING_INFO or $_SERVER["MAIN_SHOW_TUNING_INFO"]
* js for conf->logbuffer
*
* @param string $zone 'private' (for private pages) or 'public' (for public pages)
* @return void
*/
function printCommonFooter($zone = 'private')
{
global $conf, $hookmanager, $user, $langs;
global $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 (getDolGlobalString('MAIN_HTML_FOOTER')) {
print getDolGlobalString('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 mandatory 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 == 'add' || $action == 'edit' || (empty($action) && (preg_match('/new\.php/', $_SERVER["PHP_SELF"]))) || ((empty($action) || $action == 'addline') && (preg_match('/card\.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) {
print 'console.log("set the focus by executing jQuery(...).focus();")'."\n";
foreach ($defval as $paramkey => $paramval) {
// Set focus on field
print 'jQuery("input[name=\''.$paramkey.'\']").focus();'."\n";
print 'jQuery("textarea[name=\''.$paramkey.'\']").focus();'."\n"; // TODO KO with ckeditor
print 'jQuery("select[name=\''.$paramkey.'\']").focus();'."\n"; // Not really useful, 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) {
print 'console.log("set the js code to manage fields that are set as mandatory");'."\n";
foreach ($defval as $paramkey => $paramval) {
// Solution 1: Add handler on submit to check if mandatory fields are empty
print 'var form = $(\'#'.dol_escape_js($paramkey).'\').closest("form");'."\n";
print "form.on('submit', function(event) {
var submitter = $(this).find(':submit:focus').get(0);
if (submitter) {
var buttonName = $(submitter).attr('name');
if (buttonName == 'cancel') {
console.log('We click on cancel button so we accept submit with no need to check mandatory fields');
return true;
}
}
console.log('We did not click on cancel button but on something else, we check that field #".dol_escape_js($paramkey)." is not empty');
var tmpvalue = jQuery('#".dol_escape_js($paramkey)."').val();
let tmptypefield = jQuery('#".dol_escape_js($paramkey)."').prop('nodeName').toLowerCase(); // Get the tag name (div, section, footer...)
if (tmptypefield == 'textarea') {
// We must instead check the content of ckeditor
var tmpeditor = CKEDITOR.instances['".dol_escape_js($paramkey)."'];
if (tmpeditor) {
tmpvalue = tmpeditor.getData();
console.log('For textarea tmpvalue is '+tmpvalue);
}
}
let tmpvalueisempty = false;
if (tmpvalue === null || tmpvalue === undefined || tmpvalue === '' || tmpvalue === -1) {
tmpvalueisempty = true;
}
if (tmpvalue === '0' && (tmptypefield == 'select' || tmptypefield == 'input')) {
tmpvalueisempty = true;
}
if (tmpvalueisempty && (buttonName == 'save')) {
console.log('field has type '+tmptypefield+' and is empty, we cancel the submit');
event.preventDefault(); // Stop submission of form to allow custom code to decide.
event.stopPropagation(); // Stop other handlers.
alert('".dol_escape_js($langs->trans("ErrorFieldRequired", $paramkey).' ('.$langs->trans("CustomMandatoryFieldRule").')')."');
return false;
}
console.log('field has type '+tmptypefield+' and is defined to '+tmpvalue);
return true;
});
\n";
// Solution 2: Add property 'required' on input
// so browser will check value and try to focus on it when submitting the form.
//print 'setTimeout(function() {'; // If we want to wait that ckeditor beuatifier has finished its job.
//print 'jQuery("input[name=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
//print 'jQuery("textarea[id=\''.$paramkey.'\']").prop(\'required\',true);'."\n";
//print 'jQuery("select[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.'\'] 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 '}, 500);'; // 500 milliseconds delay
// Now set the class "fieldrequired"
print 'jQuery(\':input[name="' . dol_escape_js($paramkey) . '"]\').closest("tr").find("td:first").addClass("fieldrequired");'."\n";
}
// If we submit using the cancel button, we remove the required attributes
print 'jQuery("input[name=\'cancel\']").click(function() {
console.log("We click on cancel button so removed all required attribute");
jQuery("input, textarea, select").each(function(){this.removeAttribute(\'required\');});
});'."\n";
}
}
}
}
print '});'."\n";
// End of tuning
if (!empty($_SERVER['MAIN_SHOW_TUNING_INFO']) || getDolGlobalString('MAIN_SHOW_TUNING_INFO')) {
print "\n";
print "/* JS CODE TO ENABLE to add memory info */\n";
print 'window.console && console.log("';
if (getDolGlobalString('MEMCACHED_SERVER')) {
print 'MEMCACHED_SERVER=' . getDolGlobalString('MEMCACHED_SERVER').' - ';
}
print 'MAIN_OPTIMIZE_SPEED=' . getDolGlobalString('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 (isModEnabled('google') && getDolGlobalString('MAIN_GOOGLE_AN_ID')) {
$tmptagarray = explode(',', getDolGlobalString('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 nonce="'.getNonce().'" 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 ($user->hasRight('debugbar', 'read') && $debugbar instanceof DebugBar\DebugBar) {
if (isset($debugbar['time'])) {
// @phan-suppress-next-line PhanPluginUnknownObjectMethodCall
$debugbar['time']->stopMeasure('pageaftermaster');
}
print '<!-- Output debugbar data -->'."\n";
$renderer = $debugbar->getJavascriptRenderer();
print $renderer->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";
}
}
}
/**
* Split a string with 2 keys into key array.
* For example: "A=1;B=2;C=2" is exploded into array('A'=>'1','B'=>'2','C'=>'3')
*
* @param ?string $string String to explode
* @param string $delimiter Delimiter between each couple of data. Example: ';' or '[\n;]+' or '(\n\r|\r|\n|;)'
* @param string $kv Delimiter between key and value
* @return array<string,string> Array of data exploded
*/
function dolExplodeIntoArray($string, $delimiter = ';', $kv = '=')
{
if (is_null($string)) {
return array();
}
if (preg_match('/^\[.*\]$/sm', $delimiter) || preg_match('/^\(.*\)$/sm', $delimiter)) {
// This is a regex string
$newdelimiter = $delimiter;
} else {
// This is a simple string
// @phan-suppress-next-line PhanPluginSuspiciousParamPositionInternal
$newdelimiter = preg_quote($delimiter, '/');
}
if ($a = preg_split('/'.$newdelimiter.'/', $string)) {
$ka = array();
foreach ($a as $s) { // each part
if ($s) {
if ($pos = strpos($s, $kv)) { // key/value delimiter
$ka[trim(substr($s, 0, $pos))] = trim(substr($s, $pos + strlen($kv)));
} else { // key delimiter not found
$ka[] = trim($s);
}
}
}
return $ka;
}
return array();
}
/**
* Explode a search string into an array but do not explode when keys are inside quotes.
* For example "a 'b c'" will be array("a", "b c").
*
* @param string $input String to explode
* @return array<string> Array of string values
*/
function dolExplodeKeepIfQuotes($input)
{
// Use regexp to capture words and section in quotes
$matches = array();
preg_match_all('/"([^"]*)"|\'([^\']*)\'|(\S+)/', $input, $matches);
// Merge result and delete empty values
$result = array_map(
/**
* @param string $a Matched value in double quotes
* @param string $b Matched value in single quotes
* @param string $c Unquoted value
* @return string
*/
static function ($a, $b, $c) {
if ($a !== '') {
return $a;
}
if ($b !== '') {
return $b;
}
if ($c !== '') {
return $c;
}
return '';
},
$matches[1],
$matches[2],
$matches[3]
);
return array_values(array_filter(
$result,
/**
* Filter out empty strings from the result array.
*
* @param string $val The value to check.
* @return bool True if the value is not an empty string.
*/
static function ($val) {
return $val !== '';
}
));
}
/**
* Set focus onto field with selector (similar behaviour of 'autofocus' HTML5 tag)
*
* @param string $selector Selector ('#id' or 'input[name="ref"]') to use to find the HTML input field that must get the autofocus. You must use a CSS selector, so unique id preceding with the '#' char.
* @return void
*/
function dol_set_focus($selector)
{
print "\n".'<!-- Set focus onto a specific field -->'."\n";
print '<script nonce="'.getNonce().'">jQuery(document).ready(function() { console.log("Force focus by dol_set_focus"); jQuery("'.dol_escape_js($selector).'").focus(); });</script>'."\n";
}
/**
* Return getmypid() or random PID when function is disabled
* Some web hosts disable this php function for security reasons
* and sometimes we can't redeclare function.
*
* @return int
*/
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)
}
}
/**
* Generate natural SQL search string for a criteria (this criteria can be tested on one or several fields)
*
* @param string|string[] $fields String or array of strings, filled with the name of all fields in the SQL query we must check (combined with a OR). Example: array("p.field1","p.field2")
* @param string $value The value to look for.
* If param $mode is 0, can contains several keywords separated with a space or |
* like "keyword1 keyword2" = We want record field like keyword1 AND field like keyword2
* or like "keyword1|keyword2" = We want record field like keyword1 OR field like keyword2
* If param $mode is 1, can contains an operator <, > or = like "<10" or ">=100.5 < -1000"
* If param $mode is 2 or -2, can contains a list of int id separated by comma like "1,3,4"
* If param $mode is 3 or -3, can contains a list of string separated by comma like "a,b,c".
* @param integer $mode 0=value is list of keyword strings,
* 1=value is a numeric test (Example ">5.5 <10"),
* 2=value is a list of ID separated with comma (Example '1,3,4'), -2 is for exclude list,
* 3=value is list of string separated with comma (Example 'text 1,text 2'), -3 if for exclude list,
* 4=value is a list of ID separated with comma (Example '2,7') to be used to search inside a string '1,2,3,4'
* @param integer $nofirstand 1=Do not output the first 'AND'
* @return string $res The statement to append to the SQL query
* @see dolSqlDateFilter()
* @see forgeSQLFromUniversalSearchCriteria()
*/
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("SeparatorDecimal"), '/').'\-])/', '\1\2', $value); // Clean string '< 10' into '<10' so we can then explode on space to get all tests to do
}
$value = preg_replace('/\s*\|\s*/', '|', $value);
// Split criteria on ' ' but not if we are inside quotes.
// For mode 3, the split is done later on the , only and not on the ' '.
if ($mode != -3 && $mode != 3) {
$crits = dolExplodeKeepIfQuotes($value);
} else {
$crits = array($value);
}
$res = '';
if (!is_array($fields)) {
$fields = array($fields);
}
$i1 = 0; // count the nb of "and" criteria added (all fields / criteria)
foreach ($crits as $crit) { // Loop on each AND criteria
$crit = trim($crit);
$i2 = 0; // count the nb of valid criteria added for this this first criteria
$newres = '';
foreach ($fields as $field) {
if ($mode == 1) {
$tmpcrits = explode('|', $crit);
$i3 = 0; // count the nb of valid criteria added for this current field
foreach ($tmpcrits as $tmpcrit) {
if ($tmpcrit !== '0' && empty($tmpcrit)) {
continue;
}
$tmpcrit = trim($tmpcrit);
$newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
$operator = '=';
$newcrit = preg_replace('/([!<>=]+)/', '', $tmpcrit);
$reg = array();
preg_match('/([!<>=]+)/', $tmpcrit, $reg);
if (!empty($reg[1])) {
$operator = $reg[1];
}
if ($newcrit != '') {
$numnewcrit = price2num($newcrit);
if (is_numeric($numnewcrit)) {
$newres .= $db->sanitize($field).' '.$operator.' '.((float) $numnewcrit); // should be a numeric
} else {
$newres .= '1 = 2'; // force false, we received a corrupted data
}
$i3++; // a criteria was added to string
}
}
$i2++; // a criteria for 1 more field was added to string
} elseif ($mode == 2 || $mode == -2) {
$crit = preg_replace('/[^\-0-9,]/', '', $crit); // ID are always integer
$newres .= ($i2 > 0 ? ' OR ' : '').$db->sanitize($field)." ".($mode == -2 ? 'NOT ' : '');
$newres .= $crit ? "IN (".$db->sanitize($db->escape($crit)).")" : "IN (0)";
if ($mode == -2) {
$newres .= ' OR '.$db->sanitize($field).' IS NULL';
}
$i2++; // a criteria for 1 more field was added to string
} elseif ($mode == 3 || $mode == -3) {
$tmparray = explode(',', $crit);
if (count($tmparray)) {
$listofcodes = '';
foreach ($tmparray as $val) {
$val = trim($val);
if ($val) {
$listofcodes .= ($listofcodes ? ',' : '');
$listofcodes .= "'".$db->escape($val)."'";
}
}
$newres .= ($i2 > 0 ? ' OR ' : '').$db->sanitize($field)." ".($mode == -3 ? 'NOT ' : '')."IN (".$db->sanitize($listofcodes, 1, 0, 1).")";
$i2++; // a criteria for 1 more field was added to string
}
if ($mode == -3) {
$newres .= ' OR '.$db->sanitize($field).' IS NULL';
}
} elseif ($mode == 4) {
$tmparray = explode(',', $crit);
if (count($tmparray)) {
$listofcodes = '';
foreach ($tmparray as $val) {
$val = trim($val);
if ($val) {
$newres .= ($i2 > 0 ? " OR (" : "(").$db->sanitize($field)." LIKE '".$db->escape($val).",%'";
$newres .= ' OR '.$db->sanitize($field)." = '".$db->escape($val)."'";
$newres .= ' OR '.$db->sanitize($field)." LIKE '%,".$db->escape($val)."'";
$newres .= ' OR '.$db->sanitize($field)." LIKE '%,".$db->escape($val).",%'";
$newres .= ')';
$i2++; // a criteria for 1 more field was added to string (we can add several criteria for the same field as it is a multiselect search criteria)
}
}
}
} else { // $mode=0
$tmpcrits = explode('|', $crit);
$i3 = 0; // count the nb of valid criteria added for the current couple criteria/field
foreach ($tmpcrits as $tmpcrit) { // loop on each OR criteria
if ($tmpcrit !== '0' && empty($tmpcrit)) {
continue;
}
$tmpcrit = trim($tmpcrit);
if ($tmpcrit == '^$' || strpos($crit, '!') === 0) { // If we search empty, we must combined different OR fields with AND
$newres .= (($i2 > 0 || $i3 > 0) ? ' AND ' : '');
} else {
$newres .= (($i2 > 0 || $i3 > 0) ? ' OR ' : '');
}
if (preg_match('/\.(id|rowid)$/', $field)) { // Special case for rowid that is sometimes a ref so used as a search field
$newres .= $db->sanitize($field)." = ".(is_numeric($tmpcrit) ? ((float) $tmpcrit) : '0');
} else {
$tmpcrit2 = $tmpcrit;
$tmpbefore = '%';
$tmpafter = '%';
$tmps = '';
if (preg_match('/^!/', $tmpcrit)) {
$tmps .= $db->sanitize($field)." NOT LIKE "; // ! as exclude character
$tmpcrit2 = preg_replace('/^!/', '', $tmpcrit2);
} else {
$tmps .= $db->sanitize($field)." LIKE ";
}
$tmps .= "'";
if (preg_match('/^[\^\$]/', $tmpcrit)) {
$tmpbefore = '';
$tmpcrit2 = preg_replace('/^[\^\$]/', '', $tmpcrit2);
}
if (preg_match('/[\^\$]$/', $tmpcrit)) {
$tmpafter = '';
$tmpcrit2 = preg_replace('/[\^\$]$/', '', $tmpcrit2);
}
if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
$tmps = "(".$tmps;
}
$newres .= $tmps;
$newres .= $tmpbefore;
$newres .= $db->escape($tmpcrit2);
$newres .= $tmpafter;
$newres .= "'";
if ($tmpcrit2 == '' || preg_match('/^!/', $tmpcrit)) {
$newres .= " OR ".$field." IS NULL)";
}
}
$i3++;
}
$i2++; // a criteria for 1 more field was added to string
}
}
if ($newres) {
$res = $res.($res ? ' AND ' : '').($i2 > 1 ? '(' : '').$newres.($i2 > 1 ? ')' : '');
}
$i1++;
}
$res = ($nofirstand ? "" : " AND ")."(".$res.")";
return $res;
}
/**
* Return string with full Url. The file qualified is the one defined by relative path in $object->last_main_doc
*
* @param CommonObject $object Object
* @return string Url string
*/
function showDirectDownloadLink($object)
{
global $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", '');
} else {
$out .= '<div class="urllink">'.$langs->trans("FileNotShared").'</div>';
}
return $out;
}
/**
* Return the filename of file to get the thumbs
*
* @param string $file Original filename (full or relative path)
* @param string $extName Extension to differentiate thumb file name ('', '_small', '_mini')
* @param string $extImgTarget Force image extension for thumbs. Use '' to keep same extension than original image (default).
* @return string New file name (full or relative path, including the thumbs/). May be the original path if no thumb can exists.
*/
function getImageFileNameForSize($file, $extName, $extImgTarget = '')
{
$dirName = dirname($file);
if ($dirName == '.') {
$dirName = '';
}
if (!in_array($extName, array('', '_small', '_mini'))) {
return 'Bad parameter extName';
}
$fileName = preg_replace('/(\.gif|\.jpeg|\.jpg|\.png|\.bmp|\.webp)$/i', '', $file); // We remove image extension, whatever is its case
$fileName = basename($fileName);
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.jpg$/i', $file) ? '.jpg' : '');
}
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.jpeg$/i', $file) ? '.jpeg' : '');
}
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.gif$/i', $file) ? '.gif' : '');
}
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.png$/i', $file) ? '.png' : '');
}
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.bmp$/i', $file) ? '.bmp' : '');
}
if (empty($extImgTarget)) {
$extImgTarget = (preg_match('/\.webp$/i', $file) ? '.webp' : '');
}
if (!$extImgTarget) {
return $file;
}
$subdir = '';
if ($extName) {
$subdir = 'thumbs/';
}
return ($dirName ? $dirName.'/' : '').$subdir.$fileName.$extName.$extImgTarget; // New filename for thumb
}
/**
* Return URL we can use for advanced preview links
*
* @param string $modulepart propal, facture, facture_fourn, ...
* @param string $relativepath Relative path of docs.
* @param int<0,1> $alldata Return array with all components (1 is recommended, then use a simple a href link with the class, target and mime attribute added. 'documentpreview' css class is handled by jquery code into main.inc.php)
* @param string $param More param on http links
* @return string|array{}|array{target:string,css:string,url:string,mime:string} Output string with href link or array with all components of link
*/
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='.urlencode($modulepart).'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : ''), 'mime' => dol_mimetype($relativepath));
} else {
return array();
}
}
// old behavior, return a string
if ($isAllowedForPreview) {
$tmpurl = DOL_URL_ROOT.'/document.php?modulepart='.urlencode($modulepart).'&attachment=0&file='.urlencode($relativepath).($param ? '&'.$param : '');
$title = $langs->transnoentities("Preview");
//$title = '%27-alert(document.domain)-%27'; // An example of js injection into a corrupted title string, that should be blocked by the dol_escape_uri().
//$tmpurl = 'file='.urlencode("'-alert(document.domain)-'_small.jpg"); // An example of tmpurl that should be blocked by the dol_escape_uri()
// We need to do a dol_escape_uri() on the full string after the javascript: because such parts are the URI and when we click on such links, a RFC3986 decode is done,
// by the browser, converting the %27 (like when having param file=abc%27def), or when having a corrupted title), into a ', BEFORE interpreting the content that can be a js code.
// Using the dol_escape_uri guarantee that we encode for URI so decode retrieve original expected value.
return 'javascript:'.dol_escape_uri('document_preview(\''.dol_escape_js($tmpurl).'\', \''.dol_escape_js(dol_mimetype($relativepath)).'\', \''.dol_escape_js($title).'\')');
} else {
return '';
}
}
/**
* Make content of an input box selected when we click into input field.
*
* @param int $idcode Id of special code
* @return string
*/
function getLabelSpecialCode($idcode)
{
global $langs;
$arrayspecialines = array(1 => 'Transport', 2 => 'EcoTax', 3 => 'Option');
if ($idcode > 10) {
return 'Module ID '.$idcode;
}
if (!empty($arrayspecialines[$idcode])) {
return $langs->trans($arrayspecialines[$idcode]);
}
return '';
}
/**
* Make content of an input box selected when we click into input field.
*
* @param string $htmlname Id of html object ('#idvalue' or '.classvalue')
* @param string $addlink Add a 'link to' after
* @param string $textonlink Text to show on link or 'image'
* @return string
*/
function ajax_autoselect($htmlname, $addlink = '', $textonlink = 'Link')
{
global $langs;
$out = '<script nonce="'.getNonce().'">
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;
}
/**
* Return if a file is qualified for preview
*
* @param string $file Filename we looking for information
* @return int<0,1> 1 If allowed, 0 otherwise
* @see dol_mimetype(), image_format_supported() from images.lib.php
*/
function dolIsAllowedForPreview($file)
{
// 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 (getDolGlobalString('MAIN_ALLOW_SVG_FILES_AS_IMAGES')) {
$mime_preview[] = 'svg+xml';
}
//$mime_preview[]='vnd.oasis.opendocument.presentation';
//$mime_preview[]='archive';
$num_mime = array_search(dol_mimetype($file, '', 1), $mime_preview);
if ($num_mime !== false) {
return 1;
}
// By default, not allowed for preview
return 0;
}
/**
* Return MIME type of a file from its name with extension.
*
* @param string $file Filename we looking for MIME type
* @param string $default Default mime type if extension not found in known list
* @param int<0,4> $mode 0=Return full mime, 1=otherwise short mime string, 2=image for mime type, 3=source language, 4=css of font fa
* @return string Return a mime type family (text/xxx, application/xxx, image/xxx, audio, video, archive)
* @see dolIsAllowedForPreview(), image_format_supported() from images.lib.php
*/
function dol_mimetype($file, $default = 'application/octet-stream', $mode = 0)
{
$mime = $default;
$imgmime = 'other.png';
$famime = 'file-o';
$srclang = '';
$tmpfile = preg_replace('/\.noexe$/', '', $file);
// Plain text files
if (preg_match('/\.txt$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$famime = 'file-alt';
} elseif (preg_match('/\.rtx$/i', $tmpfile)) {
$mime = 'text/richtext';
$imgmime = 'text.png';
$famime = 'file-alt';
} elseif (preg_match('/\.csv$/i', $tmpfile)) {
$mime = 'text/csv';
$imgmime = 'text.png';
$famime = 'file-csv';
} elseif (preg_match('/\.tsv$/i', $tmpfile)) {
$mime = 'text/tab-separated-values';
$imgmime = 'text.png';
$famime = 'file-alt';
} elseif (preg_match('/\.(cf|conf|log)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$famime = 'file-alt';
} elseif (preg_match('/\.ini$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'ini';
$famime = 'file-alt';
} elseif (preg_match('/\.md$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'md';
$famime = 'file-alt';
} elseif (preg_match('/\.css$/i', $tmpfile)) {
$mime = 'text/css';
$imgmime = 'css.png';
$srclang = 'css';
$famime = 'file-alt';
} elseif (preg_match('/\.lang$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'lang';
$famime = 'file-alt';
} elseif (preg_match('/\.(crt|cer|key|pub)$/i', $tmpfile)) { // Certificate files
$mime = 'text/plain';
$imgmime = 'text.png';
$famime = 'file-alt';
} elseif (preg_match('/\.(html|htm|shtml)$/i', $tmpfile)) { // XML based (HTML/XML/XAML)
$mime = 'text/html';
$imgmime = 'html.png';
$srclang = 'html';
$famime = 'file-alt';
} elseif (preg_match('/\.(xml|xhtml)$/i', $tmpfile)) {
$mime = 'text/xml';
$imgmime = 'other.png';
$srclang = 'xml';
$famime = 'file-alt';
} elseif (preg_match('/\.xaml$/i', $tmpfile)) {
$mime = 'text/xml';
$imgmime = 'other.png';
$srclang = 'xaml';
$famime = 'file-alt';
} elseif (preg_match('/\.bas$/i', $tmpfile)) { // Languages
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'bas';
$famime = 'file-code';
} elseif (preg_match('/\.(c)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'c';
$famime = 'file-code';
} elseif (preg_match('/\.(cpp)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'cpp';
$famime = 'file-code';
} elseif (preg_match('/\.cs$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'cs';
$famime = 'file-code';
} elseif (preg_match('/\.(h)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'h';
$famime = 'file-code';
} elseif (preg_match('/\.(java|jsp)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'java';
$famime = 'file-code';
} elseif (preg_match('/\.php([0-9]{1})?$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'php.png';
$srclang = 'php';
$famime = 'file-code';
} elseif (preg_match('/\.phtml$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'php.png';
$srclang = 'php';
$famime = 'file-code';
} elseif (preg_match('/\.(pl|pm)$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'pl.png';
$srclang = 'perl';
$famime = 'file-code';
} elseif (preg_match('/\.sql$/i', $tmpfile)) {
$mime = 'text/plain';
$imgmime = 'text.png';
$srclang = 'sql';
$famime = 'file-code';
} elseif (preg_match('/\.js$/i', $tmpfile)) {
$mime = 'text/x-javascript';
$imgmime = 'jscript.png';
$srclang = 'js';
$famime = 'file-code';
} elseif (preg_match('/\.odp$/i', $tmpfile)) { // Open office
$mime = 'application/vnd.oasis.opendocument.presentation';
$imgmime = 'ooffice.png';
$famime = 'file-powerpoint';
} elseif (preg_match('/\.ods$/i', $tmpfile)) {
$mime = 'application/vnd.oasis.opendocument.spreadsheet';
$imgmime = 'ooffice.png';
$famime = 'file-excel';
} elseif (preg_match('/\.odt$/i', $tmpfile)) {
$mime = 'application/vnd.oasis.opendocument.text';
$imgmime = 'ooffice.png';
$famime = 'file-word';
} elseif (preg_match('/\.mdb$/i', $tmpfile)) { // MS Office
$mime = 'application/msaccess';
$imgmime = 'mdb.png';
$famime = 'file';
} elseif (preg_match('/\.doc[xm]?$/i', $tmpfile)) {
$mime = 'application/msword';
$imgmime = 'doc.png';
$famime = 'file-word';
} elseif (preg_match('/\.dot[xm]?$/i', $tmpfile)) {
$mime = 'application/msword';
$imgmime = 'doc.png';
$famime = 'file-word';
} elseif (preg_match('/\.xlt(x)?$/i', $tmpfile)) {
$mime = 'application/vnd.ms-excel';
$imgmime = 'xls.png';
$famime = 'file-excel';
} elseif (preg_match('/\.xla(m)?$/i', $tmpfile)) {
$mime = 'application/vnd.ms-excel';
$imgmime = 'xls.png';
$famime = 'file-excel';
} elseif (preg_match('/\.xls$/i', $tmpfile)) {
$mime = 'application/vnd.ms-excel';
$imgmime = 'xls.png';
$famime = 'file-excel';
} elseif (preg_match('/\.xls[bmx]$/i', $tmpfile)) {
$mime = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
$imgmime = 'xls.png';
$famime = 'file-excel';
} elseif (preg_match('/\.pps[mx]?$/i', $tmpfile)) {
$mime = 'application/vnd.ms-powerpoint';
$imgmime = 'ppt.png';
$famime = 'file-powerpoint';
} elseif (preg_match('/\.ppt[mx]?$/i', $tmpfile)) {
$mime = 'application/x-mspowerpoint';
$imgmime = 'ppt.png';
$famime = 'file-powerpoint';
} elseif (preg_match('/\.pdf$/i', $tmpfile)) { // Other
$mime = 'application/pdf';
$imgmime = 'pdf.png';
$famime = 'file-pdf';
} elseif (preg_match('/\.bat$/i', $tmpfile)) { // Scripts
$mime = 'text/x-bat';
$imgmime = 'script.png';
$srclang = 'dos';
$famime = 'file-code';
} elseif (preg_match('/\.sh$/i', $tmpfile)) {
$mime = 'text/x-sh';
$imgmime = 'script.png';
$srclang = 'bash';
$famime = 'file-code';
} elseif (preg_match('/\.ksh$/i', $tmpfile)) {
$mime = 'text/x-ksh';
$imgmime = 'script.png';
$srclang = 'bash';
$famime = 'file-code';
} elseif (preg_match('/\.bash$/i', $tmpfile)) {
$mime = 'text/x-bash';
$imgmime = 'script.png';
$srclang = 'bash';
$famime = 'file-code';
} elseif (preg_match('/\.ico$/i', $tmpfile)) { // Images
$mime = 'image/x-icon';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.(jpg|jpeg)$/i', $tmpfile)) {
$mime = 'image/jpeg';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.png$/i', $tmpfile)) {
$mime = 'image/png';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.gif$/i', $tmpfile)) {
$mime = 'image/gif';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.bmp$/i', $tmpfile)) {
$mime = 'image/bmp';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.(tif|tiff)$/i', $tmpfile)) {
$mime = 'image/tiff';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.svg$/i', $tmpfile)) {
$mime = 'image/svg+xml';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.webp$/i', $tmpfile)) {
$mime = 'image/webp';
$imgmime = 'image.png';
$famime = 'file-image';
} elseif (preg_match('/\.vcs$/i', $tmpfile)) { // Calendar
$mime = 'text/calendar';
$imgmime = 'other.png';
$famime = 'file-alt';
} elseif (preg_match('/\.ics$/i', $tmpfile)) {
$mime = 'text/calendar';
$imgmime = 'other.png';
$famime = 'file-alt';
} elseif (preg_match('/\.torrent$/i', $tmpfile)) { // Other
$mime = 'application/x-bittorrent';
$imgmime = 'other.png';
$famime = 'file-o';
} elseif (preg_match('/\.(mp3|ogg|au|wav|wma|mid)$/i', $tmpfile)) { // Audio
$mime = 'audio';
$imgmime = 'audio.png';
$famime = 'file-audio';
} elseif (preg_match('/\.mp4$/i', $tmpfile)) { // Video
$mime = 'video/mp4';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.ogv$/i', $tmpfile)) {
$mime = 'video/ogg';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.webm$/i', $tmpfile)) {
$mime = 'video/webm';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.avi$/i', $tmpfile)) {
$mime = 'video/x-msvideo';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.divx$/i', $tmpfile)) {
$mime = 'video/divx';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.xvid$/i', $tmpfile)) {
$mime = 'video/xvid';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.(wmv|mpg|mpeg)$/i', $tmpfile)) {
$mime = 'video';
$imgmime = 'video.png';
$famime = 'file-video';
} elseif (preg_match('/\.(zip|rar|gz|tgz|xz|z|cab|bz2|7z|tar|lzh|zst)$/i', $tmpfile)) { // Archive
// application/xxx where zzz is zip, ...
$mime = 'archive';
$imgmime = 'archive.png';
$famime = 'file-archive';
} elseif (preg_match('/\.(exe|com)$/i', $tmpfile)) { // Exe
$mime = 'application/octet-stream';
$imgmime = 'other.png';
$famime = 'file-o';
} elseif (preg_match('/\.(dll|lib|o|so|a)$/i', $tmpfile)) { // Lib
$mime = 'library';
$imgmime = 'library.png';
$famime = 'file-o';
} elseif (preg_match('/\.err$/i', $tmpfile)) { // phpcs:ignore
$mime = 'error';
$imgmime = 'error.png';
$famime = 'file-alt';
}
if ($famime == 'file-o') {
// file-o seems to not work in fontawesome 5
$famime = 'file';
}
// Return mimetype string
switch ((int) $mode) {
case 1:
$tmp = explode('/', $mime);
return (!empty($tmp[1]) ? $tmp[1] : $tmp[0]);
case 2:
return $imgmime;
case 3:
return $srclang;
case 4:
return $famime;
}
return $mime;
}
/**
* Return the value of a filed into a dictionary for the record $id.
* This also set all the values into a cache for a next search.
*
* @param string $tablename Name of table dictionary (without the MAIN_DB_PREFIX, example: 'c_holiday_types')
* @param string $field The name of field where to find the value to return
* @param int $id Id of line record
* @param bool $checkentity Add filter on entity
* @param string $rowidfield Name of the column rowid (to use for the filter on $id)
* @return string The value of field $field. This also set $dictvalues cache.
*/
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 '';
}
}
/**
* Return true if the color is light
*
* @param string $stringcolor String with hex (FFFFFF) or comma RGB ('255,255,255')
* @return int<-1,1> -1 : Error with argument passed |0 : color is dark | 1 : color is light
*/
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 to test if an entry is enabled or not
*
* @param int<0,1> $type_user 0=We test for internal user, 1=We test for external user
* @param array{enabled:int<0,1>,module?:string,perms:string} $menuentry Array for feature entry to test
* @param string[] $listofmodulesforexternal Array with list of modules allowed to external users
* @return int<0,2> 0=Hide, 1=Show, 2=Show gray
*/
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 && array_key_exists('module', $menuentry) && $menuentry['module']) {
$tmploops = explode('|', $menuentry['module']);
$found = 0;
foreach ($tmploops as $tmploop) {
if (in_array($tmploop, $listofmodulesforexternal)) {
$found++;
break;
}
}
if (!$found) {
return 0; // Entry is for menus all excluded to external users
}
}
if (!$menuentry['perms'] && $type_user) {
return 0; // No permissions and user is external
}
if (!$menuentry['perms'] && getDolGlobalString('MAIN_MENU_HIDE_UNAUTHORIZED')) {
return 0; // No permissions and option to hide when not allowed, even for internal user, is on
}
if (!$menuentry['perms']) {
return 2; // No permissions and user is external
}
return 1;
}
/**
* Round to next multiple.
*
* @param float $n Number to round up
* @param int $x Multiple. For example 60 to round up to nearest exact minute for a date with seconds.
* @return int Value rounded.
*/
function roundUpToNextMultiple($n, $x = 5)
{
$result = (ceil($n) % $x === 0) ? ceil($n) : (round(($n + $x / 2) / $x) * $x);
return (int) $result;
}
/**
* Function dolGetBadge
*
* @param string $label label of badge no html : use in alt attribute for accessibility
* @param string $html optional : label of badge with html
* @param string $type type of badge : Primary Secondary Success Danger Warning Info Light Dark status0 status1 status2 status3 status4 status5 status6 status7 status8 status9
* @param ''|'pill'|'dot' $mode Default '' , 'pill', 'dot'
* @param string $url the url for link
* @param array<string,mixed> $params Various params for future : recommended rather than adding more function arguments. array('attr'=>array('title'=>'abc'))
* @return string Html badge
*/
function dolGetBadge($label, $html = '', $type = 'primary', $mode = '', $url = '', $params = array())
{
$csstouse = 'badge';
$csstouse .= (!empty($mode) ? ' badge-'.$mode : '');
$csstouse .= (!empty($type) ? ' badge-'.$type : '');
$csstouse .= (empty($params['css']) ? '' : ' '.$params['css']);
$attr = array(
'class' => $csstouse
);
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('dolPrintHTMLForAttribute', $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.'>';
}
/**
* Output the badge of a status.
*
* @param string $statusLabel Label of badge no html : use in alt attribute for accessibility
* @param string $statusLabelShort Short label of badge no html
* @param string $html Optional : label of badge with html
* @param string $statusType status0 status1 status2 status3 status4 status5 status6 status7 status8 status9 : image name or badge name
* @param int<0,6> $displayMode 0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
* @param string $url The url for link
* @param array<string,mixed> $params Various params. Example: array('tooltip'=>'no|...', 'badgeParams'=>...)
* @return string Html status string
*/
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 (getDolGlobalString('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 (!getDolGlobalString('MAIN_STATUS_USES_IMAGES') && !empty($displayMode)) {
// Use new badge
$statusLabelShort = (empty($statusLabelShort) ? $statusLabel : $statusLabelShort);
$dolGetBadgeParams['attr']['class'] = 'badge-status';
if (empty($dolGetBadgeParams['attr']['title'])) {
$dolGetBadgeParams['attr']['title'] = empty($params['tooltip']) ? $statusLabel : ($params['tooltip'] != 'no' ? $params['tooltip'] : '');
} else { // If a title was forced from $params['badgeParams']['attr']['title'], we set the class to get it as a tooltip.
$dolGetBadgeParams['attr']['class'] .= ' classfortooltip';
// And if we use tooltip, we can output title in HTML @phan-suppress-next-line PhanTypeInvalidDimOffset
$dolGetBadgeParams['attr']['title'] = dol_htmlentitiesbr((string) $dolGetBadgeParams['attr']['title'], 1);
}
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) && $displayMode != 2) ? $statusLabel : (empty($statusLabelShort) ? $statusLabel : $statusLabelShort)), $html, $statusType, '', $url, $dolGetBadgeParams);
}
}
return $return;
}
/**
* Function dolGetButtonAction
*
* @param string $label Label or tooltip of button if $text is provided. Also used as tooltip in title attribute. Can be escaped HTML content or full simple text.
* @param string $text Optional : short label on button. Can be escaped HTML content or full simple text.
* @param string $actionType 'default', 'danger', 'email', 'clone', 'cancel', 'delete', ...
* @param string|array<int,array{lang:string,enabled:bool,perm:bool|int,label:string,url:string,urlroot?:string,isDropDown?:int<0,1>}> $url Url for link or array of subbutton description
* Example when an array is used:
* $arrayforbutaction = array(
* 10 => array('attr' => array('class'=>''), 'lang'=>'propal', 'enabled'=>isModEnabled("propal"), 'perm'=>$user->hasRight('propal', 'creer'), 'label' => 'AddProp', 'url'=>'/comm/propal/card.php?action=create&projectid='.$object->id.'&socid='.$object->socid),
* 20 => array('attr' => array('class'=>''), 'lang'=>'mymodule', 'enabled'=>isModEnabled("mymodule"), 'perm'=>$user->hasRight('mymodule', 'write'), 'label' => 'MyModuleAction', 'urlroot'=>dol_build_patch('/mymodule/mypage.php?action=create')),
* 30 => array('attr' => array('class'=>''), 'lang'=>'mymodule', 'enabled'=>isModEnabled("mymodule"), 'perm'=>$user->hasRight('mymodule', 'write'), 'label' => 'MyModuleOtherAction', 'urlraw' => '# || external Url || javascript: || tel: || mailto:' ),
* ); );
* @param string $id Attribute id of action button. Example 'action-delete'. This can be used for full ajax confirm if this code is reused into the ->formconfirm() method.
* @param bool|int $userRight User action right. Use 0 if user has no permission. It will add the message "No permission" on tooltip. Use -1 to have button not allowed without adding the message (because an explicit label is already set).
* // phpcs:disable
* @param array{confirm?:array{url?:string,title?:string,content?:string,use_unsecured_unescapedattr?:bool|string[],action-btn-label?:string,cancel-btn-label?:string,modal?:bool},attr?:array<string,mixed>,areDropdownButtons?:bool,backtopage?:string,lang?:string,enabled?:bool,perm?:int<0,1>,label?:string,url?:string,isDropdown?:int<0,1>,isDropDown?:int<0,1>} $params = [ // Various params for future : recommended rather than adding more function arguments
* 'attr' => [ // to add or override button attributes
* 'xxxxx' => '', // your xxxxx attribute you want
* 'class' => 'reposition', // to add more css class to the button class attribute
* 'classOverride' => '' // to replace class attribute of the button
* ],
* 'confirm' => [
* 'url' => 'http://', // Override Url to go when user click on action btn, if empty default url is $url.?confirm=yes, for no js compatibility use $url for fallback confirm.
* 'title' => '', // Override title of modal, if empty default title use "ConfirmBtnCommonTitle" lang key
* 'action-btn-label' => '', // Override label of action button, if empty default label use "Confirm" lang key
* 'cancel-btn-label' => '', // Override label of cancel button, if empty default label use "CloseDialog" lang key
* 'content' => '', // Override text of content, if empty default content use "ConfirmBtnCommonContent" lang key
* 'modal' => true, // true|false to display dialog as a modal (with dark background)
* 'isDropDown' => false, // true|false to display dialog as a dropdown list (css dropdown-item with dark background)
* ],
* ]
* // phpcs:enable
* @return string html button
*/
function dolGetButtonAction($label, $text = '', $actionType = 'default', $url = '', $id = '', $userRight = 1, $params = array())
{
global $hookmanager, $action, $object, $langs;
// If $url is an array, we must build a dropdown button or recursively iterate over each value
if (is_array($url)) {
// Loop on $url array to remove entries of disabled modules
foreach ($url as $key => $subbutton) {
if (isset($subbutton['enabled']) && empty($subbutton['enabled'])) {
unset($url[$key]);
}
}
$out = '';
if (array_key_exists('areDropdownButtons', $params) && $params["areDropdownButtons"] === false) { // @phan-suppress-current-line PhanTypeInvalidDimOffset
foreach ($url as $button) {
if (!empty($button['lang'])) {
$langs->load($button['lang']);
}
$label = $langs->trans($button['label']);
$text = $button['text'] ?? '';
$actionType = $button['actionType'] ?? '';
$tmpUrl = DOL_URL_ROOT.$button['url'].(empty($params['backtopage']) ? '' : '&backtopage='.urlencode($params['backtopage']));
$id = $button['id'] ?? '';
$userRight = $button['perm'] ?? 1;
$button['params'] = $button['params'] ?? []; // @phan-suppress-current-line PhanPluginDuplicateExpressionAssignmentOperation
$out .= dolGetButtonAction($label, $text, $actionType, $tmpUrl, $id, $userRight, $button['params']);
}
return $out;
}
if (count($url) > 1) {
$out .= '<div class="dropdown inline-block dropdown-holder">';
$out .= '<a style="margin-right: auto;" class="dropdown-toggle classfortooltip butAction'.($userRight ? '' : 'Refused').'" title="'.dol_escape_htmltag($label).'" data-toggle="dropdown">'.($text ? $text : $label).'</a>';
$out .= '<div class="dropdown-content">';
foreach ($url as $subbutton) {
if (!empty($subbutton['lang'])) {
$langs->load($subbutton['lang']);
}
if (!empty($subbutton['urlraw'])) {
$tmpurl = $subbutton['urlraw']; // Use raw url, no url completion, use only what developer send
} else {
$tmpurl = !empty($subbutton['urlroot']) ? $subbutton['urlroot'] : $subbutton['url'];
$tmpurl = dolCompletUrlForDropdownButton($tmpurl, $params, empty($subbutton['urlroot']));
}
$subbuttonparam = array();
if (!empty($subbutton['attr'])) {
$subbuttonparam['attr'] = $subbutton['attr'];
}
$subbuttonparam['isDropDown'] = (empty($params['isDropDown']) ? ($subbutton['isDropDown'] ?? false) : $params['isDropDown']);
$out .= dolGetButtonAction('', $langs->trans($subbutton['label']), 'default', $tmpurl, $subbutton['id'] ?? '', $subbutton['perm'], $subbuttonparam);
}
$out .= "</div>";
$out .= "</div>";
} else {
foreach ($url as $subbutton) { // Should loop on 1 record only
if (!empty($subbutton['lang'])) {
$langs->load($subbutton['lang']);
}
if (!empty($subbutton['urlraw'])) {
$tmpurl = $subbutton['urlraw']; // Use raw url, no url completion, use only what developer send
} else {
$tmpurl = !empty($subbutton['urlroot']) ? $subbutton['urlroot'] : $subbutton['url'];
$tmpurl = dolCompletUrlForDropdownButton($tmpurl, $params, empty($subbutton['urlroot']));
}
$out .= dolGetButtonAction('', $langs->trans($subbutton['label']), 'default', $tmpurl, '', $subbutton['perm'], $params);
}
}
return $out;
}
// Here, $url is a simple link
if (!empty($params['isDropdown']) || !empty($params['isDropDown'])) { // Use the dropdown-item style (not for action button)
$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) || $userRight < 0) {
$attr['class'] = 'butActionRefused';
$attr['href'] = '';
$attr['title'] = (($label && $text && $label != $text) ? $label : '');
$attr['title'] = ($attr['title'] ? $attr['title'] . (empty($userRight) ? '<br>' : '') : '').(empty($userRight) ? $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 disabled 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']);
}
$TCompiledAttr = array();
foreach ($attr as $key => $value) {
if (!empty($params['use_unsecured_unescapedattr']) && is_array($params['use_unsecured_unescapedattr']) && in_array($key, $params['use_unsecured_unescapedattr'])) {
// Not recommended
$value = dol_htmlentities($value, ENT_QUOTES | ENT_SUBSTITUTE);
} elseif ($key == 'href') {
$value = dolPrintHTMLForAttributeUrl($value);
} else {
$value = dolPrintHTMLForAttribute($value);
}
$TCompiledAttr[] = $key.'="'.$value.'"'; // $value has been escaped by the dolPrintHTMLForAttribute... just before
}
$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 . '><span class="textbutton">' . $text . '</span></' . $tag . '>';
} else {
return '<' . $tag . ' ' . $compiledAttributes . '><span class="textbutton">' . dol_escape_htmltag($text) . '</span></' . $tag . '>';
}
} else {
return $hookmanager->resPrint;
}
}
/**
* An function to complete dropdown url in dolGetButtonAction
*
* @param string $url the Url to complete
* @param array<string,mixed> $params params of dolGetButtonAction function
* @param bool $addDolUrlRoot to add root url
* @return string
*/
function dolCompletUrlForDropdownButton(string $url, array $params, bool $addDolUrlRoot = true)
{
if (empty($url)) {
return '';
}
$parsedUrl = parse_url($url);
if ((isset($parsedUrl['scheme']) && in_array($parsedUrl['scheme'], ['javascript', 'mailto', 'tel'])) || strpos($url, '#') === 0) {
return $url;
}
if (!empty($parsedUrl['query'])) {
// Use parse_str() function to parse the string passed via URL
parse_str($parsedUrl['query'], $urlQuery);
if (!isset($urlQuery['backtopage']) && isset($params['backtopage'])) {
$url .= '&backtopage='.urlencode($params['backtopage']);
}
}
if (!isset($parsedUrl['scheme']) && $addDolUrlRoot) {
$url = DOL_URL_ROOT.$url;
}
return $url;
}
/**
* Add space between dolGetButtonTitle
*
* @param string $moreClass more css class label
* @return string html of title separator
*/
function dolGetButtonTitleSeparator($moreClass = "")
{
return '<span class="button-title-separator '.$moreClass.'" ></span>';
}
/**
* get field error icon
*
* @param string $fieldValidationErrorMsg Message to add in tooltip
* @return string html output
*/
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 : this kind of buttons are used in title in list
*
* @param string $label label of button
* @param string $helpText optional : content for help tooltip
* @param string $iconClass class for icon element (Example: 'fa fa-file')
* @param string $url the url for link
* @param string $id attribute id of button
* @param int<-2,2> $status 0 no user rights, 1 active, 2 current action or selected, -1 Feature Disabled (deprecated, use -2 instead), -2 disable Other reason use param $helpText as tooltip help
* @param array<string,mixed> $params various parameters for future : recommended rather than adding more function arguments
* @return string html button
*/
function dolGetButtonTitle($label, $helpText = '', $iconClass = 'fa fa-file', $url = '', $id = '', $status = 1, $params = array())
{
global $langs, $user;
// Actually this conf is used in css too for external module compatibility and smooth transition to this function
if (getDolGlobalString('MAIN_BUTTON_HIDE_UNAUTHORIZED') && (!$user->admin) && $status <= 0) {
return '';
}
// Fix old picto fa-th-list to use fa-grid-vertical instead
if ($iconClass == 'fa fa-th-list imgforviewmode') {
$iconClass = ' fa fa-grip-horizontal imgforviewmode';
}
$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'] = $helpText;
} elseif ($label) { // empty($attr['title']) &&
$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'] = $langs->transnoentitiesnoconv("FeatureDisabled");
} elseif ($status == 0) { // Not enough permissions
$attr['title'] = $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
// Generate attributes with escapement
$TCompiledAttr = array();
foreach ($attr as $key => $value) {
$TCompiledAttr[] = $key.'="'.dol_escape_htmltag($value).'"'; // Do not use dolPrintHTMLForAttribute() here, we must accept "javascript:string"
}
$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;
}
/**
* Get an array with properties of an element.
*
* @param string $elementType Element type (Value of $object->element or value of $object->element@$object->module). Example:
* 'action', 'facture', 'project', 'project_task' or
* 'myobject@mymodule' (or old syntax 'mymodule_myobject' like 'project_task')
* @return array{module:string,element:string,table_element:string,subelement:string,classpath:string,classfile:string,classname:string,dir_output:string,dir_temp:string,parent_element:string} array('module'=>, 'classpath'=>, 'element'=>, 'subelement'=>, 'classfile'=>, 'classname'=>, 'dir_output'=>, 'dir_temp'=>)
* @see fetchObjectByElement(), getMultidirOutput()
*/
function getElementProperties($elementType)
{
global $conf, $db, $hookmanager;
$regs = array();
//$element_type='facture';
$classfile = $classname = $classpath = $subdir = $dir_output = $dir_temp = $parent_element = '';
// Parse element/subelement
$module = $elementType;
$element = $elementType;
$subelement = $elementType;
$table_element = $elementType;
// If we ask a resource form external module (instead of default path)
if (preg_match('/^([^@]+)@([^@]+)$/i', $elementType, $regs)) { // 'myobject@mymodule'
$element = $subelement = $regs[1];
$module = $regs[2];
}
// If we ask a resource for a string with an element and a subelement
// Example 'project_task'
if (preg_match('/^([^_]+)_([^_]+)/i', $element, $regs)) { // 'myobject_mysubobject' with myobject=mymodule
$module = $element = $regs[1];
$subelement = $regs[2];
}
// Object lines will use parent classpath and module ref
if (substr($elementType, -3) == 'det') {
$module = preg_replace('/det$/', '', $element);
$subelement = preg_replace('/det$/', '', $subelement);
$classpath = $module.'/class';
$classfile = $module;
$classname = preg_replace('/det$/', 'Line', $element);
if (in_array($module, array('expedition', 'propale', 'facture', 'contrat', 'fichinter', 'commandefournisseur'))) {
$classname = preg_replace('/det$/', 'Ligne', $element);
}
}
// For compatibility and to work with non standard path
if ($elementType == "action" || $elementType == "actioncomm") {
$classpath = 'comm/action/class';
$subelement = 'Actioncomm';
$module = 'agenda';
$table_element = 'actioncomm';
} elseif ($elementType == 'cronjob') {
$classpath = 'cron/class';
$module = 'cron';
$table_element = 'cron';
} elseif ($elementType == 'adherent_type') {
$classpath = 'adherents/class';
$classfile = 'adherent_type';
$module = 'adherent';
$subelement = 'adherent_type';
$classname = 'AdherentType';
$table_element = 'adherent_type';
} elseif ($elementType == 'bank_account') {
$classpath = 'compta/bank/class';
$module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
$classfile = 'account';
$classname = 'Account';
} elseif ($elementType == 'bank_line') {
$classpath = 'compta/bank/class';
$module = 'bank'; // We need $conf->bank->dir_output and not $conf->banque->dir_output
$classfile = 'account';
$classname = 'AccountLine';
} elseif ($elementType == 'category') {
$classpath = 'categories/class';
$module = 'categorie';
$subelement = 'categorie';
$table_element = 'categorie';
} elseif ($elementType == 'contact') {
$classpath = 'contact/class';
$classfile = 'contact';
$module = 'societe';
$subelement = 'contact';
$table_element = 'socpeople';
} elseif ($elementType == 'inventory') {
$module = 'product';
$classpath = 'product/inventory/class';
} elseif ($elementType == 'inventoryline') {
$module = 'product';
$classpath = 'product/inventory/class';
$table_element = 'inventorydet';
$parent_element = 'inventory';
} elseif ($elementType == 'stock' || $elementType == 'entrepot' || $elementType == 'warehouse') {
$module = 'stock';
$classpath = 'product/stock/class';
$classfile = 'entrepot';
$classname = 'Entrepot';
$table_element = 'entrepot';
} elseif ($elementType == 'project') {
$classpath = 'projet/class';
$module = 'projet';
$table_element = 'projet';
} elseif ($elementType == 'project_task') {
$classpath = 'projet/class';
$module = 'projet';
$subelement = 'task';
$table_element = 'projet_task';
} elseif ($elementType == 'facture' || $elementType == 'invoice') {
$classpath = 'compta/facture/class';
$module = 'facture';
$subelement = 'facture';
$table_element = 'facture';
} elseif ($elementType == 'facturedet') {
$classpath = 'compta/facture/class';
$classfile = 'facture';
$classname = 'FactureLigne';
$module = 'facture';
$table_element = 'facturedet';
$parent_element = 'facture';
} elseif ($elementType == 'facturerec') {
$classpath = 'compta/facture/class';
$classfile = 'facture-rec';
$module = 'facture';
$classname = 'FactureRec';
} elseif ($elementType == 'commande' || $elementType == 'order') {
$classpath = 'commande/class';
$module = 'commande';
$subelement = 'commande';
$table_element = 'commande';
} elseif ($elementType == 'commandedet') {
$classpath = 'commande/class';
$classfile = 'commande';
$classname = 'OrderLine';
$module = 'commande';
$table_element = 'commandedet';
$parent_element = 'commande';
} elseif ($elementType == 'propal') {
$classpath = 'comm/propal/class';
$table_element = 'propal';
} elseif ($elementType == 'propaldet') {
$classpath = 'comm/propal/class';
$classfile = 'propal';
$subelement = 'propaleligne';
$module = 'propal';
$table_element = 'propaldet';
$parent_element = 'propal';
} elseif ($elementType == 'shipping') {
$classpath = 'expedition/class';
$classfile = 'expedition';
$classname = 'Expedition';
$module = 'expedition';
$table_element = 'expedition';
} elseif ($elementType == 'expeditiondet' || $elementType == 'shippingdet') {
$classpath = 'expedition/class';
$classfile = 'expedition';
$classname = 'ExpeditionLigne';
$module = 'expedition';
$table_element = 'expeditiondet';
$parent_element = 'expedition';
} elseif ($elementType == 'delivery_note') {
$classpath = 'delivery/class';
$subelement = 'delivery';
$module = 'expedition';
} elseif ($elementType == 'delivery') {
$classpath = 'delivery/class';
$subelement = 'delivery';
$module = 'expedition';
} elseif ($elementType == 'deliverydet') {
// @todo
} elseif ($elementType == 'supplier_proposal') {
$classpath = 'supplier_proposal/class';
$module = 'supplier_proposal';
$element = 'supplierproposal';
$classfile = 'supplier_proposal';
$subelement = 'supplierproposal';
} elseif ($elementType == 'supplier_proposaldet') {
$classpath = 'supplier_proposal/class';
$module = 'supplier_proposal';
$classfile = 'supplier_proposal';
$classname = 'SupplierProposalLine';
$table_element = 'supplier_proposaldet';
$parent_element = 'supplier_proposal';
} elseif ($elementType == 'contract') {
$classpath = 'contrat/class';
$module = 'contrat';
$subelement = 'contrat';
$table_element = 'contract';
} elseif ($elementType == 'contratdet') {
$classpath = 'contrat/class';
$module = 'contrat';
$table_element = 'contratdet';
$parent_element = 'contrat';
} elseif ($elementType == 'mailing') {
$classpath = 'comm/mailing/class';
$module = 'mailing';
$classfile = 'mailing';
$classname = 'Mailing';
$subelement = '';
} elseif ($elementType == 'member' || $elementType == 'adherent') {
$classpath = 'adherents/class';
$module = 'adherent';
$subelement = 'adherent';
$table_element = 'adherent';
} elseif ($elementType == 'subscription') {
$classpath = 'adherents/class';
$classfile = 'subscription';
$module = 'adherent';
$subelement = 'subscription';
$classname = 'Subscription';
$table_element = 'subscription';
} elseif ($elementType == 'usergroup') {
$classpath = 'user/class';
$module = 'user';
} elseif ($elementType == 'mo') {
$classpath = 'mrp/class';
$classfile = 'mo';
$classname = 'Mo';
$module = 'mrp';
$subelement = '';
$table_element = 'mrp_mo';
} elseif ($elementType == 'mrp_production') {
$classpath = 'mrp/class';
$classfile = 'mo';
$classname = 'MoLine';
$module = 'mrp';
$subelement = '';
$table_element = 'mrp_production';
$parent_element = 'mo';
} elseif ($elementType == 'cabinetmed_cons') {
$classpath = 'cabinetmed/class';
$module = 'cabinetmed';
$subelement = 'cabinetmedcons';
$table_element = 'cabinetmedcons';
} elseif ($elementType == 'fichinter') {
$classpath = 'fichinter/class';
$module = 'ficheinter';
$subelement = 'fichinter';
$table_element = 'fichinter';
} elseif ($elementType == 'dolresource' || $elementType == 'resource') {
$classpath = 'resource/class';
$module = 'resource';
$subelement = 'dolresource';
$table_element = 'resource';
} elseif ($elementType == 'opensurvey_sondage') {
$classpath = 'opensurvey/class';
$module = 'opensurvey';
$subelement = 'opensurveysondage';
} elseif ($elementType == 'order_supplier' || $elementType == 'supplier_order' ||$elementType == 'commande_fournisseur' || $elementType == 'commandefournisseur') {
$classpath = 'fourn/class';
$module = 'fournisseur';
$classfile = 'fournisseur.commande';
$element = 'order_supplier';
$subelement = '';
$classname = 'CommandeFournisseur';
$table_element = 'commande_fournisseur';
} elseif ($elementType == 'commande_fournisseurdet') {
$classpath = 'fourn/class';
$module = 'fournisseur';
$classfile = 'fournisseur.commande';
$element = 'commande_fournisseurdet';
$subelement = '';
$classname = 'CommandeFournisseurLigne';
$table_element = 'commande_fournisseurdet';
$parent_element = 'commande_fournisseur';
} elseif ($elementType == 'invoice_supplier' || $elementType == 'supplier_invoice' || $elementType == 'facture_fourn') {
$classpath = 'fourn/class';
$module = 'fournisseur';
$classfile = 'fournisseur.facture';
$element = 'invoice_supplier';
$subelement = '';
$classname = 'FactureFournisseur';
$table_element = 'facture_fourn';
} elseif ($elementType == 'facture_fourn_det') {
$classpath = 'fourn/class';
$module = 'fournisseur';
$classfile = 'fournisseur.facture';
$element = 'facture_fourn_det';
$subelement = '';
$classname = 'SupplierInvoiceLine';
$table_element = 'facture_fourn_det';
$parent_element = 'invoice_supplier';
} elseif ($elementType == "service") {
$classpath = 'product/class';
$subelement = 'product';
$table_element = 'product';
} elseif ($elementType == 'salary') {
$classpath = 'salaries/class';
$module = 'salaries';
} elseif ($elementType == 'payment_salary') {
$classpath = 'salaries/class';
$classfile = 'paymentsalary';
$classname = 'PaymentSalary';
$module = 'salaries';
} elseif ($elementType == 'productlot') {
$module = 'productbatch';
$classpath = 'product/stock/class';
$classfile = 'productlot';
$classname = 'Productlot';
$element = 'productlot';
$subelement = '';
$table_element = 'product_lot';
} elseif ($elementType == 'societeaccount') {
$classpath = 'societe/class';
$classfile = 'societeaccount';
$classname = 'SocieteAccount';
$module = 'societe';
} elseif ($elementType == 'websitepage' || $elementType == 'website_page') {
$classpath = 'website/class';
$classfile = 'websitepage';
$classname = 'Websitepage';
$module = 'website';
$subelement = 'websitepage';
$table_element = 'website_page';
} elseif ($elementType == 'fiscalyear') {
$classpath = 'core/class';
$module = 'accounting';
$subelement = 'fiscalyear';
} elseif ($elementType == 'chargesociales') {
$classpath = 'compta/sociales/class';
$module = 'tax';
$table_element = 'chargesociales';
} elseif ($elementType == 'tva') {
$classpath = 'compta/tva/class';
$module = 'tax';
$subdir = '/vat';
$table_element = 'tva';
} elseif ($elementType == 'emailsenderprofile') {
$module = '';
$classpath = 'core/class';
$classfile = 'emailsenderprofile';
$classname = 'EmailSenderProfile';
$table_element = 'c_email_senderprofile';
$subelement = '';
} elseif ($elementType == 'conferenceorboothattendee') {
$classpath = 'eventorganization/class';
$classfile = 'conferenceorboothattendee';
$classname = 'ConferenceOrBoothAttendee';
$module = 'eventorganization';
} elseif ($elementType == 'conferenceorbooth') {
$classpath = 'eventorganization/class';
$classfile = 'conferenceorbooth';
$classname = 'ConferenceOrBooth';
$module = 'eventorganization';
} elseif ($elementType == 'ccountry') {
$module = '';
$classpath = 'core/class';
$classfile = 'ccountry';
$classname = 'Ccountry';
$table_element = 'c_country';
$subelement = '';
} elseif ($elementType == 'ecmfiles') {
$module = 'ecm';
$classpath = 'ecm/class';
$classfile = 'ecmfiles';
$classname = 'Ecmfiles';
$table_element = 'ecmfiles';
$subelement = '';
} elseif ($elementType == 'knowledgerecord' || $elementType == 'knowledgemanagement') {
$module = 'knowledgemanagement';
$classpath = 'knowledgemanagement/class';
$classfile = 'knowledgerecord';
$classname = 'KnowledgeRecord';
$table_element = 'knowledgemanagement_knowledgerecord';
$subelement = '';
} elseif ($elementType == 'customer') {
$module = 'societe';
$classpath = 'societe/class';
$classfile = 'client';
$classname = 'Client';
$table_element = 'societe';
$subelement = '';
} elseif ($elementType == 'fournisseur' || $elementType == 'supplier') {
$module = 'societe';
$classpath = 'fourn/class';
$classfile = 'fournisseur';
$classname = 'Fournisseur';
$table_element = 'societe';
$subelement = '';
}
if (empty($classfile)) {
$classfile = strtolower($subelement);
}
if (empty($classname)) {
$classname = ucfirst($subelement);
}
if (empty($classpath)) {
$classpath = $module.'/class';
}
//print 'getElementProperties subdir='.$subdir;
// Set dir_output
if ($module && isset($conf->$module)) { // The generic case
if (!empty($conf->$module->multidir_output[$conf->entity])) {
$dir_output = $conf->$module->multidir_output[$conf->entity];
} elseif (!empty($conf->$module->output[$conf->entity])) {
$dir_output = $conf->$module->output[$conf->entity];
} elseif (!empty($conf->$module->dir_output)) {
$dir_output = $conf->$module->dir_output;
}
if (!empty($conf->$module->multidir_temp[$conf->entity])) {
$dir_temp = $conf->$module->multidir_temp[$conf->entity];
} elseif (!empty($conf->$module->temp[$conf->entity])) {
$dir_temp = $conf->$module->temp[$conf->entity];
} elseif (!empty($conf->$module->dir_temp)) {
$dir_temp = $conf->$module->dir_temp;
}
}
// Overwrite value for special cases
if ($element == 'order_supplier' && isModEnabled('fournisseur')) {
$dir_output = $conf->fournisseur->commande->dir_output;
$dir_temp = $conf->fournisseur->commande->dir_temp;
} elseif ($element == 'invoice_supplier' && isModEnabled('fournisseur')) {
$dir_output = $conf->fournisseur->facture->dir_output;
$dir_temp = $conf->fournisseur->facture->dir_temp;
}
$dir_output .= $subdir;
$dir_temp .= $subdir;
$elementProperties = array(
'module' => $module,
'element' => $element,
'table_element' => $table_element,
'subelement' => $subelement,
'classpath' => $classpath,
'classfile' => $classfile,
'classname' => $classname,
'dir_output' => $dir_output,
'dir_temp' => $dir_temp,
'parent_element' => $parent_element,
);
// Add hook
if (!is_object($hookmanager)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($db);
}
$hookmanager->initHooks(array('elementproperties'));
// Hook params
$parameters = array(
'elementType' => $elementType,
'elementProperties' => $elementProperties
);
$reshook = $hookmanager->executeHooks('getElementProperties', $parameters);
if ($reshook) {
$elementProperties = $hookmanager->resArray;
} elseif (!empty($hookmanager->resArray) && is_array($hookmanager->resArray)) { // resArray is always an array but for sécurity against misconfigured external modules
$elementProperties = array_replace($elementProperties, $hookmanager->resArray);
}
// context of elementproperties doesn't need to exist out of this function so delete it to avoid elementproperties context is equal to all
if (($key = array_search('elementproperties', $hookmanager->contextarray)) !== false) {
unset($hookmanager->contextarray[$key]);
}
return $elementProperties;
}
/**
* Fetch an object from its id and element_type
* Inclusion of classes is automatic
*
* @param int $element_id Element id (Use this or element_ref but not both. If id and ref are empty, object with no fetch is returned)
* @param string $element_type Element type ('module' or 'myobject@mymodule' or 'mymodule_myobject')
* @param string $element_ref Element ref (Use this or element_id but not both. If id and ref are empty, object with no fetch is returned)
* @param int<0,2> $useCache If you want to store object in cache or get it from cache 0 => no use cache , 1 use cache, 2 force reload cache
* @param int $maxCacheByType Number of object in cache for this element type
* @return int<-1,0>|CommonObject object || 0 || <0 if error
* @see getElementProperties()
*/
function fetchObjectByElement($element_id, $element_type, $element_ref = '', $useCache = 0, $maxCacheByType = 10)
{
global $db, $conf;
$ret = 0;
$element_prop = getElementProperties($element_type);
if ($element_prop['module'] == 'product' || $element_prop['module'] == 'service') {
// For example, for an extrafield 'product' (shared for both product and service) that is a link to an object,
// this is called with $element_type = 'product' when we need element properties of a service, we must return a product. If we create the
// extrafield for a service, it is not supported and not found when editing the product/service card. So we must keep 'product' for extrafields
// of service and we will return properties of a product.
$ismodenabled = (isModEnabled('product') || isModEnabled('service'));
} elseif ($element_prop['module'] == 'societeaccount') {
$ismodenabled = isModEnabled('website') || isModEnabled('webportal');
} else {
$ismodenabled = isModEnabled($element_prop['module']);
}
//var_dump('element_type='.$element_type);
//var_dump($element_prop);
//var_dump($element_prop['module'].' '.$ismodenabled);
if (is_array($element_prop) && (empty($element_prop['module']) || $ismodenabled)) {
if ($useCache === 1
&& !empty($conf->cache['fetchObjectByElement'][$element_type])
&& !empty($conf->cache['fetchObjectByElement'][$element_type][$element_id])
&& is_object($conf->cache['fetchObjectByElement'][$element_type][$element_id])
) {
return $conf->cache['fetchObjectByElement'][$element_type][$element_id];
}
dol_include_once('/'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
if (class_exists($element_prop['classname'])) {
$className = $element_prop['classname'];
$objecttmp = new $className($db);
'@phan-var-force CommonObject $objecttmp';
if ($element_id > 0 || !empty($element_ref)) {
$ret = $objecttmp->fetch($element_id, $element_ref);
if ($ret >= 0) {
if (empty($objecttmp->module)) {
$objecttmp->module = $element_prop['module'];
}
if ($useCache > 0) {
if (!isset($conf->cache['fetchObjectByElement'][$element_type])) {
$conf->cache['fetchObjectByElement'][$element_type] = [];
}
// Manage cache limit
if (! empty($conf->cache['fetchObjectByElement'][$element_type]) && is_array($conf->cache['fetchObjectByElement'][$element_type]) && count($conf->cache['fetchObjectByElement'][$element_type]) >= $maxCacheByType) {
array_shift($conf->cache['fetchObjectByElement'][$element_type]);
}
$conf->cache['fetchObjectByElement'][$element_type][$element_id] = $objecttmp;
}
return $objecttmp;
}
} else {
return $objecttmp; // returned an object without fetch
}
} else {
dol_syslog($element_prop['classname'].' doesn\'t exists in /'.$element_prop['classpath'].'/'.$element_prop['classfile'].'.class.php');
return -1;
}
}
return $ret;
}
/**
* Return array of extension for executable files of text files that can contains executable code.
*
* @return string[] Array of extensions
*/
function getExecutableContent()
{
$arrayofregexextension = array(
'htm', 'html', 'shtml', 'js', 'phar', 'php', 'php3', 'php4', 'php5', 'phtml', 'pht', 'pl', 'py', 'cgi', 'ksh', 'sh', 'shtml',
'bash', 'bat', 'cmd', 'wpk', 'exe', 'dmg', 'appimage'
);
return $arrayofregexextension;
}
/**
* Return if a file can contains executable content
*
* @param string $filename File name to test
* @return boolean True if yes, False if no
*/
function isAFileWithExecutableContent($filename)
{
$arrayofregexextension = getExecutableContent();
foreach ($arrayofregexextension as $fileextension) {
if (preg_match('/\.'.preg_quote($fileextension, '/').'$/i', $filename)) {
return true;
}
}
return false;
}
/**
* Return the value of token currently saved into session with name 'newtoken'.
* This token must be send by any POST as it will be used by next page for comparison with value in session.
*
* @since Dolibarr v10.0.7
* @return string
*/
function newToken()
{
return empty($_SESSION['newtoken']) ? '' : $_SESSION['newtoken'];
}
/**
* Return the value of token currently saved into session with name 'token'.
* For ajax call, you must use this token as a parameter of the call into the js calling script (the called ajax php page must also set constant NOTOKENRENEWAL).
*
* @since Dolibarr v10.0.7
* @return string
*/
function currentToken()
{
return isset($_SESSION['token']) ? $_SESSION['token'] : '';
}
/**
* Return a random string to be used as a nonce value for js
*
* @return string
*/
function getNonce()
{
global $conf;
if (empty($conf->cache['nonce'])) {
$conf->cache['nonce'] = dolGetRandomBytes(8);
}
return $conf->cache['nonce'];
}
/**
* Start a table with headers and a optional clickable number (don't forget to use "finishSimpleTable()" after the last table row)
*
* @param string $header The first left header of the table (automatic translated)
* @param string $link (optional) The link to a internal dolibarr page, where to go on clicking on the number or the ... (without the first "/")
* @param string $arguments (optional) Additional arguments for the link (e.g. "search_status=0")
* @param integer $emptyColumns (optional) Number of empty columns to add after the first column
* @param integer $number (optional) The number that is shown right after the first header, when -1 the link is shown as '...'
* @param string $pictofulllist (optional) The picto to use for the full list link
* @return void
*
* @see finishSimpleTable()
*/
function startSimpleTable($header, $link = "", $arguments = "", $emptyColumns = 0, $number = -1, $pictofulllist = '')
{
global $langs;
print '<div class="div-table-responsive-no-min">';
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print ($emptyColumns < 1) ? '<th>' : '<th colspan="'.($emptyColumns + 1).'">';
print '<span class="valignmiddle">'.$langs->trans($header).'</span>';
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 marginleftonlyshort">'.$number.'</span>';
} elseif (!empty($link)) {
print '<span class="badge marginleftonlyshort">...</span>';
}
if (!empty($link)) {
print '</a>';
}
print '</th>';
if ($number < 0 && !empty($link)) {
print '<th class="right">';
print '</th>';
}
print '</tr>';
}
/**
* Add the correct HTML close tags for "startSimpleTable(...)" (use after the last table line)
*
* @param bool $addLineBreak (optional) Add a extra line break after the complete table (\<br\>)
* @return void
*
* @see startSimpleTable()
*/
function finishSimpleTable($addLineBreak = false)
{
print '</table>';
print '</div>';
if ($addLineBreak) {
print '<br>';
}
}
/**
* Add a summary line to the current open table ("None", "XMoreLines" or "Total xxx")
*
* @param integer $tableColumnCount The complete count columns of the table
* @param integer $num The count of the rows of the table, when it is zero (0) the "$noneWord" is shown instead
* @param integer $nbofloop (optional) The maximum count of rows thaht the table show (when it is zero (0) no summary line will show, expect "$noneWord" when $num === 0)
* @param integer $total (optional) The total value thaht is shown after when the table has minimum of one entire
* @param string $noneWord (optional) The word that is shown when the table has no entries ($num === 0)
* @param bool $extraRightColumn (optional) Add a additional column after the summary word and total number
* @return void
*/
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.'"><span class="opacitymedium">'.$langs->trans($noneWord).'</span></td>';
print '</tr>';
return;
}
if ($nbofloop === 0) {
// don't show a summary line
return;
}
/* Case already handled above, commented to satisfy phpstan.
if ($num === 0) {
$colspan = $tableColumnCount;
} else
*/
if ($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 centpercent">'.price($total).'</td>';
}
if ($extraRightColumn) {
print '<td></td>';
}
print '</tr>';
}
/**
* Return a file on output using a low memory. It can return very large files with no need of memory.
* WARNING: This close output buffers.
*
* @param string $fullpath_original_file_osencoded Full path of file to return.
* @param int<-1,2> $method -1 automatic, 0=readfile, 1=fread, 2=stream_copy_to_stream
* @return void
*/
function readfileLowMemory($fullpath_original_file_osencoded, $method = -1)
{
if ($method == -1) {
$method = 0;
if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_FREAD')) {
$method = 1;
}
if (getDolGlobalString('MAIN_FORCE_READFILE_WITH_STREAM_COPY')) {
$method = 2;
}
}
// Be sure we don't have output buffering enabled to have readfile working correctly
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);
}
}
/**
* Create a button to copy $valuetocopy in the clipboard (for copy and paste feature).
* Code that handle the click is inside core/js/lib_foot.js.php.
*
* @param string $valuetocopy The value to print
* @param int<0,1> $showonlyonhover Show the copy-paste button only on hover
* @param string $texttoshow Replace the value to show with this text. Use 'none' to show no text (only the copy-paste picto)
* @return string The string to print for the button
*/
function showValueWithClipboardCPButton($valuetocopy, $showonlyonhover = 1, $texttoshow = '')
{
global $langs;
$tag = 'span'; // Using div (like any style of type 'block') does not work when using the js copy code.
$result = '<span class="clipboardCP'.($showonlyonhover ? ' clipboardCPShowOnHover' : '').'">';
if ($texttoshow === 'none') {
$result .= '<'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'>';
$result .= '<span class="clipboardCPValueToPrint"></span>';
} elseif ($texttoshow) {
$result .= '<'.$tag.' class="clipboardCPValue hidewithsize">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'>';
$result .= '<span class="clipboardCPValueToPrint">'.dol_escape_htmltag($texttoshow, 1, 1).'</span>';
} else {
$result .= '<'.$tag.' class="clipboardCPValue">'.dol_escape_htmltag($valuetocopy, 1, 1).'</'.$tag.'>';
}
$result .= '<span class="clipboardCPButton far fa-clipboard opacitymedium paddingleft pictomodule" title="'.dolPrintHTML($langs->trans("ClickToCopyToClipboard")).'"></span>';
$result .= img_picto('', 'tick', 'class="clipboardCPTick hidden paddingleft pictomodule"');
$result .= '<span class="clipboardCPText"></span>';
$result .= '</span>';
return $result;
}
/**
* Decode an encode string. The string can be encoded in json format (recommended) or with serialize (avoid this)
*
* @param string $stringtodecode String to decode (json or serialize coded)
* @return mixed The decoded object.
*/
function jsonOrUnserialize($stringtodecode)
{
$result = json_decode($stringtodecode);
if ($result === null) {
$result = unserialize($stringtodecode);
}
return $result;
}
/**
* forgeSQLFromUniversalSearchCriteria
*
* @param ?string $filter String with universal search string. Must be '(aaa:bbb:ccc) OR (ddd:eeee:fff) ...' with
* aaa is a field name (with alias or not) and
* bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'.
* ccc must not contains ( or )
* Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a%')'
* @param string $errorstr Error message string
* @param int<0,1> $noand 1=Do not add the AND before the condition string.
* @param int<0,1> $nopar 1=Do not add the parenthesis around the final condition string.
* @param int<0,1> $noerror 1=If search criteria is not valid, does not return an error string but invalidate the SQL
* @return string Return forged SQL string
* @see dolSqlDateFilter()
* @see natural_search()
*/
function forgeSQLFromUniversalSearchCriteria($filter, &$errorstr = '', $noand = 0, $nopar = 0, $noerror = 0)
{
global $db, $user;
if (is_null($filter) || !is_string($filter) || $filter === '') {
return '';
}
if (!preg_match('/^\(.*\)$/', $filter)) { // If $filter does not start and end with ()
$filter = '(' . $filter . ')';
}
$regexstring = '\(([a-zA-Z0-9_\.]+:[<>!=insotlke]+:[^\(\)]+)\)'; // Must be (aaa:bbb:...) with aaa is a field name (with alias or not) and bbb is one of this operator '=', '<', '>', '<=', '>=', '!=', 'in', 'notin', 'like', 'notlike', 'is', 'isnot'
$firstandlastparenthesis = 0;
if (!dolCheckFilters($filter, $errorstr, $firstandlastparenthesis)) {
if ($noerror) {
return '1 = 2';
} else {
return 'Filter syntax error - '.$errorstr; // Bad balance of parenthesis, we return an error message or force a SQL not found
}
}
// Test the filter syntax
$t = preg_replace_callback('/'.$regexstring.'/i', 'dolForgeDummyCriteriaCallback', $filter);
$t = str_ireplace(array('and', 'or', ' '), '', $t); // Remove the only strings allowed between each () criteria
// If the string result contains something else than '()', the syntax was wrong
if (preg_match('/[^\(\)]/', $t)) {
$tmperrorstr = 'Bad syntax of the search string';
$errorstr = 'Bad syntax of the search string: '.$filter;
if ($noerror) {
return '1 = 2';
} else {
dol_syslog("forgeSQLFromUniversalSearchCriteria Filter error - ".$errorstr, LOG_WARNING);
return 'Filter error - '.$tmperrorstr; // Bad syntax of the search string, we return an error message or force a SQL not found
}
}
$ret = ($noand ? "" : " AND ").($nopar ? "" : '(').preg_replace_callback('/'.$regexstring.'/i', 'dolForgeSQLCriteriaCallback', $filter).($nopar ? "" : ')');
if (is_object($db)) {
$ret = str_replace('__NOW__', "'".$db->idate(dol_now())."'", $ret);
}
if (is_object($user)) {
$ret = str_replace('__USER_ID__', (string) $user->id, $ret);
}
return $ret;
}
/**
* Explode an universal search string with AND parts.
* This is used to output the search criteria in an UFS (Universal Filter Syntax) input component.
*
* @param string $sqlfilters Universal SQL filter string. Must have been trimmed before.
* @return string[] Array of AND
*/
function dolForgeExplodeAnd($sqlfilters)
{
$arrayofandtags = array();
$nbofchars = dol_strlen($sqlfilters);
$error = '';
$parenthesislevel = 0;
$result = dolCheckFilters($sqlfilters, $error, $parenthesislevel);
if (!$result) {
return array();
}
if ($parenthesislevel >= 1) {
$sqlfilters = preg_replace('/^\(/', '', preg_replace('/\)$/', '', $sqlfilters));
}
$i = 0;
$s = '';
$countparenthesis = 0;
while ($i < $nbofchars) {
$char = dol_substr($sqlfilters, $i, 1);
if ($char == '(') {
$countparenthesis++;
} elseif ($char == ')') {
$countparenthesis--;
}
if ($countparenthesis == 0) {
$char2 = dol_substr($sqlfilters, $i + 1, 1);
$char3 = dol_substr($sqlfilters, $i + 2, 1);
if ($char == 'A' && $char2 == 'N' && $char3 == 'D') {
// We found a AND
$s = trim($s);
if (!preg_match('/^\(.*\)$/', $s)) {
$s = '('.$s.')';
}
$arrayofandtags[] = $s;
$s = '';
$i += 2;
} else {
$s .= $char;
}
} else {
$s .= $char;
}
$i++;
}
if ($s) {
$s = trim($s);
if (!preg_match('/^\(.*\)$/', $s)) {
$s = '('.$s.')';
}
$arrayofandtags[] = $s;
}
return $arrayofandtags;
}
/**
* Return if a $sqlfilters parameter has a valid balance of parenthesis
*
* @param string $sqlfilters Universal SQL filter string. Must have been trimmed before.
* @param string $error Returned error message
* @param int $parenthesislevel Returned level of global parenthesis that we can remove/simplify, 0 if error or we can't simplify.
* @return boolean True if valid, False if not valid ($error returned parameter is filled with the reason in such a case)
* @see forgeSQLFromUniversalSearchCriteria()
*/
function dolCheckFilters($sqlfilters, &$error = '', &$parenthesislevel = 0)
{
//$regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
//$tmp=preg_replace_all('/'.$regexstring.'/', '', $sqlfilters);
$tmp = $sqlfilters;
$nb = dol_strlen($tmp);
$counter = 0;
$parenthesislevel = 0;
$error = '';
$i = 0;
while ($i < $nb) {
$char = dol_substr($tmp, $i, 1);
if ($char == '(') {
if ($i == $parenthesislevel && $parenthesislevel == $counter) {
// We open a parenthesis and it is the first char
$parenthesislevel++;
}
$counter++;
} elseif ($char == ')') {
$nbcharremaining = ($nb - $i - 1);
if ($nbcharremaining >= $counter) {
$parenthesislevel = min($parenthesislevel, $counter - 1);
}
if ($parenthesislevel > $counter && $nbcharremaining >= $counter) {
$parenthesislevel = $counter;
}
$counter--;
}
if ($counter < 0) {
$error = "Wrong balance of parenthesis in sqlfilters=".$sqlfilters;
$parenthesislevel = 0;
dol_syslog($error, LOG_WARNING);
return false;
}
$i++;
}
if ($counter > 0) {
$error = "Wrong balance of parenthesis in sqlfilters=".$sqlfilters;
$parenthesislevel = 0;
dol_syslog($error, LOG_WARNING);
return false;
}
return true;
}
/**
* Function to forge a SQL criteria from a Dolibarr filter syntax string.
* This method is called by forgeSQLFromUniversalSearchCriteria()
*
* @param string[] $matches Array of found string by regex search. Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.nature:is:NULL"
* @return string Forged criteria. Example: "" or "()"
*/
function dolForgeDummyCriteriaCallback($matches)
{
//dol_syslog("Convert matches ".$matches[1]);
if (empty($matches[1])) {
return '';
}
$tmp = explode(':', $matches[1]);
if (count($tmp) < 3) {
return '';
}
return '()'; // An empty criteria
}
/**
* Function to forge a SQL criteria from a USF (Universal Filter Syntax) string.
* This method is called by forgeSQLFromUniversalSearchCriteria()
*
* @param string[] $matches Array of found string by regex search.
* Example: "t.ref:like:'SO-%'" or "t.date_creation:<:'20160101'" or "t.date_creation:<:'2016-01-01 12:30:00'" or "t.nature:is:NULL"
* @return string Forged criteria. Example: "t.field LIKE 'abc%'"
*/
function dolForgeSQLCriteriaCallback($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])));
$realOperator = [
'NOTLIKE' => 'NOT LIKE',
'ISNOT' => 'IS NOT',
'NOTIN' => 'NOT IN',
'!=' => '<>',
];
if (array_key_exists($operator, $realOperator)) {
$operator = $realOperator[$operator];
}
$tmpescaped = $tmp[2];
//print "Case: ".$operator." ".$operand." ".$tmpescaped."\n";
$regbis = array();
if ($operator == 'IN' || $operator == 'NOT IN') { // IN is allowed for list of ID/code/field only (or subrequest if MAIN_DISALLOW_UNSECURED_SELECT_INTO_EXTRAFIELDS_FILTERnot enabled)
//if (!preg_match('/^\(.*\)$/', $tmpescaped)) {
$tmpescaped2 = '(';
// Explode and sanitize each element in list
$tmpelemarray = explode(',', $tmpescaped);
foreach ($tmpelemarray as $tmpkey => $tmpelem) {
$reg = array();
$tmpelem = trim($tmpelem);
if (preg_match('/^\'(.*)\'$/', $tmpelem, $reg)) {
$tmpelemarray[$tmpkey] = "'".$db->escape($db->sanitize($reg[1], 2, 1, 1, 1))."'";
} elseif (ctype_digit((string) $tmpelem)) { // if only 0-9 chars, no .
$tmpelemarray[$tmpkey] = (int) $tmpelem;
} elseif (is_numeric((string) $tmpelem)) { // it can be a float with a .
$tmpelemarray[$tmpkey] = (float) $tmpelem;
} elseif (!getDolGlobalString("MAIN_DISALLOW_UNSECURED_SELECT_INTO_EXTRAFIELDS_FILTER")) {
$tmpelemarray[$tmpkey] = preg_replace('/[^a-z0-9_<>=!\s]/i', '', $tmpelem); // it can be a full subrequest
} else {
$tmpelemarray[$tmpkey] = preg_replace('/[^a-z0-9_]/i', '', $tmpelem); // it can be a name of field or a substitution variable like '__NOW__'
}
}
$tmpescaped2 .= implode(',', $tmpelemarray);
$tmpescaped2 .= ')';
$tmpescaped = $tmpescaped2;
} elseif ($operator == 'LIKE' || $operator == 'NOT LIKE') {
if (preg_match('/^\'([^\']*)\'$/', $tmpescaped, $regbis)) {
$tmpescaped = $regbis[1];
}
//$tmpescaped = "'".$db->escape($db->escapeforlike($regbis[1]))."'";
$tmpescaped = "'".$db->escape($tmpescaped)."'"; // We do not escape the _ and % so the LIKE will work as expected
} elseif (preg_match('/^\'(.*)\'$/', $tmpescaped, $regbis)) {
// TODO Retrieve type of field for $operand field name.
// So we can complete format. For example we could complete a year with month and day.
$tmpescaped = "'".$db->escape($regbis[1])."'";
} else {
if (strtoupper($tmpescaped) == 'NULL') {
$tmpescaped = 'NULL';
} elseif (ctype_digit((string) $tmpescaped)) { // if only 0-9 chars, no .
$tmpescaped = (int) $tmpescaped;
} elseif (is_numeric((string) $tmpescaped)) { // it can be a float with a .
$tmpescaped = (float) $tmpescaped;
} else {
$tmpescaped = preg_replace('/[^a-z0-9_]/i', '', $tmpescaped); // it can be a name of field or a substitution variable like '__NOW__'
}
}
return '('.$db->escape($operand).' '.strtoupper($operator).' '.$tmpescaped.')';
}
/**
* Get timeline icon
*
* @param ActionComm $actionstatic actioncomm
* @param array<int,array{percent:int}> $histo histo
* @param int $key key
* @return string String with timeline icon
* @deprecated Use actioncomm->getPictoType() instead
*/
function getTimelineIcon($actionstatic, &$histo, $key)
{
global $langs;
$out = '<!-- timeline icon -->'."\n";
$iconClass = 'fa fa-comments';
$img_picto = '';
$colorClass = '';
$pictoTitle = '';
if ($histo[$key]['percent'] == -1) {
$colorClass = 'timeline-icon-not-applicble';
$pictoTitle = $langs->trans('StatusNotApplicable');
} elseif ($histo[$key]['percent'] == 0) {
$colorClass = 'timeline-icon-todo';
$pictoTitle = $langs->trans('StatusActionToDo').' (0%)';
} elseif ($histo[$key]['percent'] > 0 && $histo[$key]['percent'] < 100) {
$colorClass = 'timeline-icon-in-progress';
$pictoTitle = $langs->trans('StatusActionInProcess').' ('.$histo[$key]['percent'].'%)';
} elseif ($histo[$key]['percent'] >= 100) {
$colorClass = 'timeline-icon-done';
$pictoTitle = $langs->trans('StatusActionDone').' (100%)';
}
if ($actionstatic->code == 'AC_TICKET_CREATE') {
$iconClass = 'fa fa-ticket';
} elseif ($actionstatic->code == 'AC_TICKET_MODIFY') {
$iconClass = 'fa fa-pencilxxx';
} elseif (preg_match('/^TICKET_MSG/', $actionstatic->code)) {
$iconClass = 'fa fa-comments';
} elseif (preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
$iconClass = 'fa fa-mask';
} elseif (getDolGlobalString('AGENDA_USE_EVENT_TYPE')) {
if ($actionstatic->type_picto) {
$img_picto = img_picto('', $actionstatic->type_picto);
} else {
if ($actionstatic->type_code == 'AC_RDV') {
$iconClass = 'fa fa-handshake';
} elseif ($actionstatic->type_code == 'AC_TEL') {
$iconClass = 'fa fa-phone';
} elseif ($actionstatic->type_code == 'AC_FAX') {
$iconClass = 'fa fa-fax';
} elseif ($actionstatic->type_code == 'AC_EMAIL') {
$iconClass = 'fa fa-envelope';
} elseif ($actionstatic->type_code == 'AC_INT') {
$iconClass = 'fa fa-shipping-fast';
} elseif ($actionstatic->type_code == 'AC_OTH_AUTO') {
$iconClass = 'fa fa-robot';
} elseif (!preg_match('/_AUTO/', $actionstatic->type_code)) {
$iconClass = 'fa fa-robot';
}
}
}
$out .= '<i class="'.$iconClass.' '.$colorClass.'" title="'.$pictoTitle.'">'.$img_picto.'</i>'."\n";
return $out;
}
/**
* getActionCommEcmList
*
* @param ActionComm $object Object ActionComm
* @return array<int,stdClass> Array of documents in index table
*/
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, ecm.agenda_id';
$sql .= ' FROM '.MAIN_DB_PREFIX.'ecm_files ecm';
$sql .= " WHERE ecm.filepath = 'agenda/".((int) $object->id)."'";
//$sql.= " ecm.src_object_type = '".$db->escape($object->element)."' AND ecm.src_object_id = ".((int) $object->id); // Old version didn't add object_type during upload
$sql.= ' OR ecm.agenda_id = '.(int) $object->id;
$sql .= ' ORDER BY ecm.position ASC';
$resql = $db->query($sql);
if ($resql) {
if ($db->num_rows($resql)) {
while ($obj = $db->fetch_object($resql)) {
$documents[$obj->id] = $obj;
}
}
}
return $documents;
}
/**
* Show html area with actions in messaging format.
* Note: Global parameter $param must be defined.
*
* @param Conf $conf Object conf
* @param Translate $langs Object langs
* @param DoliDB $db Object db
* @param ?CommonObject $filterobj Filter on object Adherent|Societe|Project|Product|CommandeFournisseur|Dolresource|Ticket|... to list events linked to an object
* @param ?Contact $objcon Filter on object contact to filter events on a contact
* @param int $noprint Return string but does not output it
* @param string $actioncode Filter on actioncode
* @param string $donetodo Filter on event 'done' or 'todo' or ''=nofilter (all).
* @param array<string,string> $filters Filter on other fields
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @return ?string Return html part or void if noprint is 1
*/
function show_actions_messaging($conf, $langs, $db, $filterobj, $objcon = null, $noprint = 0, $actioncode = '', $donetodo = 'done', $filters = array(), $sortfield = 'a.datep,a.id', $sortorder = 'DESC')
{
global $user, $conf;
global $form;
global $param, $massactionbutton;
require_once DOL_DOCUMENT_ROOT . '/comm/action/class/actioncomm.class.php';
// Check parameters
if (!is_object($filterobj) && !is_object($objcon)) {
dol_print_error(null, 'BadParameter');
}
$histo = array();
'@phan-var-force array<int,array{type:string,tododone:string,id:string,datestart:int|string,dateend:int|string,note:string,message:string,percent:string,userid:string,login:string,userfirstname:string,userlastname:string,userphoto:string,msg_from?:string,contact_id?:string,socpeopleassigned?:int[],lastname?:string,firstname?:string,fk_element?:int,elementtype?:string,acode:string,alabel?:string,libelle?:string,apicto?:string}> $histo';
$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);
$sql = null;
$sql2 = null;
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 .= " a.email_from as msg_from,";
$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) && in_array(get_class($filterobj), array('Commande', 'CommandeFournisseur', 'Product', 'Ticket', 'BOM', 'Contrat', 'Facture', 'FactureFournisseur'))) {
$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 = $filterobj instanceof User;
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') || (is_object($filterobj) && get_class($filterobj) == 'Contact')) {
$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";
} elseif (is_object($filterobj) && get_class($filterobj) == 'Facture') {
$sql .= ", ".MAIN_DB_PREFIX."facture as o";
} elseif (is_object($filterobj) && get_class($filterobj) == 'FactureFournisseur') {
$sql .= ", ".MAIN_DB_PREFIX."facture_fourn as o";
}
$sql .= " WHERE a.entity IN (".getEntity('agenda').")";
if (!$force_filter_contact) {
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) == 'Commande') {
$sql .= " AND a.fk_element = o.rowid AND a.elementtype = 'order'";
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);
}
} elseif (is_object($filterobj) && get_class($filterobj) == 'Contact' && $filterobj->id) {
$sql .= " AND a.fk_contact = sp.rowid";
if ($filterobj->id) {
$sql .= " AND a.fk_contact = ".((int) $filterobj->id);
}
} elseif (is_object($filterobj) && get_class($filterobj) == 'Facture') {
$sql .= " AND a.fk_element = o.rowid";
if ($filterobj->id) {
$sql .= " AND a.fk_element = ".((int) $filterobj->id)." AND a.elementtype = 'invoice'";
}
} elseif (is_object($filterobj) && get_class($filterobj) == 'FactureFournisseur') {
$sql .= " AND a.fk_element = o.rowid";
if ($filterobj->id) {
$sql .= " AND a.fk_element = ".((int) $filterobj->id)." AND a.elementtype = 'invoice_supplier'";
}
}
} else {
$sql .= " AND u.rowid = ". ((int) $filterobj->id);
}
// Condition on actioncode
if (!empty($actioncode) && $actioncode != '-1') {
if (!getDolGlobalString('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 ($sql || $sql2) { // May not be defined if module Agenda is not enabled and mailing module disabled too
if (!empty($sql) && !empty($sql2)) {
$sql = $sql." UNION ".$sql2;
} elseif (empty($sql) && !empty($sql2)) {
$sql = $sql2;
}
//TODO Add navigation with this limits...
$offset = 0;
$limit = 1000;
// Complete request and execute it with limit
$sql .= $db->order($sortfield_new, $sortorder);
if ($limit) {
$sql .= $db->plimit($limit + 1, $offset);
}
dol_syslog("function.lib::show_actions_messaging", LOG_DEBUG);
$resql = $db->query($sql);
if ($resql) {
$i = 0;
$num = $db->num_rows($resql);
$imaxinloop = ($limit ? min($num, $limit) : $num);
while ($i < $imaxinloop) {
$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 resource", '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' => dol_htmlentitiesbr($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,
'msg_from' => $obj->msg_from,
'contact_id' => $obj->fk_contact,
'socpeopleassigned' => $contactaction->socpeopleassigned,
'lastname' => (empty($obj->lastname) ? '' : $obj->lastname),
'firstname' => (empty($obj->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' => dol_htmlentitiesbr($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 = getDolGlobalInt('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();
$contactGetNomUrlCache = 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.'" />';
} else {
$out .= '<input type="hidden" name="userid" value="'.$filterobj->id.'" />';
}
$out .= "\n";
$out .= '<div class="div-table-responsive-no-min">';
$out .= '<table class="noborder borderbottom centpercent">';
$out .= '<tr class="liste_titre">';
// Action column
if (getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
$out .= '<th class="liste_titre width50 middle">';
$searchpicto = $form->showFilterAndCheckAddButtons($massactionbutton ? 1 : 0, 'checkforselect', 1);
$out .= $searchpicto;
$out .= '</th>';
}
// Date
$out .= getTitleFieldOfList('Date', 0, $_SERVER["PHP_SELF"], 'a.datep', '', $param, '', $sortfield, $sortorder, 'nowraponall nopaddingleftimp ')."\n";
$out .= '<th class="liste_titre hideonsmartphone"><strong class="hideonsmartphone">'.$langs->trans("Search").' : </strong></th>';
if ($donetodo) {
$out .= '<th class="liste_titre"></th>';
}
// Type of event
$out .= '<th class="liste_titre">';
$out .= '<span class="fas fa-square inline-block fawidth30 hideonsmartphone" style="color: #ddd;" title="'.$langs->trans("ActionType").'"></span>';
$out .= $formactions->select_type_actions($actioncode, "actioncode", '', getDolGlobalString('AGENDA_USE_EVENT_TYPE') ? -1 : 1, 0, 0, 1, 'selecttype minwidth100', $langs->trans("Type"));
$out .= '</th>';
// Label
$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>';
// Action column
if (!getDolGlobalString('MAIN_CHECKBOX_LEFT_COLUMN')) {
$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 ($filterobj instanceof Societe) {
$tmp .= '<a href="'.DOL_URL_ROOT.'/comm/action/list.php?mode=show_list&socid='.$filterobj->id.'&status=done">';
}
if ($filterobj instanceof User) {
$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 ($filterobj instanceof Societe) {
$tmp .= '</a>';
}
if ($filterobj instanceof User) {
$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', '', (!getDolGlobalString('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'];
$labeltype = $actionstatic->type_code;
if (!getDolGlobalString('AGENDA_USE_EVENT_TYPE') && empty($arraylist[$labeltype])) {
$labeltype = 'AC_OTH';
}
if (!empty($actionstatic->code) && preg_match('/^TICKET_MSG/', $actionstatic->code)) {
$labeltype = $langs->trans("Message");
} else {
if (!empty($arraylist[$labeltype])) {
$labeltype = $arraylist[$labeltype];
}
if ($actionstatic->type_code == 'AC_OTH_AUTO' && ($actionstatic->type_code != $actionstatic->code) && $labeltype && !empty($arraylist[$actionstatic->code])) {
$labeltype .= ' - '.$arraylist[$actionstatic->code]; // Use code in priority on type_code
}
}
$url = DOL_URL_ROOT.'/comm/action/card.php?id='.$histo[$key]['id'];
$tmpa = dol_getdate($histo[$key]['datestart'], false);
if (isset($tmpa['year']) && isset($tmpa['yday']) && $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-'.(!empty($actionstatic->code) ? strtolower($actionstatic->code) : "none").'">';
//$timelineicon = getTimelineIcon($actionstatic, $histo, $key);
$typeicon = $actionstatic->getTypePicto('pictofixedwidth timeline-icon-not-applicble', $labeltype);
//$out .= $timelineicon;
//var_dump($timelineicon);
$out .= $typeicon;
$out .= '<div class="timeline-item">'."\n";
$out .= '<span class="time timeline-header-action2">';
if (isset($histo[$key]['type']) && $histo[$key]['type'] == 'mailing') {
$out .= '<a class="paddingleft paddingright timeline-btn2 editfielda" 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) && $user->hasRight('agenda', 'myactions', 'create'))) {
$out .= '<a class="paddingleft paddingright timeline-btn2 editfielda" href="'.DOL_MAIN_URL_ROOT.'/comm/action/card.php?action=edit&token='.newToken().'&id='.$actionstatic->id.'&backtopage='.urlencode($_SERVER["PHP_SELF"].'?'.$param).'">';
//$out .= '<i class="fa fa-pencil" title="'.$langs->trans("Modify").'" ></i>';
$out .= img_picto($langs->trans("Modify"), 'edit', 'class="edita"');
$out .= '</a>';
}
$out .= '</span>';
// Date
$out .= '<span class="time"><i class="fa fa-clock-o valignmiddle"></i> <span class="valignmiddle">';
$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></span>\n";
$out .= '<span class="time">';
$out .= $actionstatic->getLibStatut(2);
$out .= '</span>';
// Ref
$out .= '<h3 class="timeline-header">';
// Author of event
$out .= '<div class="messaging-author inline-block tdoverflowmax150 valignmiddle marginrightonly">';
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']];
} elseif (!empty($histo[$key]['msg_from']) && $actionstatic->code == 'TICKET_MSG') {
if (!isset($contactGetNomUrlCache[$histo[$key]['msg_from']])) {
if ($contactstatic->fetch(0, null, '', $histo[$key]['msg_from']) > 0) {
$contactGetNomUrlCache[$histo[$key]['msg_from']] = $contactstatic->getNomUrl(-1, '', 16);
} else {
$contactGetNomUrlCache[$histo[$key]['msg_from']] = $histo[$key]['msg_from'];
}
}
$out .= $contactGetNomUrlCache[$histo[$key]['msg_from']];
}
$out .= '</div>';
// Title
$out .= ' <div class="messaging-title inline-block">';
//$out .= $actionstatic->getTypePicto(); // The type of event is already into the timeline on left.
if (empty($conf->dol_optimize_smallscreen) && $actionstatic->type_code != 'AC_OTH_AUTO') {
$out .= $labeltype.' - ';
}
$libelle = '';
if (!empty($actionstatic->code) && preg_match('/^TICKET_MSG/', $actionstatic->code)) {
$out .= $langs->trans('TicketNewMessage');
} elseif (!empty($actionstatic->code) && preg_match('/^TICKET_MSG_PRIVATE/', $actionstatic->code)) {
$out .= $langs->trans('TicketNewMessage').' <em>('.$langs->trans('Private').')</em>';
} elseif (isset($histo[$key]['type'])) {
if ($histo[$key]['type'] == 'action') {
$transcode = $langs->transnoentitiesnoconv("Action".$histo[$key]['acode']);
$libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : $histo[$key]['alabel']);
$libelle = $histo[$key]['note'];
$actionstatic->id = $histo[$key]['id'];
if ($libelle != $labeltype) {
$out .= dol_escape_htmltag(dol_trunc($libelle, 120));
}
} elseif ($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->transnoentitiesnoconv("Action".$histo[$key]['acode']);
$libelle = ($transcode != "Action".$histo[$key]['acode'] ? $transcode : 'Send mass mailing');
$out .= dol_escape_htmltag(dol_trunc($libelle, 120));
} else {
$libelle .= $histo[$key]['note'];
$out .= dol_escape_htmltag(dol_trunc($libelle, 120));
}
}
$out = preg_replace('/ - $/', '', $out); // Remove ending ' - '
if (isset($histo[$key]['elementtype']) && !empty($histo[$key]['fk_element'])) {
if (isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']]) && isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']])) {
$link = $conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']];
} else {
if (!isset($conf->cache['elementlinkcache'][$histo[$key]['elementtype']])) {
$conf->cache['elementlinkcache'][$histo[$key]['elementtype']] = array();
}
$link = dolGetElementUrl($histo[$key]['fk_element'], $histo[$key]['elementtype'], 1);
$conf->cache['elementlinkcache'][$histo[$key]['elementtype']][$histo[$key]['fk_element']] = $link;
}
if ($link) {
$out .= ' - '.$link;
}
}
$out .= '</div>';
$out .= '</h3>';
// Message
if (!empty($histo[$key]['message'] && $histo[$key]['message'] != $libelle)
&& $actionstatic->code != 'AC_TICKET_CREATE'
&& $actionstatic->code != 'AC_TICKET_MODIFY'
) {
$out .= '<div class="timeline-body wordbreak small">';
$truncateLines = getDolGlobalInt('MAIN_TRUNCATE_TIMELINE_MESSAGE', 3);
$truncatedText = dolGetFirstLineOfText($histo[$key]['message'], $truncateLines);
if ($truncateLines > 0 && strlen($histo[$key]['message']) > strlen($truncatedText)) {
$out .= '<div class="readmore-block --closed" >';
$out .= ' <div class="readmore-block__excerpt">';
$out .= dolPrintHTML($truncatedText);
$out .= ' <br><a class="read-more-link" data-read-more-action="open" href="'.DOL_MAIN_URL_ROOT.'/comm/action/card.php?id='.$actionstatic->id.'&backtopage='.urlencode($_SERVER["PHP_SELF"].'?'.$param).'" >'.$langs->trans("ReadMore").' <span class="fa fa-chevron-right" aria-hidden="true"></span></a>';
$out .= ' </div>';
$out .= ' <div class="readmore-block__full-text" >';
$out .= dolPrintHTML($histo[$key]['message']);
$out .= ' <a class="read-less-link" data-read-more-action="close" href="#" ><span class="fa fa-chevron-up" aria-hidden="true"></span> '.$langs->trans("ReadLess").'</a>';
$out .= ' </div>';
$out .= '</div>';
} else {
$out .= dolPrintHTML($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) {
if (empty($conf->cache['contact'][$histo[$key]['contact_id']])) {
$contact = new Contact($db);
$contact->fetch($cid);
$conf->cache['contact'][$histo[$key]['contact_id']] = $contact;
} else {
$contact = $conf->cache['contact'][$histo[$key]['contact_id']];
}
if ($contact) {
$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) {
if (empty($conf->cache['contact'][$histo[$key]['contact_id']])) {
$contact = new Contact($db);
$result = $contact->fetch($histo[$key]['contact_id']);
$conf->cache['contact'][$histo[$key]['contact_id']] = $contact;
} else {
$contact = $conf->cache['contact'][$histo[$key]['contact_id']];
$result = ($contact instanceof Contact) ? $contact->id : 0;
}
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);
if (empty($doc->agenda_id)) {
$dir_ref = $actionstatic->id;
$modulepart = 'actions';
} else {
$split_dir = explode('/', $doc->filepath);
$modulepart = array_shift($split_dir);
$dir_ref = implode('/', $split_dir);
}
$file = $dir_ref.'/'.$doc->filename;
$thumb = $dir_ref.'/thumbs/'.substr($doc->filename, 0, strrpos($doc->filename, '.')).'_mini'.substr($doc->filename, strrpos($doc->filename, '.'));
$doclink = dol_buildpath('document.php', 1).'?modulepart='.$modulepart.'&attachment=0&file='.urlencode($file).'&entity='.$conf->entity;
$viewlink = dol_buildpath('viewimage.php', 1).'?modulepart='.$modulepart.'&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 -->';
}
$out .= "</ul>\n";
// Code to manage the click on button data-read-more-action to show full description of an event
$out .= '<script>
jQuery(document).ready(function () {
$(document).on("click", "[data-read-more-action]", function(e){
console.log("We click on data-read-more-action");
let readMoreBloc = $(this).closest(".readmore-block");
if(readMoreBloc.length > 0){
e.preventDefault();
if($(this).attr("data-read-more-action") == "close"){
readMoreBloc.addClass("--closed").removeClass("--open");
$("html, body").animate({
scrollTop: readMoreBloc.offset().top - 200
}, 100);
}else{
readMoreBloc.addClass("--open").removeClass("--closed");
}
}
});
});
</script>';
if (empty($histo)) {
$out .= '<span class="opacitymedium">'.$langs->trans("NoRecordFound").'</span>';
}
}
if ($noprint) {
return $out;
} else {
print $out;
return null;
}
}
/**
* Helper function that combines values of a dolibarr DatePicker (such as Form::selectDate) for year, month, day (and
* optionally hour, minute, second) fields to return a portion of URL reproducing the values from the current HTTP
* request.
*
* @param string $prefix Prefix used to build the date selector (for instance using Form::selectDate)
* @param ?int $timestamp If null, the timestamp will be created from request data
* @param string $hourTime If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp
* @param string $gm If timestamp is null, will be passed to GETPOSTDATE to construct the timestamp
* @return string Portion of URL with query parameters for the specified date
*/
function buildParamDate($prefix, $timestamp = null, $hourTime = '', $gm = 'auto')
{
if ($timestamp === null) {
$timestamp = GETPOSTDATE($prefix, $hourTime, $gm);
}
$TParam = array(
$prefix . 'day' => intval(dol_print_date($timestamp, '%d')),
$prefix . 'month' => intval(dol_print_date($timestamp, '%m')),
$prefix . 'year' => intval(dol_print_date($timestamp, '%Y')),
);
if ($hourTime === 'getpost' || ($timestamp !== null && dol_print_date($timestamp, '%H:%M:%S') !== '00:00:00')) {
$TParam = array_merge($TParam, array(
$prefix . 'hour' => intval(dol_print_date($timestamp, '%H')),
$prefix . 'minute' => intval(dol_print_date($timestamp, '%M')),
$prefix . 'second' => intval(dol_print_date($timestamp, '%S'))
));
}
return '&' . http_build_query($TParam);
}
/**
* Displays an error page when a record is not found. It allows customization of the message,
* whether to include the header and footer, and if only the message should be shown without additional details.
* The function also supports executing additional hooks for customized handling of error pages.
*
* @param string $message Custom error message to display. If empty, a default "Record Not Found" message is shown.
* @param int<0,1> $printheader Determines if the page header should be printed (1 = yes, 0 = no).
* @param int<0,1> $printfooter Determines if the page footer should be printed (1 = yes, 0 = no).
* @param int<0,1> $showonlymessage If set to 1, only the error message is displayed without any additional information or hooks.
* @param mixed $params Optional parameters to pass to hooks for further processing or customization.
* @global Conf $conf Dolibarr configuration object (global)
* @global DoliDB $db Database connection object (global)
* @global Translate $langs Language translation object, initialized within the function if not already.
* @global HookManager $hookmanager Hook manager object, initialized within the function if not already for executing hooks.
* @global string $action Current action, can be modified by hooks.
* @global object $object Current object, can be modified by hooks.
* @return void This function terminates script execution after outputting the error page.
*/
function recordNotFound($message = '', $printheader = 1, $printfooter = 1, $showonlymessage = 0, $params = null)
{
global $conf, $db, $langs, $hookmanager;
global $action, $object;
if (!is_object($langs)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php';
$langs = new Translate('', $conf);
$langs->setDefaultLang();
}
$langs->load("errors");
if ($printheader) {
if (function_exists("llxHeader")) {
llxHeader('');
} elseif (function_exists("llxHeaderVierge")) {
llxHeaderVierge('');
}
}
print '<div class="error">';
if (empty($message)) {
print $langs->trans("ErrorRecordNotFound");
} else {
print $langs->trans($message);
}
print '</div>';
print '<br>';
if (empty($showonlymessage)) {
if (empty($hookmanager)) {
include_once DOL_DOCUMENT_ROOT.'/core/class/hookmanager.class.php';
$hookmanager = new HookManager($db);
// Initialize a technical object to manage hooks of page. Note that conf->hooks_modules contains an array of hook context
$hookmanager->initHooks(array('main'));
}
$parameters = array('message' => $message, 'params' => $params);
$reshook = $hookmanager->executeHooks('getErrorRecordNotFound', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
print $hookmanager->resPrint;
}
if ($printfooter && function_exists("llxFooter")) {
llxFooter();
if (is_object($db)) {
$db->close();
}
}
exit(0);
}