feat(bkgpslog):Consolidate tar validation/creation

[EVA-2020-02.git] / exec / bkgpslog

diff --git a/exec/bkgpslog b/exec/bkgpslog
index 42d58247af732c6519456c9585d571339d413807..c66a0e5b2823491e0c0a55879b7b006e6e00974b 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -612,6 +612,32 @@ setScriptTTL() {
        yell "ERROR:Invalid argument for setScriptTTL function."; exit 1;
     fi
 } # Seconds until next (day|hour).
        yell "ERROR:Invalid argument for setScriptTTL function."; exit 1;
     fi
 } # Seconds until next (day|hour).

+checkMakeTar() {
+    # Desc: Checks that a valid tar archive exists, creates one otherwise
+    # Usage: checkMakeTar [ path ]
+    # Input: arg1: path of tar archive
+    # Output: exit code 0 (even if tar had to be created)
+    # Depends: try, tar, date
+    local PATH_TAR="$1"
+
+    # Check if file is a valid tar archive
+    if tar --list --file="$PATH_TAR" 1>/dev/null 2>&1; then
+       ## T1: return success
+       return 0;
+    else
+       ## F1: Check if file exists
+       if [[ -f "$PATH_TAR" ]]; then
+           ### T: Rename file
+           try mv "$PATH_TAR" "$PATH_TAR""--broken--""$(date +%Y%m%dT%H%M%S)";
+       else
+           ### F: -
+           :
+       fi
+       ## F2: Create tar archive, return 0
+       try tar --create --file="$PATH_TAR" --files-from=/dev/null;
+       return 0;
+    fi
+} # checks if arg1 is tar; creates one otherwise

 appendArgTar(){
     # Desc: Writes first argument to temporary file with arguments as options, then appends file to tar
     # Usage: writeArg "$(echo "Data to be written.")" [name of file to be inserted] [tar path] [temp dir] ([cmd1] [cmd2] [cmd3] [cmd4]...)
 appendArgTar(){
     # Desc: Writes first argument to temporary file with arguments as options, then appends file to tar
     # Usage: writeArg "$(echo "Data to be written.")" [name of file to be inserted] [tar path] [temp dir] ([cmd1] [cmd2] [cmd3] [cmd4]...)


@@ -663,12 +689,22 @@ appendArgTar(){
 } # Append Bash var to file appended to Tar archive
 magicWriteBuffer() {
     # Desc: bkgpslog-specific meta function for writing data to DIR_TMP then appending each file to PATHOUT_TAR
 } # Append Bash var to file appended to Tar archive
 magicWriteBuffer() {
     # Desc: bkgpslog-specific meta function for writing data to DIR_TMP then appending each file to PATHOUT_TAR

-    local FN="${FUNCNAME[0]}"
-    yell "DEBUG:STATUS:$FN:Started magicWriteBuffer()."
+    # Inputs: PATHOUT_TAR FILEOUT_{NMEA,GPX,KML} CMD_CONV_{NMEA,GPX,KML} CMD_{COMPRESS,ENCRYPT} DIR_TMP
+    # Depends: yell, try, vbm, appendArgTar, tar
+    local FN="${FUNCNAME[0]}";
+    wait; # Wait to avoid collision with older magicWriteBuffer() instances (see https://www.tldp.org/LDP/abs/html/x9644.html )
+    vbm "DEBUG:STATUS:$FN:Started magicWriteBuffer().";
+
+    # Check that PATHOUT_TAR is a tar. Rename old and create empty one otherwise.
+    checkMakeTar "$PATHOUT_TAR"
+
+    # Write bufferBash to PATHOUT_TAR

     appendArgTar "$bufferBash" "$FILEOUT_NMEA" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_NMEA" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write NMEA data
     appendArgTar "$bufferBash" "$FILEOUT_NMEA" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_NMEA" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write NMEA data

-    appendArgTar "$bufferBash" "$FILEOUT_GPX" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_NMEA" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write GPX file
-    appendArgTar "$bufferBash" "$FILEOUT_KML" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_NMEA" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write KML file
-    yell "DEBUG:STATUS:$FN:Finished magicWriteBuffer()."
+    appendArgTar "$bufferBash" "$FILEOUT_GPX" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_GPX" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write GPX file
+    appendArgTar "$bufferBash" "$FILEOUT_KML" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_KML" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write KML file
+    # Remove secured chunks from DIR_TMP
+    try rm "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML";
+    yell "DEBUG:STATUS:$FN:Finished magicWriteBuffer().";

 } # bkgpslog write function
 
 
 } # bkgpslog write function
 
 


@@ -736,7 +772,7 @@ main() {
     else
        CMD_COMPRESS="tee /dev/null ";
        CMD_COMPRESS_SUFFIX="";
     else
        CMD_COMPRESS="tee /dev/null ";
        CMD_COMPRESS_SUFFIX="";

-       vbm "DEBUG:Compression not enabled."
+       vbm "DEBUG:Compression not enabled.";

     fi
 
     # Check that critical apps and dirs are available, displag missing ones.
     fi
 
     # Check that critical apps and dirs are available, displag missing ones.


@@ -757,30 +793,14 @@ main() {
     ## Define output tar path (note: each day gets *one* tar file (Ex: "20200731..hostname_location.[.gpx.gz].tar"))
     PATHOUT_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \
        vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR";
     ## Define output tar path (note: each day gets *one* tar file (Ex: "20200731..hostname_location.[.gpx.gz].tar"))
     PATHOUT_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \
        vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR";

-    ## Write bkgpslog version to DIR_TMP/VERSION
+    ## Generate VERSION file

     FILEOUT_VERSION="$(dateTimeShort)..VERSION";
     PATHOUT_VERSION="$DIR_TMP"/"$FILEOUT_VERSION";
     echo "$(dateTimeShort):$(basename "$0")"" Version:""$SCRIPT_VERSION" >> "$PATHOUT_VERSION" && vbm "DEBUG:VERSION created:$PATHOUT_VERSION";
     FILEOUT_VERSION="$(dateTimeShort)..VERSION";
     PATHOUT_VERSION="$DIR_TMP"/"$FILEOUT_VERSION";
     echo "$(dateTimeShort):$(basename "$0")"" Version:""$SCRIPT_VERSION" >> "$PATHOUT_VERSION" && vbm "DEBUG:VERSION created:$PATHOUT_VERSION";

-    ## Check if PATHOUT_TAR already exists.
-    if [[ -f "$PATHOUT_TAR" ]]; then
-       vbm "STATUS:Output tar already exists:$PATHOUT_TAR";
-       ### Check if preexisting tar is appendable.
-       FILEOUT_APPENDTEST="$(dateTimeShort)..RESUMING_LOGGING_SESSION.txt";
-       PATHOUT_APPENDTEST="$DIR_TMP"/"$FILEOUT_APPENDTEST" && \
-           vbm "DEBUG:Set PATHOUT_APPENDTEST to:$PATHOUT_APPENDTEST";
-       echo "$(dateTimeShort):""$(basename "$0")"" version $SCRIPT_VERSION resuming logging session." >> "$PATHOUT_APPENDTEST" && \
-           vbm "DEBUG:""$PATHOUT_APPENDTEST"" created."
-       if ! tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$FILEOUT_APPENDTEST"; then
-           ### If not appendable, label tar broken, move tar, proceed.
-           mv "$PATHOUT_TAR" "${PATHOUT_TAR%.*}""-broken$(dateTimeShort)".tar && \
-               vbm "DEBUG:tar not writable, moving out of the way $PATHOUT_TAR";
-       fi
-    else
-       vbm "STATUS:Output tar does not already exist. Creating:$PATHOUT_TAR"
-       ### If (no preexisting|appendable) tar found, create empty tar archive at PATHOUT_TAR
-       try tar --create --directory="$DIR_TMP" --file="$PATHOUT_TAR" --files-from=/dev/null && \
-           vbm "DEBUG:Empty tar created at:$PATHOUT_TAR";
-    fi 
+
+    ## Check that PATHOUT_TAR is a tar. Rename old and create empty one otherwise.
+    checkMakeTar "$PATHOUT_TAR" && vbm "DEBUG:Confirmed or Created to be a tar:$PATHOUT_TAR";
+

     ## Append VERSION file to PATHOUT_TAR
     try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$FILEOUT_VERSION" && \
        vbm "DEBUG:VERSION added to $PATHOUT_TAR";
     ## Append VERSION file to PATHOUT_TAR
     try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$FILEOUT_VERSION" && \
        vbm "DEBUG:VERSION added to $PATHOUT_TAR";


@@ -792,16 +812,16 @@ main() {
        # Determine file paths (time is start of buffer period)
        FILEOUT_BASENAME="$timeBufferStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" && vbm "STATUS:Set FILEOUT_BASENAME to:$FILEOUT_BASENAME";
        ## Files saved to DIR_TMP
        # Determine file paths (time is start of buffer period)
        FILEOUT_BASENAME="$timeBufferStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" && vbm "STATUS:Set FILEOUT_BASENAME to:$FILEOUT_BASENAME";
        ## Files saved to DIR_TMP

-       FILEOUT_NMEA="$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_NMEA to:$FILEOUT_NMEA"
-       FILEOUT_GPX="$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_GPX to:$FILEOUT_GPX"
-       FILEOUT_KML="$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_KML to:$FILEOUT_KML"
+       FILEOUT_NMEA="$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_NMEA to:$FILEOUT_NMEA";
+       FILEOUT_GPX="$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_GPX to:$FILEOUT_GPX";
+       FILEOUT_KML="$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_KML to:$FILEOUT_KML";

        PATHOUT_NMEA="$DIR_TMP"/"$FILEOUT_NMEA" && vbm "STATUS:Set PATHOUT_NMEA to:$PATHOUT_NMEA";
        PATHOUT_GPX="$DIR_TMP"/"$FILEOUT_GPX" && vbm "STATUS:Set PATHOUT_GPX to:$PATHOUT_GPX";
        PATHOUT_KML="$DIR_TMP"/"$FILEOUT_KML" && vbm "STATUS:Set PATHOUT_KML to:$PATHOUT_KML";
        ## Files saved to disk (DIR_OUT)
        ### one file per day (Ex: "20200731..hostname_location.[.gpx.gz].tar")
        PATHOUT_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \
        PATHOUT_NMEA="$DIR_TMP"/"$FILEOUT_NMEA" && vbm "STATUS:Set PATHOUT_NMEA to:$PATHOUT_NMEA";
        PATHOUT_GPX="$DIR_TMP"/"$FILEOUT_GPX" && vbm "STATUS:Set PATHOUT_GPX to:$PATHOUT_GPX";
        PATHOUT_KML="$DIR_TMP"/"$FILEOUT_KML" && vbm "STATUS:Set PATHOUT_KML to:$PATHOUT_KML";
        ## Files saved to disk (DIR_OUT)
        ### one file per day (Ex: "20200731..hostname_location.[.gpx.gz].tar")
        PATHOUT_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \

-           vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR"
+           vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR";

        # Define GPS conversion commands
        CMD_CONV_NMEA="tee /dev/null " && vbm "STATUS:Set CMD_CONV_NMEA to:$CMD_CONV_NMEA"; # tee as passthrough
        CMD_CONV_GPX="gpsbabel -i nmea -f - -o gpx -F - " && vbm "STATUS:Set CMD_CONV_GPX to:$CMD_CONV_GPX"; # convert NMEA to GPX
        # Define GPS conversion commands
        CMD_CONV_NMEA="tee /dev/null " && vbm "STATUS:Set CMD_CONV_NMEA to:$CMD_CONV_NMEA"; # tee as passthrough
        CMD_CONV_GPX="gpsbabel -i nmea -f - -o gpx -F - " && vbm "STATUS:Set CMD_CONV_GPX to:$CMD_CONV_GPX"; # convert NMEA to GPX


@@ -811,23 +831,13 @@ main() {
        # Process bufferBash, save secured chunk set to DIR_TMP
        vbm "STATUS:Beginning to save data to $DIR_TMP";
        magicWriteBuffer &
        # Process bufferBash, save secured chunk set to DIR_TMP
        vbm "STATUS:Beginning to save data to $DIR_TMP";
        magicWriteBuffer &

-       #echo "$bufferBash" | $CMD_CONV_NMEA | $CMD_COMPRESS | $CMD_ENCRYPT > "$PATHOUT_NMEA" & # Create NMEA file (secured if requested)
-       #echo "$bufferBash" | $CMD_CONV_GPX  | $CMD_COMPRESS | $CMD_ENCRYPT > "$PATHOUT_GPX" & # Create GPX file (secured if requested)
-       #echo "$bufferBash" | $CMD_CONV_KML  | $CMD_COMPRESS | $CMD_ENCRYPT > "$PATHOUT_KML" & # Create KML file (secured if requested)

        # Append each secured chunk in memory dir (DIR_TMP) to file on disk (PATHOUT_TAR in DIR_OUT)
        vbm "STATUS:DIR_TMP     :$DIR_TMP";
        vbm "STATUS:PATHOUT_TAR :$PATHOUT_TAR";
        vbm "STATUS:PATHOUT_NMEA:$PATHOUT_NMEA";
        vbm "STATUS:PATHOUT_GPX:$PATHOUT_GPX";
        vbm "STATUS:PATHOUT_KML:$PATHOUT_KML";
        # Append each secured chunk in memory dir (DIR_TMP) to file on disk (PATHOUT_TAR in DIR_OUT)
        vbm "STATUS:DIR_TMP     :$DIR_TMP";
        vbm "STATUS:PATHOUT_TAR :$PATHOUT_TAR";
        vbm "STATUS:PATHOUT_NMEA:$PATHOUT_NMEA";
        vbm "STATUS:PATHOUT_GPX:$PATHOUT_GPX";
        vbm "STATUS:PATHOUT_KML:$PATHOUT_KML";

-       try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_NMEA")" && \
-           vbm "DEBUG:Appended NMEA location data $PATHOUT_NMEA to $PATHOUT_TAR";
-       try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_GPX")" && \
-           vbm "DEBUG:Appended GPX location data $PATHOUT_GPX to $PATHOUT_TAR";
-       try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_KML")" && \
-           vbm "DEBUG:Appended KML location $PATHOUT_KML to $PATHOUT_TAR";
-       # Remove secured chunks from DIR_TMP
-       try rm "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML";
+

        # Reset buffer and filenames
        unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR timeBufferStart;
        vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
        # Reset buffer and filenames
        unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR timeBufferStart;
        vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;


@@ -837,7 +847,7 @@ main() {
     # Remove DIR_TMP
     try rm -r "$DIR_TMP";
 
     # Remove DIR_TMP
     try rm -r "$DIR_TMP";
 

-    vbm "STATUS:Main function finished."
+    vbm "STATUS:Main function finished.";

 } # Main function.
 #===END Declare local script functions===
 #==END Define script parameters==
 } # Main function.
 #===END Declare local script functions===
 #==END Define script parameters==