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 9cefea019d
commit 2ab4b2e7d5
12 changed files with 693 additions and 15 deletions
@@ -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;
+	}
+}