refactoring

This commit is contained in:
Yuri Kuznetsov
2021-04-30 15:19:35 +03:00
parent e4c71fb3e4
commit e3dcfb9136
2 changed files with 255 additions and 149 deletions
+45 -149
View File
@@ -29,183 +29,79 @@
namespace Espo\Controllers;
use Espo\Core\Exceptions\Error;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Exceptions\NotFound;
use Espo\Core\{
Controllers\Base,
Exceptions\BadRequest,
Api\Request,
Di,
};
use Espo\Services\Preferences as Service;
use StdClass;
class Preferences extends Base implements
Di\EntityManagerAware,
Di\CryptAware
class Preferences
{
use Di\EntityManagerSetter;
use Di\CryptSetter;
private $service;
protected $entityManager;
protected $crypt;
protected function handleUserAccess(string $userId): void
public function __construct(Service $service)
{
if (!$this->user->isAdmin()) {
if ($this->user->getId() != $userId) {
throw new Forbidden();
}
}
}
public function deleteActionDelete(Request $request): StdClass
{
$params = $request->getRouteParams();
$userId = $params['id'];
if (empty($userId)) {
throw new BadRequest();
}
$this->handleUserAccess($userId);
$result = $this->entityManager
->getRepository('Preferences')
->resetToDefaults($userId);
if (!$result) {
throw new NotFound();
}
return $result;
}
public function putActionUpdate(Request $request): StdClass
{
$params = $request->getRouteParams();
$data = $request->getParsedBody();
$userId = $params['id'];
$this->handleUserAccess($userId);
if ($this->acl->getLevel('Preferences', 'edit') === 'no') {
throw new Forbidden();
}
foreach ($this->acl->getScopeForbiddenAttributeList('Preferences', 'edit') as $attribute) {
unset($data->$attribute);
}
if (property_exists($data, 'smtpPassword')) {
$data->smtpPassword = $this->crypt->encrypt($data->smtpPassword);
}
$user = $this->entityManager->getEntity('User', $userId);
$entity = $this->entityManager->getEntity('Preferences', $userId);
if ($entity && $user) {
$entity->set($data);
$this->entityManager->saveEntity($entity);
$entity->set('smtpEmailAddress', $user->get('emailAddress'));
$entity->set('name', $user->get('name'));
$entity->clear('smtpPassword');
return $entity->getValueMap();
}
throw new Error();
$this->service = $service;
}
public function getActionRead(Request $request): StdClass
{
$params = $request->getRouteParams();
$userId = $request->getRouteParam('id');
$userId = $params['id'];
$this->handleUserAccess($userId);
$entity = $this->entityManager->getEntity('Preferences', $userId);
$user = $this->entityManager->getEntity('User', $userId);
if (!$entity || !$user) {
throw new NotFound();
if (!$userId) {
throw new BadRequest();
}
$entity->set('smtpEmailAddress', $user->get('emailAddress'));
$entity->set('name', $user->get('name'));
$entity->set('isPortalUser', $user->isPortal());
return $this->service->read($userId)->getValueMap();
}
$entity->clear('smtpPassword');
public function deleteActionDelete(Request $request): StdClass
{
$userId = $request->getRouteParam('id');
foreach ($this->acl->getScopeForbiddenAttributeList('Preferences', 'read') as $attribute) {
$entity->clear($attribute);
if (!$userId) {
throw new BadRequest();
}
return $entity->getValueMap();
$this->service->resetToDefaults($userId);
return $this->service
->read($userId)
->getValueMap();
}
public function putActionUpdate(Request $request): StdClass
{
$userId = $request->getRouteParam('id');
if (!$userId) {
throw new BadRequest();
}
$data = $request->getParsedBody();
if (!$userId) {
throw new BadRequest();
}
return $this->service
->update($userId, $data)
->getValueMap();
}
public function postActionResetDashboard(Request $request): StdClass
{
$data = $request->getParsedBody();
if (empty($data->id)) {
$userId = $data->id ?? null;
if (!$userId) {
throw new BadRequest();
}
$userId = $data->id;
$this->handleUserAccess($userId);
$user = $this->entityManager->getEntity('User', $userId);
$preferences = $this->entityManager->getEntity('Preferences', $userId);
if (!$user) {
throw new NotFound();
}
if (!$preferences) {
throw new NotFound();
}
if ($user->isPortal()) {
throw new Forbidden();
}
if ($this->acl->getLevel('Preferences', 'edit') === 'no') {
throw new Forbidden();
}
$forbiddenAttributeList = $this->acl->getScopeForbiddenAttributeList('Preferences', 'edit');
if (in_array('dashboardLayout', $forbiddenAttributeList)) {
throw new Forbidden();
}
$dashboardLayout = $this->config->get('dashboardLayout');
$dashletsOptions = $this->config->get('dashletsOptions');
$preferences->set([
'dashboardLayout' => $dashboardLayout,
'dashletsOptions' => $dashletsOptions,
]);
$this->entityManager->saveEntity($preferences);
return (object) [
'dashboardLayout' => $preferences->get('dashboardLayout'),
'dashletsOptions' => $preferences->get('dashletsOptions'),
];
return $this->service->resetDashboard($userId);
}
}
+210
View File
@@ -0,0 +1,210 @@
<?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\Services;
use Espo\ORM\EntityManager;
use Espo\Entities\{
User,
Preferences as PreferencesEntity,
};
use Espo\Core\{
Exceptions\Forbidden,
Exceptions\NotFound,
Utils\Crypt,
Acl\Table,
Acl,
Utils\Config,
};
use StdClass;
class Preferences
{
private $entityManager;
private $user;
private $crypt;
private $acl;
private $config;
public function __construct(
EntityManager $entityManager,
User $user,
Crypt $crypt,
Acl $acl,
Config $config
) {
$this->entityManager = $entityManager;
$this->user = $user;
$this->crypt = $crypt;
$this->acl = $acl;
$this->config = $config;
}
protected function processAccessCheck(string $userId): void
{
if (!$this->user->isAdmin()) {
if ($this->user->getId() !== $userId) {
throw new Forbidden();
}
}
}
public function read(string $userId): PreferencesEntity
{
$this->processAccessCheck($userId);
$entity = $this->entityManager->getEntity('Preferences', $userId);
$user = $this->entityManager->getEntity('User', $userId);
if (!$entity || !$user) {
throw new NotFound();
}
$entity->set('smtpEmailAddress', $user->get('emailAddress'));
$entity->set('name', $user->get('name'));
$entity->set('isPortalUser', $user->isPortal());
$entity->clear('smtpPassword');
$fobiddenAttributeList = $this->acl
->getScopeForbiddenAttributeList('Preferences', Table::ACTION_READ);
foreach ($fobiddenAttributeList as $attribute) {
$entity->clear($attribute);
}
return $entity;
}
public function update(string $userId, StdClass $data): PreferencesEntity
{
$this->processAccessCheck($userId);
if ($this->acl->getLevel('Preferences', Table::ACTION_EDIT) === Table::LEVEL_NO) {
throw new Forbidden();
}
$fobiddenAttributeList = $this->acl
->getScopeForbiddenAttributeList('Preferences', Table::ACTION_EDIT);
foreach ($fobiddenAttributeList as $attribute) {
unset($data->$attribute);
}
if (property_exists($data, 'smtpPassword')) {
$data->smtpPassword = $this->crypt->encrypt($data->smtpPassword);
}
$user = $this->entityManager->getEntity('User', $userId);
$entity = $this->entityManager->getEntity('Preferences', $userId);
if (!$entity || !$user) {
throw new NotFound();
}
$entity->set($data);
$this->entityManager->saveEntity($entity);
$entity->set('smtpEmailAddress', $user->get('emailAddress'));
$entity->set('name', $user->get('name'));
$entity->clear('smtpPassword');
return $entity;
}
public function resetToDefaults(string $userId): void
{
$this->processAccessCheck($userId);
$result = $this->entityManager
->getRepository('Preferences')
->resetToDefaults($userId);
if (!$result) {
throw new NotFound();
}
}
public function resetDashboard(string $userId): StdClass
{
$this->processAccessCheck($userId);
if ($this->acl->getLevel('Preferences', Table::ACTION_EDIT) === Table::LEVEL_NO) {
throw new Forbidden();
}
$user = $this->entityManager->getEntity('User', $userId);
$preferences = $this->entityManager->getEntity('Preferences', $userId);
if (!$user) {
throw new NotFound();
}
if (!$preferences) {
throw new NotFound();
}
if ($user->isPortal()) {
throw new Forbidden();
}
$forbiddenAttributeList = $this->acl
->getScopeForbiddenAttributeList('Preferences', Table::ACTION_EDIT);
if (in_array('dashboardLayout', $forbiddenAttributeList)) {
throw new Forbidden();
}
$dashboardLayout = $this->config->get('dashboardLayout');
$dashletsOptions = $this->config->get('dashletsOptions');
$preferences->set([
'dashboardLayout' => $dashboardLayout,
'dashletsOptions' => $dashletsOptions,
]);
$this->entityManager->saveEntity($preferences);
return (object) [
'dashboardLayout' => $preferences->get('dashboardLayout'),
'dashletsOptions' => $preferences->get('dashletsOptions'),
];
}
}