multicurrency.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2020  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014       Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2015       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2015       Raphaël Doursenaud  <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2016       Pierre-Henry Favre  <phf@atm-consulting.fr>
 * Copyright (C) 2024-2026  Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024-2026  MDW             <mdeweerd@users.noreply.github.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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT.'/multicurrency/class/currencyrate.class.php';
 
class MultiCurrency extends CommonObject
{
  public $element = 'multicurrency';
 
  public $table_element = 'multicurrency';
 
  public $table_element_line = "multicurrency_rate";
 
  public $rates = array();
 
  public $id;
 
  public $code;
 
  public $name;
 
  public $date_create;
 
  public $fk_user;
 
  public $rate;
 
  public $rate_direct;
 
  public $urlendpoint;
 
 
  const MULTICURRENCY_APP_ENDPOINT_DEFAULT = 'https://api.currencylayer.com/live?access_key=__MULTICURRENCY_APP_KEY__&source=__MULTICURRENCY_APP_SOURCE__';
 
  // Frankfurter (frankfurter.dev): free, no API key, ECB reference rates (~30 currencies).
  // Unlike currencylayer's free tier, it accepts any source currency directly, so no
  // USD-pivot recalculation is needed when the configured source isn't USD.
  const MULTICURRENCY_APP_ENDPOINT_FRANKFURTER_DEFAULT = 'https://api.frankfurter.dev/v1/latest?base=__MULTICURRENCY_APP_SOURCE__';
 
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
 
    $key = getDolGlobalString("MULTICURRENCY_APP_KEY");
    $source = getDolGlobalString('MULTICURRENCY_APP_SOURCE', 'USD');
    $provider = getDolGlobalString('MULTICURRENCY_APP_PROVIDER', 'currencylayer');
    $defaultendpoint = ($provider == 'frankfurter') ? self::MULTICURRENCY_APP_ENDPOINT_FRANKFURTER_DEFAULT : self::MULTICURRENCY_APP_ENDPOINT_DEFAULT;
    $urlendpoint = getDolGlobalString("MULTICURRENCY_APP_ENDPOINT", $defaultendpoint);
 
