api_multicurrencies.class.php

<?php
/* Copyright (C) 2022   J-F Bouculat     <jfbouculat@gmail.com>
 * Copyright (C) 2024-2026  MDW       <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025       Frédéric France         <frederic.france@free.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
//require_once DOL_DOCUMENT_ROOT.'/multicurrency/class/multicurrency.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/multicurrency.lib.php';
 
class MultiCurrencies extends DolibarrApi
{
  public function __construct()
  {
    global $db;
 
    $this->db = $db;
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '')
  {
    global $db;
 
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'read')) {
      throw new RestException(403, "Insufficient rights to read currency");
    }
 
    $obj_ret = array();
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".$this->db->prefix()."multicurrency as t";
    $sql .= " WHERE t.entity IN (".getEntity('multicurrency').")";
    // 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 + 1, $offset);
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $multicurrency_static = new MultiCurrency($this->db);
        if ($multicurrency_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($multicurrency_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve currencies list : '.$this->db->lasterror());
    }
 
    return $obj_ret;
  }
 
  public function get($id)
  {
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch($id)) {
      throw new RestException(404, 'Currency not found');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'read')) {
      throw new RestException(403, "Insufficient rights to read currency");
    }
 
    return $this->_cleanObjectDatas($multicurrency);
  }
 
  public function getByCode($code)
  {
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch(0, $code)) {
      throw new RestException(404, 'Currency not found');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'read')) {
      throw new RestException(403, "Insufficient rights to read currency");
    }
 
    return $this->_cleanObjectDatas($multicurrency);
  }
 
  public function getRates($id)
  {
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch($id)) {
      throw new RestException(404, 'Currency not found');
    }
 
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'read')) {
      throw new RestException(403, "Insufficient rights to read currency rates");
    }
 
    if ($multicurrency->fetchAllCurrencyRate() < 0) {
      throw new RestException(500, "Error when fetching currency rates");
    }
 
    // Clean object datas
    foreach ($multicurrency->rates as $key => $obj) {
      $multicurrency->rates[$key] = $this->_cleanObjectDatasRate($obj);
    }
 
    return $multicurrency->rates;
  }
 
  public function post($request_data = null)
  {
 
    // Check parameters
    if (!isset($request_data['code'])) {
      throw new RestException(400, "code field missing");
    }
    if (!isset($request_data['name'])) {
      throw new RestException(400, "name field missing");
    }
 
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'write')) {
      throw new RestException(403, "Insufficient rights to create currency");
    }
 
    $multicurrency = new MultiCurrency($this->db);
 
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $multicurrency->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $multicurrency->$field = $this->_checkValForAPI($field, $value, $multicurrency);
    }
 
    // Create Currency
    if ($multicurrency->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating currency", array_merge(array($multicurrency->error), $multicurrency->errors));
    }
 
    // Add default rate if defined
    if (isset($request_data['rate']) && $request_data['rate'] > 0) {
      if ($multicurrency->addRate((float) $request_data['rate']) < 0) {
        throw new RestException(500, "Error adding currency rate", array_merge(array($multicurrency->error), $multicurrency->errors));
      }
 
      return $multicurrency->id;
    }
 
    return $multicurrency->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'write')) {
      throw new RestException(403, "Insufficient rights to update currency");
    }
 
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch($id)) {
      throw new RestException(404, 'Currency not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $multicurrency->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $multicurrency->$field = $this->_checkValForAPI($field, $value, $multicurrency);
    }
 
    if ($multicurrency->update(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error updating currency", array_merge(array($multicurrency->error), $multicurrency->errors));
    }
 
    return $this->get($id);
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'delete')) {
      throw new RestException(403, "Insufficient rights to delete currency");
    }
 
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch($id)) {
      throw new RestException(404, 'Currency not found');
    }
 
    if (!$multicurrency->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, "Error deleting currency", array_merge(array($multicurrency->error), $multicurrency->errors));
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Currency deleted'
      )
    );
  }
 
 
  public function updateRate($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('multicurrency', 'currency', 'write')) {
      throw new RestException(403, "Insufficient rights to update currency rate");
    }
 
    // Check parameters
    if (!isset($request_data['rate'])) {
      throw new RestException(400, "Rate field is missing");
    }
 
    $multicurrency = new MultiCurrency($this->db);
    if (!$multicurrency->fetch($id)) {
      throw new RestException(404, 'Currency not found');
    }
 
    // Add rate
    if ($multicurrency->addRate((float) $request_data['rate']) < 0) {
      throw new RestException(500, "Error updating currency rate", array_merge(array($multicurrency->error), $multicurrency->errors));
    }
 
    return $this->_cleanObjectDatas($multicurrency);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    // Clear all fields out of interest
    foreach ($object as $key => $value) {
      if ($key == "rate") {
        $object->$key = $this->_cleanObjectDatasRate($object->$key);
      }
      if ($key == "id" || $key == "code" || $key == "rate" || $key == "name") {
        continue;
      }
      unset($object->$key);
    }
 
    return $object;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatasRate($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    // Clear all fields out of interest
    foreach ($object as $key => $value) {
      if ($key == "id" || $key == "rate" || $key == "date_sync") {
        continue;
      }
      unset($object->$key);
    }
 
    return $object;
  }
}