X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=bin%2Fbackup-script;h=f585d42a815935277a386c5efe1ea6eb6e6626c0;hb=62d13a08821610678998f401c3cf1b47634bf07c;hp=457a5e7be4a1bdbbc47702be179894da77ef0b03;hpb=82fb77853d44e04b65e94db844be9d2a51542e81;p=backup-script.git

diff --git a/bin/backup-script b/bin/backup-script
index 457a5e7..f585d42 100755
--- a/bin/backup-script
+++ b/bin/backup-script
@@ -1,7 +1,7 @@
 #!/bin/bash
 #
 # backup-script system for cloning systems using rsync
-# Copyright (c)2008-2015 Alexander Barton <alex@barton.de>
+# Copyright (c)2008-2016 Alexander Barton <alex@barton.de>
 #
 # 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
@@ -15,6 +15,7 @@ PIDFILE="/var/run/$NAME.pid"
 
 DRYRUN=0
 VERBOSE=0
+TAG=""
 
 export LC_ALL=C
 
@@ -26,31 +27,40 @@ 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
 default_generations=0
 default_job_pre_exec=""
 default_job_post_exec=""
+default_tags=""
 
 Usage() {
 	echo "Usage: $NAME [<options>] [<system> [<system> [...]]]"
 	echo
-	echo "  -p, --progress    Show progress, see rsync(1)."
-	echo "  -n, --dry-run     Test run only, don't copy any data."
+	echo "  -n, --dry-run       Test run only, don't copy any data."
+	echo "  -p, --progress      Show progress, see rsync(1)."
+	echo "  -t TAG, --tag TAG   Only run jobs with tag TAG."
 	echo
 	echo "When no <system> is given, all defined systems are used."
 	echo
-	exit 1
+	echo -e $config_info
+	echo
+	exit 2
 }
 
 CleanUp() {
@@ -72,6 +82,7 @@ GotSignal() {
 	CleanUp
 	echo -n "Aborted: "; date
 	echo
+	sleep 3
 	exit 9
 }
 
@@ -122,6 +133,9 @@ CreateSubvolume() {
 	  "btrfs")
 		btrfs subvolume create "$volume"  >/dev/null || return 1
 		;;
+	  "zfs")
+		zfs create "$(echo "$volume" | cut -c2-)" || return 1
+		;;
 	  *)
 		echo "CreateSubvolume: Incompatible FS type \"$fs\" on \"$dir\"!"
 		return 9
@@ -135,6 +149,7 @@ CloneSubvolume() {
 	local snapshot="$3"
 	local dir
 	local fs
+	local link_name
 
 	dir=$(dirname "source")
 	fs=$(GetFS "$source")
@@ -142,6 +157,13 @@ CloneSubvolume() {
 	  "btrfs")
 		btrfs subvolume snapshot "$source" "$snapshot"  >/dev/null || return 1
 		;;
+	  "zfs")
+		zfs snapshot "$snapshot" || return 1
+		link_name="$(echo "$snapshot" | cut -d@ -f2-)"
+		ln -s \
+			"current/.zfs/snapshot/$link_name" \
+			"$(dirname "$volume")/$link_name"
+		;;
 	  *)
 		echo "CloneSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
 		return 9
@@ -159,6 +181,12 @@ RenameSubvolume() {
 	  "btrfs")
 		mv "$source" "$target" || return 1
 		;;
+	  "zfs")
+		zfs rename \
+		  "$(echo "$source" | cut -c2-)" \
+		  "$(echo "$target" | cut -c2-)" \
+			|| return 1
+		;;
 	  *)
 		echo "RenameSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
 		return 9
@@ -169,12 +197,24 @@ RenameSubvolume() {
 DeleteSubvolume() {
 	local volume="$1"
 	local fs
+	local id
+	local snapshot
 
-	fs=$(GetFS "$source")
+	fs=$(GetFS "$volume")
 	case "$fs" in
 	  "btrfs")
 		btrfs subvolume delete "$volume" >/dev/null || return 1
 		;;
+	  "zfs")
+		id="$(basename "$volume")"
+		if [ -h "$volume" ]; then
+			snapshot="$(dirname "$volume")/current@$id"
+		else
+			snapshot="$volume"
+		fi
+		zfs destroy -r "$(echo "$snapshot" | cut -c2-)" >/dev/null || return 1
+		[ -h "$volume" ] && rm "$volume"
+		;;
 	  *)
 		echo "DeleteSubvolume: Incompatible FS type \"$fs\" on \"$volume\"!"
 		return 9
@@ -182,6 +222,72 @@ DeleteSubvolume() {
 	return 0
 }
 
+Initialize_Last_SysTarget_Snapshot() {
+	sys_target="$1"
+	unset last
+	unset snapshot
+
+	fs=$(GetFS "$sys_target")
+	case "$fs" in
+	  "btrfs")
+		# Search directory of last generation, if any
+		last=$(ls -1d "$sys_target"/[0-9]* 2>/dev/null | sort -r | head -n1)
+		if [ -n "$last" ]; then
+			if [ ! -d "$last" ]; then
+				echo "Last snapshot \"$last\" seems not to be a directory!? \"$system\" skipped!"
+				echo
+				return 1
+			fi
+		fi
+		sys_target="$sys_target/$(date +%Y%m%d-%H%M%S)"
+		snapshot="$sys_target"
+		;;
+	  "zfs")
+		# On ZFS, the last generation is always named "current"
+		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"
+		;;
+	  *)
+		echo "Initialize_Last_SysTarget_Snapshot: Incompatible FS type \"$fs\" on \"$sys_target\"!"
+		return 1
+	esac
+	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
+	# shellcheck source=/dev/null
+	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")
@@ -190,6 +296,10 @@ while [ $# -gt 0 ]; do
 	  "-p"|"--progress")
 		VERBOSE=1; shift
 		;;
