api_setup.class.php

<?php
/* Copyright (C) 2016   Xebax Christy     <xebax@wanadoo.fr>
 * Copyright (C) 2016   Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2017-2025  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2017   Neil Orley        <neil.orley@oeris.fr>
 * Copyright (C) 2018-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2018-2022  Thibault FOUCART    <support@ptibogxiv.net>
 * Copyright (C) 2024   Jon Bendtsen      <jon.bendtsen.github@jonb.dk>
 * Copyright (C) 2024-2025  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025   Charlene Benke      <charlene@patas-monkey.com>
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/api/class/api.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/cstate.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/cregion.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/ccountry.class.php';
require_once DOL_DOCUMENT_ROOT.'/hrm/class/establishment.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
 
class Setup extends DolibarrApi
{
  private $translations = null;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
  }
 
  public function getListOfActionTriggers($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $elementtype = '', $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    if ($elementtype == 'thirdparty') {
      $elementtype = 'societe';
    }
    if ($elementtype == 'contact') {
      $elementtype = 'socpeople';
    }
 
    $sql = "SELECT t.rowid as id, t.elementtype, t.code, t.contexts, t.label, t.description, t.rang";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_action_trigger as t";
    $sql .= " WHERE 1=1";
    if (!empty($elementtype)) {
      $sql .= " AND t.elementtype = '".$this->db->escape($elementtype)."'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $type = $this->db->fetch_object($result);
        $this->translateLabel($type, $lang, 'Notify_', array('other'));
        $list[] = $type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of action triggers : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getOrderingMethods($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('commande', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid, code, libelle as label, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_input_method as t";
    $sql .= " WHERE t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getOrderingOrigins($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('commande', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid, code, label, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_input_reason as t";
    $sql .= " WHERE t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getPaymentTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('propal', 'lire') && !DolibarrApiAccess::$user->hasRight('commande', 'lire') && !DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT id, code, type, libelle as label, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_paiement as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_paiement').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfRegions($sortfield = "code_region", $sortorder = 'ASC', $limit = 100, $page = 0, $country = 0, $filter = '', $sqlfilters = '')
  {
    $list = array();
 
    // Note: The filter is not applied in the SQL request because it must
    // be applied to the translated names, not to the names in database.
    $sql = "SELECT t.rowid FROM ".MAIN_DB_PREFIX."c_regions as t";
    $sql .= " WHERE 1 = 1";
    if ($country) {
      $sql .= " AND t.fk_pays = ".((int) $country);
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $region = new Cregion($this->db);
        if ($region->fetch($obj->rowid) > 0) {
          if (empty($filter) || stripos((string) $region->name, $filter) !== false) {
            $list[] = $this->_cleanObjectDatas($region);
          }
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of regions');
    }
 
    return $list;
  }
 
  public function getRegionByID($id)
  {
    return $this->_fetchCregion($id, '');
  }
 
  public function getRegionByCode($code)
  {
    return $this->_fetchCregion(0, $code);
  }
 
  public function getListOfStates($sortfield = "code_departement", $sortorder = 'ASC', $limit = 100, $page = 0, $country = 0, $filter = '', $sqlfilters = '')
  {
    $list = array();
 
    // Note: The filter is not applied in the SQL request because it must
    // be applied to the translated names, not to the names in database.
    $sql = "SELECT t.rowid FROM ".MAIN_DB_PREFIX."c_departements as t";
    if ($country) {
      $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_regions as d ON t.fk_region = d.code_region";
    }
    $sql .= " WHERE 1 = 1";
    if ($country) {
      $sql .= " AND d.fk_pays = ".((int) $country);
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $state = new Cstate($this->db);
        if ($state->fetch($obj->rowid) > 0) {
          if (empty($filter) || stripos((string) $state->label, $filter) !== false) {
            $list[] = $this->_cleanObjectDatas($state);
          }
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of states');
    }
 
    return $list;
  }
 
  public function getStateByID($id)
  {
    return $this->_fetchCstate($id, '');
  }
 
  public function getStateByCode($code)
  {
    return $this->_fetchCstate(0, $code);
  }
 
  public function getListOfCountries($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $filter = '', $lang = '', $sqlfilters = '', $loadregions = 0, $loadstates = 0)
  {
    $list = array();
 
    // Note: The filter is not applied in the SQL request because it must
    // be applied to the translated names, not to the names in database.
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."c_country as t";
    $sql .= " WHERE rowid > 0";
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $obj = $this->db->fetch_object($result);
        $country = new CcountryExtended($this->db);
        $fetchres = $country->fetch($obj->rowid);
        if ($fetchres && $loadregions) {
          $country->regions = $this->getListOfRegions("code_region", 'ASC', 0, 0, $obj->rowid);
        }
        if ($fetchres && $loadstates) {
          $country->states = $this->getListOfStates("code_departement", 'ASC', 0, 0, $obj->rowid);
        }
 
        if ($fetchres > 0) {
          // Translate the name of the country if needed
          // and then apply the filter if there is one.
          $this->translateLabel($country, $lang, 'Country');
 
          if (empty($filter) || stripos((string) $country->label, $filter) !== false) {
            $list[] = $this->_cleanObjectDatas($country);
          }
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of countries');
    }
 
    return $list;
  }
 
  public function getCountryByID($id, $lang = '', $loadregions = 0, $loadstates = 0)
  {
    if ($id < 1) {
      throw new RestException(400, 'Error: id < 1');
    }
    return $this->_fetchCcountry($id, '', '', $lang = '', $loadregions, $loadstates);
  }
 
  public function getCountryByCode($code, $lang = '', $loadregions = 0, $loadstates = 0)
  {
    return $this->_fetchCcountry(0, $code, '', $lang = '', $loadregions, $loadstates);
  }
 
  public function getCountryByISO($iso, $lang = '', $loadregions = 0, $loadstates = 0)
  {
    return $this->_fetchCcountry(0, '', $iso, $lang = '', $loadregions, $loadstates);
  }
 
  private function _fetchCregion($id, $code = '')
  {
    $region = new Cregion($this->db);
 
    $result = $region->fetch($id, (int) $code);
    if ($result < 0) {
      throw new RestException(503, 'Error when retrieving region : '.$region->error);
    } elseif ($result == 0) {
      throw new RestException(404, 'Region not found');
    }
 
    return $this->_cleanObjectDatas($region);
  }
 
  private function _fetchCstate($id, $code = '')
  {
    $state = new Cstate($this->db);
 
    $result = $state->fetch($id, $code);
    if ($result < 0) {
      throw new RestException(503, 'Error when retrieving state : '.$state->error);
    } elseif ($result == 0) {
      throw new RestException(404, 'State not found');
    }
 
    return $this->_cleanObjectDatas($state);
  }
 
  private function _fetchCcountry($id, $code = '', $iso = '', $lang = '', $loadregions = 0, $loadstates = 0)
  {
    if ($loadregions || $loadstates) {
      $country = new CcountryExtended($this->db);
    } else {
      $country = new Ccountry($this->db);
    }
    $result = $country->fetch($id, $code, $iso);
 
    if ($result < 0) {
      throw new RestException(503, 'Error when retrieving country : '.$country->error);
    } elseif ($result == 0) {
      throw new RestException(404, 'Country not found');
    } else {
      if ($loadregions > 0) {
        $regions = $this->getListOfRegions($sortfield = "code_region", $sortorder = 'ASC', $limit = 0, $page = 0, $country->id, $filter = '', $sqlfilters = '');
        $country->regions = $regions;
      }
      if ($loadstates > 0) {
        $states = $this->getListOfStates($sortfield = "code_departement", $sortorder = 'ASC', $limit = 0, $page = 0, $country->id, $filter = '', $sqlfilters = '');
        $country->states = $states;
      }
    }
 
    $this->translateLabel($country, $lang, 'Country');
 
    return $this->_cleanObjectDatas($country);
  }
 
  public function getAvailability($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('commande', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid, code, label";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_availability as t";
    $sql .= " WHERE t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->error);
    unset($object->errors);
 
    return $object;
  }
 
  private function translateLabel($object, $lang, $prefix = 'Country', $dict = array('dict'))
  {
    if (!empty($lang)) {
      // Load the translations if this is a new language.
      if ($this->translations == null || $this->translations->getDefaultLang() !== $lang) {
        global $conf;
        $this->translations = new Translate('', $conf);
        $this->translations->setDefaultLang($lang);
        $this->translations->loadLangs($dict);
      }
      if ($object->code) {
        $key = $prefix.$object->code;
 
        $translation = $this->translations->trans($key);
        if ($translation != $key) {
          $object->label = html_entity_decode($translation);
        }
      }
    }
  }
 
  public function getListOfEventTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $type = '', $module = '', $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT id, code, type, libelle as label, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_actioncomm as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($type) {
      $sql .= " AND t.type LIKE '%".$this->db->escape($type)."%'";
    }
    if ($module) {
      $sql .= " AND t.module LIKE '%".$this->db->escape($module)."%'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of events types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
 
  public function getListOfExpenseReportsTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $module = '', $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('expensereport', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT id, code, label, accountancy_code, active, module, position";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_type_fees as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($module) {
      $sql .= " AND t.module LIKE '%".$this->db->escape($module)."%'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of expense report types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfHolidayTypes($sortfield = "sortorder", $sortorder = 'ASC', $limit = 100, $page = 0, $fk_country = '', $active = 1, $lang = '', $sqlfilters = '')
  {
    global $langs;
    $langs->loadLangs(array('holiday'));
 
    if (!DolibarrApiAccess::$user->hasRight('holiday', 'read')) {
      throw new RestException(403);
    }
 
    $list = array();
 
    $sql = "SELECT rowid, code, label, affect, delay, newbymonth, fk_country";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_holiday_types as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_holiday_types').")";
    $sql .= " AND t.active = ".((int) $active);
    if ($fk_country) {
      $sql .= " AND (t.fk_country = ".((int) $fk_country);
      $sql .= " OR t.fk_country is null)";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $holiday = $this->db->fetch_object($result);
        $tmplabel = $langs->trans($holiday->code);
        if ($tmplabel != $holiday->code) {
          $holiday->label = $tmplabel;
        }
        //$this->translateLabel($holiday, $lang, 'Holiday', array('dict'));
        $list[] = $holiday;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of holiday : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfPublicHolidays($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $fk_country = '', $active = 1, $lang = '', $sqlfilters = '')
  {
    global $langs;
    $langs->loadLangs(array('hrm'));
 
    if (!DolibarrApiAccess::$user->hasRight('holiday', 'lire')) {
      throw new RestException(403);
    }
 
    $list = array();
 
    $sql = "SELECT id, code, dayrule, day, month, year, fk_country, code as label";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_hrm_public_holiday as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_hrm_public_holiday').")";
    $sql .= " AND t.active = ".((int) $active);
    if ($fk_country) {
      $sql .= " AND (t.fk_country = ".((int) $fk_country);
      $sql .= " OR t.fk_country is null)";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $holiday = $this->db->fetch_object($result);
        $tmplabel = $langs->trans($holiday->code);
        if ($tmplabel != $holiday->code) {
          $holiday->label = $tmplabel;
        }
        //$this->translateLabel($holiday, $lang, 'Holiday', array('dict'));
        $list[] = $holiday;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of public holiday : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfContactTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $type = '', $module = '', $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    if ($type == 'expedition' && !getDolGlobalInt('SHIPPING_USE_ITS_OWN_CONTACTS')) {
      $type = 'commande';
    }
 
    $sql = "SELECT rowid, code, element as type, libelle as label, source, module, position";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_type_contact as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($type) {
      $sql .= " AND t.element LIKE '%".$this->db->escape($type)."%'";
    }
    if ($module) {
      $sql .= " AND t.module LIKE '%".$this->db->escape($module)."%'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $contact_type = $this->db->fetch_object($result);
        $this->translateLabel($contact_type, $lang, 'TypeContact_'.$contact_type->type.'_'.$contact_type->source.'_', array("eventorganization", "resource", "projects", "contracts", "bills", "orders", "agenda", "propal", "stocks", "supplier_proposal", "interventions", "sendings", "ticket"));
        $list[] = $contact_type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of contacts types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfCivilities($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $module = '', $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid, code, label, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_civility as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($module) {
      $sql .= " AND t.module LIKE '%".$this->db->escape($module)."%'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $civility = $this->db->fetch_object($result);
        $this->translateLabel($civility, $lang, 'Civility', array('dict'));
        $list[] = $civility;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of civility : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfCurrencies($multicurrency = 0, $sortfield = "code_iso", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
    $sql = "SELECT t.code_iso, t.label, t.unicode";
    if (!empty($multicurrency)) {
      $sql .= " , cr.date_sync, cr.rate ";
    }
    $sql .= " FROM ".MAIN_DB_PREFIX."c_currencies as t";
    if (!empty($multicurrency)) {
      $sql .= " JOIN ".MAIN_DB_PREFIX."multicurrency as m ON m.code=t.code_iso";
      $sql .= " JOIN ".MAIN_DB_PREFIX."multicurrency_rate as cr ON (m.rowid = cr.fk_multicurrency)";
    }
    $sql .= " WHERE t.active = ".((int) $active);
    if (!empty($multicurrency)) {
      $sql .= " AND m.entity IN (".getEntity('multicurrency').")";
      if (!empty($multicurrency) && $multicurrency != 2) {
        $sql .= " AND cr.date_sync = (SELECT MAX(cr2.date_sync) FROM ".MAIN_DB_PREFIX."multicurrency_rate AS cr2 WHERE cr2.fk_multicurrency = m.rowid)";
      }
    }
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of currency : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfExtrafields($sortfield = "t.pos", $sortorder = 'ASC', $elementtype = '', $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_EXTRAFIELDS') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_EXTRAFIELDS'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_GET_EXTRAFIELDS');
    }
 
    if ($elementtype == 'thirdparty') {
      $elementtype = 'societe';
    }
    if ($elementtype == 'contact') {
      $elementtype = 'socpeople';
    }
 
    $sql = "SELECT t.rowid as id, t.name, t.entity, t.elementtype, t.label, t.type, t.size, t.fieldcomputed, t.fielddefault,";
    $sql .= " t.fieldunique, t.fieldrequired, t.perms, t.enabled, t.pos, t.alwayseditable, t.param, t.list, t.printable,";
    $sql .= " t.totalizable, t.langs, t.help, t.css, t.cssview, t.csslist, t.fk_user_author, t.fk_user_modif, t.datec, t.tms";
    $sql .= " FROM ".MAIN_DB_PREFIX."extrafields as t";
    $sql .= " WHERE t.entity IN (".getEntity('extrafields').")";
    if (!empty($elementtype)) {
      $sql .= " AND t.elementtype = '".$this->db->escape($elementtype)."'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        while ($tab = $this->db->fetch_object($resql)) {
          // New usage
          $list[$tab->elementtype][$tab->name]['id'] = $tab->id;
          $list[$tab->elementtype][$tab->name]['type'] = $tab->type;
          $list[$tab->elementtype][$tab->name]['label'] = $tab->label;
          $list[$tab->elementtype][$tab->name]['size'] = $tab->size;
          $list[$tab->elementtype][$tab->name]['elementtype'] = $tab->elementtype;
          $list[$tab->elementtype][$tab->name]['default'] = $tab->fielddefault;
          $list[$tab->elementtype][$tab->name]['computed'] = $tab->fieldcomputed;
          $list[$tab->elementtype][$tab->name]['unique'] = $tab->fieldunique;
          $list[$tab->elementtype][$tab->name]['required'] = $tab->fieldrequired;
          $list[$tab->elementtype][$tab->name]['param'] = ($tab->param ? jsonOrUnserialize($tab->param) : '');  // This may be a string encoded with serialise() or json_encode()
          $list[$tab->elementtype][$tab->name]['pos'] = $tab->pos;
          $list[$tab->elementtype][$tab->name]['alwayseditable'] = $tab->alwayseditable;
          $list[$tab->elementtype][$tab->name]['perms'] = $tab->perms;
          $list[$tab->elementtype][$tab->name]['list'] = $tab->list;
          $list[$tab->elementtype][$tab->name]['printable'] = $tab->printable;
          $list[$tab->elementtype][$tab->name]['showintooltip'] = $tab->showintooltip;
          $list[$tab->elementtype][$tab->name]['totalizable'] = $tab->totalizable;
          $list[$tab->elementtype][$tab->name]['langs'] = $tab->langs;
          $list[$tab->elementtype][$tab->name]['help'] = $tab->help;
          $list[$tab->elementtype][$tab->name]['css'] = $tab->css;
          $list[$tab->elementtype][$tab->name]['cssview'] = $tab->cssview;
          $list[$tab->elementtype][$tab->name]['csslist'] = $tab->csslist;
          $list[$tab->elementtype][$tab->name]['fk_user_author'] = $tab->fk_user_author;
          $list[$tab->elementtype][$tab->name]['fk_user_modif'] = $tab->fk_user_modif;
          $list[$tab->elementtype][$tab->name]['datec'] = $tab->datec;
          $list[$tab->elementtype][$tab->name]['tms'] = $tab->tms;
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of extra fields : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function deleteExtrafieldsFromNames($attrname, $elementtype)
  {
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Only an admin user can delete an extrafield by attrname and elementtype');
    }
 
    $extrafields = new ExtraFields($this->db);
 
    $result = $extrafields->fetch_name_optionals_label($elementtype, false, $attrname);
    if (!$result) {
      throw new RestException(404, 'Extrafield not found from attrname and elementtype');
    }
 
    if (!$extrafields->delete($attrname, $elementtype)) {
      throw new RestException(500, 'Error when delete extrafield : '.$extrafields->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Extrafield deleted from attrname and elementtype'
      )
    );
  }
 
 
 
  public function getExtrafields($attrname, $elementtype)
  {
    $answer = array();
 
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Only an admin user can get list of extrafields');
    }
 
    if ($elementtype == 'thirdparty') {
      $elementtype = 'societe';
    }
    if ($elementtype == 'contact') {
      $elementtype = 'socpeople';
    }
 
    $sql = "SELECT t.rowid as id, t.name, t.entity, t.elementtype, t.label, t.type, t.size, t.fieldcomputed, t.fielddefault,";
    $sql .= " t.fieldunique, t.fieldrequired, t.perms, t.enabled, t.pos, t.alwayseditable, t.param, t.list, t.printable, t.showintooltip,";
    $sql .= " t.totalizable, t.langs, t.help, t.css, t.cssview, t.csslist, t.fk_user_author, t.fk_user_modif, t.datec, t.tms";
    $sql .= " FROM ".MAIN_DB_PREFIX."extrafields as t";
    $sql .= " WHERE t.entity IN (".getEntity('extrafields').")";
    $sql .= " AND t.elementtype = '".$this->db->escape($elementtype)."'";
    $sql .= " AND t.name = '".$this->db->escape($attrname)."'";
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        while ($tab = $this->db->fetch_object($resql)) {
          // New usage
          $answer[$tab->elementtype][$tab->name]['id'] = $tab->id;
          $answer[$tab->elementtype][$tab->name]['type'] = $tab->type;
          $answer[$tab->elementtype][$tab->name]['label'] = $tab->label;
          $answer[$tab->elementtype][$tab->name]['size'] = $tab->size;
          $answer[$tab->elementtype][$tab->name]['elementtype'] = $tab->elementtype;
          $answer[$tab->elementtype][$tab->name]['default'] = $tab->fielddefault;
          $answer[$tab->elementtype][$tab->name]['computed'] = $tab->fieldcomputed;
          $answer[$tab->elementtype][$tab->name]['unique'] = $tab->fieldunique;
          $answer[$tab->elementtype][$tab->name]['required'] = $tab->fieldrequired;
          $answer[$tab->elementtype][$tab->name]['param'] = ($tab->param ? jsonOrUnserialize($tab->param) : '');  // This may be a string encoded with serialise() or json_encode()
          $answer[$tab->elementtype][$tab->name]['pos'] = $tab->pos;
          $answer[$tab->elementtype][$tab->name]['alwayseditable'] = $tab->alwayseditable;
          $answer[$tab->elementtype][$tab->name]['perms'] = $tab->perms;
          $answer[$tab->elementtype][$tab->name]['list'] = $tab->list;
          $answer[$tab->elementtype][$tab->name]['printable'] = $tab->printable;
          $answer[$tab->elementtype][$tab->name]['showintooltip'] = $tab->showintooltip;
          $answer[$tab->elementtype][$tab->name]['totalizable'] = $tab->totalizable;
          $answer[$tab->elementtype][$tab->name]['langs'] = $tab->langs;
          $answer[$tab->elementtype][$tab->name]['help'] = $tab->help;
          $answer[$tab->elementtype][$tab->name]['css'] = $tab->css;
          $answer[$tab->elementtype][$tab->name]['cssview'] = $tab->cssview;
          $answer[$tab->elementtype][$tab->name]['csslist'] = $tab->csslist;
          $answer[$tab->elementtype][$tab->name]['fk_user_author'] = $tab->fk_user_author;
          $answer[$tab->elementtype][$tab->name]['fk_user_modif'] = $tab->fk_user_modif;
          $answer[$tab->elementtype][$tab->name]['datec'] = $tab->datec;
          $answer[$tab->elementtype][$tab->name]['tms'] = $tab->tms;
        }
      } else {
        throw new RestException(404, 'Extrafield not found from attrname and elementtype');
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of extra fields : '.$this->db->lasterror());
    }
 
    return $answer;
  }
 
  public function postExtrafields($attrname, $elementtype, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Only an admin user can create an extrafield');
    }
 
    $extrafields = new ExtraFields($this->db);
 
    $result = $extrafields->fetch_name_optionals_label($elementtype, false, $attrname);
    if ($result) {
      throw new RestException(409, 'Duplicate extrafield already found from attrname and elementtype');
    }
 
    // Check mandatory fields is not working despise being a modified copy from api_thirdparties.class.php
    // $result = $this->_validateExtrafields($request_data, $extrafields);
 
    foreach ($request_data as $field => $value) {
      $extrafields->$field = $this->_checkValForAPI($field, $value, $extrafields);
    }
 
    $entity = DolibarrApiAccess::$user->entity;
    if (empty($entity)) {
      $entity = 1;
    }
 
    // built in validation
    $enabled = 1; // hardcoded because it seems to always be 1 in every row in the database
 
    if ($request_data['label']) {
      $label = $request_data['label'];
    } else {
      throw new RestException(400, "label field absent in json at root level");
    }
 
    $alwayseditable = $request_data['alwayseditable'];
    $default_value = $request_data['default'];
    $totalizable = $request_data['totalizable'];
    $printable = $request_data['printable'];
    $showintooltip = $request_data['showintooltip'];
    $required = $request_data['required'];
    $langfile = $request_data['langfile'];
    $computed = $request_data['computed'];
    $unique = $request_data['unique'];
    $param = $request_data['param'];
    $perms = $request_data['perms'];
    $size = $request_data['size'];
    $type = $request_data['type'];
    $list = $request_data['list'];
    $help = $request_data['help'];
    $pos = $request_data['pos'];
    $moreparams = array();
 
    if (0 > $extrafields->addExtraField($attrname, $label, $type, (int) $pos, $size, $elementtype, (int) $unique, (int) $required, $default_value, $param, (int) $alwayseditable, $perms, $list, $help, $computed, (string) $entity, $langfile, (string) $enabled, (int) $totalizable, (int) $printable, $moreparams)) {
      throw new RestException(500, 'Error creating extrafield', array_merge(array($extrafields->errno), $extrafields->errors));
    }
 
    $sql = "SELECT t.rowid as id";
    $sql .= " FROM ".MAIN_DB_PREFIX."extrafields as t";
    $sql .= " WHERE elementtype = '".$this->db->escape($elementtype)."'";
    $sql .= " AND name = '".$this->db->escape($attrname)."'";
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $tab = $this->db->fetch_object($resql);
        $id = (int) $tab->id;
      } else {
        $id = (int) -1;
      }
    } else {
      $id = (int) -2;
    }
 
    return $id;
  }
 
  public function updateExtrafields($attrname, $elementtype, $request_data = null)
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Only an admin user can create an extrafield');
    }
 
    $extrafields = new ExtraFields($this->db);
 
    $result = $extrafields->fetch_name_optionals_label($elementtype, false, $attrname);
    if (!$result) {
      throw new RestException(404, 'Extrafield not found from attrname and elementtype');
    }
 
    foreach ($request_data as $field => $value) {
      $extrafields->$field = $this->_checkValForAPI($field, $value, $extrafields);
    }
 
    $entity = DolibarrApiAccess::$user->entity;
    if (empty($entity)) {
      $entity = 1;
    }
 
    // built in validation
    $enabled = 1; // hardcoded because it seems to always be 1 in every row in the database
    if ($request_data['label']) {
      $label = $request_data['label'];
    } else {
      throw new RestException(400, "label field absent in json at root level");
    }
 
    $alwayseditable = $request_data['alwayseditable'];
    $default_value = $request_data['default'];
    $totalizable = $request_data['totalizable'];
    $printable = $request_data['printable'];
    $showintooltip = $request_data['showintooltip'];
    $required = $request_data['required'];
    $langfile = $request_data['langfile'];
    $computed = $request_data['computed'];
    $unique = $request_data['unique'];
    $param = $request_data['param'];
    $perms = $request_data['perms'];
    $size = $request_data['size'];
    $type = $request_data['type'];
    $list = $request_data['list'];
    $help = $request_data['help'];
    $pos = $request_data['pos'];
    $moreparams = array();
 
    if (0 > $extrafields->updateExtraField($attrname, $label, $type, (int) $pos, $size, $elementtype, (int) $unique, (int) $required, $default_value, $param, (int) $alwayseditable, $perms, $list, $help, $computed, (string) $entity, $langfile, (string) $enabled, (int) $totalizable, (int) $printable, $moreparams)) {
      throw new RestException(500, 'Error updating extrafield', array_merge(array($extrafields->errno), $extrafields->errors));
    }
 
    $sql = "SELECT t.rowid as id";
    $sql .= " FROM ".MAIN_DB_PREFIX."extrafields as t";
    $sql .= " WHERE elementtype = '".$this->db->escape($elementtype)."'";
    $sql .= " AND name = '".$this->db->escape($attrname)."'";
 
    $resql = $this->db->query($sql);
    if ($resql) {
      if ($this->db->num_rows($resql)) {
        $tab = $this->db->fetch_object($resql);
        $id = (int) $tab->id;
      } else {
        $id = (int) -1;
      }
    } else {
      $id = (int) -2;
    }
 
    return $id;
  }
 
  public function getListOfTowns($sortfield = "zip,town", $sortorder = 'ASC', $limit = 100, $page = 0, $zipcode = '', $town = '', $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid AS id, zip, town, fk_county, fk_pays AS fk_country";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_ziptown as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($zipcode) {
      $sql .= " AND t.zip LIKE '%".$this->db->escape($zipcode)."%'";
    }
    if ($town) {
      $sql .= " AND t.town LIKE '%".$this->db->escape($town)."%'";
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of towns : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getPaymentTerms($sortfield = "sortorder", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->hasRight('propal', 'lire') && !DolibarrApiAccess::$user->hasRight('commande', 'lire') && !DolibarrApiAccess::$user->hasRight('facture', 'lire')) {
      throw new RestException(403);
    }
 
    $sql = "SELECT rowid as id, code, sortorder, libelle as label, libelle_facture as descr, type_cdr, nbjour, decalage, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_payment_term as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_payment_term').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getShippingModes($limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid as id, code, libelle as label, description, tracking, module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_shipment_mode as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_shipment_mode').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    //$sql.= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $method = $this->db->fetch_object($result);
        $this->translateLabel($method, $lang, '', array('dict'));
        $list[] = $method;
      }
    } else {
      throw new RestException(503, $this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfMeasuringUnits($sortfield = "rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT t.rowid, t.code, t.label,t.short_label, t.active, t.scale, t.unit_type";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_units as t";
    $sql .= " WHERE t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of measuring units: '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfLegalForm($sortfield = "rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $country = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT t.rowid, t.code, t.fk_pays, t.libelle, t.isvatexempted, t.active, t.module, t.position";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_forme_juridique as t";
    $sql .= " WHERE t.active = ".((int) $active);
    if ($country) {
      $sql .= " AND t.fk_pays = ".((int) $country);
    }
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of legal form: '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfStaff($sortfield = "id", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT t.id, t.code, t.libelle, t.active, t.module";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_effectif as t";
    $sql .= " WHERE t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of staff: '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfsocialNetworks($sortfield = "rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $sqlfilters = '')
  {
    global $conf;
 
    if (!isModEnabled('socialnetworks')) {
      throw new RestException(400, 'API not available: this dictionary is not enabled by setup');
    }
 
    $list = array();
    //TODO link with multicurrency module
    $sql = "SELECT t.rowid, t.entity, t.code, t.label, t.url, t.icon, t.active";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_socialnetworks as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_socialnetworks').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of social networks: '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getTicketsCategories($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid, code, pos,  label, use_default, description";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_ticket_category as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_ticket_category').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $category = $this->db->fetch_object($result);
        $this->translateLabel($category, $lang, 'TicketCategoryShort', array('ticket'));
        $list[] = $category;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of ticket categories : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getTicketsSeverities($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid, code, pos,  label, use_default, color, description";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_ticket_severity as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_ticket_severity').")";
    $sql .= " AND t.active = ".((int) $active);
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $severity = $this->db->fetch_object($result);
        $this->translateLabel($severity, $lang, 'TicketSeverityShort', array('ticket'));
        $list[] = $severity;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of ticket severities : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getTicketsTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid, code, pos,  label, use_default, description";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_ticket_type as t";
    $sql .= " WHERE t.entity IN (".getEntity('c_ticket_type').")";
    $sql .= " AND t.active = ".((int) $active);
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $type = $this->db->fetch_object($result);
        $this->translateLabel($type, $lang, 'TicketTypeShort', array('ticket'));
        $list[] = $type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of ticket types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getThirdpartiesTypes($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT id, code, libelle as label, fk_country, module, position";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_typent as t";
    $sql .= " WHERE t.active = ".((int) $active);
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $type = $this->db->fetch_object($result);
        $this->translateLabel($type, $lang, '', array('companies'));
        $list[] = $type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of thirdparty types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfIncoterms($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $lang = '', $sqlfilters = '')
  {
    $list = array();
 
    $sql = "SELECT rowid, code, active";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_incoterms as t";
    $sql .= " WHERE 1=1";
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $type = $this->db->fetch_object($result);
        $list[] = $type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of incoterm types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getListOfVAT($sortfield = "taux", $sortorder = 'ASC', $limit = 100, $page = 0, $active = 1, $fk_country = -1, $sqlfilters = '')
  {
    $list = array();
    global $mysoc;
 
    $sql = "SELECT rowid, code, type_vat, active, fk_pays, taux, localtax1, localtax2,  localtax1_type, localtax2_type, note";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_tva as t";
    $sql .= " WHERE 1=1";
 
    // Add sql filters
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
    if ($active != -1)
      $sql .= " AND active = ".((int) $active);
 
    if ($fk_country == -1)
      $sql .= " AND fk_pays =".((int) $mysoc->country_id);
 
    if ($fk_country >0)
      $sql .= " AND fk_pays =".((int) $fk_country);
 
    $sql .= $this->db->order($sortfield, $sortorder);
 
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $type = $this->db->fetch_object($result);
        $list[] = $type;
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of vat types : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getCompany()
  {
    global $mysoc;
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_COMPANY') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_COMPANY'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_GET_COMPANY');
    }
 
    unset($mysoc->pays);
    unset($mysoc->note);
    unset($mysoc->nom);
 
    unset($mysoc->lines);
 
    unset($mysoc->effectif);
    unset($mysoc->effectif_id);
    unset($mysoc->forme_juridique_code);
    unset($mysoc->forme_juridique);
    unset($mysoc->mode_reglement_supplier_id);
    unset($mysoc->cond_reglement_supplier_id);
    unset($mysoc->transport_mode_supplier_id);
    unset($mysoc->fk_prospectlevel);
 
    unset($mysoc->total_ht);
    unset($mysoc->total_tva);
    unset($mysoc->total_localtax1);
    unset($mysoc->total_localtax2);
    unset($mysoc->total_ttc);
 
    unset($mysoc->lastname);
    unset($mysoc->firstname);
    unset($mysoc->civility_id);
 
    unset($mysoc->client);
    unset($mysoc->prospect);
    unset($mysoc->fournisseur);
    unset($mysoc->contact_id);
 
    unset($mysoc->fk_incoterms);
    unset($mysoc->label_incoterms);
    unset($mysoc->location_incoterms);
 
    unset($mysoc->supplierCategories);
    unset($mysoc->prefixCustomerIsRequired);
 
    return $this->_cleanObjectDatas($mysoc);
  }
 
  public function getEstablishments()
  {
    $list = array();
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Error API open to admin users only');
    }
 
    $limit = 0;
 
    $sql = "SELECT e.rowid, e.rowid as ref, e.label, e.address, e.zip, e.town, e.status";
    $sql .= " FROM ".MAIN_DB_PREFIX."establishment as e";
    $sql .= " WHERE e.entity IN (".getEntity('establishment').')';
    // if ($type) $sql .= " AND t.type LIKE '%".$this->db->escape($type)."%'";
    // if ($module)    $sql .= " AND t.module LIKE '%".$this->db->escape($module)."%'";
    // Add sql filters
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      for ($i = 0; $i < $min; $i++) {
        $list[] = $this->db->fetch_object($result);
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of establishments : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getEtablishmentByID($id)
  {
    if (!DolibarrApiAccess::$user->admin) {
      throw new RestException(403, 'Error API open to admin users only');
    }
 
    $establishment = new Establishment($this->db);
 
    $result = $establishment->fetch($id);
    if ($result < 0) {
      throw new RestException(503, 'Error when retrieving establishment : '.$establishment->error);
    } elseif ($result == 0) {
      throw new RestException(404, 'Establishment not found');
    }
    if (!in_array($establishment->entity, explode(',', getEntity('establishment')))) {
      throw new RestException(404, 'Establishment not found');
    }
 
    return $this->_cleanObjectDatas($establishment);
  }
 
  public function getConf($constantname)
  {
    global $conf;
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_CONST_READ');
    }
 
    if (!preg_match('/^[a-zA-Z0-9_]+$/', $constantname) || !isset($conf->global->$constantname)) {
      throw new RestException(400, 'Error Bad or unknown value for constantname');
    }
    if (isASecretKey($constantname)) {
      throw new RestException(403, 'Forbidden. This parameter can not be read with APIs');
    }
 
    return getDolGlobalString($constantname);
  }
 
  public function getConfs()
  {
    $list = array();
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_CONST_READ'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_CONST_READ');
    }
 
    $sql = "select name, value";
    $sql .= " FROM ".MAIN_DB_PREFIX."const";
    $sql .= " WHERE entity IN (".getEntity('const').')';
 
    $result = $this->db->query($sql);
 
    if ($result) {
      $num = $this->db->num_rows($result);
      for ($i = 0; $i < $num; $i++) {
        $obj = $this->db->fetch_object($result);
        if (!isASecretKey($obj->name)) {
          // We do not return secret keys
          $list[$obj->name] = $obj->value;
        }
      }
    } else {
      throw new RestException(503, 'Error when retrieving list of const : '.$this->db->lasterror());
    }
 
    return $list;
  }
 
  public function getCheckIntegrity($target)
  {
    global $langs, $conf;
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_INTEGRITY_CHECK') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_INTEGRITY_CHECK'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_INTEGRITY_CHECK');
    }
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
    require_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
 
    $langs->load("admin");
 
    $outexpectedchecksum = '';
    $outcurrentchecksum = '';
 
    // Modified or missing files
    $file_list = array('missing' => array(), 'updated' => array());
 
    // Local file to compare to
    $xmlshortfile = dol_sanitizeFileName('filelist-'.DOL_VERSION.getDolGlobalString('MAIN_FILECHECK_LOCAL_SUFFIX').'.xml'.getDolGlobalString('MAIN_FILECHECK_LOCAL_EXT'));
 
    $xmlfile = DOL_DOCUMENT_ROOT.'/install/'.$xmlshortfile;
    if (!preg_match('/\.zip$/i', $xmlfile) && dol_is_file($xmlfile.'.zip')) {
      $xmlfile .= '.zip';
    }
 
    // Remote file to compare to
    $xmlremote = (($target == 'default' || $target == 'local') ? '' : $target);
    if (empty($xmlremote) && getDolGlobalString('MAIN_FILECHECK_URL')) {
      $xmlremote = getDolGlobalString('MAIN_FILECHECK_URL');
    }
    $param = 'MAIN_FILECHECK_URL_'.DOL_VERSION;
    if (empty($xmlremote) && getDolGlobalString($param)) {
      $xmlremote = getDolGlobalString($param);
    }
    if (empty($xmlremote)) {
      $xmlremote = 'https://www.dolibarr.org/files/stable/signatures/filelist-'.DOL_VERSION.'.xml';
    }
    if ($xmlremote && !preg_match('/^https?:\/\//i', $xmlremote)) {
      $langs->load("errors");
      throw new RestException(500, $langs->trans("ErrorURLMustStartWithHttp", $xmlremote));
    }
    if ($xmlremote && !preg_match('/\.xml$/', $xmlremote)) {
      $langs->load("errors");
      throw new RestException(500, $langs->trans("ErrorURLMustEndWith", $xmlremote, '.xml'));
    }
 
    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);
    }
 
    if ($target == 'local') {
      if (dol_is_file($xmlfile)) {
        $xml = simplexml_load_file($xmlfile);
      } else {
        throw new RestException(500, $langs->trans('XmlNotFound').': /install/'.$xmlshortfile);
      }
    } else {
      $xmlarray = getURLContent($xmlremote, 'GET', '', 1, array(), array('http', 'https'), 0);  // Accept http or https links on external remote server only. Same is used into filecheck.php.
 
      // Return array('content'=>response,'curl_error_no'=>errno,'curl_error_msg'=>errmsg...)
      if (!$xmlarray['curl_error_no'] && $xmlarray['http_code'] != 400 && $xmlarray['http_code'] != 404) {
        $xmlfile = $xmlarray['content'];
        //print "xmlfilestart".$xmlfile."endxmlfile";
        $xml = simplexml_load_string($xmlfile, 'SimpleXMLElement', LIBXML_NOCDATA | LIBXML_NONET);
      } else {
        $errormsg = $langs->trans('XmlNotFound').': '.$xmlremote.' - '.$xmlarray['http_code'].(($xmlarray['http_code'] == 400 && $xmlarray['content']) ? ' '.$xmlarray['content'] : '').' '.$xmlarray['curl_error_no'].' '.$xmlarray['curl_error_msg'];
        throw new RestException(500, $errormsg);
      }
    }
 
    if ($xml) {
      $checksumconcat = array();
      $file_list = array();
      $out = '';
 
      // Forced constants
      if (is_object($xml->dolibarr_constants[0])) {
        $out .= load_fiche_titre($langs->trans("ForcedConstants"));
 
        $out .= '<div class="div-table-responsive-no-min">';
        $out .= '<table class="noborder">';
        $out .= '<tr class="liste_titre">';
        $out .= '<td>#</td>';
        $out .= '<td>'.$langs->trans("Constant").'</td>';
        $out .= '<td class="center">'.$langs->trans("ExpectedValue").'</td>';
        $out .= '<td class="center">'.$langs->trans("Value").'</td>';
        $out .= '</tr>'."\n";
 
        $i = 0;
        foreach ($xml->dolibarr_constants[0]->constant as $constant) {    // $constant is a simpleXMLElement
          $constname = $constant['name'];
          $constvalue = (string) $constant;
          $constvalue = (empty($constvalue) ? '0' : $constvalue);
          // Value found
          $value = '';
          if ($constname && getDolGlobalString($constname) != '') {
            $value = getDolGlobalString($constname);
          }
          $valueforchecksum = (empty($value) ? '0' : $value);
 
          $checksumconcat[] = $valueforchecksum;
 
          $i++;
          $out .= '<tr class="oddeven">';
          $out .= '<td>'.$i.'</td>'."\n";
          $out .= '<td>'.dol_escape_htmltag($constname).'</td>'."\n";
          $out .= '<td class="center">'.dol_escape_htmltag($constvalue).'</td>'."\n";
          $out .= '<td class="center">'.dol_escape_htmltag($valueforchecksum).'</td>'."\n";
          $out .= "</tr>\n";
        }
 
        if ($i == 0) {
          $out .= '<tr class="oddeven"><td colspan="4" class="opacitymedium">'.$langs->trans("None").'</td></tr>';
        }
        $out .= '</table>';
        $out .= '</div>';
 
        $out .= '<br>';
      }
 
      // Scan htdocs
      if (is_object($xml->dolibarr_htdocs_dir[0])) {
        $includecustom = (empty($xml->dolibarr_htdocs_dir[0]['includecustom']) ? 0 : $xml->dolibarr_htdocs_dir[0]['includecustom']);
 
        // Define qualified files (must be same than into generate_filelist_xml.php and in api_setup.class.php)
        $regextoinclude = '\.(php|php3|php4|php5|phtml|phps|phar|inc|css|scss|html|xml|js|json|tpl|jpg|jpeg|png|gif|ico|sql|lang|txt|yml|bak|md|mp3|mp4|wav|mkv|z|gz|zip|rar|tar|less|svg|eot|woff|woff2|ttf|manifest)$';
        $regextoexclude = '('.($includecustom ? '' : 'custom|').'documents|escpos-php\/doc|escpos-php\/example|escpos-php\/test|conf|install|dejavu-fonts-ttf-.*|public\/test|sabre\/sabre\/.*\/tests|Shared\/PCLZip|nusoap\/lib\/Mail|php\/test|geoip\/sample.*\.php|ckeditor\/samples|ckeditor\/adapters)$';  // Exclude dirs
        $scanfiles = dol_dir_list(DOL_DOCUMENT_ROOT, 'files', 1, $regextoinclude, $regextoexclude);
 
        // Fill file_list with files in signature, new files, modified files
        $ret = getFilesUpdated($file_list, $xml->dolibarr_htdocs_dir[0], '', DOL_DOCUMENT_ROOT, $checksumconcat); // Fill array $file_list
        '@phan-var-force array{insignature:string[],missing?:array<array{filename:string,expectedmd5:string,expectedsize:string}>,updated:array<array{filename:string,expectedmd5:string,expectedsize:string,md5:string}>} $file_list';
        // Complete with list of new files
        foreach ($scanfiles as $keyfile => $valfile) {
          $tmprelativefilename = preg_replace('/^'.preg_quote(DOL_DOCUMENT_ROOT, '/').'/', '', $valfile['fullname']);
          if (!in_array($tmprelativefilename, $file_list['insignature'])) {
            $md5newfile = @md5_file($valfile['fullname']); // Can fails if we don't have permission to open/read file
            $file_list['added'][] = array('filename' => $tmprelativefilename, 'md5' => $md5newfile);
          }
        }
 
        // Files missing
        $out .= load_fiche_titre($langs->trans("FilesMissing"));
 
        $out .= '<div class="div-table-responsive-no-min">';
        $out .= '<table class="noborder">';
        $out .= '<tr class="liste_titre">';
        $out .= '<td>#</td>';
        $out .= '<td>'.$langs->trans("Filename").'</td>';
        $out .= '<td class="center">'.$langs->trans("ExpectedChecksum").'</td>';
        $out .= '</tr>'."\n";
        $tmpfilelist = dol_sort_array($file_list['missing'], 'filename');
        if (is_array($tmpfilelist) && count($tmpfilelist)) {
          $i = 0;
          foreach ($tmpfilelist as $file) {
            $i++;
            $out .= '<tr class="oddeven">';
            $out .= '<td>'.$i.'</td>'."\n";
            $out .= '<td>'.dol_escape_htmltag($file['filename']).'</td>'."\n";
            $out .= '<td class="center">'.(array_key_exists('expectedmd5', $file) ? $file['expectedmd5'] : '').'</td>'."\n";
            $out .= "</tr>\n";
          }
        } else {
          $out .= '<tr class="oddeven"><td colspan="3" class="opacitymedium">'.$langs->trans("None").'</td></tr>';
        }
        $out .= '</table>';
        $out .= '</div>';
 
        $out .= '<br>';
 
        // Files modified
        $out .= load_fiche_titre($langs->trans("FilesModified"));
 
        $totalsize = 0;
        $out .= '<div class="div-table-responsive-no-min">';
        $out .= '<table class="noborder">';
        $out .= '<tr class="liste_titre">';
        $out .= '<td>#</td>';
        $out .= '<td>'.$langs->trans("Filename").'</td>';
        $out .= '<td class="center">'.$langs->trans("ExpectedChecksum").'</td>';
        $out .= '<td class="center">'.$langs->trans("CurrentChecksum").'</td>';
        $out .= '<td class="right">'.$langs->trans("Size").'</td>';
        $out .= '<td class="right">'.$langs->trans("DateModification").'</td>';
        $out .= '</tr>'."\n";
        $tmpfilelist2 = dol_sort_array($file_list['updated'], 'filename');
        if (is_array($tmpfilelist2) && count($tmpfilelist2)) {
          $i = 0;
          foreach ($tmpfilelist2 as $file) {
            $i++;
            $out .= '<tr class="oddeven">';
            $out .= '<td>'.$i.'</td>'."\n";
            $out .= '<td>'.dol_escape_htmltag($file['filename']).'</td>'."\n";
            $out .= '<td class="center">'.$file['expectedmd5'].'</td>'."\n";
            $out .= '<td class="center">'.$file['md5'].'</td>'."\n";
            $size = dol_filesize(DOL_DOCUMENT_ROOT.'/'.$file['filename']);
            $totalsize += $size;
            $out .= '<td class="right">'.dol_print_size($size).'</td>'."\n";
            $out .= '<td class="right">'.dol_print_date(dol_filemtime(DOL_DOCUMENT_ROOT.'/'.$file['filename']), 'dayhour').'</td>'."\n";
            $out .= "</tr>\n";
          }
          $out .= '<tr class="liste_total">';
          $out .= '<td></td>'."\n";
          $out .= '<td>'.$langs->trans("Total").'</td>'."\n";
          $out .= '<td align="center"></td>'."\n";
          $out .= '<td align="center"></td>'."\n";
          $out .= '<td class="right">'.dol_print_size($totalsize).'</td>'."\n";
          $out .= '<td class="right"></td>'."\n";
          $out .= "</tr>\n";
        } else {
          $out .= '<tr class="oddeven"><td colspan="5" class="opacitymedium">'.$langs->trans("None").'</td></tr>';
        }
        $out .= '</table>';
        $out .= '</div>';
 
        $out .= '<br>';
 
        // Files added
        $out .= load_fiche_titre($langs->trans("FilesAdded"));
 
        $totalsize = 0;
        $out .= '<div class="div-table-responsive-no-min">';
        $out .= '<table class="noborder">';
        $out .= '<tr class="liste_titre">';
        $out .= '<td>#</td>';
        $out .= '<td>'.$langs->trans("Filename").'</td>';
        $out .= '<td class="center">'.$langs->trans("ExpectedChecksum").'</td>';
        $out .= '<td class="center">'.$langs->trans("CurrentChecksum").'</td>';
        $out .= '<td class="right">'.$langs->trans("Size").'</td>';
        $out .= '<td class="right">'.$langs->trans("DateModification").'</td>';
        $out .= '</tr>'."\n";
        $tmpfilelist3 = dol_sort_array($file_list['added'], 'filename');
        if (is_array($tmpfilelist3) && count($tmpfilelist3)) {
          $i = 0;
          foreach ($tmpfilelist3 as $file) {
            $i++;
            $out .= '<tr class="oddeven">';
            $out .= '<td>'.$i.'</td>'."\n";
            $out .= '<td>'.dol_escape_htmltag($file['filename']).'</td>'."\n";
            $out .= '<td class="center">'.$file['expectedmd5'].'</td>'."\n";  // @phan-suppress-current-line PhanTypeInvalidDimOffset,PhanTypeSuspiciousStringExpression
            $out .= '<td class="center">'.$file['md5'].'</td>'."\n";
            $size = dol_filesize(DOL_DOCUMENT_ROOT.'/'.$file['filename']);
            $totalsize += $size;
            $out .= '<td class="right">'.dol_print_size($size).'</td>'."\n";
            $out .= '<td class="right">'.dol_print_date(dol_filemtime(DOL_DOCUMENT_ROOT.'/'.$file['filename']), 'dayhour').'</td>'."\n";
            $out .= "</tr>\n";
          }
          $out .= '<tr class="liste_total">';
          $out .= '<td></td>'."\n";
          $out .= '<td>'.$langs->trans("Total").'</td>'."\n";
          $out .= '<td align="center"></td>'."\n";
          $out .= '<td align="center"></td>'."\n";
          $out .= '<td class="right">'.dol_print_size($totalsize).'</td>'."\n";
          $out .= '<td class="right"></td>'."\n";
          $out .= "</tr>\n";
        } else {
          $out .= '<tr class="oddeven"><td colspan="5" class="opacitymedium">'.$langs->trans("None").'</td></tr>';
        }
        $out .= '</table>';
        $out .= '</div>';
 
 
        // Show warning
        if (empty($tmpfilelist) && empty($tmpfilelist2) && empty($tmpfilelist3)) {
          //setEventMessages($langs->trans("FileIntegrityIsStrictlyConformedWithReference"), null, 'mesgs');
        } else {
          //setEventMessages($langs->trans("FileIntegritySomeFilesWereRemovedOrModified"), null, 'warnings');
        }
      } else {
        throw new RestException(500, 'Error: Failed to found dolibarr_htdocs_dir into XML file '.$xmlfile);
      }
 
 
      // Scan scripts
      asort($checksumconcat); // Sort list of checksum
      $checksumget = md5(implode(',', $checksumconcat));
      $checksumtoget = trim((string) $xml->dolibarr_htdocs_dir_checksum);
 
      $outexpectedchecksum = ($checksumtoget ? $checksumtoget : $langs->trans("Unknown"));
      if ($checksumget == $checksumtoget) {
        if (count($file_list['added'])) {
          $resultcode = 'warning';
          $resultcomment = 'FileIntegrityIsOkButFilesWereAdded';
          //$outcurrentchecksum =  $checksumget.' - <span class="'.$resultcode.'">'.$langs->trans("FileIntegrityIsOkButFilesWereAdded").'</span>';
          $outcurrentchecksum = $checksumget;
        } else {
          $resultcode = 'ok';
          $resultcomment = 'Success';
          //$outcurrentchecksum = '<span class="'.$resultcode.'">'.$checksumget.'</span>';
          $outcurrentchecksum = $checksumget;
        }
      } else {
        $resultcode = 'error';
        $resultcomment = 'Error';
        //$outcurrentchecksum = '<span class="'.$resultcode.'">'.$checksumget.'</span>';
        $outcurrentchecksum = $checksumget;
      }
    } else {
      throw new RestException(404, 'No signature file known');
    }
 
    return array('resultcode' => $resultcode, 'resultcomment' => $resultcomment, 'expectedchecksum' => $outexpectedchecksum, 'currentchecksum' => $outcurrentchecksum, 'out' => $out);
  }
 
  public function getModules()
  {
    dol_syslog("Setup::getModules is DEPRECATED, use /api/index.php/setup/modules/status", LOG_INFO);
    global $conf;
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_GET_MODULES');
    }
 
    sort($conf->modules);
 
    return $conf->modules;
  }
 
  public function getModulesList($status = "active", $origin = 'all')
  {
    global $db;
    $moduleObject = new DolibarrModules($this->db);
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_GET_MODULES');
    }
 
    $filename = array();
    $modulesdir = dolGetModulesDirs();
    foreach ($modulesdir as $dir) {
      // Load modules attributes in arrays (name, numero, orders) from dir directory
      //print $dir."\n<br>";
      dol_syslog("Scan directory ".$dir." for module descriptor files (modXXX.class.php)");
      $handle = @opendir($dir);
      if (is_resource($handle)) {
        while (($file = readdir($handle)) !== false) {
          //print "$i ".$file."\n<br>";
          if (is_readable($dir.$file) && substr($file, 0, 3) == 'mod' && substr($file, dol_strlen($file) - 10) == '.class.php') {
            $modName = substr($file, 0, dol_strlen($file) - 10);
            include_once $dir.$file; // A class already exists in a different file will send a non catchable fatal error.
            if (class_exists($modName)) {
              $objMod = new $modName($db);
              $moduleName = strtoupper(preg_replace('/^mod/i', '', get_class($objMod)));
              $publisher = dol_escape_htmltag((string) $moduleObject->getPublisher());
              $external = ((string) $moduleObject->isCoreOrExternalModule() == 'external');
              $active = getDolGlobalString('MAIN_MODULE_'.$moduleName);
              $version = $objMod->version;
              if ($status != 'all') {
                if ($status == 'active' && $active == "") {
                  continue;
                } elseif ($status == 'disabled' && $active == 1) {
                  continue;
                }
              }
              if ($origin != 'all') {
                if ($origin == 'external' && !$external) {
                  continue;
                } elseif ($origin == 'core' && $external) {
                  continue;
                }
              }
 
              $filename[$moduleName] = array(
                'modName' => $modName,
                'origin' => $external ? 'external' : 'core',
                'active' => $active,
                'publisher' => $publisher,
                'version' => $version
              );
            }
          }
        }
      }
    }
    return $filename;
  }
 
  public function enableModules($modulename)
  {
    return $this->_moduleOnOff($modulename, $state = true);
  }
  public function disableModules($modulename)
  {
    return $this->_moduleOnOff($modulename, $state = false);
  }
 
  private function _moduleOnOff($modulename, $state = false)
  {
    global $db;
 
    if (!DolibarrApiAccess::$user->admin
      && (!getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES') || DolibarrApiAccess::$user->login != getDolGlobalString('API_LOGINS_ALLOWED_FOR_GET_MODULES'))) {
      throw new RestException(403, 'Error API open to admin users only or to the users with logins defined into constant API_LOGINS_ALLOWED_FOR_GET_MODULES');
    }
 
    $modulesdir = dolGetModulesDirs();
    foreach ($modulesdir as $dir) {
      $handle = @opendir($dir);
      if (is_resource($handle)) {
        while (($file = readdir($handle)) !== false) {
          if (is_readable($dir.$file) && substr($file, 0, 3) == 'mod' && substr($file, dol_strlen($file) - 10) == '.class.php') {
            // print $modulename. "==".substr($file, 0, dol_strlen($file) - 10)."\n";
            if ($modulename == substr($file, 0, dol_strlen($file) - 10)) {
              $modName = substr($file, 0, dol_strlen($file) - 10);
              include_once $dir.$file; // A class already exists in a different file will send a non catchable fatal error.
              if (class_exists($modName)) {
                $objMod = new $modName($db);
                //$name = strtoupper(preg_replace('/^mod/i', '', get_class($objMod)));
                if ($state) {
                  activateModule($modulename, 1, 0);
                  return array('result' => 'success', 'message' => 'Module '.$this->db->escape($modulename).' activated');
                } else {
                  unActivateModule($modulename);
                  return array('result' => 'success', 'message' => 'Module '.$this->db->escape($modulename).' deactivated');
                }
              }
            }
          }
        }
      }
    }
    throw new RestException(404, 'Module '.$this->db->escape($modulename).' not found');
  }
}