dillard
0309f2e44e
- AdminApiController (admin only, CSRF-protected): status, create key, download recovery kit, confirm (statement accepted + exact phrase), backends with their usable auth mechanisms, add/test/remove locations, start backups, schedule, snapshots, browse, queue restores - RestoreJob runs web-initiated restores in the background; backup and restore runs are kept apart in the run table - admin section 'NG Backup' with a Vue 3 / @nextcloud/vue 9 page: key and recovery-kit flow (download, tick statement, 'Yes, I confirm'), location form built from files_external's parameter definitions, schedule, run list with polling, snapshot browser and restore with the three modes - auth mechanisms that depend on a user session or on files_external's own stored credentials are not offered API tested with curl on NC34 (status, backends, schedule validation, confirmation refusal, browse, queued restore and backup completed by cron); non-admins get 403, anonymous 401.
90 lines
3.4 KiB
PHP
90 lines
3.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
namespace OCA\NgBackup\Backend;
|
|
|
|
use OCA\Files_External\Lib\StorageConfig;
|
|
use OCA\Files_External\Service\BackendService;
|
|
use OCP\Files\Storage\IStorage;
|
|
use OCP\IUser;
|
|
|
|
/**
|
|
* Builds a storage object with files_external's own backends and auth mechanisms, the same
|
|
* way files_external's ConfigAdapter does it, but from a configuration that is never saved as
|
|
* a mount. The backup location therefore never appears in Files, for anyone.
|
|
*
|
|
* files_external classes are internal API: everything that touches them is in this class.
|
|
*/
|
|
final class ExternalStorageFactory {
|
|
public function __construct(
|
|
private BackendService $backends,
|
|
) {
|
|
}
|
|
|
|
/**
|
|
* @return list<array{id:string, name:string, auth:list<array{id:string, name:string, parameters:array}>, parameters:array<string, mixed>}>
|
|
* available backends, to build the settings form from
|
|
*/
|
|
public function describeBackends(): array {
|
|
$result = [];
|
|
foreach ($this->backends->getAvailableBackends() as $backend) {
|
|
$auth = [];
|
|
foreach ($this->backends->getAuthMechanismsByScheme(array_keys($backend->getAuthSchemes())) as $mech) {
|
|
// Mechanisms that need the logged-in user's session cannot work for unattended backups.
|
|
if (in_array($mech->getScheme(), ['builtin', 'null'], true) && $mech->getIdentifier() !== 'null::null') {
|
|
continue;
|
|
}
|
|
if (str_starts_with($mech->getIdentifier(), 'password::session') || str_starts_with($mech->getIdentifier(), 'password::logincredentials')
|
|
|| str_starts_with($mech->getIdentifier(), 'password::userprovided') || str_starts_with($mech->getIdentifier(), 'password::global')) {
|
|
continue;
|
|
}
|
|
$auth[] = [
|
|
'id' => $mech->getIdentifier(),
|
|
'name' => $mech->getText(),
|
|
'parameters' => array_map(fn ($p) => $p->jsonSerialize(), $mech->getParameters()),
|
|
];
|
|
}
|
|
$result[] = [
|
|
'id' => $backend->getIdentifier(),
|
|
'name' => $backend->getText(),
|
|
'auth' => $auth,
|
|
'parameters' => array_map(fn ($p) => $p->jsonSerialize(), $backend->getParameters()),
|
|
];
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param array<string, mixed> $options backend and auth options (e.g. host, bucket, key, secret)
|
|
* @param IUser|null $admin user for auth mechanisms that need one (password/session-based ones are not supported)
|
|
*/
|
|
public function create(string $backendId, string $authId, array $options, ?IUser $admin = null): IStorage {
|
|
$backend = $this->backends->getBackend($backendId);
|
|
$auth = $this->backends->getAuthMechanism($authId);
|
|
if ($backend === null || $auth === null) {
|
|
throw new BackendException("Unknown storage backend or auth mechanism: $backendId / $authId");
|
|
}
|
|
if (!in_array($auth->getScheme(), array_keys($backend->getAuthSchemes()), true)) {
|
|
throw new BackendException("Auth mechanism $authId does not fit backend $backendId");
|
|
}
|
|
|
|
$config = new StorageConfig();
|
|
$config->setBackend($backend);
|
|
$config->setAuthMechanism($auth);
|
|
$config->setBackendOptions($options);
|
|
$config->setMountPoint('/ng_backup'); // never mounted, but some code expects a value
|
|
|
|
$auth->manipulateStorageConfig($config, $admin);
|
|
$backend->manipulateStorageConfig($config, $admin);
|
|
|
|
$class = $backend->getStorageClass();
|
|
$storage = new $class($config->getBackendOptions());
|
|
$storage = $backend->wrapStorage($storage);
|
|
return $auth->wrapStorage($storage);
|
|
}
|
|
}
|