<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\Files\Config;

use OCP\Files\Cache\ICacheEntry;
use OCP\Files\Mount\IMountPoint;
use OCP\Files\NotFoundException;
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
	 * @param array|null $mountProviderClasses
	 * @since 9.0.0
	 */
	public function registerMounts(IUser $user, array $mounts, ?array $mountProviderClasses = null);

	/**
	 * 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
	 * @param string|null $user limit the results to a single user @since 12.0.0
	 * @return ICachedMountInfo[]
	 * @since 9.0.0
	 */
	public function getMountsForStorageId($numericStorageId, $user = null);

	/**
	 * 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
	 * @param string|null $user optionally restrict the results to a single user @since 12.0.0
	 * @return ICachedMountFileInfo[]
	 * @since 9.0.0
	 */
	public function getMountsForFileId($fileId, $user = null);

	/**
	 * 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);

	/**
	 * Get the used space for users
	 *
	 * Note that this only includes the space in their home directory,
	 * not any incoming shares or external storage.
	 *
	 * @param IUser[] $users
	 * @return int[] [$userId => $userSpace]
	 * @since 13.0.0
	 */
	public function getUsedSpaceForUsers(array $users);

	/**
	 * Clear all entries from the in-memory cache
	 *
	 * @since 20.0.0
	 */
	public function clear(): void;

	/**
	 * Get the cached mount for a path
	 *
	 * This walks up the directly tree until a mount is found, if you only want
	 * to get the mount at the specific path, use `getMountAtPath` instead.
	 *
	 * @param IUser $user
	 * @param string $path
	 * @return ICachedMountInfo
	 * @throws NotFoundException
	 * @since 24.0.0
	 */
	public function getMountForPath(IUser $user, string $path): ICachedMountInfo;

	/**
	 * Get all cached mounts for a user inside a path
	 *
	 * @param IUser $user
	 * @param string $path
	 * @return ICachedMountInfo[]
	 * @throws NotFoundException
	 * @since 24.0.0
	 */
	public function getMountsInPath(IUser $user, string $path): array;

	/**
	 * Remove a mount by it's mountpoint
	 *
	 * @since 33.0.0
	 */
	public function removeMount(string $mountPoint, ?IUser $user = null): void;

	/**
	 * Register a new mountpoint for a user
	 *
	 * @since 33.0.0
	 */
	public function addMount(IUser $user, string $mountPoint, ICacheEntry $rootCacheEntry, string $mountProvider, ?int $mountId = null): void;

	/**
	 * Get the mount at the specified path, if any
	 *
	 * @since 33.0.2
	 */
	public function getMountAtPath(IUser $user, string $mountPoint): ?ICachedMountInfo;
}
