X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=bin%2Fbackup-script;h=f2df4db98220e0b12472249e53a883c0ff0db2d0;hb=819cfa029a3c4ce35bf22e99bf7a1b0d594b3a91;hp=412d7b6a12429582244d20d3bba5986d75cfc598;hpb=8c6c789332d73ae45043ad2bba75dea8af89408b;p=backup-script.git

diff --git a/bin/backup-script b/bin/backup-script
index 412d7b6..f2df4db 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,8 @@ PIDFILE="/var/run/$NAME.pid"
 
 DRYRUN=0
 VERBOSE=0
+TAG=""
+PREPOSTEXEC=1
 
 export LC_ALL=C
 
@@ -22,6 +24,7 @@ declare -i count_all=0
 declare -i count_started=0
 declare -i count_ok=0
 declare -i count_ok_vanished=0
+declare -i count_enabled=0
 
 destinations=""
 
@@ -29,40 +32,47 @@ destinations=""
 [ -d "/usr/local/etc/backup-script.d" ] \
 	&& conf_d="/usr/local/etc/backup-script.d" \
 	|| conf_d="/etc/backup-script.d"
+setup_exec=""
 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_io_timeout="1800"
 default_job_pre_exec=""
 default_job_post_exec=""
+default_tags=""
 
 Usage() {
-	echo "Usage: $NAME [<options>] [<system> [<system> [...]]]"
+	echo "Usage: $NAME [<options>] [<job> [<job> [...]]]"
 	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 "  -x, --no-exec       Don't run global pre-/post-exec commands."
 	echo
-	echo "When no <system> is given, all defined systems are used."
+	echo "When no <job> is given, all defined systems are used."
 	echo
-	echo "Configuration file is \"$conf\","
-	echo "using \"$conf_d\" as configuration directory."
+	# shellcheck disable=SC2086
+	echo -e $config_info
 	echo
-	exit 1
+	exit 2
 }
 
 CleanUp() {
-	if [ -n "$post_exec" ]; then
+	if [[ -n "$pre_exec" && $PREPOSTEXEC -ne 0 ]]; then
 		echo "Executing \"$post_exec\" ..."
-		sh -c $post_exec
-		if [ $? -ne 0 ]; then
+		if ! sh -c $post_exec; then
 			echo "Warning: post-exec command failed!"
 		fi
 		echo
@@ -72,7 +82,7 @@ CleanUp() {
 
 GotSignal() {
 	echo
-	echo "--> Got break signal, cleaning up & aborting ..."
+	echo "--> Got signal, cleaning up & aborting ..."
 	echo
 	CleanUp
 	echo -n "Aborted: "; date
@@ -156,7 +166,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"
 		;;
 	  *)
@@ -226,6 +236,7 @@ Initialize_Last_SysTarget_Snapshot() {
 	case "$fs" in
 	  "btrfs")
 		# Search directory of last generation, if any
+		# shellcheck disable=SC2012
 		last=$(ls -1d "$sys_target"/[0-9]* 2>/dev/null | sort -r | head -n1)
 		if [ -n "$last" ]; then
 			if [ ! -d "$last" ]; then
@@ -266,12 +277,23 @@ Initialize_Last_SysTarget_Snapshot() {
 # Search configuration file (last one is used as default!)
 for conf in \
 	"/usr/local/etc/backup-script.conf" \
-	"${conf_d}/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")
@@ -280,6 +302,13 @@ while [ $# -gt 0 ]; do
 	  "-p"|"--progress")
 		VERBOSE=1; shift
 		;;
+	  "-t"|"--tag")
+		shift; TAG="$1"; shift
+		[ -n "$TAG" ] || Usage
+		;;
+	  "-x"|"--no-exec")
+		PREPOSTEXEC=0; shift
+		;;
 	  "-"*)
 		Usage
 		;;
