Fix queued backups never building, per-type retention, and cron connection handling

This commit is contained in:
johnnyq
2026-07-31 16:35:39 -04:00
parent ae468d6cee
commit 53f45fa008
5 changed files with 103 additions and 49 deletions

View File

@@ -223,9 +223,9 @@ if (!empty($_SESSION['backup_master_key_reveal'])) {
<small class="text-muted">0 disables age-based deletion.</small>
</div>
<div class="form-group col-md-4">
<label>Keep at most (backups)</label>
<label>Keep at most (per type)</label>
<input type="number" class="form-control" name="config_backup_retention_count" min="1" value="<?= intval($config_backup_retention_count) ?>">
<small class="text-muted">The newest is never deleted.</small>
<small class="text-muted">Counted separately for each type. The newest of each is never deleted.</small>
</div>
</div>

View File

@@ -20,7 +20,16 @@ if (isset($_GET['queue_backup'])) {
if ($backup_id > 0) {
logAudit("Backup", "Queue", ($session_name ?? 'Unknown User') . " queued a " . backupTypeLabel($type));
flashAlert(backupTypeLabel($type) . " queued - it will start within a minute and you will be notified when it is ready.");
// Saying "it will start within a minute" when the master cron switch is off is a lie
// the user only discovers by waiting, so check before promising.
$cron_row = mysqli_fetch_assoc(mysqli_query($mysqli, "SELECT config_enable_cron FROM settings WHERE company_id = 1"));
if (intval($cron_row['config_enable_cron']) === 0) {
flashAlert(backupTypeLabel($type) . " queued, but cron is switched off in Settings > Notifications, so it will not start until that is enabled.", 'error');
} else {
flashAlert(backupTypeLabel($type) . " queued - it will start within a minute and you will be notified when it is ready.");
}
} else {
flashAlert($error ?? "Could not queue the backup.", 'error');
}

View File

@@ -46,6 +46,16 @@ if ($queued > 0) {
* CONTRIBUTING's cron rules. A second dispatch in the same day (a manual Run Now, a catch-up
* after downtime) must not produce a second scheduled archive.
*/
$backup_job_row = mysqli_fetch_assoc(mysqli_query($mysqli, "SELECT cron_job_enabled FROM cron_jobs WHERE cron_job_name = 'backup'"));
if (empty($backup_job_row['cron_job_enabled'])) {
// Reached by a Run Now, which is how a queued backup gets built while the schedule is
// off. Building the scheduled archive as well would hand somebody who asked for a
// database backup an unasked-for full one. Scheduled work belongs to the schedule.
echo "Scheduled backups are switched off - built queued work only\n";
return;
}
$type = in_array($config_backup_cron_type, backupUnattendedTypes(), true) ? $config_backup_cron_type : BACKUP_TYPE_FULL;
$type_esc = escapeSql($type);

View File

@@ -183,6 +183,11 @@ function cronJobFinished($mysqli, string $job_name, string $status, ?float $dura
// "no job was due" apart from "nothing has run this since the server was rebuilt".
mysqli_query($mysqli, "UPDATE settings SET config_cron_last_dispatch_at = '" . date('Y-m-d H:i:s') . "' WHERE company_id = 1");
// Best effort: ask the server not to hang up while a long job is quiet.
if (function_exists('backupDbHoldOpen')) {
backupDbHoldOpen($mysqli);
}
// A fatal error inside a job cannot be caught, and it takes the rest of the cycle with it.
// Recording which job was running at the time is the only trace of that left behind.
$cron_dispatch_running = null;
@@ -224,6 +229,15 @@ foreach (cronJobRegistry() as $cron_dispatch_job) {
$cron_dispatch_running = $cron_dispatch_job['name'];
$cron_dispatch_started = microtime(true);
// Every job runs in this one process on this one connection, and a job that spends
// minutes on network or file work without querying leaves it idle long enough for a
// server with a short wait_timeout to close it. The next job then dies on a connection
// it never touched. Re-establish before each one so a quiet job cannot poison the rest
// of the cycle.
if (function_exists('backupDbEnsure')) {
$mysqli = backupDbEnsure($mysqli);
}
try {
require_once $cron_dispatch_path;
cronJobFinished($mysqli, $cron_dispatch_job['name'], 'Completed', microtime(true) - $cron_dispatch_started);

View File

@@ -532,7 +532,15 @@ function backupQueue(mysqli $mysqli, string $type, string $created_by, ?string &
mysqli_query($mysqli, "INSERT INTO backups SET backup_type = '$type_esc', backup_file_name = '', backup_status = 'Pending', backup_source = 'Manual', backup_created_by = '$created_by_esc'");
return intval(mysqli_insert_id($mysqli));
$backup_id = intval(mysqli_insert_id($mysqli));
// Ask the dispatcher to run the backup job on its next pass. Without this the row sits
// Pending for ever on a default install: the job ships disabled, so the schedule never
// calls it and nothing ever builds what the button just queued. run_now is honoured
// whether or not a job is enabled, which is exactly the case this needs.
mysqli_query($mysqli, "UPDATE cron_jobs SET cron_job_run_now = 1 WHERE cron_job_name = 'backup'");
return $backup_id;
}
/**
@@ -841,51 +849,10 @@ function backupRunRetention(mysqli $mysqli): array
}
// Keep the newest $count complete backups regardless of age
$keep = [];
$keep_res = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Complete' ORDER BY backup_created_at DESC LIMIT " . max(1, $count));
if ($keep_res) {
while ($row = mysqli_fetch_assoc($keep_res)) {
$keep[] = intval($row['backup_id']);
}
}
$keep_clause = empty($keep) ? "" : " AND backup_id NOT IN (" . implode(",", $keep) . ")";
// Age-based removal
if ($days > 0) {
$old = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_created_at < CURDATE() - INTERVAL $days DAY $keep_clause");
if ($old) {
while ($row = mysqli_fetch_assoc($old)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
}
// Count-based removal
if ($count > 0 && !empty($keep)) {
$surplus = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Complete' $keep_clause");
if ($surplus) {
while ($row = mysqli_fetch_assoc($surplus)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
}
// Failed rows never had a usable file
$failed = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Failed' AND backup_created_at < CURDATE() - INTERVAL 7 DAY");
if ($failed) {
while ($row = mysqli_fetch_assoc($failed)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
// Reconciliation runs BEFORE the retention maths, not after. A row this rescues or
// adopts has to be counted by the same pass that decides what to delete - otherwise it
// escapes retention until tomorrow, and a second run on the same day is not the no-op
// CONTRIBUTING's third cron rule asks for.
// Orphans: rows whose file is gone, and files with no row
$known = [];
$rows = mysqli_query($mysqli, "SELECT backup_id, backup_file_name, backup_status FROM backups");
@@ -942,6 +909,60 @@ function backupRunRetention(mysqli $mysqli): array
$result['orphan_files']++;
}
// Keep the newest $count complete backups OF EACH TYPE, regardless of age.
//
// Per type rather than one shared pool: a master key export is a few hundred bytes and
// a full backup is gigabytes, so counting them together means five master key exports
// silently evict every real backup on the box. They are also the artefact you would
// least want retention to quietly remove.
$keep = [];
foreach (backupAllTypes() as $keep_type) {
$keep_type_esc = escapeSql($keep_type);
$keep_res = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Complete' AND backup_type = '$keep_type_esc' ORDER BY backup_created_at DESC LIMIT " . max(1, $count));
if ($keep_res) {
while ($row = mysqli_fetch_assoc($keep_res)) {
$keep[] = intval($row['backup_id']);
}
}
}
$keep_clause = empty($keep) ? "" : " AND backup_id NOT IN (" . implode(",", $keep) . ")";
// Age-based removal
if ($days > 0) {
$old = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_created_at < CURDATE() - INTERVAL $days DAY $keep_clause");
if ($old) {
while ($row = mysqli_fetch_assoc($old)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
}
// Count-based removal
if ($count > 0 && !empty($keep)) {
$surplus = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Complete' $keep_clause");
if ($surplus) {
while ($row = mysqli_fetch_assoc($surplus)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
}
// Failed rows never had a usable file
$failed = mysqli_query($mysqli, "SELECT backup_id FROM backups WHERE backup_status = 'Failed' AND backup_created_at < CURDATE() - INTERVAL 7 DAY");
if ($failed) {
while ($row = mysqli_fetch_assoc($failed)) {
if (backupDeleteById($mysqli, intval($row['backup_id']))) {
$result['deleted']++;
}
}
}
return $result;
}