feat: Add new methods to list distinct mounts and retrieve all files in a mount

lib/private/Files/Cache/FileAccess.php

@@ -10,6 +10,7 @@
 
 use OC\FilesMetadata\FilesMetadataManager;
 use OC\SystemConfig;
+use OCP\DB\Exception;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\Cache\IFileAccess;
 use OCP\Files\IMimeTypeLoader;
@@ -94,4 +95,128 @@ public function getByFileIdsInStorage(array $fileIds, int $storageId): array {
 		$rows = $query->executeQuery()->fetchAll();
 		return $this->rowsToEntries($rows);
 	}
+
+	public function getByAncestorInStorage(int $storageId, int $folderId, int $fileIdCursor = 0, int $maxResults = 100, array $mimeTypeIds = [], bool $endToEndEncrypted = true, bool $serverSideEncrypted = true): \Generator {
+		$qb = $this->getQuery();
+		$qb->select('path')
+			->from('filecache')
+			->where($qb->expr()->eq('fileid', $qb->createNamedParameter($folderId, IQueryBuilder::PARAM_INT)));
+		$result = $qb->executeQuery();
+		/** @var array{path:string}|false $root */
+		$root = $result->fetch();
+		$result->closeCursor();
+
+		if ($root === false) {
+			throw new Exception('Could not fetch storage root');
+		}
+
+		$qb = $this->getQuery();
+
+		$path = $root['path'] === '' ? '' : $root['path'] . '/';
+
+		$qb->selectDistinct('*')
+			->from('filecache', 'f')
+			->where($qb->expr()->like('f.path', $qb->createNamedParameter($this->connection->escapeLikeParameter($path) . '%')))
+			->andWhere($qb->expr()->eq('f.storage', $qb->createNamedParameter($storageId)))
+			->andWhere($qb->expr()->gt('f.fileid', $qb->createNamedParameter($fileIdCursor, IQueryBuilder::PARAM_INT)));
+
+		if (!$endToEndEncrypted) {
+			// End to end encrypted files are descendants of a folder with encrypted=1
+			// Use a subquery to check the `encrypted` status of the parent folder
+			$subQuery = $this->getQuery()->select('p.encrypted')
+				->from('filecache', 'p')
+				->andWhere($qb->expr()->eq('p.fileid', 'f.parent'))
+				->getSQL();
+
+			$qb->andWhere(
+				$qb->expr()->eq($qb->createFunction(sprintf('(%s)', $subQuery)), $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT))
+			);
+		}
+
+		if (!$serverSideEncrypted) {
+			// Server side encrypted files have encrypted=1 directly
+			$qb->andWhere($qb->expr()->eq('f.encrypted', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)));
+		}
+
+		if (count($mimeTypeIds) > 0) {
+			$qb->andWhere($qb->expr()->in('f.mimetype', $qb->createNamedParameter($mimeTypeIds, IQueryBuilder::PARAM_INT_ARRAY)));
+		}
+
+		if ($maxResults !== 0) {
+			$qb->setMaxResults($maxResults);
+		}
+		$qb->orderBy('f.fileid', 'ASC');
+		$files = $qb->executeQuery();
+
+		while (
+			/** @var array */
+			$row = $files->fetch()
+		) {
+			yield Cache::cacheEntryFromData($row, $this->mimeTypeLoader);
+		}
+
+		$files->closeCursor();
+	}
+
+	public function getDistinctMounts(array $mountProviders = [], bool $onlyUserFilesMounts = true): \Generator {
+		$qb = $this->connection->getQueryBuilder();
+		$qb->selectDistinct(['root_id', 'storage_id', 'mount_provider_class'])
+			->from('mounts');
+		if ($onlyUserFilesMounts) {
+			$qb->andWhere(
+				$qb->expr()->orX(
+					$qb->expr()->like('mount_point', $qb->createNamedParameter('/%/files/%')),
+					$qb->expr()->in('mount_provider_class', $qb->createNamedParameter([
+						\OC\Files\Mount\LocalHomeMountProvider::class,
+						\OC\Files\Mount\ObjectHomeMountProvider::class,
+					], IQueryBuilder::PARAM_STR_ARRAY))
+				)
+			);
+		}
+		if (count($mountProviders) > 0) {
+			$qb->andWhere($qb->expr()->in('mount_provider_class', $qb->createNamedParameter($mountProviders, IQueryBuilder::PARAM_STR_ARRAY)));
+		}
+		$qb->orderBy('root_id', 'ASC');
+		$result = $qb->executeQuery();
+
+		while (
+			/** @var array{storage_id:int, root_id:int,mount_provider_class:string} $row */
+			$row = $result->fetch()
+		) {
+			$storageId = (int)$row['storage_id'];
+			$rootId = (int)$row['root_id'];
+			$overrideRoot = $rootId;
+			// LocalHomeMountProvider is the default provider for user home directories
+			// ObjectHomeMountProvider is the home directory provider for when S3 primary storage is used
+			if ($onlyUserFilesMounts && in_array($row['mount_provider_class'], [
+				\OC\Files\Mount\LocalHomeMountProvider::class,
+				\OC\Files\Mount\ObjectHomeMountProvider::class,
+			], true)) {
+				// Only crawl files, not cache or trashbin
+				$qb = $this->getQuery();
+				try {
+					$qb->select('fileid')
+						->from('filecache')
+						->where($qb->expr()->eq('storage', $qb->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)))
+						->andWhere($qb->expr()->eq('parent', $qb->createNamedParameter($rootId, IQueryBuilder::PARAM_INT)))
+						->andWhere($qb->expr()->eq('path', $qb->createNamedParameter('files')));
+					/** @var array|false $root */
+					$root = $qb->executeQuery()->fetch();
+					if ($root !== false) {
+						$overrideRoot = (int)$root['fileid'];
+					}
+				} catch (Exception $e) {
+					$this->logger->error('Could not fetch home storage files root for storage ' . $storageId, ['exception' => $e]);
+					continue;
+				}
+			}
+			// Reference to root_id is still necessary even if we have the overridden_root_id, because storage_id and root_id uniquely identify a mount
+			yield [
+				'storage_id' => $storageId,
+				'root_id' => $rootId,
+				'overridden_root' => $overrideRoot,
+			];
+		}
+		$result->closeCursor();
+	}
 }

