Initial commit

application/Espo/ORM/Locker/BaseLocker.php

@@ -0,0 +1,122 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\ORM\Locker;
+
+use Espo\ORM\Query\LockTableBuilder;
+use Espo\ORM\QueryComposer\QueryComposer;
+use Espo\ORM\TransactionManager;
+
+use PDO;
+use RuntimeException;
+
+class BaseLocker implements Locker
+{
+    private bool $isLocked = false;
+
+    public function __construct(
+        private PDO $pdo,
+        private QueryComposer $queryComposer,
+        private TransactionManager $transactionManager
+    ) {}
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isLocked(): bool
+    {
+        return $this->isLocked;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function lockExclusive(string $entityType): void
+    {
+        $this->isLocked = true;
+
+        $this->transactionManager->start();
+
+        $query = (new LockTableBuilder())
+            ->table($entityType)
+            ->inExclusiveMode()
+            ->build();
+
+        $sql = $this->queryComposer->composeLockTable($query);
+
+        $this->pdo->exec($sql);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function lockShare(string $entityType): void
+    {
+        $this->isLocked = true;
+
+        $this->transactionManager->start();
+
+        $query = (new LockTableBuilder())
+            ->table($entityType)
+            ->inShareMode()
+            ->build();
+
+        $sql = $this->queryComposer->composeLockTable($query);
+
+        $this->pdo->exec($sql);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function commit(): void
+    {
+        if (!$this->isLocked) {
+            throw new RuntimeException("Can't commit, it was not locked.");
+        }
+
+        $this->transactionManager->commit();
+
+        $this->isLocked = false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rollback(): void
+    {
+        if (!$this->isLocked) {
+            throw new RuntimeException("Can't rollback, it was not locked.");
+        }
+
+        $this->transactionManager->rollback();
+
+        $this->isLocked = false;
+    }
+}

application/Espo/ORM/Locker/Locker.php

@@ -0,0 +1,62 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\ORM\Locker;
+
+/**
+ * Locks and unlocks tables.
+ * Wraps operations between lock and unlock into a transaction.
+ */
+interface Locker
+{
+    /**
+     * Whether any table has been locked.
+     */
+    public function isLocked(): bool;
+
+    /**
+     * Locks a table in an exclusive mode. Starts a transaction on first call.
+     */
+    public function lockExclusive(string $entityType): void;
+
+    /**
+     * Locks a table in a share mode. Starts a transaction on first call.
+     */
+    public function lockShare(string $entityType): void;
+
+    /**
+     * Commits changes and unlocks tables.
+     */
+    public function commit(): void;
+
+    /**
+     * Rollbacks changes and unlocks tables.
+     */
+    public function rollback(): void;
+}

application/Espo/ORM/Locker/MysqlLocker.php

@@ -0,0 +1,138 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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\ORM\Locker;
+
+use Espo\ORM\QueryComposer\QueryComposer;
+use Espo\ORM\QueryComposer\MysqlQueryComposer;
+use Espo\ORM\Query\LockTableBuilder;
+use Espo\ORM\TransactionManager;
+
+use PDO;
+use RuntimeException;
+
+/**
+ * Transactions within locking is not supported for MySQL.
+ */
+class MysqlLocker implements Locker
+{
+    private MysqlQueryComposer $queryComposer;
+    /** @phpstan-ignore-next-line */
+    private TransactionManager $transactionManager;
+
+    private bool $isLocked = false;
+
+    public function __construct(
+        private PDO $pdo,
+        QueryComposer $queryComposer,
+        TransactionManager $transactionManager
+    ) {
+        $this->transactionManager = $transactionManager;
+
+        if (!$queryComposer instanceof MysqlQueryComposer) {
+            throw new RuntimeException();
+        }
+
+        $this->queryComposer = $queryComposer;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isLocked(): bool
+    {
+        return $this->isLocked;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    public function lockExclusive(string $entityType): void
+    {
+        $this->isLocked = true;
+
+        $query = (new LockTableBuilder())
+            ->table($entityType)
+            ->inExclusiveMode()
+            ->build();
+
+        $sql = $this->queryComposer->composeLockTable($query);
+
+        $this->pdo->exec($sql);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function lockShare(string $entityType): void
+    {
+        $this->isLocked = true;
+
+        $query = (new LockTableBuilder())
+            ->table($entityType)
+            ->inShareMode()
+            ->build();
+
+        $sql = $this->queryComposer->composeLockTable($query);
+
+        $this->pdo->exec($sql);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function commit(): void
+    {
+        if (!$this->isLocked) {
+            throw new RuntimeException("Can't commit, it was not locked.");
+        }
+
+        $this->isLocked = false;
+
+        $sql = $this->queryComposer->composeUnlockTables();
+
+        $this->pdo->exec($sql);
+    }
+
+    /**
+     * Lift locking.
+     * Rolling back within locking is not supported for MySQL.
+     */
+    public function rollback(): void
+    {
+        if (!$this->isLocked) {
+            throw new RuntimeException("Can't rollback, it was not locked.");
+        }
+
+        $this->isLocked = false;
+
+        $sql = $this->queryComposer->composeUnlockTables();
+
+        $this->pdo->exec($sql);
+    }
+}