some big beautfiul update
This commit is contained in:
@@ -0,0 +1,862 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2026 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;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2026 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\LeadCapture;
|
||||
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Exceptions\ForbiddenSilent;
|
||||
use Espo\Core\Exceptions\NotFound;
|
||||
use Espo\Core\Record\ServiceContainer;
|
||||
use Espo\Core\Utils\Util;
|
||||
use Espo\Entities\InboundEmail;
|
||||
use Espo\Entities\LeadCapture as LeadCaptureEntity;
|
||||
use Espo\Entities\User;
|
||||
use Espo\ORM\EntityManager;
|
||||
use stdClass;
|
||||
|
||||
class Service
|
||||
{
|
||||
public function __construct(
|
||||
private EntityManager $entityManager,
|
||||
private ServiceContainer $recordServiceContainer,
|
||||
private User $user
|
||||
) {}
|
||||
|
||||
public function isApiKeyValid(string $apiKey): bool
|
||||
{
|
||||
$leadCapture = $this->entityManager
|
||||
->getRDBRepositoryByClass(LeadCaptureEntity::class)
|
||||
->where([
|
||||
'apiKey' => $apiKey,
|
||||
'isActive' => true,
|
||||
])
|
||||
->findOne();
|
||||
|
||||
if ($leadCapture) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws ForbiddenSilent
|
||||
* @throws NotFound
|
||||
* @throws Forbidden
|
||||
*/
|
||||
public function generateNewApiKeyForEntity(string $id): LeadCaptureEntity
|
||||
{
|
||||
$service = $this->recordServiceContainer->getByClass(LeadCaptureEntity::class);
|
||||
|
||||
$entity = $service->getEntity($id);
|
||||
|
||||
if (!$entity) {
|
||||
throw new NotFound();
|
||||
}
|
||||
|
||||
$entity->setApiKey($this->generateApiKey());
|
||||
|
||||
$this->entityManager->saveEntity($entity);
|
||||
|
||||
$service->prepareEntityForOutput($entity);
|
||||
|
||||
return $entity;
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws ForbiddenSilent
|
||||
* @throws NotFound
|
||||
* @throws Forbidden
|
||||
*/
|
||||
public function generateNewFormIdForEntity(string $id): LeadCaptureEntity
|
||||
{
|
||||
$service = $this->recordServiceContainer->getByClass(LeadCaptureEntity::class);
|
||||
|
||||
$entity = $service->getEntity($id);
|
||||
|
||||
if (!$entity) {
|
||||
throw new NotFound();
|
||||
}
|
||||
|
||||
$entity->setFormId($this->generateFormId());
|
||||
|
||||
$this->entityManager->saveEntity($entity);
|
||||
|
||||
$service->prepareEntityForOutput($entity);
|
||||
|
||||
return $entity;
|
||||
}
|
||||
|
||||
public function generateApiKey(): string
|
||||
{
|
||||
return Util::generateApiKey();
|
||||
}
|
||||
|
||||
public function generateFormId(): string
|
||||
{
|
||||
return Util::generateId();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return stdClass[]
|
||||
* @throws Forbidden
|
||||
*/
|
||||
public function getSmtpAccountDataList(): array
|
||||
{
|
||||
if (!$this->user->isAdmin()) {
|
||||
throw new Forbidden();
|
||||
}
|
||||
|
||||
$dataList = [];
|
||||
|
||||
$inboundEmailList = $this->entityManager
|
||||
->getRDBRepositoryByClass(InboundEmail::class)
|
||||
->where([
|
||||
'useSmtp' => true,
|
||||
'status' => InboundEmail::STATUS_ACTIVE,
|
||||
['emailAddress!=' => ''],
|
||||
['emailAddress!=' => null],
|
||||
])
|
||||
->find();
|
||||
|
||||
foreach ($inboundEmailList as $inboundEmail) {
|
||||
$item = (object) [];
|
||||
|
||||
$key = 'inboundEmail:' . $inboundEmail->getId();
|
||||
|
||||
$item->key = $key;
|
||||
$item->emailAddress = $inboundEmail->getEmailAddress();
|
||||
$item->fromName = $inboundEmail->getFromName();
|
||||
|
||||
$dataList[] = $item;
|
||||
}
|
||||
|
||||
return $dataList;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,483 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2026 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\Notification;
|
||||
|
||||
use Espo\Core\Acl;
|
||||
use Espo\Core\Exceptions\BadRequest;
|
||||
use Espo\Core\Exceptions\Error;
|
||||
use Espo\Core\Exceptions\Forbidden;
|
||||
use Espo\Core\Name\Field;
|
||||
use Espo\Core\Record\Collection as RecordCollection;
|
||||
use Espo\Core\Select\SearchParams;
|
||||
use Espo\Core\Select\SelectBuilderFactory;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Core\Utils\Metadata;
|
||||
use Espo\Entities\Note;
|
||||
use Espo\Entities\Notification;
|
||||
use Espo\Entities\User;
|
||||
use Espo\ORM\Collection;
|
||||
use Espo\ORM\EntityCollection;
|
||||
use Espo\ORM\EntityManager;
|
||||
use Espo\ORM\Name\Attribute;
|
||||
use Espo\ORM\Query\Part\Condition as Cond;
|
||||
use Espo\ORM\Query\Part\Expression as Expr;
|
||||
use Espo\ORM\Query\Part\WhereItem;
|
||||
use Espo\ORM\Query\SelectBuilder;
|
||||
use Espo\Tools\Stream\NoteAccessControl;
|
||||
|
||||
class RecordService
|
||||
{
|
||||
public function __construct(
|
||||
private EntityManager $entityManager,
|
||||
private Acl $acl,
|
||||
private Metadata $metadata,
|
||||
private NoteAccessControl $noteAccessControl,
|
||||
private SelectBuilderFactory $selectBuilderFactory,
|
||||
private Config $config,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Get notifications for a user.
|
||||
*
|
||||
* @return RecordCollection<Notification>
|
||||
* @throws Error
|
||||
* @throws BadRequest
|
||||
* @throws Forbidden
|
||||
*/
|
||||
public function get(User $user, SearchParams $searchParams): RecordCollection
|
||||
{
|
||||
$queryBuilder = $this->selectBuilderFactory
|
||||
->create()
|
||||
->from(Notification::ENTITY_TYPE)
|
||||
->withSearchParams($searchParams)
|
||||
->buildQueryBuilder()
|
||||
->where([Notification::ATTR_USER_ID => $user->getId()])
|
||||
->order(Notification::ATTR_NUMBER, SearchParams::ORDER_DESC);
|
||||
|
||||
if ($this->isGroupingEnabled()) {
|
||||
$queryBuilder->where($this->getActionIdWhere($user->getId()));
|
||||
}
|
||||
|
||||
$offset = $searchParams->getOffset();
|
||||
$limit = $searchParams->getMaxSize();
|
||||
|
||||
if ($limit) {
|
||||
$queryBuilder->limit($offset, $limit + 1);
|
||||
}
|
||||
|
||||
$ignoreScopeList = $this->getIgnoreScopeList();
|
||||
|
||||
if ($ignoreScopeList !== []) {
|
||||
$queryBuilder->where([
|
||||
'OR' => [
|
||||
'relatedParentType' => null,
|
||||
'relatedParentType!=' => $ignoreScopeList,
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
$query = $queryBuilder->build();
|
||||
|
||||
$collection = $this->entityManager
|
||||
->getRDBRepositoryByClass(Notification::class)
|
||||
->clone($query)
|
||||
->find();
|
||||
|
||||
if (!$collection instanceof EntityCollection) {
|
||||
throw new Error("Collection is not instance of EntityCollection.");
|
||||
}
|
||||
|
||||
$collection = $this->prepareCollection($collection, $user);
|
||||
|
||||
$groupedCountMap = $this->getGroupedCountMap($collection, $user->getId());
|
||||
|
||||
$ids = [];
|
||||
$actionIds = [];
|
||||
|
||||
foreach ($collection as $i => $entity) {
|
||||
if ($i === $limit) {
|
||||
break;
|
||||
}
|
||||
|
||||
$ids[] = $entity->getId();
|
||||
|
||||
$groupedCount = null;
|
||||
|
||||
if ($entity->getActionId() && $this->isGroupingEnabled()) {
|
||||
$actionIds[] = $entity->getActionId();
|
||||
|
||||
$groupedCount = $groupedCountMap[$entity->getActionId()] ?? 0;
|
||||
}
|
||||
|
||||
$entity->setGroupedCount($groupedCount);
|
||||
}
|
||||
|
||||
$collection = new EntityCollection([...$collection], Notification::ENTITY_TYPE);
|
||||
|
||||
$this->markAsRead($user, $ids, $actionIds);
|
||||
|
||||
return RecordCollection::createNoCount($collection, $limit);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Collection<Notification> $collection
|
||||
* @return EntityCollection<Notification>
|
||||
*/
|
||||
public function prepareCollection(Collection $collection, User $user): EntityCollection
|
||||
{
|
||||
if (!$collection instanceof EntityCollection) {
|
||||
$collection = new EntityCollection([...$collection], Notification::ENTITY_TYPE);
|
||||
}
|
||||
|
||||
$limit = count($collection);
|
||||
|
||||
foreach ($collection as $i => $entity) {
|
||||
if ($i === $limit) {
|
||||
break;
|
||||
}
|
||||
|
||||
$this->prepareListItem(
|
||||
entity: $entity,
|
||||
index: $i,
|
||||
collection: $collection,
|
||||
count: $limit,
|
||||
user: $user,
|
||||
);
|
||||
}
|
||||
|
||||
/** @var EntityCollection<Notification> */
|
||||
return new EntityCollection([...$collection], Notification::ENTITY_TYPE);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $ids
|
||||
* @param string[] $actionIds
|
||||
*/
|
||||
private function markAsRead(User $user, array $ids, array $actionIds): void
|
||||
{
|
||||
if ($ids === [] && $actionIds === []) {
|
||||
return;
|
||||
}
|
||||
|
||||
$query = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in(Notification::ENTITY_TYPE)
|
||||
->set([Notification::ATTR_READ => true])
|
||||
->where([Notification::ATTR_USER_ID => $user->getId()])
|
||||
->where(
|
||||
Cond::or(
|
||||
Cond::in(Expr::column(Attribute::ID), $ids),
|
||||
Cond::in(Expr::column(Notification::ATTR_ACTION_ID), $actionIds),
|
||||
)
|
||||
)
|
||||
->build();
|
||||
|
||||
$this->entityManager->getQueryExecutor()->execute($query);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param EntityCollection<Notification> $collection
|
||||
*/
|
||||
private function prepareListItem(
|
||||
Notification $entity,
|
||||
int $index,
|
||||
EntityCollection $collection,
|
||||
?int &$count,
|
||||
User $user
|
||||
): void {
|
||||
|
||||
$this->prepareSetFields($entity);
|
||||
|
||||
$noteId = $this->getNoteId($entity);
|
||||
|
||||
if (!$noteId) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
!in_array($entity->getType(), [
|
||||
Notification::TYPE_NOTE,
|
||||
Notification::TYPE_MENTION_IN_POST,
|
||||
Notification::TYPE_USER_REACTION,
|
||||
])
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$note = $this->entityManager->getRDBRepositoryByClass(Note::class)->getById($noteId);
|
||||
|
||||
if (!$note) {
|
||||
unset($collection[$index]);
|
||||
|
||||
if ($count !== null) {
|
||||
$count--;
|
||||
}
|
||||
|
||||
$this->entityManager->removeEntity($entity);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->noteAccessControl->apply($note, $user);
|
||||
$this->loadNoteFields($note, $entity);
|
||||
|
||||
$entity->set('noteData', $note->getValueMap());
|
||||
}
|
||||
|
||||
public function getNotReadCount(string $userId): int
|
||||
{
|
||||
$whereClause = [
|
||||
Notification::ATTR_USER_ID => $userId,
|
||||
Notification::ATTR_READ => false,
|
||||
];
|
||||
|
||||
$ignoreScopeList = $this->getIgnoreScopeList();
|
||||
|
||||
if (count($ignoreScopeList)) {
|
||||
$whereClause[] = [
|
||||
'OR' => [
|
||||
'relatedParentType' => null,
|
||||
'relatedParentType!=' => $ignoreScopeList,
|
||||
]
|
||||
];
|
||||
}
|
||||
|
||||
$builder = $this->entityManager
|
||||
->getRDBRepositoryByClass(Notification::class)
|
||||
->where($whereClause);
|
||||
|
||||
if ($this->isGroupingEnabled()) {
|
||||
$builder->where($this->getActionIdWhere($userId));
|
||||
}
|
||||
|
||||
return $builder->count();
|
||||
}
|
||||
|
||||
public function markAllRead(string $userId): bool
|
||||
{
|
||||
$update = $this->entityManager
|
||||
->getQueryBuilder()
|
||||
->update()
|
||||
->in(Notification::ENTITY_TYPE)
|
||||
->set(['read' => true])
|
||||
->where([
|
||||
'userId' => $userId,
|
||||
'read' => false,
|
||||
])
|
||||
->build();
|
||||
|
||||
$this->entityManager->getQueryExecutor()->execute($update);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
private function getIgnoreScopeList(): array
|
||||
{
|
||||
$ignoreScopeList = [];
|
||||
|
||||
$scopes = $this->metadata->get('scopes', []);
|
||||
|
||||
foreach ($scopes as $scope => $item) {
|
||||
if (empty($item['entity'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (empty($item['object'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!$this->acl->checkScope($scope)) {
|
||||
$ignoreScopeList[] = $scope;
|
||||
}
|
||||
}
|
||||
|
||||
return $ignoreScopeList;
|
||||
}
|
||||
|
||||
private function getNoteId(Notification $entity): ?string
|
||||
{
|
||||
$noteId = null;
|
||||
|
||||
$data = $entity->getData();
|
||||
|
||||
if ($data) {
|
||||
$noteId = $data->noteId ?? null;
|
||||
}
|
||||
|
||||
if ($entity->getRelated()?->getEntityType() === Note::ENTITY_TYPE) {
|
||||
$noteId = $entity->getRelated()->getId();
|
||||
}
|
||||
|
||||
return $noteId;
|
||||
}
|
||||
|
||||
private function loadNoteFields(Note $note, Notification $notification): void
|
||||
{
|
||||
$parentId = $note->getParentId();
|
||||
$parentType = $note->getParentType();
|
||||
|
||||
if ($parentId && $parentType) {
|
||||
if ($notification->getType() !== Notification::TYPE_USER_REACTION) {
|
||||
$parent = $this->entityManager->getEntityById($parentType, $parentId);
|
||||
|
||||
if ($parent) {
|
||||
$note->set('parentName', $parent->get(Field::NAME));
|
||||
}
|
||||
}
|
||||
} else if (!$note->isGlobal()) {
|
||||
$targetType = $note->getTargetType();
|
||||
|
||||
if (!$targetType || $targetType === Note::TARGET_USERS) {
|
||||
$note->loadLinkMultipleField('users');
|
||||
}
|
||||
|
||||
if ($targetType !== Note::TARGET_USERS) {
|
||||
if (!$targetType || $targetType === Note::TARGET_TEAMS) {
|
||||
$note->loadLinkMultipleField(Field::TEAMS);
|
||||
} else if ($targetType === Note::TARGET_PORTALS) {
|
||||
$note->loadLinkMultipleField('portals');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$relatedId = $note->getRelatedId();
|
||||
$relatedType = $note->getRelatedType();
|
||||
|
||||
if ($relatedId && $relatedType && $notification->getType() !== Notification::TYPE_USER_REACTION) {
|
||||
$related = $this->entityManager->getEntityById($relatedType, $relatedId);
|
||||
|
||||
if ($related) {
|
||||
$note->set('relatedName', $related->get(Field::NAME));
|
||||
}
|
||||
}
|
||||
|
||||
if ($notification->getType() !== Notification::TYPE_USER_REACTION) {
|
||||
$note->loadLinkMultipleField('attachments');
|
||||
}
|
||||
}
|
||||
|
||||
private function getActionIdWhere(string $userId): WhereItem
|
||||
{
|
||||
return Cond::or(
|
||||
Expr::isNull(Expr::column('actionId')),
|
||||
Cond::and(
|
||||
Expr::isNotNull(Expr::column('actionId')),
|
||||
Cond::not(
|
||||
Cond::exists(
|
||||
SelectBuilder::create()
|
||||
->from(Notification::ENTITY_TYPE, 'sub')
|
||||
->select('id')
|
||||
->where(
|
||||
Cond::equal(
|
||||
Expr::column('sub.actionId'),
|
||||
Expr::column('notification.actionId')
|
||||
)
|
||||
)
|
||||
->where(
|
||||
Cond::less(
|
||||
Expr::column('sub.number'),
|
||||
Expr::column('notification.number')
|
||||
)
|
||||
)
|
||||
->where([Notification::ATTR_USER_ID => $userId])
|
||||
->build()
|
||||
)
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param EntityCollection<Notification> $collection
|
||||
* @return array<string, int>
|
||||
*/
|
||||
private function getGroupedCountMap(EntityCollection $collection, string $userId): array
|
||||
{
|
||||
if (!$this->isGroupingEnabled()) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$groupedCountMap = [];
|
||||
|
||||
$actionIds = [];
|
||||
|
||||
foreach ($collection as $note) {
|
||||
if ($note->getActionId()) {
|
||||
$actionIds[] = $note->getActionId();
|
||||
}
|
||||
}
|
||||
|
||||
$countsQuery = SelectBuilder::create()
|
||||
->from(Notification::ENTITY_TYPE)
|
||||
->select(Expr::count(Expr::column(Attribute::ID)), 'count')
|
||||
->select(Expr::column(Notification::ATTR_ACTION_ID))
|
||||
->where([
|
||||
Notification::ATTR_ACTION_ID => $actionIds,
|
||||
Notification::ATTR_USER_ID => $userId,
|
||||
])
|
||||
->group(Expr::column(Notification::ATTR_ACTION_ID))
|
||||
->build();
|
||||
|
||||
$rows = $this->entityManager->getQueryExecutor()->execute($countsQuery)->fetchAll();
|
||||
|
||||
foreach ($rows as $row) {
|
||||
$actionId = $row[Notification::ATTR_ACTION_ID] ?? null;
|
||||
|
||||
if (!is_string($actionId)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$groupedCountMap[$actionId] = $row['count'] ?? 0;
|
||||
}
|
||||
|
||||
return $groupedCountMap;
|
||||
}
|
||||
|
||||
private function isGroupingEnabled(): bool
|
||||
{
|
||||
// @todo Param in preferences?
|
||||
return (bool) ($this->config->get('notificationGrouping') ?? true);
|
||||
}
|
||||
|
||||
private function prepareSetFields(Notification $entity): void
|
||||
{
|
||||
if ($entity->getRelated() && $entity->getData()?->relatedName) {
|
||||
$entity->set('relatedName', $entity->getData()->relatedName);
|
||||
}
|
||||
|
||||
if ($entity->getCreatedBy() && $entity->getData()?->createdByName) {
|
||||
$entity->set('createdByName', $entity->getData()->createdByName);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
/************************************************************************
|
||||
* This file is part of EspoCRM.
|
||||
*
|
||||
* EspoCRM – Open Source CRM application.
|
||||
* Copyright (C) 2014-2026 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\Pdf\Dompdf;
|
||||
|
||||
use Dompdf\Dompdf;
|
||||
use Dompdf\Options;
|
||||
use Espo\Core\Utils\Config;
|
||||
use Espo\Tools\Pdf\Params;
|
||||
use Espo\Tools\Pdf\Template;
|
||||
|
||||
class DompdfInitializer
|
||||
{
|
||||
private string $defaultFontFace = 'DejaVu Sans';
|
||||
|
||||
private const PT = 2.83465;
|
||||
|
||||
public function __construct(
|
||||
private Config $config,
|
||||
) {}
|
||||
|
||||
public function initialize(Template $template, Params $params): Dompdf
|
||||
{
|
||||
$options = new Options();
|
||||
|
||||
$options->setIsPdfAEnabled($params->isPdfA());
|
||||
$options->setDefaultFont($this->getFontFace($template));
|
||||
|
||||
$pdf = new Dompdf($options);
|
||||
|
||||
if ($params->isPdfA()) {
|
||||
$this->mapFonts($pdf);
|
||||
}
|
||||
|
||||
$size = $template->getPageFormat() === Template::PAGE_FORMAT_CUSTOM ?
|
||||
[0.0, 0.0, $template->getPageWidth() * self::PT, $template->getPageHeight() * self::PT] :
|
||||
$template->getPageFormat();
|
||||
|
||||
$orientation = $template->getPageOrientation() === Template::PAGE_ORIENTATION_PORTRAIT ?
|
||||
'portrait' :
|
||||
'landscape';
|
||||
|
||||
$pdf->setPaper($size, $orientation);
|
||||
|
||||
return $pdf;
|
||||
}
|
||||
|
||||
private function getFontFace(Template $template): string
|
||||
{
|
||||
return
|
||||
$template->getFontFace() ??
|
||||
$this->config->get('pdfFontFace') ??
|
||||
$this->defaultFontFace;
|
||||
}
|
||||
|
||||
private function mapFonts(Dompdf $pdf): void
|
||||
{
|
||||
// Fonts are included in PDF/A. Map standard fonts to open source analogues.
|
||||
$fontMetrics = $pdf->getFontMetrics();
|
||||
|
||||
$fontMetrics->setFontFamily('courier', $fontMetrics->getFamily('DejaVu Sans Mono'));
|
||||
$fontMetrics->setFontFamily('fixed', $fontMetrics->getFamily('DejaVu Sans Mono'));
|
||||
$fontMetrics->setFontFamily('helvetica', $fontMetrics->getFamily('DejaVu Sans'));
|
||||
$fontMetrics->setFontFamily('monospace', $fontMetrics->getFamily('DejaVu Sans Mono'));
|
||||
$fontMetrics->setFontFamily('sans-serif', $fontMetrics->getFamily('DejaVu Sans'));
|
||||
$fontMetrics->setFontFamily('serif', $fontMetrics->getFamily('DejaVu Serif'));
|
||||
$fontMetrics->setFontFamily('times', $fontMetrics->getFamily('DejaVu Serif'));
|
||||
$fontMetrics->setFontFamily('times-roman', $fontMetrics->getFamily('DejaVu Serif'));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user