backmeupscotty

   1 #!/bin/bash
   2
   3 REMOTE_HOST=localhost
   4 REMOTE_DIR=/tmp/backmeupscotty/test
   5 ARCHIVE_KEEPNBACKUPS=30
   6 ARCHIVE_KEEPNDAYS=30
   7 BACKUP_RUNEVERYNTHDAY=1
   8
   9 _UPPERME=$(echo $(basename $0) | tr '[:lower:]' '[:upper:]')
  10
  11 function scottyinfo {
  12     echo $_UPPERME: $@
  13 }
  14
  15 function scottyerror {
  16     echo $_UPPERME: $@ >&2
  17 }
  18
  19 function ssh255 {
  20     ssh $@
  21     sshret=$?
  22
  23     if [ $sshret -eq 255 ]; then
  24         scottyerror "SSH connection failed!"
  25         exit 1
  26     else
  27         return $sshret
  28     fi
  29 }
  30
  31 function grepbackups {
  32     ssh255 $REMOTE_HOST "ls $REMOTE_DIR" | grep -E '[0-9]+-[0-9]+'
  33 }
  34
  35 function isIncomplete {
  36     if ( ssh255 $REMOTE_HOST '[ -d '$REMOTE_DIR/incomplete' ]' ); then
  37         return 0
  38     else
  39         return 1
  40     fi
  41 }
  42
  43 function isNthDay {
  44     if [ $(( ( $(date +%s) / (60*60*24) ) % $BACKUP_RUNEVERYNTHDAY )) -eq 0 ];
  45     then
  46         return 0
  47     else
  48         return 1
  49     fi
  50 }
  51
  52 function latestTooOld {
  53     for oldbackup in $(grepbackups); do
  54         tstamp=$(echo $oldbackup | cut -d'-' -f1)
  55
  56         if [ $(( $(date +%s) - $tstamp )) -lt \
  57             $(( ($BACKUP_RUNEVERYNTHDAY*24+12)*60*60 )) ]
  58         then
  59             return 1
  60         fi
  61     done
  62
  63     return 0
  64 }
  65
  66 function scottysync {
  67     timestamp=$(date +%s)
  68
  69     scottyinfo "Syncing $SYNC_SRC to $REMOTE_HOST:$REMOTE_DIR @$timestamp."
  70
  71     if [ ! -d "$SYNC_SRC" ]; then
  72         scottyerror "Source dir $SYNC_SRC does not exist. Not syncing!"
  73         return 1
  74     fi
  75
  76     if [ $(ls -A "$SYNC_SRC" | wc -l) -eq 0 ]; then
  77         scottyerror "Source dir $SYNC_SRC is empty. Not syncing!"
  78         return 1
  79     fi
  80
  81     dir_current=$REMOTE_DIR/current
  82     dir_incomplete=$REMOTE_DIR/incomplete
  83     dir_timestamped=$REMOTE_DIR/$timestamp-$(date -d @$timestamp +%Y%m%d%H%M%S)
  84
  85     if [ -z $SYNC_EXC ]; then
  86         rsync_exclude=""
  87     else
  88         rsync_exclude=$(eval echo --exclude={$SYNC_EXC} | tr -d {})
  89     fi
  90
  91     if (ssh255 $REMOTE_HOST '[ ! -d '$REMOTE_DIR' ]'); then
  92         scottyinfo "Creating destination directory $REMOTE_HOST:$REMOTE_DIR."
  93         ssh255 $REMOTE_HOST "mkdir $REMOTE_DIR"
  94     fi
  95
  96     if isIncomplete; then
  97         scottyerror "Continuing old incomplete backup."
  98     fi
  99
 100     scottyinfo "Starting rsync."
 101     rsync -e ssh \
 102         -v -aHAX --numeric-ids --delete --delete-excluded \
 103         --link-dest=$dir_current \
 104         $rsync_exclude \
 105         $SYNC_SRC/ $REMOTE_HOST:$dir_incomplete/
 106
 107     if [ $? -eq 0 ]; then
 108         scottyinfo "Timestamping completed backup and linking to current backup."
 109         ssh255 $REMOTE_HOST \
 110             "mv $dir_incomplete $dir_timestamped && rm -f $dir_current && ln -s $(basename $dir_timestamped) $dir_current"
 111     fi
 112
 113     while [ $(grepbackups | wc -l) -gt $ARCHIVE_KEEPNBACKUPS ]; do
 114         oldestbackup=$(grepbackups | head -1)
 115         oldestbackuptstamp=$(echo $oldestbackup | cut -d'-' -f1)
 116
 117         if [ $oldestbackuptstamp -lt $(( $(date +%s) - $ARCHIVE_KEEPNDAYS*60*60*24 )) ]; then
 118             scottyinfo "Removing old backup $oldestbackup."
 119             ssh255 $REMOTE_HOST rm -r "$REMOTE_DIR/$oldestbackup"
 120         else
 121             break
 122         fi
 123     done
 124 }
 125
 126 function deleteLock {
 127     if ! rmdir /var/lock/$(basename $0); then
 128         scottyerror "Could not delete lockfile /tmp/$(basename $0).lock!"
 129     fi
 130 }
 131
 132 function cleanup_abort {
 133     scottyerror "Caught exit signal! Cleaning up."
 134
 135     cleanup ABORT
 136
 137     if [ $(jobs -p) ]; then
 138         scottyerror "TERMinating remaining child processes."
 139         kill $(jobs -p)
 140     fi
 141
 142     deleteLock
 143
 144     exit
 145 }
 146
 147 function cleanup {
 148     scottyinfo "No cleanup function was defined."
 149 }
 150
 151 function prepare {
 152     scottyinfo "No prepare function was defined."
 153 }
 154
 155 function cleanup_normal {
 156     cleanup
 157     deleteLock
 158 }
 159
 160 function printhelp {
 161     cat <<EOF
 162 Usage: $(basename $0) [OPTION]...
 163
 164 Recognized options:
 165   -q   Only output errors
 166   -n   Run only on nth day
 167   -h   Print out this help
 168 EOF
 169 }
 170
 171 function backmeupscotty {
 172     while getopts "qn:h" opt; do
 173         case $opt in
 174             q)
 175                 exec > /dev/null
 176                 ;;
 177             n)
 178                 BACKUP_RUNEVERYNTHDAY=$OPTARG
 179                 ;;
 180             h)
 181                 printhelp
 182                 exit 0
 183                 ;;
 184         esac
 185     done
 186
 187     ssh255 $REMOTE_HOST exit
 188
 189     if latestTooOld; then
 190         scottyerror "The latest backup is too old."
 191     elif isNthDay; then
 192         scottyinfo "This is the nth day."
 193     else
 194         scottyinfo "No backup has to be done. Exiting."
 195         exit 0
 196     fi
 197
 198     scottyinfo "Performing backup."
 199
 200     trap cleanup_abort EXIT
 201
 202     prepare
 203     scottysync
 204
 205     trap cleanup_normal EXIT
 206
 207     exit 0
 208 }
 209
 210 if ! mkdir /var/lock/$(basename $0); then
 211     scottyerror "Another instance of $(basename $0) is still running!"
 212     exit 1
 213 else
 214     trap deleteLock EXIT
 215 fi