friendica-github/src/Core/BaseLock.php

84 lines
1.9 KiB
PHP
Raw Normal View History

<?php
2020-02-09 14:45:36 +00:00
/**
* @copyright Copyright (C) 2020, Friendica
*
* @license GNU AGPL version 3 or any later version
*
* 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/>.
*
*/
namespace Friendica\Core;
use Friendica\Core\Lock\ILock;
2019-08-13 19:20:41 +00:00
/**
2018-07-05 05:59:56 +00:00
* Basic class for Locking with common functions (local acquired locks, releaseAll, ..)
*/
abstract class BaseLock implements ILock
{
/**
* @var array The local acquired locks
*/
protected $acquiredLocks = [];
/**
2018-07-05 05:59:56 +00:00
* Check if we've locally acquired a lock
*
* @param string key The Name of the lock
*
* @return bool Returns true if the lock is set
*/
2019-03-04 20:28:36 +00:00
protected function hasAcquiredLock($key)
{
return isset($this->acquireLock[$key]) && $this->acquiredLocks[$key] === true;
}
/**
2018-07-05 05:59:56 +00:00
* Mark a locally acquired lock
*
* @param string $key The Name of the lock
*/
2019-03-04 20:28:36 +00:00
protected function markAcquire($key)
{
$this->acquiredLocks[$key] = true;
}
/**
2018-07-05 05:59:56 +00:00
* Mark a release of a locally acquired lock
*
* @param string $key The Name of the lock
*/
2019-03-04 20:28:36 +00:00
protected function markRelease($key)
{
unset($this->acquiredLocks[$key]);
}
/**
2019-08-13 19:20:41 +00:00
* {@inheritDoc}
*/
2019-08-13 19:20:41 +00:00
public function releaseAll($override = false)
2019-03-04 20:28:36 +00:00
{
$return = true;
foreach ($this->acquiredLocks as $acquiredLock => $hasLock) {
if (!$this->release($acquiredLock, $override)) {
2019-03-04 20:28:36 +00:00
$return = false;
}
}
2019-03-04 20:28:36 +00:00
return $return;
}
}