Initial commit

application/Espo/Tools/Formula/RunResult.php

@@ -0,0 +1,113 @@
+<?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\Formula;
+
+use Espo\Core\Formula\Exceptions\SyntaxError;
+use Espo\Core\Formula\Exceptions\Error;
+
+use stdClass;
+
+class RunResult
+{
+    private bool $isSuccess = false;
+    private ?string $output = null;
+    private ?string $message = null;
+    private ?Error $exception = null;
+
+    private function __construct(bool $isSuccess)
+    {
+        $this->isSuccess = $isSuccess;
+    }
+
+    public static function createSuccess(?string $output): self
+    {
+        $obj = new self(true);
+        $obj->output = $output;
+
+        return $obj;
+    }
+
+    public static function createError(Error $exception, ?string $output): self
+    {
+        $obj = new self(false);
+
+        $obj->message = $exception->getMessage();
+        $obj->exception = $exception;
+        $obj->output = $output;
+
+        return $obj;
+    }
+
+    public static function createSyntaxError(SyntaxError $exception): self
+    {
+        $obj = new self(false);
+
+        $obj->message = $exception->getShortMessage();
+        $obj->exception = $exception;
+
+        return $obj;
+    }
+
+    public function isSuccess(): bool
+    {
+        return $this->isSuccess;
+    }
+
+    public function getOutput(): ?string
+    {
+        return $this->output;
+    }
+
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    public function getException(): ?Error
+    {
+        return $this->exception;
+    }
+
+    public function toStdClass(): stdClass
+    {
+        $data = (object) [];
+
+        $data->isSuccess = $this->isSuccess();
+
+        if (!$this->isSuccess) {
+            $data->message = $this->message;
+            $data->isSyntaxError = $this->exception instanceof SyntaxError;
+        }
+
+        $data->output = $this->output;
+
+        return $data;
+    }
+}

application/Espo/Tools/Formula/Service.php

@@ -0,0 +1,119 @@
+<?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\Formula;
+
+use Espo\Core\Formula\Parser;
+use Espo\Core\Formula\Exceptions\SyntaxError;
+use Espo\Core\Formula\Exceptions\Error;
+use Espo\Core\Formula\Manager;
+use Espo\Core\Field\LinkParent;
+use Espo\Core\Exceptions\NotFoundSilent;
+use Espo\Core\Utils\Log;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Entity;
+
+class Service
+{
+    public function __construct(
+        private Parser $parser,
+        private Manager $manager,
+        private EntityManager $entityManager,
+        private Log $log,
+    ) {}
+
+    public function checkSyntax(string $expression): SyntaxCheckResult
+    {
+        try {
+            $this->parser->parse($expression);
+
+            $result = SyntaxCheckResult::createSuccess();
+        }  catch (SyntaxError $e) {
+            return SyntaxCheckResult::createError($e);
+        }
+
+        return $result;
+    }
+
+    /**
+     * @throws NotFoundSilent
+     */
+    public function run(string $expression, ?LinkParent $targetLink = null): RunResult
+    {
+        $syntaxCheckResult = $this->checkSyntax($expression);
+
+        if (!$syntaxCheckResult->isSuccess()) {
+            /** @var SyntaxError $exception */
+            $exception = $syntaxCheckResult->getException();
+
+            return RunResult::createSyntaxError($exception);
+        }
+
+        $target = null;
+
+        if ($targetLink) {
+            $target = $this->entityManager->getEntityById($targetLink->getEntityType(), $targetLink->getId());
+
+            if (!$target) {
+                throw new NotFoundSilent("Target entity not found.");
+            }
+        }
+
+        $variables = (object) [];
+
+        try {
+            $this->manager->run($expression, $target, $variables);
+        } catch (Error $e) {
+            $output = $variables->__output ?? null;
+
+            $this->log->error("Formula sandbox run error.", ['exception' => $e]);
+
+            return RunResult::createError($e, $output);
+        }
+
+        if ($target && $this->isEntityChanged($target)) {
+            $this->entityManager->saveEntity($target);
+        }
+
+        $output = $variables->__output ?? null;
+
+        return RunResult::createSuccess($output);
+    }
+
+    private function isEntityChanged(Entity $entity): bool
+    {
+        foreach ($entity->getAttributeList() as $attribute) {
+            if ($entity->isAttributeChanged($attribute)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

application/Espo/Tools/Formula/SyntaxCheckResult.php

@@ -0,0 +1,92 @@
+<?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\Formula;
+
+use Espo\Core\Formula\Exceptions\SyntaxError;
+use Espo\Core\Formula\Exceptions\Error;
+
+use stdClass;
+
+class SyntaxCheckResult
+{
+    private bool $isSuccess = false;
+
+    private ?string $message = null;
+
+    private ?Error $exception = null;
+
+    private function __construct(bool $isSuccess)
+    {
+        $this->isSuccess = $isSuccess;
+    }
+
+    public static function createSuccess(): self
+    {
+        return new self(true);
+    }
+
+    public static function createError(SyntaxError $exception): self
+    {
+        $obj = new self(false);
+
+        $obj->message = $exception->getShortMessage();
+        $obj->exception = $exception;
+
+        return $obj;
+    }
+
+    public function isSuccess(): bool
+    {
+        return $this->isSuccess;
+    }
+
+    public function getMessage(): ?string
+    {
+        return $this->message;
+    }
+
+    public function getException(): ?Error
+    {
+        return $this->exception;
+    }
+
+    public function toStdClass(): stdClass
+    {
+        $data = (object) [];
+
+        $data->isSuccess = $this->isSuccess();
+
+        if (!$this->isSuccess) {
+            $data->message = $this->message;
+        }
+
+        return $data;
+    }
+}