dillard
36a30732ad
- The admin page and backup:status warn when background jobs do not run on a
system cron, or the cron stopped, with a link to how to set one up.
- Without a working system cron, the open admin page moves a running backup
forward through /api/tick, a short step per poll.
- The database phase shows the tables dumped ("db: 47/183 tables"); a backup
that has not moved for 15 minutes says it is waiting for background jobs.
- The trash of restore points is on a tab of its own, Bin.
- New screenshots; changelog and plan for 1.0.2.
118 lines
4.9 KiB
PHP
118 lines
4.9 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\Db\RunMapper;
|
|
use OCA\NgBackup\Format;
|
|
use OCA\NgBackup\Service\CronHealth;
|
|
use OCA\NgBackup\Service\KeyService;
|
|
use OCA\NgBackup\Service\Schedule;
|
|
use OCA\NgBackup\Service\TargetService;
|
|
use OCA\NgBackup\Service\VerifyService;
|
|
use Symfony\Component\Console\Command\Command;
|
|
use Symfony\Component\Console\Helper\Table;
|
|
use Symfony\Component\Console\Input\InputInterface;
|
|
use Symfony\Component\Console\Input\InputOption;
|
|
use Symfony\Component\Console\Output\OutputInterface;
|
|
|
|
final class Status extends Command {
|
|
/** Runs of the last days that are listed by default (failed ones stay visible that long). */
|
|
public const RECENT_DAYS = 7;
|
|
|
|
public function __construct(
|
|
private KeyService $keys,
|
|
private TargetService $targets,
|
|
private RunMapper $runs,
|
|
private VerifyService $verify,
|
|
private Schedule $schedule,
|
|
private CronHealth $cron,
|
|
) {
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure(): void {
|
|
$this->setName('backup:status')->setDescription('Show the backup key, locations and recent runs')
|
|
->addOption('all', null, InputOption::VALUE_NONE, 'List all runs, not only those of the last ' . self::RECENT_DAYS . ' days');
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int {
|
|
$zone = $this->schedule->get()['timezone'];
|
|
$cronProblem = CronHealth::describe($this->cron->check());
|
|
if ($cronProblem !== null) {
|
|
$output->writeln('<error>' . $cronProblem . '</error>');
|
|
}
|
|
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 ' . Format::time($c['time'], $zone) . " ($zone)" : '<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 = [];
|
|
$all = (bool)$input->getOption('all');
|
|
$shown = $this->runs->findShown($all ? null : time() - self::RECENT_DAYS * 86400);
|
|
foreach ($shown as $r) {
|
|
$s = json_decode($r->getStats() ?? '{}', true)['files'] ?? [];
|
|
$rows[] = [$r->getId(), $names[$r->getTargetId()] ?? '#' . $r->getTargetId(), $r->getKind(), $r->getStatus() === 'running' ? self::runningStatus($r) : $r->getStatus(),
|
|
Format::time($r->getStartedAt(), $zone), $r->getFinishedAt() ? Format::duration($r->getFinishedAt() - $r->getStartedAt()) : '',
|
|
$s['files'] ?? '', isset($s['bytes']) ? self::size((int)$s['bytes']) : '',
|
|
isset($s['uploaded']) ? self::size((int)$s['uploaded']) : '', mb_strimwidth((string)$r->getError(), 0, 50, '…')];
|
|
}
|
|
if ($rows !== []) {
|
|
(new Table($output))->setHeaders(['run', 'location', 'kind', 'status', "started ($zone)", 'took', 'files', 'size', 'uploaded', 'error'])->setRows($rows)->render();
|
|
}
|
|
$older = $all ? 0 : $this->runs->countAll() - count($shown);
|
|
if ($older > 0) {
|
|
$output->writeln(sprintf('%d older run%s not shown (--all)', $older, $older === 1 ? '' : 's'));
|
|
}
|
|
foreach ($this->verify->progress() as $targetId => $state) {
|
|
$output->writeln(sprintf('Verify of %s on %s: %s', mb_strimwidth((string)($state['what'] ?? ''), 0, 40, '…'),
|
|
$names[$targetId] ?? '#' . $targetId, VerifyService::describe($state)));
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/** " 68%", or " ~68%" when estimated from the file cache; empty without an estimate */
|
|
private static function size(int $bytes): string {
|
|
$b = (float)$bytes;
|
|
foreach (['B', 'KiB', 'MiB', 'GiB'] as $u) {
|
|
if ($b < 1024) {
|
|
return $u === 'B' ? "$bytes B" : sprintf('%.1f %s', $b, $u);
|
|
}
|
|
$b /= 1024.0;
|
|
}
|
|
return sprintf('%.1f TiB', $b);
|
|
}
|
|
|
|
/** " 47/183 tables" in the database phase, " 68%" or " ~68%" in the files phase; empty without a figure */
|
|
private static function percent(\OCA\NgBackup\Db\Run $r): string {
|
|
$p = \OCA\NgBackup\Job\BackupRun::progressOf($r);
|
|
if ($p === null) {
|
|
return '';
|
|
}
|
|
if (isset($p['tables'], $p['totalTables'])) {
|
|
return sprintf(': %d/%d tables', $p['tables'], $p['totalTables']);
|
|
}
|
|
return sprintf(' %s%d%%', $p['approximate'] ? '~' : '', (int)floor($p['fraction'] * 100.0));
|
|
}
|
|
|
|
/** "running (db: 47/183 tables)", or "waiting for background jobs (last step 12 min ago)" */
|
|
private static function runningStatus(\OCA\NgBackup\Db\Run $r): string {
|
|
$waiting = $r->getKind() === \OCA\NgBackup\Service\BackupService::KIND_FULL ? CronHealth::waitingFor($r) : null;
|
|
if ($waiting !== null) {
|
|
return 'waiting for background jobs (' . $r->getPhase() . self::percent($r) . ', last step ' . CronHealth::ago($waiting) . ')';
|
|
}
|
|
return 'running (' . $r->getPhase() . self::percent($r) . ')';
|
|
}
|
|
}
|