Do not lock exclusively when listing backups

[backmeupscotty.git] / backmeupscotty

diff --git a/backmeupscotty b/backmeupscotty
index dd1471123bf372d0b60455d4b0a1ea9dee9eb5ca..65e4d53310b732200dc2c67edcd941f7caaf2b31 100644 (file)
--- a/backmeupscotty
+++ b/backmeupscotty
@@ -5,29 +5,33 @@ REMOTE_DIR=/tmp/backmeupscotty/test
 ARCHIVE_KEEPNBACKUPS=30
 ARCHIVE_KEEPNDAYS=30
 BACKUP_RUNEVERYNTHDAY=1
 ARCHIVE_KEEPNBACKUPS=30
 ARCHIVE_KEEPNDAYS=30
 BACKUP_RUNEVERYNTHDAY=1

+BWLIMIT=500KiB
+BACKUP_FORCE=0

 
 _ERROR_ENCOUNTERED=0
 
 _ERROR_ENCOUNTERED=0

-_UPPERME=$(echo $(basename $0) | tr '[:lower:]' '[:upper:]')

 
 function timestamp {
     date +'[%y-%m-%d|%H:%M:%S]'
 }
 
 function scottyline {
 
 function timestamp {
     date +'[%y-%m-%d|%H:%M:%S]'
 }
 
 function scottyline {

-    echo $(timestamp) $_UPPERME: $@
+    echo $(timestamp) $@

 }
 
 function scottyinfo {
     if [ $_ERROR_ENCOUNTERED -eq 0 ]; then
 }
 
 function scottyinfo {
     if [ $_ERROR_ENCOUNTERED -eq 0 ]; then

-       scottyline $@
+        scottyline $@

     else
     else

-       scottyline $@ >&2
+        scottyline $@ >&2

     fi
 }
 
 function scottyerror {
     scottyline $@ >&2
     fi
 }
 
 function scottyerror {
     scottyline $@ >&2

-    _ERROR_ENCOUNTERED=1
+    if [ $_ERROR_ENCOUNTERED -eq 0 ]; then
+        _ERROR_ENCOUNTERED=1
+        scottyline "Going into verbose mode after error encounter." >&2
+    fi

 }
 
 function ssh255 {
 }
 
 function ssh255 {


@@ -35,10 +39,10 @@ function ssh255 {
     sshret=$?
 
     if [ $sshret -eq 255 ]; then
     sshret=$?
 
     if [ $sshret -eq 255 ]; then

-       scottyerror "SSH connection failed!"
-       exit 1
+        scottyerror "SSH connection failed!"
+        exit 1

     else
     else

-       return $sshret
+        return $sshret

     fi
 }
 
     fi
 }
 


@@ -48,30 +52,29 @@ function grepbackups {
 
 function isIncomplete {
     if ( ssh255 $REMOTE_HOST '[ -d '$REMOTE_DIR/incomplete' ]' ); then
 
 function isIncomplete {
     if ( ssh255 $REMOTE_HOST '[ -d '$REMOTE_DIR/incomplete' ]' ); then

-       return 0
+        return 0

     else
     else

-       return 1
+        return 1

     fi
 }
 
 function isNthDay {
     fi
 }
 
 function isNthDay {

-    if [ $(( ( $(date +%s) / (60*60*24) ) % $BACKUP_RUNEVERYNTHDAY )) -eq 0 ]; 
+    if [ $(( ( $(date +%s) / (60*60*24) ) % $BACKUP_RUNEVERYNTHDAY )) -eq 0 ];

     then
     then

-       return 0
+        return 0

     else
     else

-       return 1
-    fi 
+        return 1
+    fi

 }
 
 function latestTooOld {
     for oldbackup in $(grepbackups); do
 }
 
 function latestTooOld {
     for oldbackup in $(grepbackups); do

-       tstamp=$(echo $oldbackup | cut -d'-' -f1)
-       
-       if [ $(( $(date +%s) - $tstamp )) -lt \
-           $(( ($BACKUP_RUNEVERYNTHDAY*24+12)*60*60 )) ]
-       then
-           return 1
-       fi
+        tstamp=$(echo $oldbackup | cut -d'-' -f1)
+
+        if [ $(( $(date +%s) - $tstamp )) -lt $(( ($BACKUP_RUNEVERYNTHDAY*24+12)*60*60 )) ]
+        then
+            return 1
+        fi

     done
 
     return 0
     done
 
     return 0


@@ -83,13 +86,13 @@ function scottysync {
     scottyinfo "Syncing $SYNC_SRC to $REMOTE_HOST:$REMOTE_DIR @$timestamp."
 
     if [ ! -d "$SYNC_SRC" ]; then
     scottyinfo "Syncing $SYNC_SRC to $REMOTE_HOST:$REMOTE_DIR @$timestamp."
 
     if [ ! -d "$SYNC_SRC" ]; then

-       scottyerror "Source dir $SYNC_SRC does not exist. Not syncing!"
-       return 1
+        scottyerror "Source dir $SYNC_SRC does not exist. Not syncing!"
+        return 1

     fi
 
     if [ $(ls -A "$SYNC_SRC" | wc -l) -eq 0 ]; then
     fi
 
     if [ $(ls -A "$SYNC_SRC" | wc -l) -eq 0 ]; then

-       scottyerror "Source dir $SYNC_SRC is empty. Not syncing!"
-       return 1
+        scottyerror "Source dir $SYNC_SRC is empty. Not syncing!"
+        return 1

     fi
 
     dir_current=$REMOTE_DIR/current
     fi
 
     dir_current=$REMOTE_DIR/current


@@ -97,51 +100,52 @@ function scottysync {
     dir_timestamped=$REMOTE_DIR/$timestamp-$(date -d @$timestamp +%Y%m%d%H%M%S)
 
     if [ -z $SYNC_EXC ]; then
     dir_timestamped=$REMOTE_DIR/$timestamp-$(date -d @$timestamp +%Y%m%d%H%M%S)
 
     if [ -z $SYNC_EXC ]; then

-       rsync_exclude=""
+        rsync_exclude=""

     else
     else

-       rsync_exclude=$(eval echo --exclude={$SYNC_EXC} | tr -d {})
+        rsync_exclude=$(eval echo --exclude={$SYNC_EXC} | tr -d {})

     fi
 
     if (ssh255 $REMOTE_HOST '[ ! -d '$REMOTE_DIR' ]'); then
     fi
 
     if (ssh255 $REMOTE_HOST '[ ! -d '$REMOTE_DIR' ]'); then

-       scottyinfo "Creating destination directory $REMOTE_HOST:$REMOTE_DIR."
-       ssh255 $REMOTE_HOST "mkdir $REMOTE_DIR"
+        scottyinfo "Creating destination directory $REMOTE_HOST:$REMOTE_DIR."
+        ssh255 $REMOTE_HOST "mkdir $REMOTE_DIR"

     fi
 
     if isIncomplete; then
     fi
 
     if isIncomplete; then

-       scottyerror "Continuing old incomplete backup."
+        scottyerror "Continuing old incomplete backup."

     fi
 
     scottyinfo "Starting rsync."
     fi
 
     scottyinfo "Starting rsync."

-    rsync -e ssh \
-       -v -aHAX --numeric-ids --delete --delete-excluded \
-       --link-dest=$dir_current \
-       $rsync_exclude \
-       $SYNC_SRC/ $REMOTE_HOST:$dir_incomplete/
-    
+    rsync -e ssh --bwlimit=$BWLIMIT \
+          -v -aHAX --numeric-ids --delete --delete-excluded \
+          --link-dest=$dir_current \
+          $rsync_exclude \
+          $SYNC_SRC/ $REMOTE_HOST:$dir_incomplete/
+

     if [ $? -eq 0 ]; then
     if [ $? -eq 0 ]; then

-       scottyinfo "Timestamping completed backup and linking to current backup."
-       ssh255 $REMOTE_HOST \
-           "mv $dir_incomplete $dir_timestamped && rm -f $dir_current && ln -s $(basename $dir_timestamped) $dir_current"
+        scottyinfo "Timestamping completed backup and linking to current backup."
+        ssh255 $REMOTE_HOST \
+               "mv $dir_incomplete $dir_timestamped && rm -f $dir_current && \
+               ln -s $(basename $dir_timestamped) $dir_current"

     else
     else

-       scottyerror "Rsync failed."
+        scottyerror "Rsync failed."

     fi
 
     while [ $(grepbackups | wc -l) -gt $ARCHIVE_KEEPNBACKUPS ]; do
     fi
 
     while [ $(grepbackups | wc -l) -gt $ARCHIVE_KEEPNBACKUPS ]; do

-       oldestbackup=$(grepbackups | head -1)
-       oldestbackuptstamp=$(echo $oldestbackup | cut -d'-' -f1)
-
-       if [ $oldestbackuptstamp -lt $(( $(date +%s) - $ARCHIVE_KEEPNDAYS*60*60*24 )) ]; then
-           scottyinfo "Removing old backup $oldestbackup."
-           ssh255 $REMOTE_HOST rm -r "$REMOTE_DIR/$oldestbackup"
-       else
-           break
-       fi
+        oldestbackup=$(grepbackups | head -1)
+        oldestbackuptstamp=$(echo $oldestbackup | cut -d'-' -f1)
+
+        if [ $oldestbackuptstamp -lt $(( $(date +%s) - $ARCHIVE_KEEPNDAYS*60*60*24 )) ]; then
+            scottyinfo "Removing old backup $oldestbackup."
+            ssh255 $REMOTE_HOST rm -r "$REMOTE_DIR/$oldestbackup"
+        else
+            break
+        fi

     done
 }
 
 function deleteLock {
     if ! rmdir /var/lock/$(basename $0); then
     done
 }
 
 function deleteLock {
     if ! rmdir /var/lock/$(basename $0); then

-       scottyerror "Could not delete lockfile /tmp/$(basename $0).lock!"
+        scottyerror "Could not delete lockfile /tmp/$(basename $0).lock!"

     fi
 }
 
     fi
 }
 


@@ -151,8 +155,8 @@ function cleanup_abort {
     cleanup ABORT
 
     if [ $(jobs -p) ]; then
     cleanup ABORT
 
     if [ $(jobs -p) ]; then

-       scottyerror "TERMinating remaining child processes."
-       kill $(jobs -p)
+        scottyerror "TERMinating remaining child processes."
+        kill $(jobs -p)

     fi
 
     deleteLock
     fi
 
     deleteLock


@@ -180,35 +184,63 @@ Usage: $(basename $0) [OPTION]...
 Recognized options:
   -q   Only output errors
   -n   Run only on nth day
 Recognized options:
   -q   Only output errors
   -n   Run only on nth day

+  -f   Force backup
+  -l   List existing backups

   -h   Print out this help
 EOF
 }
 
   -h   Print out this help
 EOF
 }
 

+function exclusiveLock {
+    if ! mkdir /var/lock/$(basename $0); then
+       scottyerror "Another instance of $(basename $0) is still running!"
+       exit 1
+    else
+       trap deleteLock EXIT
+    fi
+}
+

 function backmeupscotty {
 function backmeupscotty {

-    while getopts "qn:h" opt; do
-       case $opt in
-           q)
-               exec > /dev/null
-               ;;
-           n)
-               BACKUP_RUNEVERYNTHDAY=$OPTARG
+    while getopts "qn:flh" opt; do
+        case $opt in
+            q)
+                exec > /dev/null
+                ;;
+            n)
+                BACKUP_RUNEVERYNTHDAY=$OPTARG
+                ;;
+            f)
+                BACKUP_FORCE=1
+                ;;
+           l)
+               LIST_BACKUPS=1

                ;;
                ;;