lib/public/Files/Cache/IFileAccess.php

@@ -79,4 +79,36 @@ public function getByFileIds(array $fileIds): array;
 	 * @since 29.0.0
 	 */
 	public function getByFileIdsInStorage(array $fileIds, int $storageId): array;
+
+	/**
+	 * Retrieves files stored in a specific storage that have a specified ancestor in the file hierarchy.
+	 * Allows filtering by mime types, encryption status, and limits the number of results.
+	 *
+	 * @param int $storageId The ID of the storage to search within.
+	 * @param int $folderId The file ID of the ancestor to base the search on.
+	 * @param int $fileIdCursor The last processed file ID. Only files with a higher ID will be included. Defaults to 0.
+	 * @param int $maxResults The maximum number of results to retrieve. If set to 0, all matching files will be retrieved.
+	 * @param list<int> $mimeTypeIds An array of mime types to filter the results. If empty, no mime type filtering will be applied.
+	 * @param bool $endToEndEncrypted Whether to include EndToEndEncrypted files
+	 * @param bool $serverSideEncrypted Whether to include ServerSideEncrypted files
+	 * @return \Generator<ICacheEntry> A generator yielding matching files as cache entries.
+	 * @throws \OCP\DB\Exception
+	 *
+	 * @since 32.0.0
+	 */
+	public function getByAncestorInStorage(int $storageId, int $folderId, int $fileIdCursor = 0, int $maxResults = 100, array $mimeTypeIds = [], bool $endToEndEncrypted = true, bool $serverSideEncrypted = true): \Generator;
+
+	/**
+	 * Retrieves a list of all distinct mounts.
+	 * Allows filtering by specific mount providers.
+	 * Optionally rewrites home directory root paths to avoid cache and trashbin.
+	 *
+	 * @param list<string> $mountProviders An array of mount provider class names to filter. If empty, all providers will be included.
+	 * @param bool $onlyUserFilesMounts Whether to rewrite the root IDs for home directories to only include user files and to only consider mounts with mount points in the user files.
+	 * @return \Generator<array{storage_id: int, root_id: int, overridden_root: int}> A generator yielding mount configurations as an array containing 'storage_id', 'root_id', and 'override_root'.
+	 * @throws \OCP\DB\Exception
+	 *
+	 * @since 32.0.0
+	 */
+	public function getDistinctMounts(array $mountProviders = [], bool $onlyUserFilesMounts = true): \Generator;
 }