]> arthur.barton.de Git - backup-script.git/blobdiff - bin/backup-script
Write more information to "stamp file"
[backup-script.git] / bin / backup-script
index d28caafbc8264f5a0c89149853cd3299966c1b2c..494efca1dfa37a818d913e06797ea48ca56cc136 100755 (executable)
@@ -26,15 +26,20 @@ declare -i count_ok_vanished=0
 destinations=""
 
 # Default settings, can be overwritten in backup-script.conf:
-conf_d="/etc/backup-script.d"
+[ -d "/usr/local/etc/backup-script.d" ] \
+       && conf_d="/usr/local/etc/backup-script.d" \
+       || conf_d="/etc/backup-script.d"
 pre_exec=""
 post_exec=""
+default_backup_type="rsync"
 default_source_root="/"
-default_target=""
+default_files="running-config"
+default_target="/var/backups"
 default_user="root"
 default_ssh_args_add=""
 default_rsync_args_add=""
 default_exclude_args_add=""
+default_exclude_dirs_add=""
 default_compress=1
 default_ping=1
 default_local=0
@@ -50,7 +55,9 @@ Usage() {
        echo
        echo "When no <system> is given, all defined systems are used."
        echo
-       exit 1
+       echo -e $config_info
+       echo
+       exit 2
 }
 
 CleanUp() {
@@ -151,7 +158,7 @@ CloneSubvolume() {
                zfs snapshot "$snapshot" || return 1
                link_name="$(echo "$snapshot" | cut -d@ -f2-)"
                ln -s \
-                       "$volume/.zfs/snapshot/$link_name" \
+                       "current/.zfs/snapshot/$link_name" \
                        "$(dirname "$volume")/$link_name"
                ;;
          *)
@@ -234,10 +241,21 @@ Initialize_Last_SysTarget_Snapshot() {
                ;;
          "zfs")
                # On ZFS, the last generation is always named "current"
-               [ -e "$sys_target/current" ] \
-                       && last="$sys_target/current" \
-                       || last=""
-               snapshot="$(echo "$sys_target/current" | cut -c2-)@$(date +%Y%m%d-%H%M%S)"
+               if [ -e "$sys_target/current" ]; then
+                       last="$sys_target/current"
+                       if [ "$(uname)" = "Linux" ]; then
+                               date=$(LC_ALL=C stat "$1" | grep "^Modify: " \
+                                | cut -d':' -f2- | cut -d. -f1)
+                       else
+                               date=$(LC_ALL=C stat -f "%Sc" "$1")
+                       fi
+                       date=$(echo "$date" | sed -e's/^ //g' -e 's/[-:]//g' -e 's/ /-/g')
+
+               else
+                       last=""
+                       date="$(date +%Y%m%d-%H%M%S)"
+               fi
+               snapshot="$(echo "$sys_target/current" | cut -c2-)@$date"
                sys_target="$sys_target/current"
                ;;
          *)
@@ -247,6 +265,25 @@ Initialize_Last_SysTarget_Snapshot() {
        return 0
 }
 
+# Search configuration file (last one is used as default!)
+for conf in \
+       "/usr/local/etc/backup-script.conf" \
+       "/etc/backup-script.conf" \
+       "${conf_d}/backup-script.conf" \
+       "/usr/local/etc/backup-script.conf" \
+; do
+       [ -r "$conf" ] && break
+done
+
+# Read in configuration file
+config_info="Configuration file is \"$conf\""
+if [ -r "$conf" ]; then
+       source "$conf"
+else
+       config_info="${config_info} (not readable, using defaults)"
+fi
+config_info="${config_info},\nusing \"$conf_d\" as configuration directory."
+
 while [ $# -gt 0 ]; do
        case "$1" in
          "-n"|"--dry-run")