-           h)
-               printhelp
+            h)
+                printhelp

                 exit 0
                 ;;
                 exit 0
                 ;;

-       esac
+        esac

     done
     done

-    
+

     ssh255 $REMOTE_HOST exit
 
     ssh255 $REMOTE_HOST exit
 

-    if latestTooOld; then
-       scottyerror "The latest backup is too old."
+    if [ $LIST_BACKUPS ]; then
+       for backup in $(grepbackups); do
+           echo $backup
+       done
+       exit 0
+    fi
+
+    exclusiveLock
+
+    if [ $BACKUP_FORCE -eq 1 ]; then
+        scottyinfo "Backup was enforced."
+    elif latestTooOld; then
+        scottyerror "The latest backup is too old."

     elif isNthDay; then
     elif isNthDay; then

-       scottyinfo "This is the nth day."
+        scottyinfo "This is the nth day."

     else
     else

-       scottyinfo "No backup has to be done. Exiting."
-       exit 0
+        scottyinfo "No backup has to be done. Exiting."
+        exit 0

     fi
 
     scottyinfo "Performing backup."
     fi
 
     scottyinfo "Performing backup."


@@ -222,10 +254,3 @@ function backmeupscotty {
 
     exit 0
 }
 
     exit 0
 }

-
-if ! mkdir /var/lock/$(basename $0); then
-    scottyerror "Another instance of $(basename $0) is still running!"
-    exit 1
-else
-    trap deleteLock EXIT
-fi