Initial commit
This commit is contained in:
54
application/Espo/Tools/EntityManager/CreateParams.php
Normal file
54
application/Espo/Tools/EntityManager/CreateParams.php
Normal file
@@ -0,0 +1,54 @@
|
||||
<?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\EntityManager;
|
||||
|
||||
class CreateParams
|
||||
{
|
||||
/**
|
||||
* @param array<string, string> $replaceData
|
||||
*/
|
||||
public function __construct(
|
||||
private bool $forceCreate = false,
|
||||
private array $replaceData = []
|
||||
) {}
|
||||
|
||||
public function forceCreate(): bool
|
||||
{
|
||||
return $this->forceCreate;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, string>
|
||||
*/
|
||||
public function getReplaceData(): array
|
||||
{
|
||||
return $this->replaceData;
|
||||
}
|
||||
}
|
||||
42
application/Espo/Tools/EntityManager/DeleteParams.php
Normal file
42
application/Espo/Tools/EntityManager/DeleteParams.php
Normal file
@@ -0,0 +1,42 @@
|
||||
<?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\EntityManager;
|
||||
|
||||
class DeleteParams
|
||||
{
|
||||
public function __construct(
|
||||
private bool $forceRemove = false
|
||||
) {}
|
||||
|
||||
public function forceRemove(): bool
|
||||
{
|
||||
return $this->forceRemove;
|
||||
}
|
||||
}
|
||||
862
application/Espo/Tools/EntityManager/EntityManager.php
Normal file
862
application/Espo/Tools/EntityManager/EntityManager.php
Normal file
@@ -0,0 +1,862 @@
|
||||
<?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\EntityManager;
|
||||
|
||||
use Espo\Core\Exceptions\Error;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Exceptions\Conflict;
|
||||
use Espo\Tools\EntityManager\Hook\CreateHook;
|
||||
use Espo\Tools\EntityManager\Hook\DeleteHook;
|
||||
use Espo\Core\DataManager;
|
||||
use Espo\Core\InjectableFactory;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Config\ConfigWriter;
|
||||
use Espo\Core\Utils\File\Manager as FileManager;
|
||||
use Espo\Core\Utils\Json;
|
||||
use Espo\Core\Utils\Language;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Core\Utils\Util;
|
||||
use Espo\Tools\EntityManager\Hook\UpdateHook;
|
||||
use Espo\Tools\LinkManager\LinkManager;
|
||||
use Exception;
|
||||
use RuntimeException;
|
||||
|
||||
/**
|
||||
* Administration > Entity Manager.
|
||||
*/
|
||||
class EntityManager
|
||||
{
|
||||
private const DEFAULT_PARAM_LOCATION = 'scopes';
|
||||
|
||||
/** @var string[] */
|
||||
private const ALLOWED_PARAM_LOCATIONS = [
|
||||
'scopes',
|
||||
'entityDefs',
|
||||
'clientDefs',
|
||||
'recordDefs',
|
||||
'aclDefs',
|
||||
];
|
||||
|
||||
public function __construct(
|
||||
private Metadata $metadata,
|
||||
private Language $language,
|
||||
private Language $baseLanguage,
|
||||
private FileManager $fileManager,
|
||||
private Config $config,
|
||||
private ConfigWriter $configWriter,
|
||||
private DataManager $dataManager,
|
||||
private InjectableFactory $injectableFactory,
|
||||
private NameUtil $nameUtil,
|
||||
private LinkManager $linkManager
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $params
|
||||
* @return string An actual name.
|
||||
* @throws BadRequest
|
||||
* @throws Error
|
||||
* @throws Conflict
|
||||
*/
|
||||
public function create(string $name, string $type, array $params = [], ?CreateParams $createParams = null): string
|
||||
{
|
||||
$createParams ??= new CreateParams();
|
||||
|
||||
$name = ucfirst($name);
|
||||
$name = trim($name);
|
||||
|
||||
if (empty($name) || empty($type)) {
|
||||
throw new BadRequest();
|
||||
}
|
||||
|
||||
if (!in_array($type, $this->metadata->get(['app', 'entityTemplateList'], []))) {
|
||||
throw new Error("Type '$type' does not exist.");
|
||||
}
|
||||
|
||||
/** @var array<string, mixed> $templateDefs */
|
||||
$templateDefs = $this->metadata->get(['app', 'entityTemplates', $type], []);
|
||||
|
||||
if (!empty($templateDefs['isNotCreatable']) && !$createParams->forceCreate()) {
|
||||
throw new Error("Type '$type' is not creatable.");
|
||||
}
|
||||
|
||||
$name = $this->nameUtil->addCustomPrefix($name, true);
|
||||
|
||||
if ($this->nameUtil->nameIsBad($name)) {
|
||||
throw new Error("Entity name should contain only letters and numbers, " .
|
||||
"start with an upper case letter.");
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsTooShort($name)) {
|
||||
throw new Error("Entity name should not shorter than " . NameUtil::MIN_ENTITY_NAME_LENGTH . ".");
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsTooLong($name)) {
|
||||
throw Error::createWithBody(
|
||||
"Entity type name should not be longer than " . NameUtil::MAX_ENTITY_NAME_LENGTH . ".",
|
||||
Error\Body::create()
|
||||
->withMessageTranslation('nameIsTooLong', 'EntityManager')
|
||||
->encode()
|
||||
);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsUsed($name)) {
|
||||
throw Conflict::createWithBody(
|
||||
"Name '$name' is already used.",
|
||||
Error\Body::create()
|
||||
->withMessageTranslation('nameIsAlreadyUsed', 'EntityManager', [
|
||||
'name' => $name,
|
||||
])
|
||||
->encode()
|
||||
);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsNotAllowed($name)) {
|
||||
throw Conflict::createWithBody(
|
||||
"Entity type name '$name' is not allowed.",
|
||||
Error\Body::create()
|
||||
->withMessageTranslation('nameIsNotAllowed', 'EntityManager', [
|
||||
'name' => $name,
|
||||
])
|
||||
->encode()
|
||||
);
|
||||
}
|
||||
|
||||
$normalizedName = Util::normalizeClassName($name);
|
||||
|
||||
$templateNamespace = "\Espo\Core\Templates";
|
||||
|
||||
$templatePath = "application/Espo/Core/Templates";
|
||||
|
||||
if (!empty($templateDefs['module'])) {
|
||||
$templateModuleName = $templateDefs['module'];
|
||||
|
||||
$normalizedTemplateModuleName = Util::normalizeClassName($templateModuleName);
|
||||
|
||||
$templateNamespace = "\Espo\Modules\\$normalizedTemplateModuleName\Core\Templates";
|
||||
$templatePath = "custom/Espo/Modules/$normalizedTemplateModuleName/Core/Templates";
|
||||
}
|
||||
|
||||
$contents = "<" . "?" . "php\n\n".
|
||||
"namespace Espo\Custom\Controllers;\n\n".
|
||||
"class $normalizedName extends $templateNamespace\Controllers\\$type\n".
|
||||
"{\n".
|
||||
"}\n";
|
||||
|
||||
$this->fileManager->putContents("custom/Espo/Custom/Controllers/$normalizedName.php", $contents);
|
||||
|
||||
$stream = false;
|
||||
|
||||
if (!empty($params['stream'])) {
|
||||
$stream = $params['stream'];
|
||||
}
|
||||
|
||||
$disabled = false;
|
||||
|
||||
if (!empty($params['disabled'])) {
|
||||
$disabled = $params['disabled'];
|
||||
}
|
||||
|
||||
$labelSingular = $name;
|
||||
|
||||
if (!empty($params['labelSingular'])) {
|
||||
$labelSingular = $params['labelSingular'];
|
||||
}
|
||||
|
||||
$labelPlural = $name;
|
||||
|
||||
if (!empty($params['labelPlural'])) {
|
||||
$labelPlural = $params['labelPlural'];
|
||||
}
|
||||
|
||||
$languageList = $this->metadata->get(['app', 'language', 'list'], []);
|
||||
|
||||
foreach ($languageList as $language) {
|
||||
$filePath = $templatePath . '/i18n/' . $language . '/' . $type . '.json';
|
||||
|
||||
if (!$this->fileManager->exists($filePath)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$languageContents = $this->fileManager->getContents($filePath);
|
||||
$languageContents = $this->replace($languageContents, $name, $createParams->getReplaceData());
|
||||
$languageContents = str_replace('{entityTypeTranslated}', $labelSingular, $languageContents);
|
||||
|
||||
$destinationFilePath = 'custom/Espo/Custom/Resources/i18n/' . $language . '/' . $name . '.json';
|
||||
|
||||
$this->fileManager->putContents($destinationFilePath, $languageContents);
|
||||
}
|
||||
|
||||
$filePath = $templatePath . "/Metadata/$type/scopes.json";
|
||||
|
||||
$scopesDataContents = $this->fileManager->getContents($filePath);
|
||||
$scopesDataContents = $this->replace($scopesDataContents, $name, $createParams->getReplaceData());
|
||||
|
||||
$scopesData = Json::decode($scopesDataContents, true);
|
||||
|
||||
$scopesData['stream'] = $stream;
|
||||
$scopesData['disabled'] = $disabled;
|
||||
$scopesData['type'] = $type;
|
||||
$scopesData['module'] = 'Custom';
|
||||
$scopesData['object'] = true;
|
||||
$scopesData['isCustom'] = true;
|
||||
|
||||
if (!empty($templateDefs['isNotRemovable']) || !empty($params['isNotRemovable'])) {
|
||||
$scopesData['isNotRemovable'] = true;
|
||||
}
|
||||
|
||||
if (!empty($params['kanbanStatusIgnoreList'])) {
|
||||
$scopesData['kanbanStatusIgnoreList'] = $params['kanbanStatusIgnoreList'];
|
||||
}
|
||||
|
||||
$this->metadata->set('scopes', $name, $scopesData);
|
||||
|
||||
$filePath = $templatePath . "/Metadata/$type/entityDefs.json";
|
||||
|
||||
$entityDefsDataContents = $this->fileManager->getContents($filePath);
|
||||
$entityDefsDataContents = $this->replace($entityDefsDataContents, $name, $createParams->getReplaceData());
|
||||
|
||||
$entityDefsData = Json::decode($entityDefsDataContents, true);
|
||||
|
||||
$this->metadata->set('entityDefs', $name, $entityDefsData);
|
||||
|
||||
$filePath = $templatePath . "/Metadata/$type/clientDefs.json";
|
||||
|
||||
$clientDefsContents = $this->fileManager->getContents($filePath);
|
||||
$clientDefsContents = $this->replace($clientDefsContents, $name, $createParams->getReplaceData());
|
||||
|
||||
$clientDefsData = Json::decode($clientDefsContents, true);
|
||||
|
||||
if (array_key_exists('color', $params)) {
|
||||
$clientDefsData['color'] = $params['color'];
|
||||
}
|
||||
|
||||
if (array_key_exists('iconClass', $params)) {
|
||||
$clientDefsData['iconClass'] = $params['iconClass'];
|
||||
}
|
||||
|
||||
if (!empty($params['kanbanViewMode'])) {
|
||||
$clientDefsData['kanbanViewMode'] = true;
|
||||
}
|
||||
|
||||
$this->metadata->set('clientDefs', $name, $clientDefsData);
|
||||
|
||||
$this->processMetadataCreateSelectDefs($templatePath, $name, $type);
|
||||
$this->processMetadataCreateRecordDefs($templatePath, $name, $type);
|
||||
|
||||
$this->baseLanguage->set('Global', 'scopeNames', $name, $labelSingular);
|
||||
$this->baseLanguage->set('Global', 'scopeNamesPlural', $name, $labelPlural);
|
||||
|
||||
$this->metadata->save();
|
||||
$this->baseLanguage->save();
|
||||
|
||||
$layoutsPath = $templatePath . "/Layouts/$type";
|
||||
|
||||
if ($this->fileManager->isDir($layoutsPath)) {
|
||||
$this->fileManager->copy($layoutsPath, 'custom/Espo/Custom/Resources/layouts/' . $name);
|
||||
}
|
||||
|
||||
$entityTypeParams = new Params($name, $type, $params);
|
||||
|
||||
$this->processCreateHook($entityTypeParams);
|
||||
|
||||
$tabList = $this->config->get('tabList', []);
|
||||
|
||||
if (!in_array($name, $tabList)) {
|
||||
$tabList[] = $name;
|
||||
|
||||
$this->configWriter->set('tabList', $tabList);
|
||||
$this->configWriter->save();
|
||||
}
|
||||
|
||||
$this->dataManager->rebuild();
|
||||
|
||||
return $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, string> $data
|
||||
*/
|
||||
private function replace(
|
||||
string $contents,
|
||||
string $name,
|
||||
array $data
|
||||
): string {
|
||||
|
||||
$contents = str_replace('{entityType}', $name, $contents);
|
||||
$contents = str_replace('{entityTypeLowerFirst}', lcfirst($name), $contents);
|
||||
|
||||
foreach ($data as $key => $value) {
|
||||
$contents = str_replace('{' . $key . '}', $value, $contents);
|
||||
}
|
||||
|
||||
return $contents;
|
||||
}
|
||||
|
||||
private function processMetadataCreateSelectDefs(string $templatePath, string $name, string $type): void
|
||||
{
|
||||
$path = $templatePath . "/Metadata/$type/selectDefs.json";
|
||||
|
||||
if (!$this->fileManager->isFile($path)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$contents = $this->fileManager->getContents($path);
|
||||
|
||||
$data = Json::decode($contents, true);
|
||||
|
||||
$this->metadata->set('selectDefs', $name, $data);
|
||||
}
|
||||
|
||||
private function processMetadataCreateRecordDefs(string $templatePath, string $name, string $type): void
|
||||
{
|
||||
$path = $templatePath . "/Metadata/$type/recordDefs.json";
|
||||
|
||||
if (!$this->fileManager->isFile($path)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$contents = $this->fileManager->getContents($path);
|
||||
|
||||
$data = Json::decode($contents, true);
|
||||
|
||||
$this->metadata->set('recordDefs', $name, $data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{
|
||||
* stream?: bool,
|
||||
* disabled?: bool,
|
||||
* statusField?: ?string,
|
||||
* labelSingular?: ?string,
|
||||
* labelPlural?: ?string,
|
||||
* sortBy?: ?string,
|
||||
* sortDirection?: ?string,
|
||||
* textFilterFields?: ?string[],
|
||||
* fullTextSearch?: bool,
|
||||
* countDisabled?: bool,
|
||||
* kanbanStatusIgnoreList?: ?string[],
|
||||
* kanbanViewMode?: bool,
|
||||
* color?: ?string,
|
||||
* iconClass?: ?string,
|
||||
* optimisticConcurrencyControl?: bool,
|
||||
* }|array<string, mixed> $params
|
||||
* @throws Error
|
||||
*/
|
||||
public function update(string $name, array $params): void
|
||||
{
|
||||
if (!$this->metadata->get('scopes.' . $name)) {
|
||||
throw new Error("Entity `$name` does not exist.");
|
||||
}
|
||||
|
||||
if (!$this->isScopeCustomizable($name)) {
|
||||
throw new Error("Entity type $name is not customizable.");
|
||||
}
|
||||
|
||||
$isCustom = $this->metadata->get(['scopes', $name, 'isCustom']);
|
||||
$type = $this->metadata->get(['scopes', $name, 'type']);
|
||||
|
||||
if ($this->metadata->get(['scopes', $name, 'statusFieldLocked'])) {
|
||||
unset($params['statusField']);
|
||||
}
|
||||
|
||||
$initialData = [
|
||||
'optimisticConcurrencyControl' =>
|
||||
$this->metadata->get(['entityDefs', $name, 'optimisticConcurrencyControl']) ?? false,
|
||||
'fullTextSearch' =>
|
||||
$this->metadata->get(['entityDefs', $name, 'collection', 'fullTextSearch']) ?? false,
|
||||
];
|
||||
|
||||
$entityTypeParams = new Params($name, $type, array_merge($this->getCurrentParams($name), $params));
|
||||
$previousEntityTypeParams = new Params($name, $type, $this->getCurrentParams($name));
|
||||
|
||||
if (array_key_exists('stream', $params)) {
|
||||
$this->metadata->set('scopes', $name, ['stream' => (bool) $params['stream']]);
|
||||
}
|
||||
|
||||
if (array_key_exists('disabled', $params)) {
|
||||
$this->metadata->set('scopes', $name, ['disabled' => (bool) $params['disabled']]);
|
||||
}
|
||||
|
||||
if (array_key_exists('statusField', $params)) {
|
||||
$this->metadata->set('scopes', $name, ['statusField' => $params['statusField']]);
|
||||
|
||||
if (!$params['statusField'] && $this->metadata->get("clientDefs.$name.kanbanViewMode")) {
|
||||
$params['kanbanViewMode'] = false;
|
||||
$params['kanbanStatusIgnoreList'] = null;
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($params['sortBy'])) {
|
||||
$this->metadata->set('entityDefs', $name, [
|
||||
'collection' => ['orderBy' => $params['sortBy']],
|
||||
]);
|
||||
|
||||
if (isset($params['sortDirection'])) {
|
||||
$this->metadata->set('entityDefs', $name, [
|
||||
'collection' => ['order' => $params['sortDirection']],
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($params['textFilterFields'])) {
|
||||
$this->metadata->set('entityDefs', $name, [
|
||||
'collection' => ['textFilterFields' => $params['textFilterFields']]
|
||||
]);
|
||||
}
|
||||
|
||||
if (isset($params['fullTextSearch'])) {
|
||||
$this->metadata->set('entityDefs', $name, [
|
||||
'collection' => ['fullTextSearch' => (bool) $params['fullTextSearch']],
|
||||
]);
|
||||
}
|
||||
|
||||
if (isset($params['countDisabled'])) {
|
||||
$this->metadata->set('entityDefs', $name, [
|
||||
'collection' => ['countDisabled' => (bool) $params['countDisabled']],
|
||||
]);
|
||||
}
|
||||
|
||||
if (array_key_exists('kanbanStatusIgnoreList', $params)) {
|
||||
$itemValue = $params['kanbanStatusIgnoreList'] ?: null;
|
||||
|
||||
$this->metadata->set('scopes', $name, ['kanbanStatusIgnoreList' => $itemValue]);
|
||||
}
|
||||
|
||||
if (array_key_exists('kanbanViewMode', $params)) {
|
||||
$this->metadata->set('clientDefs', $name, ['kanbanViewMode' => $params['kanbanViewMode']]);
|
||||
}
|
||||
|
||||
if (array_key_exists('color', $params)) {
|
||||
$this->metadata->set('clientDefs', $name, ['color' => $params['color']]);
|
||||
}
|
||||
|
||||
if (array_key_exists('iconClass', $params)) {
|
||||
$this->metadata->set('clientDefs', $name, ['iconClass' => $params['iconClass']]);
|
||||
}
|
||||
|
||||
$this->setAdditionalParamsInMetadata($name, $params);
|
||||
|
||||
if (!empty($params['labelSingular'])) {
|
||||
$labelSingular = $params['labelSingular'];
|
||||
$labelCreate = $this->language->translateLabel('Create') . ' ' . $labelSingular;
|
||||
|
||||
$this->language->set('Global', 'scopeNames', $name, $labelSingular);
|
||||
$this->language->set($name, 'labels', 'Create ' . $name, $labelCreate);
|
||||
|
||||
if ($isCustom) {
|
||||
$this->baseLanguage->set('Global', 'scopeNames', $name, $labelSingular);
|
||||
$this->baseLanguage->set($name, 'labels', 'Create ' . $name, $labelCreate);
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($params['labelPlural'])) {
|
||||
$labelPlural = $params['labelPlural'];
|
||||
$this->language->set('Global', 'scopeNamesPlural', $name, $labelPlural);
|
||||
|
||||
if ($isCustom) {
|
||||
$this->baseLanguage->set('Global', 'scopeNamesPlural', $name, $labelPlural);
|
||||
}
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
$this->language->save();
|
||||
|
||||
if ($isCustom) {
|
||||
if ($this->isLanguageNotBase()) {
|
||||
$this->baseLanguage->save();
|
||||
}
|
||||
}
|
||||
|
||||
$this->processUpdateHook($entityTypeParams, $previousEntityTypeParams);
|
||||
|
||||
$this->dataManager->clearCache();
|
||||
|
||||
if (
|
||||
!$initialData['optimisticConcurrencyControl'] &&
|
||||
!empty($params['optimisticConcurrencyControl']) &&
|
||||
(
|
||||
empty($params['fullTextSearch']) || $initialData['fullTextSearch']
|
||||
)
|
||||
) {
|
||||
$this->dataManager->rebuild();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws Forbidden
|
||||
* @throws Error
|
||||
*/
|
||||
public function delete(string $name, ?DeleteParams $deleteParams = null): void
|
||||
{
|
||||
$deleteParams ??= new DeleteParams();
|
||||
|
||||
if (!$this->isCustom($name)) {
|
||||
throw new Forbidden;
|
||||
}
|
||||
|
||||
if (!$this->isScopeCustomizable($name)) {
|
||||
throw new Error("Entity type $name is not customizable.");
|
||||
}
|
||||
|
||||
$normalizedName = Util::normalizeClassName($name);
|
||||
|
||||
$type = $this->metadata->get(['scopes', $name, 'type']);
|
||||
$isNotRemovable = $this->metadata->get(['scopes', $name, 'isNotRemovable']);
|
||||
/** @var array<string, mixed> $templateDefs */
|
||||
$templateDefs = $this->metadata->get(['app', 'entityTemplates', $type], []);
|
||||
|
||||
if (
|
||||
(!empty($templateDefs['isNotRemovable']) || $isNotRemovable) &&
|
||||
!$deleteParams->forceRemove()
|
||||
) {
|
||||
throw new Error("Type '$type' is not removable.");
|
||||
}
|
||||
|
||||
$entityTypeParams = new Params($name, $type, $this->getCurrentParams($name));
|
||||
|
||||
$this->metadata->delete('entityDefs', $name);
|
||||
$this->metadata->delete('clientDefs', $name);
|
||||
$this->metadata->delete('recordDefs', $name);
|
||||
$this->metadata->delete('selectDefs', $name);
|
||||
$this->metadata->delete('entityAcl', $name);
|
||||
$this->metadata->delete('scopes', $name);
|
||||
|
||||
foreach ($this->metadata->get(['entityDefs', $name, 'links'], []) as $link => $item) {
|
||||
try {
|
||||
$this->linkManager->delete(['entity' => $name, 'link' => $link]);
|
||||
} catch (Exception) {}
|
||||
}
|
||||
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Resources/metadata/entityDefs/$name.json");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Resources/metadata/clientDefs/$name.json");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Resources/metadata/recordDefs/$name.json");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Resources/metadata/selectDefs/$name.json");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Resources/metadata/scopes/$name.json");
|
||||
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Entities/$normalizedName.php");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Services/$normalizedName.php");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Controllers/$normalizedName.php");
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/Repositories/$normalizedName.php");
|
||||
|
||||
if (file_exists("custom/Espo/Custom/SelectManagers/$normalizedName.php")) {
|
||||
$this->fileManager->removeFile("custom/Espo/Custom/SelectManagers/$normalizedName.php");
|
||||
}
|
||||
|
||||
$this->fileManager->removeInDir("custom/Espo/Custom/Resources/layouts/$normalizedName");
|
||||
$this->fileManager->removeDir("custom/Espo/Custom/Resources/layouts/$normalizedName");
|
||||
|
||||
$languageList = $this->metadata->get(['app', 'language', 'list'], []);
|
||||
|
||||
foreach ($languageList as $language) {
|
||||
$filePath = 'custom/Espo/Custom/Resources/i18n/' . $language . '/' . $normalizedName . '.json';
|
||||
|
||||
if (!file_exists($filePath)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->fileManager->removeFile($filePath);
|
||||
}
|
||||
|
||||
try {
|
||||
$this->language->delete('Global', 'scopeNames', $name);
|
||||
$this->language->delete('Global', 'scopeNamesPlural', $name);
|
||||
|
||||
$this->baseLanguage->delete('Global', 'scopeNames', $name);
|
||||
$this->baseLanguage->delete('Global', 'scopeNamesPlural', $name);
|
||||
} catch (Exception) {}
|
||||
|
||||
$this->metadata->save();
|
||||
$this->language->save();
|
||||
|
||||
if ($this->isLanguageNotBase()) {
|
||||
$this->baseLanguage->save();
|
||||
}
|
||||
|
||||
if ($type) {
|
||||
$this->processDeleteHook($entityTypeParams);
|
||||
}
|
||||
|
||||
$this->deleteEntityTypeFromConfigParams($name);
|
||||
|
||||
$this->dataManager->clearCache();
|
||||
}
|
||||
|
||||
private function deleteEntityTypeFromConfigParams(string $entityType): void
|
||||
{
|
||||
$paramList = $this->metadata->get(['app', 'config', 'entityTypeListParamList']) ?? [];
|
||||
|
||||
foreach ($paramList as $param) {
|
||||
$this->deleteEntityTypeFromConfigParam($entityType, $param);
|
||||
}
|
||||
|
||||
$this->configWriter->save();
|
||||
}
|
||||
|
||||
private function deleteEntityTypeFromConfigParam(string $entityType, string $param): void
|
||||
{
|
||||
$list = $this->config->get($param) ?? [];
|
||||
|
||||
if (($key = array_search($entityType, $list)) !== false) {
|
||||
unset($list[$key]);
|
||||
|
||||
$list = array_values($list);
|
||||
}
|
||||
|
||||
$this->configWriter->set($param, $list);
|
||||
}
|
||||
|
||||
private function isCustom(string $name): bool
|
||||
{
|
||||
return (bool) $this->metadata->get('scopes.' . $name . '.isCustom');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, string> $data
|
||||
* @throws Error
|
||||
*/
|
||||
public function setFormulaData(string $scope, array $data): void
|
||||
{
|
||||
if (!$this->isScopeCustomizableFormula($scope)) {
|
||||
throw new Error("Entity type $scope is not customizable.");
|
||||
}
|
||||
|
||||
$this->metadata->set('formula', $scope, $data);
|
||||
$this->metadata->save();
|
||||
|
||||
$this->dataManager->clearCache();
|
||||
}
|
||||
|
||||
private function processUpdateHook(Params $params, Params $previousParams): void
|
||||
{
|
||||
/** @var class-string<UpdateHook>[] $classNameList */
|
||||
$classNameList = $this->metadata->get(['app', 'entityManager', 'updateHookClassNameList']) ?? [];
|
||||
|
||||
foreach ($classNameList as $className) {
|
||||
$hook = $this->injectableFactory->create($className);
|
||||
|
||||
$hook->process($params, $previousParams);
|
||||
}
|
||||
}
|
||||
|
||||
private function processDeleteHook(Params $params): void
|
||||
{
|
||||
/** @var class-string<DeleteHook>[] $classNameList */
|
||||
$classNameList = $this->metadata->get(['app', 'entityManager', 'deleteHookClassNameList']) ?? [];
|
||||
|
||||
foreach ($classNameList as $className) {
|
||||
$hook = $this->injectableFactory->create($className);
|
||||
|
||||
$hook->process($params);
|
||||
}
|
||||
}
|
||||
|
||||
private function processCreateHook(Params $params): void
|
||||
{
|
||||
/** @var class-string<CreateHook>[] $classNameList */
|
||||
$classNameList = $this->metadata->get(['app', 'entityManager', 'createHookClassNameList']) ?? [];
|
||||
|
||||
foreach ($classNameList as $className) {
|
||||
$hook = $this->injectableFactory->create($className);
|
||||
|
||||
$hook->process($params);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws Error
|
||||
*/
|
||||
public function resetToDefaults(string $name): void
|
||||
{
|
||||
if ($this->isCustom($name)) {
|
||||
throw new Error("Can't reset to defaults custom entity type '$name.'");
|
||||
}
|
||||
|
||||
$type = $this->metadata->get(['scopes', $name, 'type']);
|
||||
|
||||
$previousEntityTypeParams = new Params($name, $type, $this->getCurrentParams($name));
|
||||
|
||||
$this->metadata->delete('scopes', $name, [
|
||||
'disabled',
|
||||
'stream',
|
||||
'statusField',
|
||||
'kanbanStatusIgnoreList',
|
||||
]);
|
||||
|
||||
$this->metadata->delete('clientDefs', $name, [
|
||||
'iconClass',
|
||||
'statusField',
|
||||
'kanbanViewMode',
|
||||
'color',
|
||||
]);
|
||||
|
||||
$this->metadata->delete('entityDefs', $name, [
|
||||
'collection.sortBy',
|
||||
'collection.asc',
|
||||
'collection.orderBy',
|
||||
'collection.order',
|
||||
'collection.textFilterFields',
|
||||
'collection.fullTextSearch',
|
||||
]);
|
||||
|
||||
foreach ($this->getAdditionalParamLocationMap($name) as $it) {
|
||||
['location' => $location, 'param' => $actualParam] = $it;
|
||||
|
||||
$this->metadata->delete($location, $name, [$actualParam]);
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
|
||||
$this->language->delete('Global', 'scopeNames', $name);
|
||||
$this->language->delete('Global', 'scopeNamesPlural', $name);
|
||||
$this->language->save();
|
||||
|
||||
$entityTypeParams = new Params($name, $type, $this->getCurrentParams($name));
|
||||
|
||||
$this->processUpdateHook($entityTypeParams, $previousEntityTypeParams);
|
||||
|
||||
$this->dataManager->clearCache();
|
||||
|
||||
if (
|
||||
!$previousEntityTypeParams->get('optimisticConcurrencyControl') &&
|
||||
$entityTypeParams->get('optimisticConcurrencyControl')
|
||||
) {
|
||||
$this->dataManager->rebuild();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<string, mixed> $data
|
||||
*/
|
||||
private function setAdditionalParamsInMetadata(string $entityType, array $data): void
|
||||
{
|
||||
foreach ($this->getAdditionalParamLocationMap($entityType) as $param => $it) {
|
||||
['location' => $location, 'param' => $actualParam] = $it;
|
||||
|
||||
if (!array_key_exists($param, $data)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$value = $data[$param];
|
||||
|
||||
$this->metadata->setParam($location, $entityType, $actualParam, $value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function getCurrentParams(string $entityType): array
|
||||
{
|
||||
$data = [];
|
||||
|
||||
foreach ($this->getAdditionalParamLocationMap($entityType) as $param => $item) {
|
||||
['location' => $location, 'param' => $actualParam] = $item;
|
||||
|
||||
$data[$param] = $this->metadata->get([$location, $entityType, $actualParam]);
|
||||
}
|
||||
|
||||
$data['statusField'] = $this->metadata->get(['scopes', $entityType, 'statusField']);
|
||||
$data['kanbanViewMode'] = $this->metadata->get(['scopes', $entityType, 'kanbanViewMode']);
|
||||
$data['disabled'] = $this->metadata->get(['scopes', $entityType, 'disabled']);
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<string, array{location: string, param: string}>
|
||||
*/
|
||||
private function getAdditionalParamLocationMap(string $entityType): array
|
||||
{
|
||||
$templateType = $this->metadata->get(['scopes', $entityType, 'type']);
|
||||
|
||||
$map1 = $this->metadata->get(['app', 'entityManagerParams', 'Global']) ?? [];
|
||||
$map2 = $this->metadata->get(['app', 'entityManagerParams', '@' . ($templateType ?? '_')]) ?? [];
|
||||
$map3 = $this->metadata->get(['app', 'entityManagerParams', $entityType]) ?? [];
|
||||
|
||||
/** @var array<string, array<string, mixed>> $params */
|
||||
$params = [...$map1, ...$map2, ...$map3];
|
||||
|
||||
$result = [];
|
||||
|
||||
foreach ($params as $param => $defs) {
|
||||
$location = $defs['location'] ?? self::DEFAULT_PARAM_LOCATION;
|
||||
$actualParam = $defs['param'] ?? $param;
|
||||
|
||||
if (!in_array($location, self::ALLOWED_PARAM_LOCATIONS)) {
|
||||
throw new RuntimeException("Param location `$location` is not supported.");
|
||||
}
|
||||
|
||||
$result[$param] = [
|
||||
'location' => $location,
|
||||
'param' => $actualParam,
|
||||
];
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
private function isLanguageNotBase(): bool
|
||||
{
|
||||
return $this->language->getLanguage() !== $this->baseLanguage->getLanguage();
|
||||
}
|
||||
|
||||
public function resetFormulaToDefault(string $scope, string $type): void
|
||||
{
|
||||
$this->metadata->delete('formula', $scope, $type);
|
||||
$this->metadata->save();
|
||||
}
|
||||
|
||||
private function isScopeCustomizable(string $scope): bool
|
||||
{
|
||||
if (!$this->metadata->get("scopes.$scope.customizable")) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($this->metadata->get("scopes.$scope.entityManager.edit") === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
private function isScopeCustomizableFormula(string $scope): bool
|
||||
{
|
||||
if (!$this->metadata->get("scopes.$scope.customizable")) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($this->metadata->get("scopes.$scope.entityManager.formula") === false) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
37
application/Espo/Tools/EntityManager/Hook/CreateHook.php
Normal file
37
application/Espo/Tools/EntityManager/Hook/CreateHook.php
Normal file
@@ -0,0 +1,37 @@
|
||||
<?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\EntityManager\Hook;
|
||||
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
interface CreateHook
|
||||
{
|
||||
public function process(Params $params): void;
|
||||
}
|
||||
37
application/Espo/Tools/EntityManager/Hook/DeleteHook.php
Normal file
37
application/Espo/Tools/EntityManager/Hook/DeleteHook.php
Normal file
@@ -0,0 +1,37 @@
|
||||
<?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\EntityManager\Hook;
|
||||
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
interface DeleteHook
|
||||
{
|
||||
public function process(Params $params): void;
|
||||
}
|
||||
@@ -0,0 +1,143 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\ORM\Type\FieldType;
|
||||
use Espo\Core\Utils\Log;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Entities\User;
|
||||
use Espo\ORM\Type\RelationType;
|
||||
use Espo\Tools\EntityManager\Hook\UpdateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class AssignedUsersUpdateHook implements UpdateHook
|
||||
{
|
||||
private const PARAM = 'assignedUsers';
|
||||
private const FIELD = Field::ASSIGNED_USERS;
|
||||
private const RELATION_NAME = 'entityUser';
|
||||
private const FIELD_ASSIGNED_USER = Field::ASSIGNED_USER;
|
||||
|
||||
private const DEFAULT_MAX_COUNT = 10;
|
||||
|
||||
public function __construct(
|
||||
private Metadata $metadata,
|
||||
private Log $log,
|
||||
) {}
|
||||
|
||||
public function process(Params $params, Params $previousParams): void
|
||||
{
|
||||
if ($params->get(self::PARAM) && !$previousParams->get(self::PARAM)) {
|
||||
$this->add($params->getName());
|
||||
} else if (!$params->get(self::PARAM) && $previousParams->get(self::PARAM)) {
|
||||
$this->remove($params->getName());
|
||||
}
|
||||
}
|
||||
|
||||
private function add(string $entityType): void
|
||||
{
|
||||
if ($this->metadata->get("entityDefs.$entityType.links." . self::FIELD . ".isCustom")) {
|
||||
$this->log->warning("Cannot enable multiple assigned users for $entityType as the link already exists.");
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, [
|
||||
'fields' => [
|
||||
self::FIELD => [
|
||||
'type' => FieldType::LINK_MULTIPLE,
|
||||
'view' => 'views/fields/assigned-users',
|
||||
'maxCount' => self::DEFAULT_MAX_COUNT,
|
||||
],
|
||||
],
|
||||
'links' => [
|
||||
self::FIELD => [
|
||||
'type' => RelationType::HAS_MANY,
|
||||
'entity' => User::ENTITY_TYPE,
|
||||
'relationName' => self::RELATION_NAME,
|
||||
'layoutRelationshipsDisabled' => true,
|
||||
],
|
||||
],
|
||||
]);
|
||||
|
||||
$this->metadata->set('entityAcl', $entityType, [
|
||||
'links' => [
|
||||
self::FIELD => [
|
||||
'readOnly' => true,
|
||||
],
|
||||
],
|
||||
]);
|
||||
|
||||
if ($this->metadata->get("entityDefs.$entityType.fields.assignedUser")) {
|
||||
$this->metadata->set('entityDefs', $entityType, [
|
||||
'fields' => [
|
||||
self::FIELD_ASSIGNED_USER => [
|
||||
'disabled' => true,
|
||||
],
|
||||
],
|
||||
'links' => [
|
||||
self::FIELD_ASSIGNED_USER => [
|
||||
'disabled' => true,
|
||||
],
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
|
||||
private function remove(string $entityType): void
|
||||
{
|
||||
$field = self::FIELD;
|
||||
|
||||
if (
|
||||
$this->metadata->get("entityDefs.$entityType.links.$field.isCustom") &&
|
||||
$this->metadata->get("entityDefs.$entityType.links.$field.relationName") !== self::RELATION_NAME
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->metadata->delete('entityDefs', $entityType, [
|
||||
'fields.' . self::FIELD,
|
||||
'links.' . self::FIELD,
|
||||
'fields.' . self::FIELD_ASSIGNED_USER . '.disabled',
|
||||
'links.' . self::FIELD_ASSIGNED_USER . '.disabled',
|
||||
]);
|
||||
|
||||
$this->metadata->delete('entityAcl', $entityType, [
|
||||
'links.' . self::FIELD,
|
||||
]);
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,146 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\DataManager;
|
||||
use Espo\Core\Exceptions\Error;
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\ORM\Type\FieldType;
|
||||
use Espo\Core\Utils\Log;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Entities\User;
|
||||
use Espo\ORM\Defs\Params\RelationParam;
|
||||
use Espo\ORM\Type\RelationType;
|
||||
use Espo\Tools\EntityManager\Hook\UpdateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class CollaboratorsUpdateHook implements UpdateHook
|
||||
{
|
||||
private const PARAM = 'collaborators';
|
||||
private const FIELD = Field::COLLABORATORS;
|
||||
private const RELATION_NAME = 'entityCollaborator';
|
||||
|
||||
private const DEFAULT_MAX_COUNT = 30;
|
||||
|
||||
public function __construct(
|
||||
private Metadata $metadata,
|
||||
private Log $log,
|
||||
private DataManager $dataManager,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @throws Error
|
||||
*/
|
||||
public function process(Params $params, Params $previousParams): void
|
||||
{
|
||||
if ($params->get(self::PARAM) && !$previousParams->get(self::PARAM)) {
|
||||
$this->add($params->getName());
|
||||
} else if (!$params->get(self::PARAM) && $previousParams->get(self::PARAM)) {
|
||||
$this->remove($params->getName());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws Error
|
||||
*/
|
||||
private function add(string $entityType): void
|
||||
{
|
||||
if ($this->metadata->get("entityDefs.$entityType.links." . self::FIELD . ".isCustom")) {
|
||||
$this->log->warning("Cannot enable collaborators for $entityType as the link already exists.");
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, [
|
||||
'fields' => [
|
||||
self::FIELD => [
|
||||
'type' => FieldType::LINK_MULTIPLE,
|
||||
'view' => 'views/fields/collaborators',
|
||||
'maxCount' => self::DEFAULT_MAX_COUNT,
|
||||
'fieldManagerParamList' => [
|
||||
'readOnly',
|
||||
'readOnlyAfterCreate',
|
||||
'audited',
|
||||
'autocompleteOnEmpty',
|
||||
'maxCount',
|
||||
'inlineEditDisabled',
|
||||
'tooltipText'
|
||||
]
|
||||
],
|
||||
],
|
||||
'links' => [
|
||||
self::FIELD => [
|
||||
'type' => RelationType::HAS_MANY,
|
||||
'entity' => User::ENTITY_TYPE,
|
||||
RelationParam::RELATION_NAME => self::RELATION_NAME,
|
||||
'layoutRelationshipsDisabled' => true,
|
||||
],
|
||||
],
|
||||
]);
|
||||
|
||||
$this->metadata->set('entityAcl', $entityType, [
|
||||
'links' => [
|
||||
self::FIELD => [
|
||||
'readOnly' => true,
|
||||
],
|
||||
],
|
||||
]);
|
||||
|
||||
$this->metadata->save();
|
||||
|
||||
$this->dataManager->rebuild([$entityType]);
|
||||
}
|
||||
|
||||
private function remove(string $entityType): void
|
||||
{
|
||||
$field = self::FIELD;
|
||||
|
||||
if (
|
||||
$this->metadata->get("entityDefs.$entityType.links.$field.isCustom") &&
|
||||
$this->metadata->get("entityDefs.$entityType.links.$field.relationName") !== self::RELATION_NAME
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->metadata->delete('entityDefs', $entityType, [
|
||||
'fields.' . self::FIELD,
|
||||
'links.' . self::FIELD,
|
||||
]);
|
||||
|
||||
$this->metadata->delete('entityAcl', $entityType, [
|
||||
'links.' . self::FIELD,
|
||||
]);
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\ORM\Defs\Params\RelationParam;
|
||||
use Espo\ORM\Type\RelationType;
|
||||
use Espo\Tools\EntityManager\Hook\DeleteHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class DeleteHasChildrenLinks implements DeleteHook
|
||||
{
|
||||
public function __construct(
|
||||
private Metadata $metadata,
|
||||
) {}
|
||||
|
||||
public function process(Params $params): void
|
||||
{
|
||||
/** @var array<string, array<string, mixed>> $entityDefs */
|
||||
$entityDefs = $this->metadata->get('entityDefs', []);
|
||||
|
||||
foreach ($entityDefs as $entityType => $defs) {
|
||||
/** @var array<string, array<string, mixed>> $links */
|
||||
$links = $defs['links'] ?? [];
|
||||
|
||||
foreach ($links as $link => $linkDefs) {
|
||||
$isCustom = $linkDefs['isCustom'] ?? false;
|
||||
$foreignEntityType = $linkDefs[RelationParam::ENTITY] ?? null;
|
||||
$type = $linkDefs[RelationParam::TYPE] ?? null;
|
||||
|
||||
if (
|
||||
!$isCustom ||
|
||||
$foreignEntityType !== $params->getName() ||
|
||||
$type !== RelationType::HAS_CHILDREN
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->metadata->delete('entityDefs', $entityType, "links.$link");
|
||||
}
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Templates\Entities\Event;
|
||||
use Espo\Core\Utils\Language;
|
||||
use Espo\Tools\EntityManager\Hook\CreateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
class EventCreateHook implements CreateHook
|
||||
{
|
||||
public function __construct(
|
||||
private Language $baseLanguage,
|
||||
private Language $language
|
||||
) {}
|
||||
|
||||
public function process(Params $params): void
|
||||
{
|
||||
if ($params->getType() !== Event::TEMPLATE_TYPE) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->translate($this->baseLanguage, $params);
|
||||
|
||||
if ($this->baseLanguage->getLanguage() === $this->language->getLanguage()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->translate($this->language, $params);
|
||||
}
|
||||
|
||||
private function translate(Language $language, Params $params): void
|
||||
{
|
||||
$name = $params->getName();
|
||||
|
||||
$label1 = 'Schedule ' . $name;
|
||||
$label2 = 'Log ' . $name;
|
||||
|
||||
$translatedName = $params->get('labelSingular') ?? $name;
|
||||
|
||||
$translation1 = $language->translateLabel('Schedule') . ' ' . $translatedName;
|
||||
$translation2 = $language->translateLabel('Log') . ' ' . $translatedName;
|
||||
|
||||
$language->set('Global', 'labels', $label1, $translation1);
|
||||
$language->set('Global', 'labels', $label2, $translation2);
|
||||
|
||||
$language->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Templates\Entities\Event;
|
||||
use Espo\Core\Utils\Language;
|
||||
use Espo\Tools\EntityManager\Hook\DeleteHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
class EventDeleteHook implements DeleteHook
|
||||
{
|
||||
public function __construct(
|
||||
private Language $baseLanguage,
|
||||
private Language $language
|
||||
) {}
|
||||
|
||||
public function process(Params $params): void
|
||||
{
|
||||
if (
|
||||
$params->getType() !== Event::TEMPLATE_TYPE
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$name = $params->getName();
|
||||
|
||||
$label1 = 'Schedule ' . $name;
|
||||
$label2 = 'Log ' . $name;
|
||||
|
||||
$this->baseLanguage->delete('Global', 'labels', $label1);
|
||||
$this->baseLanguage->delete('Global', 'labels', $label2);
|
||||
|
||||
$this->language->delete('Global', 'labels', $label1);
|
||||
$this->language->delete('Global', 'labels', $label2);
|
||||
|
||||
$this->baseLanguage->save();
|
||||
$this->language->save();
|
||||
}
|
||||
}
|
||||
@@ -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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\Templates\Entities\BasePlus;
|
||||
use Espo\Core\Templates\Entities\Company;
|
||||
use Espo\Core\Templates\Entities\Person;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Modules\Crm\Entities\Task;
|
||||
use Espo\Tools\EntityManager\Hook\CreateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
class PlusCreateHook implements CreateHook
|
||||
{
|
||||
public function __construct(
|
||||
private Config $config,
|
||||
private Metadata $metadata
|
||||
) {}
|
||||
|
||||
public function process(Params $params): void
|
||||
{
|
||||
if (
|
||||
!in_array($params->getType(), [
|
||||
BasePlus::TEMPLATE_TYPE,
|
||||
Company::TEMPLATE_TYPE,
|
||||
Person::TEMPLATE_TYPE,
|
||||
])
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$name = $params->getName();
|
||||
|
||||
$activitiesEntityTypeList = $this->config->get('activitiesEntityList', []);
|
||||
$historyEntityTypeList = $this->config->get('historyEntityList', []);
|
||||
|
||||
$entityTypeList = array_merge($activitiesEntityTypeList, $historyEntityTypeList);
|
||||
$entityTypeList[] = Task::ENTITY_TYPE;
|
||||
$entityTypeList = array_unique($entityTypeList);
|
||||
|
||||
foreach ($entityTypeList as $entityType) {
|
||||
if (!$this->metadata->get(['entityDefs', $entityType, 'fields', Field::PARENT, 'entityList'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$list = $this->metadata->get(['entityDefs', $entityType, 'fields', Field::PARENT, 'entityList'], []);
|
||||
|
||||
if (!in_array($name, $list)) {
|
||||
$list[] = $name;
|
||||
|
||||
$data = [
|
||||
'fields' => [
|
||||
Field::PARENT => ['entityList' => $list]
|
||||
]
|
||||
];
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, $data);
|
||||
}
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\Templates\Entities\BasePlus;
|
||||
use Espo\Core\Templates\Entities\Company;
|
||||
use Espo\Core\Templates\Entities\Person;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Modules\Crm\Entities\Task;
|
||||
use Espo\Tools\EntityManager\Hook\CreateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
class PlusDeleteHook implements CreateHook
|
||||
{
|
||||
public function __construct(
|
||||
private Config $config,
|
||||
private Metadata $metadata
|
||||
) {}
|
||||
|
||||
public function process(Params $params): void
|
||||
{
|
||||
if (
|
||||
!in_array($params->getType(), [
|
||||
BasePlus::TEMPLATE_TYPE,
|
||||
Company::TEMPLATE_TYPE,
|
||||
Person::TEMPLATE_TYPE,
|
||||
])
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$name = $params->getName();
|
||||
|
||||
$activitiesEntityTypeList = $this->config->get('activitiesEntityList', []);
|
||||
$historyEntityTypeList = $this->config->get('historyEntityList', []);
|
||||
|
||||
$entityTypeList = array_merge($activitiesEntityTypeList, $historyEntityTypeList);
|
||||
$entityTypeList[] = Task::ENTITY_TYPE;
|
||||
$entityTypeList = array_unique($entityTypeList);
|
||||
|
||||
foreach ($entityTypeList as $entityType) {
|
||||
if (!$this->metadata->get(['entityDefs', $entityType, 'fields', Field::PARENT, 'entityList'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$list = $this->metadata->get(['entityDefs', $entityType, 'fields', Field::PARENT, 'entityList'], []);
|
||||
|
||||
if (in_array($name, $list)) {
|
||||
$key = array_search($name, $list);
|
||||
|
||||
unset($list[$key]);
|
||||
|
||||
$list = array_values($list);
|
||||
|
||||
$data = [
|
||||
'fields' => [
|
||||
'parent' => ['entityList' => $list]
|
||||
]
|
||||
];
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, $data);
|
||||
}
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
<?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\EntityManager\Hook\Hooks;
|
||||
|
||||
use Espo\Core\DataManager;
|
||||
use Espo\Core\Exceptions\Error;
|
||||
use Espo\Tools\EntityManager\Hook\UpdateHook;
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
/**
|
||||
* @noinspection PhpUnused
|
||||
*/
|
||||
class StreamUpdateHook implements UpdateHook
|
||||
{
|
||||
private const PARAM = 'stream';
|
||||
|
||||
public function __construct(
|
||||
private DataManager $dataManager,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* @throws Error
|
||||
*/
|
||||
public function process(Params $params, Params $previousParams): void
|
||||
{
|
||||
if ($params->get(self::PARAM) && !$previousParams->get(self::PARAM)) {
|
||||
$this->dataManager->rebuild([$params->getName()]);
|
||||
}
|
||||
}
|
||||
}
|
||||
37
application/Espo/Tools/EntityManager/Hook/UpdateHook.php
Normal file
37
application/Espo/Tools/EntityManager/Hook/UpdateHook.php
Normal file
@@ -0,0 +1,37 @@
|
||||
<?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\EntityManager\Hook;
|
||||
|
||||
use Espo\Tools\EntityManager\Params;
|
||||
|
||||
interface UpdateHook
|
||||
{
|
||||
public function process(Params $params, Params $previousParams): void;
|
||||
}
|
||||
399
application/Espo/Tools/EntityManager/NameUtil.php
Normal file
399
application/Espo/Tools/EntityManager/NameUtil.php
Normal file
@@ -0,0 +1,399 @@
|
||||
<?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\EntityManager;
|
||||
|
||||
use Espo\Core\Exceptions\Error;
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Core\Utils\Route;
|
||||
use Espo\Core\Utils\Util;
|
||||
use Espo\Core\ServiceFactory;
|
||||
use Espo\ORM\Defs\Params\EntityParam;
|
||||
use Espo\ORM\EntityManager;
|
||||
use Espo\ORM\Entity;
|
||||
use Espo\ORM\Name\Attribute;
|
||||
|
||||
class NameUtil
|
||||
{
|
||||
public const MAX_ENTITY_NAME_LENGTH = 64;
|
||||
public const MIN_ENTITY_NAME_LENGTH = 3;
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
public const RESERVED_WORLD_LIST = [
|
||||
'__halt_compiler',
|
||||
'abstract',
|
||||
'and',
|
||||
'array',
|
||||
'as',
|
||||
'break',
|
||||
'callable',
|
||||
'case',
|
||||
'catch',
|
||||
'class',
|
||||
'clone',
|
||||
'const',
|
||||
'continue',
|
||||
'declare',
|
||||
'default',
|
||||
'die',
|
||||
'do',
|
||||
'echo',
|
||||
'else',
|
||||
'elseif',
|
||||
'empty',
|
||||
'enddeclare',
|
||||
'endfor',
|
||||
'endforeach',
|
||||
'endif',
|
||||
'endswitch',
|
||||
'endwhile',
|
||||
'eval',
|
||||
'exit',
|
||||
'extends',
|
||||
'final',
|
||||
'for',
|
||||
'foreach',
|
||||
'function',
|
||||
'global',
|
||||
'goto',
|
||||
'if',
|
||||
'implements',
|
||||
'include',
|
||||
'include_once',
|
||||
'instanceof',
|
||||
'insteadof',
|
||||
'interface',
|
||||
'isset',
|
||||
'list',
|
||||
'namespace',
|
||||
'new',
|
||||
'or',
|
||||
'print',
|
||||
'private',
|
||||
'protected',
|
||||
'public',
|
||||
'require',
|
||||
'require_once',
|
||||
'return',
|
||||
'static',
|
||||
'switch',
|
||||
'throw',
|
||||
'trait',
|
||||
'try',
|
||||
'unset',
|
||||
'use',
|
||||
'var',
|
||||
'while',
|
||||
'xor',
|
||||
'common',
|
||||
'fn',
|
||||
'parent',
|
||||
'int',
|
||||
'float',
|
||||
'bool',
|
||||
'string',
|
||||
'true',
|
||||
'false',
|
||||
'null',
|
||||
'void',
|
||||
'iterable',
|
||||
'object',
|
||||
'mixed',
|
||||
'never',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
public const FIELD_FORBIDDEN_NAME_LIST = [
|
||||
Attribute::ID,
|
||||
Attribute::DELETED,
|
||||
'deleteId',
|
||||
'skipDuplicateCheck',
|
||||
'null',
|
||||
'false',
|
||||
'true',
|
||||
Field::VERSION_NUMBER,
|
||||
Field::IS_STARRED,
|
||||
Field::IS_FOLLOWED,
|
||||
Field::FOLLOWERS,
|
||||
Field::TEAMS,
|
||||
Field::ASSIGNED_USER,
|
||||
Field::ASSIGNED_USERS,
|
||||
Field::COLLABORATORS,
|
||||
Field::STREAM_UPDATED_AT,
|
||||
Field::CREATED_BY,
|
||||
Field::CREATED_AT,
|
||||
Field::MODIFIED_BY,
|
||||
Field::MODIFIED_AT,
|
||||
|
||||
'emailAddressList',
|
||||
'userEmailAddressList',
|
||||
'excludeFromReplyEmailAddressList',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
public const LINK_FORBIDDEN_NAME_LIST = [
|
||||
'posts',
|
||||
'stream',
|
||||
'streamAttachments',
|
||||
'subscription',
|
||||
'starSubscription',
|
||||
'action',
|
||||
'null',
|
||||
'false',
|
||||
'true',
|
||||
'layout',
|
||||
'system',
|
||||
Field::FOLLOWERS,
|
||||
Field::TEAMS,
|
||||
Field::ASSIGNED_USER,
|
||||
Field::ASSIGNED_USERS,
|
||||
Field::COLLABORATORS,
|
||||
Field::CREATED_BY,
|
||||
Field::MODIFIED_BY,
|
||||
];
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
public const ENTITY_TYPE_FORBIDDEN_NAME_LIST = [
|
||||
'Common',
|
||||
'PortalUser',
|
||||
'ApiUser',
|
||||
'Timeline',
|
||||
'About',
|
||||
'Admin',
|
||||
'Null',
|
||||
'False',
|
||||
'True',
|
||||
'Base',
|
||||
'Layout',
|
||||
'Home',
|
||||
];
|
||||
|
||||
public function __construct(
|
||||
private Metadata $metadata,
|
||||
private ServiceFactory $serviceFactory,
|
||||
private EntityManager $entityManager,
|
||||
private Route $routeUtil,
|
||||
private Config $config
|
||||
) {}
|
||||
|
||||
public function nameIsBad(string $name): bool
|
||||
{
|
||||
if (!$name) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (preg_match('/[^a-zA-Z\d]/', $name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (preg_match('/[^A-Z]/', $name[0])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function nameIsTooShort(string $name): bool
|
||||
{
|
||||
return strlen($name) < NameUtil::MIN_ENTITY_NAME_LENGTH;
|
||||
}
|
||||
|
||||
public function nameIsTooLong(string $name): bool
|
||||
{
|
||||
return strlen(Util::camelCaseToUnderscore($name)) > NameUtil::MAX_ENTITY_NAME_LENGTH;
|
||||
}
|
||||
|
||||
public function nameIsNotAllowed(string $name): bool
|
||||
{
|
||||
if (in_array($name, self::ENTITY_TYPE_FORBIDDEN_NAME_LIST)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (in_array(strtolower($name), NameUtil::RESERVED_WORLD_LIST)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($name !== Util::normalizeScopeName($name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function nameIsUsed(string $name): bool
|
||||
{
|
||||
if ($this->metadata->get(['scopes', $name])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->metadata->get(['entityDefs', $name])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->metadata->get(['clientDefs', $name])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->relationshipExists($name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->controllerExists($name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->serviceFactory->checkExists($name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($this->routeExists($name)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function routeExists(string $name): bool
|
||||
{
|
||||
foreach ($this->routeUtil->getFullList() as $route) {
|
||||
if (
|
||||
$route->getRoute() === '/' . $name ||
|
||||
str_starts_with($route->getRoute(), '/' . $name . '/')
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function controllerExists(string $name): bool
|
||||
{
|
||||
$controllerClassName = 'Espo\\Custom\\Controllers\\' . Util::normalizeClassName($name);
|
||||
|
||||
if (class_exists($controllerClassName)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
foreach ($this->metadata->getModuleList() as $moduleName) {
|
||||
$controllerClassName =
|
||||
'Espo\\Modules\\' . $moduleName . '\\Controllers\\' . Util::normalizeClassName($name);
|
||||
|
||||
if (class_exists($controllerClassName)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
$controllerClassName = 'Espo\\Controllers\\' . Util::normalizeClassName($name);
|
||||
|
||||
if (class_exists($controllerClassName)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function relationshipExists(string $name): bool
|
||||
{
|
||||
/** @var string[] $scopeList */
|
||||
$scopeList = array_keys($this->metadata->get(['scopes'], []));
|
||||
|
||||
foreach ($scopeList as $entityType) {
|
||||
$relationsDefs = $this->entityManager
|
||||
->getMetadata()
|
||||
->get($entityType, EntityParam::RELATIONS);
|
||||
|
||||
if (empty($relationsDefs)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($relationsDefs as $item) {
|
||||
if (empty($item['type']) || empty($item['relationName'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (
|
||||
$item['type'] === Entity::MANY_MANY &&
|
||||
ucfirst($item['relationName']) === ucfirst($name)
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
public function addCustomPrefix(string $name, bool $ucFirst = false): string
|
||||
{
|
||||
if ($this->config->get('customPrefixDisabled')) {
|
||||
return $name;
|
||||
}
|
||||
|
||||
$prefix = $ucFirst ? 'C' : 'c';
|
||||
|
||||
return $prefix . ucfirst($name);
|
||||
}
|
||||
|
||||
public function fieldExists(string $entityType, string $name): bool
|
||||
{
|
||||
return (bool) $this->metadata->get("entityDefs.$entityType.fields.$name");
|
||||
}
|
||||
|
||||
public function linkExists(string $entityType, string $name): bool
|
||||
{
|
||||
return (bool) $this->metadata->get("entityDefs.$entityType.links.$name");
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 9.2.4
|
||||
*/
|
||||
public function linkNameIsBad(string $name): bool
|
||||
{
|
||||
if ($name === '') {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (preg_match('/[^a-z]/', $name[0])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $this->nameIsBad(ucfirst($name));
|
||||
}
|
||||
}
|
||||
57
application/Espo/Tools/EntityManager/Params.php
Normal file
57
application/Espo/Tools/EntityManager/Params.php
Normal file
@@ -0,0 +1,57 @@
|
||||
<?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\EntityManager;
|
||||
|
||||
class Params
|
||||
{
|
||||
/**
|
||||
* @param array<string, mixed> $params
|
||||
*/
|
||||
public function __construct(
|
||||
private string $name,
|
||||
private ?string $type,
|
||||
private array $params
|
||||
) {}
|
||||
|
||||
public function get(string $name): mixed
|
||||
{
|
||||
return $this->params[$name] ?? null;
|
||||
}
|
||||
|
||||
public function getType(): ?string
|
||||
{
|
||||
return $this->type;
|
||||
}
|
||||
|
||||
public function getName(): string
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
}
|
||||
43
application/Espo/Tools/EntityManager/Rename/ClassType.php
Normal file
43
application/Espo/Tools/EntityManager/Rename/ClassType.php
Normal file
@@ -0,0 +1,43 @@
|
||||
<?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\EntityManager\Rename;
|
||||
|
||||
class ClassType
|
||||
{
|
||||
public const ENTITY = 'Entities';
|
||||
|
||||
public const CONTROLLER = 'Controllers';
|
||||
|
||||
public const REPOSITORY = 'Repositories';
|
||||
|
||||
public const SELECT_MANAGER = 'SelectManagers';
|
||||
|
||||
public const SERVICE = 'Services';
|
||||
}
|
||||
53
application/Espo/Tools/EntityManager/Rename/FailReason.php
Normal file
53
application/Espo/Tools/EntityManager/Rename/FailReason.php
Normal file
@@ -0,0 +1,53 @@
|
||||
<?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\EntityManager\Rename;
|
||||
|
||||
class FailReason
|
||||
{
|
||||
public const ENV_NOT_SUPPORTED = 'envNotSupported';
|
||||
|
||||
public const TABLE_EXISTS = 'tableExists';
|
||||
|
||||
public const DOES_NOT_EXIST = 'doesNotExist';
|
||||
|
||||
public const NOT_CUSTOM = 'notCustom';
|
||||
|
||||
public const NAME_USED = 'nameUsed';
|
||||
|
||||
public const NAME_NOT_ALLOWED = 'nameIsNotAllosed';
|
||||
|
||||
public const NAME_BAD = 'nameBad';
|
||||
|
||||
public const NAME_TOO_LONG = 'nameTooLong';
|
||||
|
||||
public const NAME_TOO_SHORT = 'nameTooShort';
|
||||
|
||||
public const ERROR = 'error';
|
||||
}
|
||||
55
application/Espo/Tools/EntityManager/Rename/MetadataType.php
Normal file
55
application/Espo/Tools/EntityManager/Rename/MetadataType.php
Normal file
@@ -0,0 +1,55 @@
|
||||
<?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\EntityManager\Rename;
|
||||
|
||||
class MetadataType
|
||||
{
|
||||
public const ENTITY_DEFS = 'entityDefs';
|
||||
|
||||
public const SCOPES = 'scopes';
|
||||
|
||||
public const ACL_DEFS = 'aclDefs';
|
||||
|
||||
public const ENTITY_ACL = 'entityAcl';
|
||||
|
||||
public const CLIENT_DEFS = 'clientDefs';
|
||||
|
||||
public const SELECT_DEFS = 'selectDefs';
|
||||
|
||||
public const RECORD_DEFS = 'recordDefs';
|
||||
|
||||
public const NOTIFICATION_DEFS = 'notificationDefs';
|
||||
|
||||
public const PDF_DEFS = 'pdfDefs';
|
||||
|
||||
public const FORMULA = 'formula';
|
||||
|
||||
public const LOGIC_DEFS = 'logicDefs';
|
||||
}
|
||||
669
application/Espo/Tools/EntityManager/Rename/Renamer.php
Normal file
669
application/Espo/Tools/EntityManager/Rename/Renamer.php
Normal file
@@ -0,0 +1,669 @@
|
||||
<?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\EntityManager\Rename;
|
||||
|
||||
use Espo\Core\Console\IO;
|
||||
use Espo\Core\ORM\Type\FieldType;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Core\Utils\File\Manager as FileManager;
|
||||
use Espo\Core\Utils\Util;
|
||||
use Espo\Core\DataManager;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Config\ConfigWriter;
|
||||
use Espo\Core\Utils\Language;
|
||||
use Espo\Core\Utils\Log;
|
||||
use Espo\Entities\PortalRole;
|
||||
use Espo\Entities\Role;
|
||||
use Espo\ORM\EntityManager;
|
||||
|
||||
use Espo\Tools\EntityManager\NameUtil;
|
||||
|
||||
use RuntimeException;
|
||||
use Throwable;
|
||||
|
||||
class Renamer
|
||||
{
|
||||
/**
|
||||
* @var array<int,ClassType::*>
|
||||
*/
|
||||
private $classTypeList = [
|
||||
ClassType::ENTITY,
|
||||
ClassType::CONTROLLER,
|
||||
ClassType::REPOSITORY,
|
||||
ClassType::SELECT_MANAGER,
|
||||
ClassType::SERVICE,
|
||||
];
|
||||
|
||||
/**
|
||||
* @var array<int,MetadataType::*>
|
||||
*/
|
||||
private $metadataTypeList = [
|
||||
MetadataType::ACL_DEFS,
|
||||
MetadataType::CLIENT_DEFS,
|
||||
MetadataType::ENTITY_DEFS,
|
||||
MetadataType::ENTITY_ACL,
|
||||
MetadataType::FORMULA,
|
||||
MetadataType::NOTIFICATION_DEFS,
|
||||
MetadataType::PDF_DEFS,
|
||||
MetadataType::RECORD_DEFS,
|
||||
MetadataType::SCOPES,
|
||||
MetadataType::SELECT_DEFS,
|
||||
MetadataType::LOGIC_DEFS,
|
||||
];
|
||||
|
||||
private NameUtil $nameUtil;
|
||||
|
||||
private Metadata $metadata;
|
||||
|
||||
private FileManager $fileManager;
|
||||
|
||||
private EntityManager $entityManager;
|
||||
|
||||
private DataManager $dataManager;
|
||||
|
||||
private Config $config;
|
||||
|
||||
private ConfigWriter $configWriter;
|
||||
|
||||
private Language $language;
|
||||
|
||||
private Log $log;
|
||||
|
||||
public function __construct(
|
||||
NameUtil $nameUtil,
|
||||
Metadata $metadata,
|
||||
FileManager $fileManager,
|
||||
EntityManager $entityManager,
|
||||
DataManager $dataManager,
|
||||
Config $config,
|
||||
ConfigWriter $configWriter,
|
||||
Language $language,
|
||||
Log $log
|
||||
) {
|
||||
$this->nameUtil = $nameUtil;
|
||||
$this->metadata = $metadata;
|
||||
$this->fileManager = $fileManager;
|
||||
$this->entityManager = $entityManager;
|
||||
$this->dataManager = $dataManager;
|
||||
$this->config = $config;
|
||||
$this->configWriter = $configWriter;
|
||||
$this->language = $language;
|
||||
$this->log = $log;
|
||||
}
|
||||
|
||||
public function process(string $entityType, string $newName, IO $io): Result
|
||||
{
|
||||
$failResult = $this->validate($entityType, $newName);
|
||||
|
||||
if ($failResult) {
|
||||
return $failResult;
|
||||
}
|
||||
|
||||
$io->writeLine(' DB table...');
|
||||
$this->renameDbTable($entityType, $newName);
|
||||
|
||||
$io->writeLine(' DB many-to-many tables...');
|
||||
$this->renameDbManyToMany($entityType, $newName);
|
||||
|
||||
$io->writeLine(' metadata relationships...');
|
||||
$this->renameInRelationships($entityType, $newName);
|
||||
|
||||
$io->writeLine(' metadata fields...');
|
||||
$this->renameInFields($entityType, $newName);
|
||||
|
||||
$io->writeLine(' php classes...');
|
||||
foreach ($this->classTypeList as $classType) {
|
||||
$this->renameClass($classType, $entityType, $newName);
|
||||
}
|
||||
|
||||
$io->writeLine(' metadata files...');
|
||||
foreach ($this->metadataTypeList as $metadataType) {
|
||||
$this->renameMetadata($metadataType, $entityType, $newName);
|
||||
}
|
||||
|
||||
$io->writeLine(' layouts...');
|
||||
$this->renameLayouts($entityType, $newName);
|
||||
|
||||
$io->writeLine(' values in DB...');
|
||||
$this->changeValuesInDb($entityType, $newName);
|
||||
|
||||
$io->writeLine(' language...');
|
||||
$this->renameLanguage($entityType, $newName);
|
||||
|
||||
$io->writeLine(' config parameters...');
|
||||
$this->renameInConfig($entityType, $newName);
|
||||
|
||||
$io->writeLine(' rebuild...');
|
||||
$this->dataManager->rebuild();
|
||||
|
||||
return Result::createSuccess();
|
||||
}
|
||||
|
||||
private function validate(string $entityType, string $newName): ?Result
|
||||
{
|
||||
if (!$this->metadata->get(['scopes', $entityType, 'entity'])) {
|
||||
return Result::createFail(FailReason::DOES_NOT_EXIST);
|
||||
}
|
||||
|
||||
if (!$this->metadata->get(['scopes', $entityType, 'isCustom'])) {
|
||||
return Result::createFail(FailReason::NOT_CUSTOM);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsBad($newName)) {
|
||||
return Result::createFail(FailReason::NAME_BAD);
|
||||
}
|
||||
|
||||
/** @var non-empty-string $newName */
|
||||
|
||||
if ($this->nameUtil->nameIsTooLong($newName)) {
|
||||
return Result::createFail(FailReason::NAME_TOO_LONG);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsTooShort($newName)) {
|
||||
return Result::createFail(FailReason::NAME_TOO_SHORT);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsNotAllowed($newName)) {
|
||||
return Result::createFail(FailReason::NAME_NOT_ALLOWED);
|
||||
}
|
||||
|
||||
if ($this->nameUtil->nameIsUsed($newName)) {
|
||||
return Result::createFail(FailReason::NAME_USED);
|
||||
}
|
||||
|
||||
if (!$this->fileManager->isFile($this->getClassFilePath(ClassType::CONTROLLER, $entityType))) {
|
||||
return Result::createFail(FailReason::NOT_CUSTOM);
|
||||
}
|
||||
|
||||
if (!$this->fileManager->isFile($this->getMetadataFilePath(MetadataType::ENTITY_DEFS, $entityType))) {
|
||||
return Result::createFail(FailReason::NOT_CUSTOM);
|
||||
}
|
||||
|
||||
if (!$this->fileManager->isFile($this->getMetadataFilePath(MetadataType::SCOPES, $entityType))) {
|
||||
return Result::createFail(FailReason::NOT_CUSTOM);
|
||||
}
|
||||
|
||||
if ($this->tableExists($newName)) {
|
||||
return Result::createFail(FailReason::TABLE_EXISTS);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private function renameDbManyToMany(string $entityType, string $newName): void
|
||||
{
|
||||
$relationList = $this->entityManager
|
||||
->getDefs()
|
||||
->getEntity($entityType)
|
||||
->getRelationList();
|
||||
|
||||
foreach ($relationList as $relation) {
|
||||
if (!$relation->isManyToMany()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (lcfirst($relation->getRelationshipName()) === 'entityTeam') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->renameDbRelationshipTableColumn(
|
||||
$relation->getRelationshipName(),
|
||||
$entityType . 'Id',
|
||||
$newName . 'Id'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ClassType::* $classType
|
||||
*/
|
||||
private function renameClass(string $classType, string $name, string $newName): void
|
||||
{
|
||||
$path = $this->getClassFilePath($classType, $name);
|
||||
$newPath = $this->getClassFilePath($classType, $newName);
|
||||
|
||||
if (!$this->fileManager->isFile($path)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$contents = $this->fileManager->getContents($path);
|
||||
|
||||
$replaceFrom = [
|
||||
"class {$name}",
|
||||
"'{$name}'",
|
||||
];
|
||||
|
||||
$replaceTo = [
|
||||
"class {$newName}",
|
||||
"'{$newName}'",
|
||||
];
|
||||
|
||||
$newContents = str_replace($replaceFrom, $replaceTo, $contents);
|
||||
|
||||
$this->fileManager->putContents($newPath, $newContents);
|
||||
$this->fileManager->removeFile($path);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param MetadataType::* $metadataType
|
||||
*/
|
||||
private function renameMetadata(string $metadataType, string $name, string $newName): void
|
||||
{
|
||||
$path = $this->getMetadataFilePath($metadataType, $name);
|
||||
$newPath = $this->getMetadataFilePath($metadataType, $newName);
|
||||
|
||||
if (!$this->fileManager->isFile($path)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$contents = $this->fileManager->getContents($path);
|
||||
|
||||
$replaceFrom = [];
|
||||
$replaceTo = [];
|
||||
|
||||
$newContents = str_replace($replaceFrom, $replaceTo, $contents);
|
||||
|
||||
$this->fileManager->putContents($newPath, $newContents);
|
||||
$this->fileManager->removeFile($path);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param ClassType::* $classType
|
||||
*/
|
||||
private function getClassFilePath(string $classType, string $name): string
|
||||
{
|
||||
return "custom/Espo/Custom/{$classType}/{$name}.php";
|
||||
}
|
||||
|
||||
/**
|
||||
* @param MetadataType::* $metadataType
|
||||
*/
|
||||
private function getMetadataFilePath(string $metadataType, string $name): string
|
||||
{
|
||||
return "custom/Espo/Custom/Resources/metadata/{$metadataType}/{$name}.json";
|
||||
}
|
||||
|
||||
private function renameLayouts(string $name, string $newName): void
|
||||
{
|
||||
$fromPath = "custom/Espo/Custom/Resources/layouts/{$name}";
|
||||
$toPath = "custom/Espo/Custom/Resources/layouts/{$newName}";
|
||||
|
||||
rename($fromPath, $toPath);
|
||||
}
|
||||
|
||||
private function tableExists(string $newName): bool
|
||||
{
|
||||
$table = Util::camelCaseToUnderscore($newName);
|
||||
|
||||
if (self::dbNameSanitize($table) !== $table) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
$sql = "SHOW TABLES LIKE '{$table}'";
|
||||
|
||||
$sth = $this->entityManager->getSqlExecutor()->execute($sql);
|
||||
|
||||
if ($sth->fetch()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private function renameDbTable(string $name, string $newName): void
|
||||
{
|
||||
$table = Util::camelCaseToUnderscore($name);
|
||||
$newTable = Util::camelCaseToUnderscore($newName);
|
||||
|
||||
if (self::dbNameSanitize($table) !== $table) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
if (self::dbNameSanitize($newTable) !== $newTable) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
$sql = "RENAME TABLE `{$table}` TO `{$newTable}`";
|
||||
|
||||
$this->entityManager->getSqlExecutor()->execute($sql);
|
||||
}
|
||||
|
||||
private function renameDbRelationshipTableColumn(string $entityType, string $name, string $newName): void
|
||||
{
|
||||
$table = Util::camelCaseToUnderscore($entityType);
|
||||
$column = Util::camelCaseToUnderscore($name);
|
||||
$newColumn = Util::camelCaseToUnderscore($newName);
|
||||
|
||||
if (self::dbNameSanitize($table) !== $table) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
if (self::dbNameSanitize($column) !== $column) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
if (self::dbNameSanitize($newColumn) !== $newColumn) {
|
||||
throw new RuntimeException();
|
||||
}
|
||||
|
||||
$sql = "ALTER TABLE `{$table}` CHANGE `{$column}` `{$newColumn}` VARCHAR(24)";
|
||||
|
||||
try {
|
||||
$this->entityManager->getSqlExecutor()->execute($sql);
|
||||
} catch (Throwable $e) {
|
||||
$msg = $e->getMessage();
|
||||
|
||||
$this->log->error("Entity-rename: Rename relationship column failed: {$msg}.");
|
||||
}
|
||||
}
|
||||
|
||||
private static function dbNameSanitize(string $name): string
|
||||
{
|
||||
return preg_replace('/[^A-Za-z0-9_]+/', '', $name) ?? '';
|
||||
}
|
||||
|
||||
private function renameLanguage(string $entityType, string $newName): void
|
||||
{
|
||||
$label = $this->language->translateLabel($entityType, 'scopeNames');
|
||||
$labelPlural = $this->language->translateLabel($entityType, 'scopeNamesPlural');
|
||||
|
||||
$this->language->delete('Global', 'scopeNames', $entityType);
|
||||
$this->language->delete('Global', 'scopeNamesPlural', $entityType);
|
||||
$this->language->set('Global', 'scopeNames', $newName, $label);
|
||||
$this->language->set('Global', 'scopeNamesPlural', $newName, $labelPlural);
|
||||
|
||||
$this->language->save();
|
||||
|
||||
$langList = $this->fileManager->getDirList('custom/Espo/Custom/Resources/i18n');
|
||||
|
||||
foreach ($langList as $lang) {
|
||||
$fromPath = "custom/Espo/Custom/Resources/i18n/{$lang}/{$entityType}.json";
|
||||
$toPath = "custom/Espo/Custom/Resources/i18n/{$lang}/{$newName}.json";
|
||||
|
||||
if (!$this->fileManager->isFile($fromPath)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$contents = $this->fileManager->getContents($fromPath);
|
||||
|
||||
$this->fileManager->putContents($toPath, $contents);
|
||||
$this->fileManager->removeFile($fromPath);
|
||||
}
|
||||
}
|
||||
|
||||
private function renameInConfig(string $entityType, string $newName): void
|
||||
{
|
||||
/** @var string[] $entityTypeListParamList */
|
||||
$entityTypeListParamList = $this->metadata->get(['app', 'config', 'entityTypeListParamList']) ?? [];
|
||||
|
||||
foreach ($entityTypeListParamList as $param) {
|
||||
/** @var ?string[] $list */
|
||||
$list = $this->config->get($param);
|
||||
|
||||
if ($list === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$index = array_search($entityType, $list, true);
|
||||
|
||||
if ($index === false) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$list[$index] = $newName;
|
||||
|
||||
$this->configWriter->set($param, $list);
|
||||
}
|
||||
|
||||
$this->configWriter->save();
|
||||
}
|
||||
|
||||
private function renameInRelationships(string $entityType, string $newName): void
|
||||
{
|
||||
/** @var string[] $entityTypeList */
|
||||
$entityTypeList = array_keys($this->metadata->get(['entityDefs']) ?? []);
|
||||
|
||||
foreach ($entityTypeList as $itemEntityType) {
|
||||
$this->renameInRelationshipsEntity($itemEntityType, $entityType, $newName);
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
|
||||
private function renameInRelationshipsEntity(string $entityType, string $fromEntityType, string $toEntityType): void
|
||||
{
|
||||
/** @var array<string, array<string, mixed>> $linkDefs */
|
||||
$linkDefs = $this->metadata->get(['entityDefs', $entityType, 'links']) ?? [];
|
||||
|
||||
foreach ($linkDefs as $link => $defs) {
|
||||
$itemEntityType = $defs['entity'] ?? null;
|
||||
|
||||
if ($itemEntityType !== $fromEntityType) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, [
|
||||
'links' => [
|
||||
$link => [
|
||||
'entity' => $toEntityType,
|
||||
]
|
||||
]
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
private function renameInFields(string $entityType, string $newName): void
|
||||
{
|
||||
$entityList = $this->entityManager
|
||||
->getDefs()
|
||||
->getEntityList();
|
||||
|
||||
foreach ($entityList as $entityDefs) {
|
||||
foreach ($entityDefs->getFieldNameList() as $field) {
|
||||
$this->renameInFieldsField($entityDefs->getName(), $field, $entityType, $newName);
|
||||
}
|
||||
}
|
||||
|
||||
$this->metadata->save();
|
||||
}
|
||||
|
||||
private function renameInFieldsField(string $entityType, string $field, string $from, string $to): void
|
||||
{
|
||||
$defs = $this->entityManager
|
||||
->getDefs()
|
||||
->getEntity($entityType)
|
||||
->getField($field);
|
||||
|
||||
if ($defs->getType() === FieldType::LINK_PARENT) {
|
||||
$this->renameInLinkParentField($entityType, $defs->getName(), $from, $to);
|
||||
}
|
||||
}
|
||||
|
||||
private function renameInLinkParentField(string $entityType, string $field, string $from, string $to): void
|
||||
{
|
||||
/** @var string[] $list */
|
||||
$list = $this->metadata->get(['entityDefs', $entityType, 'fields', $field, 'entityList']) ?? [];
|
||||
|
||||
$index = array_search($from, $list, true);
|
||||
|
||||
if ($index === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
$list[$index] = $to;
|
||||
|
||||
$this->metadata->set('entityDefs', $entityType, [
|
||||
'fields' => [
|
||||
$field => ['entityList' => $list]
|
||||
]
|
||||
]);
|
||||
}
|
||||
|
||||
private function changeValuesInDb(string $from, string $to): void
|
||||
{
|
||||
$this->changeValuesInDbFields($from, $to);
|
||||
$this->changeValuesInDbRoles($from, $to);
|
||||
|
||||
$query1 = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in('EntityTeam')
|
||||
->set(['entityType' => $to])
|
||||
->where(['entityType' => $from])
|
||||
->build();
|
||||
|
||||
$this->entityManager->getQueryExecutor()->execute($query1);
|
||||
|
||||
$query2 = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in('EntityEmailAddress')
|
||||
->set(['entityType' => $to])
|
||||
->where(['entityType' => $from])
|
||||
->build();
|
||||
|
||||
$this->entityManager->getQueryExecutor()->execute($query2);
|
||||
|
||||
$query3 = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in('EntityPhoneNumber')
|
||||
->set(['entityType' => $to])
|
||||
->where(['entityType' => $from])
|
||||
->build();
|
||||
|
||||
$this->entityManager->getQueryExecutor()->execute($query3);
|
||||
}
|
||||
|
||||
private function changeValuesInDbFields(string $from, string $to): void
|
||||
{
|
||||
$entityList = $this->entityManager
|
||||
->getDefs()
|
||||
->getEntityList();
|
||||
|
||||
foreach ($entityList as $entityDefs) {
|
||||
foreach ($entityDefs->getFieldNameList() as $field) {
|
||||
$this->changeValuesInDbFieldsField($entityDefs->getName(), $field, $from, $to);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private function changeValuesInDbFieldsField(string $entityType, string $field, string $from, string $to): void
|
||||
{
|
||||
$defs = $this->entityManager
|
||||
->getDefs()
|
||||
->getEntity($entityType)
|
||||
->getField($field);
|
||||
|
||||
if ($defs->getType() === FieldType::LINK_PARENT) {
|
||||
$this->changeValuesInDbFieldsFieldLinkParent($entityType, $defs->getName(), $from, $to);
|
||||
}
|
||||
}
|
||||
|
||||
private function changeValuesInDbFieldsFieldLinkParent(
|
||||
string $entityType,
|
||||
string $field,
|
||||
string $from,
|
||||
string $to
|
||||
): void {
|
||||
|
||||
$typeAttribute = $field . 'Type';
|
||||
|
||||
$query = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in($entityType)
|
||||
->set([$typeAttribute => $to])
|
||||
->where([$typeAttribute => $from])
|
||||
->build();
|
||||
|
||||
try {
|
||||
$this->entityManager->getQueryExecutor()->execute($query);
|
||||
} catch (Throwable $e) {
|
||||
$msg = $e->getMessage();
|
||||
|
||||
$this->log->error("Entity-rename: Update values in link-parent field {$entityType}.{$field}: {$msg}.");
|
||||
}
|
||||
}
|
||||
|
||||
private function changeValuesInDbRoles(string $from, string $to): void
|
||||
{
|
||||
$roleList = $this->entityManager
|
||||
->getRDBRepositoryByClass(Role::class)
|
||||
->find();
|
||||
|
||||
foreach ($roleList as $role) {
|
||||
$data = $role->getRawData();
|
||||
$fieldData = $role->getRawFieldData();
|
||||
|
||||
if (isset($data->$from)) {
|
||||
$data->$to = $data->$from;
|
||||
unset($data->$from);
|
||||
|
||||
$role->setRawData($data);
|
||||
}
|
||||
|
||||
if (isset($fieldData->$from)) {
|
||||
$fieldData->$to = $fieldData->$from;
|
||||
unset($fieldData->$from);
|
||||
|
||||
$role->setRawFieldData($fieldData);
|
||||
}
|
||||
|
||||
$this->entityManager->saveEntity($role);
|
||||
}
|
||||
|
||||
/** @var iterable<PortalRole> $portalRoleList */
|
||||
$portalRoleList = $this->entityManager
|
||||
->getRDBRepositoryByClass(PortalRole::class)
|
||||
->find();
|
||||
|
||||
foreach ($portalRoleList as $role) {
|
||||
$data = $role->getRawData();
|
||||
$fieldData = $role->getRawFieldData();
|
||||
|
||||
if (isset($data->$from)) {
|
||||
$data->$to = $data->$from;
|
||||
unset($data->$from);
|
||||
|
||||
$role->setRawData($data);
|
||||
}
|
||||
|
||||
if (isset($fieldData->$from)) {
|
||||
$fieldData->$to = $fieldData->$from;
|
||||
unset($fieldData->$from);
|
||||
|
||||
$role->setRawFieldData($fieldData);
|
||||
}
|
||||
|
||||
$this->entityManager->saveEntity($role);
|
||||
}
|
||||
}
|
||||
}
|
||||
71
application/Espo/Tools/EntityManager/Rename/Result.php
Normal file
71
application/Espo/Tools/EntityManager/Rename/Result.php
Normal file
@@ -0,0 +1,71 @@
|
||||
<?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\EntityManager\Rename;
|
||||
|
||||
class Result
|
||||
{
|
||||
private bool $isFail = false;
|
||||
|
||||
/**
|
||||
* @var FailReason::*|null
|
||||
*/
|
||||
private ?string $failReason = null;
|
||||
|
||||
public static function createSuccess(): self
|
||||
{
|
||||
return new self();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param FailReason::* $reason
|
||||
*/
|
||||
public static function createFail(string $reason): self
|
||||
{
|
||||
$obj = new self();
|
||||
|
||||
$obj->isFail = true;
|
||||
$obj->failReason = $reason;
|
||||
|
||||
return $obj;
|
||||
}
|
||||
|
||||
public function isFail(): bool
|
||||
{
|
||||
return $this->isFail;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return FailReason::*|null
|
||||
*/
|
||||
public function getFailReason(): ?string
|
||||
{
|
||||
return $this->failReason;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user