feat(bkgpslog):Force ordered write operations with wait

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

diff --git a/exec/bkgpslog b/exec/bkgpslog
index 83bdc7a6f64da4515f82d2d42583519c36219da8..c7cae3658a928b3415c94899c941e7cb7b498e57 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -625,17 +625,20 @@ appendArgTar(){
     #          appendArgTar "$(cat /tmp/largefile1.gpg)" "largefile1" $HOME/archive.tar /tmp "gpg --decrypt" &
     #          appendArgTar "$(cat /tmp/largefile2.gpg)" "largefile2" $HOME/archive.tar /tmp "gpg --decrypt" &
     #          appendArgTar "$(cat /tmp/largefile3.gpg)" "largefile3" $HOME/archive.tar /tmp "gpg --decrypt" &
     #          appendArgTar "$(cat /tmp/largefile1.gpg)" "largefile1" $HOME/archive.tar /tmp "gpg --decrypt" &
     #          appendArgTar "$(cat /tmp/largefile2.gpg)" "largefile2" $HOME/archive.tar /tmp "gpg --decrypt" &
     #          appendArgTar "$(cat /tmp/largefile3.gpg)" "largefile3" $HOME/archive.tar /tmp "gpg --decrypt" &

-

     # Depends: bash 5
 
     # Depends: bash 5
 

+    # Save function name
+    local FN="${FUNCNAME[0]}"
+    yell "DEBUG:STATUS:$FN:Finished appendArgTar()."
+    

     # Set file name
     # Set file name

-    if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:Not enough arguments."; exit 1; fi
+    if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:$FN:Not enough arguments."; exit 1; fi

     
     # Check tar path is a file
     
     # Check tar path is a file

-    if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:Tar archive arg not a file."; exit 1; fi
+    if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:$FN:Tar archive arg not a file."; exit 1; fi

        
     # Check temp dir arg
        
     # Check temp dir arg

-    if ! [ -z "$4" ]; then TMP_DIR="$3"; else yell "ERROR:No temporary working dir set."; exit 1; fi
+    if ! [ -z "$4" ]; then TMP_DIR="$4"; else yell "ERROR:$FN:No temporary working dir set."; exit 1; fi

     
     # Set command strings
     if ! [ -z "$5" ]; then CMD1="$5"; else CMD1="tee /dev/null "; fi # command string 1
     
     # Set command strings
     if ! [ -z "$5" ]; then CMD1="$5"; else CMD1="tee /dev/null "; fi # command string 1


@@ -644,25 +647,31 @@ appendArgTar(){
     if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4
 
     # Debug
     if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4
 
     # Debug

-    yell "CMD1:$CMD1"
-    yell "CMD2:$CMD2"
-    yell "CMD3:$CMD3"
-    yell "CMD4:$CMD4"
-    yell "FILENAME:$FILENAME"
-    yell "TAR_PATH:$TAR_PATH"
-    yell "TMP_DIR:$TMP_DIR"
+    yell "STATUS:$FN:CMD1:$CMD1"
+    yell "STATUS:$FN:CMD2:$CMD2"
+    yell "STATUS:$FN:CMD3:$CMD3"
+    yell "STATUS:$FN:CMD4:$CMD4"
+    yell "STATUS:$FN:FILENAME:$FILENAME"
+    yell "STATUS:$FN:TAR_PATH:$TAR_PATH"
+    yell "STATUS:$FN:TMP_DIR:$TMP_DIR"

     # Write to temporary working dir
     echo "$1" | $CMD1 | $CMD2 | $CMD3 | $CMD4 > "$TMP_DIR"/"$FILENAME";
 
     # Append to tar
     try tar --append --directory="$TMP_DIR" --file="$TAR_PATH" "$FILENAME";
     # Write to temporary working dir
     echo "$1" | $CMD1 | $CMD2 | $CMD3 | $CMD4 > "$TMP_DIR"/"$FILENAME";
 
     # Append to tar
     try tar --append --directory="$TMP_DIR" --file="$TAR_PATH" "$FILENAME";

-
+    yell "DEBUG:STATUS:$FN:Finished 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]}";
+    wait; # Wait to avoid collision with older magicWriteBuffer() instances (see https://www.tldp.org/LDP/abs/html/x9644.html )
+    yell "DEBUG:STATUS:$FN:Started magicWriteBuffer().";

     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
+    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
 
 


@@ -730,7 +739,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.


@@ -763,14 +772,14 @@ main() {
        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" && \
        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."
+           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
        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"
+       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";
        ### 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";


@@ -786,16 +795,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


@@ -805,23 +814,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;


@@ -831,7 +830,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==