src/Core/BaseLock.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Friendica\Core\Lock\ILock;
  25
  26 /**
  27  * Basic class for Locking with common functions (local acquired locks, releaseAll, ..)
  28  */
  29 abstract class BaseLock implements ILock
  30 {
  31         /**
  32          * @var array The local acquired locks
  33          */
  34         protected $acquiredLocks = [];
  35
  36         /**
  37          * Check if we've locally acquired a lock
  38          *
  39          * @param string key The Name of the lock
  40          *
  41          * @return bool      Returns true if the lock is set
  42          */
  43         protected function hasAcquiredLock($key)
  44         {
  45                 return isset($this->acquireLock[$key]) && $this->acquiredLocks[$key] === true;
  46         }
  47
  48         /**
  49          * Mark a locally acquired lock
  50          *
  51          * @param string $key The Name of the lock
  52          */
  53         protected function markAcquire($key)
  54         {
  55                 $this->acquiredLocks[$key] = true;
  56         }
  57
  58         /**
  59          * Mark a release of a locally acquired lock
  60          *
  61          * @param string $key The Name of the lock
  62          */
  63         protected function markRelease($key)
  64         {
  65                 unset($this->acquiredLocks[$key]);
  66         }
  67
  68         /**
  69          * {@inheritDoc}
  70          */
  71         public function releaseAll($override = false)
  72         {
  73                 $return = true;
  74
  75                 foreach ($this->acquiredLocks as $acquiredLock => $hasLock) {
  76                         if (!$this->release($acquiredLock, $override)) {
  77                                 $return = false;
  78                         }
  79                 }
  80
  81                 return $return;
  82         }
  83 }