3 # backup-script system for cloning systems using rsync
4 # Copyright (c)2008-2015 Alexander Barton <alex@barton.de>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 # Please read the file COPYING, README and AUTHORS for more information.
14 PIDFILE="/var/run/$NAME.pid"
21 declare -i count_all=0
22 declare -i count_started=0
24 declare -i count_ok_vanished=0
28 # Default settings, can be overwritten in backup-script.conf:
29 [ -d "/usr/local/etc/backup-script.d" ] \
30 && conf_d="/usr/local/etc/backup-script.d" \
31 || conf_d="/etc/backup-script.d"
34 default_source_root="/"
35 default_target="/var/backups"
37 default_ssh_args_add=""
38 default_rsync_args_add=""
39 default_exclude_args_add=""
40 default_exclude_dirs_add=""
45 default_job_pre_exec=""
46 default_job_post_exec=""
49 echo "Usage: $NAME [<options>] [<system> [<system> [...]]]"
51 echo " -p, --progress Show progress, see rsync(1)."
52 echo " -n, --dry-run Test run only, don't copy any data."
54 echo "When no <system> is given, all defined systems are used."
62 if [ -n "$post_exec" ]; then
63 echo "Executing \"$post_exec\" ..."
66 echo "Warning: post-exec command failed!"
75 echo "--> Got break signal, cleaning up & aborting ..."
78 echo -n "Aborted: "; date
88 echo "Running job ${what}-exec command ..."
90 && cmd="$ssh_cmd ${user}@${system} $cmd"
91 echo -n "Start date (${what}-exec): "; date
93 if [ "$DRYRUN" -eq 0 ]; then
94 $SHELL -c "$cmd"; local ret=$?
96 echo " *** Trial run, not executing ${what}-exec command!"
100 && echo "The ${what}-exec command completed with status 0, OK." \
101 || echo "The ${what}-exec command completed with ERRORS, code $ret!"
108 while [ -n "$dir" ]; do
109 findmnt -fn -o FSTYPE --raw "$dir" 2>/dev/null; local r=$?
110 if [ $r -eq 0 ]; then
112 elif [ $r -eq 127 ]; then
116 dir=$(dirname "$dir") || return 1
125 dir=$(dirname "$volume")
129 btrfs subvolume create "$volume" >/dev/null || return 1
132 zfs create "$(echo "$volume" | cut -c2-)" || return 1
135 echo "CreateSubvolume: Incompatible FS type \"$fs\" on \"$dir\"!"
149 dir=$(dirname "source")
150 fs=$(GetFS "$source")
153 btrfs subvolume snapshot "$source" "$snapshot" >/dev/null || return 1
156 zfs snapshot "$snapshot" || return 1
157 link_name="$(echo "$snapshot" | cut -d@ -f2-)"
159 "current/.zfs/snapshot/$link_name" \
160 "$(dirname "$volume")/$link_name"
163 echo "CloneSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
174 fs=$(GetFS "$source")
177 mv "$source" "$target" || return 1
181 "$(echo "$source" | cut -c2-)" \
182 "$(echo "$target" | cut -c2-)" \
186 echo "RenameSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
198 fs=$(GetFS "$volume")
201 btrfs subvolume delete "$volume" >/dev/null || return 1
204 id="$(basename "$volume")"
205 if [ -h "$volume" ]; then
206 snapshot="$(dirname "$volume")/current@$id"
210 zfs destroy -r "$(echo "$snapshot" | cut -c2-)" >/dev/null || return 1
211 [ -h "$volume" ] && rm "$volume"
214 echo "DeleteSubvolume: Incompatible FS type \"$fs\" on \"$volume\"!"
220 Initialize_Last_SysTarget_Snapshot() {
225 fs=$(GetFS "$sys_target")
228 # Search directory of last generation, if any
229 last=$(ls -1d "$sys_target"/[0-9]* 2>/dev/null | sort -r | head -n1)
230 if [ -n "$last" ]; then
231 if [ ! -d "$last" ]; then
232 echo "Last snapshot \"$last\" seems not to be a directory!? \"$system\" skipped!"
237 sys_target="$sys_target/$(date +%Y%m%d-%H%M%S)"
238 snapshot="$sys_target"
241 # On ZFS, the last generation is always named "current"
242 if [ -e "$sys_target/current" ]; then
243 last="$sys_target/current"
244 if [ "$(uname)" = "Linux" ]; then
245 date=$(LC_ALL=C stat "$1" | grep "^Modify: " \
246 | cut -d':' -f2- | cut -d. -f1)
248 date=$(LC_ALL=C stat -f "%Sc" "$1")
250 date=$(echo "$date" | sed -e's/^ //g' -e 's/[-:]//g' -e 's/ /-/g')
254 date="$(date +%Y%m%d-%H%M%S)"
256 snapshot="$(echo "$sys_target/current" | cut -c2-)@$date"
257 sys_target="$sys_target/current"
260 echo "Initialize_Last_SysTarget_Snapshot: Incompatible FS type \"$fs\" on \"$sys_target\"!"
266 # Search configuration file (last one is used as default!)
268 "/usr/local/etc/backup-script.conf" \
269 "/etc/backup-script.conf" \
270 "${conf_d}/backup-script.conf" \
271 "/usr/local/etc/backup-script.conf" \
273 [ -r "$conf" ] && break
276 # Read in configuration file
277 config_info="Configuration file is \"$conf\""
278 if [ -r "$conf" ]; then
281 config_info="${config_info} (not readable, using defaults)"
283 config_info="${config_info},\nusing \"$conf_d\" as configuration directory."
285 while [ $# -gt 0 ]; do
301 echo -n "Started: "; date
302 echo -e "$config_info"
304 # Check rsync and its protocol version
305 rsync=$(which "rsync" 2>/dev/null)
306 if [ $? -ne 0 ]; then
307 echo "Failed to detect rsync(1)! Is it installed in your \$PATH?"
310 rsync_proto=$($rsync --version 2>/dev/null | head -n 1 | sed 's/.* protocol version \([0-9]*\)$/\1/')
311 if [ $? -ne 0 ]; then
312 echo "Failed to detect protocol version of $rsync!"
315 echo "Rsync command is $rsync, protocol version $rsync_proto."
318 trap GotSignal SIGINT
320 if [ $# -ge 1 ]; then
322 if [ ! -r "${conf_d}/$s" ]; then
323 echo "$NAME: Can' read \"${conf_d}/$s\"!"
326 sys="$sys ${conf_d}/$s"
332 # check and create PID file
333 if [ -e "$PIDFILE" ]; then
334 echo "Lockfile \"$PIDFILE\" already exists."
335 echo "Is an other instance still running?"
337 echo -n "Aborted: "; date
341 touch "$PIDFILE" 2>/dev/null
342 if [ $? -ne 0 ]; then
343 echo "Warning: can't create PID file \"$PIDFILE\"!"
346 echo "$$" >>"$PIDFILE"
349 if [ -n "$pre_exec" ]; then
350 echo "Executing \"$pre_exec\" ..."
352 if [ $? -ne 0 ]; then
353 echo "Error: pre-exec command failed!"; echo
355 echo "Aborting backup."; echo
363 [ -r "$f" -a -f "$f" ] || continue
365 fname=$(basename "$f")
367 "backup-script.conf"|*.sh)
372 # Set global defaults
375 source_root="$default_source_root"
376 target="$default_target"
377 ssh_args_add="$default_ssh_args_add"
378 rsync_args_add="$default_rsync_args_add"
379 exclude_args_add="$default_exclude_args_add"
380 exclude_dirs_add="$default_exclude_dirs_add"
381 compress="$default_compress"
383 local="$default_local"
384 generations="$default_generations"
385 job_pre_exec="$default_job_pre_exec"
386 job_post_exec="$default_job_post_exec"
388 # Compatibility with backup-pull(1) script: Save global values ...
389 pre_exec_saved="$pre_exec"
390 post_exec_saved="$post_exec"
392 # Compatibility with backup-pull(1) script: Set defaults
398 # Read in system configuration file
401 # Compatibility with backup-pull(1) script: Fix up configuration
402 [ "$system" = "$fname" -a -n "$host" ] \
404 [ "$source_root" = "$default_source_root" -a -n "$source" ] \
405 && source_root="$source"
406 [ -z "$job_pre_exec" -a -n "$pre_exec" ] \
407 && job_pre_exec="$pre_exec"
408 [ -z "$job_post_exec" -a -n "$post_exec" ] \
409 && job_post_exec="$post_exec"
411 # Compatibility with backup-pull(1) script: Restore global values ...
412 pre_exec="$pre_exec_saved"
413 post_exec="$post_exec_saved"
415 # Validate configuration
416 if [ "$system" = "localhost" -o "$system" = "127.0.0.1" ]; then
422 # Make sure "source" ends with a slash ("/")
430 # Make sure "target" DOESN'T end with a slash ("/")
433 target=$( echo "$target" | sed -e 's/\/$//g' )
437 [ "$system" = "$fname" ] \
438 && systxt="\"$system\"" \
439 || systxt="\"$fname\" [\"$system\"]"
441 && echo "Working on $systxt ..." \
442 || echo "Working on $systxt (local system) ..."
444 count_all=$count_all+1
446 # Check target directory
447 if [ -z "$target" ]; then
448 echo "No target directory specified for \"$system\"!? Skipped!"
451 if [ ! -d "$target" ]; then
452 echo "Target \"$target\" is not a directory!? \"$system\" skipped!"
456 sys_target="$target/$fname"
457 sys_root="$sys_target"
458 if [ "$DRYRUN" -eq 0 -a ! -e "$sys_target" ]; then
459 if [ $generations -gt 0 ]; then
460 CreateSubvolume "$sys_target"
462 mkdir -p "$sys_target"
464 if [ $? -ne 0 ]; then
465 echo "Can't create \"$sys_target\"!? \"$system\" skipped!"
470 if [ "$local" -eq 0 -a "$ping" -ne 0 ]; then
471 # Check if system is alive
472 ping -c 1 "$system" >/dev/null 2>&1
473 if [ $? -ne 0 ]; then
474 echo "Host \"$system\" seems not to be alive!? Skipped."
477 echo "OK, host \"$system\" seems to be alive."
480 if [ $generations -gt 0 ]; then
481 # Make sure no old backup is stored in system directory
482 if [ -e "$sys_target/.stamp" ]; then
483 # There seems to be a genearation-less backup in the
485 echo "Target directory \"$sys_target\" seems to be unclean!? \"$system\" skipped!"
489 Initialize_Last_SysTarget_Snapshot "$sys_target" || continue
491 if [ -n "$last" -a ! -e "$last/.stamp" ]; then
492 # Old backup directory without "stamp file", continue
493 echo "Found incomplete snapshot in \"$last\", reusing and renaming it ..."
494 RenameSubvolume "$last" "$sys_target"
495 if [ $? -ne 0 ]; then
496 echo "Failed to rename last snapshot \"$last\" to \"$sys_target\"!? \"$system\" skipped!"
499 elif [ -n "$last" ]; then
500 # Old backup directory found, create new snapshot
501 echo "Found last snapshot in \"$last\"."
502 if [ "$DRYRUN" -eq 0 ]; then
503 CloneSubvolume "$last" "$sys_target" "$snapshot"; r=$?
504 if [ $r -ne 0 ]; then
505 echo "Can't create snapshot \"$snapshot\" of \"$last\", code $r!? \"$system\" skipped!"
508 echo "Created new snapshot in \"$snapshot\"."
510 echo " *** Trial run, not creating new snapshot in \"$snapshot\"!"
513 # No old backup found, create new subvolume
514 if [ "$DRYRUN" -eq 0 ]; then
515 CreateSubvolume "$sys_target"; r=$?
516 if [ $r -ne 0 ]; then
517 echo "Can't create subvolume \"$sys_target\", code $r!? \"$system\" skipped!"
520 echo "Created new subvolume in \"$sys_target\"."
522 echo " *** Trial run, not creating new subvolume \"$sys_target\"!"
528 [ -n "$ssh_args_add" ] && ssh_cmd="$ssh_cmd $ssh_args_add"
530 # execute job "pre-exec" command, if any
531 if [ -n "$job_pre_exec" ]; then
532 ExecJob pre "$job_pre_exec" ; ret=$?
533 if [ $ret -ne 0 ]; then
534 [ $ret -ne 99 ] && count_started=$count_started+1
535 echo "Pre-exec command failed, \"$system\" skipped!"
540 # prepare (remote) command ...
541 cmd="$rsync --archive"
542 [ "$compress" -ne 0 ] && cmd="$cmd --compress"
543 [ "$local" -eq 0 ] && cmd="$cmd --rsh=\"$ssh_cmd\""
544 cmd="$cmd --delete --delete-excluded --sparse"
545 if [ "$VERBOSE" -gt 0 ]; then
546 [ "$rsync_proto" -ge 31 ] \
547 && cmd="$cmd --info=progress2" \
548 || cmd="$cmd --progress"
550 if [ "$source_root" = "$default_source_root" ]; then
560 "/var/cache/apt/**" \
564 cmd="$cmd --exclude=$dir"
567 [ -n "$exclude_args_add" ] && cmd="$cmd $exclude_args_add"
568 for dir in $exclude_dirs_add; do
569 cmd="$cmd --exclude=$dir"
571 [ -n "$rsync_args_add" ] && cmd="$cmd $rsync_args_add"
574 && cmd="$cmd ${user}@${system}:$source_root $sys_target/" \
575 || cmd="$cmd $source_root $sys_target/"
577 echo "Backing up to \"$sys_target\" ..."
578 echo -n "Start date: "; date
580 count_started=$count_started+1
583 if [ "$DRYRUN" -eq 0 ]; then
584 rm -f "$sys_target/.stamp"
585 $SHELL -c "$cmd"; ret=$?
586 echo "code=$ret" >"$sys_target/.stamp"
588 echo " *** Trial run, not executing synchronization command!"
592 if [ $ret -eq 20 ]; then
593 echo "Backup of \"$system\" interrupted. Aborting ..."
597 echo -n "End date: "; date
598 if [ $ret -eq 0 -o $ret -eq 24 ]; then
599 [ $ret -eq 24 ] && count_ok_vanished=$count_ok_vanished+1
601 echo "System \"$system\" completed with status $ret, OK."
602 [ "$DRYRUN" -gt 0 ] || count_ok=$count_ok+1
605 echo "System \"$system\" completed with ERRORS, code $ret!"
608 # execute job "post-exec" command, if any
609 if [ -n "$job_post_exec" ]; then
610 ExecJob post "$job_post_exec"
613 if [ $generations -gt 0 ]; then
614 # Update "latest" symlink
615 if [ "$DRYRUN" -eq 0 ]; then
616 rm -f "$sys_root/latest"
617 ln -s "$sys_target" "$sys_root/latest"
619 # Clean up old generations
620 declare -i gen_count=$generations+2
621 to_delete=$(ls -1t "$sys_root" 2>/dev/null | tail -n+$gen_count | sort)
622 if [ -n "$to_delete" -a $ok -eq 1 ]; then
623 [ "$DRYRUN" -eq 0 ] \
624 && echo "Deleting old backup generations (keep $generations) ..." \
625 || echo " *** Trial run, not deleting old generations:"
626 for delete in $to_delete; do
627 dir="$sys_root/$delete"
628 if [ ! -e "$dir/.stamp" ]; then
629 echo "Not deleting \"$dir\", not a backup directory!?"
632 last=$(stat "$dir/.stamp" 2>/dev/null | grep "^Modify: " \
633 | cut -d':' -f2- | cut -d. -f1)
634 echo "Removing backup from" $last "..."
635 if [ "$DRYRUN" -eq 0 ]; then
636 DeleteSubvolume "$dir"
638 echo "Failed to delete \"$dir\"!"
641 echo -n "Clean up finished: "; date
642 elif [ -n "$to_delete" ]; then
643 echo "There have been errors, not cleaning up old generations!"
645 echo "Nothing to clean up."
649 destinations="$destinations $target"
655 if [ "$DRYRUN" -eq 0 ]; then
658 for dest in $(echo $destinations | sed -e 's/ /\n/g' | sort | uniq); do
662 paths_zfs="$paths_zfs $dest"
668 if [ -n "$paths" ]; then
672 if [ -n "$paths_zfs" ]; then
680 echo -n "Done: "; date
682 [ $count_all -eq 1 ] && s="" || s="s"
683 echo " - $count_all job$s defined,"
684 [ $count_started -eq 1 ] && s="" || s="s"
685 echo " - $count_started job$s started,"
686 echo " - $count_ok done without errors."
689 if [ $count_started -ne $count_ok ]; then
690 echo "-----> THERE HAVE BEEN ERRORS! <-----"
693 elif [ $count_all -ne $count_started ]; then