Add support for multiple source directories

Author: natecollins

README.md

@@ -9,8 +9,38 @@ An easy to use file backup script where each job is based around a simple config
 - Can hard link identical files with a single backup
 - Very customizable
 
+Quick Example
+------------------------
+Setup SSH PubKey authentication between backup machine and client.  
 
-Quick Links
+Create a config file on backup machine:  
+```
+[email protected]
+SOURCE_DIR=server1.example.com:/home/ :/etc :/var/www
+TARGET_DIR=/backups/server1/
+BACKUP_TYPE=rotation
+MAX_ROTATIONS=30
+ROTATIONALS_HARD_LINK=1
+ALLOW_DELETIONS=1
+ALLOW_OVERWRITES=1
+LOG_DIR=/var/log/cfgbackup/
+COMPRESS_LOGS=1
+```
+
+Start the backup:  
+```
+cfgbackup my.conf run
+```
+
+Check the status of current/last run:  
+```
+cfgbackup my.conf status
+```
+
+That's all there is to getting started! But there is a whole lot more functionality and customization available.  
+
+
+Links
 ------------------------
 * [Dependencies](#dependencies)
 * [Installation](#installation)
@@ -190,11 +220,18 @@ Config Options
 <a name="source-dir"></a>
 `SOURCE_DIR` [Required]  
 The directory to create backups from. Can be local or remote
-via SSH.  
+via SSH. Can specify multiple directories, whitespace delimited. If specifying multiple
+remote directories, all directories must be on same host (limitation of rsync).  
+
+Source directories WITH a trailing slash will sync the contents of the source directory
+into the target backup. Source directories WITHOUT a trailing slash will sync the directory
+itself (along with its contents) into the target backup.  
 ```
 SOURCE_DIR=/home/
 SOURCE_DIR=/var/data
 [email protected]:/path/to/files/
+SOURCE_DIR=/etc /var/www /home
+SOURCE_DIR=server.example.com:/etc :/var/www :/home
 ```
 
 <a name="target-dir"></a>

cfgbackup

@@ -21,7 +21,7 @@
 # SOFTWARE.
 ################################################################################
 
-VERSION=0.4.1
+VERSION=0.4.2
 
 #######################################
 # MISC HELPER FUNCTIONS
@@ -102,6 +102,7 @@ substr_index() {
     local PREMATCH="${HAYSTACK%%$NEEDLE*}"
     if [[ $PREMATCH != $HAYSTACK ]]; then
         echo ${#PREMATCH}
+        return
     fi
     echo -1
 }
@@ -423,6 +424,10 @@ parse_config() {
         if [[ ${CONFIG[BACKUP_TYPE]} == "mirror" && ${CONFIG[MIRROR_CONFLICT_ACTION]} != "update" && ${CONFIG[MIRROR_CONFLICT_ACTION]} != "delete" ]]; then
             PARSE_ERRORS+=("Value of MIRROR_CONFLICT_ACTION must be either update or delete.")
         fi
+        read -r -a source_dirs <<< "${CONFIG[SOURCE_DIR]}"
+        if [[ ${CONFIG[BACKUP_TYPE]} == "mirror" && ${#source_dirs[@]} -gt 1 ]]; then
+            PARSE_ERRORS+=("Backup type of mirror can only have a single SOURCE_DIR directory.")
+        fi
         # Ensure ROTATE_SUBDIR is valid
         if [[ ${CONFIG[BACKUP_TYPE]} == "rotation" ]]; then
             MATCH_NUM0=$( substr_index "${CONFIG[ROTATE_SUBDIR]}" "NUM0" )
@@ -874,7 +879,7 @@ dirpath_is_remote() {
     DIRPATH="$1"
     local COLON_IDX=$( substr_index "${DIRPATH}" ":" )
     local SLASH_IDX=$( substr_index "${DIRPATH}" "/" )
-    if [[ $COLON_IDX -ge "0" && $COLON_IDX -lt $SLASH_IDX ]]; then
+    if [[ $COLON_IDX -ge 0 && $COLON_IDX -lt $SLASH_IDX ]]; then
         return 0
     fi
     return 1
@@ -891,31 +896,39 @@ command_check() {
     fi
 
     # Test source access
-    dirpath_is_remote "${CONFIG[SOURCE_DIR]}"
-    if [[ $? -eq 0 ]]; then
-        local COLON_IDX=$( substr_index "${CONFIG[SOURCE_DIR]}" ":" )+1
-        local SSH_CONNECT=${CONFIG[SOURCE_DIR]:0:$COLON_IDX}
-        local SSH_SOURCE=${CONFIG[SOURCE_DIR]:1+$COLON_IDX}
-        # Check SSH connection
-        ssh -o BatchMode=yes $SSH_CONNECT exit 0
-        if [[ $? != 0 ]]; then
-            echo "ERROR: Could not connect via SSH to ${SSH_CONNECT}"
-            exit 1
-        fi
-
-        # Check remote directory
-        ssh -o BatchMode=yes $SSH_CONNECT "[[ ! -d $SSH_SOURCE || ! -r $SSH_SOURCE ]]"
+    read -r -a SOURCE_DIRS <<< "${CONFIG[SOURCE_DIR]}"
+    LAST_SSH_CONNECT=
+    for SRC_DIR in "${SOURCE_DIRS[@]}"; do
+        dirpath_is_remote "${SRC_DIR}"
         if [[ $? -eq 0 ]]; then
-            echo "ERROR: Cannot read from remote source directory of ${SSH_SOURCE}"
-            exit 1
-        fi
-    else
-        # Check local directory
-        if [[ ! -d ${CONFIG[SOURCE_DIR]} || ! -r ${CONFIG[SOURCE_DIR]} ]]; then
-            echo "ERROR: Cannot read from local source directory of ${CONFIG[SOURCE_DIR]}"
-            exit 1
+            local COLON_IDX=$( substr_index "${SRC_DIR}" ":" )
+            local SSH_CONNECT=${SRC_DIR:0:$COLON_IDX}
+            local SSH_SOURCE=${SRC_DIR:1+$COLON_IDX}
+            if [[ -z $SSH_CONNECT ]]; then
+                SSH_CONNECT=$LAST_SSH_CONNECT
+            fi
+            # Check SSH connection
+            ssh -o BatchMode=yes $SSH_CONNECT exit 0
+            if [[ $? != 0 ]]; then
+                echo "ERROR: Could not connect via SSH to ${SSH_CONNECT}"
+                exit 1
+            fi
+            LAST_SSH_CONNECT=$SSH_CONNECT
+
+            # Check remote directory
+            ssh -o BatchMode=yes $LAST_SSH_CONNECT "[[ ! -d $SSH_SOURCE || ! -r $SSH_SOURCE ]]"
+            if [[ $? -eq 0 ]]; then
+                echo "ERROR: Cannot read from remote source directory of ${SSH_SOURCE}"
+                exit 1
+            fi
+        else
+            # Check local directory
+            if [[ ! -d ${SRC_DIR} || ! -r ${SRC_DIR} ]]; then
+                echo "ERROR: Cannot read from local source directory of ${SRC_DIR}"
+                exit 1
+            fi
         fi
-    fi
+    done
 
     # Test target access
     if [[ ! -d ${CONFIG[TARGET_DIR]} || ! -w ${CONFIG[TARGET_DIR]} ]]; then
@@ -1133,14 +1146,23 @@ hardlink_identicals() {
 ## Escape the rsync source path, including the user and host for remote ssh sources
 ## Output the escaped path
 escaped_rsync_source() {
-    ESCPATH=$( epath_join ${CONFIG[SOURCE_DIR]} )
-    dirpath_is_remote "${CONFIG[SOURCE_DIR]}"
-    if [[ $? == 0 ]]; then
-        local COLON_IDX=$( substr_index "${CONFIG[SOURCE_DIR]}" ":" )+1
-        local SSH_CONNECT=${CONFIG[SOURCE_DIR]:0:$COLON_IDX}
-        local SSH_SOURCE=${CONFIG[SOURCE_DIR]:1+$COLON_IDX}
-        ESCPATH="${SSH_CONNECT}:\"$( epath_join "$SSH_SOURCE" )\""
-    fi
+    read -r -a SOURCE_DIRS <<< "${CONFIG[SOURCE_DIR]}"
+    ESCPATH=
+    for SRC_DIR in "${SOURCE_DIRS[@]}"; do
+        TRAILSLASH=${SRC_DIR: -1}
+        if [[ $TRAILSLASH != "/" ]]; then
+            TRAILSLASH=
+        fi
+        ESCSRCPATH="$( epath_join ${SRC_DIR} )${TRAILSLASH}"
+        dirpath_is_remote "${SRC_DIR}"
+        if [[ $? == 0 ]]; then
+            local COLON_IDX=$( substr_index "${SRC_DIR}" ":" )
+            local SSH_CONNECT=${SRC_DIR:0:$COLON_IDX}
+            local SSH_SOURCE=${SRC_DIR:1+$COLON_IDX}
+            ESCSRCPATH="${SSH_CONNECT}:\"$( epath_join "$SSH_SOURCE" )${TRAILSLASH}\""
+        fi
+        ESCPATH="${ESCPATH} ${ESCSRCPATH}"
+    done
     echo "$ESCPATH"
 }
 
@@ -1161,7 +1183,7 @@ runjob_sync() {
     # Exclude PID_FILE from being synced
     RSYNC_FLAGS="${RSYNC_FLAGS} --exclude=/${PID_FILE}"
 
-    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM}/ ${RUN_DIR}/"
+    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM} ${RUN_DIR}/"
     log_entry "| Running rsync: $RSYNC_COMMAND"
     RSYNC_COMMAND="$RSYNC_COMMAND >> ${LOG_FILE} 2>&1"
     eval $RSYNC_COMMAND
@@ -1233,7 +1255,7 @@ runjob_rotation() {
     fi
 
     SYNC_FROM=$( escaped_rsync_source )
-    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM}/ ${RUN_DIR}/"
+    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM} ${RUN_DIR}/"
     log_entry "| Running rsync: $RSYNC_COMMAND"
     RSYNC_COMMAND="$RSYNC_COMMAND >> ${LOG_FILE} 2>&1"
     eval $RSYNC_COMMAND
@@ -1275,7 +1297,7 @@ runjob_skipped_files() {
         RSYNC_FLAGS="${RSYNC_FLAGS} --exclude=/${PID_FILE}"
     fi
 
-    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM}/ ${RUN_DIR}/"
+    RSYNC_COMMAND="${CONFIG[RSYNC_PATH]} ${RSYNC_FLAGS} ${SYNC_FROM} ${RUN_DIR}/"
     log_entry "| Checking for skipped files..."
     log_entry "| Running rsync: $RSYNC_COMMAND"
     SKIP_RESULTS=$( $RSYNC_COMMAND | tee -a $LOG_FILE 2>&1 )

example.conf

@@ -10,8 +10,12 @@
 NOTIFY_EMAIL=
 
 # Where to backup files from (or mirror); can be local or a SSH location
+# Multiple source locations may be specified, whitespace separated
+# Trailing slash will sync dir contents only; no trailing slash will sync dir name and its contents
 # SOURCE_DIR=/path/to/files/
 # [email protected]:/path/to/files/
+# SOURCE_DIR=/path/to/files /more/files/here /yet/more/files
+# SOURCE_DIR=remote:/path/to/files :/more/remote :/still/more
 SOURCE_DIR=
 
 # Target where to backup files to (or mirror); must be a local directory

man/cfgbackup.1

@@ -1,4 +1,4 @@
-.TH "cfgbackup" "1" "26 Feb 2017" "" ""
+.TH "cfgbackup" "1" "03 Jul 2018" "" ""
 .SH "NAME"
 cfgbackup \- "cfgbackup's a fairly good backup"
 
@@ -45,6 +45,12 @@ Binary options allow values of 0 (disabled) or 1 (enabled).
 .TP
 .B SOURCE_DIR
 The directory to create backups from. Can be local or remote via SSH.
+Can specify multiple directories, whitespace delimited. If specifying multiple
+remote directories, all directories must be on same host (limitation of rsync).
+.IP
+Source directories WITH a trailing slash will sync the contents of the source directory
+into the target backup. Source directories WITHOUT a trailing slash will sync the directory
+itself (along with its contents) into the target backup.  
 
 .TP
 .B TARGET_DIR