Move \OCP\Lock to PSR-4

2 files changed, 140 insertions, 0 deletions

diff --git a/lib/public/Lock/ILockingProvider.php b/lib/public/Lock/ILockingProvider.php
new file mode 100644
index 00000000000..b4b579bbc7a
--- /dev/null
+++ b/lib/public/Lock/ILockingProvider.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, 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 <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Lock;
+
+/**
+ * Interface ILockingProvider
+ *
+ * @package OCP\Lock
+ * @since 8.1.0
+ */
+interface ILockingProvider {
+	/**
+	 * @since 8.1.0
+	 */
+	const LOCK_SHARED = 1;
+	/**
+	 * @since 8.1.0
+	 */
+	const LOCK_EXCLUSIVE = 2;
+
+	/**
+	 * @param string $path
+	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+	 * @return bool
+	 * @since 8.1.0
+	 */
+	public function isLocked($path, $type);
+
+	/**
+	 * @param string $path
+	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+	 * @throws \OCP\Lock\LockedException
+	 * @since 8.1.0
+	 */
+	public function acquireLock($path, $type);
+
+	/**
+	 * @param string $path
+	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+	 * @since 8.1.0
+	 */
+	public function releaseLock($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
+	 * @since 8.1.0
+	 */
+	public function changeLock($path, $targetType);
+
+	/**
+	 * release all lock acquired by this instance
+	 * @since 8.1.0
+	 */
+	public function releaseAll();
+}
diff --git a/lib/public/Lock/LockedException.php b/lib/public/Lock/LockedException.php
new file mode 100644
index 00000000000..d084046046e
--- /dev/null
+++ b/lib/public/Lock/LockedException.php
@@ -0,0 +1,61 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Vincent Petry <pvince81@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, 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 <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Lock;
+
+/**
+ * Class LockedException
+ *
+ * @package OCP\Lock
+ * @since 8.1.0
+ */
+class LockedException extends \Exception {
+
+	/**
+	 * Locked path
+	 *
+	 * @var string
+	 */
+	private $path;
+
+	/**
+	 * LockedException constructor.
+	 *
+	 * @param string $path locked path
+	 * @param \Exception $previous previous exception for cascading
+	 *
+	 * @since 8.1.0
+	 */
+	public function __construct($path, \Exception $previous = null) {
+		parent::__construct('"' . $path . '" is locked', 0, $previous);
+		$this->path = $path;
+	}
+
+	/**
+	 * @return string
+	 * @since 8.1.0
+	 */
+	public function getPath() {
+		return $this->path;
+	}
+}