Initial commit

application/Espo/Tools/Currency/Conversion/DefaultEntityConverter.php

@@ -0,0 +1,129 @@
+<?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\Tools\Currency\Conversion;
+
+use Espo\Core\Acl;
+use Espo\Core\Acl\Table;
+use Espo\Core\Currency\Converter;
+use Espo\Core\Currency\Rates;
+use Espo\Core\Field\Currency;
+use Espo\Core\ORM\Entity as CoreEntity;
+use Espo\Core\ORM\Type\FieldType;
+use Espo\Core\Utils\Metadata;
+use Espo\ORM\Entity;
+use Espo\ORM\EntityManager;
+use LogicException;
+
+/**
+ * @implements EntityConverter<CoreEntity>
+ */
+class DefaultEntityConverter implements EntityConverter
+{
+    public function __construct(
+        private Converter $converter,
+        private EntityManager $entityManager,
+        private Metadata $metadata,
+        private Acl $acl
+    ) {}
+
+    /**
+     * @param CoreEntity $entity
+     */
+    public function convert(Entity $entity, string $targetCurrency, Rates $rates): void
+    {
+        $entityDefs = $this->entityManager
+            ->getDefs()
+            ->getEntity($entity->getEntityType());
+
+        foreach ($this->getFieldList($entity->getEntityType()) as $field) {
+            $disabled = $entityDefs->getField($field)->getParam('conversionDisabled');
+
+            if ($disabled) {
+                continue;
+            }
+
+            $value = $entity->getValueObject($field);
+
+            if (!$value) {
+                continue;
+            }
+
+            if (!$value instanceof Currency) {
+                throw new LogicException();
+            }
+
+            if ($targetCurrency === $value->getCode()) {
+                continue;
+            }
+
+            $convertedValue = $this->converter->convertWithRates($value, $targetCurrency, $rates);
+
+            $entity->setValueObject($field, $convertedValue);
+        }
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getFieldList(string $entityType): array
+    {
+        $resultList = [];
+
+        /** @var string[] $requiredFieldList */
+        $requiredFieldList = $this->metadata->get(['scopes', $entityType, 'currencyConversionAccessRequiredFieldList']);
+
+        $allFields = $requiredFieldList !== null;
+
+        $fieldDefsList = $this->entityManager
+            ->getDefs()
+            ->getEntity($entityType)
+            ->getFieldList();
+
+        foreach ($fieldDefsList as $fieldDefs) {
+            $field = $fieldDefs->getName();
+            $type = $fieldDefs->getType();
+
+            if ($type !== FieldType::CURRENCY) {
+                continue;
+            }
+
+            if (
+                !$allFields &&
+                !$this->acl->checkField($entityType, $field, Table::ACTION_EDIT)
+            ) {
+                continue;
+            }
+
+            $resultList[] = $field;
+        }
+
+        return $resultList;
+    }
+}

application/Espo/Tools/Currency/Conversion/EntityConverter.php

@@ -0,0 +1,48 @@
+<?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\Tools\Currency\Conversion;
+
+use Espo\Core\Currency\Rates;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\ORM\Entity;
+
+/**
+ * Converts entity currency values. Is not supposed to save the entity.
+ *
+ * @template TEntity of Entity
+ */
+interface EntityConverter
+{
+    /**
+     * @param TEntity $entity
+     * @throws Forbidden
+     */
+    public function convert(Entity $entity, string $targetCurrency, Rates $rates): void;
+}

application/Espo/Tools/Currency/Conversion/EntityConverterFactory.php

@@ -0,0 +1,65 @@
+<?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\Tools\Currency\Conversion;
+
+use Espo\Core\Acl;
+use Espo\Core\Binding\BindingContainerBuilder;
+use Espo\Core\InjectableFactory;
+use Espo\Core\Utils\Metadata;
+use Espo\Entities\User;
+use Espo\ORM\Entity;
+
+class EntityConverterFactory
+{
+    public function __construct(
+        private Metadata $metadata,
+        private InjectableFactory $injectableFactory,
+        private User $user,
+        private Acl $acl
+    ) {}
+
+    /**
+     * @return EntityConverter<Entity>
+     */
+    public function create(string $entityType): EntityConverter
+    {
+        /** @var class-string<EntityConverter<Entity>> $className */
+        $className = $this->metadata
+            ->get(['app', 'currencyConversion', 'entityConverterClassNameMap', $entityType]) ??
+            DefaultEntityConverter::class;
+
+        $binding = BindingContainerBuilder::create()
+            ->bindInstance(User::class, $this->user)
+            ->bindInstance(Acl::class, $this->acl)
+            ->build();
+
+        return $this->injectableFactory->createWithBinding($className, $binding);
+    }
+}