espocrm-extensions/espocrm-base
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

username unique index

Browse Source
This commit is contained in:
Yuri Kuznetsov
2023-04-21 13:08:06 +03:00
parent 5161fbb1d4
commit 6a963f39d4
7 changed files with 194 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/Espo/Hooks/User/DeleteId.php
+61
View File
@@ -0,0 +1,61 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 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\Hooks\User;
use Espo\Core\Hook\Hook\BeforeRemove;
use Espo\Core\Hook\Hook\BeforeSave;
use Espo\Core\Utils\Util;
use Espo\Entities\User;
use Espo\ORM\Entity;
use Espo\ORM\Repository\Option\RemoveOptions;
use Espo\ORM\Repository\Option\SaveOptions;
/**
* @implements BeforeRemove<User>
* @implements BeforeSave<User>
*/
class DeleteId implements BeforeRemove, BeforeSave
{
public function beforeRemove(Entity $entity, RemoveOptions $options): void
{
$entity->set('deleteId', Util::generateId());
}
public function beforeSave(Entity $entity, SaveOptions $options): void
{
if (!$entity->isAttributeChanged('deleted')) {
return;
}
$deleteId = $entity->get('deleted') ? Util::generateId() : '0';
$entity->set('deleteId', $deleteId);
}
}
application/Espo/Repositories/User.php
+1 -55
View File
@@ -30,18 +30,13 @@
namespace Espo\Repositories;
use Espo\ORM\Entity;
use Espo\Core\Exceptions\Error;
use Espo\Core\Exceptions\Conflict;
use Espo\Core\Repositories\Database;
use Espo\Core\Utils\Json;
use Espo\Repositories\UserData as UserDataRepository;
use Espo\Entities\UserData;
use Espo\Entities\User as UserEntity;
/**
* @extends Database<\Espo\Entities\User>
* @extends Database<UserEntity>
*/
class User extends Database
{
@@ -51,8 +46,6 @@ class User extends Database
* @param UserEntity $entity
* @param array<string, mixed> $options
* @return void
* @throws Conflict
* @throws Error
*/
protected function beforeSave(Entity $entity, array $options = [])
{
@@ -91,53 +84,6 @@ class User extends Database
$entity->set('defaultTeamId', null);
$entity->set('defaultTeamName', null);
}
if ($entity->isNew()) {
$userName = $entity->getUserName();
if (empty($userName)) {
throw new Error("Username can't be empty.");
}
$this->entityManager->getLocker()->lockExclusive($this->entityType);
$user = $this
->select(['id'])
->where([
'userName' => $userName,
])
->findOne();
if ($user) {
$this->entityManager->getLocker()->rollback();
throw new Conflict(Json::encode(['reason' => 'userNameExists']));
}
} else {
if ($entity->isAttributeChanged('userName')) {
$userName = $entity->getUserName();
if (empty($userName)) {
throw new Error("Username can't be empty.");
}
$this->entityManager->getLocker()->lockExclusive($this->entityType);
$user = $this
->select(['id'])
->where([
'userName' => $userName,
'id!=' => $entity->getId(),
])
->findOne();
if ($user) {
$this->entityManager->getLocker()->rollback();
throw new Conflict(Json::encode(['reason' => 'userNameExists']));
}
}
}
}
/**
application/Espo/Resources/metadata/entityAcl/User.json
+3
View File
@@ -61,6 +61,9 @@
},
"userData": {
"forbidden": true
},
"deleteId": {
"forbidden": true
}
},
"links": {
application/Espo/Resources/metadata/entityDefs/User.json
+18
View File
@@ -391,6 +391,15 @@
"layoutDetailDisabled": true,
"directAccessDisabled": true,
"exportDisabled": true
},
"deleteId": {
"type": "varchar",
"maxLength": 17,
"readOnly": true,
"notNull": true,
"default": "0",
"disabled": true,
"customizationDisabled": true
}
},
"links": {
@@ -508,5 +517,14 @@
"orderBy": "userName",
"order": "asc",
"textFilterFields": ["name", "userName", "emailAddress"]
},
"indexes": {
"userNameDeleteId": {
"type": "unique",
"columns": [
"userName",
"deleteId"
]
}
}
}
application/Espo/Services/User.php
+58
View File
@@ -30,6 +30,8 @@
namespace Espo\Services;
use Espo\Core\Authentication\Logins\Hmac;
use Espo\Core\Exceptions\Conflict;
use Espo\Core\Exceptions\NotFound;
use Espo\Core\Mail\Exceptions\SendingError;
use Espo\Entities\Team as TeamEntity;
use Espo\Entities\User as UserEntity;
@@ -46,6 +48,7 @@ use Espo\Core\Utils\ApiKey as ApiKeyUtil;
use Espo\Core\Utils\PasswordHash;
use Espo\Core\Utils\Util;
use Espo\ORM\Entity;
use Espo\ORM\Query\SelectBuilder;
use Espo\Tools\UserSecurity\Password\Checker as PasswordChecker;
use Espo\Tools\UserSecurity\Password\Sender as PasswordSender;
use Espo\Tools\UserSecurity\Password\Service as PasswordService;
@@ -275,9 +278,25 @@ class User extends Record implements
->count();
}
/**
* @throws Conflict
*/
private function processUserExistsChecking(UserEntity $user): void
{
$existing = $this->getRepository()
->select('id')
->where(['userName' => $user->getUserName()])
->findOne();
if ($existing) {
throw new Conflict('userNameExists');
}
}
/**
* @param UserEntity $entity
* @throws Forbidden
* @throws Conflict
*/
protected function beforeCreateEntity(Entity $entity, $data)
{
@@ -309,6 +328,8 @@ class User extends Record implements
}
}
$this->processUserExistsChecking($entity);
if ($entity->isApi()) {
$entity->set('apiKey', Util::generateApiKey());
@@ -331,6 +352,7 @@ class User extends Record implements
/**
* @param UserEntity $entity
* @throws Forbidden
* @throws Conflict
*/
protected function beforeUpdateEntity(Entity $entity, $data)
{
@@ -392,6 +414,10 @@ class User extends Record implements
}
}
if ($entity->isAttributeChanged('userName')) {
$this->processUserExistsChecking($entity);
}
if (
$entity->isApi() &&
$entity->isAttributeChanged('authMethod') &&
@@ -475,6 +501,38 @@ class User extends Record implements
}
}
/**
* @throws Forbidden
* @throws NotFound
* @throws Conflict
*/
public function restoreDeleted(string $id): void
{
$entity = $this->getRepository()
->clone(
SelectBuilder::create()
->from(UserEntity::ENTITY_TYPE)
->withDeleted()
->build()
)
->where(['id' => $id])
->findOne();
if ($entity) {
$this->processUserExistsChecking($entity);
}
parent::restoreDeleted($id);
$entity = $this->getRepository()->getById($id);
if ($entity) {
$entity->set('deleteId', '0');
$this->getRepository()->save($entity);
}
}
protected function clearRoleCache(UserEntity $user): void
{
$this->createAclCacheClearer()->clearForUser($user);
upgrades/7.5/data.json
+2
View File
@@ -0,0 +1,2 @@
{
}
upgrades/7.5/scripts/BeforeUpgrade.php
+51
View File
@@ -0,0 +1,51 @@
<?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.
************************************************************************/
use Espo\Core\Container;
use Espo\Entities\User;
use Espo\ORM\EntityManager;
use Espo\ORM\Query\DeleteBuilder;
class BeforeUpgrade
{
public function run(Container $container)
{
$this->deleteDeletedUsers($container->getByClass(EntityManager::class));
}
private function deleteDeletedUsers(EntityManager $entityManager): void
{
$query = DeleteBuilder::create()
->from(User::ENTITY_TYPE)
->where(['deleted' => true])
->build();
$entityManager->getQueryExecutor()->execute($query);
}
}