M2: full backup runs (database, config, data) with occ and cron

BackupService starts a run per location (database dump in one transaction, then config + data directory as a resumable file run), stores the state in ngb_runs after every step, locks a run while a step executes and records the snapshot. Previews, logs, updater backups and per-user cache/uploads are excluded (TreeWalker now supports patterns). BackupJob (every 5 min) starts the daily schedule and steps running runs with a short budget under web cron and a long one under system cron. occ: backup:run, backup:status, backup:list. Tested on NC34/PostgreSQL: first run 128 files / 1 GiB in 64 s (443 MiB uploaded to S3), unchanged second run 2 s / 0 bytes; a background run to SFTP completed through cron.php.
2026-10-02 00:53:50 +02:00
parent bc5a589ed8
commit 446e317786
12 changed files with 693 additions and 15 deletions
@@ -0,0 +1,49 @@
+<?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\Db\SnapshotMapper;
+use OCA\NgBackup\Service\TargetService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ListSnapshots extends Command {
+	public function __construct(
+		private TargetService $targets,
+		private SnapshotMapper $snapshots,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this->setName('backup:list')
+			->setDescription('List the snapshots (restore points) on a location')
+			->addArgument('target', InputArgument::OPTIONAL, 'Location name or id (default: all)');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$name = $input->getArgument('target');
+		$targets = $name === null ? $this->targets->list() : [$this->targets->get($name)];
+		$rows = [];
+		foreach ($targets as $t) {
+			foreach ($this->snapshots->findForTarget($t->getId()) as $s) {
+				$rows[] = [$t->getName(), $s->getSnapshotId(), date('Y-m-d H:i', $s->getCreatedAt()), $s->getKind(),
+					$s->getFiles(), sprintf('%.1f GiB', ($s->getBytes() ?? 0) / 1073741824), $s->getLabel() ?? ''];
+			}
+		}
+		if ($rows === []) {
+			$output->writeln('No snapshots yet (occ backup:run).');
+			return 0;
+		}
+		(new Table($output))->setHeaders(['location', 'snapshot', 'date', 'kind', 'files', 'size', 'label'])->setRows($rows)->render();
+		return 0;
+	}
+}
@@ -0,0 +1,85 @@
+<?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\Db\Run;
+use OCA\NgBackup\Service\BackupService;
+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;
+
+class RunBackup extends Command {
+	public function __construct(
+		private BackupService $backups,
+		private TargetService $targets,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this->setName('backup:run')
+			->setDescription('Back up this Nextcloud (database, config, data) to a location now')
+			->addArgument('target', InputArgument::OPTIONAL, 'Location name or id (default: all locations)')
+			->addOption('label', 'l', InputOption::VALUE_REQUIRED, 'Label for the snapshot', '')
+			->addOption('background', 'b', InputOption::VALUE_NONE, 'Only start the run; background jobs finish it')
+			->setHelp(<<<'HELP'
+Starts a backup (or continues one that is already running for that location) and runs it to
+the end in this process. Unchanged files are not read again; only new data is uploaded.
+
+Examples:
+  occ backup:run                     back up to every location
+  occ backup:run offsite -l "before upgrade"
+  occ backup:run offsite --background
+HELP);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$name = $input->getArgument('target');
+		try {
+			$targets = $name === null ? $this->targets->list() : [$this->targets->get($name)];
+		} catch (\Throwable) {
+			$output->writeln('<error>No such location.</error>');
+			return 1;
+		}
+		if ($targets === []) {
+			$output->writeln('<error>No backup locations yet (occ backup:target:add).</error>');
+			return 1;
+		}
+		$failed = 0;
+		foreach ($targets as $t) {
+			try {
+				$run = $this->backups->start($t, (string)$input->getOption('label'));
+			} catch (\Throwable $e) {
+				$output->writeln('<error>' . $t->getName() . ': ' . $e->getMessage() . '</error>');
+				$failed++;
+				continue;
+			}
+			$output->writeln(sprintf('<info>%s</info>: run %d, snapshot %s', $t->getName(), $run->getId(), $run->getSnapshotId()));
+			if ($input->getOption('background')) {
+				continue;
+			}
+			$start = microtime(true);
+			$run = $this->backups->runToCompletion($run, function (Run $r) use ($output, $start) {
+				$s = json_decode($r->getStats() ?? '{}', true);
+				$f = $s['files'] ?? [];
+				$output->writeln(sprintf('  %5.0fs  %-6s files %d (read %d, unchanged %d), uploaded %.1f MiB',
+					microtime(true) - $start, $r->getPhase(), $f['files'] ?? 0, $f['read'] ?? 0, $f['reused'] ?? 0, ($f['uploaded'] ?? 0) / 1048576));
+			});
+			if ($run->getStatus() === Run::DONE) {
+				$output->writeln(sprintf('  done in %.0fs', microtime(true) - $start));
+			} else {
+				$output->writeln('<error>  ' . $run->getStatus() . ': ' . $run->getError() . '</error>');
+				$failed++;
+			}
+		}
+		return $failed === 0 ? 0 : 1;
+	}
+}
@@ -0,0 +1,56 @@
+<?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\Db\RunMapper;
+use OCA\NgBackup\Service\KeyService;
+use OCA\NgBackup\Service\TargetService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Status extends Command {
+	public function __construct(
+		private KeyService $keys,
+		private TargetService $targets,
+		private RunMapper $runs,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this->setName('backup:status')->setDescription('Show the backup key, locations and recent runs');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		if (!$this->keys->isInitialized()) {
+			$output->writeln('Key: <error>not created</error> (occ backup:key:init)');
+		} else {
+			$c = $this->keys->recoveryKitConfirmation();
+			$output->writeln('Key: ' . $this->keys->fingerprint() . ', recovery kit '
+				. ($c ? 'confirmed by ' . $c['uid'] . ' on ' . date('Y-m-d H:i', $c['time']) : '<error>not confirmed</error> (occ backup:key:confirm)'));
+		}
+		$names = [];
+		foreach ($this->targets->list() as $t) {
+			$names[$t->getId()] = $t->getName();
+		}
+		$output->writeln('Locations: ' . ($names === [] ? 'none' : implode(', ', $names)));
+		$rows = [];
+		foreach ($this->runs->findRecent(10) as $r) {
+			$s = json_decode($r->getStats() ?? '{}', true)['files'] ?? [];
+			$rows[] = [$r->getId(), $names[$r->getTargetId()] ?? '#' . $r->getTargetId(), $r->getKind(), $r->getStatus() . ($r->getStatus() === 'running' ? ' (' . $r->getPhase() . ')' : ''),
+				date('Y-m-d H:i', $r->getStartedAt()), $r->getFinishedAt() ? gmdate('H:i:s', $r->getFinishedAt() - $r->getStartedAt()) : '',
+				$s['files'] ?? '', isset($s['uploaded']) ? sprintf('%.1f MiB', $s['uploaded'] / 1048576) : '', mb_strimwidth((string)$r->getError(), 0, 50, '…')];
+		}
+		if ($rows !== []) {
+			(new Table($output))->setHeaders(['run', 'location', 'kind', 'status', 'started', 'took', 'files', 'uploaded', 'error'])->setRows($rows)->render();
+		}
+		return 0;
+	}
+}