Make the # of backups at each level configurable

README.md

@@ -14,7 +14,7 @@ design goals:
 -   Portable, small, code footprint.
 
 One Tarsnap archive is created per-target per-run. 31 daily, 12 monthly,
-and indefinite yearly backups are kept.
+and indefinite yearly backups are kept by default.
 
 Download
 --------
@@ -40,7 +40,7 @@ Notes on behaviour:
     -   If no monthly backup for the current month exists, create a
         monthly backup.
     -   Otherwise, create a daily backup.
--   Archives are deleted using the following logic:
+-   Archives are deleted using the following logic by default:
     -   If any backups failed, delete nothing.
     -   Keep the most recent 31 daily backups, and delete any older
         ones.

acts

@@ -86,6 +86,9 @@ postbackupscript="${postbackupscript=}"
 tarsnap="${tarsnap:=tarsnap}"
 tarsnapbackupoptions="${tarsnapbackupoptions=}"
 lockfile="${lockfile=/var/run/acts}"
+dailymax="${dailymax:=31}"
+monthlymax="${monthlymax:=12}"
+yearlymax="${yearlymax:=0}"
 LANG="${LANG=en_US.UTF-8}"
 export LANG
 
@@ -102,6 +105,10 @@ else
     die "config-error message=\"invalid \$uselocaltime in acts.conf; valid options are 0 (for UTC) or 1 (for local time).\""
 fi
 
+[ $(( dailymax )) = "$dailymax" ]   || die "config-error message=\"Invalid \$dailymax; must be a number.\""
+[ $(( monthlymax )) = "$dailymax" ] || die "config-error message=\"Invalid \$monthlymax; must be a number.\""
+[ $(( yearlymax )) = "$dailymax" ]  || die "config-error message=\"Invalid \$yearlymax; must be a number.\""
+
 # Create the lock. mkdir is atomic test/set, so use that instead of the typical test -f/touch combo
 if [ -d "$lockfile" ]; then
     die "acts-error message=\"$lockfile exists referencing PID $(cat "$lockfile/pid" 2>/dev/null || echo "<none>"). Hint: If acts is not already running, rm -rf $lockfile.\""
@@ -146,10 +153,10 @@ backuprc=0 # Notice any failed backups
 for dir in $backuptargets; do
     log_debug "message=\"Starting backup of $dir\""
     archive_starttime=$(date +%s)
-    nicedirname=$(echo "$dir" | tr -d '/')
+    nicedirname=${dir:+-${dir#/}}  # /foo -> -foo, / -> ''
     # Determine the archive type to create
-    if echo "$archives" | grep -E -q "^$hostname-yearly-$year-.+-$nicedirname$"; then
-        if echo "$archives" | grep -E -q "^$hostname-monthly-$year-$month-.+-$nicedirname$"; then
+    if echo "$archives" | grep -E -q "^$hostname-yearly-$year-.+$nicedirname$"; then
+        if echo "$archives" | grep -E -q "^$hostname-monthly-$year-$month-.+$nicedirname$"; then
             # There's a yearly and monthly backup already
             archivetype="daily"
         else
@@ -161,7 +168,7 @@ for dir in $backuptargets; do
         archivetype="yearly"
     fi
     log_verbose "archive-type type=$archivetype"
-    archivename="$hostname-$archivetype-$today-$nicedirname"
+    archivename="$hostname-$archivetype-$today$nicedirname"
     log_verbose "backup-start type=$archivetype dir=/$dir name=$archivename"
     # Uncontrolled expansion is bad, but we have little choice. See https://github.com/koalaman/shellcheck/wiki/Sc2086
     # shellcheck disable=SC2086
@@ -180,40 +187,35 @@ if [ "$backuprc" != "0" ]; then
     die "acts-tarsnap-error One of the backups failed -- not deleting old backups"
 fi
 
-for dir in $backuptargets; do
-    log_debug "message=\"Checking $dir for old backups to delete\""
-    nicedirname=$(echo "$dir" | tr -d '/')
-    # We don't delete any yearly backups
-
-    # We keep 12 monthly backups
-    monthlybackups=$(echo "$archives" | grep "$hostname-monthly-.+-$nicedirname$" | sort -rn)
-    if [ "$(echo "$monthlybackups" | wc -l)" -gt 12 ]; then
-        log_debug 'message="More than 12 monthly backups, deleting the oldest"'
-        echo "$monthlybackups" | tail -n +13 | while read -r archiveprefixtodel; do
-            log_verbose "message=\"Deleting backup prefix $archiveprefixtodel*\""
-            echo "$archives" | grep -E "^$archiveprefixtodel" | while read -r archivetodel; do
-                log_debug "message=\"Deleting backup $archivetodel\""
-                $tarsnap -d -f "$archivetodel"
+prune_backups() {
+    backuplevel=$1 max=$2
+
+    if [ "$max" -gt 0 ]; then
+        backupslist=$(echo "$archives" | grep "$hostname-$backuplevel-.+$nicedirname$" | sort -rn)
+        if [ "$(echo "$backupslist" | wc -l)" -gt "$max" ]; then
+            log_debug "message=\"More than $max yearly backups, deleting the oldest\""
+            echo "$backupslist" | tail -n +"$max" | while read -r archiveprefixtodel; do
+                log_verbose "message=\"Deleting backup prefix $archiveprefixtodel*\""
+                echo "$archives" | grep -E "^$archiveprefixtodel" | while read -r archivetodel; do
+                    log_debug "message=\"Deleting backup $archivetodel\""
+                    $tarsnap -d -f "$archivetodel"
+                done
             done
-        done
+        else
+            log_debug "message=\"Found $(echo "$backupslist" | wc -l) $backuplevel backups, not deleting\""
+        fi
     else
-        log_debug "message=\"Found $(echo "$monthlybackups" | wc -l) monthly backups, not deleting\""
+        log_debug "message=\"Keeping all $backuplevel backups indefinitely; not deleting any\""
     fi
+}
 
-    # We keep 31 daily backups
-    dailybackups=$(echo "$archives" | grep "$hostname-daily-.+-$nicedirname$" | sort -rn)
-    if [ "$(echo "$dailybackups" | wc -l)" -gt 31 ]; then
-        log_debug "message=\"More than 30 daily backups, deleting the oldest\""
-        echo "$dailybackups" | tail -n +32 | while read -r archiveprefixtodel; do
-            log_verbose "message=\"Deleting backup prefix $archiveprefixtodel*\""
-            echo "$archives" | grep -E "^$archiveprefixtodel" | while read -r archivetodel; do
-                log_debug "message=\"Deleting backup $archivetodel\""
-                $tarsnap -d -f "$archivetodel"
-            done
-        done
-    else
-        log_debug "message=\"Found $(echo "$dailybackups" | wc -l) daily backups, not deleting any\""
-    fi
+for dir in $backuptargets; do
+    log_debug "message=\"Checking $dir for old backups to delete\""
+    nicedirname=${dir:+-${dir#/}}  # /foo -> -foo, / -> ''
+
+    prune_backups yearly  $yearlymax
+    prune_backups monthly $monthlymax
+    prune_backups daily   $dailymax
 done
 
 # Run the post-backup script

acts.conf.sample

@@ -54,3 +54,10 @@ verbose=1
 # Where acts should write its lockfile.
 # Default: /var/run/acts
 #lockfile=/tmp/acts
+
+# How many backups of each type to keep
+# For all limits, 0 means keep indefinitely
+# Defaults: 31 daily, 12 monthly, and yearly indefinitely
+# dailymax=31
+# monthlymax=12
+# yearlymax=0