fix(bkgpslog):Move chunk cleanup into magicWriteBuffer func

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

diff --git a/exec/bkgpslog b/exec/bkgpslog
index 572220b4b445537cfe4109cf2b70b7d8a75be7fb..57b685e9f975ff7bffada7b7745652aaa148863b 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -212,7 +212,7 @@ processArguments() {
            -o | --output) if [ -d "$2" ]; then DIR_OUT="$2"; vbm "DEBUG:DIR_OUT:$DIR_OUT"; shift; fi ;; # Define output directory.
            -e | --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
            -r | --recipient) # Add 'age' recipient via public key string
            -o | --output) if [ -d "$2" ]; then DIR_OUT="$2"; vbm "DEBUG:DIR_OUT:$DIR_OUT"; shift; fi ;; # Define output directory.
            -e | --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
            -r | --recipient) # Add 'age' recipient via public key string

-               recPubKeys+=("$2"); vbm "pubkey added:""$2"; shift;;
+               recPubKeys+=("$2"); vbm "STATUS:pubkey added:""$2"; shift;;

            -c | --compress) OPTION_COMPRESS="true"; vbm "DEBUG:Compressed output mode enabled.";;
            -z | --time-zone) try setTimeZoneEV "$2"; shift;;
            -t | --temp-dir) OPTION_TMPDIR="true" && TMP_DIR_PRIORITY="$2"; shift;;
            -c | --compress) OPTION_COMPRESS="true"; vbm "DEBUG:Compressed output mode enabled.";;
            -z | --time-zone) try setTimeZoneEV "$2"; shift;;
            -t | --temp-dir) OPTION_TMPDIR="true" && TMP_DIR_PRIORITY="$2"; shift;;


@@ -612,6 +612,68 @@ 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).