@@ -263,23 +300,30 @@ while [ $# -gt 0 ]; do
        esac
 done
 
-trap GotSignal SIGINT
-
 echo -n "Started: "; date
+echo -e "$config_info"
 
-for conf in "/etc/backup-script.conf" "${conf_d}/backup-script.conf"; do
-       if [ -r "$conf" ]; then
-               echo "Reading configuration: \"$conf\" ..."
-               source "$conf"
-       fi
-done
+# Check rsync and its protocol version
+rsync=$(which "rsync" 2>/dev/null)
+if [ $? -ne 0 ]; then
+       echo "Failed to detect rsync(1)! Is it installed in your \$PATH?"
+       exit 1
+fi
+rsync_proto=$($rsync --version 2>/dev/null | head -n 1 | sed 's/.*  protocol version \([0-9]*\)$/\1/')
+if [ $? -ne 0 ]; then
+       echo "Failed to detect protocol version of $rsync!"
+       exit 1
+fi
+echo "Rsync command is $rsync, protocol version $rsync_proto."
 echo
 
+trap GotSignal SIGINT
+
 if [ $# -ge 1 ]; then
        for s in "$@"; do
                if [ ! -r "${conf_d}/$s" ]; then
                        echo "$NAME: Can' read \"${conf_d}/$s\"!"
-                       exit 1
+                       exit 3
                fi
                sys="$sys ${conf_d}/$s"
        done
@@ -294,7 +338,7 @@ if [ -e "$PIDFILE" ]; then
        echo
        echo -n "Aborted: "; date
        echo
-       exit 3
+       exit 4
 fi
 touch "$PIDFILE" 2>/dev/null
 if [ $? -ne 0 ]; then
@@ -311,14 +355,14 @@ if [ -n "$pre_exec" ]; then
                echo "Error: pre-exec command failed!"; echo
                CleanUp
                echo "Aborting backup."; echo
-               exit 2
+               exit 5
        fi
        sleep 2
        echo
 fi
 
 for f in $sys; do
-       [ -r "$f" -a -f "$f" ] || continue
+       [[ -r "$f" && -f "$f" ]] || continue
 
        fname=$(basename "$f")
        case "$fname" in
@@ -329,12 +373,15 @@ for f in $sys; do
 
        # Set global defaults
        system="$fname"
+       backup_type="$default_backup_type"
        user="$default_user"
        source_root="$default_source_root"
+       files="$default_files"
        target="$default_target"
        ssh_args_add="$default_ssh_args_add"
        rsync_args_add="$default_rsync_args_add"
        exclude_args_add="$default_exclude_args_add"
+       exclude_dirs_add="$default_exclude_dirs_add"
        compress="$default_compress"
        ping="$default_ping"
        local="$default_local"
@@ -347,7 +394,7 @@ for f in $sys; do
        post_exec_saved="$post_exec"
 
        # Compatibility with backup-pull(1) script: Set defaults
-       unset host
+       host=""
        unset source
        unset pre_exec
        unset post_exec
@@ -356,13 +403,13 @@ for f in $sys; do
        source "$f"
 
        # Compatibility with backup-pull(1) script: Fix up configuration
-       [ "$system" = "$fname" -a -n "$host" ] \
+       [[ "$system" = "$fname" && -n "$host" ]] \
                && system="$host"
-       [ "$source_root" = "$default_source_root" -a -n "$source" ] \
+       [[ "$source_root" = "$default_source_root" && -n "$source" ]] \
                && source_root="$source"
-       [ -z "$job_pre_exec" -a -n "$pre_exec" ] \
+       [[ -z "$job_pre_exec" && -n "$pre_exec" ]] \
                && job_pre_exec="$pre_exec"
-       [ -z "$job_post_exec" -a -n "$post_exec" ] \
+       [[ -z "$job_post_exec" && -n "$post_exec" ]] \
                && job_post_exec="$post_exec"
 
        # Compatibility with backup-pull(1) script: Restore global values ...
@@ -370,7 +417,26 @@ for f in $sys; do
        post_exec="$post_exec_saved"
 
        # Validate configuration
-       [ "$system" = "localhost" -o "$system" = "127.0.0.1" ] && local=1
+       if [[ "$system" = "localhost" || "$system" = "127.0.0.1" ]]; then
+               # Local system
+               local=1
+               compress=0
+       fi
+
+       # Make sure "source" ends with a slash ("/")
+       case "$source" in
+         "*/")
+               ;;
+         "*")
+               source="$source/"
+       esac
+
+       # Make sure "target" DOESN'T end with a slash ("/")
+       case "$target" in
+         "*/")
+               target=$( echo "$target" | sed -e 's/\/$//g' )
+               ;;
+       esac
 
        [ "$system" = "$fname" ] \
                && systxt="\"$system\"" \
