1 files changed, 85 insertions, 79 deletions

diff --git a/lib/private/Files/Config/MountProviderCollection.php b/lib/private/Files/Config/MountProviderCollection.php
index 0e08d9d0e83..9d63184e05f 100644
--- a/lib/private/Files/Config/MountProviderCollection.php
+++ b/lib/private/Files/Config/MountProviderCollection.php
@@ -1,31 +1,15 @@
 <?php
+
 /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
  */
 namespace OC\Files\Config;
 
 use OC\Hooks\Emitter;
 use OC\Hooks\EmitterTrait;
+use OCP\Diagnostics\IEventLogger;
 use OCP\Files\Config\IHomeMountProvider;
 use OCP\Files\Config\IMountProvider;
 use OCP\Files\Config\IMountProviderCollection;
@@ -40,63 +24,65 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 	use EmitterTrait;
 
 	/**
-	 * @var \OCP\Files\Config\IHomeMountProvider[]
+	 * @var list<IHomeMountProvider>
 	 */
-	private $homeProviders = [];
+	private array $homeProviders = [];
 
 	/**
-	 * @var \OCP\Files\Config\IMountProvider[]
+	 * @var list<IMountProvider>
 	 */
-	private $providers = [];
+	private array $providers = [];
 
-	/** @var \OCP\Files\Config\IRootMountProvider[] */
-	private $rootProviders = [];
+	/** @var list<IRootMountProvider> */
+	private array $rootProviders = [];
 
-	/**
-	 * @var \OCP\Files\Storage\IStorageFactory
-	 */
-	private $loader;
+	/** @var list<callable> */
+	private array $mountFilters = [];
 
-	/**
-	 * @var \OCP\Files\Config\IUserMountCache
-	 */
-	private $mountCache;
-
-	/** @var callable[] */
-	private $mountFilters = [];
+	public function __construct(
+		private IStorageFactory $loader,
+		private IUserMountCache $mountCache,
+		private IEventLogger $eventLogger,
+	) {
+	}
 
 	/**
-	 * @param \OCP\Files\Storage\IStorageFactory $loader
-	 * @param IUserMountCache $mountCache
+	 * @return list<IMountPoint>
 	 */