+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]...)
+    # Input: arg1: data to be written
+    #        arg2: file name of file to be inserted into tar
+    #        arg3: tar archive path (must exist first)
+    #        arg4: temporary working dir
+    #        arg5+: command strings (ex: "gpsbabel -i nmea -f - -o kml -F - ")
+    # Output: file written to disk
+    # Example: decrypt multiple large files in parallel
+    #          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
+
+    # Save function name
+    local FN="${FUNCNAME[0]}"
+    yell "DEBUG:STATUS:$FN:Finished appendArgTar()."
+    
+    # Set file name
+    if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:$FN:Not enough arguments."; exit 1; fi
+    
+    # Check tar path is a file
+    if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:$FN:Tar archive arg not a file."; exit 1; fi
+       
+    # Check temp dir arg
+    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
+    if ! [ -z "$6" ]; then CMD2="$6"; else CMD2="tee /dev/null "; fi # command string 2
+    if ! [ -z "$7" ]; then CMD3="$7"; else CMD3="tee /dev/null "; fi # command string 3
+    if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4
+
+    # Debug
+    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";
+    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
+    local FN="${FUNCNAME[0]}"
+    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_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
+    # Remove secured chunks from DIR_TMP
+    try rm "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML";
+    yell "DEBUG:STATUS:$FN:Finished magicWriteBuffer()."
+} # bkgpslog write function
+
+

 main() {
     processArguments "$@" # Process arguments.
     
 main() {
     processArguments "$@" # Process arguments.
     


@@ -621,7 +683,7 @@ main() {
            if [[ -d "$TMP_DIR_PRIORITY" ]]; then
            DIR_TMP_PARENT="$OPTION_TMPDIR"; 
        else
            if [[ -d "$TMP_DIR_PRIORITY" ]]; then
            DIR_TMP_PARENT="$OPTION_TMPDIR"; 
        else

-           yell "WARNING:Specified temporary working directory not valid:$OPTION_TMP_DIR";
+           yell "WARNING:Specified temporary working directory not valid:$OPTION_TMPDIR";

            exit 1;
        fi
     fi
            exit 1;
        fi
     fi


@@ -648,7 +710,7 @@ main() {
                if echo "butts" | age -a -r "$pubkey" 1>/dev/null; then
                    # Form age recipient string
                    recipients="$recipients""-r $pubkey ";
                if echo "butts" | age -a -r "$pubkey" 1>/dev/null; then
                    # Form age recipient string
                    recipients="$recipients""-r $pubkey ";

-                   vbm "Added pubkey for forming age recipient string:""$pubkey";
+                   vbm "STATUS:Added pubkey for forming age recipient string:""$pubkey";

                    vbm "DEBUG:recipients:""$recipients";
                else
                    yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1;
                    vbm "DEBUG:recipients:""$recipients";
                else
                    yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1;


@@ -695,74 +757,88 @@ main() {
 
     # Initialize 'tar' archive
     ## Define output tar path (note: each day gets *one* tar file (Ex: "20200731..hostname_location.[.gpx.gz].tar"))
 
     # Initialize 'tar' archive
     ## 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 "Set PATHOUT_TAR to:$PATHOUT_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
     ## Write bkgpslog version to DIR_TMP/VERSION

-    echo "$0"" Version:""$SCRIPT_VERSION" >> "$DIR_TMP/VERSION" && vbm "DEBUG:VERSION created.";
+    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.
     ## 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.

-       PATHOUT_APPENDTEST="$DIR_TMP"/"$(dateTimeShort)..append_test.txt" && vbm "DEBUG:Set PATHOUT_APPENDTEST to:$PATHOUT_APPENDTEST";
-       echo "$(dateTimeShort)" >> "$PATHOUT_APPENDTEST" && vbm "DEBUG:""$PATHOUT_APPENDTEST"" created."
-       if ! tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_APPENDTEST")"; then
+       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.
            ### 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";
+           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
        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";
+       try tar --create --directory="$DIR_TMP" --file="$PATHOUT_TAR" --files-from=/dev/null && \
+           vbm "DEBUG:Empty tar created at:$PATHOUT_TAR";

     fi 
     ## Append VERSION file to PATHOUT_TAR
     fi 
     ## Append VERSION file to PATHOUT_TAR

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

     
     # Record gps data until script lifespan ends
     declare debugCounter; debugCounter="0"; # set debug counter
     
     # Record gps data until script lifespan ends
     declare debugCounter; debugCounter="0"; # set debug counter

-    timeStart=$(dateTimeShort); # Note start time

     while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
     while [[ "$SECONDS" -lt "$scriptTTL" ]]; do

+       timeBufferStart="$(dateTimeShort)"; # Note start time

        # Determine file paths (time is start of buffer period)
        # Determine file paths (time is start of buffer period)

-       FILEOUT_BASENAME="$timeStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" && vbm "Set FILEOUT_BASENAME to:$FILEOUT_BASENAME";
+       FILEOUT_BASENAME="$timeBufferStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" && vbm "STATUS:Set FILEOUT_BASENAME to:$FILEOUT_BASENAME";

        ## Files saved to DIR_TMP
        ## Files saved to DIR_TMP

-       PATHOUT_NMEA="$DIR_TMP"/"$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set PATHOUT_NMEA to:$PATHOUT_NMEA";
-       PATHOUT_GPX="$DIR_TMP"/"$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set PATHOUT_GPX to:$PATHOUT_GPX";
-       PATHOUT_KML="$DIR_TMP"/"$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set PATHOUT_KML to:$PATHOUT_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 && \
        ## 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 "Set PATHOUT_TAR to:$PATHOUT_TAR"
+           vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR"

        # Define GPS conversion commands
        # Define GPS conversion commands

-       CMD_CONV_NMEA="tee /dev/null " && vbm "Set CMD_CONV_NMEA to:$CMD_CONV_NMEA"; # tee as passthrough
-       CMD_CONV_GPX="gpsbabel -i nmea -f - -o gpx -F - " && vbm "Set CMD_CONV_GPX to:$CMD_CONV_GPX"; # convert NMEA to GPX
-       CMD_CONV_KML="gpsbabel -i nmea -f - -o kml -F - " && vbm "Set CMD_CONV_KML to:$CMD_CONV_KML"; # convert NMEA to KML
+       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
+       CMD_CONV_KML="gpsbabel -i nmea -f - -o kml -F - " && vbm "STATUS:Set CMD_CONV_KML to:$CMD_CONV_KML"; # convert NMEA to KML

        # Fill Bash variable buffer
        bufferBash="$(timeout "$BUFFER_TTL""s" gpspipe -r)" && vbm "STATUS:Successfully filled bufferBash variable with gpspipe data."; # Record gpspipe nmea data to buffer for bufferTTL seconds
        # Process bufferBash, save secured chunk set to DIR_TMP
        vbm "STATUS:Beginning to save data to $DIR_TMP";
        # Fill Bash variable buffer
        bufferBash="$(timeout "$BUFFER_TTL""s" gpspipe -r)" && vbm "STATUS:Successfully filled bufferBash variable with gpspipe data."; # Record gpspipe nmea data to buffer for bufferTTL seconds
        # Process bufferBash, save secured chunk set to DIR_TMP
        vbm "STATUS:Beginning to save data to $DIR_TMP";

-       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)
+       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)
        # Append each secured chunk in memory dir (DIR_TMP) to file on disk (PATHOUT_TAR in DIR_OUT)

-       vbm "DIR_TMP     :$DIR_TMP";
-       vbm "PATHOUT_TAR :$PATHOUT_TAR";
-       vbm "PATHOUT_NMEA:$PATHOUT_NMEA";
-       vbm "PATHOUT_NMEA:$PATHOUT_GPX";
-       vbm "PATHOUT_NMEA:$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";
+       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";
+

        # Reset buffer and filenames
        # Reset buffer and filenames

-       unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR;
+       unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR timeBufferStart;

        vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
        ((debugCounter++))
     done
 
     # Remove DIR_TMP
     try rm -r "$DIR_TMP";
        vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
        ((debugCounter++))
     done
 
     # Remove DIR_TMP
     try rm -r "$DIR_TMP";

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