198 lines
6.8 KiB
PHP
198 lines
6.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
namespace OCA\NgBackup\Repository;
|
|
|
|
use OCA\NgBackup\Backend\IBackend;
|
|
use OCA\NgBackup\Crypto\StreamCipher;
|
|
|
|
/**
|
|
* Which blob lives in which pack. Every uploaded pack gets its own small encrypted index file
|
|
* (index/<packId>), written right after the pack, so an interrupted run leaves a consistent
|
|
* repository and the next run can reuse what was already uploaded.
|
|
*
|
|
* Phase 0 keeps the whole index in memory. For large repositories this becomes a table in the
|
|
* Nextcloud database (a cache that can always be rebuilt from index/ and the pack headers).
|
|
*/
|
|
final class BlobIndex {
|
|
/** @var array<string, array{0:string, 1:int, 2:int, 3:int, 4:int}> id => [pack, offset, length, raw, flags] */
|
|
private array $blobs = [];
|
|
/** @var array<string, true> blobs added in this run but whose pack is not uploaded yet */
|
|
private array $pending = [];
|
|
|
|
private ?IIndexCache $cache = null;
|
|
/** @var list<\Closure():void>|null cache writes held back by holdCache(), or null when writing directly */
|
|
private ?array $heldCacheWrites = null;
|
|
private string $repositoryId = '';
|
|
/** @var int index files downloaded by the last load() (for tests and diagnostics) */
|
|
public int $downloaded = 0;
|
|
|
|
public function __construct(
|
|
private IBackend $backend,
|
|
private StreamCipher $cipher,
|
|
) {
|
|
}
|
|
|
|
public function setCache(IIndexCache $cache, string $repositoryId): void {
|
|
$this->cache = $cache;
|
|
$this->repositoryId = $repositoryId;
|
|
}
|
|
|
|
/**
|
|
* Hold back cache writes until releaseCache(). The database dump reads inside a read-only
|
|
* transaction on the same connection that the cache writes to: a write there fails on
|
|
* PostgreSQL and would be rolled back with the dump transaction elsewhere.
|
|
*/
|
|
public function holdCache(): void {
|
|
$this->heldCacheWrites ??= [];
|
|
}
|
|
|
|
/** Write the cache changes held back since holdCache(). */
|
|
public function releaseCache(): void {
|
|
$writes = $this->heldCacheWrites ?? [];
|
|
$this->heldCacheWrites = null;
|
|
foreach ($writes as $write) {
|
|
$write();
|
|
}
|
|
}
|
|
|
|
/** @param list<array{id:string, offset:int, length:int, raw:int, flags:int}> $entries */
|
|
private function cachePut(string $packId, array $entries): void {
|
|
if ($this->heldCacheWrites !== null) {
|
|
$this->heldCacheWrites[] = function () use ($packId, $entries): void {
|
|
$this->cache?->put($this->repositoryId, $packId, $entries);
|
|
};
|
|
return;
|
|
}
|
|
$this->cache?->put($this->repositoryId, $packId, $entries);
|
|
}
|
|
|
|
/** @param list<string> $packIds */
|
|
private function cacheRemove(array $packIds): void {
|
|
if ($this->heldCacheWrites !== null) {
|
|
$this->heldCacheWrites[] = function () use ($packIds): void {
|
|
$this->cache?->remove($this->repositoryId, $packIds);
|
|
};
|
|
return;
|
|
}
|
|
$this->cache?->remove($this->repositoryId, $packIds);
|
|
}
|
|
|
|
/**
|
|
* Load the index: one listing of index/, entries from the local cache where available,
|
|
* and only the index files that are not cached yet are downloaded. Cached packs that no
|
|
* longer exist on the backend are dropped from the cache.
|
|
*/
|
|
public function load(bool $verify = false): void {
|
|
$this->blobs = [];
|
|
$cached = $verify ? [] : ($this->cache?->all($this->repositoryId) ?? []);
|
|
$present = [];
|
|
$this->downloaded = 0;
|
|
foreach ($this->backend->listFiles('index') as $path) {
|
|
$packId = basename($path);
|
|
$present[$packId] = true;
|
|
if (isset($cached[$packId])) {
|
|
$entries = $cached[$packId];
|
|
} else {
|
|
$fh = $this->backend->get($path);
|
|
$entries = json_decode($this->cipher->decryptString((string)stream_get_contents($fh), 'index:' . $packId), true, 512, JSON_THROW_ON_ERROR);
|
|
fclose($fh);
|
|
$this->downloaded++;
|
|
$this->cache?->put($this->repositoryId, $packId, $entries);
|
|
}
|
|
foreach ($entries as $e) {
|
|
$this->blobs[$e['id']] = [$packId, $e['offset'], $e['length'], $e['raw'], $e['flags']];
|
|
}
|
|
}
|
|
if ($verify && $this->cache !== null) {
|
|
// Refresh the cache from what was just verified.
|
|
// One pass over the blobs: a pass per pack took half an hour on a 1 TB repository
|
|
// (27,547 packs x 400,000 blobs), long enough for the location to drop the idle
|
|
// connection before the check went on.
|
|
$byPack = [];
|
|
foreach ($this->blobs as $id => [$pack, $offset, $length, $raw, $flags]) {
|
|
$byPack[$pack][] = ['id' => $id, 'offset' => $offset, 'length' => $length, 'raw' => $raw, 'flags' => $flags];
|
|
}
|
|
$this->cache->remove($this->repositoryId, array_keys($this->cache->all($this->repositoryId)));
|
|
foreach ($byPack as $packId => $entries) {
|
|
$this->cache->put($this->repositoryId, $packId, $entries);
|
|
}
|
|
return;
|
|
}
|
|
$stale = array_keys(array_diff_key($cached, $present));
|
|
if ($stale !== []) {
|
|
$this->cache?->remove($this->repositoryId, $stale);
|
|
}
|
|
}
|
|
|
|
public function has(string $id): bool {
|
|
return isset($this->blobs[$id]) || isset($this->pending[$id]);
|
|
}
|
|
|
|
/** @return array{0:string, 1:int, 2:int, 3:int, 4:int} */
|
|
public function get(string $id): array {
|
|
return $this->blobs[$id] ?? throw new RepositoryException('Blob not in index: ' . $id);
|
|
}
|
|
|
|
public function addPending(string $id): void {
|
|
$this->pending[$id] = true;
|
|
}
|
|
|
|
/** @param list<string> $ids */
|
|
public function dropPending(array $ids): void {
|
|
foreach ($ids as $id) {
|
|
unset($this->pending[$id]);
|
|
}
|
|
}
|
|
|
|
/** @param list<array{id:string, offset:int, length:int, raw:int, flags:int}> $entries */
|
|
public function addPack(string $packId, array $entries): void {
|
|
$stream = fopen('php://memory', 'w+b');
|
|
fwrite($stream, $this->cipher->encryptString(json_encode($entries, JSON_THROW_ON_ERROR), 'index:' . $packId));
|
|
rewind($stream);
|
|
$this->backend->put('index/' . $packId, $stream);
|
|
$this->cachePut($packId, $entries);
|
|
foreach ($entries as $e) {
|
|
$this->blobs[$e['id']] = [$packId, $e['offset'], $e['length'], $e['raw'], $e['flags']];
|
|
unset($this->pending[$e['id']]);
|
|
}
|
|
}
|
|
|
|
/** @return array<string, list<array{id:string, offset:int, length:int}>> packId => blobs currently located in that pack */
|
|
public function packs(): array {
|
|
$packs = [];
|
|
foreach ($this->blobs as $id => [$pack, $offset, $length]) {
|
|
$packs[$pack][] = ['id' => $id, 'offset' => $offset, 'length' => $length];
|
|
}
|
|
return $packs;
|
|
}
|
|
|
|
/** Forget a pack: delete its index file and cache row. Blobs that now live elsewhere are kept. */
|
|
public function removePack(string $packId): void {
|
|
$this->backend->delete('index/' . $packId);
|
|
$this->cacheRemove([$packId]);
|
|
foreach ($this->blobs as $id => $loc) {
|
|
if ($loc[0] === $packId) {
|
|
unset($this->blobs[$id]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Bytes of all blobs in the index (encrypted size, i.e. what is stored in packs). */
|
|
public function storedBytes(): int {
|
|
$total = 0;
|
|
foreach ($this->blobs as [, , $length]) {
|
|
$total += $length;
|
|
}
|
|
return $total;
|
|
}
|
|
|
|
public function count(): int {
|
|
return count($this->blobs);
|
|
}
|
|
}
|