X-Git-Url: https://zdv2.bktei.com/gitweb/EVA-2020-02.git/blobdiff_plain/29ef133a0e3322a657756f0d14a233e2cf091965..2fc10824a04e0d2153705f9e9d5be33654a99493:/exec/bkgpslog?ds=inline

diff --git a/exec/bkgpslog b/exec/bkgpslog
index d447886..187e246 100755
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -612,6 +612,116 @@ setScriptTTL() {
 	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 ]
+    # Version: 1.0.1
+    # Input: arg1: path of tar archive
+    # Output: exit code 0 : tar readable
+    #         exit code 1 : tar missing; created
+    #         exit code 2 : tar not readable; moved; replaced
+    # Depends: try, tar, date
+    local PATH_TAR returnFlag0 returnFlag1 returnFlag2
+    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
+	returnFlag0="tar valid";
+    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)" && \
+		returnFlag1="tar moved";
+	else
+	    ### F: -
+	    :
+	fi
+	## F2: Create tar archive, return 0
+	try tar --create --file="$PATH_TAR" --files-from=/dev/null && \
+	    returnFlag2="tar created";
+    fi
+    
+    # Determine function return code
+    if [[ "$returnFlag0" = "tar valid" ]]; then
+	return 0;
+    elif [[ "$returnFlag2" = "tar created" ]] && ! [[ "$returnFlag1" = "tar moved" ]]; then
+	return 1; # tar missing so created
+    elif [[ "$returnFlag2" = "tar created" ]] && [[ "$returnFlag1" = "tar moved" ]]; then
+	return 2; # tar not readable so moved; replaced
+    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]...)
+    # 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
+    # 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_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
+
+
 main() {
     processArguments "$@" # Process arguments.
     
@@ -621,7 +731,7 @@ main() {
 	    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
@@ -676,7 +786,7 @@ main() {
     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.
@@ -697,30 +807,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";
-    ## 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";
-    ## 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";
@@ -732,13 +826,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
-	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 && \
-	    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
@@ -747,23 +844,14 @@ main() {
 	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 &
 	# 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_NMEA:$PATHOUT_GPX";
-	vbm "STATUS: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:PATHOUT_GPX:$PATHOUT_GPX";
+	vbm "STATUS:PATHOUT_KML:$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;
@@ -773,7 +861,7 @@ main() {
     # 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==