@@ -393,7 +459,7 @@ for f in $sys; do
 
        sys_target="$target/$fname"
        sys_root="$sys_target"
-       if [ "$DRYRUN" -eq 0 -a ! -e "$sys_target" ]; then
+       if [[ "$DRYRUN" -eq 0 && ! -e "$sys_target" ]]; then
                if [ $generations -gt 0 ]; then
                        CreateSubvolume "$sys_target"
                else
@@ -405,7 +471,7 @@ for f in $sys; do
                fi
        fi
 
-       if [ "$local" -eq 0 -a "$ping" -ne 0 ]; then
+       if [[ "$local" -eq 0 && "$ping" -ne 0 ]]; then
                # Check if system is alive
                ping -c 1 "$system" >/dev/null 2>&1
                if [ $? -ne 0 ]; then
@@ -426,7 +492,7 @@ for f in $sys; do
 
                Initialize_Last_SysTarget_Snapshot "$sys_target" || continue
 
-               if [ -n "$last" -a ! -e "$last/.stamp" ]; then
+               if [[ -n "$last" && ! -e "$last/.stamp" ]]; then
                        # Old backup directory without "stamp file", continue
                        echo "Found incomplete snapshot in \"$last\", reusing and renaming it ..."
                        RenameSubvolume "$last" "$sys_target"
@@ -445,7 +511,7 @@ for f in $sys; do
                                fi
                                echo "Created new snapshot in \"$snapshot\"."
                        else
-                               echo " *** Trial run, not creating new snapshot in \"$sys_target\"!"
+                               echo " *** Trial run, not creating new snapshot in \"$snapshot\"!"
                        fi
                else
                        # No old backup found, create new subvolume
@@ -476,23 +542,52 @@ for f in $sys; do
        fi
 
        # prepare (remote) command ...
-       cmd="rsync --archive"
-       [ "$compress" -ne 0 ] && cmd="$cmd --compress"
-       [ "$local" -eq 0 ] && cmd="$cmd --rsh=\"$ssh_cmd\""
-       cmd="$cmd --delete --delete-excluded --sparse"
-       [ "$VERBOSE" -gt 0 ] && cmd="$cmd --progress"
-       if [ "$source_root" = "$default_source_root" ]; then
-               cmd="$cmd --exclude=/dev --exclude=/proc --exclude=/sys"
-               cmd="$cmd --exclude=/run --exclude=/tmp --exclude=/var/tmp"
-               cmd="$cmd --exclude=/media --exclude=/mnt --exclude=/net"
-               cmd="$cmd --exclude=/var/cache/apt --exclude=/var/log"
+       if [[ "$backup_type" == "rsync" ]]; then
+               cmd="$rsync --archive"
+               [ "$compress" -ne 0 ] && cmd="$cmd --compress"
+               [ "$local" -eq 0 ] && cmd="$cmd --rsh=\"$ssh_cmd\""
+               cmd="$cmd --delete --delete-excluded --sparse"
+               if [ "$VERBOSE" -gt 0 ]; then
+                       [ "$rsync_proto" -ge 31 ] \
+                               && cmd="$cmd --info=progress2" \
+                               || cmd="$cmd --progress"
+               fi
+               if [ "$source_root" = "$default_source_root" ]; then
+                       for dir in \
+                               "/dev/**" \
+                               "/media/**" \
+                               "/mnt/**" \
+                               "/net/**" \
+                               "/proc/**" \
+                               "/run/**" \
+                               "/sys/**" \
+                               "/tmp/**" \
+                               "/var/cache/apt/**" \
+                               "/var/log/**" \
+                               "/var/tmp/**" \
+                       ; do
+                               cmd="$cmd --exclude=$dir"
+                       done
+               fi
+               [ -n "$exclude_args_add" ] && cmd="$cmd $exclude_args_add"
+               for dir in $exclude_dirs_add; do
+                       cmd="$cmd --exclude=$dir"
+               done
+               [ -n "$rsync_args_add" ] && cmd="$cmd $rsync_args_add"
+
+               [ "$local" -eq 0 ] \
+                       && cmd="$cmd ${user}@${system}:$source_root $sys_target/" \
+                       || cmd="$cmd $source_root $sys_target/"
+       elif [[ "$backup_type" == "scp" ]]; then
+               cmd="scp"
+               [ "$VERBOSE" -eq 0 ] && cmd="$cmd -q"
+               for file in $files; do
+                       cmd="$cmd ${user}@${system}:$file $sys_target/"
+               done
+       else
+               echo "Backup type \"$backup_type\" undefined, \"$system\" skipped!"
+               echo; continue
        fi