+	  "-t"|"--tag")
+		shift; TAG="$1"; shift
+		[ -n "$TAG" ] || Usage
+		;;
 	  "-"*)
 		Usage
 		;;
@@ -198,28 +308,37 @@ 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."
+
+[[ -n "$TAG" ]] && echo "Running jobs tagged with \"$TAG\"."
 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"
+		sys+=("${conf_d}/$s")
 	done
 else
-	sys="${conf_d}/"*
+	sys=("${conf_d}/"*)
 fi
 
 # check and create PID file
@@ -229,7 +348,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
@@ -246,14 +365,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
+for f in "${sys[@]}"; do
+	[[ -r "$f" && -f "$f" ]] || continue
 
 	fname=$(basename "$f")
 	case "$fname" in
@@ -264,24 +383,88 @@ 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"
 	generations="$default_generations"
 	job_pre_exec="$default_job_pre_exec"
 	job_post_exec="$default_job_post_exec"
+	tags="$default_tags"
+
+	# Compatibility with backup-pull(1) script: Save global values ...
+	pre_exec_saved="$pre_exec"
+	post_exec_saved="$post_exec"
+
+	# Compatibility with backup-pull(1) script: Set defaults
+	host=""
+	unset source
+	unset pre_exec
+	unset post_exec
 
 	# Read in system configuration file
+	# shellcheck source=/dev/null
 	source "$f"
 
+	# Compatibility with backup-pull(1) script: Fix up configuration
+	[[ "$system" = "$fname" && -n "$host" ]] \
+		&& system="$host"
+	[[ "$source_root" = "$default_source_root" && -n "$source" ]] \
+		&& source_root="$source"
+	[[ -z "$job_pre_exec" && -n "$pre_exec" ]] \
+		&& job_pre_exec="$pre_exec"
+	[[ -z "$job_post_exec" && -n "$post_exec" ]] \
+		&& job_post_exec="$post_exec"
+
+	# Compatibility with backup-pull(1) script: Restore global values ...
+	pre_exec="$pre_exec_saved"
+	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
+
+	# Add "NONE" tag when no tags are given in the config file:
+	[[ -z "$tags" ]] && tags="NONE"
+	# Add "auto-tags":
+	[[ "$local" -eq 1 ]] && tags="$tags,LOCAL"
+	# Check tags
+	if [[ -n "$TAG" && "$TAG" != "ALL" ]]; then
+		echo "$tags" | grep -E "(^|,)$TAG(,|$)" >/dev/null 2>&1
+		if [ $? -ne 0 ]; then
+			if [ "$DRYRUN" -ne 0 ]; then
+				echo "Tags of system \"$system\" don't match \"$TAG\": \"$tags\". Skipped."
+				echo
+			fi
+			continue
+		fi
+	fi
+
+	# Make sure "source_root" ends with a slash ("/")
+	case "$source_root" in
+	  *"/")
+		;;
+	  *)
+		source_root="$source_root/"
+	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\"" \
@@ -304,15 +487,19 @@ for f in $sys; do
 
 	sys_target="$target/$fname"
 	sys_root="$sys_target"
-	if [ "$DRYRUN" -eq 0 ]; then
-		mkdir -p "$sys_target" >/dev/null 2>&1
+	if [[ "$DRYRUN" -eq 0 && ! -e "$sys_target" ]]; then
+		if [ $generations -gt 0 ]; then
+			CreateSubvolume "$sys_target"
+		else
+			mkdir -p "$sys_target"
+		fi
 		if [ $? -ne 0 ]; then
 			echo "Can't create \"$sys_target\"!? \"$system\" skipped!"
 			echo; continue
 		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
@@ -331,18 +518,9 @@ for f in $sys; do
 			echo; continue
 		fi
 
-		# Search directory of last generation, if any
-		last=$(ls -1d "$sys_target"/[0-9]* 2>/dev/null | sort -r | head -n1)
-		if [ -n "$last" ]; then
-			if [ ! -d "$last" ]; then
-				echo "Last snapshot \"$last\" seems not to be a directory!? \"$system\" skipped!"
-				echo; continue
-			fi
-		fi
-		sys_target="$sys_target/$(date +%Y%m%d-%H%M%S)"
-		snapshot="$sys_target"
+		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"
@@ -361,7 +539,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
@@ -392,23 +570,54 @@ 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 --timeout=900"
+		[ "$compress" -ne 0 ] && cmd="$cmd --compress"
+		[ "$local" -eq 0 ] && cmd="$cmd --rsh=\"$ssh_cmd\""
+		cmd="$cmd --delete-during --delete-excluded --sparse"
+		if [ "$VERBOSE" -gt 0 ]; then
+			[ "$rsync_proto" -ge 31 ] \
+				&& cmd="$cmd --info=progress2" \
+				|| cmd="$cmd --progress"
+		fi
+		set -f
+		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"
+		set +f
+
+		[ "$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
@@ -417,22 +626,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."
@@ -456,7 +675,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:"
@@ -479,7 +698,7 @@ for f in $sys; do
 		elif [ -n "$to_delete" ]; then
 			echo "There have been errors, not cleaning up old generations!"
 		else
-			echo "Nothing to clean up."
+			echo "Nothing to clean up (keep up to $generations generations)."
 		fi
 	fi
 
@@ -489,10 +708,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
@@ -509,6 +745,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-