Files
espocrm/application/Espo/Core/Action/ActionFactory.php
Yuri Kuznetsov 7524bc3bc3 actions allowed
2021-04-30 22:36:45 +03:00

136 lines
4.2 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2021 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\Core\Action;
use Espo\Core\{
Exceptions\NotFound,
Exceptions\Forbidden,
Utils\Metadata,
InjectableFactory,
};
class ActionFactory
{
private $metadata;
private $injectableFactory;
public function __construct(Metadata $metadata, InjectableFactory $injectableFactory)
{
$this->metadata = $metadata;
$this->injectableFactory = $injectableFactory;
}
public function create(string $action, ?string $entityType = null): Action
{
$className = $this->getClassName($action, $entityType);
if (!$className) {
throw new NotFound("Action '{$action}' not found.");
}
if ($this->isDisabled($action, $entityType)) {
throw new Forbidden("Action '{$action}' is disabled for '{$entityType}'.");
}
return $this->injectableFactory->create($className);
}
public function createWith(string $action, ?string $entityType, array $with): Action
{
$className = $this->getClassName($action, $entityType);
if (!$className) {
throw new NotFound("Action '{$action}' not found.");
}
return $this->injectableFactory->createWith($className, $with);
}
private function getClassName(string $action, ?string $entityType): ?string
{
if ($entityType) {
$className = $this->getEntityTypeClassName($action, $entityType);
if ($className) {
return $className;
}
}
return $this->metadata->get(
['app', 'actions', $action, 'implementationClassName']
);
}
private function getEntityTypeClassName(string $action, string $entityType): ?string
{
return $this->metadata->get(
['recordDefs', $entityType, 'actions', $action, 'implementationClassName']
);
}
private function isDisabled(string $action, string $entityType): bool
{
$actionsDisabled = $this->metadata
->get(['recordDefs', $entityType, 'actionsDisabled']) ?? false;
if ($actionsDisabled) {
return true;
}
if ($this->needsToBeAllowed($entityType)) {
if (!$this->isAllowed($action, $entityType)) {
return true;
}
}
return $this->metadata
->get(['recordDefs', $entityType, 'actions', $action, 'disabled']) ?? false;
}
private function needsToBeAllowed(string $entityType): bool
{
$isObject = $this->metadata->get(['scopes', $entityType, 'object']) ?? false;
if (!$isObject) {
return true;
}
return $this->metadata
->get(['recordDefs', $entityType, 'notAllowedActionsDisabled']) ?? false;
}
private function isAllowed(string $action, string $entityType): bool
{
return $this->metadata
->get(['recordDefs', $entityType, 'actions', $action, 'allowed']) ?? false;
}
}