@@ -288,31 +317,48 @@ while [ $# -gt 0 ]; do
 	esac
 done
 
-trap GotSignal SIGINT
-
 echo -n "Started: "; date
+echo -e "$config_info"
 
-# Read in configuration file
-if [ -r "$conf" ]; then
-	echo "Reading configuration: \"$conf\" ..."
-	source "$conf"
-else
-	echo "No configuration file found, using defaults."
+# Check rsync and its protocol version
+if ! rsync=$(which "rsync" 2>/dev/null); then
+	echo "Failed to detect rsync(1)! Is it installed in your \$PATH?"
+	exit 1
 fi
+if ! rsync_proto=$($rsync --version 2>/dev/null | head -n 1 | sed 's/.*  protocol version \([0-9]*\)$/\1/'); 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
 
 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
+
+if [[ -n "$setup_exec" && $PREPOSTEXEC -ne 0 ]]; then
+	echo "Executing \"$setup_exec\" ..."
+	if ! sh -c $setup_exec; then
+		echo "Error: setup command failed!"; echo
+		echo "Aborting backup."; echo
+		exit 5
+	fi
+	sleep 2
+	echo
 fi
 
+trap GotSignal SIGINT SIGTERM
+
 # check and create PID file
 if [ -e "$PIDFILE" ]; then
 	echo "Lockfile \"$PIDFILE\" already exists."
@@ -320,31 +366,29 @@ if [ -e "$PIDFILE" ]; then
 	echo
 	echo -n "Aborted: "; date
 	echo
-	exit 3
+	exit 4
 fi
-touch "$PIDFILE" 2>/dev/null
-if [ $? -ne 0 ]; then
+if ! touch "$PIDFILE" 2>/dev/null; then
 	echo "Warning: can't create PID file \"$PIDFILE\"!"
 	echo
 else
 	echo "$$" >>"$PIDFILE"
 fi
 
-if [ -n "$pre_exec" ]; then
+if [[ -n "$pre_exec" && $PREPOSTEXEC -ne 0 ]]; then
 	echo "Executing \"$pre_exec\" ..."
-	sh -c $pre_exec
-	if [ $? -ne 0 ]; then
+	if ! sh -c $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
@@ -355,40 +399,46 @@ 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"
+	io_timeout="$default_io_timeout"
 
 	# 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
-	unset host
+	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" -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 ...
@@ -396,14 +446,33 @@ 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
-	  "*/")
+	# 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
+		if ! echo "$tags" | grep -E "(^|,)$TAG(,|$)" >/dev/null 2>&1; 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="$source/"
+	  *)
+		source_root="$source_root/"
 	esac
 
 	# Make sure "target" DOESN'T end with a slash ("/")
@@ -422,6 +491,14 @@ for f in $sys; do
 
 	count_all=$count_all+1
 
+	# Check if job is disabled
+	if [ "$backup_type" = "disabled" ]; then
+		echo "Job is DISABLED and will be skipped."
+		echo; continue
+	fi
+
+	count_enabled=$count_enabled+1
+
 	# Check target directory
 	if [ -z "$target" ]; then
 		echo "No target directory specified for \"$system\"!? Skipped!"
@@ -434,22 +511,21 @@ 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"
+			CreateSubvolume "$sys_target"; r=$?
 		else
-			mkdir -p "$sys_target"
+			mkdir -p "$sys_target"; r=$?
 		fi
-		if [ $? -ne 0 ]; then
+		if [ $r -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
+		if ! ping -c 1 "$system" >/dev/null 2>&1; then
 			echo "Host \"$system\" seems not to be alive!? Skipped."
 			echo; continue
 		fi
@@ -467,11 +543,10 @@ 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"
-			if [ $? -ne 0 ]; then
+			if ! RenameSubvolume "$last" "$sys_target"; then
 				echo "Failed to rename last snapshot \"$last\" to \"$sys_target\"!? \"$system\" skipped!"
 				echo; continue
 			fi
@@ -517,23 +592,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=$io_timeout"
+		[ "$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
@@ -542,22 +648,34 @@ 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"
+			echo "start_t=$start_t"
+			echo "end_t=$end_t"
+			echo "cmd='$cmd'"
+			echo "backup_host='$(hostname -f)'"
+			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."
@@ -580,8 +698,9 @@ for f in $sys; do
 		fi
 		# Clean up old generations
 		declare -i gen_count=$generations+2
+		# shellcheck disable=SC2012
 		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:"
@@ -593,18 +712,18 @@ for f in $sys; do
 				fi
 				last=$(stat "$dir/.stamp" 2>/dev/null | grep "^Modify: " \
 				 | cut -d':' -f2- | cut -d. -f1)
+				# shellcheck disable=SC2086
 				echo "Removing backup from" $last "..."
 				if [ "$DRYRUN" -eq 0 ]; then
-					DeleteSubvolume "$dir"
-					[ $? -eq 0 ] || \
-					  echo "Failed to delete \"$dir\"!"
+					DeleteSubvolume "$dir" \
+						|| echo "Failed to delete \"$dir\"!"
 				fi
 			done
 			echo -n "Clean up finished: "; date
 		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
 
@@ -614,10 +733,30 @@ 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=""
+	# shellcheck disable=SC2086
+	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
+		# shellcheck disable=SC2086
+		df -h $paths
+		echo
+	fi
+	if [ -n "$paths_zfs" ]; then
+		# shellcheck disable=SC2086
+		zfs list $paths_zfs
+		echo
+	fi
 fi
 
 CleanUp
@@ -625,7 +764,9 @@ CleanUp
 echo -n "Done: "; date
 echo
 [ $count_all -eq 1 ] && s="" || s="s"
-echo " - $count_all job$s defined,"
+[ $count_enabled -eq $count_all ] \
+	&& echo " - $count_all job$s defined (all enabled)," \
+	|| echo " - $count_all job$s defined ($count_enabled enabled),"
 [ $count_started -eq 1 ] && s="" || s="s"
 echo " - $count_started job$s started,"
 echo " - $count_ok done without errors."
@@ -634,6 +775,9 @@ echo
 if [ $count_started -ne $count_ok ]; then
 	echo "----->  THERE HAVE BEEN ERRORS!  <-----"
 	echo
+	exit 6
+elif [ $count_enabled -ne $count_started ]; then
+	exit 7
 fi
 
 # -eof-