nextcloud/lib/private/files/config/usermountcache.php

212 lines
6.8 KiB
PHP
Raw Normal View History

2015-11-26 19:47:53 +03:00
<?php
/**
* @author Robin Appelman <icewind@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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;
2015-12-01 14:41:48 +03:00
use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
2015-11-26 19:47:53 +03:00
use OCP\Files\Config\ICachedMountInfo;
use OCP\Files\Config\IUserMountCache;
use OCP\Files\Mount\IMountPoint;
use OCP\ICache;
use OCP\IDBConnection;
2015-12-01 14:41:48 +03:00
use OCP\ILogger;
2015-11-26 19:47:53 +03:00
use OCP\IUser;
use OCP\IUserManager;
2015-12-02 15:36:33 +03:00
/**
* Cache mounts points per user in the cache so we can easilly look them up
*/
2015-11-26 19:47:53 +03:00
class UserMountCache implements IUserMountCache {
/**
* @var IDBConnection
*/
private $connection;
/**
* @var IUserManager
*/
private $userManager;
/** @var ICachedMountInfo[][] [$userId => [$cachedMountInfo, ....], ...] */
private $mountsForUsers = [];
2015-12-01 14:41:48 +03:00
/**
* @var ILogger
*/
private $logger;
2015-11-26 19:47:53 +03:00
/**
* UserMountCache constructor.
*
* @param IDBConnection $connection
* @param IUserManager $userManager
2015-12-01 14:41:48 +03:00
* @param ILogger $logger
2015-11-26 19:47:53 +03:00
*/
2015-12-01 14:41:48 +03:00
public function __construct(IDBConnection $connection, IUserManager $userManager, ILogger $logger) {
2015-11-26 19:47:53 +03:00
$this->connection = $connection;
$this->userManager = $userManager;
2015-12-01 14:41:48 +03:00
$this->logger = $logger;
2015-11-26 19:47:53 +03:00
}
public function registerMounts(IUser $user, array $mounts) {
2015-12-02 15:36:33 +03:00
// filter out non-proper storages coming from unit tests
2015-11-30 19:29:42 +03:00
$mounts = array_filter($mounts, function (IMountPoint $mount) {
return $mount->getStorage()->getCache();
});
2015-11-26 19:47:53 +03:00
/** @var ICachedMountInfo[] $newMounts */
$newMounts = array_map(function (IMountPoint $mount) use ($user) {
$storage = $mount->getStorage();
$rootId = (int)$storage->getCache()->getId('');
$storageId = (int)$storage->getStorageCache()->getNumericId();
2015-12-02 15:36:33 +03:00
// filter out any storages which aren't scanned yet since we aren't interested in files from those storages (yet)
2015-11-30 19:29:42 +03:00
if ($rootId === -1) {
return null;
} else {
return new CachedMountInfo($user, $storageId, $rootId, $mount->getMountPoint());
}
2015-11-26 19:47:53 +03:00
}, $mounts);
2015-11-30 19:29:42 +03:00
$newMounts = array_values(array_filter($newMounts));
2015-11-26 19:47:53 +03:00
2015-12-02 15:36:33 +03:00
$cachedMounts = $this->getMountsForUser($user);
2015-11-26 19:47:53 +03:00
$mountDiff = function (ICachedMountInfo $mount1, ICachedMountInfo $mount2) {
2015-12-02 15:36:33 +03:00
// since we are only looking for mounts for a specific user comparing on root id is enough
2015-11-26 19:47:53 +03:00
return $mount1->getRootId() - $mount2->getRootId();
};
/** @var ICachedMountInfo[] $addedMounts */
$addedMounts = array_udiff($newMounts, $cachedMounts, $mountDiff);
/** @var ICachedMountInfo[] $removedMounts */
$removedMounts = array_udiff($cachedMounts, $newMounts, $mountDiff);
foreach ($addedMounts as $mount) {
$this->addToCache($mount);
$this->mountsForUsers[$user->getUID()][] = $mount;
}
foreach ($removedMounts as $mount) {
$this->removeFromCache($mount);
2015-12-02 15:36:33 +03:00
$index = array_search($mount, $this->mountsForUsers[$user->getUID()]);
unset($this->mountsForUsers[$user->getUID()][$index]);
2015-11-26 19:47:53 +03:00
}
}
private function addToCache(ICachedMountInfo $mount) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->insert('mounts')
->values([
'storage_id' => ':storage',
'root_id' => ':root',
'user_id' => ':user',
'mount_point' => ':mount'
]);
$query->setParameters([
':storage' => $mount->getStorageId(),
':root' => $mount->getRootId(),
':user' => $mount->getUser()->getUID(),
':mount' => $mount->getMountPoint()
]);
2015-12-01 14:41:48 +03:00
try {
$query->execute();
} catch (UniqueConstraintViolationException $e) {
// seems to mainly happen in tests
2015-12-02 15:36:33 +03:00
// can also happen during concurrent access but we can safely ignore it
// since inserting the same data twice will still result in the correct data being inserted
2015-12-01 14:41:48 +03:00
$this->logger->error('Duplicate entry while inserting mount');
$this->logger->logException($e);
}
2015-11-26 19:47:53 +03:00
}
private function removeFromCache(ICachedMountInfo $mount) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->delete('mounts')
->where($builder->expr()->eq('user_id', $builder->createNamedParameter($mount->getUser()->getUID())))
->andWhere($builder->expr()->eq('root_id', $builder->createNamedParameter($mount->getRootId(), \PDO::PARAM_INT)));
$query->execute();
}
private function dbRowToMountInfo(array $row) {
$user = $this->userManager->get($row['user_id']);
return new CachedMountInfo($user, (int)$row['storage_id'], (int)$row['root_id'], $row['mount_point']);
}
/**
* @param IUser $user
* @return ICachedMountInfo[]
*/
public function getMountsForUser(IUser $user) {
2015-12-02 15:36:33 +03:00
if (!isset($this->mountsForUsers[$user->getUID()])) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
->from('mounts')
->where($builder->expr()->eq('user_id', $builder->createPositionalParameter($user->getUID())));
2015-11-26 19:47:53 +03:00
2015-12-02 15:36:33 +03:00
$rows = $query->execute()->fetchAll();
2015-11-26 19:47:53 +03:00
2015-12-02 15:36:33 +03:00
$this->mountsForUsers[$user->getUID()] = array_map([$this, 'dbRowToMountInfo'], $rows);
}
return $this->mountsForUsers[$user->getUID()];
2015-11-26 19:47:53 +03:00
}
/**
* @param int $numericStorageId
* @return CachedMountInfo[]
*/
public function getMountsForStorageId($numericStorageId) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
->from('mounts')
->where($builder->expr()->eq('storage_id', $builder->createPositionalParameter($numericStorageId, \PDO::PARAM_INT)));
$rows = $query->execute()->fetchAll();
return array_map([$this, 'dbRowToMountInfo'], $rows);
}
/**
* @param int $rootFileId
* @return CachedMountInfo[]
*/
public function getMountsForRootId($rootFileId) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->select('storage_id', 'root_id', 'user_id', 'mount_point')
->from('mounts')
->where($builder->expr()->eq('root_id', $builder->createPositionalParameter($rootFileId, \PDO::PARAM_INT)));
$rows = $query->execute()->fetchAll();
return array_map([$this, 'dbRowToMountInfo'], $rows);
}
2015-12-03 16:10:05 +03:00
/**
* Remove all cached mounts for a user
*
* @param IUser $user
*/
public function removeUserMounts(IUser $user) {
$builder = $this->connection->getQueryBuilder();
$query = $builder->delete('mounts')
->where($builder->expr()->eq('user_id', $builder->createNamedParameter($user->getUID())));
$query->execute();
}
2015-11-26 19:47:53 +03:00
}