Abort on low disk space
[wizbackup.git] / wizbackup
index e2c772988fd6c7df073892141de6626ed17a8f3f..816a66b82ff3641eaa40a41f3ebceb4ba97ca33c 100755 (executable)
--- a/wizbackup
+++ b/wizbackup
@@ -1,53 +1,63 @@
 #!/bin/bash
 #
-# wizbackup 2.0 - Simple rsync backup
+# WizBackup 2.0 - Simple rsync backup
 # Based on incremental-backup 0.1 by Matteo Mattei
 #
 # Copyright 2006 Matteo Mattei <matteo.mattei@gmail.com>
 # Copyright 2007, 2008, 2009, 2010, 2011 Bernie Innocenti <bernie@codewiz.org>
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License,
-# or (at your option) any later version.
-
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License,
+#  or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 
-if [ $# -lt 2 ]
-then
+if [ $# -lt 2 ]; then
        echo "Usage: $0 SOURCE DEST [RSYNC_OPTS]"
        exit 1
 fi
 
-# Fail on any error; Treat undefined variables as errors
-set -e -u
+# Treat undefined variables as errors
+set -u
 
 #####################################################################
 # CONFIGURATION
 #####################################################################
 
-# Source path
+# Source rsync URL
 SRC=$1; shift
 
-# DESTINATION DIRECTORY (must exists)
+# Destination directory (will be created if it doesn't exist)
 DEST=$1; shift
 
 # NOTE: --timeout needs to be large enough: if a large dir tree don't change a lot of time can pass without I/O
 # NOTE: --inplace will clobber linked files in older snapshots. DON'T USE IT!
-RSYNC_OPTIONS="-HAXa --stats --timeout 1800 --numeric-ids --delete --delete-excluded --ignore-errors $@"
-# NUMBER OF SAVED ARCHIVES
-N_SNAPSHOT=45
-RESULT=500
+RSYNC_OPTS="-HAXa --stats --timeout 1800 --numeric-ids --delete --delete-excluded --ignore-errors $@"
 
+# Number of saved snapshots
+SNAPSHOTS=45
+
+# Abort backup if the destination volume has less than these GBs free
+MIN_FREE_GB=10
+
+RESULT=500
 DATE=`date +"%Y%m%d"`
 DEST="`echo $DEST | sed -e 's/\/$//'`"
 
 
 # Use "backup" ssh key with ssh protocol, or password file for rsync protocol
 if [ "${SRC%:*}" == "rsync" ]; then
-       RSYNC_PWD="--password-file=/etc/wizbackup.pwd --contimeout 10"
+       RSYNC_OPTS="$RSYNC_OPTS --password-file=/etc/wizbackup/rsync_password --contimeout 10"
 else
-       export RSYNC_RSH="ssh -i /root/.ssh/id_backup -c arcfour -x -o VerifyHostKeyDNS=yes"
-       RSYNC_PWD=""
+       export RSYNC_RSH="ssh -i /etc/wizbackup/ssh_id -c arcfour -x -o VerifyHostKeyDNS=yes -o StrictHostKeyChecking=no"
 fi
 
 # Error tolerant grep
@@ -60,8 +70,8 @@ tgrep()
 do_backup()
 {
        set -o pipefail
-       echo "$(date): Starting rsync: rsync $RSYNC_PWD $RSYNC_OPTIONS $SRC $DEST/$DATE/"
-       rsync $RSYNC_PWD $RSYNC_OPTIONS "$SRC" "$DEST/tmp/" 2>&1 | tgrep -v -E 'vanished|some files'
+       echo "$(date): rsync $RSYNC_OPTS $SRC $DEST/tmp/"
+       rsync $RSYNC_OPTS "$SRC" "$DEST/tmp/" 2>&1 | tgrep -v -E 'vanished|some files'
        RESULT=$?
        case "$RESULT" in
        0|24)
@@ -81,7 +91,8 @@ do_backup()
        set +o pipefail
 }
 
-do_link()
+
+do_init()
 {
        # Safety net (4 slashes just in case)
        case "$DEST" in
@@ -93,36 +104,56 @@ do_link()
                mkdir -p "$DEST" || exit 667
        fi
 
-       pushd "$DEST" >/dev/null || exit 668
+       cd "$DEST" || exit 668
+}
 
-       # Remove old backups
-       local old="`ls | head -n -$N_SNAPSHOT`"
+do_prune()
+{
+       local old="`ls | grep -v tmp | head -n -$SNAPSHOTS`"
        if [ ! -z "$old" ]; then
                echo "$(date): Removing oldest snapshot(s): $old..."
                rm -rf "$old" || exit 669
        fi
+}
 
-       local newest=`ls | tail -n 1`
-       if [ -z "$newest" ]; then
+do_link()
+{
+       local newest=`ls | grep  -v tmp | tail -n 1`
+       if [ -d "$DEST/tmp" ]; then
+               echo "$(date): Continuing with pre-existing snapshot $DEST/tmp"
+       elif [ -z "$newest" ]; then
                echo "$(date): No previous snapshot found, performing a full backup!"
-       elif [ -d "$DEST/tmp" ]; then
-               echo "$(date): Continuing with preexisting snapshot $DEST/tmp"
        else
                echo "$(date): Linking snapshot $DEST/$newest to $DEST/tmp"
                # TODO: Creating the hardlinks takes a lot of time.
                # Perhaps we could save time by recycling the oldest snapshot
-               cp -lR "$DEST/$newest" "$DEST/tmp" || exit 670
+               cp -la "$DEST/$newest" "$DEST/tmp"
+               RESULT=$?
+               if [ $RESULT -ne 0 ]; then
+                       echo "$(date): Failed to setup tmp snapshot: $RESULT. Cleaning up."
+                       rm -rf "$DEST/tmp"
+                       exit $RESULT
+               fi
        fi
-
-       popd >/dev/null
 }
 
 do_test()
 {
+       # TODO: test for free space and free inodes in the $DEST filesystem
+       block_size=`stat --file-system --format "%S" "$DEST"`
+       free_blocks=`stat --file-system --format "%f" "$DEST"`
+       free_inodes=`stat --file-system --format "%d" "$DEST"`
+       free_gb=$((block_size * free_blocks / 1024 / 1024 / 1024))
+
+       if [ "$free_gb" -lt "$MIN_FREE_GB" ]; then
+               echo "$(date): Aborting due to insufficient free space ${free_gb}GB."
+               exit 670
+       fi
+
        # Avoid clobbering the latest snapshot if the remote host does
        # not allow us to connect
        # --contimeout: sometimes hangs on connection...
-       rsync $RSYNC_PWD $RSYNC_OPTIONS --dry-run --no-recursive "$SRC" >/dev/null
+       rsync $RSYNC_OPTS --dry-run --no-recursive "$SRC" >/dev/null
        RESULT=$?
        if [ $RESULT -ne 0 ]; then
                echo "$(date): rsync test failed: $RESULT.  Aborting."
@@ -130,14 +161,16 @@ do_test()
        fi
 }
 
-######################
-# MAIN
-######################
+######################################
+# Main
+######################################
 
 # make sure to be root
 if (( `id -u` != 0 )); then { echo "Sorry, must be root.  Exiting..."; exit; } fi
 
 echo "$(date): START backup: $SRC -> $DEST"
+do_init
+do_prune
 do_test
 do_link
 do_backup