Initial commit

application/Espo/Core/Utils/Metadata/AdditionalBuilder/DeleteIdField.php

@@ -0,0 +1,61 @@
+<?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\Utils\Metadata\AdditionalBuilder;
+
+use Espo\Core\Utils\Metadata\AdditionalBuilder;
+use stdClass;
+
+class DeleteIdField implements AdditionalBuilder
+{
+    public function build(stdClass $data): void
+    {
+        if (!isset($data->entityDefs)) {
+            return;
+        }
+
+        foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
+            if (!($entityDefsItem->deleteId ?? false)) {
+                continue;
+            }
+
+            $entityDefsItem->fields ??= (object) [];
+
+            $data->entityDefs->$entityType->fields->deleteId = (object) [
+                "type" => "varchar",
+                "maxLength" => 17,
+                "readOnly" => true,
+                "notNull" => true,
+                "default" => "0",
+                "utility" => true,
+                "customizationDisabled" => true
+            ];
+        }
+    }
+}

application/Espo/Core/Utils/Metadata/AdditionalBuilder/Fields.php

@@ -0,0 +1,106 @@
+<?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\Utils\Metadata\AdditionalBuilder;
+
+use Espo\Core\Utils\DataUtil;
+use Espo\Core\Utils\Metadata\AdditionalBuilder;
+use Espo\Core\Utils\Metadata\BuilderHelper;
+use Espo\Core\Utils\Util;
+use stdClass;
+
+class Fields implements AdditionalBuilder
+{
+    private BuilderHelper $builderHelper;
+
+    public function __construct()
+    {
+        $this->builderHelper = new BuilderHelper();
+    }
+
+    public function build(stdClass $data): void
+    {
+        if (!isset($data->entityDefs)) {
+            return;
+        }
+
+        $defs = Util::objectToArray($data->fields);
+
+        foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
+            if (isset($data->entityDefs->$entityType->collection)) {
+                /** @var stdClass $collectionItem */
+                $collectionItem = $data->entityDefs->$entityType->collection;
+
+                if (isset($collectionItem->orderBy)) {
+                    $collectionItem->sortBy = $collectionItem->orderBy;
+                } else if (isset($collectionItem->sortBy)) {
+                    $collectionItem->orderBy = $collectionItem->sortBy;
+                }
+
+                if (isset($collectionItem->order)) {
+                    $collectionItem->asc = $collectionItem->order === 'asc';
+                } else if (isset($collectionItem->asc)) {
+                    $collectionItem->order = $collectionItem->asc === true ? 'asc' : 'desc';
+                }
+            }
+
+            if (!isset($entityDefsItem->fields)) {
+                continue;
+            }
+
+            foreach (get_object_vars($entityDefsItem->fields) as $field => $fieldDefsItem) {
+                $additionalFields = $this->builderHelper->getAdditionalFields(
+                    field: $field,
+                    params: Util::objectToArray($fieldDefsItem),
+                    defs: $defs,
+                );
+
+                if (!$additionalFields) {
+                    continue;
+                }
+
+                foreach ($additionalFields as $subFieldName => $subFieldParams) {
+                    $item = Util::arrayToObject($subFieldParams);
+
+                    if (isset($entityDefsItem->fields->$subFieldName)) {
+                        $data->entityDefs->$entityType->fields->$subFieldName =
+                            DataUtil::merge(
+                                $item,
+                                $entityDefsItem->fields->$subFieldName
+                            );
+
+                        continue;
+                    }
+
+                    $data->entityDefs->$entityType->fields->$subFieldName = $item;
+                }
+            }
+        }
+    }
+}

application/Espo/Core/Utils/Metadata/AdditionalBuilder/FilterFields.php

@@ -0,0 +1,67 @@
+<?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\Utils\Metadata\AdditionalBuilder;
+
+use Espo\Core\Utils\Metadata\AdditionalBuilder;
+use stdClass;
+
+/**
+ * @noinspection PhpUnused
+ */
+class FilterFields implements AdditionalBuilder
+{
+    public function __construct()
+    {}
+
+    public function build(stdClass $data): void
+    {
+        if (!isset($data->entityDefs)) {
+            return;
+        }
+
+        foreach (get_object_vars($data->entityDefs) as $entityDefsItem) {
+            if (isset($entityDefsItem->fields) && is_object($entityDefsItem->fields)) {
+                foreach (get_object_vars($entityDefsItem->fields) as $field => $fieldDefsItem) {
+                    if (!isset($fieldDefsItem->type)) {
+                        unset($entityDefsItem->fields->$field);
+                    }
+                }
+            }
+
+            if (isset($entityDefsItem->links) && is_object($entityDefsItem->links)) {
+                foreach (get_object_vars($entityDefsItem->links) as $link => $linkDefsItem) {
+                    if (!isset($linkDefsItem->type)) {
+                        unset($entityDefsItem->links->$link);
+                    }
+                }
+            }
+        }
+    }
+}

application/Espo/Core/Utils/Metadata/AdditionalBuilder/LogicDefsBc.php

