diff options
author | ringmaster <epithet@gmail.com> | 2014-05-20 17:44:57 -0400 |
---|---|---|
committer | Thomas Müller <thomas.mueller@tmit.eu> | 2014-06-04 07:55:44 +0200 |
commit | 5365ae416ec1a2c1dd868707cbb01f50bbe9027d (patch) | |
tree | 09b8a89846594eedbb14adb4f5ae31204205c912 /lib/public | |
parent | 3a1994d00149bea6d554c96a3bdee3126cfb17b8 (diff) | |
download | nextcloud-server-5365ae416ec1a2c1dd868707cbb01f50bbe9027d.tar.gz nextcloud-server-5365ae416ec1a2c1dd868707cbb01f50bbe9027d.zip |
flock changes. Work in progress.
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/files/lock.php | 48 | ||||
-rw-r--r-- | lib/public/files/locknotacquiredexception.php | 47 | ||||
-rw-r--r-- | lib/public/files/storage.php | 1 |
3 files changed, 96 insertions, 0 deletions
diff --git a/lib/public/files/lock.php b/lib/public/files/lock.php new file mode 100644 index 00000000000..fb1e4b9f1c5 --- /dev/null +++ b/lib/public/files/lock.php @@ -0,0 +1,48 @@ +<?php +/** + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE + * License as published by the Free Software Foundation; either + * version 3 of the License, or any later version. + * + * This library 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 library. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Files; + +/** + * Class Lock + * @package OC\Files + */ +class Lock { + const READ = 1; + const WRITE = 2; + + /** @var string $path Filename of the file as represented in storage */ + protected $path; + + public function __construct($path) { + $this->path = $path; + } + + public function addLock($lockType) { + // This class is a stub/base for classes that implement locks + // We don't actually care what kind of lock we're queuing here + } + + /** + * Release locks on handles and files + */ + public function release($lockType) { + return true; + } + +}
\ No newline at end of file diff --git a/lib/public/files/locknotacquiredexception.php b/lib/public/files/locknotacquiredexception.php new file mode 100644 index 00000000000..9fb70e7cbe2 --- /dev/null +++ b/lib/public/files/locknotacquiredexception.php @@ -0,0 +1,47 @@ +<?php +/** + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE + * License as published by the Free Software Foundation; either + * version 3 of the License, or any later version. + * + * This library 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 library. If not, see <http://www.gnu.org/licenses/>. + * + */ + +/** + * Public interface of ownCloud for apps to use. + * Files/LockNotAcquiredException class + */ + +// use OCP namespace for all classes that are considered public. +// This means that they should be used by apps instead of the internal ownCloud classes +namespace OCP\Files; + +/** + * Exception for a file that is locked + */ +class LockNotAcquiredException extends \Exception { + /** @var string $path The path that could not be locked */ + public $path; + + /** @var integer $lockType The type of the lock that was attempted */ + public $lockType; + + public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { + $message = \OC_L10N::get('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); + parent::__construct($message, $code, $previous); + } + + // custom string representation of object + public function __toString() { + return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; + } +}
\ No newline at end of file diff --git a/lib/public/files/storage.php b/lib/public/files/storage.php index 323d20db564..758cbb27377 100644 --- a/lib/public/files/storage.php +++ b/lib/public/files/storage.php @@ -35,6 +35,7 @@ namespace OCP\Files; * All paths passed to the storage are relative to the storage and should NOT have a leading slash. */ interface Storage { + /** * $parameters is a free form array with the configuration options needed to construct the storage * |