-       [ -n "$exclude_args_add" ] && cmd="$cmd $exclude_args_add"
-       [ -n "$rsync_args_add" ] && cmd="$cmd $rsync_args_add"
-
-       [ "$local" -eq 0 ] \
-               && cmd="$cmd ${user}@${system}:$source_root $sys_target/" \
-               || cmd="$cmd $source_root $sys_target/"
 
        echo "Backing up to \"$sys_target\" ..."
        echo -n "Start date: "; date
@@ -501,22 +596,32 @@ for f in $sys; do
        ok=0
 
        if [ "$DRYRUN" -eq 0 ]; then
-               rm -f "$sys_target/.stamp"
+               stamp_file="$sys_target/.stamp"
+               rm -f "$stamp_file"
+
+               # Execute backup command:
+               start_t=$(date "+%s")
                $SHELL -c "$cmd"; ret=$?
-               echo "code=$ret" >"$sys_target/.stamp"
+               end_t=$(date "+%s")
+
+               echo "code=$ret" >"$stamp_file"
+               echo "start_t=$start_t" >>"$stamp_file"
+               echo "end_t=$end_t" >>"$stamp_file"
+               echo "cmd='$cmd'" >>"$stamp_file"
+               echo "backup_host='`hostname -f`'" >>"$stamp_file"
+               echo "backup_user='`id -un`'" >>"$stamp_file"
        else
-               echo " *** Trial run, not executing synchronization command!"
+               echo " *** Trial run, not executing save command!"
                ret=0
        fi
 
        if [ $ret -eq 20 ]; then
                echo "Backup of \"$system\" interrupted. Aborting ..."
-               CleanUp
-               exit 1
+               GotSignal
        fi
 
        echo -n "End date: "; date
-       if [ $ret -eq 0 -o $ret -eq 24 ]; then
+       if [[ $ret -eq 0 || $ret -eq 24 ]]; then
                [ $ret -eq 24 ] && count_ok_vanished=$count_ok_vanished+1
 
                echo "System \"$system\" completed with status $ret, OK."
@@ -540,7 +645,7 @@ for f in $sys; do
                # Clean up old generations
                declare -i gen_count=$generations+2
                to_delete=$(ls -1t "$sys_root" 2>/dev/null | tail -n+$gen_count | sort)
-               if [ -n "$to_delete" -a $ok -eq 1 ]; then
+               if [[ -n "$to_delete" && $ok -eq 1 ]]; then
                        [ "$DRYRUN" -eq 0 ] \
                                && echo "Deleting old backup generations (keep $generations) ..." \
                                || echo " *** Trial run, not deleting old generations:"
@@ -573,10 +678,27 @@ done
 
 sync
 
-paths=$( echo $destinations | sed -e 's/ /\n/g' | sort | uniq )
-if [ "$DRYRUN" -eq 0 -a -n "$paths" ]; then
-       df -h $paths
-       echo
+if [ "$DRYRUN" -eq 0 ]; then
+       paths=""
+       paths_zfs=""
+       for dest in $(echo $destinations | sed -e 's/ /\n/g' | sort | uniq); do
+               fs=$(GetFS "$dest")
+               case $fs in
+                 "zfs" )
+                       paths_zfs="$paths_zfs $dest"
+                       ;;
+                 *)
+                       paths="$paths $dest"
+               esac
+       done
+       if [ -n "$paths" ]; then
+               df -h $paths
+               echo
+       fi
+       if [ -n "$paths_zfs" ]; then
+               zfs list $paths_zfs
+               echo
+       fi
 fi
 
 CleanUp
@@ -593,6 +715,9 @@ echo
 if [ $count_started -ne $count_ok ]; then
        echo "----->  THERE HAVE BEEN ERRORS!  <-----"
        echo
+       exit 6
+elif [ $count_all -ne $count_started ]; then
+       exit 7
 fi
 
 # -eof-