226 lines
6.6 KiB
PHP
226 lines
6.6 KiB
PHP
<?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/>
|
|
*
|
|
*/
|
|
|
|
namespace OC\Files\Config;
|
|
|
|
use OC\Hooks\Emitter;
|
|
use OC\Hooks\EmitterTrait;
|
|
use OCP\Files\Config\IHomeMountProvider;
|
|
use OCP\Files\Config\IMountProvider;
|
|
use OCP\Files\Config\IMountProviderCollection;
|
|
use OCP\Files\Config\IRootMountProvider;
|
|
use OCP\Files\Config\IUserMountCache;
|
|
use OCP\Files\Mount\IMountManager;
|
|
use OCP\Files\Mount\IMountPoint;
|
|
use OCP\Files\Storage\IStorageFactory;
|
|
use OCP\IUser;
|
|
|
|
class MountProviderCollection implements IMountProviderCollection, Emitter {
|
|
use EmitterTrait;
|
|
|
|
/**
|
|
* @var \OCP\Files\Config\IHomeMountProvider[]
|
|
*/
|
|
private $homeProviders = [];
|
|
|
|
/**
|
|
* @var \OCP\Files\Config\IMountProvider[]
|
|
*/
|
|
private $providers = [];
|
|
|
|
/** @var \OCP\Files\Config\IRootMountProvider[] */
|
|
private $rootProviders = [];
|
|
|
|
/**
|
|
* @var \OCP\Files\Storage\IStorageFactory
|
|
*/
|
|
private $loader;
|
|
|
|
/**
|
|
* @var \OCP\Files\Config\IUserMountCache
|
|
*/
|
|
private $mountCache;
|
|
|
|
/** @var callable[] */
|
|
private $mountFilters = [];
|
|
|
|
/**
|
|
* @param \OCP\Files\Storage\IStorageFactory $loader
|
|
* @param IUserMountCache $mountCache
|
|
*/
|
|
public function __construct(IStorageFactory $loader, IUserMountCache $mountCache) {
|
|
$this->loader = $loader;
|
|
$this->mountCache = $mountCache;
|
|
}
|
|
|
|
/**
|
|
* Get all configured mount points for the user
|
|
*
|
|
* @param \OCP\IUser $user
|
|
* @return \OCP\Files\Mount\IMountPoint[]
|
|
*/
|
|
public function getMountsForUser(IUser $user) {
|
|
$loader = $this->loader;
|
|
$mounts = array_map(function (IMountProvider $provider) use ($user, $loader) {
|
|
return $provider->getMountsForUser($user, $loader);
|
|
}, $this->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);
|
|
}
|
|
|
|
public function addMountForUser(IUser $user, IMountManager $mountManager) {
|
|
// shared mount provider gets to go last since it needs to know existing files
|
|
// to check for name collisions
|
|
$firstMounts = [];
|
|
$firstProviders = array_filter($this->providers, function (IMountProvider $provider) {
|
|
return (get_class($provider) !== 'OCA\Files_Sharing\MountProvider');
|
|
});
|
|
$lastProviders = array_filter($this->providers, function (IMountProvider $provider) {
|
|
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);
|
|
}
|
|
}
|
|
$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);
|
|
}
|
|
}
|
|
|
|
$lateMounts = $this->filterMounts($user, $lateMounts);
|
|
array_walk($lateMounts, [$mountManager, 'addMount']);
|
|
|
|
return 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 */
|
|
$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)) {
|
|
$mount->setMountPoint('/' . $user->getUID()); //make sure the mountpoint is what we expect
|
|
return $mount;
|
|
}
|
|
}
|
|
throw new \Exception('No home storage configured for user ' . $user);
|
|
}
|
|
|
|
/**
|
|
* Add a provider for mount points
|
|
*
|
|
* @param \OCP\Files\Config\IMountProvider $provider
|
|
*/
|
|
public function registerProvider(IMountProvider $provider) {
|
|
$this->providers[] = $provider;
|
|
|
|
$this->emit('\OC\Files\Config', 'registerMountProvider', [$provider]);
|
|
}
|
|
|
|
public function registerMountFilter(callable $filter) {
|
|
$this->mountFilters[] = $filter;
|
|
}
|
|
|
|
private function filterMounts(IUser $user, array $mountPoints) {
|
|
return 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
|
|
* @since 9.1.0
|
|
*/
|
|
public function registerHomeProvider(IHomeMountProvider $provider) {
|
|
$this->homeProviders[] = $provider;
|
|
$this->emit('\OC\Files\Config', 'registerHomeMountProvider', [$provider]);
|
|
}
|
|
|
|
/**
|
|
* Cache mounts for user
|
|
*
|
|
* @param IUser $user
|
|
* @param IMountPoint[] $mountPoints
|
|
*/
|
|
public function registerMounts(IUser $user, array $mountPoints) {
|
|
$this->mountCache->registerMounts($user, $mountPoints);
|
|
}
|
|
|
|
/**
|
|
* Get the mount cache which can be used to search for mounts without setting up the filesystem
|
|
*
|
|
* @return IUserMountCache
|
|
*/
|
|
public function getMountCache() {
|
|
return $this->mountCache;
|
|
}
|
|
|
|
public function registerRootProvider(IRootMountProvider $provider) {
|
|
$this->rootProviders[] = $provider;
|
|
}
|
|
|
|
/**
|
|
* Get all root mountpoints
|
|
*
|
|
* @return \OCP\Files\Mount\IMountPoint[]
|
|
* @since 20.0.0
|
|
*/
|
|
public function getRootMounts(): array {
|
|
$loader = $this->loader;
|
|
$mounts = array_map(function (IRootMountProvider $provider) use ($loader) {
|
|
return $provider->getRootMounts($loader);
|
|
}, $this->rootProviders);
|
|
$mounts = array_reduce($mounts, function (array $mounts, array $providerMounts) {
|
|
return array_merge($mounts, $providerMounts);
|
|
}, []);
|
|
return $mounts;
|
|
}
|
|
}
|