diff --git a/lib/private/lock/memcachelockingprovider.php b/lib/private/lock/memcachelockingprovider.php new file mode 100644 index 0000000000..43fdf70bc8 --- /dev/null +++ b/lib/private/lock/memcachelockingprovider.php @@ -0,0 +1,86 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OC\Lock; + +use OCP\Lock\ILockingProvider; +use OCP\Lock\LockedException; +use OCP\IMemcache; + +class MemcacheLockingProvider implements ILockingProvider { + /** + * @var \OCP\IMemcache + */ + private $memcache; + + /** + * @param \OCP\IMemcache $memcache + */ + public function __construct(IMemcache $memcache) { + $this->memcache = $memcache; + } + + /** + * @param string $path + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + * @return bool + */ + public function isLocked($path, $type) { + $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($path, $type) { + if ($type === self::LOCK_SHARED) { + if (!$this->memcache->inc($path)) { + throw new LockedException($path . ' is locked'); + } + } else { + $this->memcache->add($path, 0); + if (!$this->memcache->cas($path, 0, 'exclusive')) { + throw new LockedException($path . ' is locked'); + } + } + } + + /** + * @param string $path + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + */ + public function releaseLock($path, $type) { + if ($type === self::LOCK_SHARED) { + $this->memcache->dec($path); + } else if ($type === self::LOCK_EXCLUSIVE) { + $this->memcache->cas($path, 'exclusive', 0); + } + } +} diff --git a/lib/public/lock/ilockingprovider.php b/lib/public/lock/ilockingprovider.php new file mode 100644 index 0000000000..a584ec02ef --- /dev/null +++ b/lib/public/lock/ilockingprovider.php @@ -0,0 +1,47 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Lock; + +interface ILockingProvider { + const LOCK_SHARED = 1; + const LOCK_EXCLUSIVE = 2; + + /** + * @param string $path + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + * @return bool + */ + public function isLocked($path, $type); + + /** + * @param string $path + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + * @throws \OCP\Files\Lock\LockedException + */ + public function acquireLock($path, $type); + + /** + * @param string $path + * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + */ + public function releaseLock($path, $type); +} diff --git a/lib/public/lock/lockedexception.php b/lib/public/lock/lockedexception.php new file mode 100644 index 0000000000..4c0ca9b8c5 --- /dev/null +++ b/lib/public/lock/lockedexception.php @@ -0,0 +1,25 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace OCP\Lock; + +class LockedException extends \Exception { +} diff --git a/tests/lib/lock/lockingprovider.php b/tests/lib/lock/lockingprovider.php new file mode 100644 index 0000000000..e7b8028dc9 --- /dev/null +++ b/tests/lib/lock/lockingprovider.php @@ -0,0 +1,118 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace Test\Lock; + +use OCP\Lock\ILockingProvider; +use Test\TestCase; + +abstract class LockingProvider extends TestCase { + /** + * @var \OCP\Lock\ILockingProvider + */ + protected $instance; + + /** + * @return \OCP\Lock\ILockingProvider + */ + abstract protected function getInstance(); + + protected function setUp() { + parent::setUp(); + $this->instance = $this->getInstance(); + } + + public function testExclusiveLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + } + + public function testSharedLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + } + + public function testDoubleSharedLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + } + + public function testReleaseSharedLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->releaseLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->releaseLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + } + + /** + * @expectedException \OCP\Lock\LockedException + */ + public function testDoubleExclusiveLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + } + + public function testReleaseExclusiveLock() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->instance->releaseLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertFalse($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + } + + /** + * @expectedException \OCP\Lock\LockedException + */ + public function testExclusiveLockAfterShared() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + } + + public function testExclusiveLockAfterSharedReleased() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_SHARED)); + $this->instance->releaseLock('foo', ILockingProvider::LOCK_SHARED); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + } + + + /** + * @expectedException \OCP\Lock\LockedException + */ + public function testSharedLockAfterExclusive() { + $this->instance->acquireLock('foo', ILockingProvider::LOCK_EXCLUSIVE); + $this->assertTrue($this->instance->isLocked('foo', ILockingProvider::LOCK_EXCLUSIVE)); + $this->instance->acquireLock('foo', ILockingProvider::LOCK_SHARED); + } +} diff --git a/tests/lib/lock/memcachelockingprovider.php b/tests/lib/lock/memcachelockingprovider.php new file mode 100644 index 0000000000..40478b2293 --- /dev/null +++ b/tests/lib/lock/memcachelockingprovider.php @@ -0,0 +1,45 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @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 + * + */ + +namespace Test\Lock; + +use OC\Memcache\ArrayCache; + +class MemcacheLockingProvider extends LockingProvider { + + /** + * @var \OCP\IMemcache + */ + private $memcache; + + /** + * @return \OCP\Lock\ILockingProvider + */ + protected function getInstance() { + $this->memcache = new ArrayCache(); + return new \OC\Lock\MemcacheLockingProvider($this->memcache); + } + + public function tearDown() { + $this->memcache->clear(); + parent::tearDown(); + } +}