129 lines
3 KiB
PHP
129 lines
3 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
||
|
|
*
|
||
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
||
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
||
|
|
* @author Robin Appelman <robin@icewind.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/>
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
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
|
||
|
|
* @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 storages.
|
||
|
|
*
|
||
|
|
* @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;
|
||
|
|
}
|