Initial commit

application/Espo/Core/Currency/CalculatorUtil.php

@@ -0,0 +1,165 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Currency;
+
+use DivisionByZeroError;
+
+class CalculatorUtil
+{
+    private const SCALE = 14;
+
+    /**
+     * @param numeric-string $arg1
+     * @param numeric-string $arg2
+     * @return numeric-string
+     */
+    public static function add(string $arg1, string $arg2): string
+    {
+        if (!function_exists('bcadd')) {
+            return (string) (
+                (float) $arg1 + (float) $arg2
+            );
+        }
+
+        return bcadd(
+            $arg1,
+            $arg2,
+            self::SCALE
+        );
+    }
+
+    /**
+     * @param numeric-string $arg1
+     * @param numeric-string $arg2
+     * @return numeric-string
+     */
+    public static function subtract(string $arg1, string $arg2): string
+    {
+        if (!function_exists('bcsub')) {
+            return (string) (
+                (float) $arg1 - (float) $arg2
+            );
+        }
+
+        return bcsub(
+            $arg1,
+            $arg2,
+            self::SCALE
+        );
+    }
+
+    /**
+     * @param numeric-string $arg1
+     * @param numeric-string $arg2
+     * @return numeric-string
+     */
+    public static function multiply(string $arg1, string $arg2): string
+    {
+        if (!function_exists('bcmul')) {
+            return (string) (
+                (float) $arg1 * (float) $arg2
+            );
+        }
+
+        return bcmul(
+            $arg1,
+            $arg2,
+            self::SCALE
+        );
+    }
+
+    /**
+     * @param numeric-string $arg1
+     * @param numeric-string $arg2
+     * @return numeric-string
+     */
+    public static function divide(string $arg1, string $arg2): string
+    {
+        if (!function_exists('bcdiv')) {
+            return (string) (
+                (float) $arg1 / (float) $arg2
+            );
+        }
+
+        $result = bcdiv(
+            $arg1,
+            $arg2,
+            self::SCALE
+        );
+
+        if ($result === null) { /** @phpstan-ignore-line  */
+            throw new DivisionByZeroError();
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param numeric-string $arg
+     * @return numeric-string
+     */
+    public static function round(string $arg, int $precision = 0): string
+    {
+        if (!function_exists('bcadd')) {
+            return (string) round((float) $arg, $precision);
+        }
+
+        $addition = '0.' . str_repeat('0', $precision) . '5';
+
+        if ($arg[0] === '-') {
+            $addition = '-' . $addition;
+        }
+
+        assert(is_numeric($addition));
+
+        return bcadd(
+            $arg,
+            $addition,
+            $precision
+        );
+    }
+
+    /**
+     * @param numeric-string $arg1
+     * @param numeric-string $arg2
+     */
+    public static function compare(string $arg1, string $arg2): int
+    {
+        if (!function_exists('bccomp')) {
+            return (float) $arg1 <=> (float) $arg2;
+        }
+
+        return bccomp(
+            $arg1,
+            $arg2,
+            self::SCALE
+        );
+    }
+}

application/Espo/Core/Currency/ConfigDataProvider.php

@@ -0,0 +1,109 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Currency;
+
+use Espo\Core\Utils\Config;
+use RuntimeException;
+
+class ConfigDataProvider
+{
+    public function __construct(private Config $config)
+    {}
+
+    /**
+     * Get decimal places.
+     *
+     * @since 8.3.0
+     */
+    public function getDecimalPlaces(): ?int
+    {
+        return $this->config->get('currencyDecimalPlaces');
+    }
+
+    /**
+     * Get a system default currency.
+     */
+    public function getDefaultCurrency(): string
+    {
+        return $this->config->get('defaultCurrency');
+    }
+
+    /**
+     * Get a base currency, used for conversion.
+     */
+    public function getBaseCurrency(): string
+    {
+        return $this->config->get('baseCurrency');
+    }
+
+    /**
+     * Get a list of available currencies.
+     *
+     * @return array<int, string>
+     */
+    public function getCurrencyList(): array
+    {
+        return $this->config->get('currencyList') ?? [];
+    }
+
+    /**
+     * Whether a currency is available in the system.
+     */
+    public function hasCurrency(string $currencyCode): bool
+    {
+        return in_array($currencyCode, $this->getCurrencyList());
+    }
+
+    /**
+     * Get a rate of a specific currency related to the base currency.
+     */
+    public function getCurrencyRate(string $currencyCode): float
+    {
+        $rates = $this->config->get('currencyRates') ?? [];
+
+        if (!$this->hasCurrency($currencyCode)) {
+            throw new RuntimeException("Can't get currency rate of '{$currencyCode}' currency.");
+        }
+
+        return $rates[$currencyCode] ?? 1.0;
+    }
+
+    /**
+     * Get rates.
+     */
+    public function getCurrencyRates(): Rates
+    {
+        $rates = $this->config->get('currencyRates') ?? [];
+
+        $rates[$this->getBaseCurrency()] = 1.0;
+
+        return Rates::fromAssoc($rates, $this->getBaseCurrency());
+    }
+}

application/Espo/Core/Currency/Converter.php

@@ -0,0 +1,114 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Currency;
+
+use Espo\Core\Field\Currency;
+
+use RuntimeException;
+
+/**
+ * Converts currency values.
+ */
+class Converter
+{
+    private ConfigDataProvider $configDataProvider;
+
+    public function __construct(ConfigDataProvider $configDataProvider)
+    {
+        $this->configDataProvider = $configDataProvider;
+    }
+
+    /**
+     * Convert a currency value to a specific currency.
+     *
+     * @throws RuntimeException
+     */
+    public function convert(Currency $value, string $targetCurrencyCode): Currency
+    {
+        if (!$this->configDataProvider->hasCurrency($targetCurrencyCode)) {
+            throw new RuntimeException("Can't convert currency to unknown currency '{$targetCurrencyCode}.");
+        }
+
+        $rate = $this->configDataProvider->getCurrencyRate($value->getCode());
+        $targetRate = $this->configDataProvider->getCurrencyRate($targetCurrencyCode);
+
+        $convertedAmount = $this->convertAmount($value->getAmountAsString(), $rate, $targetRate);
+
+        return new Currency($convertedAmount, $targetCurrencyCode);
+    }
+
+    /**
+     * Convert a currency value to a specific currency with specific rates.
+     * Base currency should have rate equal to `1.0`.
+     *
+     * @throws RuntimeException
+     */
+    public function convertWithRates(Currency $value, string $targetCurrencyCode, Rates $rates): Currency
+    {
+        $currencyCode = $value->getCode();
+
+        if (!$rates->hasRate($currencyCode)) {
+            throw new RuntimeException("No rate for the currency '{$currencyCode}.");
+        }
+
+        if (!$rates->hasRate($targetCurrencyCode)) {
+            throw new RuntimeException("No rate for the currency '{$targetCurrencyCode}.");
+        }
+
+        $rate = $rates->getRate($currencyCode);
+        $targetRate = $rates->getRate($targetCurrencyCode);
+
+        $convertedAmount = $this->convertAmount($value->getAmountAsString(), $rate, $targetRate);
+
+        return new Currency($convertedAmount, $targetCurrencyCode);
+    }
+
+    /**
+     * Convert a currency value to the system default currency.
+     */
+    public function convertToDefault(Currency $value): Currency
+    {
+        $targetCurrencyCode = $this->configDataProvider->getDefaultCurrency();
+
+        return $this->convert($value, $targetCurrencyCode);
+    }
+
+    /**
+     * @param numeric-string $amount
+     * @return numeric-string
+     */
+    private function convertAmount(string $amount, float $rate, float $targetRate): string
+    {
+        return CalculatorUtil::divide(
+            CalculatorUtil::multiply($amount, (string) $rate),
+            (string) $targetRate
+        );
+    }
+}

application/Espo/Core/Currency/Rates.php

@@ -0,0 +1,134 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Currency;
+
+use RuntimeException;
+
+/**
+ * Currency rates.
+ */
+class Rates
+{
+    /** @var array<string, float> */
+    private array $data = [];
+
+    private function __construct(private ?string $baseCode = null)
+    {}
+
+    /**
+     * Create an instance.
+     *
+     * @param ?string $baseCode A base-currency code.
+     */
+    public static function create(?string $baseCode = null): self
+    {
+        return new self($baseCode);
+    }
+
+    /**
+     * Get a base-currency code.
+     *
+     * @throws RuntimeException If the base code is not set.
+     */
+    public function getBase(): string
+    {
+        if ($this->baseCode === null) {
+            throw new RuntimeException("Base code is not set.");
+        }
+
+        return $this->baseCode;
+    }
+
+    /**
+     * Clone with a rate value for a specific currency.
+     */
+    public function withRate(string $code, float $value): self
+    {
+        $obj = clone $this;
+        $obj->data[$code] = $value;
+
+        return $obj;
+    }
+
+    /**
+     * Whether a rate is set for a specific currency.
+     */
+    public function hasRate(string $code): bool
+    {
+        return array_key_exists($code, $this->data);
+    }
+
+    /**
+     * Get a rate value for a specific currency.
+     */
+    public function getRate(string $code): float
+    {
+        if (!$this->hasRate($code)) {
+            throw new RuntimeException("No currency rate for '{$code}'.");
+        }
+
+        return $this->data[$code];
+    }
+
+    /**
+     * To an associative array.
+     *
+     * @return array<string, float>
+     */
+    public function toAssoc(): array
+    {
+        return array_merge(
+            $this->data,
+            [$this->getBase() => 1.0]
+        );
+    }
+
+    /**
+     * Create from an associative array.
+     *
+     * @param array<string, float> $data
+     */
+    public static function fromAssoc(array $data, ?string $baseCode = null): self
+    {
+        $obj = new self($baseCode);
+        $obj->data = $data;
+
+        return $obj;
+    }
+
+    /**
+     * @deprecated Use `fromAssoc`.
+     * @param array<string, float> $data
+     */
+    public function fromArray(array $data, ?string $baseCode = null): self
+    {
+        return self::fromAssoc($data, $baseCode);
+    }
+}