mirror of
https://github.com/espocrm/espocrm.git
synced 2026-06-28 15:06:06 +00:00
398 lines
11 KiB
PHP
398 lines
11 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* EspoCRM 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with EspoCRM. If not, see http://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 General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
|
************************************************************************/
|
|
|
|
namespace Espo\Tools\Layout;
|
|
|
|
use Espo\Entities\LayoutRecord;
|
|
|
|
use Espo\Core\Acl;
|
|
use Espo\Core\Acl\Exceptions\NotImplemented;
|
|
use Espo\Core\DataManager;
|
|
use Espo\Core\Exceptions\Error;
|
|
use Espo\Core\Exceptions\Forbidden;
|
|
use Espo\Core\Exceptions\NotFound;
|
|
use Espo\Core\ORM\EntityManager;
|
|
use Espo\Core\Utils\Json;
|
|
use Espo\Core\Utils\Layout as LayoutUtil;
|
|
use Espo\Core\Utils\Metadata;
|
|
|
|
use Espo\Entities\LayoutSet;
|
|
use Espo\Entities\Portal as PortalEntity;
|
|
use Espo\Entities\Team as TeamEntity;
|
|
use Espo\Entities\User;
|
|
use Espo\Tools\LayoutManager\LayoutManager;
|
|
|
|
use stdClass;
|
|
|
|
class Service
|
|
{
|
|
private Acl $acl;
|
|
private LayoutUtil $layout;
|
|
private LayoutManager $layoutManager;
|
|
private EntityManager $entityManager;
|
|
private Metadata $metadata;
|
|
private DataManager $dataManager;
|
|
private User $user;
|
|
|
|
public function __construct(
|
|
Acl $acl,
|
|
LayoutUtil $layout,
|
|
LayoutManager $layoutManager,
|
|
EntityManager $entityManager,
|
|
Metadata $metadata,
|
|
DataManager $dataManager,
|
|
User $user
|
|
) {
|
|
$this->acl = $acl;
|
|
$this->layout = $layout;
|
|
$this->layoutManager = $layoutManager;
|
|
$this->entityManager = $entityManager;
|
|
$this->metadata = $metadata;
|
|
$this->dataManager = $dataManager;
|
|
$this->user = $user;
|
|
}
|
|
|
|
/**
|
|
* @return array<int,mixed>|stdClass|null
|
|
* @throws NotFound
|
|
* @throws Error
|
|
*/
|
|
public function getOriginal(string $scope, string $name, ?string $setId = null)
|
|
{
|
|
$result = null;
|
|
|
|
if ($setId) {
|
|
$layout = $this->getRecordFromSet($scope, $name, $setId, true);
|
|
|
|
if ($layout && $layout->get('data') !== null) {
|
|
/** @var string $data */
|
|
$data = $layout->get('data');
|
|
|
|
$result = Json::decode($data);
|
|
}
|
|
}
|
|
|
|
if (!$result) {
|
|
$data = $this->layout->get($scope, $name) ?? 'false';
|
|
|
|
$result = Json::decode($data);
|
|
}
|
|
|
|
if ($result === false) {
|
|
$methodName = 'getOriginal' . ucfirst($name);
|
|
|
|
if (method_exists($this, $methodName)) {
|
|
$result = $this->$methodName($scope, $setId);
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
* @throws Forbidden
|
|
* @throws NotFound
|
|
* @throws Error
|
|
*/
|
|
public function getForFrontend(string $scope, string $name)
|
|
{
|
|
try {
|
|
if (!$this->acl->checkScope($scope)) {
|
|
throw new Forbidden();
|
|
}
|
|
}
|
|
catch (NotImplemented $e) {}
|
|
|
|
$layoutSetId = null;
|
|
$data = null;
|
|
|
|
$em = $this->entityManager;
|
|
$user = $this->user;
|
|
|
|
if ($user->isPortal()) {
|
|
$portalId = $user->get('portalId');
|
|
|
|
if ($portalId) {
|
|
$portal = $em
|
|
->getRDBRepositoryByClass(PortalEntity::class)
|
|
->select(['layoutSetId'])
|
|
->where(['id' => $portalId])
|
|
->findOne();
|
|
|
|
if ($portal) {
|
|
$layoutSetId = $portal->get('layoutSetId');
|
|
}
|
|
}
|
|
} else {
|
|
$teamId = $user->get('defaultTeamId');
|
|
|
|
if ($teamId) {
|
|
$team = $em
|
|
->getRDBRepositoryByClass(TeamEntity::class)
|
|
->select(['layoutSetId'])
|
|
->where(['id' => $teamId])
|
|
->findOne();
|
|
|
|
if ($team) {
|
|
$layoutSetId = $team->get('layoutSetId');
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($layoutSetId) {
|
|
$nameReal = $name;
|
|
|
|
if ($user->isPortal()) {
|
|
if (substr($name, -6) === 'Portal') {
|
|
$nameReal = substr($name, 0, -6);
|
|
}
|
|
}
|
|
|
|
$layout = $this->getRecordFromSet($scope, $nameReal, $layoutSetId, true);
|
|
|
|
if ($layout) {
|
|
$data = $layout->get('data');
|
|
}
|
|
}
|
|
|
|
if (!$data) {
|
|
$dataString = $this->layout->get($scope, $name) ?? 'null';
|
|
|
|
$data = Json::decode($dataString);
|
|
}
|
|
else {
|
|
$dataString = Json::encode($data);
|
|
}
|
|
|
|
if (is_null($data)) {
|
|
throw new NotFound("Layout {$scope}:{$name} is not found.");
|
|
}
|
|
|
|
if (!$this->user->isAdmin()) {
|
|
if ($name === 'relationships') {
|
|
if (is_array($data)) {
|
|
foreach ($data as $i => $item) {
|
|
$link = $item;
|
|
|
|
if (is_object($item)) {
|
|
/** @var \stdClass $item */
|
|
$link = $item->name ?? null;
|
|
}
|
|
|
|
$foreignEntityType = $this->metadata
|
|
->get(['entityDefs', $scope, 'links', $link, 'entity']);
|
|
|
|
if ($foreignEntityType) {
|
|
if (!$this->acl->tryCheck($foreignEntityType)) {
|
|
unset($data[$i]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$data = array_values($data);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($data === false) {
|
|
$methodName = 'getForFrontend' . ucfirst($name);
|
|
|
|
if (method_exists($this, $methodName)) {
|
|
$data = $this->$methodName($scope);
|
|
}
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* @throws NotFound
|
|
*/
|
|
protected function getRecordFromSet(
|
|
string $scope,
|
|
string $name,
|
|
string $setId,
|
|
bool $skipCheck = false
|
|
): ?LayoutRecord {
|
|
|
|
$entityManager = $this->entityManager;
|
|
|
|
$layoutSet = $entityManager->getEntityById(LayoutSet::ENTITY_TYPE, $setId);
|
|
|
|
if (!$layoutSet) {
|
|
throw new NotFound("LayoutSet {$setId} not found.");
|
|
}
|
|
|
|
$layoutList = $layoutSet->get('layoutList') ?? [];
|
|
|
|
$fullName = $scope . '.' . $name;
|
|
|
|
if (!in_array($fullName, $layoutList)) {
|
|
if ($skipCheck) {
|
|
return null;
|
|
}
|
|
|
|
throw new NotFound("Layout {$fullName} is no allowed in set.");
|
|
}
|
|
|
|
return $entityManager
|
|
->getRDBRepositoryByClass(LayoutRecord::class)
|
|
->where([
|
|
'layoutSetId' => $setId,
|
|
'name' => $fullName,
|
|
])
|
|
->findOne();
|
|
}
|
|
|
|
/**
|
|
* @param mixed $data
|
|
* @return mixed
|
|
* @throws NotFound
|
|
* @throws Error
|
|
*/
|
|
public function update(string $scope, string $name, ?string $setId, $data)
|
|
{
|
|
if ($setId) {
|
|
$layout = $this->getRecordFromSet($scope, $name, $setId);
|
|
|
|
if (!$layout) {
|
|
$layout = $this->entityManager->getNewEntity(LayoutRecord::ENTITY_TYPE);
|
|
|
|
$layout->set([
|
|
'layoutSetId' => $setId,
|
|
'name' => $scope . '.' . $name,
|
|
]);
|
|
}
|
|
|
|
$layout->set('data', Json::encode($data));
|
|
|
|
$this->entityManager->saveEntity($layout);
|
|
|
|
return Json::decode(
|
|
$layout->get('data')
|
|
);
|
|
}
|
|
|
|
$layoutManager = $this->layoutManager;
|
|
|
|
$layoutManager->set($data, $scope, $name);
|
|
$layoutManager->save();
|
|
|
|
$this->dataManager->updateCacheTimestamp();
|
|
|
|
return $layoutManager->get($scope, $name);
|
|
}
|
|
|
|
/**
|
|
* @return array<int,mixed>|stdClass|null
|
|
* @throws NotFound
|
|
* @throws Error
|
|
*/
|
|
public function resetToDefault(string $scope, string $name, ?string $setId = null)
|
|
{
|
|
$this->dataManager->updateCacheTimestamp();
|
|
|
|
if ($setId) {
|
|
$layout = $this->getRecordFromSet($scope, $name, $setId);
|
|
|
|
if ($layout) {
|
|
$em = $this->entityManager;
|
|
$em->removeEntity($layout);
|
|
}
|
|
|
|
return $this->getOriginal($scope, $name);
|
|
}
|
|
|
|
$this->layoutManager->resetToDefault($scope, $name);
|
|
|
|
$methodName = 'resetToDefault' . ucfirst($name);
|
|
|
|
if (method_exists($this, $methodName)) {
|
|
$this->$methodName($scope);
|
|
}
|
|
|
|
return $this->getOriginal($scope, $name);
|
|
}
|
|
|
|
/**
|
|
* @throws Error
|
|
* @throws NotFound
|
|
*/
|
|
protected function getOriginalBottomPanelsDetail(string $scope, ?string $setId = null): stdClass
|
|
{
|
|
$relationships = $this->getOriginal($scope, 'relationships') ?? [];
|
|
|
|
if (!is_array($relationships)) {
|
|
throw new Error("Bad 'relationships' layout.");
|
|
}
|
|
|
|
$result = (object) [];
|
|
|
|
foreach ($relationships as $i => $item) {
|
|
if (is_string($item)) {
|
|
$item = (object) [
|
|
'name' => $item,
|
|
];
|
|
}
|
|
|
|
if (!is_object($item)) {
|
|
continue;
|
|
}
|
|
|
|
/** @var stdClass $item */
|
|
|
|
$item = clone $item;
|
|
$item->index = 5 + 0.001 * $i;
|
|
|
|
if (!isset($item->name)) {
|
|
continue;
|
|
}
|
|
|
|
$result->{$item->name} = $item;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @throws NotFound
|
|
* @throws Error
|
|
*/
|
|
protected function getForFrontendBottomPanelsDetail(string $scope): stdClass
|
|
{
|
|
return $this->getOriginalBottomPanelsDetail($scope);
|
|
}
|
|
|
|
protected function resetToDefaultBottomPanelsDetail(string $scope): void
|
|
{
|
|
$this->layoutManager->resetToDefault($scope, 'relationships');
|
|
}
|
|
}
|