nextcloud
/
server
mirror of https://github.com/nextcloud/server
0
0
Fork 0
Code Issues Releases Wiki Activity

feat: add interface for lower level filecache acess without having to do direct db queries 

Signed-off-by: Robin Appelman <robin@icewind.nl>
This commit is contained in:
Robin Appelman 2024-03-06 12:30:04 +01:00
parent 46906b7d69
commit 1d9354a81e
No known key found for this signature in database
GPG Key ID: 42B69D8A64526EFB
4 changed files with 219 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/composer/composer/autoload_classmap.php
View File

@ -319,6 +319,7 @@ return array(
'OCP\\Files\\Cache\\ICache' => $baseDir . '/lib/public/Files/Cache/ICache.php',
'OCP\\Files\\Cache\\ICacheEntry' => $baseDir . '/lib/public/Files/Cache/ICacheEntry.php',
'OCP\\Files\\Cache\\ICacheEvent' => $baseDir . '/lib/public/Files/Cache/ICacheEvent.php',
'OCP\\Files\\Cache\\IFileAccess' => $baseDir . '/lib/public/Files/Cache/IFileAccess.php',
'OCP\\Files\\Cache\\IPropagator' => $baseDir . '/lib/public/Files/Cache/IPropagator.php',
'OCP\\Files\\Cache\\IScanner' => $baseDir . '/lib/public/Files/Cache/IScanner.php',
'OCP\\Files\\Cache\\IUpdater' => $baseDir . '/lib/public/Files/Cache/IUpdater.php',
@ -1364,6 +1365,7 @@ return array(
'OC\\Files\\Cache\\CacheEntry' => $baseDir . '/lib/private/Files/Cache/CacheEntry.php',
'OC\\Files\\Cache\\CacheQueryBuilder' => $baseDir . '/lib/private/Files/Cache/CacheQueryBuilder.php',
'OC\\Files\\Cache\\FailedCache' => $baseDir . '/lib/private/Files/Cache/FailedCache.php',
'OC\\Files\\Cache\\FileAccess' => $baseDir . '/lib/private/Files/Cache/FileAccess.php',
'OC\\Files\\Cache\\HomeCache' => $baseDir . '/lib/private/Files/Cache/HomeCache.php',
'OC\\Files\\Cache\\HomePropagator' => $baseDir . '/lib/private/Files/Cache/HomePropagator.php',
'OC\\Files\\Cache\\LocalRootScanner' => $baseDir . '/lib/private/Files/Cache/LocalRootScanner.php',

2
lib/composer/composer/autoload_static.php
View File

@ -352,6 +352,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\Files\\Cache\\ICache' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/ICache.php',
'OCP\\Files\\Cache\\ICacheEntry' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/ICacheEntry.php',
'OCP\\Files\\Cache\\ICacheEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/ICacheEvent.php',
'OCP\\Files\\Cache\\IFileAccess' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/IFileAccess.php',
'OCP\\Files\\Cache\\IPropagator' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/IPropagator.php',
'OCP\\Files\\Cache\\IScanner' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/IScanner.php',
'OCP\\Files\\Cache\\IUpdater' => __DIR__ . '/../../..' . '/lib/public/Files/Cache/IUpdater.php',
@ -1397,6 +1398,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Files\\Cache\\CacheEntry' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/CacheEntry.php',
'OC\\Files\\Cache\\CacheQueryBuilder' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/CacheQueryBuilder.php',
'OC\\Files\\Cache\\FailedCache' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/FailedCache.php',
'OC\\Files\\Cache\\FileAccess' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/FileAccess.php',
'OC\\Files\\Cache\\HomeCache' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/HomeCache.php',
'OC\\Files\\Cache\\HomePropagator' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/HomePropagator.php',
'OC\\Files\\Cache\\LocalRootScanner' => __DIR__ . '/../../..' . '/lib/private/Files/Cache/LocalRootScanner.php',

116
lib/private/Files/Cache/FileAccess.php Normal file
View File

@ -0,0 +1,116 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2024 Robin Appelman <robin@icewind.nl>
*
* @author Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Files\Cache;
use OC\FilesMetadata\FilesMetadataManager;
use OC\SystemConfig;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\Files\Cache\IFileAccess;
use OCP\Files\IMimeTypeLoader;
use OCP\IDBConnection;
use Psr\Log\LoggerInterface;
/**
* Low level access to the file cache
*/
class FileAccess implements IFileAccess {
public function __construct(
private IDBConnection $connection,
private SystemConfig $systemConfig,
private LoggerInterface $logger,
private FilesMetadataManager $metadataManager,
private IMimeTypeLoader $mimeTypeLoader,
) {
}
private function getQuery(): CacheQueryBuilder {
return new CacheQueryBuilder(
$this->connection,
$this->systemConfig,
$this->logger,
$this->metadataManager,
);
}
public function getByFileIdInStorage(int $fileId, int $storageId): ?CacheEntry {
$items = $this->getByFileIdsInStorage([$fileId], $storageId);
return $items[0] ?? null;
}
public function getByPathInStorage(string $path, int $storageId): ?CacheEntry {
$query = $this->getQuery()->selectFileCache();
$query->andWhere($query->expr()->eq('filecache.path_hash', $query->createNamedParameter(md5($path))));
$query->andWhere($query->expr()->eq('filecache.storage', $query->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
$row = $query->executeQuery()->fetch();
return $row ? Cache::cacheEntryFromData($row, $this->mimeTypeLoader) : null;
}
public function getByFileId(int $fileId): ?CacheEntry {
$items = $this->getByFileIds([$fileId]);
return $items[0] ?? null;
}
/**
* @param array[] $rows
* @return array<int, CacheEntry>
*/
private function rowsToEntries(array $rows): array {
$result = [];
foreach ($rows as $row) {
$entry = Cache::cacheEntryFromData($row, $this->mimeTypeLoader);
$result[$entry->getId()] = $entry;
}
return $result;
}
/**
* @param int[] $fileIds
* @return array<int, CacheEntry>
*/
public function getByFileIds(array $fileIds): array {
$query = $this->getQuery()->selectFileCache();
$query->andWhere($query->expr()->in('filecache.fileid', $query->createNamedParameter($fileIds, IQueryBuilder::PARAM_INT_ARRAY)));
$rows = $query->executeQuery()->fetchAll();
return $this->rowsToEntries($rows);
}
/**
* @param int[] $fileIds
* @param int $storageId
* @return array<int, CacheEntry>
*/
public function getByFileIdsInStorage(array $fileIds, int $storageId): array {
$fileIds = array_values($fileIds);
$query = $this->getQuery()->selectFileCache();
$query->andWhere($query->expr()->in('filecache.fileid', $query->createNamedParameter($fileIds, IQueryBuilder::PARAM_INT_ARRAY)));
$query->andWhere($query->expr()->eq('filecache.storage', $query->createNamedParameter($storageId, IQueryBuilder::PARAM_INT)));
$rows = $query->executeQuery()->fetchAll();
return $this->rowsToEntries($rows);
}
}

99
lib/public/Files/Cache/IFileAccess.php Normal file
View File

@ -0,0 +1,99 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2024 Robin Appelman <robin@icewind.nl>
*
* @author Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Files\Cache;
/**
* Low level access to the file cache.
*
* This is intended for use cases where data from the filecache needs to be loaded, but the full filesystem apis are
* insufficient or too inefficient for the use-case.
*
* @since 29.0.0
*/
interface IFileAccess {
/**
* Get a filecache data by file id from a specific storage.
*
* This is preferred over `getByFileId` when the storage id is known as it
* can be more efficient in some setups.
*
* @param int $fileId
* @param int $storageId
* @return ICacheEntry|null
*
* @since 29.0.0
*/
public function getByFileIdInStorage(int $fileId, int $storageId): ?ICacheEntry;
/**
* Get a filecache data by path and storage id.
*
* @param string $path
* @param int $storageId
* @return ICacheEntry|null
*
* @since 29.0.0
*/
public function getByPathInStorage(string $path, int $storageId): ?ICacheEntry;
/**
* Get a filecache data by file id.
*
* If the storage id is known then `getByFileIdInStorage` is preferred as it can be more efficient in some setups.
*
* @param int $fileId
* @return ICacheEntry|null
*
* @since 29.0.0
*/
public function getByFileId(int $fileId): ?ICacheEntry;
/**
* Get filecache data by file ids.
*
* If the storage id is known then `getByFileIdsInStorage` is preferred as it can be more efficient in some setups.
*
* @param int[] $fileIds
* @return array<int, ICacheEntry>
*
* @since 29.0.0
*/
public function getByFileIds(array $fileIds): array;
/**
* Get filecache data by file ids from a specific storage.
*
* This is prefered over `getByFileIds` when the storage id is known as it
* can be more efficient in some setups.
*
* @param int[] $fileIds
* @param int $storageId
* @return array<int, ICacheEntry>
*
* @since 29.0.0
*/
public function getByFileIdsInStorage(array $fileIds, int $storageId): array;
}