Merge pull request #12577 from owncloud/public-mount-api

Add a public api for apps to add mounts

5 files changed, 152 insertions, 0 deletions

diff --git a/lib/public/files/config/imountprovider.php b/lib/public/files/config/imountprovider.php
new file mode 100644
index 00000000000..5a39e6c8948
--- /dev/null
+++ b/lib/public/files/config/imountprovider.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\Files\Config;
+
+use OCP\Files\Storage\IStorageFactory;
+use OCP\IUser;
+
+/**
+ * Provides
+ */
+interface IMountProvider {
+	/**
+	 * Get all mountpoints applicable for the user
+	 *
+	 * @param \OCP\IUser $user
+	 * @param \OCP\Files\Storage\IStorageFactory $loader
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function getMountsForUser(IUser $user, IStorageFactory $loader);
+}
diff --git a/lib/public/files/config/imountprovidercollection.php b/lib/public/files/config/imountprovidercollection.php
new file mode 100644
index 00000000000..52797414ab9
--- /dev/null
+++ b/lib/public/files/config/imountprovidercollection.php
@@ -0,0 +1,31 @@
+<?php
+/**
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\Files\Config;
+
+use OCP\IUser;
+
+/**
+ * Manages the different mount providers
+ */
+interface IMountProviderCollection {
+	/**
+	 * Get all configured mount points for the user
+	 *
+	 * @param \OCP\IUser $user
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 */
+	public function getMountsForUser(IUser $user);
+
+	/**
+	 * Add a provider for mount points
+	 *
+	 * @param \OCP\Files\Config\IMountProvider $provider
+	 */
+	public function registerProvider(IMountProvider $provider);
+}
diff --git a/lib/public/files/mount/imountpoint.php b/lib/public/files/mount/imountpoint.php
new file mode 100644
index 00000000000..dac634bae4c
--- /dev/null
+++ b/lib/public/files/mount/imountpoint.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\Files\Mount;
+
+/**
+ * A storage mounted to folder on the filesystem
+ */
+interface IMountPoint {
+
+	/**
+	 * get complete path to the mount point
+	 *
+	 * @return string
+	 */
+	public function getMountPoint();
+
+	/**
+	 * Set the mountpoint
+	 *
+	 * @param string $mountPoint new mount point
+	 */
+	public function setMountPoint($mountPoint);
+
+	/**
+	 * Get the storage that is mounted
+	 *
+	 * @return \OC\Files\Storage\Storage
+	 */
+	public function getStorage();
+
+	/**
+	 * Get the id of the storages
+	 *
+	 * @return string
+	 */
+	public function getStorageId();
+
+	/**
+	 * Get the path relative to the mountpoint
+	 *
+	 * @param string $path absolute path to a file or folder
+	 * @return string
+	 */
+	public function getInternalPath($path);
+
+	/**
+	 * Apply a storage wrapper to the mounted storage
+	 *
+	 * @param callable $wrapper
+	 */
+	public function wrapStorage($wrapper);
+}
diff --git a/lib/public/files/storage/istoragefactory.php b/lib/public/files/storage/istoragefactory.php
new file mode 100644
index 00000000000..769d7011de4
--- /dev/null
+++ b/lib/public/files/storage/istoragefactory.php
@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright (c) 2012 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\Files\Storage;
+
+/**
+ * Creates storage instances and manages and applies storage wrappers
+ */
+interface IStorageFactory {
+	/**
+	 * allow modifier storage behaviour by adding wrappers around storages
+	 *
+	 * $callback should be a function of type (string $mountPoint, Storage $storage) => Storage
+	 *
+	 * @param string $wrapperName
+	 * @param callable $callback
+	 */
+	public function addStorageWrapper($wrapperName, $callback);
+
+	/**
+	 * @param string|boolean $mountPoint
+	 * @param string $class
+	 * @param array $arguments
+	 * @return \OCP\Files\Storage
+	 */
+	public function getInstance($mountPoint, $class, $arguments);
+}
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 301f47c68fa..657c9be423b 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -305,4 +305,9 @@ interface IServerContainer {
 	 * @return string
 	 */
 	function getWebRoot();
+
+	/**
+	 * @return \OCP\Files\Config\IMountProviderCollection
+	 */
+	function getMountProviderCollection();
 }