Merge branch 'master' of https://github.com/tyriis/rsync-time-backup into tyriis-master

Conflicts:
	rsync_tmbackup.sh

rsync_tmbackup.sh

@@ -5,15 +5,15 @@
 # -----------------------------------------------------------------------------
 
 fn_log_info() {
-	echo "[RB INFO] $1"
+	echo "rsync_tmbackup: $1"
 }
 
 fn_log_warn() {
-	echo "[RB WARN] $1"
+	echo "rsync_tmbackup: [WARNING] $1"
 }
 
 fn_log_error() {
-	echo "[RB ERROR] $1"
+	echo "rsync_tmbackup: [ERROR] $1"
 }
 
 # -----------------------------------------------------------------------------
@@ -21,7 +21,7 @@ fn_log_error() {
 # -----------------------------------------------------------------------------
 
 fn_terminate_script() {
-	echo "SIGINT caught"
+	echo "rsync_tmbackup: SIGINT caught."
 	exit 1
 }
 
@@ -35,6 +35,13 @@ SRC_FOLDER=${1%/}
 DEST_FOLDER=${2%/}
 EXCLUSION_FILE=$3
 
+for arg in "$SRC_FOLDER" "$DEST_FOLDER" "$EXCLUSION_FILE"; do
+	if [[ "$arg" == *"'"* ]]; then
+		fn_log_error 'Arguments may not have any single quote characters.'
+		exit 1
+	fi
+done
+
 # -----------------------------------------------------------------------------
 # Check that the destination drive is a backup drive
 # -----------------------------------------------------------------------------
@@ -67,12 +74,12 @@ fi
 # Setup additional variables
 # -----------------------------------------------------------------------------
 
-BACKUP_FOLDER_PATTERN="\d\d\d\d-\d\d-\d\d-\d\d\d\d\d\d"
+BACKUP_FOLDER_PATTERN="^[[:digit:]][[:digit:]][[:digit:]][[:digit:]]-[[:digit:]][[:digit:]]-[[:digit:]][[:digit:]]-[[:digit:]][[:digit:]][[:digit:]][[:digit:]][[:digit:]][[:digit:]]$"
 NOW=$(date +"%Y-%m-%d-%H%M%S")
 PROFILE_FOLDER="$HOME/.rsync_tmbackup"
 LOG_FILE="$PROFILE_FOLDER/$NOW.log"
 DEST=$DEST_FOLDER/$NOW
-LAST_TIME=$(ls -1 $DEST_FOLDER | grep "$BACKUP_FOLDER_PATTERN" | tail -n 1)
+LAST_TIME=$(ls -1 -- "$DEST_FOLDER" | grep "$BACKUP_FOLDER_PATTERN" | tail -n 1)
 PREVIOUS_DEST=$DEST_FOLDER/$LAST_TIME
 INPROGRESS_FILE=$DEST_FOLDER/backup.inprogress
 
@@ -94,10 +101,10 @@ if [ -f "$INPROGRESS_FILE" ]; then
 		# - Last backup is moved to current backup folder so that it can be resumed.
 		# - 2nd to last backup becomes last backup.
 		fn_log_info "$INPROGRESS_FILE already exists - the previous backup failed or was interrupted. Backup will resume from there."
-		LINE_COUNT=$(ls -1 $DEST_FOLDER | grep "$BACKUP_FOLDER_PATTERN" | tail -n 2 | wc -l)
+		LINE_COUNT=$(ls -1 -- "$DEST_FOLDER" | grep "$BACKUP_FOLDER_PATTERN" | tail -n 2 | wc -l)
-		mv $PREVIOUS_DEST $DEST
+		mv -- "$PREVIOUS_DEST" "$DEST"
 		if [ "$LINE_COUNT" -gt 1 ]; then
-			SECOND_LAST_TIME=$(ls -1 $DEST_FOLDER | grep "$BACKUP_FOLDER_PATTERN" | tail -n 2 | head -n 1)
+			SECOND_LAST_TIME=$(ls -1 -- "$DEST_FOLDER" | grep "$BACKUP_FOLDER_PATTERN" | tail -n 2 | head -n 1)
 			LAST_TIME=$SECOND_LAST_TIME
 		else
 			LAST_TIME=""
@@ -106,36 +113,37 @@ if [ -f "$INPROGRESS_FILE" ]; then
 	fi
 fi
 
-# -----------------------------------------------------------------------------
+# Run in a loop to handle the "No space left on device" logic.
-# Check if we are doing an incremental backup (if previous backup exists) or not
-# -----------------------------------------------------------------------------
-
-LINK_DEST_OPTION=""
-if [ "$LAST_TIME" == "" ]; then
-	fn_log_info "No previous backup - creating new one."
-else
-	# If the path is relative, it needs to be relative to the destination. To keep
-	# it simple, just use an absolute path. See http://serverfault.com/a/210058/118679
-	PREVIOUS_DEST=`cd \`dirname "$PREVIOUS_DEST"\`; pwd`"/"`basename "$PREVIOUS_DEST"`
-	fn_log_info "Previous backup found - doing incremental backup from $PREVIOUS_DEST"
-	LINK_DEST_OPTION="--link-dest=$PREVIOUS_DEST"
-fi
-
-# -----------------------------------------------------------------------------
-# Create destination folder if it doesn't already exists
-# -----------------------------------------------------------------------------
-
-if [ ! -d "$DEST" ]; then
-	fn_log_info "Creating destination $DEST"
-	mkdir -p $DEST
-fi
-
-# -----------------------------------------------------------------------------
-# Start backup
-# -----------------------------------------------------------------------------
-
-# Run in a loop to handle the "No space left on device" logic
 while [ "1" ]; do
+
+	# -----------------------------------------------------------------------------
+	# Check if we are doing an incremental backup (if previous backup exists) or not
+	# -----------------------------------------------------------------------------
+
+	LINK_DEST_OPTION=""
+	if [ "$LAST_TIME" == "" ]; then
+		fn_log_info "No previous backup - creating new one."
+	else
+		# If the path is relative, it needs to be relative to the destination. To keep
+		# it simple, just use an absolute path. See http://serverfault.com/a/210058/118679
+		PREVIOUS_DEST=`cd \`dirname -- "$PREVIOUS_DEST"\`; pwd`"/"`basename -- "$PREVIOUS_DEST"`
+		fn_log_info "Previous backup found - doing incremental backup from $PREVIOUS_DEST"
+		LINK_DEST_OPTION="--link-dest=$PREVIOUS_DEST"
+	fi
+
+	# -----------------------------------------------------------------------------
+	# Create destination folder if it doesn't already exists
+	# -----------------------------------------------------------------------------
+
+	if [ ! -d "$DEST" ]; then
+		fn_log_info "Creating destination $DEST"
+		mkdir -p -- "$DEST"
+	fi
+
+	# -----------------------------------------------------------------------------
+	# Start backup
+	# -----------------------------------------------------------------------------
+
 	LOG_FILE="$PROFILE_FOLDER/$(date +"%Y-%m-%d-%H%M%S").log"
 
 	fn_log_info "Starting backup..."
@@ -151,21 +159,21 @@ while [ "1" ]; do
 	CMD="$CMD --delete-excluded"
 	CMD="$CMD --one-file-system"
 	CMD="$CMD --archive"
-	CMD="$CMD --progress"
 	CMD="$CMD --itemize-changes"
 	CMD="$CMD --verbose"
 	CMD="$CMD --log-file '$LOG_FILE'"
 	if [ "$EXCLUSION_FILE" != "" ]; then
-		CMD="$CMD --exclude-from \"$EXCLUSION_FILE\""
+		# We've already checked that $EXCLUSION_FILE doesn't contain a single quote
+		CMD="$CMD --exclude-from '$EXCLUSION_FILE'"
 	fi
 	CMD="$CMD $LINK_DEST_OPTION"
-	CMD="$CMD $SRC_FOLDER/ $DEST/"
+	CMD="$CMD -- '$SRC_FOLDER/' '$DEST/'"
 	CMD="$CMD | grep -E '^deleting|[^/]$'"
 
 	fn_log_info "Running command:"
 	fn_log_info "$CMD"
 
-	touch $INPROGRESS_FILE
+	touch -- "$INPROGRESS_FILE"
 	eval $CMD
 	RSYNC_EXIT_CODE=$?
 
@@ -185,6 +193,7 @@ while [ "1" ]; do
 	rm -- "$LOG_FILE"
 	
 	if [ "$NO_SPACE_LEFT" == "0" ]; then
+		# TODO: -y flag
 		read -p "It looks like there is no space left on the destination. Delete old backup? (Y/n) " yn
 		case $yn in
 			[Nn]* ) exit 0;;
@@ -197,9 +206,7 @@ while [ "1" ]; do
 			fn_log_error "No space left on device, and no old backup to delete."
 			exit 1
 		fi
-		
+				
-		# TODO: handle case where only two backup folders are left. In which case, need to remove --link-dest option
-		
 		OLDEST_BACKUP=$(ls -1 $DEST_FOLDER | grep "$BACKUP_FOLDER_PATTERN" | head -n 1)
 		if [ "$OLDEST_BACKUP" == "" ]; then
 			fn_log_error "No space left on device, and cannot get path to oldest backup to delete."
@@ -227,7 +234,8 @@ while [ "1" ]; do
 		exit $RSYNC_EXIT_CODE
 	fi
 	
-	rm $INPROGRESS_FILE
+	rm -- "$INPROGRESS_FILE"
+	# TODO: grep for "^rsync error:.*$" in log
 	fn_log_info "Backup completed without errors."
 	exit 0
 done