espocrm/application/Espo/Tools/Lock/LockService.php

<?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\Lock;

use Espo\Core\Acl;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Exceptions\Error;
use Espo\Core\Exceptions\ErrorSilent;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Exceptions\ForbiddenSilent;
use Espo\Core\MassAction\Result;
use Espo\Core\Name\Field;
use Espo\ORM\Collection;
use Espo\ORM\Entity;
use Espo\ORM\EntityManager;

class LockService
{
    public function __construct(
        private Acl $acl,
        private EntityManager $entityManager,
        private LockMetadataProvider $lockMetadataProvider,
    ) {}

    /**
     * @param Collection<Entity> $collection
     */
    public function massLock(Collection $collection): Result
    {
        $count = 0;

        foreach ($collection as $entity) {
            try {
                $this->lock($entity);
            } catch (Error|Forbidden|BadRequest) {
                continue;
            }

            $count ++;
        }

        return new Result(count: $count);
    }

    /**
     * @param Collection<Entity> $collection
     */
    public function massUnlock(Collection $collection): Result
    {
        $count = 0;

        foreach ($collection as $entity) {
            try {
                $this->unlock($entity);
            } catch (Error|Forbidden|BadRequest) {
                continue;
            }

            $count ++;
        }

        return new Result(count: $count);
    }

    public function isEnabled(string $entityType): bool
    {
        return $this->lockMetadataProvider->isEnabled($entityType);
    }

    public function isAllowed(string $entityType): bool
    {
        if (!$this->acl->checkScope($entityType, Acl\Table::ACTION_EDIT)) {
            return false;
        }

        if ($this->acl->getPermissionLevel(Acl\Permission::LOCK) !== Acl\Table::LEVEL_YES) {
            return false;
        }

        return true;
    }

    /**
     * @throws Error
     * @throws Forbidden
     * @throws BadRequest
     */
    public function lock(Entity $entity): void
    {
        $this->check($entity);

        if ($entity->get(Field::IS_LOCKED)) {
            throw new BadRequest("Already locked.");
        }

        $this->lockEntity($entity);
    }

    /**
     * @throws Error
     * @throws Forbidden
     * @throws BadRequest
     */
    public function unlock(Entity $entity): void
    {
        $this->check($entity);

        if (!$entity->get(Field::IS_LOCKED)) {
            throw new BadRequest("Already unlocked.");
        }

        $this->unlockEntity($entity);
    }

    private function lockEntity(Entity $entity): void
    {
        if ($entity->get(Field::IS_LOCKED)) {
            return;
        }

        $entity->set(Field::IS_LOCKED, true);

        $this->entityManager->saveEntity($entity);

    }

    private function unlockEntity(Entity $entity): void
    {
        if (!$entity->get(Field::IS_LOCKED)) {
            return;
        }

        $entity->set(Field::IS_LOCKED, false);

        $this->entityManager->saveEntity($entity);
    }

    /**
     * @throws Error
     * @throws Forbidden
     */
    private function check(Entity $entity): void
    {
        if (!$this->isEnabled($entity->getEntityType())) {
            throw new ErrorSilent("Lock is not enabled.");
        }

        if ($this->acl->getPermissionLevel(Acl\Permission::LOCK) !== Acl\Table::LEVEL_YES) {
            throw new ForbiddenSilent("Not lock permission.");
        }

        if (!$this->acl->checkEntityEdit($entity)) {
            throw new ForbiddenSilent("No edit access.");
        }
    }
}