dillard
b625fe7666
The DR test of 1.0.2 over SMB is done: result in PLAN, empty folders as a known issue (#27).
102 lines
4.8 KiB
PHP
102 lines
4.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
namespace OCA\NgBackup\Command;
|
|
|
|
use OCA\NgBackup\Service\RestoreService;
|
|
use OCA\NgBackup\Service\TargetService;
|
|
use Symfony\Component\Console\Command\Command;
|
|
use Symfony\Component\Console\Input\InputArgument;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
|
|
final class Restore extends Command {
|
|
public function __construct(
|
|
private TargetService $targets,
|
|
private RestoreService $restore,
|
|
) {
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure(): void {
|
|
$this->setName('backup:restore')
|
|
->setDescription('Restore files or folders from a snapshot')
|
|
->addArgument('target', InputArgument::REQUIRED, 'Location name or id')
|
|
->addArgument('snapshot', InputArgument::REQUIRED, 'Snapshot id (see backup:list)')
|
|
->addArgument('path', InputArgument::REQUIRED, 'Path in the snapshot (see backup:browse)')
|
|
->addOption('mode', 'm', InputOption::VALUE_REQUIRED, 'new-folder, merge or replace (user files)', RestoreService::MODE_NEW_FOLDER)
|
|
->addOption('to-directory', 'd', InputOption::VALUE_REQUIRED, 'Write to this local directory instead (any path, raw files)')
|
|
->addOption('salvage', null, InputOption::VALUE_NONE, 'Leave out a file that cannot be read or decrypted, list it at the end and go on, instead of stopping')
|
|
->setHelp(<<<'HELP'
|
|
User files (data/<user>/files/...) are restored through Nextcloud, so versions, trash and the
|
|
file cache stay correct. Modes:
|
|
new-folder (default) into "Restored <date>/<same path>" in the user's files; nothing existing is touched
|
|
merge into the original place; overwritten files keep their old content as a version
|
|
replace like merge, and files that are not in the snapshot are moved to the trash
|
|
|
|
Examples:
|
|
occ backup:restore offsite 537bf7e9... data/alice/files/Documents
|
|
occ backup:restore offsite 537bf7e9... data/alice/files/Documents/plan.odt --mode=merge
|
|
occ backup:restore offsite 537bf7e9... config --to-directory=/root/restored-config
|
|
With --salvage, a file whose data on the location is damaged or missing is left out and listed
|
|
at the end; everything else is restored. The command then exits with code 2.
|
|
HELP);
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int {
|
|
$skipped = $input->getOption('salvage') ? [] : null;
|
|
try {
|
|
$target = $this->targets->get($input->getArgument('target'));
|
|
$snapshot = $input->getArgument('snapshot');
|
|
$path = trim((string)$input->getArgument('path'), '/'); // CLI convenience; the service itself only accepts canonical paths
|
|
if ($dir = $input->getOption('to-directory')) {
|
|
$n = $this->restore->restoreToDirectory($target, $snapshot, $path, $dir, false, null, $skipped);
|
|
$output->writeln("Restored <info>$n</info> files to $dir.");
|
|
return self::reportSkipped($skipped, $output);
|
|
}
|
|
$r = $this->restore->restoreUserFiles($target, $snapshot, $path, (string)$input->getOption('mode'),
|
|
function (int $done, int $total, string $name) use ($output) {
|
|
if ($output->isVerbose() || $done === $total || $done % 100 === 0) {
|
|
$output->writeln(" $done/$total $name");
|
|
}
|
|
}, $skipped);
|
|
} catch (\Throwable $e) {
|
|
$output->writeln('<error>' . $e->getMessage() . '</error>');
|
|
if ($skipped === null && self::backupLooksDamaged($e)) {
|
|
$output->writeln('The data of a file on the location is damaged or missing. Run the same command with --salvage to restore everything else and list what could not be restored.');
|
|
}
|
|
return 1;
|
|
}
|
|
$output->writeln(sprintf('Restored <info>%d</info> files to %s%s.', $r['restored'], $r['target'], $r['trashed'] ? ", moved {$r['trashed']} extra files to the trash" : ''));
|
|
return self::reportSkipped($skipped, $output);
|
|
}
|
|
|
|
/** Damaged data, or a file that is gone from the location: what --salvage is for. */
|
|
public static function backupLooksDamaged(\Throwable $e): bool {
|
|
return $e instanceof \OCA\NgBackup\Repository\RepositoryException
|
|
|| $e instanceof \OCA\NgBackup\Crypto\CryptoException
|
|
|| ($e instanceof \OCA\NgBackup\Backend\BackendException && str_starts_with($e->getMessage(), 'Not found'));
|
|
}
|
|
|
|
/**
|
|
* The files --salvage left out; exit code 2 when there are any.
|
|
*
|
|
* @param array<string, string>|null $skipped
|
|
*/
|
|
public static function reportSkipped(?array $skipped, OutputInterface $output): int {
|
|
if ($skipped === null || $skipped === []) {
|
|
return 0;
|
|
}
|
|
$output->writeln(sprintf('<comment>%d file%s could not be restored (damaged or missing on the location):</comment>', count($skipped), count($skipped) === 1 ? '' : 's'));
|
|
foreach ($skipped as $path => $reason) {
|
|
$output->writeln(" $path: $reason");
|
|
}
|
|
return 2;
|
|
}
|
|
}
|