-	public function __construct(IStorageFactory $loader, IUserMountCache $mountCache) {
-		$this->loader = $loader;
-		$this->mountCache = $mountCache;
+	private function getMountsFromProvider(IMountProvider $provider, IUser $user, IStorageFactory $loader): array {
+		$class = str_replace('\\', '_', get_class($provider));
+		$uid = $user->getUID();
+		$this->eventLogger->start('fs:setup:provider:' . $class, "Getting mounts from $class for $uid");
+		$mounts = $provider->getMountsForUser($user, $loader) ?? [];
+		$this->eventLogger->end('fs:setup:provider:' . $class);
+		return array_values($mounts);
 	}
 
 	/**
-	 * @param IUser $user
-	 * @param IMountProvider[] $providers
-	 * @return IMountPoint[]
+	 * @param list<IMountProvider> $providers
+	 * @return list<IMountPoint>
 	 */
 	private function getUserMountsForProviders(IUser $user, array $providers): array {
 		$loader = $this->loader;
 		$mounts = array_map(function (IMountProvider $provider) use ($user, $loader) {
-			return $provider->getMountsForUser($user, $loader);
+			return $this->getMountsFromProvider($provider, $user, $loader);
 		}, $providers);
-		$mounts = array_filter($mounts, function ($result) {
-			return is_array($result);
-		});
 		$mounts = array_reduce($mounts, function (array $mounts, array $providerMounts) {
 			return array_merge($mounts, $providerMounts);
 		}, []);
 		return $this->filterMounts($user, $mounts);
 	}
 
+	/**
+	 * @return list<IMountPoint>
+	 */
 	public function getMountsForUser(IUser $user): array {
 		return $this->getUserMountsForProviders($user, $this->providers);
 	}
 
+	/**
+	 * @return list<IMountPoint>
+	 */
 	public function getUserMountsForProviderClasses(IUser $user, array $mountProviderClasses): array {
 		$providers = array_filter(
 			$this->providers,
@@ -105,7 +91,10 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 		return $this->getUserMountsForProviders($user, $providers);
 	}
 
-	public function addMountForUser(IUser $user, IMountManager $mountManager, callable $providerFilter = null) {
+	/**
+	 * @return list<IMountPoint>
+	 */
+	public function addMountForUser(IUser $user, IMountManager $mountManager, ?callable $providerFilter = null): array {
 		// shared mount provider gets to go last since it needs to know existing files
 		// to check for name collisions
 		$firstMounts = [];
@@ -121,37 +110,32 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 			return (get_class($provider) === 'OCA\Files_Sharing\MountProvider');
 		});
 		foreach ($firstProviders as $provider) {
-			$mounts = $provider->getMountsForUser($user, $this->loader);
-			if (is_array($mounts)) {
-				$firstMounts = array_merge($firstMounts, $mounts);
-			}
+			$mounts = $this->getMountsFromProvider($provider, $user, $this->loader);
+			$firstMounts = array_merge($firstMounts, $mounts);
 		}
 		$firstMounts = $this->filterMounts($user, $firstMounts);
 		array_walk($firstMounts, [$mountManager, 'addMount']);
 
 		$lateMounts = [];
 		foreach ($lastProviders as $provider) {
-			$mounts = $provider->getMountsForUser($user, $this->loader);
-			if (is_array($mounts)) {
-				$lateMounts = array_merge($lateMounts, $mounts);
-			}
+			$mounts = $this->getMountsFromProvider($provider, $user, $this->loader);
+			$lateMounts = array_merge($lateMounts, $mounts);
 		}
 
 		$lateMounts = $this->filterMounts($user, $lateMounts);
+		$this->eventLogger->start('fs:setup:add-mounts', 'Add mounts to the filesystem');
 		array_walk($lateMounts, [$mountManager, 'addMount']);
+		$this->eventLogger->end('fs:setup:add-mounts');
 
-		return array_merge($lateMounts, $firstMounts);
+		return array_values(array_merge($lateMounts, $firstMounts));
 	}
 
 	/**
 	 * 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) {
-		/** @var \OCP\Files\Config\IHomeMountProvider[] $providers */
+	public function getHomeMountForUser(IUser $user): IMountPoint {
 		$providers = array_reverse($this->homeProviders); // call the latest registered provider first to give apps an opportunity to overwrite builtin
 		foreach ($providers as $homeProvider) {
 			if ($mount = $homeProvider->getHomeMountForUser($user, $this->loader)) {
@@ -164,34 +148,36 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 
 	/**
 	 * Add a provider for mount points
-	 *
-	 * @param \OCP\Files\Config\IMountProvider $provider
 	 */
-	public function registerProvider(IMountProvider $provider) {
+	public function registerProvider(IMountProvider $provider): void {
 		$this->providers[] = $provider;
 
 		$this->emit('\OC\Files\Config', 'registerMountProvider', [$provider]);
 	}
 
-	public function registerMountFilter(callable $filter) {
+	public function registerMountFilter(callable $filter): void {
 		$this->mountFilters[] = $filter;
 	}
 
-	private function filterMounts(IUser $user, array $mountPoints) {
-		return array_filter($mountPoints, function (IMountPoint $mountPoint) use ($user) {
+	/**
+	 * @param list<IMountPoint> $mountPoints
+	 * @return list<IMountPoint>
+	 */
+	private function filterMounts(IUser $user, array $mountPoints): array {
+		return array_values(array_filter($mountPoints, function (IMountPoint $mountPoint) use ($user) {
 			foreach ($this->mountFilters as $filter) {
 				if ($filter($mountPoint, $user) === false) {
 					return false;
 				}
 			}
 			return true;
-		});
+		}));
 	}
 
 	/**
 	 * Add a provider for home mount points
 	 *
-	 * @param \OCP\Files\Config\IHomeMountProvider $provider
+	 * @param IHomeMountProvider $provider
 	 * @since 9.1.0
 	 */
 	public function registerHomeProvider(IHomeMountProvider $provider) {
@@ -201,21 +187,19 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 
 	/**
 	 * Get the mount cache which can be used to search for mounts without setting up the filesystem
-	 *
-	 * @return IUserMountCache
 	 */
-	public function getMountCache() {
+	public function getMountCache(): IUserMountCache {
 		return $this->mountCache;
 	}
 
-	public function registerRootProvider(IRootMountProvider $provider) {
+	public function registerRootProvider(IRootMountProvider $provider): void {
 		$this->rootProviders[] = $provider;
 	}
 
 	/**
 	 * Get all root mountpoints
 	 *
-	 * @return \OCP\Files\Mount\IMountPoint[]
+	 * @return list<IMountPoint>
 	 * @since 20.0.0
 	 */
 	public function getRootMounts(): array {
@@ -226,16 +210,38 @@ class MountProviderCollection implements IMountProviderCollection, Emitter {
 		$mounts = array_reduce($mounts, function (array $mounts, array $providerMounts) {
 			return array_merge($mounts, $providerMounts);
 		}, []);
-		return $mounts;
+
+		if (count($mounts) === 0) {
+			throw new \Exception('No root mounts provided by any provider');
+		}
+
+		return array_values($mounts);
 	}
 
-	public function clearProviders() {
+	public function clearProviders(): void {
 		$this->providers = [];
 		$this->homeProviders = [];
 		$this->rootProviders = [];
 	}
 
+	/**
+	 * @return list<IMountProvider>
+	 */
 	public function getProviders(): array {
 		return $this->providers;
 	}
+
+	/**
+	 * @return list<IHomeMountProvider>
+	 */
+	public function getHomeProviders(): array {
+		return $this->homeProviders;
+	}
+
+	/**
+	 * @return list<IRootMountProvider>
+	 */
+	public function getRootProviders(): array {
+		return $this->rootProviders;
+	}
 }