You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
146 lines
4.2 KiB
146 lines
4.2 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Robin Appelman <robin@icewind.nl> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* 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, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OC\Lock; |
|
|
|
use OCP\IMemcacheTTL; |
|
use OCP\Lock\LockedException; |
|
use OCP\IMemcache; |
|
|
|
class MemcacheLockingProvider extends AbstractLockingProvider { |
|
/** |
|
* @var \OCP\IMemcache |
|
*/ |
|
private $memcache; |
|
|
|
/** |
|
* @param \OCP\IMemcache $memcache |
|
* @param int $ttl |
|
*/ |
|
public function __construct(IMemcache $memcache, int $ttl = 3600) { |
|
$this->memcache = $memcache; |
|
$this->ttl = $ttl; |
|
} |
|
|
|
private function setTTL(string $path) { |
|
if ($this->memcache instanceof IMemcacheTTL) { |
|
$this->memcache->setTTL($path, $this->ttl); |
|
} |
|
} |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @return bool |
|
*/ |
|
public function isLocked(string $path, int $type): bool { |
|
$lockValue = $this->memcache->get($path); |
|
if ($type === self::LOCK_SHARED) { |
|
return $lockValue > 0; |
|
} else if ($type === self::LOCK_EXCLUSIVE) { |
|
return $lockValue === 'exclusive'; |
|
} else { |
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @throws \OCP\Lock\LockedException |
|
*/ |
|
public function acquireLock(string $path, int $type) { |
|
if ($type === self::LOCK_SHARED) { |
|
if (!$this->memcache->inc($path)) { |
|
throw new LockedException($path, null, $this->getExistingLockForException($path)); |
|
} |
|
} else { |
|
$this->memcache->add($path, 0); |
|
if (!$this->memcache->cas($path, 0, 'exclusive')) { |
|
throw new LockedException($path, null, $this->getExistingLockForException($path)); |
|
} |
|
} |
|
$this->setTTL($path); |
|
$this->markAcquire($path, $type); |
|
} |
|
|
|
/** |
|
* @param string $path |
|
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
*/ |
|
public function releaseLock(string $path, int $type) { |
|
if ($type === self::LOCK_SHARED) { |
|
$newValue = 0; |
|
if ($this->getOwnSharedLockCount($path) === 1) { |
|
$removed = $this->memcache->cad($path, 1); // if we're the only one having a shared lock we can remove it in one go |
|
if (!$removed) { //someone else also has a shared lock, decrease only |
|
$newValue = $this->memcache->dec($path); |
|
} |
|
} else { |
|
// if we own more than one lock ourselves just decrease |
|
$newValue = $this->memcache->dec($path); |
|
} |
|
|
|
// if we somehow release more locks then exists, reset the lock |
|
if ($newValue < 0) { |
|
$this->memcache->cad($path, $newValue); |
|
} |
|
} else if ($type === self::LOCK_EXCLUSIVE) { |
|
$this->memcache->cad($path, 'exclusive'); |
|
} |
|
$this->markRelease($path, $type); |
|
} |
|
|
|
/** |
|
* Change the type of an existing lock |
|
* |
|
* @param string $path |
|
* @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE |
|
* @throws \OCP\Lock\LockedException |
|
*/ |
|
public function changeLock(string $path, int $targetType) { |
|
if ($targetType === self::LOCK_SHARED) { |
|
if (!$this->memcache->cas($path, 'exclusive', 1)) { |
|
throw new LockedException($path, null, $this->getExistingLockForException($path)); |
|
} |
|
} else if ($targetType === self::LOCK_EXCLUSIVE) { |
|
// we can only change a shared lock to an exclusive if there's only a single owner of the shared lock |
|
if (!$this->memcache->cas($path, 1, 'exclusive')) { |
|
throw new LockedException($path, null, $this->getExistingLockForException($path)); |
|
} |
|
} |
|
$this->setTTL($path); |
|
$this->markChange($path, $targetType); |
|
} |
|
|
|
private function getExistingLockForException($path) { |
|
$existing = $this->memcache->get($path); |
|
if (!$existing) { |
|
return 'none'; |
|
} else if ($existing === 'exclusive') { |
|
return $existing; |
|
} else { |
|
return $existing . ' shared locks'; |
|
} |
|
} |
|
}
|
|
|