add locking to the storage api

This commit is contained in:
Robin Appelman 2015-05-04 14:21:34 +02:00
parent cdf7f91259
commit 536e187e51
6 changed files with 117 additions and 0 deletions

View File

@ -31,6 +31,9 @@ namespace OC\Files\Storage;
use OC\Files\Filesystem; use OC\Files\Filesystem;
use OCA\Files_Sharing\ISharedStorage; use OCA\Files_Sharing\ISharedStorage;
use OCA\Files_Sharing\Propagator;
use OCA\Files_Sharing\SharedMount;
use OCP\Lock\ILockingProvider;
/** /**
* Convert target path to source path and pass the function call to the correct storage provider * Convert target path to source path and pass the function call to the correct storage provider
@ -608,4 +611,27 @@ class Shared extends \OC\Files\Storage\Common implements ISharedStorage {
list($targetStorage, $targetInternalPath) = $this->resolvePath($targetInternalPath); list($targetStorage, $targetInternalPath) = $this->resolvePath($targetInternalPath);
return $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); return $targetStorage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
} }
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider) {
/** @var \OCP\Files\Storage $targetStorage */
list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
$targetStorage->acquireLock($targetInternalPath, $type, $provider);
}
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider) {
/** @var \OCP\Files\Storage $targetStorage */
list($targetStorage, $targetInternalPath) = $this->resolvePath($path);
$targetStorage->releaseLock($targetInternalPath, $type, $provider);
}
} }

View File

@ -43,6 +43,7 @@ use OCP\Files\FileNameTooLongException;
use OCP\Files\InvalidCharacterInPathException; use OCP\Files\InvalidCharacterInPathException;
use OCP\Files\InvalidPathException; use OCP\Files\InvalidPathException;
use OCP\Files\ReservedWordException; use OCP\Files\ReservedWordException;
use OCP\Lock\ILockingProvider;
/** /**
* Storage backend class for providing common filesystem operation methods * Storage backend class for providing common filesystem operation methods
@ -621,4 +622,23 @@ abstract class Common implements Storage {
return $data; return $data;
} }
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider) {
$provider->acquireLock($this->getId() . '::' . $path, $type);
}
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider) {
$provider->releaseLock($this->getId() . '::' . $path, $type);
}
} }

View File

@ -21,6 +21,7 @@
*/ */
namespace OC\Files\Storage; namespace OC\Files\Storage;
use OCP\Lock\ILockingProvider;
/** /**
* Provide a common interface to all different storage options * Provide a common interface to all different storage options
@ -76,4 +77,18 @@ interface Storage extends \OCP\Files\Storage {
*/ */
public function getMetaData($path); public function getMetaData($path);
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider);
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider);
} }

View File

@ -23,6 +23,7 @@
namespace OC\Files\Storage\Wrapper; namespace OC\Files\Storage\Wrapper;
use OC\Files\Cache\Wrapper\CacheJail; use OC\Files\Cache\Wrapper\CacheJail;
use OCP\Lock\ILockingProvider;
/** /**
* Jail to a subdirectory of the wrapped storage * Jail to a subdirectory of the wrapped storage
@ -424,4 +425,23 @@ class Jail extends Wrapper {
public function getETag($path) { public function getETag($path) {
return $this->storage->getETag($this->getSourcePath($path)); return $this->storage->getETag($this->getSourcePath($path));
} }
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider) {
$this->storage->acquireLock($this->getSourcePath($path), $type, $provider);
}
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider) {
$this->storage->releaseLock($this->getSourcePath($path), $type, $provider);
}
} }

View File

@ -25,6 +25,7 @@
namespace OC\Files\Storage\Wrapper; namespace OC\Files\Storage\Wrapper;
use OCP\Files\InvalidPathException; use OCP\Files\InvalidPathException;
use OCP\Lock\ILockingProvider;
class Wrapper implements \OC\Files\Storage\Storage { class Wrapper implements \OC\Files\Storage\Storage {
/** /**
@ -541,4 +542,23 @@ class Wrapper implements \OC\Files\Storage\Storage {
public function getMetaData($path) { public function getMetaData($path) {
return $this->storage->getMetaData($path); return $this->storage->getMetaData($path);
} }
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider) {
$this->storage->acquireLock($path, $type, $provider);
}
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider) {
$this->storage->releaseLock($path, $type, $provider);
}
} }

View File

@ -33,6 +33,7 @@
// This means that they should be used by apps instead of the internal ownCloud classes // This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP\Files; namespace OCP\Files;
use OCP\Files\InvalidPathException; use OCP\Files\InvalidPathException;
use OCP\Lock\ILockingProvider;
/** /**
* Provide a common interface to all different storage options * Provide a common interface to all different storage options
@ -413,4 +414,19 @@ interface Storage {
* @since 8.1.0 * @since 8.1.0
*/ */
public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath); public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath);
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
* @throws \OCP\Lock\LockedException
*/
public function acquireLock($path, $type, ILockingProvider $provider);
/**
* @param string $path
* @param int $type \OCP\Lock\ILockingProvider::LOCK_SHARED or \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE
* @param \OCP\Lock\ILockingProvider $provider
*/
public function releaseLock($path, $type, ILockingProvider $provider);
} }