    $this->urlendpoint = str_replace(array('__MULTICURRENCY_APP_KEY__', '__MULTICURRENCY_APP_SOURCE__'), array($key, $source), $urlendpoint);
  }
 
  public function create(User $user, $notrigger = 0)
  {
    global $conf, $langs;
 
    dol_syslog('MultiCurrency::create', LOG_DEBUG);
 
    $error = 0;
 
    if (self::checkCodeAlreadyExists($this->code)) {
      $error++;
      $this->errors[] = $langs->trans('multicurrency_code_already_added');
      return -1;
    }
 
    if (empty($this->entity) || $this->entity <= 0) {
      $this->entity = $conf->entity;
    }
    $now = dol_now();
 
    // Insert request
    $sql = "INSERT INTO ".MAIN_DB_PREFIX.$this->table_element."(";
    $sql .= ' code,';
    $sql .= ' name,';
    $sql .= ' entity,';
    $sql .= ' date_create,';
    $sql .= ' fk_user';
    $sql .= ') VALUES (';
    $sql .= " '".$this->db->escape($this->code)."',";
    $sql .= " '".$this->db->escape($this->name)."',";
    $sql .= " ".((int) $this->entity).",";
    $sql .= " '".$this->db->idate($now)."',";
    $sql .= " ".((int) $user->id);
    $sql .= ')';
 
    $this->db->begin();
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog('MultiCurrency::create '.implode(',', $this->errors), LOG_ERR);
    }
 
    if (!$error) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element);
      $this->date_create = $now;
      $this->fk_user = $user->id;
 
      if (empty($notrigger)) {
        $result = $this->call_trigger('CURRENCY_CREATE', $user);
        if ($result < 0) {
          $error++;
        }
      }
    }
 
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return $this->id;
    }
  }
 
  public function fetch($id, $code = null)
  {
    dol_syslog('MultiCurrency::fetch', LOG_DEBUG);
 
    $sql = "SELECT c.rowid, c.name, c.code, c.entity, c.date_create, c.fk_user";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." AS c";
    if (!empty($code)) {
      $sql .= " WHERE c.code = '".$this->db->escape($code)."'";
      $sql .= " AND c.entity IN (".getEntity($this->element).")";
    } else {
      $sql .= ' WHERE c.rowid = '.((int) $id);
    }
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
 
    if ($resql) {
      $numrows = $this->db->num_rows($resql);
      if ($numrows) {
        $obj = $this->db->fetch_object($resql);
 
        $this->id = $obj->rowid;
        $this->name = $obj->name;
        $this->code = $obj->code;
        $this->entity = $obj->entity;
        $this->date_create = $obj->date_create;
        $this->fk_user = $obj->fk_user;
 
        $this->fetchAllCurrencyRate();
        $this->getRate();
      }
      $this->db->free($resql);
 
      if ($numrows) {
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog('MultiCurrency::fetch '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function fetchAllCurrencyRate()
  {
    $sql = "SELECT cr.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element_line." as cr";
    $sql .= " WHERE cr.entity IN (".getEntity($this->element).")";
    $sql .= " AND cr.fk_multicurrency = ".((int) $this->id);
    $sql .= " ORDER BY cr.date_sync DESC";
 
    $this->rates = array();
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
 
      while ($obj = $this->db->fetch_object($resql)) {
        $rate = new CurrencyRate($this->db);
        $rate->fetch($obj->rowid);
 
        $this->rates[] = $rate;
      }
      $this->db->free($resql);
 
      return $num;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog('MultiCurrency::fetchAllCurrencyRate '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function update(User $user, $notrigger = 0)
  {
    $error = 0;
 
    dol_syslog('MultiCurrency::update', LOG_DEBUG);
 
    // Clean parameters
    $this->name = trim($this->name);
    $this->code = trim($this->code);
 
    // Check parameters
    if (empty($this->code)) {
      $error++;
      dol_syslog('MultiCurrency::update $this->code can not be empty', LOG_ERR);
 
      return -1;
    }
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
    $sql .= " name = '".$this->db->escape($this->name)."',";
    $sql .= " code = '".$this->db->escape($this->code)."'";
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    $this->db->begin();
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog('MultiCurrency::update '.implode(',', $this->errors), LOG_ERR);
    }
 
    if (!$error && empty($notrigger)) {
      $result = $this->call_trigger('CURRENCY_MODIFY', $user);
      if ($result < 0) {
        $error++;
      }
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return 1;
    }
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    dol_syslog('MultiCurrency::delete', LOG_DEBUG);
 
    $error = 0;
 
    $this->db->begin();
 
    if (empty($notrigger)) {
      $result = $this->call_trigger('CURRENCY_DELETE', $user);
      if ($result < 0) {
        $error++;
      }
    }
 
    if (!$error) {
      // Delete all rates before
      if (!$this->deleteRates()) {
        $error++;
        $this->errors[] = 'Error '.$this->db->lasterror();
        dol_syslog('Currency::delete  '.implode(',', $this->errors), LOG_ERR);
      }
 
      $sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      dol_syslog(__METHOD__, LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) {
        $error++;
        $this->errors[] = 'Error '.$this->db->lasterror();
        dol_syslog('MultiCurrency::delete '.implode(',', $this->errors), LOG_ERR);
      }
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return 1;
    }
  }
 
  public function deleteRates()
  {
    global $user;
 
    foreach ($this->rates as &$rate) {
      if ($rate->delete($user) <= 0) {
        return false;
      }
    }
 
    return true;
  }
 
  public function addRate($rate)
  {
    global $user;
 
    $currencyRate = new CurrencyRate($this->db);
    $currencyRate->rate = (float) price2num($rate);
 
    if ($currencyRate->create($user, $this->id) > 0) {
      $this->rate = $currencyRate;
      return 1;
    } else {
      $this->rate = null;
      $this->errors = $currencyRate->errors;
      return -1;
    }
  }
 
  public function addRateFromDolibarr($code, $rate)
  {
    global $user;
 
    $currency = new MultiCurrency($this->db);
    $currency->code = $code;
    $currency->name = $code;
 
    $sql = "SELECT label FROM ".MAIN_DB_PREFIX."c_currencies WHERE code_iso = '".$this->db->escape($code)."'";
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql && ($line = $this->db->fetch_object($resql))) {
      $currency->name = $line->label;
    }
 
    if ($currency->create($user) > 0) {
      $currency->addRate($rate);
 
      if (!empty($line)) {
        return 2;
      } else {
        return 1;
      }
    }
 
    return -1;
  }
 
  public function updateRate($rate)
  {
    return $this->addRate($rate);
  }
 
  public function getRate()
  {
    $sql = "SELECT cr.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element_line." as cr";
    $sql .= " WHERE cr.entity IN (".getEntity($this->element).")";
    $sql .= " AND cr.fk_multicurrency = ".((int) $this->id);
    $sql .= " AND cr.date_sync = (SELECT MAX(cr2.date_sync) FROM ".MAIN_DB_PREFIX.$this->table_element_line." AS cr2";
    $sql .= " WHERE cr2.entity IN (".getEntity($this->element).") AND cr2.fk_multicurrency = ".((int) $this->id).")";
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $resql = $this->db->query($sql);
    if ($resql && ($obj = $this->db->fetch_object($resql))) {
      $this->rate = new CurrencyRate($this->db);
      return $this->rate->fetch($obj->rowid);
    }
 
    return -1;
  }
 
  public static function getIdFromCode($dbs, $code)
  {
    global $conf;
 
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."multicurrency WHERE code = '".$dbs->escape($code)."' AND entity = ".((int) $conf->entity);
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $dbs->query($sql);
    if ($resql && $obj = $dbs->fetch_object($resql)) {
      return $obj->rowid;
    } else {
      return 0;
    }
  }
 
  public static function getIdAndTxFromCode($dbs, $code, $date_document = 0)
  {
    $sql1 = "SELECT m.rowid, mc.rate, mc.rate_direct FROM ".MAIN_DB_PREFIX."multicurrency m";
    $sql1 .= ' LEFT JOIN '.MAIN_DB_PREFIX.'multicurrency_rate mc ON (m.rowid = mc.fk_multicurrency)';
    $sql1 .= " WHERE m.code = '".$dbs->escape($code)."'";
    $sql1 .= " AND m.entity IN (".getEntity('multicurrency').")";
    $sql2 = '';
    if (getDolGlobalString('MULTICURRENCY_USE_RATE_ON_DOCUMENT_DATE') && !empty($date_document)) {  // Use last known rate compared to document date
      $tmparray = dol_getdate($date_document);
      $sql2 .= " AND mc.date_sync <= '".$dbs->idate(dol_mktime(23, 59, 59, $tmparray['mon'], $tmparray['mday'], $tmparray['year'], true))."'";
    }
    $sql3 = " ORDER BY mc.date_sync DESC LIMIT 1";
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $dbs->query($sql1.$sql2.$sql3);
 
    if ($resql && $obj = $dbs->fetch_object($resql)) {
      return array($obj->rowid, $obj->rate);
    } else {
      if (getDolGlobalString('MULTICURRENCY_USE_RATE_ON_DOCUMENT_DATE')) {
        $resql = $dbs->query($sql1.$sql3);
        if ($resql && $obj = $dbs->fetch_object($resql)) {
          return array($obj->rowid, $obj->rate, $obj->rate_direct);
        }
      }
 
      return array(0, 1);
    }
  }
 
  public static function getAmountConversionFromInvoiceRate($fk_facture, $amount, $way = 'dolibarr', $table = 'facture', $invoice_rate = null)
  {
    if (!is_null($invoice_rate)) {
      $multicurrency_tx = $invoice_rate;
    } else {
      $tmparray = self::getInvoiceRate($fk_facture, $table);
      $multicurrency_tx = $tmparray['invoice_multicurrency_tx'];
    }
 
    if ($multicurrency_tx) {
      if ($way == 'dolibarr') {
        return (float) price2num($amount * $multicurrency_tx, 'MU');
      } else {
        return (float) price2num($amount / $multicurrency_tx, 'MU');
      }
    } else {
      return false;
    }
  }
 
  public static function getInvoiceRate($fk_facture, $table = 'facture')
  {
    global $db;
 
    $sql = "SELECT multicurrency_tx, multicurrency_code";
    $sql .= " FROM ".MAIN_DB_PREFIX.$db->sanitize($table);
    $sql .= " WHERE rowid = ".((int) $fk_facture);
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $db->query($sql);
    if ($resql && ($line = $db->fetch_object($resql))) {
      return array('invoice_multicurrency_tx' => $line->multicurrency_tx, 'invoice_multicurrency_code' => $line->multicurrency_code);
    }
 
    return false;
  }
 
  public function recalculRates(&$TRate)
  {
    if (getDolCurrency() != getDolGlobalString('MULTICURRENCY_APP_SOURCE')) {
      $alternate_source = 'USD'.getDolCurrency();
      if (!empty($TRate->$alternate_source)) {
        $coef = 1 / $TRate->$alternate_source;
        foreach ($TRate as $attr => &$rate) {
          $rate *= $coef;
        }
        $TRate->USDUSD = $coef;
        return 1;
      }
 
      return -1; // Alternate source not found
    }
 
    return 0; // Nothing to do
  }
 
  public function syncRates($nu = 0, $addifnotfound = 0, $mode = "")
  {
    global $db, $langs;
 
    if (getDolGlobalString('MULTICURRENCY_DISABLE_SYNC_CURRENCYLAYER')) {
      $this->output = $langs->trans('Use of API for currency update is disabled by option MULTICURRENCY_DISABLE_SYNC_CURRENCYLAYER');
      $this->errors[] = $this->output;
      return -1;
    }
 
    include_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
 
    $provider = getDolGlobalString('MULTICURRENCY_APP_PROVIDER', 'currencylayer');
    $urlendpoint = $this->urlendpoint;
 
    dol_syslog("Call url endpoint ".$urlendpoint);
 
    // Frankfurter is free and needs no API key; currencylayer/apilayer require one.
    $addheaders = array();
    if ($provider != 'frankfurter') {
      $addheaders[] = 'apikey: '.getDolGlobalString('MULTICURRENCY_APP_KEY');
    }
 
    $resget = getURLContent($urlendpoint, 'GET', '', 1, $addheaders);
 
    // Example of result with https://currencylayer.com/live and https://api.apilayer.com/currency_data/live
    // 'content' => string '{"success":true,"terms":"https:\/\/currencylayer.com\/terms","privacy":"https:\/\/currencylayer.com\/privacy","timestamp":1742562
    // 251,"source":"USD","quotes":{"USDAED":3.67302,"USDAFN":70.6213,"USDALL":91.042287,"USDAMD":390.984233,"USDANG":1.802039,"USDAOA":913.498241,"USDARS":1
    // 068.745088,"USDAUD":1.591824,"USDAWG":1.8,"USDAZN":1.699323,"USDBAM":1.80224,"USDBBD":2.018881,"USDBDT":121.488567,"USDBGN":1.802745,"USDBHD":0.376878
    // ,"USDBIF":2963.403228,"USDBMD":1,"USDBND":1.333573,"USDBOB":6.909262,"USDBRL":5.721'... (length=3337)
    //
    // Example of result with https://api.frankfurter.dev/v1/latest (no key, ECB rates, ~30 currencies):
    // 'content' => string '{"amount":1.0,"base":"USD","date":"2026-09-17","rates":{"AUD":1.4057,"BRL":5.1307,"CAD":1.3995,"EUR":0.871,"GBP":0.74758,...}}'
    //var_dump($urlendpoint);
    //var_dump($resget);
 
    if (empty($resget['content'])) {
      $this->output = $resget['curl_error_msg'];
      $this->errors[] = $this->output;
 
      return -1;
    }
 
    $response = json_decode($resget['content']);
 
    $TRate = null;
    $error_info = '';
    $error_info_syslog = '';
 
    if ($provider == 'frankfurter') {
      if (!empty($response->rates) && is_object($response->rates)) {
        // Frankfurter never includes the base currency itself in 'rates', add it back
        // so recalculRates()'s pivot lookup (USD<localcurrency>) keeps working the same
        // way it does for currencylayer's response, which does include it.
        $sourcecode = !empty($response->base) ? $response->base : getDolGlobalString('MULTICURRENCY_APP_SOURCE', 'USD');
        $TRate = new stdClass();
        foreach ($response->rates as $code => $rate) {
          $TRate->{$sourcecode.$code} = $rate;
        }
        $TRate->{$sourcecode.$sourcecode} = 1.0;
      } else {
        $error_info = !empty($response->message) ? $response->message : (!empty($response->error) ? $response->error : json_encode($response));
        $error_info_syslog = $error_info;
      }
    } else {
      // currencylayer / apilayer
      if (!empty($response->success)) {
        $TRate = $response->quotes;
        //$timestamp = $response->timestamp;
      } else {
        if (isset($response->error->info)) {  // @phan-suppress-current-line PhanTypeExpectedObjectPropAccess
          $error_info_syslog = $response->error->info;  // @phan-suppress-current-line PhanTypeExpectedObjectPropAccess
          $error_info = $error_info_syslog;
        } else {
          $error_info_syslog = json_encode($response);
          $error_info = $resget['content'];
        }
      }
    }
 
    if ($TRate !== null) {
      // Recalculate rate and update it (or add it) into database
      if ($this->recalculRates($TRate) >= 0) {
        foreach ($TRate as $currency_code => $rate) {
          $code = substr($currency_code, 3, 3);
          $obj = new MultiCurrency($db);
          if ($obj->fetch(0, $code) > 0) {
            $obj->updateRate($rate);
          } elseif ($addifnotfound) {
            $this->addRateFromDolibarr($code, $rate);
          }
        }
      }
 
      if ($mode == "cron") {
        return 0;
      }
      return 1;
    } else {
      dol_syslog("Failed to call endpoint ".$error_info_syslog, LOG_WARNING);
 
      $this->output = $langs->trans('multicurrency_syncronize_error', $error_info);
      $this->errors[] = $this->output;
 
      return -1;
    }
  }
 
  public function checkCodeAlreadyExists($code)
  {
    $currencytmp = new MultiCurrency($this->db);
    if ($currencytmp->fetch(0, $code) > 0) {
      return true;
    } else {
      return false;
    }
  }
}