@@ -0,0 +1,168 @@
+<?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\Utils\Metadata\AdditionalBuilder;
+
+use Espo\Core\Utils\Metadata\AdditionalBuilder;
+use Espo\Core\Utils\ObjectUtil;
+use stdClass;
+
+/**
+ * Establishes backward compatibility of clientDefs > {scope} > dynamicLogic.
+ * The dynamic logic is NOT supposed to be set in custom clientDefs as of v9.1.
+ * The custom dynamic logic is supposed to be moved to logicDefs by an upgrade script.
+ * But extensions can have a dynamic logic defined in clientDefs as they may be supposed
+ * to be compatible with older Espo versions.
+ *
+ * @noinspection PhpUnused
+ */
+class LogicDefsBc implements AdditionalBuilder
+{
+    public function build(stdClass $data): void
+    {
+        if (!isset($data->clientDefs)) {
+            return;
+        }
+
+        /** @var array<string, stdClass> $clientDefs */
+        $clientDefs = get_object_vars($data->clientDefs);
+
+        foreach ($clientDefs as $scope => $defs) {
+            $this->processScope($scope, $data);
+        }
+    }
+
+    private function processScope(string $scope, stdClass $data): void
+    {
+        if (!isset($data->clientDefs->$scope)) {
+            return;
+        }
+
+        /** @var stdClass $clientDefs */
+        $clientDefs = $data->clientDefs->$scope;
+
+        if (!isset($clientDefs->dynamicLogic)) {
+            return;
+        }
+
+        /** @var stdClass $dynamicLogic */
+        $dynamicLogic = $clientDefs->dynamicLogic;
+
+        $keys = [
+            'fields',
+            'panels',
+        ];
+
+        $subKeys = [
+            'visible',
+            'required',
+            'readOnly',
+            'invalid',
+        ];
+
+        $data->logicDefs ??= (object) [];
+        $data->logicDefs->$scope ??= (object) [];
+
+        /** @var stdClass $logicDefs */
+        $logicDefs = $data->logicDefs->$scope;
+
+        $customFile = "custom/Espo/Custom/Resources/metadata/logicDefs/$scope.json";
+
+        $customLogicDefs = file_exists($customFile) ?
+            json_decode(file_get_contents($customFile) ?: '') :
+            null;
+
+        if (!$customLogicDefs instanceof stdClass) {
+            $customLogicDefs = (object) [];
+        }
+
+        foreach ($keys as $key) {
+            if (!isset($dynamicLogic->$key) || !is_object($dynamicLogic->$key)) {
+                continue;
+            }
+
+            /** @var array<string, stdClass> $defs */
+            $defs = get_object_vars($dynamicLogic->$key);
+
+            foreach ($defs as $name => $subDefs) {
+
+                foreach ($subKeys as $subKey) {
+                    if (!property_exists($subDefs, $subKey)) {
+                        continue;
+                    }
+
+                    if (
+                        isset($customLogicDefs->$key->$name) &&
+                        property_exists($customLogicDefs->$key->$name, $subKey)
+                    ) {
+                        // Overridden in custom.
+                        continue;
+                    }
+
+                    /** @var stdClass|null $item */
+                    $item = $subDefs->$subKey;
+
+                    $logicDefs->$key ??= (object) [];
+
+                    // Fix if corrupted.
+                    if (is_array($logicDefs->$key)) {
+                        $logicDefs->$key = (object) [];
+                    }
+
+                    $logicDefs->$key->$name ??= (object) [];
+
+                    $logicDefs->$key->$name->$subKey = $item !== null ?
+                        ObjectUtil::clone($item) :
+                        null;
+                }
+            }
+        }
+
+        if (isset($dynamicLogic->options)) {
+            /** @var array<string, stdClass[]> $defs */
+            $defs = get_object_vars($dynamicLogic->options);
+
+            foreach ($defs as $name => $subDefs) {
+                if (
+                    isset($customLogicDefs->options) &&
+                    property_exists($customLogicDefs->options, $name)
+                ) {
+                    // Overridden in custom.
+                    continue;
+                }
+
+                $logicDefs->options ??= (object) [];
+
+                $logicDefs->options->$name = $subDefs !== null ?
+                    array_map(fn ($it) => ObjectUtil::clone($it), $subDefs) :
+                    null;
+            }
+        }
+    }
+}

application/Espo/Core/Utils/Metadata/AdditionalBuilder/StreamUpdatedAtField.php

@@ -0,0 +1,67 @@
+<?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\Utils\Metadata\AdditionalBuilder;
+
+use Espo\Core\Name\Field;
+use Espo\Core\ORM\Type\FieldType;
+use Espo\Core\Utils\Metadata\AdditionalBuilder;
+use stdClass;
+
+class StreamUpdatedAtField implements AdditionalBuilder
+{
+    public function build(stdClass $data): void
+    {
+        if (!isset($data->entityDefs)) {
+            return;
+        }
+
+        $field = Field::STREAM_UPDATED_AT;
+
+        foreach (get_object_vars($data->entityDefs) as $entityType => $entityDefsItem) {
+            $hasStream = $data->scopes?->$entityType->stream ?? false;
+
+            if (!$hasStream) {
+                continue;
+            }
+
+            if (isset($entityDefsItem?->fields->$field)) {
+                continue;
+            }
+
+            $entityDefsItem->fields ??= (object) [];
+
+            $entityDefsItem->fields->$field = (object) [
+                'type' => FieldType::DATETIME,
+                'readOnly' => true,
+                'customizationReadOnlyDisabled' => true,
+            ];
+        }
+    }
+}