Move \OCP\Files to PSR-4

5 files changed, 325 insertions, 0 deletions

diff --git a/lib/public/Files/Config/ICachedMountInfo.php b/lib/public/Files/Config/ICachedMountInfo.php
new file mode 100644
index 00000000000..e09c1a7f014
--- /dev/null
+++ b/lib/public/Files/Config/ICachedMountInfo.php
@@ -0,0 +1,62 @@
+<?php
+/**
+ * @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\Files\Config;
+
+use OCP\Files\Node;
+use OCP\IUser;
+
+/**
+ * Holds information about a mount for a user
+ *
+ * @since 9.0.0
+ */
+interface ICachedMountInfo {
+	/**
+	 * @return IUser
+	 * @since 9.0.0
+	 */
+	public function getUser();
+
+	/**
+	 * @return int the numeric storage id of the mount
+	 * @since 9.0.0
+	 */
+	public function getStorageId();
+
+	/**
+	 * @return int the fileid of the root of the mount
+	 * @since 9.0.0
+	 */
+	public function getRootId();
+
+	/**
+	 * @return Node the root node of the mount
+	 * @since 9.0.0
+	 */
+	public function getMountPointNode();
+
+	/**
+	 * @return string the mount point of the mount for the user
+	 * @since 9.0.0
+	 */
+	public function getMountPoint();
+}
diff --git a/lib/public/Files/Config/IHomeMountProvider.php b/lib/public/Files/Config/IHomeMountProvider.php
new file mode 100644
index 00000000000..bedcd3cfacc
--- /dev/null
+++ b/lib/public/Files/Config/IHomeMountProvider.php
@@ -0,0 +1,43 @@
+<?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\Files\Config;
+
+use OCP\Files\Storage\IStorageFactory;
+use OCP\IUser;
+
+/**
+ * Provides
+ *
+ * @since 9.1.0
+ */
+interface IHomeMountProvider {
+	/**
+	 * Get all mountpoints applicable for the user
+	 *
+	 * @param \OCP\IUser $user
+	 * @param \OCP\Files\Storage\IStorageFactory $loader
+	 * @return \OCP\Files\Mount\IMountPoint|null
+	 * @since 9.1.0
+	 */
+	public function getHomeMountForUser(IUser $user, IStorageFactory $loader);
+}
diff --git a/lib/public/Files/Config/IMountProvider.php b/lib/public/Files/Config/IMountProvider.php
new file mode 100644
index 00000000000..d1498fd5f61
--- /dev/null
+++ b/lib/public/Files/Config/IMountProvider.php
@@ -0,0 +1,42 @@
+<?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\Files\Config;
+
+use OCP\Files\Storage\IStorageFactory;
+use OCP\IUser;
+
+/**
+ * Provides
+ * @since 8.0.0
+ */
+interface IMountProvider {
+	/**
+	 * Get all mountpoints applicable for the user
+	 *
+	 * @param \OCP\IUser $user
+	 * @param \OCP\Files\Storage\IStorageFactory $loader
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.0.0
+	 */
+	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..29208cb6f53
--- /dev/null
+++ b/lib/public/Files/Config/IMountProviderCollection.php
@@ -0,0 +1,74 @@
+<?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\Files\Config;
+
+use OCP\Files\Mount\IMountPoint;
+use OCP\IUser;
+
+/**
+ * Manages the different mount providers
+ * @since 8.0.0
+ */
+interface IMountProviderCollection {
+	/**
+	 * Get all configured mount points for the user
+	 *
+	 * @param \OCP\IUser $user
+	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @since 8.0.0
+	 */
+	public function getMountsForUser(IUser $user);
+
+	/**
+	 * Get the configured home mount for this user
+	 *
+	 * @param \OCP\IUser $user
+	 * @return \OCP\Files\Mount\IMountPoint
+	 * @since 9.1.0
+	 */
+	public function getHomeMountForUser(IUser $user);
+
+	/**
+	 * Add a provider for mount points
+	 *
+	 * @param \OCP\Files\Config\IMountProvider $provider
+	 * @since 8.0.0
+	 */
+	public function registerProvider(IMountProvider $provider);
+
+	/**
+	 * Add a provider for home mount points
+	 *
+	 * @param \OCP\Files\Config\IHomeMountProvider $provider
+	 * @since 9.1.0
+	 */
+	public function registerHomeProvider(IHomeMountProvider $provider);
+
+	/**
+	 * Get the mount cache which can be used to search for mounts without setting up the filesystem
+	 *
+	 * @return IUserMountCache
+	 * @since 9.0.0
+	 */
+	public function getMountCache();
+}
diff --git a/lib/public/Files/Config/IUserMountCache.php b/lib/public/Files/Config/IUserMountCache.php
new file mode 100644
index 00000000000..2f2c11da1a0
--- /dev/null
+++ b/lib/public/Files/Config/IUserMountCache.php
@@ -0,0 +1,104 @@
+<?php
+/**
+ * @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\Files\Config;
+
+use OCP\Files\Mount\IMountPoint;
+use OCP\IUser;
+
+/**
+ * Cache mounts points per user in the cache so we can easily look them up
+ *
+ * @since 9.0.0
+ */
+interface IUserMountCache {
+	/**
+	 * Register mounts for a user to the cache
+	 *
+	 * @param IUser $user
+	 * @param IMountPoint[] $mounts
+	 * @since 9.0.0
+	 */
+	public function registerMounts(IUser $user, array $mounts);
+
+	/**
+	 * Get all cached mounts for a user
+	 *
+	 * @param IUser $user
+	 * @return ICachedMountInfo[]
+	 * @since 9.0.0
+	 */
+	public function getMountsForUser(IUser $user);
+
+	/**
+	 * Get all cached mounts by storage
+	 *
+	 * @param int $numericStorageId
+	 * @return ICachedMountInfo[]
+	 * @since 9.0.0
+	 */
+	public function getMountsForStorageId($numericStorageId);
+
+	/**
+	 * Get all cached mounts by root
+	 *
+	 * @param int $rootFileId
+	 * @return ICachedMountInfo[]
+	 * @since 9.0.0
+	 */
+	public function getMountsForRootId($rootFileId);
+
+	/**
+	 * Get all cached mounts that contain a file
+	 *
+	 * @param int $fileId
+	 * @return ICachedMountInfo[]
+	 * @since 9.0.0
+	 */
+	public function getMountsForFileId($fileId);
+
+	/**
+	 * Remove all cached mounts for a user
+	 *
+	 * @param IUser $user
+	 * @since 9.0.0
+	 */
+	public function removeUserMounts(IUser $user);
+
+	/**
+	 * Remove all mounts for a user and storage
+	 *
+	 * @param $storageId
+	 * @param string $userId
+	 * @return mixed
+	 * @since 9.0.0
+	 */
+	public function removeUserStorageMount($storageId, $userId);
+
+	/**
+	 * Remove all cached mounts for a storage
+	 *
+	 * @param $storageId
+	 * @return mixed
+	 * @since 9.0.0
+	 */
+	public function remoteStorageMounts($storageId);
+}